babylon.module.d.ts 6.6 MB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710197111971219713197141971519716197171971819719197201972119722197231972419725197261972719728197291973019731197321973319734197351973619737197381973919740197411974219743197441974519746197471974819749197501975119752197531975419755197561975719758197591976019761197621976319764197651976619767197681976919770197711977219773197741977519776197771977819779197801978119782197831978419785197861978719788197891979019791197921979319794197951979619797197981979919800198011980219803198041980519806198071980819809198101981119812198131981419815198161981719818198191982019821198221982319824198251982619827198281982919830198311983219833198341983519836198371983819839198401984119842198431984419845198461984719848198491985019851198521985319854198551985619857198581985919860198611986219863198641986519866198671986819869198701987119872198731987419875198761987719878198791988019881198821988319884198851988619887198881988919890198911989219893198941989519896198971989819899199001990119902199031990419905199061990719908199091991019911199121991319914199151991619917199181991919920199211992219923199241992519926199271992819929199301993119932199331993419935199361993719938199391994019941199421994319944199451994619947199481994919950199511995219953199541995519956199571995819959199601996119962199631996419965199661996719968199691997019971199721997319974199751997619977199781997919980199811998219983199841998519986199871998819989199901999119992199931999419995199961999719998199992000020001200022000320004200052000620007200082000920010200112001220013200142001520016200172001820019200202002120022200232002420025200262002720028200292003020031200322003320034200352003620037200382003920040200412004220043200442004520046200472004820049200502005120052200532005420055200562005720058200592006020061200622006320064200652006620067200682006920070200712007220073200742007520076200772007820079200802008120082200832008420085200862008720088200892009020091200922009320094200952009620097200982009920100201012010220103201042010520106201072010820109201102011120112201132011420115201162011720118201192012020121201222012320124201252012620127201282012920130201312013220133201342013520136201372013820139201402014120142201432014420145201462014720148201492015020151201522015320154201552015620157201582015920160201612016220163201642016520166201672016820169201702017120172201732017420175201762017720178201792018020181201822018320184201852018620187201882018920190201912019220193201942019520196201972019820199202002020120202202032020420205202062020720208202092021020211202122021320214202152021620217202182021920220202212022220223202242022520226202272022820229202302023120232202332023420235202362023720238202392024020241202422024320244202452024620247202482024920250202512025220253202542025520256202572025820259202602026120262202632026420265202662026720268202692027020271202722027320274202752027620277202782027920280202812028220283202842028520286202872028820289202902029120292202932029420295202962029720298202992030020301203022030320304203052030620307203082030920310203112031220313203142031520316203172031820319203202032120322203232032420325203262032720328203292033020331203322033320334203352033620337203382033920340203412034220343203442034520346203472034820349203502035120352203532035420355203562035720358203592036020361203622036320364203652036620367203682036920370203712037220373203742037520376203772037820379203802038120382203832038420385203862038720388203892039020391203922039320394203952039620397203982039920400204012040220403204042040520406204072040820409204102041120412204132041420415204162041720418204192042020421204222042320424204252042620427204282042920430204312043220433204342043520436204372043820439204402044120442204432044420445204462044720448204492045020451204522045320454204552045620457204582045920460204612046220463204642046520466204672046820469204702047120472204732047420475204762047720478204792048020481204822048320484204852048620487204882048920490204912049220493204942049520496204972049820499205002050120502205032050420505205062050720508205092051020511205122051320514205152051620517205182051920520205212052220523205242052520526205272052820529205302053120532205332053420535205362053720538205392054020541205422054320544205452054620547205482054920550205512055220553205542055520556205572055820559205602056120562205632056420565205662056720568205692057020571205722057320574205752057620577205782057920580205812058220583205842058520586205872058820589205902059120592205932059420595205962059720598205992060020601206022060320604206052060620607206082060920610206112061220613206142061520616206172061820619206202062120622206232062420625206262062720628206292063020631206322063320634206352063620637206382063920640206412064220643206442064520646206472064820649206502065120652206532065420655206562065720658206592066020661206622066320664206652066620667206682066920670206712067220673206742067520676206772067820679206802068120682206832068420685206862068720688206892069020691206922069320694206952069620697206982069920700207012070220703207042070520706207072070820709207102071120712207132071420715207162071720718207192072020721207222072320724207252072620727207282072920730207312073220733207342073520736207372073820739207402074120742207432074420745207462074720748207492075020751207522075320754207552075620757207582075920760207612076220763207642076520766207672076820769207702077120772207732077420775207762077720778207792078020781207822078320784207852078620787207882078920790207912079220793207942079520796207972079820799208002080120802208032080420805208062080720808208092081020811208122081320814208152081620817208182081920820208212082220823208242082520826208272082820829208302083120832208332083420835208362083720838208392084020841208422084320844208452084620847208482084920850208512085220853208542085520856208572085820859208602086120862208632086420865208662086720868208692087020871208722087320874208752087620877208782087920880208812088220883208842088520886208872088820889208902089120892208932089420895208962089720898208992090020901209022090320904209052090620907209082090920910209112091220913209142091520916209172091820919209202092120922209232092420925209262092720928209292093020931209322093320934209352093620937209382093920940209412094220943209442094520946209472094820949209502095120952209532095420955209562095720958209592096020961209622096320964209652096620967209682096920970209712097220973209742097520976209772097820979209802098120982209832098420985209862098720988209892099020991209922099320994209952099620997209982099921000210012100221003210042100521006210072100821009210102101121012210132101421015210162101721018210192102021021210222102321024210252102621027210282102921030210312103221033210342103521036210372103821039210402104121042210432104421045210462104721048210492105021051210522105321054210552105621057210582105921060210612106221063210642106521066210672106821069210702107121072210732107421075210762107721078210792108021081210822108321084210852108621087210882108921090210912109221093210942109521096210972109821099211002110121102211032110421105211062110721108211092111021111211122111321114211152111621117211182111921120211212112221123211242112521126211272112821129211302113121132211332113421135211362113721138211392114021141211422114321144211452114621147211482114921150211512115221153211542115521156211572115821159211602116121162211632116421165211662116721168211692117021171211722117321174211752117621177211782117921180211812118221183211842118521186211872118821189211902119121192211932119421195211962119721198211992120021201212022120321204212052120621207212082120921210212112121221213212142121521216212172121821219212202122121222212232122421225212262122721228212292123021231212322123321234212352123621237212382123921240212412124221243212442124521246212472124821249212502125121252212532125421255212562125721258212592126021261212622126321264212652126621267212682126921270212712127221273212742127521276212772127821279212802128121282212832128421285212862128721288212892129021291212922129321294212952129621297212982129921300213012130221303213042130521306213072130821309213102131121312213132131421315213162131721318213192132021321213222132321324213252132621327213282132921330213312133221333213342133521336213372133821339213402134121342213432134421345213462134721348213492135021351213522135321354213552135621357213582135921360213612136221363213642136521366213672136821369213702137121372213732137421375213762137721378213792138021381213822138321384213852138621387213882138921390213912139221393213942139521396213972139821399214002140121402214032140421405214062140721408214092141021411214122141321414214152141621417214182141921420214212142221423214242142521426214272142821429214302143121432214332143421435214362143721438214392144021441214422144321444214452144621447214482144921450214512145221453214542145521456214572145821459214602146121462214632146421465214662146721468214692147021471214722147321474214752147621477214782147921480214812148221483214842148521486214872148821489214902149121492214932149421495214962149721498214992150021501215022150321504215052150621507215082150921510215112151221513215142151521516215172151821519215202152121522215232152421525215262152721528215292153021531215322153321534215352153621537215382153921540215412154221543215442154521546215472154821549215502155121552215532155421555215562155721558215592156021561215622156321564215652156621567215682156921570215712157221573215742157521576215772157821579215802158121582215832158421585215862158721588215892159021591215922159321594215952159621597215982159921600216012160221603216042160521606216072160821609216102161121612216132161421615216162161721618216192162021621216222162321624216252162621627216282162921630216312163221633216342163521636216372163821639216402164121642216432164421645216462164721648216492165021651216522165321654216552165621657216582165921660216612166221663216642166521666216672166821669216702167121672216732167421675216762167721678216792168021681216822168321684216852168621687216882168921690216912169221693216942169521696216972169821699217002170121702217032170421705217062170721708217092171021711217122171321714217152171621717217182171921720217212172221723217242172521726217272172821729217302173121732217332173421735217362173721738217392174021741217422174321744217452174621747217482174921750217512175221753217542175521756217572175821759217602176121762217632176421765217662176721768217692177021771217722177321774217752177621777217782177921780217812178221783217842178521786217872178821789217902179121792217932179421795217962179721798217992180021801218022180321804218052180621807218082180921810218112181221813218142181521816218172181821819218202182121822218232182421825218262182721828218292183021831218322183321834218352183621837218382183921840218412184221843218442184521846218472184821849218502185121852218532185421855218562185721858218592186021861218622186321864218652186621867218682186921870218712187221873218742187521876218772187821879218802188121882218832188421885218862188721888218892189021891218922189321894218952189621897218982189921900219012190221903219042190521906219072190821909219102191121912219132191421915219162191721918219192192021921219222192321924219252192621927219282192921930219312193221933219342193521936219372193821939219402194121942219432194421945219462194721948219492195021951219522195321954219552195621957219582195921960219612196221963219642196521966219672196821969219702197121972219732197421975219762197721978219792198021981219822198321984219852198621987219882198921990219912199221993219942199521996219972199821999220002200122002220032200422005220062200722008220092201022011220122201322014220152201622017220182201922020220212202222023220242202522026220272202822029220302203122032220332203422035220362203722038220392204022041220422204322044220452204622047220482204922050220512205222053220542205522056220572205822059220602206122062220632206422065220662206722068220692207022071220722207322074220752207622077220782207922080220812208222083220842208522086220872208822089220902209122092220932209422095220962209722098220992210022101221022210322104221052210622107221082210922110221112211222113221142211522116221172211822119221202212122122221232212422125221262212722128221292213022131221322213322134221352213622137221382213922140221412214222143221442214522146221472214822149221502215122152221532215422155221562215722158221592216022161221622216322164221652216622167221682216922170221712217222173221742217522176221772217822179221802218122182221832218422185221862218722188221892219022191221922219322194221952219622197221982219922200222012220222203222042220522206222072220822209222102221122212222132221422215222162221722218222192222022221222222222322224222252222622227222282222922230222312223222233222342223522236222372223822239222402224122242222432224422245222462224722248222492225022251222522225322254222552225622257222582225922260222612226222263222642226522266222672226822269222702227122272222732227422275222762227722278222792228022281222822228322284222852228622287222882228922290222912229222293222942229522296222972229822299223002230122302223032230422305223062230722308223092231022311223122231322314223152231622317223182231922320223212232222323223242232522326223272232822329223302233122332223332233422335223362233722338223392234022341223422234322344223452234622347223482234922350223512235222353223542235522356223572235822359223602236122362223632236422365223662236722368223692237022371223722237322374223752237622377223782237922380223812238222383223842238522386223872238822389223902239122392223932239422395223962239722398223992240022401224022240322404224052240622407224082240922410224112241222413224142241522416224172241822419224202242122422224232242422425224262242722428224292243022431224322243322434224352243622437224382243922440224412244222443224442244522446224472244822449224502245122452224532245422455224562245722458224592246022461224622246322464224652246622467224682246922470224712247222473224742247522476224772247822479224802248122482224832248422485224862248722488224892249022491224922249322494224952249622497224982249922500225012250222503225042250522506225072250822509225102251122512225132251422515225162251722518225192252022521225222252322524225252252622527225282252922530225312253222533225342253522536225372253822539225402254122542225432254422545225462254722548225492255022551225522255322554225552255622557225582255922560225612256222563225642256522566225672256822569225702257122572225732257422575225762257722578225792258022581225822258322584225852258622587225882258922590225912259222593225942259522596225972259822599226002260122602226032260422605226062260722608226092261022611226122261322614226152261622617226182261922620226212262222623226242262522626226272262822629226302263122632226332263422635226362263722638226392264022641226422264322644226452264622647226482264922650226512265222653226542265522656226572265822659226602266122662226632266422665226662266722668226692267022671226722267322674226752267622677226782267922680226812268222683226842268522686226872268822689226902269122692226932269422695226962269722698226992270022701227022270322704227052270622707227082270922710227112271222713227142271522716227172271822719227202272122722227232272422725227262272722728227292273022731227322273322734227352273622737227382273922740227412274222743227442274522746227472274822749227502275122752227532275422755227562275722758227592276022761227622276322764227652276622767227682276922770227712277222773227742277522776227772277822779227802278122782227832278422785227862278722788227892279022791227922279322794227952279622797227982279922800228012280222803228042280522806228072280822809228102281122812228132281422815228162281722818228192282022821228222282322824228252282622827228282282922830228312283222833228342283522836228372283822839228402284122842228432284422845228462284722848228492285022851228522285322854228552285622857228582285922860228612286222863228642286522866228672286822869228702287122872228732287422875228762287722878228792288022881228822288322884228852288622887228882288922890228912289222893228942289522896228972289822899229002290122902229032290422905229062290722908229092291022911229122291322914229152291622917229182291922920229212292222923229242292522926229272292822929229302293122932229332293422935229362293722938229392294022941229422294322944229452294622947229482294922950229512295222953229542295522956229572295822959229602296122962229632296422965229662296722968229692297022971229722297322974229752297622977229782297922980229812298222983229842298522986229872298822989229902299122992229932299422995229962299722998229992300023001230022300323004230052300623007230082300923010230112301223013230142301523016230172301823019230202302123022230232302423025230262302723028230292303023031230322303323034230352303623037230382303923040230412304223043230442304523046230472304823049230502305123052230532305423055230562305723058230592306023061230622306323064230652306623067230682306923070230712307223073230742307523076230772307823079230802308123082230832308423085230862308723088230892309023091230922309323094230952309623097230982309923100231012310223103231042310523106231072310823109231102311123112231132311423115231162311723118231192312023121231222312323124231252312623127231282312923130231312313223133231342313523136231372313823139231402314123142231432314423145231462314723148231492315023151231522315323154231552315623157231582315923160231612316223163231642316523166231672316823169231702317123172231732317423175231762317723178231792318023181231822318323184231852318623187231882318923190231912319223193231942319523196231972319823199232002320123202232032320423205232062320723208232092321023211232122321323214232152321623217232182321923220232212322223223232242322523226232272322823229232302323123232232332323423235232362323723238232392324023241232422324323244232452324623247232482324923250232512325223253232542325523256232572325823259232602326123262232632326423265232662326723268232692327023271232722327323274232752327623277232782327923280232812328223283232842328523286232872328823289232902329123292232932329423295232962329723298232992330023301233022330323304233052330623307233082330923310233112331223313233142331523316233172331823319233202332123322233232332423325233262332723328233292333023331233322333323334233352333623337233382333923340233412334223343233442334523346233472334823349233502335123352233532335423355233562335723358233592336023361233622336323364233652336623367233682336923370233712337223373233742337523376233772337823379233802338123382233832338423385233862338723388233892339023391233922339323394233952339623397233982339923400234012340223403234042340523406234072340823409234102341123412234132341423415234162341723418234192342023421234222342323424234252342623427234282342923430234312343223433234342343523436234372343823439234402344123442234432344423445234462344723448234492345023451234522345323454234552345623457234582345923460234612346223463234642346523466234672346823469234702347123472234732347423475234762347723478234792348023481234822348323484234852348623487234882348923490234912349223493234942349523496234972349823499235002350123502235032350423505235062350723508235092351023511235122351323514235152351623517235182351923520235212352223523235242352523526235272352823529235302353123532235332353423535235362353723538235392354023541235422354323544235452354623547235482354923550235512355223553235542355523556235572355823559235602356123562235632356423565235662356723568235692357023571235722357323574235752357623577235782357923580235812358223583235842358523586235872358823589235902359123592235932359423595235962359723598235992360023601236022360323604236052360623607236082360923610236112361223613236142361523616236172361823619236202362123622236232362423625236262362723628236292363023631236322363323634236352363623637236382363923640236412364223643236442364523646236472364823649236502365123652236532365423655236562365723658236592366023661236622366323664236652366623667236682366923670236712367223673236742367523676236772367823679236802368123682236832368423685236862368723688236892369023691236922369323694236952369623697236982369923700237012370223703237042370523706237072370823709237102371123712237132371423715237162371723718237192372023721237222372323724237252372623727237282372923730237312373223733237342373523736237372373823739237402374123742237432374423745237462374723748237492375023751237522375323754237552375623757237582375923760237612376223763237642376523766237672376823769237702377123772237732377423775237762377723778237792378023781237822378323784237852378623787237882378923790237912379223793237942379523796237972379823799238002380123802238032380423805238062380723808238092381023811238122381323814238152381623817238182381923820238212382223823238242382523826238272382823829238302383123832238332383423835238362383723838238392384023841238422384323844238452384623847238482384923850238512385223853238542385523856238572385823859238602386123862238632386423865238662386723868238692387023871238722387323874238752387623877238782387923880238812388223883238842388523886238872388823889238902389123892238932389423895238962389723898238992390023901239022390323904239052390623907239082390923910239112391223913239142391523916239172391823919239202392123922239232392423925239262392723928239292393023931239322393323934239352393623937239382393923940239412394223943239442394523946239472394823949239502395123952239532395423955239562395723958239592396023961239622396323964239652396623967239682396923970239712397223973239742397523976239772397823979239802398123982239832398423985239862398723988239892399023991239922399323994239952399623997239982399924000240012400224003240042400524006240072400824009240102401124012240132401424015240162401724018240192402024021240222402324024240252402624027240282402924030240312403224033240342403524036240372403824039240402404124042240432404424045240462404724048240492405024051240522405324054240552405624057240582405924060240612406224063240642406524066240672406824069240702407124072240732407424075240762407724078240792408024081240822408324084240852408624087240882408924090240912409224093240942409524096240972409824099241002410124102241032410424105241062410724108241092411024111241122411324114241152411624117241182411924120241212412224123241242412524126241272412824129241302413124132241332413424135241362413724138241392414024141241422414324144241452414624147241482414924150241512415224153241542415524156241572415824159241602416124162241632416424165241662416724168241692417024171241722417324174241752417624177241782417924180241812418224183241842418524186241872418824189241902419124192241932419424195241962419724198241992420024201242022420324204242052420624207242082420924210242112421224213242142421524216242172421824219242202422124222242232422424225242262422724228242292423024231242322423324234242352423624237242382423924240242412424224243242442424524246242472424824249242502425124252242532425424255242562425724258242592426024261242622426324264242652426624267242682426924270242712427224273242742427524276242772427824279242802428124282242832428424285242862428724288242892429024291242922429324294242952429624297242982429924300243012430224303243042430524306243072430824309243102431124312243132431424315243162431724318243192432024321243222432324324243252432624327243282432924330243312433224333243342433524336243372433824339243402434124342243432434424345243462434724348243492435024351243522435324354243552435624357243582435924360243612436224363243642436524366243672436824369243702437124372243732437424375243762437724378243792438024381243822438324384243852438624387243882438924390243912439224393243942439524396243972439824399244002440124402244032440424405244062440724408244092441024411244122441324414244152441624417244182441924420244212442224423244242442524426244272442824429244302443124432244332443424435244362443724438244392444024441244422444324444244452444624447244482444924450244512445224453244542445524456244572445824459244602446124462244632446424465244662446724468244692447024471244722447324474244752447624477244782447924480244812448224483244842448524486244872448824489244902449124492244932449424495244962449724498244992450024501245022450324504245052450624507245082450924510245112451224513245142451524516245172451824519245202452124522245232452424525245262452724528245292453024531245322453324534245352453624537245382453924540245412454224543245442454524546245472454824549245502455124552245532455424555245562455724558245592456024561245622456324564245652456624567245682456924570245712457224573245742457524576245772457824579245802458124582245832458424585245862458724588245892459024591245922459324594245952459624597245982459924600246012460224603246042460524606246072460824609246102461124612246132461424615246162461724618246192462024621246222462324624246252462624627246282462924630246312463224633246342463524636246372463824639246402464124642246432464424645246462464724648246492465024651246522465324654246552465624657246582465924660246612466224663246642466524666246672466824669246702467124672246732467424675246762467724678246792468024681246822468324684246852468624687246882468924690246912469224693246942469524696246972469824699247002470124702247032470424705247062470724708247092471024711247122471324714247152471624717247182471924720247212472224723247242472524726247272472824729247302473124732247332473424735247362473724738247392474024741247422474324744247452474624747247482474924750247512475224753247542475524756247572475824759247602476124762247632476424765247662476724768247692477024771247722477324774247752477624777247782477924780247812478224783247842478524786247872478824789247902479124792247932479424795247962479724798247992480024801248022480324804248052480624807248082480924810248112481224813248142481524816248172481824819248202482124822248232482424825248262482724828248292483024831248322483324834248352483624837248382483924840248412484224843248442484524846248472484824849248502485124852248532485424855248562485724858248592486024861248622486324864248652486624867248682486924870248712487224873248742487524876248772487824879248802488124882248832488424885248862488724888248892489024891248922489324894248952489624897248982489924900249012490224903249042490524906249072490824909249102491124912249132491424915249162491724918249192492024921249222492324924249252492624927249282492924930249312493224933249342493524936249372493824939249402494124942249432494424945249462494724948249492495024951249522495324954249552495624957249582495924960249612496224963249642496524966249672496824969249702497124972249732497424975249762497724978249792498024981249822498324984249852498624987249882498924990249912499224993249942499524996249972499824999250002500125002250032500425005250062500725008250092501025011250122501325014250152501625017250182501925020250212502225023250242502525026250272502825029250302503125032250332503425035250362503725038250392504025041250422504325044250452504625047250482504925050250512505225053250542505525056250572505825059250602506125062250632506425065250662506725068250692507025071250722507325074250752507625077250782507925080250812508225083250842508525086250872508825089250902509125092250932509425095250962509725098250992510025101251022510325104251052510625107251082510925110251112511225113251142511525116251172511825119251202512125122251232512425125251262512725128251292513025131251322513325134251352513625137251382513925140251412514225143251442514525146251472514825149251502515125152251532515425155251562515725158251592516025161251622516325164251652516625167251682516925170251712517225173251742517525176251772517825179251802518125182251832518425185251862518725188251892519025191251922519325194251952519625197251982519925200252012520225203252042520525206252072520825209252102521125212252132521425215252162521725218252192522025221252222522325224252252522625227252282522925230252312523225233252342523525236252372523825239252402524125242252432524425245252462524725248252492525025251252522525325254252552525625257252582525925260252612526225263252642526525266252672526825269252702527125272252732527425275252762527725278252792528025281252822528325284252852528625287252882528925290252912529225293252942529525296252972529825299253002530125302253032530425305253062530725308253092531025311253122531325314253152531625317253182531925320253212532225323253242532525326253272532825329253302533125332253332533425335253362533725338253392534025341253422534325344253452534625347253482534925350253512535225353253542535525356253572535825359253602536125362253632536425365253662536725368253692537025371253722537325374253752537625377253782537925380253812538225383253842538525386253872538825389253902539125392253932539425395253962539725398253992540025401254022540325404254052540625407254082540925410254112541225413254142541525416254172541825419254202542125422254232542425425254262542725428254292543025431254322543325434254352543625437254382543925440254412544225443254442544525446254472544825449254502545125452254532545425455254562545725458254592546025461254622546325464254652546625467254682546925470254712547225473254742547525476254772547825479254802548125482254832548425485254862548725488254892549025491254922549325494254952549625497254982549925500255012550225503255042550525506255072550825509255102551125512255132551425515255162551725518255192552025521255222552325524255252552625527255282552925530255312553225533255342553525536255372553825539255402554125542255432554425545255462554725548255492555025551255522555325554255552555625557255582555925560255612556225563255642556525566255672556825569255702557125572255732557425575255762557725578255792558025581255822558325584255852558625587255882558925590255912559225593255942559525596255972559825599256002560125602256032560425605256062560725608256092561025611256122561325614256152561625617256182561925620256212562225623256242562525626256272562825629256302563125632256332563425635256362563725638256392564025641256422564325644256452564625647256482564925650256512565225653256542565525656256572565825659256602566125662256632566425665256662566725668256692567025671256722567325674256752567625677256782567925680256812568225683256842568525686256872568825689256902569125692256932569425695256962569725698256992570025701257022570325704257052570625707257082570925710257112571225713257142571525716257172571825719257202572125722257232572425725257262572725728257292573025731257322573325734257352573625737257382573925740257412574225743257442574525746257472574825749257502575125752257532575425755257562575725758257592576025761257622576325764257652576625767257682576925770257712577225773257742577525776257772577825779257802578125782257832578425785257862578725788257892579025791257922579325794257952579625797257982579925800258012580225803258042580525806258072580825809258102581125812258132581425815258162581725818258192582025821258222582325824258252582625827258282582925830258312583225833258342583525836258372583825839258402584125842258432584425845258462584725848258492585025851258522585325854258552585625857258582585925860258612586225863258642586525866258672586825869258702587125872258732587425875258762587725878258792588025881258822588325884258852588625887258882588925890258912589225893258942589525896258972589825899259002590125902259032590425905259062590725908259092591025911259122591325914259152591625917259182591925920259212592225923259242592525926259272592825929259302593125932259332593425935259362593725938259392594025941259422594325944259452594625947259482594925950259512595225953259542595525956259572595825959259602596125962259632596425965259662596725968259692597025971259722597325974259752597625977259782597925980259812598225983259842598525986259872598825989259902599125992259932599425995259962599725998259992600026001260022600326004260052600626007260082600926010260112601226013260142601526016260172601826019260202602126022260232602426025260262602726028260292603026031260322603326034260352603626037260382603926040260412604226043260442604526046260472604826049260502605126052260532605426055260562605726058260592606026061260622606326064260652606626067260682606926070260712607226073260742607526076260772607826079260802608126082260832608426085260862608726088260892609026091260922609326094260952609626097260982609926100261012610226103261042610526106261072610826109261102611126112261132611426115261162611726118261192612026121261222612326124261252612626127261282612926130261312613226133261342613526136261372613826139261402614126142261432614426145261462614726148261492615026151261522615326154261552615626157261582615926160261612616226163261642616526166261672616826169261702617126172261732617426175261762617726178261792618026181261822618326184261852618626187261882618926190261912619226193261942619526196261972619826199262002620126202262032620426205262062620726208262092621026211262122621326214262152621626217262182621926220262212622226223262242622526226262272622826229262302623126232262332623426235262362623726238262392624026241262422624326244262452624626247262482624926250262512625226253262542625526256262572625826259262602626126262262632626426265262662626726268262692627026271262722627326274262752627626277262782627926280262812628226283262842628526286262872628826289262902629126292262932629426295262962629726298262992630026301263022630326304263052630626307263082630926310263112631226313263142631526316263172631826319263202632126322263232632426325263262632726328263292633026331263322633326334263352633626337263382633926340263412634226343263442634526346263472634826349263502635126352263532635426355263562635726358263592636026361263622636326364263652636626367263682636926370263712637226373263742637526376263772637826379263802638126382263832638426385263862638726388263892639026391263922639326394263952639626397263982639926400264012640226403264042640526406264072640826409264102641126412264132641426415264162641726418264192642026421264222642326424264252642626427264282642926430264312643226433264342643526436264372643826439264402644126442264432644426445264462644726448264492645026451264522645326454264552645626457264582645926460264612646226463264642646526466264672646826469264702647126472264732647426475264762647726478264792648026481264822648326484264852648626487264882648926490264912649226493264942649526496264972649826499265002650126502265032650426505265062650726508265092651026511265122651326514265152651626517265182651926520265212652226523265242652526526265272652826529265302653126532265332653426535265362653726538265392654026541265422654326544265452654626547265482654926550265512655226553265542655526556265572655826559265602656126562265632656426565265662656726568265692657026571265722657326574265752657626577265782657926580265812658226583265842658526586265872658826589265902659126592265932659426595265962659726598265992660026601266022660326604266052660626607266082660926610266112661226613266142661526616266172661826619266202662126622266232662426625266262662726628266292663026631266322663326634266352663626637266382663926640266412664226643266442664526646266472664826649266502665126652266532665426655266562665726658266592666026661266622666326664266652666626667266682666926670266712667226673266742667526676266772667826679266802668126682266832668426685266862668726688266892669026691266922669326694266952669626697266982669926700267012670226703267042670526706267072670826709267102671126712267132671426715267162671726718267192672026721267222672326724267252672626727267282672926730267312673226733267342673526736267372673826739267402674126742267432674426745267462674726748267492675026751267522675326754267552675626757267582675926760267612676226763267642676526766267672676826769267702677126772267732677426775267762677726778267792678026781267822678326784267852678626787267882678926790267912679226793267942679526796267972679826799268002680126802268032680426805268062680726808268092681026811268122681326814268152681626817268182681926820268212682226823268242682526826268272682826829268302683126832268332683426835268362683726838268392684026841268422684326844268452684626847268482684926850268512685226853268542685526856268572685826859268602686126862268632686426865268662686726868268692687026871268722687326874268752687626877268782687926880268812688226883268842688526886268872688826889268902689126892268932689426895268962689726898268992690026901269022690326904269052690626907269082690926910269112691226913269142691526916269172691826919269202692126922269232692426925269262692726928269292693026931269322693326934269352693626937269382693926940269412694226943269442694526946269472694826949269502695126952269532695426955269562695726958269592696026961269622696326964269652696626967269682696926970269712697226973269742697526976269772697826979269802698126982269832698426985269862698726988269892699026991269922699326994269952699626997269982699927000270012700227003270042700527006270072700827009270102701127012270132701427015270162701727018270192702027021270222702327024270252702627027270282702927030270312703227033270342703527036270372703827039270402704127042270432704427045270462704727048270492705027051270522705327054270552705627057270582705927060270612706227063270642706527066270672706827069270702707127072270732707427075270762707727078270792708027081270822708327084270852708627087270882708927090270912709227093270942709527096270972709827099271002710127102271032710427105271062710727108271092711027111271122711327114271152711627117271182711927120271212712227123271242712527126271272712827129271302713127132271332713427135271362713727138271392714027141271422714327144271452714627147271482714927150271512715227153271542715527156271572715827159271602716127162271632716427165271662716727168271692717027171271722717327174271752717627177271782717927180271812718227183271842718527186271872718827189271902719127192271932719427195271962719727198271992720027201272022720327204272052720627207272082720927210272112721227213272142721527216272172721827219272202722127222272232722427225272262722727228272292723027231272322723327234272352723627237272382723927240272412724227243272442724527246272472724827249272502725127252272532725427255272562725727258272592726027261272622726327264272652726627267272682726927270272712727227273272742727527276272772727827279272802728127282272832728427285272862728727288272892729027291272922729327294272952729627297272982729927300273012730227303273042730527306273072730827309273102731127312273132731427315273162731727318273192732027321273222732327324273252732627327273282732927330273312733227333273342733527336273372733827339273402734127342273432734427345273462734727348273492735027351273522735327354273552735627357273582735927360273612736227363273642736527366273672736827369273702737127372273732737427375273762737727378273792738027381273822738327384273852738627387273882738927390273912739227393273942739527396273972739827399274002740127402274032740427405274062740727408274092741027411274122741327414274152741627417274182741927420274212742227423274242742527426274272742827429274302743127432274332743427435274362743727438274392744027441274422744327444274452744627447274482744927450274512745227453274542745527456274572745827459274602746127462274632746427465274662746727468274692747027471274722747327474274752747627477274782747927480274812748227483274842748527486274872748827489274902749127492274932749427495274962749727498274992750027501275022750327504275052750627507275082750927510275112751227513275142751527516275172751827519275202752127522275232752427525275262752727528275292753027531275322753327534275352753627537275382753927540275412754227543275442754527546275472754827549275502755127552275532755427555275562755727558275592756027561275622756327564275652756627567275682756927570275712757227573275742757527576275772757827579275802758127582275832758427585275862758727588275892759027591275922759327594275952759627597275982759927600276012760227603276042760527606276072760827609276102761127612276132761427615276162761727618276192762027621276222762327624276252762627627276282762927630276312763227633276342763527636276372763827639276402764127642276432764427645276462764727648276492765027651276522765327654276552765627657276582765927660276612766227663276642766527666276672766827669276702767127672276732767427675276762767727678276792768027681276822768327684276852768627687276882768927690276912769227693276942769527696276972769827699277002770127702277032770427705277062770727708277092771027711277122771327714277152771627717277182771927720277212772227723277242772527726277272772827729277302773127732277332773427735277362773727738277392774027741277422774327744277452774627747277482774927750277512775227753277542775527756277572775827759277602776127762277632776427765277662776727768277692777027771277722777327774277752777627777277782777927780277812778227783277842778527786277872778827789277902779127792277932779427795277962779727798277992780027801278022780327804278052780627807278082780927810278112781227813278142781527816278172781827819278202782127822278232782427825278262782727828278292783027831278322783327834278352783627837278382783927840278412784227843278442784527846278472784827849278502785127852278532785427855278562785727858278592786027861278622786327864278652786627867278682786927870278712787227873278742787527876278772787827879278802788127882278832788427885278862788727888278892789027891278922789327894278952789627897278982789927900279012790227903279042790527906279072790827909279102791127912279132791427915279162791727918279192792027921279222792327924279252792627927279282792927930279312793227933279342793527936279372793827939279402794127942279432794427945279462794727948279492795027951279522795327954279552795627957279582795927960279612796227963279642796527966279672796827969279702797127972279732797427975279762797727978279792798027981279822798327984279852798627987279882798927990279912799227993279942799527996279972799827999280002800128002280032800428005280062800728008280092801028011280122801328014280152801628017280182801928020280212802228023280242802528026280272802828029280302803128032280332803428035280362803728038280392804028041280422804328044280452804628047280482804928050280512805228053280542805528056280572805828059280602806128062280632806428065280662806728068280692807028071280722807328074280752807628077280782807928080280812808228083280842808528086280872808828089280902809128092280932809428095280962809728098280992810028101281022810328104281052810628107281082810928110281112811228113281142811528116281172811828119281202812128122281232812428125281262812728128281292813028131281322813328134281352813628137281382813928140281412814228143281442814528146281472814828149281502815128152281532815428155281562815728158281592816028161281622816328164281652816628167281682816928170281712817228173281742817528176281772817828179281802818128182281832818428185281862818728188281892819028191281922819328194281952819628197281982819928200282012820228203282042820528206282072820828209282102821128212282132821428215282162821728218282192822028221282222822328224282252822628227282282822928230282312823228233282342823528236282372823828239282402824128242282432824428245282462824728248282492825028251282522825328254282552825628257282582825928260282612826228263282642826528266282672826828269282702827128272282732827428275282762827728278282792828028281282822828328284282852828628287282882828928290282912829228293282942829528296282972829828299283002830128302283032830428305283062830728308283092831028311283122831328314283152831628317283182831928320283212832228323283242832528326283272832828329283302833128332283332833428335283362833728338283392834028341283422834328344283452834628347283482834928350283512835228353283542835528356283572835828359283602836128362283632836428365283662836728368283692837028371283722837328374283752837628377283782837928380283812838228383283842838528386283872838828389283902839128392283932839428395283962839728398283992840028401284022840328404284052840628407284082840928410284112841228413284142841528416284172841828419284202842128422284232842428425284262842728428284292843028431284322843328434284352843628437284382843928440284412844228443284442844528446284472844828449284502845128452284532845428455284562845728458284592846028461284622846328464284652846628467284682846928470284712847228473284742847528476284772847828479284802848128482284832848428485284862848728488284892849028491284922849328494284952849628497284982849928500285012850228503285042850528506285072850828509285102851128512285132851428515285162851728518285192852028521285222852328524285252852628527285282852928530285312853228533285342853528536285372853828539285402854128542285432854428545285462854728548285492855028551285522855328554285552855628557285582855928560285612856228563285642856528566285672856828569285702857128572285732857428575285762857728578285792858028581285822858328584285852858628587285882858928590285912859228593285942859528596285972859828599286002860128602286032860428605286062860728608286092861028611286122861328614286152861628617286182861928620286212862228623286242862528626286272862828629286302863128632286332863428635286362863728638286392864028641286422864328644286452864628647286482864928650286512865228653286542865528656286572865828659286602866128662286632866428665286662866728668286692867028671286722867328674286752867628677286782867928680286812868228683286842868528686286872868828689286902869128692286932869428695286962869728698286992870028701287022870328704287052870628707287082870928710287112871228713287142871528716287172871828719287202872128722287232872428725287262872728728287292873028731287322873328734287352873628737287382873928740287412874228743287442874528746287472874828749287502875128752287532875428755287562875728758287592876028761287622876328764287652876628767287682876928770287712877228773287742877528776287772877828779287802878128782287832878428785287862878728788287892879028791287922879328794287952879628797287982879928800288012880228803288042880528806288072880828809288102881128812288132881428815288162881728818288192882028821288222882328824288252882628827288282882928830288312883228833288342883528836288372883828839288402884128842288432884428845288462884728848288492885028851288522885328854288552885628857288582885928860288612886228863288642886528866288672886828869288702887128872288732887428875288762887728878288792888028881288822888328884288852888628887288882888928890288912889228893288942889528896288972889828899289002890128902289032890428905289062890728908289092891028911289122891328914289152891628917289182891928920289212892228923289242892528926289272892828929289302893128932289332893428935289362893728938289392894028941289422894328944289452894628947289482894928950289512895228953289542895528956289572895828959289602896128962289632896428965289662896728968289692897028971289722897328974289752897628977289782897928980289812898228983289842898528986289872898828989289902899128992289932899428995289962899728998289992900029001290022900329004290052900629007290082900929010290112901229013290142901529016290172901829019290202902129022290232902429025290262902729028290292903029031290322903329034290352903629037290382903929040290412904229043290442904529046290472904829049290502905129052290532905429055290562905729058290592906029061290622906329064290652906629067290682906929070290712907229073290742907529076290772907829079290802908129082290832908429085290862908729088290892909029091290922909329094290952909629097290982909929100291012910229103291042910529106291072910829109291102911129112291132911429115291162911729118291192912029121291222912329124291252912629127291282912929130291312913229133291342913529136291372913829139291402914129142291432914429145291462914729148291492915029151291522915329154291552915629157291582915929160291612916229163291642916529166291672916829169291702917129172291732917429175291762917729178291792918029181291822918329184291852918629187291882918929190291912919229193291942919529196291972919829199292002920129202292032920429205292062920729208292092921029211292122921329214292152921629217292182921929220292212922229223292242922529226292272922829229292302923129232292332923429235292362923729238292392924029241292422924329244292452924629247292482924929250292512925229253292542925529256292572925829259292602926129262292632926429265292662926729268292692927029271292722927329274292752927629277292782927929280292812928229283292842928529286292872928829289292902929129292292932929429295292962929729298292992930029301293022930329304293052930629307293082930929310293112931229313293142931529316293172931829319293202932129322293232932429325293262932729328293292933029331293322933329334293352933629337293382933929340293412934229343293442934529346293472934829349293502935129352293532935429355293562935729358293592936029361293622936329364293652936629367293682936929370293712937229373293742937529376293772937829379293802938129382293832938429385293862938729388293892939029391293922939329394293952939629397293982939929400294012940229403294042940529406294072940829409294102941129412294132941429415294162941729418294192942029421294222942329424294252942629427294282942929430294312943229433294342943529436294372943829439294402944129442294432944429445294462944729448294492945029451294522945329454294552945629457294582945929460294612946229463294642946529466294672946829469294702947129472294732947429475294762947729478294792948029481294822948329484294852948629487294882948929490294912949229493294942949529496294972949829499295002950129502295032950429505295062950729508295092951029511295122951329514295152951629517295182951929520295212952229523295242952529526295272952829529295302953129532295332953429535295362953729538295392954029541295422954329544295452954629547295482954929550295512955229553295542955529556295572955829559295602956129562295632956429565295662956729568295692957029571295722957329574295752957629577295782957929580295812958229583295842958529586295872958829589295902959129592295932959429595295962959729598295992960029601296022960329604296052960629607296082960929610296112961229613296142961529616296172961829619296202962129622296232962429625296262962729628296292963029631296322963329634296352963629637296382963929640296412964229643296442964529646296472964829649296502965129652296532965429655296562965729658296592966029661296622966329664296652966629667296682966929670296712967229673296742967529676296772967829679296802968129682296832968429685296862968729688296892969029691296922969329694296952969629697296982969929700297012970229703297042970529706297072970829709297102971129712297132971429715297162971729718297192972029721297222972329724297252972629727297282972929730297312973229733297342973529736297372973829739297402974129742297432974429745297462974729748297492975029751297522975329754297552975629757297582975929760297612976229763297642976529766297672976829769297702977129772297732977429775297762977729778297792978029781297822978329784297852978629787297882978929790297912979229793297942979529796297972979829799298002980129802298032980429805298062980729808298092981029811298122981329814298152981629817298182981929820298212982229823298242982529826298272982829829298302983129832298332983429835298362983729838298392984029841298422984329844298452984629847298482984929850298512985229853298542985529856298572985829859298602986129862298632986429865298662986729868298692987029871298722987329874298752987629877298782987929880298812988229883298842988529886298872988829889298902989129892298932989429895298962989729898298992990029901299022990329904299052990629907299082990929910299112991229913299142991529916299172991829919299202992129922299232992429925299262992729928299292993029931299322993329934299352993629937299382993929940299412994229943299442994529946299472994829949299502995129952299532995429955299562995729958299592996029961299622996329964299652996629967299682996929970299712997229973299742997529976299772997829979299802998129982299832998429985299862998729988299892999029991299922999329994299952999629997299982999930000300013000230003300043000530006300073000830009300103001130012300133001430015300163001730018300193002030021300223002330024300253002630027300283002930030300313003230033300343003530036300373003830039300403004130042300433004430045300463004730048300493005030051300523005330054300553005630057300583005930060300613006230063300643006530066300673006830069300703007130072300733007430075300763007730078300793008030081300823008330084300853008630087300883008930090300913009230093300943009530096300973009830099301003010130102301033010430105301063010730108301093011030111301123011330114301153011630117301183011930120301213012230123301243012530126301273012830129301303013130132301333013430135301363013730138301393014030141301423014330144301453014630147301483014930150301513015230153301543015530156301573015830159301603016130162301633016430165301663016730168301693017030171301723017330174301753017630177301783017930180301813018230183301843018530186301873018830189301903019130192301933019430195301963019730198301993020030201302023020330204302053020630207302083020930210302113021230213302143021530216302173021830219302203022130222302233022430225302263022730228302293023030231302323023330234302353023630237302383023930240302413024230243302443024530246302473024830249302503025130252302533025430255302563025730258302593026030261302623026330264302653026630267302683026930270302713027230273302743027530276302773027830279302803028130282302833028430285302863028730288302893029030291302923029330294302953029630297302983029930300303013030230303303043030530306303073030830309303103031130312303133031430315303163031730318303193032030321303223032330324303253032630327303283032930330303313033230333303343033530336303373033830339303403034130342303433034430345303463034730348303493035030351303523035330354303553035630357303583035930360303613036230363303643036530366303673036830369303703037130372303733037430375303763037730378303793038030381303823038330384303853038630387303883038930390303913039230393303943039530396303973039830399304003040130402304033040430405304063040730408304093041030411304123041330414304153041630417304183041930420304213042230423304243042530426304273042830429304303043130432304333043430435304363043730438304393044030441304423044330444304453044630447304483044930450304513045230453304543045530456304573045830459304603046130462304633046430465304663046730468304693047030471304723047330474304753047630477304783047930480304813048230483304843048530486304873048830489304903049130492304933049430495304963049730498304993050030501305023050330504305053050630507305083050930510305113051230513305143051530516305173051830519305203052130522305233052430525305263052730528305293053030531305323053330534305353053630537305383053930540305413054230543305443054530546305473054830549305503055130552305533055430555305563055730558305593056030561305623056330564305653056630567305683056930570305713057230573305743057530576305773057830579305803058130582305833058430585305863058730588305893059030591305923059330594305953059630597305983059930600306013060230603306043060530606306073060830609306103061130612306133061430615306163061730618306193062030621306223062330624306253062630627306283062930630306313063230633306343063530636306373063830639306403064130642306433064430645306463064730648306493065030651306523065330654306553065630657306583065930660306613066230663306643066530666306673066830669306703067130672306733067430675306763067730678306793068030681306823068330684306853068630687306883068930690306913069230693306943069530696306973069830699307003070130702307033070430705307063070730708307093071030711307123071330714307153071630717307183071930720307213072230723307243072530726307273072830729307303073130732307333073430735307363073730738307393074030741307423074330744307453074630747307483074930750307513075230753307543075530756307573075830759307603076130762307633076430765307663076730768307693077030771307723077330774307753077630777307783077930780307813078230783307843078530786307873078830789307903079130792307933079430795307963079730798307993080030801308023080330804308053080630807308083080930810308113081230813308143081530816308173081830819308203082130822308233082430825308263082730828308293083030831308323083330834308353083630837308383083930840308413084230843308443084530846308473084830849308503085130852308533085430855308563085730858308593086030861308623086330864308653086630867308683086930870308713087230873308743087530876308773087830879308803088130882308833088430885308863088730888308893089030891308923089330894308953089630897308983089930900309013090230903309043090530906309073090830909309103091130912309133091430915309163091730918309193092030921309223092330924309253092630927309283092930930309313093230933309343093530936309373093830939309403094130942309433094430945309463094730948309493095030951309523095330954309553095630957309583095930960309613096230963309643096530966309673096830969309703097130972309733097430975309763097730978309793098030981309823098330984309853098630987309883098930990309913099230993309943099530996309973099830999310003100131002310033100431005310063100731008310093101031011310123101331014310153101631017310183101931020310213102231023310243102531026310273102831029310303103131032310333103431035310363103731038310393104031041310423104331044310453104631047310483104931050310513105231053310543105531056310573105831059310603106131062310633106431065310663106731068310693107031071310723107331074310753107631077310783107931080310813108231083310843108531086310873108831089310903109131092310933109431095310963109731098310993110031101311023110331104311053110631107311083110931110311113111231113311143111531116311173111831119311203112131122311233112431125311263112731128311293113031131311323113331134311353113631137311383113931140311413114231143311443114531146311473114831149311503115131152311533115431155311563115731158311593116031161311623116331164311653116631167311683116931170311713117231173311743117531176311773117831179311803118131182311833118431185311863118731188311893119031191311923119331194311953119631197311983119931200312013120231203312043120531206312073120831209312103121131212312133121431215312163121731218312193122031221312223122331224312253122631227312283122931230312313123231233312343123531236312373123831239312403124131242312433124431245312463124731248312493125031251312523125331254312553125631257312583125931260312613126231263312643126531266312673126831269312703127131272312733127431275312763127731278312793128031281312823128331284312853128631287312883128931290312913129231293312943129531296312973129831299313003130131302313033130431305313063130731308313093131031311313123131331314313153131631317313183131931320313213132231323313243132531326313273132831329313303133131332313333133431335313363133731338313393134031341313423134331344313453134631347313483134931350313513135231353313543135531356313573135831359313603136131362313633136431365313663136731368313693137031371313723137331374313753137631377313783137931380313813138231383313843138531386313873138831389313903139131392313933139431395313963139731398313993140031401314023140331404314053140631407314083140931410314113141231413314143141531416314173141831419314203142131422314233142431425314263142731428314293143031431314323143331434314353143631437314383143931440314413144231443314443144531446314473144831449314503145131452314533145431455314563145731458314593146031461314623146331464314653146631467314683146931470314713147231473314743147531476314773147831479314803148131482314833148431485314863148731488314893149031491314923149331494314953149631497314983149931500315013150231503315043150531506315073150831509315103151131512315133151431515315163151731518315193152031521315223152331524315253152631527315283152931530315313153231533315343153531536315373153831539315403154131542315433154431545315463154731548315493155031551315523155331554315553155631557315583155931560315613156231563315643156531566315673156831569315703157131572315733157431575315763157731578315793158031581315823158331584315853158631587315883158931590315913159231593315943159531596315973159831599316003160131602316033160431605316063160731608316093161031611316123161331614316153161631617316183161931620316213162231623316243162531626316273162831629316303163131632316333163431635316363163731638316393164031641316423164331644316453164631647316483164931650316513165231653316543165531656316573165831659316603166131662316633166431665316663166731668316693167031671316723167331674316753167631677316783167931680316813168231683316843168531686316873168831689316903169131692316933169431695316963169731698316993170031701317023170331704317053170631707317083170931710317113171231713317143171531716317173171831719317203172131722317233172431725317263172731728317293173031731317323173331734317353173631737317383173931740317413174231743317443174531746317473174831749317503175131752317533175431755317563175731758317593176031761317623176331764317653176631767317683176931770317713177231773317743177531776317773177831779317803178131782317833178431785317863178731788317893179031791317923179331794317953179631797317983179931800318013180231803318043180531806318073180831809318103181131812318133181431815318163181731818318193182031821318223182331824318253182631827318283182931830318313183231833318343183531836318373183831839318403184131842318433184431845318463184731848318493185031851318523185331854318553185631857318583185931860318613186231863318643186531866318673186831869318703187131872318733187431875318763187731878318793188031881318823188331884318853188631887318883188931890318913189231893318943189531896318973189831899319003190131902319033190431905319063190731908319093191031911319123191331914319153191631917319183191931920319213192231923319243192531926319273192831929319303193131932319333193431935319363193731938319393194031941319423194331944319453194631947319483194931950319513195231953319543195531956319573195831959319603196131962319633196431965319663196731968319693197031971319723197331974319753197631977319783197931980319813198231983319843198531986319873198831989319903199131992319933199431995319963199731998319993200032001320023200332004320053200632007320083200932010320113201232013320143201532016320173201832019320203202132022320233202432025320263202732028320293203032031320323203332034320353203632037320383203932040320413204232043320443204532046320473204832049320503205132052320533205432055320563205732058320593206032061320623206332064320653206632067320683206932070320713207232073320743207532076320773207832079320803208132082320833208432085320863208732088320893209032091320923209332094320953209632097320983209932100321013210232103321043210532106321073210832109321103211132112321133211432115321163211732118321193212032121321223212332124321253212632127321283212932130321313213232133321343213532136321373213832139321403214132142321433214432145321463214732148321493215032151321523215332154321553215632157321583215932160321613216232163321643216532166321673216832169321703217132172321733217432175321763217732178321793218032181321823218332184321853218632187321883218932190321913219232193321943219532196321973219832199322003220132202322033220432205322063220732208322093221032211322123221332214322153221632217322183221932220322213222232223322243222532226322273222832229322303223132232322333223432235322363223732238322393224032241322423224332244322453224632247322483224932250322513225232253322543225532256322573225832259322603226132262322633226432265322663226732268322693227032271322723227332274322753227632277322783227932280322813228232283322843228532286322873228832289322903229132292322933229432295322963229732298322993230032301323023230332304323053230632307323083230932310323113231232313323143231532316323173231832319323203232132322323233232432325323263232732328323293233032331323323233332334323353233632337323383233932340323413234232343323443234532346323473234832349323503235132352323533235432355323563235732358323593236032361323623236332364323653236632367323683236932370323713237232373323743237532376323773237832379323803238132382323833238432385323863238732388323893239032391323923239332394323953239632397323983239932400324013240232403324043240532406324073240832409324103241132412324133241432415324163241732418324193242032421324223242332424324253242632427324283242932430324313243232433324343243532436324373243832439324403244132442324433244432445324463244732448324493245032451324523245332454324553245632457324583245932460324613246232463324643246532466324673246832469324703247132472324733247432475324763247732478324793248032481324823248332484324853248632487324883248932490324913249232493324943249532496324973249832499325003250132502325033250432505325063250732508325093251032511325123251332514325153251632517325183251932520325213252232523325243252532526325273252832529325303253132532325333253432535325363253732538325393254032541325423254332544325453254632547325483254932550325513255232553325543255532556325573255832559325603256132562325633256432565325663256732568325693257032571325723257332574325753257632577325783257932580325813258232583325843258532586325873258832589325903259132592325933259432595325963259732598325993260032601326023260332604326053260632607326083260932610326113261232613326143261532616326173261832619326203262132622326233262432625326263262732628326293263032631326323263332634326353263632637326383263932640326413264232643326443264532646326473264832649326503265132652326533265432655326563265732658326593266032661326623266332664326653266632667326683266932670326713267232673326743267532676326773267832679326803268132682326833268432685326863268732688326893269032691326923269332694326953269632697326983269932700327013270232703327043270532706327073270832709327103271132712327133271432715327163271732718327193272032721327223272332724327253272632727327283272932730327313273232733327343273532736327373273832739327403274132742327433274432745327463274732748327493275032751327523275332754327553275632757327583275932760327613276232763327643276532766327673276832769327703277132772327733277432775327763277732778327793278032781327823278332784327853278632787327883278932790327913279232793327943279532796327973279832799328003280132802328033280432805328063280732808328093281032811328123281332814328153281632817328183281932820328213282232823328243282532826328273282832829328303283132832328333283432835328363283732838328393284032841328423284332844328453284632847328483284932850328513285232853328543285532856328573285832859328603286132862328633286432865328663286732868328693287032871328723287332874328753287632877328783287932880328813288232883328843288532886328873288832889328903289132892328933289432895328963289732898328993290032901329023290332904329053290632907329083290932910329113291232913329143291532916329173291832919329203292132922329233292432925329263292732928329293293032931329323293332934329353293632937329383293932940329413294232943329443294532946329473294832949329503295132952329533295432955329563295732958329593296032961329623296332964329653296632967329683296932970329713297232973329743297532976329773297832979329803298132982329833298432985329863298732988329893299032991329923299332994329953299632997329983299933000330013300233003330043300533006330073300833009330103301133012330133301433015330163301733018330193302033021330223302333024330253302633027330283302933030330313303233033330343303533036330373303833039330403304133042330433304433045330463304733048330493305033051330523305333054330553305633057330583305933060330613306233063330643306533066330673306833069330703307133072330733307433075330763307733078330793308033081330823308333084330853308633087330883308933090330913309233093330943309533096330973309833099331003310133102331033310433105331063310733108331093311033111331123311333114331153311633117331183311933120331213312233123331243312533126331273312833129331303313133132331333313433135331363313733138331393314033141331423314333144331453314633147331483314933150331513315233153331543315533156331573315833159331603316133162331633316433165331663316733168331693317033171331723317333174331753317633177331783317933180331813318233183331843318533186331873318833189331903319133192331933319433195331963319733198331993320033201332023320333204332053320633207332083320933210332113321233213332143321533216332173321833219332203322133222332233322433225332263322733228332293323033231332323323333234332353323633237332383323933240332413324233243332443324533246332473324833249332503325133252332533325433255332563325733258332593326033261332623326333264332653326633267332683326933270332713327233273332743327533276332773327833279332803328133282332833328433285332863328733288332893329033291332923329333294332953329633297332983329933300333013330233303333043330533306333073330833309333103331133312333133331433315333163331733318333193332033321333223332333324333253332633327333283332933330333313333233333333343333533336333373333833339333403334133342333433334433345333463334733348333493335033351333523335333354333553335633357333583335933360333613336233363333643336533366333673336833369333703337133372333733337433375333763337733378333793338033381333823338333384333853338633387333883338933390333913339233393333943339533396333973339833399334003340133402334033340433405334063340733408334093341033411334123341333414334153341633417334183341933420334213342233423334243342533426334273342833429334303343133432334333343433435334363343733438334393344033441334423344333444334453344633447334483344933450334513345233453334543345533456334573345833459334603346133462334633346433465334663346733468334693347033471334723347333474334753347633477334783347933480334813348233483334843348533486334873348833489334903349133492334933349433495334963349733498334993350033501335023350333504335053350633507335083350933510335113351233513335143351533516335173351833519335203352133522335233352433525335263352733528335293353033531335323353333534335353353633537335383353933540335413354233543335443354533546335473354833549335503355133552335533355433555335563355733558335593356033561335623356333564335653356633567335683356933570335713357233573335743357533576335773357833579335803358133582335833358433585335863358733588335893359033591335923359333594335953359633597335983359933600336013360233603336043360533606336073360833609336103361133612336133361433615336163361733618336193362033621336223362333624336253362633627336283362933630336313363233633336343363533636336373363833639336403364133642336433364433645336463364733648336493365033651336523365333654336553365633657336583365933660336613366233663336643366533666336673366833669336703367133672336733367433675336763367733678336793368033681336823368333684336853368633687336883368933690336913369233693336943369533696336973369833699337003370133702337033370433705337063370733708337093371033711337123371333714337153371633717337183371933720337213372233723337243372533726337273372833729337303373133732337333373433735337363373733738337393374033741337423374333744337453374633747337483374933750337513375233753337543375533756337573375833759337603376133762337633376433765337663376733768337693377033771337723377333774337753377633777337783377933780337813378233783337843378533786337873378833789337903379133792337933379433795337963379733798337993380033801338023380333804338053380633807338083380933810338113381233813338143381533816338173381833819338203382133822338233382433825338263382733828338293383033831338323383333834338353383633837338383383933840338413384233843338443384533846338473384833849338503385133852338533385433855338563385733858338593386033861338623386333864338653386633867338683386933870338713387233873338743387533876338773387833879338803388133882338833388433885338863388733888338893389033891338923389333894338953389633897338983389933900339013390233903339043390533906339073390833909339103391133912339133391433915339163391733918339193392033921339223392333924339253392633927339283392933930339313393233933339343393533936339373393833939339403394133942339433394433945339463394733948339493395033951339523395333954339553395633957339583395933960339613396233963339643396533966339673396833969339703397133972339733397433975339763397733978339793398033981339823398333984339853398633987339883398933990339913399233993339943399533996339973399833999340003400134002340033400434005340063400734008340093401034011340123401334014340153401634017340183401934020340213402234023340243402534026340273402834029340303403134032340333403434035340363403734038340393404034041340423404334044340453404634047340483404934050340513405234053340543405534056340573405834059340603406134062340633406434065340663406734068340693407034071340723407334074340753407634077340783407934080340813408234083340843408534086340873408834089340903409134092340933409434095340963409734098340993410034101341023410334104341053410634107341083410934110341113411234113341143411534116341173411834119341203412134122341233412434125341263412734128341293413034131341323413334134341353413634137341383413934140341413414234143341443414534146341473414834149341503415134152341533415434155341563415734158341593416034161341623416334164341653416634167341683416934170341713417234173341743417534176341773417834179341803418134182341833418434185341863418734188341893419034191341923419334194341953419634197341983419934200342013420234203342043420534206342073420834209342103421134212342133421434215342163421734218342193422034221342223422334224342253422634227342283422934230342313423234233342343423534236342373423834239342403424134242342433424434245342463424734248342493425034251342523425334254342553425634257342583425934260342613426234263342643426534266342673426834269342703427134272342733427434275342763427734278342793428034281342823428334284342853428634287342883428934290342913429234293342943429534296342973429834299343003430134302343033430434305343063430734308343093431034311343123431334314343153431634317343183431934320343213432234323343243432534326343273432834329343303433134332343333433434335343363433734338343393434034341343423434334344343453434634347343483434934350343513435234353343543435534356343573435834359343603436134362343633436434365343663436734368343693437034371343723437334374343753437634377343783437934380343813438234383343843438534386343873438834389343903439134392343933439434395343963439734398343993440034401344023440334404344053440634407344083440934410344113441234413344143441534416344173441834419344203442134422344233442434425344263442734428344293443034431344323443334434344353443634437344383443934440344413444234443344443444534446344473444834449344503445134452344533445434455344563445734458344593446034461344623446334464344653446634467344683446934470344713447234473344743447534476344773447834479344803448134482344833448434485344863448734488344893449034491344923449334494344953449634497344983449934500345013450234503345043450534506345073450834509345103451134512345133451434515345163451734518345193452034521345223452334524345253452634527345283452934530345313453234533345343453534536345373453834539345403454134542345433454434545345463454734548345493455034551345523455334554345553455634557345583455934560345613456234563345643456534566345673456834569345703457134572345733457434575345763457734578345793458034581345823458334584345853458634587345883458934590345913459234593345943459534596345973459834599346003460134602346033460434605346063460734608346093461034611346123461334614346153461634617346183461934620346213462234623346243462534626346273462834629346303463134632346333463434635346363463734638346393464034641346423464334644346453464634647346483464934650346513465234653346543465534656346573465834659346603466134662346633466434665346663466734668346693467034671346723467334674346753467634677346783467934680346813468234683346843468534686346873468834689346903469134692346933469434695346963469734698346993470034701347023470334704347053470634707347083470934710347113471234713347143471534716347173471834719347203472134722347233472434725347263472734728347293473034731347323473334734347353473634737347383473934740347413474234743347443474534746347473474834749347503475134752347533475434755347563475734758347593476034761347623476334764347653476634767347683476934770347713477234773347743477534776347773477834779347803478134782347833478434785347863478734788347893479034791347923479334794347953479634797347983479934800348013480234803348043480534806348073480834809348103481134812348133481434815348163481734818348193482034821348223482334824348253482634827348283482934830348313483234833348343483534836348373483834839348403484134842348433484434845348463484734848348493485034851348523485334854348553485634857348583485934860348613486234863348643486534866348673486834869348703487134872348733487434875348763487734878348793488034881348823488334884348853488634887348883488934890348913489234893348943489534896348973489834899349003490134902349033490434905349063490734908349093491034911349123491334914349153491634917349183491934920349213492234923349243492534926349273492834929349303493134932349333493434935349363493734938349393494034941349423494334944349453494634947349483494934950349513495234953349543495534956349573495834959349603496134962349633496434965349663496734968349693497034971349723497334974349753497634977349783497934980349813498234983349843498534986349873498834989349903499134992349933499434995349963499734998349993500035001350023500335004350053500635007350083500935010350113501235013350143501535016350173501835019350203502135022350233502435025350263502735028350293503035031350323503335034350353503635037350383503935040350413504235043350443504535046350473504835049350503505135052350533505435055350563505735058350593506035061350623506335064350653506635067350683506935070350713507235073350743507535076350773507835079350803508135082350833508435085350863508735088350893509035091350923509335094350953509635097350983509935100351013510235103351043510535106351073510835109351103511135112351133511435115351163511735118351193512035121351223512335124351253512635127351283512935130351313513235133351343513535136351373513835139351403514135142351433514435145351463514735148351493515035151351523515335154351553515635157351583515935160351613516235163351643516535166351673516835169351703517135172351733517435175351763517735178351793518035181351823518335184351853518635187351883518935190351913519235193351943519535196351973519835199352003520135202352033520435205352063520735208352093521035211352123521335214352153521635217352183521935220352213522235223352243522535226352273522835229352303523135232352333523435235352363523735238352393524035241352423524335244352453524635247352483524935250352513525235253352543525535256352573525835259352603526135262352633526435265352663526735268352693527035271352723527335274352753527635277352783527935280352813528235283352843528535286352873528835289352903529135292352933529435295352963529735298352993530035301353023530335304353053530635307353083530935310353113531235313353143531535316353173531835319353203532135322353233532435325353263532735328353293533035331353323533335334353353533635337353383533935340353413534235343353443534535346353473534835349353503535135352353533535435355353563535735358353593536035361353623536335364353653536635367353683536935370353713537235373353743537535376353773537835379353803538135382353833538435385353863538735388353893539035391353923539335394353953539635397353983539935400354013540235403354043540535406354073540835409354103541135412354133541435415354163541735418354193542035421354223542335424354253542635427354283542935430354313543235433354343543535436354373543835439354403544135442354433544435445354463544735448354493545035451354523545335454354553545635457354583545935460354613546235463354643546535466354673546835469354703547135472354733547435475354763547735478354793548035481354823548335484354853548635487354883548935490354913549235493354943549535496354973549835499355003550135502355033550435505355063550735508355093551035511355123551335514355153551635517355183551935520355213552235523355243552535526355273552835529355303553135532355333553435535355363553735538355393554035541355423554335544355453554635547355483554935550355513555235553355543555535556355573555835559355603556135562355633556435565355663556735568355693557035571355723557335574355753557635577355783557935580355813558235583355843558535586355873558835589355903559135592355933559435595355963559735598355993560035601356023560335604356053560635607356083560935610356113561235613356143561535616356173561835619356203562135622356233562435625356263562735628356293563035631356323563335634356353563635637356383563935640356413564235643356443564535646356473564835649356503565135652356533565435655356563565735658356593566035661356623566335664356653566635667356683566935670356713567235673356743567535676356773567835679356803568135682356833568435685356863568735688356893569035691356923569335694356953569635697356983569935700357013570235703357043570535706357073570835709357103571135712357133571435715357163571735718357193572035721357223572335724357253572635727357283572935730357313573235733357343573535736357373573835739357403574135742357433574435745357463574735748357493575035751357523575335754357553575635757357583575935760357613576235763357643576535766357673576835769357703577135772357733577435775357763577735778357793578035781357823578335784357853578635787357883578935790357913579235793357943579535796357973579835799358003580135802358033580435805358063580735808358093581035811358123581335814358153581635817358183581935820358213582235823358243582535826358273582835829358303583135832358333583435835358363583735838358393584035841358423584335844358453584635847358483584935850358513585235853358543585535856358573585835859358603586135862358633586435865358663586735868358693587035871358723587335874358753587635877358783587935880358813588235883358843588535886358873588835889358903589135892358933589435895358963589735898358993590035901359023590335904359053590635907359083590935910359113591235913359143591535916359173591835919359203592135922359233592435925359263592735928359293593035931359323593335934359353593635937359383593935940359413594235943359443594535946359473594835949359503595135952359533595435955359563595735958359593596035961359623596335964359653596635967359683596935970359713597235973359743597535976359773597835979359803598135982359833598435985359863598735988359893599035991359923599335994359953599635997359983599936000360013600236003360043600536006360073600836009360103601136012360133601436015360163601736018360193602036021360223602336024360253602636027360283602936030360313603236033360343603536036360373603836039360403604136042360433604436045360463604736048360493605036051360523605336054360553605636057360583605936060360613606236063360643606536066360673606836069360703607136072360733607436075360763607736078360793608036081360823608336084360853608636087360883608936090360913609236093360943609536096360973609836099361003610136102361033610436105361063610736108361093611036111361123611336114361153611636117361183611936120361213612236123361243612536126361273612836129361303613136132361333613436135361363613736138361393614036141361423614336144361453614636147361483614936150361513615236153361543615536156361573615836159361603616136162361633616436165361663616736168361693617036171361723617336174361753617636177361783617936180361813618236183361843618536186361873618836189361903619136192361933619436195361963619736198361993620036201362023620336204362053620636207362083620936210362113621236213362143621536216362173621836219362203622136222362233622436225362263622736228362293623036231362323623336234362353623636237362383623936240362413624236243362443624536246362473624836249362503625136252362533625436255362563625736258362593626036261362623626336264362653626636267362683626936270362713627236273362743627536276362773627836279362803628136282362833628436285362863628736288362893629036291362923629336294362953629636297362983629936300363013630236303363043630536306363073630836309363103631136312363133631436315363163631736318363193632036321363223632336324363253632636327363283632936330363313633236333363343633536336363373633836339363403634136342363433634436345363463634736348363493635036351363523635336354363553635636357363583635936360363613636236363363643636536366363673636836369363703637136372363733637436375363763637736378363793638036381363823638336384363853638636387363883638936390363913639236393363943639536396363973639836399364003640136402364033640436405364063640736408364093641036411364123641336414364153641636417364183641936420364213642236423364243642536426364273642836429364303643136432364333643436435364363643736438364393644036441364423644336444364453644636447364483644936450364513645236453364543645536456364573645836459364603646136462364633646436465364663646736468364693647036471364723647336474364753647636477364783647936480364813648236483364843648536486364873648836489364903649136492364933649436495364963649736498364993650036501365023650336504365053650636507365083650936510365113651236513365143651536516365173651836519365203652136522365233652436525365263652736528365293653036531365323653336534365353653636537365383653936540365413654236543365443654536546365473654836549365503655136552365533655436555365563655736558365593656036561365623656336564365653656636567365683656936570365713657236573365743657536576365773657836579365803658136582365833658436585365863658736588365893659036591365923659336594365953659636597365983659936600366013660236603366043660536606366073660836609366103661136612366133661436615366163661736618366193662036621366223662336624366253662636627366283662936630366313663236633366343663536636366373663836639366403664136642366433664436645366463664736648366493665036651366523665336654366553665636657366583665936660366613666236663366643666536666366673666836669366703667136672366733667436675366763667736678366793668036681366823668336684366853668636687366883668936690366913669236693366943669536696366973669836699367003670136702367033670436705367063670736708367093671036711367123671336714367153671636717367183671936720367213672236723367243672536726367273672836729367303673136732367333673436735367363673736738367393674036741367423674336744367453674636747367483674936750367513675236753367543675536756367573675836759367603676136762367633676436765367663676736768367693677036771367723677336774367753677636777367783677936780367813678236783367843678536786367873678836789367903679136792367933679436795367963679736798367993680036801368023680336804368053680636807368083680936810368113681236813368143681536816368173681836819368203682136822368233682436825368263682736828368293683036831368323683336834368353683636837368383683936840368413684236843368443684536846368473684836849368503685136852368533685436855368563685736858368593686036861368623686336864368653686636867368683686936870368713687236873368743687536876368773687836879368803688136882368833688436885368863688736888368893689036891368923689336894368953689636897368983689936900369013690236903369043690536906369073690836909369103691136912369133691436915369163691736918369193692036921369223692336924369253692636927369283692936930369313693236933369343693536936369373693836939369403694136942369433694436945369463694736948369493695036951369523695336954369553695636957369583695936960369613696236963369643696536966369673696836969369703697136972369733697436975369763697736978369793698036981369823698336984369853698636987369883698936990369913699236993369943699536996369973699836999370003700137002370033700437005370063700737008370093701037011370123701337014370153701637017370183701937020370213702237023370243702537026370273702837029370303703137032370333703437035370363703737038370393704037041370423704337044370453704637047370483704937050370513705237053370543705537056370573705837059370603706137062370633706437065370663706737068370693707037071370723707337074370753707637077370783707937080370813708237083370843708537086370873708837089370903709137092370933709437095370963709737098370993710037101371023710337104371053710637107371083710937110371113711237113371143711537116371173711837119371203712137122371233712437125371263712737128371293713037131371323713337134371353713637137371383713937140371413714237143371443714537146371473714837149371503715137152371533715437155371563715737158371593716037161371623716337164371653716637167371683716937170371713717237173371743717537176371773717837179371803718137182371833718437185371863718737188371893719037191371923719337194371953719637197371983719937200372013720237203372043720537206372073720837209372103721137212372133721437215372163721737218372193722037221372223722337224372253722637227372283722937230372313723237233372343723537236372373723837239372403724137242372433724437245372463724737248372493725037251372523725337254372553725637257372583725937260372613726237263372643726537266372673726837269372703727137272372733727437275372763727737278372793728037281372823728337284372853728637287372883728937290372913729237293372943729537296372973729837299373003730137302373033730437305373063730737308373093731037311373123731337314373153731637317373183731937320373213732237323373243732537326373273732837329373303733137332373333733437335373363733737338373393734037341373423734337344373453734637347373483734937350373513735237353373543735537356373573735837359373603736137362373633736437365373663736737368373693737037371373723737337374373753737637377373783737937380373813738237383373843738537386373873738837389373903739137392373933739437395373963739737398373993740037401374023740337404374053740637407374083740937410374113741237413374143741537416374173741837419374203742137422374233742437425374263742737428374293743037431374323743337434374353743637437374383743937440374413744237443374443744537446374473744837449374503745137452374533745437455374563745737458374593746037461374623746337464374653746637467374683746937470374713747237473374743747537476374773747837479374803748137482374833748437485374863748737488374893749037491374923749337494374953749637497374983749937500375013750237503375043750537506375073750837509375103751137512375133751437515375163751737518375193752037521375223752337524375253752637527375283752937530375313753237533375343753537536375373753837539375403754137542375433754437545375463754737548375493755037551375523755337554375553755637557375583755937560375613756237563375643756537566375673756837569375703757137572375733757437575375763757737578375793758037581375823758337584375853758637587375883758937590375913759237593375943759537596375973759837599376003760137602376033760437605376063760737608376093761037611376123761337614376153761637617376183761937620376213762237623376243762537626376273762837629376303763137632376333763437635376363763737638376393764037641376423764337644376453764637647376483764937650376513765237653376543765537656376573765837659376603766137662376633766437665376663766737668376693767037671376723767337674376753767637677376783767937680376813768237683376843768537686376873768837689376903769137692376933769437695376963769737698376993770037701377023770337704377053770637707377083770937710377113771237713377143771537716377173771837719377203772137722377233772437725377263772737728377293773037731377323773337734377353773637737377383773937740377413774237743377443774537746377473774837749377503775137752377533775437755377563775737758377593776037761377623776337764377653776637767377683776937770377713777237773377743777537776377773777837779377803778137782377833778437785377863778737788377893779037791377923779337794377953779637797377983779937800378013780237803378043780537806378073780837809378103781137812378133781437815378163781737818378193782037821378223782337824378253782637827378283782937830378313783237833378343783537836378373783837839378403784137842378433784437845378463784737848378493785037851378523785337854378553785637857378583785937860378613786237863378643786537866378673786837869378703787137872378733787437875378763787737878378793788037881378823788337884378853788637887378883788937890378913789237893378943789537896378973789837899379003790137902379033790437905379063790737908379093791037911379123791337914379153791637917379183791937920379213792237923379243792537926379273792837929379303793137932379333793437935379363793737938379393794037941379423794337944379453794637947379483794937950379513795237953379543795537956379573795837959379603796137962379633796437965379663796737968379693797037971379723797337974379753797637977379783797937980379813798237983379843798537986379873798837989379903799137992379933799437995379963799737998379993800038001380023800338004380053800638007380083800938010380113801238013380143801538016380173801838019380203802138022380233802438025380263802738028380293803038031380323803338034380353803638037380383803938040380413804238043380443804538046380473804838049380503805138052380533805438055380563805738058380593806038061380623806338064380653806638067380683806938070380713807238073380743807538076380773807838079380803808138082380833808438085380863808738088380893809038091380923809338094380953809638097380983809938100381013810238103381043810538106381073810838109381103811138112381133811438115381163811738118381193812038121381223812338124381253812638127381283812938130381313813238133381343813538136381373813838139381403814138142381433814438145381463814738148381493815038151381523815338154381553815638157381583815938160381613816238163381643816538166381673816838169381703817138172381733817438175381763817738178381793818038181381823818338184381853818638187381883818938190381913819238193381943819538196381973819838199382003820138202382033820438205382063820738208382093821038211382123821338214382153821638217382183821938220382213822238223382243822538226382273822838229382303823138232382333823438235382363823738238382393824038241382423824338244382453824638247382483824938250382513825238253382543825538256382573825838259382603826138262382633826438265382663826738268382693827038271382723827338274382753827638277382783827938280382813828238283382843828538286382873828838289382903829138292382933829438295382963829738298382993830038301383023830338304383053830638307383083830938310383113831238313383143831538316383173831838319383203832138322383233832438325383263832738328383293833038331383323833338334383353833638337383383833938340383413834238343383443834538346383473834838349383503835138352383533835438355383563835738358383593836038361383623836338364383653836638367383683836938370383713837238373383743837538376383773837838379383803838138382383833838438385383863838738388383893839038391383923839338394383953839638397383983839938400384013840238403384043840538406384073840838409384103841138412384133841438415384163841738418384193842038421384223842338424384253842638427384283842938430384313843238433384343843538436384373843838439384403844138442384433844438445384463844738448384493845038451384523845338454384553845638457384583845938460384613846238463384643846538466384673846838469384703847138472384733847438475384763847738478384793848038481384823848338484384853848638487384883848938490384913849238493384943849538496384973849838499385003850138502385033850438505385063850738508385093851038511385123851338514385153851638517385183851938520385213852238523385243852538526385273852838529385303853138532385333853438535385363853738538385393854038541385423854338544385453854638547385483854938550385513855238553385543855538556385573855838559385603856138562385633856438565385663856738568385693857038571385723857338574385753857638577385783857938580385813858238583385843858538586385873858838589385903859138592385933859438595385963859738598385993860038601386023860338604386053860638607386083860938610386113861238613386143861538616386173861838619386203862138622386233862438625386263862738628386293863038631386323863338634386353863638637386383863938640386413864238643386443864538646386473864838649386503865138652386533865438655386563865738658386593866038661386623866338664386653866638667386683866938670386713867238673386743867538676386773867838679386803868138682386833868438685386863868738688386893869038691386923869338694386953869638697386983869938700387013870238703387043870538706387073870838709387103871138712387133871438715387163871738718387193872038721387223872338724387253872638727387283872938730387313873238733387343873538736387373873838739387403874138742387433874438745387463874738748387493875038751387523875338754387553875638757387583875938760387613876238763387643876538766387673876838769387703877138772387733877438775387763877738778387793878038781387823878338784387853878638787387883878938790387913879238793387943879538796387973879838799388003880138802388033880438805388063880738808388093881038811388123881338814388153881638817388183881938820388213882238823388243882538826388273882838829388303883138832388333883438835388363883738838388393884038841388423884338844388453884638847388483884938850388513885238853388543885538856388573885838859388603886138862388633886438865388663886738868388693887038871388723887338874388753887638877388783887938880388813888238883388843888538886388873888838889388903889138892388933889438895388963889738898388993890038901389023890338904389053890638907389083890938910389113891238913389143891538916389173891838919389203892138922389233892438925389263892738928389293893038931389323893338934389353893638937389383893938940389413894238943389443894538946389473894838949389503895138952389533895438955389563895738958389593896038961389623896338964389653896638967389683896938970389713897238973389743897538976389773897838979389803898138982389833898438985389863898738988389893899038991389923899338994389953899638997389983899939000390013900239003390043900539006390073900839009390103901139012390133901439015390163901739018390193902039021390223902339024390253902639027390283902939030390313903239033390343903539036390373903839039390403904139042390433904439045390463904739048390493905039051390523905339054390553905639057390583905939060390613906239063390643906539066390673906839069390703907139072390733907439075390763907739078390793908039081390823908339084390853908639087390883908939090390913909239093390943909539096390973909839099391003910139102391033910439105391063910739108391093911039111391123911339114391153911639117391183911939120391213912239123391243912539126391273912839129391303913139132391333913439135391363913739138391393914039141391423914339144391453914639147391483914939150391513915239153391543915539156391573915839159391603916139162391633916439165391663916739168391693917039171391723917339174391753917639177391783917939180391813918239183391843918539186391873918839189391903919139192391933919439195391963919739198391993920039201392023920339204392053920639207392083920939210392113921239213392143921539216392173921839219392203922139222392233922439225392263922739228392293923039231392323923339234392353923639237392383923939240392413924239243392443924539246392473924839249392503925139252392533925439255392563925739258392593926039261392623926339264392653926639267392683926939270392713927239273392743927539276392773927839279392803928139282392833928439285392863928739288392893929039291392923929339294392953929639297392983929939300393013930239303393043930539306393073930839309393103931139312393133931439315393163931739318393193932039321393223932339324393253932639327393283932939330393313933239333393343933539336393373933839339393403934139342393433934439345393463934739348393493935039351393523935339354393553935639357393583935939360393613936239363393643936539366393673936839369393703937139372393733937439375393763937739378393793938039381393823938339384393853938639387393883938939390393913939239393393943939539396393973939839399394003940139402394033940439405394063940739408394093941039411394123941339414394153941639417394183941939420394213942239423394243942539426394273942839429394303943139432394333943439435394363943739438394393944039441394423944339444394453944639447394483944939450394513945239453394543945539456394573945839459394603946139462394633946439465394663946739468394693947039471394723947339474394753947639477394783947939480394813948239483394843948539486394873948839489394903949139492394933949439495394963949739498394993950039501395023950339504395053950639507395083950939510395113951239513395143951539516395173951839519395203952139522395233952439525395263952739528395293953039531395323953339534395353953639537395383953939540395413954239543395443954539546395473954839549395503955139552395533955439555395563955739558395593956039561395623956339564395653956639567395683956939570395713957239573395743957539576395773957839579395803958139582395833958439585395863958739588395893959039591395923959339594395953959639597395983959939600396013960239603396043960539606396073960839609396103961139612396133961439615396163961739618396193962039621396223962339624396253962639627396283962939630396313963239633396343963539636396373963839639396403964139642396433964439645396463964739648396493965039651396523965339654396553965639657396583965939660396613966239663396643966539666396673966839669396703967139672396733967439675396763967739678396793968039681396823968339684396853968639687396883968939690396913969239693396943969539696396973969839699397003970139702397033970439705397063970739708397093971039711397123971339714397153971639717397183971939720397213972239723397243972539726397273972839729397303973139732397333973439735397363973739738397393974039741397423974339744397453974639747397483974939750397513975239753397543975539756397573975839759397603976139762397633976439765397663976739768397693977039771397723977339774397753977639777397783977939780397813978239783397843978539786397873978839789397903979139792397933979439795397963979739798397993980039801398023980339804398053980639807398083980939810398113981239813398143981539816398173981839819398203982139822398233982439825398263982739828398293983039831398323983339834398353983639837398383983939840398413984239843398443984539846398473984839849398503985139852398533985439855398563985739858398593986039861398623986339864398653986639867398683986939870398713987239873398743987539876398773987839879398803988139882398833988439885398863988739888398893989039891398923989339894398953989639897398983989939900399013990239903399043990539906399073990839909399103991139912399133991439915399163991739918399193992039921399223992339924399253992639927399283992939930399313993239933399343993539936399373993839939399403994139942399433994439945399463994739948399493995039951399523995339954399553995639957399583995939960399613996239963399643996539966399673996839969399703997139972399733997439975399763997739978399793998039981399823998339984399853998639987399883998939990399913999239993399943999539996399973999839999400004000140002400034000440005400064000740008400094001040011400124001340014400154001640017400184001940020400214002240023400244002540026400274002840029400304003140032400334003440035400364003740038400394004040041400424004340044400454004640047400484004940050400514005240053400544005540056400574005840059400604006140062400634006440065400664006740068400694007040071400724007340074400754007640077400784007940080400814008240083400844008540086400874008840089400904009140092400934009440095400964009740098400994010040101401024010340104401054010640107401084010940110401114011240113401144011540116401174011840119401204012140122401234012440125401264012740128401294013040131401324013340134401354013640137401384013940140401414014240143401444014540146401474014840149401504015140152401534015440155401564015740158401594016040161401624016340164401654016640167401684016940170401714017240173401744017540176401774017840179401804018140182401834018440185401864018740188401894019040191401924019340194401954019640197401984019940200402014020240203402044020540206402074020840209402104021140212402134021440215402164021740218402194022040221402224022340224402254022640227402284022940230402314023240233402344023540236402374023840239402404024140242402434024440245402464024740248402494025040251402524025340254402554025640257402584025940260402614026240263402644026540266402674026840269402704027140272402734027440275402764027740278402794028040281402824028340284402854028640287402884028940290402914029240293402944029540296402974029840299403004030140302403034030440305403064030740308403094031040311403124031340314403154031640317403184031940320403214032240323403244032540326403274032840329403304033140332403334033440335403364033740338403394034040341403424034340344403454034640347403484034940350403514035240353403544035540356403574035840359403604036140362403634036440365403664036740368403694037040371403724037340374403754037640377403784037940380403814038240383403844038540386403874038840389403904039140392403934039440395403964039740398403994040040401404024040340404404054040640407404084040940410404114041240413404144041540416404174041840419404204042140422404234042440425404264042740428404294043040431404324043340434404354043640437404384043940440404414044240443404444044540446404474044840449404504045140452404534045440455404564045740458404594046040461404624046340464404654046640467404684046940470404714047240473404744047540476404774047840479404804048140482404834048440485404864048740488404894049040491404924049340494404954049640497404984049940500405014050240503405044050540506405074050840509405104051140512405134051440515405164051740518405194052040521405224052340524405254052640527405284052940530405314053240533405344053540536405374053840539405404054140542405434054440545405464054740548405494055040551405524055340554405554055640557405584055940560405614056240563405644056540566405674056840569405704057140572405734057440575405764057740578405794058040581405824058340584405854058640587405884058940590405914059240593405944059540596405974059840599406004060140602406034060440605406064060740608406094061040611406124061340614406154061640617406184061940620406214062240623406244062540626406274062840629406304063140632406334063440635406364063740638406394064040641406424064340644406454064640647406484064940650406514065240653406544065540656406574065840659406604066140662406634066440665406664066740668406694067040671406724067340674406754067640677406784067940680406814068240683406844068540686406874068840689406904069140692406934069440695406964069740698406994070040701407024070340704407054070640707407084070940710407114071240713407144071540716407174071840719407204072140722407234072440725407264072740728407294073040731407324073340734407354073640737407384073940740407414074240743407444074540746407474074840749407504075140752407534075440755407564075740758407594076040761407624076340764407654076640767407684076940770407714077240773407744077540776407774077840779407804078140782407834078440785407864078740788407894079040791407924079340794407954079640797407984079940800408014080240803408044080540806408074080840809408104081140812408134081440815408164081740818408194082040821408224082340824408254082640827408284082940830408314083240833408344083540836408374083840839408404084140842408434084440845408464084740848408494085040851408524085340854408554085640857408584085940860408614086240863408644086540866408674086840869408704087140872408734087440875408764087740878408794088040881408824088340884408854088640887408884088940890408914089240893408944089540896408974089840899409004090140902409034090440905409064090740908409094091040911409124091340914409154091640917409184091940920409214092240923409244092540926409274092840929409304093140932409334093440935409364093740938409394094040941409424094340944409454094640947409484094940950409514095240953409544095540956409574095840959409604096140962409634096440965409664096740968409694097040971409724097340974409754097640977409784097940980409814098240983409844098540986409874098840989409904099140992409934099440995409964099740998409994100041001410024100341004410054100641007410084100941010410114101241013410144101541016410174101841019410204102141022410234102441025410264102741028410294103041031410324103341034410354103641037410384103941040410414104241043410444104541046410474104841049410504105141052410534105441055410564105741058410594106041061410624106341064410654106641067410684106941070410714107241073410744107541076410774107841079410804108141082410834108441085410864108741088410894109041091410924109341094410954109641097410984109941100411014110241103411044110541106411074110841109411104111141112411134111441115411164111741118411194112041121411224112341124411254112641127411284112941130411314113241133411344113541136411374113841139411404114141142411434114441145411464114741148411494115041151411524115341154411554115641157411584115941160411614116241163411644116541166411674116841169411704117141172411734117441175411764117741178411794118041181411824118341184411854118641187411884118941190411914119241193411944119541196411974119841199412004120141202412034120441205412064120741208412094121041211412124121341214412154121641217412184121941220412214122241223412244122541226412274122841229412304123141232412334123441235412364123741238412394124041241412424124341244412454124641247412484124941250412514125241253412544125541256412574125841259412604126141262412634126441265412664126741268412694127041271412724127341274412754127641277412784127941280412814128241283412844128541286412874128841289412904129141292412934129441295412964129741298412994130041301413024130341304413054130641307413084130941310413114131241313413144131541316413174131841319413204132141322413234132441325413264132741328413294133041331413324133341334413354133641337413384133941340413414134241343413444134541346413474134841349413504135141352413534135441355413564135741358413594136041361413624136341364413654136641367413684136941370413714137241373413744137541376413774137841379413804138141382413834138441385413864138741388413894139041391413924139341394413954139641397413984139941400414014140241403414044140541406414074140841409414104141141412414134141441415414164141741418414194142041421414224142341424414254142641427414284142941430414314143241433414344143541436414374143841439414404144141442414434144441445414464144741448414494145041451414524145341454414554145641457414584145941460414614146241463414644146541466414674146841469414704147141472414734147441475414764147741478414794148041481414824148341484414854148641487414884148941490414914149241493414944149541496414974149841499415004150141502415034150441505415064150741508415094151041511415124151341514415154151641517415184151941520415214152241523415244152541526415274152841529415304153141532415334153441535415364153741538415394154041541415424154341544415454154641547415484154941550415514155241553415544155541556415574155841559415604156141562415634156441565415664156741568415694157041571415724157341574415754157641577415784157941580415814158241583415844158541586415874158841589415904159141592415934159441595415964159741598415994160041601416024160341604416054160641607416084160941610416114161241613416144161541616416174161841619416204162141622416234162441625416264162741628416294163041631416324163341634416354163641637416384163941640416414164241643416444164541646416474164841649416504165141652416534165441655416564165741658416594166041661416624166341664416654166641667416684166941670416714167241673416744167541676416774167841679416804168141682416834168441685416864168741688416894169041691416924169341694416954169641697416984169941700417014170241703417044170541706417074170841709417104171141712417134171441715417164171741718417194172041721417224172341724417254172641727417284172941730417314173241733417344173541736417374173841739417404174141742417434174441745417464174741748417494175041751417524175341754417554175641757417584175941760417614176241763417644176541766417674176841769417704177141772417734177441775417764177741778417794178041781417824178341784417854178641787417884178941790417914179241793417944179541796417974179841799418004180141802418034180441805418064180741808418094181041811418124181341814418154181641817418184181941820418214182241823418244182541826418274182841829418304183141832418334183441835418364183741838418394184041841418424184341844418454184641847418484184941850418514185241853418544185541856418574185841859418604186141862418634186441865418664186741868418694187041871418724187341874418754187641877418784187941880418814188241883418844188541886418874188841889418904189141892418934189441895418964189741898418994190041901419024190341904419054190641907419084190941910419114191241913419144191541916419174191841919419204192141922419234192441925419264192741928419294193041931419324193341934419354193641937419384193941940419414194241943419444194541946419474194841949419504195141952419534195441955419564195741958419594196041961419624196341964419654196641967419684196941970419714197241973419744197541976419774197841979419804198141982419834198441985419864198741988419894199041991419924199341994419954199641997419984199942000420014200242003420044200542006420074200842009420104201142012420134201442015420164201742018420194202042021420224202342024420254202642027420284202942030420314203242033420344203542036420374203842039420404204142042420434204442045420464204742048420494205042051420524205342054420554205642057420584205942060420614206242063420644206542066420674206842069420704207142072420734207442075420764207742078420794208042081420824208342084420854208642087420884208942090420914209242093420944209542096420974209842099421004210142102421034210442105421064210742108421094211042111421124211342114421154211642117421184211942120421214212242123421244212542126421274212842129421304213142132421334213442135421364213742138421394214042141421424214342144421454214642147421484214942150421514215242153421544215542156421574215842159421604216142162421634216442165421664216742168421694217042171421724217342174421754217642177421784217942180421814218242183421844218542186421874218842189421904219142192421934219442195421964219742198421994220042201422024220342204422054220642207422084220942210422114221242213422144221542216422174221842219422204222142222422234222442225422264222742228422294223042231422324223342234422354223642237422384223942240422414224242243422444224542246422474224842249422504225142252422534225442255422564225742258422594226042261422624226342264422654226642267422684226942270422714227242273422744227542276422774227842279422804228142282422834228442285422864228742288422894229042291422924229342294422954229642297422984229942300423014230242303423044230542306423074230842309423104231142312423134231442315423164231742318423194232042321423224232342324423254232642327423284232942330423314233242333423344233542336423374233842339423404234142342423434234442345423464234742348423494235042351423524235342354423554235642357423584235942360423614236242363423644236542366423674236842369423704237142372423734237442375423764237742378423794238042381423824238342384423854238642387423884238942390423914239242393423944239542396423974239842399424004240142402424034240442405424064240742408424094241042411424124241342414424154241642417424184241942420424214242242423424244242542426424274242842429424304243142432424334243442435424364243742438424394244042441424424244342444424454244642447424484244942450424514245242453424544245542456424574245842459424604246142462424634246442465424664246742468424694247042471424724247342474424754247642477424784247942480424814248242483424844248542486424874248842489424904249142492424934249442495424964249742498424994250042501425024250342504425054250642507425084250942510425114251242513425144251542516425174251842519425204252142522425234252442525425264252742528425294253042531425324253342534425354253642537425384253942540425414254242543425444254542546425474254842549425504255142552425534255442555425564255742558425594256042561425624256342564425654256642567425684256942570425714257242573425744257542576425774257842579425804258142582425834258442585425864258742588425894259042591425924259342594425954259642597425984259942600426014260242603426044260542606426074260842609426104261142612426134261442615426164261742618426194262042621426224262342624426254262642627426284262942630426314263242633426344263542636426374263842639426404264142642426434264442645426464264742648426494265042651426524265342654426554265642657426584265942660426614266242663426644266542666426674266842669426704267142672426734267442675426764267742678426794268042681426824268342684426854268642687426884268942690426914269242693426944269542696426974269842699427004270142702427034270442705427064270742708427094271042711427124271342714427154271642717427184271942720427214272242723427244272542726427274272842729427304273142732427334273442735427364273742738427394274042741427424274342744427454274642747427484274942750427514275242753427544275542756427574275842759427604276142762427634276442765427664276742768427694277042771427724277342774427754277642777427784277942780427814278242783427844278542786427874278842789427904279142792427934279442795427964279742798427994280042801428024280342804428054280642807428084280942810428114281242813428144281542816428174281842819428204282142822428234282442825428264282742828428294283042831428324283342834428354283642837428384283942840428414284242843428444284542846428474284842849428504285142852428534285442855428564285742858428594286042861428624286342864428654286642867428684286942870428714287242873428744287542876428774287842879428804288142882428834288442885428864288742888428894289042891428924289342894428954289642897428984289942900429014290242903429044290542906429074290842909429104291142912429134291442915429164291742918429194292042921429224292342924429254292642927429284292942930429314293242933429344293542936429374293842939429404294142942429434294442945429464294742948429494295042951429524295342954429554295642957429584295942960429614296242963429644296542966429674296842969429704297142972429734297442975429764297742978429794298042981429824298342984429854298642987429884298942990429914299242993429944299542996429974299842999430004300143002430034300443005430064300743008430094301043011430124301343014430154301643017430184301943020430214302243023430244302543026430274302843029430304303143032430334303443035430364303743038430394304043041430424304343044430454304643047430484304943050430514305243053430544305543056430574305843059430604306143062430634306443065430664306743068430694307043071430724307343074430754307643077430784307943080430814308243083430844308543086430874308843089430904309143092430934309443095430964309743098430994310043101431024310343104431054310643107431084310943110431114311243113431144311543116431174311843119431204312143122431234312443125431264312743128431294313043131431324313343134431354313643137431384313943140431414314243143431444314543146431474314843149431504315143152431534315443155431564315743158431594316043161431624316343164431654316643167431684316943170431714317243173431744317543176431774317843179431804318143182431834318443185431864318743188431894319043191431924319343194431954319643197431984319943200432014320243203432044320543206432074320843209432104321143212432134321443215432164321743218432194322043221432224322343224432254322643227432284322943230432314323243233432344323543236432374323843239432404324143242432434324443245432464324743248432494325043251432524325343254432554325643257432584325943260432614326243263432644326543266432674326843269432704327143272432734327443275432764327743278432794328043281432824328343284432854328643287432884328943290432914329243293432944329543296432974329843299433004330143302433034330443305433064330743308433094331043311433124331343314433154331643317433184331943320433214332243323433244332543326433274332843329433304333143332433334333443335433364333743338433394334043341433424334343344433454334643347433484334943350433514335243353433544335543356433574335843359433604336143362433634336443365433664336743368433694337043371433724337343374433754337643377433784337943380433814338243383433844338543386433874338843389433904339143392433934339443395433964339743398433994340043401434024340343404434054340643407434084340943410434114341243413434144341543416434174341843419434204342143422434234342443425434264342743428434294343043431434324343343434434354343643437434384343943440434414344243443434444344543446434474344843449434504345143452434534345443455434564345743458434594346043461434624346343464434654346643467434684346943470434714347243473434744347543476434774347843479434804348143482434834348443485434864348743488434894349043491434924349343494434954349643497434984349943500435014350243503435044350543506435074350843509435104351143512435134351443515435164351743518435194352043521435224352343524435254352643527435284352943530435314353243533435344353543536435374353843539435404354143542435434354443545435464354743548435494355043551435524355343554435554355643557435584355943560435614356243563435644356543566435674356843569435704357143572435734357443575435764357743578435794358043581435824358343584435854358643587435884358943590435914359243593435944359543596435974359843599436004360143602436034360443605436064360743608436094361043611436124361343614436154361643617436184361943620436214362243623436244362543626436274362843629436304363143632436334363443635436364363743638436394364043641436424364343644436454364643647436484364943650436514365243653436544365543656436574365843659436604366143662436634366443665436664366743668436694367043671436724367343674436754367643677436784367943680436814368243683436844368543686436874368843689436904369143692436934369443695436964369743698436994370043701437024370343704437054370643707437084370943710437114371243713437144371543716437174371843719437204372143722437234372443725437264372743728437294373043731437324373343734437354373643737437384373943740437414374243743437444374543746437474374843749437504375143752437534375443755437564375743758437594376043761437624376343764437654376643767437684376943770437714377243773437744377543776437774377843779437804378143782437834378443785437864378743788437894379043791437924379343794437954379643797437984379943800438014380243803438044380543806438074380843809438104381143812438134381443815438164381743818438194382043821438224382343824438254382643827438284382943830438314383243833438344383543836438374383843839438404384143842438434384443845438464384743848438494385043851438524385343854438554385643857438584385943860438614386243863438644386543866438674386843869438704387143872438734387443875438764387743878438794388043881438824388343884438854388643887438884388943890438914389243893438944389543896438974389843899439004390143902439034390443905439064390743908439094391043911439124391343914439154391643917439184391943920439214392243923439244392543926439274392843929439304393143932439334393443935439364393743938439394394043941439424394343944439454394643947439484394943950439514395243953439544395543956439574395843959439604396143962439634396443965439664396743968439694397043971439724397343974439754397643977439784397943980439814398243983439844398543986439874398843989439904399143992439934399443995439964399743998439994400044001440024400344004440054400644007440084400944010440114401244013440144401544016440174401844019440204402144022440234402444025440264402744028440294403044031440324403344034440354403644037440384403944040440414404244043440444404544046440474404844049440504405144052440534405444055440564405744058440594406044061440624406344064440654406644067440684406944070440714407244073440744407544076440774407844079440804408144082440834408444085440864408744088440894409044091440924409344094440954409644097440984409944100441014410244103441044410544106441074410844109441104411144112441134411444115441164411744118441194412044121441224412344124441254412644127441284412944130441314413244133441344413544136441374413844139441404414144142441434414444145441464414744148441494415044151441524415344154441554415644157441584415944160441614416244163441644416544166441674416844169441704417144172441734417444175441764417744178441794418044181441824418344184441854418644187441884418944190441914419244193441944419544196441974419844199442004420144202442034420444205442064420744208442094421044211442124421344214442154421644217442184421944220442214422244223442244422544226442274422844229442304423144232442334423444235442364423744238442394424044241442424424344244442454424644247442484424944250442514425244253442544425544256442574425844259442604426144262442634426444265442664426744268442694427044271442724427344274442754427644277442784427944280442814428244283442844428544286442874428844289442904429144292442934429444295442964429744298442994430044301443024430344304443054430644307443084430944310443114431244313443144431544316443174431844319443204432144322443234432444325443264432744328443294433044331443324433344334443354433644337443384433944340443414434244343443444434544346443474434844349443504435144352443534435444355443564435744358443594436044361443624436344364443654436644367443684436944370443714437244373443744437544376443774437844379443804438144382443834438444385443864438744388443894439044391443924439344394443954439644397443984439944400444014440244403444044440544406444074440844409444104441144412444134441444415444164441744418444194442044421444224442344424444254442644427444284442944430444314443244433444344443544436444374443844439444404444144442444434444444445444464444744448444494445044451444524445344454444554445644457444584445944460444614446244463444644446544466444674446844469444704447144472444734447444475444764447744478444794448044481444824448344484444854448644487444884448944490444914449244493444944449544496444974449844499445004450144502445034450444505445064450744508445094451044511445124451344514445154451644517445184451944520445214452244523445244452544526445274452844529445304453144532445334453444535445364453744538445394454044541445424454344544445454454644547445484454944550445514455244553445544455544556445574455844559445604456144562445634456444565445664456744568445694457044571445724457344574445754457644577445784457944580445814458244583445844458544586445874458844589445904459144592445934459444595445964459744598445994460044601446024460344604446054460644607446084460944610446114461244613446144461544616446174461844619446204462144622446234462444625446264462744628446294463044631446324463344634446354463644637446384463944640446414464244643446444464544646446474464844649446504465144652446534465444655446564465744658446594466044661446624466344664446654466644667446684466944670446714467244673446744467544676446774467844679446804468144682446834468444685446864468744688446894469044691446924469344694446954469644697446984469944700447014470244703447044470544706447074470844709447104471144712447134471444715447164471744718447194472044721447224472344724447254472644727447284472944730447314473244733447344473544736447374473844739447404474144742447434474444745447464474744748447494475044751447524475344754447554475644757447584475944760447614476244763447644476544766447674476844769447704477144772447734477444775447764477744778447794478044781447824478344784447854478644787447884478944790447914479244793447944479544796447974479844799448004480144802448034480444805448064480744808448094481044811448124481344814448154481644817448184481944820448214482244823448244482544826448274482844829448304483144832448334483444835448364483744838448394484044841448424484344844448454484644847448484484944850448514485244853448544485544856448574485844859448604486144862448634486444865448664486744868448694487044871448724487344874448754487644877448784487944880448814488244883448844488544886448874488844889448904489144892448934489444895448964489744898448994490044901449024490344904449054490644907449084490944910449114491244913449144491544916449174491844919449204492144922449234492444925449264492744928449294493044931449324493344934449354493644937449384493944940449414494244943449444494544946449474494844949449504495144952449534495444955449564495744958449594496044961449624496344964449654496644967449684496944970449714497244973449744497544976449774497844979449804498144982449834498444985449864498744988449894499044991449924499344994449954499644997449984499945000450014500245003450044500545006450074500845009450104501145012450134501445015450164501745018450194502045021450224502345024450254502645027450284502945030450314503245033450344503545036450374503845039450404504145042450434504445045450464504745048450494505045051450524505345054450554505645057450584505945060450614506245063450644506545066450674506845069450704507145072450734507445075450764507745078450794508045081450824508345084450854508645087450884508945090450914509245093450944509545096450974509845099451004510145102451034510445105451064510745108451094511045111451124511345114451154511645117451184511945120451214512245123451244512545126451274512845129451304513145132451334513445135451364513745138451394514045141451424514345144451454514645147451484514945150451514515245153451544515545156451574515845159451604516145162451634516445165451664516745168451694517045171451724517345174451754517645177451784517945180451814518245183451844518545186451874518845189451904519145192451934519445195451964519745198451994520045201452024520345204452054520645207452084520945210452114521245213452144521545216452174521845219452204522145222452234522445225452264522745228452294523045231452324523345234452354523645237452384523945240452414524245243452444524545246452474524845249452504525145252452534525445255452564525745258452594526045261452624526345264452654526645267452684526945270452714527245273452744527545276452774527845279452804528145282452834528445285452864528745288452894529045291452924529345294452954529645297452984529945300453014530245303453044530545306453074530845309453104531145312453134531445315453164531745318453194532045321453224532345324453254532645327453284532945330453314533245333453344533545336453374533845339453404534145342453434534445345453464534745348453494535045351453524535345354453554535645357453584535945360453614536245363453644536545366453674536845369453704537145372453734537445375453764537745378453794538045381453824538345384453854538645387453884538945390453914539245393453944539545396453974539845399454004540145402454034540445405454064540745408454094541045411454124541345414454154541645417454184541945420454214542245423454244542545426454274542845429454304543145432454334543445435454364543745438454394544045441454424544345444454454544645447454484544945450454514545245453454544545545456454574545845459454604546145462454634546445465454664546745468454694547045471454724547345474454754547645477454784547945480454814548245483454844548545486454874548845489454904549145492454934549445495454964549745498454994550045501455024550345504455054550645507455084550945510455114551245513455144551545516455174551845519455204552145522455234552445525455264552745528455294553045531455324553345534455354553645537455384553945540455414554245543455444554545546455474554845549455504555145552455534555445555455564555745558455594556045561455624556345564455654556645567455684556945570455714557245573455744557545576455774557845579455804558145582455834558445585455864558745588455894559045591455924559345594455954559645597455984559945600456014560245603456044560545606456074560845609456104561145612456134561445615456164561745618456194562045621456224562345624456254562645627456284562945630456314563245633456344563545636456374563845639456404564145642456434564445645456464564745648456494565045651456524565345654456554565645657456584565945660456614566245663456644566545666456674566845669456704567145672456734567445675456764567745678456794568045681456824568345684456854568645687456884568945690456914569245693456944569545696456974569845699457004570145702457034570445705457064570745708457094571045711457124571345714457154571645717457184571945720457214572245723457244572545726457274572845729457304573145732457334573445735457364573745738457394574045741457424574345744457454574645747457484574945750457514575245753457544575545756457574575845759457604576145762457634576445765457664576745768457694577045771457724577345774457754577645777457784577945780457814578245783457844578545786457874578845789457904579145792457934579445795457964579745798457994580045801458024580345804458054580645807458084580945810458114581245813458144581545816458174581845819458204582145822458234582445825458264582745828458294583045831458324583345834458354583645837458384583945840458414584245843458444584545846458474584845849458504585145852458534585445855458564585745858458594586045861458624586345864458654586645867458684586945870458714587245873458744587545876458774587845879458804588145882458834588445885458864588745888458894589045891458924589345894458954589645897458984589945900459014590245903459044590545906459074590845909459104591145912459134591445915459164591745918459194592045921459224592345924459254592645927459284592945930459314593245933459344593545936459374593845939459404594145942459434594445945459464594745948459494595045951459524595345954459554595645957459584595945960459614596245963459644596545966459674596845969459704597145972459734597445975459764597745978459794598045981459824598345984459854598645987459884598945990459914599245993459944599545996459974599845999460004600146002460034600446005460064600746008460094601046011460124601346014460154601646017460184601946020460214602246023460244602546026460274602846029460304603146032460334603446035460364603746038460394604046041460424604346044460454604646047460484604946050460514605246053460544605546056460574605846059460604606146062460634606446065460664606746068460694607046071460724607346074460754607646077460784607946080460814608246083460844608546086460874608846089460904609146092460934609446095460964609746098460994610046101461024610346104461054610646107461084610946110461114611246113461144611546116461174611846119461204612146122461234612446125461264612746128461294613046131461324613346134461354613646137461384613946140461414614246143461444614546146461474614846149461504615146152461534615446155461564615746158461594616046161461624616346164461654616646167461684616946170461714617246173461744617546176461774617846179461804618146182461834618446185461864618746188461894619046191461924619346194461954619646197461984619946200462014620246203462044620546206462074620846209462104621146212462134621446215462164621746218462194622046221462224622346224462254622646227462284622946230462314623246233462344623546236462374623846239462404624146242462434624446245462464624746248462494625046251462524625346254462554625646257462584625946260462614626246263462644626546266462674626846269462704627146272462734627446275462764627746278462794628046281462824628346284462854628646287462884628946290462914629246293462944629546296462974629846299463004630146302463034630446305463064630746308463094631046311463124631346314463154631646317463184631946320463214632246323463244632546326463274632846329463304633146332463334633446335463364633746338463394634046341463424634346344463454634646347463484634946350463514635246353463544635546356463574635846359463604636146362463634636446365463664636746368463694637046371463724637346374463754637646377463784637946380463814638246383463844638546386463874638846389463904639146392463934639446395463964639746398463994640046401464024640346404464054640646407464084640946410464114641246413464144641546416464174641846419464204642146422464234642446425464264642746428464294643046431464324643346434464354643646437464384643946440464414644246443464444644546446464474644846449464504645146452464534645446455464564645746458464594646046461464624646346464464654646646467464684646946470464714647246473464744647546476464774647846479464804648146482464834648446485464864648746488464894649046491464924649346494464954649646497464984649946500465014650246503465044650546506465074650846509465104651146512465134651446515465164651746518465194652046521465224652346524465254652646527465284652946530465314653246533465344653546536465374653846539465404654146542465434654446545465464654746548465494655046551465524655346554465554655646557465584655946560465614656246563465644656546566465674656846569465704657146572465734657446575465764657746578465794658046581465824658346584465854658646587465884658946590465914659246593465944659546596465974659846599466004660146602466034660446605466064660746608466094661046611466124661346614466154661646617466184661946620466214662246623466244662546626466274662846629466304663146632466334663446635466364663746638466394664046641466424664346644466454664646647466484664946650466514665246653466544665546656466574665846659466604666146662466634666446665466664666746668466694667046671466724667346674466754667646677466784667946680466814668246683466844668546686466874668846689466904669146692466934669446695466964669746698466994670046701467024670346704467054670646707467084670946710467114671246713467144671546716467174671846719467204672146722467234672446725467264672746728467294673046731467324673346734467354673646737467384673946740467414674246743467444674546746467474674846749467504675146752467534675446755467564675746758467594676046761467624676346764467654676646767467684676946770467714677246773467744677546776467774677846779467804678146782467834678446785467864678746788467894679046791467924679346794467954679646797467984679946800468014680246803468044680546806468074680846809468104681146812468134681446815468164681746818468194682046821468224682346824468254682646827468284682946830468314683246833468344683546836468374683846839468404684146842468434684446845468464684746848468494685046851468524685346854468554685646857468584685946860468614686246863468644686546866468674686846869468704687146872468734687446875468764687746878468794688046881468824688346884468854688646887468884688946890468914689246893468944689546896468974689846899469004690146902469034690446905469064690746908469094691046911469124691346914469154691646917469184691946920469214692246923469244692546926469274692846929469304693146932469334693446935469364693746938469394694046941469424694346944469454694646947469484694946950469514695246953469544695546956469574695846959469604696146962469634696446965469664696746968469694697046971469724697346974469754697646977469784697946980469814698246983469844698546986469874698846989469904699146992469934699446995469964699746998469994700047001470024700347004470054700647007470084700947010470114701247013470144701547016470174701847019470204702147022470234702447025470264702747028470294703047031470324703347034470354703647037470384703947040470414704247043470444704547046470474704847049470504705147052470534705447055470564705747058470594706047061470624706347064470654706647067470684706947070470714707247073470744707547076470774707847079470804708147082470834708447085470864708747088470894709047091470924709347094470954709647097470984709947100471014710247103471044710547106471074710847109471104711147112471134711447115471164711747118471194712047121471224712347124471254712647127471284712947130471314713247133471344713547136471374713847139471404714147142471434714447145471464714747148471494715047151471524715347154471554715647157471584715947160471614716247163471644716547166471674716847169471704717147172471734717447175471764717747178471794718047181471824718347184471854718647187471884718947190471914719247193471944719547196471974719847199472004720147202472034720447205472064720747208472094721047211472124721347214472154721647217472184721947220472214722247223472244722547226472274722847229472304723147232472334723447235472364723747238472394724047241472424724347244472454724647247472484724947250472514725247253472544725547256472574725847259472604726147262472634726447265472664726747268472694727047271472724727347274472754727647277472784727947280472814728247283472844728547286472874728847289472904729147292472934729447295472964729747298472994730047301473024730347304473054730647307473084730947310473114731247313473144731547316473174731847319473204732147322473234732447325473264732747328473294733047331473324733347334473354733647337473384733947340473414734247343473444734547346473474734847349473504735147352473534735447355473564735747358473594736047361473624736347364473654736647367473684736947370473714737247373473744737547376473774737847379473804738147382473834738447385473864738747388473894739047391473924739347394473954739647397473984739947400474014740247403474044740547406474074740847409474104741147412474134741447415474164741747418474194742047421474224742347424474254742647427474284742947430474314743247433474344743547436474374743847439474404744147442474434744447445474464744747448474494745047451474524745347454474554745647457474584745947460474614746247463474644746547466474674746847469474704747147472474734747447475474764747747478474794748047481474824748347484474854748647487474884748947490474914749247493474944749547496474974749847499475004750147502475034750447505475064750747508475094751047511475124751347514475154751647517475184751947520475214752247523475244752547526475274752847529475304753147532475334753447535475364753747538475394754047541475424754347544475454754647547475484754947550475514755247553475544755547556475574755847559475604756147562475634756447565475664756747568475694757047571475724757347574475754757647577475784757947580475814758247583475844758547586475874758847589475904759147592475934759447595475964759747598475994760047601476024760347604476054760647607476084760947610476114761247613476144761547616476174761847619476204762147622476234762447625476264762747628476294763047631476324763347634476354763647637476384763947640476414764247643476444764547646476474764847649476504765147652476534765447655476564765747658476594766047661476624766347664476654766647667476684766947670476714767247673476744767547676476774767847679476804768147682476834768447685476864768747688476894769047691476924769347694476954769647697476984769947700477014770247703477044770547706477074770847709477104771147712477134771447715477164771747718477194772047721477224772347724477254772647727477284772947730477314773247733477344773547736477374773847739477404774147742477434774447745477464774747748477494775047751477524775347754477554775647757477584775947760477614776247763477644776547766477674776847769477704777147772477734777447775477764777747778477794778047781477824778347784477854778647787477884778947790477914779247793477944779547796477974779847799478004780147802478034780447805478064780747808478094781047811478124781347814478154781647817478184781947820478214782247823478244782547826478274782847829478304783147832478334783447835478364783747838478394784047841478424784347844478454784647847478484784947850478514785247853478544785547856478574785847859478604786147862478634786447865478664786747868478694787047871478724787347874478754787647877478784787947880478814788247883478844788547886478874788847889478904789147892478934789447895478964789747898478994790047901479024790347904479054790647907479084790947910479114791247913479144791547916479174791847919479204792147922479234792447925479264792747928479294793047931479324793347934479354793647937479384793947940479414794247943479444794547946479474794847949479504795147952479534795447955479564795747958479594796047961479624796347964479654796647967479684796947970479714797247973479744797547976479774797847979479804798147982479834798447985479864798747988479894799047991479924799347994479954799647997479984799948000480014800248003480044800548006480074800848009480104801148012480134801448015480164801748018480194802048021480224802348024480254802648027480284802948030480314803248033480344803548036480374803848039480404804148042480434804448045480464804748048480494805048051480524805348054480554805648057480584805948060480614806248063480644806548066480674806848069480704807148072480734807448075480764807748078480794808048081480824808348084480854808648087480884808948090480914809248093480944809548096480974809848099481004810148102481034810448105481064810748108481094811048111481124811348114481154811648117481184811948120481214812248123481244812548126481274812848129481304813148132481334813448135481364813748138481394814048141481424814348144481454814648147481484814948150481514815248153481544815548156481574815848159481604816148162481634816448165481664816748168481694817048171481724817348174481754817648177481784817948180481814818248183481844818548186481874818848189481904819148192481934819448195481964819748198481994820048201482024820348204482054820648207482084820948210482114821248213482144821548216482174821848219482204822148222482234822448225482264822748228482294823048231482324823348234482354823648237482384823948240482414824248243482444824548246482474824848249482504825148252482534825448255482564825748258482594826048261482624826348264482654826648267482684826948270482714827248273482744827548276482774827848279482804828148282482834828448285482864828748288482894829048291482924829348294482954829648297482984829948300483014830248303483044830548306483074830848309483104831148312483134831448315483164831748318483194832048321483224832348324483254832648327483284832948330483314833248333483344833548336483374833848339483404834148342483434834448345483464834748348483494835048351483524835348354483554835648357483584835948360483614836248363483644836548366483674836848369483704837148372483734837448375483764837748378483794838048381483824838348384483854838648387483884838948390483914839248393483944839548396483974839848399484004840148402484034840448405484064840748408484094841048411484124841348414484154841648417484184841948420484214842248423484244842548426484274842848429484304843148432484334843448435484364843748438484394844048441484424844348444484454844648447484484844948450484514845248453484544845548456484574845848459484604846148462484634846448465484664846748468484694847048471484724847348474484754847648477484784847948480484814848248483484844848548486484874848848489484904849148492484934849448495484964849748498484994850048501485024850348504485054850648507485084850948510485114851248513485144851548516485174851848519485204852148522485234852448525485264852748528485294853048531485324853348534485354853648537485384853948540485414854248543485444854548546485474854848549485504855148552485534855448555485564855748558485594856048561485624856348564485654856648567485684856948570485714857248573485744857548576485774857848579485804858148582485834858448585485864858748588485894859048591485924859348594485954859648597485984859948600486014860248603486044860548606486074860848609486104861148612486134861448615486164861748618486194862048621486224862348624486254862648627486284862948630486314863248633486344863548636486374863848639486404864148642486434864448645486464864748648486494865048651486524865348654486554865648657486584865948660486614866248663486644866548666486674866848669486704867148672486734867448675486764867748678486794868048681486824868348684486854868648687486884868948690486914869248693486944869548696486974869848699487004870148702487034870448705487064870748708487094871048711487124871348714487154871648717487184871948720487214872248723487244872548726487274872848729487304873148732487334873448735487364873748738487394874048741487424874348744487454874648747487484874948750487514875248753487544875548756487574875848759487604876148762487634876448765487664876748768487694877048771487724877348774487754877648777487784877948780487814878248783487844878548786487874878848789487904879148792487934879448795487964879748798487994880048801488024880348804488054880648807488084880948810488114881248813488144881548816488174881848819488204882148822488234882448825488264882748828488294883048831488324883348834488354883648837488384883948840488414884248843488444884548846488474884848849488504885148852488534885448855488564885748858488594886048861488624886348864488654886648867488684886948870488714887248873488744887548876488774887848879488804888148882488834888448885488864888748888488894889048891488924889348894488954889648897488984889948900489014890248903489044890548906489074890848909489104891148912489134891448915489164891748918489194892048921489224892348924489254892648927489284892948930489314893248933489344893548936489374893848939489404894148942489434894448945489464894748948489494895048951489524895348954489554895648957489584895948960489614896248963489644896548966489674896848969489704897148972489734897448975489764897748978489794898048981489824898348984489854898648987489884898948990489914899248993489944899548996489974899848999490004900149002490034900449005490064900749008490094901049011490124901349014490154901649017490184901949020490214902249023490244902549026490274902849029490304903149032490334903449035490364903749038490394904049041490424904349044490454904649047490484904949050490514905249053490544905549056490574905849059490604906149062490634906449065490664906749068490694907049071490724907349074490754907649077490784907949080490814908249083490844908549086490874908849089490904909149092490934909449095490964909749098490994910049101491024910349104491054910649107491084910949110491114911249113491144911549116491174911849119491204912149122491234912449125491264912749128491294913049131491324913349134491354913649137491384913949140491414914249143491444914549146491474914849149491504915149152491534915449155491564915749158491594916049161491624916349164491654916649167491684916949170491714917249173491744917549176491774917849179491804918149182491834918449185491864918749188491894919049191491924919349194491954919649197491984919949200492014920249203492044920549206492074920849209492104921149212492134921449215492164921749218492194922049221492224922349224492254922649227492284922949230492314923249233492344923549236492374923849239492404924149242492434924449245492464924749248492494925049251492524925349254492554925649257492584925949260492614926249263492644926549266492674926849269492704927149272492734927449275492764927749278492794928049281492824928349284492854928649287492884928949290492914929249293492944929549296492974929849299493004930149302493034930449305493064930749308493094931049311493124931349314493154931649317493184931949320493214932249323493244932549326493274932849329493304933149332493334933449335493364933749338493394934049341493424934349344493454934649347493484934949350493514935249353493544935549356493574935849359493604936149362493634936449365493664936749368493694937049371493724937349374493754937649377493784937949380493814938249383493844938549386493874938849389493904939149392493934939449395493964939749398493994940049401494024940349404494054940649407494084940949410494114941249413494144941549416494174941849419494204942149422494234942449425494264942749428494294943049431494324943349434494354943649437494384943949440494414944249443494444944549446494474944849449494504945149452494534945449455494564945749458494594946049461494624946349464494654946649467494684946949470494714947249473494744947549476494774947849479494804948149482494834948449485494864948749488494894949049491494924949349494494954949649497494984949949500495014950249503495044950549506495074950849509495104951149512495134951449515495164951749518495194952049521495224952349524495254952649527495284952949530495314953249533495344953549536495374953849539495404954149542495434954449545495464954749548495494955049551495524955349554495554955649557495584955949560495614956249563495644956549566495674956849569495704957149572495734957449575495764957749578495794958049581495824958349584495854958649587495884958949590495914959249593495944959549596495974959849599496004960149602496034960449605496064960749608496094961049611496124961349614496154961649617496184961949620496214962249623496244962549626496274962849629496304963149632496334963449635496364963749638496394964049641496424964349644496454964649647496484964949650496514965249653496544965549656496574965849659496604966149662496634966449665496664966749668496694967049671496724967349674496754967649677496784967949680496814968249683496844968549686496874968849689496904969149692496934969449695496964969749698496994970049701497024970349704497054970649707497084970949710497114971249713497144971549716497174971849719497204972149722497234972449725497264972749728497294973049731497324973349734497354973649737497384973949740497414974249743497444974549746497474974849749497504975149752497534975449755497564975749758497594976049761497624976349764497654976649767497684976949770497714977249773497744977549776497774977849779497804978149782497834978449785497864978749788497894979049791497924979349794497954979649797497984979949800498014980249803498044980549806498074980849809498104981149812498134981449815498164981749818498194982049821498224982349824498254982649827498284982949830498314983249833498344983549836498374983849839498404984149842498434984449845498464984749848498494985049851498524985349854498554985649857498584985949860498614986249863498644986549866498674986849869498704987149872498734987449875498764987749878498794988049881498824988349884498854988649887498884988949890498914989249893498944989549896498974989849899499004990149902499034990449905499064990749908499094991049911499124991349914499154991649917499184991949920499214992249923499244992549926499274992849929499304993149932499334993449935499364993749938499394994049941499424994349944499454994649947499484994949950499514995249953499544995549956499574995849959499604996149962499634996449965499664996749968499694997049971499724997349974499754997649977499784997949980499814998249983499844998549986499874998849989499904999149992499934999449995499964999749998499995000050001500025000350004500055000650007500085000950010500115001250013500145001550016500175001850019500205002150022500235002450025500265002750028500295003050031500325003350034500355003650037500385003950040500415004250043500445004550046500475004850049500505005150052500535005450055500565005750058500595006050061500625006350064500655006650067500685006950070500715007250073500745007550076500775007850079500805008150082500835008450085500865008750088500895009050091500925009350094500955009650097500985009950100501015010250103501045010550106501075010850109501105011150112501135011450115501165011750118501195012050121501225012350124501255012650127501285012950130501315013250133501345013550136501375013850139501405014150142501435014450145501465014750148501495015050151501525015350154501555015650157501585015950160501615016250163501645016550166501675016850169501705017150172501735017450175501765017750178501795018050181501825018350184501855018650187501885018950190501915019250193501945019550196501975019850199502005020150202502035020450205502065020750208502095021050211502125021350214502155021650217502185021950220502215022250223502245022550226502275022850229502305023150232502335023450235502365023750238502395024050241502425024350244502455024650247502485024950250502515025250253502545025550256502575025850259502605026150262502635026450265502665026750268502695027050271502725027350274502755027650277502785027950280502815028250283502845028550286502875028850289502905029150292502935029450295502965029750298502995030050301503025030350304503055030650307503085030950310503115031250313503145031550316503175031850319503205032150322503235032450325503265032750328503295033050331503325033350334503355033650337503385033950340503415034250343503445034550346503475034850349503505035150352503535035450355503565035750358503595036050361503625036350364503655036650367503685036950370503715037250373503745037550376503775037850379503805038150382503835038450385503865038750388503895039050391503925039350394503955039650397503985039950400504015040250403504045040550406504075040850409504105041150412504135041450415504165041750418504195042050421504225042350424504255042650427504285042950430504315043250433504345043550436504375043850439504405044150442504435044450445504465044750448504495045050451504525045350454504555045650457504585045950460504615046250463504645046550466504675046850469504705047150472504735047450475504765047750478504795048050481504825048350484504855048650487504885048950490504915049250493504945049550496504975049850499505005050150502505035050450505505065050750508505095051050511505125051350514505155051650517505185051950520505215052250523505245052550526505275052850529505305053150532505335053450535505365053750538505395054050541505425054350544505455054650547505485054950550505515055250553505545055550556505575055850559505605056150562505635056450565505665056750568505695057050571505725057350574505755057650577505785057950580505815058250583505845058550586505875058850589505905059150592505935059450595505965059750598505995060050601506025060350604506055060650607506085060950610506115061250613506145061550616506175061850619506205062150622506235062450625506265062750628506295063050631506325063350634506355063650637506385063950640506415064250643506445064550646506475064850649506505065150652506535065450655506565065750658506595066050661506625066350664506655066650667506685066950670506715067250673506745067550676506775067850679506805068150682506835068450685506865068750688506895069050691506925069350694506955069650697506985069950700507015070250703507045070550706507075070850709507105071150712507135071450715507165071750718507195072050721507225072350724507255072650727507285072950730507315073250733507345073550736507375073850739507405074150742507435074450745507465074750748507495075050751507525075350754507555075650757507585075950760507615076250763507645076550766507675076850769507705077150772507735077450775507765077750778507795078050781507825078350784507855078650787507885078950790507915079250793507945079550796507975079850799508005080150802508035080450805508065080750808508095081050811508125081350814508155081650817508185081950820508215082250823508245082550826508275082850829508305083150832508335083450835508365083750838508395084050841508425084350844508455084650847508485084950850508515085250853508545085550856508575085850859508605086150862508635086450865508665086750868508695087050871508725087350874508755087650877508785087950880508815088250883508845088550886508875088850889508905089150892508935089450895508965089750898508995090050901509025090350904509055090650907509085090950910509115091250913509145091550916509175091850919509205092150922509235092450925509265092750928509295093050931509325093350934509355093650937509385093950940509415094250943509445094550946509475094850949509505095150952509535095450955509565095750958509595096050961509625096350964509655096650967509685096950970509715097250973509745097550976509775097850979509805098150982509835098450985509865098750988509895099050991509925099350994509955099650997509985099951000510015100251003510045100551006510075100851009510105101151012510135101451015510165101751018510195102051021510225102351024510255102651027510285102951030510315103251033510345103551036510375103851039510405104151042510435104451045510465104751048510495105051051510525105351054510555105651057510585105951060510615106251063510645106551066510675106851069510705107151072510735107451075510765107751078510795108051081510825108351084510855108651087510885108951090510915109251093510945109551096510975109851099511005110151102511035110451105511065110751108511095111051111511125111351114511155111651117511185111951120511215112251123511245112551126511275112851129511305113151132511335113451135511365113751138511395114051141511425114351144511455114651147511485114951150511515115251153511545115551156511575115851159511605116151162511635116451165511665116751168511695117051171511725117351174511755117651177511785117951180511815118251183511845118551186511875118851189511905119151192511935119451195511965119751198511995120051201512025120351204512055120651207512085120951210512115121251213512145121551216512175121851219512205122151222512235122451225512265122751228512295123051231512325123351234512355123651237512385123951240512415124251243512445124551246512475124851249512505125151252512535125451255512565125751258512595126051261512625126351264512655126651267512685126951270512715127251273512745127551276512775127851279512805128151282512835128451285512865128751288512895129051291512925129351294512955129651297512985129951300513015130251303513045130551306513075130851309513105131151312513135131451315513165131751318513195132051321513225132351324513255132651327513285132951330513315133251333513345133551336513375133851339513405134151342513435134451345513465134751348513495135051351513525135351354513555135651357513585135951360513615136251363513645136551366513675136851369513705137151372513735137451375513765137751378513795138051381513825138351384513855138651387513885138951390513915139251393513945139551396513975139851399514005140151402514035140451405514065140751408514095141051411514125141351414514155141651417514185141951420514215142251423514245142551426514275142851429514305143151432514335143451435514365143751438514395144051441514425144351444514455144651447514485144951450514515145251453514545145551456514575145851459514605146151462514635146451465514665146751468514695147051471514725147351474514755147651477514785147951480514815148251483514845148551486514875148851489514905149151492514935149451495514965149751498514995150051501515025150351504515055150651507515085150951510515115151251513515145151551516515175151851519515205152151522515235152451525515265152751528515295153051531515325153351534515355153651537515385153951540515415154251543515445154551546515475154851549515505155151552515535155451555515565155751558515595156051561515625156351564515655156651567515685156951570515715157251573515745157551576515775157851579515805158151582515835158451585515865158751588515895159051591515925159351594515955159651597515985159951600516015160251603516045160551606516075160851609516105161151612516135161451615516165161751618516195162051621516225162351624516255162651627516285162951630516315163251633516345163551636516375163851639516405164151642516435164451645516465164751648516495165051651516525165351654516555165651657516585165951660516615166251663516645166551666516675166851669516705167151672516735167451675516765167751678516795168051681516825168351684516855168651687516885168951690516915169251693516945169551696516975169851699517005170151702517035170451705517065170751708517095171051711517125171351714517155171651717517185171951720517215172251723517245172551726517275172851729517305173151732517335173451735517365173751738517395174051741517425174351744517455174651747517485174951750517515175251753517545175551756517575175851759517605176151762517635176451765517665176751768517695177051771517725177351774517755177651777517785177951780517815178251783517845178551786517875178851789517905179151792517935179451795517965179751798517995180051801518025180351804518055180651807518085180951810518115181251813518145181551816518175181851819518205182151822518235182451825518265182751828518295183051831518325183351834518355183651837518385183951840518415184251843518445184551846518475184851849518505185151852518535185451855518565185751858518595186051861518625186351864518655186651867518685186951870518715187251873518745187551876518775187851879518805188151882518835188451885518865188751888518895189051891518925189351894518955189651897518985189951900519015190251903519045190551906519075190851909519105191151912519135191451915519165191751918519195192051921519225192351924519255192651927519285192951930519315193251933519345193551936519375193851939519405194151942519435194451945519465194751948519495195051951519525195351954519555195651957519585195951960519615196251963519645196551966519675196851969519705197151972519735197451975519765197751978519795198051981519825198351984519855198651987519885198951990519915199251993519945199551996519975199851999520005200152002520035200452005520065200752008520095201052011520125201352014520155201652017520185201952020520215202252023520245202552026520275202852029520305203152032520335203452035520365203752038520395204052041520425204352044520455204652047520485204952050520515205252053520545205552056520575205852059520605206152062520635206452065520665206752068520695207052071520725207352074520755207652077520785207952080520815208252083520845208552086520875208852089520905209152092520935209452095520965209752098520995210052101521025210352104521055210652107521085210952110521115211252113521145211552116521175211852119521205212152122521235212452125521265212752128521295213052131521325213352134521355213652137521385213952140521415214252143521445214552146521475214852149521505215152152521535215452155521565215752158521595216052161521625216352164521655216652167521685216952170521715217252173521745217552176521775217852179521805218152182521835218452185521865218752188521895219052191521925219352194521955219652197521985219952200522015220252203522045220552206522075220852209522105221152212522135221452215522165221752218522195222052221522225222352224522255222652227522285222952230522315223252233522345223552236522375223852239522405224152242522435224452245522465224752248522495225052251522525225352254522555225652257522585225952260522615226252263522645226552266522675226852269522705227152272522735227452275522765227752278522795228052281522825228352284522855228652287522885228952290522915229252293522945229552296522975229852299523005230152302523035230452305523065230752308523095231052311523125231352314523155231652317523185231952320523215232252323523245232552326523275232852329523305233152332523335233452335523365233752338523395234052341523425234352344523455234652347523485234952350523515235252353523545235552356523575235852359523605236152362523635236452365523665236752368523695237052371523725237352374523755237652377523785237952380523815238252383523845238552386523875238852389523905239152392523935239452395523965239752398523995240052401524025240352404524055240652407524085240952410524115241252413524145241552416524175241852419524205242152422524235242452425524265242752428524295243052431524325243352434524355243652437524385243952440524415244252443524445244552446524475244852449524505245152452524535245452455524565245752458524595246052461524625246352464524655246652467524685246952470524715247252473524745247552476524775247852479524805248152482524835248452485524865248752488524895249052491524925249352494524955249652497524985249952500525015250252503525045250552506525075250852509525105251152512525135251452515525165251752518525195252052521525225252352524525255252652527525285252952530525315253252533525345253552536525375253852539525405254152542525435254452545525465254752548525495255052551525525255352554525555255652557525585255952560525615256252563525645256552566525675256852569525705257152572525735257452575525765257752578525795258052581525825258352584525855258652587525885258952590525915259252593525945259552596525975259852599526005260152602526035260452605526065260752608526095261052611526125261352614526155261652617526185261952620526215262252623526245262552626526275262852629526305263152632526335263452635526365263752638526395264052641526425264352644526455264652647526485264952650526515265252653526545265552656526575265852659526605266152662526635266452665526665266752668526695267052671526725267352674526755267652677526785267952680526815268252683526845268552686526875268852689526905269152692526935269452695526965269752698526995270052701527025270352704527055270652707527085270952710527115271252713527145271552716527175271852719527205272152722527235272452725527265272752728527295273052731527325273352734527355273652737527385273952740527415274252743527445274552746527475274852749527505275152752527535275452755527565275752758527595276052761527625276352764527655276652767527685276952770527715277252773527745277552776527775277852779527805278152782527835278452785527865278752788527895279052791527925279352794527955279652797527985279952800528015280252803528045280552806528075280852809528105281152812528135281452815528165281752818528195282052821528225282352824528255282652827528285282952830528315283252833528345283552836528375283852839528405284152842528435284452845528465284752848528495285052851528525285352854528555285652857528585285952860528615286252863528645286552866528675286852869528705287152872528735287452875528765287752878528795288052881528825288352884528855288652887528885288952890528915289252893528945289552896528975289852899529005290152902529035290452905529065290752908529095291052911529125291352914529155291652917529185291952920529215292252923529245292552926529275292852929529305293152932529335293452935529365293752938529395294052941529425294352944529455294652947529485294952950529515295252953529545295552956529575295852959529605296152962529635296452965529665296752968529695297052971529725297352974529755297652977529785297952980529815298252983529845298552986529875298852989529905299152992529935299452995529965299752998529995300053001530025300353004530055300653007530085300953010530115301253013530145301553016530175301853019530205302153022530235302453025530265302753028530295303053031530325303353034530355303653037530385303953040530415304253043530445304553046530475304853049530505305153052530535305453055530565305753058530595306053061530625306353064530655306653067530685306953070530715307253073530745307553076530775307853079530805308153082530835308453085530865308753088530895309053091530925309353094530955309653097530985309953100531015310253103531045310553106531075310853109531105311153112531135311453115531165311753118531195312053121531225312353124531255312653127531285312953130531315313253133531345313553136531375313853139531405314153142531435314453145531465314753148531495315053151531525315353154531555315653157531585315953160531615316253163531645316553166531675316853169531705317153172531735317453175531765317753178531795318053181531825318353184531855318653187531885318953190531915319253193531945319553196531975319853199532005320153202532035320453205532065320753208532095321053211532125321353214532155321653217532185321953220532215322253223532245322553226532275322853229532305323153232532335323453235532365323753238532395324053241532425324353244532455324653247532485324953250532515325253253532545325553256532575325853259532605326153262532635326453265532665326753268532695327053271532725327353274532755327653277532785327953280532815328253283532845328553286532875328853289532905329153292532935329453295532965329753298532995330053301533025330353304533055330653307533085330953310533115331253313533145331553316533175331853319533205332153322533235332453325533265332753328533295333053331533325333353334533355333653337533385333953340533415334253343533445334553346533475334853349533505335153352533535335453355533565335753358533595336053361533625336353364533655336653367533685336953370533715337253373533745337553376533775337853379533805338153382533835338453385533865338753388533895339053391533925339353394533955339653397533985339953400534015340253403534045340553406534075340853409534105341153412534135341453415534165341753418534195342053421534225342353424534255342653427534285342953430534315343253433534345343553436534375343853439534405344153442534435344453445534465344753448534495345053451534525345353454534555345653457534585345953460534615346253463534645346553466534675346853469534705347153472534735347453475534765347753478534795348053481534825348353484534855348653487534885348953490534915349253493534945349553496534975349853499535005350153502535035350453505535065350753508535095351053511535125351353514535155351653517535185351953520535215352253523535245352553526535275352853529535305353153532535335353453535535365353753538535395354053541535425354353544535455354653547535485354953550535515355253553535545355553556535575355853559535605356153562535635356453565535665356753568535695357053571535725357353574535755357653577535785357953580535815358253583535845358553586535875358853589535905359153592535935359453595535965359753598535995360053601536025360353604536055360653607536085360953610536115361253613536145361553616536175361853619536205362153622536235362453625536265362753628536295363053631536325363353634536355363653637536385363953640536415364253643536445364553646536475364853649536505365153652536535365453655536565365753658536595366053661536625366353664536655366653667536685366953670536715367253673536745367553676536775367853679536805368153682536835368453685536865368753688536895369053691536925369353694536955369653697536985369953700537015370253703537045370553706537075370853709537105371153712537135371453715537165371753718537195372053721537225372353724537255372653727537285372953730537315373253733537345373553736537375373853739537405374153742537435374453745537465374753748537495375053751537525375353754537555375653757537585375953760537615376253763537645376553766537675376853769537705377153772537735377453775537765377753778537795378053781537825378353784537855378653787537885378953790537915379253793537945379553796537975379853799538005380153802538035380453805538065380753808538095381053811538125381353814538155381653817538185381953820538215382253823538245382553826538275382853829538305383153832538335383453835538365383753838538395384053841538425384353844538455384653847538485384953850538515385253853538545385553856538575385853859538605386153862538635386453865538665386753868538695387053871538725387353874538755387653877538785387953880538815388253883538845388553886538875388853889538905389153892538935389453895538965389753898538995390053901539025390353904539055390653907539085390953910539115391253913539145391553916539175391853919539205392153922539235392453925539265392753928539295393053931539325393353934539355393653937539385393953940539415394253943539445394553946539475394853949539505395153952539535395453955539565395753958539595396053961539625396353964539655396653967539685396953970539715397253973539745397553976539775397853979539805398153982539835398453985539865398753988539895399053991539925399353994539955399653997539985399954000540015400254003540045400554006540075400854009540105401154012540135401454015540165401754018540195402054021540225402354024540255402654027540285402954030540315403254033540345403554036540375403854039540405404154042540435404454045540465404754048540495405054051540525405354054540555405654057540585405954060540615406254063540645406554066540675406854069540705407154072540735407454075540765407754078540795408054081540825408354084540855408654087540885408954090540915409254093540945409554096540975409854099541005410154102541035410454105541065410754108541095411054111541125411354114541155411654117541185411954120541215412254123541245412554126541275412854129541305413154132541335413454135541365413754138541395414054141541425414354144541455414654147541485414954150541515415254153541545415554156541575415854159541605416154162541635416454165541665416754168541695417054171541725417354174541755417654177541785417954180541815418254183541845418554186541875418854189541905419154192541935419454195541965419754198541995420054201542025420354204542055420654207542085420954210542115421254213542145421554216542175421854219542205422154222542235422454225542265422754228542295423054231542325423354234542355423654237542385423954240542415424254243542445424554246542475424854249542505425154252542535425454255542565425754258542595426054261542625426354264542655426654267542685426954270542715427254273542745427554276542775427854279542805428154282542835428454285542865428754288542895429054291542925429354294542955429654297542985429954300543015430254303543045430554306543075430854309543105431154312543135431454315543165431754318543195432054321543225432354324543255432654327543285432954330543315433254333543345433554336543375433854339543405434154342543435434454345543465434754348543495435054351543525435354354543555435654357543585435954360543615436254363543645436554366543675436854369543705437154372543735437454375543765437754378543795438054381543825438354384543855438654387543885438954390543915439254393543945439554396543975439854399544005440154402544035440454405544065440754408544095441054411544125441354414544155441654417544185441954420544215442254423544245442554426544275442854429544305443154432544335443454435544365443754438544395444054441544425444354444544455444654447544485444954450544515445254453544545445554456544575445854459544605446154462544635446454465544665446754468544695447054471544725447354474544755447654477544785447954480544815448254483544845448554486544875448854489544905449154492544935449454495544965449754498544995450054501545025450354504545055450654507545085450954510545115451254513545145451554516545175451854519545205452154522545235452454525545265452754528545295453054531545325453354534545355453654537545385453954540545415454254543545445454554546545475454854549545505455154552545535455454555545565455754558545595456054561545625456354564545655456654567545685456954570545715457254573545745457554576545775457854579545805458154582545835458454585545865458754588545895459054591545925459354594545955459654597545985459954600546015460254603546045460554606546075460854609546105461154612546135461454615546165461754618546195462054621546225462354624546255462654627546285462954630546315463254633546345463554636546375463854639546405464154642546435464454645546465464754648546495465054651546525465354654546555465654657546585465954660546615466254663546645466554666546675466854669546705467154672546735467454675546765467754678546795468054681546825468354684546855468654687546885468954690546915469254693546945469554696546975469854699547005470154702547035470454705547065470754708547095471054711547125471354714547155471654717547185471954720547215472254723547245472554726547275472854729547305473154732547335473454735547365473754738547395474054741547425474354744547455474654747547485474954750547515475254753547545475554756547575475854759547605476154762547635476454765547665476754768547695477054771547725477354774547755477654777547785477954780547815478254783547845478554786547875478854789547905479154792547935479454795547965479754798547995480054801548025480354804548055480654807548085480954810548115481254813548145481554816548175481854819548205482154822548235482454825548265482754828548295483054831548325483354834548355483654837548385483954840548415484254843548445484554846548475484854849548505485154852548535485454855548565485754858548595486054861548625486354864548655486654867548685486954870548715487254873548745487554876548775487854879548805488154882548835488454885548865488754888548895489054891548925489354894548955489654897548985489954900549015490254903549045490554906549075490854909549105491154912549135491454915549165491754918549195492054921549225492354924549255492654927549285492954930549315493254933549345493554936549375493854939549405494154942549435494454945549465494754948549495495054951549525495354954549555495654957549585495954960549615496254963549645496554966549675496854969549705497154972549735497454975549765497754978549795498054981549825498354984549855498654987549885498954990549915499254993549945499554996549975499854999550005500155002550035500455005550065500755008550095501055011550125501355014550155501655017550185501955020550215502255023550245502555026550275502855029550305503155032550335503455035550365503755038550395504055041550425504355044550455504655047550485504955050550515505255053550545505555056550575505855059550605506155062550635506455065550665506755068550695507055071550725507355074550755507655077550785507955080550815508255083550845508555086550875508855089550905509155092550935509455095550965509755098550995510055101551025510355104551055510655107551085510955110551115511255113551145511555116551175511855119551205512155122551235512455125551265512755128551295513055131551325513355134551355513655137551385513955140551415514255143551445514555146551475514855149551505515155152551535515455155551565515755158551595516055161551625516355164551655516655167551685516955170551715517255173551745517555176551775517855179551805518155182551835518455185551865518755188551895519055191551925519355194551955519655197551985519955200552015520255203552045520555206552075520855209552105521155212552135521455215552165521755218552195522055221552225522355224552255522655227552285522955230552315523255233552345523555236552375523855239552405524155242552435524455245552465524755248552495525055251552525525355254552555525655257552585525955260552615526255263552645526555266552675526855269552705527155272552735527455275552765527755278552795528055281552825528355284552855528655287552885528955290552915529255293552945529555296552975529855299553005530155302553035530455305553065530755308553095531055311553125531355314553155531655317553185531955320553215532255323553245532555326553275532855329553305533155332553335533455335553365533755338553395534055341553425534355344553455534655347553485534955350553515535255353553545535555356553575535855359553605536155362553635536455365553665536755368553695537055371553725537355374553755537655377553785537955380553815538255383553845538555386553875538855389553905539155392553935539455395553965539755398553995540055401554025540355404554055540655407554085540955410554115541255413554145541555416554175541855419554205542155422554235542455425554265542755428554295543055431554325543355434554355543655437554385543955440554415544255443554445544555446554475544855449554505545155452554535545455455554565545755458554595546055461554625546355464554655546655467554685546955470554715547255473554745547555476554775547855479554805548155482554835548455485554865548755488554895549055491554925549355494554955549655497554985549955500555015550255503555045550555506555075550855509555105551155512555135551455515555165551755518555195552055521555225552355524555255552655527555285552955530555315553255533555345553555536555375553855539555405554155542555435554455545555465554755548555495555055551555525555355554555555555655557555585555955560555615556255563555645556555566555675556855569555705557155572555735557455575555765557755578555795558055581555825558355584555855558655587555885558955590555915559255593555945559555596555975559855599556005560155602556035560455605556065560755608556095561055611556125561355614556155561655617556185561955620556215562255623556245562555626556275562855629556305563155632556335563455635556365563755638556395564055641556425564355644556455564655647556485564955650556515565255653556545565555656556575565855659556605566155662556635566455665556665566755668556695567055671556725567355674556755567655677556785567955680556815568255683556845568555686556875568855689556905569155692556935569455695556965569755698556995570055701557025570355704557055570655707557085570955710557115571255713557145571555716557175571855719557205572155722557235572455725557265572755728557295573055731557325573355734557355573655737557385573955740557415574255743557445574555746557475574855749557505575155752557535575455755557565575755758557595576055761557625576355764557655576655767557685576955770557715577255773557745577555776557775577855779557805578155782557835578455785557865578755788557895579055791557925579355794557955579655797557985579955800558015580255803558045580555806558075580855809558105581155812558135581455815558165581755818558195582055821558225582355824558255582655827558285582955830558315583255833558345583555836558375583855839558405584155842558435584455845558465584755848558495585055851558525585355854558555585655857558585585955860558615586255863558645586555866558675586855869558705587155872558735587455875558765587755878558795588055881558825588355884558855588655887558885588955890558915589255893558945589555896558975589855899559005590155902559035590455905559065590755908559095591055911559125591355914559155591655917559185591955920559215592255923559245592555926559275592855929559305593155932559335593455935559365593755938559395594055941559425594355944559455594655947559485594955950559515595255953559545595555956559575595855959559605596155962559635596455965559665596755968559695597055971559725597355974559755597655977559785597955980559815598255983559845598555986559875598855989559905599155992559935599455995559965599755998559995600056001560025600356004560055600656007560085600956010560115601256013560145601556016560175601856019560205602156022560235602456025560265602756028560295603056031560325603356034560355603656037560385603956040560415604256043560445604556046560475604856049560505605156052560535605456055560565605756058560595606056061560625606356064560655606656067560685606956070560715607256073560745607556076560775607856079560805608156082560835608456085560865608756088560895609056091560925609356094560955609656097560985609956100561015610256103561045610556106561075610856109561105611156112561135611456115561165611756118561195612056121561225612356124561255612656127561285612956130561315613256133561345613556136561375613856139561405614156142561435614456145561465614756148561495615056151561525615356154561555615656157561585615956160561615616256163561645616556166561675616856169561705617156172561735617456175561765617756178561795618056181561825618356184561855618656187561885618956190561915619256193561945619556196561975619856199562005620156202562035620456205562065620756208562095621056211562125621356214562155621656217562185621956220562215622256223562245622556226562275622856229562305623156232562335623456235562365623756238562395624056241562425624356244562455624656247562485624956250562515625256253562545625556256562575625856259562605626156262562635626456265562665626756268562695627056271562725627356274562755627656277562785627956280562815628256283562845628556286562875628856289562905629156292562935629456295562965629756298562995630056301563025630356304563055630656307563085630956310563115631256313563145631556316563175631856319563205632156322563235632456325563265632756328563295633056331563325633356334563355633656337563385633956340563415634256343563445634556346563475634856349563505635156352563535635456355563565635756358563595636056361563625636356364563655636656367563685636956370563715637256373563745637556376563775637856379563805638156382563835638456385563865638756388563895639056391563925639356394563955639656397563985639956400564015640256403564045640556406564075640856409564105641156412564135641456415564165641756418564195642056421564225642356424564255642656427564285642956430564315643256433564345643556436564375643856439564405644156442564435644456445564465644756448564495645056451564525645356454564555645656457564585645956460564615646256463564645646556466564675646856469564705647156472564735647456475564765647756478564795648056481564825648356484564855648656487564885648956490564915649256493564945649556496564975649856499565005650156502565035650456505565065650756508565095651056511565125651356514565155651656517565185651956520565215652256523565245652556526565275652856529565305653156532565335653456535565365653756538565395654056541565425654356544565455654656547565485654956550565515655256553565545655556556565575655856559565605656156562565635656456565565665656756568565695657056571565725657356574565755657656577565785657956580565815658256583565845658556586565875658856589565905659156592565935659456595565965659756598565995660056601566025660356604566055660656607566085660956610566115661256613566145661556616566175661856619566205662156622566235662456625566265662756628566295663056631566325663356634566355663656637566385663956640566415664256643566445664556646566475664856649566505665156652566535665456655566565665756658566595666056661566625666356664566655666656667566685666956670566715667256673566745667556676566775667856679566805668156682566835668456685566865668756688566895669056691566925669356694566955669656697566985669956700567015670256703567045670556706567075670856709567105671156712567135671456715567165671756718567195672056721567225672356724567255672656727567285672956730567315673256733567345673556736567375673856739567405674156742567435674456745567465674756748567495675056751567525675356754567555675656757567585675956760567615676256763567645676556766567675676856769567705677156772567735677456775567765677756778567795678056781567825678356784567855678656787567885678956790567915679256793567945679556796567975679856799568005680156802568035680456805568065680756808568095681056811568125681356814568155681656817568185681956820568215682256823568245682556826568275682856829568305683156832568335683456835568365683756838568395684056841568425684356844568455684656847568485684956850568515685256853568545685556856568575685856859568605686156862568635686456865568665686756868568695687056871568725687356874568755687656877568785687956880568815688256883568845688556886568875688856889568905689156892568935689456895568965689756898568995690056901569025690356904569055690656907569085690956910569115691256913569145691556916569175691856919569205692156922569235692456925569265692756928569295693056931569325693356934569355693656937569385693956940569415694256943569445694556946569475694856949569505695156952569535695456955569565695756958569595696056961569625696356964569655696656967569685696956970569715697256973569745697556976569775697856979569805698156982569835698456985569865698756988569895699056991569925699356994569955699656997569985699957000570015700257003570045700557006570075700857009570105701157012570135701457015570165701757018570195702057021570225702357024570255702657027570285702957030570315703257033570345703557036570375703857039570405704157042570435704457045570465704757048570495705057051570525705357054570555705657057570585705957060570615706257063570645706557066570675706857069570705707157072570735707457075570765707757078570795708057081570825708357084570855708657087570885708957090570915709257093570945709557096570975709857099571005710157102571035710457105571065710757108571095711057111571125711357114571155711657117571185711957120571215712257123571245712557126571275712857129571305713157132571335713457135571365713757138571395714057141571425714357144571455714657147571485714957150571515715257153571545715557156571575715857159571605716157162571635716457165571665716757168571695717057171571725717357174571755717657177571785717957180571815718257183571845718557186571875718857189571905719157192571935719457195571965719757198571995720057201572025720357204572055720657207572085720957210572115721257213572145721557216572175721857219572205722157222572235722457225572265722757228572295723057231572325723357234572355723657237572385723957240572415724257243572445724557246572475724857249572505725157252572535725457255572565725757258572595726057261572625726357264572655726657267572685726957270572715727257273572745727557276572775727857279572805728157282572835728457285572865728757288572895729057291572925729357294572955729657297572985729957300573015730257303573045730557306573075730857309573105731157312573135731457315573165731757318573195732057321573225732357324573255732657327573285732957330573315733257333573345733557336573375733857339573405734157342573435734457345573465734757348573495735057351573525735357354573555735657357573585735957360573615736257363573645736557366573675736857369573705737157372573735737457375573765737757378573795738057381573825738357384573855738657387573885738957390573915739257393573945739557396573975739857399574005740157402574035740457405574065740757408574095741057411574125741357414574155741657417574185741957420574215742257423574245742557426574275742857429574305743157432574335743457435574365743757438574395744057441574425744357444574455744657447574485744957450574515745257453574545745557456574575745857459574605746157462574635746457465574665746757468574695747057471574725747357474574755747657477574785747957480574815748257483574845748557486574875748857489574905749157492574935749457495574965749757498574995750057501575025750357504575055750657507575085750957510575115751257513575145751557516575175751857519575205752157522575235752457525575265752757528575295753057531575325753357534575355753657537575385753957540575415754257543575445754557546575475754857549575505755157552575535755457555575565755757558575595756057561575625756357564575655756657567575685756957570575715757257573575745757557576575775757857579575805758157582575835758457585575865758757588575895759057591575925759357594575955759657597575985759957600576015760257603576045760557606576075760857609576105761157612576135761457615576165761757618576195762057621576225762357624576255762657627576285762957630576315763257633576345763557636576375763857639576405764157642576435764457645576465764757648576495765057651576525765357654576555765657657576585765957660576615766257663576645766557666576675766857669576705767157672576735767457675576765767757678576795768057681576825768357684576855768657687576885768957690576915769257693576945769557696576975769857699577005770157702577035770457705577065770757708577095771057711577125771357714577155771657717577185771957720577215772257723577245772557726577275772857729577305773157732577335773457735577365773757738577395774057741577425774357744577455774657747577485774957750577515775257753577545775557756577575775857759577605776157762577635776457765577665776757768577695777057771577725777357774577755777657777577785777957780577815778257783577845778557786577875778857789577905779157792577935779457795577965779757798577995780057801578025780357804578055780657807578085780957810578115781257813578145781557816578175781857819578205782157822578235782457825578265782757828578295783057831578325783357834578355783657837578385783957840578415784257843578445784557846578475784857849578505785157852578535785457855578565785757858578595786057861578625786357864578655786657867578685786957870578715787257873578745787557876578775787857879578805788157882578835788457885578865788757888578895789057891578925789357894578955789657897578985789957900579015790257903579045790557906579075790857909579105791157912579135791457915579165791757918579195792057921579225792357924579255792657927579285792957930579315793257933579345793557936579375793857939579405794157942579435794457945579465794757948579495795057951579525795357954579555795657957579585795957960579615796257963579645796557966579675796857969579705797157972579735797457975579765797757978579795798057981579825798357984579855798657987579885798957990579915799257993579945799557996579975799857999580005800158002580035800458005580065800758008580095801058011580125801358014580155801658017580185801958020580215802258023580245802558026580275802858029580305803158032580335803458035580365803758038580395804058041580425804358044580455804658047580485804958050580515805258053580545805558056580575805858059580605806158062580635806458065580665806758068580695807058071580725807358074580755807658077580785807958080580815808258083580845808558086580875808858089580905809158092580935809458095580965809758098580995810058101581025810358104581055810658107581085810958110581115811258113581145811558116581175811858119581205812158122581235812458125581265812758128581295813058131581325813358134581355813658137581385813958140581415814258143581445814558146581475814858149581505815158152581535815458155581565815758158581595816058161581625816358164581655816658167581685816958170581715817258173581745817558176581775817858179581805818158182581835818458185581865818758188581895819058191581925819358194581955819658197581985819958200582015820258203582045820558206582075820858209582105821158212582135821458215582165821758218582195822058221582225822358224582255822658227582285822958230582315823258233582345823558236582375823858239582405824158242582435824458245582465824758248582495825058251582525825358254582555825658257582585825958260582615826258263582645826558266582675826858269582705827158272582735827458275582765827758278582795828058281582825828358284582855828658287582885828958290582915829258293582945829558296582975829858299583005830158302583035830458305583065830758308583095831058311583125831358314583155831658317583185831958320583215832258323583245832558326583275832858329583305833158332583335833458335583365833758338583395834058341583425834358344583455834658347583485834958350583515835258353583545835558356583575835858359583605836158362583635836458365583665836758368583695837058371583725837358374583755837658377583785837958380583815838258383583845838558386583875838858389583905839158392583935839458395583965839758398583995840058401584025840358404584055840658407584085840958410584115841258413584145841558416584175841858419584205842158422584235842458425584265842758428584295843058431584325843358434584355843658437584385843958440584415844258443584445844558446584475844858449584505845158452584535845458455584565845758458584595846058461584625846358464584655846658467584685846958470584715847258473584745847558476584775847858479584805848158482584835848458485584865848758488584895849058491584925849358494584955849658497584985849958500585015850258503585045850558506585075850858509585105851158512585135851458515585165851758518585195852058521585225852358524585255852658527585285852958530585315853258533585345853558536585375853858539585405854158542585435854458545585465854758548585495855058551585525855358554585555855658557585585855958560585615856258563585645856558566585675856858569585705857158572585735857458575585765857758578585795858058581585825858358584585855858658587585885858958590585915859258593585945859558596585975859858599586005860158602586035860458605586065860758608586095861058611586125861358614586155861658617586185861958620586215862258623586245862558626586275862858629586305863158632586335863458635586365863758638586395864058641586425864358644586455864658647586485864958650586515865258653586545865558656586575865858659586605866158662586635866458665586665866758668586695867058671586725867358674586755867658677586785867958680586815868258683586845868558686586875868858689586905869158692586935869458695586965869758698586995870058701587025870358704587055870658707587085870958710587115871258713587145871558716587175871858719587205872158722587235872458725587265872758728587295873058731587325873358734587355873658737587385873958740587415874258743587445874558746587475874858749587505875158752587535875458755587565875758758587595876058761587625876358764587655876658767587685876958770587715877258773587745877558776587775877858779587805878158782587835878458785587865878758788587895879058791587925879358794587955879658797587985879958800588015880258803588045880558806588075880858809588105881158812588135881458815588165881758818588195882058821588225882358824588255882658827588285882958830588315883258833588345883558836588375883858839588405884158842588435884458845588465884758848588495885058851588525885358854588555885658857588585885958860588615886258863588645886558866588675886858869588705887158872588735887458875588765887758878588795888058881588825888358884588855888658887588885888958890588915889258893588945889558896588975889858899589005890158902589035890458905589065890758908589095891058911589125891358914589155891658917589185891958920589215892258923589245892558926589275892858929589305893158932589335893458935589365893758938589395894058941589425894358944589455894658947589485894958950589515895258953589545895558956589575895858959589605896158962589635896458965589665896758968589695897058971589725897358974589755897658977589785897958980589815898258983589845898558986589875898858989589905899158992589935899458995589965899758998589995900059001590025900359004590055900659007590085900959010590115901259013590145901559016590175901859019590205902159022590235902459025590265902759028590295903059031590325903359034590355903659037590385903959040590415904259043590445904559046590475904859049590505905159052590535905459055590565905759058590595906059061590625906359064590655906659067590685906959070590715907259073590745907559076590775907859079590805908159082590835908459085590865908759088590895909059091590925909359094590955909659097590985909959100591015910259103591045910559106591075910859109591105911159112591135911459115591165911759118591195912059121591225912359124591255912659127591285912959130591315913259133591345913559136591375913859139591405914159142591435914459145591465914759148591495915059151591525915359154591555915659157591585915959160591615916259163591645916559166591675916859169591705917159172591735917459175591765917759178591795918059181591825918359184591855918659187591885918959190591915919259193591945919559196591975919859199592005920159202592035920459205592065920759208592095921059211592125921359214592155921659217592185921959220592215922259223592245922559226592275922859229592305923159232592335923459235592365923759238592395924059241592425924359244592455924659247592485924959250592515925259253592545925559256592575925859259592605926159262592635926459265592665926759268592695927059271592725927359274592755927659277592785927959280592815928259283592845928559286592875928859289592905929159292592935929459295592965929759298592995930059301593025930359304593055930659307593085930959310593115931259313593145931559316593175931859319593205932159322593235932459325593265932759328593295933059331593325933359334593355933659337593385933959340593415934259343593445934559346593475934859349593505935159352593535935459355593565935759358593595936059361593625936359364593655936659367593685936959370593715937259373593745937559376593775937859379593805938159382593835938459385593865938759388593895939059391593925939359394593955939659397593985939959400594015940259403594045940559406594075940859409594105941159412594135941459415594165941759418594195942059421594225942359424594255942659427594285942959430594315943259433594345943559436594375943859439594405944159442594435944459445594465944759448594495945059451594525945359454594555945659457594585945959460594615946259463594645946559466594675946859469594705947159472594735947459475594765947759478594795948059481594825948359484594855948659487594885948959490594915949259493594945949559496594975949859499595005950159502595035950459505595065950759508595095951059511595125951359514595155951659517595185951959520595215952259523595245952559526595275952859529595305953159532595335953459535595365953759538595395954059541595425954359544595455954659547595485954959550595515955259553595545955559556595575955859559595605956159562595635956459565595665956759568595695957059571595725957359574595755957659577595785957959580595815958259583595845958559586595875958859589595905959159592595935959459595595965959759598595995960059601596025960359604596055960659607596085960959610596115961259613596145961559616596175961859619596205962159622596235962459625596265962759628596295963059631596325963359634596355963659637596385963959640596415964259643596445964559646596475964859649596505965159652596535965459655596565965759658596595966059661596625966359664596655966659667596685966959670596715967259673596745967559676596775967859679596805968159682596835968459685596865968759688596895969059691596925969359694596955969659697596985969959700597015970259703597045970559706597075970859709597105971159712597135971459715597165971759718597195972059721597225972359724597255972659727597285972959730597315973259733597345973559736597375973859739597405974159742597435974459745597465974759748597495975059751597525975359754597555975659757597585975959760597615976259763597645976559766597675976859769597705977159772597735977459775597765977759778597795978059781597825978359784597855978659787597885978959790597915979259793597945979559796597975979859799598005980159802598035980459805598065980759808598095981059811598125981359814598155981659817598185981959820598215982259823598245982559826598275982859829598305983159832598335983459835598365983759838598395984059841598425984359844598455984659847598485984959850598515985259853598545985559856598575985859859598605986159862598635986459865598665986759868598695987059871598725987359874598755987659877598785987959880598815988259883598845988559886598875988859889598905989159892598935989459895598965989759898598995990059901599025990359904599055990659907599085990959910599115991259913599145991559916599175991859919599205992159922599235992459925599265992759928599295993059931599325993359934599355993659937599385993959940599415994259943599445994559946599475994859949599505995159952599535995459955599565995759958599595996059961599625996359964599655996659967599685996959970599715997259973599745997559976599775997859979599805998159982599835998459985599865998759988599895999059991599925999359994599955999659997599985999960000600016000260003600046000560006600076000860009600106001160012600136001460015600166001760018600196002060021600226002360024600256002660027600286002960030600316003260033600346003560036600376003860039600406004160042600436004460045600466004760048600496005060051600526005360054600556005660057600586005960060600616006260063600646006560066600676006860069600706007160072600736007460075600766007760078600796008060081600826008360084600856008660087600886008960090600916009260093600946009560096600976009860099601006010160102601036010460105601066010760108601096011060111601126011360114601156011660117601186011960120601216012260123601246012560126601276012860129601306013160132601336013460135601366013760138601396014060141601426014360144601456014660147601486014960150601516015260153601546015560156601576015860159601606016160162601636016460165601666016760168601696017060171601726017360174601756017660177601786017960180601816018260183601846018560186601876018860189601906019160192601936019460195601966019760198601996020060201602026020360204602056020660207602086020960210602116021260213602146021560216602176021860219602206022160222602236022460225602266022760228602296023060231602326023360234602356023660237602386023960240602416024260243602446024560246602476024860249602506025160252602536025460255602566025760258602596026060261602626026360264602656026660267602686026960270602716027260273602746027560276602776027860279602806028160282602836028460285602866028760288602896029060291602926029360294602956029660297602986029960300603016030260303603046030560306603076030860309603106031160312603136031460315603166031760318603196032060321603226032360324603256032660327603286032960330603316033260333603346033560336603376033860339603406034160342603436034460345603466034760348603496035060351603526035360354603556035660357603586035960360603616036260363603646036560366603676036860369603706037160372603736037460375603766037760378603796038060381603826038360384603856038660387603886038960390603916039260393603946039560396603976039860399604006040160402604036040460405604066040760408604096041060411604126041360414604156041660417604186041960420604216042260423604246042560426604276042860429604306043160432604336043460435604366043760438604396044060441604426044360444604456044660447604486044960450604516045260453604546045560456604576045860459604606046160462604636046460465604666046760468604696047060471604726047360474604756047660477604786047960480604816048260483604846048560486604876048860489604906049160492604936049460495604966049760498604996050060501605026050360504605056050660507605086050960510605116051260513605146051560516605176051860519605206052160522605236052460525605266052760528605296053060531605326053360534605356053660537605386053960540605416054260543605446054560546605476054860549605506055160552605536055460555605566055760558605596056060561605626056360564605656056660567605686056960570605716057260573605746057560576605776057860579605806058160582605836058460585605866058760588605896059060591605926059360594605956059660597605986059960600606016060260603606046060560606606076060860609606106061160612606136061460615606166061760618606196062060621606226062360624606256062660627606286062960630606316063260633606346063560636606376063860639606406064160642606436064460645606466064760648606496065060651606526065360654606556065660657606586065960660606616066260663606646066560666606676066860669606706067160672606736067460675606766067760678606796068060681606826068360684606856068660687606886068960690606916069260693606946069560696606976069860699607006070160702607036070460705607066070760708607096071060711607126071360714607156071660717607186071960720607216072260723607246072560726607276072860729607306073160732607336073460735607366073760738607396074060741607426074360744607456074660747607486074960750607516075260753607546075560756607576075860759607606076160762607636076460765607666076760768607696077060771607726077360774607756077660777607786077960780607816078260783607846078560786607876078860789607906079160792607936079460795607966079760798607996080060801608026080360804608056080660807608086080960810608116081260813608146081560816608176081860819608206082160822608236082460825608266082760828608296083060831608326083360834608356083660837608386083960840608416084260843608446084560846608476084860849608506085160852608536085460855608566085760858608596086060861608626086360864608656086660867608686086960870608716087260873608746087560876608776087860879608806088160882608836088460885608866088760888608896089060891608926089360894608956089660897608986089960900609016090260903609046090560906609076090860909609106091160912609136091460915609166091760918609196092060921609226092360924609256092660927609286092960930609316093260933609346093560936609376093860939609406094160942609436094460945609466094760948609496095060951609526095360954609556095660957609586095960960609616096260963609646096560966609676096860969609706097160972609736097460975609766097760978609796098060981609826098360984609856098660987609886098960990609916099260993609946099560996609976099860999610006100161002610036100461005610066100761008610096101061011610126101361014610156101661017610186101961020610216102261023610246102561026610276102861029610306103161032610336103461035610366103761038610396104061041610426104361044610456104661047610486104961050610516105261053610546105561056610576105861059610606106161062610636106461065610666106761068610696107061071610726107361074610756107661077610786107961080610816108261083610846108561086610876108861089610906109161092610936109461095610966109761098610996110061101611026110361104611056110661107611086110961110611116111261113611146111561116611176111861119611206112161122611236112461125611266112761128611296113061131611326113361134611356113661137611386113961140611416114261143611446114561146611476114861149611506115161152611536115461155611566115761158611596116061161611626116361164611656116661167611686116961170611716117261173611746117561176611776117861179611806118161182611836118461185611866118761188611896119061191611926119361194611956119661197611986119961200612016120261203612046120561206612076120861209612106121161212612136121461215612166121761218612196122061221612226122361224612256122661227612286122961230612316123261233612346123561236612376123861239612406124161242612436124461245612466124761248612496125061251612526125361254612556125661257612586125961260612616126261263612646126561266612676126861269612706127161272612736127461275612766127761278612796128061281612826128361284612856128661287612886128961290612916129261293612946129561296612976129861299613006130161302613036130461305613066130761308613096131061311613126131361314613156131661317613186131961320613216132261323613246132561326613276132861329613306133161332613336133461335613366133761338613396134061341613426134361344613456134661347613486134961350613516135261353613546135561356613576135861359613606136161362613636136461365613666136761368613696137061371613726137361374613756137661377613786137961380613816138261383613846138561386613876138861389613906139161392613936139461395613966139761398613996140061401614026140361404614056140661407614086140961410614116141261413614146141561416614176141861419614206142161422614236142461425614266142761428614296143061431614326143361434614356143661437614386143961440614416144261443614446144561446614476144861449614506145161452614536145461455614566145761458614596146061461614626146361464614656146661467614686146961470614716147261473614746147561476614776147861479614806148161482614836148461485614866148761488614896149061491614926149361494614956149661497614986149961500615016150261503615046150561506615076150861509615106151161512615136151461515615166151761518615196152061521615226152361524615256152661527615286152961530615316153261533615346153561536615376153861539615406154161542615436154461545615466154761548615496155061551615526155361554615556155661557615586155961560615616156261563615646156561566615676156861569615706157161572615736157461575615766157761578615796158061581615826158361584615856158661587615886158961590615916159261593615946159561596615976159861599616006160161602616036160461605616066160761608616096161061611616126161361614616156161661617616186161961620616216162261623616246162561626616276162861629616306163161632616336163461635616366163761638616396164061641616426164361644616456164661647616486164961650616516165261653616546165561656616576165861659616606166161662616636166461665616666166761668616696167061671616726167361674616756167661677616786167961680616816168261683616846168561686616876168861689616906169161692616936169461695616966169761698616996170061701617026170361704617056170661707617086170961710617116171261713617146171561716617176171861719617206172161722617236172461725617266172761728617296173061731617326173361734617356173661737617386173961740617416174261743617446174561746617476174861749617506175161752617536175461755617566175761758617596176061761617626176361764617656176661767617686176961770617716177261773617746177561776617776177861779617806178161782617836178461785617866178761788617896179061791617926179361794617956179661797617986179961800618016180261803618046180561806618076180861809618106181161812618136181461815618166181761818618196182061821618226182361824618256182661827618286182961830618316183261833618346183561836618376183861839618406184161842618436184461845618466184761848618496185061851618526185361854618556185661857618586185961860618616186261863618646186561866618676186861869618706187161872618736187461875618766187761878618796188061881618826188361884618856188661887618886188961890618916189261893618946189561896618976189861899619006190161902619036190461905619066190761908619096191061911619126191361914619156191661917619186191961920619216192261923619246192561926619276192861929619306193161932619336193461935619366193761938619396194061941619426194361944619456194661947619486194961950619516195261953619546195561956619576195861959619606196161962619636196461965619666196761968619696197061971619726197361974619756197661977619786197961980619816198261983619846198561986619876198861989619906199161992619936199461995619966199761998619996200062001620026200362004620056200662007620086200962010620116201262013620146201562016620176201862019620206202162022620236202462025620266202762028620296203062031620326203362034620356203662037620386203962040620416204262043620446204562046620476204862049620506205162052620536205462055620566205762058620596206062061620626206362064620656206662067620686206962070620716207262073620746207562076620776207862079620806208162082620836208462085620866208762088620896209062091620926209362094620956209662097620986209962100621016210262103621046210562106621076210862109621106211162112621136211462115621166211762118621196212062121621226212362124621256212662127621286212962130621316213262133621346213562136621376213862139621406214162142621436214462145621466214762148621496215062151621526215362154621556215662157621586215962160621616216262163621646216562166621676216862169621706217162172621736217462175621766217762178621796218062181621826218362184621856218662187621886218962190621916219262193621946219562196621976219862199622006220162202622036220462205622066220762208622096221062211622126221362214622156221662217622186221962220622216222262223622246222562226622276222862229622306223162232622336223462235622366223762238622396224062241622426224362244622456224662247622486224962250622516225262253622546225562256622576225862259622606226162262622636226462265622666226762268622696227062271622726227362274622756227662277622786227962280622816228262283622846228562286622876228862289622906229162292622936229462295622966229762298622996230062301623026230362304623056230662307623086230962310623116231262313623146231562316623176231862319623206232162322623236232462325623266232762328623296233062331623326233362334623356233662337623386233962340623416234262343623446234562346623476234862349623506235162352623536235462355623566235762358623596236062361623626236362364623656236662367623686236962370623716237262373623746237562376623776237862379623806238162382623836238462385623866238762388623896239062391623926239362394623956239662397623986239962400624016240262403624046240562406624076240862409624106241162412624136241462415624166241762418624196242062421624226242362424624256242662427624286242962430624316243262433624346243562436624376243862439624406244162442624436244462445624466244762448624496245062451624526245362454624556245662457624586245962460624616246262463624646246562466624676246862469624706247162472624736247462475624766247762478624796248062481624826248362484624856248662487624886248962490624916249262493624946249562496624976249862499625006250162502625036250462505625066250762508625096251062511625126251362514625156251662517625186251962520625216252262523625246252562526625276252862529625306253162532625336253462535625366253762538625396254062541625426254362544625456254662547625486254962550625516255262553625546255562556625576255862559625606256162562625636256462565625666256762568625696257062571625726257362574625756257662577625786257962580625816258262583625846258562586625876258862589625906259162592625936259462595625966259762598625996260062601626026260362604626056260662607626086260962610626116261262613626146261562616626176261862619626206262162622626236262462625626266262762628626296263062631626326263362634626356263662637626386263962640626416264262643626446264562646626476264862649626506265162652626536265462655626566265762658626596266062661626626266362664626656266662667626686266962670626716267262673626746267562676626776267862679626806268162682626836268462685626866268762688626896269062691626926269362694626956269662697626986269962700627016270262703627046270562706627076270862709627106271162712627136271462715627166271762718627196272062721627226272362724627256272662727627286272962730627316273262733627346273562736627376273862739627406274162742627436274462745627466274762748627496275062751627526275362754627556275662757627586275962760627616276262763627646276562766627676276862769627706277162772627736277462775627766277762778627796278062781627826278362784627856278662787627886278962790627916279262793627946279562796627976279862799628006280162802628036280462805628066280762808628096281062811628126281362814628156281662817628186281962820628216282262823628246282562826628276282862829628306283162832628336283462835628366283762838628396284062841628426284362844628456284662847628486284962850628516285262853628546285562856628576285862859628606286162862628636286462865628666286762868628696287062871628726287362874628756287662877628786287962880628816288262883628846288562886628876288862889628906289162892628936289462895628966289762898628996290062901629026290362904629056290662907629086290962910629116291262913629146291562916629176291862919629206292162922629236292462925629266292762928629296293062931629326293362934629356293662937629386293962940629416294262943629446294562946629476294862949629506295162952629536295462955629566295762958629596296062961629626296362964629656296662967629686296962970629716297262973629746297562976629776297862979629806298162982629836298462985629866298762988629896299062991629926299362994629956299662997629986299963000630016300263003630046300563006630076300863009630106301163012630136301463015630166301763018630196302063021630226302363024630256302663027630286302963030630316303263033630346303563036630376303863039630406304163042630436304463045630466304763048630496305063051630526305363054630556305663057630586305963060630616306263063630646306563066630676306863069630706307163072630736307463075630766307763078630796308063081630826308363084630856308663087630886308963090630916309263093630946309563096630976309863099631006310163102631036310463105631066310763108631096311063111631126311363114631156311663117631186311963120631216312263123631246312563126631276312863129631306313163132631336313463135631366313763138631396314063141631426314363144631456314663147631486314963150631516315263153631546315563156631576315863159631606316163162631636316463165631666316763168631696317063171631726317363174631756317663177631786317963180631816318263183631846318563186631876318863189631906319163192631936319463195631966319763198631996320063201632026320363204632056320663207632086320963210632116321263213632146321563216632176321863219632206322163222632236322463225632266322763228632296323063231632326323363234632356323663237632386323963240632416324263243632446324563246632476324863249632506325163252632536325463255632566325763258632596326063261632626326363264632656326663267632686326963270632716327263273632746327563276632776327863279632806328163282632836328463285632866328763288632896329063291632926329363294632956329663297632986329963300633016330263303633046330563306633076330863309633106331163312633136331463315633166331763318633196332063321633226332363324633256332663327633286332963330633316333263333633346333563336633376333863339633406334163342633436334463345633466334763348633496335063351633526335363354633556335663357633586335963360633616336263363633646336563366633676336863369633706337163372633736337463375633766337763378633796338063381633826338363384633856338663387633886338963390633916339263393633946339563396633976339863399634006340163402634036340463405634066340763408634096341063411634126341363414634156341663417634186341963420634216342263423634246342563426634276342863429634306343163432634336343463435634366343763438634396344063441634426344363444634456344663447634486344963450634516345263453634546345563456634576345863459634606346163462634636346463465634666346763468634696347063471634726347363474634756347663477634786347963480634816348263483634846348563486634876348863489634906349163492634936349463495634966349763498634996350063501635026350363504635056350663507635086350963510635116351263513635146351563516635176351863519635206352163522635236352463525635266352763528635296353063531635326353363534635356353663537635386353963540635416354263543635446354563546635476354863549635506355163552635536355463555635566355763558635596356063561635626356363564635656356663567635686356963570635716357263573635746357563576635776357863579635806358163582635836358463585635866358763588635896359063591635926359363594635956359663597635986359963600636016360263603636046360563606636076360863609636106361163612636136361463615636166361763618636196362063621636226362363624636256362663627636286362963630636316363263633636346363563636636376363863639636406364163642636436364463645636466364763648636496365063651636526365363654636556365663657636586365963660636616366263663636646366563666636676366863669636706367163672636736367463675636766367763678636796368063681636826368363684636856368663687636886368963690636916369263693636946369563696636976369863699637006370163702637036370463705637066370763708637096371063711637126371363714637156371663717637186371963720637216372263723637246372563726637276372863729637306373163732637336373463735637366373763738637396374063741637426374363744637456374663747637486374963750637516375263753637546375563756637576375863759637606376163762637636376463765637666376763768637696377063771637726377363774637756377663777637786377963780637816378263783637846378563786637876378863789637906379163792637936379463795637966379763798637996380063801638026380363804638056380663807638086380963810638116381263813638146381563816638176381863819638206382163822638236382463825638266382763828638296383063831638326383363834638356383663837638386383963840638416384263843638446384563846638476384863849638506385163852638536385463855638566385763858638596386063861638626386363864638656386663867638686386963870638716387263873638746387563876638776387863879638806388163882638836388463885638866388763888638896389063891638926389363894638956389663897638986389963900639016390263903639046390563906639076390863909639106391163912639136391463915639166391763918639196392063921639226392363924639256392663927639286392963930639316393263933639346393563936639376393863939639406394163942639436394463945639466394763948639496395063951639526395363954639556395663957639586395963960639616396263963639646396563966639676396863969639706397163972639736397463975639766397763978639796398063981639826398363984639856398663987639886398963990639916399263993639946399563996639976399863999640006400164002640036400464005640066400764008640096401064011640126401364014640156401664017640186401964020640216402264023640246402564026640276402864029640306403164032640336403464035640366403764038640396404064041640426404364044640456404664047640486404964050640516405264053640546405564056640576405864059640606406164062640636406464065640666406764068640696407064071640726407364074640756407664077640786407964080640816408264083640846408564086640876408864089640906409164092640936409464095640966409764098640996410064101641026410364104641056410664107641086410964110641116411264113641146411564116641176411864119641206412164122641236412464125641266412764128641296413064131641326413364134641356413664137641386413964140641416414264143641446414564146641476414864149641506415164152641536415464155641566415764158641596416064161641626416364164641656416664167641686416964170641716417264173641746417564176641776417864179641806418164182641836418464185641866418764188641896419064191641926419364194641956419664197641986419964200642016420264203642046420564206642076420864209642106421164212642136421464215642166421764218642196422064221642226422364224642256422664227642286422964230642316423264233642346423564236642376423864239642406424164242642436424464245642466424764248642496425064251642526425364254642556425664257642586425964260642616426264263642646426564266642676426864269642706427164272642736427464275642766427764278642796428064281642826428364284642856428664287642886428964290642916429264293642946429564296642976429864299643006430164302643036430464305643066430764308643096431064311643126431364314643156431664317643186431964320643216432264323643246432564326643276432864329643306433164332643336433464335643366433764338643396434064341643426434364344643456434664347643486434964350643516435264353643546435564356643576435864359643606436164362643636436464365643666436764368643696437064371643726437364374643756437664377643786437964380643816438264383643846438564386643876438864389643906439164392643936439464395643966439764398643996440064401644026440364404644056440664407644086440964410644116441264413644146441564416644176441864419644206442164422644236442464425644266442764428644296443064431644326443364434644356443664437644386443964440644416444264443644446444564446644476444864449644506445164452644536445464455644566445764458644596446064461644626446364464644656446664467644686446964470644716447264473644746447564476644776447864479644806448164482644836448464485644866448764488644896449064491644926449364494644956449664497644986449964500645016450264503645046450564506645076450864509645106451164512645136451464515645166451764518645196452064521645226452364524645256452664527645286452964530645316453264533645346453564536645376453864539645406454164542645436454464545645466454764548645496455064551645526455364554645556455664557645586455964560645616456264563645646456564566645676456864569645706457164572645736457464575645766457764578645796458064581645826458364584645856458664587645886458964590645916459264593645946459564596645976459864599646006460164602646036460464605646066460764608646096461064611646126461364614646156461664617646186461964620646216462264623646246462564626646276462864629646306463164632646336463464635646366463764638646396464064641646426464364644646456464664647646486464964650646516465264653646546465564656646576465864659646606466164662646636466464665646666466764668646696467064671646726467364674646756467664677646786467964680646816468264683646846468564686646876468864689646906469164692646936469464695646966469764698646996470064701647026470364704647056470664707647086470964710647116471264713647146471564716647176471864719647206472164722647236472464725647266472764728647296473064731647326473364734647356473664737647386473964740647416474264743647446474564746647476474864749647506475164752647536475464755647566475764758647596476064761647626476364764647656476664767647686476964770647716477264773647746477564776647776477864779647806478164782647836478464785647866478764788647896479064791647926479364794647956479664797647986479964800648016480264803648046480564806648076480864809648106481164812648136481464815648166481764818648196482064821648226482364824648256482664827648286482964830648316483264833648346483564836648376483864839648406484164842648436484464845648466484764848648496485064851648526485364854648556485664857648586485964860648616486264863648646486564866648676486864869648706487164872648736487464875648766487764878648796488064881648826488364884648856488664887648886488964890648916489264893648946489564896648976489864899649006490164902649036490464905649066490764908649096491064911649126491364914649156491664917649186491964920649216492264923649246492564926649276492864929649306493164932649336493464935649366493764938649396494064941649426494364944649456494664947649486494964950649516495264953649546495564956649576495864959649606496164962649636496464965649666496764968649696497064971649726497364974649756497664977649786497964980649816498264983649846498564986649876498864989649906499164992649936499464995649966499764998649996500065001650026500365004650056500665007650086500965010650116501265013650146501565016650176501865019650206502165022650236502465025650266502765028650296503065031650326503365034650356503665037650386503965040650416504265043650446504565046650476504865049650506505165052650536505465055650566505765058650596506065061650626506365064650656506665067650686506965070650716507265073650746507565076650776507865079650806508165082650836508465085650866508765088650896509065091650926509365094650956509665097650986509965100651016510265103651046510565106651076510865109651106511165112651136511465115651166511765118651196512065121651226512365124651256512665127651286512965130651316513265133651346513565136651376513865139651406514165142651436514465145651466514765148651496515065151651526515365154651556515665157651586515965160651616516265163651646516565166651676516865169651706517165172651736517465175651766517765178651796518065181651826518365184651856518665187651886518965190651916519265193651946519565196651976519865199652006520165202652036520465205652066520765208652096521065211652126521365214652156521665217652186521965220652216522265223652246522565226652276522865229652306523165232652336523465235652366523765238652396524065241652426524365244652456524665247652486524965250652516525265253652546525565256652576525865259652606526165262652636526465265652666526765268652696527065271652726527365274652756527665277652786527965280652816528265283652846528565286652876528865289652906529165292652936529465295652966529765298652996530065301653026530365304653056530665307653086530965310653116531265313653146531565316653176531865319653206532165322653236532465325653266532765328653296533065331653326533365334653356533665337653386533965340653416534265343653446534565346653476534865349653506535165352653536535465355653566535765358653596536065361653626536365364653656536665367653686536965370653716537265373653746537565376653776537865379653806538165382653836538465385653866538765388653896539065391653926539365394653956539665397653986539965400654016540265403654046540565406654076540865409654106541165412654136541465415654166541765418654196542065421654226542365424654256542665427654286542965430654316543265433654346543565436654376543865439654406544165442654436544465445654466544765448654496545065451654526545365454654556545665457654586545965460654616546265463654646546565466654676546865469654706547165472654736547465475654766547765478654796548065481654826548365484654856548665487654886548965490654916549265493654946549565496654976549865499655006550165502655036550465505655066550765508655096551065511655126551365514655156551665517655186551965520655216552265523655246552565526655276552865529655306553165532655336553465535655366553765538655396554065541655426554365544655456554665547655486554965550655516555265553655546555565556655576555865559655606556165562655636556465565655666556765568655696557065571655726557365574655756557665577655786557965580655816558265583655846558565586655876558865589655906559165592655936559465595655966559765598655996560065601656026560365604656056560665607656086560965610656116561265613656146561565616656176561865619656206562165622656236562465625656266562765628656296563065631656326563365634656356563665637656386563965640656416564265643656446564565646656476564865649656506565165652656536565465655656566565765658656596566065661656626566365664656656566665667656686566965670656716567265673656746567565676656776567865679656806568165682656836568465685656866568765688656896569065691656926569365694656956569665697656986569965700657016570265703657046570565706657076570865709657106571165712657136571465715657166571765718657196572065721657226572365724657256572665727657286572965730657316573265733657346573565736657376573865739657406574165742657436574465745657466574765748657496575065751657526575365754657556575665757657586575965760657616576265763657646576565766657676576865769657706577165772657736577465775657766577765778657796578065781657826578365784657856578665787657886578965790657916579265793657946579565796657976579865799658006580165802658036580465805658066580765808658096581065811658126581365814658156581665817658186581965820658216582265823658246582565826658276582865829658306583165832658336583465835658366583765838658396584065841658426584365844658456584665847658486584965850658516585265853658546585565856658576585865859658606586165862658636586465865658666586765868658696587065871658726587365874658756587665877658786587965880658816588265883658846588565886658876588865889658906589165892658936589465895658966589765898658996590065901659026590365904659056590665907659086590965910659116591265913659146591565916659176591865919659206592165922659236592465925659266592765928659296593065931659326593365934659356593665937659386593965940659416594265943659446594565946659476594865949659506595165952659536595465955659566595765958659596596065961659626596365964659656596665967659686596965970659716597265973659746597565976659776597865979659806598165982659836598465985659866598765988659896599065991659926599365994659956599665997659986599966000660016600266003660046600566006660076600866009660106601166012660136601466015660166601766018660196602066021660226602366024660256602666027660286602966030660316603266033660346603566036660376603866039660406604166042660436604466045660466604766048660496605066051660526605366054660556605666057660586605966060660616606266063660646606566066660676606866069660706607166072660736607466075660766607766078660796608066081660826608366084660856608666087660886608966090660916609266093660946609566096660976609866099661006610166102661036610466105661066610766108661096611066111661126611366114661156611666117661186611966120661216612266123661246612566126661276612866129661306613166132661336613466135661366613766138661396614066141661426614366144661456614666147661486614966150661516615266153661546615566156661576615866159661606616166162661636616466165661666616766168661696617066171661726617366174661756617666177661786617966180661816618266183661846618566186661876618866189661906619166192661936619466195661966619766198661996620066201662026620366204662056620666207662086620966210662116621266213662146621566216662176621866219662206622166222662236622466225662266622766228662296623066231662326623366234662356623666237662386623966240662416624266243662446624566246662476624866249662506625166252662536625466255662566625766258662596626066261662626626366264662656626666267662686626966270662716627266273662746627566276662776627866279662806628166282662836628466285662866628766288662896629066291662926629366294662956629666297662986629966300663016630266303663046630566306663076630866309663106631166312663136631466315663166631766318663196632066321663226632366324663256632666327663286632966330663316633266333663346633566336663376633866339663406634166342663436634466345663466634766348663496635066351663526635366354663556635666357663586635966360663616636266363663646636566366663676636866369663706637166372663736637466375663766637766378663796638066381663826638366384663856638666387663886638966390663916639266393663946639566396663976639866399664006640166402664036640466405664066640766408664096641066411664126641366414664156641666417664186641966420664216642266423664246642566426664276642866429664306643166432664336643466435664366643766438664396644066441664426644366444664456644666447664486644966450664516645266453664546645566456664576645866459664606646166462664636646466465664666646766468664696647066471664726647366474664756647666477664786647966480664816648266483664846648566486664876648866489664906649166492664936649466495664966649766498664996650066501665026650366504665056650666507665086650966510665116651266513665146651566516665176651866519665206652166522665236652466525665266652766528665296653066531665326653366534665356653666537665386653966540665416654266543665446654566546665476654866549665506655166552665536655466555665566655766558665596656066561665626656366564665656656666567665686656966570665716657266573665746657566576665776657866579665806658166582665836658466585665866658766588665896659066591665926659366594665956659666597665986659966600666016660266603666046660566606666076660866609666106661166612666136661466615666166661766618666196662066621666226662366624666256662666627666286662966630666316663266633666346663566636666376663866639666406664166642666436664466645666466664766648666496665066651666526665366654666556665666657666586665966660666616666266663666646666566666666676666866669666706667166672666736667466675666766667766678666796668066681666826668366684666856668666687666886668966690666916669266693666946669566696666976669866699667006670166702667036670466705667066670766708667096671066711667126671366714667156671666717667186671966720667216672266723667246672566726667276672866729667306673166732667336673466735667366673766738667396674066741667426674366744667456674666747667486674966750667516675266753667546675566756667576675866759667606676166762667636676466765667666676766768667696677066771667726677366774667756677666777667786677966780667816678266783667846678566786667876678866789667906679166792667936679466795667966679766798667996680066801668026680366804668056680666807668086680966810668116681266813668146681566816668176681866819668206682166822668236682466825668266682766828668296683066831668326683366834668356683666837668386683966840668416684266843668446684566846668476684866849668506685166852668536685466855668566685766858668596686066861668626686366864668656686666867668686686966870668716687266873668746687566876668776687866879668806688166882668836688466885668866688766888668896689066891668926689366894668956689666897668986689966900669016690266903669046690566906669076690866909669106691166912669136691466915669166691766918669196692066921669226692366924669256692666927669286692966930669316693266933669346693566936669376693866939669406694166942669436694466945669466694766948669496695066951669526695366954669556695666957669586695966960669616696266963669646696566966669676696866969669706697166972669736697466975669766697766978669796698066981669826698366984669856698666987669886698966990669916699266993669946699566996669976699866999670006700167002670036700467005670066700767008670096701067011670126701367014670156701667017670186701967020670216702267023670246702567026670276702867029670306703167032670336703467035670366703767038670396704067041670426704367044670456704667047670486704967050670516705267053670546705567056670576705867059670606706167062670636706467065670666706767068670696707067071670726707367074670756707667077670786707967080670816708267083670846708567086670876708867089670906709167092670936709467095670966709767098670996710067101671026710367104671056710667107671086710967110671116711267113671146711567116671176711867119671206712167122671236712467125671266712767128671296713067131671326713367134671356713667137671386713967140671416714267143671446714567146671476714867149671506715167152671536715467155671566715767158671596716067161671626716367164671656716667167671686716967170671716717267173671746717567176671776717867179671806718167182671836718467185671866718767188671896719067191671926719367194671956719667197671986719967200672016720267203672046720567206672076720867209672106721167212672136721467215672166721767218672196722067221672226722367224672256722667227672286722967230672316723267233672346723567236672376723867239672406724167242672436724467245672466724767248672496725067251672526725367254672556725667257672586725967260672616726267263672646726567266672676726867269672706727167272672736727467275672766727767278672796728067281672826728367284672856728667287672886728967290672916729267293672946729567296672976729867299673006730167302673036730467305673066730767308673096731067311673126731367314673156731667317673186731967320673216732267323673246732567326673276732867329673306733167332673336733467335673366733767338673396734067341673426734367344673456734667347673486734967350673516735267353673546735567356673576735867359673606736167362673636736467365673666736767368673696737067371673726737367374673756737667377673786737967380673816738267383673846738567386673876738867389673906739167392673936739467395673966739767398673996740067401674026740367404674056740667407674086740967410674116741267413674146741567416674176741867419674206742167422674236742467425674266742767428674296743067431674326743367434674356743667437674386743967440674416744267443674446744567446674476744867449674506745167452674536745467455674566745767458674596746067461674626746367464674656746667467674686746967470674716747267473674746747567476674776747867479674806748167482674836748467485674866748767488674896749067491674926749367494674956749667497674986749967500675016750267503675046750567506675076750867509675106751167512675136751467515675166751767518675196752067521675226752367524675256752667527675286752967530675316753267533675346753567536675376753867539675406754167542675436754467545675466754767548675496755067551675526755367554675556755667557675586755967560675616756267563675646756567566675676756867569675706757167572675736757467575675766757767578675796758067581675826758367584675856758667587675886758967590675916759267593675946759567596675976759867599676006760167602676036760467605676066760767608676096761067611676126761367614676156761667617676186761967620676216762267623676246762567626676276762867629676306763167632676336763467635676366763767638676396764067641676426764367644676456764667647676486764967650676516765267653676546765567656676576765867659676606766167662676636766467665676666766767668676696767067671676726767367674676756767667677676786767967680676816768267683676846768567686676876768867689676906769167692676936769467695676966769767698676996770067701677026770367704677056770667707677086770967710677116771267713677146771567716677176771867719677206772167722677236772467725677266772767728677296773067731677326773367734677356773667737677386773967740677416774267743677446774567746677476774867749677506775167752677536775467755677566775767758677596776067761677626776367764677656776667767677686776967770677716777267773677746777567776677776777867779677806778167782677836778467785677866778767788677896779067791677926779367794677956779667797677986779967800678016780267803678046780567806678076780867809678106781167812678136781467815678166781767818678196782067821678226782367824678256782667827678286782967830678316783267833678346783567836678376783867839678406784167842678436784467845678466784767848678496785067851678526785367854678556785667857678586785967860678616786267863678646786567866678676786867869678706787167872678736787467875678766787767878678796788067881678826788367884678856788667887678886788967890678916789267893678946789567896678976789867899679006790167902679036790467905679066790767908679096791067911679126791367914679156791667917679186791967920679216792267923679246792567926679276792867929679306793167932679336793467935679366793767938679396794067941679426794367944679456794667947679486794967950679516795267953679546795567956679576795867959679606796167962679636796467965679666796767968679696797067971679726797367974679756797667977679786797967980679816798267983679846798567986679876798867989679906799167992679936799467995679966799767998679996800068001680026800368004680056800668007680086800968010680116801268013680146801568016680176801868019680206802168022680236802468025680266802768028680296803068031680326803368034680356803668037680386803968040680416804268043680446804568046680476804868049680506805168052680536805468055680566805768058680596806068061680626806368064680656806668067680686806968070680716807268073680746807568076680776807868079680806808168082680836808468085680866808768088680896809068091680926809368094680956809668097680986809968100681016810268103681046810568106681076810868109681106811168112681136811468115681166811768118681196812068121681226812368124681256812668127681286812968130681316813268133681346813568136681376813868139681406814168142681436814468145681466814768148681496815068151681526815368154681556815668157681586815968160681616816268163681646816568166681676816868169681706817168172681736817468175681766817768178681796818068181681826818368184681856818668187681886818968190681916819268193681946819568196681976819868199682006820168202682036820468205682066820768208682096821068211682126821368214682156821668217682186821968220682216822268223682246822568226682276822868229682306823168232682336823468235682366823768238682396824068241682426824368244682456824668247682486824968250682516825268253682546825568256682576825868259682606826168262682636826468265682666826768268682696827068271682726827368274682756827668277682786827968280682816828268283682846828568286682876828868289682906829168292682936829468295682966829768298682996830068301683026830368304683056830668307683086830968310683116831268313683146831568316683176831868319683206832168322683236832468325683266832768328683296833068331683326833368334683356833668337683386833968340683416834268343683446834568346683476834868349683506835168352683536835468355683566835768358683596836068361683626836368364683656836668367683686836968370683716837268373683746837568376683776837868379683806838168382683836838468385683866838768388683896839068391683926839368394683956839668397683986839968400684016840268403684046840568406684076840868409684106841168412684136841468415684166841768418684196842068421684226842368424684256842668427684286842968430684316843268433684346843568436684376843868439684406844168442684436844468445684466844768448684496845068451684526845368454684556845668457684586845968460684616846268463684646846568466684676846868469684706847168472684736847468475684766847768478684796848068481684826848368484684856848668487684886848968490684916849268493684946849568496684976849868499685006850168502685036850468505685066850768508685096851068511685126851368514685156851668517685186851968520685216852268523685246852568526685276852868529685306853168532685336853468535685366853768538685396854068541685426854368544685456854668547685486854968550685516855268553685546855568556685576855868559685606856168562685636856468565685666856768568685696857068571685726857368574685756857668577685786857968580685816858268583685846858568586685876858868589685906859168592685936859468595685966859768598685996860068601686026860368604686056860668607686086860968610686116861268613686146861568616686176861868619686206862168622686236862468625686266862768628686296863068631686326863368634686356863668637686386863968640686416864268643686446864568646686476864868649686506865168652686536865468655686566865768658686596866068661686626866368664686656866668667686686866968670686716867268673686746867568676686776867868679686806868168682686836868468685686866868768688686896869068691686926869368694686956869668697686986869968700687016870268703687046870568706687076870868709687106871168712687136871468715687166871768718687196872068721687226872368724687256872668727687286872968730687316873268733687346873568736687376873868739687406874168742687436874468745687466874768748687496875068751687526875368754687556875668757687586875968760687616876268763687646876568766687676876868769687706877168772687736877468775687766877768778687796878068781687826878368784687856878668787687886878968790687916879268793687946879568796687976879868799688006880168802688036880468805688066880768808688096881068811688126881368814688156881668817688186881968820688216882268823688246882568826688276882868829688306883168832688336883468835688366883768838688396884068841688426884368844688456884668847688486884968850688516885268853688546885568856688576885868859688606886168862688636886468865688666886768868688696887068871688726887368874688756887668877688786887968880688816888268883688846888568886688876888868889688906889168892688936889468895688966889768898688996890068901689026890368904689056890668907689086890968910689116891268913689146891568916689176891868919689206892168922689236892468925689266892768928689296893068931689326893368934689356893668937689386893968940689416894268943689446894568946689476894868949689506895168952689536895468955689566895768958689596896068961689626896368964689656896668967689686896968970689716897268973689746897568976689776897868979689806898168982689836898468985689866898768988689896899068991689926899368994689956899668997689986899969000690016900269003690046900569006690076900869009690106901169012690136901469015690166901769018690196902069021690226902369024690256902669027690286902969030690316903269033690346903569036690376903869039690406904169042690436904469045690466904769048690496905069051690526905369054690556905669057690586905969060690616906269063690646906569066690676906869069690706907169072690736907469075690766907769078690796908069081690826908369084690856908669087690886908969090690916909269093690946909569096690976909869099691006910169102691036910469105691066910769108691096911069111691126911369114691156911669117691186911969120691216912269123691246912569126691276912869129691306913169132691336913469135691366913769138691396914069141691426914369144691456914669147691486914969150691516915269153691546915569156691576915869159691606916169162691636916469165691666916769168691696917069171691726917369174691756917669177691786917969180691816918269183691846918569186691876918869189691906919169192691936919469195691966919769198691996920069201692026920369204692056920669207692086920969210692116921269213692146921569216692176921869219692206922169222692236922469225692266922769228692296923069231692326923369234692356923669237692386923969240692416924269243692446924569246692476924869249692506925169252692536925469255692566925769258692596926069261692626926369264692656926669267692686926969270692716927269273692746927569276692776927869279692806928169282692836928469285692866928769288692896929069291692926929369294692956929669297692986929969300693016930269303693046930569306693076930869309693106931169312693136931469315693166931769318693196932069321693226932369324693256932669327693286932969330693316933269333693346933569336693376933869339693406934169342693436934469345693466934769348693496935069351693526935369354693556935669357693586935969360693616936269363693646936569366693676936869369693706937169372693736937469375693766937769378693796938069381693826938369384693856938669387693886938969390693916939269393693946939569396693976939869399694006940169402694036940469405694066940769408694096941069411694126941369414694156941669417694186941969420694216942269423694246942569426694276942869429694306943169432694336943469435694366943769438694396944069441694426944369444694456944669447694486944969450694516945269453694546945569456694576945869459694606946169462694636946469465694666946769468694696947069471694726947369474694756947669477694786947969480694816948269483694846948569486694876948869489694906949169492694936949469495694966949769498694996950069501695026950369504695056950669507695086950969510695116951269513695146951569516695176951869519695206952169522695236952469525695266952769528695296953069531695326953369534695356953669537695386953969540695416954269543695446954569546695476954869549695506955169552695536955469555695566955769558695596956069561695626956369564695656956669567695686956969570695716957269573695746957569576695776957869579695806958169582695836958469585695866958769588695896959069591695926959369594695956959669597695986959969600696016960269603696046960569606696076960869609696106961169612696136961469615696166961769618696196962069621696226962369624696256962669627696286962969630696316963269633696346963569636696376963869639696406964169642696436964469645696466964769648696496965069651696526965369654696556965669657696586965969660696616966269663696646966569666696676966869669696706967169672696736967469675696766967769678696796968069681696826968369684696856968669687696886968969690696916969269693696946969569696696976969869699697006970169702697036970469705697066970769708697096971069711697126971369714697156971669717697186971969720697216972269723697246972569726697276972869729697306973169732697336973469735697366973769738697396974069741697426974369744697456974669747697486974969750697516975269753697546975569756697576975869759697606976169762697636976469765697666976769768697696977069771697726977369774697756977669777697786977969780697816978269783697846978569786697876978869789697906979169792697936979469795697966979769798697996980069801698026980369804698056980669807698086980969810698116981269813698146981569816698176981869819698206982169822698236982469825698266982769828698296983069831698326983369834698356983669837698386983969840698416984269843698446984569846698476984869849698506985169852698536985469855698566985769858698596986069861698626986369864698656986669867698686986969870698716987269873698746987569876698776987869879698806988169882698836988469885698866988769888698896989069891698926989369894698956989669897698986989969900699016990269903699046990569906699076990869909699106991169912699136991469915699166991769918699196992069921699226992369924699256992669927699286992969930699316993269933699346993569936699376993869939699406994169942699436994469945699466994769948699496995069951699526995369954699556995669957699586995969960699616996269963699646996569966699676996869969699706997169972699736997469975699766997769978699796998069981699826998369984699856998669987699886998969990699916999269993699946999569996699976999869999700007000170002700037000470005700067000770008700097001070011700127001370014700157001670017700187001970020700217002270023700247002570026700277002870029700307003170032700337003470035700367003770038700397004070041700427004370044700457004670047700487004970050700517005270053700547005570056700577005870059700607006170062700637006470065700667006770068700697007070071700727007370074700757007670077700787007970080700817008270083700847008570086700877008870089700907009170092700937009470095700967009770098700997010070101701027010370104701057010670107701087010970110701117011270113701147011570116701177011870119701207012170122701237012470125701267012770128701297013070131701327013370134701357013670137701387013970140701417014270143701447014570146701477014870149701507015170152701537015470155701567015770158701597016070161701627016370164701657016670167701687016970170701717017270173701747017570176701777017870179701807018170182701837018470185701867018770188701897019070191701927019370194701957019670197701987019970200702017020270203702047020570206702077020870209702107021170212702137021470215702167021770218702197022070221702227022370224702257022670227702287022970230702317023270233702347023570236702377023870239702407024170242702437024470245702467024770248702497025070251702527025370254702557025670257702587025970260702617026270263702647026570266702677026870269702707027170272702737027470275702767027770278702797028070281702827028370284702857028670287702887028970290702917029270293702947029570296702977029870299703007030170302703037030470305703067030770308703097031070311703127031370314703157031670317703187031970320703217032270323703247032570326703277032870329703307033170332703337033470335703367033770338703397034070341703427034370344703457034670347703487034970350703517035270353703547035570356703577035870359703607036170362703637036470365703667036770368703697037070371703727037370374703757037670377703787037970380703817038270383703847038570386703877038870389703907039170392703937039470395703967039770398703997040070401704027040370404704057040670407704087040970410704117041270413704147041570416704177041870419704207042170422704237042470425704267042770428704297043070431704327043370434704357043670437704387043970440704417044270443704447044570446704477044870449704507045170452704537045470455704567045770458704597046070461704627046370464704657046670467704687046970470704717047270473704747047570476704777047870479704807048170482704837048470485704867048770488704897049070491704927049370494704957049670497704987049970500705017050270503705047050570506705077050870509705107051170512705137051470515705167051770518705197052070521705227052370524705257052670527705287052970530705317053270533705347053570536705377053870539705407054170542705437054470545705467054770548705497055070551705527055370554705557055670557705587055970560705617056270563705647056570566705677056870569705707057170572705737057470575705767057770578705797058070581705827058370584705857058670587705887058970590705917059270593705947059570596705977059870599706007060170602706037060470605706067060770608706097061070611706127061370614706157061670617706187061970620706217062270623706247062570626706277062870629706307063170632706337063470635706367063770638706397064070641706427064370644706457064670647706487064970650706517065270653706547065570656706577065870659706607066170662706637066470665706667066770668706697067070671706727067370674706757067670677706787067970680706817068270683706847068570686706877068870689706907069170692706937069470695706967069770698706997070070701707027070370704707057070670707707087070970710707117071270713707147071570716707177071870719707207072170722707237072470725707267072770728707297073070731707327073370734707357073670737707387073970740707417074270743707447074570746707477074870749707507075170752707537075470755707567075770758707597076070761707627076370764707657076670767707687076970770707717077270773707747077570776707777077870779707807078170782707837078470785707867078770788707897079070791707927079370794707957079670797707987079970800708017080270803708047080570806708077080870809708107081170812708137081470815708167081770818708197082070821708227082370824708257082670827708287082970830708317083270833708347083570836708377083870839708407084170842708437084470845708467084770848708497085070851708527085370854708557085670857708587085970860708617086270863708647086570866708677086870869708707087170872708737087470875708767087770878708797088070881708827088370884708857088670887708887088970890708917089270893708947089570896708977089870899709007090170902709037090470905709067090770908709097091070911709127091370914709157091670917709187091970920709217092270923709247092570926709277092870929709307093170932709337093470935709367093770938709397094070941709427094370944709457094670947709487094970950709517095270953709547095570956709577095870959709607096170962709637096470965709667096770968709697097070971709727097370974709757097670977709787097970980709817098270983709847098570986709877098870989709907099170992709937099470995709967099770998709997100071001710027100371004710057100671007710087100971010710117101271013710147101571016710177101871019710207102171022710237102471025710267102771028710297103071031710327103371034710357103671037710387103971040710417104271043710447104571046710477104871049710507105171052710537105471055710567105771058710597106071061710627106371064710657106671067710687106971070710717107271073710747107571076710777107871079710807108171082710837108471085710867108771088710897109071091710927109371094710957109671097710987109971100711017110271103711047110571106711077110871109711107111171112711137111471115711167111771118711197112071121711227112371124711257112671127711287112971130711317113271133711347113571136711377113871139711407114171142711437114471145711467114771148711497115071151711527115371154711557115671157711587115971160711617116271163711647116571166711677116871169711707117171172711737117471175711767117771178711797118071181711827118371184711857118671187711887118971190711917119271193711947119571196711977119871199712007120171202712037120471205712067120771208712097121071211712127121371214712157121671217712187121971220712217122271223712247122571226712277122871229712307123171232712337123471235712367123771238712397124071241712427124371244712457124671247712487124971250712517125271253712547125571256712577125871259712607126171262712637126471265712667126771268712697127071271712727127371274712757127671277712787127971280712817128271283712847128571286712877128871289712907129171292712937129471295712967129771298712997130071301713027130371304713057130671307713087130971310713117131271313713147131571316713177131871319713207132171322713237132471325713267132771328713297133071331713327133371334713357133671337713387133971340713417134271343713447134571346713477134871349713507135171352713537135471355713567135771358713597136071361713627136371364713657136671367713687136971370713717137271373713747137571376713777137871379713807138171382713837138471385713867138771388713897139071391713927139371394713957139671397713987139971400714017140271403714047140571406714077140871409714107141171412714137141471415714167141771418714197142071421714227142371424714257142671427714287142971430714317143271433714347143571436714377143871439714407144171442714437144471445714467144771448714497145071451714527145371454714557145671457714587145971460714617146271463714647146571466714677146871469714707147171472714737147471475714767147771478714797148071481714827148371484714857148671487714887148971490714917149271493714947149571496714977149871499715007150171502715037150471505715067150771508715097151071511715127151371514715157151671517715187151971520715217152271523715247152571526715277152871529715307153171532715337153471535715367153771538715397154071541715427154371544715457154671547715487154971550715517155271553715547155571556715577155871559715607156171562715637156471565715667156771568715697157071571715727157371574715757157671577715787157971580715817158271583715847158571586715877158871589715907159171592715937159471595715967159771598715997160071601716027160371604716057160671607716087160971610716117161271613716147161571616716177161871619716207162171622716237162471625716267162771628716297163071631716327163371634716357163671637716387163971640716417164271643716447164571646716477164871649716507165171652716537165471655716567165771658716597166071661716627166371664716657166671667716687166971670716717167271673716747167571676716777167871679716807168171682716837168471685716867168771688716897169071691716927169371694716957169671697716987169971700717017170271703717047170571706717077170871709717107171171712717137171471715717167171771718717197172071721717227172371724717257172671727717287172971730717317173271733717347173571736717377173871739717407174171742717437174471745717467174771748717497175071751717527175371754717557175671757717587175971760717617176271763717647176571766717677176871769717707177171772717737177471775717767177771778717797178071781717827178371784717857178671787717887178971790717917179271793717947179571796717977179871799718007180171802718037180471805718067180771808718097181071811718127181371814718157181671817718187181971820718217182271823718247182571826718277182871829718307183171832718337183471835718367183771838718397184071841718427184371844718457184671847718487184971850718517185271853718547185571856718577185871859718607186171862718637186471865718667186771868718697187071871718727187371874718757187671877718787187971880718817188271883718847188571886718877188871889718907189171892718937189471895718967189771898718997190071901719027190371904719057190671907719087190971910719117191271913719147191571916719177191871919719207192171922719237192471925719267192771928719297193071931719327193371934719357193671937719387193971940719417194271943719447194571946719477194871949719507195171952719537195471955719567195771958719597196071961719627196371964719657196671967719687196971970719717197271973719747197571976719777197871979719807198171982719837198471985719867198771988719897199071991719927199371994719957199671997719987199972000720017200272003720047200572006720077200872009720107201172012720137201472015720167201772018720197202072021720227202372024720257202672027720287202972030720317203272033720347203572036720377203872039720407204172042720437204472045720467204772048720497205072051720527205372054720557205672057720587205972060720617206272063720647206572066720677206872069720707207172072720737207472075720767207772078720797208072081720827208372084720857208672087720887208972090720917209272093720947209572096720977209872099721007210172102721037210472105721067210772108721097211072111721127211372114721157211672117721187211972120721217212272123721247212572126721277212872129721307213172132721337213472135721367213772138721397214072141721427214372144721457214672147721487214972150721517215272153721547215572156721577215872159721607216172162721637216472165721667216772168721697217072171721727217372174721757217672177721787217972180721817218272183721847218572186721877218872189721907219172192721937219472195721967219772198721997220072201722027220372204722057220672207722087220972210722117221272213722147221572216722177221872219722207222172222722237222472225722267222772228722297223072231722327223372234722357223672237722387223972240722417224272243722447224572246722477224872249722507225172252722537225472255722567225772258722597226072261722627226372264722657226672267722687226972270722717227272273722747227572276722777227872279722807228172282722837228472285722867228772288722897229072291722927229372294722957229672297722987229972300723017230272303723047230572306723077230872309723107231172312723137231472315723167231772318723197232072321723227232372324723257232672327723287232972330723317233272333723347233572336723377233872339723407234172342723437234472345723467234772348723497235072351723527235372354723557235672357723587235972360723617236272363723647236572366723677236872369723707237172372723737237472375723767237772378723797238072381723827238372384723857238672387723887238972390723917239272393723947239572396723977239872399724007240172402724037240472405724067240772408724097241072411724127241372414724157241672417724187241972420724217242272423724247242572426724277242872429724307243172432724337243472435724367243772438724397244072441724427244372444724457244672447724487244972450724517245272453724547245572456724577245872459724607246172462724637246472465724667246772468724697247072471724727247372474724757247672477724787247972480724817248272483724847248572486724877248872489724907249172492724937249472495724967249772498724997250072501725027250372504725057250672507725087250972510725117251272513725147251572516725177251872519725207252172522725237252472525725267252772528725297253072531725327253372534725357253672537725387253972540725417254272543725447254572546725477254872549725507255172552725537255472555725567255772558725597256072561725627256372564725657256672567725687256972570725717257272573725747257572576725777257872579725807258172582725837258472585725867258772588725897259072591725927259372594725957259672597725987259972600726017260272603726047260572606726077260872609726107261172612726137261472615726167261772618726197262072621726227262372624726257262672627726287262972630726317263272633726347263572636726377263872639726407264172642726437264472645726467264772648726497265072651726527265372654726557265672657726587265972660726617266272663726647266572666726677266872669726707267172672726737267472675726767267772678726797268072681726827268372684726857268672687726887268972690726917269272693726947269572696726977269872699727007270172702727037270472705727067270772708727097271072711727127271372714727157271672717727187271972720727217272272723727247272572726727277272872729727307273172732727337273472735727367273772738727397274072741727427274372744727457274672747727487274972750727517275272753727547275572756727577275872759727607276172762727637276472765727667276772768727697277072771727727277372774727757277672777727787277972780727817278272783727847278572786727877278872789727907279172792727937279472795727967279772798727997280072801728027280372804728057280672807728087280972810728117281272813728147281572816728177281872819728207282172822728237282472825728267282772828728297283072831728327283372834728357283672837728387283972840728417284272843728447284572846728477284872849728507285172852728537285472855728567285772858728597286072861728627286372864728657286672867728687286972870728717287272873728747287572876728777287872879728807288172882728837288472885728867288772888728897289072891728927289372894728957289672897728987289972900729017290272903729047290572906729077290872909729107291172912729137291472915729167291772918729197292072921729227292372924729257292672927729287292972930729317293272933729347293572936729377293872939729407294172942729437294472945729467294772948729497295072951729527295372954729557295672957729587295972960729617296272963729647296572966729677296872969729707297172972729737297472975729767297772978729797298072981729827298372984729857298672987729887298972990729917299272993729947299572996729977299872999730007300173002730037300473005730067300773008730097301073011730127301373014730157301673017730187301973020730217302273023730247302573026730277302873029730307303173032730337303473035730367303773038730397304073041730427304373044730457304673047730487304973050730517305273053730547305573056730577305873059730607306173062730637306473065730667306773068730697307073071730727307373074730757307673077730787307973080730817308273083730847308573086730877308873089730907309173092730937309473095730967309773098730997310073101731027310373104731057310673107731087310973110731117311273113731147311573116731177311873119731207312173122731237312473125731267312773128731297313073131731327313373134731357313673137731387313973140731417314273143731447314573146731477314873149731507315173152731537315473155731567315773158731597316073161731627316373164731657316673167731687316973170731717317273173731747317573176731777317873179731807318173182731837318473185731867318773188731897319073191731927319373194731957319673197731987319973200732017320273203732047320573206732077320873209732107321173212732137321473215732167321773218732197322073221732227322373224732257322673227732287322973230732317323273233732347323573236732377323873239732407324173242732437324473245732467324773248732497325073251732527325373254732557325673257732587325973260732617326273263732647326573266732677326873269732707327173272732737327473275732767327773278732797328073281732827328373284732857328673287732887328973290732917329273293732947329573296732977329873299733007330173302733037330473305733067330773308733097331073311733127331373314733157331673317733187331973320733217332273323733247332573326733277332873329733307333173332733337333473335733367333773338733397334073341733427334373344733457334673347733487334973350733517335273353733547335573356733577335873359733607336173362733637336473365733667336773368733697337073371733727337373374733757337673377733787337973380733817338273383733847338573386733877338873389733907339173392733937339473395733967339773398733997340073401734027340373404734057340673407734087340973410734117341273413734147341573416734177341873419734207342173422734237342473425734267342773428734297343073431734327343373434734357343673437734387343973440734417344273443734447344573446734477344873449734507345173452734537345473455734567345773458734597346073461734627346373464734657346673467734687346973470734717347273473734747347573476734777347873479734807348173482734837348473485734867348773488734897349073491734927349373494734957349673497734987349973500735017350273503735047350573506735077350873509735107351173512735137351473515735167351773518735197352073521735227352373524735257352673527735287352973530735317353273533735347353573536735377353873539735407354173542735437354473545735467354773548735497355073551735527355373554735557355673557735587355973560735617356273563735647356573566735677356873569735707357173572735737357473575735767357773578735797358073581735827358373584735857358673587735887358973590735917359273593735947359573596735977359873599736007360173602736037360473605736067360773608736097361073611736127361373614736157361673617736187361973620736217362273623736247362573626736277362873629736307363173632736337363473635736367363773638736397364073641736427364373644736457364673647736487364973650736517365273653736547365573656736577365873659736607366173662736637366473665736667366773668736697367073671736727367373674736757367673677736787367973680736817368273683736847368573686736877368873689736907369173692736937369473695736967369773698736997370073701737027370373704737057370673707737087370973710737117371273713737147371573716737177371873719737207372173722737237372473725737267372773728737297373073731737327373373734737357373673737737387373973740737417374273743737447374573746737477374873749737507375173752737537375473755737567375773758737597376073761737627376373764737657376673767737687376973770737717377273773737747377573776737777377873779737807378173782737837378473785737867378773788737897379073791737927379373794737957379673797737987379973800738017380273803738047380573806738077380873809738107381173812738137381473815738167381773818738197382073821738227382373824738257382673827738287382973830738317383273833738347383573836738377383873839738407384173842738437384473845738467384773848738497385073851738527385373854738557385673857738587385973860738617386273863738647386573866738677386873869738707387173872738737387473875738767387773878738797388073881738827388373884738857388673887738887388973890738917389273893738947389573896738977389873899739007390173902739037390473905739067390773908739097391073911739127391373914739157391673917739187391973920739217392273923739247392573926739277392873929739307393173932739337393473935739367393773938739397394073941739427394373944739457394673947739487394973950739517395273953739547395573956739577395873959739607396173962739637396473965739667396773968739697397073971739727397373974739757397673977739787397973980739817398273983739847398573986739877398873989739907399173992739937399473995739967399773998739997400074001740027400374004740057400674007740087400974010740117401274013740147401574016740177401874019740207402174022740237402474025740267402774028740297403074031740327403374034740357403674037740387403974040740417404274043740447404574046740477404874049740507405174052740537405474055740567405774058740597406074061740627406374064740657406674067740687406974070740717407274073740747407574076740777407874079740807408174082740837408474085740867408774088740897409074091740927409374094740957409674097740987409974100741017410274103741047410574106741077410874109741107411174112741137411474115741167411774118741197412074121741227412374124741257412674127741287412974130741317413274133741347413574136741377413874139741407414174142741437414474145741467414774148741497415074151741527415374154741557415674157741587415974160741617416274163741647416574166741677416874169741707417174172741737417474175741767417774178741797418074181741827418374184741857418674187741887418974190741917419274193741947419574196741977419874199742007420174202742037420474205742067420774208742097421074211742127421374214742157421674217742187421974220742217422274223742247422574226742277422874229742307423174232742337423474235742367423774238742397424074241742427424374244742457424674247742487424974250742517425274253742547425574256742577425874259742607426174262742637426474265742667426774268742697427074271742727427374274742757427674277742787427974280742817428274283742847428574286742877428874289742907429174292742937429474295742967429774298742997430074301743027430374304743057430674307743087430974310743117431274313743147431574316743177431874319743207432174322743237432474325743267432774328743297433074331743327433374334743357433674337743387433974340743417434274343743447434574346743477434874349743507435174352743537435474355743567435774358743597436074361743627436374364743657436674367743687436974370743717437274373743747437574376743777437874379743807438174382743837438474385743867438774388743897439074391743927439374394743957439674397743987439974400744017440274403744047440574406744077440874409744107441174412744137441474415744167441774418744197442074421744227442374424744257442674427744287442974430744317443274433744347443574436744377443874439744407444174442744437444474445744467444774448744497445074451744527445374454744557445674457744587445974460744617446274463744647446574466744677446874469744707447174472744737447474475744767447774478744797448074481744827448374484744857448674487744887448974490744917449274493744947449574496744977449874499745007450174502745037450474505745067450774508745097451074511745127451374514745157451674517745187451974520745217452274523745247452574526745277452874529745307453174532745337453474535745367453774538745397454074541745427454374544745457454674547745487454974550745517455274553745547455574556745577455874559745607456174562745637456474565745667456774568745697457074571745727457374574745757457674577745787457974580745817458274583745847458574586745877458874589745907459174592745937459474595745967459774598745997460074601746027460374604746057460674607746087460974610746117461274613746147461574616746177461874619746207462174622746237462474625746267462774628746297463074631746327463374634746357463674637746387463974640746417464274643746447464574646746477464874649746507465174652746537465474655746567465774658746597466074661746627466374664746657466674667746687466974670746717467274673746747467574676746777467874679746807468174682746837468474685746867468774688746897469074691746927469374694746957469674697746987469974700747017470274703747047470574706747077470874709747107471174712747137471474715747167471774718747197472074721747227472374724747257472674727747287472974730747317473274733747347473574736747377473874739747407474174742747437474474745747467474774748747497475074751747527475374754747557475674757747587475974760747617476274763747647476574766747677476874769747707477174772747737477474775747767477774778747797478074781747827478374784747857478674787747887478974790747917479274793747947479574796747977479874799748007480174802748037480474805748067480774808748097481074811748127481374814748157481674817748187481974820748217482274823748247482574826748277482874829748307483174832748337483474835748367483774838748397484074841748427484374844748457484674847748487484974850748517485274853748547485574856748577485874859748607486174862748637486474865748667486774868748697487074871748727487374874748757487674877748787487974880748817488274883748847488574886748877488874889748907489174892748937489474895748967489774898748997490074901749027490374904749057490674907749087490974910749117491274913749147491574916749177491874919749207492174922749237492474925749267492774928749297493074931749327493374934749357493674937749387493974940749417494274943749447494574946749477494874949749507495174952749537495474955749567495774958749597496074961749627496374964749657496674967749687496974970749717497274973749747497574976749777497874979749807498174982749837498474985749867498774988749897499074991749927499374994749957499674997749987499975000750017500275003750047500575006750077500875009750107501175012750137501475015750167501775018750197502075021750227502375024750257502675027750287502975030750317503275033750347503575036750377503875039750407504175042750437504475045750467504775048750497505075051750527505375054750557505675057750587505975060750617506275063750647506575066750677506875069750707507175072750737507475075750767507775078750797508075081750827508375084750857508675087750887508975090750917509275093750947509575096750977509875099751007510175102751037510475105751067510775108751097511075111751127511375114751157511675117751187511975120751217512275123751247512575126751277512875129751307513175132751337513475135751367513775138751397514075141751427514375144751457514675147751487514975150751517515275153751547515575156751577515875159751607516175162751637516475165751667516775168751697517075171751727517375174751757517675177751787517975180751817518275183751847518575186751877518875189751907519175192751937519475195751967519775198751997520075201752027520375204752057520675207752087520975210752117521275213752147521575216752177521875219752207522175222752237522475225752267522775228752297523075231752327523375234752357523675237752387523975240752417524275243752447524575246752477524875249752507525175252752537525475255752567525775258752597526075261752627526375264752657526675267752687526975270752717527275273752747527575276752777527875279752807528175282752837528475285752867528775288752897529075291752927529375294752957529675297752987529975300753017530275303753047530575306753077530875309753107531175312753137531475315753167531775318753197532075321753227532375324753257532675327753287532975330753317533275333753347533575336753377533875339753407534175342753437534475345753467534775348753497535075351753527535375354753557535675357753587535975360753617536275363753647536575366753677536875369753707537175372753737537475375753767537775378753797538075381753827538375384753857538675387753887538975390753917539275393753947539575396753977539875399754007540175402754037540475405754067540775408754097541075411754127541375414754157541675417754187541975420754217542275423754247542575426754277542875429754307543175432754337543475435754367543775438754397544075441754427544375444754457544675447754487544975450754517545275453754547545575456754577545875459754607546175462754637546475465754667546775468754697547075471754727547375474754757547675477754787547975480754817548275483754847548575486754877548875489754907549175492754937549475495754967549775498754997550075501755027550375504755057550675507755087550975510755117551275513755147551575516755177551875519755207552175522755237552475525755267552775528755297553075531755327553375534755357553675537755387553975540755417554275543755447554575546755477554875549755507555175552755537555475555755567555775558755597556075561755627556375564755657556675567755687556975570755717557275573755747557575576755777557875579755807558175582755837558475585755867558775588755897559075591755927559375594755957559675597755987559975600756017560275603756047560575606756077560875609756107561175612756137561475615756167561775618756197562075621756227562375624756257562675627756287562975630756317563275633756347563575636756377563875639756407564175642756437564475645756467564775648756497565075651756527565375654756557565675657756587565975660756617566275663756647566575666756677566875669756707567175672756737567475675756767567775678756797568075681756827568375684756857568675687756887568975690756917569275693756947569575696756977569875699757007570175702757037570475705757067570775708757097571075711757127571375714757157571675717757187571975720757217572275723757247572575726757277572875729757307573175732757337573475735757367573775738757397574075741757427574375744757457574675747757487574975750757517575275753757547575575756757577575875759757607576175762757637576475765757667576775768757697577075771757727577375774757757577675777757787577975780757817578275783757847578575786757877578875789757907579175792757937579475795757967579775798757997580075801758027580375804758057580675807758087580975810758117581275813758147581575816758177581875819758207582175822758237582475825758267582775828758297583075831758327583375834758357583675837758387583975840758417584275843758447584575846758477584875849758507585175852758537585475855758567585775858758597586075861758627586375864758657586675867758687586975870758717587275873758747587575876758777587875879758807588175882758837588475885758867588775888758897589075891758927589375894758957589675897758987589975900759017590275903759047590575906759077590875909759107591175912759137591475915759167591775918759197592075921759227592375924759257592675927759287592975930759317593275933759347593575936759377593875939759407594175942759437594475945759467594775948759497595075951759527595375954759557595675957759587595975960759617596275963759647596575966759677596875969759707597175972759737597475975759767597775978759797598075981759827598375984759857598675987759887598975990759917599275993759947599575996759977599875999760007600176002760037600476005760067600776008760097601076011760127601376014760157601676017760187601976020760217602276023760247602576026760277602876029760307603176032760337603476035760367603776038760397604076041760427604376044760457604676047760487604976050760517605276053760547605576056760577605876059760607606176062760637606476065760667606776068760697607076071760727607376074760757607676077760787607976080760817608276083760847608576086760877608876089760907609176092760937609476095760967609776098760997610076101761027610376104761057610676107761087610976110761117611276113761147611576116761177611876119761207612176122761237612476125761267612776128761297613076131761327613376134761357613676137761387613976140761417614276143761447614576146761477614876149761507615176152761537615476155761567615776158761597616076161761627616376164761657616676167761687616976170761717617276173761747617576176761777617876179761807618176182761837618476185761867618776188761897619076191761927619376194761957619676197761987619976200762017620276203762047620576206762077620876209762107621176212762137621476215762167621776218762197622076221762227622376224762257622676227762287622976230762317623276233762347623576236762377623876239762407624176242762437624476245762467624776248762497625076251762527625376254762557625676257762587625976260762617626276263762647626576266762677626876269762707627176272762737627476275762767627776278762797628076281762827628376284762857628676287762887628976290762917629276293762947629576296762977629876299763007630176302763037630476305763067630776308763097631076311763127631376314763157631676317763187631976320763217632276323763247632576326763277632876329763307633176332763337633476335763367633776338763397634076341763427634376344763457634676347763487634976350763517635276353763547635576356763577635876359763607636176362763637636476365763667636776368763697637076371763727637376374763757637676377763787637976380763817638276383763847638576386763877638876389763907639176392763937639476395763967639776398763997640076401764027640376404764057640676407764087640976410764117641276413764147641576416764177641876419764207642176422764237642476425764267642776428764297643076431764327643376434764357643676437764387643976440764417644276443764447644576446764477644876449764507645176452764537645476455764567645776458764597646076461764627646376464764657646676467764687646976470764717647276473764747647576476764777647876479764807648176482764837648476485764867648776488764897649076491764927649376494764957649676497764987649976500765017650276503765047650576506765077650876509765107651176512765137651476515765167651776518765197652076521765227652376524765257652676527765287652976530765317653276533765347653576536765377653876539765407654176542765437654476545765467654776548765497655076551765527655376554765557655676557765587655976560765617656276563765647656576566765677656876569765707657176572765737657476575765767657776578765797658076581765827658376584765857658676587765887658976590765917659276593765947659576596765977659876599766007660176602766037660476605766067660776608766097661076611766127661376614766157661676617766187661976620766217662276623766247662576626766277662876629766307663176632766337663476635766367663776638766397664076641766427664376644766457664676647766487664976650766517665276653766547665576656766577665876659766607666176662766637666476665766667666776668766697667076671766727667376674766757667676677766787667976680766817668276683766847668576686766877668876689766907669176692766937669476695766967669776698766997670076701767027670376704767057670676707767087670976710767117671276713767147671576716767177671876719767207672176722767237672476725767267672776728767297673076731767327673376734767357673676737767387673976740767417674276743767447674576746767477674876749767507675176752767537675476755767567675776758767597676076761767627676376764767657676676767767687676976770767717677276773767747677576776767777677876779767807678176782767837678476785767867678776788767897679076791767927679376794767957679676797767987679976800768017680276803768047680576806768077680876809768107681176812768137681476815768167681776818768197682076821768227682376824768257682676827768287682976830768317683276833768347683576836768377683876839768407684176842768437684476845768467684776848768497685076851768527685376854768557685676857768587685976860768617686276863768647686576866768677686876869768707687176872768737687476875768767687776878768797688076881768827688376884768857688676887768887688976890768917689276893768947689576896768977689876899769007690176902769037690476905769067690776908769097691076911769127691376914769157691676917769187691976920769217692276923769247692576926769277692876929769307693176932769337693476935769367693776938769397694076941769427694376944769457694676947769487694976950769517695276953769547695576956769577695876959769607696176962769637696476965769667696776968769697697076971769727697376974769757697676977769787697976980769817698276983769847698576986769877698876989769907699176992769937699476995769967699776998769997700077001770027700377004770057700677007770087700977010770117701277013770147701577016770177701877019770207702177022770237702477025770267702777028770297703077031770327703377034770357703677037770387703977040770417704277043770447704577046770477704877049770507705177052770537705477055770567705777058770597706077061770627706377064770657706677067770687706977070770717707277073770747707577076770777707877079770807708177082770837708477085770867708777088770897709077091770927709377094770957709677097770987709977100771017710277103771047710577106771077710877109771107711177112771137711477115771167711777118771197712077121771227712377124771257712677127771287712977130771317713277133771347713577136771377713877139771407714177142771437714477145771467714777148771497715077151771527715377154771557715677157771587715977160771617716277163771647716577166771677716877169771707717177172771737717477175771767717777178771797718077181771827718377184771857718677187771887718977190771917719277193771947719577196771977719877199772007720177202772037720477205772067720777208772097721077211772127721377214772157721677217772187721977220772217722277223772247722577226772277722877229772307723177232772337723477235772367723777238772397724077241772427724377244772457724677247772487724977250772517725277253772547725577256772577725877259772607726177262772637726477265772667726777268772697727077271772727727377274772757727677277772787727977280772817728277283772847728577286772877728877289772907729177292772937729477295772967729777298772997730077301773027730377304773057730677307773087730977310773117731277313773147731577316773177731877319773207732177322773237732477325773267732777328773297733077331773327733377334773357733677337773387733977340773417734277343773447734577346773477734877349773507735177352773537735477355773567735777358773597736077361773627736377364773657736677367773687736977370773717737277373773747737577376773777737877379773807738177382773837738477385773867738777388773897739077391773927739377394773957739677397773987739977400774017740277403774047740577406774077740877409774107741177412774137741477415774167741777418774197742077421774227742377424774257742677427774287742977430774317743277433774347743577436774377743877439774407744177442774437744477445774467744777448774497745077451774527745377454774557745677457774587745977460774617746277463774647746577466774677746877469774707747177472774737747477475774767747777478774797748077481774827748377484774857748677487774887748977490774917749277493774947749577496774977749877499775007750177502775037750477505775067750777508775097751077511775127751377514775157751677517775187751977520775217752277523775247752577526775277752877529775307753177532775337753477535775367753777538775397754077541775427754377544775457754677547775487754977550775517755277553775547755577556775577755877559775607756177562775637756477565775667756777568775697757077571775727757377574775757757677577775787757977580775817758277583775847758577586775877758877589775907759177592775937759477595775967759777598775997760077601776027760377604776057760677607776087760977610776117761277613776147761577616776177761877619776207762177622776237762477625776267762777628776297763077631776327763377634776357763677637776387763977640776417764277643776447764577646776477764877649776507765177652776537765477655776567765777658776597766077661776627766377664776657766677667776687766977670776717767277673776747767577676776777767877679776807768177682776837768477685776867768777688776897769077691776927769377694776957769677697776987769977700777017770277703777047770577706777077770877709777107771177712777137771477715777167771777718777197772077721777227772377724777257772677727777287772977730777317773277733777347773577736777377773877739777407774177742777437774477745777467774777748777497775077751777527775377754777557775677757777587775977760777617776277763777647776577766777677776877769777707777177772777737777477775777767777777778777797778077781777827778377784777857778677787777887778977790777917779277793777947779577796777977779877799778007780177802778037780477805778067780777808778097781077811778127781377814778157781677817778187781977820778217782277823778247782577826778277782877829778307783177832778337783477835778367783777838778397784077841778427784377844778457784677847778487784977850778517785277853778547785577856778577785877859778607786177862778637786477865778667786777868778697787077871778727787377874778757787677877778787787977880778817788277883778847788577886778877788877889778907789177892778937789477895778967789777898778997790077901779027790377904779057790677907779087790977910779117791277913779147791577916779177791877919779207792177922779237792477925779267792777928779297793077931779327793377934779357793677937779387793977940779417794277943779447794577946779477794877949779507795177952779537795477955779567795777958779597796077961779627796377964779657796677967779687796977970779717797277973779747797577976779777797877979779807798177982779837798477985779867798777988779897799077991779927799377994779957799677997779987799978000780017800278003780047800578006780077800878009780107801178012780137801478015780167801778018780197802078021780227802378024780257802678027780287802978030780317803278033780347803578036780377803878039780407804178042780437804478045780467804778048780497805078051780527805378054780557805678057780587805978060780617806278063780647806578066780677806878069780707807178072780737807478075780767807778078780797808078081780827808378084780857808678087780887808978090780917809278093780947809578096780977809878099781007810178102781037810478105781067810778108781097811078111781127811378114781157811678117781187811978120781217812278123781247812578126781277812878129781307813178132781337813478135781367813778138781397814078141781427814378144781457814678147781487814978150781517815278153781547815578156781577815878159781607816178162781637816478165781667816778168781697817078171781727817378174781757817678177781787817978180781817818278183781847818578186781877818878189781907819178192781937819478195781967819778198781997820078201782027820378204782057820678207782087820978210782117821278213782147821578216782177821878219782207822178222782237822478225782267822778228782297823078231782327823378234782357823678237782387823978240782417824278243782447824578246782477824878249782507825178252782537825478255782567825778258782597826078261782627826378264782657826678267782687826978270782717827278273782747827578276782777827878279782807828178282782837828478285782867828778288782897829078291782927829378294782957829678297782987829978300783017830278303783047830578306783077830878309783107831178312783137831478315783167831778318783197832078321783227832378324783257832678327783287832978330783317833278333783347833578336783377833878339783407834178342783437834478345783467834778348783497835078351783527835378354783557835678357783587835978360783617836278363783647836578366783677836878369783707837178372783737837478375783767837778378783797838078381783827838378384783857838678387783887838978390783917839278393783947839578396783977839878399784007840178402784037840478405784067840778408784097841078411784127841378414784157841678417784187841978420784217842278423784247842578426784277842878429784307843178432784337843478435784367843778438784397844078441784427844378444784457844678447784487844978450784517845278453784547845578456784577845878459784607846178462784637846478465784667846778468784697847078471784727847378474784757847678477784787847978480784817848278483784847848578486784877848878489784907849178492784937849478495784967849778498784997850078501785027850378504785057850678507785087850978510785117851278513785147851578516785177851878519785207852178522785237852478525785267852778528785297853078531785327853378534785357853678537785387853978540785417854278543785447854578546785477854878549785507855178552785537855478555785567855778558785597856078561785627856378564785657856678567785687856978570785717857278573785747857578576785777857878579785807858178582785837858478585785867858778588785897859078591785927859378594785957859678597785987859978600786017860278603786047860578606786077860878609786107861178612786137861478615786167861778618786197862078621786227862378624786257862678627786287862978630786317863278633786347863578636786377863878639786407864178642786437864478645786467864778648786497865078651786527865378654786557865678657786587865978660786617866278663786647866578666786677866878669786707867178672786737867478675786767867778678786797868078681786827868378684786857868678687786887868978690786917869278693786947869578696786977869878699787007870178702787037870478705787067870778708787097871078711787127871378714787157871678717787187871978720787217872278723787247872578726787277872878729787307873178732787337873478735787367873778738787397874078741787427874378744787457874678747787487874978750787517875278753787547875578756787577875878759787607876178762787637876478765787667876778768787697877078771787727877378774787757877678777787787877978780787817878278783787847878578786787877878878789787907879178792787937879478795787967879778798787997880078801788027880378804788057880678807788087880978810788117881278813788147881578816788177881878819788207882178822788237882478825788267882778828788297883078831788327883378834788357883678837788387883978840788417884278843788447884578846788477884878849788507885178852788537885478855788567885778858788597886078861788627886378864788657886678867788687886978870788717887278873788747887578876788777887878879788807888178882788837888478885788867888778888788897889078891788927889378894788957889678897788987889978900789017890278903789047890578906789077890878909789107891178912789137891478915789167891778918789197892078921789227892378924789257892678927789287892978930789317893278933789347893578936789377893878939789407894178942789437894478945789467894778948789497895078951789527895378954789557895678957789587895978960789617896278963789647896578966789677896878969789707897178972789737897478975789767897778978789797898078981789827898378984789857898678987789887898978990789917899278993789947899578996789977899878999790007900179002790037900479005790067900779008790097901079011790127901379014790157901679017790187901979020790217902279023790247902579026790277902879029790307903179032790337903479035790367903779038790397904079041790427904379044790457904679047790487904979050790517905279053790547905579056790577905879059790607906179062790637906479065790667906779068790697907079071790727907379074790757907679077790787907979080790817908279083790847908579086790877908879089790907909179092790937909479095790967909779098790997910079101791027910379104791057910679107791087910979110791117911279113791147911579116791177911879119791207912179122791237912479125791267912779128791297913079131791327913379134791357913679137791387913979140791417914279143791447914579146791477914879149791507915179152791537915479155791567915779158791597916079161791627916379164791657916679167791687916979170791717917279173791747917579176791777917879179791807918179182791837918479185791867918779188791897919079191791927919379194791957919679197791987919979200792017920279203792047920579206792077920879209792107921179212792137921479215792167921779218792197922079221792227922379224792257922679227792287922979230792317923279233792347923579236792377923879239792407924179242792437924479245792467924779248792497925079251792527925379254792557925679257792587925979260792617926279263792647926579266792677926879269792707927179272792737927479275792767927779278792797928079281792827928379284792857928679287792887928979290792917929279293792947929579296792977929879299793007930179302793037930479305793067930779308793097931079311793127931379314793157931679317793187931979320793217932279323793247932579326793277932879329793307933179332793337933479335793367933779338793397934079341793427934379344793457934679347793487934979350793517935279353793547935579356793577935879359793607936179362793637936479365793667936779368793697937079371793727937379374793757937679377793787937979380793817938279383793847938579386793877938879389793907939179392793937939479395793967939779398793997940079401794027940379404794057940679407794087940979410794117941279413794147941579416794177941879419794207942179422794237942479425794267942779428794297943079431794327943379434794357943679437794387943979440794417944279443794447944579446794477944879449794507945179452794537945479455794567945779458794597946079461794627946379464794657946679467794687946979470794717947279473794747947579476794777947879479794807948179482794837948479485794867948779488794897949079491794927949379494794957949679497794987949979500795017950279503795047950579506795077950879509795107951179512795137951479515795167951779518795197952079521795227952379524795257952679527795287952979530795317953279533795347953579536795377953879539795407954179542795437954479545795467954779548795497955079551795527955379554795557955679557795587955979560795617956279563795647956579566795677956879569795707957179572795737957479575795767957779578795797958079581795827958379584795857958679587795887958979590795917959279593795947959579596795977959879599796007960179602796037960479605796067960779608796097961079611796127961379614796157961679617796187961979620796217962279623796247962579626796277962879629796307963179632796337963479635796367963779638796397964079641796427964379644796457964679647796487964979650796517965279653796547965579656796577965879659796607966179662796637966479665796667966779668796697967079671796727967379674796757967679677796787967979680796817968279683796847968579686796877968879689796907969179692796937969479695796967969779698796997970079701797027970379704797057970679707797087970979710797117971279713797147971579716797177971879719797207972179722797237972479725797267972779728797297973079731797327973379734797357973679737797387973979740797417974279743797447974579746797477974879749797507975179752797537975479755797567975779758797597976079761797627976379764797657976679767797687976979770797717977279773797747977579776797777977879779797807978179782797837978479785797867978779788797897979079791797927979379794797957979679797797987979979800798017980279803798047980579806798077980879809798107981179812798137981479815798167981779818798197982079821798227982379824798257982679827798287982979830798317983279833798347983579836798377983879839798407984179842798437984479845798467984779848798497985079851798527985379854798557985679857798587985979860798617986279863798647986579866798677986879869798707987179872798737987479875798767987779878798797988079881798827988379884798857988679887798887988979890798917989279893798947989579896798977989879899799007990179902799037990479905799067990779908799097991079911799127991379914799157991679917799187991979920799217992279923799247992579926799277992879929799307993179932799337993479935799367993779938799397994079941799427994379944799457994679947799487994979950799517995279953799547995579956799577995879959799607996179962799637996479965799667996779968799697997079971799727997379974799757997679977799787997979980799817998279983799847998579986799877998879989799907999179992799937999479995799967999779998799998000080001800028000380004800058000680007800088000980010800118001280013800148001580016800178001880019800208002180022800238002480025800268002780028800298003080031800328003380034800358003680037800388003980040800418004280043800448004580046800478004880049800508005180052800538005480055800568005780058800598006080061800628006380064800658006680067800688006980070800718007280073800748007580076800778007880079800808008180082800838008480085800868008780088800898009080091800928009380094800958009680097800988009980100801018010280103801048010580106801078010880109801108011180112801138011480115801168011780118801198012080121801228012380124801258012680127801288012980130801318013280133801348013580136801378013880139801408014180142801438014480145801468014780148801498015080151801528015380154801558015680157801588015980160801618016280163801648016580166801678016880169801708017180172801738017480175801768017780178801798018080181801828018380184801858018680187801888018980190801918019280193801948019580196801978019880199802008020180202802038020480205802068020780208802098021080211802128021380214802158021680217802188021980220802218022280223802248022580226802278022880229802308023180232802338023480235802368023780238802398024080241802428024380244802458024680247802488024980250802518025280253802548025580256802578025880259802608026180262802638026480265802668026780268802698027080271802728027380274802758027680277802788027980280802818028280283802848028580286802878028880289802908029180292802938029480295802968029780298802998030080301803028030380304803058030680307803088030980310803118031280313803148031580316803178031880319803208032180322803238032480325803268032780328803298033080331803328033380334803358033680337803388033980340803418034280343803448034580346803478034880349803508035180352803538035480355803568035780358803598036080361803628036380364803658036680367803688036980370803718037280373803748037580376803778037880379803808038180382803838038480385803868038780388803898039080391803928039380394803958039680397803988039980400804018040280403804048040580406804078040880409804108041180412804138041480415804168041780418804198042080421804228042380424804258042680427804288042980430804318043280433804348043580436804378043880439804408044180442804438044480445804468044780448804498045080451804528045380454804558045680457804588045980460804618046280463804648046580466804678046880469804708047180472804738047480475804768047780478804798048080481804828048380484804858048680487804888048980490804918049280493804948049580496804978049880499805008050180502805038050480505805068050780508805098051080511805128051380514805158051680517805188051980520805218052280523805248052580526805278052880529805308053180532805338053480535805368053780538805398054080541805428054380544805458054680547805488054980550805518055280553805548055580556805578055880559805608056180562805638056480565805668056780568805698057080571805728057380574805758057680577805788057980580805818058280583805848058580586805878058880589805908059180592805938059480595805968059780598805998060080601806028060380604806058060680607806088060980610806118061280613806148061580616806178061880619806208062180622806238062480625806268062780628806298063080631806328063380634806358063680637806388063980640806418064280643806448064580646806478064880649806508065180652806538065480655806568065780658806598066080661806628066380664806658066680667806688066980670806718067280673806748067580676806778067880679806808068180682806838068480685806868068780688806898069080691806928069380694806958069680697806988069980700807018070280703807048070580706807078070880709807108071180712807138071480715807168071780718807198072080721807228072380724807258072680727807288072980730807318073280733807348073580736807378073880739807408074180742807438074480745807468074780748807498075080751807528075380754807558075680757807588075980760807618076280763807648076580766807678076880769807708077180772807738077480775807768077780778807798078080781807828078380784807858078680787807888078980790807918079280793807948079580796807978079880799808008080180802808038080480805808068080780808808098081080811808128081380814808158081680817808188081980820808218082280823808248082580826808278082880829808308083180832808338083480835808368083780838808398084080841808428084380844808458084680847808488084980850808518085280853808548085580856808578085880859808608086180862808638086480865808668086780868808698087080871808728087380874808758087680877808788087980880808818088280883808848088580886808878088880889808908089180892808938089480895808968089780898808998090080901809028090380904809058090680907809088090980910809118091280913809148091580916809178091880919809208092180922809238092480925809268092780928809298093080931809328093380934809358093680937809388093980940809418094280943809448094580946809478094880949809508095180952809538095480955809568095780958809598096080961809628096380964809658096680967809688096980970809718097280973809748097580976809778097880979809808098180982809838098480985809868098780988809898099080991809928099380994809958099680997809988099981000810018100281003810048100581006810078100881009810108101181012810138101481015810168101781018810198102081021810228102381024810258102681027810288102981030810318103281033810348103581036810378103881039810408104181042810438104481045810468104781048810498105081051810528105381054810558105681057810588105981060810618106281063810648106581066810678106881069810708107181072810738107481075810768107781078810798108081081810828108381084810858108681087810888108981090810918109281093810948109581096810978109881099811008110181102811038110481105811068110781108811098111081111811128111381114811158111681117811188111981120811218112281123811248112581126811278112881129811308113181132811338113481135811368113781138811398114081141811428114381144811458114681147811488114981150811518115281153811548115581156811578115881159811608116181162811638116481165811668116781168811698117081171811728117381174811758117681177811788117981180811818118281183811848118581186811878118881189811908119181192811938119481195811968119781198811998120081201812028120381204812058120681207812088120981210812118121281213812148121581216812178121881219812208122181222812238122481225812268122781228812298123081231812328123381234812358123681237812388123981240812418124281243812448124581246812478124881249812508125181252812538125481255812568125781258812598126081261812628126381264812658126681267812688126981270812718127281273812748127581276812778127881279812808128181282812838128481285812868128781288812898129081291812928129381294812958129681297812988129981300813018130281303813048130581306813078130881309813108131181312813138131481315813168131781318813198132081321813228132381324813258132681327813288132981330813318133281333813348133581336813378133881339813408134181342813438134481345813468134781348813498135081351813528135381354813558135681357813588135981360813618136281363813648136581366813678136881369813708137181372813738137481375813768137781378813798138081381813828138381384813858138681387813888138981390813918139281393813948139581396813978139881399814008140181402814038140481405814068140781408814098141081411814128141381414814158141681417814188141981420814218142281423814248142581426814278142881429814308143181432814338143481435814368143781438814398144081441814428144381444814458144681447814488144981450814518145281453814548145581456814578145881459814608146181462814638146481465814668146781468814698147081471814728147381474814758147681477814788147981480814818148281483814848148581486814878148881489814908149181492814938149481495814968149781498814998150081501815028150381504815058150681507815088150981510815118151281513815148151581516815178151881519815208152181522815238152481525815268152781528815298153081531815328153381534815358153681537815388153981540815418154281543815448154581546815478154881549815508155181552815538155481555815568155781558815598156081561815628156381564815658156681567815688156981570815718157281573815748157581576815778157881579815808158181582815838158481585815868158781588815898159081591815928159381594815958159681597815988159981600816018160281603816048160581606816078160881609816108161181612816138161481615816168161781618816198162081621816228162381624816258162681627816288162981630816318163281633816348163581636816378163881639816408164181642816438164481645816468164781648816498165081651816528165381654816558165681657816588165981660816618166281663816648166581666816678166881669816708167181672816738167481675816768167781678816798168081681816828168381684816858168681687816888168981690816918169281693816948169581696816978169881699817008170181702817038170481705817068170781708817098171081711817128171381714817158171681717817188171981720817218172281723817248172581726817278172881729817308173181732817338173481735817368173781738817398174081741817428174381744817458174681747817488174981750817518175281753817548175581756817578175881759817608176181762817638176481765817668176781768817698177081771817728177381774817758177681777817788177981780817818178281783817848178581786817878178881789817908179181792817938179481795817968179781798817998180081801818028180381804818058180681807818088180981810818118181281813818148181581816818178181881819818208182181822818238182481825818268182781828818298183081831818328183381834818358183681837818388183981840818418184281843818448184581846818478184881849818508185181852818538185481855818568185781858818598186081861818628186381864818658186681867818688186981870818718187281873818748187581876818778187881879818808188181882818838188481885818868188781888818898189081891818928189381894818958189681897818988189981900819018190281903819048190581906819078190881909819108191181912819138191481915819168191781918819198192081921819228192381924819258192681927819288192981930819318193281933819348193581936819378193881939819408194181942819438194481945819468194781948819498195081951819528195381954819558195681957819588195981960819618196281963819648196581966819678196881969819708197181972819738197481975819768197781978819798198081981819828198381984819858198681987819888198981990819918199281993819948199581996819978199881999820008200182002820038200482005820068200782008820098201082011820128201382014820158201682017820188201982020820218202282023820248202582026820278202882029820308203182032820338203482035820368203782038820398204082041820428204382044820458204682047820488204982050820518205282053820548205582056820578205882059820608206182062820638206482065820668206782068820698207082071820728207382074820758207682077820788207982080820818208282083820848208582086820878208882089820908209182092820938209482095820968209782098820998210082101821028210382104821058210682107821088210982110821118211282113821148211582116821178211882119821208212182122821238212482125821268212782128821298213082131821328213382134821358213682137821388213982140821418214282143821448214582146821478214882149821508215182152821538215482155821568215782158821598216082161821628216382164821658216682167821688216982170821718217282173821748217582176821778217882179821808218182182821838218482185821868218782188821898219082191821928219382194821958219682197821988219982200822018220282203822048220582206822078220882209822108221182212822138221482215822168221782218822198222082221822228222382224822258222682227822288222982230822318223282233822348223582236822378223882239822408224182242822438224482245822468224782248822498225082251822528225382254822558225682257822588225982260822618226282263822648226582266822678226882269822708227182272822738227482275822768227782278822798228082281822828228382284822858228682287822888228982290822918229282293822948229582296822978229882299823008230182302823038230482305823068230782308823098231082311823128231382314823158231682317823188231982320823218232282323823248232582326823278232882329823308233182332823338233482335823368233782338823398234082341823428234382344823458234682347823488234982350823518235282353823548235582356823578235882359823608236182362823638236482365823668236782368823698237082371823728237382374823758237682377823788237982380823818238282383823848238582386823878238882389823908239182392823938239482395823968239782398823998240082401824028240382404824058240682407824088240982410824118241282413824148241582416824178241882419824208242182422824238242482425824268242782428824298243082431824328243382434824358243682437824388243982440824418244282443824448244582446824478244882449824508245182452824538245482455824568245782458824598246082461824628246382464824658246682467824688246982470824718247282473824748247582476824778247882479824808248182482824838248482485824868248782488824898249082491824928249382494824958249682497824988249982500825018250282503825048250582506825078250882509825108251182512825138251482515825168251782518825198252082521825228252382524825258252682527825288252982530825318253282533825348253582536825378253882539825408254182542825438254482545825468254782548825498255082551825528255382554825558255682557825588255982560825618256282563825648256582566825678256882569825708257182572825738257482575825768257782578825798258082581825828258382584825858258682587825888258982590825918259282593825948259582596825978259882599826008260182602826038260482605826068260782608826098261082611826128261382614826158261682617826188261982620826218262282623826248262582626826278262882629826308263182632826338263482635826368263782638826398264082641826428264382644826458264682647826488264982650826518265282653826548265582656826578265882659826608266182662826638266482665826668266782668826698267082671826728267382674826758267682677826788267982680826818268282683826848268582686826878268882689826908269182692826938269482695826968269782698826998270082701827028270382704827058270682707827088270982710827118271282713827148271582716827178271882719827208272182722827238272482725827268272782728827298273082731827328273382734827358273682737827388273982740827418274282743827448274582746827478274882749827508275182752827538275482755827568275782758827598276082761827628276382764827658276682767827688276982770827718277282773827748277582776827778277882779827808278182782827838278482785827868278782788827898279082791827928279382794827958279682797827988279982800828018280282803828048280582806828078280882809828108281182812828138281482815828168281782818828198282082821828228282382824828258282682827828288282982830828318283282833828348283582836828378283882839828408284182842828438284482845828468284782848828498285082851828528285382854828558285682857828588285982860828618286282863828648286582866828678286882869828708287182872828738287482875828768287782878828798288082881828828288382884828858288682887828888288982890828918289282893828948289582896828978289882899829008290182902829038290482905829068290782908829098291082911829128291382914829158291682917829188291982920829218292282923829248292582926829278292882929829308293182932829338293482935829368293782938829398294082941829428294382944829458294682947829488294982950829518295282953829548295582956829578295882959829608296182962829638296482965829668296782968829698297082971829728297382974829758297682977829788297982980829818298282983829848298582986829878298882989829908299182992829938299482995829968299782998829998300083001830028300383004830058300683007830088300983010830118301283013830148301583016830178301883019830208302183022830238302483025830268302783028830298303083031830328303383034830358303683037830388303983040830418304283043830448304583046830478304883049830508305183052830538305483055830568305783058830598306083061830628306383064830658306683067830688306983070830718307283073830748307583076830778307883079830808308183082830838308483085830868308783088830898309083091830928309383094830958309683097830988309983100831018310283103831048310583106831078310883109831108311183112831138311483115831168311783118831198312083121831228312383124831258312683127831288312983130831318313283133831348313583136831378313883139831408314183142831438314483145831468314783148831498315083151831528315383154831558315683157831588315983160831618316283163831648316583166831678316883169831708317183172831738317483175831768317783178831798318083181831828318383184831858318683187831888318983190831918319283193831948319583196831978319883199832008320183202832038320483205832068320783208832098321083211832128321383214832158321683217832188321983220832218322283223832248322583226832278322883229832308323183232832338323483235832368323783238832398324083241832428324383244832458324683247832488324983250832518325283253832548325583256832578325883259832608326183262832638326483265832668326783268832698327083271832728327383274832758327683277832788327983280832818328283283832848328583286832878328883289832908329183292832938329483295832968329783298832998330083301833028330383304833058330683307833088330983310833118331283313833148331583316833178331883319833208332183322833238332483325833268332783328833298333083331833328333383334833358333683337833388333983340833418334283343833448334583346833478334883349833508335183352833538335483355833568335783358833598336083361833628336383364833658336683367833688336983370833718337283373833748337583376833778337883379833808338183382833838338483385833868338783388833898339083391833928339383394833958339683397833988339983400834018340283403834048340583406834078340883409834108341183412834138341483415834168341783418834198342083421834228342383424834258342683427834288342983430834318343283433834348343583436834378343883439834408344183442834438344483445834468344783448834498345083451834528345383454834558345683457834588345983460834618346283463834648346583466834678346883469834708347183472834738347483475834768347783478834798348083481834828348383484834858348683487834888348983490834918349283493834948349583496834978349883499835008350183502835038350483505835068350783508835098351083511835128351383514835158351683517835188351983520835218352283523835248352583526835278352883529835308353183532835338353483535835368353783538835398354083541835428354383544835458354683547835488354983550835518355283553835548355583556835578355883559835608356183562835638356483565835668356783568835698357083571835728357383574835758357683577835788357983580835818358283583835848358583586835878358883589835908359183592835938359483595835968359783598835998360083601836028360383604836058360683607836088360983610836118361283613836148361583616836178361883619836208362183622836238362483625836268362783628836298363083631836328363383634836358363683637836388363983640836418364283643836448364583646836478364883649836508365183652836538365483655836568365783658836598366083661836628366383664836658366683667836688366983670836718367283673836748367583676836778367883679836808368183682836838368483685836868368783688836898369083691836928369383694836958369683697836988369983700837018370283703837048370583706837078370883709837108371183712837138371483715837168371783718837198372083721837228372383724837258372683727837288372983730837318373283733837348373583736837378373883739837408374183742837438374483745837468374783748837498375083751837528375383754837558375683757837588375983760837618376283763837648376583766837678376883769837708377183772837738377483775837768377783778837798378083781837828378383784837858378683787837888378983790837918379283793837948379583796837978379883799838008380183802838038380483805838068380783808838098381083811838128381383814838158381683817838188381983820838218382283823838248382583826838278382883829838308383183832838338383483835838368383783838838398384083841838428384383844838458384683847838488384983850838518385283853838548385583856838578385883859838608386183862838638386483865838668386783868838698387083871838728387383874838758387683877838788387983880838818388283883838848388583886838878388883889838908389183892838938389483895838968389783898838998390083901839028390383904839058390683907839088390983910839118391283913839148391583916839178391883919839208392183922839238392483925839268392783928839298393083931839328393383934839358393683937839388393983940839418394283943839448394583946839478394883949839508395183952839538395483955839568395783958839598396083961839628396383964839658396683967839688396983970839718397283973839748397583976839778397883979839808398183982839838398483985839868398783988839898399083991839928399383994839958399683997839988399984000840018400284003840048400584006840078400884009840108401184012840138401484015840168401784018840198402084021840228402384024840258402684027840288402984030840318403284033840348403584036840378403884039840408404184042840438404484045840468404784048840498405084051840528405384054840558405684057840588405984060840618406284063840648406584066840678406884069840708407184072840738407484075840768407784078840798408084081840828408384084840858408684087840888408984090840918409284093840948409584096840978409884099841008410184102841038410484105841068410784108841098411084111841128411384114841158411684117841188411984120841218412284123841248412584126841278412884129841308413184132841338413484135841368413784138841398414084141841428414384144841458414684147841488414984150841518415284153841548415584156841578415884159841608416184162841638416484165841668416784168841698417084171841728417384174841758417684177841788417984180841818418284183841848418584186841878418884189841908419184192841938419484195841968419784198841998420084201842028420384204842058420684207842088420984210842118421284213842148421584216842178421884219842208422184222842238422484225842268422784228842298423084231842328423384234842358423684237842388423984240842418424284243842448424584246842478424884249842508425184252842538425484255842568425784258842598426084261842628426384264842658426684267842688426984270842718427284273842748427584276842778427884279842808428184282842838428484285842868428784288842898429084291842928429384294842958429684297842988429984300843018430284303843048430584306843078430884309843108431184312843138431484315843168431784318843198432084321843228432384324843258432684327843288432984330843318433284333843348433584336843378433884339843408434184342843438434484345843468434784348843498435084351843528435384354843558435684357843588435984360843618436284363843648436584366843678436884369843708437184372843738437484375843768437784378843798438084381843828438384384843858438684387843888438984390843918439284393843948439584396843978439884399844008440184402844038440484405844068440784408844098441084411844128441384414844158441684417844188441984420844218442284423844248442584426844278442884429844308443184432844338443484435844368443784438844398444084441844428444384444844458444684447844488444984450844518445284453844548445584456844578445884459844608446184462844638446484465844668446784468844698447084471844728447384474844758447684477844788447984480844818448284483844848448584486844878448884489844908449184492844938449484495844968449784498844998450084501845028450384504845058450684507845088450984510845118451284513845148451584516845178451884519845208452184522845238452484525845268452784528845298453084531845328453384534845358453684537845388453984540845418454284543845448454584546845478454884549845508455184552845538455484555845568455784558845598456084561845628456384564845658456684567845688456984570845718457284573845748457584576845778457884579845808458184582845838458484585845868458784588845898459084591845928459384594845958459684597845988459984600846018460284603846048460584606846078460884609846108461184612846138461484615846168461784618846198462084621846228462384624846258462684627846288462984630846318463284633846348463584636846378463884639846408464184642846438464484645846468464784648846498465084651846528465384654846558465684657846588465984660846618466284663846648466584666846678466884669846708467184672846738467484675846768467784678846798468084681846828468384684846858468684687846888468984690846918469284693846948469584696846978469884699847008470184702847038470484705847068470784708847098471084711847128471384714847158471684717847188471984720847218472284723847248472584726847278472884729847308473184732847338473484735847368473784738847398474084741847428474384744847458474684747847488474984750847518475284753847548475584756847578475884759847608476184762847638476484765847668476784768847698477084771847728477384774847758477684777847788477984780847818478284783847848478584786847878478884789847908479184792847938479484795847968479784798847998480084801848028480384804848058480684807848088480984810848118481284813848148481584816848178481884819848208482184822848238482484825848268482784828848298483084831848328483384834848358483684837848388483984840848418484284843848448484584846848478484884849848508485184852848538485484855848568485784858848598486084861848628486384864848658486684867848688486984870848718487284873848748487584876848778487884879848808488184882848838488484885848868488784888848898489084891848928489384894848958489684897848988489984900849018490284903849048490584906849078490884909849108491184912849138491484915849168491784918849198492084921849228492384924849258492684927849288492984930849318493284933849348493584936849378493884939849408494184942849438494484945849468494784948849498495084951849528495384954849558495684957849588495984960849618496284963849648496584966849678496884969849708497184972849738497484975849768497784978849798498084981849828498384984849858498684987849888498984990849918499284993849948499584996849978499884999850008500185002850038500485005850068500785008850098501085011850128501385014850158501685017850188501985020850218502285023850248502585026850278502885029850308503185032850338503485035850368503785038850398504085041850428504385044850458504685047850488504985050850518505285053850548505585056850578505885059850608506185062850638506485065850668506785068850698507085071850728507385074850758507685077850788507985080850818508285083850848508585086850878508885089850908509185092850938509485095850968509785098850998510085101851028510385104851058510685107851088510985110851118511285113851148511585116851178511885119851208512185122851238512485125851268512785128851298513085131851328513385134851358513685137851388513985140851418514285143851448514585146851478514885149851508515185152851538515485155851568515785158851598516085161851628516385164851658516685167851688516985170851718517285173851748517585176851778517885179851808518185182851838518485185851868518785188851898519085191851928519385194851958519685197851988519985200852018520285203852048520585206852078520885209852108521185212852138521485215852168521785218852198522085221852228522385224852258522685227852288522985230852318523285233852348523585236852378523885239852408524185242852438524485245852468524785248852498525085251852528525385254852558525685257852588525985260852618526285263852648526585266852678526885269852708527185272852738527485275852768527785278852798528085281852828528385284852858528685287852888528985290852918529285293852948529585296852978529885299853008530185302853038530485305853068530785308853098531085311853128531385314853158531685317853188531985320853218532285323853248532585326853278532885329853308533185332853338533485335853368533785338853398534085341853428534385344853458534685347853488534985350853518535285353853548535585356853578535885359853608536185362853638536485365853668536785368853698537085371853728537385374853758537685377853788537985380853818538285383853848538585386853878538885389853908539185392853938539485395853968539785398853998540085401854028540385404854058540685407854088540985410854118541285413854148541585416854178541885419854208542185422854238542485425854268542785428854298543085431854328543385434854358543685437854388543985440854418544285443854448544585446854478544885449854508545185452854538545485455854568545785458854598546085461854628546385464854658546685467854688546985470854718547285473854748547585476854778547885479854808548185482854838548485485854868548785488854898549085491854928549385494854958549685497854988549985500855018550285503855048550585506855078550885509855108551185512855138551485515855168551785518855198552085521855228552385524855258552685527855288552985530855318553285533855348553585536855378553885539855408554185542855438554485545855468554785548855498555085551855528555385554855558555685557855588555985560855618556285563855648556585566855678556885569855708557185572855738557485575855768557785578855798558085581855828558385584855858558685587855888558985590855918559285593855948559585596855978559885599856008560185602856038560485605856068560785608856098561085611856128561385614856158561685617856188561985620856218562285623856248562585626856278562885629856308563185632856338563485635856368563785638856398564085641856428564385644856458564685647856488564985650856518565285653856548565585656856578565885659856608566185662856638566485665856668566785668856698567085671856728567385674856758567685677856788567985680856818568285683856848568585686856878568885689856908569185692856938569485695856968569785698856998570085701857028570385704857058570685707857088570985710857118571285713857148571585716857178571885719857208572185722857238572485725857268572785728857298573085731857328573385734857358573685737857388573985740857418574285743857448574585746857478574885749857508575185752857538575485755857568575785758857598576085761857628576385764857658576685767857688576985770857718577285773857748577585776857778577885779857808578185782857838578485785857868578785788857898579085791857928579385794857958579685797857988579985800858018580285803858048580585806858078580885809858108581185812858138581485815858168581785818858198582085821858228582385824858258582685827858288582985830858318583285833858348583585836858378583885839858408584185842858438584485845858468584785848858498585085851858528585385854858558585685857858588585985860858618586285863858648586585866858678586885869858708587185872858738587485875858768587785878858798588085881858828588385884858858588685887858888588985890858918589285893858948589585896858978589885899859008590185902859038590485905859068590785908859098591085911859128591385914859158591685917859188591985920859218592285923859248592585926859278592885929859308593185932859338593485935859368593785938859398594085941859428594385944859458594685947859488594985950859518595285953859548595585956859578595885959859608596185962859638596485965859668596785968859698597085971859728597385974859758597685977859788597985980859818598285983859848598585986859878598885989859908599185992859938599485995859968599785998859998600086001860028600386004860058600686007860088600986010860118601286013860148601586016860178601886019860208602186022860238602486025860268602786028860298603086031860328603386034860358603686037860388603986040860418604286043860448604586046860478604886049860508605186052860538605486055860568605786058860598606086061860628606386064860658606686067860688606986070860718607286073860748607586076860778607886079860808608186082860838608486085860868608786088860898609086091860928609386094860958609686097860988609986100861018610286103861048610586106861078610886109861108611186112861138611486115861168611786118861198612086121861228612386124861258612686127861288612986130861318613286133861348613586136861378613886139861408614186142861438614486145861468614786148861498615086151861528615386154861558615686157861588615986160861618616286163861648616586166861678616886169861708617186172861738617486175861768617786178861798618086181861828618386184861858618686187861888618986190861918619286193861948619586196861978619886199862008620186202862038620486205862068620786208862098621086211862128621386214862158621686217862188621986220862218622286223862248622586226862278622886229862308623186232862338623486235862368623786238862398624086241862428624386244862458624686247862488624986250862518625286253862548625586256862578625886259862608626186262862638626486265862668626786268862698627086271862728627386274862758627686277862788627986280862818628286283862848628586286862878628886289862908629186292862938629486295862968629786298862998630086301863028630386304863058630686307863088630986310863118631286313863148631586316863178631886319863208632186322863238632486325863268632786328863298633086331863328633386334863358633686337863388633986340863418634286343863448634586346863478634886349863508635186352863538635486355863568635786358863598636086361863628636386364863658636686367863688636986370863718637286373863748637586376863778637886379863808638186382863838638486385863868638786388863898639086391863928639386394863958639686397863988639986400864018640286403864048640586406864078640886409864108641186412864138641486415864168641786418864198642086421864228642386424864258642686427864288642986430864318643286433864348643586436864378643886439864408644186442864438644486445864468644786448864498645086451864528645386454864558645686457864588645986460864618646286463864648646586466864678646886469864708647186472864738647486475864768647786478864798648086481864828648386484864858648686487864888648986490864918649286493864948649586496864978649886499865008650186502865038650486505865068650786508865098651086511865128651386514865158651686517865188651986520865218652286523865248652586526865278652886529865308653186532865338653486535865368653786538865398654086541865428654386544865458654686547865488654986550865518655286553865548655586556865578655886559865608656186562865638656486565865668656786568865698657086571865728657386574865758657686577865788657986580865818658286583865848658586586865878658886589865908659186592865938659486595865968659786598865998660086601866028660386604866058660686607866088660986610866118661286613866148661586616866178661886619866208662186622866238662486625866268662786628866298663086631866328663386634866358663686637866388663986640866418664286643866448664586646866478664886649866508665186652866538665486655866568665786658866598666086661866628666386664866658666686667866688666986670866718667286673866748667586676866778667886679866808668186682866838668486685866868668786688866898669086691866928669386694866958669686697866988669986700867018670286703867048670586706867078670886709867108671186712867138671486715867168671786718867198672086721867228672386724867258672686727867288672986730867318673286733867348673586736867378673886739867408674186742867438674486745867468674786748867498675086751867528675386754867558675686757867588675986760867618676286763867648676586766867678676886769867708677186772867738677486775867768677786778867798678086781867828678386784867858678686787867888678986790867918679286793867948679586796867978679886799868008680186802868038680486805868068680786808868098681086811868128681386814868158681686817868188681986820868218682286823868248682586826868278682886829868308683186832868338683486835868368683786838868398684086841868428684386844868458684686847868488684986850868518685286853868548685586856868578685886859868608686186862868638686486865868668686786868868698687086871868728687386874868758687686877868788687986880868818688286883868848688586886868878688886889868908689186892868938689486895868968689786898868998690086901869028690386904869058690686907869088690986910869118691286913869148691586916869178691886919869208692186922869238692486925869268692786928869298693086931869328693386934869358693686937869388693986940869418694286943869448694586946869478694886949869508695186952869538695486955869568695786958869598696086961869628696386964869658696686967869688696986970869718697286973869748697586976869778697886979869808698186982869838698486985869868698786988869898699086991869928699386994869958699686997869988699987000870018700287003870048700587006870078700887009870108701187012870138701487015870168701787018870198702087021870228702387024870258702687027870288702987030870318703287033870348703587036870378703887039870408704187042870438704487045870468704787048870498705087051870528705387054870558705687057870588705987060870618706287063870648706587066870678706887069870708707187072870738707487075870768707787078870798708087081870828708387084870858708687087870888708987090870918709287093870948709587096870978709887099871008710187102871038710487105871068710787108871098711087111871128711387114871158711687117871188711987120871218712287123871248712587126871278712887129871308713187132871338713487135871368713787138871398714087141871428714387144871458714687147871488714987150871518715287153871548715587156871578715887159871608716187162871638716487165871668716787168871698717087171871728717387174871758717687177871788717987180871818718287183871848718587186871878718887189871908719187192871938719487195871968719787198871998720087201872028720387204872058720687207872088720987210872118721287213872148721587216872178721887219872208722187222872238722487225872268722787228872298723087231872328723387234872358723687237872388723987240872418724287243872448724587246872478724887249872508725187252872538725487255872568725787258872598726087261872628726387264872658726687267872688726987270872718727287273872748727587276872778727887279872808728187282872838728487285872868728787288872898729087291872928729387294872958729687297872988729987300873018730287303873048730587306873078730887309873108731187312873138731487315873168731787318873198732087321873228732387324873258732687327873288732987330873318733287333873348733587336873378733887339873408734187342873438734487345873468734787348873498735087351873528735387354873558735687357873588735987360873618736287363873648736587366873678736887369873708737187372873738737487375873768737787378873798738087381873828738387384873858738687387873888738987390873918739287393873948739587396873978739887399874008740187402874038740487405874068740787408874098741087411874128741387414874158741687417874188741987420874218742287423874248742587426874278742887429874308743187432874338743487435874368743787438874398744087441874428744387444874458744687447874488744987450874518745287453874548745587456874578745887459874608746187462874638746487465874668746787468874698747087471874728747387474874758747687477874788747987480874818748287483874848748587486874878748887489874908749187492874938749487495874968749787498874998750087501875028750387504875058750687507875088750987510875118751287513875148751587516875178751887519875208752187522875238752487525875268752787528875298753087531875328753387534875358753687537875388753987540875418754287543875448754587546875478754887549875508755187552875538755487555875568755787558875598756087561875628756387564875658756687567875688756987570875718757287573875748757587576875778757887579875808758187582875838758487585875868758787588875898759087591875928759387594875958759687597875988759987600876018760287603876048760587606876078760887609876108761187612876138761487615876168761787618876198762087621876228762387624876258762687627876288762987630876318763287633876348763587636876378763887639876408764187642876438764487645876468764787648876498765087651876528765387654876558765687657876588765987660876618766287663876648766587666876678766887669876708767187672876738767487675876768767787678876798768087681876828768387684876858768687687876888768987690876918769287693876948769587696876978769887699877008770187702877038770487705877068770787708877098771087711877128771387714877158771687717877188771987720877218772287723877248772587726877278772887729877308773187732877338773487735877368773787738877398774087741877428774387744877458774687747877488774987750877518775287753877548775587756877578775887759877608776187762877638776487765877668776787768877698777087771877728777387774877758777687777877788777987780877818778287783877848778587786877878778887789877908779187792877938779487795877968779787798877998780087801878028780387804878058780687807878088780987810878118781287813878148781587816878178781887819878208782187822878238782487825878268782787828878298783087831878328783387834878358783687837878388783987840878418784287843878448784587846878478784887849878508785187852878538785487855878568785787858878598786087861878628786387864878658786687867878688786987870878718787287873878748787587876878778787887879878808788187882878838788487885878868788787888878898789087891878928789387894878958789687897878988789987900879018790287903879048790587906879078790887909879108791187912879138791487915879168791787918879198792087921879228792387924879258792687927879288792987930879318793287933879348793587936879378793887939879408794187942879438794487945879468794787948879498795087951879528795387954879558795687957879588795987960879618796287963879648796587966879678796887969879708797187972879738797487975879768797787978879798798087981879828798387984879858798687987879888798987990879918799287993879948799587996879978799887999880008800188002880038800488005880068800788008880098801088011880128801388014880158801688017880188801988020880218802288023880248802588026880278802888029880308803188032880338803488035880368803788038880398804088041880428804388044880458804688047880488804988050880518805288053880548805588056880578805888059880608806188062880638806488065880668806788068880698807088071880728807388074880758807688077880788807988080880818808288083880848808588086880878808888089880908809188092880938809488095880968809788098880998810088101881028810388104881058810688107881088810988110881118811288113881148811588116881178811888119881208812188122881238812488125881268812788128881298813088131881328813388134881358813688137881388813988140881418814288143881448814588146881478814888149881508815188152881538815488155881568815788158881598816088161881628816388164881658816688167881688816988170881718817288173881748817588176881778817888179881808818188182881838818488185881868818788188881898819088191881928819388194881958819688197881988819988200882018820288203882048820588206882078820888209882108821188212882138821488215882168821788218882198822088221882228822388224882258822688227882288822988230882318823288233882348823588236882378823888239882408824188242882438824488245882468824788248882498825088251882528825388254882558825688257882588825988260882618826288263882648826588266882678826888269882708827188272882738827488275882768827788278882798828088281882828828388284882858828688287882888828988290882918829288293882948829588296882978829888299883008830188302883038830488305883068830788308883098831088311883128831388314883158831688317883188831988320883218832288323883248832588326883278832888329883308833188332883338833488335883368833788338883398834088341883428834388344883458834688347883488834988350883518835288353883548835588356883578835888359883608836188362883638836488365883668836788368883698837088371883728837388374883758837688377883788837988380883818838288383883848838588386883878838888389883908839188392883938839488395883968839788398883998840088401884028840388404884058840688407884088840988410884118841288413884148841588416884178841888419884208842188422884238842488425884268842788428884298843088431884328843388434884358843688437884388843988440884418844288443884448844588446884478844888449884508845188452884538845488455884568845788458884598846088461884628846388464884658846688467884688846988470884718847288473884748847588476884778847888479884808848188482884838848488485884868848788488884898849088491884928849388494884958849688497884988849988500885018850288503885048850588506885078850888509885108851188512885138851488515885168851788518885198852088521885228852388524885258852688527885288852988530885318853288533885348853588536885378853888539885408854188542885438854488545885468854788548885498855088551885528855388554885558855688557885588855988560885618856288563885648856588566885678856888569885708857188572885738857488575885768857788578885798858088581885828858388584885858858688587885888858988590885918859288593885948859588596885978859888599886008860188602886038860488605886068860788608886098861088611886128861388614886158861688617886188861988620886218862288623886248862588626886278862888629886308863188632886338863488635886368863788638886398864088641886428864388644886458864688647886488864988650886518865288653886548865588656886578865888659886608866188662886638866488665886668866788668886698867088671886728867388674886758867688677886788867988680886818868288683886848868588686886878868888689886908869188692886938869488695886968869788698886998870088701887028870388704887058870688707887088870988710887118871288713887148871588716887178871888719887208872188722887238872488725887268872788728887298873088731887328873388734887358873688737887388873988740887418874288743887448874588746887478874888749887508875188752887538875488755887568875788758887598876088761887628876388764887658876688767887688876988770887718877288773887748877588776887778877888779887808878188782887838878488785887868878788788887898879088791887928879388794887958879688797887988879988800888018880288803888048880588806888078880888809888108881188812888138881488815888168881788818888198882088821888228882388824888258882688827888288882988830888318883288833888348883588836888378883888839888408884188842888438884488845888468884788848888498885088851888528885388854888558885688857888588885988860888618886288863888648886588866888678886888869888708887188872888738887488875888768887788878888798888088881888828888388884888858888688887888888888988890888918889288893888948889588896888978889888899889008890188902889038890488905889068890788908889098891088911889128891388914889158891688917889188891988920889218892288923889248892588926889278892888929889308893188932889338893488935889368893788938889398894088941889428894388944889458894688947889488894988950889518895288953889548895588956889578895888959889608896188962889638896488965889668896788968889698897088971889728897388974889758897688977889788897988980889818898288983889848898588986889878898888989889908899188992889938899488995889968899788998889998900089001890028900389004890058900689007890088900989010890118901289013890148901589016890178901889019890208902189022890238902489025890268902789028890298903089031890328903389034890358903689037890388903989040890418904289043890448904589046890478904889049890508905189052890538905489055890568905789058890598906089061890628906389064890658906689067890688906989070890718907289073890748907589076890778907889079890808908189082890838908489085890868908789088890898909089091890928909389094890958909689097890988909989100891018910289103891048910589106891078910889109891108911189112891138911489115891168911789118891198912089121891228912389124891258912689127891288912989130891318913289133891348913589136891378913889139891408914189142891438914489145891468914789148891498915089151891528915389154891558915689157891588915989160891618916289163891648916589166891678916889169891708917189172891738917489175891768917789178891798918089181891828918389184891858918689187891888918989190891918919289193891948919589196891978919889199892008920189202892038920489205892068920789208892098921089211892128921389214892158921689217892188921989220892218922289223892248922589226892278922889229892308923189232892338923489235892368923789238892398924089241892428924389244892458924689247892488924989250892518925289253892548925589256892578925889259892608926189262892638926489265892668926789268892698927089271892728927389274892758927689277892788927989280892818928289283892848928589286892878928889289892908929189292892938929489295892968929789298892998930089301893028930389304893058930689307893088930989310893118931289313893148931589316893178931889319893208932189322893238932489325893268932789328893298933089331893328933389334893358933689337893388933989340893418934289343893448934589346893478934889349893508935189352893538935489355893568935789358893598936089361893628936389364893658936689367893688936989370893718937289373893748937589376893778937889379893808938189382893838938489385893868938789388893898939089391893928939389394893958939689397893988939989400894018940289403894048940589406894078940889409894108941189412894138941489415894168941789418894198942089421894228942389424894258942689427894288942989430894318943289433894348943589436894378943889439894408944189442894438944489445894468944789448894498945089451894528945389454894558945689457894588945989460894618946289463894648946589466894678946889469894708947189472894738947489475894768947789478894798948089481894828948389484894858948689487894888948989490894918949289493894948949589496894978949889499895008950189502895038950489505895068950789508895098951089511895128951389514895158951689517895188951989520895218952289523895248952589526895278952889529895308953189532895338953489535895368953789538895398954089541895428954389544895458954689547895488954989550895518955289553895548955589556895578955889559895608956189562895638956489565895668956789568895698957089571895728957389574895758957689577895788957989580895818958289583895848958589586895878958889589895908959189592895938959489595895968959789598895998960089601896028960389604896058960689607896088960989610896118961289613896148961589616896178961889619896208962189622896238962489625896268962789628896298963089631896328963389634896358963689637896388963989640896418964289643896448964589646896478964889649896508965189652896538965489655896568965789658896598966089661896628966389664896658966689667896688966989670896718967289673896748967589676896778967889679896808968189682896838968489685896868968789688896898969089691896928969389694896958969689697896988969989700897018970289703897048970589706897078970889709897108971189712897138971489715897168971789718897198972089721897228972389724897258972689727897288972989730897318973289733897348973589736897378973889739897408974189742897438974489745897468974789748897498975089751897528975389754897558975689757897588975989760897618976289763897648976589766897678976889769897708977189772897738977489775897768977789778897798978089781897828978389784897858978689787897888978989790897918979289793897948979589796897978979889799898008980189802898038980489805898068980789808898098981089811898128981389814898158981689817898188981989820898218982289823898248982589826898278982889829898308983189832898338983489835898368983789838898398984089841898428984389844898458984689847898488984989850898518985289853898548985589856898578985889859898608986189862898638986489865898668986789868898698987089871898728987389874898758987689877898788987989880898818988289883898848988589886898878988889889898908989189892898938989489895898968989789898898998990089901899028990389904899058990689907899088990989910899118991289913899148991589916899178991889919899208992189922899238992489925899268992789928899298993089931899328993389934899358993689937899388993989940899418994289943899448994589946899478994889949899508995189952899538995489955899568995789958899598996089961899628996389964899658996689967899688996989970899718997289973899748997589976899778997889979899808998189982899838998489985899868998789988899898999089991899928999389994899958999689997899988999990000900019000290003900049000590006900079000890009900109001190012900139001490015900169001790018900199002090021900229002390024900259002690027900289002990030900319003290033900349003590036900379003890039900409004190042900439004490045900469004790048900499005090051900529005390054900559005690057900589005990060900619006290063900649006590066900679006890069900709007190072900739007490075900769007790078900799008090081900829008390084900859008690087900889008990090900919009290093900949009590096900979009890099901009010190102901039010490105901069010790108901099011090111901129011390114901159011690117901189011990120901219012290123901249012590126901279012890129901309013190132901339013490135901369013790138901399014090141901429014390144901459014690147901489014990150901519015290153901549015590156901579015890159901609016190162901639016490165901669016790168901699017090171901729017390174901759017690177901789017990180901819018290183901849018590186901879018890189901909019190192901939019490195901969019790198901999020090201902029020390204902059020690207902089020990210902119021290213902149021590216902179021890219902209022190222902239022490225902269022790228902299023090231902329023390234902359023690237902389023990240902419024290243902449024590246902479024890249902509025190252902539025490255902569025790258902599026090261902629026390264902659026690267902689026990270902719027290273902749027590276902779027890279902809028190282902839028490285902869028790288902899029090291902929029390294902959029690297902989029990300903019030290303903049030590306903079030890309903109031190312903139031490315903169031790318903199032090321903229032390324903259032690327903289032990330903319033290333903349033590336903379033890339903409034190342903439034490345903469034790348903499035090351903529035390354903559035690357903589035990360903619036290363903649036590366903679036890369903709037190372903739037490375903769037790378903799038090381903829038390384903859038690387903889038990390903919039290393903949039590396903979039890399904009040190402904039040490405904069040790408904099041090411904129041390414904159041690417904189041990420904219042290423904249042590426904279042890429904309043190432904339043490435904369043790438904399044090441904429044390444904459044690447904489044990450904519045290453904549045590456904579045890459904609046190462904639046490465904669046790468904699047090471904729047390474904759047690477904789047990480904819048290483904849048590486904879048890489904909049190492904939049490495904969049790498904999050090501905029050390504905059050690507905089050990510905119051290513905149051590516905179051890519905209052190522905239052490525905269052790528905299053090531905329053390534905359053690537905389053990540905419054290543905449054590546905479054890549905509055190552905539055490555905569055790558905599056090561905629056390564905659056690567905689056990570905719057290573905749057590576905779057890579905809058190582905839058490585905869058790588905899059090591905929059390594905959059690597905989059990600906019060290603906049060590606906079060890609906109061190612906139061490615906169061790618906199062090621906229062390624906259062690627906289062990630906319063290633906349063590636906379063890639906409064190642906439064490645906469064790648906499065090651906529065390654906559065690657906589065990660906619066290663906649066590666906679066890669906709067190672906739067490675906769067790678906799068090681906829068390684906859068690687906889068990690906919069290693906949069590696906979069890699907009070190702907039070490705907069070790708907099071090711907129071390714907159071690717907189071990720907219072290723907249072590726907279072890729907309073190732907339073490735907369073790738907399074090741907429074390744907459074690747907489074990750907519075290753907549075590756907579075890759907609076190762907639076490765907669076790768907699077090771907729077390774907759077690777907789077990780907819078290783907849078590786907879078890789907909079190792907939079490795907969079790798907999080090801908029080390804908059080690807908089080990810908119081290813908149081590816908179081890819908209082190822908239082490825908269082790828908299083090831908329083390834908359083690837908389083990840908419084290843908449084590846908479084890849908509085190852908539085490855908569085790858908599086090861908629086390864908659086690867908689086990870908719087290873908749087590876908779087890879908809088190882908839088490885908869088790888908899089090891908929089390894908959089690897908989089990900909019090290903909049090590906909079090890909909109091190912909139091490915909169091790918909199092090921909229092390924909259092690927909289092990930909319093290933909349093590936909379093890939909409094190942909439094490945909469094790948909499095090951909529095390954909559095690957909589095990960909619096290963909649096590966909679096890969909709097190972909739097490975909769097790978909799098090981909829098390984909859098690987909889098990990909919099290993909949099590996909979099890999910009100191002910039100491005910069100791008910099101091011910129101391014910159101691017910189101991020910219102291023910249102591026910279102891029910309103191032910339103491035910369103791038910399104091041910429104391044910459104691047910489104991050910519105291053910549105591056910579105891059910609106191062910639106491065910669106791068910699107091071910729107391074910759107691077910789107991080910819108291083910849108591086910879108891089910909109191092910939109491095910969109791098910999110091101911029110391104911059110691107911089110991110911119111291113911149111591116911179111891119911209112191122911239112491125911269112791128911299113091131911329113391134911359113691137911389113991140911419114291143911449114591146911479114891149911509115191152911539115491155911569115791158911599116091161911629116391164911659116691167911689116991170911719117291173911749117591176911779117891179911809118191182911839118491185911869118791188911899119091191911929119391194911959119691197911989119991200912019120291203912049120591206912079120891209912109121191212912139121491215912169121791218912199122091221912229122391224912259122691227912289122991230912319123291233912349123591236912379123891239912409124191242912439124491245912469124791248912499125091251912529125391254912559125691257912589125991260912619126291263912649126591266912679126891269912709127191272912739127491275912769127791278912799128091281912829128391284912859128691287912889128991290912919129291293912949129591296912979129891299913009130191302913039130491305913069130791308913099131091311913129131391314913159131691317913189131991320913219132291323913249132591326913279132891329913309133191332913339133491335913369133791338913399134091341913429134391344913459134691347913489134991350913519135291353913549135591356913579135891359913609136191362913639136491365913669136791368913699137091371913729137391374913759137691377913789137991380913819138291383913849138591386913879138891389913909139191392913939139491395913969139791398913999140091401914029140391404914059140691407914089140991410914119141291413914149141591416914179141891419914209142191422914239142491425914269142791428914299143091431914329143391434914359143691437914389143991440914419144291443914449144591446914479144891449914509145191452914539145491455914569145791458914599146091461914629146391464914659146691467914689146991470914719147291473914749147591476914779147891479914809148191482914839148491485914869148791488914899149091491914929149391494914959149691497914989149991500915019150291503915049150591506915079150891509915109151191512915139151491515915169151791518915199152091521915229152391524915259152691527915289152991530915319153291533915349153591536915379153891539915409154191542915439154491545915469154791548915499155091551915529155391554915559155691557915589155991560915619156291563915649156591566915679156891569915709157191572915739157491575915769157791578915799158091581915829158391584915859158691587915889158991590915919159291593915949159591596915979159891599916009160191602916039160491605916069160791608916099161091611916129161391614916159161691617916189161991620916219162291623916249162591626916279162891629916309163191632916339163491635916369163791638916399164091641916429164391644916459164691647916489164991650916519165291653916549165591656916579165891659916609166191662916639166491665916669166791668916699167091671916729167391674916759167691677916789167991680916819168291683916849168591686916879168891689916909169191692916939169491695916969169791698916999170091701917029170391704917059170691707917089170991710917119171291713917149171591716917179171891719917209172191722917239172491725917269172791728917299173091731917329173391734917359173691737917389173991740917419174291743917449174591746917479174891749917509175191752917539175491755917569175791758917599176091761917629176391764917659176691767917689176991770917719177291773917749177591776917779177891779917809178191782917839178491785917869178791788917899179091791917929179391794917959179691797917989179991800918019180291803918049180591806918079180891809918109181191812918139181491815918169181791818918199182091821918229182391824918259182691827918289182991830918319183291833918349183591836918379183891839918409184191842918439184491845918469184791848918499185091851918529185391854918559185691857918589185991860918619186291863918649186591866918679186891869918709187191872918739187491875918769187791878918799188091881918829188391884918859188691887918889188991890918919189291893918949189591896918979189891899919009190191902919039190491905919069190791908919099191091911919129191391914919159191691917919189191991920919219192291923919249192591926919279192891929919309193191932919339193491935919369193791938919399194091941919429194391944919459194691947919489194991950919519195291953919549195591956919579195891959919609196191962919639196491965919669196791968919699197091971919729197391974919759197691977919789197991980919819198291983919849198591986919879198891989919909199191992919939199491995919969199791998919999200092001920029200392004920059200692007920089200992010920119201292013920149201592016920179201892019920209202192022920239202492025920269202792028920299203092031920329203392034920359203692037920389203992040920419204292043920449204592046920479204892049920509205192052920539205492055920569205792058920599206092061920629206392064920659206692067920689206992070920719207292073920749207592076920779207892079920809208192082920839208492085920869208792088920899209092091920929209392094920959209692097920989209992100921019210292103921049210592106921079210892109921109211192112921139211492115921169211792118921199212092121921229212392124921259212692127921289212992130921319213292133921349213592136921379213892139921409214192142921439214492145921469214792148921499215092151921529215392154921559215692157921589215992160921619216292163921649216592166921679216892169921709217192172921739217492175921769217792178921799218092181921829218392184921859218692187921889218992190921919219292193921949219592196921979219892199922009220192202922039220492205922069220792208922099221092211922129221392214922159221692217922189221992220922219222292223922249222592226922279222892229922309223192232922339223492235922369223792238922399224092241922429224392244922459224692247922489224992250922519225292253922549225592256922579225892259922609226192262922639226492265922669226792268922699227092271922729227392274922759227692277922789227992280922819228292283922849228592286922879228892289922909229192292922939229492295922969229792298922999230092301923029230392304923059230692307923089230992310923119231292313923149231592316923179231892319923209232192322923239232492325923269232792328923299233092331923329233392334923359233692337923389233992340923419234292343923449234592346923479234892349923509235192352923539235492355923569235792358923599236092361923629236392364923659236692367923689236992370923719237292373923749237592376923779237892379923809238192382923839238492385923869238792388923899239092391923929239392394923959239692397923989239992400924019240292403924049240592406924079240892409924109241192412924139241492415924169241792418924199242092421924229242392424924259242692427924289242992430924319243292433924349243592436924379243892439924409244192442924439244492445924469244792448924499245092451924529245392454924559245692457924589245992460924619246292463924649246592466924679246892469924709247192472924739247492475924769247792478924799248092481924829248392484924859248692487924889248992490924919249292493924949249592496924979249892499925009250192502925039250492505925069250792508925099251092511925129251392514925159251692517925189251992520925219252292523925249252592526925279252892529925309253192532925339253492535925369253792538925399254092541925429254392544925459254692547925489254992550925519255292553925549255592556925579255892559925609256192562925639256492565925669256792568925699257092571925729257392574925759257692577925789257992580925819258292583925849258592586925879258892589925909259192592925939259492595925969259792598925999260092601926029260392604926059260692607926089260992610926119261292613926149261592616926179261892619926209262192622926239262492625926269262792628926299263092631926329263392634926359263692637926389263992640926419264292643926449264592646926479264892649926509265192652926539265492655926569265792658926599266092661926629266392664926659266692667926689266992670926719267292673926749267592676926779267892679926809268192682926839268492685926869268792688926899269092691926929269392694926959269692697926989269992700927019270292703927049270592706927079270892709927109271192712927139271492715927169271792718927199272092721927229272392724927259272692727927289272992730927319273292733927349273592736927379273892739927409274192742927439274492745927469274792748927499275092751927529275392754927559275692757927589275992760927619276292763927649276592766927679276892769927709277192772927739277492775927769277792778927799278092781927829278392784927859278692787927889278992790927919279292793927949279592796927979279892799928009280192802928039280492805928069280792808928099281092811928129281392814928159281692817928189281992820928219282292823928249282592826928279282892829928309283192832928339283492835928369283792838928399284092841928429284392844928459284692847928489284992850928519285292853928549285592856928579285892859928609286192862928639286492865928669286792868928699287092871928729287392874928759287692877928789287992880928819288292883928849288592886928879288892889928909289192892928939289492895928969289792898928999290092901929029290392904929059290692907929089290992910929119291292913929149291592916929179291892919929209292192922929239292492925929269292792928929299293092931929329293392934929359293692937929389293992940929419294292943929449294592946929479294892949929509295192952929539295492955929569295792958929599296092961929629296392964929659296692967929689296992970929719297292973929749297592976929779297892979929809298192982929839298492985929869298792988929899299092991929929299392994929959299692997929989299993000930019300293003930049300593006930079300893009930109301193012930139301493015930169301793018930199302093021930229302393024930259302693027930289302993030930319303293033930349303593036930379303893039930409304193042930439304493045930469304793048930499305093051930529305393054930559305693057930589305993060930619306293063930649306593066930679306893069930709307193072930739307493075930769307793078930799308093081930829308393084930859308693087930889308993090930919309293093930949309593096930979309893099931009310193102931039310493105931069310793108931099311093111931129311393114931159311693117931189311993120931219312293123931249312593126931279312893129931309313193132931339313493135931369313793138931399314093141931429314393144931459314693147931489314993150931519315293153931549315593156931579315893159931609316193162931639316493165931669316793168931699317093171931729317393174931759317693177931789317993180931819318293183931849318593186931879318893189931909319193192931939319493195931969319793198931999320093201932029320393204932059320693207932089320993210932119321293213932149321593216932179321893219932209322193222932239322493225932269322793228932299323093231932329323393234932359323693237932389323993240932419324293243932449324593246932479324893249932509325193252932539325493255932569325793258932599326093261932629326393264932659326693267932689326993270932719327293273932749327593276932779327893279932809328193282932839328493285932869328793288932899329093291932929329393294932959329693297932989329993300933019330293303933049330593306933079330893309933109331193312933139331493315933169331793318933199332093321933229332393324933259332693327933289332993330933319333293333933349333593336933379333893339933409334193342933439334493345933469334793348933499335093351933529335393354933559335693357933589335993360933619336293363933649336593366933679336893369933709337193372933739337493375933769337793378933799338093381933829338393384933859338693387933889338993390933919339293393933949339593396933979339893399934009340193402934039340493405934069340793408934099341093411934129341393414934159341693417934189341993420934219342293423934249342593426934279342893429934309343193432934339343493435934369343793438934399344093441934429344393444934459344693447934489344993450934519345293453934549345593456934579345893459934609346193462934639346493465934669346793468934699347093471934729347393474934759347693477934789347993480934819348293483934849348593486934879348893489934909349193492934939349493495934969349793498934999350093501935029350393504935059350693507935089350993510935119351293513935149351593516935179351893519935209352193522935239352493525935269352793528935299353093531935329353393534935359353693537935389353993540935419354293543935449354593546935479354893549935509355193552935539355493555935569355793558935599356093561935629356393564935659356693567935689356993570935719357293573935749357593576935779357893579935809358193582935839358493585935869358793588935899359093591935929359393594935959359693597935989359993600936019360293603936049360593606936079360893609936109361193612936139361493615936169361793618936199362093621936229362393624936259362693627936289362993630936319363293633936349363593636936379363893639936409364193642936439364493645936469364793648936499365093651936529365393654936559365693657936589365993660936619366293663936649366593666936679366893669936709367193672936739367493675936769367793678936799368093681936829368393684936859368693687936889368993690936919369293693936949369593696936979369893699937009370193702937039370493705937069370793708937099371093711937129371393714937159371693717937189371993720937219372293723937249372593726937279372893729937309373193732937339373493735937369373793738937399374093741937429374393744937459374693747937489374993750937519375293753937549375593756937579375893759937609376193762937639376493765937669376793768937699377093771937729377393774937759377693777937789377993780937819378293783937849378593786937879378893789937909379193792937939379493795937969379793798937999380093801938029380393804938059380693807938089380993810938119381293813938149381593816938179381893819938209382193822938239382493825938269382793828938299383093831938329383393834938359383693837938389383993840938419384293843938449384593846938479384893849938509385193852938539385493855938569385793858938599386093861938629386393864938659386693867938689386993870938719387293873938749387593876938779387893879938809388193882938839388493885938869388793888938899389093891938929389393894938959389693897938989389993900939019390293903939049390593906939079390893909939109391193912939139391493915939169391793918939199392093921939229392393924939259392693927939289392993930939319393293933939349393593936939379393893939939409394193942939439394493945939469394793948939499395093951939529395393954939559395693957939589395993960939619396293963939649396593966939679396893969939709397193972939739397493975939769397793978939799398093981939829398393984939859398693987939889398993990939919399293993939949399593996939979399893999940009400194002940039400494005940069400794008940099401094011940129401394014940159401694017940189401994020940219402294023940249402594026940279402894029940309403194032940339403494035940369403794038940399404094041940429404394044940459404694047940489404994050940519405294053940549405594056940579405894059940609406194062940639406494065940669406794068940699407094071940729407394074940759407694077940789407994080940819408294083940849408594086940879408894089940909409194092940939409494095940969409794098940999410094101941029410394104941059410694107941089410994110941119411294113941149411594116941179411894119941209412194122941239412494125941269412794128941299413094131941329413394134941359413694137941389413994140941419414294143941449414594146941479414894149941509415194152941539415494155941569415794158941599416094161941629416394164941659416694167941689416994170941719417294173941749417594176941779417894179941809418194182941839418494185941869418794188941899419094191941929419394194941959419694197941989419994200942019420294203942049420594206942079420894209942109421194212942139421494215942169421794218942199422094221942229422394224942259422694227942289422994230942319423294233942349423594236942379423894239942409424194242942439424494245942469424794248942499425094251942529425394254942559425694257942589425994260942619426294263942649426594266942679426894269942709427194272942739427494275942769427794278942799428094281942829428394284942859428694287942889428994290942919429294293942949429594296942979429894299943009430194302943039430494305943069430794308943099431094311943129431394314943159431694317943189431994320943219432294323943249432594326943279432894329943309433194332943339433494335943369433794338943399434094341943429434394344943459434694347943489434994350943519435294353943549435594356943579435894359943609436194362943639436494365943669436794368943699437094371943729437394374943759437694377943789437994380943819438294383943849438594386943879438894389943909439194392943939439494395943969439794398943999440094401944029440394404944059440694407944089440994410944119441294413944149441594416944179441894419944209442194422944239442494425944269442794428944299443094431944329443394434944359443694437944389443994440944419444294443944449444594446944479444894449944509445194452944539445494455944569445794458944599446094461944629446394464944659446694467944689446994470944719447294473944749447594476944779447894479944809448194482944839448494485944869448794488944899449094491944929449394494944959449694497944989449994500945019450294503945049450594506945079450894509945109451194512945139451494515945169451794518945199452094521945229452394524945259452694527945289452994530945319453294533945349453594536945379453894539945409454194542945439454494545945469454794548945499455094551945529455394554945559455694557945589455994560945619456294563945649456594566945679456894569945709457194572945739457494575945769457794578945799458094581945829458394584945859458694587945889458994590945919459294593945949459594596945979459894599946009460194602946039460494605946069460794608946099461094611946129461394614946159461694617946189461994620946219462294623946249462594626946279462894629946309463194632946339463494635946369463794638946399464094641946429464394644946459464694647946489464994650946519465294653946549465594656946579465894659946609466194662946639466494665946669466794668946699467094671946729467394674946759467694677946789467994680946819468294683946849468594686946879468894689946909469194692946939469494695946969469794698946999470094701947029470394704947059470694707947089470994710947119471294713947149471594716947179471894719947209472194722947239472494725947269472794728947299473094731947329473394734947359473694737947389473994740947419474294743947449474594746947479474894749947509475194752947539475494755947569475794758947599476094761947629476394764947659476694767947689476994770947719477294773947749477594776947779477894779947809478194782947839478494785947869478794788947899479094791947929479394794947959479694797947989479994800948019480294803948049480594806948079480894809948109481194812948139481494815948169481794818948199482094821948229482394824948259482694827948289482994830948319483294833948349483594836948379483894839948409484194842948439484494845948469484794848948499485094851948529485394854948559485694857948589485994860948619486294863948649486594866948679486894869948709487194872948739487494875948769487794878948799488094881948829488394884948859488694887948889488994890948919489294893948949489594896948979489894899949009490194902949039490494905949069490794908949099491094911949129491394914949159491694917949189491994920949219492294923949249492594926949279492894929949309493194932949339493494935949369493794938949399494094941949429494394944949459494694947949489494994950949519495294953949549495594956949579495894959949609496194962949639496494965949669496794968949699497094971949729497394974949759497694977949789497994980949819498294983949849498594986949879498894989949909499194992949939499494995949969499794998949999500095001950029500395004950059500695007950089500995010950119501295013950149501595016950179501895019950209502195022950239502495025950269502795028950299503095031950329503395034950359503695037950389503995040950419504295043950449504595046950479504895049950509505195052950539505495055950569505795058950599506095061950629506395064950659506695067950689506995070950719507295073950749507595076950779507895079950809508195082950839508495085950869508795088950899509095091950929509395094950959509695097950989509995100951019510295103951049510595106951079510895109951109511195112951139511495115951169511795118951199512095121951229512395124951259512695127951289512995130951319513295133951349513595136951379513895139951409514195142951439514495145951469514795148951499515095151951529515395154951559515695157951589515995160951619516295163951649516595166951679516895169951709517195172951739517495175951769517795178951799518095181951829518395184951859518695187951889518995190951919519295193951949519595196951979519895199952009520195202952039520495205952069520795208952099521095211952129521395214952159521695217952189521995220952219522295223952249522595226952279522895229952309523195232952339523495235952369523795238952399524095241952429524395244952459524695247952489524995250952519525295253952549525595256952579525895259952609526195262952639526495265952669526795268952699527095271952729527395274952759527695277952789527995280952819528295283952849528595286952879528895289952909529195292952939529495295952969529795298952999530095301953029530395304953059530695307953089530995310953119531295313953149531595316953179531895319953209532195322953239532495325953269532795328953299533095331953329533395334953359533695337953389533995340953419534295343953449534595346953479534895349953509535195352953539535495355953569535795358953599536095361953629536395364953659536695367953689536995370953719537295373953749537595376953779537895379953809538195382953839538495385953869538795388953899539095391953929539395394953959539695397953989539995400954019540295403954049540595406954079540895409954109541195412954139541495415954169541795418954199542095421954229542395424954259542695427954289542995430954319543295433954349543595436954379543895439954409544195442954439544495445954469544795448954499545095451954529545395454954559545695457954589545995460954619546295463954649546595466954679546895469954709547195472954739547495475954769547795478954799548095481954829548395484954859548695487954889548995490954919549295493954949549595496954979549895499955009550195502955039550495505955069550795508955099551095511955129551395514955159551695517955189551995520955219552295523955249552595526955279552895529955309553195532955339553495535955369553795538955399554095541955429554395544955459554695547955489554995550955519555295553955549555595556955579555895559955609556195562955639556495565955669556795568955699557095571955729557395574955759557695577955789557995580955819558295583955849558595586955879558895589955909559195592955939559495595955969559795598955999560095601956029560395604956059560695607956089560995610956119561295613956149561595616956179561895619956209562195622956239562495625956269562795628956299563095631956329563395634956359563695637956389563995640956419564295643956449564595646956479564895649956509565195652956539565495655956569565795658956599566095661956629566395664956659566695667956689566995670956719567295673956749567595676956779567895679956809568195682956839568495685956869568795688956899569095691956929569395694956959569695697956989569995700957019570295703957049570595706957079570895709957109571195712957139571495715957169571795718957199572095721957229572395724957259572695727957289572995730957319573295733957349573595736957379573895739957409574195742957439574495745957469574795748957499575095751957529575395754957559575695757957589575995760957619576295763957649576595766957679576895769957709577195772957739577495775957769577795778957799578095781957829578395784957859578695787957889578995790957919579295793957949579595796957979579895799958009580195802958039580495805958069580795808958099581095811958129581395814958159581695817958189581995820958219582295823958249582595826958279582895829958309583195832958339583495835958369583795838958399584095841958429584395844958459584695847958489584995850958519585295853958549585595856958579585895859958609586195862958639586495865958669586795868958699587095871958729587395874958759587695877958789587995880958819588295883958849588595886958879588895889958909589195892958939589495895958969589795898958999590095901959029590395904959059590695907959089590995910959119591295913959149591595916959179591895919959209592195922959239592495925959269592795928959299593095931959329593395934959359593695937959389593995940959419594295943959449594595946959479594895949959509595195952959539595495955959569595795958959599596095961959629596395964959659596695967959689596995970959719597295973959749597595976959779597895979959809598195982959839598495985959869598795988959899599095991959929599395994959959599695997959989599996000960019600296003960049600596006960079600896009960109601196012960139601496015960169601796018960199602096021960229602396024960259602696027960289602996030960319603296033960349603596036960379603896039960409604196042960439604496045960469604796048960499605096051960529605396054960559605696057960589605996060960619606296063960649606596066960679606896069960709607196072960739607496075960769607796078960799608096081960829608396084960859608696087960889608996090960919609296093960949609596096960979609896099961009610196102961039610496105961069610796108961099611096111961129611396114961159611696117961189611996120961219612296123961249612596126961279612896129961309613196132961339613496135961369613796138961399614096141961429614396144961459614696147961489614996150961519615296153961549615596156961579615896159961609616196162961639616496165961669616796168961699617096171961729617396174961759617696177961789617996180961819618296183961849618596186961879618896189961909619196192961939619496195961969619796198961999620096201962029620396204962059620696207962089620996210962119621296213962149621596216962179621896219962209622196222962239622496225962269622796228962299623096231962329623396234962359623696237962389623996240962419624296243962449624596246962479624896249962509625196252962539625496255962569625796258962599626096261962629626396264962659626696267962689626996270962719627296273962749627596276962779627896279962809628196282962839628496285962869628796288962899629096291962929629396294962959629696297962989629996300963019630296303963049630596306963079630896309963109631196312963139631496315963169631796318963199632096321963229632396324963259632696327963289632996330963319633296333963349633596336963379633896339963409634196342963439634496345963469634796348963499635096351963529635396354963559635696357963589635996360963619636296363963649636596366963679636896369963709637196372963739637496375963769637796378963799638096381963829638396384963859638696387963889638996390963919639296393963949639596396963979639896399964009640196402964039640496405964069640796408964099641096411964129641396414964159641696417964189641996420964219642296423964249642596426964279642896429964309643196432964339643496435964369643796438964399644096441964429644396444964459644696447964489644996450964519645296453964549645596456964579645896459964609646196462964639646496465964669646796468964699647096471964729647396474964759647696477964789647996480964819648296483964849648596486964879648896489964909649196492964939649496495964969649796498964999650096501965029650396504965059650696507965089650996510965119651296513965149651596516965179651896519965209652196522965239652496525965269652796528965299653096531965329653396534965359653696537965389653996540965419654296543965449654596546965479654896549965509655196552965539655496555965569655796558965599656096561965629656396564965659656696567965689656996570965719657296573965749657596576965779657896579965809658196582965839658496585965869658796588965899659096591965929659396594965959659696597965989659996600966019660296603966049660596606966079660896609966109661196612966139661496615966169661796618966199662096621966229662396624966259662696627966289662996630966319663296633966349663596636966379663896639966409664196642966439664496645966469664796648966499665096651966529665396654966559665696657966589665996660966619666296663966649666596666966679666896669966709667196672966739667496675966769667796678966799668096681966829668396684966859668696687966889668996690966919669296693966949669596696966979669896699967009670196702967039670496705967069670796708967099671096711967129671396714967159671696717967189671996720967219672296723967249672596726967279672896729967309673196732967339673496735967369673796738967399674096741967429674396744967459674696747967489674996750967519675296753967549675596756967579675896759967609676196762967639676496765967669676796768967699677096771967729677396774967759677696777967789677996780967819678296783967849678596786967879678896789967909679196792967939679496795967969679796798967999680096801968029680396804968059680696807968089680996810968119681296813968149681596816968179681896819968209682196822968239682496825968269682796828968299683096831968329683396834968359683696837968389683996840968419684296843968449684596846968479684896849968509685196852968539685496855968569685796858968599686096861968629686396864968659686696867968689686996870968719687296873968749687596876968779687896879968809688196882968839688496885968869688796888968899689096891968929689396894968959689696897968989689996900969019690296903969049690596906969079690896909969109691196912969139691496915969169691796918969199692096921969229692396924969259692696927969289692996930969319693296933969349693596936969379693896939969409694196942969439694496945969469694796948969499695096951969529695396954969559695696957969589695996960969619696296963969649696596966969679696896969969709697196972969739697496975969769697796978969799698096981969829698396984969859698696987969889698996990969919699296993969949699596996969979699896999970009700197002970039700497005970069700797008970099701097011970129701397014970159701697017970189701997020970219702297023970249702597026970279702897029970309703197032970339703497035970369703797038970399704097041970429704397044970459704697047970489704997050970519705297053970549705597056970579705897059970609706197062970639706497065970669706797068970699707097071970729707397074970759707697077970789707997080970819708297083970849708597086970879708897089970909709197092970939709497095970969709797098970999710097101971029710397104971059710697107971089710997110971119711297113971149711597116971179711897119971209712197122971239712497125971269712797128971299713097131971329713397134971359713697137971389713997140971419714297143971449714597146971479714897149971509715197152971539715497155971569715797158971599716097161971629716397164971659716697167971689716997170971719717297173971749717597176971779717897179971809718197182971839718497185971869718797188971899719097191971929719397194971959719697197971989719997200972019720297203972049720597206972079720897209972109721197212972139721497215972169721797218972199722097221972229722397224972259722697227972289722997230972319723297233972349723597236972379723897239972409724197242972439724497245972469724797248972499725097251972529725397254972559725697257972589725997260972619726297263972649726597266972679726897269972709727197272972739727497275972769727797278972799728097281972829728397284972859728697287972889728997290972919729297293972949729597296972979729897299973009730197302973039730497305973069730797308973099731097311973129731397314973159731697317973189731997320973219732297323973249732597326973279732897329973309733197332973339733497335973369733797338973399734097341973429734397344973459734697347973489734997350973519735297353973549735597356973579735897359973609736197362973639736497365973669736797368973699737097371973729737397374973759737697377973789737997380973819738297383973849738597386973879738897389973909739197392973939739497395973969739797398973999740097401974029740397404974059740697407974089740997410974119741297413974149741597416974179741897419974209742197422974239742497425974269742797428974299743097431974329743397434974359743697437974389743997440974419744297443974449744597446974479744897449974509745197452974539745497455974569745797458974599746097461974629746397464974659746697467974689746997470974719747297473974749747597476974779747897479974809748197482974839748497485974869748797488974899749097491974929749397494974959749697497974989749997500975019750297503975049750597506975079750897509975109751197512975139751497515975169751797518975199752097521975229752397524975259752697527975289752997530975319753297533975349753597536975379753897539975409754197542975439754497545975469754797548975499755097551975529755397554975559755697557975589755997560975619756297563975649756597566975679756897569975709757197572975739757497575975769757797578975799758097581975829758397584975859758697587975889758997590975919759297593975949759597596975979759897599976009760197602976039760497605976069760797608976099761097611976129761397614976159761697617976189761997620976219762297623976249762597626976279762897629976309763197632976339763497635976369763797638976399764097641976429764397644976459764697647976489764997650976519765297653976549765597656976579765897659976609766197662976639766497665976669766797668976699767097671976729767397674976759767697677976789767997680976819768297683976849768597686976879768897689976909769197692976939769497695976969769797698976999770097701977029770397704977059770697707977089770997710977119771297713977149771597716977179771897719977209772197722977239772497725977269772797728977299773097731977329773397734977359773697737977389773997740977419774297743977449774597746977479774897749977509775197752977539775497755977569775797758977599776097761977629776397764977659776697767977689776997770977719777297773977749777597776977779777897779977809778197782977839778497785977869778797788977899779097791977929779397794977959779697797977989779997800978019780297803978049780597806978079780897809978109781197812978139781497815978169781797818978199782097821978229782397824978259782697827978289782997830978319783297833978349783597836978379783897839978409784197842978439784497845978469784797848978499785097851978529785397854978559785697857978589785997860978619786297863978649786597866978679786897869978709787197872978739787497875978769787797878978799788097881978829788397884978859788697887978889788997890978919789297893978949789597896978979789897899979009790197902979039790497905979069790797908979099791097911979129791397914979159791697917979189791997920979219792297923979249792597926979279792897929979309793197932979339793497935979369793797938979399794097941979429794397944979459794697947979489794997950979519795297953979549795597956979579795897959979609796197962979639796497965979669796797968979699797097971979729797397974979759797697977979789797997980979819798297983979849798597986979879798897989979909799197992979939799497995979969799797998979999800098001980029800398004980059800698007980089800998010980119801298013980149801598016980179801898019980209802198022980239802498025980269802798028980299803098031980329803398034980359803698037980389803998040980419804298043980449804598046980479804898049980509805198052980539805498055980569805798058980599806098061980629806398064980659806698067980689806998070980719807298073980749807598076980779807898079980809808198082980839808498085980869808798088980899809098091980929809398094980959809698097980989809998100981019810298103981049810598106981079810898109981109811198112981139811498115981169811798118981199812098121981229812398124981259812698127981289812998130981319813298133981349813598136981379813898139981409814198142981439814498145981469814798148981499815098151981529815398154981559815698157981589815998160981619816298163981649816598166981679816898169981709817198172981739817498175981769817798178981799818098181981829818398184981859818698187981889818998190981919819298193981949819598196981979819898199982009820198202982039820498205982069820798208982099821098211982129821398214982159821698217982189821998220982219822298223982249822598226982279822898229982309823198232982339823498235982369823798238982399824098241982429824398244982459824698247982489824998250982519825298253982549825598256982579825898259982609826198262982639826498265982669826798268982699827098271982729827398274982759827698277982789827998280982819828298283982849828598286982879828898289982909829198292982939829498295982969829798298982999830098301983029830398304983059830698307983089830998310983119831298313983149831598316983179831898319983209832198322983239832498325983269832798328983299833098331983329833398334983359833698337983389833998340983419834298343983449834598346983479834898349983509835198352983539835498355983569835798358983599836098361983629836398364983659836698367983689836998370983719837298373983749837598376983779837898379983809838198382983839838498385983869838798388983899839098391983929839398394983959839698397983989839998400984019840298403984049840598406984079840898409984109841198412984139841498415984169841798418984199842098421984229842398424984259842698427984289842998430984319843298433984349843598436984379843898439984409844198442984439844498445984469844798448984499845098451984529845398454984559845698457984589845998460984619846298463984649846598466984679846898469984709847198472984739847498475984769847798478984799848098481984829848398484984859848698487984889848998490984919849298493984949849598496984979849898499985009850198502985039850498505985069850798508985099851098511985129851398514985159851698517985189851998520985219852298523985249852598526985279852898529985309853198532985339853498535985369853798538985399854098541985429854398544985459854698547985489854998550985519855298553985549855598556985579855898559985609856198562985639856498565985669856798568985699857098571985729857398574985759857698577985789857998580985819858298583985849858598586985879858898589985909859198592985939859498595985969859798598985999860098601986029860398604986059860698607986089860998610986119861298613986149861598616986179861898619986209862198622986239862498625986269862798628986299863098631986329863398634986359863698637986389863998640986419864298643986449864598646986479864898649986509865198652986539865498655986569865798658986599866098661986629866398664986659866698667986689866998670986719867298673986749867598676986779867898679986809868198682986839868498685986869868798688986899869098691986929869398694986959869698697986989869998700987019870298703987049870598706987079870898709987109871198712987139871498715987169871798718987199872098721987229872398724987259872698727987289872998730987319873298733987349873598736987379873898739987409874198742987439874498745987469874798748987499875098751987529875398754987559875698757987589875998760987619876298763987649876598766987679876898769987709877198772987739877498775987769877798778987799878098781987829878398784987859878698787987889878998790987919879298793987949879598796987979879898799988009880198802988039880498805988069880798808988099881098811988129881398814988159881698817988189881998820988219882298823988249882598826988279882898829988309883198832988339883498835988369883798838988399884098841988429884398844988459884698847988489884998850988519885298853988549885598856988579885898859988609886198862988639886498865988669886798868988699887098871988729887398874988759887698877988789887998880988819888298883988849888598886988879888898889988909889198892988939889498895988969889798898988999890098901989029890398904989059890698907989089890998910989119891298913989149891598916989179891898919989209892198922989239892498925989269892798928989299893098931989329893398934989359893698937989389893998940989419894298943989449894598946989479894898949989509895198952989539895498955989569895798958989599896098961989629896398964989659896698967989689896998970989719897298973989749897598976989779897898979989809898198982989839898498985989869898798988989899899098991989929899398994989959899698997989989899999000990019900299003990049900599006990079900899009990109901199012990139901499015990169901799018990199902099021990229902399024990259902699027990289902999030990319903299033990349903599036990379903899039990409904199042990439904499045990469904799048990499905099051990529905399054990559905699057990589905999060990619906299063990649906599066990679906899069990709907199072990739907499075990769907799078990799908099081990829908399084990859908699087990889908999090990919909299093990949909599096990979909899099991009910199102991039910499105991069910799108991099911099111991129911399114991159911699117991189911999120991219912299123991249912599126991279912899129991309913199132991339913499135991369913799138991399914099141991429914399144991459914699147991489914999150991519915299153991549915599156991579915899159991609916199162991639916499165991669916799168991699917099171991729917399174991759917699177991789917999180991819918299183991849918599186991879918899189991909919199192991939919499195991969919799198991999920099201992029920399204992059920699207992089920999210992119921299213992149921599216992179921899219992209922199222992239922499225992269922799228992299923099231992329923399234992359923699237992389923999240992419924299243992449924599246992479924899249992509925199252992539925499255992569925799258992599926099261992629926399264992659926699267992689926999270992719927299273992749927599276992779927899279992809928199282992839928499285992869928799288992899929099291992929929399294992959929699297992989929999300993019930299303993049930599306993079930899309993109931199312993139931499315993169931799318993199932099321993229932399324993259932699327993289932999330993319933299333993349933599336993379933899339993409934199342993439934499345993469934799348993499935099351993529935399354993559935699357993589935999360993619936299363993649936599366993679936899369993709937199372993739937499375993769937799378993799938099381993829938399384993859938699387993889938999390993919939299393993949939599396993979939899399994009940199402994039940499405994069940799408994099941099411994129941399414994159941699417994189941999420994219942299423994249942599426994279942899429994309943199432994339943499435994369943799438994399944099441994429944399444994459944699447994489944999450994519945299453994549945599456994579945899459994609946199462994639946499465994669946799468994699947099471994729947399474994759947699477994789947999480994819948299483994849948599486994879948899489994909949199492994939949499495994969949799498994999950099501995029950399504995059950699507995089950999510995119951299513995149951599516995179951899519995209952199522995239952499525995269952799528995299953099531995329953399534995359953699537995389953999540995419954299543995449954599546995479954899549995509955199552995539955499555995569955799558995599956099561995629956399564995659956699567995689956999570995719957299573995749957599576995779957899579995809958199582995839958499585995869958799588995899959099591995929959399594995959959699597995989959999600996019960299603996049960599606996079960899609996109961199612996139961499615996169961799618996199962099621996229962399624996259962699627996289962999630996319963299633996349963599636996379963899639996409964199642996439964499645996469964799648996499965099651996529965399654996559965699657996589965999660996619966299663996649966599666996679966899669996709967199672996739967499675996769967799678996799968099681996829968399684996859968699687996889968999690996919969299693996949969599696996979969899699997009970199702997039970499705997069970799708997099971099711997129971399714997159971699717997189971999720997219972299723997249972599726997279972899729997309973199732997339973499735997369973799738997399974099741997429974399744997459974699747997489974999750997519975299753997549975599756997579975899759997609976199762997639976499765997669976799768997699977099771997729977399774997759977699777997789977999780997819978299783997849978599786997879978899789997909979199792997939979499795997969979799798997999980099801998029980399804998059980699807998089980999810998119981299813998149981599816998179981899819998209982199822998239982499825998269982799828998299983099831998329983399834998359983699837998389983999840998419984299843998449984599846998479984899849998509985199852998539985499855998569985799858998599986099861998629986399864998659986699867998689986999870998719987299873998749987599876998779987899879998809988199882998839988499885998869988799888998899989099891998929989399894998959989699897998989989999900999019990299903999049990599906999079990899909999109991199912999139991499915999169991799918999199992099921999229992399924999259992699927999289992999930999319993299933999349993599936999379993899939999409994199942999439994499945999469994799948999499995099951999529995399954999559995699957999589995999960999619996299963999649996599966999679996899969999709997199972999739997499975999769997799978999799998099981999829998399984999859998699987999889998999990999919999299993999949999599996999979999899999100000100001100002100003100004100005100006100007100008100009100010100011100012100013100014100015100016100017100018100019100020100021100022100023100024100025100026100027100028100029100030100031100032100033100034100035100036100037100038100039100040100041100042100043100044100045100046100047100048100049100050100051100052100053100054100055100056100057100058100059100060100061100062100063100064100065100066100067100068100069100070100071100072100073100074100075100076100077100078100079100080100081100082100083100084100085100086100087100088100089100090100091100092100093100094100095100096100097100098100099100100100101100102100103100104100105100106100107100108100109100110100111100112100113100114100115100116100117100118100119100120100121100122100123100124100125100126100127100128100129100130100131100132100133100134100135100136100137100138100139100140100141100142100143100144100145100146100147100148100149100150100151100152100153100154100155100156100157100158100159100160100161100162100163100164100165100166100167100168100169100170100171100172100173100174100175100176100177100178100179100180100181100182100183100184100185100186100187100188100189100190100191100192100193100194100195100196100197100198100199100200100201100202100203100204100205100206100207100208100209100210100211100212100213100214100215100216100217100218100219100220100221100222100223100224100225100226100227100228100229100230100231100232100233100234100235100236100237100238100239100240100241100242100243100244100245100246100247100248100249100250100251100252100253100254100255100256100257100258100259100260100261100262100263100264100265100266100267100268100269100270100271100272100273100274100275100276100277100278100279100280100281100282100283100284100285100286100287100288100289100290100291100292100293100294100295100296100297100298100299100300100301100302100303100304100305100306100307100308100309100310100311100312100313100314100315100316100317100318100319100320100321100322100323100324100325100326100327100328100329100330100331100332100333100334100335100336100337100338100339100340100341100342100343100344100345100346100347100348100349100350100351100352100353100354100355100356100357100358100359100360100361100362100363100364100365100366100367100368100369100370100371100372100373100374100375100376100377100378100379100380100381100382100383100384100385100386100387100388100389100390100391100392100393100394100395100396100397100398100399100400100401100402100403100404100405100406100407100408100409100410100411100412100413100414100415100416100417100418100419100420100421100422100423100424100425100426100427100428100429100430100431100432100433100434100435100436100437100438100439100440100441100442100443100444100445100446100447100448100449100450100451100452100453100454100455100456100457100458100459100460100461100462100463100464100465100466100467100468100469100470100471100472100473100474100475100476100477100478100479100480100481100482100483100484100485100486100487100488100489100490100491100492100493100494100495100496100497100498100499100500100501100502100503100504100505100506100507100508100509100510100511100512100513100514100515100516100517100518100519100520100521100522100523100524100525100526100527100528100529100530100531100532100533100534100535100536100537100538100539100540100541100542100543100544100545100546100547100548100549100550100551100552100553100554100555100556100557100558100559100560100561100562100563100564100565100566100567100568100569100570100571100572100573100574100575100576100577100578100579100580100581100582100583100584100585100586100587100588100589100590100591100592100593100594100595100596100597100598100599100600100601100602100603100604100605100606100607100608100609100610100611100612100613100614100615100616100617100618100619100620100621100622100623100624100625100626100627100628100629100630100631100632100633100634100635100636100637100638100639100640100641100642100643100644100645100646100647100648100649100650100651100652100653100654100655100656100657100658100659100660100661100662100663100664100665100666100667100668100669100670100671100672100673100674100675100676100677100678100679100680100681100682100683100684100685100686100687100688100689100690100691100692100693100694100695100696100697100698100699100700100701100702100703100704100705100706100707100708100709100710100711100712100713100714100715100716100717100718100719100720100721100722100723100724100725100726100727100728100729100730100731100732100733100734100735100736100737100738100739100740100741100742100743100744100745100746100747100748100749100750100751100752100753100754100755100756100757100758100759100760100761100762100763100764100765100766100767100768100769100770100771100772100773100774100775100776100777100778100779100780100781100782100783100784100785100786100787100788100789100790100791100792100793100794100795100796100797100798100799100800100801100802100803100804100805100806100807100808100809100810100811100812100813100814100815100816100817100818100819100820100821100822100823100824100825100826100827100828100829100830100831100832100833100834100835100836100837100838100839100840100841100842100843100844100845100846100847100848100849100850100851100852100853100854100855100856100857100858100859100860100861100862100863100864100865100866100867100868100869100870100871100872100873100874100875100876100877100878100879100880100881100882100883100884100885100886100887100888100889100890100891100892100893100894100895100896100897100898100899100900100901100902100903100904100905100906100907100908100909100910100911100912100913100914100915100916100917100918100919100920100921100922100923100924100925100926100927100928100929100930100931100932100933100934100935100936100937100938100939100940100941100942100943100944100945100946100947100948100949100950100951100952100953100954100955100956100957100958100959100960100961100962100963100964100965100966100967100968100969100970100971100972100973100974100975100976100977100978100979100980100981100982100983100984100985100986100987100988100989100990100991100992100993100994100995100996100997100998100999101000101001101002101003101004101005101006101007101008101009101010101011101012101013101014101015101016101017101018101019101020101021101022101023101024101025101026101027101028101029101030101031101032101033101034101035101036101037101038101039101040101041101042101043101044101045101046101047101048101049101050101051101052101053101054101055101056101057101058101059101060101061101062101063101064101065101066101067101068101069101070101071101072101073101074101075101076101077101078101079101080101081101082101083101084101085101086101087101088101089101090101091101092101093101094101095101096101097101098101099101100101101101102101103101104101105101106101107101108101109101110101111101112101113101114101115101116101117101118101119101120101121101122101123101124101125101126101127101128101129101130101131101132101133101134101135101136101137101138101139101140101141101142101143101144101145101146101147101148101149101150101151101152101153101154101155101156101157101158101159101160101161101162101163101164101165101166101167101168101169101170101171101172101173101174101175101176101177101178101179101180101181101182101183101184101185101186101187101188101189101190101191101192101193101194101195101196101197101198101199101200101201101202101203101204101205101206101207101208101209101210101211101212101213101214101215101216101217101218101219101220101221101222101223101224101225101226101227101228101229101230101231101232101233101234101235101236101237101238101239101240101241101242101243101244101245101246101247101248101249101250101251101252101253101254101255101256101257101258101259101260101261101262101263101264101265101266101267101268101269101270101271101272101273101274101275101276101277101278101279101280101281101282101283101284101285101286101287101288101289101290101291101292101293101294101295101296101297101298101299101300101301101302101303101304101305101306101307101308101309101310101311101312101313101314101315101316101317101318101319101320101321101322101323101324101325101326101327101328101329101330101331101332101333101334101335101336101337101338101339101340101341101342101343101344101345101346101347101348101349101350101351101352101353101354101355101356101357101358101359101360101361101362101363101364101365101366101367101368101369101370101371101372101373101374101375101376101377101378101379101380101381101382101383101384101385101386101387101388101389101390101391101392101393101394101395101396101397101398101399101400101401101402101403101404101405101406101407101408101409101410101411101412101413101414101415101416101417101418101419101420101421101422101423101424101425101426101427101428101429101430101431101432101433101434101435101436101437101438101439101440101441101442101443101444101445101446101447101448101449101450101451101452101453101454101455101456101457101458101459101460101461101462101463101464101465101466101467101468101469101470101471101472101473101474101475101476101477101478101479101480101481101482101483101484101485101486101487101488101489101490101491101492101493101494101495101496101497101498101499101500101501101502101503101504101505101506101507101508101509101510101511101512101513101514101515101516101517101518101519101520101521101522101523101524101525101526101527101528101529101530101531101532101533101534101535101536101537101538101539101540101541101542101543101544101545101546101547101548101549101550101551101552101553101554101555101556101557101558101559101560101561101562101563101564101565101566101567101568101569101570101571101572101573101574101575101576101577101578101579101580101581101582101583101584101585101586101587101588101589101590101591101592101593101594101595101596101597101598101599101600101601101602101603101604101605101606101607101608101609101610101611101612101613101614101615101616101617101618101619101620101621101622101623101624101625101626101627101628101629101630101631101632101633101634101635101636101637101638101639101640101641101642101643101644101645101646101647101648101649101650101651101652101653101654101655101656101657101658101659101660101661101662101663101664101665101666101667101668101669101670101671101672101673101674101675101676101677101678101679101680101681101682101683101684101685101686101687101688101689101690101691101692101693101694101695101696101697101698101699101700101701101702101703101704101705101706101707101708101709101710101711101712101713101714101715101716101717101718101719101720101721101722101723101724101725101726101727101728101729101730101731101732101733101734101735101736101737101738101739101740101741101742101743101744101745101746101747101748101749101750101751101752101753101754101755101756101757101758101759101760101761101762101763101764101765101766101767101768101769101770101771101772101773101774101775101776101777101778101779101780101781101782101783101784101785101786101787101788101789101790101791101792101793101794101795101796101797101798101799101800101801101802101803101804101805101806101807101808101809101810101811101812101813101814101815101816101817101818101819101820101821101822101823101824101825101826101827101828101829101830101831101832101833101834101835101836101837101838101839101840101841101842101843101844101845101846101847101848101849101850101851101852101853101854101855101856101857101858101859101860101861101862101863101864101865101866101867101868101869101870101871101872101873101874101875101876101877101878101879101880101881101882101883101884101885101886101887101888101889101890101891101892101893101894101895101896101897101898101899101900101901101902101903101904101905101906101907101908101909101910101911101912101913101914101915101916101917101918101919101920101921101922101923101924101925101926101927101928101929101930101931101932101933101934101935101936101937101938101939101940101941101942101943101944101945101946101947101948101949101950101951101952101953101954101955101956101957101958101959101960101961101962101963101964101965101966101967101968101969101970101971101972101973101974101975101976101977101978101979101980101981101982101983101984101985101986101987101988101989101990101991101992101993101994101995101996101997101998101999102000102001102002102003102004102005102006102007102008102009102010102011102012102013102014102015102016102017102018102019102020102021102022102023102024102025102026102027102028102029102030102031102032102033102034102035102036102037102038102039102040102041102042102043102044102045102046102047102048102049102050102051102052102053102054102055102056102057102058102059102060102061102062102063102064102065102066102067102068102069102070102071102072102073102074102075102076102077102078102079102080102081102082102083102084102085102086102087102088102089102090102091102092102093102094102095102096102097102098102099102100102101102102102103102104102105102106102107102108102109102110102111102112102113102114102115102116102117102118102119102120102121102122102123102124102125102126102127102128102129102130102131102132102133102134102135102136102137102138102139102140102141102142102143102144102145102146102147102148102149102150102151102152102153102154102155102156102157102158102159102160102161102162102163102164102165102166102167102168102169102170102171102172102173102174102175102176102177102178102179102180102181102182102183102184102185102186102187102188102189102190102191102192102193102194102195102196102197102198102199102200102201102202102203102204102205102206102207102208102209102210102211102212102213102214102215102216102217102218102219102220102221102222102223102224102225102226102227102228102229102230102231102232102233102234102235102236102237102238102239102240102241102242102243102244102245102246102247102248102249102250102251102252102253102254102255102256102257102258102259102260102261102262102263102264102265102266102267102268102269102270102271102272102273102274102275102276102277102278102279102280102281102282102283102284102285102286102287102288102289102290102291102292102293102294102295102296102297102298102299102300102301102302102303102304102305102306102307102308102309102310102311102312102313102314102315102316102317102318102319102320102321102322102323102324102325102326102327102328102329102330102331102332102333102334102335102336102337102338102339102340102341102342102343102344102345102346102347102348102349102350102351102352102353102354102355102356102357102358102359102360102361102362102363102364102365102366102367102368102369102370102371102372102373102374102375102376102377102378102379102380102381102382102383102384102385102386102387102388102389102390102391102392102393102394102395102396102397102398102399102400102401102402102403102404102405102406102407102408102409102410102411102412102413102414102415102416102417102418102419102420102421102422102423102424102425102426102427102428102429102430102431102432102433102434102435102436102437102438102439102440102441102442102443102444102445102446102447102448102449102450102451102452102453102454102455102456102457102458102459102460102461102462102463102464102465102466102467102468102469102470102471102472102473102474102475102476102477102478102479102480102481102482102483102484102485102486102487102488102489102490102491102492102493102494102495102496102497102498102499102500102501102502102503102504102505102506102507102508102509102510102511102512102513102514102515102516102517102518102519102520102521102522102523102524102525102526102527102528102529102530102531102532102533102534102535102536102537102538102539102540102541102542102543102544102545102546102547102548102549102550102551102552102553102554102555102556102557102558102559102560102561102562102563102564102565102566102567102568102569102570102571102572102573102574102575102576102577102578102579102580102581102582102583102584102585102586102587102588102589102590102591102592102593102594102595102596102597102598102599102600102601102602102603102604102605102606102607102608102609102610102611102612102613102614102615102616102617102618102619102620102621102622102623102624102625102626102627102628102629102630102631102632102633102634102635102636102637102638102639102640102641102642102643102644102645102646102647102648102649102650102651102652102653102654102655102656102657102658102659102660102661102662102663102664102665102666102667102668102669102670102671102672102673102674102675102676102677102678102679102680102681102682102683102684102685102686102687102688102689102690102691102692102693102694102695102696102697102698102699102700102701102702102703102704102705102706102707102708102709102710102711102712102713102714102715102716102717102718102719102720102721102722102723102724102725102726102727102728102729102730102731102732102733102734102735102736102737102738102739102740102741102742102743102744102745102746102747102748102749102750102751102752102753102754102755102756102757102758102759102760102761102762102763102764102765102766102767102768102769102770102771102772102773102774102775102776102777102778102779102780102781102782102783102784102785102786102787102788102789102790102791102792102793102794102795102796102797102798102799102800102801102802102803102804102805102806102807102808102809102810102811102812102813102814102815102816102817102818102819102820102821102822102823102824102825102826102827102828102829102830102831102832102833102834102835102836102837102838102839102840102841102842102843102844102845102846102847102848102849102850102851102852102853102854102855102856102857102858102859102860102861102862102863102864102865102866102867102868102869102870102871102872102873102874102875102876102877102878102879102880102881102882102883102884102885102886102887102888102889102890102891102892102893102894102895102896102897102898102899102900102901102902102903102904102905102906102907102908102909102910102911102912102913102914102915102916102917102918102919102920102921102922102923102924102925102926102927102928102929102930102931102932102933102934102935102936102937102938102939102940102941102942102943102944102945102946102947102948102949102950102951102952102953102954102955102956102957102958102959102960102961102962102963102964102965102966102967102968102969102970102971102972102973102974102975102976102977102978102979102980102981102982102983102984102985102986102987102988102989102990102991102992102993102994102995102996102997102998102999103000103001103002103003103004103005103006103007103008103009103010103011103012103013103014103015103016103017103018103019103020103021103022103023103024103025103026103027103028103029103030103031103032103033103034103035103036103037103038103039103040103041103042103043103044103045103046103047103048103049103050103051103052103053103054103055103056103057103058103059103060103061103062103063103064103065103066103067103068103069103070103071103072103073103074103075103076103077103078103079103080103081103082103083103084103085103086103087103088103089103090103091103092103093103094103095103096103097103098103099103100103101103102103103103104103105103106103107103108103109103110103111103112103113103114103115103116103117103118103119103120103121103122103123103124103125103126103127103128103129103130103131103132103133103134103135103136103137103138103139103140103141103142103143103144103145103146103147103148103149103150103151103152103153103154103155103156103157103158103159103160103161103162103163103164103165103166103167103168103169103170103171103172103173103174103175103176103177103178103179103180103181103182103183103184103185103186103187103188103189103190103191103192103193103194103195103196103197103198103199103200103201103202103203103204103205103206103207103208103209103210103211103212103213103214103215103216103217103218103219103220103221103222103223103224103225103226103227103228103229103230103231103232103233103234103235103236103237103238103239103240103241103242103243103244103245103246103247103248103249103250103251103252103253103254103255103256103257103258103259103260103261103262103263103264103265103266103267103268103269103270103271103272103273103274103275103276103277103278103279103280103281103282103283103284103285103286103287103288103289103290103291103292103293103294103295103296103297103298103299103300103301103302103303103304103305103306103307103308103309103310103311103312103313103314103315103316103317103318103319103320103321103322103323103324103325103326103327103328103329103330103331103332103333103334103335103336103337103338103339103340103341103342103343103344103345103346103347103348103349103350103351103352103353103354103355103356103357103358103359103360103361103362103363103364103365103366103367103368103369103370103371103372103373103374103375103376103377103378103379103380103381103382103383103384103385103386103387103388103389103390103391103392103393103394103395103396103397103398103399103400103401103402103403103404103405103406103407103408103409103410103411103412103413103414103415103416103417103418103419103420103421103422103423103424103425103426103427103428103429103430103431103432103433103434103435103436103437103438103439103440103441103442103443103444103445103446103447103448103449103450103451103452103453103454103455103456103457103458103459103460103461103462103463103464103465103466103467103468103469103470103471103472103473103474103475103476103477103478103479103480103481103482103483103484103485103486103487103488103489103490103491103492103493103494103495103496103497103498103499103500103501103502103503103504103505103506103507103508103509103510103511103512103513103514103515103516103517103518103519103520103521103522103523103524103525103526103527103528103529103530103531103532103533103534103535103536103537103538103539103540103541103542103543103544103545103546103547103548103549103550103551103552103553103554103555103556103557103558103559103560103561103562103563103564103565103566103567103568103569103570103571103572103573103574103575103576103577103578103579103580103581103582103583103584103585103586103587103588103589103590103591103592103593103594103595103596103597103598103599103600103601103602103603103604103605103606103607103608103609103610103611103612103613103614103615103616103617103618103619103620103621103622103623103624103625103626103627103628103629103630103631103632103633103634103635103636103637103638103639103640103641103642103643103644103645103646103647103648103649103650103651103652103653103654103655103656103657103658103659103660103661103662103663103664103665103666103667103668103669103670103671103672103673103674103675103676103677103678103679103680103681103682103683103684103685103686103687103688103689103690103691103692103693103694103695103696103697103698103699103700103701103702103703103704103705103706103707103708103709103710103711103712103713103714103715103716103717103718103719103720103721103722103723103724103725103726103727103728103729103730103731103732103733103734103735103736103737103738103739103740103741103742103743103744103745103746103747103748103749103750103751103752103753103754103755103756103757103758103759103760103761103762103763103764103765103766103767103768103769103770103771103772103773103774103775103776103777103778103779103780103781103782103783103784103785103786103787103788103789103790103791103792103793103794103795103796103797103798103799103800103801103802103803103804103805103806103807103808103809103810103811103812103813103814103815103816103817103818103819103820103821103822103823103824103825103826103827103828103829103830103831103832103833103834103835103836103837103838103839103840103841103842103843103844103845103846103847103848103849103850103851103852103853103854103855103856103857103858103859103860103861103862103863103864103865103866103867103868103869103870103871103872103873103874103875103876103877103878103879103880103881103882103883103884103885103886103887103888103889103890103891103892103893103894103895103896103897103898103899103900103901103902103903103904103905103906103907103908103909103910103911103912103913103914103915103916103917103918103919103920103921103922103923103924103925103926103927103928103929103930103931103932103933103934103935103936103937103938103939103940103941103942103943103944103945103946103947103948103949103950103951103952103953103954103955103956103957103958103959103960103961103962103963103964103965103966103967103968103969103970103971103972103973103974103975103976103977103978103979103980103981103982103983103984103985103986103987103988103989103990103991103992103993103994103995103996103997103998103999104000104001104002104003104004104005104006104007104008104009104010104011104012104013104014104015104016104017104018104019104020104021104022104023104024104025104026104027104028104029104030104031104032104033104034104035104036104037104038104039104040104041104042104043104044104045104046104047104048104049104050104051104052104053104054104055104056104057104058104059104060104061104062104063104064104065104066104067104068104069104070104071104072104073104074104075104076104077104078104079104080104081104082104083104084104085104086104087104088104089104090104091104092104093104094104095104096104097104098104099104100104101104102104103104104104105104106104107104108104109104110104111104112104113104114104115104116104117104118104119104120104121104122104123104124104125104126104127104128104129104130104131104132104133104134104135104136104137104138104139104140104141104142104143104144104145104146104147104148104149104150104151104152104153104154104155104156104157104158104159104160104161104162104163104164104165104166104167104168104169104170104171104172104173104174104175104176104177104178104179104180104181104182104183104184104185104186104187104188104189104190104191104192104193104194104195104196104197104198104199104200104201104202104203104204104205104206104207104208104209104210104211104212104213104214104215104216104217104218104219104220104221104222104223104224104225104226104227104228104229104230104231104232104233104234104235104236104237104238104239104240104241104242104243104244104245104246104247104248104249104250104251104252104253104254104255104256104257104258104259104260104261104262104263104264104265104266104267104268104269104270104271104272104273104274104275104276104277104278104279104280104281104282104283104284104285104286104287104288104289104290104291104292104293104294104295104296104297104298104299104300104301104302104303104304104305104306104307104308104309104310104311104312104313104314104315104316104317104318104319104320104321104322104323104324104325104326104327104328104329104330104331104332104333104334104335104336104337104338104339104340104341104342104343104344104345104346104347104348104349104350104351104352104353104354104355104356104357104358104359104360104361104362104363104364104365104366104367104368104369104370104371104372104373104374104375104376104377104378104379104380104381104382104383104384104385104386104387104388104389104390104391104392104393104394104395104396104397104398104399104400104401104402104403104404104405104406104407104408104409104410104411104412104413104414104415104416104417104418104419104420104421104422104423104424104425104426104427104428104429104430104431104432104433104434104435104436104437104438104439104440104441104442104443104444104445104446104447104448104449104450104451104452104453104454104455104456104457104458104459104460104461104462104463104464104465104466104467104468104469104470104471104472104473104474104475104476104477104478104479104480104481104482104483104484104485104486104487104488104489104490104491104492104493104494104495104496104497104498104499104500104501104502104503104504104505104506104507104508104509104510104511104512104513104514104515104516104517104518104519104520104521104522104523104524104525104526104527104528104529104530104531104532104533104534104535104536104537104538104539104540104541104542104543104544104545104546104547104548104549104550104551104552104553104554104555104556104557104558104559104560104561104562104563104564104565104566104567104568104569104570104571104572104573104574104575104576104577104578104579104580104581104582104583104584104585104586104587104588104589104590104591104592104593104594104595104596104597104598104599104600104601104602104603104604104605104606104607104608104609104610104611104612104613104614104615104616104617104618104619104620104621104622104623104624104625104626104627104628104629104630104631104632104633104634104635104636104637104638104639104640104641104642104643104644104645104646104647104648104649104650104651104652104653104654104655104656104657104658104659104660104661104662104663104664104665104666104667104668104669104670104671104672104673104674104675104676104677104678104679104680104681104682104683104684104685104686104687104688104689104690104691104692104693104694104695104696104697104698104699104700104701104702104703104704104705104706104707104708104709104710104711104712104713104714104715104716104717104718104719104720104721104722104723104724104725104726104727104728104729104730104731104732104733104734104735104736104737104738104739104740104741104742104743104744104745104746104747104748104749104750104751104752104753104754104755104756104757104758104759104760104761104762104763104764104765104766104767104768104769104770104771104772104773104774104775104776104777104778104779104780104781104782104783104784104785104786104787104788104789104790104791104792104793104794104795104796104797104798104799104800104801104802104803104804104805104806104807104808104809104810104811104812104813104814104815104816104817104818104819104820104821104822104823104824104825104826104827104828104829104830104831104832104833104834104835104836104837104838104839104840104841104842104843104844104845104846104847104848104849104850104851104852104853104854104855104856104857104858104859104860104861104862104863104864104865104866104867104868104869104870104871104872104873104874104875104876104877104878104879104880104881104882104883104884104885104886104887104888104889104890104891104892104893104894104895104896104897104898104899104900104901104902104903104904104905104906104907104908104909104910104911104912104913104914104915104916104917104918104919104920104921104922104923104924104925104926104927104928104929104930104931104932104933104934104935104936104937104938104939104940104941104942104943104944104945104946104947104948104949104950104951104952104953104954104955104956104957104958104959104960104961104962104963104964104965104966104967104968104969104970104971104972104973104974104975104976104977104978104979104980104981104982104983104984104985104986104987104988104989104990104991104992104993104994104995104996104997104998104999105000105001105002105003105004105005105006105007105008105009105010105011105012105013105014105015105016105017105018105019105020105021105022105023105024105025105026105027105028105029105030105031105032105033105034105035105036105037105038105039105040105041105042105043105044105045105046105047105048105049105050105051105052105053105054105055105056105057105058105059105060105061105062105063105064105065105066105067105068105069105070105071105072105073105074105075105076105077105078105079105080105081105082105083105084105085105086105087105088105089105090105091105092105093105094105095105096105097105098105099105100105101105102105103105104105105105106105107105108105109105110105111105112105113105114105115105116105117105118105119105120105121105122105123105124105125105126105127105128105129105130105131105132105133105134105135105136105137105138105139105140105141105142105143105144105145105146105147105148105149105150105151105152105153105154105155105156105157105158105159105160105161105162105163105164105165105166105167105168105169105170105171105172105173105174105175105176105177105178105179105180105181105182105183105184105185105186105187105188105189105190105191105192105193105194105195105196105197105198105199105200105201105202105203105204105205105206105207105208105209105210105211105212105213105214105215105216105217105218105219105220105221105222105223105224105225105226105227105228105229105230105231105232105233105234105235105236105237105238105239105240105241105242105243105244105245105246105247105248105249105250105251105252105253105254105255105256105257105258105259105260105261105262105263105264105265105266105267105268105269105270105271105272105273105274105275105276105277105278105279105280105281105282105283105284105285105286105287105288105289105290105291105292105293105294105295105296105297105298105299105300105301105302105303105304105305105306105307105308105309105310105311105312105313105314105315105316105317105318105319105320105321105322105323105324105325105326105327105328105329105330105331105332105333105334105335105336105337105338105339105340105341105342105343105344105345105346105347105348105349105350105351105352105353105354105355105356105357105358105359105360105361105362105363105364105365105366105367105368105369105370105371105372105373105374105375105376105377105378105379105380105381105382105383105384105385105386105387105388105389105390105391105392105393105394105395105396105397105398105399105400105401105402105403105404105405105406105407105408105409105410105411105412105413105414105415105416105417105418105419105420105421105422105423105424105425105426105427105428105429105430105431105432105433105434105435105436105437105438105439105440105441105442105443105444105445105446105447105448105449105450105451105452105453105454105455105456105457105458105459105460105461105462105463105464105465105466105467105468105469105470105471105472105473105474105475105476105477105478105479105480105481105482105483105484105485105486105487105488105489105490105491105492105493105494105495105496105497105498105499105500105501105502105503105504105505105506105507105508105509105510105511105512105513105514105515105516105517105518105519105520105521105522105523105524105525105526105527105528105529105530105531105532105533105534105535105536105537105538105539105540105541105542105543105544105545105546105547105548105549105550105551105552105553105554105555105556105557105558105559105560105561105562105563105564105565105566105567105568105569105570105571105572105573105574105575105576105577105578105579105580105581105582105583105584105585105586105587105588105589105590105591105592105593105594105595105596105597105598105599105600105601105602105603105604105605105606105607105608105609105610105611105612105613105614105615105616105617105618105619105620105621105622105623105624105625105626105627105628105629105630105631105632105633105634105635105636105637105638105639105640105641105642105643105644105645105646105647105648105649105650105651105652105653105654105655105656105657105658105659105660105661105662105663105664105665105666105667105668105669105670105671105672105673105674105675105676105677105678105679105680105681105682105683105684105685105686105687105688105689105690105691105692105693105694105695105696105697105698105699105700105701105702105703105704105705105706105707105708105709105710105711105712105713105714105715105716105717105718105719105720105721105722105723105724105725105726105727105728105729105730105731105732105733105734105735105736105737105738105739105740105741105742105743105744105745105746105747105748105749105750105751105752105753105754105755105756105757105758105759105760105761105762105763105764105765105766105767105768105769105770105771105772105773105774105775105776105777105778105779105780105781105782105783105784105785105786105787105788105789105790105791105792105793105794105795105796105797105798105799105800105801105802105803105804105805105806105807105808105809105810105811105812105813105814105815105816105817105818105819105820105821105822105823105824105825105826105827105828105829105830105831105832105833105834105835105836105837105838105839105840105841105842105843105844105845105846105847105848105849105850105851105852105853105854105855105856105857105858105859105860105861105862105863105864105865105866105867105868105869105870105871105872105873105874105875105876105877105878105879105880105881105882105883105884105885105886105887105888105889105890105891105892105893105894105895105896105897105898105899105900105901105902105903105904105905105906105907105908105909105910105911105912105913105914105915105916105917105918105919105920105921105922105923105924105925105926105927105928105929105930105931105932105933105934105935105936105937105938105939105940105941105942105943105944105945105946105947105948105949105950105951105952105953105954105955105956105957105958105959105960105961105962105963105964105965105966105967105968105969105970105971105972105973105974105975105976105977105978105979105980105981105982105983105984105985105986105987105988105989105990105991105992105993105994105995105996105997105998105999106000106001106002106003106004106005106006106007106008106009106010106011106012106013106014106015106016106017106018106019106020106021106022106023106024106025106026106027106028106029106030106031106032106033106034106035106036106037106038106039106040106041106042106043106044106045106046106047106048106049106050106051106052106053106054106055106056106057106058106059106060106061106062106063106064106065106066106067106068106069106070106071106072106073106074106075106076106077106078106079106080106081106082106083106084106085106086106087106088106089106090106091106092106093106094106095106096106097106098106099106100106101106102106103106104106105106106106107106108106109106110106111106112106113106114106115106116106117106118106119106120106121106122106123106124106125106126106127106128106129106130106131106132106133106134106135106136106137106138106139106140106141106142106143106144106145106146106147106148106149106150106151106152106153106154106155106156106157106158106159106160106161106162106163106164106165106166106167106168106169106170106171106172106173106174106175106176106177106178106179106180106181106182106183106184106185106186106187106188106189106190106191106192106193106194106195106196106197106198106199106200106201106202106203106204106205106206106207106208106209106210106211106212106213106214106215106216106217106218106219106220106221106222106223106224106225106226106227106228106229106230106231106232106233106234106235106236106237106238106239106240106241106242106243106244106245106246106247106248106249106250106251106252106253106254106255106256106257106258106259106260106261106262106263106264106265106266106267106268106269106270106271106272106273106274106275106276106277106278106279106280106281106282106283106284106285106286106287106288106289106290106291106292106293106294106295106296106297106298106299106300106301106302106303106304106305106306106307106308106309106310106311106312106313106314106315106316106317106318106319106320106321106322106323106324106325106326106327106328106329106330106331106332106333106334106335106336106337106338106339106340106341106342106343106344106345106346106347106348106349106350106351106352106353106354106355106356106357106358106359106360106361106362106363106364106365106366106367106368106369106370106371106372106373106374106375106376106377106378106379106380106381106382106383106384106385106386106387106388106389106390106391106392106393106394106395106396106397106398106399106400106401106402106403106404106405106406106407106408106409106410106411106412106413106414106415106416106417106418106419106420106421106422106423106424106425106426106427106428106429106430106431106432106433106434106435106436106437106438106439106440106441106442106443106444106445106446106447106448106449106450106451106452106453106454106455106456106457106458106459106460106461106462106463106464106465106466106467106468106469106470106471106472106473106474106475106476106477106478106479106480106481106482106483106484106485106486106487106488106489106490106491106492106493106494106495106496106497106498106499106500106501106502106503106504106505106506106507106508106509106510106511106512106513106514106515106516106517106518106519106520106521106522106523106524106525106526106527106528106529106530106531106532106533106534106535106536106537106538106539106540106541106542106543106544106545106546106547106548106549106550106551106552106553106554106555106556106557106558106559106560106561106562106563106564106565106566106567106568106569106570106571106572106573106574106575106576106577106578106579106580106581106582106583106584106585106586106587106588106589106590106591106592106593106594106595106596106597106598106599106600106601106602106603106604106605106606106607106608106609106610106611106612106613106614106615106616106617106618106619106620106621106622106623106624106625106626106627106628106629106630106631106632106633106634106635106636106637106638106639106640106641106642106643106644106645106646106647106648106649106650106651106652106653106654106655106656106657106658106659106660106661106662106663106664106665106666106667106668106669106670106671106672106673106674106675106676106677106678106679106680106681106682106683106684106685106686106687106688106689106690106691106692106693106694106695106696106697106698106699106700106701106702106703106704106705106706106707106708106709106710106711106712106713106714106715106716106717106718106719106720106721106722106723106724106725106726106727106728106729106730106731106732106733106734106735106736106737106738106739106740106741106742106743106744106745106746106747106748106749106750106751106752106753106754106755106756106757106758106759106760106761106762106763106764106765106766106767106768106769106770106771106772106773106774106775106776106777106778106779106780106781106782106783106784106785106786106787106788106789106790106791106792106793106794106795106796106797106798106799106800106801106802106803106804106805106806106807106808106809106810106811106812106813106814106815106816106817106818106819106820106821106822106823106824106825106826106827106828106829106830106831106832106833106834106835106836106837106838106839106840106841106842106843106844106845106846106847106848106849106850106851106852106853106854106855106856106857106858106859106860106861106862106863106864106865106866106867106868106869106870106871106872106873106874106875106876106877106878106879106880106881106882106883106884106885106886106887106888106889106890106891106892106893106894106895106896106897106898106899106900106901106902106903106904106905106906106907106908106909106910106911106912106913106914106915106916106917106918106919106920106921106922106923106924106925106926106927106928106929106930106931106932106933106934106935106936106937106938106939106940106941106942106943106944106945106946106947106948106949106950106951106952106953106954106955106956106957106958106959106960106961106962106963106964106965106966106967106968106969106970106971106972106973106974106975106976106977106978106979106980106981106982106983106984106985106986106987106988106989106990106991106992106993106994106995106996106997106998106999107000107001107002107003107004107005107006107007107008107009107010107011107012107013107014107015107016107017107018107019107020107021107022107023107024107025107026107027107028107029107030107031107032107033107034107035107036107037107038107039107040107041107042107043107044107045107046107047107048107049107050107051107052107053107054107055107056107057107058107059107060107061107062107063107064107065107066107067107068107069107070107071107072107073107074107075107076107077107078107079107080107081107082107083107084107085107086107087107088107089107090107091107092107093107094107095107096107097107098107099107100107101107102107103107104107105107106107107107108107109107110107111107112107113107114107115107116107117107118107119107120107121107122107123107124107125107126107127107128107129107130107131107132107133107134107135107136107137107138107139107140107141107142107143107144107145107146107147107148107149107150107151107152107153107154107155107156107157107158107159107160107161107162107163107164107165107166107167107168107169107170107171107172107173107174107175107176107177107178107179107180107181107182107183107184107185107186107187107188107189107190107191107192107193107194107195107196107197107198107199107200107201107202107203107204107205107206107207107208107209107210107211107212107213107214107215107216107217107218107219107220107221107222107223107224107225107226107227107228107229107230107231107232107233107234107235107236107237107238107239107240107241107242107243107244107245107246107247107248107249107250107251107252107253107254107255107256107257107258107259107260107261107262107263107264107265107266107267107268107269107270107271107272107273107274107275107276107277107278107279107280107281107282107283107284107285107286107287107288107289107290107291107292107293107294107295107296107297107298107299107300107301107302107303107304107305107306107307107308107309107310107311107312107313107314107315107316107317107318107319107320107321107322107323107324107325107326107327107328107329107330107331107332107333107334107335107336107337107338107339107340107341107342107343107344107345107346107347107348107349107350107351107352107353107354107355107356107357107358107359107360107361107362107363107364107365107366107367107368107369107370107371107372107373107374107375107376107377107378107379107380107381107382107383107384107385107386107387107388107389107390107391107392107393107394107395107396107397107398107399107400107401107402107403107404107405107406107407107408107409107410107411107412107413107414107415107416107417107418107419107420107421107422107423107424107425107426107427107428107429107430107431107432107433107434107435107436107437107438107439107440107441107442107443107444107445107446107447107448107449107450107451107452107453107454107455107456107457107458107459107460107461107462107463107464107465107466107467107468107469107470107471107472107473107474107475107476107477107478107479107480107481107482107483107484107485107486107487107488107489107490107491107492107493107494107495107496107497107498107499107500107501107502107503107504107505107506107507107508107509107510107511107512107513107514107515107516107517107518107519107520107521107522107523107524107525107526107527107528107529107530107531107532107533107534107535107536107537107538107539107540107541107542107543107544107545107546107547107548107549107550107551107552107553107554107555107556107557107558107559107560107561107562107563107564107565107566107567107568107569107570107571107572107573107574107575107576107577107578107579107580107581107582107583107584107585107586107587107588107589107590107591107592107593107594107595107596107597107598107599107600107601107602107603107604107605107606107607107608107609107610107611107612107613107614107615107616107617107618107619107620107621107622107623107624107625107626107627107628107629107630107631107632107633107634107635107636107637107638107639107640107641107642107643107644107645107646107647107648107649107650107651107652107653107654107655107656107657107658107659107660107661107662107663107664107665107666107667107668107669107670107671107672107673107674107675107676107677107678107679107680107681107682107683107684107685107686107687107688107689107690107691107692107693107694107695107696107697107698107699107700107701107702107703107704107705107706107707107708107709107710107711107712107713107714107715107716107717107718107719107720107721107722107723107724107725107726107727107728107729107730107731107732107733107734107735107736107737107738107739107740107741107742107743107744107745107746107747107748107749107750107751107752107753107754107755107756107757107758107759107760107761107762107763107764107765107766107767107768107769107770107771107772107773107774107775107776107777107778107779107780107781107782107783107784107785107786107787107788107789107790107791107792107793107794107795107796107797107798107799107800107801107802107803107804107805107806107807107808107809107810107811107812107813107814107815107816107817107818107819107820107821107822107823107824107825107826107827107828107829107830107831107832107833107834107835107836107837107838107839107840107841107842107843107844107845107846107847107848107849107850107851107852107853107854107855107856107857107858107859107860107861107862107863107864107865107866107867107868107869107870107871107872107873107874107875107876107877107878107879107880107881107882107883107884107885107886107887107888107889107890107891107892107893107894107895107896107897107898107899107900107901107902107903107904107905107906107907107908107909107910107911107912107913107914107915107916107917107918107919107920107921107922107923107924107925107926107927107928107929107930107931107932107933107934107935107936107937107938107939107940107941107942107943107944107945107946107947107948107949107950107951107952107953107954107955107956107957107958107959107960107961107962107963107964107965107966107967107968107969107970107971107972107973107974107975107976107977107978107979107980107981107982107983107984107985107986107987107988107989107990107991107992107993107994107995107996107997107998107999108000108001108002108003108004108005108006108007108008108009108010108011108012108013108014108015108016108017108018108019108020108021108022108023108024108025108026108027108028108029108030108031108032108033108034108035108036108037108038108039108040108041108042108043108044108045108046108047108048108049108050108051108052108053108054108055108056108057108058108059108060108061108062108063108064108065108066108067108068108069108070108071108072108073108074108075108076108077108078108079108080108081108082108083108084108085108086108087108088108089108090108091108092108093108094108095108096108097108098108099108100108101108102108103108104108105108106108107108108108109108110108111108112108113108114108115108116108117108118108119108120108121108122108123108124108125108126108127108128108129108130108131108132108133108134108135108136108137108138108139108140108141108142108143108144108145108146108147108148108149108150108151108152108153108154108155108156108157108158108159108160108161108162108163108164108165108166108167108168108169108170108171108172108173108174108175108176108177108178108179108180108181108182108183108184108185108186108187108188108189108190108191108192108193108194108195108196108197108198108199108200108201108202108203108204108205108206108207108208108209108210108211108212108213108214108215108216108217108218108219108220108221108222108223108224108225108226108227108228108229108230108231108232108233108234108235108236108237108238108239108240108241108242108243108244108245108246108247108248108249108250108251108252108253108254108255108256108257108258108259108260108261108262108263108264108265108266108267108268108269108270108271108272108273108274108275108276108277108278108279108280108281108282108283108284108285108286108287108288108289108290108291108292108293108294108295108296108297108298108299108300108301108302108303108304108305108306108307108308108309108310108311108312108313108314108315108316108317108318108319108320108321108322108323108324108325108326108327108328108329108330108331108332108333108334108335108336108337108338108339108340108341108342108343108344108345108346108347108348108349108350108351108352108353108354108355108356108357108358108359108360108361108362108363108364108365108366108367108368108369108370108371108372108373108374108375108376108377108378108379108380108381108382108383108384108385108386108387108388108389108390108391108392108393108394108395108396108397108398108399108400108401108402108403108404108405108406108407108408108409108410108411108412108413108414108415108416108417108418108419108420108421108422108423108424108425108426108427108428108429108430108431108432108433108434108435108436108437108438108439108440108441108442108443108444108445108446108447108448108449108450108451108452108453108454108455108456108457108458108459108460108461108462108463108464108465108466108467108468108469108470108471108472108473108474108475108476108477108478108479108480108481108482108483108484108485108486108487108488108489108490108491108492108493108494108495108496108497108498108499108500108501108502108503108504108505108506108507108508108509108510108511108512108513108514108515108516108517108518108519108520108521108522108523108524108525108526108527108528108529108530108531108532108533108534108535108536108537108538108539108540108541108542108543108544108545108546108547108548108549108550108551108552108553108554108555108556108557108558108559108560108561108562108563108564108565108566108567108568108569108570108571108572108573108574108575108576108577108578108579108580108581108582108583108584108585108586108587108588108589108590108591108592108593108594108595108596108597108598108599108600108601108602108603108604108605108606108607108608108609108610108611108612108613108614108615108616108617108618108619108620108621108622108623108624108625108626108627108628108629108630108631108632108633108634108635108636108637108638108639108640108641108642108643108644108645108646108647108648108649108650108651108652108653108654108655108656108657108658108659108660108661108662108663108664108665108666108667108668108669108670108671108672108673108674108675108676108677108678108679108680108681108682108683108684108685108686108687108688108689108690108691108692108693108694108695108696108697108698108699108700108701108702108703108704108705108706108707108708108709108710108711108712108713108714108715108716108717108718108719108720108721108722108723108724108725108726108727108728108729108730108731108732108733108734108735108736108737108738108739108740108741108742108743108744108745108746108747108748108749108750108751108752108753108754108755108756108757108758108759108760108761108762108763108764108765108766108767108768108769108770108771108772108773108774108775108776108777108778108779108780108781108782108783108784108785108786108787108788108789108790108791108792108793108794108795108796108797108798108799108800108801108802108803108804108805108806108807108808108809108810108811108812108813108814108815108816108817108818108819108820108821108822108823108824108825108826108827108828108829108830108831108832108833108834108835108836108837108838108839108840108841108842108843108844108845108846108847108848108849108850108851108852108853108854108855108856108857108858108859108860108861108862108863108864108865108866108867108868108869108870108871108872108873108874108875108876108877108878108879108880108881108882108883108884108885108886108887108888108889108890108891108892108893108894108895108896108897108898108899108900108901108902108903108904108905108906108907108908108909108910108911108912108913108914108915108916108917108918108919108920108921108922108923108924108925108926108927108928108929108930108931108932108933108934108935108936108937108938108939108940108941108942108943108944108945108946108947108948108949108950108951108952108953108954108955108956108957108958108959108960108961108962108963108964108965108966108967108968108969108970108971108972108973108974108975108976108977108978108979108980108981108982108983108984108985108986108987108988108989108990108991108992108993108994108995108996108997108998108999109000109001109002109003109004109005109006109007109008109009109010109011109012109013109014109015109016109017109018109019109020109021109022109023109024109025109026109027109028109029109030109031109032109033109034109035109036109037109038109039109040109041109042109043109044109045109046109047109048109049109050109051109052109053109054109055109056109057109058109059109060109061109062109063109064109065109066109067109068109069109070109071109072109073109074109075109076109077109078109079109080109081109082109083109084109085109086109087109088109089109090109091109092109093109094109095109096109097109098109099109100109101109102109103109104109105109106109107109108109109109110109111109112109113109114109115109116109117109118109119109120109121109122109123109124109125109126109127109128109129109130109131109132109133109134109135109136109137109138109139109140109141109142109143109144109145109146109147109148109149109150109151109152109153109154109155109156109157109158109159109160109161109162109163109164109165109166109167109168109169109170109171109172109173109174109175109176109177109178109179109180109181109182109183109184109185109186109187109188109189109190109191109192109193109194109195109196109197109198109199109200109201109202109203109204109205109206109207109208109209109210109211109212109213109214109215109216109217109218109219109220109221109222109223109224109225109226109227109228109229109230109231109232109233109234109235109236109237109238109239109240109241109242109243109244109245109246109247109248109249109250109251109252109253109254109255109256109257109258109259109260109261109262109263109264109265109266109267109268109269109270109271109272109273109274109275109276109277109278109279109280109281109282109283109284109285109286109287109288109289109290109291109292109293109294109295109296109297109298109299109300109301109302109303109304109305109306109307109308109309109310109311109312109313109314109315109316109317109318109319109320109321109322109323109324109325109326109327109328109329109330109331109332109333109334109335109336109337109338109339109340109341109342109343109344109345109346109347109348109349109350109351109352109353109354109355109356109357109358109359109360109361109362109363109364109365109366109367109368109369109370109371109372109373109374109375109376109377109378109379109380109381109382109383109384109385109386109387109388109389109390109391109392109393109394109395109396109397109398109399109400109401109402109403109404109405109406109407109408109409109410109411109412109413109414109415109416109417109418109419109420109421109422109423109424109425109426109427109428109429109430109431109432109433109434109435109436109437109438109439109440109441109442109443109444109445109446109447109448109449109450109451109452109453109454109455109456109457109458109459109460109461109462109463109464109465109466109467109468109469109470109471109472109473109474109475109476109477109478109479109480109481109482109483109484109485109486109487109488109489109490109491109492109493109494109495109496109497109498109499109500109501109502109503109504109505109506109507109508109509109510109511109512109513109514109515109516109517109518109519109520109521109522109523109524109525109526109527109528109529109530109531109532109533109534109535109536109537109538109539109540109541109542109543109544109545109546109547109548109549109550109551109552109553109554109555109556109557109558109559109560109561109562109563109564109565109566109567109568109569109570109571109572109573109574109575109576109577109578109579109580109581109582109583109584109585109586109587109588109589109590109591109592109593109594109595109596109597109598109599109600109601109602109603109604109605109606109607109608109609109610109611109612109613109614109615109616109617109618109619109620109621109622109623109624109625109626109627109628109629109630109631109632109633109634109635109636109637109638109639109640109641109642109643109644109645109646109647109648109649109650109651109652109653109654109655109656109657109658109659109660109661109662109663109664109665109666109667109668109669109670109671109672109673109674109675109676109677109678109679109680109681109682109683109684109685109686109687109688109689109690109691109692109693109694109695109696109697109698109699109700109701109702109703109704109705109706109707109708109709109710109711109712109713109714109715109716109717109718109719109720109721109722109723109724109725109726109727109728109729109730109731109732109733109734109735109736109737109738109739109740109741109742109743109744109745109746109747109748109749109750109751109752109753109754109755109756109757109758109759109760109761109762109763109764109765109766109767109768109769109770109771109772109773109774109775109776109777109778109779109780109781109782109783109784109785109786109787109788109789109790109791109792109793109794109795109796109797109798109799109800109801109802109803109804109805109806109807109808109809109810109811109812109813109814109815109816109817109818109819109820109821109822109823109824109825109826109827109828109829109830109831109832109833109834109835109836109837109838109839109840109841109842109843109844109845109846109847109848109849109850109851109852109853109854109855109856109857109858109859109860109861109862109863109864109865109866109867109868109869109870109871109872109873109874109875109876109877109878109879109880109881109882109883109884109885109886109887109888109889109890109891109892109893109894109895109896109897109898109899109900109901109902109903109904109905109906109907109908109909109910109911109912109913109914109915109916109917109918109919109920109921109922109923109924109925109926109927109928109929109930109931109932109933109934109935109936109937109938109939109940109941109942109943109944109945109946109947109948109949109950109951109952109953109954109955109956109957109958109959109960109961109962109963109964109965109966109967109968109969109970109971109972109973109974109975109976109977109978109979109980109981109982109983109984109985109986109987109988109989109990109991109992109993109994109995109996109997109998109999110000110001110002110003110004110005110006110007110008110009110010110011110012110013110014110015110016110017110018110019110020110021110022110023110024110025110026110027110028110029110030110031110032110033110034110035110036110037110038110039110040110041110042110043110044110045110046110047110048110049110050110051110052110053110054110055110056110057110058110059110060110061110062110063110064110065110066110067110068110069110070110071110072110073110074110075110076110077110078110079110080110081110082110083110084110085110086110087110088110089110090110091110092110093110094110095110096110097110098110099110100110101110102110103110104110105110106110107110108110109110110110111110112110113110114110115110116110117110118110119110120110121110122110123110124110125110126110127110128110129110130110131110132110133110134110135110136110137110138110139110140110141110142110143110144110145110146110147110148110149110150110151110152110153110154110155110156110157110158110159110160110161110162110163110164110165110166110167110168110169110170110171110172110173110174110175110176110177110178110179110180110181110182110183110184110185110186110187110188110189110190110191110192110193110194110195110196110197110198110199110200110201110202110203110204110205110206110207110208110209110210110211110212110213110214110215110216110217110218110219110220110221110222110223110224110225110226110227110228110229110230110231110232110233110234110235110236110237110238110239110240110241110242110243110244110245110246110247110248110249110250110251110252110253110254110255110256110257110258110259110260110261110262110263110264110265110266110267110268110269110270110271110272110273110274110275110276110277110278110279110280110281110282110283110284110285110286110287110288110289110290110291110292110293110294110295110296110297110298110299110300110301110302110303110304110305110306110307110308110309110310110311110312110313110314110315110316110317110318110319110320110321110322110323110324110325110326110327110328110329110330110331110332110333110334110335110336110337110338110339110340110341110342110343110344110345110346110347110348110349110350110351110352110353110354110355110356110357110358110359110360110361110362110363110364110365110366110367110368110369110370110371110372110373110374110375110376110377110378110379110380110381110382110383110384110385110386110387110388110389110390110391110392110393110394110395110396110397110398110399110400110401110402110403110404110405110406110407110408110409110410110411110412110413110414110415110416110417110418110419110420110421110422110423110424110425110426110427110428110429110430110431110432110433110434110435110436110437110438110439110440110441110442110443110444110445110446110447110448110449110450110451110452110453110454110455110456110457110458110459110460110461110462110463110464110465110466110467110468110469110470110471110472110473110474110475110476110477110478110479110480110481110482110483110484110485110486110487110488110489110490110491110492110493110494110495110496110497110498110499110500110501110502110503110504110505110506110507110508110509110510110511110512110513110514110515110516110517110518110519110520110521110522110523110524110525110526110527110528110529110530110531110532110533110534110535110536110537110538110539110540110541110542110543110544110545110546110547110548110549110550110551110552110553110554110555110556110557110558110559110560110561110562110563110564110565110566110567110568110569110570110571110572110573110574110575110576110577110578110579110580110581110582110583110584110585110586110587110588110589110590110591110592110593110594110595110596110597110598110599110600110601110602110603110604110605110606110607110608110609110610110611110612110613110614110615110616110617110618110619110620110621110622110623110624110625110626110627110628110629110630110631110632110633110634110635110636110637110638110639110640110641110642110643110644110645110646110647110648110649110650110651110652110653110654110655110656110657110658110659110660110661110662110663110664110665110666110667110668110669110670110671110672110673110674110675110676110677110678110679110680110681110682110683110684110685110686110687110688110689110690110691110692110693110694110695110696110697110698110699110700110701110702110703110704110705110706110707110708110709110710110711110712110713110714110715110716110717110718110719110720110721110722110723110724110725110726110727110728110729110730110731110732110733110734110735110736110737110738110739110740110741110742110743110744110745110746110747110748110749110750110751110752110753110754110755110756110757110758110759110760110761110762110763110764110765110766110767110768110769110770110771110772110773110774110775110776110777110778110779110780110781110782110783110784110785110786110787110788110789110790110791110792110793110794110795110796110797110798110799110800110801110802110803110804110805110806110807110808110809110810110811110812110813110814110815110816110817110818110819110820110821110822110823110824110825110826110827110828110829110830110831110832110833110834110835110836110837110838110839110840110841110842110843110844110845110846110847110848110849110850110851110852110853110854110855110856110857110858110859110860110861110862110863110864110865110866110867110868110869110870110871110872110873110874110875110876110877110878110879110880110881110882110883110884110885110886110887110888110889110890110891110892110893110894110895110896110897110898110899110900110901110902110903110904110905110906110907110908110909110910110911110912110913110914110915110916110917110918110919110920110921110922110923110924110925110926110927110928110929110930110931110932110933110934110935110936110937110938110939110940110941110942110943110944110945110946110947110948110949110950110951110952110953110954110955110956110957110958110959110960110961110962110963110964110965110966110967110968110969110970110971110972110973110974110975110976110977110978110979110980110981110982110983110984110985110986110987110988110989110990110991110992110993110994110995110996110997110998110999111000111001111002111003111004111005111006111007111008111009111010111011111012111013111014111015111016111017111018111019111020111021111022111023111024111025111026111027111028111029111030111031111032111033111034111035111036111037111038111039111040111041111042111043111044111045111046111047111048111049111050111051111052111053111054111055111056111057111058111059111060111061111062111063111064111065111066111067111068111069111070111071111072111073111074111075111076111077111078111079111080111081111082111083111084111085111086111087111088111089111090111091111092111093111094111095111096111097111098111099111100111101111102111103111104111105111106111107111108111109111110111111111112111113111114111115111116111117111118111119111120111121111122111123111124111125111126111127111128111129111130111131111132111133111134111135111136111137111138111139111140111141111142111143111144111145111146111147111148111149111150111151111152111153111154111155111156111157111158111159111160111161111162111163111164111165111166111167111168111169111170111171111172111173111174111175111176111177111178111179111180111181111182111183111184111185111186111187111188111189111190111191111192111193111194111195111196111197111198111199111200111201111202111203111204111205111206111207111208111209111210111211111212111213111214111215111216111217111218111219111220111221111222111223111224111225111226111227111228111229111230111231111232111233111234111235111236111237111238111239111240111241111242111243111244111245111246111247111248111249111250111251111252111253111254111255111256111257111258111259111260111261111262111263111264111265111266111267111268111269111270111271111272111273111274111275111276111277111278111279111280111281111282111283111284111285111286111287111288111289111290111291111292111293111294111295111296111297111298111299111300111301111302111303111304111305111306111307111308111309111310111311111312111313111314111315111316111317111318111319111320111321111322111323111324111325111326111327111328111329111330111331111332111333111334111335111336111337111338111339111340111341111342111343111344111345111346111347111348111349111350111351111352111353111354111355111356111357111358111359111360111361111362111363111364111365111366111367111368111369111370111371111372111373111374111375111376111377111378111379111380111381111382111383111384111385111386111387111388111389111390111391111392111393111394111395111396111397111398111399111400111401111402111403111404111405111406111407111408111409111410111411111412111413111414111415111416111417111418111419111420111421111422111423111424111425111426111427111428111429111430111431111432111433111434111435111436111437111438111439111440111441111442111443111444111445111446111447111448111449111450111451111452111453111454111455111456111457111458111459111460111461111462111463111464111465111466111467111468111469111470111471111472111473111474111475111476111477111478111479111480111481111482111483111484111485111486111487111488111489111490111491111492111493111494111495111496111497111498111499111500111501111502111503111504111505111506111507111508111509111510111511111512111513111514111515111516111517111518111519111520111521111522111523111524111525111526111527111528111529111530111531111532111533111534111535111536111537111538111539111540111541111542111543111544111545111546111547111548111549111550111551111552111553111554111555111556111557111558111559111560111561111562111563111564111565111566111567111568111569111570111571111572111573111574111575111576111577111578111579111580111581111582111583111584111585111586111587111588111589111590111591111592111593111594111595111596111597111598111599111600111601111602111603111604111605111606111607111608111609111610111611111612111613111614111615111616111617111618111619111620111621111622111623111624111625111626111627111628111629111630111631111632111633111634111635111636111637111638111639111640111641111642111643111644111645111646111647111648111649111650111651111652111653111654111655111656111657111658111659111660111661111662111663111664111665111666111667111668111669111670111671111672111673111674111675111676111677111678111679111680111681111682111683111684111685111686111687111688111689111690111691111692111693111694111695111696111697111698111699111700111701111702111703111704111705111706111707111708111709111710111711111712111713111714111715111716111717111718111719111720111721111722111723111724111725111726111727111728111729111730111731111732111733111734111735111736111737111738111739111740111741111742111743111744111745111746111747111748111749111750111751111752111753111754111755111756111757111758111759111760111761111762111763111764111765111766111767111768111769111770111771111772111773111774111775111776111777111778111779111780111781111782111783111784111785111786111787111788111789111790111791111792111793111794111795111796111797111798111799111800111801111802111803111804111805111806111807111808111809111810111811111812111813111814111815111816111817111818111819111820111821111822111823111824111825111826111827111828111829111830111831111832111833111834111835111836111837111838111839111840111841111842111843111844111845111846111847111848111849111850111851111852111853111854111855111856111857111858111859111860111861111862111863111864111865111866111867111868111869111870111871111872111873111874111875111876111877111878111879111880111881111882111883111884111885111886111887111888111889111890111891111892111893111894111895111896111897111898111899111900111901111902111903111904111905111906111907111908111909111910111911111912111913111914111915111916111917111918111919111920111921111922111923111924111925111926111927111928111929111930111931111932111933111934111935111936111937111938111939111940111941111942111943111944111945111946111947111948111949111950111951111952111953111954111955111956111957111958111959111960111961111962111963111964111965111966111967111968111969111970111971111972111973111974111975111976111977111978111979111980111981111982111983111984111985111986111987111988111989111990111991111992111993111994111995111996111997111998111999112000112001112002112003112004112005112006112007112008112009112010112011112012112013112014112015112016112017112018112019112020112021112022112023112024112025112026112027112028112029112030112031112032112033112034112035112036112037112038112039112040112041112042112043112044112045112046112047112048112049112050112051112052112053112054112055112056112057112058112059112060112061112062112063112064112065112066112067112068112069112070112071112072112073112074112075112076112077112078112079112080112081112082112083112084112085112086112087112088112089112090112091112092112093112094112095112096112097112098112099112100112101112102112103112104112105112106112107112108112109112110112111112112112113112114112115112116112117112118112119112120112121112122112123112124112125112126112127112128112129112130112131112132112133112134112135112136112137112138112139112140112141112142112143112144112145112146112147112148112149112150112151112152112153112154112155112156112157112158112159112160112161112162112163112164112165112166112167112168112169112170112171112172112173112174112175112176112177112178112179112180112181112182112183112184112185112186112187112188112189112190112191112192112193112194112195112196112197112198112199112200112201112202112203112204112205112206112207112208112209112210112211112212112213112214112215112216112217112218112219112220112221112222112223112224112225112226112227112228112229112230112231112232112233112234112235112236112237112238112239112240112241112242112243112244112245112246112247112248112249112250112251112252112253112254112255112256112257112258112259112260112261112262112263112264112265112266112267112268112269112270112271112272112273112274112275112276112277112278112279112280112281112282112283112284112285112286112287112288112289112290112291112292112293112294112295112296112297112298112299112300112301112302112303112304112305112306112307112308112309112310112311112312112313112314112315112316112317112318112319112320112321112322112323112324112325112326112327112328112329112330112331112332112333112334112335112336112337112338112339112340112341112342112343112344112345112346112347112348112349112350112351112352112353112354112355112356112357112358112359112360112361112362112363112364112365112366112367112368112369112370112371112372112373112374112375112376112377112378112379112380112381112382112383112384112385112386112387112388112389112390112391112392112393112394112395112396112397112398112399112400112401112402112403112404112405112406112407112408112409112410112411112412112413112414112415112416112417112418112419112420112421112422112423112424112425112426112427112428112429112430112431112432112433112434112435112436112437112438112439112440112441112442112443112444112445112446112447112448112449112450112451112452112453112454112455112456112457112458112459112460112461112462112463112464112465112466112467112468112469112470112471112472112473112474112475112476112477112478112479112480112481112482112483112484112485112486112487112488112489112490112491112492112493112494112495112496112497112498112499112500112501112502112503112504112505112506112507112508112509112510112511112512112513112514112515112516112517112518112519112520112521112522112523112524112525112526112527112528112529112530112531112532112533112534112535112536112537112538112539112540112541112542112543112544112545112546112547112548112549112550112551112552112553112554112555112556112557112558112559112560112561112562112563112564112565112566112567112568112569112570112571112572112573112574112575112576112577112578112579112580112581112582112583112584112585112586112587112588112589112590112591112592112593112594112595112596112597112598112599112600112601112602112603112604112605112606112607112608112609112610112611112612112613112614112615112616112617112618112619112620112621112622112623112624112625112626112627112628112629112630112631112632112633112634112635112636112637112638112639112640112641112642112643112644112645112646112647112648112649112650112651112652112653112654112655112656112657112658112659112660112661112662112663112664112665112666112667112668112669112670112671112672112673112674112675112676112677112678112679112680112681112682112683112684112685112686112687112688112689112690112691112692112693112694112695112696112697112698112699112700112701112702112703112704112705112706112707112708112709112710112711112712112713112714112715112716112717112718112719112720112721112722112723112724112725112726112727112728112729112730112731112732112733112734112735112736112737112738112739112740112741112742112743112744112745112746112747112748112749112750112751112752112753112754112755112756112757112758112759112760112761112762112763112764112765112766112767112768112769112770112771112772112773112774112775112776112777112778112779112780112781112782112783112784112785112786112787112788112789112790112791112792112793112794112795112796112797112798112799112800112801112802112803112804112805112806112807112808112809112810112811112812112813112814112815112816112817112818112819112820112821112822112823112824112825112826112827112828112829112830112831112832112833112834112835112836112837112838112839112840112841112842112843112844112845112846112847112848112849112850112851112852112853112854112855112856112857112858112859112860112861112862112863112864112865112866112867112868112869112870112871112872112873112874112875112876112877112878112879112880112881112882112883112884112885112886112887112888112889112890112891112892112893112894112895112896112897112898112899112900112901112902112903112904112905112906112907112908112909112910112911112912112913112914112915112916112917112918112919112920112921112922112923112924112925112926112927112928112929112930112931112932112933112934112935112936112937112938112939112940112941112942112943112944112945112946112947112948112949112950112951112952112953112954112955112956112957112958112959112960112961112962112963112964112965112966112967112968112969112970112971112972112973112974112975112976112977112978112979112980112981112982112983112984112985112986112987112988112989112990112991112992112993112994112995112996112997112998112999113000113001113002113003113004113005113006113007113008113009113010113011113012113013113014113015113016113017113018113019113020113021113022113023113024113025113026113027113028113029113030113031113032113033113034113035113036113037113038113039113040113041113042113043113044113045113046113047113048113049113050113051113052113053113054113055113056113057113058113059113060113061113062113063113064113065113066113067113068113069113070113071113072113073113074113075113076113077113078113079113080113081113082113083113084113085113086113087113088113089113090113091113092113093113094113095113096113097113098113099113100113101113102113103113104113105113106113107113108113109113110113111113112113113113114113115113116113117113118113119113120113121113122113123113124113125113126113127113128113129113130113131113132113133113134113135113136113137113138113139113140113141113142113143113144113145113146113147113148113149113150113151113152113153113154113155113156113157113158113159113160113161113162113163113164113165113166113167113168113169113170113171113172113173113174113175113176113177113178113179113180113181113182113183113184113185113186113187113188113189113190113191113192113193113194113195113196113197113198113199113200113201113202113203113204113205113206113207113208113209113210113211113212113213113214113215113216113217113218113219113220113221113222113223113224113225113226113227113228113229113230113231113232113233113234113235113236113237113238113239113240113241113242113243113244113245113246113247113248113249113250113251113252113253113254113255113256113257113258113259113260113261113262113263113264113265113266113267113268113269113270113271113272113273113274113275113276113277113278113279113280113281113282113283113284113285113286113287113288113289113290113291113292113293113294113295113296113297113298113299113300113301113302113303113304113305113306113307113308113309113310113311113312113313113314113315113316113317113318113319113320113321113322113323113324113325113326113327113328113329113330113331113332113333113334113335113336113337113338113339113340113341113342113343113344113345113346113347113348113349113350113351113352113353113354113355113356113357113358113359113360113361113362113363113364113365113366113367113368113369113370113371113372113373113374113375113376113377113378113379113380113381113382113383113384113385113386113387113388113389113390113391113392113393113394113395113396113397113398113399113400113401113402113403113404113405113406113407113408113409113410113411113412113413113414113415113416113417113418113419113420113421113422113423113424113425113426113427113428113429113430113431113432113433113434113435113436113437113438113439113440113441113442113443113444113445113446113447113448113449113450113451113452113453113454113455113456113457113458113459113460113461113462113463113464113465113466113467113468113469113470113471113472113473113474113475113476113477113478113479113480113481113482113483113484113485113486113487113488113489113490113491113492113493113494113495113496113497113498113499113500113501113502113503113504113505113506113507113508113509113510113511113512113513113514113515113516113517113518113519113520113521113522113523113524113525113526113527113528113529113530113531113532113533113534113535113536113537113538113539113540113541113542113543113544113545113546113547113548113549113550113551113552113553113554113555113556113557113558113559113560113561113562113563113564113565113566113567113568113569113570113571113572113573113574113575113576113577113578113579113580113581113582113583113584113585113586113587113588113589113590113591113592113593113594113595113596113597113598113599113600113601113602113603113604113605113606113607113608113609113610113611113612113613113614113615113616113617113618113619113620113621113622113623113624113625113626113627113628113629113630113631113632113633113634113635113636113637113638113639113640113641113642113643113644113645113646113647113648113649113650113651113652113653113654113655113656113657113658113659113660113661113662113663113664113665113666113667113668113669113670113671113672113673113674113675113676113677113678113679113680113681113682113683113684113685113686113687113688113689113690113691113692113693113694113695113696113697113698113699113700113701113702113703113704113705113706113707113708113709113710113711113712113713113714113715113716113717113718113719113720113721113722113723113724113725113726113727113728113729113730113731113732113733113734113735113736113737113738113739113740113741113742113743113744113745113746113747113748113749113750113751113752113753113754113755113756113757113758113759113760113761113762113763113764113765113766113767113768113769113770113771113772113773113774113775113776113777113778113779113780113781113782113783113784113785113786113787113788113789113790113791113792113793113794113795113796113797113798113799113800113801113802113803113804113805113806113807113808113809113810113811113812113813113814113815113816113817113818113819113820113821113822113823113824113825113826113827113828113829113830113831113832113833113834113835113836113837113838113839113840113841113842113843113844113845113846113847113848113849113850113851113852113853113854113855113856113857113858113859113860113861113862113863113864113865113866113867113868113869113870113871113872113873113874113875113876113877113878113879113880113881113882113883113884113885113886113887113888113889113890113891113892113893113894113895113896113897113898113899113900113901113902113903113904113905113906113907113908113909113910113911113912113913113914113915113916113917113918113919113920113921113922113923113924113925113926113927113928113929113930113931113932113933113934113935113936113937113938113939113940113941113942113943113944113945113946113947113948113949113950113951113952113953113954113955113956113957113958113959113960113961113962113963113964113965113966113967113968113969113970113971113972113973113974113975113976113977113978113979113980113981113982113983113984113985113986113987113988113989113990113991113992113993113994113995113996113997113998113999114000114001114002114003114004114005114006114007114008114009114010114011114012114013114014114015114016114017114018114019114020114021114022114023114024114025114026114027114028114029114030114031114032114033114034114035114036114037114038114039114040114041114042114043114044114045114046114047114048114049114050114051114052114053114054114055114056114057114058114059114060114061114062114063114064114065114066114067114068114069114070114071114072114073114074114075114076114077114078114079114080114081114082114083114084114085114086114087114088114089114090114091114092114093114094114095114096114097114098114099114100114101114102114103114104114105114106114107114108114109114110114111114112114113114114114115114116114117114118114119114120114121114122114123114124114125114126114127114128114129114130114131114132114133114134114135114136114137114138114139114140114141114142114143114144114145114146114147114148114149114150114151114152114153114154114155114156114157114158114159114160114161114162114163114164114165114166114167114168114169114170114171114172114173114174114175114176114177114178114179114180114181114182114183114184114185114186114187114188114189114190114191114192114193114194114195114196114197114198114199114200114201114202114203114204114205114206114207114208114209114210114211114212114213114214114215114216114217114218114219114220114221114222114223114224114225114226114227114228114229114230114231114232114233114234114235114236114237114238114239114240114241114242114243114244114245114246114247114248114249114250114251114252114253114254114255114256114257114258114259114260114261114262114263114264114265114266114267114268114269114270114271114272114273114274114275114276114277114278114279114280114281114282114283114284114285114286114287114288114289114290114291114292114293114294114295114296114297114298114299114300114301114302114303114304114305114306114307114308114309114310114311114312114313114314114315114316114317114318114319114320114321114322114323114324114325114326114327114328114329114330114331114332114333114334114335114336114337114338114339114340114341114342114343114344114345114346114347114348114349114350114351114352114353114354114355114356114357114358114359114360114361114362114363114364114365114366114367114368114369114370114371114372114373114374114375114376114377114378114379114380114381114382114383114384114385114386114387114388114389114390114391114392114393114394114395114396114397114398114399114400114401114402114403114404114405114406114407114408114409114410114411114412114413114414114415114416114417114418114419114420114421114422114423114424114425114426114427114428114429114430114431114432114433114434114435114436114437114438114439114440114441114442114443114444114445114446114447114448114449114450114451114452114453114454114455114456114457114458114459114460114461114462114463114464114465114466114467114468114469114470114471114472114473114474114475114476114477114478114479114480114481114482114483114484114485114486114487114488114489114490114491114492114493114494114495114496114497114498114499114500114501114502114503114504114505114506114507114508114509114510114511114512114513114514114515114516114517114518114519114520114521114522114523114524114525114526114527114528114529114530114531114532114533114534114535114536114537114538114539114540114541114542114543114544114545114546114547114548114549114550114551114552114553114554114555114556114557114558114559114560114561114562114563114564114565114566114567114568114569114570114571114572114573114574114575114576114577114578114579114580114581114582114583114584114585114586114587114588114589114590114591114592114593114594114595114596114597114598114599114600114601114602114603114604114605114606114607114608114609114610114611114612114613114614114615114616114617114618114619114620114621114622114623114624114625114626114627114628114629114630114631114632114633114634114635114636114637114638114639114640114641114642114643114644114645114646114647114648114649114650114651114652114653114654114655114656114657114658114659114660114661114662114663114664114665114666114667114668114669114670114671114672114673114674114675114676114677114678114679114680114681114682114683114684114685114686114687114688114689114690114691114692114693114694114695114696114697114698114699114700114701114702114703114704114705114706114707114708114709114710114711114712114713114714114715114716114717114718114719114720114721114722114723114724114725114726114727114728114729114730114731114732114733114734114735114736114737114738114739114740114741114742114743114744114745114746114747114748114749114750114751114752114753114754114755114756114757114758114759114760114761114762114763114764114765114766114767114768114769114770114771114772114773114774114775114776114777114778114779114780114781114782114783114784114785114786114787114788114789114790114791114792114793114794114795114796114797114798114799114800114801114802114803114804114805114806114807114808114809114810114811114812114813114814114815114816114817114818114819114820114821114822114823114824114825114826114827114828114829114830114831114832114833114834114835114836114837114838114839114840114841114842114843114844114845114846114847114848114849114850114851114852114853114854114855114856114857114858114859114860114861114862114863114864114865114866114867114868114869114870114871114872114873114874114875114876114877114878114879114880114881114882114883114884114885114886114887114888114889114890114891114892114893114894114895114896114897114898114899114900114901114902114903114904114905114906114907114908114909114910114911114912114913114914114915114916114917114918114919114920114921114922114923114924114925114926114927114928114929114930114931114932114933114934114935114936114937114938114939114940114941114942114943114944114945114946114947114948114949114950114951114952114953114954114955114956114957114958114959114960114961114962114963114964114965114966114967114968114969114970114971114972114973114974114975114976114977114978114979114980114981114982114983114984114985114986114987114988114989114990114991114992114993114994114995114996114997114998114999115000115001115002115003115004115005115006115007115008115009115010115011115012115013115014115015115016115017115018115019115020115021115022115023115024115025115026115027115028115029115030115031115032115033115034115035115036115037115038115039115040115041115042115043115044115045115046115047115048115049115050115051115052115053115054115055115056115057115058115059115060115061115062115063115064115065115066115067115068115069115070115071115072115073115074115075115076115077115078115079115080115081115082115083115084115085115086115087115088115089115090115091115092115093115094115095115096115097115098115099115100115101115102115103115104115105115106115107115108115109115110115111115112115113115114115115115116115117115118115119115120115121115122115123115124115125115126115127115128115129115130115131115132115133115134115135115136115137115138115139115140115141115142115143115144115145115146115147115148115149115150115151115152115153115154115155115156115157115158115159115160115161115162115163115164115165115166115167115168115169115170115171115172115173115174115175115176115177115178115179115180115181115182115183115184115185115186115187115188115189115190115191115192115193115194115195115196115197115198115199115200115201115202115203115204115205115206115207115208115209115210115211115212115213115214115215115216115217115218115219115220115221115222115223115224115225115226115227115228115229115230115231115232115233115234115235115236115237115238115239115240115241115242115243115244115245115246115247115248115249115250115251115252115253115254115255115256115257115258115259115260115261115262115263115264115265115266115267115268115269115270115271115272115273115274115275115276115277115278115279115280115281115282115283115284115285115286115287115288115289115290115291115292115293115294115295115296115297115298115299115300115301115302115303115304115305115306115307115308115309115310115311115312115313115314115315115316115317115318115319115320115321115322115323115324115325115326115327115328115329115330115331115332115333115334115335115336115337115338115339115340115341115342115343115344115345115346115347115348115349115350115351115352115353115354115355115356115357115358115359115360115361115362115363115364115365115366115367115368115369115370115371115372115373115374115375115376115377115378115379115380115381115382115383115384115385115386115387115388115389115390115391115392115393115394115395115396115397115398115399115400115401115402115403115404115405115406115407115408115409115410115411115412115413115414115415115416115417115418115419115420115421115422115423115424115425115426115427115428115429115430115431115432115433115434115435115436115437115438115439115440115441115442115443115444115445115446115447115448115449115450115451115452115453115454115455115456115457115458115459115460115461115462115463115464115465115466115467115468115469115470115471115472115473115474115475115476115477115478115479115480115481115482115483115484115485115486115487115488115489115490115491115492115493115494115495115496115497115498115499115500115501115502115503115504115505115506115507115508115509115510115511115512115513115514115515115516115517115518115519115520115521115522115523115524115525115526115527115528115529115530115531115532115533115534115535115536115537115538115539115540115541115542115543115544115545115546115547115548115549115550115551115552115553115554115555115556115557115558115559115560115561115562115563115564115565115566115567115568115569115570115571115572115573115574115575115576115577115578115579115580115581115582115583115584115585115586115587115588115589115590115591115592115593115594115595115596115597115598115599115600115601115602115603115604115605115606115607115608115609115610115611115612115613115614115615115616115617115618115619115620115621115622115623115624115625115626115627115628115629115630115631115632115633115634115635115636115637115638115639115640115641115642115643115644115645115646115647115648115649115650115651115652115653115654115655115656115657115658115659115660115661115662115663115664115665115666115667115668115669115670115671115672115673115674115675115676115677115678115679115680115681115682115683115684115685115686115687115688115689115690115691115692115693115694115695115696115697115698115699115700115701115702115703115704115705115706115707115708115709115710115711115712115713115714115715115716115717115718115719115720115721115722115723115724115725115726115727115728115729115730115731115732115733115734115735115736115737115738115739115740115741115742115743115744115745115746115747115748115749115750115751115752115753115754115755115756115757115758115759115760115761115762115763115764115765115766115767115768115769115770115771115772115773115774115775115776115777115778115779115780115781115782115783115784115785115786115787115788115789115790115791115792115793115794115795115796115797115798115799115800115801115802115803115804115805115806115807115808115809115810115811115812115813115814115815115816115817115818115819115820115821115822115823115824115825115826115827115828115829115830115831115832115833115834115835115836115837115838115839115840115841115842115843115844115845115846115847115848115849115850115851115852115853115854115855115856115857115858115859115860115861115862115863115864115865115866115867115868115869115870115871115872115873115874115875115876115877115878115879115880115881115882115883115884115885115886115887115888115889115890115891115892115893115894115895115896115897115898115899115900115901115902115903115904115905115906115907115908115909115910115911115912115913115914115915115916115917115918115919115920115921115922115923115924115925115926115927115928115929115930115931115932115933115934115935115936115937115938115939115940115941115942115943115944115945115946115947115948115949115950115951115952115953115954115955115956115957115958115959115960115961115962115963115964115965115966115967115968115969115970115971115972115973115974115975115976115977115978115979115980115981115982115983115984115985115986115987115988115989115990115991115992115993115994115995115996115997115998115999116000116001116002116003116004116005116006116007116008116009116010116011116012116013116014116015116016116017116018116019116020116021116022116023116024116025116026116027116028116029116030116031116032116033116034116035116036116037116038116039116040116041116042116043116044116045116046116047116048116049116050116051116052116053116054116055116056116057116058116059116060116061116062116063116064116065116066116067116068116069116070116071116072116073116074116075116076116077116078116079116080116081116082116083116084116085116086116087116088116089116090116091116092116093116094116095116096116097116098116099116100116101116102116103116104116105116106116107116108116109116110116111116112116113116114116115116116116117116118116119116120116121116122116123116124116125116126116127116128116129116130116131116132116133116134116135116136116137116138116139116140116141116142116143116144116145116146116147116148116149116150116151116152116153116154116155116156116157116158116159116160116161116162116163116164116165116166116167116168116169116170116171116172116173116174116175116176116177116178116179116180116181116182116183116184116185116186116187116188116189116190116191116192116193116194116195116196116197116198116199116200116201116202116203116204116205116206116207116208116209116210116211116212116213116214116215116216116217116218116219116220116221116222116223116224116225116226116227116228116229116230116231116232116233116234116235116236116237116238116239116240116241116242116243116244116245116246116247116248116249116250116251116252116253116254116255116256116257116258116259116260116261116262116263116264116265116266116267116268116269116270116271116272116273116274116275116276116277116278116279116280116281116282116283116284116285116286116287116288116289116290116291116292116293116294116295116296116297116298116299116300116301116302116303116304116305116306116307116308116309116310116311116312116313116314116315116316116317116318116319116320116321116322116323116324116325116326116327116328116329116330116331116332116333116334116335116336116337116338116339116340116341116342116343116344116345116346116347116348116349116350116351116352116353116354116355116356116357116358116359116360116361116362116363116364116365116366116367116368116369116370116371116372116373116374116375116376116377116378116379116380116381116382116383116384116385116386116387116388116389116390116391116392116393116394116395116396116397116398116399116400116401116402116403116404116405116406116407116408116409116410116411116412116413116414116415116416116417116418116419116420116421116422116423116424116425116426116427116428116429116430116431116432116433116434116435116436116437116438116439116440116441116442116443116444116445116446116447116448116449116450116451116452116453116454116455116456116457116458116459116460116461116462116463116464116465116466116467116468116469116470116471116472116473116474116475116476116477116478116479116480116481116482116483116484116485116486116487116488116489116490116491116492116493116494116495116496116497116498116499116500116501116502116503116504116505116506116507116508116509116510116511116512116513116514116515116516116517116518116519116520116521116522116523116524116525116526116527116528116529116530116531116532116533116534116535116536116537116538116539116540116541116542116543116544116545116546116547116548116549116550116551116552116553116554116555116556116557116558116559116560116561116562116563116564116565116566116567116568116569116570116571116572116573116574116575116576116577116578116579116580116581116582116583116584116585116586116587116588116589116590116591116592116593116594116595116596116597116598116599116600116601116602116603116604116605116606116607116608116609116610116611116612116613116614116615116616116617116618116619116620116621116622116623116624116625116626116627116628116629116630116631116632116633116634116635116636116637116638116639116640116641116642116643116644116645116646116647116648116649116650116651116652116653116654116655116656116657116658116659116660116661116662116663116664116665116666116667116668116669116670116671116672116673116674116675116676116677116678116679116680116681116682116683116684116685116686116687116688116689116690116691116692116693116694116695116696116697116698116699116700116701116702116703116704116705116706116707116708116709116710116711116712116713116714116715116716116717116718116719116720116721116722116723116724116725116726116727116728116729116730116731116732116733116734116735116736116737116738116739116740116741116742116743116744116745116746116747116748116749116750116751116752116753116754116755116756116757116758116759116760116761116762116763116764116765116766116767116768116769116770116771116772116773116774116775116776116777116778116779116780116781116782116783116784116785116786116787116788116789116790116791116792116793116794116795116796116797116798116799116800116801116802116803116804116805116806116807116808116809116810116811116812116813116814116815116816116817116818116819116820116821116822116823116824116825116826116827116828116829116830116831116832116833116834116835116836116837116838116839116840116841116842116843116844116845116846116847116848116849116850116851116852116853116854116855116856116857116858116859116860116861116862116863116864116865116866116867116868116869116870116871116872116873116874116875116876116877116878116879116880116881116882116883116884116885116886116887116888116889116890116891116892116893116894116895116896116897116898116899116900116901116902116903116904116905116906116907116908116909116910116911116912116913116914116915116916116917116918116919116920116921116922116923116924116925116926116927116928116929116930116931116932116933116934116935116936116937116938116939116940116941116942116943116944116945116946116947116948116949116950116951116952116953116954116955116956116957116958116959116960116961116962116963116964116965116966116967116968116969116970116971116972116973116974116975116976116977116978116979116980116981116982116983116984116985116986116987116988116989116990116991116992116993116994116995116996116997116998116999117000117001117002117003117004117005117006117007117008117009117010117011117012117013117014117015117016117017117018117019117020117021117022117023117024117025117026117027117028117029117030117031117032117033117034117035117036117037117038117039117040117041117042117043117044117045117046117047117048117049117050117051117052117053117054117055117056117057117058117059117060117061117062117063117064117065117066117067117068117069117070117071117072117073117074117075117076117077117078117079117080117081117082117083117084117085117086117087117088117089117090117091117092117093117094117095117096117097117098117099117100117101117102117103117104117105117106117107117108117109117110117111117112117113117114117115117116117117117118117119117120117121117122117123117124117125117126117127117128117129117130117131117132117133117134117135117136117137117138117139117140117141117142117143117144117145117146117147117148117149117150117151117152117153117154117155117156117157117158117159117160117161117162117163117164117165117166117167117168117169117170117171117172117173117174117175117176117177117178117179117180117181117182117183117184117185117186117187117188117189117190117191117192117193117194117195117196117197117198117199117200117201117202117203117204117205117206117207117208117209117210117211117212117213117214117215117216117217117218117219117220117221117222117223117224117225117226117227117228117229117230117231117232117233117234117235117236117237117238117239117240117241117242117243117244117245117246117247117248117249117250117251117252117253117254117255117256117257117258117259117260117261117262117263117264117265117266117267117268117269117270117271117272117273117274117275117276117277117278117279117280117281117282117283117284117285117286117287117288117289117290117291117292117293117294117295117296117297117298117299117300117301117302117303117304117305117306117307117308117309117310117311117312117313117314117315117316117317117318117319117320117321117322117323117324117325117326117327117328117329117330117331117332117333117334117335117336117337117338117339117340117341117342117343117344117345117346117347117348117349117350117351117352117353117354117355117356117357117358117359117360117361117362117363117364117365117366117367117368117369117370117371117372117373117374117375117376117377117378117379117380117381117382117383117384117385117386117387117388117389117390117391117392117393117394117395117396117397117398117399117400117401117402117403117404117405117406117407117408117409117410117411117412117413117414117415117416117417117418117419117420117421117422117423117424117425117426117427117428117429117430117431117432117433117434117435117436117437117438117439117440117441117442117443117444117445117446117447117448117449117450117451117452117453117454117455117456117457117458117459117460117461117462117463117464117465117466117467117468117469117470117471117472117473117474117475117476117477117478117479117480117481117482117483117484117485117486117487117488117489117490117491117492117493117494117495117496117497117498117499117500117501117502117503117504117505117506117507117508117509117510117511117512117513117514117515117516117517117518117519117520117521117522117523117524117525117526117527117528117529117530117531117532117533117534117535117536117537117538117539117540117541117542117543117544117545117546117547117548117549117550117551117552117553117554117555117556117557117558117559117560117561117562117563117564117565117566117567117568117569117570117571117572117573117574117575117576117577117578117579117580117581117582117583117584117585117586117587117588117589117590117591117592117593117594117595117596117597117598117599117600117601117602117603117604117605117606117607117608117609117610117611117612117613117614117615117616117617117618117619117620117621117622117623117624117625117626117627117628117629117630117631117632117633117634117635117636117637117638117639117640117641117642117643117644117645117646117647117648117649117650117651117652117653117654117655117656117657117658117659117660117661117662117663117664117665117666117667117668117669117670117671117672117673117674117675117676117677117678117679117680117681117682117683117684117685117686117687117688117689117690117691117692117693117694117695117696117697117698117699117700117701117702117703117704117705117706117707117708117709117710117711117712117713117714117715117716117717117718117719117720117721117722117723117724117725117726117727117728117729117730117731117732117733117734117735117736117737117738117739117740117741117742117743117744117745117746117747117748117749117750117751117752117753117754117755117756117757117758117759117760117761117762117763117764117765117766117767117768117769117770117771117772117773117774117775117776117777117778117779117780117781117782117783117784117785117786117787117788117789117790117791117792117793117794117795117796117797117798117799117800117801117802117803117804117805117806117807117808117809117810117811117812117813117814117815117816117817117818117819117820117821117822117823117824117825117826117827117828117829117830117831117832117833117834117835117836117837117838117839117840117841117842117843117844117845117846117847117848117849117850117851117852117853117854117855117856117857117858117859117860117861117862117863117864117865117866117867117868117869117870117871117872117873117874117875117876117877117878117879117880117881117882117883117884117885117886117887117888117889117890117891117892117893117894117895117896117897117898117899117900117901117902117903117904117905117906117907117908117909117910117911117912117913117914117915117916117917117918117919117920117921117922117923117924117925117926117927117928117929117930117931117932117933117934117935117936117937117938117939117940117941117942117943117944117945117946117947117948117949117950117951117952117953117954117955117956117957117958117959117960117961117962117963117964117965117966117967117968117969117970117971117972117973117974117975117976117977117978117979117980117981117982117983117984117985117986117987117988117989117990117991117992117993117994117995117996117997117998117999118000118001118002118003118004118005118006118007118008118009118010118011118012118013118014118015118016118017118018118019118020118021118022118023118024118025118026118027118028118029118030118031118032118033118034118035118036118037118038118039118040118041118042118043118044118045118046118047118048118049118050118051118052118053118054118055118056118057118058118059118060118061118062118063118064118065118066118067118068118069118070118071118072118073118074118075118076118077118078118079118080118081118082118083118084118085118086118087118088118089118090118091118092118093118094118095118096118097118098118099118100118101118102118103118104118105118106118107118108118109118110118111118112118113118114118115118116118117118118118119118120118121118122118123118124118125118126118127118128118129118130118131118132118133118134118135118136118137118138118139118140118141118142118143118144118145118146118147118148118149118150118151118152118153118154118155118156118157118158118159118160118161118162118163118164118165118166118167118168118169118170118171118172118173118174118175118176118177118178118179118180118181118182118183118184118185118186118187118188118189118190118191118192118193118194118195118196118197118198118199118200118201118202118203118204118205118206118207118208118209118210118211118212118213118214118215118216118217118218118219118220118221118222118223118224118225118226118227118228118229118230118231118232118233118234118235118236118237118238118239118240118241118242118243118244118245118246118247118248118249118250118251118252118253118254118255118256118257118258118259118260118261118262118263118264118265118266118267118268118269118270118271118272118273118274118275118276118277118278118279118280118281118282118283118284118285118286118287118288118289118290118291118292118293118294118295118296118297118298118299118300118301118302118303118304118305118306118307118308118309118310118311118312118313118314118315118316118317118318118319118320118321118322118323118324118325118326118327118328118329118330118331118332118333118334118335118336118337118338118339118340118341118342118343118344118345118346118347118348118349118350118351118352118353118354118355118356118357118358118359118360118361118362118363118364118365118366118367118368118369118370118371118372118373118374118375118376118377118378118379118380118381118382118383118384118385118386118387118388118389118390118391118392118393118394118395118396118397118398118399118400118401118402118403118404118405118406118407118408118409118410118411118412118413118414118415118416118417118418118419118420118421118422118423118424118425118426118427118428118429118430118431118432118433118434118435118436118437118438118439118440118441118442118443118444118445118446118447118448118449118450118451118452118453118454118455118456118457118458118459118460118461118462118463118464118465118466118467118468118469118470118471118472118473118474118475118476118477118478118479118480118481118482118483118484118485118486118487118488118489118490118491118492118493118494118495118496118497118498118499118500118501118502118503118504118505118506118507118508118509118510118511118512118513118514118515118516118517118518118519118520118521118522118523118524118525118526118527118528118529118530118531118532118533118534118535118536118537118538118539118540118541118542118543118544118545118546118547118548118549118550118551118552118553118554118555118556118557118558118559118560118561118562118563118564118565118566118567118568118569118570118571118572118573118574118575118576118577118578118579118580118581118582118583118584118585118586118587118588118589118590118591118592118593118594118595118596118597118598118599118600118601118602118603118604118605118606118607118608118609118610118611118612118613118614118615118616118617118618118619118620118621118622118623118624118625118626118627118628118629118630118631118632118633118634118635118636118637118638118639118640118641118642118643118644118645118646118647118648118649118650118651118652118653118654118655118656118657118658118659118660118661118662118663118664118665118666118667118668118669118670118671118672118673118674118675118676118677118678118679118680118681118682118683118684118685118686118687118688118689118690118691118692118693118694118695118696118697118698118699118700118701118702118703118704118705118706118707118708118709118710118711118712118713118714118715118716118717118718118719118720118721118722118723118724118725118726118727118728118729118730118731118732118733118734118735118736118737118738118739118740118741118742118743118744118745118746118747118748118749118750118751118752118753118754118755118756118757118758118759118760118761118762118763118764118765118766118767118768118769118770118771118772118773118774118775118776118777118778118779118780118781118782118783118784118785118786118787118788118789118790118791118792118793118794118795118796118797118798118799118800118801118802118803118804118805118806118807118808118809118810118811118812118813118814118815118816118817118818118819118820118821118822118823118824118825118826118827118828118829118830118831118832118833118834118835118836118837118838118839118840118841118842118843118844118845118846118847118848118849118850118851118852118853118854118855118856118857118858118859118860118861118862118863118864118865118866118867118868118869118870118871118872118873118874118875118876118877118878118879118880118881118882118883118884118885118886118887118888118889118890118891118892118893118894118895118896118897118898118899118900118901118902118903118904118905118906118907118908118909118910118911118912118913118914118915118916118917118918118919118920118921118922118923118924118925118926118927118928118929118930118931118932118933118934118935118936118937118938118939118940118941118942118943118944118945118946118947118948118949118950118951118952118953118954118955118956118957118958118959118960118961118962118963118964118965118966118967118968118969118970118971118972118973118974118975118976118977118978118979118980118981118982118983118984118985118986118987118988118989118990118991118992118993118994118995118996118997118998118999119000119001119002119003119004119005119006119007119008119009119010119011119012119013119014119015119016119017119018119019119020119021119022119023119024119025119026119027119028119029119030119031119032119033119034119035119036119037119038119039119040119041119042119043119044119045119046119047119048119049119050119051119052119053119054119055119056119057119058119059119060119061119062119063119064119065119066119067119068119069119070119071119072119073119074119075119076119077119078119079119080119081119082119083119084119085119086119087119088119089119090119091119092119093119094119095119096119097119098119099119100119101119102119103119104119105119106119107119108119109119110119111119112119113119114119115119116119117119118119119119120119121119122119123119124119125119126119127119128119129119130119131119132119133119134119135119136119137119138119139119140119141119142119143119144119145119146119147119148119149119150119151119152119153119154119155119156119157119158119159119160119161119162119163119164119165119166119167119168119169119170119171119172119173119174119175119176119177119178119179119180119181119182119183119184119185119186119187119188119189119190119191119192119193119194119195119196119197119198119199119200119201119202119203119204119205119206119207119208119209119210119211119212119213119214119215119216119217119218119219119220119221119222119223119224119225119226119227119228119229119230119231119232119233119234119235119236119237119238119239119240119241119242119243119244119245119246119247119248119249119250119251119252119253119254119255119256119257119258119259119260119261119262119263119264119265119266119267119268119269119270119271119272119273119274119275119276119277119278119279119280119281119282119283119284119285119286119287119288119289119290119291119292119293119294119295119296119297119298119299119300119301119302119303119304119305119306119307119308119309119310119311119312119313119314119315119316119317119318119319119320119321119322119323119324119325119326119327119328119329119330119331119332119333119334119335119336119337119338119339119340119341119342119343119344119345119346119347119348119349119350119351119352119353119354119355119356119357119358119359119360119361119362119363119364119365119366119367119368119369119370119371119372119373119374119375119376119377119378119379119380119381119382119383119384119385119386119387119388119389119390119391119392119393119394119395119396119397119398119399119400119401119402119403119404119405119406119407119408119409119410119411119412119413119414119415119416119417119418119419119420119421119422119423119424119425119426119427119428119429119430119431119432119433119434119435119436119437119438119439119440119441119442119443119444119445119446119447119448119449119450119451119452119453119454119455119456119457119458119459119460119461119462119463119464119465119466119467119468119469119470119471119472119473119474119475119476119477119478119479119480119481119482119483119484119485119486119487119488119489119490119491119492119493119494119495119496119497119498119499119500119501119502119503119504119505119506119507119508119509119510119511119512119513119514119515119516119517119518119519119520119521119522119523119524119525119526119527119528119529119530119531119532119533119534119535119536119537119538119539119540119541119542119543119544119545119546119547119548119549119550119551119552119553119554119555119556119557119558119559119560119561119562119563119564119565119566119567119568119569119570119571119572119573119574119575119576119577119578119579119580119581119582119583119584119585119586119587119588119589119590119591119592119593119594119595119596119597119598119599119600119601119602119603119604119605119606119607119608119609119610119611119612119613119614119615119616119617119618119619119620119621119622119623119624119625119626119627119628119629119630119631119632119633119634119635119636119637119638119639119640119641119642119643119644119645119646119647119648119649119650119651119652119653119654119655119656119657119658119659119660119661119662119663119664119665119666119667119668119669119670119671119672119673119674119675119676119677119678119679119680119681119682119683119684119685119686119687119688119689119690119691119692119693119694119695119696119697119698119699119700119701119702119703119704119705119706119707119708119709119710119711119712119713119714119715119716119717119718119719119720119721119722119723119724119725119726119727119728119729119730119731119732119733119734119735119736119737119738119739119740119741119742119743119744119745119746119747119748119749119750119751119752119753119754119755119756119757119758119759119760119761119762119763119764119765119766119767119768119769119770119771119772119773119774119775119776119777119778119779119780119781119782119783119784119785119786119787119788119789119790119791119792119793119794119795119796119797119798119799119800119801119802119803119804119805119806119807119808119809119810119811119812119813119814119815119816119817119818119819119820119821119822119823119824119825119826119827119828119829119830119831119832119833119834119835119836119837119838119839119840119841119842119843119844119845119846119847119848119849119850119851119852119853119854119855119856119857119858119859119860119861119862119863119864119865119866119867119868119869119870119871119872119873119874119875119876119877119878119879119880119881119882119883119884119885119886119887119888119889119890119891119892119893119894119895119896119897119898119899119900119901119902119903119904119905119906119907119908119909119910119911119912119913119914119915119916119917119918119919119920119921119922119923119924119925119926119927119928119929119930119931119932119933119934119935119936119937119938119939119940119941119942119943119944119945119946119947119948119949119950119951119952119953119954119955119956119957119958119959119960119961119962119963119964119965119966119967119968119969119970119971119972119973119974119975119976119977119978119979119980119981119982119983119984119985119986119987119988119989119990119991119992119993119994119995119996119997119998119999120000120001120002120003120004120005120006120007120008120009120010120011120012120013120014120015120016120017120018120019120020120021120022120023120024120025120026120027120028120029120030120031120032120033120034120035120036120037120038120039120040120041120042120043120044120045120046120047120048120049120050120051120052120053120054120055120056120057120058120059120060120061120062120063120064120065120066120067120068120069120070120071120072120073120074120075120076120077120078120079120080120081120082120083120084120085120086120087120088120089120090120091120092120093120094120095120096120097120098120099120100120101120102120103120104120105120106120107120108120109120110120111120112120113120114120115120116120117120118120119120120120121120122120123120124120125120126120127120128120129120130120131120132120133120134120135120136120137120138120139120140120141120142120143120144120145120146120147120148120149120150120151120152120153120154120155120156120157120158120159120160120161120162120163120164120165120166120167120168120169120170120171120172120173120174120175120176120177120178120179120180120181120182120183120184120185120186120187120188120189120190120191120192120193120194120195120196120197120198120199120200120201120202120203120204120205120206120207120208120209120210120211120212120213120214120215120216120217120218120219120220120221120222120223120224120225120226120227120228120229120230120231120232120233120234120235120236120237120238120239120240120241120242120243120244120245120246120247120248120249120250120251120252120253120254120255120256120257120258120259120260120261120262120263120264120265120266120267120268120269120270120271120272120273120274120275120276120277120278120279120280120281120282120283120284120285120286120287120288120289120290120291120292120293120294120295120296120297120298120299120300120301120302120303120304120305120306120307120308120309120310120311120312120313120314120315120316120317120318120319120320120321120322120323120324120325120326120327120328120329120330120331120332120333120334120335120336120337120338120339120340120341120342120343120344120345120346120347120348120349120350120351120352120353120354120355120356120357120358120359120360120361120362120363120364120365120366120367120368120369120370120371120372120373120374120375120376120377120378120379120380120381120382120383120384120385120386120387120388120389120390120391120392120393120394120395120396120397120398120399120400120401120402120403120404120405120406120407120408120409120410120411120412120413120414120415120416120417120418120419120420120421120422120423120424120425120426120427120428120429120430120431120432120433120434120435120436120437120438120439120440120441120442120443120444120445120446120447120448120449120450120451120452120453120454120455120456120457120458120459120460120461120462120463120464120465120466120467120468120469120470120471120472120473120474120475120476120477120478120479120480120481120482120483120484120485120486120487120488120489120490120491120492120493120494120495120496120497120498120499120500120501120502120503120504120505120506120507120508120509120510120511120512120513120514120515120516120517120518120519120520120521120522120523120524120525120526120527120528120529120530120531120532120533120534120535120536120537120538120539120540120541120542120543120544120545120546120547120548120549120550120551120552120553120554120555120556120557120558120559120560120561120562120563120564120565120566120567120568120569120570120571120572120573120574120575120576120577120578120579120580120581120582120583120584120585120586120587120588120589120590120591120592120593120594120595120596120597120598120599120600120601120602120603120604120605120606120607120608120609120610120611120612120613120614120615120616120617120618120619120620120621120622120623120624120625120626120627120628120629120630120631120632120633120634120635120636120637120638120639120640120641120642120643120644120645120646120647120648120649120650120651120652120653120654120655120656120657120658120659120660120661120662120663120664120665120666120667120668120669120670120671120672120673120674120675120676120677120678120679120680120681120682120683120684120685120686120687120688120689120690120691120692120693120694120695120696120697120698120699120700120701120702120703120704120705120706120707120708120709120710120711120712120713120714120715120716120717120718120719120720120721120722120723120724120725120726120727120728120729120730120731120732120733120734120735120736120737120738120739120740120741120742120743120744120745120746120747120748120749120750120751120752120753120754120755120756120757120758120759120760120761120762120763120764120765120766120767120768120769120770120771120772120773120774120775120776120777120778120779120780120781120782120783120784120785120786120787120788120789120790120791120792120793120794120795120796120797120798120799120800120801120802120803120804120805120806120807120808120809120810120811120812120813120814120815120816120817120818120819120820120821120822120823120824120825120826120827120828120829120830120831120832120833120834120835120836120837120838120839120840120841120842120843120844120845120846120847120848120849120850120851120852120853120854120855120856120857120858120859120860120861120862120863120864120865120866120867120868120869120870120871120872120873120874120875120876120877120878120879120880120881120882120883120884120885120886120887120888120889120890120891120892120893120894120895120896120897120898120899120900120901120902120903120904120905120906120907120908120909120910120911120912120913120914120915120916120917120918120919120920120921120922120923120924120925120926120927120928120929120930120931120932120933120934120935120936120937120938120939120940120941120942120943120944120945120946120947120948120949120950120951120952120953120954120955120956120957120958120959120960120961120962120963120964120965120966120967120968120969120970120971120972120973120974120975120976120977120978120979120980120981120982120983120984120985120986120987120988120989120990120991120992120993120994120995120996120997120998120999121000121001121002121003121004121005121006121007121008121009121010121011121012121013121014121015121016121017121018121019121020121021121022121023121024121025121026121027121028121029121030121031121032121033121034121035121036121037121038121039121040121041121042121043121044121045121046121047121048121049121050121051121052121053121054121055121056121057121058121059121060121061121062121063121064121065121066121067121068121069121070121071121072121073121074121075121076121077121078121079121080121081121082121083121084121085121086121087121088121089121090121091121092121093121094121095121096121097121098121099121100121101121102121103121104121105121106121107121108121109121110121111121112121113121114121115121116121117121118121119121120121121121122121123121124121125121126121127121128121129121130121131121132121133121134121135121136121137121138121139121140121141121142121143121144121145121146121147121148121149121150121151121152121153121154121155121156121157121158121159121160121161121162121163121164121165121166121167121168121169121170121171121172121173121174121175121176121177121178121179121180121181121182121183121184121185121186121187121188121189121190121191121192121193121194121195121196121197121198121199121200121201121202121203121204121205121206121207121208121209121210121211121212121213121214121215121216121217121218121219121220121221121222121223121224121225121226121227121228121229121230121231121232121233121234121235121236121237121238121239121240121241121242121243121244121245121246121247121248121249121250121251121252121253121254121255121256121257121258121259121260121261121262121263121264121265121266121267121268121269121270121271121272121273121274121275121276121277121278121279121280121281121282121283121284121285121286121287121288121289121290121291121292121293121294121295121296121297121298121299121300121301121302121303121304121305121306121307121308121309121310121311121312121313121314121315121316121317121318121319121320121321121322121323121324121325121326121327121328121329121330121331121332121333121334121335121336121337121338121339121340121341121342121343121344121345121346121347121348121349121350121351121352121353121354121355121356121357121358121359121360121361121362121363121364121365121366121367121368121369121370121371121372121373121374121375121376121377121378121379121380121381121382121383121384121385121386121387121388121389121390121391121392121393121394121395121396121397121398121399121400121401121402121403121404121405121406121407121408121409121410121411121412121413121414121415121416121417121418121419121420121421121422121423121424121425121426121427121428121429121430121431121432121433121434121435121436121437121438121439121440121441121442121443121444121445121446121447121448121449121450121451121452121453121454121455121456121457121458121459121460121461121462121463121464121465121466121467121468121469121470121471121472121473121474121475121476121477121478121479121480121481121482121483121484121485121486121487121488121489121490121491121492121493121494121495121496121497121498121499121500121501121502121503121504121505121506121507121508121509121510121511121512121513121514121515121516121517121518121519121520121521121522121523121524121525121526121527121528121529121530121531121532121533121534121535121536121537121538121539121540121541121542121543121544121545121546121547121548121549121550121551121552121553121554121555121556121557121558121559121560121561121562121563121564121565121566121567121568121569121570121571121572121573121574121575121576121577121578121579121580121581121582121583121584121585121586121587121588121589121590121591121592121593121594121595121596121597121598121599121600121601121602121603121604121605121606121607121608121609121610121611121612121613121614121615121616121617121618121619121620121621121622121623121624121625121626121627121628121629121630121631121632121633121634121635121636121637121638121639121640121641121642121643121644121645121646121647121648121649121650121651121652121653121654121655121656121657121658121659121660121661121662121663121664121665121666121667121668121669121670121671121672121673121674121675121676121677121678121679121680121681121682121683121684121685121686121687121688121689121690121691121692121693121694121695121696121697121698121699121700121701121702121703121704121705121706121707121708121709121710121711121712121713121714121715121716121717121718121719121720121721121722121723121724121725121726121727121728121729121730121731121732121733121734121735121736121737121738121739121740121741121742121743121744121745121746121747121748121749121750121751121752121753121754121755121756121757121758121759121760121761121762121763121764121765121766121767121768121769121770121771121772121773121774121775121776121777121778121779121780121781121782121783121784121785121786121787121788121789121790121791121792121793121794121795121796121797121798121799121800121801121802121803121804121805121806121807121808121809121810121811121812121813121814121815121816121817121818121819121820121821121822121823121824121825121826121827121828121829121830121831121832121833121834121835121836121837121838121839121840121841121842121843121844121845121846121847121848121849121850121851121852121853121854121855121856121857121858121859121860121861121862121863121864121865121866121867121868121869121870121871121872121873121874121875121876121877121878121879121880121881121882121883121884121885121886121887121888121889121890121891121892121893121894121895121896121897121898121899121900121901121902121903121904121905121906121907121908121909121910121911121912121913121914121915121916121917121918121919121920121921121922121923121924121925121926121927121928121929121930121931121932121933121934121935121936121937121938121939121940121941121942121943121944121945121946121947121948121949121950121951121952121953121954121955121956121957121958121959121960121961121962121963121964121965121966121967121968121969121970121971121972121973121974121975121976121977121978121979121980121981121982121983121984121985121986121987121988121989121990121991121992121993121994121995121996121997121998121999122000122001122002122003122004122005122006122007122008122009122010122011122012122013122014122015122016122017122018122019122020122021122022122023122024122025122026122027122028122029122030122031122032122033122034122035122036122037122038122039122040122041122042122043122044122045122046122047122048122049122050122051122052122053122054122055122056122057122058122059122060122061122062122063122064122065122066122067122068122069122070122071122072122073122074122075122076122077122078122079122080122081122082122083122084122085122086122087122088122089122090122091122092122093122094122095122096122097122098122099122100122101122102122103122104122105122106122107122108122109122110122111122112122113122114122115122116122117122118122119122120122121122122122123122124122125122126122127122128122129122130122131122132122133122134122135122136122137122138122139122140122141122142122143122144122145122146122147122148122149122150122151122152122153122154122155122156122157122158122159122160122161122162122163122164122165122166122167122168122169122170122171122172122173122174122175122176122177122178122179122180122181122182122183122184122185122186122187122188122189122190122191122192122193122194122195122196122197122198122199122200122201122202122203122204122205122206122207122208122209122210122211122212122213122214122215122216122217122218122219122220122221122222122223122224122225122226122227122228122229122230122231122232122233122234122235122236122237122238122239122240122241122242122243122244122245122246122247122248122249122250122251122252122253122254122255122256122257122258122259122260122261122262122263122264122265122266122267122268122269122270122271122272122273122274122275122276122277122278122279122280122281122282122283122284122285122286122287122288122289122290122291122292122293122294122295122296122297122298122299122300122301122302122303122304122305122306122307122308122309122310122311122312122313122314122315122316122317122318122319122320122321122322122323122324122325122326122327122328122329122330122331122332122333122334122335122336122337122338122339122340122341122342122343122344122345122346122347122348122349122350122351122352122353122354122355122356122357122358122359122360122361122362122363122364122365122366122367122368122369122370122371122372122373122374122375122376122377122378122379122380122381122382122383122384122385122386122387122388122389122390122391122392122393122394122395122396122397122398122399122400122401122402122403122404122405122406122407122408122409122410122411122412122413122414122415122416122417122418122419122420122421122422122423122424122425122426122427122428122429122430122431122432122433122434122435122436122437122438122439122440122441122442122443122444122445122446122447122448122449122450122451122452122453122454122455122456122457122458122459122460122461122462122463122464122465122466122467122468122469122470122471122472122473122474122475122476122477122478122479122480122481122482122483122484122485122486122487122488122489122490122491122492122493122494122495122496122497122498122499122500122501122502122503122504122505122506122507122508122509122510122511122512122513122514122515122516122517122518122519122520122521122522122523122524122525122526122527122528122529122530122531122532122533122534122535122536122537122538122539122540122541122542122543122544122545122546122547122548122549122550122551122552122553122554122555122556122557122558122559122560122561122562122563122564122565122566122567122568122569122570122571122572122573122574122575122576122577122578122579122580122581122582122583122584122585122586122587122588122589122590122591122592122593122594122595122596122597122598122599122600122601122602122603122604122605122606122607122608122609122610122611122612122613122614122615122616122617122618122619122620122621122622122623122624122625122626122627122628122629122630122631122632122633122634122635122636122637122638122639122640122641122642122643122644122645122646122647122648122649122650122651122652122653122654122655122656122657122658122659122660122661122662122663122664122665122666122667122668122669122670122671122672122673122674122675122676122677122678122679122680122681122682122683122684122685122686122687122688122689122690122691122692122693122694122695122696122697122698122699122700122701122702122703122704122705122706122707122708122709122710122711122712122713122714122715122716122717122718122719122720122721122722122723122724122725122726122727122728122729122730122731122732122733122734122735122736122737122738122739122740122741122742122743122744122745122746122747122748122749122750122751122752122753122754122755122756122757122758122759122760122761122762122763122764122765122766122767122768122769122770122771122772122773122774122775122776122777122778122779122780122781122782122783122784122785122786122787122788122789122790122791122792122793122794122795122796122797122798122799122800122801122802122803122804122805122806122807122808122809122810122811122812122813122814122815122816122817122818122819122820122821122822122823122824122825122826122827122828122829122830122831122832122833122834122835122836122837122838122839122840122841122842122843122844122845122846122847122848122849122850122851122852122853122854122855122856122857122858122859122860122861122862122863122864122865122866122867122868122869122870122871122872122873122874122875122876122877122878122879122880122881122882122883122884122885122886122887122888122889122890122891122892122893122894122895122896122897122898122899122900122901122902122903122904122905122906122907122908122909122910122911122912122913122914122915122916122917122918122919122920122921122922122923122924122925122926122927122928122929122930122931122932122933122934122935122936122937122938122939122940122941122942122943122944122945122946122947122948122949122950122951122952122953122954122955122956122957122958122959122960122961122962122963122964122965122966122967122968122969122970122971122972122973122974122975122976122977122978122979122980122981122982122983122984122985122986122987122988122989122990122991122992122993122994122995122996122997122998122999123000123001123002123003123004123005123006123007123008123009123010123011123012123013123014123015123016123017123018123019123020123021123022123023123024123025123026123027123028123029123030123031123032123033123034123035123036123037123038123039123040123041123042123043123044123045123046123047123048123049123050123051123052123053123054123055123056123057123058123059123060123061123062123063123064123065123066123067123068123069123070123071123072123073123074123075123076123077123078123079123080123081123082123083123084123085123086123087123088123089123090123091123092123093123094123095123096123097123098123099123100123101123102123103123104123105123106123107123108123109123110123111123112123113123114123115123116123117123118123119123120123121123122123123123124123125123126123127123128123129123130123131123132123133123134123135123136123137123138123139123140123141123142123143123144123145123146123147123148123149123150123151123152123153123154123155123156123157123158123159123160123161123162123163123164123165123166123167123168123169123170123171123172123173123174123175123176123177123178123179123180123181123182123183123184123185123186123187123188123189123190123191123192123193123194123195123196123197123198123199123200123201123202123203123204123205123206123207123208123209123210123211123212123213123214123215123216123217123218123219123220123221123222123223123224123225123226123227123228123229123230123231123232123233123234123235123236123237123238123239123240123241123242123243123244123245123246123247123248123249123250123251123252123253123254123255123256123257123258123259123260123261123262123263123264123265123266123267123268123269123270123271123272123273123274123275123276123277123278123279123280123281123282123283123284123285123286123287123288123289123290123291123292123293123294123295123296123297123298123299123300123301123302123303123304123305123306123307123308123309123310123311123312123313123314123315123316123317123318123319123320123321123322123323123324123325123326123327123328123329123330123331123332123333123334123335123336123337123338123339123340123341123342123343123344123345123346123347123348123349123350123351123352123353123354123355123356123357123358123359123360123361123362123363123364123365123366123367123368123369123370123371123372123373123374123375123376123377123378123379123380123381123382123383123384123385123386123387123388123389123390123391123392123393123394123395123396123397123398123399123400123401123402123403123404123405123406123407123408123409123410123411123412123413123414123415123416123417123418123419123420123421123422123423123424123425123426123427123428123429123430123431123432123433123434123435123436123437123438123439123440123441123442123443123444123445123446123447123448123449123450123451123452123453123454123455123456123457123458123459123460123461123462123463123464123465123466123467123468123469123470123471123472123473123474123475123476123477123478123479123480123481123482123483123484123485123486123487123488123489123490123491123492123493123494123495123496123497123498123499123500123501123502123503123504123505123506123507123508123509123510123511123512123513123514123515123516123517123518123519123520123521123522123523123524123525123526123527123528123529123530123531123532123533123534123535123536123537123538123539123540123541123542123543123544123545123546123547123548123549123550123551123552123553123554123555123556123557123558123559123560123561123562123563123564123565123566123567123568123569123570123571123572123573123574123575123576123577123578123579123580123581123582123583123584123585123586123587123588123589123590123591123592123593123594123595123596123597123598123599123600123601123602123603123604123605123606123607123608123609123610123611123612123613123614123615123616123617123618123619123620123621123622123623123624123625123626123627123628123629123630123631123632123633123634123635123636123637123638123639123640123641123642123643123644123645123646123647123648123649123650123651123652123653123654123655123656123657123658123659123660123661123662123663123664123665123666123667123668123669123670123671123672123673123674123675123676123677123678123679123680123681123682123683123684123685123686123687123688123689123690123691123692123693123694123695123696123697123698123699123700123701123702123703123704123705123706123707123708123709123710123711123712123713123714123715123716123717123718123719123720123721123722123723123724123725123726123727123728123729123730123731123732123733123734123735123736123737123738123739123740123741123742123743123744123745123746123747123748123749123750123751123752123753123754123755123756123757123758123759123760123761123762123763123764123765123766123767123768123769123770123771123772123773123774123775123776123777123778123779123780123781123782123783123784123785123786123787123788123789123790123791123792123793123794123795123796123797123798123799123800123801123802123803123804123805123806123807123808123809123810123811123812123813123814123815123816123817123818123819123820123821123822123823123824123825123826123827123828123829123830123831123832123833123834123835123836123837123838123839123840123841123842123843123844123845123846123847123848123849123850123851123852123853123854123855123856123857123858123859123860123861123862123863123864123865123866123867123868123869123870123871123872123873123874123875123876123877123878123879123880123881123882123883123884123885123886123887123888123889123890123891123892123893123894123895123896123897123898123899123900123901123902123903123904123905123906123907123908123909123910123911123912123913123914123915123916123917123918123919123920123921123922123923123924123925123926123927123928123929123930123931123932123933123934123935123936123937123938123939123940123941123942123943123944123945123946123947123948123949123950123951123952123953123954123955123956123957123958123959123960123961123962123963123964123965123966123967123968123969123970123971123972123973123974123975123976123977123978123979123980123981123982123983123984123985123986123987123988123989123990123991123992123993123994123995123996123997123998123999124000124001124002124003124004124005124006124007124008124009124010124011124012124013124014124015124016124017124018124019124020124021124022124023124024124025124026124027124028124029124030124031124032124033124034124035124036124037124038124039124040124041124042124043124044124045124046124047124048124049124050124051124052124053124054124055124056124057124058124059124060124061124062124063124064124065124066124067124068124069124070124071124072124073124074124075124076124077124078124079124080124081124082124083124084124085124086124087124088124089124090124091124092124093124094124095124096124097124098124099124100124101124102124103124104124105124106124107124108124109124110124111124112124113124114124115124116124117124118124119124120124121124122124123124124124125124126124127124128124129124130124131124132124133124134124135124136124137124138124139124140124141124142124143124144124145124146124147124148124149124150124151124152124153124154124155124156124157124158124159124160124161124162124163124164124165124166124167124168124169124170124171124172124173124174124175124176124177124178124179124180124181124182124183124184124185124186124187124188124189124190124191124192124193124194124195124196124197124198124199124200124201124202124203124204124205124206124207124208124209124210124211124212124213124214124215124216124217124218124219124220124221124222124223124224124225124226124227124228124229124230124231124232124233124234124235124236124237124238124239124240124241124242124243124244124245124246124247124248124249124250124251124252124253124254124255124256124257124258124259124260124261124262124263124264124265124266124267124268124269124270124271124272124273124274124275124276124277124278124279124280124281124282124283124284124285124286124287124288124289124290124291124292124293124294124295124296124297124298124299124300124301124302124303124304124305124306124307124308124309124310124311124312124313124314124315124316124317124318124319124320124321124322124323124324124325124326124327124328124329124330124331124332124333124334124335124336124337124338124339124340124341124342124343124344124345124346124347124348124349124350124351124352124353124354124355124356124357124358124359124360124361124362124363124364124365124366124367124368124369124370124371124372124373124374124375124376124377124378124379124380124381124382124383124384124385124386124387124388124389124390124391124392124393124394124395124396124397124398124399124400124401124402124403124404124405124406124407124408124409124410124411124412124413124414124415124416124417124418124419124420124421124422124423124424124425124426124427124428124429124430124431124432124433124434124435124436124437124438124439124440124441124442124443124444124445124446124447124448124449124450124451124452124453124454124455124456124457124458124459124460124461124462124463124464124465124466124467124468124469124470124471124472124473124474124475124476124477124478124479124480124481124482124483124484124485124486124487124488124489124490124491124492124493124494124495124496124497124498124499124500124501124502124503124504124505124506124507124508124509124510124511124512124513124514124515124516124517124518124519124520124521124522124523124524124525124526124527124528124529124530124531124532124533124534124535124536124537124538124539124540124541124542124543124544124545124546124547124548124549124550124551124552124553124554124555124556124557124558124559124560124561124562124563124564124565124566124567124568124569124570124571124572124573124574124575124576124577124578124579124580124581124582124583124584124585124586124587124588124589124590124591124592124593124594124595124596124597124598124599124600124601124602124603124604124605124606124607124608124609124610124611124612124613124614124615124616124617124618124619124620124621124622124623124624124625124626124627124628124629124630124631124632124633124634124635124636124637124638124639124640124641124642124643124644124645124646124647124648124649124650124651124652124653124654124655124656124657124658124659124660124661124662124663124664124665124666124667124668124669124670124671124672124673124674124675124676124677124678124679124680124681124682124683124684124685124686124687124688124689124690124691124692124693124694124695124696124697124698124699124700124701124702124703124704124705124706124707124708124709124710124711124712124713124714124715124716124717124718124719124720124721124722124723124724124725124726124727124728124729124730124731124732124733124734124735124736124737124738124739124740124741124742124743124744124745124746124747124748124749124750124751124752124753124754124755124756124757124758124759124760124761124762124763124764124765124766124767124768124769124770124771124772124773124774124775124776124777124778124779124780124781124782124783124784124785124786124787124788124789124790124791124792124793124794124795124796124797124798124799124800124801124802124803124804124805124806124807124808124809124810124811124812124813124814124815124816124817124818124819124820124821124822124823124824124825124826124827124828124829124830124831124832124833124834124835124836124837124838124839124840124841124842124843124844124845124846124847124848124849124850124851124852124853124854124855124856124857124858124859124860124861124862124863124864124865124866124867124868124869124870124871124872124873124874124875124876124877124878124879124880124881124882124883124884124885124886124887124888124889124890124891124892124893124894124895124896124897124898124899124900124901124902124903124904124905124906124907124908124909124910124911124912124913124914124915124916124917124918124919124920124921124922124923124924124925124926124927124928124929124930124931124932124933124934124935124936124937124938124939124940124941124942124943124944124945124946124947124948124949124950124951124952124953124954124955124956124957124958124959124960124961124962124963124964124965124966124967124968124969124970124971124972124973124974124975124976124977124978124979124980124981124982124983124984124985124986124987124988124989124990124991124992124993124994124995124996124997124998124999125000125001125002125003125004125005125006125007125008125009125010125011125012125013125014125015125016125017125018125019125020125021125022125023125024125025125026125027125028125029125030125031125032125033125034125035125036125037125038125039125040125041125042125043125044125045125046125047125048125049125050125051125052125053125054125055125056125057125058125059125060125061125062125063125064125065125066125067125068125069125070125071125072125073125074125075125076125077125078125079125080125081125082125083125084125085125086125087125088125089125090125091125092125093125094125095125096125097125098125099125100125101125102125103125104125105125106125107125108125109125110125111125112125113125114125115125116125117125118125119125120125121125122125123125124125125125126125127125128125129125130125131125132125133125134125135125136125137125138125139125140125141125142125143125144125145125146125147125148125149125150125151125152125153125154125155125156125157125158125159125160125161125162125163125164125165125166125167125168125169125170125171125172125173125174125175125176125177125178125179125180125181125182125183125184125185125186125187125188125189125190125191125192125193125194125195125196125197125198125199125200125201125202125203125204125205125206125207125208125209125210125211125212125213125214125215125216125217125218125219125220125221125222125223125224125225125226125227125228125229125230125231125232125233125234125235125236125237125238125239125240125241125242125243125244125245125246125247125248125249125250125251125252125253125254125255125256125257125258125259125260125261125262125263125264125265125266125267125268125269125270125271125272125273125274125275125276125277125278125279125280125281125282125283125284125285125286125287125288125289125290125291125292125293125294125295125296125297125298125299125300125301125302125303125304125305125306125307125308125309125310125311125312125313125314125315125316125317125318125319125320125321125322125323125324125325125326125327125328125329125330125331125332125333125334125335125336125337125338125339125340125341125342125343125344125345125346125347125348125349125350125351125352125353125354125355125356125357125358125359125360125361125362125363125364125365125366125367125368125369125370125371125372125373125374125375125376125377125378125379125380125381125382125383125384125385125386125387125388125389125390125391125392125393125394125395125396125397125398125399125400125401125402125403125404125405125406125407125408125409125410125411125412125413125414125415125416125417125418125419125420125421125422125423125424125425125426125427125428125429125430125431125432125433125434125435125436125437125438125439125440125441125442125443125444125445125446125447125448125449125450125451125452125453125454125455125456125457125458125459125460125461125462125463125464125465125466125467125468125469125470125471125472125473125474125475125476125477125478125479125480125481125482125483125484125485125486125487125488125489125490125491125492125493125494125495125496125497125498125499125500125501125502125503125504125505125506125507125508125509125510125511125512125513125514125515125516125517125518125519125520125521125522125523125524125525125526125527125528125529125530125531125532125533125534125535125536125537125538125539125540125541125542125543125544125545125546125547125548125549125550125551125552125553125554125555125556125557125558125559125560125561125562125563125564125565125566125567125568125569125570125571125572125573125574125575125576125577125578125579125580125581125582125583125584125585125586125587125588125589125590125591125592125593125594125595125596125597125598125599125600125601125602125603125604125605125606125607125608125609125610125611125612125613125614125615125616125617125618125619125620125621125622125623125624125625125626125627125628125629125630125631125632125633125634125635125636125637125638125639125640125641125642125643125644125645125646125647125648125649125650125651125652125653125654125655125656125657125658125659125660125661125662125663125664125665125666125667125668125669125670125671125672125673125674125675125676125677125678125679125680125681125682125683125684125685125686125687125688125689125690125691125692125693125694125695125696125697125698125699125700125701125702125703125704125705125706125707125708125709125710125711125712125713125714125715125716125717125718125719125720125721125722125723125724125725125726125727125728125729125730125731125732125733125734125735125736125737125738125739125740125741125742125743125744125745125746125747125748125749125750125751125752125753125754125755125756125757125758125759125760125761125762125763125764125765125766125767125768125769125770125771125772125773125774125775125776125777125778125779125780125781125782125783125784125785125786125787125788125789125790125791125792125793125794125795125796125797125798125799125800125801125802125803125804125805125806125807125808125809125810125811125812125813125814125815125816125817125818125819125820125821125822125823125824125825125826125827125828125829125830125831125832125833125834125835125836125837125838125839125840125841125842125843125844125845125846125847125848125849125850125851125852125853125854125855125856125857125858125859125860125861125862125863125864125865125866125867125868125869125870125871125872125873125874125875125876125877125878125879125880125881125882125883125884125885125886125887125888125889125890125891125892125893125894125895125896125897125898125899125900125901125902125903125904125905125906125907125908125909125910125911125912125913125914125915125916125917125918125919125920125921125922125923125924125925125926125927125928125929125930125931125932125933125934125935125936125937125938125939125940125941125942125943125944125945125946125947125948125949125950125951125952125953125954125955125956125957125958125959125960125961125962125963125964125965125966125967125968125969125970125971125972125973125974125975125976125977125978125979125980125981125982125983125984125985125986125987125988125989125990125991125992125993125994125995125996125997125998125999126000126001126002126003126004126005126006126007126008126009126010126011126012126013126014126015126016126017126018126019126020126021126022126023126024126025126026126027126028126029126030126031126032126033126034126035126036126037126038126039126040126041126042126043126044126045126046126047126048126049126050126051126052126053126054126055126056126057126058126059126060126061126062126063126064126065126066126067126068126069126070126071126072126073126074126075126076126077126078126079126080126081126082126083126084126085126086126087126088126089126090126091126092126093126094126095126096126097126098126099126100126101126102126103126104126105126106126107126108126109126110126111126112126113126114126115126116126117126118126119126120126121126122126123126124126125126126126127126128126129126130126131126132126133126134126135126136126137126138126139126140126141126142126143126144126145126146126147126148126149126150126151126152126153126154126155126156126157126158126159126160126161126162126163126164126165126166126167126168126169126170126171126172126173126174126175126176126177126178126179126180126181126182126183126184126185126186126187126188126189126190126191126192126193126194126195126196126197126198126199126200126201126202126203126204126205126206126207126208126209126210126211126212126213126214126215126216126217126218126219126220126221126222126223126224126225126226126227126228126229126230126231126232126233126234126235126236126237126238126239126240126241126242126243126244126245126246126247126248126249126250126251126252126253126254126255126256126257126258126259126260126261126262126263126264126265126266126267126268126269126270126271126272126273126274126275126276126277126278126279126280126281126282126283126284126285126286126287126288126289126290126291126292126293126294126295126296126297126298126299126300126301126302126303126304126305126306126307126308126309126310126311126312126313126314126315126316126317126318126319126320126321126322126323126324126325126326126327126328126329126330126331126332126333126334126335126336126337126338126339126340126341126342126343126344126345126346126347126348126349126350126351126352126353126354126355126356126357126358126359126360126361126362126363126364126365126366126367126368126369126370126371126372126373126374126375126376126377126378126379126380126381126382126383126384126385126386126387126388126389126390126391126392126393126394126395126396126397126398126399126400126401126402126403126404126405126406126407126408126409126410126411126412126413126414126415126416126417126418126419126420126421126422126423126424126425126426126427126428126429126430126431126432126433126434126435126436126437126438126439126440126441126442126443126444126445126446126447126448126449126450126451126452126453126454126455126456126457126458126459126460126461126462126463126464126465126466126467126468126469126470126471126472126473126474126475126476126477126478126479126480126481126482126483126484126485126486126487126488126489126490126491126492126493126494126495126496126497126498126499126500126501126502126503126504126505126506126507126508126509126510126511126512126513126514126515126516126517126518126519126520126521126522126523126524126525126526126527126528126529126530126531126532126533126534126535126536126537126538126539126540126541126542126543126544126545126546126547126548126549126550126551126552126553126554126555126556126557126558126559126560126561126562126563126564126565126566126567126568126569126570126571126572126573126574126575126576126577126578126579126580126581126582126583126584126585126586126587126588126589126590126591126592126593126594126595126596126597126598126599126600126601126602126603126604126605126606126607126608126609126610126611126612126613126614126615126616126617126618126619126620126621126622126623126624126625126626126627126628126629126630126631126632126633126634126635126636126637126638126639126640126641126642126643126644126645126646126647126648126649126650126651126652126653126654126655126656126657126658126659126660126661126662126663126664126665126666126667126668126669126670126671126672126673126674126675126676126677126678126679126680126681126682126683126684126685126686126687126688126689126690126691126692126693126694126695126696126697126698126699126700126701126702126703126704126705126706126707126708126709126710126711126712126713126714126715126716126717126718126719126720126721126722126723126724126725126726126727126728126729126730126731126732126733126734126735126736126737126738126739126740126741126742126743126744126745126746126747126748126749126750126751126752126753126754126755126756126757126758126759126760126761126762126763126764126765126766126767126768126769126770126771126772126773126774126775126776126777126778126779126780126781126782126783126784126785126786126787126788126789126790126791126792126793126794126795126796126797126798126799126800126801126802126803126804126805126806126807126808126809126810126811126812126813126814126815126816126817126818126819126820126821126822126823126824126825126826126827126828126829126830126831126832126833126834126835126836126837126838126839126840126841126842126843126844126845126846126847126848126849126850126851126852126853126854126855126856126857126858126859126860126861126862126863126864126865126866126867126868126869126870126871126872126873126874126875126876126877126878126879126880126881126882126883126884126885126886126887126888126889126890126891126892126893126894126895126896126897126898126899126900126901126902126903126904126905126906126907126908126909126910126911126912126913126914126915126916126917126918126919126920126921126922126923126924126925126926126927126928126929126930126931126932126933126934126935126936126937126938126939126940126941126942126943126944126945126946126947126948126949126950126951126952126953126954126955126956126957126958126959126960126961126962126963126964126965126966126967126968126969126970126971126972126973126974126975126976126977126978126979126980126981126982126983126984126985126986126987126988126989126990126991126992126993126994126995126996126997126998126999127000127001127002127003127004127005127006127007127008127009127010127011127012127013127014127015127016127017127018127019127020127021127022127023127024127025127026127027127028127029127030127031127032127033127034127035127036127037127038127039127040127041127042127043127044127045127046127047127048127049127050127051127052127053127054127055127056127057127058127059127060127061127062127063127064127065127066127067127068127069127070127071127072127073127074127075127076127077127078127079127080127081127082127083127084127085127086127087127088127089127090127091127092127093127094127095127096127097127098127099127100127101127102127103127104127105127106127107127108127109127110127111127112127113127114127115127116127117127118127119127120127121127122127123127124127125127126127127127128127129127130127131127132127133127134127135127136127137127138127139127140127141127142127143127144127145127146127147127148127149127150127151127152127153127154127155127156127157127158127159127160127161127162127163127164127165127166127167127168127169127170127171127172127173127174127175127176127177127178127179127180127181127182127183127184127185127186127187127188127189127190127191127192127193127194127195127196127197127198127199127200127201127202127203127204127205127206127207127208127209127210127211127212127213127214127215127216127217127218127219127220127221127222127223127224127225127226127227127228127229127230127231127232127233127234127235127236127237127238127239127240127241127242127243127244127245127246127247127248127249127250127251127252127253127254127255127256127257127258127259127260127261127262127263127264127265127266127267127268127269127270127271127272127273127274127275127276127277127278127279127280127281127282127283127284127285127286127287127288127289127290127291127292127293127294127295127296127297127298127299127300127301127302127303127304127305127306127307127308127309127310127311127312127313127314127315127316127317127318127319127320127321127322127323127324127325127326127327127328127329127330127331127332127333127334127335127336127337127338127339127340127341127342127343127344127345127346127347127348127349127350127351127352127353127354127355127356127357127358127359127360127361127362127363127364127365127366127367127368127369127370127371127372127373127374127375127376127377127378127379127380127381127382127383127384127385127386127387127388127389127390127391127392127393127394127395127396127397127398127399127400127401127402127403127404127405127406127407127408127409127410127411127412127413127414127415127416127417127418127419127420127421127422127423127424127425127426127427127428127429127430127431127432127433127434127435127436127437127438127439127440127441127442127443127444127445127446127447127448127449127450127451127452127453127454127455127456127457127458127459127460127461127462127463127464127465127466127467127468127469127470127471127472127473127474127475127476127477127478127479127480127481127482127483127484127485127486127487127488127489127490127491127492127493127494127495127496127497127498127499127500127501127502127503127504127505127506127507127508127509127510127511127512127513127514127515127516127517127518127519127520127521127522127523127524127525127526127527127528127529127530127531127532127533127534127535127536127537127538127539127540127541127542127543127544127545127546127547127548127549127550127551127552127553127554127555127556127557127558127559127560127561127562127563127564127565127566127567127568127569127570127571127572127573127574127575127576127577127578127579127580127581127582127583127584127585127586127587127588127589127590127591127592127593127594127595127596127597127598127599127600127601127602127603127604127605127606127607127608127609127610127611127612127613127614127615127616127617127618127619127620127621127622127623127624127625127626127627127628127629127630127631127632127633127634127635127636127637127638127639127640127641127642127643127644127645127646127647127648127649127650127651127652127653127654127655127656127657127658127659127660127661127662127663127664127665127666127667127668127669127670127671127672127673127674127675127676127677127678127679127680127681127682127683127684127685127686127687127688127689127690127691127692127693127694127695127696127697127698127699127700127701127702127703127704127705127706127707127708127709127710127711127712127713127714127715127716127717127718127719127720127721127722127723127724127725127726127727127728127729127730127731127732127733127734127735127736127737127738127739127740127741127742127743127744127745127746127747127748127749127750127751127752127753127754127755127756127757127758127759127760127761127762127763127764127765127766127767127768127769127770127771127772127773127774127775127776127777127778127779127780127781127782127783127784127785127786127787127788127789127790127791127792127793127794127795127796127797127798127799127800127801127802127803127804127805127806127807127808127809127810127811127812127813127814127815127816127817127818127819127820127821127822127823127824127825127826127827127828127829127830127831127832127833127834127835127836127837127838127839127840127841127842127843127844127845127846127847127848127849127850127851127852127853127854127855127856127857127858127859127860127861127862127863127864127865127866127867127868127869127870127871127872127873127874127875127876127877127878127879127880127881127882127883127884127885127886127887127888127889127890127891127892127893127894127895127896127897127898127899127900127901127902127903127904127905127906127907127908127909127910127911127912127913127914127915127916127917127918127919127920127921127922127923127924127925127926127927127928127929127930127931127932127933127934127935127936127937127938127939127940127941127942127943127944127945127946127947127948127949127950127951127952127953127954127955127956127957127958127959127960127961127962127963127964127965127966127967127968127969127970127971127972127973127974127975127976127977127978127979127980127981127982127983127984127985127986127987127988127989127990127991127992127993127994127995127996127997127998127999128000128001128002128003128004128005128006128007128008128009128010128011128012128013128014128015128016128017128018128019128020128021128022128023128024128025128026128027128028128029128030128031128032128033128034128035128036128037128038128039128040128041128042128043128044128045128046128047128048128049128050128051128052128053128054128055128056128057128058128059128060128061128062128063128064128065128066128067128068128069128070128071128072128073128074128075128076128077128078128079128080128081128082128083128084128085128086128087128088128089128090128091128092128093128094128095128096128097128098128099128100128101128102128103128104128105128106128107128108128109128110128111128112128113128114128115128116128117128118128119128120128121128122128123128124128125128126128127128128128129128130128131128132128133128134128135128136128137128138128139128140128141128142128143128144128145128146128147128148128149128150128151128152128153128154128155128156128157128158128159128160128161128162128163128164128165128166128167128168128169128170128171128172128173128174128175128176128177128178128179128180128181128182128183128184128185128186128187128188128189128190128191128192128193128194128195128196128197128198128199128200128201128202128203128204128205128206128207128208128209128210128211128212128213128214128215128216128217128218128219128220128221128222128223128224128225128226128227128228128229128230128231128232128233128234128235128236128237128238128239128240128241128242128243128244128245128246128247128248128249128250128251128252128253128254128255128256128257128258128259128260128261128262128263128264128265128266128267128268128269128270128271128272128273128274128275128276128277128278128279128280128281128282128283128284128285128286128287128288128289128290128291128292128293128294128295128296128297128298128299128300128301128302128303128304128305128306128307128308128309128310128311128312128313128314128315128316128317128318128319128320128321128322128323128324128325128326128327128328128329128330128331128332128333128334128335128336128337128338128339128340128341128342128343128344128345128346128347128348128349128350128351128352128353128354128355128356128357128358128359128360128361128362128363128364128365128366128367128368128369128370128371128372128373128374128375128376128377128378128379128380128381128382128383128384128385128386128387128388128389128390128391128392128393128394128395128396128397128398128399128400128401128402128403128404128405128406128407128408128409128410128411128412128413128414128415128416128417128418128419128420128421128422128423128424128425128426128427128428128429128430128431128432128433128434128435128436128437128438128439128440128441128442128443128444128445128446128447128448128449128450128451128452128453128454128455128456128457128458128459128460128461128462128463128464128465128466128467128468128469128470128471128472128473128474128475128476128477128478128479128480128481128482128483128484128485128486128487128488128489128490128491128492128493128494128495128496128497128498128499128500128501128502128503128504128505128506128507128508128509128510128511128512128513128514128515128516128517128518128519128520128521128522128523128524128525128526128527128528128529128530128531128532128533128534128535128536128537128538128539128540128541128542128543128544128545128546128547128548128549128550128551128552128553128554128555128556128557128558128559128560128561128562128563128564128565128566128567128568128569128570128571128572128573128574128575128576128577128578128579128580128581128582128583128584128585128586128587128588128589128590128591128592128593128594128595128596128597128598128599128600128601128602128603128604128605128606128607128608128609128610128611128612128613128614128615128616128617128618128619128620128621128622128623128624128625128626128627128628128629128630128631128632128633128634128635128636128637128638128639128640128641128642128643128644128645128646128647128648128649128650128651128652128653128654128655128656128657128658128659128660128661128662128663128664128665128666128667128668128669128670128671128672128673128674128675128676128677128678128679128680128681128682128683128684128685128686128687128688128689128690128691128692128693128694128695128696128697128698128699128700128701128702128703128704128705128706128707128708128709128710128711128712128713128714128715128716128717128718128719128720128721128722128723128724128725128726128727128728128729128730128731128732128733128734128735128736128737128738128739128740128741128742128743128744128745128746128747128748128749128750128751128752128753128754128755128756128757128758128759128760128761128762128763128764128765128766128767128768128769128770128771128772128773128774128775128776128777128778128779128780128781128782128783128784128785128786128787128788128789128790128791128792128793128794128795128796128797128798128799128800128801128802128803128804128805128806128807128808128809128810128811128812128813128814128815128816128817128818128819128820128821128822128823128824128825128826128827128828128829128830128831128832128833128834128835128836128837128838128839128840128841128842128843128844128845128846128847128848128849128850128851128852128853128854128855128856128857128858128859128860128861128862128863128864128865128866128867128868128869128870128871128872128873128874128875128876128877128878128879128880128881128882128883128884128885128886128887128888128889128890128891128892128893128894128895128896128897128898128899128900128901128902128903128904128905128906128907128908128909128910128911128912128913128914128915128916128917128918128919128920128921128922128923128924128925128926128927128928128929128930128931128932128933128934128935128936128937128938128939128940128941128942128943128944128945128946128947128948128949128950128951128952128953128954128955128956128957128958128959128960128961128962128963128964128965128966128967128968128969128970128971128972128973128974128975128976128977128978128979128980128981128982128983128984128985128986128987128988128989128990128991128992128993128994128995128996128997128998128999129000129001129002129003129004129005129006129007129008129009129010129011129012129013129014129015129016129017129018129019129020129021129022129023129024129025129026129027129028129029129030129031129032129033129034129035129036129037129038129039129040129041129042129043129044129045129046129047129048129049129050129051129052129053129054129055129056129057129058129059129060129061129062129063129064129065129066129067129068129069129070129071129072129073129074129075129076129077129078129079129080129081129082129083129084129085129086129087129088129089129090129091129092129093129094129095129096129097129098129099129100129101129102129103129104129105129106129107129108129109129110129111129112129113129114129115129116129117129118129119129120129121129122129123129124129125129126129127129128129129129130129131129132129133129134129135129136129137129138129139129140129141129142129143129144129145129146129147129148129149129150129151129152129153129154129155129156129157129158129159129160129161129162129163129164129165129166129167129168129169129170129171129172129173129174129175129176129177129178129179129180129181129182129183129184129185129186129187129188129189129190129191129192129193129194129195129196129197129198129199129200129201129202129203129204129205129206129207129208129209129210129211129212129213129214129215129216129217129218129219129220129221129222129223129224129225129226129227129228129229129230129231129232129233129234129235129236129237129238129239129240129241129242129243129244129245129246129247129248129249129250129251129252129253129254129255129256129257129258129259129260129261129262129263129264129265129266129267129268129269129270129271129272129273129274129275129276129277129278129279129280129281129282129283129284129285129286129287129288129289129290129291129292129293129294129295129296129297129298129299129300129301129302129303129304129305129306129307129308129309129310129311129312129313129314129315129316129317129318129319129320129321129322129323129324129325129326129327129328129329129330129331129332129333129334129335129336129337129338129339129340129341129342129343129344129345129346129347129348129349129350129351129352129353129354129355129356129357129358129359129360129361129362129363129364129365129366129367129368129369129370129371129372129373129374129375129376129377129378129379129380129381129382129383129384129385129386129387129388129389129390129391129392129393129394129395129396129397129398129399129400129401129402129403129404129405129406129407129408129409129410129411129412129413129414129415129416129417129418129419129420129421129422129423129424129425129426129427129428129429129430129431129432129433129434129435129436129437129438129439129440129441129442129443129444129445129446129447129448129449129450129451129452129453129454129455129456129457129458129459129460129461129462129463129464129465129466129467129468129469129470129471129472129473129474129475129476129477129478129479129480129481129482129483129484129485129486129487129488129489129490129491129492129493129494129495129496129497129498129499129500129501129502129503129504129505129506129507129508129509129510129511129512129513129514129515129516129517129518129519129520129521129522129523129524129525129526129527129528129529129530129531129532129533129534129535129536129537129538129539129540129541129542129543129544129545129546129547129548129549129550129551129552129553129554129555129556129557129558129559129560129561129562129563129564129565129566129567129568129569129570129571129572129573129574129575129576129577129578129579129580129581129582129583129584129585129586129587129588129589129590129591129592129593129594129595129596129597129598129599129600129601129602129603129604129605129606129607129608129609129610129611129612129613129614129615129616129617129618129619129620129621129622129623129624129625129626129627129628129629129630129631129632129633129634129635129636129637129638129639129640129641129642129643129644129645129646129647129648129649129650129651129652129653129654129655129656129657129658129659129660129661129662129663129664129665129666129667129668129669129670129671129672129673129674129675129676129677129678129679129680129681129682129683129684129685129686129687129688129689129690129691129692129693129694129695129696129697129698129699129700129701129702129703129704129705129706129707129708129709129710129711129712129713129714129715129716129717129718129719129720129721129722129723129724129725129726129727129728129729129730129731129732129733129734129735129736129737129738129739129740129741129742129743129744129745129746129747129748129749129750129751129752129753129754129755129756129757129758129759129760129761129762129763129764129765129766129767129768129769129770129771129772129773129774129775129776129777129778129779129780129781129782129783129784129785129786129787129788129789129790129791129792129793129794129795129796129797129798129799129800129801129802129803129804129805129806129807129808129809129810129811129812129813129814129815129816129817129818129819129820129821129822129823129824129825129826129827129828129829129830129831129832129833129834129835129836129837129838129839129840129841129842129843129844129845129846129847129848129849129850129851129852129853129854129855129856129857129858129859129860129861129862129863129864129865129866129867129868129869129870129871129872129873129874129875129876129877129878129879129880129881129882129883129884129885129886129887129888129889129890129891129892129893129894129895129896129897129898129899129900129901129902129903129904129905129906129907129908129909129910129911129912129913129914129915129916129917129918129919129920129921129922129923129924129925129926129927129928129929129930129931129932129933129934129935129936129937129938129939129940129941129942129943129944129945129946129947129948129949129950129951129952129953129954129955129956129957129958129959129960129961129962129963129964129965129966129967129968129969129970129971129972129973129974129975129976129977129978129979129980129981129982129983129984129985129986129987129988129989129990129991129992129993129994129995129996129997129998129999130000130001130002130003130004130005130006130007130008130009130010130011130012130013130014130015130016130017130018130019130020130021130022130023130024130025130026130027130028130029130030130031130032130033130034130035130036130037130038130039130040130041130042130043130044130045130046130047130048130049130050130051130052130053130054130055130056130057130058130059130060130061130062130063130064130065130066130067130068130069130070130071130072130073130074130075130076130077130078130079130080130081130082130083130084130085130086130087130088130089130090130091130092130093130094130095130096130097130098130099130100130101130102130103130104130105130106130107130108130109130110130111130112130113130114130115130116130117130118130119130120130121130122130123130124130125130126130127130128130129130130130131130132130133130134130135130136130137130138130139130140130141130142130143130144130145130146130147130148130149130150130151130152130153130154130155130156130157130158130159130160130161130162130163130164130165130166130167130168130169130170130171130172130173130174130175130176130177130178130179130180130181130182130183130184130185130186130187130188130189130190130191130192130193130194130195130196130197130198130199130200130201130202130203130204130205130206130207130208130209130210130211130212130213130214130215130216130217130218130219130220130221130222130223130224130225130226130227130228130229130230130231130232130233130234130235130236130237130238130239130240130241130242130243130244130245130246130247130248130249130250130251130252130253130254130255130256130257130258130259130260130261130262130263130264130265130266130267130268130269130270130271130272130273130274130275130276130277130278130279130280130281130282130283130284130285130286130287130288130289130290130291130292130293130294130295130296130297130298130299130300130301130302130303130304130305130306130307130308130309130310130311130312130313130314130315130316130317130318130319130320130321130322130323130324130325130326130327130328130329130330130331130332130333130334130335130336130337130338130339130340130341130342130343130344130345130346130347130348130349130350130351130352130353130354130355130356130357130358130359130360130361130362130363130364130365130366130367130368130369130370130371130372130373130374130375130376130377130378130379130380130381130382130383130384130385130386130387130388130389130390130391130392130393130394130395130396130397130398130399130400130401130402130403130404130405130406130407130408130409130410130411130412130413130414130415130416130417130418130419130420130421130422130423130424130425130426130427130428130429130430130431130432130433130434130435130436130437130438130439130440130441130442130443130444130445130446130447130448130449130450130451130452130453130454130455130456130457130458130459130460130461130462130463130464130465130466130467130468130469130470130471130472130473130474130475130476130477130478130479130480130481130482130483130484130485130486130487130488130489130490130491130492130493130494130495130496130497130498130499130500130501130502130503130504130505130506130507130508130509130510130511130512130513130514130515130516130517130518130519130520130521130522130523130524130525130526130527130528130529130530130531130532130533130534130535130536130537130538130539130540130541130542130543130544130545130546130547130548130549130550130551130552130553130554130555130556130557130558130559130560130561130562130563130564130565130566130567130568130569130570130571130572130573130574130575130576130577130578130579130580130581130582130583130584130585130586130587130588130589130590130591130592130593130594130595130596130597130598130599130600130601130602130603130604130605130606130607130608130609130610130611130612130613130614130615130616130617130618130619130620130621130622130623130624130625130626130627130628130629130630130631130632130633130634130635130636130637130638130639130640130641130642130643130644130645130646130647130648130649130650130651130652130653130654130655130656130657130658130659130660130661130662130663130664130665130666130667130668130669130670130671130672130673130674130675130676130677130678130679130680130681130682130683130684130685130686130687130688130689130690130691130692130693130694130695130696130697130698130699130700130701130702130703130704130705130706130707130708130709130710130711130712130713130714130715130716130717130718130719130720130721130722130723130724130725130726130727130728130729130730130731130732130733130734130735130736130737130738130739130740130741130742130743130744130745130746130747130748130749130750130751130752130753130754130755130756130757130758130759130760130761130762130763130764130765130766130767130768130769130770130771130772130773130774130775130776130777130778130779130780130781130782130783130784130785130786130787130788130789130790130791130792130793130794130795130796130797130798130799130800130801130802130803130804130805130806130807130808130809130810130811130812130813130814130815130816130817130818130819130820130821130822130823130824130825130826130827130828130829130830130831130832130833130834130835130836130837130838130839130840130841130842130843130844130845130846130847130848130849130850130851130852130853130854130855130856130857130858130859130860130861130862130863130864130865130866130867130868130869130870130871130872130873130874130875130876130877130878130879130880130881130882130883130884130885130886130887130888130889130890130891130892130893130894130895130896130897130898130899130900130901130902130903130904130905130906130907130908130909130910130911130912130913130914130915130916130917130918130919130920130921130922130923130924130925130926130927130928130929130930130931130932130933130934130935130936130937130938130939130940130941130942130943130944130945130946130947130948130949130950130951130952130953130954130955130956130957130958130959130960130961130962130963130964130965130966130967130968130969130970130971130972130973130974130975130976130977130978130979130980130981130982130983130984130985130986130987130988130989130990130991130992130993130994130995130996130997130998130999131000131001131002131003131004131005131006131007131008131009131010131011131012131013131014131015131016131017131018131019131020131021131022131023131024131025131026131027131028131029131030131031131032131033131034131035131036131037131038131039131040131041131042131043131044131045131046131047131048131049131050131051131052131053131054131055131056131057131058131059131060131061131062131063131064131065131066131067131068131069131070131071131072131073131074131075131076131077131078131079131080131081131082131083131084131085131086131087131088131089131090131091131092131093131094131095131096131097131098131099131100131101131102131103131104131105131106131107131108131109131110131111131112131113131114131115131116131117131118131119131120131121131122131123131124131125131126131127131128131129131130131131131132131133131134131135131136131137131138131139131140131141131142131143131144131145131146131147131148131149131150131151131152131153131154131155131156131157131158131159131160131161131162131163131164131165131166131167131168131169131170131171131172131173131174131175131176131177131178131179131180131181131182131183131184131185131186131187131188131189131190131191131192131193131194131195131196131197131198131199131200131201131202131203131204131205131206131207131208131209131210131211131212131213131214131215131216131217131218131219131220131221131222131223131224131225131226131227131228131229131230131231131232131233131234131235131236131237131238131239131240131241131242131243131244131245131246131247131248131249131250131251131252131253131254131255131256131257131258131259131260131261131262131263131264131265131266131267131268131269131270131271131272131273131274131275131276131277131278131279131280131281131282131283131284131285131286131287131288131289131290131291131292131293131294131295131296131297131298131299131300131301131302131303131304131305131306131307131308131309131310131311131312131313131314131315131316131317131318131319131320131321131322131323131324131325131326131327131328131329131330131331131332131333131334131335131336131337131338131339131340131341131342131343131344131345131346131347131348131349131350131351131352131353131354131355131356131357131358131359131360131361131362131363131364131365131366131367131368131369131370131371131372131373131374131375131376131377131378131379131380131381131382131383131384131385131386131387131388131389131390131391131392131393131394131395131396131397131398131399131400131401131402131403131404131405131406131407131408131409131410131411131412131413131414131415131416131417131418131419131420131421131422131423131424131425131426131427131428131429131430131431131432131433131434131435131436131437131438131439131440131441131442131443131444131445131446131447131448131449131450131451131452131453131454131455131456131457131458131459131460131461131462131463131464131465131466131467131468131469131470131471131472131473131474131475131476131477131478131479131480131481131482131483131484131485131486131487131488131489131490131491131492131493131494131495131496131497131498131499131500131501131502131503131504131505131506131507131508131509131510131511131512131513131514131515131516131517131518131519131520131521131522131523131524131525131526131527131528131529131530131531131532131533131534131535131536131537131538131539131540131541131542131543131544131545131546131547131548131549131550131551131552131553131554131555131556131557131558131559131560131561131562131563131564131565131566131567131568131569131570131571131572131573131574131575131576131577131578131579131580131581131582131583131584131585131586131587131588131589131590131591131592131593131594131595131596131597131598131599131600131601131602131603131604131605131606131607131608131609131610131611131612131613131614131615131616131617131618131619131620131621131622131623131624131625131626131627131628131629131630131631131632131633131634131635131636131637131638131639131640131641131642131643131644131645131646131647131648131649131650131651131652131653131654131655131656131657131658131659131660131661131662131663131664131665131666131667131668131669131670131671131672131673131674131675131676131677131678131679131680131681131682131683131684131685131686131687131688131689131690131691131692131693131694131695131696131697131698131699131700131701131702131703131704131705131706131707131708131709131710131711131712131713131714131715131716131717131718131719131720131721131722131723131724131725131726131727131728131729131730131731131732131733131734131735131736131737131738131739131740131741131742131743131744131745131746131747131748131749131750131751131752131753131754131755131756131757131758131759131760131761131762131763131764131765131766131767131768131769131770131771131772131773131774131775131776131777131778131779131780131781131782131783131784131785131786131787131788131789131790131791131792131793131794131795131796131797131798131799131800131801131802131803131804131805131806131807131808131809131810131811131812131813131814131815131816131817131818131819131820131821131822131823131824131825131826131827131828131829131830131831131832131833131834131835131836131837131838131839131840131841131842131843131844131845131846131847131848131849131850131851131852131853131854131855131856131857131858131859131860131861131862131863131864131865131866131867131868131869131870131871131872131873131874131875131876131877131878131879131880131881131882131883131884131885131886131887131888131889131890131891131892131893131894131895131896131897131898131899131900131901131902131903131904131905131906131907131908131909131910131911131912131913131914131915131916131917131918131919131920131921131922131923131924131925131926131927131928131929131930131931131932131933131934131935131936131937131938131939131940131941131942131943131944131945131946131947131948131949131950131951131952131953131954131955131956131957131958131959131960131961131962131963131964131965131966131967131968131969131970131971131972131973131974131975131976131977131978131979131980131981131982131983131984131985131986131987131988131989131990131991131992131993131994131995131996131997131998131999132000132001132002132003132004132005132006132007132008132009132010132011132012132013132014132015132016132017132018132019132020132021132022132023132024132025132026132027132028132029132030132031132032132033132034132035132036132037132038132039132040132041132042132043132044132045132046132047132048132049132050132051132052132053132054132055132056132057132058132059132060132061132062132063132064132065132066132067132068132069132070132071132072132073132074132075132076132077132078132079132080132081132082132083132084132085132086132087132088132089132090132091132092132093132094132095132096132097132098132099132100132101132102132103132104132105132106132107132108132109132110132111132112132113132114132115132116132117132118132119132120132121132122132123132124132125132126132127132128132129132130132131132132132133132134132135132136132137132138132139132140132141132142132143132144132145132146132147132148132149132150132151132152132153132154132155132156132157132158132159132160132161132162132163132164132165132166132167132168132169132170132171132172132173132174132175132176132177132178132179132180132181132182132183132184132185132186132187132188132189132190132191132192132193132194132195132196132197132198132199132200132201132202132203132204132205132206132207132208132209132210132211132212132213132214132215132216132217132218132219132220132221132222132223132224132225132226132227132228132229132230132231132232132233132234132235132236132237132238132239132240132241132242132243132244132245132246132247132248132249132250132251132252132253132254132255132256132257132258132259132260132261132262132263132264132265132266132267132268132269132270132271132272132273132274132275132276132277132278132279132280132281132282132283132284132285132286132287132288132289132290132291132292132293132294132295132296132297132298132299132300132301132302132303132304132305132306132307132308132309132310132311132312132313132314132315132316132317132318132319132320132321132322132323132324132325132326132327132328132329132330132331132332132333132334132335132336132337132338132339132340132341132342132343132344132345132346132347132348132349132350132351132352132353132354132355132356132357132358132359132360132361132362132363132364132365132366132367132368132369132370132371132372132373132374132375132376132377132378132379132380132381132382132383132384132385132386132387132388132389132390132391132392132393132394132395132396132397132398132399132400132401132402132403132404132405132406132407132408132409132410132411132412132413132414132415132416132417132418132419132420132421132422132423132424132425132426132427132428132429132430132431132432132433132434132435132436132437132438132439132440132441132442132443132444132445132446132447132448132449132450132451132452132453132454132455132456132457132458132459132460132461132462132463132464132465132466132467132468132469132470132471132472132473132474132475132476132477132478132479132480132481132482132483132484132485132486132487132488132489132490132491132492132493132494132495132496132497132498132499132500132501132502132503132504132505132506132507132508132509132510132511132512132513132514132515132516132517132518132519132520132521132522132523132524132525132526132527132528132529132530132531132532132533132534132535132536132537132538132539132540132541132542132543132544132545132546132547132548132549132550132551132552132553132554132555132556132557132558132559132560132561132562132563132564132565132566132567132568132569132570132571132572132573132574132575132576132577132578132579132580132581132582132583132584132585132586132587132588132589132590132591132592132593132594132595132596132597132598132599132600132601132602132603132604132605132606132607132608132609132610132611132612132613132614132615132616132617132618132619132620132621132622132623132624132625132626132627132628132629132630132631132632132633132634132635132636132637132638132639132640132641132642132643132644132645132646132647132648132649132650132651132652132653132654132655132656132657132658132659132660132661132662132663132664132665132666132667132668132669132670132671132672132673132674132675132676132677132678132679132680132681132682132683132684132685132686132687132688132689132690132691132692132693132694132695132696132697132698132699132700132701132702132703132704132705132706132707132708132709132710132711132712132713132714132715132716132717132718132719132720132721132722132723132724132725132726132727132728132729132730132731132732132733132734132735132736132737132738132739132740132741132742132743132744132745132746132747132748132749132750132751132752132753132754132755132756132757132758132759132760132761132762132763132764132765132766132767132768132769132770132771132772132773132774132775132776132777132778132779132780132781132782132783132784132785132786132787132788132789132790132791132792132793132794132795132796132797132798132799132800132801132802132803132804132805132806132807132808132809132810132811132812132813132814132815132816132817132818132819132820132821132822132823132824132825132826132827132828132829132830132831132832132833132834132835132836132837132838132839132840132841132842132843132844132845132846132847132848132849132850132851132852132853132854132855132856132857132858132859132860132861132862132863132864132865132866132867132868132869132870132871132872132873132874132875132876132877132878132879132880132881132882132883132884132885132886132887132888132889132890132891132892132893132894132895132896132897132898132899132900132901132902132903132904132905132906132907132908132909132910132911132912132913132914132915132916132917132918132919132920132921132922132923132924132925132926132927132928132929132930132931132932132933132934132935132936132937132938132939132940132941132942132943132944132945132946132947132948132949132950132951132952132953132954132955132956132957132958132959132960132961132962132963132964132965132966132967132968132969132970132971132972132973132974132975132976132977132978132979132980132981132982132983132984132985132986132987132988132989132990132991132992132993132994132995132996132997132998132999133000133001133002133003133004133005133006133007133008133009133010133011133012133013133014133015133016133017133018133019133020133021133022133023133024133025133026133027133028133029133030133031133032133033133034133035133036133037133038133039133040133041133042133043133044133045133046133047133048133049133050133051133052133053133054133055133056133057133058133059133060133061133062133063133064133065133066133067133068133069133070133071133072133073133074133075133076133077133078133079133080133081133082133083133084133085133086133087133088133089133090133091133092133093133094133095133096133097133098133099133100133101133102133103133104133105133106133107133108133109133110133111133112133113133114133115133116133117133118133119133120133121133122133123133124133125133126133127133128133129133130133131133132133133133134133135133136133137133138133139133140133141133142133143133144133145133146133147133148133149133150133151133152133153133154133155133156133157133158133159133160133161133162133163133164133165133166133167133168133169133170133171133172133173133174133175133176133177133178133179133180133181133182133183133184133185133186133187133188133189133190133191133192133193133194133195133196133197133198133199133200133201133202133203133204133205133206133207133208133209133210133211133212133213133214133215133216133217133218133219133220133221133222133223133224133225133226133227133228133229133230133231133232133233133234133235133236133237133238133239133240133241133242133243133244133245133246133247133248133249133250133251133252133253133254133255133256133257133258133259133260133261133262133263133264133265133266133267133268133269133270133271133272133273133274133275133276133277133278133279133280133281133282133283133284133285133286133287133288133289133290133291133292133293133294133295133296133297133298133299133300133301133302133303133304133305133306133307133308133309133310133311133312133313133314133315133316133317133318133319133320133321133322133323133324133325133326133327133328133329133330133331133332133333133334133335133336133337133338133339133340133341133342133343133344133345133346133347133348133349133350133351133352133353133354133355133356133357133358133359133360133361133362133363133364133365133366133367133368133369133370133371133372133373133374133375133376133377133378133379133380133381133382133383133384133385133386133387133388133389133390133391133392133393133394133395133396133397133398133399133400133401133402133403133404133405133406133407133408133409133410133411133412133413133414133415133416133417133418133419133420133421133422133423133424133425133426133427133428133429133430133431133432133433133434133435133436133437133438133439133440133441133442133443133444133445133446133447133448133449133450133451133452133453133454133455133456133457133458133459133460133461133462133463133464133465133466133467133468133469133470133471133472133473133474133475133476133477133478133479133480133481133482133483133484133485133486133487133488133489133490133491133492133493133494133495133496133497133498133499133500133501133502133503133504133505133506133507133508133509133510133511133512133513133514133515133516133517133518133519133520133521133522133523133524133525133526133527133528133529133530133531133532133533133534133535133536133537133538133539133540133541133542133543133544133545133546133547133548133549133550133551133552133553133554133555133556133557133558133559133560133561133562133563133564133565133566133567133568133569133570133571133572133573133574133575133576133577133578133579133580133581133582133583133584133585133586133587133588133589133590133591133592133593133594133595133596133597133598133599133600133601133602133603133604133605133606133607133608133609133610133611133612133613133614133615133616133617133618133619133620133621133622133623133624133625133626133627133628133629133630133631133632133633133634133635133636133637133638133639133640133641133642133643133644133645133646133647133648133649133650133651133652133653133654133655133656133657133658133659133660133661133662133663133664133665133666133667133668133669133670133671133672133673133674133675133676133677133678133679133680133681133682133683133684133685133686133687133688133689133690133691133692133693133694133695133696133697133698133699133700133701133702133703133704133705133706133707133708133709133710133711133712133713133714133715133716133717133718133719133720133721133722133723133724133725133726133727133728133729133730133731133732133733133734133735133736133737133738133739133740133741133742133743133744133745133746133747133748133749133750133751133752133753133754133755133756133757133758133759133760133761133762133763133764133765133766133767133768133769133770133771133772133773133774133775133776133777133778133779133780133781133782133783133784133785133786133787133788133789133790133791133792133793133794133795133796133797133798133799133800133801133802133803133804133805133806133807133808133809133810133811133812133813133814133815133816133817133818133819133820133821133822133823133824133825133826133827133828133829133830133831133832133833133834133835133836133837133838133839133840133841133842133843133844133845133846133847133848133849133850133851133852133853133854133855133856133857133858133859133860133861133862133863133864133865133866133867133868133869133870133871133872133873133874133875133876133877133878133879133880133881133882133883133884133885133886133887133888133889133890133891133892133893133894133895133896133897133898133899133900133901133902133903133904133905133906133907133908133909133910133911133912133913133914133915133916133917133918133919133920133921133922133923133924133925133926133927133928133929133930133931133932133933133934133935133936133937133938133939133940133941133942133943133944133945133946133947133948133949133950133951133952133953133954133955133956133957133958133959133960133961133962133963133964133965133966133967133968133969133970133971133972133973133974133975133976133977133978133979133980133981133982133983133984133985133986133987133988133989133990133991133992133993133994133995133996133997133998133999134000134001134002134003134004134005134006134007134008134009134010134011134012134013134014134015134016134017134018134019134020134021134022134023134024134025134026134027134028134029134030134031134032134033134034134035134036134037134038134039134040134041134042134043134044134045134046134047134048134049134050134051134052134053134054134055134056134057134058134059134060134061134062134063134064134065134066134067134068134069134070134071134072134073134074134075134076134077134078134079134080134081134082134083134084134085134086134087134088134089134090134091134092134093134094134095134096134097134098134099134100134101134102134103134104134105134106134107134108134109134110134111134112134113134114134115134116134117134118134119134120134121134122134123134124134125134126134127134128134129134130134131134132134133134134134135134136134137134138134139134140134141134142134143134144134145134146134147134148134149134150134151134152134153134154134155134156134157134158134159134160134161134162134163134164134165134166134167134168134169134170134171134172134173134174134175134176134177134178134179134180134181134182134183134184134185134186134187134188134189134190134191134192134193134194134195134196134197134198134199134200134201134202134203134204134205134206134207134208134209134210134211134212134213134214134215134216134217134218134219134220134221134222134223134224134225134226134227134228134229134230134231134232134233134234134235134236134237134238134239134240134241134242134243134244134245134246134247134248134249134250134251134252134253134254134255134256134257134258134259134260134261134262134263134264134265134266134267134268134269134270134271134272134273134274134275134276134277134278134279134280134281134282134283134284134285134286134287134288134289134290134291134292134293134294134295134296134297134298134299134300134301134302134303134304134305134306134307134308134309134310134311134312134313134314134315134316134317134318134319134320134321134322134323134324134325134326134327134328134329134330134331134332134333134334134335134336134337134338134339134340134341134342134343134344134345134346134347134348134349134350134351134352134353134354134355134356134357134358134359134360134361134362134363134364134365134366134367134368134369134370134371134372134373134374134375134376134377134378134379134380134381134382134383134384134385134386134387134388134389134390134391134392134393134394134395134396134397134398134399134400134401134402134403134404134405134406134407134408134409134410134411134412134413134414134415134416134417134418134419134420134421134422134423134424134425134426134427134428134429134430134431134432134433134434134435134436134437134438134439134440134441134442134443134444134445134446134447134448134449134450134451134452134453134454134455134456134457134458134459134460134461134462134463134464134465134466134467134468134469134470134471134472134473134474134475134476134477134478134479134480134481134482134483134484134485134486134487134488134489134490134491134492134493134494134495134496134497134498134499134500134501134502134503134504134505134506134507134508134509134510134511134512134513134514134515134516134517134518134519134520134521134522134523134524134525134526134527134528134529134530134531134532134533134534134535134536134537134538134539134540134541134542134543134544134545134546134547134548134549134550134551134552134553134554134555134556134557134558134559134560134561134562134563134564134565134566134567134568134569134570134571134572134573134574134575134576134577134578134579134580134581134582134583134584134585134586134587134588134589134590134591134592134593134594134595134596134597134598134599134600134601134602134603134604134605134606134607134608134609134610134611134612134613134614134615134616134617134618134619134620134621134622134623134624134625134626134627134628134629134630134631134632134633134634134635134636134637134638134639134640134641134642134643134644134645134646134647134648134649134650134651134652134653134654134655134656134657134658134659134660134661134662134663134664134665134666134667134668134669134670134671134672134673134674134675134676134677134678134679134680134681134682134683134684134685134686134687134688134689134690134691134692134693134694134695134696134697134698134699134700134701134702134703134704134705134706134707134708134709134710134711134712134713134714134715134716134717134718134719134720134721134722134723134724134725134726134727134728134729134730134731134732134733134734134735134736134737134738134739134740134741134742134743134744134745134746134747134748134749134750134751134752134753134754134755134756134757134758134759134760134761134762134763134764134765134766134767134768134769134770134771134772134773134774134775134776134777134778134779134780134781134782134783134784134785134786134787134788134789134790134791134792134793134794134795134796134797134798134799134800134801134802134803134804134805134806134807134808134809134810134811134812134813134814134815134816134817134818134819134820134821134822134823134824134825134826134827134828134829134830134831134832134833134834134835134836134837134838134839134840134841134842134843134844134845134846134847134848134849134850134851134852134853134854134855134856134857134858134859134860134861134862134863134864134865134866134867134868134869134870134871134872134873134874134875134876134877134878134879134880134881134882134883134884134885134886134887134888134889134890134891134892134893134894134895134896134897134898134899134900134901134902134903134904134905134906134907134908134909134910134911134912134913134914134915134916134917134918134919134920134921134922134923134924134925134926134927134928134929134930134931134932134933134934134935134936134937134938134939134940134941134942134943134944134945134946134947134948134949134950134951134952134953134954134955134956134957134958134959134960134961134962134963134964134965134966134967134968134969134970134971134972134973134974134975134976134977134978134979134980134981134982134983134984134985134986134987134988134989134990134991134992134993134994134995134996134997134998134999135000135001135002135003135004135005135006135007135008135009135010135011135012135013135014135015135016135017135018135019135020135021135022135023135024135025135026135027135028135029135030135031135032135033135034135035135036135037135038135039135040135041135042135043135044135045135046135047135048135049135050135051135052135053135054135055135056135057135058135059135060135061135062135063135064135065135066135067135068135069135070135071135072135073135074135075135076135077135078135079135080135081135082135083135084135085135086135087135088135089135090135091135092135093135094135095135096135097135098135099135100135101135102135103135104135105135106135107135108135109135110135111135112135113135114135115135116135117135118135119135120135121135122135123135124135125135126135127135128135129135130135131135132135133135134135135135136135137135138135139135140135141135142135143135144135145135146135147135148135149135150135151135152135153135154135155135156135157135158135159135160135161135162135163135164135165135166135167135168135169135170135171135172135173135174135175135176135177135178135179135180135181135182135183135184135185135186135187135188135189135190135191135192135193135194135195135196135197135198135199135200135201135202135203135204135205135206135207135208135209135210135211135212135213135214135215135216135217135218135219135220135221135222135223135224135225135226135227135228135229135230135231135232135233135234135235135236135237135238135239135240135241135242135243135244135245135246135247135248135249135250135251135252135253135254135255135256135257135258135259135260135261135262135263135264135265135266135267135268135269135270135271135272135273135274135275135276135277135278135279135280135281135282135283135284135285135286135287135288135289135290135291135292135293135294135295135296135297135298135299135300135301135302135303135304135305135306135307135308135309135310135311135312135313135314135315135316135317135318135319135320135321135322135323135324135325135326135327135328135329135330135331135332135333135334135335135336135337135338135339135340135341135342135343135344135345135346135347135348135349135350135351135352135353135354135355135356135357135358135359135360135361135362135363135364135365135366135367135368135369135370135371135372135373135374135375135376135377135378135379135380135381135382135383135384135385135386135387135388135389135390135391135392135393135394135395135396135397135398135399135400135401135402135403135404135405135406135407135408135409135410135411135412135413135414135415135416135417135418135419135420135421135422135423135424135425135426135427135428135429135430135431135432135433135434135435135436135437135438135439135440135441135442135443135444135445135446135447135448135449135450135451135452135453135454135455135456135457135458135459135460135461135462135463135464135465135466135467135468135469135470135471135472135473135474135475135476135477135478135479135480135481135482135483135484135485135486135487135488135489135490135491135492135493135494135495135496135497135498135499135500135501135502135503135504135505135506135507135508135509135510135511135512135513135514135515135516135517135518135519135520135521135522135523135524135525135526135527135528135529135530135531135532135533135534135535135536135537135538135539135540135541135542135543135544135545135546135547135548135549135550135551135552135553135554135555135556135557135558135559135560135561135562135563135564135565135566135567135568135569135570135571135572135573135574135575135576135577135578135579135580135581135582135583135584135585135586135587135588135589135590135591135592135593135594135595135596135597135598135599135600135601135602135603135604135605135606135607135608135609135610135611135612135613135614135615135616135617135618135619135620135621135622135623135624135625135626135627135628135629135630135631135632135633135634135635135636135637135638135639135640135641135642135643135644135645135646135647135648135649135650135651135652135653135654135655135656135657135658135659135660135661135662135663135664135665135666135667135668135669135670135671135672135673135674135675135676135677135678135679135680135681135682135683135684135685135686135687135688135689135690135691135692135693135694135695135696135697135698135699135700135701135702135703135704135705135706135707135708135709135710135711135712135713135714135715135716135717135718135719135720135721135722135723135724135725135726135727135728135729135730135731135732135733135734135735135736135737135738135739135740135741135742135743135744135745135746135747135748135749135750135751135752135753135754135755135756135757135758135759135760135761135762135763135764135765135766135767135768135769135770135771135772135773135774135775135776135777135778135779135780135781135782135783135784135785135786135787135788135789135790135791135792135793135794135795135796135797135798135799135800135801135802135803135804135805135806135807135808135809135810135811135812135813135814135815135816135817135818135819135820135821135822135823135824135825135826135827135828135829135830135831135832135833135834135835135836135837135838135839135840135841135842135843135844135845135846135847135848135849135850135851135852135853135854135855135856135857135858135859135860135861135862135863135864135865135866135867135868135869135870135871135872135873135874135875135876135877135878135879135880135881135882135883135884135885135886135887135888135889135890135891135892135893135894135895135896135897135898135899135900135901135902135903135904135905135906135907135908135909135910135911135912135913135914135915135916135917135918135919135920135921135922135923135924135925135926135927135928135929135930135931135932135933135934135935135936135937135938135939135940135941135942135943135944135945135946135947135948135949135950135951135952135953135954135955135956135957135958135959135960135961135962135963135964135965135966135967135968135969135970135971135972135973135974135975135976135977135978135979135980135981135982135983135984135985135986135987135988135989135990135991135992135993135994135995135996135997135998135999136000136001136002136003136004136005136006136007136008136009136010136011136012136013136014136015136016136017136018136019136020136021136022136023136024136025136026136027136028136029136030136031136032136033136034136035136036136037136038136039136040136041136042136043136044136045136046136047136048136049136050136051136052136053136054136055136056136057136058136059136060136061136062136063136064136065136066136067136068136069136070136071136072136073136074136075136076136077136078136079136080136081136082136083136084136085136086136087136088136089136090136091136092136093136094136095136096136097136098136099136100136101136102136103136104136105136106136107136108136109136110136111136112136113136114136115136116136117136118136119136120136121136122136123136124136125136126136127136128136129136130136131136132136133136134136135136136136137136138136139136140136141136142136143136144136145136146136147136148136149136150136151136152136153136154136155136156136157136158136159136160136161136162136163136164136165136166136167136168136169136170136171136172136173136174136175136176136177136178136179136180136181136182136183136184136185136186136187136188136189136190136191136192136193136194136195136196136197136198136199136200136201136202136203136204136205136206136207136208136209136210136211136212136213136214136215136216136217136218136219136220136221136222136223136224136225136226136227136228136229136230136231136232136233136234136235136236136237136238136239136240136241136242136243136244136245136246136247136248136249136250136251136252136253136254136255136256136257136258136259136260136261136262136263136264136265136266136267136268136269136270136271136272136273136274136275136276136277136278136279136280136281136282136283136284136285136286136287136288136289136290136291136292136293136294136295136296136297136298136299136300136301136302136303136304136305136306136307136308136309136310136311136312136313136314136315136316136317136318136319136320136321136322136323136324136325136326136327136328136329136330136331136332136333136334136335136336136337136338136339136340136341136342136343136344136345136346136347136348136349136350136351136352136353136354136355136356136357136358136359136360136361136362136363136364136365136366136367136368136369136370136371136372136373136374136375136376136377136378136379136380136381136382136383136384136385136386136387136388136389136390136391136392136393136394136395136396136397136398136399136400136401136402136403136404136405136406136407136408136409136410136411136412136413136414136415136416136417136418136419136420136421136422136423136424136425136426136427136428136429136430136431136432136433136434136435136436136437136438136439136440136441136442136443136444136445136446136447136448136449136450136451136452136453136454136455136456136457136458136459136460136461136462136463136464136465136466136467136468136469136470136471136472136473136474136475136476136477136478136479136480136481136482136483136484136485136486136487136488136489136490136491136492136493136494136495136496136497136498136499136500136501136502136503136504136505136506136507136508136509136510136511136512136513136514136515136516136517136518136519136520136521136522136523136524136525136526136527136528136529136530136531136532136533136534136535136536136537136538136539136540136541136542136543136544136545136546136547136548136549136550136551136552136553136554136555136556136557136558136559136560136561136562136563136564136565136566136567136568136569136570136571136572136573136574136575136576136577136578136579136580136581136582136583136584136585136586136587136588136589136590136591136592136593136594136595136596136597136598136599136600136601136602136603136604136605136606136607136608136609136610136611136612136613136614136615136616136617136618136619136620136621136622136623136624136625136626136627136628136629136630136631136632136633136634136635136636136637136638136639136640136641136642136643136644136645136646136647136648136649136650136651136652136653136654136655136656136657136658136659136660136661136662136663136664136665136666136667136668136669136670136671136672136673136674136675136676136677136678136679136680136681136682136683136684136685136686136687136688136689136690136691136692136693136694136695136696136697136698136699136700136701136702136703136704136705136706136707136708136709136710136711136712136713136714136715136716136717136718136719136720136721136722136723136724136725136726136727136728136729136730136731136732136733136734136735136736136737136738136739136740136741136742136743136744136745136746136747136748136749136750136751136752136753136754136755136756136757136758136759136760136761136762136763136764136765136766136767136768136769136770136771136772136773136774136775136776136777136778136779136780136781136782136783136784136785136786136787136788136789136790136791136792136793136794136795136796136797136798136799136800136801136802136803136804136805136806136807136808136809136810136811136812136813136814136815136816136817136818136819136820136821136822136823136824136825136826136827136828136829136830136831136832136833136834136835136836136837136838136839136840136841136842136843136844136845136846136847136848136849136850136851136852136853136854136855136856136857136858136859136860136861136862136863136864136865136866136867136868136869136870136871136872136873136874136875136876136877136878136879136880136881136882136883136884136885136886136887136888136889136890136891136892136893136894136895136896136897136898136899136900136901136902136903136904136905136906136907136908136909136910136911136912136913136914136915136916136917136918136919136920136921136922136923136924136925136926136927136928136929136930136931136932136933136934136935136936136937136938136939136940136941136942136943136944136945136946136947136948136949136950136951136952136953136954136955136956136957136958136959136960136961136962136963136964136965136966136967136968136969136970136971136972136973136974136975136976136977136978136979136980136981136982136983136984136985136986136987136988136989136990136991136992136993136994136995136996136997136998136999137000137001137002137003137004137005137006137007137008137009137010137011137012137013137014137015137016137017137018137019137020137021137022137023137024137025137026137027137028137029137030137031137032137033137034137035137036137037137038137039137040137041137042137043137044137045137046137047137048137049137050137051137052137053137054137055137056137057137058137059137060137061137062137063137064137065137066137067137068137069137070137071137072137073137074137075137076137077137078137079137080137081137082137083137084137085137086137087137088137089137090137091137092137093137094137095137096137097137098137099137100137101137102137103137104137105137106137107137108137109137110137111137112137113137114137115137116137117137118137119137120137121137122137123137124137125137126137127137128137129137130137131137132137133137134137135137136137137137138137139137140137141137142137143137144137145137146137147137148137149137150137151137152137153137154137155137156137157137158137159137160137161137162137163137164137165137166137167137168137169137170137171137172137173137174137175137176137177137178137179137180137181137182137183137184137185137186137187137188137189137190137191137192137193137194137195137196137197137198137199137200137201137202137203137204137205137206137207137208137209137210137211137212137213137214137215137216137217137218137219137220137221137222137223137224137225137226137227137228137229137230137231137232137233137234137235137236137237137238137239137240137241137242137243137244137245137246137247137248137249137250137251137252137253137254137255137256137257137258137259137260137261137262137263137264137265137266137267137268137269137270137271137272137273137274137275137276137277137278137279137280137281137282137283137284137285137286137287137288137289137290137291137292137293137294137295137296137297137298137299137300137301137302137303137304137305137306137307137308137309137310137311137312137313137314137315137316137317137318137319137320137321137322137323137324137325137326137327137328137329137330137331137332137333137334137335137336137337137338137339137340137341137342137343137344137345137346137347137348137349137350137351137352137353137354137355137356137357137358137359137360137361137362137363137364137365137366137367137368137369137370137371137372137373137374137375137376137377137378137379137380137381137382137383137384137385137386137387137388137389137390137391137392137393137394137395137396137397137398137399137400137401137402137403137404137405137406137407137408137409137410137411137412137413137414137415137416137417137418137419137420137421137422137423137424137425137426137427137428137429137430137431137432137433137434137435137436137437137438137439137440137441137442137443137444137445137446137447137448137449137450137451137452137453137454137455137456137457137458137459137460137461137462137463137464137465137466137467137468137469137470137471137472137473137474137475137476137477137478137479137480137481137482137483137484137485137486137487137488137489137490137491137492137493137494137495137496137497137498137499137500137501137502137503137504137505137506137507137508137509137510137511137512137513137514137515137516137517137518137519137520137521137522137523137524137525137526137527137528137529137530137531137532137533137534137535137536137537137538137539137540137541137542137543137544137545137546137547137548137549137550137551137552137553137554137555137556137557137558137559137560137561137562137563137564137565137566137567137568137569137570137571137572137573137574137575137576137577137578137579137580137581137582137583137584137585137586137587137588137589137590137591137592137593137594137595137596137597137598137599137600137601137602137603137604137605137606137607137608137609137610137611137612137613137614137615137616137617137618137619137620137621137622137623137624137625137626137627137628137629137630137631137632137633137634137635137636137637137638137639137640137641137642137643137644137645137646137647137648137649137650137651137652137653137654137655137656137657137658137659137660137661137662137663137664137665137666137667137668137669137670137671137672137673137674137675137676137677137678137679137680137681137682137683137684137685137686137687137688137689137690137691137692137693137694137695137696137697137698137699137700137701137702137703137704137705137706137707137708137709137710137711137712137713137714137715137716137717137718137719137720137721137722137723137724137725137726137727137728137729137730137731137732137733137734137735137736137737137738137739137740137741137742137743137744137745137746137747137748137749137750137751137752137753137754137755137756137757137758137759137760137761137762137763137764137765137766137767137768137769137770137771137772137773137774137775137776137777137778137779137780137781137782137783137784137785137786137787137788137789137790137791137792137793137794137795137796137797137798137799137800137801137802137803137804137805137806137807137808137809137810137811137812137813137814137815137816137817137818137819137820137821137822137823137824137825137826137827137828137829137830137831137832137833137834137835137836137837137838137839137840137841137842137843137844137845137846137847137848137849137850137851137852137853137854137855137856137857137858137859137860137861137862137863137864137865137866137867137868137869137870137871137872137873137874137875137876137877137878137879137880137881137882137883137884137885137886137887137888137889137890137891137892137893137894137895137896137897137898137899137900137901137902137903137904137905137906137907137908137909137910137911137912137913137914137915137916137917137918137919137920137921137922137923137924137925137926137927137928137929137930137931137932137933137934137935137936137937137938137939137940137941137942137943137944137945137946137947137948137949137950137951137952137953137954137955137956137957137958137959137960137961137962137963137964137965137966137967137968137969137970137971137972137973137974137975137976137977137978137979137980137981137982137983137984137985137986137987137988137989137990137991137992137993137994137995137996137997137998137999138000138001138002138003138004138005138006138007138008138009138010138011138012138013138014138015138016138017138018138019138020138021138022138023138024138025138026138027138028138029138030138031138032138033138034138035138036138037138038138039138040138041138042138043138044138045138046138047138048138049138050138051138052138053138054138055138056138057138058138059138060138061138062138063138064138065138066138067138068138069138070138071138072138073138074138075138076138077138078138079138080138081138082138083138084138085138086138087138088138089138090138091138092138093138094138095138096138097138098138099138100138101138102138103138104138105138106138107138108138109138110138111138112138113138114138115138116138117138118138119138120138121138122138123138124138125138126138127138128138129138130138131138132138133138134138135138136138137138138138139138140138141138142138143138144138145138146138147138148138149138150138151138152138153138154138155138156138157138158138159138160138161138162138163138164138165138166138167138168138169138170138171138172138173138174138175138176138177138178138179138180138181138182138183138184138185138186138187138188138189138190138191138192138193138194138195138196138197138198138199138200138201138202138203138204138205138206138207138208138209138210138211138212138213138214138215138216138217138218138219138220138221138222138223138224138225138226138227138228138229138230138231138232138233138234138235138236138237138238138239138240138241138242138243138244138245138246138247138248138249138250138251138252138253138254138255138256138257138258138259138260138261138262138263138264138265138266138267138268138269138270138271138272138273138274138275138276138277138278138279138280138281138282138283138284138285138286138287138288138289138290138291138292138293138294138295138296138297138298138299138300138301138302138303138304138305138306138307138308138309138310138311138312138313138314138315138316138317138318138319138320138321138322138323138324138325138326138327138328138329138330138331138332138333138334138335138336138337138338138339138340138341138342138343138344138345138346138347138348138349138350138351138352138353138354138355138356138357138358138359138360138361138362138363138364138365138366138367138368138369138370138371138372138373138374138375138376138377138378138379138380138381138382138383138384138385138386138387138388138389138390138391138392138393138394138395138396138397138398138399138400138401138402138403138404138405138406138407138408138409138410138411138412138413138414138415138416138417138418138419138420138421138422138423138424138425138426138427138428138429138430138431138432138433138434138435138436138437138438138439138440138441138442138443138444138445138446138447138448138449138450138451138452138453138454138455138456138457138458138459138460138461138462138463138464138465138466138467138468138469138470138471138472138473138474138475138476138477138478138479138480138481138482138483138484138485138486138487138488138489138490138491138492138493138494138495138496138497138498138499138500138501138502138503138504138505138506138507138508138509138510138511138512138513138514138515138516138517138518138519138520138521138522138523138524138525138526138527138528138529138530138531138532138533138534138535138536138537138538138539138540138541138542138543138544138545138546138547138548138549138550138551138552138553138554138555138556138557138558138559138560138561138562138563138564138565138566138567138568138569138570138571138572138573138574138575138576138577138578138579138580138581138582138583138584138585138586138587138588138589138590138591138592138593138594138595138596138597138598138599138600138601138602138603138604138605138606138607138608138609138610138611138612138613138614138615138616138617138618138619138620138621138622138623138624138625138626138627138628138629138630138631138632138633138634138635138636138637138638138639138640138641138642138643138644138645138646138647138648138649138650138651138652138653138654138655138656138657138658138659138660138661138662138663138664138665138666138667138668138669138670138671138672138673138674138675138676138677138678138679138680138681138682138683138684138685138686138687138688138689138690138691138692138693138694138695138696138697138698138699138700138701138702138703138704138705138706138707138708138709138710138711138712138713138714138715138716138717138718138719138720138721138722138723138724138725138726138727138728138729138730138731138732138733138734138735138736138737138738138739138740138741138742138743138744138745138746138747138748138749138750138751138752138753138754138755138756138757138758138759138760138761138762138763138764138765138766138767138768138769138770138771138772138773138774138775138776138777138778138779138780138781138782138783138784138785138786138787138788138789138790138791138792138793138794138795138796138797138798138799138800138801138802138803138804138805138806138807138808138809138810138811138812138813138814138815138816138817138818138819138820138821138822138823138824138825138826138827138828138829138830138831138832138833138834138835138836138837138838138839138840138841138842138843138844138845138846138847138848138849138850138851138852138853138854138855138856138857138858138859138860138861138862138863138864138865138866138867138868138869138870138871138872138873138874138875138876138877138878138879138880138881138882138883138884138885138886138887138888138889138890138891138892138893138894138895138896138897138898138899138900138901138902138903138904138905138906138907138908138909138910138911138912138913138914138915138916138917138918138919138920138921138922138923138924138925138926138927138928138929138930138931138932138933138934138935138936138937138938138939138940138941138942138943138944138945138946138947138948138949138950138951138952138953138954138955138956138957138958138959138960138961138962138963138964138965138966138967138968138969138970138971138972138973138974138975138976138977138978138979138980138981138982138983138984138985138986138987138988138989138990138991138992138993138994138995138996138997138998138999139000139001139002139003139004139005139006139007139008139009139010139011139012139013139014139015139016139017139018139019139020139021139022139023139024139025139026139027139028139029139030139031139032139033139034139035139036139037139038139039139040139041139042139043139044139045139046139047139048139049139050139051139052139053139054139055139056139057139058139059139060139061139062139063139064139065139066139067139068139069139070139071139072139073139074139075139076139077139078139079139080139081139082139083139084139085139086139087139088139089139090139091139092139093139094139095139096139097139098139099139100139101139102139103139104139105139106139107139108139109139110139111139112139113139114139115139116139117139118139119139120139121139122139123139124139125139126139127139128139129139130139131139132139133139134139135139136139137139138139139139140139141139142139143139144139145139146139147139148139149139150139151139152139153139154139155139156139157139158139159139160139161139162139163139164139165139166139167139168139169139170139171139172139173139174139175139176139177139178139179139180139181139182139183139184139185139186139187139188139189139190139191139192139193139194139195139196139197139198139199139200139201139202139203139204139205139206139207139208139209139210139211139212139213139214139215139216139217139218139219139220139221139222139223139224139225139226139227139228139229139230139231139232139233139234139235139236139237139238139239139240139241139242139243139244139245139246139247139248139249139250139251139252139253139254139255139256139257139258139259139260139261139262139263139264139265139266139267139268139269139270139271139272139273139274139275139276139277139278139279139280139281139282139283139284139285139286139287139288139289139290139291139292139293139294139295139296139297139298139299139300139301139302139303139304139305139306139307139308139309139310139311139312139313139314139315139316139317139318139319139320139321139322139323139324139325139326139327139328139329139330139331139332139333139334139335139336139337139338139339139340139341139342139343139344139345139346139347139348139349139350139351139352139353139354139355139356139357139358139359139360139361139362139363139364139365139366139367139368139369139370139371139372139373139374139375139376139377139378139379139380139381139382139383139384139385139386139387139388139389139390139391139392139393139394139395139396139397139398139399139400139401139402139403139404139405139406139407139408139409139410139411139412139413139414139415139416139417139418139419139420139421139422139423139424139425139426139427139428139429139430139431139432139433139434139435139436139437139438139439139440139441139442139443139444139445139446139447139448139449139450139451139452139453139454139455139456139457139458139459139460139461139462139463139464139465139466139467139468139469139470139471139472139473139474139475139476139477139478139479139480139481139482139483139484139485139486139487139488139489139490139491139492139493139494139495139496139497139498139499139500139501139502139503139504139505139506139507139508139509139510139511139512139513139514139515139516139517139518139519139520139521139522139523139524139525139526139527139528139529139530139531139532139533139534139535139536139537139538139539139540139541139542139543139544139545139546139547139548139549139550139551139552139553139554139555139556139557139558139559139560139561139562139563139564139565139566139567139568139569139570139571139572139573139574139575139576139577139578139579139580139581139582139583139584139585139586139587139588139589139590139591139592139593139594139595139596139597139598139599139600139601139602139603139604139605139606139607139608139609139610139611139612139613139614139615139616139617139618139619139620139621139622139623139624139625139626139627139628139629139630139631139632139633139634139635139636139637139638139639139640139641139642139643139644139645139646139647139648139649139650139651139652139653139654139655139656139657139658139659139660139661139662139663139664139665139666139667139668139669139670139671139672139673139674139675139676139677139678139679139680139681139682139683139684139685139686139687139688139689139690139691139692139693139694139695139696139697139698139699139700139701139702139703139704139705139706139707139708139709139710139711139712139713139714139715139716139717139718139719139720139721139722139723139724139725139726139727139728139729139730139731139732139733139734139735139736139737139738139739139740139741139742139743139744139745139746139747139748139749139750139751139752139753139754139755139756139757139758139759139760139761139762139763139764139765139766139767139768139769139770139771139772139773139774139775139776139777139778139779139780139781139782139783139784139785139786139787139788139789139790139791139792139793139794139795139796139797139798139799139800139801139802139803139804139805139806139807139808139809139810139811139812139813139814139815139816139817139818139819139820139821139822139823139824139825139826139827139828139829139830139831139832139833139834139835139836139837139838139839139840139841139842139843139844139845139846139847139848139849139850139851139852139853139854139855139856139857139858139859139860139861139862139863139864139865139866139867139868139869139870139871139872139873139874139875139876139877139878139879139880139881139882139883139884139885139886139887139888139889139890139891139892139893139894139895139896139897139898139899139900139901139902139903139904139905139906139907139908139909139910139911139912139913139914139915139916139917139918139919139920139921139922139923139924139925139926139927139928139929139930139931139932139933139934139935139936139937139938139939139940139941139942139943139944139945139946139947139948139949139950139951139952139953139954139955139956139957139958139959139960139961139962139963139964139965139966139967139968139969139970139971139972139973139974139975139976139977139978139979139980139981139982139983139984139985139986139987139988139989139990139991139992139993139994139995139996139997139998139999140000140001140002140003140004140005140006140007140008140009140010140011140012140013140014140015140016140017140018140019140020140021140022140023140024140025140026140027140028140029140030140031140032140033140034140035140036140037140038140039140040140041140042140043140044140045140046140047140048140049140050140051140052140053140054140055140056140057140058140059140060140061140062140063140064140065140066140067140068140069140070140071140072140073140074140075140076140077140078140079140080140081140082140083140084140085140086140087140088140089140090140091140092140093140094140095140096140097140098140099140100140101140102140103140104140105140106140107140108140109140110140111140112140113140114140115140116140117140118140119140120140121140122140123140124140125140126140127140128140129140130140131140132140133140134140135140136140137140138140139140140140141140142140143140144140145140146140147140148140149140150140151140152140153140154140155140156140157140158140159140160140161140162140163140164140165140166140167140168140169140170140171140172140173140174140175140176140177140178140179140180140181140182140183140184140185140186140187140188140189140190140191140192140193140194140195140196140197140198140199140200140201140202140203140204140205140206140207140208140209140210140211140212140213140214140215140216140217140218140219140220140221140222140223140224140225140226140227140228140229140230140231140232140233140234140235140236140237140238140239140240140241140242140243140244140245140246140247140248140249140250140251140252140253140254140255140256140257140258140259140260140261140262140263140264140265140266140267140268140269140270140271140272140273140274140275140276140277140278140279140280140281140282140283140284140285140286140287140288140289140290140291140292140293140294140295140296140297140298140299140300140301140302140303140304140305140306140307140308140309140310140311140312140313140314140315140316140317140318140319140320140321140322140323140324140325140326140327140328140329140330140331140332140333140334140335140336140337140338140339140340140341140342140343140344140345140346140347140348140349140350140351140352140353140354140355140356140357140358140359140360140361140362140363140364140365140366140367140368140369140370140371140372140373140374140375140376140377140378140379140380140381140382140383140384140385140386140387140388140389140390140391140392140393140394140395140396140397140398140399140400140401140402140403140404140405140406140407140408140409140410140411140412140413140414140415140416140417140418140419140420140421140422140423140424140425140426140427140428140429140430140431140432140433140434140435140436140437140438140439140440140441140442140443140444140445140446140447140448140449140450140451140452140453140454140455140456140457140458140459140460140461140462140463140464140465140466140467140468140469140470140471140472140473140474140475140476140477140478140479140480140481140482140483140484140485140486140487140488140489140490140491140492140493140494140495140496140497140498140499140500140501140502140503140504140505140506140507140508140509140510140511140512140513140514140515140516140517140518140519140520140521140522140523140524140525140526140527140528140529140530140531140532140533140534140535140536140537140538140539140540140541140542140543140544140545140546140547140548140549140550140551140552140553140554140555140556140557140558140559140560140561140562140563140564140565140566140567140568140569140570140571140572140573140574140575140576140577140578140579140580140581140582140583140584140585140586140587140588140589140590140591140592140593140594140595140596140597140598140599140600140601140602140603140604140605140606140607140608140609140610140611140612140613140614140615140616140617140618140619140620140621140622140623140624140625140626140627140628140629140630140631140632140633140634140635140636140637140638140639140640140641140642140643140644140645140646140647140648140649140650140651140652140653140654140655140656140657140658140659140660140661140662140663140664140665140666140667140668140669140670140671140672140673140674140675140676140677140678140679140680140681140682140683140684140685140686140687140688140689140690140691140692140693140694140695140696140697140698140699140700140701140702140703140704140705140706140707140708140709140710140711140712140713140714140715140716140717140718140719140720140721140722140723140724140725140726140727140728140729140730140731140732140733140734140735140736140737140738140739140740140741140742140743140744140745140746140747140748140749140750140751140752140753140754140755140756140757140758140759140760140761140762140763140764140765140766140767140768140769140770140771140772140773140774140775140776140777140778140779140780140781140782140783140784140785140786140787140788140789140790140791140792140793140794140795140796140797140798140799140800140801140802140803140804140805140806140807140808140809140810140811140812140813140814140815140816140817140818140819140820140821140822140823140824140825140826140827140828140829140830140831140832140833140834140835140836140837140838140839140840140841140842140843140844140845140846140847140848140849140850140851140852140853140854140855140856140857140858140859140860140861140862140863140864140865140866140867140868140869140870140871140872140873140874140875140876140877140878140879140880140881140882140883140884140885140886140887140888140889140890140891140892140893140894140895140896140897140898140899140900140901140902140903140904140905140906140907140908140909140910140911140912140913140914140915140916140917140918140919140920140921140922140923140924140925140926140927140928140929140930140931140932140933140934140935140936140937140938140939140940140941140942140943140944140945140946140947140948140949140950140951140952140953140954140955140956140957140958140959140960140961140962140963140964140965140966140967140968140969140970140971140972140973140974140975140976140977140978140979140980140981140982140983140984140985140986140987140988140989140990140991140992140993140994140995140996140997140998140999141000141001141002141003141004141005141006141007141008141009141010141011141012141013141014141015141016141017141018141019141020141021141022141023141024141025141026141027141028141029141030141031141032141033141034141035141036141037141038141039141040141041141042141043141044141045141046141047141048141049141050141051141052141053141054141055141056141057141058141059141060141061141062141063141064141065141066141067141068141069141070141071141072141073141074141075141076141077141078141079141080141081141082141083141084141085141086141087141088141089141090141091141092141093141094141095141096141097141098141099141100141101141102141103141104141105141106141107141108141109141110141111141112141113141114141115141116141117141118141119141120141121141122141123141124141125141126141127141128141129141130141131141132141133141134141135141136141137141138141139141140141141141142141143141144141145141146141147141148141149141150141151141152141153141154141155141156141157141158141159141160141161141162141163141164141165141166141167141168141169141170141171141172141173141174141175141176141177141178141179141180141181141182141183141184141185141186141187141188141189141190141191141192141193141194141195141196141197141198141199141200141201141202141203141204141205141206141207141208141209141210141211141212141213141214141215141216141217141218141219141220141221141222141223141224141225141226141227141228141229141230141231141232141233141234141235141236141237141238141239141240141241141242141243141244141245141246141247141248141249141250141251141252141253141254141255141256141257141258141259141260141261141262141263141264141265141266141267141268141269141270141271141272141273141274141275141276141277141278141279141280141281141282141283141284141285141286141287141288141289141290141291141292141293141294141295141296141297141298141299141300141301141302141303141304141305141306141307141308141309141310141311141312141313141314141315141316141317141318141319141320141321141322141323141324141325141326141327141328141329141330141331141332141333141334141335141336141337141338141339141340141341141342141343141344141345141346141347141348141349141350141351141352141353141354141355141356141357141358141359141360141361141362141363141364141365141366141367141368141369141370141371141372141373141374141375141376141377141378141379141380141381141382141383141384141385141386141387141388141389141390141391141392141393141394141395141396141397141398141399141400141401141402141403141404141405141406141407141408141409141410141411141412141413141414141415141416141417141418141419141420141421141422141423141424141425141426141427141428141429141430141431141432141433141434141435141436141437141438141439141440141441141442141443141444141445141446141447141448141449141450141451141452141453141454141455141456141457141458141459141460141461141462141463141464141465141466141467141468141469141470141471141472141473141474141475141476141477141478141479141480141481141482141483141484141485141486141487141488141489141490141491141492141493141494141495141496141497141498141499141500141501141502141503141504141505141506141507141508141509141510141511141512141513141514141515141516141517141518141519141520141521141522141523141524141525141526141527141528141529141530141531141532141533141534141535141536141537141538141539141540141541141542141543141544141545141546141547141548141549141550141551141552141553141554141555141556141557141558141559141560141561141562141563141564141565141566141567141568141569141570141571141572141573141574141575141576141577141578141579141580141581141582141583141584141585141586141587141588141589141590141591141592141593141594141595141596141597141598141599141600141601141602141603141604141605141606141607141608141609141610141611141612141613141614141615141616141617141618141619141620141621141622141623141624141625141626141627141628141629141630141631141632141633141634141635141636141637141638141639141640141641141642141643141644141645141646141647141648141649141650141651141652141653141654141655141656141657141658141659141660141661141662141663141664141665141666141667141668141669141670141671141672141673141674141675141676141677141678141679141680141681141682141683141684141685141686141687141688141689141690141691141692141693141694141695141696141697141698141699141700141701141702141703141704141705141706141707141708141709141710141711141712141713141714141715141716141717141718141719141720141721141722141723141724141725141726141727141728141729141730141731141732141733141734141735141736141737141738141739141740141741141742141743141744141745141746141747141748141749141750141751141752141753141754141755141756141757141758141759141760141761141762141763141764141765141766141767141768141769141770141771141772141773141774141775141776141777141778141779141780141781141782141783141784141785141786141787141788141789141790141791141792141793141794141795141796141797141798141799141800141801141802141803141804141805141806141807141808141809141810141811141812141813141814141815141816141817141818141819141820141821141822141823141824141825141826141827141828141829141830141831141832141833141834141835141836141837141838141839141840141841141842141843141844141845141846141847141848141849141850141851141852141853141854141855141856141857141858141859141860141861141862141863141864141865141866141867141868141869141870141871141872141873141874141875141876141877141878141879141880141881141882141883141884141885141886141887141888141889141890141891141892141893141894141895141896141897141898141899141900141901141902141903141904141905141906141907141908141909141910141911141912141913141914141915141916141917141918141919141920141921141922141923141924141925141926141927141928141929141930141931141932141933141934141935141936141937141938141939141940141941141942141943141944141945141946141947141948141949141950141951141952141953141954141955141956141957141958141959141960141961141962141963141964141965141966141967141968141969141970141971141972141973141974141975141976141977141978141979141980141981141982141983141984141985141986141987141988141989141990141991141992141993141994141995141996141997141998141999142000142001142002142003142004142005142006142007142008142009142010142011142012142013142014142015142016142017142018142019142020142021142022142023142024142025142026142027142028142029142030142031142032142033142034142035142036142037142038142039142040142041142042142043142044142045142046142047142048142049142050142051142052142053142054142055142056142057142058142059142060142061142062142063142064142065142066142067142068142069142070142071142072142073142074142075142076142077142078142079142080142081142082142083142084142085142086142087142088142089142090142091142092142093142094142095142096142097142098142099142100142101142102142103142104142105142106142107142108142109142110142111142112142113142114142115142116142117142118142119142120142121142122142123142124142125142126142127142128142129142130142131142132142133142134142135142136142137142138142139142140142141142142142143142144142145142146142147142148142149142150142151142152142153142154142155142156142157142158142159142160142161142162142163142164142165142166142167142168142169142170142171142172142173142174142175142176142177142178142179142180142181142182142183142184142185142186142187142188142189142190142191142192142193142194142195142196142197142198142199142200142201142202142203142204142205142206142207142208142209142210142211142212142213142214142215142216142217142218142219142220142221142222142223142224142225142226142227142228142229142230142231142232142233142234142235142236142237142238142239142240142241142242142243142244142245142246142247142248142249142250142251142252142253142254142255142256142257142258142259142260142261142262142263142264142265142266142267142268142269142270142271142272142273142274142275142276142277142278142279142280142281142282142283142284142285142286142287142288142289142290142291142292142293142294142295142296142297142298142299142300142301142302142303142304142305142306142307142308142309142310142311142312142313142314142315142316142317142318142319142320142321142322142323142324142325142326142327142328142329142330142331142332142333142334142335142336142337142338142339142340142341142342142343142344142345142346142347142348142349142350142351142352142353142354142355142356142357142358142359142360142361142362142363142364142365142366142367142368142369142370142371142372142373142374142375142376142377142378142379142380142381142382142383142384142385142386142387142388142389142390142391142392142393142394142395142396142397142398142399142400142401142402142403142404142405142406142407142408142409142410142411142412142413142414142415142416142417142418142419142420142421142422142423142424142425142426142427142428142429142430142431142432142433142434142435142436142437142438142439142440142441142442142443142444142445142446142447142448142449142450142451142452142453142454142455142456142457142458142459142460142461142462142463142464142465142466142467142468142469142470142471142472142473142474142475142476142477142478142479142480142481142482142483142484142485142486142487142488142489142490142491142492142493142494142495142496142497142498142499142500142501142502142503142504142505142506142507142508142509142510142511142512142513142514142515142516142517142518142519142520142521142522142523142524142525142526142527142528142529142530142531142532142533142534142535142536142537142538142539142540142541142542142543142544142545142546142547142548142549142550142551142552142553142554142555142556142557142558142559142560142561142562142563142564142565142566142567142568142569142570142571142572142573142574142575142576142577142578142579142580142581142582142583142584142585142586142587142588142589142590142591142592142593142594142595142596142597142598142599142600142601142602142603142604142605142606142607142608142609142610142611142612142613142614142615142616142617142618142619142620142621142622142623142624142625142626142627142628142629142630142631142632142633142634142635142636142637142638142639142640142641142642142643142644142645142646142647142648142649142650142651142652142653142654142655142656142657142658142659142660142661142662142663142664142665142666142667142668142669142670142671142672142673142674142675142676142677142678142679142680142681142682142683142684142685142686142687142688142689142690142691142692142693142694142695142696142697142698142699142700142701142702142703142704142705142706142707142708142709142710142711142712142713142714142715142716142717142718142719142720142721142722142723142724142725142726142727142728142729142730142731142732142733142734142735142736142737142738142739142740142741142742142743142744142745142746142747142748142749142750142751142752142753142754142755142756142757142758142759142760142761142762142763142764142765142766142767142768142769142770142771142772142773142774142775142776142777142778142779142780142781142782142783142784142785142786142787142788142789142790142791142792142793142794142795142796142797142798142799142800142801142802142803142804142805142806142807142808142809142810142811142812142813142814142815142816142817142818142819142820142821142822142823142824142825142826142827142828142829142830142831142832142833142834142835142836142837142838142839142840142841142842142843142844142845142846142847142848142849142850142851142852142853142854142855142856142857142858142859142860142861142862142863142864142865142866142867142868142869142870142871142872142873142874142875142876142877142878142879142880142881142882142883142884142885142886142887142888142889142890142891142892142893142894142895142896142897142898142899142900142901142902142903142904142905142906142907142908142909142910142911142912142913142914142915142916142917142918142919142920142921142922142923142924142925142926142927142928142929142930142931142932142933142934142935142936142937142938142939142940142941142942142943142944142945142946142947142948142949142950142951142952142953142954142955142956142957142958142959142960142961142962142963142964142965142966142967142968142969142970142971142972142973142974142975142976142977142978142979142980142981142982142983142984142985142986142987142988142989142990142991142992142993142994142995142996142997142998142999143000143001143002143003143004143005143006143007143008143009143010143011143012143013143014143015143016143017143018143019143020143021143022143023143024143025143026143027143028143029143030143031143032143033143034143035143036143037143038143039143040143041143042143043143044143045143046143047143048143049143050143051143052143053143054143055143056143057143058143059143060143061143062143063143064143065143066143067143068143069143070143071143072143073143074143075143076143077143078143079143080143081143082143083143084143085143086143087143088143089143090143091143092143093143094143095143096143097143098143099143100143101143102143103143104143105143106143107143108143109143110143111143112143113143114143115143116143117143118143119143120143121143122143123143124143125143126143127143128143129143130143131143132143133143134143135143136143137143138143139143140143141143142143143143144143145143146143147143148143149143150143151143152143153143154143155143156143157143158143159143160143161143162143163143164143165143166143167143168143169143170143171143172143173143174143175143176143177143178143179143180143181143182143183143184143185143186143187143188143189143190143191143192143193143194143195143196143197143198143199143200143201143202143203143204143205143206143207143208143209143210143211143212143213143214143215143216143217143218143219143220143221143222143223143224143225143226143227143228143229143230143231143232143233143234143235143236143237143238143239143240143241143242143243143244143245143246143247143248143249143250143251143252143253143254143255143256143257143258143259143260143261143262143263143264143265143266143267143268143269143270143271143272143273143274143275143276143277143278143279143280143281143282143283143284143285143286143287143288143289143290143291143292143293143294143295143296143297143298143299143300143301143302143303143304143305143306143307143308143309143310143311143312143313143314143315143316143317143318143319143320143321143322143323143324143325143326143327143328143329143330143331143332143333143334143335143336143337143338143339143340143341143342143343143344143345143346143347143348143349143350143351143352143353143354143355143356143357143358143359143360143361143362143363143364143365143366143367143368143369143370143371143372143373143374143375143376143377143378143379143380143381143382143383143384143385143386143387143388143389143390143391143392143393143394143395143396143397143398143399143400143401143402143403143404143405143406143407143408143409143410143411143412143413143414143415143416143417143418143419143420143421143422143423143424143425143426143427143428143429143430143431143432143433143434143435143436143437143438143439143440143441143442143443143444143445143446143447143448143449143450143451143452143453143454143455143456143457143458143459143460143461143462143463143464143465143466143467143468143469143470143471143472143473143474143475143476143477143478143479143480143481143482143483143484143485143486143487143488143489143490143491143492143493143494143495143496143497143498143499143500143501143502143503143504143505143506143507143508143509143510143511143512143513143514143515143516143517143518143519143520143521143522143523143524143525143526143527143528143529143530143531143532143533143534143535143536143537143538143539143540143541143542143543143544143545143546143547143548143549143550143551143552143553143554143555143556143557143558143559143560143561143562143563143564143565143566143567143568143569143570143571143572143573143574143575143576143577143578143579143580143581143582143583143584143585143586143587143588143589143590143591143592143593143594143595143596143597143598143599143600143601143602143603143604143605143606143607143608143609143610143611143612143613143614143615143616143617143618143619143620143621143622143623143624143625143626143627143628143629143630143631143632143633143634143635143636143637143638143639143640143641143642143643143644143645143646143647143648143649143650143651143652143653143654143655143656143657143658143659143660143661143662143663143664143665143666143667143668143669143670143671143672143673143674143675143676143677143678143679143680143681143682143683143684143685143686143687143688143689143690143691143692143693143694143695143696143697143698143699143700143701143702143703143704143705143706143707143708143709143710143711143712143713143714143715143716143717143718143719143720143721143722143723143724143725143726143727143728143729143730143731143732143733143734143735143736143737143738143739143740143741143742143743143744143745143746143747143748143749143750143751143752143753143754143755143756143757143758143759143760143761143762143763143764143765143766143767143768143769143770143771143772143773143774143775143776143777143778143779143780143781143782143783143784143785143786143787143788143789143790143791143792143793143794143795143796143797143798143799143800143801143802143803143804143805143806143807143808143809143810143811143812143813143814143815143816143817143818143819143820143821143822143823143824143825143826143827143828143829143830143831143832143833143834143835143836143837143838143839143840143841143842143843143844143845143846143847143848143849143850143851143852143853143854143855143856143857143858143859143860143861143862143863143864143865143866143867143868143869143870143871143872143873143874143875143876143877143878143879143880143881143882143883143884143885143886143887143888143889143890143891143892143893143894143895143896143897143898143899143900143901143902143903143904143905143906143907143908143909143910143911143912143913143914143915143916143917143918143919143920143921143922143923143924143925143926143927143928143929143930143931143932143933143934143935143936143937143938143939143940143941143942143943143944143945143946143947143948143949143950143951143952143953143954143955143956143957143958143959143960143961143962143963143964143965143966143967143968143969143970143971143972143973143974143975143976143977143978143979143980143981143982143983143984143985143986143987143988143989143990143991143992143993143994143995143996143997143998143999144000144001144002144003144004144005144006144007144008144009144010144011144012144013144014144015144016144017144018144019144020144021144022144023144024144025144026144027144028144029144030144031144032144033144034144035144036144037144038144039144040144041144042144043144044144045144046144047144048144049144050144051144052144053144054144055144056144057144058144059144060144061144062144063144064144065144066144067144068144069144070144071144072144073144074144075144076144077144078144079144080144081144082144083144084144085144086144087144088144089144090144091144092144093144094144095144096144097144098144099144100144101144102144103144104144105144106144107144108144109144110144111144112144113144114144115144116144117144118144119144120144121144122144123144124144125144126144127144128144129144130144131144132144133144134144135144136144137144138144139144140144141144142144143144144144145144146144147144148144149144150144151144152144153144154144155144156144157144158144159144160144161144162144163144164144165144166144167144168144169144170144171144172144173144174144175144176144177144178144179144180144181144182144183144184144185144186144187144188144189144190144191144192144193144194144195144196144197144198144199144200144201144202144203144204144205144206144207144208144209144210144211144212144213144214144215144216144217144218144219144220144221144222144223144224144225144226144227144228144229144230144231144232144233144234144235144236144237144238144239144240144241144242144243144244144245144246144247144248144249144250144251144252144253144254144255144256144257144258144259144260144261144262144263144264144265144266144267144268144269144270144271144272144273144274144275144276144277144278144279144280144281144282144283144284144285144286144287144288144289144290144291144292144293144294144295144296144297144298144299144300144301144302144303144304144305144306144307144308144309144310144311144312144313144314144315144316144317144318144319144320144321144322144323144324144325144326144327144328144329144330144331144332144333144334144335144336144337144338144339144340144341144342144343144344144345144346144347144348144349144350144351144352144353144354144355144356144357144358144359144360144361144362144363144364144365144366144367144368144369144370144371144372144373144374144375144376144377144378144379144380144381144382144383144384144385144386144387144388144389144390144391144392144393144394144395144396144397144398144399144400144401144402144403144404144405144406144407144408144409144410144411144412144413144414144415144416144417144418144419144420144421144422144423144424144425144426144427144428144429144430144431144432144433144434144435144436144437144438144439144440144441144442144443144444144445144446144447144448144449144450144451144452144453144454144455144456144457144458144459144460144461144462144463144464144465144466144467144468144469144470144471144472144473144474144475144476144477144478144479144480144481144482144483144484144485144486144487144488144489144490144491144492144493144494144495144496144497144498144499144500144501144502144503144504144505144506144507144508144509144510144511144512144513144514144515144516144517144518144519144520144521144522144523144524144525144526144527144528144529144530144531144532144533144534144535144536144537144538144539144540144541144542144543144544144545144546144547144548144549144550144551144552144553144554144555144556144557144558144559144560144561144562144563144564144565144566144567144568144569144570144571144572144573144574144575144576144577144578144579144580144581144582144583144584144585144586144587144588144589144590144591144592144593144594144595144596144597144598144599144600144601144602144603144604144605144606144607144608144609144610144611144612144613144614144615144616144617144618144619144620144621144622144623144624144625144626144627144628144629144630144631144632144633144634144635144636144637144638144639144640144641144642144643144644144645144646144647144648144649144650144651144652144653144654144655144656144657144658144659144660144661144662144663144664144665144666144667144668144669144670144671144672144673144674144675144676144677144678144679144680144681144682144683144684144685144686144687144688144689144690144691144692144693144694144695144696144697144698144699144700144701144702144703144704144705144706144707144708144709144710144711144712144713144714144715144716144717144718144719144720144721144722144723144724144725144726144727144728144729144730144731144732144733144734144735144736144737144738144739144740144741144742144743144744144745144746144747144748144749144750144751144752144753144754144755144756144757144758144759144760144761144762144763144764144765144766144767144768144769144770144771144772144773144774144775144776144777144778144779144780144781144782144783144784144785144786144787144788144789144790144791144792144793144794144795144796144797144798144799144800144801144802144803144804144805144806144807144808144809144810144811144812144813144814144815144816144817144818144819144820144821144822144823144824144825144826144827144828144829144830144831144832144833144834144835144836144837144838144839144840144841144842144843144844144845144846144847144848144849144850144851144852144853144854144855144856144857144858144859144860144861144862144863144864144865144866144867144868144869144870144871144872144873144874144875144876144877144878144879144880144881144882144883144884144885144886144887144888144889144890144891144892144893144894144895144896144897144898144899144900144901144902144903144904144905144906144907144908144909144910144911144912144913144914144915144916144917144918144919144920144921144922144923144924144925144926144927144928144929144930144931144932144933144934144935144936144937144938144939144940144941144942144943144944144945144946144947144948144949144950144951144952144953144954144955144956144957144958144959144960144961144962144963144964144965144966144967144968144969144970144971144972144973144974144975144976144977144978144979144980144981144982144983144984144985144986144987144988144989144990144991144992144993144994144995144996144997144998144999145000145001145002145003145004145005145006145007145008145009145010145011145012145013145014145015145016145017145018145019145020145021145022145023145024145025145026145027145028145029145030145031145032145033145034145035145036145037145038145039145040145041145042145043145044145045145046145047145048145049145050145051145052145053145054145055145056145057145058145059145060145061145062145063145064145065145066145067145068145069145070145071145072145073145074145075145076145077145078145079145080145081145082145083145084145085145086145087145088145089145090145091145092145093145094145095145096145097145098145099145100145101145102145103145104145105145106145107145108145109145110145111145112145113145114145115145116145117145118145119145120145121145122145123145124145125145126145127145128145129145130145131145132145133145134145135145136145137145138145139145140145141145142145143145144145145145146145147145148145149145150145151145152145153145154145155145156145157145158145159145160145161145162145163145164145165145166145167145168145169145170145171145172145173145174145175145176145177145178145179145180145181145182145183145184145185145186145187145188145189145190145191145192145193145194145195145196145197145198145199145200145201145202145203145204145205145206145207145208145209145210145211145212145213145214145215145216145217145218145219145220145221145222145223145224145225145226145227145228145229145230145231145232145233145234145235145236145237145238145239145240145241145242145243145244145245145246145247145248145249145250145251145252145253145254145255145256145257145258145259145260145261145262145263145264145265145266145267145268145269145270145271145272145273145274145275145276145277145278145279145280145281145282145283145284145285145286145287145288145289145290145291145292145293145294145295145296145297145298145299145300145301145302145303145304145305145306145307145308145309145310145311145312145313145314145315145316145317145318145319145320145321145322145323145324145325145326145327145328145329145330145331145332145333145334145335145336145337145338145339145340145341145342145343145344145345145346145347145348145349145350145351145352145353145354145355145356145357145358145359145360145361145362145363145364145365145366145367145368145369145370145371145372145373145374145375145376145377145378145379145380145381145382145383145384145385145386145387145388145389145390145391145392145393145394145395145396145397145398145399145400145401145402145403145404145405145406145407145408145409145410145411145412145413145414145415145416145417145418145419145420145421145422145423145424145425145426145427145428145429145430145431145432145433145434145435145436145437145438145439145440145441145442145443145444145445145446145447145448145449145450145451145452145453145454145455145456145457145458145459145460145461145462145463145464145465145466145467145468145469145470145471145472145473145474145475145476145477145478145479145480145481145482145483145484145485145486145487145488145489145490145491145492145493145494145495145496145497145498145499145500145501145502145503145504145505145506145507145508145509145510145511145512145513145514145515145516145517145518145519145520145521145522145523145524145525145526145527145528145529145530145531145532145533145534145535145536145537145538145539145540145541145542145543145544145545145546145547145548145549145550145551145552145553145554145555145556145557145558145559145560145561145562145563145564145565145566145567145568145569145570145571145572145573145574145575145576145577145578145579145580145581145582145583145584145585145586145587145588145589145590145591145592145593145594145595145596145597145598145599145600145601145602145603145604145605145606145607145608145609145610145611145612145613145614145615145616145617145618145619145620145621145622145623145624145625145626145627145628145629145630145631145632145633145634145635145636145637145638145639145640145641145642145643145644145645145646145647145648145649145650145651145652145653145654145655145656145657145658145659145660145661145662145663145664145665145666145667145668145669145670145671145672145673145674145675145676145677145678145679145680145681145682145683145684145685145686145687145688145689145690145691145692145693145694145695145696145697145698145699145700145701145702145703145704145705145706145707145708145709145710145711145712145713145714145715145716145717145718145719145720145721145722145723145724145725145726145727145728145729145730145731145732145733145734145735145736145737145738145739145740145741145742145743145744145745145746145747145748145749145750145751145752145753145754145755145756145757145758145759145760145761145762145763145764145765145766145767145768145769145770145771145772145773145774145775145776145777145778145779145780145781145782145783145784145785145786145787145788145789145790145791145792145793145794145795145796145797145798145799145800145801145802145803145804145805145806145807145808145809145810145811145812145813145814145815145816145817145818145819145820145821145822145823145824145825145826145827145828145829145830145831145832145833145834145835145836145837145838145839145840145841145842145843145844145845145846145847145848145849145850145851145852145853145854145855145856145857145858145859145860145861145862145863145864145865145866145867145868145869145870145871145872145873145874145875145876145877145878145879145880145881145882145883145884145885145886145887145888145889145890145891145892145893145894145895145896145897145898145899145900145901145902145903145904145905145906145907145908145909145910145911145912145913145914145915145916145917145918145919145920145921145922145923145924145925145926145927145928145929145930145931145932145933145934145935145936145937145938145939145940145941145942145943145944145945145946145947145948145949145950145951145952145953145954145955145956145957145958145959145960145961145962145963145964145965145966145967145968145969145970145971145972145973145974145975145976145977145978145979145980145981145982145983145984145985145986145987145988145989145990145991145992145993145994145995145996145997145998145999146000146001146002146003146004146005146006146007146008146009146010146011146012146013146014146015146016146017146018146019146020146021146022146023146024146025146026146027146028146029146030146031146032146033146034146035146036146037146038146039146040146041146042146043146044146045146046146047146048146049146050146051146052146053146054146055146056146057146058146059146060146061146062146063146064146065146066146067146068146069146070146071146072146073146074146075146076146077146078146079146080146081146082146083146084146085146086146087146088146089146090146091146092146093146094146095146096146097146098146099146100146101146102146103146104146105146106146107146108146109146110146111146112146113146114146115146116146117146118146119146120146121146122146123146124146125146126146127146128146129146130146131146132146133146134146135146136146137146138146139146140146141146142146143146144146145146146146147146148146149146150146151146152146153146154146155146156146157146158146159146160146161146162146163146164146165146166146167146168146169146170146171146172146173146174146175146176146177146178146179146180146181146182146183146184146185146186146187146188146189146190146191146192146193146194146195146196146197146198146199146200146201146202146203146204146205146206146207146208146209146210146211146212146213146214146215146216146217146218146219146220146221146222146223146224146225146226146227146228146229146230146231146232146233146234146235146236146237146238146239146240146241146242146243146244146245146246146247146248146249146250146251146252146253146254146255146256146257146258146259146260146261146262146263146264146265146266146267146268146269146270146271146272146273146274146275146276146277146278146279146280146281146282146283146284146285146286146287146288146289146290146291146292146293146294146295146296146297146298146299146300146301146302146303146304146305146306146307146308146309146310146311146312146313146314146315146316146317146318146319146320146321146322146323146324146325146326146327146328146329146330146331146332146333146334146335146336146337146338146339146340146341146342146343146344146345146346146347146348146349146350146351146352146353146354146355146356146357146358146359146360146361146362146363146364146365146366146367146368146369146370146371146372146373146374146375146376146377146378146379146380146381146382146383146384146385146386146387146388146389146390146391146392146393146394146395146396146397146398146399146400146401146402146403146404146405146406146407146408146409146410146411146412146413146414146415146416146417146418146419146420146421146422146423146424146425146426146427146428146429146430146431146432146433146434146435146436146437146438146439146440146441146442146443146444146445146446146447146448146449146450146451146452146453146454146455146456146457146458146459146460146461146462146463146464146465146466146467146468146469146470146471146472146473146474146475146476146477146478146479146480146481146482146483146484146485146486146487146488146489146490146491146492146493146494146495146496146497146498146499146500146501146502146503146504146505146506146507146508146509146510146511146512146513146514146515146516146517146518146519146520146521146522146523146524146525146526146527146528146529146530146531146532146533146534146535146536146537146538146539146540146541146542146543146544146545146546146547146548146549146550146551146552146553146554146555146556146557146558146559146560146561146562146563146564146565146566146567146568146569146570146571146572146573146574146575146576146577146578146579146580146581146582146583146584146585146586146587146588146589146590146591146592146593146594146595146596146597146598146599146600146601146602146603146604146605146606146607146608146609146610146611146612146613146614146615146616146617146618146619146620146621146622146623146624146625146626146627146628146629146630146631146632146633146634146635146636146637146638146639146640146641146642146643146644146645146646146647146648146649146650146651146652146653146654146655146656146657146658146659146660146661146662146663146664146665146666146667146668146669146670146671146672146673146674146675146676146677146678146679146680146681146682146683146684146685146686146687146688146689146690146691146692146693146694146695146696146697146698146699146700146701146702146703146704146705146706146707146708146709146710146711146712146713146714146715146716146717146718146719146720146721146722146723146724146725146726146727146728146729146730146731146732146733146734146735146736146737146738146739146740146741146742146743146744146745146746146747146748146749146750146751146752146753146754146755146756146757146758146759146760146761146762146763146764146765146766146767146768146769146770146771146772146773146774146775146776146777146778146779146780146781146782146783146784146785146786146787146788146789146790146791146792146793146794146795146796146797146798146799146800146801146802146803146804146805146806146807146808146809146810146811146812146813146814146815146816146817146818146819146820146821146822146823146824146825146826146827146828146829146830146831146832146833146834146835146836146837146838146839146840146841146842146843146844146845146846146847146848146849146850146851146852146853146854146855146856146857146858146859146860146861146862146863146864146865146866146867146868146869146870146871146872146873146874146875146876146877146878146879146880146881146882146883146884146885146886146887146888146889146890146891146892146893146894146895146896146897146898146899146900146901146902146903146904146905146906146907146908146909146910146911146912146913146914146915146916146917146918146919146920146921146922146923146924146925146926146927146928146929146930146931146932146933146934146935146936146937146938146939146940146941146942146943146944146945146946146947146948146949146950146951146952146953146954146955146956146957146958146959146960146961146962146963146964146965146966146967146968146969146970146971146972146973146974146975146976146977146978146979146980146981146982146983146984146985146986146987146988146989146990146991146992146993146994146995146996146997146998146999147000147001147002147003147004147005147006147007147008147009147010147011147012147013147014147015147016147017147018147019147020147021147022147023147024147025147026147027147028147029147030147031147032147033147034147035147036147037147038147039147040147041147042147043147044147045147046147047147048147049147050147051147052147053147054147055147056147057147058147059147060147061147062147063147064147065147066147067147068147069147070147071147072147073147074147075147076147077147078147079147080147081147082147083147084147085147086147087147088147089147090147091147092147093147094147095147096147097147098147099147100147101147102147103147104147105147106147107147108147109147110147111147112147113147114147115147116147117147118147119147120147121147122147123147124147125147126147127147128147129147130147131147132147133147134147135147136147137147138147139147140147141147142147143147144147145147146147147147148147149147150147151147152147153147154147155147156147157147158147159147160147161147162147163147164147165147166147167147168147169147170147171147172147173147174147175147176147177147178147179147180147181147182147183147184147185147186147187147188147189147190147191147192147193147194147195147196147197147198147199147200147201147202147203147204147205147206147207147208147209147210147211147212147213147214147215147216147217147218147219147220147221147222147223147224147225147226147227147228147229147230147231147232147233147234147235147236147237147238147239147240147241147242147243147244147245147246147247147248147249147250147251147252147253147254147255147256147257147258147259147260147261147262147263147264147265147266147267147268147269147270147271147272147273147274147275147276147277147278147279147280147281147282147283147284147285147286147287147288147289147290147291147292147293147294147295147296147297147298147299147300147301147302147303147304147305147306147307147308147309147310147311147312147313147314147315147316147317147318147319147320147321147322147323147324147325147326147327147328147329147330147331147332147333147334147335147336147337147338147339147340147341147342147343147344147345147346147347147348147349147350147351147352147353147354147355147356147357147358147359147360147361147362147363147364147365147366147367147368147369147370147371147372147373147374147375147376147377147378147379147380147381147382147383147384147385147386147387147388147389147390147391147392147393147394147395147396147397147398147399147400147401147402147403147404147405147406147407147408147409147410147411147412147413147414147415147416147417147418147419147420147421147422147423147424147425147426147427147428147429147430147431147432147433147434147435147436147437147438147439147440147441147442147443147444147445147446147447147448147449147450147451147452147453147454147455147456147457147458147459147460147461147462147463147464147465147466147467147468147469147470147471147472147473147474147475147476147477147478147479147480147481147482147483147484147485147486147487147488147489147490147491147492147493147494147495147496147497147498147499147500147501147502147503147504147505147506147507147508147509147510147511147512147513147514147515147516147517147518147519147520147521147522147523147524147525147526147527147528147529147530147531147532147533147534147535147536147537147538147539147540147541147542147543147544147545147546147547147548147549147550147551147552147553147554147555147556147557147558147559147560147561147562147563147564147565147566147567147568147569147570147571147572147573147574147575147576147577147578147579147580147581147582147583147584147585147586147587147588147589147590147591147592147593147594147595147596147597147598147599147600147601147602147603147604147605147606147607147608147609147610147611147612147613147614147615147616147617147618147619147620147621147622147623147624147625147626147627147628147629147630147631147632147633147634147635147636147637147638147639147640147641147642147643147644147645147646147647147648147649147650147651147652147653147654147655147656147657147658147659147660147661147662147663147664147665147666147667147668147669147670147671147672147673147674147675147676147677147678147679147680147681147682147683147684147685147686147687147688147689147690147691147692147693147694147695147696147697147698147699147700147701147702147703147704147705147706147707147708147709147710147711147712147713147714147715147716147717147718147719147720147721147722147723147724147725147726147727147728147729147730147731147732147733147734147735147736147737147738147739147740147741147742147743147744147745147746147747147748147749147750147751147752147753147754147755147756147757147758147759147760147761147762147763147764147765147766147767147768147769147770147771147772147773147774147775147776147777147778147779147780147781147782147783147784147785147786147787147788147789147790147791147792147793147794147795147796147797147798147799147800147801147802147803147804147805147806147807147808147809147810147811147812147813147814147815147816147817147818147819147820147821147822147823147824147825147826147827147828147829147830147831147832147833147834147835147836147837147838147839147840147841147842147843147844147845147846147847147848147849147850147851147852147853147854147855147856147857147858147859147860147861147862147863147864147865147866147867147868147869147870147871147872147873147874147875147876147877147878147879147880147881147882147883147884147885147886147887147888147889147890147891147892147893147894147895147896147897147898147899147900147901147902147903147904147905147906147907147908147909147910147911147912147913147914147915147916147917147918147919147920147921147922147923147924147925147926147927147928147929147930147931147932147933147934147935147936147937147938147939147940147941147942147943147944147945147946147947147948147949147950147951147952147953147954147955147956147957147958147959147960147961147962147963147964147965147966147967147968147969147970147971147972147973147974147975147976147977147978147979147980147981147982147983147984147985147986147987147988147989147990147991147992147993147994147995147996147997147998147999148000148001148002148003148004148005148006148007148008148009148010148011148012148013148014148015148016148017148018148019148020148021148022148023148024148025148026148027148028148029148030148031148032148033148034148035148036148037148038148039148040148041148042148043148044148045148046148047148048148049148050148051148052148053148054148055148056148057148058148059148060148061148062148063148064148065148066148067148068148069148070148071148072148073148074148075148076148077148078148079148080148081148082148083148084148085148086148087148088148089148090148091148092148093148094148095148096148097148098148099148100148101148102148103148104148105148106148107148108148109148110148111148112148113148114148115148116148117148118148119148120148121148122148123148124148125148126148127148128148129148130148131148132148133148134148135148136148137148138148139148140148141148142148143148144148145148146148147148148148149148150148151148152148153148154148155148156148157148158148159148160148161148162148163148164148165148166148167148168148169148170148171148172148173148174148175148176148177148178148179148180148181148182148183148184148185148186148187148188148189148190148191148192148193148194148195148196148197148198148199148200148201148202148203148204148205148206148207148208148209148210148211148212148213148214148215148216148217148218148219148220148221148222148223148224148225148226148227148228148229148230148231148232148233148234148235148236148237148238148239148240148241148242148243148244148245148246148247148248148249148250148251148252148253148254148255148256148257148258148259148260148261148262148263148264148265148266148267148268148269148270148271148272148273148274148275148276148277148278148279148280148281148282148283148284148285148286148287148288148289148290148291148292148293148294148295148296148297148298148299148300148301148302148303148304148305148306148307148308148309148310148311148312148313148314148315148316148317148318148319148320148321148322148323148324148325148326148327148328148329148330148331148332148333148334148335148336148337148338148339148340148341148342148343148344148345148346148347148348148349148350148351148352148353148354148355148356148357148358148359148360148361148362148363148364148365148366148367148368148369148370148371148372148373148374148375148376148377148378148379148380148381148382148383148384148385148386148387148388148389148390148391148392148393148394148395148396148397148398148399148400148401148402148403148404148405148406148407148408148409148410148411148412148413148414148415148416148417148418148419148420148421148422148423148424148425148426148427148428148429148430148431148432148433148434148435148436148437148438148439148440148441148442148443148444148445148446148447148448148449148450148451148452148453148454148455148456148457148458148459148460148461148462148463148464148465148466148467148468148469148470148471148472148473148474148475148476148477148478148479148480148481148482148483148484148485148486148487148488148489148490148491148492148493148494148495148496148497148498148499148500148501148502148503148504148505148506148507148508148509148510148511148512148513148514148515148516148517148518148519148520148521148522148523148524148525148526148527148528148529148530148531148532148533148534148535148536148537148538148539148540148541148542148543148544148545148546148547148548148549148550148551148552148553148554148555148556148557148558148559148560148561148562148563148564148565148566148567148568148569148570148571148572148573148574148575148576148577148578148579148580148581148582148583148584148585148586148587148588148589148590148591148592148593148594148595148596148597148598148599148600148601148602148603148604148605148606148607148608148609148610148611148612148613148614148615148616148617148618148619148620148621148622148623148624148625148626148627148628148629148630148631148632148633148634148635148636148637148638148639148640148641148642148643148644148645148646148647148648148649148650148651148652148653148654148655148656148657148658148659148660148661148662148663148664148665148666148667148668148669148670148671148672148673148674148675148676148677148678148679148680148681148682148683148684148685148686148687148688148689148690148691148692148693148694148695148696148697148698148699148700148701148702148703148704148705148706148707148708148709148710148711148712148713148714148715148716148717148718148719148720148721148722148723148724148725148726148727148728148729148730148731148732148733148734148735148736148737148738148739148740148741148742148743148744148745148746148747148748148749148750148751148752148753148754148755148756148757148758148759148760148761148762148763148764148765148766148767148768148769148770148771148772148773148774148775148776148777148778148779148780148781148782148783148784148785148786148787148788148789148790148791148792148793148794148795148796148797148798148799148800148801148802148803148804148805148806148807148808148809148810148811148812148813148814148815148816148817148818148819148820148821148822148823148824148825148826148827148828148829148830148831148832148833148834148835148836148837148838148839148840148841148842148843148844148845148846148847148848148849148850148851148852148853148854148855148856148857148858148859148860148861148862148863148864148865148866148867148868148869148870148871148872148873148874148875148876148877148878148879148880148881148882148883148884148885148886148887148888148889148890148891148892148893148894148895148896148897148898148899148900148901148902148903148904148905148906148907148908148909148910148911148912148913148914148915148916148917148918148919148920148921148922148923148924148925148926148927148928148929148930148931148932148933148934148935148936148937148938148939148940148941148942148943148944148945148946148947148948148949148950148951148952148953148954148955148956148957148958148959148960148961148962148963148964148965148966148967148968148969148970148971148972148973148974148975148976148977148978148979148980148981148982148983148984148985148986148987148988148989148990148991148992148993148994148995148996148997148998148999149000149001149002149003149004149005149006149007149008149009149010149011149012149013149014149015149016149017149018149019149020149021149022149023149024149025149026149027149028149029149030149031149032149033149034149035149036149037149038149039149040149041149042149043149044149045149046149047149048149049149050149051149052149053149054149055149056149057149058149059149060149061149062149063149064149065149066149067149068149069149070149071149072149073149074149075149076149077149078149079149080149081149082149083149084149085149086149087149088149089149090149091149092149093149094149095149096149097149098149099149100149101149102149103149104149105149106149107149108149109149110149111149112149113149114149115149116149117149118149119149120149121149122149123149124149125149126149127149128149129149130149131149132149133149134149135149136149137149138149139149140149141149142149143149144149145149146149147149148149149149150149151149152149153149154149155149156149157149158149159149160149161149162149163149164149165149166149167149168149169149170149171149172149173149174149175149176149177149178149179149180149181149182149183149184149185149186149187149188149189149190149191149192149193149194149195149196149197149198149199149200149201149202149203149204149205149206149207149208149209149210149211149212149213149214149215149216149217149218149219149220149221149222149223149224149225149226149227149228149229149230149231149232149233149234149235149236149237149238149239149240149241149242149243149244149245149246149247149248149249149250149251149252149253149254149255149256149257149258149259149260149261149262149263149264149265149266149267149268149269149270149271149272149273149274149275149276149277149278149279149280149281149282149283149284149285149286149287149288149289149290149291149292149293149294149295149296149297149298149299149300149301149302149303149304149305149306149307149308149309149310149311149312149313149314149315149316149317149318149319149320149321149322149323149324149325149326149327149328149329149330149331149332149333149334149335149336149337149338149339149340149341149342149343149344149345149346149347149348149349149350149351149352149353149354149355149356149357149358149359149360149361149362149363149364149365149366149367149368149369149370149371149372149373149374149375149376149377149378149379149380149381149382149383149384149385149386149387149388149389149390149391149392149393149394149395149396149397149398149399149400149401149402149403149404149405149406149407149408149409149410149411149412149413149414149415149416149417149418149419149420149421149422149423149424149425149426149427149428149429149430149431149432149433149434149435149436149437149438149439149440149441149442149443149444149445149446149447149448149449149450149451149452149453149454149455149456149457149458149459149460149461149462149463149464149465149466149467149468149469149470149471149472149473149474149475149476149477149478149479149480149481149482149483149484149485149486149487149488149489149490149491149492149493149494149495149496149497149498149499149500149501149502149503149504149505149506149507149508149509149510149511149512149513149514149515149516149517149518149519149520149521149522149523149524149525149526149527149528149529149530149531149532149533149534149535149536149537149538149539149540149541149542149543149544149545149546149547149548149549149550149551149552149553149554149555149556149557149558149559149560149561149562149563149564149565149566149567149568149569149570149571149572149573149574149575149576149577149578149579149580149581149582149583149584149585149586149587149588149589149590149591149592149593149594149595149596149597149598149599149600149601149602149603149604149605149606149607149608149609149610149611149612149613149614149615149616149617149618149619149620149621149622149623149624149625149626149627149628149629149630149631149632149633149634149635149636149637149638149639149640149641149642149643149644149645149646149647149648149649149650149651149652149653149654149655149656149657149658149659149660149661149662149663149664149665149666149667149668149669149670149671149672149673149674149675149676149677149678149679149680149681149682149683149684149685149686149687149688149689149690149691149692149693149694149695149696149697149698149699149700149701149702149703149704149705149706149707149708149709149710149711149712149713149714149715149716149717149718149719149720149721149722149723149724149725149726149727149728149729149730149731149732149733149734149735149736149737149738149739149740149741149742149743149744149745149746149747149748149749149750149751149752149753149754149755149756149757149758149759149760149761149762149763149764149765149766149767149768149769149770149771149772149773149774149775149776149777149778149779149780149781149782149783149784149785149786149787149788149789149790149791149792149793149794149795149796149797149798149799149800149801149802149803149804149805149806149807149808149809149810149811149812149813149814149815149816149817149818149819149820149821149822149823149824149825149826149827149828149829149830149831149832149833149834149835149836149837149838149839149840149841149842149843149844149845149846149847149848149849149850149851149852149853149854149855149856149857149858149859149860149861149862149863149864149865149866149867149868149869149870149871149872149873149874149875149876149877149878149879149880149881149882149883149884149885149886149887149888149889149890149891149892149893149894149895149896149897149898149899149900149901149902149903149904149905149906149907149908149909149910149911149912149913149914149915149916149917149918149919149920149921149922149923149924149925149926149927149928149929149930149931149932149933149934149935149936149937149938149939149940149941149942149943149944149945149946149947149948149949149950149951149952149953149954149955149956149957149958149959149960149961149962149963149964149965149966149967149968149969149970149971149972149973149974149975149976149977149978149979149980149981149982149983149984149985149986149987149988149989149990149991149992149993149994149995149996149997149998149999150000150001150002150003150004150005150006150007150008150009150010150011150012150013150014150015150016150017150018150019150020150021150022150023150024150025150026150027150028150029150030150031150032150033150034150035150036150037150038150039150040150041150042150043150044150045150046150047150048150049150050150051150052150053150054150055150056150057150058150059150060150061150062150063150064150065150066150067150068150069150070150071150072150073150074150075150076150077150078150079150080150081150082150083150084150085150086150087150088150089150090150091150092150093150094150095150096150097150098150099150100150101150102150103150104150105150106150107150108150109150110150111150112150113150114150115150116150117150118150119150120150121150122150123150124150125150126150127150128150129150130150131150132150133150134150135150136150137150138150139150140150141150142150143150144150145150146150147150148150149150150150151150152150153150154150155150156150157150158150159150160150161150162150163150164150165150166150167150168150169150170150171150172150173150174150175150176150177150178150179150180150181150182150183150184150185150186150187150188150189150190150191150192150193150194150195150196150197150198150199150200150201150202150203150204150205150206150207150208150209150210150211150212150213150214150215150216150217150218150219150220150221150222150223150224150225150226150227150228150229150230150231150232150233150234150235150236150237150238150239150240150241150242150243150244150245150246150247150248150249150250150251150252150253150254150255150256150257150258150259150260150261150262150263150264150265150266150267150268150269150270150271150272150273150274150275150276150277150278150279150280150281150282150283150284150285150286150287150288150289150290150291150292150293150294150295150296150297150298150299150300150301150302150303150304150305150306150307150308150309150310150311150312150313150314150315150316150317150318150319150320150321150322150323150324150325150326150327150328150329150330150331150332150333150334150335150336150337150338150339150340150341150342150343150344150345150346150347150348150349150350150351150352150353150354150355150356150357150358150359150360150361150362150363150364150365150366150367150368150369150370150371150372150373150374150375150376150377150378150379150380150381150382150383150384150385150386150387150388150389150390150391150392150393150394150395150396150397150398150399150400150401150402150403150404150405150406150407150408150409150410150411150412150413150414150415150416150417150418150419150420150421150422150423150424150425150426150427150428150429150430150431150432150433150434150435150436150437150438150439150440150441150442150443150444150445150446150447150448150449150450150451150452150453150454150455150456150457150458150459150460150461150462150463150464150465150466150467150468150469150470150471150472150473150474150475150476150477150478150479150480150481150482150483150484150485150486150487150488150489150490150491150492150493150494150495150496150497150498150499150500150501150502150503150504150505150506150507150508150509150510150511150512150513150514150515150516150517150518150519150520150521150522150523150524150525150526150527150528150529150530150531150532150533150534150535150536150537150538150539150540150541150542150543150544150545150546150547150548150549150550150551150552150553150554150555150556150557150558150559150560150561150562150563150564150565150566150567150568150569150570150571150572150573150574150575150576150577150578150579150580150581150582150583150584150585150586150587150588150589150590150591150592150593150594150595150596150597150598150599150600150601150602150603150604150605150606150607150608150609150610150611150612150613150614150615150616150617150618150619150620150621150622150623150624150625150626150627150628150629150630150631150632150633150634150635150636150637150638150639150640150641150642150643150644150645150646150647150648150649150650150651150652150653150654150655150656150657150658150659150660150661150662150663150664150665150666150667150668150669150670150671150672150673150674150675150676150677150678150679150680150681150682150683150684150685150686150687150688150689150690150691150692150693150694150695150696150697150698150699150700150701150702150703150704150705150706150707150708150709150710150711150712150713150714150715150716150717150718150719150720150721150722150723150724150725150726150727150728150729150730150731150732150733150734150735150736150737150738150739150740150741150742150743150744150745150746150747150748150749150750150751150752150753150754150755150756150757150758150759150760150761150762150763150764150765150766150767150768150769150770150771150772150773150774150775150776150777150778150779150780150781150782150783150784150785150786150787150788150789150790150791150792150793150794150795150796150797150798150799150800150801150802150803150804150805150806150807150808150809150810150811150812150813150814150815150816150817150818150819150820150821150822150823150824150825150826150827150828150829150830150831150832150833150834150835150836150837150838150839150840150841150842150843150844150845150846150847150848150849150850150851150852150853150854150855150856150857150858150859150860150861150862150863150864150865150866150867150868150869150870150871150872150873150874150875150876150877150878150879150880150881150882150883150884150885150886150887150888150889150890150891150892150893150894150895150896150897150898150899150900150901150902150903150904150905150906150907150908150909150910150911150912150913150914150915150916150917150918150919150920150921150922150923150924150925150926150927150928150929150930150931150932150933150934150935150936150937150938150939150940150941150942150943150944150945150946150947150948150949150950150951150952150953150954150955150956150957150958150959150960150961150962150963150964150965150966150967150968150969150970150971150972150973150974150975150976150977150978150979150980150981150982150983150984150985150986150987150988150989150990150991150992150993150994150995150996150997150998150999151000151001151002151003151004151005151006151007151008151009151010151011151012151013151014151015151016151017151018151019151020151021151022151023151024151025151026151027151028151029151030151031151032151033151034151035151036151037151038151039151040151041151042151043151044151045151046151047151048151049151050151051151052151053151054151055151056151057151058151059151060151061151062151063151064151065151066151067151068151069151070151071151072151073151074151075151076151077151078151079151080151081151082151083151084151085151086151087151088151089151090151091151092151093151094151095151096151097151098151099151100151101151102151103151104151105151106151107151108151109151110151111151112151113151114151115151116151117151118151119151120151121151122151123151124151125151126151127151128151129151130151131151132151133151134151135151136151137151138151139151140151141151142151143151144151145151146151147151148151149151150151151151152151153151154151155151156151157151158151159151160151161151162151163151164151165151166151167151168151169151170151171151172151173151174151175151176151177151178151179151180151181151182151183151184151185151186151187151188151189151190151191151192151193151194151195151196151197151198151199151200151201151202151203151204151205151206151207151208151209151210151211151212151213151214151215151216151217151218151219151220151221151222151223151224151225151226151227151228151229151230151231151232151233151234151235151236151237151238151239151240151241151242151243151244151245151246151247151248151249151250151251151252151253151254151255151256151257151258151259151260151261151262151263151264151265151266151267151268151269151270151271151272151273151274151275151276151277151278151279151280151281151282151283151284151285151286151287151288151289151290151291151292151293151294151295151296151297151298151299151300151301151302151303151304151305151306151307151308151309151310151311151312151313151314151315151316151317151318151319151320151321151322151323151324151325151326151327151328151329151330151331151332151333151334151335151336151337151338151339151340151341151342151343151344151345151346151347151348151349151350151351151352151353151354151355151356151357151358151359151360151361151362151363151364151365151366151367151368151369151370151371151372151373151374151375151376151377151378151379151380151381151382151383151384151385151386151387151388151389151390151391151392151393151394151395151396151397151398151399151400151401151402151403151404151405151406151407151408151409151410151411151412151413151414151415151416151417151418151419151420151421151422151423151424151425151426151427151428151429151430151431151432151433151434151435151436151437151438151439151440151441151442151443151444151445151446151447151448151449151450151451151452151453151454151455151456151457151458151459151460151461151462151463151464151465151466151467151468151469151470151471151472151473151474151475151476151477151478151479151480151481151482151483151484151485151486151487151488151489151490151491151492151493151494151495151496151497151498151499151500151501151502151503151504151505151506151507151508151509151510151511151512151513151514151515151516151517151518151519151520151521151522151523151524151525151526151527151528151529151530151531151532151533151534151535151536151537151538151539151540151541151542151543151544151545151546151547151548151549151550151551151552151553151554151555151556151557151558151559151560151561151562151563151564151565151566151567151568151569151570151571151572151573151574151575151576151577151578151579151580151581151582151583151584151585151586151587151588151589151590151591151592151593151594151595151596151597151598151599151600151601151602151603151604151605151606151607151608151609151610151611151612151613151614151615151616151617151618151619151620151621151622151623151624151625151626151627151628151629151630151631151632151633151634151635151636151637151638151639151640151641151642151643151644151645151646151647151648151649151650151651151652151653151654151655151656151657151658151659151660151661151662151663151664151665151666151667151668151669151670151671151672151673151674151675151676151677151678151679151680151681151682151683151684151685151686151687151688151689151690151691151692151693151694151695151696151697151698151699151700151701151702151703151704151705151706151707151708151709151710151711151712151713151714151715151716151717151718151719151720151721151722151723151724151725151726151727151728151729151730151731151732151733151734151735151736151737151738151739151740151741151742151743151744151745151746151747151748151749151750151751151752151753151754151755151756151757151758151759151760151761151762151763151764151765151766151767151768151769151770151771151772151773151774151775151776151777151778151779151780151781151782151783151784151785151786151787151788151789151790151791151792151793151794151795151796151797151798151799151800151801151802151803151804151805151806151807151808151809151810151811151812151813151814151815151816151817151818151819151820151821151822151823151824151825151826151827151828151829151830151831151832151833151834151835151836151837151838151839151840151841151842151843151844151845151846151847151848151849151850151851151852151853151854151855151856151857151858151859151860151861151862151863151864151865151866151867151868151869151870151871151872151873151874151875151876151877151878151879151880151881151882151883151884151885151886151887151888151889151890151891151892151893151894151895151896151897151898151899151900151901151902151903151904151905151906151907151908151909151910151911151912151913151914151915151916151917151918151919151920151921151922151923151924151925151926151927151928151929151930151931151932151933151934151935151936151937151938151939151940151941151942151943151944151945151946151947151948151949151950151951151952151953151954151955151956151957151958151959151960151961151962151963151964151965151966151967151968151969151970151971151972151973151974151975151976151977151978151979151980151981151982151983151984151985151986151987151988151989151990151991151992151993151994151995151996151997151998151999152000152001152002152003152004152005152006152007152008152009152010152011152012152013152014152015152016152017152018152019152020152021152022152023152024152025152026152027152028152029152030152031152032152033152034152035152036152037152038152039152040152041152042152043152044152045152046152047152048152049152050152051152052152053152054152055152056152057152058152059152060152061152062152063152064152065152066152067152068152069152070152071152072152073152074152075152076152077152078152079152080152081152082152083152084152085152086152087152088152089152090152091152092152093152094152095152096152097152098152099152100152101152102152103152104152105152106152107152108152109152110152111152112152113152114152115152116152117152118152119152120152121152122152123152124152125152126152127152128152129152130152131152132152133152134152135152136152137152138152139152140152141152142152143152144152145152146152147152148152149152150152151152152152153152154152155152156152157152158152159152160152161152162152163152164152165152166152167152168152169152170152171152172152173152174152175152176152177152178152179152180152181152182152183152184152185152186152187152188152189152190152191152192152193152194152195152196152197152198152199152200152201152202152203152204152205152206152207152208152209152210152211152212152213152214152215152216152217152218152219152220152221152222152223152224152225152226152227152228152229152230152231152232152233152234152235152236152237152238152239152240152241152242152243152244152245152246152247152248152249152250152251152252152253152254152255152256152257152258152259152260152261152262152263152264152265152266152267152268152269152270152271152272152273152274152275152276152277152278152279152280152281152282152283152284152285152286152287152288152289152290152291152292152293152294152295152296152297152298152299152300152301152302152303152304152305152306152307152308152309152310152311152312152313152314152315152316152317152318152319152320152321152322152323152324152325152326152327152328152329152330152331152332152333152334152335152336152337152338152339152340152341152342152343152344152345152346152347152348152349152350152351152352152353152354152355152356152357152358152359152360152361152362152363152364152365152366152367152368152369152370152371152372152373152374152375152376152377152378152379152380152381152382152383152384152385152386152387152388152389152390152391152392152393152394152395152396152397152398152399152400152401152402152403152404152405152406152407152408152409152410152411152412152413152414152415152416152417152418152419152420152421152422152423152424152425152426152427152428152429152430152431152432152433152434152435152436152437152438152439152440152441152442152443152444152445152446152447152448152449152450152451152452152453152454152455152456152457152458152459152460152461152462152463152464152465152466152467152468152469152470152471152472152473152474152475152476152477152478152479152480152481152482152483152484152485152486152487152488152489152490152491152492152493152494152495152496152497152498152499152500152501152502152503152504152505152506152507152508152509152510152511152512152513152514152515152516152517152518152519152520152521152522152523152524152525152526152527152528152529152530152531152532152533152534152535152536152537152538152539152540152541152542152543152544152545152546152547152548152549152550152551152552152553152554152555152556152557152558152559152560152561152562152563152564152565152566152567152568152569152570152571152572152573152574152575152576152577152578152579152580152581152582152583152584152585152586152587152588152589152590152591152592152593152594152595152596152597152598152599152600152601152602152603152604152605152606152607152608152609152610152611152612152613152614152615152616152617152618152619152620152621152622152623152624152625152626152627152628152629152630152631152632152633152634152635152636152637152638152639152640152641152642152643152644152645152646152647152648152649152650152651152652152653152654152655152656152657152658152659152660152661152662152663152664152665152666152667152668152669152670152671152672152673152674152675152676152677152678152679152680152681152682152683152684152685152686152687152688152689152690152691152692152693152694152695152696152697152698152699152700152701152702152703152704152705152706152707152708152709152710152711152712152713152714152715152716152717152718152719152720152721152722152723152724152725152726152727152728152729152730152731152732152733152734152735152736152737152738152739152740152741152742152743152744152745152746152747152748152749152750152751152752152753152754152755152756152757152758152759152760152761152762152763152764152765152766152767152768152769152770152771152772152773152774152775152776152777152778152779152780152781152782152783152784152785152786152787152788152789152790152791152792152793152794152795152796152797152798152799152800152801152802152803152804152805152806152807152808152809152810152811152812152813152814152815152816152817152818152819152820152821152822152823152824152825152826152827152828152829152830152831152832152833152834152835152836152837152838152839152840152841152842152843152844152845152846152847152848152849152850152851152852152853152854152855152856152857152858152859152860152861152862152863152864152865152866152867152868152869152870152871152872152873152874152875152876152877152878152879152880152881152882152883152884152885152886152887152888152889152890152891152892152893152894152895152896152897152898152899152900152901152902152903152904152905152906152907152908152909152910152911152912152913152914152915152916152917152918152919152920152921152922152923152924152925152926152927152928152929152930152931152932152933152934152935152936152937152938152939152940152941152942152943152944152945152946152947152948152949152950152951152952152953152954152955152956152957152958152959152960152961152962152963152964152965152966152967152968152969152970152971152972152973152974152975152976152977152978152979152980152981152982152983152984152985152986152987152988152989152990152991152992152993152994152995152996152997152998152999153000153001153002153003153004153005153006153007153008153009153010153011153012153013153014153015153016153017153018153019153020153021153022153023153024153025153026153027153028153029153030153031153032153033153034153035153036153037153038153039153040153041153042153043153044153045153046153047153048153049153050153051153052153053153054153055153056153057153058153059153060153061153062153063153064153065153066153067153068153069153070153071153072153073153074153075153076153077153078153079153080153081153082153083153084153085153086153087153088153089153090153091153092153093153094153095153096153097153098153099153100153101153102153103153104153105153106153107153108153109153110153111153112153113153114153115153116153117153118153119153120153121153122153123153124153125153126153127153128153129153130153131153132153133153134153135153136153137153138153139153140153141153142153143153144153145153146153147153148153149153150153151153152153153153154153155153156153157153158153159153160153161153162153163153164153165153166153167153168153169153170153171153172153173153174153175153176153177153178153179153180153181153182153183153184153185153186153187153188153189153190153191153192153193153194153195153196153197153198153199153200153201153202153203153204153205153206153207153208153209153210153211153212153213153214153215153216153217153218153219153220153221153222153223153224153225153226153227153228153229153230153231153232153233153234153235153236153237153238153239153240153241153242153243153244153245153246153247153248153249153250153251153252153253153254153255153256153257153258153259153260153261153262153263153264153265153266153267153268153269153270153271153272153273153274153275153276153277153278153279153280153281153282153283153284153285153286153287153288153289153290153291153292153293153294153295153296153297153298153299153300153301153302153303153304153305153306153307153308153309153310153311153312153313153314153315153316153317153318153319153320153321153322153323153324153325153326153327153328153329153330153331153332153333153334153335153336153337153338153339153340153341153342153343153344153345153346153347153348153349153350153351153352153353153354153355153356153357153358153359153360153361153362153363153364153365153366153367153368153369153370153371153372153373153374153375153376153377153378153379153380153381153382153383153384153385153386153387153388153389153390153391153392153393153394153395153396153397153398153399153400153401153402153403153404153405153406153407153408153409153410153411153412153413153414153415153416153417153418153419153420153421153422153423153424153425153426153427153428153429153430153431153432153433153434153435153436153437153438153439153440153441153442153443153444153445153446153447153448153449153450153451153452153453153454153455153456153457153458153459153460153461153462153463153464153465153466153467153468153469153470153471153472153473153474153475153476153477153478153479153480153481153482153483153484153485153486153487153488153489153490153491153492153493153494153495153496153497153498153499153500153501153502153503153504153505153506153507153508153509153510153511153512153513153514153515153516153517153518153519153520153521153522153523153524153525153526153527153528153529153530153531153532153533153534153535153536153537153538153539153540153541153542153543153544153545153546153547153548153549153550153551153552153553153554153555153556153557153558153559153560153561153562153563153564153565153566153567153568153569153570153571153572153573153574153575153576153577153578153579153580153581153582153583153584153585153586153587153588153589153590153591153592153593153594153595153596153597153598153599153600153601153602153603153604153605153606153607153608153609153610153611153612153613153614153615153616153617153618153619153620153621153622153623153624153625153626153627153628153629153630153631153632153633153634153635153636153637153638153639153640153641153642153643153644153645153646153647153648153649153650153651153652153653153654153655153656153657153658153659153660153661153662153663153664153665153666153667153668153669153670153671153672153673153674153675153676153677153678153679153680153681153682153683153684153685153686153687153688153689153690153691153692153693153694153695153696153697153698153699153700153701153702153703153704153705153706153707153708153709153710153711153712153713153714153715153716153717153718153719153720153721153722153723153724153725153726153727153728153729153730153731153732153733153734153735153736153737153738153739153740153741153742153743153744153745153746153747153748153749153750153751153752153753153754153755153756153757153758153759153760153761153762153763153764153765153766153767153768153769153770153771153772153773153774153775153776153777153778153779153780153781153782153783153784153785153786153787153788153789153790153791153792153793153794153795153796153797153798153799153800153801153802153803153804153805153806153807153808153809153810153811153812153813153814153815153816153817153818153819153820153821153822153823153824153825153826153827153828153829153830153831153832153833153834153835153836153837153838153839153840153841153842153843153844153845153846153847153848153849153850153851153852153853153854153855153856153857153858153859153860153861153862153863153864153865153866153867153868153869153870153871153872153873153874153875153876153877153878153879153880153881153882153883153884153885153886153887153888153889153890153891153892153893153894153895153896153897153898153899153900153901153902153903153904153905153906153907153908153909153910153911153912153913153914153915153916153917153918153919153920153921153922153923153924153925153926153927153928153929153930153931153932153933153934153935153936153937153938153939153940153941153942153943153944153945153946153947153948153949153950153951153952153953153954153955153956153957153958153959153960153961153962153963153964153965153966153967153968153969153970153971153972153973153974153975153976153977153978153979153980153981153982153983153984153985153986153987153988153989153990153991153992153993153994153995153996153997153998153999154000154001154002154003154004154005154006154007154008154009154010154011154012154013154014154015154016154017154018154019154020154021154022154023154024154025154026154027154028154029154030154031154032154033154034154035154036154037154038154039154040154041154042154043154044154045154046154047154048154049154050154051154052154053154054154055154056154057154058154059154060154061154062154063154064154065154066154067154068154069154070154071154072154073154074154075154076154077154078154079154080154081154082154083154084154085154086154087154088154089154090154091154092154093154094154095154096154097154098154099154100154101154102154103154104154105154106154107154108154109154110154111154112154113154114154115154116154117154118154119154120154121154122154123154124154125154126154127154128154129154130154131154132154133154134154135154136154137154138154139154140154141154142154143154144154145154146154147154148154149154150154151154152154153154154154155154156154157154158154159154160154161154162154163154164154165154166154167154168154169154170154171154172154173154174154175154176154177154178154179154180154181154182154183154184154185154186154187154188154189154190154191154192154193154194154195154196154197154198154199154200154201154202154203154204154205154206154207154208154209154210154211154212154213154214154215154216154217154218154219154220154221154222154223154224154225154226154227154228154229154230154231154232154233154234154235154236154237154238154239154240154241154242154243154244154245154246154247154248154249154250154251154252154253154254154255154256154257154258154259154260154261154262154263154264154265154266154267154268154269154270154271154272154273154274154275154276154277154278154279154280154281154282154283154284154285154286154287154288154289154290154291154292154293154294154295154296154297154298154299154300154301154302154303154304154305154306154307154308154309154310154311154312154313154314154315154316154317154318154319154320154321154322154323154324154325154326154327154328154329154330154331154332154333154334154335154336154337154338154339154340154341154342154343154344154345154346154347154348154349154350154351154352154353154354154355154356154357154358154359154360154361154362154363154364154365154366154367154368154369154370154371154372154373154374154375154376154377154378154379154380154381154382154383154384154385154386154387154388154389154390154391154392154393154394154395154396154397154398154399154400154401154402154403154404154405154406154407154408154409154410154411154412154413154414154415154416154417154418154419154420154421154422154423154424154425154426154427154428154429154430154431154432154433154434154435154436154437154438154439154440154441154442154443154444154445154446154447154448154449154450154451154452154453154454154455154456154457154458154459154460154461154462154463154464154465154466154467154468154469154470154471154472154473154474154475154476154477154478154479154480154481154482154483154484154485154486154487154488154489154490154491154492154493154494154495154496154497154498154499154500154501154502154503154504154505154506154507154508154509154510154511154512154513154514154515154516154517154518154519154520154521154522154523154524154525154526154527154528154529154530154531154532154533154534154535154536154537154538154539154540154541154542154543154544154545154546154547154548154549154550154551154552154553154554154555154556154557154558154559154560154561154562154563154564154565154566154567154568154569154570154571154572154573154574154575154576154577154578154579154580154581154582154583154584154585154586154587154588154589154590154591154592154593154594154595154596154597154598154599154600154601154602154603154604154605154606154607154608154609154610154611154612154613154614154615154616154617154618154619154620154621154622154623154624154625154626154627154628154629154630154631154632154633154634154635154636154637154638154639154640154641154642154643154644154645154646154647154648154649154650154651154652154653154654154655154656154657154658154659154660154661154662154663154664154665154666154667154668154669154670154671154672154673154674154675154676154677154678154679154680154681154682154683154684154685154686154687154688154689154690154691154692154693154694154695154696154697154698154699154700154701154702154703154704154705154706154707154708154709154710154711154712154713154714154715154716154717154718154719154720154721154722154723154724154725154726154727154728154729154730154731154732154733154734154735154736154737154738154739154740154741154742154743154744154745154746154747154748154749154750154751154752154753154754154755154756154757154758154759154760154761154762154763154764154765154766154767154768154769154770154771154772154773154774154775154776154777154778154779154780154781154782154783154784154785154786154787154788154789154790154791154792154793154794154795154796154797154798154799154800154801154802154803154804154805154806154807154808154809154810154811154812154813154814154815154816154817154818154819154820154821154822154823154824154825154826154827154828154829154830154831154832154833154834154835154836154837154838154839154840154841154842154843154844154845154846154847154848154849154850154851154852154853154854154855154856154857154858154859154860154861154862154863154864154865154866154867154868154869154870154871154872154873154874154875154876154877154878154879154880154881154882154883154884154885154886154887154888154889154890154891154892154893154894154895154896154897154898154899154900154901154902154903154904154905154906154907154908154909154910154911154912154913154914154915154916154917154918154919154920154921154922154923154924154925154926154927154928154929154930154931154932154933154934154935154936154937154938154939154940154941154942154943154944154945154946154947154948154949154950154951154952154953154954154955154956154957154958154959154960154961154962154963154964154965154966154967154968154969154970154971154972154973154974154975154976154977154978154979154980154981154982154983154984154985154986154987154988154989154990154991154992154993154994154995154996154997154998154999155000155001155002155003155004155005155006155007155008155009155010155011155012155013155014155015155016155017155018155019155020155021155022155023155024155025155026155027155028155029155030155031155032155033155034155035155036155037155038155039155040155041155042155043155044155045155046155047155048155049155050155051155052155053155054155055155056155057155058155059155060155061155062155063155064155065155066155067155068155069155070155071155072155073155074155075155076155077155078155079155080155081155082155083155084155085155086155087155088155089155090155091155092155093155094155095155096155097155098155099155100155101155102155103155104155105155106155107155108155109155110155111155112155113155114155115155116155117155118155119155120155121155122155123155124155125155126155127155128155129155130155131155132155133155134155135155136155137155138155139155140155141155142155143155144155145155146155147155148155149155150155151155152155153155154155155155156155157155158155159155160155161155162155163155164155165155166155167155168155169155170155171155172155173155174155175155176155177155178155179155180155181155182155183155184155185155186155187155188155189155190155191155192155193155194155195155196155197155198155199155200155201155202155203155204155205155206155207155208155209155210155211155212155213155214155215155216155217155218155219155220155221155222155223155224155225155226155227155228155229155230155231155232155233155234155235155236155237155238155239155240155241155242155243155244155245155246155247155248155249155250155251155252155253155254155255155256155257155258155259155260155261155262155263155264155265155266155267155268155269155270155271155272155273155274155275155276155277155278155279155280155281155282155283155284155285155286155287155288155289155290155291155292155293155294155295155296155297155298155299155300155301155302155303155304155305155306155307155308155309155310155311155312155313155314155315155316155317155318155319155320155321155322155323155324155325155326155327155328155329155330155331155332155333155334155335155336155337155338155339155340155341155342155343155344155345155346155347155348155349155350155351155352155353155354155355155356155357155358155359155360155361155362155363155364155365155366155367155368155369155370155371155372155373155374155375155376155377155378155379155380155381155382155383155384155385155386155387155388155389155390155391155392155393155394155395155396155397155398155399155400155401155402155403155404155405155406155407155408155409155410155411155412155413155414155415155416155417155418155419155420155421155422155423155424155425155426155427155428155429155430155431155432155433155434155435155436155437155438155439155440155441155442155443155444155445155446155447155448155449155450155451155452155453155454155455155456155457155458155459155460155461155462155463155464155465155466155467155468155469155470155471155472155473155474155475155476155477155478155479155480155481155482155483155484155485155486155487155488155489155490155491155492155493155494155495155496155497155498155499155500155501155502155503155504155505155506155507155508155509155510155511155512155513155514155515155516155517155518155519155520155521155522155523155524155525155526155527155528155529155530155531155532155533155534155535155536155537155538155539155540155541155542155543155544155545155546155547155548155549155550155551155552155553155554155555155556155557155558155559155560155561155562155563155564155565155566155567155568155569155570155571155572155573155574155575155576155577155578155579155580155581155582155583155584155585155586155587155588155589155590155591155592155593155594155595155596155597155598155599155600155601155602155603155604155605155606155607155608155609155610155611155612155613155614155615155616155617155618155619155620155621155622155623155624155625155626155627155628155629155630155631155632155633155634155635155636155637155638155639155640155641155642155643155644155645155646155647155648155649155650155651155652155653155654155655155656155657155658155659155660155661155662155663155664155665155666155667155668155669155670155671155672155673155674155675155676155677155678155679155680155681155682155683155684155685155686155687155688155689155690155691155692155693155694155695155696155697155698155699155700155701155702155703155704155705155706155707155708155709155710155711155712155713155714155715155716155717155718155719155720155721155722155723155724155725155726155727155728155729155730155731155732155733155734155735155736155737155738155739155740155741155742155743155744155745155746155747155748155749155750155751155752155753155754155755155756155757155758155759155760155761155762155763155764155765155766155767155768155769155770155771155772155773155774155775155776155777155778155779155780155781155782155783155784155785155786155787155788155789155790155791155792155793155794155795155796155797155798155799155800155801155802155803155804155805155806155807155808155809155810155811155812155813155814155815155816155817155818155819155820155821155822155823155824155825155826155827155828155829155830155831155832155833155834155835155836155837155838155839155840155841155842155843155844155845155846155847155848155849155850155851155852155853155854155855155856155857155858155859155860155861155862155863155864155865155866155867155868155869155870155871155872155873155874155875155876155877155878155879155880155881155882155883155884155885155886155887155888155889155890155891155892155893155894155895155896155897155898155899155900155901155902155903155904155905155906155907155908155909155910155911155912155913155914155915155916155917155918155919155920155921155922155923155924155925155926155927155928155929155930155931155932155933155934155935155936155937155938155939155940155941155942155943155944155945155946155947155948155949155950155951155952155953155954155955155956155957155958155959155960155961155962155963155964155965155966155967155968155969155970155971155972155973155974155975155976155977155978155979155980155981155982155983155984155985155986155987155988155989155990155991155992155993155994155995155996155997
  1. declare module "babylonjs/types" {
  2. /** Alias type for value that can be null */
  3. export type Nullable<T> = T | null;
  4. /**
  5. * Alias type for number that are floats
  6. * @ignorenaming
  7. */
  8. export type float = number;
  9. /**
  10. * Alias type for number that are doubles.
  11. * @ignorenaming
  12. */
  13. export type double = number;
  14. /**
  15. * Alias type for number that are integer
  16. * @ignorenaming
  17. */
  18. export type int = number;
  19. /** Alias type for number array or Float32Array */
  20. export type FloatArray = number[] | Float32Array;
  21. /** Alias type for number array or Float32Array or Int32Array or Uint32Array or Uint16Array */
  22. export type IndicesArray = number[] | Int32Array | Uint32Array | Uint16Array;
  23. /**
  24. * Alias for types that can be used by a Buffer or VertexBuffer.
  25. */
  26. export type DataArray = number[] | ArrayBuffer | ArrayBufferView;
  27. /**
  28. * Alias type for primitive types
  29. * @ignorenaming
  30. */
  31. type Primitive = undefined | null | boolean | string | number | Function;
  32. /**
  33. * Type modifier to make all the properties of an object Readonly
  34. */
  35. export type Immutable<T> = T extends Primitive ? T : T extends Array<infer U> ? ReadonlyArray<U> : DeepImmutable<T>;
  36. /**
  37. * Type modifier to make all the properties of an object Readonly recursively
  38. */
  39. export type DeepImmutable<T> = T extends Primitive ? T : T extends Array<infer U> ? DeepImmutableArray<U> : DeepImmutableObject<T>;
  40. /**
  41. * Type modifier to make object properties readonly.
  42. */
  43. export type DeepImmutableObject<T> = {
  44. readonly [K in keyof T]: DeepImmutable<T[K]>;
  45. };
  46. /** @hidden */
  47. interface DeepImmutableArray<T> extends ReadonlyArray<DeepImmutable<T>> {
  48. }
  49. }
  50. declare module "babylonjs/Misc/observable" {
  51. import { Nullable } from "babylonjs/types";
  52. /**
  53. * A class serves as a medium between the observable and its observers
  54. */
  55. export class EventState {
  56. /**
  57. * Create a new EventState
  58. * @param mask defines the mask associated with this state
  59. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  60. * @param target defines the original target of the state
  61. * @param currentTarget defines the current target of the state
  62. */
  63. constructor(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any);
  64. /**
  65. * Initialize the current event state
  66. * @param mask defines the mask associated with this state
  67. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  68. * @param target defines the original target of the state
  69. * @param currentTarget defines the current target of the state
  70. * @returns the current event state
  71. */
  72. initalize(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any): EventState;
  73. /**
  74. * An Observer can set this property to true to prevent subsequent observers of being notified
  75. */
  76. skipNextObservers: boolean;
  77. /**
  78. * Get the mask value that were used to trigger the event corresponding to this EventState object
  79. */
  80. mask: number;
  81. /**
  82. * The object that originally notified the event
  83. */
  84. target?: any;
  85. /**
  86. * The current object in the bubbling phase
  87. */
  88. currentTarget?: any;
  89. /**
  90. * This will be populated with the return value of the last function that was executed.
  91. * If it is the first function in the callback chain it will be the event data.
  92. */
  93. lastReturnValue?: any;
  94. }
  95. /**
  96. * Represent an Observer registered to a given Observable object.
  97. */
  98. export class Observer<T> {
  99. /**
  100. * Defines the callback to call when the observer is notified
  101. */
  102. callback: (eventData: T, eventState: EventState) => void;
  103. /**
  104. * Defines the mask of the observer (used to filter notifications)
  105. */
  106. mask: number;
  107. /**
  108. * Defines the current scope used to restore the JS context
  109. */
  110. scope: any;
  111. /** @hidden */
  112. _willBeUnregistered: boolean;
  113. /**
  114. * Gets or sets a property defining that the observer as to be unregistered after the next notification
  115. */
  116. unregisterOnNextCall: boolean;
  117. /**
  118. * Creates a new observer
  119. * @param callback defines the callback to call when the observer is notified
  120. * @param mask defines the mask of the observer (used to filter notifications)
  121. * @param scope defines the current scope used to restore the JS context
  122. */
  123. constructor(
  124. /**
  125. * Defines the callback to call when the observer is notified
  126. */
  127. callback: (eventData: T, eventState: EventState) => void,
  128. /**
  129. * Defines the mask of the observer (used to filter notifications)
  130. */
  131. mask: number,
  132. /**
  133. * Defines the current scope used to restore the JS context
  134. */
  135. scope?: any);
  136. }
  137. /**
  138. * Represent a list of observers registered to multiple Observables object.
  139. */
  140. export class MultiObserver<T> {
  141. private _observers;
  142. private _observables;
  143. /**
  144. * Release associated resources
  145. */
  146. dispose(): void;
  147. /**
  148. * Raise a callback when one of the observable will notify
  149. * @param observables defines a list of observables to watch
  150. * @param callback defines the callback to call on notification
  151. * @param mask defines the mask used to filter notifications
  152. * @param scope defines the current scope used to restore the JS context
  153. * @returns the new MultiObserver
  154. */
  155. static Watch<T>(observables: Observable<T>[], callback: (eventData: T, eventState: EventState) => void, mask?: number, scope?: any): MultiObserver<T>;
  156. }
  157. /**
  158. * The Observable class is a simple implementation of the Observable pattern.
  159. *
  160. * There's one slight particularity though: a given Observable can notify its observer using a particular mask value, only the Observers registered with this mask value will be notified.
  161. * This enable a more fine grained execution without having to rely on multiple different Observable objects.
  162. * For instance you may have a given Observable that have four different types of notifications: Move (mask = 0x01), Stop (mask = 0x02), Turn Right (mask = 0X04), Turn Left (mask = 0X08).
  163. * A given observer can register itself with only Move and Stop (mask = 0x03), then it will only be notified when one of these two occurs and will never be for Turn Left/Right.
  164. */
  165. export class Observable<T> {
  166. private _observers;
  167. private _eventState;
  168. private _onObserverAdded;
  169. /**
  170. * Gets the list of observers
  171. */
  172. get observers(): Array<Observer<T>>;
  173. /**
  174. * Creates a new observable
  175. * @param onObserverAdded defines a callback to call when a new observer is added
  176. */
  177. constructor(onObserverAdded?: (observer: Observer<T>) => void);
  178. /**
  179. * Create a new Observer with the specified callback
  180. * @param callback the callback that will be executed for that Observer
  181. * @param mask the mask used to filter observers
  182. * @param insertFirst if true the callback will be inserted at the first position, hence executed before the others ones. If false (default behavior) the callback will be inserted at the last position, executed after all the others already present.
  183. * @param scope optional scope for the callback to be called from
  184. * @param unregisterOnFirstCall defines if the observer as to be unregistered after the next notification
  185. * @returns the new observer created for the callback
  186. */
  187. add(callback: (eventData: T, eventState: EventState) => void, mask?: number, insertFirst?: boolean, scope?: any, unregisterOnFirstCall?: boolean): Nullable<Observer<T>>;
  188. /**
  189. * Create a new Observer with the specified callback and unregisters after the next notification
  190. * @param callback the callback that will be executed for that Observer
  191. * @returns the new observer created for the callback
  192. */
  193. addOnce(callback: (eventData: T, eventState: EventState) => void): Nullable<Observer<T>>;
  194. /**
  195. * Remove an Observer from the Observable object
  196. * @param observer the instance of the Observer to remove
  197. * @returns false if it doesn't belong to this Observable
  198. */
  199. remove(observer: Nullable<Observer<T>>): boolean;
  200. /**
  201. * Remove a callback from the Observable object
  202. * @param callback the callback to remove
  203. * @param scope optional scope. If used only the callbacks with this scope will be removed
  204. * @returns false if it doesn't belong to this Observable
  205. */
  206. removeCallback(callback: (eventData: T, eventState: EventState) => void, scope?: any): boolean;
  207. private _deferUnregister;
  208. private _remove;
  209. /**
  210. * Moves the observable to the top of the observer list making it get called first when notified
  211. * @param observer the observer to move
  212. */
  213. makeObserverTopPriority(observer: Observer<T>): void;
  214. /**
  215. * Moves the observable to the bottom of the observer list making it get called last when notified
  216. * @param observer the observer to move
  217. */
  218. makeObserverBottomPriority(observer: Observer<T>): void;
  219. /**
  220. * Notify all Observers by calling their respective callback with the given data
  221. * Will return true if all observers were executed, false if an observer set skipNextObservers to true, then prevent the subsequent ones to execute
  222. * @param eventData defines the data to send to all observers
  223. * @param mask defines the mask of the current notification (observers with incompatible mask (ie mask & observer.mask === 0) will not be notified)
  224. * @param target defines the original target of the state
  225. * @param currentTarget defines the current target of the state
  226. * @returns false if the complete observer chain was not processed (because one observer set the skipNextObservers to true)
  227. */
  228. notifyObservers(eventData: T, mask?: number, target?: any, currentTarget?: any): boolean;
  229. /**
  230. * Calling this will execute each callback, expecting it to be a promise or return a value.
  231. * If at any point in the chain one function fails, the promise will fail and the execution will not continue.
  232. * This is useful when a chain of events (sometimes async events) is needed to initialize a certain object
  233. * and it is crucial that all callbacks will be executed.
  234. * The order of the callbacks is kept, callbacks are not executed parallel.
  235. *
  236. * @param eventData The data to be sent to each callback
  237. * @param mask is used to filter observers defaults to -1
  238. * @param target defines the callback target (see EventState)
  239. * @param currentTarget defines he current object in the bubbling phase
  240. * @returns {Promise<T>} will return a Promise than resolves when all callbacks executed successfully.
  241. */
  242. notifyObserversWithPromise(eventData: T, mask?: number, target?: any, currentTarget?: any): Promise<T>;
  243. /**
  244. * Notify a specific observer
  245. * @param observer defines the observer to notify
  246. * @param eventData defines the data to be sent to each callback
  247. * @param mask is used to filter observers defaults to -1
  248. */
  249. notifyObserver(observer: Observer<T>, eventData: T, mask?: number): void;
  250. /**
  251. * Gets a boolean indicating if the observable has at least one observer
  252. * @returns true is the Observable has at least one Observer registered
  253. */
  254. hasObservers(): boolean;
  255. /**
  256. * Clear the list of observers
  257. */
  258. clear(): void;
  259. /**
  260. * Clone the current observable
  261. * @returns a new observable
  262. */
  263. clone(): Observable<T>;
  264. /**
  265. * Does this observable handles observer registered with a given mask
  266. * @param mask defines the mask to be tested
  267. * @return whether or not one observer registered with the given mask is handeled
  268. **/
  269. hasSpecificMask(mask?: number): boolean;
  270. }
  271. }
  272. declare module "babylonjs/Misc/domManagement" {
  273. /**
  274. * Sets of helpers dealing with the DOM and some of the recurrent functions needed in
  275. * Babylon.js
  276. */
  277. export class DomManagement {
  278. /**
  279. * Checks if the window object exists
  280. * @returns true if the window object exists
  281. */
  282. static IsWindowObjectExist(): boolean;
  283. /**
  284. * Checks if the navigator object exists
  285. * @returns true if the navigator object exists
  286. */
  287. static IsNavigatorAvailable(): boolean;
  288. /**
  289. * Check if the document object exists
  290. * @returns true if the document object exists
  291. */
  292. static IsDocumentAvailable(): boolean;
  293. /**
  294. * Extracts text content from a DOM element hierarchy
  295. * @param element defines the root element
  296. * @returns a string
  297. */
  298. static GetDOMTextContent(element: HTMLElement): string;
  299. }
  300. }
  301. declare module "babylonjs/Misc/logger" {
  302. /**
  303. * Logger used througouht the application to allow configuration of
  304. * the log level required for the messages.
  305. */
  306. export class Logger {
  307. /**
  308. * No log
  309. */
  310. static readonly NoneLogLevel: number;
  311. /**
  312. * Only message logs
  313. */
  314. static readonly MessageLogLevel: number;
  315. /**
  316. * Only warning logs
  317. */
  318. static readonly WarningLogLevel: number;
  319. /**
  320. * Only error logs
  321. */
  322. static readonly ErrorLogLevel: number;
  323. /**
  324. * All logs
  325. */
  326. static readonly AllLogLevel: number;
  327. private static _LogCache;
  328. /**
  329. * Gets a value indicating the number of loading errors
  330. * @ignorenaming
  331. */
  332. static errorsCount: number;
  333. /**
  334. * Callback called when a new log is added
  335. */
  336. static OnNewCacheEntry: (entry: string) => void;
  337. private static _AddLogEntry;
  338. private static _FormatMessage;
  339. private static _LogDisabled;
  340. private static _LogEnabled;
  341. private static _WarnDisabled;
  342. private static _WarnEnabled;
  343. private static _ErrorDisabled;
  344. private static _ErrorEnabled;
  345. /**
  346. * Log a message to the console
  347. */
  348. static Log: (message: string) => void;
  349. /**
  350. * Write a warning message to the console
  351. */
  352. static Warn: (message: string) => void;
  353. /**
  354. * Write an error message to the console
  355. */
  356. static Error: (message: string) => void;
  357. /**
  358. * Gets current log cache (list of logs)
  359. */
  360. static get LogCache(): string;
  361. /**
  362. * Clears the log cache
  363. */
  364. static ClearLogCache(): void;
  365. /**
  366. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  367. */
  368. static set LogLevels(level: number);
  369. }
  370. }
  371. declare module "babylonjs/Misc/typeStore" {
  372. /** @hidden */
  373. export class _TypeStore {
  374. /** @hidden */
  375. static RegisteredTypes: {
  376. [key: string]: Object;
  377. };
  378. /** @hidden */
  379. static GetClass(fqdn: string): any;
  380. }
  381. }
  382. declare module "babylonjs/Misc/stringTools" {
  383. /**
  384. * Helper to manipulate strings
  385. */
  386. export class StringTools {
  387. /**
  388. * Checks for a matching suffix at the end of a string (for ES5 and lower)
  389. * @param str Source string
  390. * @param suffix Suffix to search for in the source string
  391. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  392. */
  393. static EndsWith(str: string, suffix: string): boolean;
  394. /**
  395. * Checks for a matching suffix at the beginning of a string (for ES5 and lower)
  396. * @param str Source string
  397. * @param suffix Suffix to search for in the source string
  398. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  399. */
  400. static StartsWith(str: string, suffix: string): boolean;
  401. /**
  402. * Decodes a buffer into a string
  403. * @param buffer The buffer to decode
  404. * @returns The decoded string
  405. */
  406. static Decode(buffer: Uint8Array | Uint16Array): string;
  407. /**
  408. * Encode a buffer to a base64 string
  409. * @param buffer defines the buffer to encode
  410. * @returns the encoded string
  411. */
  412. static EncodeArrayBufferToBase64(buffer: ArrayBuffer | ArrayBufferView): string;
  413. /**
  414. * Converts a number to string and pads with preceeding zeroes until it is of specified length.
  415. * @param num the number to convert and pad
  416. * @param length the expected length of the string
  417. * @returns the padded string
  418. */
  419. static PadNumber(num: number, length: number): string;
  420. }
  421. }
  422. declare module "babylonjs/Misc/deepCopier" {
  423. /**
  424. * Class containing a set of static utilities functions for deep copy.
  425. */
  426. export class DeepCopier {
  427. /**
  428. * Tries to copy an object by duplicating every property
  429. * @param source defines the source object
  430. * @param destination defines the target object
  431. * @param doNotCopyList defines a list of properties to avoid
  432. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  433. */
  434. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  435. }
  436. }
  437. declare module "babylonjs/Misc/precisionDate" {
  438. /**
  439. * Class containing a set of static utilities functions for precision date
  440. */
  441. export class PrecisionDate {
  442. /**
  443. * Gets either window.performance.now() if supported or Date.now() else
  444. */
  445. static get Now(): number;
  446. }
  447. }
  448. declare module "babylonjs/Misc/devTools" {
  449. /** @hidden */
  450. export class _DevTools {
  451. static WarnImport(name: string): string;
  452. }
  453. }
  454. declare module "babylonjs/Misc/interfaces/iWebRequest" {
  455. /**
  456. * Interface used to define the mechanism to get data from the network
  457. */
  458. export interface IWebRequest {
  459. /**
  460. * Returns client's response url
  461. */
  462. responseURL: string;
  463. /**
  464. * Returns client's status
  465. */
  466. status: number;
  467. /**
  468. * Returns client's status as a text
  469. */
  470. statusText: string;
  471. }
  472. }
  473. declare module "babylonjs/Misc/webRequest" {
  474. import { IWebRequest } from "babylonjs/Misc/interfaces/iWebRequest";
  475. import { Nullable } from "babylonjs/types";
  476. /**
  477. * Extended version of XMLHttpRequest with support for customizations (headers, ...)
  478. */
  479. export class WebRequest implements IWebRequest {
  480. private _xhr;
  481. /**
  482. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  483. * i.e. when loading files, where the server/service expects an Authorization header
  484. */
  485. static CustomRequestHeaders: {
  486. [key: string]: string;
  487. };
  488. /**
  489. * Add callback functions in this array to update all the requests before they get sent to the network
  490. */
  491. static CustomRequestModifiers: ((request: XMLHttpRequest, url: string) => void)[];
  492. private _injectCustomRequestHeaders;
  493. /**
  494. * Gets or sets a function to be called when loading progress changes
  495. */
  496. get onprogress(): ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null;
  497. set onprogress(value: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null);
  498. /**
  499. * Returns client's state
  500. */
  501. get readyState(): number;
  502. /**
  503. * Returns client's status
  504. */
  505. get status(): number;
  506. /**
  507. * Returns client's status as a text
  508. */
  509. get statusText(): string;
  510. /**
  511. * Returns client's response
  512. */
  513. get response(): any;
  514. /**
  515. * Returns client's response url
  516. */
  517. get responseURL(): string;
  518. /**
  519. * Returns client's response as text
  520. */
  521. get responseText(): string;
  522. /**
  523. * Gets or sets the expected response type
  524. */
  525. get responseType(): XMLHttpRequestResponseType;
  526. set responseType(value: XMLHttpRequestResponseType);
  527. /** @hidden */
  528. addEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
  529. /** @hidden */
  530. removeEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
  531. /**
  532. * Cancels any network activity
  533. */
  534. abort(): void;
  535. /**
  536. * Initiates the request. The optional argument provides the request body. The argument is ignored if request method is GET or HEAD
  537. * @param body defines an optional request body
  538. */
  539. send(body?: Document | BodyInit | null): void;
  540. /**
  541. * Sets the request method, request URL
  542. * @param method defines the method to use (GET, POST, etc..)
  543. * @param url defines the url to connect with
  544. */
  545. open(method: string, url: string): void;
  546. /**
  547. * Sets the value of a request header.
  548. * @param name The name of the header whose value is to be set
  549. * @param value The value to set as the body of the header
  550. */
  551. setRequestHeader(name: string, value: string): void;
  552. /**
  553. * Get the string containing the text of a particular header's value.
  554. * @param name The name of the header
  555. * @returns The string containing the text of the given header name
  556. */
  557. getResponseHeader(name: string): Nullable<string>;
  558. }
  559. }
  560. declare module "babylonjs/Misc/fileRequest" {
  561. import { Observable } from "babylonjs/Misc/observable";
  562. /**
  563. * File request interface
  564. */
  565. export interface IFileRequest {
  566. /**
  567. * Raised when the request is complete (success or error).
  568. */
  569. onCompleteObservable: Observable<IFileRequest>;
  570. /**
  571. * Aborts the request for a file.
  572. */
  573. abort: () => void;
  574. }
  575. }
  576. declare module "babylonjs/Materials/Textures/renderTargetCreationOptions" {
  577. /**
  578. * Define options used to create a render target texture
  579. */
  580. export class RenderTargetCreationOptions {
  581. /**
  582. * Specifies is mipmaps must be generated
  583. */
  584. generateMipMaps?: boolean;
  585. /** Specifies whether or not a depth should be allocated in the texture (true by default) */
  586. generateDepthBuffer?: boolean;
  587. /** Specifies whether or not a stencil should be allocated in the texture (false by default)*/
  588. generateStencilBuffer?: boolean;
  589. /** Defines texture type (int by default) */
  590. type?: number;
  591. /** Defines sampling mode (trilinear by default) */
  592. samplingMode?: number;
  593. /** Defines format (RGBA by default) */
  594. format?: number;
  595. }
  596. }
  597. declare module "babylonjs/Engines/constants" {
  598. /** Defines the cross module used constants to avoid circular dependncies */
  599. export class Constants {
  600. /** Defines that alpha blending is disabled */
  601. static readonly ALPHA_DISABLE: number;
  602. /** Defines that alpha blending is SRC ALPHA * SRC + DEST */
  603. static readonly ALPHA_ADD: number;
  604. /** Defines that alpha blending is SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  605. static readonly ALPHA_COMBINE: number;
  606. /** Defines that alpha blending is DEST - SRC * DEST */
  607. static readonly ALPHA_SUBTRACT: number;
  608. /** Defines that alpha blending is SRC * DEST */
  609. static readonly ALPHA_MULTIPLY: number;
  610. /** Defines that alpha blending is SRC ALPHA * SRC + (1 - SRC) * DEST */
  611. static readonly ALPHA_MAXIMIZED: number;
  612. /** Defines that alpha blending is SRC + DEST */
  613. static readonly ALPHA_ONEONE: number;
  614. /** Defines that alpha blending is SRC + (1 - SRC ALPHA) * DEST */
  615. static readonly ALPHA_PREMULTIPLIED: number;
  616. /**
  617. * Defines that alpha blending is SRC + (1 - SRC ALPHA) * DEST
  618. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  619. */
  620. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  621. /** Defines that alpha blending is CST * SRC + (1 - CST) * DEST */
  622. static readonly ALPHA_INTERPOLATE: number;
  623. /**
  624. * Defines that alpha blending is SRC + (1 - SRC) * DEST
  625. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  626. */
  627. static readonly ALPHA_SCREENMODE: number;
  628. /**
  629. * Defines that alpha blending is SRC + DST
  630. * Alpha will be set to SRC ALPHA + DST ALPHA
  631. */
  632. static readonly ALPHA_ONEONE_ONEONE: number;
  633. /**
  634. * Defines that alpha blending is SRC * DST ALPHA + DST
  635. * Alpha will be set to 0
  636. */
  637. static readonly ALPHA_ALPHATOCOLOR: number;
  638. /**
  639. * Defines that alpha blending is SRC * (1 - DST) + DST * (1 - SRC)
  640. */
  641. static readonly ALPHA_REVERSEONEMINUS: number;
  642. /**
  643. * Defines that alpha blending is SRC + DST * (1 - SRC ALPHA)
  644. * Alpha will be set to SRC ALPHA + DST ALPHA * (1 - SRC ALPHA)
  645. */
  646. static readonly ALPHA_SRC_DSTONEMINUSSRCALPHA: number;
  647. /**
  648. * Defines that alpha blending is SRC + DST
  649. * Alpha will be set to SRC ALPHA
  650. */
  651. static readonly ALPHA_ONEONE_ONEZERO: number;
  652. /**
  653. * Defines that alpha blending is SRC * (1 - DST) + DST * (1 - SRC)
  654. * Alpha will be set to DST ALPHA
  655. */
  656. static readonly ALPHA_EXCLUSION: number;
  657. /** Defines that alpha blending equation a SUM */
  658. static readonly ALPHA_EQUATION_ADD: number;
  659. /** Defines that alpha blending equation a SUBSTRACTION */
  660. static readonly ALPHA_EQUATION_SUBSTRACT: number;
  661. /** Defines that alpha blending equation a REVERSE SUBSTRACTION */
  662. static readonly ALPHA_EQUATION_REVERSE_SUBTRACT: number;
  663. /** Defines that alpha blending equation a MAX operation */
  664. static readonly ALPHA_EQUATION_MAX: number;
  665. /** Defines that alpha blending equation a MIN operation */
  666. static readonly ALPHA_EQUATION_MIN: number;
  667. /**
  668. * Defines that alpha blending equation a DARKEN operation:
  669. * It takes the min of the src and sums the alpha channels.
  670. */
  671. static readonly ALPHA_EQUATION_DARKEN: number;
  672. /** Defines that the ressource is not delayed*/
  673. static readonly DELAYLOADSTATE_NONE: number;
  674. /** Defines that the ressource was successfully delay loaded */
  675. static readonly DELAYLOADSTATE_LOADED: number;
  676. /** Defines that the ressource is currently delay loading */
  677. static readonly DELAYLOADSTATE_LOADING: number;
  678. /** Defines that the ressource is delayed and has not started loading */
  679. static readonly DELAYLOADSTATE_NOTLOADED: number;
  680. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  681. static readonly NEVER: number;
  682. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will always pass. i.e. Pixels will be drawn in the order they are drawn */
  683. static readonly ALWAYS: number;
  684. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  685. static readonly LESS: number;
  686. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  687. static readonly EQUAL: number;
  688. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than or equal to the stored value */
  689. static readonly LEQUAL: number;
  690. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  691. static readonly GREATER: number;
  692. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than or equal to the stored value */
  693. static readonly GEQUAL: number;
  694. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is not equal to the stored value */
  695. static readonly NOTEQUAL: number;
  696. /** Passed to stencilOperation to specify that stencil value must be kept */
  697. static readonly KEEP: number;
  698. /** Passed to stencilOperation to specify that stencil value must be replaced */
  699. static readonly REPLACE: number;
  700. /** Passed to stencilOperation to specify that stencil value must be incremented */
  701. static readonly INCR: number;
  702. /** Passed to stencilOperation to specify that stencil value must be decremented */
  703. static readonly DECR: number;
  704. /** Passed to stencilOperation to specify that stencil value must be inverted */
  705. static readonly INVERT: number;
  706. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  707. static readonly INCR_WRAP: number;
  708. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  709. static readonly DECR_WRAP: number;
  710. /** Texture is not repeating outside of 0..1 UVs */
  711. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  712. /** Texture is repeating outside of 0..1 UVs */
  713. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  714. /** Texture is repeating and mirrored */
  715. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  716. /** ALPHA */
  717. static readonly TEXTUREFORMAT_ALPHA: number;
  718. /** LUMINANCE */
  719. static readonly TEXTUREFORMAT_LUMINANCE: number;
  720. /** LUMINANCE_ALPHA */
  721. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  722. /** RGB */
  723. static readonly TEXTUREFORMAT_RGB: number;
  724. /** RGBA */
  725. static readonly TEXTUREFORMAT_RGBA: number;
  726. /** RED */
  727. static readonly TEXTUREFORMAT_RED: number;
  728. /** RED (2nd reference) */
  729. static readonly TEXTUREFORMAT_R: number;
  730. /** RG */
  731. static readonly TEXTUREFORMAT_RG: number;
  732. /** RED_INTEGER */
  733. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  734. /** RED_INTEGER (2nd reference) */
  735. static readonly TEXTUREFORMAT_R_INTEGER: number;
  736. /** RG_INTEGER */
  737. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  738. /** RGB_INTEGER */
  739. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  740. /** RGBA_INTEGER */
  741. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  742. /** UNSIGNED_BYTE */
  743. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  744. /** UNSIGNED_BYTE (2nd reference) */
  745. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  746. /** FLOAT */
  747. static readonly TEXTURETYPE_FLOAT: number;
  748. /** HALF_FLOAT */
  749. static readonly TEXTURETYPE_HALF_FLOAT: number;
  750. /** BYTE */
  751. static readonly TEXTURETYPE_BYTE: number;
  752. /** SHORT */
  753. static readonly TEXTURETYPE_SHORT: number;
  754. /** UNSIGNED_SHORT */
  755. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  756. /** INT */
  757. static readonly TEXTURETYPE_INT: number;
  758. /** UNSIGNED_INT */
  759. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  760. /** UNSIGNED_SHORT_4_4_4_4 */
  761. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  762. /** UNSIGNED_SHORT_5_5_5_1 */
  763. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  764. /** UNSIGNED_SHORT_5_6_5 */
  765. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  766. /** UNSIGNED_INT_2_10_10_10_REV */
  767. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  768. /** UNSIGNED_INT_24_8 */
  769. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  770. /** UNSIGNED_INT_10F_11F_11F_REV */
  771. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  772. /** UNSIGNED_INT_5_9_9_9_REV */
  773. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  774. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  775. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  776. /** nearest is mag = nearest and min = nearest and no mip */
  777. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  778. /** mag = nearest and min = nearest and mip = none */
  779. static readonly TEXTURE_NEAREST_NEAREST: number;
  780. /** Bilinear is mag = linear and min = linear and no mip */
  781. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  782. /** mag = linear and min = linear and mip = none */
  783. static readonly TEXTURE_LINEAR_LINEAR: number;
  784. /** Trilinear is mag = linear and min = linear and mip = linear */
  785. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  786. /** Trilinear is mag = linear and min = linear and mip = linear */
  787. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  788. /** mag = nearest and min = nearest and mip = nearest */
  789. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  790. /** mag = nearest and min = linear and mip = nearest */
  791. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  792. /** mag = nearest and min = linear and mip = linear */
  793. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  794. /** mag = nearest and min = linear and mip = none */
  795. static readonly TEXTURE_NEAREST_LINEAR: number;
  796. /** nearest is mag = nearest and min = nearest and mip = linear */
  797. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  798. /** mag = linear and min = nearest and mip = nearest */
  799. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  800. /** mag = linear and min = nearest and mip = linear */
  801. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  802. /** Bilinear is mag = linear and min = linear and mip = nearest */
  803. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  804. /** mag = linear and min = nearest and mip = none */
  805. static readonly TEXTURE_LINEAR_NEAREST: number;
  806. /** Explicit coordinates mode */
  807. static readonly TEXTURE_EXPLICIT_MODE: number;
  808. /** Spherical coordinates mode */
  809. static readonly TEXTURE_SPHERICAL_MODE: number;
  810. /** Planar coordinates mode */
  811. static readonly TEXTURE_PLANAR_MODE: number;
  812. /** Cubic coordinates mode */
  813. static readonly TEXTURE_CUBIC_MODE: number;
  814. /** Projection coordinates mode */
  815. static readonly TEXTURE_PROJECTION_MODE: number;
  816. /** Skybox coordinates mode */
  817. static readonly TEXTURE_SKYBOX_MODE: number;
  818. /** Inverse Cubic coordinates mode */
  819. static readonly TEXTURE_INVCUBIC_MODE: number;
  820. /** Equirectangular coordinates mode */
  821. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  822. /** Equirectangular Fixed coordinates mode */
  823. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  824. /** Equirectangular Fixed Mirrored coordinates mode */
  825. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  826. /** Offline (baking) quality for texture filtering */
  827. static readonly TEXTURE_FILTERING_QUALITY_OFFLINE: number;
  828. /** High quality for texture filtering */
  829. static readonly TEXTURE_FILTERING_QUALITY_HIGH: number;
  830. /** Medium quality for texture filtering */
  831. static readonly TEXTURE_FILTERING_QUALITY_MEDIUM: number;
  832. /** Low quality for texture filtering */
  833. static readonly TEXTURE_FILTERING_QUALITY_LOW: number;
  834. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  835. static readonly SCALEMODE_FLOOR: number;
  836. /** Defines that texture rescaling will look for the nearest power of 2 size */
  837. static readonly SCALEMODE_NEAREST: number;
  838. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  839. static readonly SCALEMODE_CEILING: number;
  840. /**
  841. * The dirty texture flag value
  842. */
  843. static readonly MATERIAL_TextureDirtyFlag: number;
  844. /**
  845. * The dirty light flag value
  846. */
  847. static readonly MATERIAL_LightDirtyFlag: number;
  848. /**
  849. * The dirty fresnel flag value
  850. */
  851. static readonly MATERIAL_FresnelDirtyFlag: number;
  852. /**
  853. * The dirty attribute flag value
  854. */
  855. static readonly MATERIAL_AttributesDirtyFlag: number;
  856. /**
  857. * The dirty misc flag value
  858. */
  859. static readonly MATERIAL_MiscDirtyFlag: number;
  860. /**
  861. * The all dirty flag value
  862. */
  863. static readonly MATERIAL_AllDirtyFlag: number;
  864. /**
  865. * Returns the triangle fill mode
  866. */
  867. static readonly MATERIAL_TriangleFillMode: number;
  868. /**
  869. * Returns the wireframe mode
  870. */
  871. static readonly MATERIAL_WireFrameFillMode: number;
  872. /**
  873. * Returns the point fill mode
  874. */
  875. static readonly MATERIAL_PointFillMode: number;
  876. /**
  877. * Returns the point list draw mode
  878. */
  879. static readonly MATERIAL_PointListDrawMode: number;
  880. /**
  881. * Returns the line list draw mode
  882. */
  883. static readonly MATERIAL_LineListDrawMode: number;
  884. /**
  885. * Returns the line loop draw mode
  886. */
  887. static readonly MATERIAL_LineLoopDrawMode: number;
  888. /**
  889. * Returns the line strip draw mode
  890. */
  891. static readonly MATERIAL_LineStripDrawMode: number;
  892. /**
  893. * Returns the triangle strip draw mode
  894. */
  895. static readonly MATERIAL_TriangleStripDrawMode: number;
  896. /**
  897. * Returns the triangle fan draw mode
  898. */
  899. static readonly MATERIAL_TriangleFanDrawMode: number;
  900. /**
  901. * Stores the clock-wise side orientation
  902. */
  903. static readonly MATERIAL_ClockWiseSideOrientation: number;
  904. /**
  905. * Stores the counter clock-wise side orientation
  906. */
  907. static readonly MATERIAL_CounterClockWiseSideOrientation: number;
  908. /**
  909. * Nothing
  910. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  911. */
  912. static readonly ACTION_NothingTrigger: number;
  913. /**
  914. * On pick
  915. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  916. */
  917. static readonly ACTION_OnPickTrigger: number;
  918. /**
  919. * On left pick
  920. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  921. */
  922. static readonly ACTION_OnLeftPickTrigger: number;
  923. /**
  924. * On right pick
  925. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  926. */
  927. static readonly ACTION_OnRightPickTrigger: number;
  928. /**
  929. * On center pick
  930. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  931. */
  932. static readonly ACTION_OnCenterPickTrigger: number;
  933. /**
  934. * On pick down
  935. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  936. */
  937. static readonly ACTION_OnPickDownTrigger: number;
  938. /**
  939. * On double pick
  940. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  941. */
  942. static readonly ACTION_OnDoublePickTrigger: number;
  943. /**
  944. * On pick up
  945. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  946. */
  947. static readonly ACTION_OnPickUpTrigger: number;
  948. /**
  949. * On pick out.
  950. * This trigger will only be raised if you also declared a OnPickDown
  951. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  952. */
  953. static readonly ACTION_OnPickOutTrigger: number;
  954. /**
  955. * On long press
  956. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  957. */
  958. static readonly ACTION_OnLongPressTrigger: number;
  959. /**
  960. * On pointer over
  961. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  962. */
  963. static readonly ACTION_OnPointerOverTrigger: number;
  964. /**
  965. * On pointer out
  966. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  967. */
  968. static readonly ACTION_OnPointerOutTrigger: number;
  969. /**
  970. * On every frame
  971. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  972. */
  973. static readonly ACTION_OnEveryFrameTrigger: number;
  974. /**
  975. * On intersection enter
  976. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  977. */
  978. static readonly ACTION_OnIntersectionEnterTrigger: number;
  979. /**
  980. * On intersection exit
  981. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  982. */
  983. static readonly ACTION_OnIntersectionExitTrigger: number;
  984. /**
  985. * On key down
  986. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  987. */
  988. static readonly ACTION_OnKeyDownTrigger: number;
  989. /**
  990. * On key up
  991. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  992. */
  993. static readonly ACTION_OnKeyUpTrigger: number;
  994. /**
  995. * Billboard mode will only apply to Y axis
  996. */
  997. static readonly PARTICLES_BILLBOARDMODE_Y: number;
  998. /**
  999. * Billboard mode will apply to all axes
  1000. */
  1001. static readonly PARTICLES_BILLBOARDMODE_ALL: number;
  1002. /**
  1003. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  1004. */
  1005. static readonly PARTICLES_BILLBOARDMODE_STRETCHED: number;
  1006. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  1007. * Test order :
  1008. * Is the bounding sphere outside the frustum ?
  1009. * If not, are the bounding box vertices outside the frustum ?
  1010. * It not, then the cullable object is in the frustum.
  1011. */
  1012. static readonly MESHES_CULLINGSTRATEGY_STANDARD: number;
  1013. /** Culling strategy : Bounding Sphere Only.
  1014. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  1015. * It's also less accurate than the standard because some not visible objects can still be selected.
  1016. * Test : is the bounding sphere outside the frustum ?
  1017. * If not, then the cullable object is in the frustum.
  1018. */
  1019. static readonly MESHES_CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  1020. /** Culling strategy : Optimistic Inclusion.
  1021. * This in an inclusion test first, then the standard exclusion test.
  1022. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  1023. * This could also be a little slower than the standard test when the tested object center is not the frustum but one of its bounding box vertex is still inside.
  1024. * Anyway, it's as accurate as the standard strategy.
  1025. * Test :
  1026. * Is the cullable object bounding sphere center in the frustum ?
  1027. * If not, apply the default culling strategy.
  1028. */
  1029. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  1030. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  1031. * This in an inclusion test first, then the bounding sphere only exclusion test.
  1032. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  1033. * This could also be a little slower than the BoundingSphereOnly strategy when the tested object center is not in the frustum but its bounding sphere still intersects it.
  1034. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  1035. * Test :
  1036. * Is the cullable object bounding sphere center in the frustum ?
  1037. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  1038. */
  1039. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  1040. /**
  1041. * No logging while loading
  1042. */
  1043. static readonly SCENELOADER_NO_LOGGING: number;
  1044. /**
  1045. * Minimal logging while loading
  1046. */
  1047. static readonly SCENELOADER_MINIMAL_LOGGING: number;
  1048. /**
  1049. * Summary logging while loading
  1050. */
  1051. static readonly SCENELOADER_SUMMARY_LOGGING: number;
  1052. /**
  1053. * Detailled logging while loading
  1054. */
  1055. static readonly SCENELOADER_DETAILED_LOGGING: number;
  1056. /**
  1057. * Prepass texture index for color
  1058. */
  1059. static readonly PREPASS_COLOR_INDEX: number;
  1060. /**
  1061. * Prepass texture index for irradiance
  1062. */
  1063. static readonly PREPASS_IRRADIANCE_INDEX: number;
  1064. /**
  1065. * Prepass texture index for depth + normal
  1066. */
  1067. static readonly PREPASS_DEPTHNORMAL_INDEX: number;
  1068. /**
  1069. * Prepass texture index for albedo
  1070. */
  1071. static readonly PREPASS_ALBEDO_INDEX: number;
  1072. }
  1073. }
  1074. declare module "babylonjs/Materials/Textures/internalTextureLoader" {
  1075. import { Nullable } from "babylonjs/types";
  1076. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  1077. /**
  1078. * This represents the required contract to create a new type of texture loader.
  1079. */
  1080. export interface IInternalTextureLoader {
  1081. /**
  1082. * Defines wether the loader supports cascade loading the different faces.
  1083. */
  1084. supportCascades: boolean;
  1085. /**
  1086. * This returns if the loader support the current file information.
  1087. * @param extension defines the file extension of the file being loaded
  1088. * @param mimeType defines the optional mime type of the file being loaded
  1089. * @returns true if the loader can load the specified file
  1090. */
  1091. canLoad(extension: string, mimeType?: string): boolean;
  1092. /**
  1093. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  1094. * @param data contains the texture data
  1095. * @param texture defines the BabylonJS internal texture
  1096. * @param createPolynomials will be true if polynomials have been requested
  1097. * @param onLoad defines the callback to trigger once the texture is ready
  1098. * @param onError defines the callback to trigger in case of error
  1099. */
  1100. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  1101. /**
  1102. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  1103. * @param data contains the texture data
  1104. * @param texture defines the BabylonJS internal texture
  1105. * @param callback defines the method to call once ready to upload
  1106. */
  1107. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed?: boolean) => void): void;
  1108. }
  1109. }
  1110. declare module "babylonjs/Engines/IPipelineContext" {
  1111. /**
  1112. * Class used to store and describe the pipeline context associated with an effect
  1113. */
  1114. export interface IPipelineContext {
  1115. /**
  1116. * Gets a boolean indicating that this pipeline context is supporting asynchronous creating
  1117. */
  1118. isAsync: boolean;
  1119. /**
  1120. * Gets a boolean indicating that the context is ready to be used (like shaders / pipelines are compiled and ready for instance)
  1121. */
  1122. isReady: boolean;
  1123. /** @hidden */
  1124. _getVertexShaderCode(): string | null;
  1125. /** @hidden */
  1126. _getFragmentShaderCode(): string | null;
  1127. /** @hidden */
  1128. _handlesSpectorRebuildCallback(onCompiled: (compiledObject: any) => void): void;
  1129. }
  1130. }
  1131. declare module "babylonjs/Meshes/dataBuffer" {
  1132. /**
  1133. * Class used to store gfx data (like WebGLBuffer)
  1134. */
  1135. export class DataBuffer {
  1136. /**
  1137. * Gets or sets the number of objects referencing this buffer
  1138. */
  1139. references: number;
  1140. /** Gets or sets the size of the underlying buffer */
  1141. capacity: number;
  1142. /**
  1143. * Gets or sets a boolean indicating if the buffer contains 32bits indices
  1144. */
  1145. is32Bits: boolean;
  1146. /**
  1147. * Gets the underlying buffer
  1148. */
  1149. get underlyingResource(): any;
  1150. }
  1151. }
  1152. declare module "babylonjs/Engines/Processors/iShaderProcessor" {
  1153. /** @hidden */
  1154. export interface IShaderProcessor {
  1155. attributeProcessor?: (attribute: string) => string;
  1156. varyingProcessor?: (varying: string, isFragment: boolean) => string;
  1157. uniformProcessor?: (uniform: string, isFragment: boolean) => string;
  1158. uniformBufferProcessor?: (uniformBuffer: string, isFragment: boolean) => string;
  1159. endOfUniformBufferProcessor?: (closingBracketLine: string, isFragment: boolean) => string;
  1160. lineProcessor?: (line: string, isFragment: boolean) => string;
  1161. preProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  1162. postProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  1163. }
  1164. }
  1165. declare module "babylonjs/Engines/Processors/shaderProcessingOptions" {
  1166. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  1167. /** @hidden */
  1168. export interface ProcessingOptions {
  1169. defines: string[];
  1170. indexParameters: any;
  1171. isFragment: boolean;
  1172. shouldUseHighPrecisionShader: boolean;
  1173. supportsUniformBuffers: boolean;
  1174. shadersRepository: string;
  1175. includesShadersStore: {
  1176. [key: string]: string;
  1177. };
  1178. processor?: IShaderProcessor;
  1179. version: string;
  1180. platformName: string;
  1181. lookForClosingBracketForUniformBuffer?: boolean;
  1182. }
  1183. }
  1184. declare module "babylonjs/Engines/Processors/shaderCodeNode" {
  1185. import { ProcessingOptions } from "babylonjs/Engines/Processors/shaderProcessingOptions";
  1186. /** @hidden */
  1187. export class ShaderCodeNode {
  1188. line: string;
  1189. children: ShaderCodeNode[];
  1190. additionalDefineKey?: string;
  1191. additionalDefineValue?: string;
  1192. isValid(preprocessors: {
  1193. [key: string]: string;
  1194. }): boolean;
  1195. process(preprocessors: {
  1196. [key: string]: string;
  1197. }, options: ProcessingOptions): string;
  1198. }
  1199. }
  1200. declare module "babylonjs/Engines/Processors/shaderCodeCursor" {
  1201. /** @hidden */
  1202. export class ShaderCodeCursor {
  1203. private _lines;
  1204. lineIndex: number;
  1205. get currentLine(): string;
  1206. get canRead(): boolean;
  1207. set lines(value: string[]);
  1208. }
  1209. }
  1210. declare module "babylonjs/Engines/Processors/shaderCodeConditionNode" {
  1211. import { ShaderCodeNode } from "babylonjs/Engines/Processors/shaderCodeNode";
  1212. import { ProcessingOptions } from "babylonjs/Engines/Processors/shaderProcessingOptions";
  1213. /** @hidden */
  1214. export class ShaderCodeConditionNode extends ShaderCodeNode {
  1215. process(preprocessors: {
  1216. [key: string]: string;
  1217. }, options: ProcessingOptions): string;
  1218. }
  1219. }
  1220. declare module "babylonjs/Engines/Processors/Expressions/shaderDefineExpression" {
  1221. /** @hidden */
  1222. export class ShaderDefineExpression {
  1223. isTrue(preprocessors: {
  1224. [key: string]: string;
  1225. }): boolean;
  1226. private static _OperatorPriority;
  1227. private static _Stack;
  1228. static postfixToInfix(postfix: string[]): string;
  1229. static infixToPostfix(infix: string): string[];
  1230. }
  1231. }
  1232. declare module "babylonjs/Engines/Processors/shaderCodeTestNode" {
  1233. import { ShaderCodeNode } from "babylonjs/Engines/Processors/shaderCodeNode";
  1234. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1235. /** @hidden */
  1236. export class ShaderCodeTestNode extends ShaderCodeNode {
  1237. testExpression: ShaderDefineExpression;
  1238. isValid(preprocessors: {
  1239. [key: string]: string;
  1240. }): boolean;
  1241. }
  1242. }
  1243. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineIsDefinedOperator" {
  1244. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1245. /** @hidden */
  1246. export class ShaderDefineIsDefinedOperator extends ShaderDefineExpression {
  1247. define: string;
  1248. not: boolean;
  1249. constructor(define: string, not?: boolean);
  1250. isTrue(preprocessors: {
  1251. [key: string]: string;
  1252. }): boolean;
  1253. }
  1254. }
  1255. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineOrOperator" {
  1256. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1257. /** @hidden */
  1258. export class ShaderDefineOrOperator extends ShaderDefineExpression {
  1259. leftOperand: ShaderDefineExpression;
  1260. rightOperand: ShaderDefineExpression;
  1261. isTrue(preprocessors: {
  1262. [key: string]: string;
  1263. }): boolean;
  1264. }
  1265. }
  1266. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineAndOperator" {
  1267. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1268. /** @hidden */
  1269. export class ShaderDefineAndOperator extends ShaderDefineExpression {
  1270. leftOperand: ShaderDefineExpression;
  1271. rightOperand: ShaderDefineExpression;
  1272. isTrue(preprocessors: {
  1273. [key: string]: string;
  1274. }): boolean;
  1275. }
  1276. }
  1277. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineArithmeticOperator" {
  1278. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1279. /** @hidden */
  1280. export class ShaderDefineArithmeticOperator extends ShaderDefineExpression {
  1281. define: string;
  1282. operand: string;
  1283. testValue: string;
  1284. constructor(define: string, operand: string, testValue: string);
  1285. isTrue(preprocessors: {
  1286. [key: string]: string;
  1287. }): boolean;
  1288. }
  1289. }
  1290. declare module "babylonjs/Offline/IOfflineProvider" {
  1291. /**
  1292. * Class used to enable access to offline support
  1293. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  1294. */
  1295. export interface IOfflineProvider {
  1296. /**
  1297. * Gets a boolean indicating if scene must be saved in the database
  1298. */
  1299. enableSceneOffline: boolean;
  1300. /**
  1301. * Gets a boolean indicating if textures must be saved in the database
  1302. */
  1303. enableTexturesOffline: boolean;
  1304. /**
  1305. * Open the offline support and make it available
  1306. * @param successCallback defines the callback to call on success
  1307. * @param errorCallback defines the callback to call on error
  1308. */
  1309. open(successCallback: () => void, errorCallback: () => void): void;
  1310. /**
  1311. * Loads an image from the offline support
  1312. * @param url defines the url to load from
  1313. * @param image defines the target DOM image
  1314. */
  1315. loadImage(url: string, image: HTMLImageElement): void;
  1316. /**
  1317. * Loads a file from offline support
  1318. * @param url defines the URL to load from
  1319. * @param sceneLoaded defines a callback to call on success
  1320. * @param progressCallBack defines a callback to call when progress changed
  1321. * @param errorCallback defines a callback to call on error
  1322. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  1323. */
  1324. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  1325. }
  1326. }
  1327. declare module "babylonjs/Misc/filesInputStore" {
  1328. /**
  1329. * Class used to help managing file picking and drag'n'drop
  1330. * File Storage
  1331. */
  1332. export class FilesInputStore {
  1333. /**
  1334. * List of files ready to be loaded
  1335. */
  1336. static FilesToLoad: {
  1337. [key: string]: File;
  1338. };
  1339. }
  1340. }
  1341. declare module "babylonjs/Misc/retryStrategy" {
  1342. import { WebRequest } from "babylonjs/Misc/webRequest";
  1343. /**
  1344. * Class used to define a retry strategy when error happens while loading assets
  1345. */
  1346. export class RetryStrategy {
  1347. /**
  1348. * Function used to defines an exponential back off strategy
  1349. * @param maxRetries defines the maximum number of retries (3 by default)
  1350. * @param baseInterval defines the interval between retries
  1351. * @returns the strategy function to use
  1352. */
  1353. static ExponentialBackoff(maxRetries?: number, baseInterval?: number): (url: string, request: WebRequest, retryIndex: number) => number;
  1354. }
  1355. }
  1356. declare module "babylonjs/Misc/baseError" {
  1357. /**
  1358. * @ignore
  1359. * Application error to support additional information when loading a file
  1360. */
  1361. export abstract class BaseError extends Error {
  1362. protected static _setPrototypeOf: (o: any, proto: object | null) => any;
  1363. }
  1364. }
  1365. declare module "babylonjs/Misc/fileTools" {
  1366. import { WebRequest } from "babylonjs/Misc/webRequest";
  1367. import { Nullable } from "babylonjs/types";
  1368. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  1369. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  1370. import { BaseError } from "babylonjs/Misc/baseError";
  1371. /** @ignore */
  1372. export class LoadFileError extends BaseError {
  1373. request?: WebRequest;
  1374. file?: File;
  1375. /**
  1376. * Creates a new LoadFileError
  1377. * @param message defines the message of the error
  1378. * @param request defines the optional web request
  1379. * @param file defines the optional file
  1380. */
  1381. constructor(message: string, object?: WebRequest | File);
  1382. }
  1383. /** @ignore */
  1384. export class RequestFileError extends BaseError {
  1385. request: WebRequest;
  1386. /**
  1387. * Creates a new LoadFileError
  1388. * @param message defines the message of the error
  1389. * @param request defines the optional web request
  1390. */
  1391. constructor(message: string, request: WebRequest);
  1392. }
  1393. /** @ignore */
  1394. export class ReadFileError extends BaseError {
  1395. file: File;
  1396. /**
  1397. * Creates a new ReadFileError
  1398. * @param message defines the message of the error
  1399. * @param file defines the optional file
  1400. */
  1401. constructor(message: string, file: File);
  1402. }
  1403. /**
  1404. * @hidden
  1405. */
  1406. export class FileTools {
  1407. /**
  1408. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  1409. */
  1410. static DefaultRetryStrategy: (url: string, request: WebRequest, retryIndex: number) => number;
  1411. /**
  1412. * Gets or sets the base URL to use to load assets
  1413. */
  1414. static BaseUrl: string;
  1415. /**
  1416. * Default behaviour for cors in the application.
  1417. * It can be a string if the expected behavior is identical in the entire app.
  1418. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  1419. */
  1420. static CorsBehavior: string | ((url: string | string[]) => string);
  1421. /**
  1422. * Gets or sets a function used to pre-process url before using them to load assets
  1423. */
  1424. static PreprocessUrl: (url: string) => string;
  1425. /**
  1426. * Removes unwanted characters from an url
  1427. * @param url defines the url to clean
  1428. * @returns the cleaned url
  1429. */
  1430. private static _CleanUrl;
  1431. /**
  1432. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  1433. * @param url define the url we are trying
  1434. * @param element define the dom element where to configure the cors policy
  1435. */
  1436. static SetCorsBehavior(url: string | string[], element: {
  1437. crossOrigin: string | null;
  1438. }): void;
  1439. /**
  1440. * Loads an image as an HTMLImageElement.
  1441. * @param input url string, ArrayBuffer, or Blob to load
  1442. * @param onLoad callback called when the image successfully loads
  1443. * @param onError callback called when the image fails to load
  1444. * @param offlineProvider offline provider for caching
  1445. * @param mimeType optional mime type
  1446. * @returns the HTMLImageElement of the loaded image
  1447. */
  1448. static LoadImage(input: string | ArrayBuffer | ArrayBufferView | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  1449. /**
  1450. * Reads a file from a File object
  1451. * @param file defines the file to load
  1452. * @param onSuccess defines the callback to call when data is loaded
  1453. * @param onProgress defines the callback to call during loading process
  1454. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  1455. * @param onError defines the callback to call when an error occurs
  1456. * @returns a file request object
  1457. */
  1458. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  1459. /**
  1460. * Loads a file from a url
  1461. * @param url url to load
  1462. * @param onSuccess callback called when the file successfully loads
  1463. * @param onProgress callback called while file is loading (if the server supports this mode)
  1464. * @param offlineProvider defines the offline provider for caching
  1465. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  1466. * @param onError callback called when the file fails to load
  1467. * @returns a file request object
  1468. */
  1469. static LoadFile(url: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (ev: ProgressEvent) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (request?: WebRequest, exception?: LoadFileError) => void): IFileRequest;
  1470. /**
  1471. * Loads a file
  1472. * @param url url to load
  1473. * @param onSuccess callback called when the file successfully loads
  1474. * @param onProgress callback called while file is loading (if the server supports this mode)
  1475. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  1476. * @param onError callback called when the file fails to load
  1477. * @param onOpened callback called when the web request is opened
  1478. * @returns a file request object
  1479. */
  1480. static RequestFile(url: string, onSuccess: (data: string | ArrayBuffer, request?: WebRequest) => void, onProgress?: (event: ProgressEvent) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (error: RequestFileError) => void, onOpened?: (request: WebRequest) => void): IFileRequest;
  1481. /**
  1482. * Checks if the loaded document was accessed via `file:`-Protocol.
  1483. * @returns boolean
  1484. */
  1485. static IsFileURL(): boolean;
  1486. }
  1487. }
  1488. declare module "babylonjs/Engines/Processors/shaderProcessor" {
  1489. import { ProcessingOptions } from "babylonjs/Engines/Processors/shaderProcessingOptions";
  1490. import { WebRequest } from "babylonjs/Misc/webRequest";
  1491. import { LoadFileError } from "babylonjs/Misc/fileTools";
  1492. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  1493. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  1494. /** @hidden */
  1495. export class ShaderProcessor {
  1496. static Process(sourceCode: string, options: ProcessingOptions, callback: (migratedCode: string) => void): void;
  1497. private static _ProcessPrecision;
  1498. private static _ExtractOperation;
  1499. private static _BuildSubExpression;
  1500. private static _BuildExpression;
  1501. private static _MoveCursorWithinIf;
  1502. private static _MoveCursor;
  1503. private static _EvaluatePreProcessors;
  1504. private static _PreparePreProcessors;
  1505. private static _ProcessShaderConversion;
  1506. private static _ProcessIncludes;
  1507. /**
  1508. * Loads a file from a url
  1509. * @param url url to load
  1510. * @param onSuccess callback called when the file successfully loads
  1511. * @param onProgress callback called while file is loading (if the server supports this mode)
  1512. * @param offlineProvider defines the offline provider for caching
  1513. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  1514. * @param onError callback called when the file fails to load
  1515. * @returns a file request object
  1516. * @hidden
  1517. */
  1518. static _FileToolsLoadFile(url: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (ev: ProgressEvent) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (request?: WebRequest, exception?: LoadFileError) => void): IFileRequest;
  1519. }
  1520. }
  1521. declare module "babylonjs/Maths/math.like" {
  1522. import { float, int, DeepImmutable } from "babylonjs/types";
  1523. /**
  1524. * @hidden
  1525. */
  1526. export interface IColor4Like {
  1527. r: float;
  1528. g: float;
  1529. b: float;
  1530. a: float;
  1531. }
  1532. /**
  1533. * @hidden
  1534. */
  1535. export interface IColor3Like {
  1536. r: float;
  1537. g: float;
  1538. b: float;
  1539. }
  1540. /**
  1541. * @hidden
  1542. */
  1543. export interface IVector4Like {
  1544. x: float;
  1545. y: float;
  1546. z: float;
  1547. w: float;
  1548. }
  1549. /**
  1550. * @hidden
  1551. */
  1552. export interface IVector3Like {
  1553. x: float;
  1554. y: float;
  1555. z: float;
  1556. }
  1557. /**
  1558. * @hidden
  1559. */
  1560. export interface IVector2Like {
  1561. x: float;
  1562. y: float;
  1563. }
  1564. /**
  1565. * @hidden
  1566. */
  1567. export interface IMatrixLike {
  1568. toArray(): DeepImmutable<Float32Array | Array<number>>;
  1569. updateFlag: int;
  1570. }
  1571. /**
  1572. * @hidden
  1573. */
  1574. export interface IViewportLike {
  1575. x: float;
  1576. y: float;
  1577. width: float;
  1578. height: float;
  1579. }
  1580. /**
  1581. * @hidden
  1582. */
  1583. export interface IPlaneLike {
  1584. normal: IVector3Like;
  1585. d: float;
  1586. normalize(): void;
  1587. }
  1588. }
  1589. declare module "babylonjs/Materials/iEffectFallbacks" {
  1590. import { Effect } from "babylonjs/Materials/effect";
  1591. /**
  1592. * Interface used to define common properties for effect fallbacks
  1593. */
  1594. export interface IEffectFallbacks {
  1595. /**
  1596. * Removes the defines that should be removed when falling back.
  1597. * @param currentDefines defines the current define statements for the shader.
  1598. * @param effect defines the current effect we try to compile
  1599. * @returns The resulting defines with defines of the current rank removed.
  1600. */
  1601. reduce(currentDefines: string, effect: Effect): string;
  1602. /**
  1603. * Removes the fallback from the bound mesh.
  1604. */
  1605. unBindMesh(): void;
  1606. /**
  1607. * Checks to see if more fallbacks are still availible.
  1608. */
  1609. hasMoreFallbacks: boolean;
  1610. }
  1611. }
  1612. declare module "babylonjs/Misc/andOrNotEvaluator" {
  1613. /**
  1614. * Class used to evalaute queries containing `and` and `or` operators
  1615. */
  1616. export class AndOrNotEvaluator {
  1617. /**
  1618. * Evaluate a query
  1619. * @param query defines the query to evaluate
  1620. * @param evaluateCallback defines the callback used to filter result
  1621. * @returns true if the query matches
  1622. */
  1623. static Eval(query: string, evaluateCallback: (val: any) => boolean): boolean;
  1624. private static _HandleParenthesisContent;
  1625. private static _SimplifyNegation;
  1626. }
  1627. }
  1628. declare module "babylonjs/Misc/tags" {
  1629. /**
  1630. * Class used to store custom tags
  1631. */
  1632. export class Tags {
  1633. /**
  1634. * Adds support for tags on the given object
  1635. * @param obj defines the object to use
  1636. */
  1637. static EnableFor(obj: any): void;
  1638. /**
  1639. * Removes tags support
  1640. * @param obj defines the object to use
  1641. */
  1642. static DisableFor(obj: any): void;
  1643. /**
  1644. * Gets a boolean indicating if the given object has tags
  1645. * @param obj defines the object to use
  1646. * @returns a boolean
  1647. */
  1648. static HasTags(obj: any): boolean;
  1649. /**
  1650. * Gets the tags available on a given object
  1651. * @param obj defines the object to use
  1652. * @param asString defines if the tags must be returned as a string instead of an array of strings
  1653. * @returns the tags
  1654. */
  1655. static GetTags(obj: any, asString?: boolean): any;
  1656. /**
  1657. * Adds tags to an object
  1658. * @param obj defines the object to use
  1659. * @param tagsString defines the tag string. The tags 'true' and 'false' are reserved and cannot be used as tags.
  1660. * A tag cannot start with '||', '&&', and '!'. It cannot contain whitespaces
  1661. */
  1662. static AddTagsTo(obj: any, tagsString: string): void;
  1663. /**
  1664. * @hidden
  1665. */
  1666. static _AddTagTo(obj: any, tag: string): void;
  1667. /**
  1668. * Removes specific tags from a specific object
  1669. * @param obj defines the object to use
  1670. * @param tagsString defines the tags to remove
  1671. */
  1672. static RemoveTagsFrom(obj: any, tagsString: string): void;
  1673. /**
  1674. * @hidden
  1675. */
  1676. static _RemoveTagFrom(obj: any, tag: string): void;
  1677. /**
  1678. * Defines if tags hosted on an object match a given query
  1679. * @param obj defines the object to use
  1680. * @param tagsQuery defines the tag query
  1681. * @returns a boolean
  1682. */
  1683. static MatchesQuery(obj: any, tagsQuery: string): boolean;
  1684. }
  1685. }
  1686. declare module "babylonjs/Maths/math.scalar" {
  1687. /**
  1688. * Scalar computation library
  1689. */
  1690. export class Scalar {
  1691. /**
  1692. * Two pi constants convenient for computation.
  1693. */
  1694. static TwoPi: number;
  1695. /**
  1696. * Boolean : true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  1697. * @param a number
  1698. * @param b number
  1699. * @param epsilon (default = 1.401298E-45)
  1700. * @returns true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  1701. */
  1702. static WithinEpsilon(a: number, b: number, epsilon?: number): boolean;
  1703. /**
  1704. * Returns a string : the upper case translation of the number i to hexadecimal.
  1705. * @param i number
  1706. * @returns the upper case translation of the number i to hexadecimal.
  1707. */
  1708. static ToHex(i: number): string;
  1709. /**
  1710. * Returns -1 if value is negative and +1 is value is positive.
  1711. * @param value the value
  1712. * @returns the value itself if it's equal to zero.
  1713. */
  1714. static Sign(value: number): number;
  1715. /**
  1716. * Returns the value itself if it's between min and max.
  1717. * Returns min if the value is lower than min.
  1718. * Returns max if the value is greater than max.
  1719. * @param value the value to clmap
  1720. * @param min the min value to clamp to (default: 0)
  1721. * @param max the max value to clamp to (default: 1)
  1722. * @returns the clamped value
  1723. */
  1724. static Clamp(value: number, min?: number, max?: number): number;
  1725. /**
  1726. * the log2 of value.
  1727. * @param value the value to compute log2 of
  1728. * @returns the log2 of value.
  1729. */
  1730. static Log2(value: number): number;
  1731. /**
  1732. * Loops the value, so that it is never larger than length and never smaller than 0.
  1733. *
  1734. * This is similar to the modulo operator but it works with floating point numbers.
  1735. * For example, using 3.0 for t and 2.5 for length, the result would be 0.5.
  1736. * With t = 5 and length = 2.5, the result would be 0.0.
  1737. * Note, however, that the behaviour is not defined for negative numbers as it is for the modulo operator
  1738. * @param value the value
  1739. * @param length the length
  1740. * @returns the looped value
  1741. */
  1742. static Repeat(value: number, length: number): number;
  1743. /**
  1744. * Normalize the value between 0.0 and 1.0 using min and max values
  1745. * @param value value to normalize
  1746. * @param min max to normalize between
  1747. * @param max min to normalize between
  1748. * @returns the normalized value
  1749. */
  1750. static Normalize(value: number, min: number, max: number): number;
  1751. /**
  1752. * Denormalize the value from 0.0 and 1.0 using min and max values
  1753. * @param normalized value to denormalize
  1754. * @param min max to denormalize between
  1755. * @param max min to denormalize between
  1756. * @returns the denormalized value
  1757. */
  1758. static Denormalize(normalized: number, min: number, max: number): number;
  1759. /**
  1760. * Calculates the shortest difference between two given angles given in degrees.
  1761. * @param current current angle in degrees
  1762. * @param target target angle in degrees
  1763. * @returns the delta
  1764. */
  1765. static DeltaAngle(current: number, target: number): number;
  1766. /**
  1767. * PingPongs the value t, so that it is never larger than length and never smaller than 0.
  1768. * @param tx value
  1769. * @param length length
  1770. * @returns The returned value will move back and forth between 0 and length
  1771. */
  1772. static PingPong(tx: number, length: number): number;
  1773. /**
  1774. * Interpolates between min and max with smoothing at the limits.
  1775. *
  1776. * This function interpolates between min and max in a similar way to Lerp. However, the interpolation will gradually speed up
  1777. * from the start and slow down toward the end. This is useful for creating natural-looking animation, fading and other transitions.
  1778. * @param from from
  1779. * @param to to
  1780. * @param tx value
  1781. * @returns the smooth stepped value
  1782. */
  1783. static SmoothStep(from: number, to: number, tx: number): number;
  1784. /**
  1785. * Moves a value current towards target.
  1786. *
  1787. * This is essentially the same as Mathf.Lerp but instead the function will ensure that the speed never exceeds maxDelta.
  1788. * Negative values of maxDelta pushes the value away from target.
  1789. * @param current current value
  1790. * @param target target value
  1791. * @param maxDelta max distance to move
  1792. * @returns resulting value
  1793. */
  1794. static MoveTowards(current: number, target: number, maxDelta: number): number;
  1795. /**
  1796. * Same as MoveTowards but makes sure the values interpolate correctly when they wrap around 360 degrees.
  1797. *
  1798. * Variables current and target are assumed to be in degrees. For optimization reasons, negative values of maxDelta
  1799. * are not supported and may cause oscillation. To push current away from a target angle, add 180 to that angle instead.
  1800. * @param current current value
  1801. * @param target target value
  1802. * @param maxDelta max distance to move
  1803. * @returns resulting angle
  1804. */
  1805. static MoveTowardsAngle(current: number, target: number, maxDelta: number): number;
  1806. /**
  1807. * Creates a new scalar with values linearly interpolated of "amount" between the start scalar and the end scalar.
  1808. * @param start start value
  1809. * @param end target value
  1810. * @param amount amount to lerp between
  1811. * @returns the lerped value
  1812. */
  1813. static Lerp(start: number, end: number, amount: number): number;
  1814. /**
  1815. * Same as Lerp but makes sure the values interpolate correctly when they wrap around 360 degrees.
  1816. * The parameter t is clamped to the range [0, 1]. Variables a and b are assumed to be in degrees.
  1817. * @param start start value
  1818. * @param end target value
  1819. * @param amount amount to lerp between
  1820. * @returns the lerped value
  1821. */
  1822. static LerpAngle(start: number, end: number, amount: number): number;
  1823. /**
  1824. * Calculates the linear parameter t that produces the interpolant value within the range [a, b].
  1825. * @param a start value
  1826. * @param b target value
  1827. * @param value value between a and b
  1828. * @returns the inverseLerp value
  1829. */
  1830. static InverseLerp(a: number, b: number, value: number): number;
  1831. /**
  1832. * Returns a new scalar located for "amount" (float) on the Hermite spline defined by the scalars "value1", "value3", "tangent1", "tangent2".
  1833. * @see http://mathworld.wolfram.com/HermitePolynomial.html
  1834. * @param value1 spline value
  1835. * @param tangent1 spline value
  1836. * @param value2 spline value
  1837. * @param tangent2 spline value
  1838. * @param amount input value
  1839. * @returns hermite result
  1840. */
  1841. static Hermite(value1: number, tangent1: number, value2: number, tangent2: number, amount: number): number;
  1842. /**
  1843. * Returns a random float number between and min and max values
  1844. * @param min min value of random
  1845. * @param max max value of random
  1846. * @returns random value
  1847. */
  1848. static RandomRange(min: number, max: number): number;
  1849. /**
  1850. * This function returns percentage of a number in a given range.
  1851. *
  1852. * RangeToPercent(40,20,60) will return 0.5 (50%)
  1853. * RangeToPercent(34,0,100) will return 0.34 (34%)
  1854. * @param number to convert to percentage
  1855. * @param min min range
  1856. * @param max max range
  1857. * @returns the percentage
  1858. */
  1859. static RangeToPercent(number: number, min: number, max: number): number;
  1860. /**
  1861. * This function returns number that corresponds to the percentage in a given range.
  1862. *
  1863. * PercentToRange(0.34,0,100) will return 34.
  1864. * @param percent to convert to number
  1865. * @param min min range
  1866. * @param max max range
  1867. * @returns the number
  1868. */
  1869. static PercentToRange(percent: number, min: number, max: number): number;
  1870. /**
  1871. * Returns the angle converted to equivalent value between -Math.PI and Math.PI radians.
  1872. * @param angle The angle to normalize in radian.
  1873. * @return The converted angle.
  1874. */
  1875. static NormalizeRadians(angle: number): number;
  1876. }
  1877. }
  1878. declare module "babylonjs/Maths/math.constants" {
  1879. /**
  1880. * Constant used to convert a value to gamma space
  1881. * @ignorenaming
  1882. */
  1883. export const ToGammaSpace: number;
  1884. /**
  1885. * Constant used to convert a value to linear space
  1886. * @ignorenaming
  1887. */
  1888. export const ToLinearSpace = 2.2;
  1889. /**
  1890. * Constant used to define the minimal number value in Babylon.js
  1891. * @ignorenaming
  1892. */
  1893. let Epsilon: number;
  1894. export { Epsilon };
  1895. }
  1896. declare module "babylonjs/Maths/math.viewport" {
  1897. /**
  1898. * Class used to represent a viewport on screen
  1899. */
  1900. export class Viewport {
  1901. /** viewport left coordinate */
  1902. x: number;
  1903. /** viewport top coordinate */
  1904. y: number;
  1905. /**viewport width */
  1906. width: number;
  1907. /** viewport height */
  1908. height: number;
  1909. /**
  1910. * Creates a Viewport object located at (x, y) and sized (width, height)
  1911. * @param x defines viewport left coordinate
  1912. * @param y defines viewport top coordinate
  1913. * @param width defines the viewport width
  1914. * @param height defines the viewport height
  1915. */
  1916. constructor(
  1917. /** viewport left coordinate */
  1918. x: number,
  1919. /** viewport top coordinate */
  1920. y: number,
  1921. /**viewport width */
  1922. width: number,
  1923. /** viewport height */
  1924. height: number);
  1925. /**
  1926. * Creates a new viewport using absolute sizing (from 0-> width, 0-> height instead of 0->1)
  1927. * @param renderWidth defines the rendering width
  1928. * @param renderHeight defines the rendering height
  1929. * @returns a new Viewport
  1930. */
  1931. toGlobal(renderWidth: number, renderHeight: number): Viewport;
  1932. /**
  1933. * Stores absolute viewport value into a target viewport (from 0-> width, 0-> height instead of 0->1)
  1934. * @param renderWidth defines the rendering width
  1935. * @param renderHeight defines the rendering height
  1936. * @param ref defines the target viewport
  1937. * @returns the current viewport
  1938. */
  1939. toGlobalToRef(renderWidth: number, renderHeight: number, ref: Viewport): Viewport;
  1940. /**
  1941. * Returns a new Viewport copied from the current one
  1942. * @returns a new Viewport
  1943. */
  1944. clone(): Viewport;
  1945. }
  1946. }
  1947. declare module "babylonjs/Misc/arrayTools" {
  1948. /**
  1949. * Class containing a set of static utilities functions for arrays.
  1950. */
  1951. export class ArrayTools {
  1952. /**
  1953. * Returns an array of the given size filled with element built from the given constructor and the paramters
  1954. * @param size the number of element to construct and put in the array
  1955. * @param itemBuilder a callback responsible for creating new instance of item. Called once per array entry.
  1956. * @returns a new array filled with new objects
  1957. */
  1958. static BuildArray<T>(size: number, itemBuilder: () => T): Array<T>;
  1959. }
  1960. }
  1961. declare module "babylonjs/Maths/math.plane" {
  1962. import { DeepImmutable } from "babylonjs/types";
  1963. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  1964. /**
  1965. * Represents a plane by the equation ax + by + cz + d = 0
  1966. */
  1967. export class Plane {
  1968. private static _TmpMatrix;
  1969. /**
  1970. * Normal of the plane (a,b,c)
  1971. */
  1972. normal: Vector3;
  1973. /**
  1974. * d component of the plane
  1975. */
  1976. d: number;
  1977. /**
  1978. * Creates a Plane object according to the given floats a, b, c, d and the plane equation : ax + by + cz + d = 0
  1979. * @param a a component of the plane
  1980. * @param b b component of the plane
  1981. * @param c c component of the plane
  1982. * @param d d component of the plane
  1983. */
  1984. constructor(a: number, b: number, c: number, d: number);
  1985. /**
  1986. * @returns the plane coordinates as a new array of 4 elements [a, b, c, d].
  1987. */
  1988. asArray(): number[];
  1989. /**
  1990. * @returns a new plane copied from the current Plane.
  1991. */
  1992. clone(): Plane;
  1993. /**
  1994. * @returns the string "Plane".
  1995. */
  1996. getClassName(): string;
  1997. /**
  1998. * @returns the Plane hash code.
  1999. */
  2000. getHashCode(): number;
  2001. /**
  2002. * Normalize the current Plane in place.
  2003. * @returns the updated Plane.
  2004. */
  2005. normalize(): Plane;
  2006. /**
  2007. * Applies a transformation the plane and returns the result
  2008. * @param transformation the transformation matrix to be applied to the plane
  2009. * @returns a new Plane as the result of the transformation of the current Plane by the given matrix.
  2010. */
  2011. transform(transformation: DeepImmutable<Matrix>): Plane;
  2012. /**
  2013. * Compute the dot product between the point and the plane normal
  2014. * @param point point to calculate the dot product with
  2015. * @returns the dot product (float) of the point coordinates and the plane normal.
  2016. */
  2017. dotCoordinate(point: DeepImmutable<Vector3>): number;
  2018. /**
  2019. * Updates the current Plane from the plane defined by the three given points.
  2020. * @param point1 one of the points used to contruct the plane
  2021. * @param point2 one of the points used to contruct the plane
  2022. * @param point3 one of the points used to contruct the plane
  2023. * @returns the updated Plane.
  2024. */
  2025. copyFromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  2026. /**
  2027. * Checks if the plane is facing a given direction
  2028. * @param direction the direction to check if the plane is facing
  2029. * @param epsilon value the dot product is compared against (returns true if dot <= epsilon)
  2030. * @returns True is the vector "direction" is the same side than the plane normal.
  2031. */
  2032. isFrontFacingTo(direction: DeepImmutable<Vector3>, epsilon: number): boolean;
  2033. /**
  2034. * Calculates the distance to a point
  2035. * @param point point to calculate distance to
  2036. * @returns the signed distance (float) from the given point to the Plane.
  2037. */
  2038. signedDistanceTo(point: DeepImmutable<Vector3>): number;
  2039. /**
  2040. * Creates a plane from an array
  2041. * @param array the array to create a plane from
  2042. * @returns a new Plane from the given array.
  2043. */
  2044. static FromArray(array: DeepImmutable<ArrayLike<number>>): Plane;
  2045. /**
  2046. * Creates a plane from three points
  2047. * @param point1 point used to create the plane
  2048. * @param point2 point used to create the plane
  2049. * @param point3 point used to create the plane
  2050. * @returns a new Plane defined by the three given points.
  2051. */
  2052. static FromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  2053. /**
  2054. * Creates a plane from an origin point and a normal
  2055. * @param origin origin of the plane to be constructed
  2056. * @param normal normal of the plane to be constructed
  2057. * @returns a new Plane the normal vector to this plane at the given origin point.
  2058. * Note : the vector "normal" is updated because normalized.
  2059. */
  2060. static FromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: Vector3): Plane;
  2061. /**
  2062. * Calculates the distance from a plane and a point
  2063. * @param origin origin of the plane to be constructed
  2064. * @param normal normal of the plane to be constructed
  2065. * @param point point to calculate distance to
  2066. * @returns the signed distance between the plane defined by the normal vector at the "origin"" point and the given other point.
  2067. */
  2068. static SignedDistanceToPlaneFromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>, point: DeepImmutable<Vector3>): number;
  2069. }
  2070. }
  2071. declare module "babylonjs/Engines/performanceConfigurator" {
  2072. /** @hidden */
  2073. export class PerformanceConfigurator {
  2074. /** @hidden */
  2075. static MatrixUse64Bits: boolean;
  2076. /** @hidden */
  2077. static MatrixTrackPrecisionChange: boolean;
  2078. /** @hidden */
  2079. static MatrixCurrentType: any;
  2080. /** @hidden */
  2081. static MatrixTrackedMatrices: Array<any> | null;
  2082. /** @hidden */
  2083. static SetMatrixPrecision(use64bits: boolean): void;
  2084. }
  2085. }
  2086. declare module "babylonjs/Maths/math.vector" {
  2087. import { Viewport } from "babylonjs/Maths/math.viewport";
  2088. import { DeepImmutable, Nullable, FloatArray, float } from "babylonjs/types";
  2089. import { IPlaneLike } from "babylonjs/Maths/math.like";
  2090. import { Plane } from "babylonjs/Maths/math.plane";
  2091. /**
  2092. * Class representing a vector containing 2 coordinates
  2093. */
  2094. export class Vector2 {
  2095. /** defines the first coordinate */
  2096. x: number;
  2097. /** defines the second coordinate */
  2098. y: number;
  2099. /**
  2100. * Creates a new Vector2 from the given x and y coordinates
  2101. * @param x defines the first coordinate
  2102. * @param y defines the second coordinate
  2103. */
  2104. constructor(
  2105. /** defines the first coordinate */
  2106. x?: number,
  2107. /** defines the second coordinate */
  2108. y?: number);
  2109. /**
  2110. * Gets a string with the Vector2 coordinates
  2111. * @returns a string with the Vector2 coordinates
  2112. */
  2113. toString(): string;
  2114. /**
  2115. * Gets class name
  2116. * @returns the string "Vector2"
  2117. */
  2118. getClassName(): string;
  2119. /**
  2120. * Gets current vector hash code
  2121. * @returns the Vector2 hash code as a number
  2122. */
  2123. getHashCode(): number;
  2124. /**
  2125. * Sets the Vector2 coordinates in the given array or Float32Array from the given index.
  2126. * @param array defines the source array
  2127. * @param index defines the offset in source array
  2128. * @returns the current Vector2
  2129. */
  2130. toArray(array: FloatArray, index?: number): Vector2;
  2131. /**
  2132. * Update the current vector from an array
  2133. * @param array defines the destination array
  2134. * @param index defines the offset in the destination array
  2135. * @returns the current Vector3
  2136. */
  2137. fromArray(array: FloatArray, index?: number): Vector2;
  2138. /**
  2139. * Copy the current vector to an array
  2140. * @returns a new array with 2 elements: the Vector2 coordinates.
  2141. */
  2142. asArray(): number[];
  2143. /**
  2144. * Sets the Vector2 coordinates with the given Vector2 coordinates
  2145. * @param source defines the source Vector2
  2146. * @returns the current updated Vector2
  2147. */
  2148. copyFrom(source: DeepImmutable<Vector2>): Vector2;
  2149. /**
  2150. * Sets the Vector2 coordinates with the given floats
  2151. * @param x defines the first coordinate
  2152. * @param y defines the second coordinate
  2153. * @returns the current updated Vector2
  2154. */
  2155. copyFromFloats(x: number, y: number): Vector2;
  2156. /**
  2157. * Sets the Vector2 coordinates with the given floats
  2158. * @param x defines the first coordinate
  2159. * @param y defines the second coordinate
  2160. * @returns the current updated Vector2
  2161. */
  2162. set(x: number, y: number): Vector2;
  2163. /**
  2164. * Add another vector with the current one
  2165. * @param otherVector defines the other vector
  2166. * @returns a new Vector2 set with the addition of the current Vector2 and the given one coordinates
  2167. */
  2168. add(otherVector: DeepImmutable<Vector2>): Vector2;
  2169. /**
  2170. * Sets the "result" coordinates with the addition of the current Vector2 and the given one coordinates
  2171. * @param otherVector defines the other vector
  2172. * @param result defines the target vector
  2173. * @returns the unmodified current Vector2
  2174. */
  2175. addToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2176. /**
  2177. * Set the Vector2 coordinates by adding the given Vector2 coordinates
  2178. * @param otherVector defines the other vector
  2179. * @returns the current updated Vector2
  2180. */
  2181. addInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2182. /**
  2183. * Gets a new Vector2 by adding the current Vector2 coordinates to the given Vector3 x, y coordinates
  2184. * @param otherVector defines the other vector
  2185. * @returns a new Vector2
  2186. */
  2187. addVector3(otherVector: Vector3): Vector2;
  2188. /**
  2189. * Gets a new Vector2 set with the subtracted coordinates of the given one from the current Vector2
  2190. * @param otherVector defines the other vector
  2191. * @returns a new Vector2
  2192. */
  2193. subtract(otherVector: Vector2): Vector2;
  2194. /**
  2195. * Sets the "result" coordinates with the subtraction of the given one from the current Vector2 coordinates.
  2196. * @param otherVector defines the other vector
  2197. * @param result defines the target vector
  2198. * @returns the unmodified current Vector2
  2199. */
  2200. subtractToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2201. /**
  2202. * Sets the current Vector2 coordinates by subtracting from it the given one coordinates
  2203. * @param otherVector defines the other vector
  2204. * @returns the current updated Vector2
  2205. */
  2206. subtractInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2207. /**
  2208. * Multiplies in place the current Vector2 coordinates by the given ones
  2209. * @param otherVector defines the other vector
  2210. * @returns the current updated Vector2
  2211. */
  2212. multiplyInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2213. /**
  2214. * Returns a new Vector2 set with the multiplication of the current Vector2 and the given one coordinates
  2215. * @param otherVector defines the other vector
  2216. * @returns a new Vector2
  2217. */
  2218. multiply(otherVector: DeepImmutable<Vector2>): Vector2;
  2219. /**
  2220. * Sets "result" coordinates with the multiplication of the current Vector2 and the given one coordinates
  2221. * @param otherVector defines the other vector
  2222. * @param result defines the target vector
  2223. * @returns the unmodified current Vector2
  2224. */
  2225. multiplyToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2226. /**
  2227. * Gets a new Vector2 set with the Vector2 coordinates multiplied by the given floats
  2228. * @param x defines the first coordinate
  2229. * @param y defines the second coordinate
  2230. * @returns a new Vector2
  2231. */
  2232. multiplyByFloats(x: number, y: number): Vector2;
  2233. /**
  2234. * Returns a new Vector2 set with the Vector2 coordinates divided by the given one coordinates
  2235. * @param otherVector defines the other vector
  2236. * @returns a new Vector2
  2237. */
  2238. divide(otherVector: Vector2): Vector2;
  2239. /**
  2240. * Sets the "result" coordinates with the Vector2 divided by the given one coordinates
  2241. * @param otherVector defines the other vector
  2242. * @param result defines the target vector
  2243. * @returns the unmodified current Vector2
  2244. */
  2245. divideToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2246. /**
  2247. * Divides the current Vector2 coordinates by the given ones
  2248. * @param otherVector defines the other vector
  2249. * @returns the current updated Vector2
  2250. */
  2251. divideInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2252. /**
  2253. * Gets a new Vector2 with current Vector2 negated coordinates
  2254. * @returns a new Vector2
  2255. */
  2256. negate(): Vector2;
  2257. /**
  2258. * Negate this vector in place
  2259. * @returns this
  2260. */
  2261. negateInPlace(): Vector2;
  2262. /**
  2263. * Negate the current Vector2 and stores the result in the given vector "result" coordinates
  2264. * @param result defines the Vector3 object where to store the result
  2265. * @returns the current Vector2
  2266. */
  2267. negateToRef(result: Vector2): Vector2;
  2268. /**
  2269. * Multiply the Vector2 coordinates by scale
  2270. * @param scale defines the scaling factor
  2271. * @returns the current updated Vector2
  2272. */
  2273. scaleInPlace(scale: number): Vector2;
  2274. /**
  2275. * Returns a new Vector2 scaled by "scale" from the current Vector2
  2276. * @param scale defines the scaling factor
  2277. * @returns a new Vector2
  2278. */
  2279. scale(scale: number): Vector2;
  2280. /**
  2281. * Scale the current Vector2 values by a factor to a given Vector2
  2282. * @param scale defines the scale factor
  2283. * @param result defines the Vector2 object where to store the result
  2284. * @returns the unmodified current Vector2
  2285. */
  2286. scaleToRef(scale: number, result: Vector2): Vector2;
  2287. /**
  2288. * Scale the current Vector2 values by a factor and add the result to a given Vector2
  2289. * @param scale defines the scale factor
  2290. * @param result defines the Vector2 object where to store the result
  2291. * @returns the unmodified current Vector2
  2292. */
  2293. scaleAndAddToRef(scale: number, result: Vector2): Vector2;
  2294. /**
  2295. * Gets a boolean if two vectors are equals
  2296. * @param otherVector defines the other vector
  2297. * @returns true if the given vector coordinates strictly equal the current Vector2 ones
  2298. */
  2299. equals(otherVector: DeepImmutable<Vector2>): boolean;
  2300. /**
  2301. * Gets a boolean if two vectors are equals (using an epsilon value)
  2302. * @param otherVector defines the other vector
  2303. * @param epsilon defines the minimal distance to consider equality
  2304. * @returns true if the given vector coordinates are close to the current ones by a distance of epsilon.
  2305. */
  2306. equalsWithEpsilon(otherVector: DeepImmutable<Vector2>, epsilon?: number): boolean;
  2307. /**
  2308. * Gets a new Vector2 from current Vector2 floored values
  2309. * @returns a new Vector2
  2310. */
  2311. floor(): Vector2;
  2312. /**
  2313. * Gets a new Vector2 from current Vector2 floored values
  2314. * @returns a new Vector2
  2315. */
  2316. fract(): Vector2;
  2317. /**
  2318. * Gets the length of the vector
  2319. * @returns the vector length (float)
  2320. */
  2321. length(): number;
  2322. /**
  2323. * Gets the vector squared length
  2324. * @returns the vector squared length (float)
  2325. */
  2326. lengthSquared(): number;
  2327. /**
  2328. * Normalize the vector
  2329. * @returns the current updated Vector2
  2330. */
  2331. normalize(): Vector2;
  2332. /**
  2333. * Gets a new Vector2 copied from the Vector2
  2334. * @returns a new Vector2
  2335. */
  2336. clone(): Vector2;
  2337. /**
  2338. * Gets a new Vector2(0, 0)
  2339. * @returns a new Vector2
  2340. */
  2341. static Zero(): Vector2;
  2342. /**
  2343. * Gets a new Vector2(1, 1)
  2344. * @returns a new Vector2
  2345. */
  2346. static One(): Vector2;
  2347. /**
  2348. * Gets a new Vector2 set from the given index element of the given array
  2349. * @param array defines the data source
  2350. * @param offset defines the offset in the data source
  2351. * @returns a new Vector2
  2352. */
  2353. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector2;
  2354. /**
  2355. * Sets "result" from the given index element of the given array
  2356. * @param array defines the data source
  2357. * @param offset defines the offset in the data source
  2358. * @param result defines the target vector
  2359. */
  2360. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector2): void;
  2361. /**
  2362. * Gets a new Vector2 located for "amount" (float) on the CatmullRom spline defined by the given four Vector2
  2363. * @param value1 defines 1st point of control
  2364. * @param value2 defines 2nd point of control
  2365. * @param value3 defines 3rd point of control
  2366. * @param value4 defines 4th point of control
  2367. * @param amount defines the interpolation factor
  2368. * @returns a new Vector2
  2369. */
  2370. static CatmullRom(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, value3: DeepImmutable<Vector2>, value4: DeepImmutable<Vector2>, amount: number): Vector2;
  2371. /**
  2372. * Returns a new Vector2 set with same the coordinates than "value" ones if the vector "value" is in the square defined by "min" and "max".
  2373. * If a coordinate of "value" is lower than "min" coordinates, the returned Vector2 is given this "min" coordinate.
  2374. * If a coordinate of "value" is greater than "max" coordinates, the returned Vector2 is given this "max" coordinate
  2375. * @param value defines the value to clamp
  2376. * @param min defines the lower limit
  2377. * @param max defines the upper limit
  2378. * @returns a new Vector2
  2379. */
  2380. static Clamp(value: DeepImmutable<Vector2>, min: DeepImmutable<Vector2>, max: DeepImmutable<Vector2>): Vector2;
  2381. /**
  2382. * Returns a new Vector2 located for "amount" (float) on the Hermite spline defined by the vectors "value1", "value3", "tangent1", "tangent2"
  2383. * @param value1 defines the 1st control point
  2384. * @param tangent1 defines the outgoing tangent
  2385. * @param value2 defines the 2nd control point
  2386. * @param tangent2 defines the incoming tangent
  2387. * @param amount defines the interpolation factor
  2388. * @returns a new Vector2
  2389. */
  2390. static Hermite(value1: DeepImmutable<Vector2>, tangent1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, tangent2: DeepImmutable<Vector2>, amount: number): Vector2;
  2391. /**
  2392. * Returns a new Vector2 located for "amount" (float) on the linear interpolation between the vector "start" adn the vector "end".
  2393. * @param start defines the start vector
  2394. * @param end defines the end vector
  2395. * @param amount defines the interpolation factor
  2396. * @returns a new Vector2
  2397. */
  2398. static Lerp(start: DeepImmutable<Vector2>, end: DeepImmutable<Vector2>, amount: number): Vector2;
  2399. /**
  2400. * Gets the dot product of the vector "left" and the vector "right"
  2401. * @param left defines first vector
  2402. * @param right defines second vector
  2403. * @returns the dot product (float)
  2404. */
  2405. static Dot(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): number;
  2406. /**
  2407. * Returns a new Vector2 equal to the normalized given vector
  2408. * @param vector defines the vector to normalize
  2409. * @returns a new Vector2
  2410. */
  2411. static Normalize(vector: DeepImmutable<Vector2>): Vector2;
  2412. /**
  2413. * Gets a new Vector2 set with the minimal coordinate values from the "left" and "right" vectors
  2414. * @param left defines 1st vector
  2415. * @param right defines 2nd vector
  2416. * @returns a new Vector2
  2417. */
  2418. static Minimize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  2419. /**
  2420. * Gets a new Vecto2 set with the maximal coordinate values from the "left" and "right" vectors
  2421. * @param left defines 1st vector
  2422. * @param right defines 2nd vector
  2423. * @returns a new Vector2
  2424. */
  2425. static Maximize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  2426. /**
  2427. * Gets a new Vector2 set with the transformed coordinates of the given vector by the given transformation matrix
  2428. * @param vector defines the vector to transform
  2429. * @param transformation defines the matrix to apply
  2430. * @returns a new Vector2
  2431. */
  2432. static Transform(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>): Vector2;
  2433. /**
  2434. * Transforms the given vector coordinates by the given transformation matrix and stores the result in the vector "result" coordinates
  2435. * @param vector defines the vector to transform
  2436. * @param transformation defines the matrix to apply
  2437. * @param result defines the target vector
  2438. */
  2439. static TransformToRef(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>, result: Vector2): void;
  2440. /**
  2441. * Determines if a given vector is included in a triangle
  2442. * @param p defines the vector to test
  2443. * @param p0 defines 1st triangle point
  2444. * @param p1 defines 2nd triangle point
  2445. * @param p2 defines 3rd triangle point
  2446. * @returns true if the point "p" is in the triangle defined by the vertors "p0", "p1", "p2"
  2447. */
  2448. static PointInTriangle(p: DeepImmutable<Vector2>, p0: DeepImmutable<Vector2>, p1: DeepImmutable<Vector2>, p2: DeepImmutable<Vector2>): boolean;
  2449. /**
  2450. * Gets the distance between the vectors "value1" and "value2"
  2451. * @param value1 defines first vector
  2452. * @param value2 defines second vector
  2453. * @returns the distance between vectors
  2454. */
  2455. static Distance(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  2456. /**
  2457. * Returns the squared distance between the vectors "value1" and "value2"
  2458. * @param value1 defines first vector
  2459. * @param value2 defines second vector
  2460. * @returns the squared distance between vectors
  2461. */
  2462. static DistanceSquared(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  2463. /**
  2464. * Gets a new Vector2 located at the center of the vectors "value1" and "value2"
  2465. * @param value1 defines first vector
  2466. * @param value2 defines second vector
  2467. * @returns a new Vector2
  2468. */
  2469. static Center(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): Vector2;
  2470. /**
  2471. * Gets the shortest distance (float) between the point "p" and the segment defined by the two points "segA" and "segB".
  2472. * @param p defines the middle point
  2473. * @param segA defines one point of the segment
  2474. * @param segB defines the other point of the segment
  2475. * @returns the shortest distance
  2476. */
  2477. static DistanceOfPointFromSegment(p: DeepImmutable<Vector2>, segA: DeepImmutable<Vector2>, segB: DeepImmutable<Vector2>): number;
  2478. }
  2479. /**
  2480. * Class used to store (x,y,z) vector representation
  2481. * A Vector3 is the main object used in 3D geometry
  2482. * It can represent etiher the coordinates of a point the space, either a direction
  2483. * Reminder: js uses a left handed forward facing system
  2484. */
  2485. export class Vector3 {
  2486. private static _UpReadOnly;
  2487. private static _ZeroReadOnly;
  2488. /** @hidden */
  2489. _x: number;
  2490. /** @hidden */
  2491. _y: number;
  2492. /** @hidden */
  2493. _z: number;
  2494. /** @hidden */
  2495. _isDirty: boolean;
  2496. /** Gets or sets the x coordinate */
  2497. get x(): number;
  2498. set x(value: number);
  2499. /** Gets or sets the y coordinate */
  2500. get y(): number;
  2501. set y(value: number);
  2502. /** Gets or sets the z coordinate */
  2503. get z(): number;
  2504. set z(value: number);
  2505. /**
  2506. * Creates a new Vector3 object from the given x, y, z (floats) coordinates.
  2507. * @param x defines the first coordinates (on X axis)
  2508. * @param y defines the second coordinates (on Y axis)
  2509. * @param z defines the third coordinates (on Z axis)
  2510. */
  2511. constructor(x?: number, y?: number, z?: number);
  2512. /**
  2513. * Creates a string representation of the Vector3
  2514. * @returns a string with the Vector3 coordinates.
  2515. */
  2516. toString(): string;
  2517. /**
  2518. * Gets the class name
  2519. * @returns the string "Vector3"
  2520. */
  2521. getClassName(): string;
  2522. /**
  2523. * Creates the Vector3 hash code
  2524. * @returns a number which tends to be unique between Vector3 instances
  2525. */
  2526. getHashCode(): number;
  2527. /**
  2528. * Creates an array containing three elements : the coordinates of the Vector3
  2529. * @returns a new array of numbers
  2530. */
  2531. asArray(): number[];
  2532. /**
  2533. * Populates the given array or Float32Array from the given index with the successive coordinates of the Vector3
  2534. * @param array defines the destination array
  2535. * @param index defines the offset in the destination array
  2536. * @returns the current Vector3
  2537. */
  2538. toArray(array: FloatArray, index?: number): Vector3;
  2539. /**
  2540. * Update the current vector from an array
  2541. * @param array defines the destination array
  2542. * @param index defines the offset in the destination array
  2543. * @returns the current Vector3
  2544. */
  2545. fromArray(array: FloatArray, index?: number): Vector3;
  2546. /**
  2547. * Converts the current Vector3 into a quaternion (considering that the Vector3 contains Euler angles representation of a rotation)
  2548. * @returns a new Quaternion object, computed from the Vector3 coordinates
  2549. */
  2550. toQuaternion(): Quaternion;
  2551. /**
  2552. * Adds the given vector to the current Vector3
  2553. * @param otherVector defines the second operand
  2554. * @returns the current updated Vector3
  2555. */
  2556. addInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  2557. /**
  2558. * Adds the given coordinates to the current Vector3
  2559. * @param x defines the x coordinate of the operand
  2560. * @param y defines the y coordinate of the operand
  2561. * @param z defines the z coordinate of the operand
  2562. * @returns the current updated Vector3
  2563. */
  2564. addInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  2565. /**
  2566. * Gets a new Vector3, result of the addition the current Vector3 and the given vector
  2567. * @param otherVector defines the second operand
  2568. * @returns the resulting Vector3
  2569. */
  2570. add(otherVector: DeepImmutable<Vector3>): Vector3;
  2571. /**
  2572. * Adds the current Vector3 to the given one and stores the result in the vector "result"
  2573. * @param otherVector defines the second operand
  2574. * @param result defines the Vector3 object where to store the result
  2575. * @returns the current Vector3
  2576. */
  2577. addToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2578. /**
  2579. * Subtract the given vector from the current Vector3
  2580. * @param otherVector defines the second operand
  2581. * @returns the current updated Vector3
  2582. */
  2583. subtractInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  2584. /**
  2585. * Returns a new Vector3, result of the subtraction of the given vector from the current Vector3
  2586. * @param otherVector defines the second operand
  2587. * @returns the resulting Vector3
  2588. */
  2589. subtract(otherVector: DeepImmutable<Vector3>): Vector3;
  2590. /**
  2591. * Subtracts the given vector from the current Vector3 and stores the result in the vector "result".
  2592. * @param otherVector defines the second operand
  2593. * @param result defines the Vector3 object where to store the result
  2594. * @returns the current Vector3
  2595. */
  2596. subtractToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2597. /**
  2598. * Returns a new Vector3 set with the subtraction of the given floats from the current Vector3 coordinates
  2599. * @param x defines the x coordinate of the operand
  2600. * @param y defines the y coordinate of the operand
  2601. * @param z defines the z coordinate of the operand
  2602. * @returns the resulting Vector3
  2603. */
  2604. subtractFromFloats(x: number, y: number, z: number): Vector3;
  2605. /**
  2606. * Subtracts the given floats from the current Vector3 coordinates and set the given vector "result" with this result
  2607. * @param x defines the x coordinate of the operand
  2608. * @param y defines the y coordinate of the operand
  2609. * @param z defines the z coordinate of the operand
  2610. * @param result defines the Vector3 object where to store the result
  2611. * @returns the current Vector3
  2612. */
  2613. subtractFromFloatsToRef(x: number, y: number, z: number, result: Vector3): Vector3;
  2614. /**
  2615. * Gets a new Vector3 set with the current Vector3 negated coordinates
  2616. * @returns a new Vector3
  2617. */
  2618. negate(): Vector3;
  2619. /**
  2620. * Negate this vector in place
  2621. * @returns this
  2622. */
  2623. negateInPlace(): Vector3;
  2624. /**
  2625. * Negate the current Vector3 and stores the result in the given vector "result" coordinates
  2626. * @param result defines the Vector3 object where to store the result
  2627. * @returns the current Vector3
  2628. */
  2629. negateToRef(result: Vector3): Vector3;
  2630. /**
  2631. * Multiplies the Vector3 coordinates by the float "scale"
  2632. * @param scale defines the multiplier factor
  2633. * @returns the current updated Vector3
  2634. */
  2635. scaleInPlace(scale: number): Vector3;
  2636. /**
  2637. * Returns a new Vector3 set with the current Vector3 coordinates multiplied by the float "scale"
  2638. * @param scale defines the multiplier factor
  2639. * @returns a new Vector3
  2640. */
  2641. scale(scale: number): Vector3;
  2642. /**
  2643. * Multiplies the current Vector3 coordinates by the float "scale" and stores the result in the given vector "result" coordinates
  2644. * @param scale defines the multiplier factor
  2645. * @param result defines the Vector3 object where to store the result
  2646. * @returns the current Vector3
  2647. */
  2648. scaleToRef(scale: number, result: Vector3): Vector3;
  2649. /**
  2650. * Scale the current Vector3 values by a factor and add the result to a given Vector3
  2651. * @param scale defines the scale factor
  2652. * @param result defines the Vector3 object where to store the result
  2653. * @returns the unmodified current Vector3
  2654. */
  2655. scaleAndAddToRef(scale: number, result: Vector3): Vector3;
  2656. /**
  2657. * Projects the current vector3 to a plane along a ray starting from a specified origin and directed towards the point.
  2658. * @param origin defines the origin of the projection ray
  2659. * @param plane defines the plane to project to
  2660. * @returns the projected vector3
  2661. */
  2662. projectOnPlane(plane: Plane, origin: Vector3): Vector3;
  2663. /**
  2664. * Projects the current vector3 to a plane along a ray starting from a specified origin and directed towards the point.
  2665. * @param origin defines the origin of the projection ray
  2666. * @param plane defines the plane to project to
  2667. * @param result defines the Vector3 where to store the result
  2668. */
  2669. projectOnPlaneToRef(plane: Plane, origin: Vector3, result: Vector3): void;
  2670. /**
  2671. * Returns true if the current Vector3 and the given vector coordinates are strictly equal
  2672. * @param otherVector defines the second operand
  2673. * @returns true if both vectors are equals
  2674. */
  2675. equals(otherVector: DeepImmutable<Vector3>): boolean;
  2676. /**
  2677. * Returns true if the current Vector3 and the given vector coordinates are distant less than epsilon
  2678. * @param otherVector defines the second operand
  2679. * @param epsilon defines the minimal distance to define values as equals
  2680. * @returns true if both vectors are distant less than epsilon
  2681. */
  2682. equalsWithEpsilon(otherVector: DeepImmutable<Vector3>, epsilon?: number): boolean;
  2683. /**
  2684. * Returns true if the current Vector3 coordinates equals the given floats
  2685. * @param x defines the x coordinate of the operand
  2686. * @param y defines the y coordinate of the operand
  2687. * @param z defines the z coordinate of the operand
  2688. * @returns true if both vectors are equals
  2689. */
  2690. equalsToFloats(x: number, y: number, z: number): boolean;
  2691. /**
  2692. * Multiplies the current Vector3 coordinates by the given ones
  2693. * @param otherVector defines the second operand
  2694. * @returns the current updated Vector3
  2695. */
  2696. multiplyInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  2697. /**
  2698. * Returns a new Vector3, result of the multiplication of the current Vector3 by the given vector
  2699. * @param otherVector defines the second operand
  2700. * @returns the new Vector3
  2701. */
  2702. multiply(otherVector: DeepImmutable<Vector3>): Vector3;
  2703. /**
  2704. * Multiplies the current Vector3 by the given one and stores the result in the given vector "result"
  2705. * @param otherVector defines the second operand
  2706. * @param result defines the Vector3 object where to store the result
  2707. * @returns the current Vector3
  2708. */
  2709. multiplyToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2710. /**
  2711. * Returns a new Vector3 set with the result of the mulliplication of the current Vector3 coordinates by the given floats
  2712. * @param x defines the x coordinate of the operand
  2713. * @param y defines the y coordinate of the operand
  2714. * @param z defines the z coordinate of the operand
  2715. * @returns the new Vector3
  2716. */
  2717. multiplyByFloats(x: number, y: number, z: number): Vector3;
  2718. /**
  2719. * Returns a new Vector3 set with the result of the division of the current Vector3 coordinates by the given ones
  2720. * @param otherVector defines the second operand
  2721. * @returns the new Vector3
  2722. */
  2723. divide(otherVector: DeepImmutable<Vector3>): Vector3;
  2724. /**
  2725. * Divides the current Vector3 coordinates by the given ones and stores the result in the given vector "result"
  2726. * @param otherVector defines the second operand
  2727. * @param result defines the Vector3 object where to store the result
  2728. * @returns the current Vector3
  2729. */
  2730. divideToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2731. /**
  2732. * Divides the current Vector3 coordinates by the given ones.
  2733. * @param otherVector defines the second operand
  2734. * @returns the current updated Vector3
  2735. */
  2736. divideInPlace(otherVector: Vector3): Vector3;
  2737. /**
  2738. * Updates the current Vector3 with the minimal coordinate values between its and the given vector ones
  2739. * @param other defines the second operand
  2740. * @returns the current updated Vector3
  2741. */
  2742. minimizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  2743. /**
  2744. * Updates the current Vector3 with the maximal coordinate values between its and the given vector ones.
  2745. * @param other defines the second operand
  2746. * @returns the current updated Vector3
  2747. */
  2748. maximizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  2749. /**
  2750. * Updates the current Vector3 with the minimal coordinate values between its and the given coordinates
  2751. * @param x defines the x coordinate of the operand
  2752. * @param y defines the y coordinate of the operand
  2753. * @param z defines the z coordinate of the operand
  2754. * @returns the current updated Vector3
  2755. */
  2756. minimizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  2757. /**
  2758. * Updates the current Vector3 with the maximal coordinate values between its and the given coordinates.
  2759. * @param x defines the x coordinate of the operand
  2760. * @param y defines the y coordinate of the operand
  2761. * @param z defines the z coordinate of the operand
  2762. * @returns the current updated Vector3
  2763. */
  2764. maximizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  2765. /**
  2766. * Due to float precision, scale of a mesh could be uniform but float values are off by a small fraction
  2767. * Check if is non uniform within a certain amount of decimal places to account for this
  2768. * @param epsilon the amount the values can differ
  2769. * @returns if the the vector is non uniform to a certain number of decimal places
  2770. */
  2771. isNonUniformWithinEpsilon(epsilon: number): boolean;
  2772. /**
  2773. * Gets a boolean indicating that the vector is non uniform meaning x, y or z are not all the same
  2774. */
  2775. get isNonUniform(): boolean;
  2776. /**
  2777. * Gets a new Vector3 from current Vector3 floored values
  2778. * @returns a new Vector3
  2779. */
  2780. floor(): Vector3;
  2781. /**
  2782. * Gets a new Vector3 from current Vector3 floored values
  2783. * @returns a new Vector3
  2784. */
  2785. fract(): Vector3;
  2786. /**
  2787. * Gets the length of the Vector3
  2788. * @returns the length of the Vector3
  2789. */
  2790. length(): number;
  2791. /**
  2792. * Gets the squared length of the Vector3
  2793. * @returns squared length of the Vector3
  2794. */
  2795. lengthSquared(): number;
  2796. /**
  2797. * Normalize the current Vector3.
  2798. * Please note that this is an in place operation.
  2799. * @returns the current updated Vector3
  2800. */
  2801. normalize(): Vector3;
  2802. /**
  2803. * Reorders the x y z properties of the vector in place
  2804. * @param order new ordering of the properties (eg. for vector 1,2,3 with "ZYX" will produce 3,2,1)
  2805. * @returns the current updated vector
  2806. */
  2807. reorderInPlace(order: string): this;
  2808. /**
  2809. * Rotates the vector around 0,0,0 by a quaternion
  2810. * @param quaternion the rotation quaternion
  2811. * @param result vector to store the result
  2812. * @returns the resulting vector
  2813. */
  2814. rotateByQuaternionToRef(quaternion: Quaternion, result: Vector3): Vector3;
  2815. /**
  2816. * Rotates a vector around a given point
  2817. * @param quaternion the rotation quaternion
  2818. * @param point the point to rotate around
  2819. * @param result vector to store the result
  2820. * @returns the resulting vector
  2821. */
  2822. rotateByQuaternionAroundPointToRef(quaternion: Quaternion, point: Vector3, result: Vector3): Vector3;
  2823. /**
  2824. * Returns a new Vector3 as the cross product of the current vector and the "other" one
  2825. * The cross product is then orthogonal to both current and "other"
  2826. * @param other defines the right operand
  2827. * @returns the cross product
  2828. */
  2829. cross(other: Vector3): Vector3;
  2830. /**
  2831. * Normalize the current Vector3 with the given input length.
  2832. * Please note that this is an in place operation.
  2833. * @param len the length of the vector
  2834. * @returns the current updated Vector3
  2835. */
  2836. normalizeFromLength(len: number): Vector3;
  2837. /**
  2838. * Normalize the current Vector3 to a new vector
  2839. * @returns the new Vector3
  2840. */
  2841. normalizeToNew(): Vector3;
  2842. /**
  2843. * Normalize the current Vector3 to the reference
  2844. * @param reference define the Vector3 to update
  2845. * @returns the updated Vector3
  2846. */
  2847. normalizeToRef(reference: Vector3): Vector3;
  2848. /**
  2849. * Creates a new Vector3 copied from the current Vector3
  2850. * @returns the new Vector3
  2851. */
  2852. clone(): Vector3;
  2853. /**
  2854. * Copies the given vector coordinates to the current Vector3 ones
  2855. * @param source defines the source Vector3
  2856. * @returns the current updated Vector3
  2857. */
  2858. copyFrom(source: DeepImmutable<Vector3>): Vector3;
  2859. /**
  2860. * Copies the given floats to the current Vector3 coordinates
  2861. * @param x defines the x coordinate of the operand
  2862. * @param y defines the y coordinate of the operand
  2863. * @param z defines the z coordinate of the operand
  2864. * @returns the current updated Vector3
  2865. */
  2866. copyFromFloats(x: number, y: number, z: number): Vector3;
  2867. /**
  2868. * Copies the given floats to the current Vector3 coordinates
  2869. * @param x defines the x coordinate of the operand
  2870. * @param y defines the y coordinate of the operand
  2871. * @param z defines the z coordinate of the operand
  2872. * @returns the current updated Vector3
  2873. */
  2874. set(x: number, y: number, z: number): Vector3;
  2875. /**
  2876. * Copies the given float to the current Vector3 coordinates
  2877. * @param v defines the x, y and z coordinates of the operand
  2878. * @returns the current updated Vector3
  2879. */
  2880. setAll(v: number): Vector3;
  2881. /**
  2882. * Get the clip factor between two vectors
  2883. * @param vector0 defines the first operand
  2884. * @param vector1 defines the second operand
  2885. * @param axis defines the axis to use
  2886. * @param size defines the size along the axis
  2887. * @returns the clip factor
  2888. */
  2889. static GetClipFactor(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, axis: DeepImmutable<Vector3>, size: number): number;
  2890. /**
  2891. * Get angle between two vectors
  2892. * @param vector0 angle between vector0 and vector1
  2893. * @param vector1 angle between vector0 and vector1
  2894. * @param normal direction of the normal
  2895. * @return the angle between vector0 and vector1
  2896. */
  2897. static GetAngleBetweenVectors(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>): number;
  2898. /**
  2899. * Returns a new Vector3 set from the index "offset" of the given array
  2900. * @param array defines the source array
  2901. * @param offset defines the offset in the source array
  2902. * @returns the new Vector3
  2903. */
  2904. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector3;
  2905. /**
  2906. * Returns a new Vector3 set from the index "offset" of the given Float32Array
  2907. * @param array defines the source array
  2908. * @param offset defines the offset in the source array
  2909. * @returns the new Vector3
  2910. * @deprecated Please use FromArray instead.
  2911. */
  2912. static FromFloatArray(array: DeepImmutable<Float32Array>, offset?: number): Vector3;
  2913. /**
  2914. * Sets the given vector "result" with the element values from the index "offset" of the given array
  2915. * @param array defines the source array
  2916. * @param offset defines the offset in the source array
  2917. * @param result defines the Vector3 where to store the result
  2918. */
  2919. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector3): void;
  2920. /**
  2921. * Sets the given vector "result" with the element values from the index "offset" of the given Float32Array
  2922. * @param array defines the source array
  2923. * @param offset defines the offset in the source array
  2924. * @param result defines the Vector3 where to store the result
  2925. * @deprecated Please use FromArrayToRef instead.
  2926. */
  2927. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector3): void;
  2928. /**
  2929. * Sets the given vector "result" with the given floats.
  2930. * @param x defines the x coordinate of the source
  2931. * @param y defines the y coordinate of the source
  2932. * @param z defines the z coordinate of the source
  2933. * @param result defines the Vector3 where to store the result
  2934. */
  2935. static FromFloatsToRef(x: number, y: number, z: number, result: Vector3): void;
  2936. /**
  2937. * Returns a new Vector3 set to (0.0, 0.0, 0.0)
  2938. * @returns a new empty Vector3
  2939. */
  2940. static Zero(): Vector3;
  2941. /**
  2942. * Returns a new Vector3 set to (1.0, 1.0, 1.0)
  2943. * @returns a new unit Vector3
  2944. */
  2945. static One(): Vector3;
  2946. /**
  2947. * Returns a new Vector3 set to (0.0, 1.0, 0.0)
  2948. * @returns a new up Vector3
  2949. */
  2950. static Up(): Vector3;
  2951. /**
  2952. * Gets a up Vector3 that must not be updated
  2953. */
  2954. static get UpReadOnly(): DeepImmutable<Vector3>;
  2955. /**
  2956. * Gets a zero Vector3 that must not be updated
  2957. */
  2958. static get ZeroReadOnly(): DeepImmutable<Vector3>;
  2959. /**
  2960. * Returns a new Vector3 set to (0.0, -1.0, 0.0)
  2961. * @returns a new down Vector3
  2962. */
  2963. static Down(): Vector3;
  2964. /**
  2965. * Returns a new Vector3 set to (0.0, 0.0, 1.0)
  2966. * @param rightHandedSystem is the scene right-handed (negative z)
  2967. * @returns a new forward Vector3
  2968. */
  2969. static Forward(rightHandedSystem?: boolean): Vector3;
  2970. /**
  2971. * Returns a new Vector3 set to (0.0, 0.0, -1.0)
  2972. * @param rightHandedSystem is the scene right-handed (negative-z)
  2973. * @returns a new forward Vector3
  2974. */
  2975. static Backward(rightHandedSystem?: boolean): Vector3;
  2976. /**
  2977. * Returns a new Vector3 set to (1.0, 0.0, 0.0)
  2978. * @returns a new right Vector3
  2979. */
  2980. static Right(): Vector3;
  2981. /**
  2982. * Returns a new Vector3 set to (-1.0, 0.0, 0.0)
  2983. * @returns a new left Vector3
  2984. */
  2985. static Left(): Vector3;
  2986. /**
  2987. * Returns a new Vector3 set with the result of the transformation by the given matrix of the given vector.
  2988. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  2989. * @param vector defines the Vector3 to transform
  2990. * @param transformation defines the transformation matrix
  2991. * @returns the transformed Vector3
  2992. */
  2993. static TransformCoordinates(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  2994. /**
  2995. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given vector
  2996. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  2997. * @param vector defines the Vector3 to transform
  2998. * @param transformation defines the transformation matrix
  2999. * @param result defines the Vector3 where to store the result
  3000. */
  3001. static TransformCoordinatesToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  3002. /**
  3003. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given floats (x, y, z)
  3004. * This method computes tranformed coordinates only, not transformed direction vectors
  3005. * @param x define the x coordinate of the source vector
  3006. * @param y define the y coordinate of the source vector
  3007. * @param z define the z coordinate of the source vector
  3008. * @param transformation defines the transformation matrix
  3009. * @param result defines the Vector3 where to store the result
  3010. */
  3011. static TransformCoordinatesFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  3012. /**
  3013. * Returns a new Vector3 set with the result of the normal transformation by the given matrix of the given vector
  3014. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  3015. * @param vector defines the Vector3 to transform
  3016. * @param transformation defines the transformation matrix
  3017. * @returns the new Vector3
  3018. */
  3019. static TransformNormal(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  3020. /**
  3021. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector
  3022. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  3023. * @param vector defines the Vector3 to transform
  3024. * @param transformation defines the transformation matrix
  3025. * @param result defines the Vector3 where to store the result
  3026. */
  3027. static TransformNormalToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  3028. /**
  3029. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z)
  3030. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  3031. * @param x define the x coordinate of the source vector
  3032. * @param y define the y coordinate of the source vector
  3033. * @param z define the z coordinate of the source vector
  3034. * @param transformation defines the transformation matrix
  3035. * @param result defines the Vector3 where to store the result
  3036. */
  3037. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  3038. /**
  3039. * Returns a new Vector3 located for "amount" on the CatmullRom interpolation spline defined by the vectors "value1", "value2", "value3", "value4"
  3040. * @param value1 defines the first control point
  3041. * @param value2 defines the second control point
  3042. * @param value3 defines the third control point
  3043. * @param value4 defines the fourth control point
  3044. * @param amount defines the amount on the spline to use
  3045. * @returns the new Vector3
  3046. */
  3047. static CatmullRom(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, value3: DeepImmutable<Vector3>, value4: DeepImmutable<Vector3>, amount: number): Vector3;
  3048. /**
  3049. * Returns a new Vector3 set with the coordinates of "value", if the vector "value" is in the cube defined by the vectors "min" and "max"
  3050. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  3051. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  3052. * @param value defines the current value
  3053. * @param min defines the lower range value
  3054. * @param max defines the upper range value
  3055. * @returns the new Vector3
  3056. */
  3057. static Clamp(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): Vector3;
  3058. /**
  3059. * Sets the given vector "result" with the coordinates of "value", if the vector "value" is in the cube defined by the vectors "min" and "max"
  3060. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  3061. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  3062. * @param value defines the current value
  3063. * @param min defines the lower range value
  3064. * @param max defines the upper range value
  3065. * @param result defines the Vector3 where to store the result
  3066. */
  3067. static ClampToRef(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, result: Vector3): void;
  3068. /**
  3069. * Checks if a given vector is inside a specific range
  3070. * @param v defines the vector to test
  3071. * @param min defines the minimum range
  3072. * @param max defines the maximum range
  3073. */
  3074. static CheckExtends(v: Vector3, min: Vector3, max: Vector3): void;
  3075. /**
  3076. * Returns a new Vector3 located for "amount" (float) on the Hermite interpolation spline defined by the vectors "value1", "tangent1", "value2", "tangent2"
  3077. * @param value1 defines the first control point
  3078. * @param tangent1 defines the first tangent vector
  3079. * @param value2 defines the second control point
  3080. * @param tangent2 defines the second tangent vector
  3081. * @param amount defines the amount on the interpolation spline (between 0 and 1)
  3082. * @returns the new Vector3
  3083. */
  3084. static Hermite(value1: DeepImmutable<Vector3>, tangent1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, tangent2: DeepImmutable<Vector3>, amount: number): Vector3;
  3085. /**
  3086. * Returns a new Vector3 located for "amount" (float) on the linear interpolation between the vectors "start" and "end"
  3087. * @param start defines the start value
  3088. * @param end defines the end value
  3089. * @param amount max defines amount between both (between 0 and 1)
  3090. * @returns the new Vector3
  3091. */
  3092. static Lerp(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number): Vector3;
  3093. /**
  3094. * Sets the given vector "result" with the result of the linear interpolation from the vector "start" for "amount" to the vector "end"
  3095. * @param start defines the start value
  3096. * @param end defines the end value
  3097. * @param amount max defines amount between both (between 0 and 1)
  3098. * @param result defines the Vector3 where to store the result
  3099. */
  3100. static LerpToRef(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number, result: Vector3): void;
  3101. /**
  3102. * Returns the dot product (float) between the vectors "left" and "right"
  3103. * @param left defines the left operand
  3104. * @param right defines the right operand
  3105. * @returns the dot product
  3106. */
  3107. static Dot(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): number;
  3108. /**
  3109. * Returns a new Vector3 as the cross product of the vectors "left" and "right"
  3110. * The cross product is then orthogonal to both "left" and "right"
  3111. * @param left defines the left operand
  3112. * @param right defines the right operand
  3113. * @returns the cross product
  3114. */
  3115. static Cross(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  3116. /**
  3117. * Sets the given vector "result" with the cross product of "left" and "right"
  3118. * The cross product is then orthogonal to both "left" and "right"
  3119. * @param left defines the left operand
  3120. * @param right defines the right operand
  3121. * @param result defines the Vector3 where to store the result
  3122. */
  3123. static CrossToRef(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>, result: Vector3): void;
  3124. /**
  3125. * Returns a new Vector3 as the normalization of the given vector
  3126. * @param vector defines the Vector3 to normalize
  3127. * @returns the new Vector3
  3128. */
  3129. static Normalize(vector: DeepImmutable<Vector3>): Vector3;
  3130. /**
  3131. * Sets the given vector "result" with the normalization of the given first vector
  3132. * @param vector defines the Vector3 to normalize
  3133. * @param result defines the Vector3 where to store the result
  3134. */
  3135. static NormalizeToRef(vector: DeepImmutable<Vector3>, result: Vector3): void;
  3136. /**
  3137. * Project a Vector3 onto screen space
  3138. * @param vector defines the Vector3 to project
  3139. * @param world defines the world matrix to use
  3140. * @param transform defines the transform (view x projection) matrix to use
  3141. * @param viewport defines the screen viewport to use
  3142. * @returns the new Vector3
  3143. */
  3144. static Project(vector: DeepImmutable<Vector3>, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>, viewport: DeepImmutable<Viewport>): Vector3;
  3145. /** @hidden */
  3146. static _UnprojectFromInvertedMatrixToRef(source: DeepImmutable<Vector3>, matrix: DeepImmutable<Matrix>, result: Vector3): void;
  3147. /**
  3148. * Unproject from screen space to object space
  3149. * @param source defines the screen space Vector3 to use
  3150. * @param viewportWidth defines the current width of the viewport
  3151. * @param viewportHeight defines the current height of the viewport
  3152. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  3153. * @param transform defines the transform (view x projection) matrix to use
  3154. * @returns the new Vector3
  3155. */
  3156. static UnprojectFromTransform(source: Vector3, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>): Vector3;
  3157. /**
  3158. * Unproject from screen space to object space
  3159. * @param source defines the screen space Vector3 to use
  3160. * @param viewportWidth defines the current width of the viewport
  3161. * @param viewportHeight defines the current height of the viewport
  3162. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  3163. * @param view defines the view matrix to use
  3164. * @param projection defines the projection matrix to use
  3165. * @returns the new Vector3
  3166. */
  3167. static Unproject(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Vector3;
  3168. /**
  3169. * Unproject from screen space to object space
  3170. * @param source defines the screen space Vector3 to use
  3171. * @param viewportWidth defines the current width of the viewport
  3172. * @param viewportHeight defines the current height of the viewport
  3173. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  3174. * @param view defines the view matrix to use
  3175. * @param projection defines the projection matrix to use
  3176. * @param result defines the Vector3 where to store the result
  3177. */
  3178. static UnprojectToRef(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  3179. /**
  3180. * Unproject from screen space to object space
  3181. * @param sourceX defines the screen space x coordinate to use
  3182. * @param sourceY defines the screen space y coordinate to use
  3183. * @param sourceZ defines the screen space z coordinate to use
  3184. * @param viewportWidth defines the current width of the viewport
  3185. * @param viewportHeight defines the current height of the viewport
  3186. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  3187. * @param view defines the view matrix to use
  3188. * @param projection defines the projection matrix to use
  3189. * @param result defines the Vector3 where to store the result
  3190. */
  3191. static UnprojectFloatsToRef(sourceX: float, sourceY: float, sourceZ: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  3192. /**
  3193. * Gets the minimal coordinate values between two Vector3
  3194. * @param left defines the first operand
  3195. * @param right defines the second operand
  3196. * @returns the new Vector3
  3197. */
  3198. static Minimize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  3199. /**
  3200. * Gets the maximal coordinate values between two Vector3
  3201. * @param left defines the first operand
  3202. * @param right defines the second operand
  3203. * @returns the new Vector3
  3204. */
  3205. static Maximize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  3206. /**
  3207. * Returns the distance between the vectors "value1" and "value2"
  3208. * @param value1 defines the first operand
  3209. * @param value2 defines the second operand
  3210. * @returns the distance
  3211. */
  3212. static Distance(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  3213. /**
  3214. * Returns the squared distance between the vectors "value1" and "value2"
  3215. * @param value1 defines the first operand
  3216. * @param value2 defines the second operand
  3217. * @returns the squared distance
  3218. */
  3219. static DistanceSquared(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  3220. /**
  3221. * Returns a new Vector3 located at the center between "value1" and "value2"
  3222. * @param value1 defines the first operand
  3223. * @param value2 defines the second operand
  3224. * @returns the new Vector3
  3225. */
  3226. static Center(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): Vector3;
  3227. /**
  3228. * Given three orthogonal normalized left-handed oriented Vector3 axis in space (target system),
  3229. * RotationFromAxis() returns the rotation Euler angles (ex : rotation.x, rotation.y, rotation.z) to apply
  3230. * to something in order to rotate it from its local system to the given target system
  3231. * Note: axis1, axis2 and axis3 are normalized during this operation
  3232. * @param axis1 defines the first axis
  3233. * @param axis2 defines the second axis
  3234. * @param axis3 defines the third axis
  3235. * @returns a new Vector3
  3236. */
  3237. static RotationFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Vector3;
  3238. /**
  3239. * The same than RotationFromAxis but updates the given ref Vector3 parameter instead of returning a new Vector3
  3240. * @param axis1 defines the first axis
  3241. * @param axis2 defines the second axis
  3242. * @param axis3 defines the third axis
  3243. * @param ref defines the Vector3 where to store the result
  3244. */
  3245. static RotationFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Vector3): void;
  3246. }
  3247. /**
  3248. * Vector4 class created for EulerAngle class conversion to Quaternion
  3249. */
  3250. export class Vector4 {
  3251. /** x value of the vector */
  3252. x: number;
  3253. /** y value of the vector */
  3254. y: number;
  3255. /** z value of the vector */
  3256. z: number;
  3257. /** w value of the vector */
  3258. w: number;
  3259. /**
  3260. * Creates a Vector4 object from the given floats.
  3261. * @param x x value of the vector
  3262. * @param y y value of the vector
  3263. * @param z z value of the vector
  3264. * @param w w value of the vector
  3265. */
  3266. constructor(
  3267. /** x value of the vector */
  3268. x: number,
  3269. /** y value of the vector */
  3270. y: number,
  3271. /** z value of the vector */
  3272. z: number,
  3273. /** w value of the vector */
  3274. w: number);
  3275. /**
  3276. * Returns the string with the Vector4 coordinates.
  3277. * @returns a string containing all the vector values
  3278. */
  3279. toString(): string;
  3280. /**
  3281. * Returns the string "Vector4".
  3282. * @returns "Vector4"
  3283. */
  3284. getClassName(): string;
  3285. /**
  3286. * Returns the Vector4 hash code.
  3287. * @returns a unique hash code
  3288. */
  3289. getHashCode(): number;
  3290. /**
  3291. * Returns a new array populated with 4 elements : the Vector4 coordinates.
  3292. * @returns the resulting array
  3293. */
  3294. asArray(): number[];
  3295. /**
  3296. * Populates the given array from the given index with the Vector4 coordinates.
  3297. * @param array array to populate
  3298. * @param index index of the array to start at (default: 0)
  3299. * @returns the Vector4.
  3300. */
  3301. toArray(array: FloatArray, index?: number): Vector4;
  3302. /**
  3303. * Update the current vector from an array
  3304. * @param array defines the destination array
  3305. * @param index defines the offset in the destination array
  3306. * @returns the current Vector3
  3307. */
  3308. fromArray(array: FloatArray, index?: number): Vector4;
  3309. /**
  3310. * Adds the given vector to the current Vector4.
  3311. * @param otherVector the vector to add
  3312. * @returns the updated Vector4.
  3313. */
  3314. addInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  3315. /**
  3316. * Returns a new Vector4 as the result of the addition of the current Vector4 and the given one.
  3317. * @param otherVector the vector to add
  3318. * @returns the resulting vector
  3319. */
  3320. add(otherVector: DeepImmutable<Vector4>): Vector4;
  3321. /**
  3322. * Updates the given vector "result" with the result of the addition of the current Vector4 and the given one.
  3323. * @param otherVector the vector to add
  3324. * @param result the vector to store the result
  3325. * @returns the current Vector4.
  3326. */
  3327. addToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3328. /**
  3329. * Subtract in place the given vector from the current Vector4.
  3330. * @param otherVector the vector to subtract
  3331. * @returns the updated Vector4.
  3332. */
  3333. subtractInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  3334. /**
  3335. * Returns a new Vector4 with the result of the subtraction of the given vector from the current Vector4.
  3336. * @param otherVector the vector to add
  3337. * @returns the new vector with the result
  3338. */
  3339. subtract(otherVector: DeepImmutable<Vector4>): Vector4;
  3340. /**
  3341. * Sets the given vector "result" with the result of the subtraction of the given vector from the current Vector4.
  3342. * @param otherVector the vector to subtract
  3343. * @param result the vector to store the result
  3344. * @returns the current Vector4.
  3345. */
  3346. subtractToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3347. /**
  3348. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  3349. */
  3350. /**
  3351. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  3352. * @param x value to subtract
  3353. * @param y value to subtract
  3354. * @param z value to subtract
  3355. * @param w value to subtract
  3356. * @returns new vector containing the result
  3357. */
  3358. subtractFromFloats(x: number, y: number, z: number, w: number): Vector4;
  3359. /**
  3360. * Sets the given vector "result" set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  3361. * @param x value to subtract
  3362. * @param y value to subtract
  3363. * @param z value to subtract
  3364. * @param w value to subtract
  3365. * @param result the vector to store the result in
  3366. * @returns the current Vector4.
  3367. */
  3368. subtractFromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): Vector4;
  3369. /**
  3370. * Returns a new Vector4 set with the current Vector4 negated coordinates.
  3371. * @returns a new vector with the negated values
  3372. */
  3373. negate(): Vector4;
  3374. /**
  3375. * Negate this vector in place
  3376. * @returns this
  3377. */
  3378. negateInPlace(): Vector4;
  3379. /**
  3380. * Negate the current Vector4 and stores the result in the given vector "result" coordinates
  3381. * @param result defines the Vector3 object where to store the result
  3382. * @returns the current Vector4
  3383. */
  3384. negateToRef(result: Vector4): Vector4;
  3385. /**
  3386. * Multiplies the current Vector4 coordinates by scale (float).
  3387. * @param scale the number to scale with
  3388. * @returns the updated Vector4.
  3389. */
  3390. scaleInPlace(scale: number): Vector4;
  3391. /**
  3392. * Returns a new Vector4 set with the current Vector4 coordinates multiplied by scale (float).
  3393. * @param scale the number to scale with
  3394. * @returns a new vector with the result
  3395. */
  3396. scale(scale: number): Vector4;
  3397. /**
  3398. * Sets the given vector "result" with the current Vector4 coordinates multiplied by scale (float).
  3399. * @param scale the number to scale with
  3400. * @param result a vector to store the result in
  3401. * @returns the current Vector4.
  3402. */
  3403. scaleToRef(scale: number, result: Vector4): Vector4;
  3404. /**
  3405. * Scale the current Vector4 values by a factor and add the result to a given Vector4
  3406. * @param scale defines the scale factor
  3407. * @param result defines the Vector4 object where to store the result
  3408. * @returns the unmodified current Vector4
  3409. */
  3410. scaleAndAddToRef(scale: number, result: Vector4): Vector4;
  3411. /**
  3412. * Boolean : True if the current Vector4 coordinates are stricly equal to the given ones.
  3413. * @param otherVector the vector to compare against
  3414. * @returns true if they are equal
  3415. */
  3416. equals(otherVector: DeepImmutable<Vector4>): boolean;
  3417. /**
  3418. * Boolean : True if the current Vector4 coordinates are each beneath the distance "epsilon" from the given vector ones.
  3419. * @param otherVector vector to compare against
  3420. * @param epsilon (Default: very small number)
  3421. * @returns true if they are equal
  3422. */
  3423. equalsWithEpsilon(otherVector: DeepImmutable<Vector4>, epsilon?: number): boolean;
  3424. /**
  3425. * Boolean : True if the given floats are strictly equal to the current Vector4 coordinates.
  3426. * @param x x value to compare against
  3427. * @param y y value to compare against
  3428. * @param z z value to compare against
  3429. * @param w w value to compare against
  3430. * @returns true if equal
  3431. */
  3432. equalsToFloats(x: number, y: number, z: number, w: number): boolean;
  3433. /**
  3434. * Multiplies in place the current Vector4 by the given one.
  3435. * @param otherVector vector to multiple with
  3436. * @returns the updated Vector4.
  3437. */
  3438. multiplyInPlace(otherVector: Vector4): Vector4;
  3439. /**
  3440. * Returns a new Vector4 set with the multiplication result of the current Vector4 and the given one.
  3441. * @param otherVector vector to multiple with
  3442. * @returns resulting new vector
  3443. */
  3444. multiply(otherVector: DeepImmutable<Vector4>): Vector4;
  3445. /**
  3446. * Updates the given vector "result" with the multiplication result of the current Vector4 and the given one.
  3447. * @param otherVector vector to multiple with
  3448. * @param result vector to store the result
  3449. * @returns the current Vector4.
  3450. */
  3451. multiplyToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3452. /**
  3453. * Returns a new Vector4 set with the multiplication result of the given floats and the current Vector4 coordinates.
  3454. * @param x x value multiply with
  3455. * @param y y value multiply with
  3456. * @param z z value multiply with
  3457. * @param w w value multiply with
  3458. * @returns resulting new vector
  3459. */
  3460. multiplyByFloats(x: number, y: number, z: number, w: number): Vector4;
  3461. /**
  3462. * Returns a new Vector4 set with the division result of the current Vector4 by the given one.
  3463. * @param otherVector vector to devide with
  3464. * @returns resulting new vector
  3465. */
  3466. divide(otherVector: DeepImmutable<Vector4>): Vector4;
  3467. /**
  3468. * Updates the given vector "result" with the division result of the current Vector4 by the given one.
  3469. * @param otherVector vector to devide with
  3470. * @param result vector to store the result
  3471. * @returns the current Vector4.
  3472. */
  3473. divideToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3474. /**
  3475. * Divides the current Vector3 coordinates by the given ones.
  3476. * @param otherVector vector to devide with
  3477. * @returns the updated Vector3.
  3478. */
  3479. divideInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  3480. /**
  3481. * Updates the Vector4 coordinates with the minimum values between its own and the given vector ones
  3482. * @param other defines the second operand
  3483. * @returns the current updated Vector4
  3484. */
  3485. minimizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  3486. /**
  3487. * Updates the Vector4 coordinates with the maximum values between its own and the given vector ones
  3488. * @param other defines the second operand
  3489. * @returns the current updated Vector4
  3490. */
  3491. maximizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  3492. /**
  3493. * Gets a new Vector4 from current Vector4 floored values
  3494. * @returns a new Vector4
  3495. */
  3496. floor(): Vector4;
  3497. /**
  3498. * Gets a new Vector4 from current Vector3 floored values
  3499. * @returns a new Vector4
  3500. */
  3501. fract(): Vector4;
  3502. /**
  3503. * Returns the Vector4 length (float).
  3504. * @returns the length
  3505. */
  3506. length(): number;
  3507. /**
  3508. * Returns the Vector4 squared length (float).
  3509. * @returns the length squared
  3510. */
  3511. lengthSquared(): number;
  3512. /**
  3513. * Normalizes in place the Vector4.
  3514. * @returns the updated Vector4.
  3515. */
  3516. normalize(): Vector4;
  3517. /**
  3518. * Returns a new Vector3 from the Vector4 (x, y, z) coordinates.
  3519. * @returns this converted to a new vector3
  3520. */
  3521. toVector3(): Vector3;
  3522. /**
  3523. * Returns a new Vector4 copied from the current one.
  3524. * @returns the new cloned vector
  3525. */
  3526. clone(): Vector4;
  3527. /**
  3528. * Updates the current Vector4 with the given one coordinates.
  3529. * @param source the source vector to copy from
  3530. * @returns the updated Vector4.
  3531. */
  3532. copyFrom(source: DeepImmutable<Vector4>): Vector4;
  3533. /**
  3534. * Updates the current Vector4 coordinates with the given floats.
  3535. * @param x float to copy from
  3536. * @param y float to copy from
  3537. * @param z float to copy from
  3538. * @param w float to copy from
  3539. * @returns the updated Vector4.
  3540. */
  3541. copyFromFloats(x: number, y: number, z: number, w: number): Vector4;
  3542. /**
  3543. * Updates the current Vector4 coordinates with the given floats.
  3544. * @param x float to set from
  3545. * @param y float to set from
  3546. * @param z float to set from
  3547. * @param w float to set from
  3548. * @returns the updated Vector4.
  3549. */
  3550. set(x: number, y: number, z: number, w: number): Vector4;
  3551. /**
  3552. * Copies the given float to the current Vector3 coordinates
  3553. * @param v defines the x, y, z and w coordinates of the operand
  3554. * @returns the current updated Vector3
  3555. */
  3556. setAll(v: number): Vector4;
  3557. /**
  3558. * Returns a new Vector4 set from the starting index of the given array.
  3559. * @param array the array to pull values from
  3560. * @param offset the offset into the array to start at
  3561. * @returns the new vector
  3562. */
  3563. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector4;
  3564. /**
  3565. * Updates the given vector "result" from the starting index of the given array.
  3566. * @param array the array to pull values from
  3567. * @param offset the offset into the array to start at
  3568. * @param result the vector to store the result in
  3569. */
  3570. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector4): void;
  3571. /**
  3572. * Updates the given vector "result" from the starting index of the given Float32Array.
  3573. * @param array the array to pull values from
  3574. * @param offset the offset into the array to start at
  3575. * @param result the vector to store the result in
  3576. */
  3577. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector4): void;
  3578. /**
  3579. * Updates the given vector "result" coordinates from the given floats.
  3580. * @param x float to set from
  3581. * @param y float to set from
  3582. * @param z float to set from
  3583. * @param w float to set from
  3584. * @param result the vector to the floats in
  3585. */
  3586. static FromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): void;
  3587. /**
  3588. * Returns a new Vector4 set to (0.0, 0.0, 0.0, 0.0)
  3589. * @returns the new vector
  3590. */
  3591. static Zero(): Vector4;
  3592. /**
  3593. * Returns a new Vector4 set to (1.0, 1.0, 1.0, 1.0)
  3594. * @returns the new vector
  3595. */
  3596. static One(): Vector4;
  3597. /**
  3598. * Returns a new normalized Vector4 from the given one.
  3599. * @param vector the vector to normalize
  3600. * @returns the vector
  3601. */
  3602. static Normalize(vector: DeepImmutable<Vector4>): Vector4;
  3603. /**
  3604. * Updates the given vector "result" from the normalization of the given one.
  3605. * @param vector the vector to normalize
  3606. * @param result the vector to store the result in
  3607. */
  3608. static NormalizeToRef(vector: DeepImmutable<Vector4>, result: Vector4): void;
  3609. /**
  3610. * Returns a vector with the minimum values from the left and right vectors
  3611. * @param left left vector to minimize
  3612. * @param right right vector to minimize
  3613. * @returns a new vector with the minimum of the left and right vector values
  3614. */
  3615. static Minimize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  3616. /**
  3617. * Returns a vector with the maximum values from the left and right vectors
  3618. * @param left left vector to maximize
  3619. * @param right right vector to maximize
  3620. * @returns a new vector with the maximum of the left and right vector values
  3621. */
  3622. static Maximize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  3623. /**
  3624. * Returns the distance (float) between the vectors "value1" and "value2".
  3625. * @param value1 value to calulate the distance between
  3626. * @param value2 value to calulate the distance between
  3627. * @return the distance between the two vectors
  3628. */
  3629. static Distance(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  3630. /**
  3631. * Returns the squared distance (float) between the vectors "value1" and "value2".
  3632. * @param value1 value to calulate the distance between
  3633. * @param value2 value to calulate the distance between
  3634. * @return the distance between the two vectors squared
  3635. */
  3636. static DistanceSquared(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  3637. /**
  3638. * Returns a new Vector4 located at the center between the vectors "value1" and "value2".
  3639. * @param value1 value to calulate the center between
  3640. * @param value2 value to calulate the center between
  3641. * @return the center between the two vectors
  3642. */
  3643. static Center(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): Vector4;
  3644. /**
  3645. * Returns a new Vector4 set with the result of the normal transformation by the given matrix of the given vector.
  3646. * This methods computes transformed normalized direction vectors only.
  3647. * @param vector the vector to transform
  3648. * @param transformation the transformation matrix to apply
  3649. * @returns the new vector
  3650. */
  3651. static TransformNormal(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>): Vector4;
  3652. /**
  3653. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector.
  3654. * This methods computes transformed normalized direction vectors only.
  3655. * @param vector the vector to transform
  3656. * @param transformation the transformation matrix to apply
  3657. * @param result the vector to store the result in
  3658. */
  3659. static TransformNormalToRef(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  3660. /**
  3661. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z, w).
  3662. * This methods computes transformed normalized direction vectors only.
  3663. * @param x value to transform
  3664. * @param y value to transform
  3665. * @param z value to transform
  3666. * @param w value to transform
  3667. * @param transformation the transformation matrix to apply
  3668. * @param result the vector to store the results in
  3669. */
  3670. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, w: number, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  3671. /**
  3672. * Creates a new Vector4 from a Vector3
  3673. * @param source defines the source data
  3674. * @param w defines the 4th component (default is 0)
  3675. * @returns a new Vector4
  3676. */
  3677. static FromVector3(source: Vector3, w?: number): Vector4;
  3678. }
  3679. /**
  3680. * Class used to store quaternion data
  3681. * @see https://en.wikipedia.org/wiki/Quaternion
  3682. * @see https://doc.babylonjs.com/features/position,_rotation,_scaling
  3683. */
  3684. export class Quaternion {
  3685. /** @hidden */
  3686. _x: number;
  3687. /** @hidden */
  3688. _y: number;
  3689. /** @hidden */
  3690. _z: number;
  3691. /** @hidden */
  3692. _w: number;
  3693. /** @hidden */
  3694. _isDirty: boolean;
  3695. /** Gets or sets the x coordinate */
  3696. get x(): number;
  3697. set x(value: number);
  3698. /** Gets or sets the y coordinate */
  3699. get y(): number;
  3700. set y(value: number);
  3701. /** Gets or sets the z coordinate */
  3702. get z(): number;
  3703. set z(value: number);
  3704. /** Gets or sets the w coordinate */
  3705. get w(): number;
  3706. set w(value: number);
  3707. /**
  3708. * Creates a new Quaternion from the given floats
  3709. * @param x defines the first component (0 by default)
  3710. * @param y defines the second component (0 by default)
  3711. * @param z defines the third component (0 by default)
  3712. * @param w defines the fourth component (1.0 by default)
  3713. */
  3714. constructor(x?: number, y?: number, z?: number, w?: number);
  3715. /**
  3716. * Gets a string representation for the current quaternion
  3717. * @returns a string with the Quaternion coordinates
  3718. */
  3719. toString(): string;
  3720. /**
  3721. * Gets the class name of the quaternion
  3722. * @returns the string "Quaternion"
  3723. */
  3724. getClassName(): string;
  3725. /**
  3726. * Gets a hash code for this quaternion
  3727. * @returns the quaternion hash code
  3728. */
  3729. getHashCode(): number;
  3730. /**
  3731. * Copy the quaternion to an array
  3732. * @returns a new array populated with 4 elements from the quaternion coordinates
  3733. */
  3734. asArray(): number[];
  3735. /**
  3736. * Check if two quaternions are equals
  3737. * @param otherQuaternion defines the second operand
  3738. * @return true if the current quaternion and the given one coordinates are strictly equals
  3739. */
  3740. equals(otherQuaternion: DeepImmutable<Quaternion>): boolean;
  3741. /**
  3742. * Gets a boolean if two quaternions are equals (using an epsilon value)
  3743. * @param otherQuaternion defines the other quaternion
  3744. * @param epsilon defines the minimal distance to consider equality
  3745. * @returns true if the given quaternion coordinates are close to the current ones by a distance of epsilon.
  3746. */
  3747. equalsWithEpsilon(otherQuaternion: DeepImmutable<Quaternion>, epsilon?: number): boolean;
  3748. /**
  3749. * Clone the current quaternion
  3750. * @returns a new quaternion copied from the current one
  3751. */
  3752. clone(): Quaternion;
  3753. /**
  3754. * Copy a quaternion to the current one
  3755. * @param other defines the other quaternion
  3756. * @returns the updated current quaternion
  3757. */
  3758. copyFrom(other: DeepImmutable<Quaternion>): Quaternion;
  3759. /**
  3760. * Updates the current quaternion with the given float coordinates
  3761. * @param x defines the x coordinate
  3762. * @param y defines the y coordinate
  3763. * @param z defines the z coordinate
  3764. * @param w defines the w coordinate
  3765. * @returns the updated current quaternion
  3766. */
  3767. copyFromFloats(x: number, y: number, z: number, w: number): Quaternion;
  3768. /**
  3769. * Updates the current quaternion from the given float coordinates
  3770. * @param x defines the x coordinate
  3771. * @param y defines the y coordinate
  3772. * @param z defines the z coordinate
  3773. * @param w defines the w coordinate
  3774. * @returns the updated current quaternion
  3775. */
  3776. set(x: number, y: number, z: number, w: number): Quaternion;
  3777. /**
  3778. * Adds two quaternions
  3779. * @param other defines the second operand
  3780. * @returns a new quaternion as the addition result of the given one and the current quaternion
  3781. */
  3782. add(other: DeepImmutable<Quaternion>): Quaternion;
  3783. /**
  3784. * Add a quaternion to the current one
  3785. * @param other defines the quaternion to add
  3786. * @returns the current quaternion
  3787. */
  3788. addInPlace(other: DeepImmutable<Quaternion>): Quaternion;
  3789. /**
  3790. * Subtract two quaternions
  3791. * @param other defines the second operand
  3792. * @returns a new quaternion as the subtraction result of the given one from the current one
  3793. */
  3794. subtract(other: Quaternion): Quaternion;
  3795. /**
  3796. * Multiplies the current quaternion by a scale factor
  3797. * @param value defines the scale factor
  3798. * @returns a new quaternion set by multiplying the current quaternion coordinates by the float "scale"
  3799. */
  3800. scale(value: number): Quaternion;
  3801. /**
  3802. * Scale the current quaternion values by a factor and stores the result to a given quaternion
  3803. * @param scale defines the scale factor
  3804. * @param result defines the Quaternion object where to store the result
  3805. * @returns the unmodified current quaternion
  3806. */
  3807. scaleToRef(scale: number, result: Quaternion): Quaternion;
  3808. /**
  3809. * Multiplies in place the current quaternion by a scale factor
  3810. * @param value defines the scale factor
  3811. * @returns the current modified quaternion
  3812. */
  3813. scaleInPlace(value: number): Quaternion;
  3814. /**
  3815. * Scale the current quaternion values by a factor and add the result to a given quaternion
  3816. * @param scale defines the scale factor
  3817. * @param result defines the Quaternion object where to store the result
  3818. * @returns the unmodified current quaternion
  3819. */
  3820. scaleAndAddToRef(scale: number, result: Quaternion): Quaternion;
  3821. /**
  3822. * Multiplies two quaternions
  3823. * @param q1 defines the second operand
  3824. * @returns a new quaternion set as the multiplication result of the current one with the given one "q1"
  3825. */
  3826. multiply(q1: DeepImmutable<Quaternion>): Quaternion;
  3827. /**
  3828. * Sets the given "result" as the the multiplication result of the current one with the given one "q1"
  3829. * @param q1 defines the second operand
  3830. * @param result defines the target quaternion
  3831. * @returns the current quaternion
  3832. */
  3833. multiplyToRef(q1: DeepImmutable<Quaternion>, result: Quaternion): Quaternion;
  3834. /**
  3835. * Updates the current quaternion with the multiplication of itself with the given one "q1"
  3836. * @param q1 defines the second operand
  3837. * @returns the currentupdated quaternion
  3838. */
  3839. multiplyInPlace(q1: DeepImmutable<Quaternion>): Quaternion;
  3840. /**
  3841. * Conjugates (1-q) the current quaternion and stores the result in the given quaternion
  3842. * @param ref defines the target quaternion
  3843. * @returns the current quaternion
  3844. */
  3845. conjugateToRef(ref: Quaternion): Quaternion;
  3846. /**
  3847. * Conjugates in place (1-q) the current quaternion
  3848. * @returns the current updated quaternion
  3849. */
  3850. conjugateInPlace(): Quaternion;
  3851. /**
  3852. * Conjugates in place (1-q) the current quaternion
  3853. * @returns a new quaternion
  3854. */
  3855. conjugate(): Quaternion;
  3856. /**
  3857. * Gets length of current quaternion
  3858. * @returns the quaternion length (float)
  3859. */
  3860. length(): number;
  3861. /**
  3862. * Normalize in place the current quaternion
  3863. * @returns the current updated quaternion
  3864. */
  3865. normalize(): Quaternion;
  3866. /**
  3867. * Returns a new Vector3 set with the Euler angles translated from the current quaternion
  3868. * @param order is a reserved parameter and is ignore for now
  3869. * @returns a new Vector3 containing the Euler angles
  3870. */
  3871. toEulerAngles(order?: string): Vector3;
  3872. /**
  3873. * Sets the given vector3 "result" with the Euler angles translated from the current quaternion
  3874. * @param result defines the vector which will be filled with the Euler angles
  3875. * @param order is a reserved parameter and is ignore for now
  3876. * @returns the current unchanged quaternion
  3877. */
  3878. toEulerAnglesToRef(result: Vector3): Quaternion;
  3879. /**
  3880. * Updates the given rotation matrix with the current quaternion values
  3881. * @param result defines the target matrix
  3882. * @returns the current unchanged quaternion
  3883. */
  3884. toRotationMatrix(result: Matrix): Quaternion;
  3885. /**
  3886. * Updates the current quaternion from the given rotation matrix values
  3887. * @param matrix defines the source matrix
  3888. * @returns the current updated quaternion
  3889. */
  3890. fromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  3891. /**
  3892. * Creates a new quaternion from a rotation matrix
  3893. * @param matrix defines the source matrix
  3894. * @returns a new quaternion created from the given rotation matrix values
  3895. */
  3896. static FromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  3897. /**
  3898. * Updates the given quaternion with the given rotation matrix values
  3899. * @param matrix defines the source matrix
  3900. * @param result defines the target quaternion
  3901. */
  3902. static FromRotationMatrixToRef(matrix: DeepImmutable<Matrix>, result: Quaternion): void;
  3903. /**
  3904. * Returns the dot product (float) between the quaternions "left" and "right"
  3905. * @param left defines the left operand
  3906. * @param right defines the right operand
  3907. * @returns the dot product
  3908. */
  3909. static Dot(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>): number;
  3910. /**
  3911. * Checks if the two quaternions are close to each other
  3912. * @param quat0 defines the first quaternion to check
  3913. * @param quat1 defines the second quaternion to check
  3914. * @returns true if the two quaternions are close to each other
  3915. */
  3916. static AreClose(quat0: DeepImmutable<Quaternion>, quat1: DeepImmutable<Quaternion>): boolean;
  3917. /**
  3918. * Creates an empty quaternion
  3919. * @returns a new quaternion set to (0.0, 0.0, 0.0)
  3920. */
  3921. static Zero(): Quaternion;
  3922. /**
  3923. * Inverse a given quaternion
  3924. * @param q defines the source quaternion
  3925. * @returns a new quaternion as the inverted current quaternion
  3926. */
  3927. static Inverse(q: DeepImmutable<Quaternion>): Quaternion;
  3928. /**
  3929. * Inverse a given quaternion
  3930. * @param q defines the source quaternion
  3931. * @param result the quaternion the result will be stored in
  3932. * @returns the result quaternion
  3933. */
  3934. static InverseToRef(q: Quaternion, result: Quaternion): Quaternion;
  3935. /**
  3936. * Creates an identity quaternion
  3937. * @returns the identity quaternion
  3938. */
  3939. static Identity(): Quaternion;
  3940. /**
  3941. * Gets a boolean indicating if the given quaternion is identity
  3942. * @param quaternion defines the quaternion to check
  3943. * @returns true if the quaternion is identity
  3944. */
  3945. static IsIdentity(quaternion: DeepImmutable<Quaternion>): boolean;
  3946. /**
  3947. * Creates a quaternion from a rotation around an axis
  3948. * @param axis defines the axis to use
  3949. * @param angle defines the angle to use
  3950. * @returns a new quaternion created from the given axis (Vector3) and angle in radians (float)
  3951. */
  3952. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Quaternion;
  3953. /**
  3954. * Creates a rotation around an axis and stores it into the given quaternion
  3955. * @param axis defines the axis to use
  3956. * @param angle defines the angle to use
  3957. * @param result defines the target quaternion
  3958. * @returns the target quaternion
  3959. */
  3960. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Quaternion): Quaternion;
  3961. /**
  3962. * Creates a new quaternion from data stored into an array
  3963. * @param array defines the data source
  3964. * @param offset defines the offset in the source array where the data starts
  3965. * @returns a new quaternion
  3966. */
  3967. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Quaternion;
  3968. /**
  3969. * Updates the given quaternion "result" from the starting index of the given array.
  3970. * @param array the array to pull values from
  3971. * @param offset the offset into the array to start at
  3972. * @param result the quaternion to store the result in
  3973. */
  3974. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Quaternion): void;
  3975. /**
  3976. * Create a quaternion from Euler rotation angles
  3977. * @param x Pitch
  3978. * @param y Yaw
  3979. * @param z Roll
  3980. * @returns the new Quaternion
  3981. */
  3982. static FromEulerAngles(x: number, y: number, z: number): Quaternion;
  3983. /**
  3984. * Updates a quaternion from Euler rotation angles
  3985. * @param x Pitch
  3986. * @param y Yaw
  3987. * @param z Roll
  3988. * @param result the quaternion to store the result
  3989. * @returns the updated quaternion
  3990. */
  3991. static FromEulerAnglesToRef(x: number, y: number, z: number, result: Quaternion): Quaternion;
  3992. /**
  3993. * Create a quaternion from Euler rotation vector
  3994. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  3995. * @returns the new Quaternion
  3996. */
  3997. static FromEulerVector(vec: DeepImmutable<Vector3>): Quaternion;
  3998. /**
  3999. * Updates a quaternion from Euler rotation vector
  4000. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  4001. * @param result the quaternion to store the result
  4002. * @returns the updated quaternion
  4003. */
  4004. static FromEulerVectorToRef(vec: DeepImmutable<Vector3>, result: Quaternion): Quaternion;
  4005. /**
  4006. * Creates a new quaternion from the given Euler float angles (y, x, z)
  4007. * @param yaw defines the rotation around Y axis
  4008. * @param pitch defines the rotation around X axis
  4009. * @param roll defines the rotation around Z axis
  4010. * @returns the new quaternion
  4011. */
  4012. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Quaternion;
  4013. /**
  4014. * Creates a new rotation from the given Euler float angles (y, x, z) and stores it in the target quaternion
  4015. * @param yaw defines the rotation around Y axis
  4016. * @param pitch defines the rotation around X axis
  4017. * @param roll defines the rotation around Z axis
  4018. * @param result defines the target quaternion
  4019. */
  4020. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Quaternion): void;
  4021. /**
  4022. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation
  4023. * @param alpha defines the rotation around first axis
  4024. * @param beta defines the rotation around second axis
  4025. * @param gamma defines the rotation around third axis
  4026. * @returns the new quaternion
  4027. */
  4028. static RotationAlphaBetaGamma(alpha: number, beta: number, gamma: number): Quaternion;
  4029. /**
  4030. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation and stores it in the target quaternion
  4031. * @param alpha defines the rotation around first axis
  4032. * @param beta defines the rotation around second axis
  4033. * @param gamma defines the rotation around third axis
  4034. * @param result defines the target quaternion
  4035. */
  4036. static RotationAlphaBetaGammaToRef(alpha: number, beta: number, gamma: number, result: Quaternion): void;
  4037. /**
  4038. * Creates a new quaternion containing the rotation value to reach the target (axis1, axis2, axis3) orientation as a rotated XYZ system (axis1, axis2 and axis3 are normalized during this operation)
  4039. * @param axis1 defines the first axis
  4040. * @param axis2 defines the second axis
  4041. * @param axis3 defines the third axis
  4042. * @returns the new quaternion
  4043. */
  4044. static RotationQuaternionFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Quaternion;
  4045. /**
  4046. * Creates a rotation value to reach the target (axis1, axis2, axis3) orientation as a rotated XYZ system (axis1, axis2 and axis3 are normalized during this operation) and stores it in the target quaternion
  4047. * @param axis1 defines the first axis
  4048. * @param axis2 defines the second axis
  4049. * @param axis3 defines the third axis
  4050. * @param ref defines the target quaternion
  4051. */
  4052. static RotationQuaternionFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Quaternion): void;
  4053. /**
  4054. * Interpolates between two quaternions
  4055. * @param left defines first quaternion
  4056. * @param right defines second quaternion
  4057. * @param amount defines the gradient to use
  4058. * @returns the new interpolated quaternion
  4059. */
  4060. static Slerp(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number): Quaternion;
  4061. /**
  4062. * Interpolates between two quaternions and stores it into a target quaternion
  4063. * @param left defines first quaternion
  4064. * @param right defines second quaternion
  4065. * @param amount defines the gradient to use
  4066. * @param result defines the target quaternion
  4067. */
  4068. static SlerpToRef(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number, result: Quaternion): void;
  4069. /**
  4070. * Interpolate between two quaternions using Hermite interpolation
  4071. * @param value1 defines first quaternion
  4072. * @param tangent1 defines the incoming tangent
  4073. * @param value2 defines second quaternion
  4074. * @param tangent2 defines the outgoing tangent
  4075. * @param amount defines the target quaternion
  4076. * @returns the new interpolated quaternion
  4077. */
  4078. static Hermite(value1: DeepImmutable<Quaternion>, tangent1: DeepImmutable<Quaternion>, value2: DeepImmutable<Quaternion>, tangent2: DeepImmutable<Quaternion>, amount: number): Quaternion;
  4079. }
  4080. /**
  4081. * Class used to store matrix data (4x4)
  4082. */
  4083. export class Matrix {
  4084. /**
  4085. * Gets the precision of matrix computations
  4086. */
  4087. static get Use64Bits(): boolean;
  4088. private static _updateFlagSeed;
  4089. private static _identityReadOnly;
  4090. private _isIdentity;
  4091. private _isIdentityDirty;
  4092. private _isIdentity3x2;
  4093. private _isIdentity3x2Dirty;
  4094. /**
  4095. * Gets the update flag of the matrix which is an unique number for the matrix.
  4096. * It will be incremented every time the matrix data change.
  4097. * You can use it to speed the comparison between two versions of the same matrix.
  4098. */
  4099. updateFlag: number;
  4100. private readonly _m;
  4101. /**
  4102. * Gets the internal data of the matrix
  4103. */
  4104. get m(): DeepImmutable<Float32Array | Array<number>>;
  4105. /** @hidden */
  4106. _markAsUpdated(): void;
  4107. /** @hidden */
  4108. private _updateIdentityStatus;
  4109. /**
  4110. * Creates an empty matrix (filled with zeros)
  4111. */
  4112. constructor();
  4113. /**
  4114. * Check if the current matrix is identity
  4115. * @returns true is the matrix is the identity matrix
  4116. */
  4117. isIdentity(): boolean;
  4118. /**
  4119. * Check if the current matrix is identity as a texture matrix (3x2 store in 4x4)
  4120. * @returns true is the matrix is the identity matrix
  4121. */
  4122. isIdentityAs3x2(): boolean;
  4123. /**
  4124. * Gets the determinant of the matrix
  4125. * @returns the matrix determinant
  4126. */
  4127. determinant(): number;
  4128. /**
  4129. * Returns the matrix as a Float32Array or Array<number>
  4130. * @returns the matrix underlying array
  4131. */
  4132. toArray(): DeepImmutable<Float32Array | Array<number>>;
  4133. /**
  4134. * Returns the matrix as a Float32Array or Array<number>
  4135. * @returns the matrix underlying array.
  4136. */
  4137. asArray(): DeepImmutable<Float32Array | Array<number>>;
  4138. /**
  4139. * Inverts the current matrix in place
  4140. * @returns the current inverted matrix
  4141. */
  4142. invert(): Matrix;
  4143. /**
  4144. * Sets all the matrix elements to zero
  4145. * @returns the current matrix
  4146. */
  4147. reset(): Matrix;
  4148. /**
  4149. * Adds the current matrix with a second one
  4150. * @param other defines the matrix to add
  4151. * @returns a new matrix as the addition of the current matrix and the given one
  4152. */
  4153. add(other: DeepImmutable<Matrix>): Matrix;
  4154. /**
  4155. * Sets the given matrix "result" to the addition of the current matrix and the given one
  4156. * @param other defines the matrix to add
  4157. * @param result defines the target matrix
  4158. * @returns the current matrix
  4159. */
  4160. addToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  4161. /**
  4162. * Adds in place the given matrix to the current matrix
  4163. * @param other defines the second operand
  4164. * @returns the current updated matrix
  4165. */
  4166. addToSelf(other: DeepImmutable<Matrix>): Matrix;
  4167. /**
  4168. * Sets the given matrix to the current inverted Matrix
  4169. * @param other defines the target matrix
  4170. * @returns the unmodified current matrix
  4171. */
  4172. invertToRef(other: Matrix): Matrix;
  4173. /**
  4174. * add a value at the specified position in the current Matrix
  4175. * @param index the index of the value within the matrix. between 0 and 15.
  4176. * @param value the value to be added
  4177. * @returns the current updated matrix
  4178. */
  4179. addAtIndex(index: number, value: number): Matrix;
  4180. /**
  4181. * mutiply the specified position in the current Matrix by a value
  4182. * @param index the index of the value within the matrix. between 0 and 15.
  4183. * @param value the value to be added
  4184. * @returns the current updated matrix
  4185. */
  4186. multiplyAtIndex(index: number, value: number): Matrix;
  4187. /**
  4188. * Inserts the translation vector (using 3 floats) in the current matrix
  4189. * @param x defines the 1st component of the translation
  4190. * @param y defines the 2nd component of the translation
  4191. * @param z defines the 3rd component of the translation
  4192. * @returns the current updated matrix
  4193. */
  4194. setTranslationFromFloats(x: number, y: number, z: number): Matrix;
  4195. /**
  4196. * Adds the translation vector (using 3 floats) in the current matrix
  4197. * @param x defines the 1st component of the translation
  4198. * @param y defines the 2nd component of the translation
  4199. * @param z defines the 3rd component of the translation
  4200. * @returns the current updated matrix
  4201. */
  4202. addTranslationFromFloats(x: number, y: number, z: number): Matrix;
  4203. /**
  4204. * Inserts the translation vector in the current matrix
  4205. * @param vector3 defines the translation to insert
  4206. * @returns the current updated matrix
  4207. */
  4208. setTranslation(vector3: DeepImmutable<Vector3>): Matrix;
  4209. /**
  4210. * Gets the translation value of the current matrix
  4211. * @returns a new Vector3 as the extracted translation from the matrix
  4212. */
  4213. getTranslation(): Vector3;
  4214. /**
  4215. * Fill a Vector3 with the extracted translation from the matrix
  4216. * @param result defines the Vector3 where to store the translation
  4217. * @returns the current matrix
  4218. */
  4219. getTranslationToRef(result: Vector3): Matrix;
  4220. /**
  4221. * Remove rotation and scaling part from the matrix
  4222. * @returns the updated matrix
  4223. */
  4224. removeRotationAndScaling(): Matrix;
  4225. /**
  4226. * Multiply two matrices
  4227. * @param other defines the second operand
  4228. * @returns a new matrix set with the multiplication result of the current Matrix and the given one
  4229. */
  4230. multiply(other: DeepImmutable<Matrix>): Matrix;
  4231. /**
  4232. * Copy the current matrix from the given one
  4233. * @param other defines the source matrix
  4234. * @returns the current updated matrix
  4235. */
  4236. copyFrom(other: DeepImmutable<Matrix>): Matrix;
  4237. /**
  4238. * Populates the given array from the starting index with the current matrix values
  4239. * @param array defines the target array
  4240. * @param offset defines the offset in the target array where to start storing values
  4241. * @returns the current matrix
  4242. */
  4243. copyToArray(array: Float32Array | Array<number>, offset?: number): Matrix;
  4244. /**
  4245. * Sets the given matrix "result" with the multiplication result of the current Matrix and the given one
  4246. * @param other defines the second operand
  4247. * @param result defines the matrix where to store the multiplication
  4248. * @returns the current matrix
  4249. */
  4250. multiplyToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  4251. /**
  4252. * Sets the Float32Array "result" from the given index "offset" with the multiplication of the current matrix and the given one
  4253. * @param other defines the second operand
  4254. * @param result defines the array where to store the multiplication
  4255. * @param offset defines the offset in the target array where to start storing values
  4256. * @returns the current matrix
  4257. */
  4258. multiplyToArray(other: DeepImmutable<Matrix>, result: Float32Array | Array<number>, offset: number): Matrix;
  4259. /**
  4260. * Check equality between this matrix and a second one
  4261. * @param value defines the second matrix to compare
  4262. * @returns true is the current matrix and the given one values are strictly equal
  4263. */
  4264. equals(value: DeepImmutable<Matrix>): boolean;
  4265. /**
  4266. * Clone the current matrix
  4267. * @returns a new matrix from the current matrix
  4268. */
  4269. clone(): Matrix;
  4270. /**
  4271. * Returns the name of the current matrix class
  4272. * @returns the string "Matrix"
  4273. */
  4274. getClassName(): string;
  4275. /**
  4276. * Gets the hash code of the current matrix
  4277. * @returns the hash code
  4278. */
  4279. getHashCode(): number;
  4280. /**
  4281. * Decomposes the current Matrix into a translation, rotation and scaling components
  4282. * @param scale defines the scale vector3 given as a reference to update
  4283. * @param rotation defines the rotation quaternion given as a reference to update
  4284. * @param translation defines the translation vector3 given as a reference to update
  4285. * @returns true if operation was successful
  4286. */
  4287. decompose(scale?: Vector3, rotation?: Quaternion, translation?: Vector3): boolean;
  4288. /**
  4289. * Gets specific row of the matrix
  4290. * @param index defines the number of the row to get
  4291. * @returns the index-th row of the current matrix as a new Vector4
  4292. */
  4293. getRow(index: number): Nullable<Vector4>;
  4294. /**
  4295. * Sets the index-th row of the current matrix to the vector4 values
  4296. * @param index defines the number of the row to set
  4297. * @param row defines the target vector4
  4298. * @returns the updated current matrix
  4299. */
  4300. setRow(index: number, row: Vector4): Matrix;
  4301. /**
  4302. * Compute the transpose of the matrix
  4303. * @returns the new transposed matrix
  4304. */
  4305. transpose(): Matrix;
  4306. /**
  4307. * Compute the transpose of the matrix and store it in a given matrix
  4308. * @param result defines the target matrix
  4309. * @returns the current matrix
  4310. */
  4311. transposeToRef(result: Matrix): Matrix;
  4312. /**
  4313. * Sets the index-th row of the current matrix with the given 4 x float values
  4314. * @param index defines the row index
  4315. * @param x defines the x component to set
  4316. * @param y defines the y component to set
  4317. * @param z defines the z component to set
  4318. * @param w defines the w component to set
  4319. * @returns the updated current matrix
  4320. */
  4321. setRowFromFloats(index: number, x: number, y: number, z: number, w: number): Matrix;
  4322. /**
  4323. * Compute a new matrix set with the current matrix values multiplied by scale (float)
  4324. * @param scale defines the scale factor
  4325. * @returns a new matrix
  4326. */
  4327. scale(scale: number): Matrix;
  4328. /**
  4329. * Scale the current matrix values by a factor to a given result matrix
  4330. * @param scale defines the scale factor
  4331. * @param result defines the matrix to store the result
  4332. * @returns the current matrix
  4333. */
  4334. scaleToRef(scale: number, result: Matrix): Matrix;
  4335. /**
  4336. * Scale the current matrix values by a factor and add the result to a given matrix
  4337. * @param scale defines the scale factor
  4338. * @param result defines the Matrix to store the result
  4339. * @returns the current matrix
  4340. */
  4341. scaleAndAddToRef(scale: number, result: Matrix): Matrix;
  4342. /**
  4343. * Writes to the given matrix a normal matrix, computed from this one (using values from identity matrix for fourth row and column).
  4344. * @param ref matrix to store the result
  4345. */
  4346. toNormalMatrix(ref: Matrix): void;
  4347. /**
  4348. * Gets only rotation part of the current matrix
  4349. * @returns a new matrix sets to the extracted rotation matrix from the current one
  4350. */
  4351. getRotationMatrix(): Matrix;
  4352. /**
  4353. * Extracts the rotation matrix from the current one and sets it as the given "result"
  4354. * @param result defines the target matrix to store data to
  4355. * @returns the current matrix
  4356. */
  4357. getRotationMatrixToRef(result: Matrix): Matrix;
  4358. /**
  4359. * Toggles model matrix from being right handed to left handed in place and vice versa
  4360. */
  4361. toggleModelMatrixHandInPlace(): void;
  4362. /**
  4363. * Toggles projection matrix from being right handed to left handed in place and vice versa
  4364. */
  4365. toggleProjectionMatrixHandInPlace(): void;
  4366. /**
  4367. * Creates a matrix from an array
  4368. * @param array defines the source array
  4369. * @param offset defines an offset in the source array
  4370. * @returns a new Matrix set from the starting index of the given array
  4371. */
  4372. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Matrix;
  4373. /**
  4374. * Copy the content of an array into a given matrix
  4375. * @param array defines the source array
  4376. * @param offset defines an offset in the source array
  4377. * @param result defines the target matrix
  4378. */
  4379. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Matrix): void;
  4380. /**
  4381. * Stores an array into a matrix after having multiplied each component by a given factor
  4382. * @param array defines the source array
  4383. * @param offset defines the offset in the source array
  4384. * @param scale defines the scaling factor
  4385. * @param result defines the target matrix
  4386. */
  4387. static FromFloat32ArrayToRefScaled(array: DeepImmutable<Float32Array | Array<number>>, offset: number, scale: number, result: Matrix): void;
  4388. /**
  4389. * Gets an identity matrix that must not be updated
  4390. */
  4391. static get IdentityReadOnly(): DeepImmutable<Matrix>;
  4392. /**
  4393. * Stores a list of values (16) inside a given matrix
  4394. * @param initialM11 defines 1st value of 1st row
  4395. * @param initialM12 defines 2nd value of 1st row
  4396. * @param initialM13 defines 3rd value of 1st row
  4397. * @param initialM14 defines 4th value of 1st row
  4398. * @param initialM21 defines 1st value of 2nd row
  4399. * @param initialM22 defines 2nd value of 2nd row
  4400. * @param initialM23 defines 3rd value of 2nd row
  4401. * @param initialM24 defines 4th value of 2nd row
  4402. * @param initialM31 defines 1st value of 3rd row
  4403. * @param initialM32 defines 2nd value of 3rd row
  4404. * @param initialM33 defines 3rd value of 3rd row
  4405. * @param initialM34 defines 4th value of 3rd row
  4406. * @param initialM41 defines 1st value of 4th row
  4407. * @param initialM42 defines 2nd value of 4th row
  4408. * @param initialM43 defines 3rd value of 4th row
  4409. * @param initialM44 defines 4th value of 4th row
  4410. * @param result defines the target matrix
  4411. */
  4412. static FromValuesToRef(initialM11: number, initialM12: number, initialM13: number, initialM14: number, initialM21: number, initialM22: number, initialM23: number, initialM24: number, initialM31: number, initialM32: number, initialM33: number, initialM34: number, initialM41: number, initialM42: number, initialM43: number, initialM44: number, result: Matrix): void;
  4413. /**
  4414. * Creates new matrix from a list of values (16)
  4415. * @param initialM11 defines 1st value of 1st row
  4416. * @param initialM12 defines 2nd value of 1st row
  4417. * @param initialM13 defines 3rd value of 1st row
  4418. * @param initialM14 defines 4th value of 1st row
  4419. * @param initialM21 defines 1st value of 2nd row
  4420. * @param initialM22 defines 2nd value of 2nd row
  4421. * @param initialM23 defines 3rd value of 2nd row
  4422. * @param initialM24 defines 4th value of 2nd row
  4423. * @param initialM31 defines 1st value of 3rd row
  4424. * @param initialM32 defines 2nd value of 3rd row
  4425. * @param initialM33 defines 3rd value of 3rd row
  4426. * @param initialM34 defines 4th value of 3rd row
  4427. * @param initialM41 defines 1st value of 4th row
  4428. * @param initialM42 defines 2nd value of 4th row
  4429. * @param initialM43 defines 3rd value of 4th row
  4430. * @param initialM44 defines 4th value of 4th row
  4431. * @returns the new matrix
  4432. */
  4433. static FromValues(initialM11: number, initialM12: number, initialM13: number, initialM14: number, initialM21: number, initialM22: number, initialM23: number, initialM24: number, initialM31: number, initialM32: number, initialM33: number, initialM34: number, initialM41: number, initialM42: number, initialM43: number, initialM44: number): Matrix;
  4434. /**
  4435. * Creates a new matrix composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  4436. * @param scale defines the scale vector3
  4437. * @param rotation defines the rotation quaternion
  4438. * @param translation defines the translation vector3
  4439. * @returns a new matrix
  4440. */
  4441. static Compose(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>): Matrix;
  4442. /**
  4443. * Sets a matrix to a value composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  4444. * @param scale defines the scale vector3
  4445. * @param rotation defines the rotation quaternion
  4446. * @param translation defines the translation vector3
  4447. * @param result defines the target matrix
  4448. */
  4449. static ComposeToRef(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>, result: Matrix): void;
  4450. /**
  4451. * Creates a new identity matrix
  4452. * @returns a new identity matrix
  4453. */
  4454. static Identity(): Matrix;
  4455. /**
  4456. * Creates a new identity matrix and stores the result in a given matrix
  4457. * @param result defines the target matrix
  4458. */
  4459. static IdentityToRef(result: Matrix): void;
  4460. /**
  4461. * Creates a new zero matrix
  4462. * @returns a new zero matrix
  4463. */
  4464. static Zero(): Matrix;
  4465. /**
  4466. * Creates a new rotation matrix for "angle" radians around the X axis
  4467. * @param angle defines the angle (in radians) to use
  4468. * @return the new matrix
  4469. */
  4470. static RotationX(angle: number): Matrix;
  4471. /**
  4472. * Creates a new matrix as the invert of a given matrix
  4473. * @param source defines the source matrix
  4474. * @returns the new matrix
  4475. */
  4476. static Invert(source: DeepImmutable<Matrix>): Matrix;
  4477. /**
  4478. * Creates a new rotation matrix for "angle" radians around the X axis and stores it in a given matrix
  4479. * @param angle defines the angle (in radians) to use
  4480. * @param result defines the target matrix
  4481. */
  4482. static RotationXToRef(angle: number, result: Matrix): void;
  4483. /**
  4484. * Creates a new rotation matrix for "angle" radians around the Y axis
  4485. * @param angle defines the angle (in radians) to use
  4486. * @return the new matrix
  4487. */
  4488. static RotationY(angle: number): Matrix;
  4489. /**
  4490. * Creates a new rotation matrix for "angle" radians around the Y axis and stores it in a given matrix
  4491. * @param angle defines the angle (in radians) to use
  4492. * @param result defines the target matrix
  4493. */
  4494. static RotationYToRef(angle: number, result: Matrix): void;
  4495. /**
  4496. * Creates a new rotation matrix for "angle" radians around the Z axis
  4497. * @param angle defines the angle (in radians) to use
  4498. * @return the new matrix
  4499. */
  4500. static RotationZ(angle: number): Matrix;
  4501. /**
  4502. * Creates a new rotation matrix for "angle" radians around the Z axis and stores it in a given matrix
  4503. * @param angle defines the angle (in radians) to use
  4504. * @param result defines the target matrix
  4505. */
  4506. static RotationZToRef(angle: number, result: Matrix): void;
  4507. /**
  4508. * Creates a new rotation matrix for "angle" radians around the given axis
  4509. * @param axis defines the axis to use
  4510. * @param angle defines the angle (in radians) to use
  4511. * @return the new matrix
  4512. */
  4513. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Matrix;
  4514. /**
  4515. * Creates a new rotation matrix for "angle" radians around the given axis and stores it in a given matrix
  4516. * @param axis defines the axis to use
  4517. * @param angle defines the angle (in radians) to use
  4518. * @param result defines the target matrix
  4519. */
  4520. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Matrix): void;
  4521. /**
  4522. * Takes normalised vectors and returns a rotation matrix to align "from" with "to".
  4523. * Taken from http://www.iquilezles.org/www/articles/noacos/noacos.htm
  4524. * @param from defines the vector to align
  4525. * @param to defines the vector to align to
  4526. * @param result defines the target matrix
  4527. */
  4528. static RotationAlignToRef(from: DeepImmutable<Vector3>, to: DeepImmutable<Vector3>, result: Matrix): void;
  4529. /**
  4530. * Creates a rotation matrix
  4531. * @param yaw defines the yaw angle in radians (Y axis)
  4532. * @param pitch defines the pitch angle in radians (X axis)
  4533. * @param roll defines the roll angle in radians (Z axis)
  4534. * @returns the new rotation matrix
  4535. */
  4536. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Matrix;
  4537. /**
  4538. * Creates a rotation matrix and stores it in a given matrix
  4539. * @param yaw defines the yaw angle in radians (Y axis)
  4540. * @param pitch defines the pitch angle in radians (X axis)
  4541. * @param roll defines the roll angle in radians (Z axis)
  4542. * @param result defines the target matrix
  4543. */
  4544. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Matrix): void;
  4545. /**
  4546. * Creates a scaling matrix
  4547. * @param x defines the scale factor on X axis
  4548. * @param y defines the scale factor on Y axis
  4549. * @param z defines the scale factor on Z axis
  4550. * @returns the new matrix
  4551. */
  4552. static Scaling(x: number, y: number, z: number): Matrix;
  4553. /**
  4554. * Creates a scaling matrix and stores it in a given matrix
  4555. * @param x defines the scale factor on X axis
  4556. * @param y defines the scale factor on Y axis
  4557. * @param z defines the scale factor on Z axis
  4558. * @param result defines the target matrix
  4559. */
  4560. static ScalingToRef(x: number, y: number, z: number, result: Matrix): void;
  4561. /**
  4562. * Creates a translation matrix
  4563. * @param x defines the translation on X axis
  4564. * @param y defines the translation on Y axis
  4565. * @param z defines the translationon Z axis
  4566. * @returns the new matrix
  4567. */
  4568. static Translation(x: number, y: number, z: number): Matrix;
  4569. /**
  4570. * Creates a translation matrix and stores it in a given matrix
  4571. * @param x defines the translation on X axis
  4572. * @param y defines the translation on Y axis
  4573. * @param z defines the translationon Z axis
  4574. * @param result defines the target matrix
  4575. */
  4576. static TranslationToRef(x: number, y: number, z: number, result: Matrix): void;
  4577. /**
  4578. * Returns a new Matrix whose values are the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  4579. * @param startValue defines the start value
  4580. * @param endValue defines the end value
  4581. * @param gradient defines the gradient factor
  4582. * @returns the new matrix
  4583. */
  4584. static Lerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  4585. /**
  4586. * Set the given matrix "result" as the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  4587. * @param startValue defines the start value
  4588. * @param endValue defines the end value
  4589. * @param gradient defines the gradient factor
  4590. * @param result defines the Matrix object where to store data
  4591. */
  4592. static LerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  4593. /**
  4594. * Builds a new matrix whose values are computed by:
  4595. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  4596. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  4597. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  4598. * @param startValue defines the first matrix
  4599. * @param endValue defines the second matrix
  4600. * @param gradient defines the gradient between the two matrices
  4601. * @returns the new matrix
  4602. */
  4603. static DecomposeLerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  4604. /**
  4605. * Update a matrix to values which are computed by:
  4606. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  4607. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  4608. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  4609. * @param startValue defines the first matrix
  4610. * @param endValue defines the second matrix
  4611. * @param gradient defines the gradient between the two matrices
  4612. * @param result defines the target matrix
  4613. */
  4614. static DecomposeLerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  4615. /**
  4616. * Gets a new rotation matrix used to rotate an entity so as it looks at the target vector3, from the eye vector3 position, the up vector3 being oriented like "up"
  4617. * This function works in left handed mode
  4618. * @param eye defines the final position of the entity
  4619. * @param target defines where the entity should look at
  4620. * @param up defines the up vector for the entity
  4621. * @returns the new matrix
  4622. */
  4623. static LookAtLH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  4624. /**
  4625. * Sets the given "result" Matrix to a rotation matrix used to rotate an entity so that it looks at the target vector3, from the eye vector3 position, the up vector3 being oriented like "up".
  4626. * This function works in left handed mode
  4627. * @param eye defines the final position of the entity
  4628. * @param target defines where the entity should look at
  4629. * @param up defines the up vector for the entity
  4630. * @param result defines the target matrix
  4631. */
  4632. static LookAtLHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  4633. /**
  4634. * Gets a new rotation matrix used to rotate an entity so as it looks at the target vector3, from the eye vector3 position, the up vector3 being oriented like "up"
  4635. * This function works in right handed mode
  4636. * @param eye defines the final position of the entity
  4637. * @param target defines where the entity should look at
  4638. * @param up defines the up vector for the entity
  4639. * @returns the new matrix
  4640. */
  4641. static LookAtRH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  4642. /**
  4643. * Sets the given "result" Matrix to a rotation matrix used to rotate an entity so that it looks at the target vector3, from the eye vector3 position, the up vector3 being oriented like "up".
  4644. * This function works in right handed mode
  4645. * @param eye defines the final position of the entity
  4646. * @param target defines where the entity should look at
  4647. * @param up defines the up vector for the entity
  4648. * @param result defines the target matrix
  4649. */
  4650. static LookAtRHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  4651. /**
  4652. * Create a left-handed orthographic projection matrix
  4653. * @param width defines the viewport width
  4654. * @param height defines the viewport height
  4655. * @param znear defines the near clip plane
  4656. * @param zfar defines the far clip plane
  4657. * @returns a new matrix as a left-handed orthographic projection matrix
  4658. */
  4659. static OrthoLH(width: number, height: number, znear: number, zfar: number): Matrix;
  4660. /**
  4661. * Store a left-handed orthographic projection to a given matrix
  4662. * @param width defines the viewport width
  4663. * @param height defines the viewport height
  4664. * @param znear defines the near clip plane
  4665. * @param zfar defines the far clip plane
  4666. * @param result defines the target matrix
  4667. */
  4668. static OrthoLHToRef(width: number, height: number, znear: number, zfar: number, result: Matrix): void;
  4669. /**
  4670. * Create a left-handed orthographic projection matrix
  4671. * @param left defines the viewport left coordinate
  4672. * @param right defines the viewport right coordinate
  4673. * @param bottom defines the viewport bottom coordinate
  4674. * @param top defines the viewport top coordinate
  4675. * @param znear defines the near clip plane
  4676. * @param zfar defines the far clip plane
  4677. * @returns a new matrix as a left-handed orthographic projection matrix
  4678. */
  4679. static OrthoOffCenterLH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  4680. /**
  4681. * Stores a left-handed orthographic projection into a given matrix
  4682. * @param left defines the viewport left coordinate
  4683. * @param right defines the viewport right coordinate
  4684. * @param bottom defines the viewport bottom coordinate
  4685. * @param top defines the viewport top coordinate
  4686. * @param znear defines the near clip plane
  4687. * @param zfar defines the far clip plane
  4688. * @param result defines the target matrix
  4689. */
  4690. static OrthoOffCenterLHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  4691. /**
  4692. * Creates a right-handed orthographic projection matrix
  4693. * @param left defines the viewport left coordinate
  4694. * @param right defines the viewport right coordinate
  4695. * @param bottom defines the viewport bottom coordinate
  4696. * @param top defines the viewport top coordinate
  4697. * @param znear defines the near clip plane
  4698. * @param zfar defines the far clip plane
  4699. * @returns a new matrix as a right-handed orthographic projection matrix
  4700. */
  4701. static OrthoOffCenterRH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  4702. /**
  4703. * Stores a right-handed orthographic projection into a given matrix
  4704. * @param left defines the viewport left coordinate
  4705. * @param right defines the viewport right coordinate
  4706. * @param bottom defines the viewport bottom coordinate
  4707. * @param top defines the viewport top coordinate
  4708. * @param znear defines the near clip plane
  4709. * @param zfar defines the far clip plane
  4710. * @param result defines the target matrix
  4711. */
  4712. static OrthoOffCenterRHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  4713. /**
  4714. * Creates a left-handed perspective projection matrix
  4715. * @param width defines the viewport width
  4716. * @param height defines the viewport height
  4717. * @param znear defines the near clip plane
  4718. * @param zfar defines the far clip plane
  4719. * @returns a new matrix as a left-handed perspective projection matrix
  4720. */
  4721. static PerspectiveLH(width: number, height: number, znear: number, zfar: number): Matrix;
  4722. /**
  4723. * Creates a left-handed perspective projection matrix
  4724. * @param fov defines the horizontal field of view
  4725. * @param aspect defines the aspect ratio
  4726. * @param znear defines the near clip plane
  4727. * @param zfar defines the far clip plane
  4728. * @returns a new matrix as a left-handed perspective projection matrix
  4729. */
  4730. static PerspectiveFovLH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  4731. /**
  4732. * Stores a left-handed perspective projection into a given matrix
  4733. * @param fov defines the horizontal field of view
  4734. * @param aspect defines the aspect ratio
  4735. * @param znear defines the near clip plane
  4736. * @param zfar defines the far clip plane
  4737. * @param result defines the target matrix
  4738. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4739. */
  4740. static PerspectiveFovLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4741. /**
  4742. * Stores a left-handed perspective projection into a given matrix with depth reversed
  4743. * @param fov defines the horizontal field of view
  4744. * @param aspect defines the aspect ratio
  4745. * @param znear defines the near clip plane
  4746. * @param zfar not used as infinity is used as far clip
  4747. * @param result defines the target matrix
  4748. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4749. */
  4750. static PerspectiveFovReverseLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4751. /**
  4752. * Creates a right-handed perspective projection matrix
  4753. * @param fov defines the horizontal field of view
  4754. * @param aspect defines the aspect ratio
  4755. * @param znear defines the near clip plane
  4756. * @param zfar defines the far clip plane
  4757. * @returns a new matrix as a right-handed perspective projection matrix
  4758. */
  4759. static PerspectiveFovRH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  4760. /**
  4761. * Stores a right-handed perspective projection into a given matrix
  4762. * @param fov defines the horizontal field of view
  4763. * @param aspect defines the aspect ratio
  4764. * @param znear defines the near clip plane
  4765. * @param zfar defines the far clip plane
  4766. * @param result defines the target matrix
  4767. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4768. */
  4769. static PerspectiveFovRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4770. /**
  4771. * Stores a right-handed perspective projection into a given matrix
  4772. * @param fov defines the horizontal field of view
  4773. * @param aspect defines the aspect ratio
  4774. * @param znear defines the near clip plane
  4775. * @param zfar not used as infinity is used as far clip
  4776. * @param result defines the target matrix
  4777. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4778. */
  4779. static PerspectiveFovReverseRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4780. /**
  4781. * Stores a perspective projection for WebVR info a given matrix
  4782. * @param fov defines the field of view
  4783. * @param znear defines the near clip plane
  4784. * @param zfar defines the far clip plane
  4785. * @param result defines the target matrix
  4786. * @param rightHanded defines if the matrix must be in right-handed mode (false by default)
  4787. */
  4788. static PerspectiveFovWebVRToRef(fov: {
  4789. upDegrees: number;
  4790. downDegrees: number;
  4791. leftDegrees: number;
  4792. rightDegrees: number;
  4793. }, znear: number, zfar: number, result: Matrix, rightHanded?: boolean): void;
  4794. /**
  4795. * Computes a complete transformation matrix
  4796. * @param viewport defines the viewport to use
  4797. * @param world defines the world matrix
  4798. * @param view defines the view matrix
  4799. * @param projection defines the projection matrix
  4800. * @param zmin defines the near clip plane
  4801. * @param zmax defines the far clip plane
  4802. * @returns the transformation matrix
  4803. */
  4804. static GetFinalMatrix(viewport: DeepImmutable<Viewport>, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, zmin: number, zmax: number): Matrix;
  4805. /**
  4806. * Extracts a 2x2 matrix from a given matrix and store the result in a Float32Array
  4807. * @param matrix defines the matrix to use
  4808. * @returns a new Float32Array array with 4 elements : the 2x2 matrix extracted from the given matrix
  4809. */
  4810. static GetAsMatrix2x2(matrix: DeepImmutable<Matrix>): Float32Array | Array<number>;
  4811. /**
  4812. * Extracts a 3x3 matrix from a given matrix and store the result in a Float32Array
  4813. * @param matrix defines the matrix to use
  4814. * @returns a new Float32Array array with 9 elements : the 3x3 matrix extracted from the given matrix
  4815. */
  4816. static GetAsMatrix3x3(matrix: DeepImmutable<Matrix>): Float32Array | Array<number>;
  4817. /**
  4818. * Compute the transpose of a given matrix
  4819. * @param matrix defines the matrix to transpose
  4820. * @returns the new matrix
  4821. */
  4822. static Transpose(matrix: DeepImmutable<Matrix>): Matrix;
  4823. /**
  4824. * Compute the transpose of a matrix and store it in a target matrix
  4825. * @param matrix defines the matrix to transpose
  4826. * @param result defines the target matrix
  4827. */
  4828. static TransposeToRef(matrix: DeepImmutable<Matrix>, result: Matrix): void;
  4829. /**
  4830. * Computes a reflection matrix from a plane
  4831. * @param plane defines the reflection plane
  4832. * @returns a new matrix
  4833. */
  4834. static Reflection(plane: DeepImmutable<IPlaneLike>): Matrix;
  4835. /**
  4836. * Computes a reflection matrix from a plane
  4837. * @param plane defines the reflection plane
  4838. * @param result defines the target matrix
  4839. */
  4840. static ReflectionToRef(plane: DeepImmutable<IPlaneLike>, result: Matrix): void;
  4841. /**
  4842. * Sets the given matrix as a rotation matrix composed from the 3 left handed axes
  4843. * @param xaxis defines the value of the 1st axis
  4844. * @param yaxis defines the value of the 2nd axis
  4845. * @param zaxis defines the value of the 3rd axis
  4846. * @param result defines the target matrix
  4847. */
  4848. static FromXYZAxesToRef(xaxis: DeepImmutable<Vector3>, yaxis: DeepImmutable<Vector3>, zaxis: DeepImmutable<Vector3>, result: Matrix): void;
  4849. /**
  4850. * Creates a rotation matrix from a quaternion and stores it in a target matrix
  4851. * @param quat defines the quaternion to use
  4852. * @param result defines the target matrix
  4853. */
  4854. static FromQuaternionToRef(quat: DeepImmutable<Quaternion>, result: Matrix): void;
  4855. }
  4856. /**
  4857. * @hidden
  4858. */
  4859. export class TmpVectors {
  4860. static Vector2: Vector2[];
  4861. static Vector3: Vector3[];
  4862. static Vector4: Vector4[];
  4863. static Quaternion: Quaternion[];
  4864. static Matrix: Matrix[];
  4865. }
  4866. }
  4867. declare module "babylonjs/Maths/math.path" {
  4868. import { DeepImmutable, Nullable } from "babylonjs/types";
  4869. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  4870. /**
  4871. * Defines potential orientation for back face culling
  4872. */
  4873. export enum Orientation {
  4874. /**
  4875. * Clockwise
  4876. */
  4877. CW = 0,
  4878. /** Counter clockwise */
  4879. CCW = 1
  4880. }
  4881. /** Class used to represent a Bezier curve */
  4882. export class BezierCurve {
  4883. /**
  4884. * Returns the cubic Bezier interpolated value (float) at "t" (float) from the given x1, y1, x2, y2 floats
  4885. * @param t defines the time
  4886. * @param x1 defines the left coordinate on X axis
  4887. * @param y1 defines the left coordinate on Y axis
  4888. * @param x2 defines the right coordinate on X axis
  4889. * @param y2 defines the right coordinate on Y axis
  4890. * @returns the interpolated value
  4891. */
  4892. static Interpolate(t: number, x1: number, y1: number, x2: number, y2: number): number;
  4893. }
  4894. /**
  4895. * Defines angle representation
  4896. */
  4897. export class Angle {
  4898. private _radians;
  4899. /**
  4900. * Creates an Angle object of "radians" radians (float).
  4901. * @param radians the angle in radians
  4902. */
  4903. constructor(radians: number);
  4904. /**
  4905. * Get value in degrees
  4906. * @returns the Angle value in degrees (float)
  4907. */
  4908. degrees(): number;
  4909. /**
  4910. * Get value in radians
  4911. * @returns the Angle value in radians (float)
  4912. */
  4913. radians(): number;
  4914. /**
  4915. * Gets a new Angle object valued with the gradient angle, in radians, of the line joining two points
  4916. * @param a defines first point as the origin
  4917. * @param b defines point
  4918. * @returns a new Angle
  4919. */
  4920. static BetweenTwoPoints(a: DeepImmutable<Vector2>, b: DeepImmutable<Vector2>): Angle;
  4921. /**
  4922. * Gets a new Angle object from the given float in radians
  4923. * @param radians defines the angle value in radians
  4924. * @returns a new Angle
  4925. */
  4926. static FromRadians(radians: number): Angle;
  4927. /**
  4928. * Gets a new Angle object from the given float in degrees
  4929. * @param degrees defines the angle value in degrees
  4930. * @returns a new Angle
  4931. */
  4932. static FromDegrees(degrees: number): Angle;
  4933. }
  4934. /**
  4935. * This represents an arc in a 2d space.
  4936. */
  4937. export class Arc2 {
  4938. /** Defines the start point of the arc */
  4939. startPoint: Vector2;
  4940. /** Defines the mid point of the arc */
  4941. midPoint: Vector2;
  4942. /** Defines the end point of the arc */
  4943. endPoint: Vector2;
  4944. /**
  4945. * Defines the center point of the arc.
  4946. */
  4947. centerPoint: Vector2;
  4948. /**
  4949. * Defines the radius of the arc.
  4950. */
  4951. radius: number;
  4952. /**
  4953. * Defines the angle of the arc (from mid point to end point).
  4954. */
  4955. angle: Angle;
  4956. /**
  4957. * Defines the start angle of the arc (from start point to middle point).
  4958. */
  4959. startAngle: Angle;
  4960. /**
  4961. * Defines the orientation of the arc (clock wise/counter clock wise).
  4962. */
  4963. orientation: Orientation;
  4964. /**
  4965. * Creates an Arc object from the three given points : start, middle and end.
  4966. * @param startPoint Defines the start point of the arc
  4967. * @param midPoint Defines the midlle point of the arc
  4968. * @param endPoint Defines the end point of the arc
  4969. */
  4970. constructor(
  4971. /** Defines the start point of the arc */
  4972. startPoint: Vector2,
  4973. /** Defines the mid point of the arc */
  4974. midPoint: Vector2,
  4975. /** Defines the end point of the arc */
  4976. endPoint: Vector2);
  4977. }
  4978. /**
  4979. * Represents a 2D path made up of multiple 2D points
  4980. */
  4981. export class Path2 {
  4982. private _points;
  4983. private _length;
  4984. /**
  4985. * If the path start and end point are the same
  4986. */
  4987. closed: boolean;
  4988. /**
  4989. * Creates a Path2 object from the starting 2D coordinates x and y.
  4990. * @param x the starting points x value
  4991. * @param y the starting points y value
  4992. */
  4993. constructor(x: number, y: number);
  4994. /**
  4995. * Adds a new segment until the given coordinates (x, y) to the current Path2.
  4996. * @param x the added points x value
  4997. * @param y the added points y value
  4998. * @returns the updated Path2.
  4999. */
  5000. addLineTo(x: number, y: number): Path2;
  5001. /**
  5002. * Adds _numberOfSegments_ segments according to the arc definition (middle point coordinates, end point coordinates, the arc start point being the current Path2 last point) to the current Path2.
  5003. * @param midX middle point x value
  5004. * @param midY middle point y value
  5005. * @param endX end point x value
  5006. * @param endY end point y value
  5007. * @param numberOfSegments (default: 36)
  5008. * @returns the updated Path2.
  5009. */
  5010. addArcTo(midX: number, midY: number, endX: number, endY: number, numberOfSegments?: number): Path2;
  5011. /**
  5012. * Closes the Path2.
  5013. * @returns the Path2.
  5014. */
  5015. close(): Path2;
  5016. /**
  5017. * Gets the sum of the distance between each sequential point in the path
  5018. * @returns the Path2 total length (float).
  5019. */
  5020. length(): number;
  5021. /**
  5022. * Gets the points which construct the path
  5023. * @returns the Path2 internal array of points.
  5024. */
  5025. getPoints(): Vector2[];
  5026. /**
  5027. * Retreives the point at the distance aways from the starting point
  5028. * @param normalizedLengthPosition the length along the path to retreive the point from
  5029. * @returns a new Vector2 located at a percentage of the Path2 total length on this path.
  5030. */
  5031. getPointAtLengthPosition(normalizedLengthPosition: number): Vector2;
  5032. /**
  5033. * Creates a new path starting from an x and y position
  5034. * @param x starting x value
  5035. * @param y starting y value
  5036. * @returns a new Path2 starting at the coordinates (x, y).
  5037. */
  5038. static StartingAt(x: number, y: number): Path2;
  5039. }
  5040. /**
  5041. * Represents a 3D path made up of multiple 3D points
  5042. */
  5043. export class Path3D {
  5044. /**
  5045. * an array of Vector3, the curve axis of the Path3D
  5046. */
  5047. path: Vector3[];
  5048. private _curve;
  5049. private _distances;
  5050. private _tangents;
  5051. private _normals;
  5052. private _binormals;
  5053. private _raw;
  5054. private _alignTangentsWithPath;
  5055. private readonly _pointAtData;
  5056. /**
  5057. * new Path3D(path, normal, raw)
  5058. * Creates a Path3D. A Path3D is a logical math object, so not a mesh.
  5059. * please read the description in the tutorial : https://doc.babylonjs.com/how_to/how_to_use_path3d
  5060. * @param path an array of Vector3, the curve axis of the Path3D
  5061. * @param firstNormal (options) Vector3, the first wanted normal to the curve. Ex (0, 1, 0) for a vertical normal.
  5062. * @param raw (optional, default false) : boolean, if true the returned Path3D isn't normalized. Useful to depict path acceleration or speed.
  5063. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path.
  5064. */
  5065. constructor(
  5066. /**
  5067. * an array of Vector3, the curve axis of the Path3D
  5068. */
  5069. path: Vector3[], firstNormal?: Nullable<Vector3>, raw?: boolean, alignTangentsWithPath?: boolean);
  5070. /**
  5071. * Returns the Path3D array of successive Vector3 designing its curve.
  5072. * @returns the Path3D array of successive Vector3 designing its curve.
  5073. */
  5074. getCurve(): Vector3[];
  5075. /**
  5076. * Returns the Path3D array of successive Vector3 designing its curve.
  5077. * @returns the Path3D array of successive Vector3 designing its curve.
  5078. */
  5079. getPoints(): Vector3[];
  5080. /**
  5081. * @returns the computed length (float) of the path.
  5082. */
  5083. length(): number;
  5084. /**
  5085. * Returns an array populated with tangent vectors on each Path3D curve point.
  5086. * @returns an array populated with tangent vectors on each Path3D curve point.
  5087. */
  5088. getTangents(): Vector3[];
  5089. /**
  5090. * Returns an array populated with normal vectors on each Path3D curve point.
  5091. * @returns an array populated with normal vectors on each Path3D curve point.
  5092. */
  5093. getNormals(): Vector3[];
  5094. /**
  5095. * Returns an array populated with binormal vectors on each Path3D curve point.
  5096. * @returns an array populated with binormal vectors on each Path3D curve point.
  5097. */
  5098. getBinormals(): Vector3[];
  5099. /**
  5100. * Returns an array populated with distances (float) of the i-th point from the first curve point.
  5101. * @returns an array populated with distances (float) of the i-th point from the first curve point.
  5102. */
  5103. getDistances(): number[];
  5104. /**
  5105. * Returns an interpolated point along this path
  5106. * @param position the position of the point along this path, from 0.0 to 1.0
  5107. * @returns a new Vector3 as the point
  5108. */
  5109. getPointAt(position: number): Vector3;
  5110. /**
  5111. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  5112. * @param position the position of the point along this path, from 0.0 to 1.0
  5113. * @param interpolated (optional, default false) : boolean, if true returns an interpolated tangent instead of the tangent of the previous path point.
  5114. * @returns a tangent vector corresponding to the interpolated Path3D curve point, if not interpolated, the tangent is taken from the precomputed tangents array.
  5115. */
  5116. getTangentAt(position: number, interpolated?: boolean): Vector3;
  5117. /**
  5118. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  5119. * @param position the position of the point along this path, from 0.0 to 1.0
  5120. * @param interpolated (optional, default false) : boolean, if true returns an interpolated normal instead of the normal of the previous path point.
  5121. * @returns a normal vector corresponding to the interpolated Path3D curve point, if not interpolated, the normal is taken from the precomputed normals array.
  5122. */
  5123. getNormalAt(position: number, interpolated?: boolean): Vector3;
  5124. /**
  5125. * Returns the binormal vector of an interpolated Path3D curve point at the specified position along this path.
  5126. * @param position the position of the point along this path, from 0.0 to 1.0
  5127. * @param interpolated (optional, default false) : boolean, if true returns an interpolated binormal instead of the binormal of the previous path point.
  5128. * @returns a binormal vector corresponding to the interpolated Path3D curve point, if not interpolated, the binormal is taken from the precomputed binormals array.
  5129. */
  5130. getBinormalAt(position: number, interpolated?: boolean): Vector3;
  5131. /**
  5132. * Returns the distance (float) of an interpolated Path3D curve point at the specified position along this path.
  5133. * @param position the position of the point along this path, from 0.0 to 1.0
  5134. * @returns the distance of the interpolated Path3D curve point at the specified position along this path.
  5135. */
  5136. getDistanceAt(position: number): number;
  5137. /**
  5138. * Returns the array index of the previous point of an interpolated point along this path
  5139. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  5140. * @returns the array index
  5141. */
  5142. getPreviousPointIndexAt(position: number): number;
  5143. /**
  5144. * Returns the position of an interpolated point relative to the two path points it lies between, from 0.0 (point A) to 1.0 (point B)
  5145. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  5146. * @returns the sub position
  5147. */
  5148. getSubPositionAt(position: number): number;
  5149. /**
  5150. * Returns the position of the closest virtual point on this path to an arbitrary Vector3, from 0.0 to 1.0
  5151. * @param target the vector of which to get the closest position to
  5152. * @returns the position of the closest virtual point on this path to the target vector
  5153. */
  5154. getClosestPositionTo(target: Vector3): number;
  5155. /**
  5156. * Returns a sub path (slice) of this path
  5157. * @param start the position of the fist path point, from 0.0 to 1.0, or a negative value, which will get wrapped around from the end of the path to 0.0 to 1.0 values
  5158. * @param end the position of the last path point, from 0.0 to 1.0, or a negative value, which will get wrapped around from the end of the path to 0.0 to 1.0 values
  5159. * @returns a sub path (slice) of this path
  5160. */
  5161. slice(start?: number, end?: number): Path3D;
  5162. /**
  5163. * Forces the Path3D tangent, normal, binormal and distance recomputation.
  5164. * @param path path which all values are copied into the curves points
  5165. * @param firstNormal which should be projected onto the curve
  5166. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path
  5167. * @returns the same object updated.
  5168. */
  5169. update(path: Vector3[], firstNormal?: Nullable<Vector3>, alignTangentsWithPath?: boolean): Path3D;
  5170. private _compute;
  5171. private _getFirstNonNullVector;
  5172. private _getLastNonNullVector;
  5173. private _normalVector;
  5174. /**
  5175. * Updates the point at data for an interpolated point along this curve
  5176. * @param position the position of the point along this curve, from 0.0 to 1.0
  5177. * @interpolateTNB wether to compute the interpolated tangent, normal and binormal
  5178. * @returns the (updated) point at data
  5179. */
  5180. private _updatePointAtData;
  5181. /**
  5182. * Updates the point at data from the specified parameters
  5183. * @param position where along the path the interpolated point is, from 0.0 to 1.0
  5184. * @param point the interpolated point
  5185. * @param parentIndex the index of an existing curve point that is on, or else positionally the first behind, the interpolated point
  5186. */
  5187. private _setPointAtData;
  5188. /**
  5189. * Updates the point at interpolation matrix for the tangents, normals and binormals
  5190. */
  5191. private _updateInterpolationMatrix;
  5192. }
  5193. /**
  5194. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  5195. * A Curve3 is designed from a series of successive Vector3.
  5196. * @see https://doc.babylonjs.com/how_to/how_to_use_curve3
  5197. */
  5198. export class Curve3 {
  5199. private _points;
  5200. private _length;
  5201. /**
  5202. * Returns a Curve3 object along a Quadratic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#quadratic-bezier-curve
  5203. * @param v0 (Vector3) the origin point of the Quadratic Bezier
  5204. * @param v1 (Vector3) the control point
  5205. * @param v2 (Vector3) the end point of the Quadratic Bezier
  5206. * @param nbPoints (integer) the wanted number of points in the curve
  5207. * @returns the created Curve3
  5208. */
  5209. static CreateQuadraticBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  5210. /**
  5211. * Returns a Curve3 object along a Cubic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#cubic-bezier-curve
  5212. * @param v0 (Vector3) the origin point of the Cubic Bezier
  5213. * @param v1 (Vector3) the first control point
  5214. * @param v2 (Vector3) the second control point
  5215. * @param v3 (Vector3) the end point of the Cubic Bezier
  5216. * @param nbPoints (integer) the wanted number of points in the curve
  5217. * @returns the created Curve3
  5218. */
  5219. static CreateCubicBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, v3: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  5220. /**
  5221. * Returns a Curve3 object along a Hermite Spline curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#hermite-spline
  5222. * @param p1 (Vector3) the origin point of the Hermite Spline
  5223. * @param t1 (Vector3) the tangent vector at the origin point
  5224. * @param p2 (Vector3) the end point of the Hermite Spline
  5225. * @param t2 (Vector3) the tangent vector at the end point
  5226. * @param nbPoints (integer) the wanted number of points in the curve
  5227. * @returns the created Curve3
  5228. */
  5229. static CreateHermiteSpline(p1: DeepImmutable<Vector3>, t1: DeepImmutable<Vector3>, p2: DeepImmutable<Vector3>, t2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  5230. /**
  5231. * Returns a Curve3 object along a CatmullRom Spline curve :
  5232. * @param points (array of Vector3) the points the spline must pass through. At least, four points required
  5233. * @param nbPoints (integer) the wanted number of points between each curve control points
  5234. * @param closed (boolean) optional with default false, when true forms a closed loop from the points
  5235. * @returns the created Curve3
  5236. */
  5237. static CreateCatmullRomSpline(points: DeepImmutable<Vector3[]>, nbPoints: number, closed?: boolean): Curve3;
  5238. /**
  5239. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  5240. * A Curve3 is designed from a series of successive Vector3.
  5241. * Tuto : https://doc.babylonjs.com/how_to/how_to_use_curve3#curve3-object
  5242. * @param points points which make up the curve
  5243. */
  5244. constructor(points: Vector3[]);
  5245. /**
  5246. * @returns the Curve3 stored array of successive Vector3
  5247. */
  5248. getPoints(): Vector3[];
  5249. /**
  5250. * @returns the computed length (float) of the curve.
  5251. */
  5252. length(): number;
  5253. /**
  5254. * Returns a new instance of Curve3 object : var curve = curveA.continue(curveB);
  5255. * This new Curve3 is built by translating and sticking the curveB at the end of the curveA.
  5256. * curveA and curveB keep unchanged.
  5257. * @param curve the curve to continue from this curve
  5258. * @returns the newly constructed curve
  5259. */
  5260. continue(curve: DeepImmutable<Curve3>): Curve3;
  5261. private _computeLength;
  5262. }
  5263. }
  5264. declare module "babylonjs/Animations/easing" {
  5265. /**
  5266. * This represents the main contract an easing function should follow.
  5267. * Easing functions are used throughout the animation system.
  5268. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5269. */
  5270. export interface IEasingFunction {
  5271. /**
  5272. * Given an input gradient between 0 and 1, this returns the corrseponding value
  5273. * of the easing function.
  5274. * The link below provides some of the most common examples of easing functions.
  5275. * @see https://easings.net/
  5276. * @param gradient Defines the value between 0 and 1 we want the easing value for
  5277. * @returns the corresponding value on the curve defined by the easing function
  5278. */
  5279. ease(gradient: number): number;
  5280. }
  5281. /**
  5282. * Base class used for every default easing function.
  5283. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5284. */
  5285. export class EasingFunction implements IEasingFunction {
  5286. /**
  5287. * Interpolation follows the mathematical formula associated with the easing function.
  5288. */
  5289. static readonly EASINGMODE_EASEIN: number;
  5290. /**
  5291. * Interpolation follows 100% interpolation minus the output of the formula associated with the easing function.
  5292. */
  5293. static readonly EASINGMODE_EASEOUT: number;
  5294. /**
  5295. * Interpolation uses EaseIn for the first half of the animation and EaseOut for the second half.
  5296. */
  5297. static readonly EASINGMODE_EASEINOUT: number;
  5298. private _easingMode;
  5299. /**
  5300. * Sets the easing mode of the current function.
  5301. * @param easingMode Defines the willing mode (EASINGMODE_EASEIN, EASINGMODE_EASEOUT or EASINGMODE_EASEINOUT)
  5302. */
  5303. setEasingMode(easingMode: number): void;
  5304. /**
  5305. * Gets the current easing mode.
  5306. * @returns the easing mode
  5307. */
  5308. getEasingMode(): number;
  5309. /**
  5310. * @hidden
  5311. */
  5312. easeInCore(gradient: number): number;
  5313. /**
  5314. * Given an input gradient between 0 and 1, this returns the corresponding value
  5315. * of the easing function.
  5316. * @param gradient Defines the value between 0 and 1 we want the easing value for
  5317. * @returns the corresponding value on the curve defined by the easing function
  5318. */
  5319. ease(gradient: number): number;
  5320. }
  5321. /**
  5322. * Easing function with a circle shape (see link below).
  5323. * @see https://easings.net/#easeInCirc
  5324. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5325. */
  5326. export class CircleEase extends EasingFunction implements IEasingFunction {
  5327. /** @hidden */
  5328. easeInCore(gradient: number): number;
  5329. }
  5330. /**
  5331. * Easing function with a ease back shape (see link below).
  5332. * @see https://easings.net/#easeInBack
  5333. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5334. */
  5335. export class BackEase extends EasingFunction implements IEasingFunction {
  5336. /** Defines the amplitude of the function */
  5337. amplitude: number;
  5338. /**
  5339. * Instantiates a back ease easing
  5340. * @see https://easings.net/#easeInBack
  5341. * @param amplitude Defines the amplitude of the function
  5342. */
  5343. constructor(
  5344. /** Defines the amplitude of the function */
  5345. amplitude?: number);
  5346. /** @hidden */
  5347. easeInCore(gradient: number): number;
  5348. }
  5349. /**
  5350. * Easing function with a bouncing shape (see link below).
  5351. * @see https://easings.net/#easeInBounce
  5352. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5353. */
  5354. export class BounceEase extends EasingFunction implements IEasingFunction {
  5355. /** Defines the number of bounces */
  5356. bounces: number;
  5357. /** Defines the amplitude of the bounce */
  5358. bounciness: number;
  5359. /**
  5360. * Instantiates a bounce easing
  5361. * @see https://easings.net/#easeInBounce
  5362. * @param bounces Defines the number of bounces
  5363. * @param bounciness Defines the amplitude of the bounce
  5364. */
  5365. constructor(
  5366. /** Defines the number of bounces */
  5367. bounces?: number,
  5368. /** Defines the amplitude of the bounce */
  5369. bounciness?: number);
  5370. /** @hidden */
  5371. easeInCore(gradient: number): number;
  5372. }
  5373. /**
  5374. * Easing function with a power of 3 shape (see link below).
  5375. * @see https://easings.net/#easeInCubic
  5376. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5377. */
  5378. export class CubicEase extends EasingFunction implements IEasingFunction {
  5379. /** @hidden */
  5380. easeInCore(gradient: number): number;
  5381. }
  5382. /**
  5383. * Easing function with an elastic shape (see link below).
  5384. * @see https://easings.net/#easeInElastic
  5385. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5386. */
  5387. export class ElasticEase extends EasingFunction implements IEasingFunction {
  5388. /** Defines the number of oscillations*/
  5389. oscillations: number;
  5390. /** Defines the amplitude of the oscillations*/
  5391. springiness: number;
  5392. /**
  5393. * Instantiates an elastic easing function
  5394. * @see https://easings.net/#easeInElastic
  5395. * @param oscillations Defines the number of oscillations
  5396. * @param springiness Defines the amplitude of the oscillations
  5397. */
  5398. constructor(
  5399. /** Defines the number of oscillations*/
  5400. oscillations?: number,
  5401. /** Defines the amplitude of the oscillations*/
  5402. springiness?: number);
  5403. /** @hidden */
  5404. easeInCore(gradient: number): number;
  5405. }
  5406. /**
  5407. * Easing function with an exponential shape (see link below).
  5408. * @see https://easings.net/#easeInExpo
  5409. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5410. */
  5411. export class ExponentialEase extends EasingFunction implements IEasingFunction {
  5412. /** Defines the exponent of the function */
  5413. exponent: number;
  5414. /**
  5415. * Instantiates an exponential easing function
  5416. * @see https://easings.net/#easeInExpo
  5417. * @param exponent Defines the exponent of the function
  5418. */
  5419. constructor(
  5420. /** Defines the exponent of the function */
  5421. exponent?: number);
  5422. /** @hidden */
  5423. easeInCore(gradient: number): number;
  5424. }
  5425. /**
  5426. * Easing function with a power shape (see link below).
  5427. * @see https://easings.net/#easeInQuad
  5428. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5429. */
  5430. export class PowerEase extends EasingFunction implements IEasingFunction {
  5431. /** Defines the power of the function */
  5432. power: number;
  5433. /**
  5434. * Instantiates an power base easing function
  5435. * @see https://easings.net/#easeInQuad
  5436. * @param power Defines the power of the function
  5437. */
  5438. constructor(
  5439. /** Defines the power of the function */
  5440. power?: number);
  5441. /** @hidden */
  5442. easeInCore(gradient: number): number;
  5443. }
  5444. /**
  5445. * Easing function with a power of 2 shape (see link below).
  5446. * @see https://easings.net/#easeInQuad
  5447. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5448. */
  5449. export class QuadraticEase extends EasingFunction implements IEasingFunction {
  5450. /** @hidden */
  5451. easeInCore(gradient: number): number;
  5452. }
  5453. /**
  5454. * Easing function with a power of 4 shape (see link below).
  5455. * @see https://easings.net/#easeInQuart
  5456. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5457. */
  5458. export class QuarticEase extends EasingFunction implements IEasingFunction {
  5459. /** @hidden */
  5460. easeInCore(gradient: number): number;
  5461. }
  5462. /**
  5463. * Easing function with a power of 5 shape (see link below).
  5464. * @see https://easings.net/#easeInQuint
  5465. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5466. */
  5467. export class QuinticEase extends EasingFunction implements IEasingFunction {
  5468. /** @hidden */
  5469. easeInCore(gradient: number): number;
  5470. }
  5471. /**
  5472. * Easing function with a sin shape (see link below).
  5473. * @see https://easings.net/#easeInSine
  5474. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5475. */
  5476. export class SineEase extends EasingFunction implements IEasingFunction {
  5477. /** @hidden */
  5478. easeInCore(gradient: number): number;
  5479. }
  5480. /**
  5481. * Easing function with a bezier shape (see link below).
  5482. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  5483. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5484. */
  5485. export class BezierCurveEase extends EasingFunction implements IEasingFunction {
  5486. /** Defines the x component of the start tangent in the bezier curve */
  5487. x1: number;
  5488. /** Defines the y component of the start tangent in the bezier curve */
  5489. y1: number;
  5490. /** Defines the x component of the end tangent in the bezier curve */
  5491. x2: number;
  5492. /** Defines the y component of the end tangent in the bezier curve */
  5493. y2: number;
  5494. /**
  5495. * Instantiates a bezier function
  5496. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  5497. * @param x1 Defines the x component of the start tangent in the bezier curve
  5498. * @param y1 Defines the y component of the start tangent in the bezier curve
  5499. * @param x2 Defines the x component of the end tangent in the bezier curve
  5500. * @param y2 Defines the y component of the end tangent in the bezier curve
  5501. */
  5502. constructor(
  5503. /** Defines the x component of the start tangent in the bezier curve */
  5504. x1?: number,
  5505. /** Defines the y component of the start tangent in the bezier curve */
  5506. y1?: number,
  5507. /** Defines the x component of the end tangent in the bezier curve */
  5508. x2?: number,
  5509. /** Defines the y component of the end tangent in the bezier curve */
  5510. y2?: number);
  5511. /** @hidden */
  5512. easeInCore(gradient: number): number;
  5513. }
  5514. }
  5515. declare module "babylonjs/Maths/math.color" {
  5516. import { DeepImmutable, FloatArray } from "babylonjs/types";
  5517. /**
  5518. * Class used to hold a RBG color
  5519. */
  5520. export class Color3 {
  5521. /**
  5522. * Defines the red component (between 0 and 1, default is 0)
  5523. */
  5524. r: number;
  5525. /**
  5526. * Defines the green component (between 0 and 1, default is 0)
  5527. */
  5528. g: number;
  5529. /**
  5530. * Defines the blue component (between 0 and 1, default is 0)
  5531. */
  5532. b: number;
  5533. /**
  5534. * Creates a new Color3 object from red, green, blue values, all between 0 and 1
  5535. * @param r defines the red component (between 0 and 1, default is 0)
  5536. * @param g defines the green component (between 0 and 1, default is 0)
  5537. * @param b defines the blue component (between 0 and 1, default is 0)
  5538. */
  5539. constructor(
  5540. /**
  5541. * Defines the red component (between 0 and 1, default is 0)
  5542. */
  5543. r?: number,
  5544. /**
  5545. * Defines the green component (between 0 and 1, default is 0)
  5546. */
  5547. g?: number,
  5548. /**
  5549. * Defines the blue component (between 0 and 1, default is 0)
  5550. */
  5551. b?: number);
  5552. /**
  5553. * Creates a string with the Color3 current values
  5554. * @returns the string representation of the Color3 object
  5555. */
  5556. toString(): string;
  5557. /**
  5558. * Returns the string "Color3"
  5559. * @returns "Color3"
  5560. */
  5561. getClassName(): string;
  5562. /**
  5563. * Compute the Color3 hash code
  5564. * @returns an unique number that can be used to hash Color3 objects
  5565. */
  5566. getHashCode(): number;
  5567. /**
  5568. * Stores in the given array from the given starting index the red, green, blue values as successive elements
  5569. * @param array defines the array where to store the r,g,b components
  5570. * @param index defines an optional index in the target array to define where to start storing values
  5571. * @returns the current Color3 object
  5572. */
  5573. toArray(array: FloatArray, index?: number): Color3;
  5574. /**
  5575. * Update the current color with values stored in an array from the starting index of the given array
  5576. * @param array defines the source array
  5577. * @param offset defines an offset in the source array
  5578. * @returns the current Color3 object
  5579. */
  5580. fromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  5581. /**
  5582. * Returns a new Color4 object from the current Color3 and the given alpha
  5583. * @param alpha defines the alpha component on the new Color4 object (default is 1)
  5584. * @returns a new Color4 object
  5585. */
  5586. toColor4(alpha?: number): Color4;
  5587. /**
  5588. * Returns a new array populated with 3 numeric elements : red, green and blue values
  5589. * @returns the new array
  5590. */
  5591. asArray(): number[];
  5592. /**
  5593. * Returns the luminance value
  5594. * @returns a float value
  5595. */
  5596. toLuminance(): number;
  5597. /**
  5598. * Multiply each Color3 rgb values by the given Color3 rgb values in a new Color3 object
  5599. * @param otherColor defines the second operand
  5600. * @returns the new Color3 object
  5601. */
  5602. multiply(otherColor: DeepImmutable<Color3>): Color3;
  5603. /**
  5604. * Multiply the rgb values of the Color3 and the given Color3 and stores the result in the object "result"
  5605. * @param otherColor defines the second operand
  5606. * @param result defines the Color3 object where to store the result
  5607. * @returns the current Color3
  5608. */
  5609. multiplyToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  5610. /**
  5611. * Determines equality between Color3 objects
  5612. * @param otherColor defines the second operand
  5613. * @returns true if the rgb values are equal to the given ones
  5614. */
  5615. equals(otherColor: DeepImmutable<Color3>): boolean;
  5616. /**
  5617. * Determines equality between the current Color3 object and a set of r,b,g values
  5618. * @param r defines the red component to check
  5619. * @param g defines the green component to check
  5620. * @param b defines the blue component to check
  5621. * @returns true if the rgb values are equal to the given ones
  5622. */
  5623. equalsFloats(r: number, g: number, b: number): boolean;
  5624. /**
  5625. * Multiplies in place each rgb value by scale
  5626. * @param scale defines the scaling factor
  5627. * @returns the updated Color3
  5628. */
  5629. scale(scale: number): Color3;
  5630. /**
  5631. * Multiplies the rgb values by scale and stores the result into "result"
  5632. * @param scale defines the scaling factor
  5633. * @param result defines the Color3 object where to store the result
  5634. * @returns the unmodified current Color3
  5635. */
  5636. scaleToRef(scale: number, result: Color3): Color3;
  5637. /**
  5638. * Scale the current Color3 values by a factor and add the result to a given Color3
  5639. * @param scale defines the scale factor
  5640. * @param result defines color to store the result into
  5641. * @returns the unmodified current Color3
  5642. */
  5643. scaleAndAddToRef(scale: number, result: Color3): Color3;
  5644. /**
  5645. * Clamps the rgb values by the min and max values and stores the result into "result"
  5646. * @param min defines minimum clamping value (default is 0)
  5647. * @param max defines maximum clamping value (default is 1)
  5648. * @param result defines color to store the result into
  5649. * @returns the original Color3
  5650. */
  5651. clampToRef(min: number | undefined, max: number | undefined, result: Color3): Color3;
  5652. /**
  5653. * Creates a new Color3 set with the added values of the current Color3 and of the given one
  5654. * @param otherColor defines the second operand
  5655. * @returns the new Color3
  5656. */
  5657. add(otherColor: DeepImmutable<Color3>): Color3;
  5658. /**
  5659. * Stores the result of the addition of the current Color3 and given one rgb values into "result"
  5660. * @param otherColor defines the second operand
  5661. * @param result defines Color3 object to store the result into
  5662. * @returns the unmodified current Color3
  5663. */
  5664. addToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  5665. /**
  5666. * Returns a new Color3 set with the subtracted values of the given one from the current Color3
  5667. * @param otherColor defines the second operand
  5668. * @returns the new Color3
  5669. */
  5670. subtract(otherColor: DeepImmutable<Color3>): Color3;
  5671. /**
  5672. * Stores the result of the subtraction of given one from the current Color3 rgb values into "result"
  5673. * @param otherColor defines the second operand
  5674. * @param result defines Color3 object to store the result into
  5675. * @returns the unmodified current Color3
  5676. */
  5677. subtractToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  5678. /**
  5679. * Copy the current object
  5680. * @returns a new Color3 copied the current one
  5681. */
  5682. clone(): Color3;
  5683. /**
  5684. * Copies the rgb values from the source in the current Color3
  5685. * @param source defines the source Color3 object
  5686. * @returns the updated Color3 object
  5687. */
  5688. copyFrom(source: DeepImmutable<Color3>): Color3;
  5689. /**
  5690. * Updates the Color3 rgb values from the given floats
  5691. * @param r defines the red component to read from
  5692. * @param g defines the green component to read from
  5693. * @param b defines the blue component to read from
  5694. * @returns the current Color3 object
  5695. */
  5696. copyFromFloats(r: number, g: number, b: number): Color3;
  5697. /**
  5698. * Updates the Color3 rgb values from the given floats
  5699. * @param r defines the red component to read from
  5700. * @param g defines the green component to read from
  5701. * @param b defines the blue component to read from
  5702. * @returns the current Color3 object
  5703. */
  5704. set(r: number, g: number, b: number): Color3;
  5705. /**
  5706. * Compute the Color3 hexadecimal code as a string
  5707. * @returns a string containing the hexadecimal representation of the Color3 object
  5708. */
  5709. toHexString(): string;
  5710. /**
  5711. * Computes a new Color3 converted from the current one to linear space
  5712. * @returns a new Color3 object
  5713. */
  5714. toLinearSpace(): Color3;
  5715. /**
  5716. * Converts current color in rgb space to HSV values
  5717. * @returns a new color3 representing the HSV values
  5718. */
  5719. toHSV(): Color3;
  5720. /**
  5721. * Converts current color in rgb space to HSV values
  5722. * @param result defines the Color3 where to store the HSV values
  5723. */
  5724. toHSVToRef(result: Color3): void;
  5725. /**
  5726. * Converts the Color3 values to linear space and stores the result in "convertedColor"
  5727. * @param convertedColor defines the Color3 object where to store the linear space version
  5728. * @returns the unmodified Color3
  5729. */
  5730. toLinearSpaceToRef(convertedColor: Color3): Color3;
  5731. /**
  5732. * Computes a new Color3 converted from the current one to gamma space
  5733. * @returns a new Color3 object
  5734. */
  5735. toGammaSpace(): Color3;
  5736. /**
  5737. * Converts the Color3 values to gamma space and stores the result in "convertedColor"
  5738. * @param convertedColor defines the Color3 object where to store the gamma space version
  5739. * @returns the unmodified Color3
  5740. */
  5741. toGammaSpaceToRef(convertedColor: Color3): Color3;
  5742. private static _BlackReadOnly;
  5743. /**
  5744. * Convert Hue, saturation and value to a Color3 (RGB)
  5745. * @param hue defines the hue
  5746. * @param saturation defines the saturation
  5747. * @param value defines the value
  5748. * @param result defines the Color3 where to store the RGB values
  5749. */
  5750. static HSVtoRGBToRef(hue: number, saturation: number, value: number, result: Color3): void;
  5751. /**
  5752. * Creates a new Color3 from the string containing valid hexadecimal values
  5753. * @param hex defines a string containing valid hexadecimal values
  5754. * @returns a new Color3 object
  5755. */
  5756. static FromHexString(hex: string): Color3;
  5757. /**
  5758. * Creates a new Color3 from the starting index of the given array
  5759. * @param array defines the source array
  5760. * @param offset defines an offset in the source array
  5761. * @returns a new Color3 object
  5762. */
  5763. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  5764. /**
  5765. * Creates a new Color3 from the starting index element of the given array
  5766. * @param array defines the source array to read from
  5767. * @param offset defines the offset in the source array
  5768. * @param result defines the target Color3 object
  5769. */
  5770. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number | undefined, result: Color3): void;
  5771. /**
  5772. * Creates a new Color3 from integer values (< 256)
  5773. * @param r defines the red component to read from (value between 0 and 255)
  5774. * @param g defines the green component to read from (value between 0 and 255)
  5775. * @param b defines the blue component to read from (value between 0 and 255)
  5776. * @returns a new Color3 object
  5777. */
  5778. static FromInts(r: number, g: number, b: number): Color3;
  5779. /**
  5780. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  5781. * @param start defines the start Color3 value
  5782. * @param end defines the end Color3 value
  5783. * @param amount defines the gradient value between start and end
  5784. * @returns a new Color3 object
  5785. */
  5786. static Lerp(start: DeepImmutable<Color3>, end: DeepImmutable<Color3>, amount: number): Color3;
  5787. /**
  5788. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  5789. * @param left defines the start value
  5790. * @param right defines the end value
  5791. * @param amount defines the gradient factor
  5792. * @param result defines the Color3 object where to store the result
  5793. */
  5794. static LerpToRef(left: DeepImmutable<Color3>, right: DeepImmutable<Color3>, amount: number, result: Color3): void;
  5795. /**
  5796. * Returns a Color3 value containing a red color
  5797. * @returns a new Color3 object
  5798. */
  5799. static Red(): Color3;
  5800. /**
  5801. * Returns a Color3 value containing a green color
  5802. * @returns a new Color3 object
  5803. */
  5804. static Green(): Color3;
  5805. /**
  5806. * Returns a Color3 value containing a blue color
  5807. * @returns a new Color3 object
  5808. */
  5809. static Blue(): Color3;
  5810. /**
  5811. * Returns a Color3 value containing a black color
  5812. * @returns a new Color3 object
  5813. */
  5814. static Black(): Color3;
  5815. /**
  5816. * Gets a Color3 value containing a black color that must not be updated
  5817. */
  5818. static get BlackReadOnly(): DeepImmutable<Color3>;
  5819. /**
  5820. * Returns a Color3 value containing a white color
  5821. * @returns a new Color3 object
  5822. */
  5823. static White(): Color3;
  5824. /**
  5825. * Returns a Color3 value containing a purple color
  5826. * @returns a new Color3 object
  5827. */
  5828. static Purple(): Color3;
  5829. /**
  5830. * Returns a Color3 value containing a magenta color
  5831. * @returns a new Color3 object
  5832. */
  5833. static Magenta(): Color3;
  5834. /**
  5835. * Returns a Color3 value containing a yellow color
  5836. * @returns a new Color3 object
  5837. */
  5838. static Yellow(): Color3;
  5839. /**
  5840. * Returns a Color3 value containing a gray color
  5841. * @returns a new Color3 object
  5842. */
  5843. static Gray(): Color3;
  5844. /**
  5845. * Returns a Color3 value containing a teal color
  5846. * @returns a new Color3 object
  5847. */
  5848. static Teal(): Color3;
  5849. /**
  5850. * Returns a Color3 value containing a random color
  5851. * @returns a new Color3 object
  5852. */
  5853. static Random(): Color3;
  5854. }
  5855. /**
  5856. * Class used to hold a RBGA color
  5857. */
  5858. export class Color4 {
  5859. /**
  5860. * Defines the red component (between 0 and 1, default is 0)
  5861. */
  5862. r: number;
  5863. /**
  5864. * Defines the green component (between 0 and 1, default is 0)
  5865. */
  5866. g: number;
  5867. /**
  5868. * Defines the blue component (between 0 and 1, default is 0)
  5869. */
  5870. b: number;
  5871. /**
  5872. * Defines the alpha component (between 0 and 1, default is 1)
  5873. */
  5874. a: number;
  5875. /**
  5876. * Creates a new Color4 object from red, green, blue values, all between 0 and 1
  5877. * @param r defines the red component (between 0 and 1, default is 0)
  5878. * @param g defines the green component (between 0 and 1, default is 0)
  5879. * @param b defines the blue component (between 0 and 1, default is 0)
  5880. * @param a defines the alpha component (between 0 and 1, default is 1)
  5881. */
  5882. constructor(
  5883. /**
  5884. * Defines the red component (between 0 and 1, default is 0)
  5885. */
  5886. r?: number,
  5887. /**
  5888. * Defines the green component (between 0 and 1, default is 0)
  5889. */
  5890. g?: number,
  5891. /**
  5892. * Defines the blue component (between 0 and 1, default is 0)
  5893. */
  5894. b?: number,
  5895. /**
  5896. * Defines the alpha component (between 0 and 1, default is 1)
  5897. */
  5898. a?: number);
  5899. /**
  5900. * Adds in place the given Color4 values to the current Color4 object
  5901. * @param right defines the second operand
  5902. * @returns the current updated Color4 object
  5903. */
  5904. addInPlace(right: DeepImmutable<Color4>): Color4;
  5905. /**
  5906. * Creates a new array populated with 4 numeric elements : red, green, blue, alpha values
  5907. * @returns the new array
  5908. */
  5909. asArray(): number[];
  5910. /**
  5911. * Stores from the starting index in the given array the Color4 successive values
  5912. * @param array defines the array where to store the r,g,b components
  5913. * @param index defines an optional index in the target array to define where to start storing values
  5914. * @returns the current Color4 object
  5915. */
  5916. toArray(array: number[], index?: number): Color4;
  5917. /**
  5918. * Update the current color with values stored in an array from the starting index of the given array
  5919. * @param array defines the source array
  5920. * @param offset defines an offset in the source array
  5921. * @returns the current Color4 object
  5922. */
  5923. fromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  5924. /**
  5925. * Determines equality between Color4 objects
  5926. * @param otherColor defines the second operand
  5927. * @returns true if the rgba values are equal to the given ones
  5928. */
  5929. equals(otherColor: DeepImmutable<Color4>): boolean;
  5930. /**
  5931. * Creates a new Color4 set with the added values of the current Color4 and of the given one
  5932. * @param right defines the second operand
  5933. * @returns a new Color4 object
  5934. */
  5935. add(right: DeepImmutable<Color4>): Color4;
  5936. /**
  5937. * Creates a new Color4 set with the subtracted values of the given one from the current Color4
  5938. * @param right defines the second operand
  5939. * @returns a new Color4 object
  5940. */
  5941. subtract(right: DeepImmutable<Color4>): Color4;
  5942. /**
  5943. * Subtracts the given ones from the current Color4 values and stores the results in "result"
  5944. * @param right defines the second operand
  5945. * @param result defines the Color4 object where to store the result
  5946. * @returns the current Color4 object
  5947. */
  5948. subtractToRef(right: DeepImmutable<Color4>, result: Color4): Color4;
  5949. /**
  5950. * Creates a new Color4 with the current Color4 values multiplied by scale
  5951. * @param scale defines the scaling factor to apply
  5952. * @returns a new Color4 object
  5953. */
  5954. scale(scale: number): Color4;
  5955. /**
  5956. * Multiplies the current Color4 values by scale and stores the result in "result"
  5957. * @param scale defines the scaling factor to apply
  5958. * @param result defines the Color4 object where to store the result
  5959. * @returns the current unmodified Color4
  5960. */
  5961. scaleToRef(scale: number, result: Color4): Color4;
  5962. /**
  5963. * Scale the current Color4 values by a factor and add the result to a given Color4
  5964. * @param scale defines the scale factor
  5965. * @param result defines the Color4 object where to store the result
  5966. * @returns the unmodified current Color4
  5967. */
  5968. scaleAndAddToRef(scale: number, result: Color4): Color4;
  5969. /**
  5970. * Clamps the rgb values by the min and max values and stores the result into "result"
  5971. * @param min defines minimum clamping value (default is 0)
  5972. * @param max defines maximum clamping value (default is 1)
  5973. * @param result defines color to store the result into.
  5974. * @returns the cuurent Color4
  5975. */
  5976. clampToRef(min: number | undefined, max: number | undefined, result: Color4): Color4;
  5977. /**
  5978. * Multipy an Color4 value by another and return a new Color4 object
  5979. * @param color defines the Color4 value to multiply by
  5980. * @returns a new Color4 object
  5981. */
  5982. multiply(color: Color4): Color4;
  5983. /**
  5984. * Multipy a Color4 value by another and push the result in a reference value
  5985. * @param color defines the Color4 value to multiply by
  5986. * @param result defines the Color4 to fill the result in
  5987. * @returns the result Color4
  5988. */
  5989. multiplyToRef(color: Color4, result: Color4): Color4;
  5990. /**
  5991. * Creates a string with the Color4 current values
  5992. * @returns the string representation of the Color4 object
  5993. */
  5994. toString(): string;
  5995. /**
  5996. * Returns the string "Color4"
  5997. * @returns "Color4"
  5998. */
  5999. getClassName(): string;
  6000. /**
  6001. * Compute the Color4 hash code
  6002. * @returns an unique number that can be used to hash Color4 objects
  6003. */
  6004. getHashCode(): number;
  6005. /**
  6006. * Creates a new Color4 copied from the current one
  6007. * @returns a new Color4 object
  6008. */
  6009. clone(): Color4;
  6010. /**
  6011. * Copies the given Color4 values into the current one
  6012. * @param source defines the source Color4 object
  6013. * @returns the current updated Color4 object
  6014. */
  6015. copyFrom(source: Color4): Color4;
  6016. /**
  6017. * Copies the given float values into the current one
  6018. * @param r defines the red component to read from
  6019. * @param g defines the green component to read from
  6020. * @param b defines the blue component to read from
  6021. * @param a defines the alpha component to read from
  6022. * @returns the current updated Color4 object
  6023. */
  6024. copyFromFloats(r: number, g: number, b: number, a: number): Color4;
  6025. /**
  6026. * Copies the given float values into the current one
  6027. * @param r defines the red component to read from
  6028. * @param g defines the green component to read from
  6029. * @param b defines the blue component to read from
  6030. * @param a defines the alpha component to read from
  6031. * @returns the current updated Color4 object
  6032. */
  6033. set(r: number, g: number, b: number, a: number): Color4;
  6034. /**
  6035. * Compute the Color4 hexadecimal code as a string
  6036. * @param returnAsColor3 defines if the string should only contains RGB values (off by default)
  6037. * @returns a string containing the hexadecimal representation of the Color4 object
  6038. */
  6039. toHexString(returnAsColor3?: boolean): string;
  6040. /**
  6041. * Computes a new Color4 converted from the current one to linear space
  6042. * @returns a new Color4 object
  6043. */
  6044. toLinearSpace(): Color4;
  6045. /**
  6046. * Converts the Color4 values to linear space and stores the result in "convertedColor"
  6047. * @param convertedColor defines the Color4 object where to store the linear space version
  6048. * @returns the unmodified Color4
  6049. */
  6050. toLinearSpaceToRef(convertedColor: Color4): Color4;
  6051. /**
  6052. * Computes a new Color4 converted from the current one to gamma space
  6053. * @returns a new Color4 object
  6054. */
  6055. toGammaSpace(): Color4;
  6056. /**
  6057. * Converts the Color4 values to gamma space and stores the result in "convertedColor"
  6058. * @param convertedColor defines the Color4 object where to store the gamma space version
  6059. * @returns the unmodified Color4
  6060. */
  6061. toGammaSpaceToRef(convertedColor: Color4): Color4;
  6062. /**
  6063. * Creates a new Color4 from the string containing valid hexadecimal values
  6064. * @param hex defines a string containing valid hexadecimal values
  6065. * @returns a new Color4 object
  6066. */
  6067. static FromHexString(hex: string): Color4;
  6068. /**
  6069. * Creates a new Color4 object set with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  6070. * @param left defines the start value
  6071. * @param right defines the end value
  6072. * @param amount defines the gradient factor
  6073. * @returns a new Color4 object
  6074. */
  6075. static Lerp(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number): Color4;
  6076. /**
  6077. * Set the given "result" with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  6078. * @param left defines the start value
  6079. * @param right defines the end value
  6080. * @param amount defines the gradient factor
  6081. * @param result defines the Color4 object where to store data
  6082. */
  6083. static LerpToRef(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number, result: Color4): void;
  6084. /**
  6085. * Creates a new Color4 from a Color3 and an alpha value
  6086. * @param color3 defines the source Color3 to read from
  6087. * @param alpha defines the alpha component (1.0 by default)
  6088. * @returns a new Color4 object
  6089. */
  6090. static FromColor3(color3: DeepImmutable<Color3>, alpha?: number): Color4;
  6091. /**
  6092. * Creates a new Color4 from the starting index element of the given array
  6093. * @param array defines the source array to read from
  6094. * @param offset defines the offset in the source array
  6095. * @returns a new Color4 object
  6096. */
  6097. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  6098. /**
  6099. * Creates a new Color4 from the starting index element of the given array
  6100. * @param array defines the source array to read from
  6101. * @param offset defines the offset in the source array
  6102. * @param result defines the target Color4 object
  6103. */
  6104. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number | undefined, result: Color4): void;
  6105. /**
  6106. * Creates a new Color3 from integer values (< 256)
  6107. * @param r defines the red component to read from (value between 0 and 255)
  6108. * @param g defines the green component to read from (value between 0 and 255)
  6109. * @param b defines the blue component to read from (value between 0 and 255)
  6110. * @param a defines the alpha component to read from (value between 0 and 255)
  6111. * @returns a new Color3 object
  6112. */
  6113. static FromInts(r: number, g: number, b: number, a: number): Color4;
  6114. /**
  6115. * Check the content of a given array and convert it to an array containing RGBA data
  6116. * If the original array was already containing count * 4 values then it is returned directly
  6117. * @param colors defines the array to check
  6118. * @param count defines the number of RGBA data to expect
  6119. * @returns an array containing count * 4 values (RGBA)
  6120. */
  6121. static CheckColors4(colors: number[], count: number): number[];
  6122. }
  6123. /**
  6124. * @hidden
  6125. */
  6126. export class TmpColors {
  6127. static Color3: Color3[];
  6128. static Color4: Color4[];
  6129. }
  6130. }
  6131. declare module "babylonjs/Animations/animationKey" {
  6132. /**
  6133. * Defines an interface which represents an animation key frame
  6134. */
  6135. export interface IAnimationKey {
  6136. /**
  6137. * Frame of the key frame
  6138. */
  6139. frame: number;
  6140. /**
  6141. * Value at the specifies key frame
  6142. */
  6143. value: any;
  6144. /**
  6145. * The input tangent for the cubic hermite spline
  6146. */
  6147. inTangent?: any;
  6148. /**
  6149. * The output tangent for the cubic hermite spline
  6150. */
  6151. outTangent?: any;
  6152. /**
  6153. * The animation interpolation type
  6154. */
  6155. interpolation?: AnimationKeyInterpolation;
  6156. }
  6157. /**
  6158. * Enum for the animation key frame interpolation type
  6159. */
  6160. export enum AnimationKeyInterpolation {
  6161. /**
  6162. * Do not interpolate between keys and use the start key value only. Tangents are ignored
  6163. */
  6164. STEP = 1
  6165. }
  6166. }
  6167. declare module "babylonjs/Animations/animationRange" {
  6168. /**
  6169. * Represents the range of an animation
  6170. */
  6171. export class AnimationRange {
  6172. /**The name of the animation range**/
  6173. name: string;
  6174. /**The starting frame of the animation */
  6175. from: number;
  6176. /**The ending frame of the animation*/
  6177. to: number;
  6178. /**
  6179. * Initializes the range of an animation
  6180. * @param name The name of the animation range
  6181. * @param from The starting frame of the animation
  6182. * @param to The ending frame of the animation
  6183. */
  6184. constructor(
  6185. /**The name of the animation range**/
  6186. name: string,
  6187. /**The starting frame of the animation */
  6188. from: number,
  6189. /**The ending frame of the animation*/
  6190. to: number);
  6191. /**
  6192. * Makes a copy of the animation range
  6193. * @returns A copy of the animation range
  6194. */
  6195. clone(): AnimationRange;
  6196. }
  6197. }
  6198. declare module "babylonjs/Animations/animationEvent" {
  6199. /**
  6200. * Composed of a frame, and an action function
  6201. */
  6202. export class AnimationEvent {
  6203. /** The frame for which the event is triggered **/
  6204. frame: number;
  6205. /** The event to perform when triggered **/
  6206. action: (currentFrame: number) => void;
  6207. /** Specifies if the event should be triggered only once**/
  6208. onlyOnce?: boolean | undefined;
  6209. /**
  6210. * Specifies if the animation event is done
  6211. */
  6212. isDone: boolean;
  6213. /**
  6214. * Initializes the animation event
  6215. * @param frame The frame for which the event is triggered
  6216. * @param action The event to perform when triggered
  6217. * @param onlyOnce Specifies if the event should be triggered only once
  6218. */
  6219. constructor(
  6220. /** The frame for which the event is triggered **/
  6221. frame: number,
  6222. /** The event to perform when triggered **/
  6223. action: (currentFrame: number) => void,
  6224. /** Specifies if the event should be triggered only once**/
  6225. onlyOnce?: boolean | undefined);
  6226. /** @hidden */
  6227. _clone(): AnimationEvent;
  6228. }
  6229. }
  6230. declare module "babylonjs/Behaviors/behavior" {
  6231. import { Nullable } from "babylonjs/types";
  6232. /**
  6233. * Interface used to define a behavior
  6234. */
  6235. export interface Behavior<T> {
  6236. /** gets or sets behavior's name */
  6237. name: string;
  6238. /**
  6239. * Function called when the behavior needs to be initialized (after attaching it to a target)
  6240. */
  6241. init(): void;
  6242. /**
  6243. * Called when the behavior is attached to a target
  6244. * @param target defines the target where the behavior is attached to
  6245. */
  6246. attach(target: T): void;
  6247. /**
  6248. * Called when the behavior is detached from its target
  6249. */
  6250. detach(): void;
  6251. }
  6252. /**
  6253. * Interface implemented by classes supporting behaviors
  6254. */
  6255. export interface IBehaviorAware<T> {
  6256. /**
  6257. * Attach a behavior
  6258. * @param behavior defines the behavior to attach
  6259. * @returns the current host
  6260. */
  6261. addBehavior(behavior: Behavior<T>): T;
  6262. /**
  6263. * Remove a behavior from the current object
  6264. * @param behavior defines the behavior to detach
  6265. * @returns the current host
  6266. */
  6267. removeBehavior(behavior: Behavior<T>): T;
  6268. /**
  6269. * Gets a behavior using its name to search
  6270. * @param name defines the name to search
  6271. * @returns the behavior or null if not found
  6272. */
  6273. getBehaviorByName(name: string): Nullable<Behavior<T>>;
  6274. }
  6275. }
  6276. declare module "babylonjs/Misc/smartArray" {
  6277. /**
  6278. * Defines an array and its length.
  6279. * It can be helpfull to group result from both Arrays and smart arrays in one structure.
  6280. */
  6281. export interface ISmartArrayLike<T> {
  6282. /**
  6283. * The data of the array.
  6284. */
  6285. data: Array<T>;
  6286. /**
  6287. * The active length of the array.
  6288. */
  6289. length: number;
  6290. }
  6291. /**
  6292. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  6293. */
  6294. export class SmartArray<T> implements ISmartArrayLike<T> {
  6295. /**
  6296. * The full set of data from the array.
  6297. */
  6298. data: Array<T>;
  6299. /**
  6300. * The active length of the array.
  6301. */
  6302. length: number;
  6303. protected _id: number;
  6304. /**
  6305. * Instantiates a Smart Array.
  6306. * @param capacity defines the default capacity of the array.
  6307. */
  6308. constructor(capacity: number);
  6309. /**
  6310. * Pushes a value at the end of the active data.
  6311. * @param value defines the object to push in the array.
  6312. */
  6313. push(value: T): void;
  6314. /**
  6315. * Iterates over the active data and apply the lambda to them.
  6316. * @param func defines the action to apply on each value.
  6317. */
  6318. forEach(func: (content: T) => void): void;
  6319. /**
  6320. * Sorts the full sets of data.
  6321. * @param compareFn defines the comparison function to apply.
  6322. */
  6323. sort(compareFn: (a: T, b: T) => number): void;
  6324. /**
  6325. * Resets the active data to an empty array.
  6326. */
  6327. reset(): void;
  6328. /**
  6329. * Releases all the data from the array as well as the array.
  6330. */
  6331. dispose(): void;
  6332. /**
  6333. * Concats the active data with a given array.
  6334. * @param array defines the data to concatenate with.
  6335. */
  6336. concat(array: any): void;
  6337. /**
  6338. * Returns the position of a value in the active data.
  6339. * @param value defines the value to find the index for
  6340. * @returns the index if found in the active data otherwise -1
  6341. */
  6342. indexOf(value: T): number;
  6343. /**
  6344. * Returns whether an element is part of the active data.
  6345. * @param value defines the value to look for
  6346. * @returns true if found in the active data otherwise false
  6347. */
  6348. contains(value: T): boolean;
  6349. private static _GlobalId;
  6350. }
  6351. /**
  6352. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  6353. * The data in this array can only be present once
  6354. */
  6355. export class SmartArrayNoDuplicate<T> extends SmartArray<T> {
  6356. private _duplicateId;
  6357. /**
  6358. * Pushes a value at the end of the active data.
  6359. * THIS DOES NOT PREVENT DUPPLICATE DATA
  6360. * @param value defines the object to push in the array.
  6361. */
  6362. push(value: T): void;
  6363. /**
  6364. * Pushes a value at the end of the active data.
  6365. * If the data is already present, it won t be added again
  6366. * @param value defines the object to push in the array.
  6367. * @returns true if added false if it was already present
  6368. */
  6369. pushNoDuplicate(value: T): boolean;
  6370. /**
  6371. * Resets the active data to an empty array.
  6372. */
  6373. reset(): void;
  6374. /**
  6375. * Concats the active data with a given array.
  6376. * This ensures no dupplicate will be present in the result.
  6377. * @param array defines the data to concatenate with.
  6378. */
  6379. concatWithNoDuplicate(array: any): void;
  6380. }
  6381. }
  6382. declare module "babylonjs/Cameras/cameraInputsManager" {
  6383. import { Nullable } from "babylonjs/types";
  6384. import { Camera } from "babylonjs/Cameras/camera";
  6385. /**
  6386. * @ignore
  6387. * This is a list of all the different input types that are available in the application.
  6388. * Fo instance: ArcRotateCameraGamepadInput...
  6389. */
  6390. export var CameraInputTypes: {};
  6391. /**
  6392. * This is the contract to implement in order to create a new input class.
  6393. * Inputs are dealing with listening to user actions and moving the camera accordingly.
  6394. */
  6395. export interface ICameraInput<TCamera extends Camera> {
  6396. /**
  6397. * Defines the camera the input is attached to.
  6398. */
  6399. camera: Nullable<TCamera>;
  6400. /**
  6401. * Gets the class name of the current intput.
  6402. * @returns the class name
  6403. */
  6404. getClassName(): string;
  6405. /**
  6406. * Get the friendly name associated with the input class.
  6407. * @returns the input friendly name
  6408. */
  6409. getSimpleName(): string;
  6410. /**
  6411. * Attach the input controls to a specific dom element to get the input from.
  6412. * @param element Defines the element the controls should be listened from
  6413. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  6414. */
  6415. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  6416. /**
  6417. * Detach the current controls from the specified dom element.
  6418. * @param element Defines the element to stop listening the inputs from
  6419. */
  6420. detachControl(element: Nullable<HTMLElement>): void;
  6421. /**
  6422. * Update the current camera state depending on the inputs that have been used this frame.
  6423. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  6424. */
  6425. checkInputs?: () => void;
  6426. }
  6427. /**
  6428. * Represents a map of input types to input instance or input index to input instance.
  6429. */
  6430. export interface CameraInputsMap<TCamera extends Camera> {
  6431. /**
  6432. * Accessor to the input by input type.
  6433. */
  6434. [name: string]: ICameraInput<TCamera>;
  6435. /**
  6436. * Accessor to the input by input index.
  6437. */
  6438. [idx: number]: ICameraInput<TCamera>;
  6439. }
  6440. /**
  6441. * This represents the input manager used within a camera.
  6442. * It helps dealing with all the different kind of input attached to a camera.
  6443. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  6444. */
  6445. export class CameraInputsManager<TCamera extends Camera> {
  6446. /**
  6447. * Defines the list of inputs attahed to the camera.
  6448. */
  6449. attached: CameraInputsMap<TCamera>;
  6450. /**
  6451. * Defines the dom element the camera is collecting inputs from.
  6452. * This is null if the controls have not been attached.
  6453. */
  6454. attachedElement: Nullable<HTMLElement>;
  6455. /**
  6456. * Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  6457. */
  6458. noPreventDefault: boolean;
  6459. /**
  6460. * Defined the camera the input manager belongs to.
  6461. */
  6462. camera: TCamera;
  6463. /**
  6464. * Update the current camera state depending on the inputs that have been used this frame.
  6465. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  6466. */
  6467. checkInputs: () => void;
  6468. /**
  6469. * Instantiate a new Camera Input Manager.
  6470. * @param camera Defines the camera the input manager blongs to
  6471. */
  6472. constructor(camera: TCamera);
  6473. /**
  6474. * Add an input method to a camera
  6475. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  6476. * @param input camera input method
  6477. */
  6478. add(input: ICameraInput<TCamera>): void;
  6479. /**
  6480. * Remove a specific input method from a camera
  6481. * example: camera.inputs.remove(camera.inputs.attached.mouse);
  6482. * @param inputToRemove camera input method
  6483. */
  6484. remove(inputToRemove: ICameraInput<TCamera>): void;
  6485. /**
  6486. * Remove a specific input type from a camera
  6487. * example: camera.inputs.remove("ArcRotateCameraGamepadInput");
  6488. * @param inputType the type of the input to remove
  6489. */
  6490. removeByType(inputType: string): void;
  6491. private _addCheckInputs;
  6492. /**
  6493. * Attach the input controls to the currently attached dom element to listen the events from.
  6494. * @param input Defines the input to attach
  6495. */
  6496. attachInput(input: ICameraInput<TCamera>): void;
  6497. /**
  6498. * Attach the current manager inputs controls to a specific dom element to listen the events from.
  6499. * @param element Defines the dom element to collect the events from
  6500. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  6501. */
  6502. attachElement(element: HTMLElement, noPreventDefault?: boolean): void;
  6503. /**
  6504. * Detach the current manager inputs controls from a specific dom element.
  6505. * @param element Defines the dom element to collect the events from
  6506. * @param disconnect Defines whether the input should be removed from the current list of attached inputs
  6507. */
  6508. detachElement(element: HTMLElement, disconnect?: boolean): void;
  6509. /**
  6510. * Rebuild the dynamic inputCheck function from the current list of
  6511. * defined inputs in the manager.
  6512. */
  6513. rebuildInputCheck(): void;
  6514. /**
  6515. * Remove all attached input methods from a camera
  6516. */
  6517. clear(): void;
  6518. /**
  6519. * Serialize the current input manager attached to a camera.
  6520. * This ensures than once parsed,
  6521. * the input associated to the camera will be identical to the current ones
  6522. * @param serializedCamera Defines the camera serialization JSON the input serialization should write to
  6523. */
  6524. serialize(serializedCamera: any): void;
  6525. /**
  6526. * Parses an input manager serialized JSON to restore the previous list of inputs
  6527. * and states associated to a camera.
  6528. * @param parsedCamera Defines the JSON to parse
  6529. */
  6530. parse(parsedCamera: any): void;
  6531. }
  6532. }
  6533. declare module "babylonjs/Meshes/buffer" {
  6534. import { Nullable, DataArray } from "babylonjs/types";
  6535. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  6536. /**
  6537. * Class used to store data that will be store in GPU memory
  6538. */
  6539. export class Buffer {
  6540. private _engine;
  6541. private _buffer;
  6542. /** @hidden */
  6543. _data: Nullable<DataArray>;
  6544. private _updatable;
  6545. private _instanced;
  6546. private _divisor;
  6547. /**
  6548. * Gets the byte stride.
  6549. */
  6550. readonly byteStride: number;
  6551. /**
  6552. * Constructor
  6553. * @param engine the engine
  6554. * @param data the data to use for this buffer
  6555. * @param updatable whether the data is updatable
  6556. * @param stride the stride (optional)
  6557. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  6558. * @param instanced whether the buffer is instanced (optional)
  6559. * @param useBytes set to true if the stride in in bytes (optional)
  6560. * @param divisor sets an optional divisor for instances (1 by default)
  6561. */
  6562. constructor(engine: any, data: DataArray, updatable: boolean, stride?: number, postponeInternalCreation?: boolean, instanced?: boolean, useBytes?: boolean, divisor?: number);
  6563. /**
  6564. * Create a new VertexBuffer based on the current buffer
  6565. * @param kind defines the vertex buffer kind (position, normal, etc.)
  6566. * @param offset defines offset in the buffer (0 by default)
  6567. * @param size defines the size in floats of attributes (position is 3 for instance)
  6568. * @param stride defines the stride size in floats in the buffer (the offset to apply to reach next value when data is interleaved)
  6569. * @param instanced defines if the vertex buffer contains indexed data
  6570. * @param useBytes defines if the offset and stride are in bytes *
  6571. * @param divisor sets an optional divisor for instances (1 by default)
  6572. * @returns the new vertex buffer
  6573. */
  6574. createVertexBuffer(kind: string, offset: number, size: number, stride?: number, instanced?: boolean, useBytes?: boolean, divisor?: number): VertexBuffer;
  6575. /**
  6576. * Gets a boolean indicating if the Buffer is updatable?
  6577. * @returns true if the buffer is updatable
  6578. */
  6579. isUpdatable(): boolean;
  6580. /**
  6581. * Gets current buffer's data
  6582. * @returns a DataArray or null
  6583. */
  6584. getData(): Nullable<DataArray>;
  6585. /**
  6586. * Gets underlying native buffer
  6587. * @returns underlying native buffer
  6588. */
  6589. getBuffer(): Nullable<DataBuffer>;
  6590. /**
  6591. * Gets the stride in float32 units (i.e. byte stride / 4).
  6592. * May not be an integer if the byte stride is not divisible by 4.
  6593. * @returns the stride in float32 units
  6594. * @deprecated Please use byteStride instead.
  6595. */
  6596. getStrideSize(): number;
  6597. /**
  6598. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  6599. * @param data defines the data to store
  6600. */
  6601. create(data?: Nullable<DataArray>): void;
  6602. /** @hidden */
  6603. _rebuild(): void;
  6604. /**
  6605. * Update current buffer data
  6606. * @param data defines the data to store
  6607. */
  6608. update(data: DataArray): void;
  6609. /**
  6610. * Updates the data directly.
  6611. * @param data the new data
  6612. * @param offset the new offset
  6613. * @param vertexCount the vertex count (optional)
  6614. * @param useBytes set to true if the offset is in bytes
  6615. */
  6616. updateDirectly(data: DataArray, offset: number, vertexCount?: number, useBytes?: boolean): void;
  6617. /**
  6618. * Release all resources
  6619. */
  6620. dispose(): void;
  6621. }
  6622. /**
  6623. * Specialized buffer used to store vertex data
  6624. */
  6625. export class VertexBuffer {
  6626. /** @hidden */
  6627. _buffer: Buffer;
  6628. private _kind;
  6629. private _size;
  6630. private _ownsBuffer;
  6631. private _instanced;
  6632. private _instanceDivisor;
  6633. /**
  6634. * The byte type.
  6635. */
  6636. static readonly BYTE: number;
  6637. /**
  6638. * The unsigned byte type.
  6639. */
  6640. static readonly UNSIGNED_BYTE: number;
  6641. /**
  6642. * The short type.
  6643. */
  6644. static readonly SHORT: number;
  6645. /**
  6646. * The unsigned short type.
  6647. */
  6648. static readonly UNSIGNED_SHORT: number;
  6649. /**
  6650. * The integer type.
  6651. */
  6652. static readonly INT: number;
  6653. /**
  6654. * The unsigned integer type.
  6655. */
  6656. static readonly UNSIGNED_INT: number;
  6657. /**
  6658. * The float type.
  6659. */
  6660. static readonly FLOAT: number;
  6661. /**
  6662. * Gets or sets the instance divisor when in instanced mode
  6663. */
  6664. get instanceDivisor(): number;
  6665. set instanceDivisor(value: number);
  6666. /**
  6667. * Gets the byte stride.
  6668. */
  6669. readonly byteStride: number;
  6670. /**
  6671. * Gets the byte offset.
  6672. */
  6673. readonly byteOffset: number;
  6674. /**
  6675. * Gets whether integer data values should be normalized into a certain range when being casted to a float.
  6676. */
  6677. readonly normalized: boolean;
  6678. /**
  6679. * Gets the data type of each component in the array.
  6680. */
  6681. readonly type: number;
  6682. /**
  6683. * Constructor
  6684. * @param engine the engine
  6685. * @param data the data to use for this vertex buffer
  6686. * @param kind the vertex buffer kind
  6687. * @param updatable whether the data is updatable
  6688. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  6689. * @param stride the stride (optional)
  6690. * @param instanced whether the buffer is instanced (optional)
  6691. * @param offset the offset of the data (optional)
  6692. * @param size the number of components (optional)
  6693. * @param type the type of the component (optional)
  6694. * @param normalized whether the data contains normalized data (optional)
  6695. * @param useBytes set to true if stride and offset are in bytes (optional)
  6696. * @param divisor defines the instance divisor to use (1 by default)
  6697. */
  6698. constructor(engine: any, data: DataArray | Buffer, kind: string, updatable: boolean, postponeInternalCreation?: boolean, stride?: number, instanced?: boolean, offset?: number, size?: number, type?: number, normalized?: boolean, useBytes?: boolean, divisor?: number);
  6699. /** @hidden */
  6700. _rebuild(): void;
  6701. /**
  6702. * Returns the kind of the VertexBuffer (string)
  6703. * @returns a string
  6704. */
  6705. getKind(): string;
  6706. /**
  6707. * Gets a boolean indicating if the VertexBuffer is updatable?
  6708. * @returns true if the buffer is updatable
  6709. */
  6710. isUpdatable(): boolean;
  6711. /**
  6712. * Gets current buffer's data
  6713. * @returns a DataArray or null
  6714. */
  6715. getData(): Nullable<DataArray>;
  6716. /**
  6717. * Gets underlying native buffer
  6718. * @returns underlying native buffer
  6719. */
  6720. getBuffer(): Nullable<DataBuffer>;
  6721. /**
  6722. * Gets the stride in float32 units (i.e. byte stride / 4).
  6723. * May not be an integer if the byte stride is not divisible by 4.
  6724. * @returns the stride in float32 units
  6725. * @deprecated Please use byteStride instead.
  6726. */
  6727. getStrideSize(): number;
  6728. /**
  6729. * Returns the offset as a multiple of the type byte length.
  6730. * @returns the offset in bytes
  6731. * @deprecated Please use byteOffset instead.
  6732. */
  6733. getOffset(): number;
  6734. /**
  6735. * Returns the number of components per vertex attribute (integer)
  6736. * @returns the size in float
  6737. */
  6738. getSize(): number;
  6739. /**
  6740. * Gets a boolean indicating is the internal buffer of the VertexBuffer is instanced
  6741. * @returns true if this buffer is instanced
  6742. */
  6743. getIsInstanced(): boolean;
  6744. /**
  6745. * Returns the instancing divisor, zero for non-instanced (integer).
  6746. * @returns a number
  6747. */
  6748. getInstanceDivisor(): number;
  6749. /**
  6750. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  6751. * @param data defines the data to store
  6752. */
  6753. create(data?: DataArray): void;
  6754. /**
  6755. * Updates the underlying buffer according to the passed numeric array or Float32Array.
  6756. * This function will create a new buffer if the current one is not updatable
  6757. * @param data defines the data to store
  6758. */
  6759. update(data: DataArray): void;
  6760. /**
  6761. * Updates directly the underlying WebGLBuffer according to the passed numeric array or Float32Array.
  6762. * Returns the directly updated WebGLBuffer.
  6763. * @param data the new data
  6764. * @param offset the new offset
  6765. * @param useBytes set to true if the offset is in bytes
  6766. */
  6767. updateDirectly(data: DataArray, offset: number, useBytes?: boolean): void;
  6768. /**
  6769. * Disposes the VertexBuffer and the underlying WebGLBuffer.
  6770. */
  6771. dispose(): void;
  6772. /**
  6773. * Enumerates each value of this vertex buffer as numbers.
  6774. * @param count the number of values to enumerate
  6775. * @param callback the callback function called for each value
  6776. */
  6777. forEach(count: number, callback: (value: number, index: number) => void): void;
  6778. /**
  6779. * Positions
  6780. */
  6781. static readonly PositionKind: string;
  6782. /**
  6783. * Normals
  6784. */
  6785. static readonly NormalKind: string;
  6786. /**
  6787. * Tangents
  6788. */
  6789. static readonly TangentKind: string;
  6790. /**
  6791. * Texture coordinates
  6792. */
  6793. static readonly UVKind: string;
  6794. /**
  6795. * Texture coordinates 2
  6796. */
  6797. static readonly UV2Kind: string;
  6798. /**
  6799. * Texture coordinates 3
  6800. */
  6801. static readonly UV3Kind: string;
  6802. /**
  6803. * Texture coordinates 4
  6804. */
  6805. static readonly UV4Kind: string;
  6806. /**
  6807. * Texture coordinates 5
  6808. */
  6809. static readonly UV5Kind: string;
  6810. /**
  6811. * Texture coordinates 6
  6812. */
  6813. static readonly UV6Kind: string;
  6814. /**
  6815. * Colors
  6816. */
  6817. static readonly ColorKind: string;
  6818. /**
  6819. * Matrix indices (for bones)
  6820. */
  6821. static readonly MatricesIndicesKind: string;
  6822. /**
  6823. * Matrix weights (for bones)
  6824. */
  6825. static readonly MatricesWeightsKind: string;
  6826. /**
  6827. * Additional matrix indices (for bones)
  6828. */
  6829. static readonly MatricesIndicesExtraKind: string;
  6830. /**
  6831. * Additional matrix weights (for bones)
  6832. */
  6833. static readonly MatricesWeightsExtraKind: string;
  6834. /**
  6835. * Deduces the stride given a kind.
  6836. * @param kind The kind string to deduce
  6837. * @returns The deduced stride
  6838. */
  6839. static DeduceStride(kind: string): number;
  6840. /**
  6841. * Gets the byte length of the given type.
  6842. * @param type the type
  6843. * @returns the number of bytes
  6844. */
  6845. static GetTypeByteLength(type: number): number;
  6846. /**
  6847. * Enumerates each value of the given parameters as numbers.
  6848. * @param data the data to enumerate
  6849. * @param byteOffset the byte offset of the data
  6850. * @param byteStride the byte stride of the data
  6851. * @param componentCount the number of components per element
  6852. * @param componentType the type of the component
  6853. * @param count the number of values to enumerate
  6854. * @param normalized whether the data is normalized
  6855. * @param callback the callback function called for each value
  6856. */
  6857. static ForEach(data: DataArray, byteOffset: number, byteStride: number, componentCount: number, componentType: number, count: number, normalized: boolean, callback: (value: number, index: number) => void): void;
  6858. private static _GetFloatValue;
  6859. }
  6860. }
  6861. declare module "babylonjs/Collisions/intersectionInfo" {
  6862. import { Nullable } from "babylonjs/types";
  6863. /**
  6864. * @hidden
  6865. */
  6866. export class IntersectionInfo {
  6867. bu: Nullable<number>;
  6868. bv: Nullable<number>;
  6869. distance: number;
  6870. faceId: number;
  6871. subMeshId: number;
  6872. constructor(bu: Nullable<number>, bv: Nullable<number>, distance: number);
  6873. }
  6874. }
  6875. declare module "babylonjs/Culling/boundingSphere" {
  6876. import { DeepImmutable } from "babylonjs/types";
  6877. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  6878. import { Plane } from "babylonjs/Maths/math.plane";
  6879. /**
  6880. * Class used to store bounding sphere information
  6881. */
  6882. export class BoundingSphere {
  6883. /**
  6884. * Gets the center of the bounding sphere in local space
  6885. */
  6886. readonly center: Vector3;
  6887. /**
  6888. * Radius of the bounding sphere in local space
  6889. */
  6890. radius: number;
  6891. /**
  6892. * Gets the center of the bounding sphere in world space
  6893. */
  6894. readonly centerWorld: Vector3;
  6895. /**
  6896. * Radius of the bounding sphere in world space
  6897. */
  6898. radiusWorld: number;
  6899. /**
  6900. * Gets the minimum vector in local space
  6901. */
  6902. readonly minimum: Vector3;
  6903. /**
  6904. * Gets the maximum vector in local space
  6905. */
  6906. readonly maximum: Vector3;
  6907. private _worldMatrix;
  6908. private static readonly TmpVector3;
  6909. /**
  6910. * Creates a new bounding sphere
  6911. * @param min defines the minimum vector (in local space)
  6912. * @param max defines the maximum vector (in local space)
  6913. * @param worldMatrix defines the new world matrix
  6914. */
  6915. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  6916. /**
  6917. * Recreates the entire bounding sphere from scratch as if we call the constructor in place
  6918. * @param min defines the new minimum vector (in local space)
  6919. * @param max defines the new maximum vector (in local space)
  6920. * @param worldMatrix defines the new world matrix
  6921. */
  6922. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  6923. /**
  6924. * Scale the current bounding sphere by applying a scale factor
  6925. * @param factor defines the scale factor to apply
  6926. * @returns the current bounding box
  6927. */
  6928. scale(factor: number): BoundingSphere;
  6929. /**
  6930. * Gets the world matrix of the bounding box
  6931. * @returns a matrix
  6932. */
  6933. getWorldMatrix(): DeepImmutable<Matrix>;
  6934. /** @hidden */
  6935. _update(worldMatrix: DeepImmutable<Matrix>): void;
  6936. /**
  6937. * Tests if the bounding sphere is intersecting the frustum planes
  6938. * @param frustumPlanes defines the frustum planes to test
  6939. * @returns true if there is an intersection
  6940. */
  6941. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  6942. /**
  6943. * Tests if the bounding sphere center is in between the frustum planes.
  6944. * Used for optimistic fast inclusion.
  6945. * @param frustumPlanes defines the frustum planes to test
  6946. * @returns true if the sphere center is in between the frustum planes
  6947. */
  6948. isCenterInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  6949. /**
  6950. * Tests if a point is inside the bounding sphere
  6951. * @param point defines the point to test
  6952. * @returns true if the point is inside the bounding sphere
  6953. */
  6954. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  6955. /**
  6956. * Checks if two sphere intersct
  6957. * @param sphere0 sphere 0
  6958. * @param sphere1 sphere 1
  6959. * @returns true if the speres intersect
  6960. */
  6961. static Intersects(sphere0: DeepImmutable<BoundingSphere>, sphere1: DeepImmutable<BoundingSphere>): boolean;
  6962. }
  6963. }
  6964. declare module "babylonjs/Culling/boundingBox" {
  6965. import { DeepImmutable } from "babylonjs/types";
  6966. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  6967. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  6968. import { ICullable } from "babylonjs/Culling/boundingInfo";
  6969. import { Plane } from "babylonjs/Maths/math.plane";
  6970. /**
  6971. * Class used to store bounding box information
  6972. */
  6973. export class BoundingBox implements ICullable {
  6974. /**
  6975. * Gets the 8 vectors representing the bounding box in local space
  6976. */
  6977. readonly vectors: Vector3[];
  6978. /**
  6979. * Gets the center of the bounding box in local space
  6980. */
  6981. readonly center: Vector3;
  6982. /**
  6983. * Gets the center of the bounding box in world space
  6984. */
  6985. readonly centerWorld: Vector3;
  6986. /**
  6987. * Gets the extend size in local space
  6988. */
  6989. readonly extendSize: Vector3;
  6990. /**
  6991. * Gets the extend size in world space
  6992. */
  6993. readonly extendSizeWorld: Vector3;
  6994. /**
  6995. * Gets the OBB (object bounding box) directions
  6996. */
  6997. readonly directions: Vector3[];
  6998. /**
  6999. * Gets the 8 vectors representing the bounding box in world space
  7000. */
  7001. readonly vectorsWorld: Vector3[];
  7002. /**
  7003. * Gets the minimum vector in world space
  7004. */
  7005. readonly minimumWorld: Vector3;
  7006. /**
  7007. * Gets the maximum vector in world space
  7008. */
  7009. readonly maximumWorld: Vector3;
  7010. /**
  7011. * Gets the minimum vector in local space
  7012. */
  7013. readonly minimum: Vector3;
  7014. /**
  7015. * Gets the maximum vector in local space
  7016. */
  7017. readonly maximum: Vector3;
  7018. private _worldMatrix;
  7019. private static readonly TmpVector3;
  7020. /**
  7021. * @hidden
  7022. */
  7023. _tag: number;
  7024. /**
  7025. * Creates a new bounding box
  7026. * @param min defines the minimum vector (in local space)
  7027. * @param max defines the maximum vector (in local space)
  7028. * @param worldMatrix defines the new world matrix
  7029. */
  7030. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  7031. /**
  7032. * Recreates the entire bounding box from scratch as if we call the constructor in place
  7033. * @param min defines the new minimum vector (in local space)
  7034. * @param max defines the new maximum vector (in local space)
  7035. * @param worldMatrix defines the new world matrix
  7036. */
  7037. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  7038. /**
  7039. * Scale the current bounding box by applying a scale factor
  7040. * @param factor defines the scale factor to apply
  7041. * @returns the current bounding box
  7042. */
  7043. scale(factor: number): BoundingBox;
  7044. /**
  7045. * Gets the world matrix of the bounding box
  7046. * @returns a matrix
  7047. */
  7048. getWorldMatrix(): DeepImmutable<Matrix>;
  7049. /** @hidden */
  7050. _update(world: DeepImmutable<Matrix>): void;
  7051. /**
  7052. * Tests if the bounding box is intersecting the frustum planes
  7053. * @param frustumPlanes defines the frustum planes to test
  7054. * @returns true if there is an intersection
  7055. */
  7056. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7057. /**
  7058. * Tests if the bounding box is entirely inside the frustum planes
  7059. * @param frustumPlanes defines the frustum planes to test
  7060. * @returns true if there is an inclusion
  7061. */
  7062. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7063. /**
  7064. * Tests if a point is inside the bounding box
  7065. * @param point defines the point to test
  7066. * @returns true if the point is inside the bounding box
  7067. */
  7068. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  7069. /**
  7070. * Tests if the bounding box intersects with a bounding sphere
  7071. * @param sphere defines the sphere to test
  7072. * @returns true if there is an intersection
  7073. */
  7074. intersectsSphere(sphere: DeepImmutable<BoundingSphere>): boolean;
  7075. /**
  7076. * Tests if the bounding box intersects with a box defined by a min and max vectors
  7077. * @param min defines the min vector to use
  7078. * @param max defines the max vector to use
  7079. * @returns true if there is an intersection
  7080. */
  7081. intersectsMinMax(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): boolean;
  7082. /**
  7083. * Tests if two bounding boxes are intersections
  7084. * @param box0 defines the first box to test
  7085. * @param box1 defines the second box to test
  7086. * @returns true if there is an intersection
  7087. */
  7088. static Intersects(box0: DeepImmutable<BoundingBox>, box1: DeepImmutable<BoundingBox>): boolean;
  7089. /**
  7090. * Tests if a bounding box defines by a min/max vectors intersects a sphere
  7091. * @param minPoint defines the minimum vector of the bounding box
  7092. * @param maxPoint defines the maximum vector of the bounding box
  7093. * @param sphereCenter defines the sphere center
  7094. * @param sphereRadius defines the sphere radius
  7095. * @returns true if there is an intersection
  7096. */
  7097. static IntersectsSphere(minPoint: DeepImmutable<Vector3>, maxPoint: DeepImmutable<Vector3>, sphereCenter: DeepImmutable<Vector3>, sphereRadius: number): boolean;
  7098. /**
  7099. * Tests if a bounding box defined with 8 vectors is entirely inside frustum planes
  7100. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  7101. * @param frustumPlanes defines the frustum planes to test
  7102. * @return true if there is an inclusion
  7103. */
  7104. static IsCompletelyInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7105. /**
  7106. * Tests if a bounding box defined with 8 vectors intersects frustum planes
  7107. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  7108. * @param frustumPlanes defines the frustum planes to test
  7109. * @return true if there is an intersection
  7110. */
  7111. static IsInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7112. }
  7113. }
  7114. declare module "babylonjs/Collisions/collider" {
  7115. import { Nullable, IndicesArray } from "babylonjs/types";
  7116. import { Vector3 } from "babylonjs/Maths/math.vector";
  7117. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  7118. import { Plane } from "babylonjs/Maths/math.plane";
  7119. /** @hidden */
  7120. export class Collider {
  7121. /** Define if a collision was found */
  7122. collisionFound: boolean;
  7123. /**
  7124. * Define last intersection point in local space
  7125. */
  7126. intersectionPoint: Vector3;
  7127. /**
  7128. * Define last collided mesh
  7129. */
  7130. collidedMesh: Nullable<AbstractMesh>;
  7131. private _collisionPoint;
  7132. private _planeIntersectionPoint;
  7133. private _tempVector;
  7134. private _tempVector2;
  7135. private _tempVector3;
  7136. private _tempVector4;
  7137. private _edge;
  7138. private _baseToVertex;
  7139. private _destinationPoint;
  7140. private _slidePlaneNormal;
  7141. private _displacementVector;
  7142. /** @hidden */
  7143. _radius: Vector3;
  7144. /** @hidden */
  7145. _retry: number;
  7146. private _velocity;
  7147. private _basePoint;
  7148. private _epsilon;
  7149. /** @hidden */
  7150. _velocityWorldLength: number;
  7151. /** @hidden */
  7152. _basePointWorld: Vector3;
  7153. private _velocityWorld;
  7154. private _normalizedVelocity;
  7155. /** @hidden */
  7156. _initialVelocity: Vector3;
  7157. /** @hidden */
  7158. _initialPosition: Vector3;
  7159. private _nearestDistance;
  7160. private _collisionMask;
  7161. get collisionMask(): number;
  7162. set collisionMask(mask: number);
  7163. /**
  7164. * Gets the plane normal used to compute the sliding response (in local space)
  7165. */
  7166. get slidePlaneNormal(): Vector3;
  7167. /** @hidden */
  7168. _initialize(source: Vector3, dir: Vector3, e: number): void;
  7169. /** @hidden */
  7170. _checkPointInTriangle(point: Vector3, pa: Vector3, pb: Vector3, pc: Vector3, n: Vector3): boolean;
  7171. /** @hidden */
  7172. _canDoCollision(sphereCenter: Vector3, sphereRadius: number, vecMin: Vector3, vecMax: Vector3): boolean;
  7173. /** @hidden */
  7174. _testTriangle(faceIndex: number, trianglePlaneArray: Array<Plane>, p1: Vector3, p2: Vector3, p3: Vector3, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  7175. /** @hidden */
  7176. _collide(trianglePlaneArray: Array<Plane>, pts: Vector3[], indices: IndicesArray, indexStart: number, indexEnd: number, decal: number, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  7177. /** @hidden */
  7178. _getResponse(pos: Vector3, vel: Vector3): void;
  7179. }
  7180. }
  7181. declare module "babylonjs/Culling/boundingInfo" {
  7182. import { DeepImmutable } from "babylonjs/types";
  7183. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  7184. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  7185. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  7186. import { Plane } from "babylonjs/Maths/math.plane";
  7187. import { Collider } from "babylonjs/Collisions/collider";
  7188. /**
  7189. * Interface for cullable objects
  7190. * @see https://doc.babylonjs.com/babylon101/materials#back-face-culling
  7191. */
  7192. export interface ICullable {
  7193. /**
  7194. * Checks if the object or part of the object is in the frustum
  7195. * @param frustumPlanes Camera near/planes
  7196. * @returns true if the object is in frustum otherwise false
  7197. */
  7198. isInFrustum(frustumPlanes: Plane[]): boolean;
  7199. /**
  7200. * Checks if a cullable object (mesh...) is in the camera frustum
  7201. * Unlike isInFrustum this cheks the full bounding box
  7202. * @param frustumPlanes Camera near/planes
  7203. * @returns true if the object is in frustum otherwise false
  7204. */
  7205. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  7206. }
  7207. /**
  7208. * Info for a bounding data of a mesh
  7209. */
  7210. export class BoundingInfo implements ICullable {
  7211. /**
  7212. * Bounding box for the mesh
  7213. */
  7214. readonly boundingBox: BoundingBox;
  7215. /**
  7216. * Bounding sphere for the mesh
  7217. */
  7218. readonly boundingSphere: BoundingSphere;
  7219. private _isLocked;
  7220. private static readonly TmpVector3;
  7221. /**
  7222. * Constructs bounding info
  7223. * @param minimum min vector of the bounding box/sphere
  7224. * @param maximum max vector of the bounding box/sphere
  7225. * @param worldMatrix defines the new world matrix
  7226. */
  7227. constructor(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  7228. /**
  7229. * Recreates the entire bounding info from scratch as if we call the constructor in place
  7230. * @param min defines the new minimum vector (in local space)
  7231. * @param max defines the new maximum vector (in local space)
  7232. * @param worldMatrix defines the new world matrix
  7233. */
  7234. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  7235. /**
  7236. * min vector of the bounding box/sphere
  7237. */
  7238. get minimum(): Vector3;
  7239. /**
  7240. * max vector of the bounding box/sphere
  7241. */
  7242. get maximum(): Vector3;
  7243. /**
  7244. * If the info is locked and won't be updated to avoid perf overhead
  7245. */
  7246. get isLocked(): boolean;
  7247. set isLocked(value: boolean);
  7248. /**
  7249. * Updates the bounding sphere and box
  7250. * @param world world matrix to be used to update
  7251. */
  7252. update(world: DeepImmutable<Matrix>): void;
  7253. /**
  7254. * Recreate the bounding info to be centered around a specific point given a specific extend.
  7255. * @param center New center of the bounding info
  7256. * @param extend New extend of the bounding info
  7257. * @returns the current bounding info
  7258. */
  7259. centerOn(center: DeepImmutable<Vector3>, extend: DeepImmutable<Vector3>): BoundingInfo;
  7260. /**
  7261. * Scale the current bounding info by applying a scale factor
  7262. * @param factor defines the scale factor to apply
  7263. * @returns the current bounding info
  7264. */
  7265. scale(factor: number): BoundingInfo;
  7266. /**
  7267. * Returns `true` if the bounding info is within the frustum defined by the passed array of planes.
  7268. * @param frustumPlanes defines the frustum to test
  7269. * @param strategy defines the strategy to use for the culling (default is BABYLON.AbstractMesh.CULLINGSTRATEGY_STANDARD)
  7270. * @returns true if the bounding info is in the frustum planes
  7271. */
  7272. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>, strategy?: number): boolean;
  7273. /**
  7274. * Gets the world distance between the min and max points of the bounding box
  7275. */
  7276. get diagonalLength(): number;
  7277. /**
  7278. * Checks if a cullable object (mesh...) is in the camera frustum
  7279. * Unlike isInFrustum this cheks the full bounding box
  7280. * @param frustumPlanes Camera near/planes
  7281. * @returns true if the object is in frustum otherwise false
  7282. */
  7283. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7284. /** @hidden */
  7285. _checkCollision(collider: Collider): boolean;
  7286. /**
  7287. * Checks if a point is inside the bounding box and bounding sphere or the mesh
  7288. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  7289. * @param point the point to check intersection with
  7290. * @returns if the point intersects
  7291. */
  7292. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  7293. /**
  7294. * Checks if another bounding info intersects the bounding box and bounding sphere or the mesh
  7295. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  7296. * @param boundingInfo the bounding info to check intersection with
  7297. * @param precise if the intersection should be done using OBB
  7298. * @returns if the bounding info intersects
  7299. */
  7300. intersects(boundingInfo: DeepImmutable<BoundingInfo>, precise: boolean): boolean;
  7301. }
  7302. }
  7303. declare module "babylonjs/Maths/math.functions" {
  7304. import { FloatArray, Nullable, IndicesArray } from "babylonjs/types";
  7305. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  7306. /**
  7307. * Extracts minimum and maximum values from a list of indexed positions
  7308. * @param positions defines the positions to use
  7309. * @param indices defines the indices to the positions
  7310. * @param indexStart defines the start index
  7311. * @param indexCount defines the end index
  7312. * @param bias defines bias value to add to the result
  7313. * @return minimum and maximum values
  7314. */
  7315. export function extractMinAndMaxIndexed(positions: FloatArray, indices: IndicesArray, indexStart: number, indexCount: number, bias?: Nullable<Vector2>): {
  7316. minimum: Vector3;
  7317. maximum: Vector3;
  7318. };
  7319. /**
  7320. * Extracts minimum and maximum values from a list of positions
  7321. * @param positions defines the positions to use
  7322. * @param start defines the start index in the positions array
  7323. * @param count defines the number of positions to handle
  7324. * @param bias defines bias value to add to the result
  7325. * @param stride defines the stride size to use (distance between two positions in the positions array)
  7326. * @return minimum and maximum values
  7327. */
  7328. export function extractMinAndMax(positions: FloatArray, start: number, count: number, bias?: Nullable<Vector2>, stride?: number): {
  7329. minimum: Vector3;
  7330. maximum: Vector3;
  7331. };
  7332. }
  7333. declare module "babylonjs/Meshes/WebGL/webGLDataBuffer" {
  7334. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  7335. /** @hidden */
  7336. export class WebGLDataBuffer extends DataBuffer {
  7337. private _buffer;
  7338. constructor(resource: WebGLBuffer);
  7339. get underlyingResource(): any;
  7340. }
  7341. }
  7342. declare module "babylonjs/Engines/WebGL/webGLPipelineContext" {
  7343. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  7344. import { Nullable } from "babylonjs/types";
  7345. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  7346. /** @hidden */
  7347. export class WebGLPipelineContext implements IPipelineContext {
  7348. engine: ThinEngine;
  7349. program: Nullable<WebGLProgram>;
  7350. context?: WebGLRenderingContext;
  7351. vertexShader?: WebGLShader;
  7352. fragmentShader?: WebGLShader;
  7353. isParallelCompiled: boolean;
  7354. onCompiled?: () => void;
  7355. transformFeedback?: WebGLTransformFeedback | null;
  7356. vertexCompilationError: Nullable<string>;
  7357. fragmentCompilationError: Nullable<string>;
  7358. programLinkError: Nullable<string>;
  7359. programValidationError: Nullable<string>;
  7360. get isAsync(): boolean;
  7361. get isReady(): boolean;
  7362. _handlesSpectorRebuildCallback(onCompiled: (program: WebGLProgram) => void): void;
  7363. _getVertexShaderCode(): string | null;
  7364. _getFragmentShaderCode(): string | null;
  7365. }
  7366. }
  7367. declare module "babylonjs/Engines/Extensions/engine.uniformBuffer" {
  7368. import { FloatArray, Nullable } from "babylonjs/types";
  7369. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  7370. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  7371. module "babylonjs/Engines/thinEngine" {
  7372. interface ThinEngine {
  7373. /**
  7374. * Create an uniform buffer
  7375. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  7376. * @param elements defines the content of the uniform buffer
  7377. * @returns the webGL uniform buffer
  7378. */
  7379. createUniformBuffer(elements: FloatArray): DataBuffer;
  7380. /**
  7381. * Create a dynamic uniform buffer
  7382. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  7383. * @param elements defines the content of the uniform buffer
  7384. * @returns the webGL uniform buffer
  7385. */
  7386. createDynamicUniformBuffer(elements: FloatArray): DataBuffer;
  7387. /**
  7388. * Update an existing uniform buffer
  7389. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  7390. * @param uniformBuffer defines the target uniform buffer
  7391. * @param elements defines the content to update
  7392. * @param offset defines the offset in the uniform buffer where update should start
  7393. * @param count defines the size of the data to update
  7394. */
  7395. updateUniformBuffer(uniformBuffer: DataBuffer, elements: FloatArray, offset?: number, count?: number): void;
  7396. /**
  7397. * Bind an uniform buffer to the current webGL context
  7398. * @param buffer defines the buffer to bind
  7399. */
  7400. bindUniformBuffer(buffer: Nullable<DataBuffer>): void;
  7401. /**
  7402. * Bind a buffer to the current webGL context at a given location
  7403. * @param buffer defines the buffer to bind
  7404. * @param location defines the index where to bind the buffer
  7405. */
  7406. bindUniformBufferBase(buffer: DataBuffer, location: number): void;
  7407. /**
  7408. * Bind a specific block at a given index in a specific shader program
  7409. * @param pipelineContext defines the pipeline context to use
  7410. * @param blockName defines the block name
  7411. * @param index defines the index where to bind the block
  7412. */
  7413. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  7414. }
  7415. }
  7416. }
  7417. declare module "babylonjs/Materials/uniformBuffer" {
  7418. import { Nullable, FloatArray } from "babylonjs/types";
  7419. import { Matrix, Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  7420. import { Engine } from "babylonjs/Engines/engine";
  7421. import { Effect } from "babylonjs/Materials/effect";
  7422. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  7423. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  7424. import { Color3 } from "babylonjs/Maths/math.color";
  7425. import "babylonjs/Engines/Extensions/engine.uniformBuffer";
  7426. /**
  7427. * Uniform buffer objects.
  7428. *
  7429. * Handles blocks of uniform on the GPU.
  7430. *
  7431. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  7432. *
  7433. * For more information, please refer to :
  7434. * https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  7435. */
  7436. export class UniformBuffer {
  7437. private _engine;
  7438. private _buffer;
  7439. private _data;
  7440. private _bufferData;
  7441. private _dynamic?;
  7442. private _uniformLocations;
  7443. private _uniformSizes;
  7444. private _uniformLocationPointer;
  7445. private _needSync;
  7446. private _noUBO;
  7447. private _currentEffect;
  7448. /** @hidden */
  7449. _alreadyBound: boolean;
  7450. private static _MAX_UNIFORM_SIZE;
  7451. private static _tempBuffer;
  7452. /**
  7453. * Lambda to Update a 3x3 Matrix in a uniform buffer.
  7454. * This is dynamic to allow compat with webgl 1 and 2.
  7455. * You will need to pass the name of the uniform as well as the value.
  7456. */
  7457. updateMatrix3x3: (name: string, matrix: Float32Array) => void;
  7458. /**
  7459. * Lambda to Update a 2x2 Matrix in a uniform buffer.
  7460. * This is dynamic to allow compat with webgl 1 and 2.
  7461. * You will need to pass the name of the uniform as well as the value.
  7462. */
  7463. updateMatrix2x2: (name: string, matrix: Float32Array) => void;
  7464. /**
  7465. * Lambda to Update a single float in a uniform buffer.
  7466. * This is dynamic to allow compat with webgl 1 and 2.
  7467. * You will need to pass the name of the uniform as well as the value.
  7468. */
  7469. updateFloat: (name: string, x: number) => void;
  7470. /**
  7471. * Lambda to Update a vec2 of float in a uniform buffer.
  7472. * This is dynamic to allow compat with webgl 1 and 2.
  7473. * You will need to pass the name of the uniform as well as the value.
  7474. */
  7475. updateFloat2: (name: string, x: number, y: number, suffix?: string) => void;
  7476. /**
  7477. * Lambda to Update a vec3 of float in a uniform buffer.
  7478. * This is dynamic to allow compat with webgl 1 and 2.
  7479. * You will need to pass the name of the uniform as well as the value.
  7480. */
  7481. updateFloat3: (name: string, x: number, y: number, z: number, suffix?: string) => void;
  7482. /**
  7483. * Lambda to Update a vec4 of float in a uniform buffer.
  7484. * This is dynamic to allow compat with webgl 1 and 2.
  7485. * You will need to pass the name of the uniform as well as the value.
  7486. */
  7487. updateFloat4: (name: string, x: number, y: number, z: number, w: number, suffix?: string) => void;
  7488. /**
  7489. * Lambda to Update a 4x4 Matrix in a uniform buffer.
  7490. * This is dynamic to allow compat with webgl 1 and 2.
  7491. * You will need to pass the name of the uniform as well as the value.
  7492. */
  7493. updateMatrix: (name: string, mat: Matrix) => void;
  7494. /**
  7495. * Lambda to Update vec3 of float from a Vector in a uniform buffer.
  7496. * This is dynamic to allow compat with webgl 1 and 2.
  7497. * You will need to pass the name of the uniform as well as the value.
  7498. */
  7499. updateVector3: (name: string, vector: Vector3) => void;
  7500. /**
  7501. * Lambda to Update vec4 of float from a Vector in a uniform buffer.
  7502. * This is dynamic to allow compat with webgl 1 and 2.
  7503. * You will need to pass the name of the uniform as well as the value.
  7504. */
  7505. updateVector4: (name: string, vector: Vector4) => void;
  7506. /**
  7507. * Lambda to Update vec3 of float from a Color in a uniform buffer.
  7508. * This is dynamic to allow compat with webgl 1 and 2.
  7509. * You will need to pass the name of the uniform as well as the value.
  7510. */
  7511. updateColor3: (name: string, color: Color3, suffix?: string) => void;
  7512. /**
  7513. * Lambda to Update vec4 of float from a Color in a uniform buffer.
  7514. * This is dynamic to allow compat with webgl 1 and 2.
  7515. * You will need to pass the name of the uniform as well as the value.
  7516. */
  7517. updateColor4: (name: string, color: Color3, alpha: number, suffix?: string) => void;
  7518. /**
  7519. * Instantiates a new Uniform buffer objects.
  7520. *
  7521. * Handles blocks of uniform on the GPU.
  7522. *
  7523. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  7524. *
  7525. * For more information, please refer to :
  7526. * @see https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  7527. * @param engine Define the engine the buffer is associated with
  7528. * @param data Define the data contained in the buffer
  7529. * @param dynamic Define if the buffer is updatable
  7530. */
  7531. constructor(engine: Engine, data?: number[], dynamic?: boolean);
  7532. /**
  7533. * Indicates if the buffer is using the WebGL2 UBO implementation,
  7534. * or just falling back on setUniformXXX calls.
  7535. */
  7536. get useUbo(): boolean;
  7537. /**
  7538. * Indicates if the WebGL underlying uniform buffer is in sync
  7539. * with the javascript cache data.
  7540. */
  7541. get isSync(): boolean;
  7542. /**
  7543. * Indicates if the WebGL underlying uniform buffer is dynamic.
  7544. * Also, a dynamic UniformBuffer will disable cache verification and always
  7545. * update the underlying WebGL uniform buffer to the GPU.
  7546. * @returns if Dynamic, otherwise false
  7547. */
  7548. isDynamic(): boolean;
  7549. /**
  7550. * The data cache on JS side.
  7551. * @returns the underlying data as a float array
  7552. */
  7553. getData(): Float32Array;
  7554. /**
  7555. * The underlying WebGL Uniform buffer.
  7556. * @returns the webgl buffer
  7557. */
  7558. getBuffer(): Nullable<DataBuffer>;
  7559. /**
  7560. * std140 layout specifies how to align data within an UBO structure.
  7561. * See https://khronos.org/registry/OpenGL/specs/gl/glspec45.core.pdf#page=159
  7562. * for specs.
  7563. */
  7564. private _fillAlignment;
  7565. /**
  7566. * Adds an uniform in the buffer.
  7567. * Warning : the subsequents calls of this function must be in the same order as declared in the shader
  7568. * for the layout to be correct !
  7569. * @param name Name of the uniform, as used in the uniform block in the shader.
  7570. * @param size Data size, or data directly.
  7571. */
  7572. addUniform(name: string, size: number | number[]): void;
  7573. /**
  7574. * Adds a Matrix 4x4 to the uniform buffer.
  7575. * @param name Name of the uniform, as used in the uniform block in the shader.
  7576. * @param mat A 4x4 matrix.
  7577. */
  7578. addMatrix(name: string, mat: Matrix): void;
  7579. /**
  7580. * Adds a vec2 to the uniform buffer.
  7581. * @param name Name of the uniform, as used in the uniform block in the shader.
  7582. * @param x Define the x component value of the vec2
  7583. * @param y Define the y component value of the vec2
  7584. */
  7585. addFloat2(name: string, x: number, y: number): void;
  7586. /**
  7587. * Adds a vec3 to the uniform buffer.
  7588. * @param name Name of the uniform, as used in the uniform block in the shader.
  7589. * @param x Define the x component value of the vec3
  7590. * @param y Define the y component value of the vec3
  7591. * @param z Define the z component value of the vec3
  7592. */
  7593. addFloat3(name: string, x: number, y: number, z: number): void;
  7594. /**
  7595. * Adds a vec3 to the uniform buffer.
  7596. * @param name Name of the uniform, as used in the uniform block in the shader.
  7597. * @param color Define the vec3 from a Color
  7598. */
  7599. addColor3(name: string, color: Color3): void;
  7600. /**
  7601. * Adds a vec4 to the uniform buffer.
  7602. * @param name Name of the uniform, as used in the uniform block in the shader.
  7603. * @param color Define the rgb components from a Color
  7604. * @param alpha Define the a component of the vec4
  7605. */
  7606. addColor4(name: string, color: Color3, alpha: number): void;
  7607. /**
  7608. * Adds a vec3 to the uniform buffer.
  7609. * @param name Name of the uniform, as used in the uniform block in the shader.
  7610. * @param vector Define the vec3 components from a Vector
  7611. */
  7612. addVector3(name: string, vector: Vector3): void;
  7613. /**
  7614. * Adds a Matrix 3x3 to the uniform buffer.
  7615. * @param name Name of the uniform, as used in the uniform block in the shader.
  7616. */
  7617. addMatrix3x3(name: string): void;
  7618. /**
  7619. * Adds a Matrix 2x2 to the uniform buffer.
  7620. * @param name Name of the uniform, as used in the uniform block in the shader.
  7621. */
  7622. addMatrix2x2(name: string): void;
  7623. /**
  7624. * Effectively creates the WebGL Uniform Buffer, once layout is completed with `addUniform`.
  7625. */
  7626. create(): void;
  7627. /** @hidden */
  7628. _rebuild(): void;
  7629. /**
  7630. * Updates the WebGL Uniform Buffer on the GPU.
  7631. * If the `dynamic` flag is set to true, no cache comparison is done.
  7632. * Otherwise, the buffer will be updated only if the cache differs.
  7633. */
  7634. update(): void;
  7635. /**
  7636. * Updates the value of an uniform. The `update` method must be called afterwards to make it effective in the GPU.
  7637. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  7638. * @param data Define the flattened data
  7639. * @param size Define the size of the data.
  7640. */
  7641. updateUniform(uniformName: string, data: FloatArray, size: number): void;
  7642. private _valueCache;
  7643. private _cacheMatrix;
  7644. private _updateMatrix3x3ForUniform;
  7645. private _updateMatrix3x3ForEffect;
  7646. private _updateMatrix2x2ForEffect;
  7647. private _updateMatrix2x2ForUniform;
  7648. private _updateFloatForEffect;
  7649. private _updateFloatForUniform;
  7650. private _updateFloat2ForEffect;
  7651. private _updateFloat2ForUniform;
  7652. private _updateFloat3ForEffect;
  7653. private _updateFloat3ForUniform;
  7654. private _updateFloat4ForEffect;
  7655. private _updateFloat4ForUniform;
  7656. private _updateMatrixForEffect;
  7657. private _updateMatrixForUniform;
  7658. private _updateVector3ForEffect;
  7659. private _updateVector3ForUniform;
  7660. private _updateVector4ForEffect;
  7661. private _updateVector4ForUniform;
  7662. private _updateColor3ForEffect;
  7663. private _updateColor3ForUniform;
  7664. private _updateColor4ForEffect;
  7665. private _updateColor4ForUniform;
  7666. /**
  7667. * Sets a sampler uniform on the effect.
  7668. * @param name Define the name of the sampler.
  7669. * @param texture Define the texture to set in the sampler
  7670. */
  7671. setTexture(name: string, texture: Nullable<BaseTexture>): void;
  7672. /**
  7673. * Directly updates the value of the uniform in the cache AND on the GPU.
  7674. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  7675. * @param data Define the flattened data
  7676. */
  7677. updateUniformDirectly(uniformName: string, data: FloatArray): void;
  7678. /**
  7679. * Binds this uniform buffer to an effect.
  7680. * @param effect Define the effect to bind the buffer to
  7681. * @param name Name of the uniform block in the shader.
  7682. */
  7683. bindToEffect(effect: Effect, name: string): void;
  7684. /**
  7685. * Disposes the uniform buffer.
  7686. */
  7687. dispose(): void;
  7688. }
  7689. }
  7690. declare module "babylonjs/Misc/iInspectable" {
  7691. /**
  7692. * Enum that determines the text-wrapping mode to use.
  7693. */
  7694. export enum InspectableType {
  7695. /**
  7696. * Checkbox for booleans
  7697. */
  7698. Checkbox = 0,
  7699. /**
  7700. * Sliders for numbers
  7701. */
  7702. Slider = 1,
  7703. /**
  7704. * Vector3
  7705. */
  7706. Vector3 = 2,
  7707. /**
  7708. * Quaternions
  7709. */
  7710. Quaternion = 3,
  7711. /**
  7712. * Color3
  7713. */
  7714. Color3 = 4,
  7715. /**
  7716. * String
  7717. */
  7718. String = 5
  7719. }
  7720. /**
  7721. * Interface used to define custom inspectable properties.
  7722. * This interface is used by the inspector to display custom property grids
  7723. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  7724. */
  7725. export interface IInspectable {
  7726. /**
  7727. * Gets the label to display
  7728. */
  7729. label: string;
  7730. /**
  7731. * Gets the name of the property to edit
  7732. */
  7733. propertyName: string;
  7734. /**
  7735. * Gets the type of the editor to use
  7736. */
  7737. type: InspectableType;
  7738. /**
  7739. * Gets the minimum value of the property when using in "slider" mode
  7740. */
  7741. min?: number;
  7742. /**
  7743. * Gets the maximum value of the property when using in "slider" mode
  7744. */
  7745. max?: number;
  7746. /**
  7747. * Gets the setp to use when using in "slider" mode
  7748. */
  7749. step?: number;
  7750. }
  7751. }
  7752. declare module "babylonjs/Misc/timingTools" {
  7753. /**
  7754. * Class used to provide helper for timing
  7755. */
  7756. export class TimingTools {
  7757. /**
  7758. * Polyfill for setImmediate
  7759. * @param action defines the action to execute after the current execution block
  7760. */
  7761. static SetImmediate(action: () => void): void;
  7762. }
  7763. }
  7764. declare module "babylonjs/Misc/instantiationTools" {
  7765. /**
  7766. * Class used to enable instatition of objects by class name
  7767. */
  7768. export class InstantiationTools {
  7769. /**
  7770. * Use this object to register external classes like custom textures or material
  7771. * to allow the laoders to instantiate them
  7772. */
  7773. static RegisteredExternalClasses: {
  7774. [key: string]: Object;
  7775. };
  7776. /**
  7777. * Tries to instantiate a new object from a given class name
  7778. * @param className defines the class name to instantiate
  7779. * @returns the new object or null if the system was not able to do the instantiation
  7780. */
  7781. static Instantiate(className: string): any;
  7782. }
  7783. }
  7784. declare module "babylonjs/Engines/depthTextureCreationOptions" {
  7785. /**
  7786. * Define options used to create a depth texture
  7787. */
  7788. export class DepthTextureCreationOptions {
  7789. /** Specifies whether or not a stencil should be allocated in the texture */
  7790. generateStencil?: boolean;
  7791. /** Specifies whether or not bilinear filtering is enable on the texture */
  7792. bilinearFiltering?: boolean;
  7793. /** Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode */
  7794. comparisonFunction?: number;
  7795. /** Specifies if the created texture is a cube texture */
  7796. isCube?: boolean;
  7797. }
  7798. }
  7799. declare module "babylonjs/Engines/Extensions/engine.cubeTexture" {
  7800. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  7801. import { Nullable } from "babylonjs/types";
  7802. import { Scene } from "babylonjs/scene";
  7803. import { DepthTextureCreationOptions } from "babylonjs/Engines/depthTextureCreationOptions";
  7804. module "babylonjs/Engines/thinEngine" {
  7805. interface ThinEngine {
  7806. /**
  7807. * Creates a depth stencil cube texture.
  7808. * This is only available in WebGL 2.
  7809. * @param size The size of face edge in the cube texture.
  7810. * @param options The options defining the cube texture.
  7811. * @returns The cube texture
  7812. */
  7813. _createDepthStencilCubeTexture(size: number, options: DepthTextureCreationOptions): InternalTexture;
  7814. /**
  7815. * Creates a cube texture
  7816. * @param rootUrl defines the url where the files to load is located
  7817. * @param scene defines the current scene
  7818. * @param files defines the list of files to load (1 per face)
  7819. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  7820. * @param onLoad defines an optional callback raised when the texture is loaded
  7821. * @param onError defines an optional callback raised if there is an issue to load the texture
  7822. * @param format defines the format of the data
  7823. * @param forcedExtension defines the extension to use to pick the right loader
  7824. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  7825. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  7826. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  7827. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  7828. * @returns the cube texture as an InternalTexture
  7829. */
  7830. createCubeTexture(rootUrl: string, scene: Nullable<Scene>, files: Nullable<string[]>, noMipmap: boolean | undefined, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>, format: number | undefined, forcedExtension: any, createPolynomials: boolean, lodScale: number, lodOffset: number, fallback: Nullable<InternalTexture>): InternalTexture;
  7831. /**
  7832. * Creates a cube texture
  7833. * @param rootUrl defines the url where the files to load is located
  7834. * @param scene defines the current scene
  7835. * @param files defines the list of files to load (1 per face)
  7836. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  7837. * @param onLoad defines an optional callback raised when the texture is loaded
  7838. * @param onError defines an optional callback raised if there is an issue to load the texture
  7839. * @param format defines the format of the data
  7840. * @param forcedExtension defines the extension to use to pick the right loader
  7841. * @returns the cube texture as an InternalTexture
  7842. */
  7843. createCubeTexture(rootUrl: string, scene: Nullable<Scene>, files: Nullable<string[]>, noMipmap: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>, format: number | undefined, forcedExtension: any): InternalTexture;
  7844. /**
  7845. * Creates a cube texture
  7846. * @param rootUrl defines the url where the files to load is located
  7847. * @param scene defines the current scene
  7848. * @param files defines the list of files to load (1 per face)
  7849. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  7850. * @param onLoad defines an optional callback raised when the texture is loaded
  7851. * @param onError defines an optional callback raised if there is an issue to load the texture
  7852. * @param format defines the format of the data
  7853. * @param forcedExtension defines the extension to use to pick the right loader
  7854. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  7855. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  7856. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  7857. * @returns the cube texture as an InternalTexture
  7858. */
  7859. createCubeTexture(rootUrl: string, scene: Nullable<Scene>, files: Nullable<string[]>, noMipmap: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>, format: number | undefined, forcedExtension: any, createPolynomials: boolean, lodScale: number, lodOffset: number): InternalTexture;
  7860. /** @hidden */
  7861. _partialLoadFile(url: string, index: number, loadedFiles: ArrayBuffer[], onfinish: (files: ArrayBuffer[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>): void;
  7862. /** @hidden */
  7863. _cascadeLoadFiles(scene: Nullable<Scene>, onfinish: (images: ArrayBuffer[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>): void;
  7864. /** @hidden */
  7865. _cascadeLoadImgs(scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  7866. /** @hidden */
  7867. _partialLoadImg(url: string, index: number, loadedImages: HTMLImageElement[], scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  7868. /**
  7869. * @hidden
  7870. */
  7871. _setCubeMapTextureParams(loadMipmap: boolean): void;
  7872. }
  7873. }
  7874. }
  7875. declare module "babylonjs/Materials/Textures/cubeTexture" {
  7876. import { Nullable } from "babylonjs/types";
  7877. import { Scene } from "babylonjs/scene";
  7878. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  7879. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  7880. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  7881. import "babylonjs/Engines/Extensions/engine.cubeTexture";
  7882. import { Observable } from "babylonjs/Misc/observable";
  7883. /**
  7884. * Class for creating a cube texture
  7885. */
  7886. export class CubeTexture extends BaseTexture {
  7887. private _delayedOnLoad;
  7888. /**
  7889. * Observable triggered once the texture has been loaded.
  7890. */
  7891. onLoadObservable: Observable<CubeTexture>;
  7892. /**
  7893. * The url of the texture
  7894. */
  7895. url: string;
  7896. /**
  7897. * Gets or sets the center of the bounding box associated with the cube texture.
  7898. * It must define where the camera used to render the texture was set
  7899. * @see https://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  7900. */
  7901. boundingBoxPosition: Vector3;
  7902. private _boundingBoxSize;
  7903. /**
  7904. * Gets or sets the size of the bounding box associated with the cube texture
  7905. * When defined, the cubemap will switch to local mode
  7906. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  7907. * @example https://www.babylonjs-playground.com/#RNASML
  7908. */
  7909. set boundingBoxSize(value: Vector3);
  7910. /**
  7911. * Returns the bounding box size
  7912. * @see https://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  7913. */
  7914. get boundingBoxSize(): Vector3;
  7915. protected _rotationY: number;
  7916. /**
  7917. * Sets texture matrix rotation angle around Y axis in radians.
  7918. */
  7919. set rotationY(value: number);
  7920. /**
  7921. * Gets texture matrix rotation angle around Y axis radians.
  7922. */
  7923. get rotationY(): number;
  7924. /**
  7925. * Are mip maps generated for this texture or not.
  7926. */
  7927. get noMipmap(): boolean;
  7928. private _noMipmap;
  7929. private _files;
  7930. protected _forcedExtension: Nullable<string>;
  7931. private _extensions;
  7932. private _textureMatrix;
  7933. private _format;
  7934. private _createPolynomials;
  7935. /**
  7936. * Creates a cube texture from an array of image urls
  7937. * @param files defines an array of image urls
  7938. * @param scene defines the hosting scene
  7939. * @param noMipmap specifies if mip maps are not used
  7940. * @returns a cube texture
  7941. */
  7942. static CreateFromImages(files: string[], scene: Scene, noMipmap?: boolean): CubeTexture;
  7943. /**
  7944. * Creates and return a texture created from prefilterd data by tools like IBL Baker or Lys.
  7945. * @param url defines the url of the prefiltered texture
  7946. * @param scene defines the scene the texture is attached to
  7947. * @param forcedExtension defines the extension of the file if different from the url
  7948. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  7949. * @return the prefiltered texture
  7950. */
  7951. static CreateFromPrefilteredData(url: string, scene: Scene, forcedExtension?: any, createPolynomials?: boolean): CubeTexture;
  7952. /**
  7953. * Creates a cube texture to use with reflection for instance. It can be based upon dds or six images as well
  7954. * as prefiltered data.
  7955. * @param rootUrl defines the url of the texture or the root name of the six images
  7956. * @param null defines the scene or engine the texture is attached to
  7957. * @param extensions defines the suffixes add to the picture name in case six images are in use like _px.jpg...
  7958. * @param noMipmap defines if mipmaps should be created or not
  7959. * @param files defines the six files to load for the different faces in that order: px, py, pz, nx, ny, nz
  7960. * @param onLoad defines a callback triggered at the end of the file load if no errors occured
  7961. * @param onError defines a callback triggered in case of error during load
  7962. * @param format defines the internal format to use for the texture once loaded
  7963. * @param prefiltered defines whether or not the texture is created from prefiltered data
  7964. * @param forcedExtension defines the extensions to use (force a special type of file to load) in case it is different from the file name
  7965. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  7966. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  7967. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  7968. * @return the cube texture
  7969. */
  7970. constructor(rootUrl: string, sceneOrEngine: Scene | ThinEngine, extensions?: Nullable<string[]>, noMipmap?: boolean, files?: Nullable<string[]>, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>, format?: number, prefiltered?: boolean, forcedExtension?: any, createPolynomials?: boolean, lodScale?: number, lodOffset?: number);
  7971. /**
  7972. * Get the current class name of the texture useful for serialization or dynamic coding.
  7973. * @returns "CubeTexture"
  7974. */
  7975. getClassName(): string;
  7976. /**
  7977. * Update the url (and optional buffer) of this texture if url was null during construction.
  7978. * @param url the url of the texture
  7979. * @param forcedExtension defines the extension to use
  7980. * @param onLoad callback called when the texture is loaded (defaults to null)
  7981. * @param prefiltered Defines whether the updated texture is prefiltered or not
  7982. */
  7983. updateURL(url: string, forcedExtension?: string, onLoad?: () => void, prefiltered?: boolean): void;
  7984. /**
  7985. * Delays loading of the cube texture
  7986. * @param forcedExtension defines the extension to use
  7987. */
  7988. delayLoad(forcedExtension?: string): void;
  7989. /**
  7990. * Returns the reflection texture matrix
  7991. * @returns the reflection texture matrix
  7992. */
  7993. getReflectionTextureMatrix(): Matrix;
  7994. /**
  7995. * Sets the reflection texture matrix
  7996. * @param value Reflection texture matrix
  7997. */
  7998. setReflectionTextureMatrix(value: Matrix): void;
  7999. /**
  8000. * Parses text to create a cube texture
  8001. * @param parsedTexture define the serialized text to read from
  8002. * @param scene defines the hosting scene
  8003. * @param rootUrl defines the root url of the cube texture
  8004. * @returns a cube texture
  8005. */
  8006. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): CubeTexture;
  8007. /**
  8008. * Makes a clone, or deep copy, of the cube texture
  8009. * @returns a new cube texture
  8010. */
  8011. clone(): CubeTexture;
  8012. }
  8013. }
  8014. declare module "babylonjs/Materials/materialDefines" {
  8015. /**
  8016. * Manages the defines for the Material
  8017. */
  8018. export class MaterialDefines {
  8019. /** @hidden */
  8020. protected _keys: string[];
  8021. private _isDirty;
  8022. /** @hidden */
  8023. _renderId: number;
  8024. /** @hidden */
  8025. _areLightsDirty: boolean;
  8026. /** @hidden */
  8027. _areLightsDisposed: boolean;
  8028. /** @hidden */
  8029. _areAttributesDirty: boolean;
  8030. /** @hidden */
  8031. _areTexturesDirty: boolean;
  8032. /** @hidden */
  8033. _areFresnelDirty: boolean;
  8034. /** @hidden */
  8035. _areMiscDirty: boolean;
  8036. /** @hidden */
  8037. _areImageProcessingDirty: boolean;
  8038. /** @hidden */
  8039. _normals: boolean;
  8040. /** @hidden */
  8041. _uvs: boolean;
  8042. /** @hidden */
  8043. _needNormals: boolean;
  8044. /** @hidden */
  8045. _needUVs: boolean;
  8046. [id: string]: any;
  8047. /**
  8048. * Specifies if the material needs to be re-calculated
  8049. */
  8050. get isDirty(): boolean;
  8051. /**
  8052. * Marks the material to indicate that it has been re-calculated
  8053. */
  8054. markAsProcessed(): void;
  8055. /**
  8056. * Marks the material to indicate that it needs to be re-calculated
  8057. */
  8058. markAsUnprocessed(): void;
  8059. /**
  8060. * Marks the material to indicate all of its defines need to be re-calculated
  8061. */
  8062. markAllAsDirty(): void;
  8063. /**
  8064. * Marks the material to indicate that image processing needs to be re-calculated
  8065. */
  8066. markAsImageProcessingDirty(): void;
  8067. /**
  8068. * Marks the material to indicate the lights need to be re-calculated
  8069. * @param disposed Defines whether the light is dirty due to dispose or not
  8070. */
  8071. markAsLightDirty(disposed?: boolean): void;
  8072. /**
  8073. * Marks the attribute state as changed
  8074. */
  8075. markAsAttributesDirty(): void;
  8076. /**
  8077. * Marks the texture state as changed
  8078. */
  8079. markAsTexturesDirty(): void;
  8080. /**
  8081. * Marks the fresnel state as changed
  8082. */
  8083. markAsFresnelDirty(): void;
  8084. /**
  8085. * Marks the misc state as changed
  8086. */
  8087. markAsMiscDirty(): void;
  8088. /**
  8089. * Rebuilds the material defines
  8090. */
  8091. rebuild(): void;
  8092. /**
  8093. * Specifies if two material defines are equal
  8094. * @param other - A material define instance to compare to
  8095. * @returns - Boolean indicating if the material defines are equal (true) or not (false)
  8096. */
  8097. isEqual(other: MaterialDefines): boolean;
  8098. /**
  8099. * Clones this instance's defines to another instance
  8100. * @param other - material defines to clone values to
  8101. */
  8102. cloneTo(other: MaterialDefines): void;
  8103. /**
  8104. * Resets the material define values
  8105. */
  8106. reset(): void;
  8107. /**
  8108. * Converts the material define values to a string
  8109. * @returns - String of material define information
  8110. */
  8111. toString(): string;
  8112. }
  8113. }
  8114. declare module "babylonjs/Materials/colorCurves" {
  8115. import { Effect } from "babylonjs/Materials/effect";
  8116. /**
  8117. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  8118. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  8119. * These are similar to controls found in many professional imaging or colorist software. The global controls are applied to the entire image. For advanced tuning, extra controls are provided to adjust the shadow, midtone and highlight areas of the image;
  8120. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  8121. */
  8122. export class ColorCurves {
  8123. private _dirty;
  8124. private _tempColor;
  8125. private _globalCurve;
  8126. private _highlightsCurve;
  8127. private _midtonesCurve;
  8128. private _shadowsCurve;
  8129. private _positiveCurve;
  8130. private _negativeCurve;
  8131. private _globalHue;
  8132. private _globalDensity;
  8133. private _globalSaturation;
  8134. private _globalExposure;
  8135. /**
  8136. * Gets the global Hue value.
  8137. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  8138. */
  8139. get globalHue(): number;
  8140. /**
  8141. * Sets the global Hue value.
  8142. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  8143. */
  8144. set globalHue(value: number);
  8145. /**
  8146. * Gets the global Density value.
  8147. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  8148. * Values less than zero provide a filter of opposite hue.
  8149. */
  8150. get globalDensity(): number;
  8151. /**
  8152. * Sets the global Density value.
  8153. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  8154. * Values less than zero provide a filter of opposite hue.
  8155. */
  8156. set globalDensity(value: number);
  8157. /**
  8158. * Gets the global Saturation value.
  8159. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  8160. */
  8161. get globalSaturation(): number;
  8162. /**
  8163. * Sets the global Saturation value.
  8164. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  8165. */
  8166. set globalSaturation(value: number);
  8167. /**
  8168. * Gets the global Exposure value.
  8169. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  8170. */
  8171. get globalExposure(): number;
  8172. /**
  8173. * Sets the global Exposure value.
  8174. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  8175. */
  8176. set globalExposure(value: number);
  8177. private _highlightsHue;
  8178. private _highlightsDensity;
  8179. private _highlightsSaturation;
  8180. private _highlightsExposure;
  8181. /**
  8182. * Gets the highlights Hue value.
  8183. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  8184. */
  8185. get highlightsHue(): number;
  8186. /**
  8187. * Sets the highlights Hue value.
  8188. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  8189. */
  8190. set highlightsHue(value: number);
  8191. /**
  8192. * Gets the highlights Density value.
  8193. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  8194. * Values less than zero provide a filter of opposite hue.
  8195. */
  8196. get highlightsDensity(): number;
  8197. /**
  8198. * Sets the highlights Density value.
  8199. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  8200. * Values less than zero provide a filter of opposite hue.
  8201. */
  8202. set highlightsDensity(value: number);
  8203. /**
  8204. * Gets the highlights Saturation value.
  8205. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  8206. */
  8207. get highlightsSaturation(): number;
  8208. /**
  8209. * Sets the highlights Saturation value.
  8210. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  8211. */
  8212. set highlightsSaturation(value: number);
  8213. /**
  8214. * Gets the highlights Exposure value.
  8215. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  8216. */
  8217. get highlightsExposure(): number;
  8218. /**
  8219. * Sets the highlights Exposure value.
  8220. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  8221. */
  8222. set highlightsExposure(value: number);
  8223. private _midtonesHue;
  8224. private _midtonesDensity;
  8225. private _midtonesSaturation;
  8226. private _midtonesExposure;
  8227. /**
  8228. * Gets the midtones Hue value.
  8229. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  8230. */
  8231. get midtonesHue(): number;
  8232. /**
  8233. * Sets the midtones Hue value.
  8234. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  8235. */
  8236. set midtonesHue(value: number);
  8237. /**
  8238. * Gets the midtones Density value.
  8239. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  8240. * Values less than zero provide a filter of opposite hue.
  8241. */
  8242. get midtonesDensity(): number;
  8243. /**
  8244. * Sets the midtones Density value.
  8245. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  8246. * Values less than zero provide a filter of opposite hue.
  8247. */
  8248. set midtonesDensity(value: number);
  8249. /**
  8250. * Gets the midtones Saturation value.
  8251. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  8252. */
  8253. get midtonesSaturation(): number;
  8254. /**
  8255. * Sets the midtones Saturation value.
  8256. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  8257. */
  8258. set midtonesSaturation(value: number);
  8259. /**
  8260. * Gets the midtones Exposure value.
  8261. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  8262. */
  8263. get midtonesExposure(): number;
  8264. /**
  8265. * Sets the midtones Exposure value.
  8266. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  8267. */
  8268. set midtonesExposure(value: number);
  8269. private _shadowsHue;
  8270. private _shadowsDensity;
  8271. private _shadowsSaturation;
  8272. private _shadowsExposure;
  8273. /**
  8274. * Gets the shadows Hue value.
  8275. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  8276. */
  8277. get shadowsHue(): number;
  8278. /**
  8279. * Sets the shadows Hue value.
  8280. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  8281. */
  8282. set shadowsHue(value: number);
  8283. /**
  8284. * Gets the shadows Density value.
  8285. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  8286. * Values less than zero provide a filter of opposite hue.
  8287. */
  8288. get shadowsDensity(): number;
  8289. /**
  8290. * Sets the shadows Density value.
  8291. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  8292. * Values less than zero provide a filter of opposite hue.
  8293. */
  8294. set shadowsDensity(value: number);
  8295. /**
  8296. * Gets the shadows Saturation value.
  8297. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  8298. */
  8299. get shadowsSaturation(): number;
  8300. /**
  8301. * Sets the shadows Saturation value.
  8302. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  8303. */
  8304. set shadowsSaturation(value: number);
  8305. /**
  8306. * Gets the shadows Exposure value.
  8307. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  8308. */
  8309. get shadowsExposure(): number;
  8310. /**
  8311. * Sets the shadows Exposure value.
  8312. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  8313. */
  8314. set shadowsExposure(value: number);
  8315. /**
  8316. * Returns the class name
  8317. * @returns The class name
  8318. */
  8319. getClassName(): string;
  8320. /**
  8321. * Binds the color curves to the shader.
  8322. * @param colorCurves The color curve to bind
  8323. * @param effect The effect to bind to
  8324. * @param positiveUniform The positive uniform shader parameter
  8325. * @param neutralUniform The neutral uniform shader parameter
  8326. * @param negativeUniform The negative uniform shader parameter
  8327. */
  8328. static Bind(colorCurves: ColorCurves, effect: Effect, positiveUniform?: string, neutralUniform?: string, negativeUniform?: string): void;
  8329. /**
  8330. * Prepare the list of uniforms associated with the ColorCurves effects.
  8331. * @param uniformsList The list of uniforms used in the effect
  8332. */
  8333. static PrepareUniforms(uniformsList: string[]): void;
  8334. /**
  8335. * Returns color grading data based on a hue, density, saturation and exposure value.
  8336. * @param filterHue The hue of the color filter.
  8337. * @param filterDensity The density of the color filter.
  8338. * @param saturation The saturation.
  8339. * @param exposure The exposure.
  8340. * @param result The result data container.
  8341. */
  8342. private getColorGradingDataToRef;
  8343. /**
  8344. * Takes an input slider value and returns an adjusted value that provides extra control near the centre.
  8345. * @param value The input slider value in range [-100,100].
  8346. * @returns Adjusted value.
  8347. */
  8348. private static applyColorGradingSliderNonlinear;
  8349. /**
  8350. * Returns an RGBA Color4 based on Hue, Saturation and Brightness (also referred to as value, HSV).
  8351. * @param hue The hue (H) input.
  8352. * @param saturation The saturation (S) input.
  8353. * @param brightness The brightness (B) input.
  8354. * @result An RGBA color represented as Vector4.
  8355. */
  8356. private static fromHSBToRef;
  8357. /**
  8358. * Returns a value clamped between min and max
  8359. * @param value The value to clamp
  8360. * @param min The minimum of value
  8361. * @param max The maximum of value
  8362. * @returns The clamped value.
  8363. */
  8364. private static clamp;
  8365. /**
  8366. * Clones the current color curve instance.
  8367. * @return The cloned curves
  8368. */
  8369. clone(): ColorCurves;
  8370. /**
  8371. * Serializes the current color curve instance to a json representation.
  8372. * @return a JSON representation
  8373. */
  8374. serialize(): any;
  8375. /**
  8376. * Parses the color curve from a json representation.
  8377. * @param source the JSON source to parse
  8378. * @return The parsed curves
  8379. */
  8380. static Parse(source: any): ColorCurves;
  8381. }
  8382. }
  8383. declare module "babylonjs/Materials/imageProcessingConfiguration" {
  8384. import { Observable } from "babylonjs/Misc/observable";
  8385. import { Nullable } from "babylonjs/types";
  8386. import { Color4 } from "babylonjs/Maths/math.color";
  8387. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  8388. import { Effect } from "babylonjs/Materials/effect";
  8389. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  8390. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  8391. /**
  8392. * Interface to follow in your material defines to integrate easily the
  8393. * Image proccessing functions.
  8394. * @hidden
  8395. */
  8396. export interface IImageProcessingConfigurationDefines {
  8397. IMAGEPROCESSING: boolean;
  8398. VIGNETTE: boolean;
  8399. VIGNETTEBLENDMODEMULTIPLY: boolean;
  8400. VIGNETTEBLENDMODEOPAQUE: boolean;
  8401. TONEMAPPING: boolean;
  8402. TONEMAPPING_ACES: boolean;
  8403. CONTRAST: boolean;
  8404. EXPOSURE: boolean;
  8405. COLORCURVES: boolean;
  8406. COLORGRADING: boolean;
  8407. COLORGRADING3D: boolean;
  8408. SAMPLER3DGREENDEPTH: boolean;
  8409. SAMPLER3DBGRMAP: boolean;
  8410. IMAGEPROCESSINGPOSTPROCESS: boolean;
  8411. }
  8412. /**
  8413. * @hidden
  8414. */
  8415. export class ImageProcessingConfigurationDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  8416. IMAGEPROCESSING: boolean;
  8417. VIGNETTE: boolean;
  8418. VIGNETTEBLENDMODEMULTIPLY: boolean;
  8419. VIGNETTEBLENDMODEOPAQUE: boolean;
  8420. TONEMAPPING: boolean;
  8421. TONEMAPPING_ACES: boolean;
  8422. CONTRAST: boolean;
  8423. COLORCURVES: boolean;
  8424. COLORGRADING: boolean;
  8425. COLORGRADING3D: boolean;
  8426. SAMPLER3DGREENDEPTH: boolean;
  8427. SAMPLER3DBGRMAP: boolean;
  8428. IMAGEPROCESSINGPOSTPROCESS: boolean;
  8429. EXPOSURE: boolean;
  8430. constructor();
  8431. }
  8432. /**
  8433. * This groups together the common properties used for image processing either in direct forward pass
  8434. * or through post processing effect depending on the use of the image processing pipeline in your scene
  8435. * or not.
  8436. */
  8437. export class ImageProcessingConfiguration {
  8438. /**
  8439. * Default tone mapping applied in BabylonJS.
  8440. */
  8441. static readonly TONEMAPPING_STANDARD: number;
  8442. /**
  8443. * ACES Tone mapping (used by default in unreal and unity). This can help getting closer
  8444. * to other engines rendering to increase portability.
  8445. */
  8446. static readonly TONEMAPPING_ACES: number;
  8447. /**
  8448. * Color curves setup used in the effect if colorCurvesEnabled is set to true
  8449. */
  8450. colorCurves: Nullable<ColorCurves>;
  8451. private _colorCurvesEnabled;
  8452. /**
  8453. * Gets wether the color curves effect is enabled.
  8454. */
  8455. get colorCurvesEnabled(): boolean;
  8456. /**
  8457. * Sets wether the color curves effect is enabled.
  8458. */
  8459. set colorCurvesEnabled(value: boolean);
  8460. private _colorGradingTexture;
  8461. /**
  8462. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  8463. */
  8464. get colorGradingTexture(): Nullable<BaseTexture>;
  8465. /**
  8466. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  8467. */
  8468. set colorGradingTexture(value: Nullable<BaseTexture>);
  8469. private _colorGradingEnabled;
  8470. /**
  8471. * Gets wether the color grading effect is enabled.
  8472. */
  8473. get colorGradingEnabled(): boolean;
  8474. /**
  8475. * Sets wether the color grading effect is enabled.
  8476. */
  8477. set colorGradingEnabled(value: boolean);
  8478. private _colorGradingWithGreenDepth;
  8479. /**
  8480. * Gets wether the color grading effect is using a green depth for the 3d Texture.
  8481. */
  8482. get colorGradingWithGreenDepth(): boolean;
  8483. /**
  8484. * Sets wether the color grading effect is using a green depth for the 3d Texture.
  8485. */
  8486. set colorGradingWithGreenDepth(value: boolean);
  8487. private _colorGradingBGR;
  8488. /**
  8489. * Gets wether the color grading texture contains BGR values.
  8490. */
  8491. get colorGradingBGR(): boolean;
  8492. /**
  8493. * Sets wether the color grading texture contains BGR values.
  8494. */
  8495. set colorGradingBGR(value: boolean);
  8496. /** @hidden */
  8497. _exposure: number;
  8498. /**
  8499. * Gets the Exposure used in the effect.
  8500. */
  8501. get exposure(): number;
  8502. /**
  8503. * Sets the Exposure used in the effect.
  8504. */
  8505. set exposure(value: number);
  8506. private _toneMappingEnabled;
  8507. /**
  8508. * Gets wether the tone mapping effect is enabled.
  8509. */
  8510. get toneMappingEnabled(): boolean;
  8511. /**
  8512. * Sets wether the tone mapping effect is enabled.
  8513. */
  8514. set toneMappingEnabled(value: boolean);
  8515. private _toneMappingType;
  8516. /**
  8517. * Gets the type of tone mapping effect.
  8518. */
  8519. get toneMappingType(): number;
  8520. /**
  8521. * Sets the type of tone mapping effect used in BabylonJS.
  8522. */
  8523. set toneMappingType(value: number);
  8524. protected _contrast: number;
  8525. /**
  8526. * Gets the contrast used in the effect.
  8527. */
  8528. get contrast(): number;
  8529. /**
  8530. * Sets the contrast used in the effect.
  8531. */
  8532. set contrast(value: number);
  8533. /**
  8534. * Vignette stretch size.
  8535. */
  8536. vignetteStretch: number;
  8537. /**
  8538. * Vignette centre X Offset.
  8539. */
  8540. vignetteCentreX: number;
  8541. /**
  8542. * Vignette centre Y Offset.
  8543. */
  8544. vignetteCentreY: number;
  8545. /**
  8546. * Vignette weight or intensity of the vignette effect.
  8547. */
  8548. vignetteWeight: number;
  8549. /**
  8550. * Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  8551. * if vignetteEnabled is set to true.
  8552. */
  8553. vignetteColor: Color4;
  8554. /**
  8555. * Camera field of view used by the Vignette effect.
  8556. */
  8557. vignetteCameraFov: number;
  8558. private _vignetteBlendMode;
  8559. /**
  8560. * Gets the vignette blend mode allowing different kind of effect.
  8561. */
  8562. get vignetteBlendMode(): number;
  8563. /**
  8564. * Sets the vignette blend mode allowing different kind of effect.
  8565. */
  8566. set vignetteBlendMode(value: number);
  8567. private _vignetteEnabled;
  8568. /**
  8569. * Gets wether the vignette effect is enabled.
  8570. */
  8571. get vignetteEnabled(): boolean;
  8572. /**
  8573. * Sets wether the vignette effect is enabled.
  8574. */
  8575. set vignetteEnabled(value: boolean);
  8576. private _applyByPostProcess;
  8577. /**
  8578. * Gets wether the image processing is applied through a post process or not.
  8579. */
  8580. get applyByPostProcess(): boolean;
  8581. /**
  8582. * Sets wether the image processing is applied through a post process or not.
  8583. */
  8584. set applyByPostProcess(value: boolean);
  8585. private _isEnabled;
  8586. /**
  8587. * Gets wether the image processing is enabled or not.
  8588. */
  8589. get isEnabled(): boolean;
  8590. /**
  8591. * Sets wether the image processing is enabled or not.
  8592. */
  8593. set isEnabled(value: boolean);
  8594. /**
  8595. * An event triggered when the configuration changes and requires Shader to Update some parameters.
  8596. */
  8597. onUpdateParameters: Observable<ImageProcessingConfiguration>;
  8598. /**
  8599. * Method called each time the image processing information changes requires to recompile the effect.
  8600. */
  8601. protected _updateParameters(): void;
  8602. /**
  8603. * Gets the current class name.
  8604. * @return "ImageProcessingConfiguration"
  8605. */
  8606. getClassName(): string;
  8607. /**
  8608. * Prepare the list of uniforms associated with the Image Processing effects.
  8609. * @param uniforms The list of uniforms used in the effect
  8610. * @param defines the list of defines currently in use
  8611. */
  8612. static PrepareUniforms(uniforms: string[], defines: IImageProcessingConfigurationDefines): void;
  8613. /**
  8614. * Prepare the list of samplers associated with the Image Processing effects.
  8615. * @param samplersList The list of uniforms used in the effect
  8616. * @param defines the list of defines currently in use
  8617. */
  8618. static PrepareSamplers(samplersList: string[], defines: IImageProcessingConfigurationDefines): void;
  8619. /**
  8620. * Prepare the list of defines associated to the shader.
  8621. * @param defines the list of defines to complete
  8622. * @param forPostProcess Define if we are currently in post process mode or not
  8623. */
  8624. prepareDefines(defines: IImageProcessingConfigurationDefines, forPostProcess?: boolean): void;
  8625. /**
  8626. * Returns true if all the image processing information are ready.
  8627. * @returns True if ready, otherwise, false
  8628. */
  8629. isReady(): boolean;
  8630. /**
  8631. * Binds the image processing to the shader.
  8632. * @param effect The effect to bind to
  8633. * @param overrideAspectRatio Override the aspect ratio of the effect
  8634. */
  8635. bind(effect: Effect, overrideAspectRatio?: number): void;
  8636. /**
  8637. * Clones the current image processing instance.
  8638. * @return The cloned image processing
  8639. */
  8640. clone(): ImageProcessingConfiguration;
  8641. /**
  8642. * Serializes the current image processing instance to a json representation.
  8643. * @return a JSON representation
  8644. */
  8645. serialize(): any;
  8646. /**
  8647. * Parses the image processing from a json representation.
  8648. * @param source the JSON source to parse
  8649. * @return The parsed image processing
  8650. */
  8651. static Parse(source: any): ImageProcessingConfiguration;
  8652. private static _VIGNETTEMODE_MULTIPLY;
  8653. private static _VIGNETTEMODE_OPAQUE;
  8654. /**
  8655. * Used to apply the vignette as a mix with the pixel color.
  8656. */
  8657. static get VIGNETTEMODE_MULTIPLY(): number;
  8658. /**
  8659. * Used to apply the vignette as a replacement of the pixel color.
  8660. */
  8661. static get VIGNETTEMODE_OPAQUE(): number;
  8662. }
  8663. }
  8664. declare module "babylonjs/Shaders/postprocess.vertex" {
  8665. /** @hidden */
  8666. export var postprocessVertexShader: {
  8667. name: string;
  8668. shader: string;
  8669. };
  8670. }
  8671. declare module "babylonjs/Engines/Extensions/engine.renderTarget" {
  8672. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  8673. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  8674. import { DepthTextureCreationOptions } from "babylonjs/Engines/depthTextureCreationOptions";
  8675. module "babylonjs/Engines/thinEngine" {
  8676. interface ThinEngine {
  8677. /**
  8678. * Creates a new render target texture
  8679. * @param size defines the size of the texture
  8680. * @param options defines the options used to create the texture
  8681. * @returns a new render target texture stored in an InternalTexture
  8682. */
  8683. createRenderTargetTexture(size: number | {
  8684. width: number;
  8685. height: number;
  8686. layers?: number;
  8687. }, options: boolean | RenderTargetCreationOptions): InternalTexture;
  8688. /**
  8689. * Creates a depth stencil texture.
  8690. * This is only available in WebGL 2 or with the depth texture extension available.
  8691. * @param size The size of face edge in the texture.
  8692. * @param options The options defining the texture.
  8693. * @returns The texture
  8694. */
  8695. createDepthStencilTexture(size: number | {
  8696. width: number;
  8697. height: number;
  8698. layers?: number;
  8699. }, options: DepthTextureCreationOptions): InternalTexture;
  8700. /** @hidden */
  8701. _createDepthStencilTexture(size: number | {
  8702. width: number;
  8703. height: number;
  8704. layers?: number;
  8705. }, options: DepthTextureCreationOptions): InternalTexture;
  8706. }
  8707. }
  8708. }
  8709. declare module "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes" {
  8710. /**
  8711. * Defines the kind of connection point for node based material
  8712. */
  8713. export enum NodeMaterialBlockConnectionPointTypes {
  8714. /** Float */
  8715. Float = 1,
  8716. /** Int */
  8717. Int = 2,
  8718. /** Vector2 */
  8719. Vector2 = 4,
  8720. /** Vector3 */
  8721. Vector3 = 8,
  8722. /** Vector4 */
  8723. Vector4 = 16,
  8724. /** Color3 */
  8725. Color3 = 32,
  8726. /** Color4 */
  8727. Color4 = 64,
  8728. /** Matrix */
  8729. Matrix = 128,
  8730. /** Custom object */
  8731. Object = 256,
  8732. /** Detect type based on connection */
  8733. AutoDetect = 1024,
  8734. /** Output type that will be defined by input type */
  8735. BasedOnInput = 2048
  8736. }
  8737. }
  8738. declare module "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets" {
  8739. /**
  8740. * Enum used to define the target of a block
  8741. */
  8742. export enum NodeMaterialBlockTargets {
  8743. /** Vertex shader */
  8744. Vertex = 1,
  8745. /** Fragment shader */
  8746. Fragment = 2,
  8747. /** Neutral */
  8748. Neutral = 4,
  8749. /** Vertex and Fragment */
  8750. VertexAndFragment = 3
  8751. }
  8752. }
  8753. declare module "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointMode" {
  8754. /**
  8755. * Enum defining the mode of a NodeMaterialBlockConnectionPoint
  8756. */
  8757. export enum NodeMaterialBlockConnectionPointMode {
  8758. /** Value is an uniform */
  8759. Uniform = 0,
  8760. /** Value is a mesh attribute */
  8761. Attribute = 1,
  8762. /** Value is a varying between vertex and fragment shaders */
  8763. Varying = 2,
  8764. /** Mode is undefined */
  8765. Undefined = 3
  8766. }
  8767. }
  8768. declare module "babylonjs/Materials/Node/Enums/nodeMaterialSystemValues" {
  8769. /**
  8770. * Enum used to define system values e.g. values automatically provided by the system
  8771. */
  8772. export enum NodeMaterialSystemValues {
  8773. /** World */
  8774. World = 1,
  8775. /** View */
  8776. View = 2,
  8777. /** Projection */
  8778. Projection = 3,
  8779. /** ViewProjection */
  8780. ViewProjection = 4,
  8781. /** WorldView */
  8782. WorldView = 5,
  8783. /** WorldViewProjection */
  8784. WorldViewProjection = 6,
  8785. /** CameraPosition */
  8786. CameraPosition = 7,
  8787. /** Fog Color */
  8788. FogColor = 8,
  8789. /** Delta time */
  8790. DeltaTime = 9
  8791. }
  8792. }
  8793. declare module "babylonjs/Maths/math.axis" {
  8794. import { Vector3 } from "babylonjs/Maths/math.vector";
  8795. /** Defines supported spaces */
  8796. export enum Space {
  8797. /** Local (object) space */
  8798. LOCAL = 0,
  8799. /** World space */
  8800. WORLD = 1,
  8801. /** Bone space */
  8802. BONE = 2
  8803. }
  8804. /** Defines the 3 main axes */
  8805. export class Axis {
  8806. /** X axis */
  8807. static X: Vector3;
  8808. /** Y axis */
  8809. static Y: Vector3;
  8810. /** Z axis */
  8811. static Z: Vector3;
  8812. }
  8813. }
  8814. declare module "babylonjs/Maths/math.frustum" {
  8815. import { Matrix } from "babylonjs/Maths/math.vector";
  8816. import { DeepImmutable } from "babylonjs/types";
  8817. import { Plane } from "babylonjs/Maths/math.plane";
  8818. /**
  8819. * Represents a camera frustum
  8820. */
  8821. export class Frustum {
  8822. /**
  8823. * Gets the planes representing the frustum
  8824. * @param transform matrix to be applied to the returned planes
  8825. * @returns a new array of 6 Frustum planes computed by the given transformation matrix.
  8826. */
  8827. static GetPlanes(transform: DeepImmutable<Matrix>): Plane[];
  8828. /**
  8829. * Gets the near frustum plane transformed by the transform matrix
  8830. * @param transform transformation matrix to be applied to the resulting frustum plane
  8831. * @param frustumPlane the resuling frustum plane
  8832. */
  8833. static GetNearPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8834. /**
  8835. * Gets the far frustum plane transformed by the transform matrix
  8836. * @param transform transformation matrix to be applied to the resulting frustum plane
  8837. * @param frustumPlane the resuling frustum plane
  8838. */
  8839. static GetFarPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8840. /**
  8841. * Gets the left frustum plane transformed by the transform matrix
  8842. * @param transform transformation matrix to be applied to the resulting frustum plane
  8843. * @param frustumPlane the resuling frustum plane
  8844. */
  8845. static GetLeftPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8846. /**
  8847. * Gets the right frustum plane transformed by the transform matrix
  8848. * @param transform transformation matrix to be applied to the resulting frustum plane
  8849. * @param frustumPlane the resuling frustum plane
  8850. */
  8851. static GetRightPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8852. /**
  8853. * Gets the top frustum plane transformed by the transform matrix
  8854. * @param transform transformation matrix to be applied to the resulting frustum plane
  8855. * @param frustumPlane the resuling frustum plane
  8856. */
  8857. static GetTopPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8858. /**
  8859. * Gets the bottom frustum plane transformed by the transform matrix
  8860. * @param transform transformation matrix to be applied to the resulting frustum plane
  8861. * @param frustumPlane the resuling frustum plane
  8862. */
  8863. static GetBottomPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8864. /**
  8865. * Sets the given array "frustumPlanes" with the 6 Frustum planes computed by the given transformation matrix.
  8866. * @param transform transformation matrix to be applied to the resulting frustum planes
  8867. * @param frustumPlanes the resuling frustum planes
  8868. */
  8869. static GetPlanesToRef(transform: DeepImmutable<Matrix>, frustumPlanes: Plane[]): void;
  8870. }
  8871. }
  8872. declare module "babylonjs/Maths/math.size" {
  8873. /**
  8874. * Interface for the size containing width and height
  8875. */
  8876. export interface ISize {
  8877. /**
  8878. * Width
  8879. */
  8880. width: number;
  8881. /**
  8882. * Heighht
  8883. */
  8884. height: number;
  8885. }
  8886. /**
  8887. * Size containing widht and height
  8888. */
  8889. export class Size implements ISize {
  8890. /**
  8891. * Width
  8892. */
  8893. width: number;
  8894. /**
  8895. * Height
  8896. */
  8897. height: number;
  8898. /**
  8899. * Creates a Size object from the given width and height (floats).
  8900. * @param width width of the new size
  8901. * @param height height of the new size
  8902. */
  8903. constructor(width: number, height: number);
  8904. /**
  8905. * Returns a string with the Size width and height
  8906. * @returns a string with the Size width and height
  8907. */
  8908. toString(): string;
  8909. /**
  8910. * "Size"
  8911. * @returns the string "Size"
  8912. */
  8913. getClassName(): string;
  8914. /**
  8915. * Returns the Size hash code.
  8916. * @returns a hash code for a unique width and height
  8917. */
  8918. getHashCode(): number;
  8919. /**
  8920. * Updates the current size from the given one.
  8921. * @param src the given size
  8922. */
  8923. copyFrom(src: Size): void;
  8924. /**
  8925. * Updates in place the current Size from the given floats.
  8926. * @param width width of the new size
  8927. * @param height height of the new size
  8928. * @returns the updated Size.
  8929. */
  8930. copyFromFloats(width: number, height: number): Size;
  8931. /**
  8932. * Updates in place the current Size from the given floats.
  8933. * @param width width to set
  8934. * @param height height to set
  8935. * @returns the updated Size.
  8936. */
  8937. set(width: number, height: number): Size;
  8938. /**
  8939. * Multiplies the width and height by numbers
  8940. * @param w factor to multiple the width by
  8941. * @param h factor to multiple the height by
  8942. * @returns a new Size set with the multiplication result of the current Size and the given floats.
  8943. */
  8944. multiplyByFloats(w: number, h: number): Size;
  8945. /**
  8946. * Clones the size
  8947. * @returns a new Size copied from the given one.
  8948. */
  8949. clone(): Size;
  8950. /**
  8951. * True if the current Size and the given one width and height are strictly equal.
  8952. * @param other the other size to compare against
  8953. * @returns True if the current Size and the given one width and height are strictly equal.
  8954. */
  8955. equals(other: Size): boolean;
  8956. /**
  8957. * The surface of the Size : width * height (float).
  8958. */
  8959. get surface(): number;
  8960. /**
  8961. * Create a new size of zero
  8962. * @returns a new Size set to (0.0, 0.0)
  8963. */
  8964. static Zero(): Size;
  8965. /**
  8966. * Sums the width and height of two sizes
  8967. * @param otherSize size to add to this size
  8968. * @returns a new Size set as the addition result of the current Size and the given one.
  8969. */
  8970. add(otherSize: Size): Size;
  8971. /**
  8972. * Subtracts the width and height of two
  8973. * @param otherSize size to subtract to this size
  8974. * @returns a new Size set as the subtraction result of the given one from the current Size.
  8975. */
  8976. subtract(otherSize: Size): Size;
  8977. /**
  8978. * Creates a new Size set at the linear interpolation "amount" between "start" and "end"
  8979. * @param start starting size to lerp between
  8980. * @param end end size to lerp between
  8981. * @param amount amount to lerp between the start and end values
  8982. * @returns a new Size set at the linear interpolation "amount" between "start" and "end"
  8983. */
  8984. static Lerp(start: Size, end: Size, amount: number): Size;
  8985. }
  8986. }
  8987. declare module "babylonjs/Maths/math.vertexFormat" {
  8988. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  8989. /**
  8990. * Contains position and normal vectors for a vertex
  8991. */
  8992. export class PositionNormalVertex {
  8993. /** the position of the vertex (defaut: 0,0,0) */
  8994. position: Vector3;
  8995. /** the normal of the vertex (defaut: 0,1,0) */
  8996. normal: Vector3;
  8997. /**
  8998. * Creates a PositionNormalVertex
  8999. * @param position the position of the vertex (defaut: 0,0,0)
  9000. * @param normal the normal of the vertex (defaut: 0,1,0)
  9001. */
  9002. constructor(
  9003. /** the position of the vertex (defaut: 0,0,0) */
  9004. position?: Vector3,
  9005. /** the normal of the vertex (defaut: 0,1,0) */
  9006. normal?: Vector3);
  9007. /**
  9008. * Clones the PositionNormalVertex
  9009. * @returns the cloned PositionNormalVertex
  9010. */
  9011. clone(): PositionNormalVertex;
  9012. }
  9013. /**
  9014. * Contains position, normal and uv vectors for a vertex
  9015. */
  9016. export class PositionNormalTextureVertex {
  9017. /** the position of the vertex (defaut: 0,0,0) */
  9018. position: Vector3;
  9019. /** the normal of the vertex (defaut: 0,1,0) */
  9020. normal: Vector3;
  9021. /** the uv of the vertex (default: 0,0) */
  9022. uv: Vector2;
  9023. /**
  9024. * Creates a PositionNormalTextureVertex
  9025. * @param position the position of the vertex (defaut: 0,0,0)
  9026. * @param normal the normal of the vertex (defaut: 0,1,0)
  9027. * @param uv the uv of the vertex (default: 0,0)
  9028. */
  9029. constructor(
  9030. /** the position of the vertex (defaut: 0,0,0) */
  9031. position?: Vector3,
  9032. /** the normal of the vertex (defaut: 0,1,0) */
  9033. normal?: Vector3,
  9034. /** the uv of the vertex (default: 0,0) */
  9035. uv?: Vector2);
  9036. /**
  9037. * Clones the PositionNormalTextureVertex
  9038. * @returns the cloned PositionNormalTextureVertex
  9039. */
  9040. clone(): PositionNormalTextureVertex;
  9041. }
  9042. }
  9043. declare module "babylonjs/Maths/math" {
  9044. export * from "babylonjs/Maths/math.axis";
  9045. export * from "babylonjs/Maths/math.color";
  9046. export * from "babylonjs/Maths/math.constants";
  9047. export * from "babylonjs/Maths/math.frustum";
  9048. export * from "babylonjs/Maths/math.path";
  9049. export * from "babylonjs/Maths/math.plane";
  9050. export * from "babylonjs/Maths/math.size";
  9051. export * from "babylonjs/Maths/math.vector";
  9052. export * from "babylonjs/Maths/math.vertexFormat";
  9053. export * from "babylonjs/Maths/math.viewport";
  9054. }
  9055. declare module "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes" {
  9056. /**
  9057. * Enum defining the type of animations supported by InputBlock
  9058. */
  9059. export enum AnimatedInputBlockTypes {
  9060. /** No animation */
  9061. None = 0,
  9062. /** Time based animation. Will only work for floats */
  9063. Time = 1
  9064. }
  9065. }
  9066. declare module "babylonjs/Lights/shadowLight" {
  9067. import { Camera } from "babylonjs/Cameras/camera";
  9068. import { Scene } from "babylonjs/scene";
  9069. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  9070. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  9071. import { Light } from "babylonjs/Lights/light";
  9072. /**
  9073. * Interface describing all the common properties and methods a shadow light needs to implement.
  9074. * This helps both the shadow generator and materials to genrate the corresponding shadow maps
  9075. * as well as binding the different shadow properties to the effects.
  9076. */
  9077. export interface IShadowLight extends Light {
  9078. /**
  9079. * The light id in the scene (used in scene.findLighById for instance)
  9080. */
  9081. id: string;
  9082. /**
  9083. * The position the shdow will be casted from.
  9084. */
  9085. position: Vector3;
  9086. /**
  9087. * In 2d mode (needCube being false), the direction used to cast the shadow.
  9088. */
  9089. direction: Vector3;
  9090. /**
  9091. * The transformed position. Position of the light in world space taking parenting in account.
  9092. */
  9093. transformedPosition: Vector3;
  9094. /**
  9095. * The transformed direction. Direction of the light in world space taking parenting in account.
  9096. */
  9097. transformedDirection: Vector3;
  9098. /**
  9099. * The friendly name of the light in the scene.
  9100. */
  9101. name: string;
  9102. /**
  9103. * Defines the shadow projection clipping minimum z value.
  9104. */
  9105. shadowMinZ: number;
  9106. /**
  9107. * Defines the shadow projection clipping maximum z value.
  9108. */
  9109. shadowMaxZ: number;
  9110. /**
  9111. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  9112. * @returns true if the information has been computed, false if it does not need to (no parenting)
  9113. */
  9114. computeTransformedInformation(): boolean;
  9115. /**
  9116. * Gets the scene the light belongs to.
  9117. * @returns The scene
  9118. */
  9119. getScene(): Scene;
  9120. /**
  9121. * Callback defining a custom Projection Matrix Builder.
  9122. * This can be used to override the default projection matrix computation.
  9123. */
  9124. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  9125. /**
  9126. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  9127. * @param matrix The materix to updated with the projection information
  9128. * @param viewMatrix The transform matrix of the light
  9129. * @param renderList The list of mesh to render in the map
  9130. * @returns The current light
  9131. */
  9132. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  9133. /**
  9134. * Gets the current depth scale used in ESM.
  9135. * @returns The scale
  9136. */
  9137. getDepthScale(): number;
  9138. /**
  9139. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  9140. * @returns true if a cube texture needs to be use
  9141. */
  9142. needCube(): boolean;
  9143. /**
  9144. * Detects if the projection matrix requires to be recomputed this frame.
  9145. * @returns true if it requires to be recomputed otherwise, false.
  9146. */
  9147. needProjectionMatrixCompute(): boolean;
  9148. /**
  9149. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  9150. */
  9151. forceProjectionMatrixCompute(): void;
  9152. /**
  9153. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  9154. * @param faceIndex The index of the face we are computed the direction to generate shadow
  9155. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  9156. */
  9157. getShadowDirection(faceIndex?: number): Vector3;
  9158. /**
  9159. * Gets the minZ used for shadow according to both the scene and the light.
  9160. * @param activeCamera The camera we are returning the min for
  9161. * @returns the depth min z
  9162. */
  9163. getDepthMinZ(activeCamera: Camera): number;
  9164. /**
  9165. * Gets the maxZ used for shadow according to both the scene and the light.
  9166. * @param activeCamera The camera we are returning the max for
  9167. * @returns the depth max z
  9168. */
  9169. getDepthMaxZ(activeCamera: Camera): number;
  9170. }
  9171. /**
  9172. * Base implementation IShadowLight
  9173. * It groups all the common behaviour in order to reduce dupplication and better follow the DRY pattern.
  9174. */
  9175. export abstract class ShadowLight extends Light implements IShadowLight {
  9176. protected abstract _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  9177. protected _position: Vector3;
  9178. protected _setPosition(value: Vector3): void;
  9179. /**
  9180. * Sets the position the shadow will be casted from. Also use as the light position for both
  9181. * point and spot lights.
  9182. */
  9183. get position(): Vector3;
  9184. /**
  9185. * Sets the position the shadow will be casted from. Also use as the light position for both
  9186. * point and spot lights.
  9187. */
  9188. set position(value: Vector3);
  9189. protected _direction: Vector3;
  9190. protected _setDirection(value: Vector3): void;
  9191. /**
  9192. * In 2d mode (needCube being false), gets the direction used to cast the shadow.
  9193. * Also use as the light direction on spot and directional lights.
  9194. */
  9195. get direction(): Vector3;
  9196. /**
  9197. * In 2d mode (needCube being false), sets the direction used to cast the shadow.
  9198. * Also use as the light direction on spot and directional lights.
  9199. */
  9200. set direction(value: Vector3);
  9201. protected _shadowMinZ: number;
  9202. /**
  9203. * Gets the shadow projection clipping minimum z value.
  9204. */
  9205. get shadowMinZ(): number;
  9206. /**
  9207. * Sets the shadow projection clipping minimum z value.
  9208. */
  9209. set shadowMinZ(value: number);
  9210. protected _shadowMaxZ: number;
  9211. /**
  9212. * Sets the shadow projection clipping maximum z value.
  9213. */
  9214. get shadowMaxZ(): number;
  9215. /**
  9216. * Gets the shadow projection clipping maximum z value.
  9217. */
  9218. set shadowMaxZ(value: number);
  9219. /**
  9220. * Callback defining a custom Projection Matrix Builder.
  9221. * This can be used to override the default projection matrix computation.
  9222. */
  9223. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  9224. /**
  9225. * The transformed position. Position of the light in world space taking parenting in account.
  9226. */
  9227. transformedPosition: Vector3;
  9228. /**
  9229. * The transformed direction. Direction of the light in world space taking parenting in account.
  9230. */
  9231. transformedDirection: Vector3;
  9232. private _needProjectionMatrixCompute;
  9233. /**
  9234. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  9235. * @returns true if the information has been computed, false if it does not need to (no parenting)
  9236. */
  9237. computeTransformedInformation(): boolean;
  9238. /**
  9239. * Return the depth scale used for the shadow map.
  9240. * @returns the depth scale.
  9241. */
  9242. getDepthScale(): number;
  9243. /**
  9244. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  9245. * @param faceIndex The index of the face we are computed the direction to generate shadow
  9246. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  9247. */
  9248. getShadowDirection(faceIndex?: number): Vector3;
  9249. /**
  9250. * Returns the ShadowLight absolute position in the World.
  9251. * @returns the position vector in world space
  9252. */
  9253. getAbsolutePosition(): Vector3;
  9254. /**
  9255. * Sets the ShadowLight direction toward the passed target.
  9256. * @param target The point to target in local space
  9257. * @returns the updated ShadowLight direction
  9258. */
  9259. setDirectionToTarget(target: Vector3): Vector3;
  9260. /**
  9261. * Returns the light rotation in euler definition.
  9262. * @returns the x y z rotation in local space.
  9263. */
  9264. getRotation(): Vector3;
  9265. /**
  9266. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  9267. * @returns true if a cube texture needs to be use
  9268. */
  9269. needCube(): boolean;
  9270. /**
  9271. * Detects if the projection matrix requires to be recomputed this frame.
  9272. * @returns true if it requires to be recomputed otherwise, false.
  9273. */
  9274. needProjectionMatrixCompute(): boolean;
  9275. /**
  9276. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  9277. */
  9278. forceProjectionMatrixCompute(): void;
  9279. /** @hidden */
  9280. _initCache(): void;
  9281. /** @hidden */
  9282. _isSynchronized(): boolean;
  9283. /**
  9284. * Computes the world matrix of the node
  9285. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  9286. * @returns the world matrix
  9287. */
  9288. computeWorldMatrix(force?: boolean): Matrix;
  9289. /**
  9290. * Gets the minZ used for shadow according to both the scene and the light.
  9291. * @param activeCamera The camera we are returning the min for
  9292. * @returns the depth min z
  9293. */
  9294. getDepthMinZ(activeCamera: Camera): number;
  9295. /**
  9296. * Gets the maxZ used for shadow according to both the scene and the light.
  9297. * @param activeCamera The camera we are returning the max for
  9298. * @returns the depth max z
  9299. */
  9300. getDepthMaxZ(activeCamera: Camera): number;
  9301. /**
  9302. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  9303. * @param matrix The materix to updated with the projection information
  9304. * @param viewMatrix The transform matrix of the light
  9305. * @param renderList The list of mesh to render in the map
  9306. * @returns The current light
  9307. */
  9308. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  9309. }
  9310. }
  9311. declare module "babylonjs/Shaders/ShadersInclude/packingFunctions" {
  9312. /** @hidden */
  9313. export var packingFunctions: {
  9314. name: string;
  9315. shader: string;
  9316. };
  9317. }
  9318. declare module "babylonjs/Shaders/ShadersInclude/bayerDitherFunctions" {
  9319. /** @hidden */
  9320. export var bayerDitherFunctions: {
  9321. name: string;
  9322. shader: string;
  9323. };
  9324. }
  9325. declare module "babylonjs/Shaders/ShadersInclude/shadowMapFragmentDeclaration" {
  9326. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  9327. import "babylonjs/Shaders/ShadersInclude/bayerDitherFunctions";
  9328. /** @hidden */
  9329. export var shadowMapFragmentDeclaration: {
  9330. name: string;
  9331. shader: string;
  9332. };
  9333. }
  9334. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration" {
  9335. /** @hidden */
  9336. export var clipPlaneFragmentDeclaration: {
  9337. name: string;
  9338. shader: string;
  9339. };
  9340. }
  9341. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragment" {
  9342. /** @hidden */
  9343. export var clipPlaneFragment: {
  9344. name: string;
  9345. shader: string;
  9346. };
  9347. }
  9348. declare module "babylonjs/Shaders/ShadersInclude/shadowMapFragment" {
  9349. /** @hidden */
  9350. export var shadowMapFragment: {
  9351. name: string;
  9352. shader: string;
  9353. };
  9354. }
  9355. declare module "babylonjs/Shaders/shadowMap.fragment" {
  9356. import "babylonjs/Shaders/ShadersInclude/shadowMapFragmentDeclaration";
  9357. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  9358. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  9359. import "babylonjs/Shaders/ShadersInclude/shadowMapFragment";
  9360. /** @hidden */
  9361. export var shadowMapPixelShader: {
  9362. name: string;
  9363. shader: string;
  9364. };
  9365. }
  9366. declare module "babylonjs/Shaders/ShadersInclude/bonesDeclaration" {
  9367. /** @hidden */
  9368. export var bonesDeclaration: {
  9369. name: string;
  9370. shader: string;
  9371. };
  9372. }
  9373. declare module "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration" {
  9374. /** @hidden */
  9375. export var morphTargetsVertexGlobalDeclaration: {
  9376. name: string;
  9377. shader: string;
  9378. };
  9379. }
  9380. declare module "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration" {
  9381. /** @hidden */
  9382. export var morphTargetsVertexDeclaration: {
  9383. name: string;
  9384. shader: string;
  9385. };
  9386. }
  9387. declare module "babylonjs/Shaders/ShadersInclude/instancesDeclaration" {
  9388. /** @hidden */
  9389. export var instancesDeclaration: {
  9390. name: string;
  9391. shader: string;
  9392. };
  9393. }
  9394. declare module "babylonjs/Shaders/ShadersInclude/helperFunctions" {
  9395. /** @hidden */
  9396. export var helperFunctions: {
  9397. name: string;
  9398. shader: string;
  9399. };
  9400. }
  9401. declare module "babylonjs/Shaders/ShadersInclude/shadowMapVertexDeclaration" {
  9402. /** @hidden */
  9403. export var shadowMapVertexDeclaration: {
  9404. name: string;
  9405. shader: string;
  9406. };
  9407. }
  9408. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration" {
  9409. /** @hidden */
  9410. export var clipPlaneVertexDeclaration: {
  9411. name: string;
  9412. shader: string;
  9413. };
  9414. }
  9415. declare module "babylonjs/Shaders/ShadersInclude/morphTargetsVertex" {
  9416. /** @hidden */
  9417. export var morphTargetsVertex: {
  9418. name: string;
  9419. shader: string;
  9420. };
  9421. }
  9422. declare module "babylonjs/Shaders/ShadersInclude/instancesVertex" {
  9423. /** @hidden */
  9424. export var instancesVertex: {
  9425. name: string;
  9426. shader: string;
  9427. };
  9428. }
  9429. declare module "babylonjs/Shaders/ShadersInclude/bonesVertex" {
  9430. /** @hidden */
  9431. export var bonesVertex: {
  9432. name: string;
  9433. shader: string;
  9434. };
  9435. }
  9436. declare module "babylonjs/Shaders/ShadersInclude/shadowMapVertexNormalBias" {
  9437. /** @hidden */
  9438. export var shadowMapVertexNormalBias: {
  9439. name: string;
  9440. shader: string;
  9441. };
  9442. }
  9443. declare module "babylonjs/Shaders/ShadersInclude/shadowMapVertexMetric" {
  9444. /** @hidden */
  9445. export var shadowMapVertexMetric: {
  9446. name: string;
  9447. shader: string;
  9448. };
  9449. }
  9450. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertex" {
  9451. /** @hidden */
  9452. export var clipPlaneVertex: {
  9453. name: string;
  9454. shader: string;
  9455. };
  9456. }
  9457. declare module "babylonjs/Shaders/shadowMap.vertex" {
  9458. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  9459. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  9460. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  9461. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  9462. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  9463. import "babylonjs/Shaders/ShadersInclude/shadowMapVertexDeclaration";
  9464. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  9465. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  9466. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  9467. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  9468. import "babylonjs/Shaders/ShadersInclude/shadowMapVertexNormalBias";
  9469. import "babylonjs/Shaders/ShadersInclude/shadowMapVertexMetric";
  9470. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  9471. /** @hidden */
  9472. export var shadowMapVertexShader: {
  9473. name: string;
  9474. shader: string;
  9475. };
  9476. }
  9477. declare module "babylonjs/Shaders/depthBoxBlur.fragment" {
  9478. /** @hidden */
  9479. export var depthBoxBlurPixelShader: {
  9480. name: string;
  9481. shader: string;
  9482. };
  9483. }
  9484. declare module "babylonjs/Shaders/ShadersInclude/shadowMapFragmentSoftTransparentShadow" {
  9485. /** @hidden */
  9486. export var shadowMapFragmentSoftTransparentShadow: {
  9487. name: string;
  9488. shader: string;
  9489. };
  9490. }
  9491. declare module "babylonjs/Materials/effectFallbacks" {
  9492. import { IEffectFallbacks } from "babylonjs/Materials/iEffectFallbacks";
  9493. import { Effect } from "babylonjs/Materials/effect";
  9494. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  9495. /**
  9496. * EffectFallbacks can be used to add fallbacks (properties to disable) to certain properties when desired to improve performance.
  9497. * (Eg. Start at high quality with reflection and fog, if fps is low, remove reflection, if still low remove fog)
  9498. */
  9499. export class EffectFallbacks implements IEffectFallbacks {
  9500. private _defines;
  9501. private _currentRank;
  9502. private _maxRank;
  9503. private _mesh;
  9504. /**
  9505. * Removes the fallback from the bound mesh.
  9506. */
  9507. unBindMesh(): void;
  9508. /**
  9509. * Adds a fallback on the specified property.
  9510. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  9511. * @param define The name of the define in the shader
  9512. */
  9513. addFallback(rank: number, define: string): void;
  9514. /**
  9515. * Sets the mesh to use CPU skinning when needing to fallback.
  9516. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  9517. * @param mesh The mesh to use the fallbacks.
  9518. */
  9519. addCPUSkinningFallback(rank: number, mesh: AbstractMesh): void;
  9520. /**
  9521. * Checks to see if more fallbacks are still availible.
  9522. */
  9523. get hasMoreFallbacks(): boolean;
  9524. /**
  9525. * Removes the defines that should be removed when falling back.
  9526. * @param currentDefines defines the current define statements for the shader.
  9527. * @param effect defines the current effect we try to compile
  9528. * @returns The resulting defines with defines of the current rank removed.
  9529. */
  9530. reduce(currentDefines: string, effect: Effect): string;
  9531. }
  9532. }
  9533. declare module "babylonjs/Actions/action" {
  9534. import { Observable } from "babylonjs/Misc/observable";
  9535. import { Condition } from "babylonjs/Actions/condition";
  9536. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  9537. import { Nullable } from "babylonjs/types";
  9538. import { Scene } from "babylonjs/scene";
  9539. import { ActionManager } from "babylonjs/Actions/actionManager";
  9540. import { ActionEvent } from "babylonjs/Actions/actionEvent";
  9541. import { Node } from "babylonjs/node";
  9542. /**
  9543. * Interface used to define Action
  9544. */
  9545. export interface IAction {
  9546. /**
  9547. * Trigger for the action
  9548. */
  9549. trigger: number;
  9550. /** Options of the trigger */
  9551. triggerOptions: any;
  9552. /**
  9553. * Gets the trigger parameters
  9554. * @returns the trigger parameters
  9555. */
  9556. getTriggerParameter(): any;
  9557. /**
  9558. * Internal only - executes current action event
  9559. * @hidden
  9560. */
  9561. _executeCurrent(evt?: ActionEvent): void;
  9562. /**
  9563. * Serialize placeholder for child classes
  9564. * @param parent of child
  9565. * @returns the serialized object
  9566. */
  9567. serialize(parent: any): any;
  9568. /**
  9569. * Internal only
  9570. * @hidden
  9571. */
  9572. _prepare(): void;
  9573. /**
  9574. * Internal only - manager for action
  9575. * @hidden
  9576. */
  9577. _actionManager: Nullable<AbstractActionManager>;
  9578. /**
  9579. * Adds action to chain of actions, may be a DoNothingAction
  9580. * @param action defines the next action to execute
  9581. * @returns The action passed in
  9582. * @see https://www.babylonjs-playground.com/#1T30HR#0
  9583. */
  9584. then(action: IAction): IAction;
  9585. }
  9586. /**
  9587. * The action to be carried out following a trigger
  9588. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#available-actions
  9589. */
  9590. export class Action implements IAction {
  9591. /** the trigger, with or without parameters, for the action */
  9592. triggerOptions: any;
  9593. /**
  9594. * Trigger for the action
  9595. */
  9596. trigger: number;
  9597. /**
  9598. * Internal only - manager for action
  9599. * @hidden
  9600. */
  9601. _actionManager: ActionManager;
  9602. private _nextActiveAction;
  9603. private _child;
  9604. private _condition?;
  9605. private _triggerParameter;
  9606. /**
  9607. * An event triggered prior to action being executed.
  9608. */
  9609. onBeforeExecuteObservable: Observable<Action>;
  9610. /**
  9611. * Creates a new Action
  9612. * @param triggerOptions the trigger, with or without parameters, for the action
  9613. * @param condition an optional determinant of action
  9614. */
  9615. constructor(
  9616. /** the trigger, with or without parameters, for the action */
  9617. triggerOptions: any, condition?: Condition);
  9618. /**
  9619. * Internal only
  9620. * @hidden
  9621. */
  9622. _prepare(): void;
  9623. /**
  9624. * Gets the trigger parameters
  9625. * @returns the trigger parameters
  9626. */
  9627. getTriggerParameter(): any;
  9628. /**
  9629. * Internal only - executes current action event
  9630. * @hidden
  9631. */
  9632. _executeCurrent(evt?: ActionEvent): void;
  9633. /**
  9634. * Execute placeholder for child classes
  9635. * @param evt optional action event
  9636. */
  9637. execute(evt?: ActionEvent): void;
  9638. /**
  9639. * Skips to next active action
  9640. */
  9641. skipToNextActiveAction(): void;
  9642. /**
  9643. * Adds action to chain of actions, may be a DoNothingAction
  9644. * @param action defines the next action to execute
  9645. * @returns The action passed in
  9646. * @see https://www.babylonjs-playground.com/#1T30HR#0
  9647. */
  9648. then(action: Action): Action;
  9649. /**
  9650. * Internal only
  9651. * @hidden
  9652. */
  9653. _getProperty(propertyPath: string): string;
  9654. /**
  9655. * Internal only
  9656. * @hidden
  9657. */
  9658. _getEffectiveTarget(target: any, propertyPath: string): any;
  9659. /**
  9660. * Serialize placeholder for child classes
  9661. * @param parent of child
  9662. * @returns the serialized object
  9663. */
  9664. serialize(parent: any): any;
  9665. /**
  9666. * Internal only called by serialize
  9667. * @hidden
  9668. */
  9669. protected _serialize(serializedAction: any, parent?: any): any;
  9670. /**
  9671. * Internal only
  9672. * @hidden
  9673. */
  9674. static _SerializeValueAsString: (value: any) => string;
  9675. /**
  9676. * Internal only
  9677. * @hidden
  9678. */
  9679. static _GetTargetProperty: (target: Scene | Node) => {
  9680. name: string;
  9681. targetType: string;
  9682. value: string;
  9683. };
  9684. }
  9685. }
  9686. declare module "babylonjs/Actions/condition" {
  9687. import { ActionManager } from "babylonjs/Actions/actionManager";
  9688. /**
  9689. * A Condition applied to an Action
  9690. */
  9691. export class Condition {
  9692. /**
  9693. * Internal only - manager for action
  9694. * @hidden
  9695. */
  9696. _actionManager: ActionManager;
  9697. /**
  9698. * Internal only
  9699. * @hidden
  9700. */
  9701. _evaluationId: number;
  9702. /**
  9703. * Internal only
  9704. * @hidden
  9705. */
  9706. _currentResult: boolean;
  9707. /**
  9708. * Creates a new Condition
  9709. * @param actionManager the manager of the action the condition is applied to
  9710. */
  9711. constructor(actionManager: ActionManager);
  9712. /**
  9713. * Check if the current condition is valid
  9714. * @returns a boolean
  9715. */
  9716. isValid(): boolean;
  9717. /**
  9718. * Internal only
  9719. * @hidden
  9720. */
  9721. _getProperty(propertyPath: string): string;
  9722. /**
  9723. * Internal only
  9724. * @hidden
  9725. */
  9726. _getEffectiveTarget(target: any, propertyPath: string): any;
  9727. /**
  9728. * Serialize placeholder for child classes
  9729. * @returns the serialized object
  9730. */
  9731. serialize(): any;
  9732. /**
  9733. * Internal only
  9734. * @hidden
  9735. */
  9736. protected _serialize(serializedCondition: any): any;
  9737. }
  9738. /**
  9739. * Defines specific conditional operators as extensions of Condition
  9740. */
  9741. export class ValueCondition extends Condition {
  9742. /** path to specify the property of the target the conditional operator uses */
  9743. propertyPath: string;
  9744. /** the value compared by the conditional operator against the current value of the property */
  9745. value: any;
  9746. /** the conditional operator, default ValueCondition.IsEqual */
  9747. operator: number;
  9748. /**
  9749. * Internal only
  9750. * @hidden
  9751. */
  9752. private static _IsEqual;
  9753. /**
  9754. * Internal only
  9755. * @hidden
  9756. */
  9757. private static _IsDifferent;
  9758. /**
  9759. * Internal only
  9760. * @hidden
  9761. */
  9762. private static _IsGreater;
  9763. /**
  9764. * Internal only
  9765. * @hidden
  9766. */
  9767. private static _IsLesser;
  9768. /**
  9769. * returns the number for IsEqual
  9770. */
  9771. static get IsEqual(): number;
  9772. /**
  9773. * Returns the number for IsDifferent
  9774. */
  9775. static get IsDifferent(): number;
  9776. /**
  9777. * Returns the number for IsGreater
  9778. */
  9779. static get IsGreater(): number;
  9780. /**
  9781. * Returns the number for IsLesser
  9782. */
  9783. static get IsLesser(): number;
  9784. /**
  9785. * Internal only The action manager for the condition
  9786. * @hidden
  9787. */
  9788. _actionManager: ActionManager;
  9789. /**
  9790. * Internal only
  9791. * @hidden
  9792. */
  9793. private _target;
  9794. /**
  9795. * Internal only
  9796. * @hidden
  9797. */
  9798. private _effectiveTarget;
  9799. /**
  9800. * Internal only
  9801. * @hidden
  9802. */
  9803. private _property;
  9804. /**
  9805. * Creates a new ValueCondition
  9806. * @param actionManager manager for the action the condition applies to
  9807. * @param target for the action
  9808. * @param propertyPath path to specify the property of the target the conditional operator uses
  9809. * @param value the value compared by the conditional operator against the current value of the property
  9810. * @param operator the conditional operator, default ValueCondition.IsEqual
  9811. */
  9812. constructor(actionManager: ActionManager, target: any,
  9813. /** path to specify the property of the target the conditional operator uses */
  9814. propertyPath: string,
  9815. /** the value compared by the conditional operator against the current value of the property */
  9816. value: any,
  9817. /** the conditional operator, default ValueCondition.IsEqual */
  9818. operator?: number);
  9819. /**
  9820. * Compares the given value with the property value for the specified conditional operator
  9821. * @returns the result of the comparison
  9822. */
  9823. isValid(): boolean;
  9824. /**
  9825. * Serialize the ValueCondition into a JSON compatible object
  9826. * @returns serialization object
  9827. */
  9828. serialize(): any;
  9829. /**
  9830. * Gets the name of the conditional operator for the ValueCondition
  9831. * @param operator the conditional operator
  9832. * @returns the name
  9833. */
  9834. static GetOperatorName(operator: number): string;
  9835. }
  9836. /**
  9837. * Defines a predicate condition as an extension of Condition
  9838. */
  9839. export class PredicateCondition extends Condition {
  9840. /** defines the predicate function used to validate the condition */
  9841. predicate: () => boolean;
  9842. /**
  9843. * Internal only - manager for action
  9844. * @hidden
  9845. */
  9846. _actionManager: ActionManager;
  9847. /**
  9848. * Creates a new PredicateCondition
  9849. * @param actionManager manager for the action the condition applies to
  9850. * @param predicate defines the predicate function used to validate the condition
  9851. */
  9852. constructor(actionManager: ActionManager,
  9853. /** defines the predicate function used to validate the condition */
  9854. predicate: () => boolean);
  9855. /**
  9856. * @returns the validity of the predicate condition
  9857. */
  9858. isValid(): boolean;
  9859. }
  9860. /**
  9861. * Defines a state condition as an extension of Condition
  9862. */
  9863. export class StateCondition extends Condition {
  9864. /** Value to compare with target state */
  9865. value: string;
  9866. /**
  9867. * Internal only - manager for action
  9868. * @hidden
  9869. */
  9870. _actionManager: ActionManager;
  9871. /**
  9872. * Internal only
  9873. * @hidden
  9874. */
  9875. private _target;
  9876. /**
  9877. * Creates a new StateCondition
  9878. * @param actionManager manager for the action the condition applies to
  9879. * @param target of the condition
  9880. * @param value to compare with target state
  9881. */
  9882. constructor(actionManager: ActionManager, target: any,
  9883. /** Value to compare with target state */
  9884. value: string);
  9885. /**
  9886. * Gets a boolean indicating if the current condition is met
  9887. * @returns the validity of the state
  9888. */
  9889. isValid(): boolean;
  9890. /**
  9891. * Serialize the StateCondition into a JSON compatible object
  9892. * @returns serialization object
  9893. */
  9894. serialize(): any;
  9895. }
  9896. }
  9897. declare module "babylonjs/Actions/directActions" {
  9898. import { Action } from "babylonjs/Actions/action";
  9899. import { Condition } from "babylonjs/Actions/condition";
  9900. import { ActionEvent } from "babylonjs/Actions/actionEvent";
  9901. /**
  9902. * This defines an action responsible to toggle a boolean once triggered.
  9903. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  9904. */
  9905. export class SwitchBooleanAction extends Action {
  9906. /**
  9907. * The path to the boolean property in the target object
  9908. */
  9909. propertyPath: string;
  9910. private _target;
  9911. private _effectiveTarget;
  9912. private _property;
  9913. /**
  9914. * Instantiate the action
  9915. * @param triggerOptions defines the trigger options
  9916. * @param target defines the object containing the boolean
  9917. * @param propertyPath defines the path to the boolean property in the target object
  9918. * @param condition defines the trigger related conditions
  9919. */
  9920. constructor(triggerOptions: any, target: any, propertyPath: string, condition?: Condition);
  9921. /** @hidden */
  9922. _prepare(): void;
  9923. /**
  9924. * Execute the action toggle the boolean value.
  9925. */
  9926. execute(): void;
  9927. /**
  9928. * Serializes the actions and its related information.
  9929. * @param parent defines the object to serialize in
  9930. * @returns the serialized object
  9931. */
  9932. serialize(parent: any): any;
  9933. }
  9934. /**
  9935. * This defines an action responsible to set a the state field of the target
  9936. * to a desired value once triggered.
  9937. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  9938. */
  9939. export class SetStateAction extends Action {
  9940. /**
  9941. * The value to store in the state field.
  9942. */
  9943. value: string;
  9944. private _target;
  9945. /**
  9946. * Instantiate the action
  9947. * @param triggerOptions defines the trigger options
  9948. * @param target defines the object containing the state property
  9949. * @param value defines the value to store in the state field
  9950. * @param condition defines the trigger related conditions
  9951. */
  9952. constructor(triggerOptions: any, target: any, value: string, condition?: Condition);
  9953. /**
  9954. * Execute the action and store the value on the target state property.
  9955. */
  9956. execute(): void;
  9957. /**
  9958. * Serializes the actions and its related information.
  9959. * @param parent defines the object to serialize in
  9960. * @returns the serialized object
  9961. */
  9962. serialize(parent: any): any;
  9963. }
  9964. /**
  9965. * This defines an action responsible to set a property of the target
  9966. * to a desired value once triggered.
  9967. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  9968. */
  9969. export class SetValueAction extends Action {
  9970. /**
  9971. * The path of the property to set in the target.
  9972. */
  9973. propertyPath: string;
  9974. /**
  9975. * The value to set in the property
  9976. */
  9977. value: any;
  9978. private _target;
  9979. private _effectiveTarget;
  9980. private _property;
  9981. /**
  9982. * Instantiate the action
  9983. * @param triggerOptions defines the trigger options
  9984. * @param target defines the object containing the property
  9985. * @param propertyPath defines the path of the property to set in the target
  9986. * @param value defines the value to set in the property
  9987. * @param condition defines the trigger related conditions
  9988. */
  9989. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  9990. /** @hidden */
  9991. _prepare(): void;
  9992. /**
  9993. * Execute the action and set the targetted property to the desired value.
  9994. */
  9995. execute(): void;
  9996. /**
  9997. * Serializes the actions and its related information.
  9998. * @param parent defines the object to serialize in
  9999. * @returns the serialized object
  10000. */
  10001. serialize(parent: any): any;
  10002. }
  10003. /**
  10004. * This defines an action responsible to increment the target value
  10005. * to a desired value once triggered.
  10006. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10007. */
  10008. export class IncrementValueAction extends Action {
  10009. /**
  10010. * The path of the property to increment in the target.
  10011. */
  10012. propertyPath: string;
  10013. /**
  10014. * The value we should increment the property by.
  10015. */
  10016. value: any;
  10017. private _target;
  10018. private _effectiveTarget;
  10019. private _property;
  10020. /**
  10021. * Instantiate the action
  10022. * @param triggerOptions defines the trigger options
  10023. * @param target defines the object containing the property
  10024. * @param propertyPath defines the path of the property to increment in the target
  10025. * @param value defines the value value we should increment the property by
  10026. * @param condition defines the trigger related conditions
  10027. */
  10028. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  10029. /** @hidden */
  10030. _prepare(): void;
  10031. /**
  10032. * Execute the action and increment the target of the value amount.
  10033. */
  10034. execute(): void;
  10035. /**
  10036. * Serializes the actions and its related information.
  10037. * @param parent defines the object to serialize in
  10038. * @returns the serialized object
  10039. */
  10040. serialize(parent: any): any;
  10041. }
  10042. /**
  10043. * This defines an action responsible to start an animation once triggered.
  10044. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10045. */
  10046. export class PlayAnimationAction extends Action {
  10047. /**
  10048. * Where the animation should start (animation frame)
  10049. */
  10050. from: number;
  10051. /**
  10052. * Where the animation should stop (animation frame)
  10053. */
  10054. to: number;
  10055. /**
  10056. * Define if the animation should loop or stop after the first play.
  10057. */
  10058. loop?: boolean;
  10059. private _target;
  10060. /**
  10061. * Instantiate the action
  10062. * @param triggerOptions defines the trigger options
  10063. * @param target defines the target animation or animation name
  10064. * @param from defines from where the animation should start (animation frame)
  10065. * @param end defines where the animation should stop (animation frame)
  10066. * @param loop defines if the animation should loop or stop after the first play
  10067. * @param condition defines the trigger related conditions
  10068. */
  10069. constructor(triggerOptions: any, target: any, from: number, to: number, loop?: boolean, condition?: Condition);
  10070. /** @hidden */
  10071. _prepare(): void;
  10072. /**
  10073. * Execute the action and play the animation.
  10074. */
  10075. execute(): void;
  10076. /**
  10077. * Serializes the actions and its related information.
  10078. * @param parent defines the object to serialize in
  10079. * @returns the serialized object
  10080. */
  10081. serialize(parent: any): any;
  10082. }
  10083. /**
  10084. * This defines an action responsible to stop an animation once triggered.
  10085. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10086. */
  10087. export class StopAnimationAction extends Action {
  10088. private _target;
  10089. /**
  10090. * Instantiate the action
  10091. * @param triggerOptions defines the trigger options
  10092. * @param target defines the target animation or animation name
  10093. * @param condition defines the trigger related conditions
  10094. */
  10095. constructor(triggerOptions: any, target: any, condition?: Condition);
  10096. /** @hidden */
  10097. _prepare(): void;
  10098. /**
  10099. * Execute the action and stop the animation.
  10100. */
  10101. execute(): void;
  10102. /**
  10103. * Serializes the actions and its related information.
  10104. * @param parent defines the object to serialize in
  10105. * @returns the serialized object
  10106. */
  10107. serialize(parent: any): any;
  10108. }
  10109. /**
  10110. * This defines an action responsible that does nothing once triggered.
  10111. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10112. */
  10113. export class DoNothingAction extends Action {
  10114. /**
  10115. * Instantiate the action
  10116. * @param triggerOptions defines the trigger options
  10117. * @param condition defines the trigger related conditions
  10118. */
  10119. constructor(triggerOptions?: any, condition?: Condition);
  10120. /**
  10121. * Execute the action and do nothing.
  10122. */
  10123. execute(): void;
  10124. /**
  10125. * Serializes the actions and its related information.
  10126. * @param parent defines the object to serialize in
  10127. * @returns the serialized object
  10128. */
  10129. serialize(parent: any): any;
  10130. }
  10131. /**
  10132. * This defines an action responsible to trigger several actions once triggered.
  10133. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10134. */
  10135. export class CombineAction extends Action {
  10136. /**
  10137. * The list of aggregated animations to run.
  10138. */
  10139. children: Action[];
  10140. /**
  10141. * Instantiate the action
  10142. * @param triggerOptions defines the trigger options
  10143. * @param children defines the list of aggregated animations to run
  10144. * @param condition defines the trigger related conditions
  10145. */
  10146. constructor(triggerOptions: any, children: Action[], condition?: Condition);
  10147. /** @hidden */
  10148. _prepare(): void;
  10149. /**
  10150. * Execute the action and executes all the aggregated actions.
  10151. */
  10152. execute(evt: ActionEvent): void;
  10153. /**
  10154. * Serializes the actions and its related information.
  10155. * @param parent defines the object to serialize in
  10156. * @returns the serialized object
  10157. */
  10158. serialize(parent: any): any;
  10159. }
  10160. /**
  10161. * This defines an action responsible to run code (external event) once triggered.
  10162. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10163. */
  10164. export class ExecuteCodeAction extends Action {
  10165. /**
  10166. * The callback function to run.
  10167. */
  10168. func: (evt: ActionEvent) => void;
  10169. /**
  10170. * Instantiate the action
  10171. * @param triggerOptions defines the trigger options
  10172. * @param func defines the callback function to run
  10173. * @param condition defines the trigger related conditions
  10174. */
  10175. constructor(triggerOptions: any, func: (evt: ActionEvent) => void, condition?: Condition);
  10176. /**
  10177. * Execute the action and run the attached code.
  10178. */
  10179. execute(evt: ActionEvent): void;
  10180. }
  10181. /**
  10182. * This defines an action responsible to set the parent property of the target once triggered.
  10183. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10184. */
  10185. export class SetParentAction extends Action {
  10186. private _parent;
  10187. private _target;
  10188. /**
  10189. * Instantiate the action
  10190. * @param triggerOptions defines the trigger options
  10191. * @param target defines the target containing the parent property
  10192. * @param parent defines from where the animation should start (animation frame)
  10193. * @param condition defines the trigger related conditions
  10194. */
  10195. constructor(triggerOptions: any, target: any, parent: any, condition?: Condition);
  10196. /** @hidden */
  10197. _prepare(): void;
  10198. /**
  10199. * Execute the action and set the parent property.
  10200. */
  10201. execute(): void;
  10202. /**
  10203. * Serializes the actions and its related information.
  10204. * @param parent defines the object to serialize in
  10205. * @returns the serialized object
  10206. */
  10207. serialize(parent: any): any;
  10208. }
  10209. }
  10210. declare module "babylonjs/Actions/actionManager" {
  10211. import { Nullable } from "babylonjs/types";
  10212. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10213. import { Scene } from "babylonjs/scene";
  10214. import { IAction } from "babylonjs/Actions/action";
  10215. import { IActionEvent } from "babylonjs/Actions/actionEvent";
  10216. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  10217. /**
  10218. * Action Manager manages all events to be triggered on a given mesh or the global scene.
  10219. * A single scene can have many Action Managers to handle predefined actions on specific meshes.
  10220. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10221. */
  10222. export class ActionManager extends AbstractActionManager {
  10223. /**
  10224. * Nothing
  10225. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10226. */
  10227. static readonly NothingTrigger: number;
  10228. /**
  10229. * On pick
  10230. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10231. */
  10232. static readonly OnPickTrigger: number;
  10233. /**
  10234. * On left pick
  10235. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10236. */
  10237. static readonly OnLeftPickTrigger: number;
  10238. /**
  10239. * On right pick
  10240. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10241. */
  10242. static readonly OnRightPickTrigger: number;
  10243. /**
  10244. * On center pick
  10245. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10246. */
  10247. static readonly OnCenterPickTrigger: number;
  10248. /**
  10249. * On pick down
  10250. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10251. */
  10252. static readonly OnPickDownTrigger: number;
  10253. /**
  10254. * On double pick
  10255. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10256. */
  10257. static readonly OnDoublePickTrigger: number;
  10258. /**
  10259. * On pick up
  10260. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10261. */
  10262. static readonly OnPickUpTrigger: number;
  10263. /**
  10264. * On pick out.
  10265. * This trigger will only be raised if you also declared a OnPickDown
  10266. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10267. */
  10268. static readonly OnPickOutTrigger: number;
  10269. /**
  10270. * On long press
  10271. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10272. */
  10273. static readonly OnLongPressTrigger: number;
  10274. /**
  10275. * On pointer over
  10276. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10277. */
  10278. static readonly OnPointerOverTrigger: number;
  10279. /**
  10280. * On pointer out
  10281. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10282. */
  10283. static readonly OnPointerOutTrigger: number;
  10284. /**
  10285. * On every frame
  10286. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10287. */
  10288. static readonly OnEveryFrameTrigger: number;
  10289. /**
  10290. * On intersection enter
  10291. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10292. */
  10293. static readonly OnIntersectionEnterTrigger: number;
  10294. /**
  10295. * On intersection exit
  10296. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10297. */
  10298. static readonly OnIntersectionExitTrigger: number;
  10299. /**
  10300. * On key down
  10301. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10302. */
  10303. static readonly OnKeyDownTrigger: number;
  10304. /**
  10305. * On key up
  10306. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10307. */
  10308. static readonly OnKeyUpTrigger: number;
  10309. private _scene;
  10310. /**
  10311. * Creates a new action manager
  10312. * @param scene defines the hosting scene
  10313. */
  10314. constructor(scene: Scene);
  10315. /**
  10316. * Releases all associated resources
  10317. */
  10318. dispose(): void;
  10319. /**
  10320. * Gets hosting scene
  10321. * @returns the hosting scene
  10322. */
  10323. getScene(): Scene;
  10324. /**
  10325. * Does this action manager handles actions of any of the given triggers
  10326. * @param triggers defines the triggers to be tested
  10327. * @return a boolean indicating whether one (or more) of the triggers is handled
  10328. */
  10329. hasSpecificTriggers(triggers: number[]): boolean;
  10330. /**
  10331. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  10332. * speed.
  10333. * @param triggerA defines the trigger to be tested
  10334. * @param triggerB defines the trigger to be tested
  10335. * @return a boolean indicating whether one (or more) of the triggers is handled
  10336. */
  10337. hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  10338. /**
  10339. * Does this action manager handles actions of a given trigger
  10340. * @param trigger defines the trigger to be tested
  10341. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  10342. * @return whether the trigger is handled
  10343. */
  10344. hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  10345. /**
  10346. * Does this action manager has pointer triggers
  10347. */
  10348. get hasPointerTriggers(): boolean;
  10349. /**
  10350. * Does this action manager has pick triggers
  10351. */
  10352. get hasPickTriggers(): boolean;
  10353. /**
  10354. * Registers an action to this action manager
  10355. * @param action defines the action to be registered
  10356. * @return the action amended (prepared) after registration
  10357. */
  10358. registerAction(action: IAction): Nullable<IAction>;
  10359. /**
  10360. * Unregisters an action to this action manager
  10361. * @param action defines the action to be unregistered
  10362. * @return a boolean indicating whether the action has been unregistered
  10363. */
  10364. unregisterAction(action: IAction): Boolean;
  10365. /**
  10366. * Process a specific trigger
  10367. * @param trigger defines the trigger to process
  10368. * @param evt defines the event details to be processed
  10369. */
  10370. processTrigger(trigger: number, evt?: IActionEvent): void;
  10371. /** @hidden */
  10372. _getEffectiveTarget(target: any, propertyPath: string): any;
  10373. /** @hidden */
  10374. _getProperty(propertyPath: string): string;
  10375. /**
  10376. * Serialize this manager to a JSON object
  10377. * @param name defines the property name to store this manager
  10378. * @returns a JSON representation of this manager
  10379. */
  10380. serialize(name: string): any;
  10381. /**
  10382. * Creates a new ActionManager from a JSON data
  10383. * @param parsedActions defines the JSON data to read from
  10384. * @param object defines the hosting mesh
  10385. * @param scene defines the hosting scene
  10386. */
  10387. static Parse(parsedActions: any, object: Nullable<AbstractMesh>, scene: Scene): void;
  10388. /**
  10389. * Get a trigger name by index
  10390. * @param trigger defines the trigger index
  10391. * @returns a trigger name
  10392. */
  10393. static GetTriggerName(trigger: number): string;
  10394. }
  10395. }
  10396. declare module "babylonjs/Sprites/sprite" {
  10397. import { Vector3 } from "babylonjs/Maths/math.vector";
  10398. import { Nullable } from "babylonjs/types";
  10399. import { ActionManager } from "babylonjs/Actions/actionManager";
  10400. import { ISpriteManager, SpriteManager } from "babylonjs/Sprites/spriteManager";
  10401. import { Color4 } from "babylonjs/Maths/math.color";
  10402. import { Observable } from "babylonjs/Misc/observable";
  10403. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  10404. import { Animation } from "babylonjs/Animations/animation";
  10405. /**
  10406. * Class used to represent a sprite
  10407. * @see https://doc.babylonjs.com/babylon101/sprites
  10408. */
  10409. export class Sprite implements IAnimatable {
  10410. /** defines the name */
  10411. name: string;
  10412. /** Gets or sets the current world position */
  10413. position: Vector3;
  10414. /** Gets or sets the main color */
  10415. color: Color4;
  10416. /** Gets or sets the width */
  10417. width: number;
  10418. /** Gets or sets the height */
  10419. height: number;
  10420. /** Gets or sets rotation angle */
  10421. angle: number;
  10422. /** Gets or sets the cell index in the sprite sheet */
  10423. cellIndex: number;
  10424. /** Gets or sets the cell reference in the sprite sheet, uses sprite's filename when added to sprite sheet */
  10425. cellRef: string;
  10426. /** Gets or sets a boolean indicating if UV coordinates should be inverted in U axis */
  10427. invertU: boolean;
  10428. /** Gets or sets a boolean indicating if UV coordinates should be inverted in B axis */
  10429. invertV: boolean;
  10430. /** Gets or sets a boolean indicating that this sprite should be disposed after animation ends */
  10431. disposeWhenFinishedAnimating: boolean;
  10432. /** Gets the list of attached animations */
  10433. animations: Nullable<Array<Animation>>;
  10434. /** Gets or sets a boolean indicating if the sprite can be picked */
  10435. isPickable: boolean;
  10436. /** Gets or sets a boolean indicating that sprite texture alpha will be used for precise picking (false by default) */
  10437. useAlphaForPicking: boolean;
  10438. /** @hidden */
  10439. _xOffset: number;
  10440. /** @hidden */
  10441. _yOffset: number;
  10442. /** @hidden */
  10443. _xSize: number;
  10444. /** @hidden */
  10445. _ySize: number;
  10446. /**
  10447. * Gets or sets the associated action manager
  10448. */
  10449. actionManager: Nullable<ActionManager>;
  10450. /**
  10451. * An event triggered when the control has been disposed
  10452. */
  10453. onDisposeObservable: Observable<Sprite>;
  10454. private _animationStarted;
  10455. private _loopAnimation;
  10456. private _fromIndex;
  10457. private _toIndex;
  10458. private _delay;
  10459. private _direction;
  10460. private _manager;
  10461. private _time;
  10462. private _onAnimationEnd;
  10463. /**
  10464. * Gets or sets a boolean indicating if the sprite is visible (renderable). Default is true
  10465. */
  10466. isVisible: boolean;
  10467. /**
  10468. * Gets or sets the sprite size
  10469. */
  10470. get size(): number;
  10471. set size(value: number);
  10472. /**
  10473. * Returns a boolean indicating if the animation is started
  10474. */
  10475. get animationStarted(): boolean;
  10476. /**
  10477. * Gets or sets the unique id of the sprite
  10478. */
  10479. uniqueId: number;
  10480. /**
  10481. * Gets the manager of this sprite
  10482. */
  10483. get manager(): ISpriteManager;
  10484. /**
  10485. * Creates a new Sprite
  10486. * @param name defines the name
  10487. * @param manager defines the manager
  10488. */
  10489. constructor(
  10490. /** defines the name */
  10491. name: string, manager: ISpriteManager);
  10492. /**
  10493. * Returns the string "Sprite"
  10494. * @returns "Sprite"
  10495. */
  10496. getClassName(): string;
  10497. /** Gets or sets the initial key for the animation (setting it will restart the animation) */
  10498. get fromIndex(): number;
  10499. set fromIndex(value: number);
  10500. /** Gets or sets the end key for the animation (setting it will restart the animation) */
  10501. get toIndex(): number;
  10502. set toIndex(value: number);
  10503. /** Gets or sets a boolean indicating if the animation is looping (setting it will restart the animation) */
  10504. get loopAnimation(): boolean;
  10505. set loopAnimation(value: boolean);
  10506. /** Gets or sets the delay between cell changes (setting it will restart the animation) */
  10507. get delay(): number;
  10508. set delay(value: number);
  10509. /**
  10510. * Starts an animation
  10511. * @param from defines the initial key
  10512. * @param to defines the end key
  10513. * @param loop defines if the animation must loop
  10514. * @param delay defines the start delay (in ms)
  10515. * @param onAnimationEnd defines a callback to call when animation ends
  10516. */
  10517. playAnimation(from: number, to: number, loop: boolean, delay: number, onAnimationEnd?: Nullable<() => void>): void;
  10518. /** Stops current animation (if any) */
  10519. stopAnimation(): void;
  10520. /** @hidden */
  10521. _animate(deltaTime: number): void;
  10522. /** Release associated resources */
  10523. dispose(): void;
  10524. /**
  10525. * Serializes the sprite to a JSON object
  10526. * @returns the JSON object
  10527. */
  10528. serialize(): any;
  10529. /**
  10530. * Parses a JSON object to create a new sprite
  10531. * @param parsedSprite The JSON object to parse
  10532. * @param manager defines the hosting manager
  10533. * @returns the new sprite
  10534. */
  10535. static Parse(parsedSprite: any, manager: SpriteManager): Sprite;
  10536. }
  10537. }
  10538. declare module "babylonjs/Collisions/pickingInfo" {
  10539. import { Nullable } from "babylonjs/types";
  10540. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  10541. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10542. import { Sprite } from "babylonjs/Sprites/sprite";
  10543. import { Ray } from "babylonjs/Culling/ray";
  10544. /**
  10545. * Information about the result of picking within a scene
  10546. * @see https://doc.babylonjs.com/babylon101/picking_collisions
  10547. */
  10548. export class PickingInfo {
  10549. /** @hidden */
  10550. _pickingUnavailable: boolean;
  10551. /**
  10552. * If the pick collided with an object
  10553. */
  10554. hit: boolean;
  10555. /**
  10556. * Distance away where the pick collided
  10557. */
  10558. distance: number;
  10559. /**
  10560. * The location of pick collision
  10561. */
  10562. pickedPoint: Nullable<Vector3>;
  10563. /**
  10564. * The mesh corresponding the the pick collision
  10565. */
  10566. pickedMesh: Nullable<AbstractMesh>;
  10567. /** (See getTextureCoordinates) The barycentric U coordinate that is used when calculating the texture coordinates of the collision.*/
  10568. bu: number;
  10569. /** (See getTextureCoordinates) The barycentric V coordinate that is used when calculating the texture coordinates of the collision.*/
  10570. bv: number;
  10571. /** The index of the face on the mesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  10572. faceId: number;
  10573. /** The index of the face on the subMesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  10574. subMeshFaceId: number;
  10575. /** Id of the the submesh that was picked */
  10576. subMeshId: number;
  10577. /** If a sprite was picked, this will be the sprite the pick collided with */
  10578. pickedSprite: Nullable<Sprite>;
  10579. /** If we are pikcing a mesh with thin instance, this will give you the picked thin instance */
  10580. thinInstanceIndex: number;
  10581. /**
  10582. * If a mesh was used to do the picking (eg. 6dof controller) this will be populated.
  10583. */
  10584. originMesh: Nullable<AbstractMesh>;
  10585. /**
  10586. * The ray that was used to perform the picking.
  10587. */
  10588. ray: Nullable<Ray>;
  10589. /**
  10590. * Gets the normal correspodning to the face the pick collided with
  10591. * @param useWorldCoordinates If the resulting normal should be relative to the world (default: false)
  10592. * @param useVerticesNormals If the vertices normals should be used to calculate the normal instead of the normal map
  10593. * @returns The normal correspodning to the face the pick collided with
  10594. */
  10595. getNormal(useWorldCoordinates?: boolean, useVerticesNormals?: boolean): Nullable<Vector3>;
  10596. /**
  10597. * Gets the texture coordinates of where the pick occured
  10598. * @returns the vector containing the coordnates of the texture
  10599. */
  10600. getTextureCoordinates(): Nullable<Vector2>;
  10601. }
  10602. }
  10603. declare module "babylonjs/Culling/ray" {
  10604. import { DeepImmutable, Nullable, float } from "babylonjs/types";
  10605. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  10606. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10607. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  10608. import { IntersectionInfo } from "babylonjs/Collisions/intersectionInfo";
  10609. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  10610. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  10611. import { Plane } from "babylonjs/Maths/math.plane";
  10612. /**
  10613. * Class representing a ray with position and direction
  10614. */
  10615. export class Ray {
  10616. /** origin point */
  10617. origin: Vector3;
  10618. /** direction */
  10619. direction: Vector3;
  10620. /** length of the ray */
  10621. length: number;
  10622. private static readonly _TmpVector3;
  10623. private _tmpRay;
  10624. /**
  10625. * Creates a new ray
  10626. * @param origin origin point
  10627. * @param direction direction
  10628. * @param length length of the ray
  10629. */
  10630. constructor(
  10631. /** origin point */
  10632. origin: Vector3,
  10633. /** direction */
  10634. direction: Vector3,
  10635. /** length of the ray */
  10636. length?: number);
  10637. /**
  10638. * Checks if the ray intersects a box
  10639. * This does not account for the ray lenght by design to improve perfs.
  10640. * @param minimum bound of the box
  10641. * @param maximum bound of the box
  10642. * @param intersectionTreshold extra extend to be added to the box in all direction
  10643. * @returns if the box was hit
  10644. */
  10645. intersectsBoxMinMax(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, intersectionTreshold?: number): boolean;
  10646. /**
  10647. * Checks if the ray intersects a box
  10648. * This does not account for the ray lenght by design to improve perfs.
  10649. * @param box the bounding box to check
  10650. * @param intersectionTreshold extra extend to be added to the BoundingBox in all direction
  10651. * @returns if the box was hit
  10652. */
  10653. intersectsBox(box: DeepImmutable<BoundingBox>, intersectionTreshold?: number): boolean;
  10654. /**
  10655. * If the ray hits a sphere
  10656. * @param sphere the bounding sphere to check
  10657. * @param intersectionTreshold extra extend to be added to the BoundingSphere in all direction
  10658. * @returns true if it hits the sphere
  10659. */
  10660. intersectsSphere(sphere: DeepImmutable<BoundingSphere>, intersectionTreshold?: number): boolean;
  10661. /**
  10662. * If the ray hits a triange
  10663. * @param vertex0 triangle vertex
  10664. * @param vertex1 triangle vertex
  10665. * @param vertex2 triangle vertex
  10666. * @returns intersection information if hit
  10667. */
  10668. intersectsTriangle(vertex0: DeepImmutable<Vector3>, vertex1: DeepImmutable<Vector3>, vertex2: DeepImmutable<Vector3>): Nullable<IntersectionInfo>;
  10669. /**
  10670. * Checks if ray intersects a plane
  10671. * @param plane the plane to check
  10672. * @returns the distance away it was hit
  10673. */
  10674. intersectsPlane(plane: DeepImmutable<Plane>): Nullable<number>;
  10675. /**
  10676. * Calculate the intercept of a ray on a given axis
  10677. * @param axis to check 'x' | 'y' | 'z'
  10678. * @param offset from axis interception (i.e. an offset of 1y is intercepted above ground)
  10679. * @returns a vector containing the coordinates where 'axis' is equal to zero (else offset), or null if there is no intercept.
  10680. */
  10681. intersectsAxis(axis: string, offset?: number): Nullable<Vector3>;
  10682. /**
  10683. * Checks if ray intersects a mesh
  10684. * @param mesh the mesh to check
  10685. * @param fastCheck defines if the first intersection will be used (and not the closest)
  10686. * @returns picking info of the intersecton
  10687. */
  10688. intersectsMesh(mesh: DeepImmutable<AbstractMesh>, fastCheck?: boolean): PickingInfo;
  10689. /**
  10690. * Checks if ray intersects a mesh
  10691. * @param meshes the meshes to check
  10692. * @param fastCheck defines if the first intersection will be used (and not the closest)
  10693. * @param results array to store result in
  10694. * @returns Array of picking infos
  10695. */
  10696. intersectsMeshes(meshes: Array<DeepImmutable<AbstractMesh>>, fastCheck?: boolean, results?: Array<PickingInfo>): Array<PickingInfo>;
  10697. private _comparePickingInfo;
  10698. private static smallnum;
  10699. private static rayl;
  10700. /**
  10701. * Intersection test between the ray and a given segment whithin a given tolerance (threshold)
  10702. * @param sega the first point of the segment to test the intersection against
  10703. * @param segb the second point of the segment to test the intersection against
  10704. * @param threshold the tolerance margin, if the ray doesn't intersect the segment but is close to the given threshold, the intersection is successful
  10705. * @return the distance from the ray origin to the intersection point if there's intersection, or -1 if there's no intersection
  10706. */
  10707. intersectionSegment(sega: DeepImmutable<Vector3>, segb: DeepImmutable<Vector3>, threshold: number): number;
  10708. /**
  10709. * Update the ray from viewport position
  10710. * @param x position
  10711. * @param y y position
  10712. * @param viewportWidth viewport width
  10713. * @param viewportHeight viewport height
  10714. * @param world world matrix
  10715. * @param view view matrix
  10716. * @param projection projection matrix
  10717. * @returns this ray updated
  10718. */
  10719. update(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  10720. /**
  10721. * Creates a ray with origin and direction of 0,0,0
  10722. * @returns the new ray
  10723. */
  10724. static Zero(): Ray;
  10725. /**
  10726. * Creates a new ray from screen space and viewport
  10727. * @param x position
  10728. * @param y y position
  10729. * @param viewportWidth viewport width
  10730. * @param viewportHeight viewport height
  10731. * @param world world matrix
  10732. * @param view view matrix
  10733. * @param projection projection matrix
  10734. * @returns new ray
  10735. */
  10736. static CreateNew(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  10737. /**
  10738. * Function will create a new transformed ray starting from origin and ending at the end point. Ray's length will be set, and ray will be
  10739. * transformed to the given world matrix.
  10740. * @param origin The origin point
  10741. * @param end The end point
  10742. * @param world a matrix to transform the ray to. Default is the identity matrix.
  10743. * @returns the new ray
  10744. */
  10745. static CreateNewFromTo(origin: Vector3, end: Vector3, world?: DeepImmutable<Matrix>): Ray;
  10746. /**
  10747. * Transforms a ray by a matrix
  10748. * @param ray ray to transform
  10749. * @param matrix matrix to apply
  10750. * @returns the resulting new ray
  10751. */
  10752. static Transform(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>): Ray;
  10753. /**
  10754. * Transforms a ray by a matrix
  10755. * @param ray ray to transform
  10756. * @param matrix matrix to apply
  10757. * @param result ray to store result in
  10758. */
  10759. static TransformToRef(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>, result: Ray): void;
  10760. /**
  10761. * Unproject a ray from screen space to object space
  10762. * @param sourceX defines the screen space x coordinate to use
  10763. * @param sourceY defines the screen space y coordinate to use
  10764. * @param viewportWidth defines the current width of the viewport
  10765. * @param viewportHeight defines the current height of the viewport
  10766. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  10767. * @param view defines the view matrix to use
  10768. * @param projection defines the projection matrix to use
  10769. */
  10770. unprojectRayToRef(sourceX: float, sourceY: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): void;
  10771. }
  10772. /**
  10773. * Type used to define predicate used to select faces when a mesh intersection is detected
  10774. */
  10775. export type TrianglePickingPredicate = (p0: Vector3, p1: Vector3, p2: Vector3, ray: Ray) => boolean;
  10776. module "babylonjs/scene" {
  10777. interface Scene {
  10778. /** @hidden */
  10779. _tempPickingRay: Nullable<Ray>;
  10780. /** @hidden */
  10781. _cachedRayForTransform: Ray;
  10782. /** @hidden */
  10783. _pickWithRayInverseMatrix: Matrix;
  10784. /** @hidden */
  10785. _internalPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, onlyBoundingInfo?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  10786. /** @hidden */
  10787. _internalMultiPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  10788. /** @hidden */
  10789. _internalPickForMesh(pickingInfo: Nullable<PickingInfo>, rayFunction: (world: Matrix) => Ray, mesh: AbstractMesh, world: Matrix, fastCheck?: boolean, onlyBoundingInfo?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  10790. }
  10791. }
  10792. }
  10793. declare module "babylonjs/sceneComponent" {
  10794. import { Scene } from "babylonjs/scene";
  10795. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10796. import { SubMesh } from "babylonjs/Meshes/subMesh";
  10797. import { _InstancesBatch } from "babylonjs/Meshes/mesh";
  10798. import { SmartArrayNoDuplicate } from "babylonjs/Misc/smartArray";
  10799. import { Nullable } from "babylonjs/types";
  10800. import { Camera } from "babylonjs/Cameras/camera";
  10801. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  10802. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  10803. import { AbstractScene } from "babylonjs/abstractScene";
  10804. import { Mesh } from "babylonjs/Meshes/mesh";
  10805. /**
  10806. * Groups all the scene component constants in one place to ease maintenance.
  10807. * @hidden
  10808. */
  10809. export class SceneComponentConstants {
  10810. static readonly NAME_EFFECTLAYER: string;
  10811. static readonly NAME_LAYER: string;
  10812. static readonly NAME_LENSFLARESYSTEM: string;
  10813. static readonly NAME_BOUNDINGBOXRENDERER: string;
  10814. static readonly NAME_PARTICLESYSTEM: string;
  10815. static readonly NAME_GAMEPAD: string;
  10816. static readonly NAME_SIMPLIFICATIONQUEUE: string;
  10817. static readonly NAME_GEOMETRYBUFFERRENDERER: string;
  10818. static readonly NAME_PREPASSRENDERER: string;
  10819. static readonly NAME_DEPTHRENDERER: string;
  10820. static readonly NAME_POSTPROCESSRENDERPIPELINEMANAGER: string;
  10821. static readonly NAME_SPRITE: string;
  10822. static readonly NAME_OUTLINERENDERER: string;
  10823. static readonly NAME_PROCEDURALTEXTURE: string;
  10824. static readonly NAME_SHADOWGENERATOR: string;
  10825. static readonly NAME_OCTREE: string;
  10826. static readonly NAME_PHYSICSENGINE: string;
  10827. static readonly NAME_AUDIO: string;
  10828. static readonly STEP_ISREADYFORMESH_EFFECTLAYER: number;
  10829. static readonly STEP_BEFOREEVALUATEACTIVEMESH_BOUNDINGBOXRENDERER: number;
  10830. static readonly STEP_EVALUATESUBMESH_BOUNDINGBOXRENDERER: number;
  10831. static readonly STEP_ACTIVEMESH_BOUNDINGBOXRENDERER: number;
  10832. static readonly STEP_CAMERADRAWRENDERTARGET_EFFECTLAYER: number;
  10833. static readonly STEP_BEFORECAMERADRAW_EFFECTLAYER: number;
  10834. static readonly STEP_BEFORECAMERADRAW_LAYER: number;
  10835. static readonly STEP_BEFORECAMERADRAW_PREPASS: number;
  10836. static readonly STEP_BEFORERENDERTARGETDRAW_LAYER: number;
  10837. static readonly STEP_BEFORERENDERINGMESH_OUTLINE: number;
  10838. static readonly STEP_AFTERRENDERINGMESH_OUTLINE: number;
  10839. static readonly STEP_AFTERRENDERINGGROUPDRAW_EFFECTLAYER_DRAW: number;
  10840. static readonly STEP_AFTERRENDERINGGROUPDRAW_BOUNDINGBOXRENDERER: number;
  10841. static readonly STEP_BEFORECAMERAUPDATE_SIMPLIFICATIONQUEUE: number;
  10842. static readonly STEP_BEFORECAMERAUPDATE_GAMEPAD: number;
  10843. static readonly STEP_BEFORECLEAR_PROCEDURALTEXTURE: number;
  10844. static readonly STEP_AFTERRENDERTARGETDRAW_LAYER: number;
  10845. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER: number;
  10846. static readonly STEP_AFTERCAMERADRAW_LENSFLARESYSTEM: number;
  10847. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER_DRAW: number;
  10848. static readonly STEP_AFTERCAMERADRAW_LAYER: number;
  10849. static readonly STEP_AFTERCAMERADRAW_PREPASS: number;
  10850. static readonly STEP_AFTERRENDER_AUDIO: number;
  10851. static readonly STEP_GATHERRENDERTARGETS_DEPTHRENDERER: number;
  10852. static readonly STEP_GATHERRENDERTARGETS_GEOMETRYBUFFERRENDERER: number;
  10853. static readonly STEP_GATHERRENDERTARGETS_SHADOWGENERATOR: number;
  10854. static readonly STEP_GATHERRENDERTARGETS_POSTPROCESSRENDERPIPELINEMANAGER: number;
  10855. static readonly STEP_GATHERACTIVECAMERARENDERTARGETS_DEPTHRENDERER: number;
  10856. static readonly STEP_BEFORECLEARSTAGE_PREPASS: number;
  10857. static readonly STEP_POINTERMOVE_SPRITE: number;
  10858. static readonly STEP_POINTERDOWN_SPRITE: number;
  10859. static readonly STEP_POINTERUP_SPRITE: number;
  10860. }
  10861. /**
  10862. * This represents a scene component.
  10863. *
  10864. * This is used to decouple the dependency the scene is having on the different workloads like
  10865. * layers, post processes...
  10866. */
  10867. export interface ISceneComponent {
  10868. /**
  10869. * The name of the component. Each component must have a unique name.
  10870. */
  10871. name: string;
  10872. /**
  10873. * The scene the component belongs to.
  10874. */
  10875. scene: Scene;
  10876. /**
  10877. * Register the component to one instance of a scene.
  10878. */
  10879. register(): void;
  10880. /**
  10881. * Rebuilds the elements related to this component in case of
  10882. * context lost for instance.
  10883. */
  10884. rebuild(): void;
  10885. /**
  10886. * Disposes the component and the associated ressources.
  10887. */
  10888. dispose(): void;
  10889. }
  10890. /**
  10891. * This represents a SERIALIZABLE scene component.
  10892. *
  10893. * This extends Scene Component to add Serialization methods on top.
  10894. */
  10895. export interface ISceneSerializableComponent extends ISceneComponent {
  10896. /**
  10897. * Adds all the elements from the container to the scene
  10898. * @param container the container holding the elements
  10899. */
  10900. addFromContainer(container: AbstractScene): void;
  10901. /**
  10902. * Removes all the elements in the container from the scene
  10903. * @param container contains the elements to remove
  10904. * @param dispose if the removed element should be disposed (default: false)
  10905. */
  10906. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  10907. /**
  10908. * Serializes the component data to the specified json object
  10909. * @param serializationObject The object to serialize to
  10910. */
  10911. serialize(serializationObject: any): void;
  10912. }
  10913. /**
  10914. * Strong typing of a Mesh related stage step action
  10915. */
  10916. export type MeshStageAction = (mesh: AbstractMesh, hardwareInstancedRendering: boolean) => boolean;
  10917. /**
  10918. * Strong typing of a Evaluate Sub Mesh related stage step action
  10919. */
  10920. export type EvaluateSubMeshStageAction = (mesh: AbstractMesh, subMesh: SubMesh) => void;
  10921. /**
  10922. * Strong typing of a Active Mesh related stage step action
  10923. */
  10924. export type ActiveMeshStageAction = (sourceMesh: AbstractMesh, mesh: AbstractMesh) => void;
  10925. /**
  10926. * Strong typing of a Camera related stage step action
  10927. */
  10928. export type CameraStageAction = (camera: Camera) => void;
  10929. /**
  10930. * Strong typing of a Camera Frame buffer related stage step action
  10931. */
  10932. export type CameraStageFrameBufferAction = (camera: Camera) => boolean;
  10933. /**
  10934. * Strong typing of a Render Target related stage step action
  10935. */
  10936. export type RenderTargetStageAction = (renderTarget: RenderTargetTexture) => void;
  10937. /**
  10938. * Strong typing of a RenderingGroup related stage step action
  10939. */
  10940. export type RenderingGroupStageAction = (renderingGroupId: number) => void;
  10941. /**
  10942. * Strong typing of a Mesh Render related stage step action
  10943. */
  10944. export type RenderingMeshStageAction = (mesh: Mesh, subMesh: SubMesh, batch: _InstancesBatch) => void;
  10945. /**
  10946. * Strong typing of a simple stage step action
  10947. */
  10948. export type SimpleStageAction = () => void;
  10949. /**
  10950. * Strong typing of a render target action.
  10951. */
  10952. export type RenderTargetsStageAction = (renderTargets: SmartArrayNoDuplicate<RenderTargetTexture>) => void;
  10953. /**
  10954. * Strong typing of a pointer move action.
  10955. */
  10956. export type PointerMoveStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, isMeshPicked: boolean, element: HTMLElement) => Nullable<PickingInfo>;
  10957. /**
  10958. * Strong typing of a pointer up/down action.
  10959. */
  10960. export type PointerUpDownStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, evt: PointerEvent) => Nullable<PickingInfo>;
  10961. /**
  10962. * Representation of a stage in the scene (Basically a list of ordered steps)
  10963. * @hidden
  10964. */
  10965. export class Stage<T extends Function> extends Array<{
  10966. index: number;
  10967. component: ISceneComponent;
  10968. action: T;
  10969. }> {
  10970. /**
  10971. * Hide ctor from the rest of the world.
  10972. * @param items The items to add.
  10973. */
  10974. private constructor();
  10975. /**
  10976. * Creates a new Stage.
  10977. * @returns A new instance of a Stage
  10978. */
  10979. static Create<T extends Function>(): Stage<T>;
  10980. /**
  10981. * Registers a step in an ordered way in the targeted stage.
  10982. * @param index Defines the position to register the step in
  10983. * @param component Defines the component attached to the step
  10984. * @param action Defines the action to launch during the step
  10985. */
  10986. registerStep(index: number, component: ISceneComponent, action: T): void;
  10987. /**
  10988. * Clears all the steps from the stage.
  10989. */
  10990. clear(): void;
  10991. }
  10992. }
  10993. declare module "babylonjs/Sprites/spriteSceneComponent" {
  10994. import { Nullable } from "babylonjs/types";
  10995. import { Observable } from "babylonjs/Misc/observable";
  10996. import { Scene } from "babylonjs/scene";
  10997. import { Sprite } from "babylonjs/Sprites/sprite";
  10998. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  10999. import { Ray } from "babylonjs/Culling/ray";
  11000. import { Camera } from "babylonjs/Cameras/camera";
  11001. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  11002. import { ISceneComponent } from "babylonjs/sceneComponent";
  11003. module "babylonjs/scene" {
  11004. interface Scene {
  11005. /** @hidden */
  11006. _pointerOverSprite: Nullable<Sprite>;
  11007. /** @hidden */
  11008. _pickedDownSprite: Nullable<Sprite>;
  11009. /** @hidden */
  11010. _tempSpritePickingRay: Nullable<Ray>;
  11011. /**
  11012. * All of the sprite managers added to this scene
  11013. * @see https://doc.babylonjs.com/babylon101/sprites
  11014. */
  11015. spriteManagers: Array<ISpriteManager>;
  11016. /**
  11017. * An event triggered when sprites rendering is about to start
  11018. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  11019. */
  11020. onBeforeSpritesRenderingObservable: Observable<Scene>;
  11021. /**
  11022. * An event triggered when sprites rendering is done
  11023. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  11024. */
  11025. onAfterSpritesRenderingObservable: Observable<Scene>;
  11026. /** @hidden */
  11027. _internalPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  11028. /** Launch a ray to try to pick a sprite in the scene
  11029. * @param x position on screen
  11030. * @param y position on screen
  11031. * @param predicate Predicate function used to determine eligible sprites. Can be set to null. In this case, a sprite must have isPickable set to true
  11032. * @param fastCheck defines if the first intersection will be used (and not the closest)
  11033. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  11034. * @returns a PickingInfo
  11035. */
  11036. pickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  11037. /** Use the given ray to pick a sprite in the scene
  11038. * @param ray The ray (in world space) to use to pick meshes
  11039. * @param predicate Predicate function used to determine eligible sprites. Can be set to null. In this case, a sprite must have isPickable set to true
  11040. * @param fastCheck defines if the first intersection will be used (and not the closest)
  11041. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  11042. * @returns a PickingInfo
  11043. */
  11044. pickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  11045. /** @hidden */
  11046. _internalMultiPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  11047. /** Launch a ray to try to pick sprites in the scene
  11048. * @param x position on screen
  11049. * @param y position on screen
  11050. * @param predicate Predicate function used to determine eligible sprites. Can be set to null. In this case, a sprite must have isPickable set to true
  11051. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  11052. * @returns a PickingInfo array
  11053. */
  11054. multiPickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  11055. /** Use the given ray to pick sprites in the scene
  11056. * @param ray The ray (in world space) to use to pick meshes
  11057. * @param predicate Predicate function used to determine eligible sprites. Can be set to null. In this case, a sprite must have isPickable set to true
  11058. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  11059. * @returns a PickingInfo array
  11060. */
  11061. multiPickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  11062. /**
  11063. * Force the sprite under the pointer
  11064. * @param sprite defines the sprite to use
  11065. */
  11066. setPointerOverSprite(sprite: Nullable<Sprite>): void;
  11067. /**
  11068. * Gets the sprite under the pointer
  11069. * @returns a Sprite or null if no sprite is under the pointer
  11070. */
  11071. getPointerOverSprite(): Nullable<Sprite>;
  11072. }
  11073. }
  11074. /**
  11075. * Defines the sprite scene component responsible to manage sprites
  11076. * in a given scene.
  11077. */
  11078. export class SpriteSceneComponent implements ISceneComponent {
  11079. /**
  11080. * The component name helpfull to identify the component in the list of scene components.
  11081. */
  11082. readonly name: string;
  11083. /**
  11084. * The scene the component belongs to.
  11085. */
  11086. scene: Scene;
  11087. /** @hidden */
  11088. private _spritePredicate;
  11089. /**
  11090. * Creates a new instance of the component for the given scene
  11091. * @param scene Defines the scene to register the component in
  11092. */
  11093. constructor(scene: Scene);
  11094. /**
  11095. * Registers the component in a given scene
  11096. */
  11097. register(): void;
  11098. /**
  11099. * Rebuilds the elements related to this component in case of
  11100. * context lost for instance.
  11101. */
  11102. rebuild(): void;
  11103. /**
  11104. * Disposes the component and the associated ressources.
  11105. */
  11106. dispose(): void;
  11107. private _pickSpriteButKeepRay;
  11108. private _pointerMove;
  11109. private _pointerDown;
  11110. private _pointerUp;
  11111. }
  11112. }
  11113. declare module "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration" {
  11114. /** @hidden */
  11115. export var fogFragmentDeclaration: {
  11116. name: string;
  11117. shader: string;
  11118. };
  11119. }
  11120. declare module "babylonjs/Shaders/ShadersInclude/fogFragment" {
  11121. /** @hidden */
  11122. export var fogFragment: {
  11123. name: string;
  11124. shader: string;
  11125. };
  11126. }
  11127. declare module "babylonjs/Shaders/sprites.fragment" {
  11128. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  11129. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  11130. /** @hidden */
  11131. export var spritesPixelShader: {
  11132. name: string;
  11133. shader: string;
  11134. };
  11135. }
  11136. declare module "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration" {
  11137. /** @hidden */
  11138. export var fogVertexDeclaration: {
  11139. name: string;
  11140. shader: string;
  11141. };
  11142. }
  11143. declare module "babylonjs/Shaders/sprites.vertex" {
  11144. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  11145. /** @hidden */
  11146. export var spritesVertexShader: {
  11147. name: string;
  11148. shader: string;
  11149. };
  11150. }
  11151. declare module "babylonjs/Sprites/spriteManager" {
  11152. import { IDisposable, Scene } from "babylonjs/scene";
  11153. import { Nullable } from "babylonjs/types";
  11154. import { Observable } from "babylonjs/Misc/observable";
  11155. import { Sprite } from "babylonjs/Sprites/sprite";
  11156. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  11157. import { Camera } from "babylonjs/Cameras/camera";
  11158. import { Texture } from "babylonjs/Materials/Textures/texture";
  11159. import "babylonjs/Shaders/sprites.fragment";
  11160. import "babylonjs/Shaders/sprites.vertex";
  11161. import { Ray } from "babylonjs/Culling/ray";
  11162. /**
  11163. * Defines the minimum interface to fullfil in order to be a sprite manager.
  11164. */
  11165. export interface ISpriteManager extends IDisposable {
  11166. /**
  11167. * Gets manager's name
  11168. */
  11169. name: string;
  11170. /**
  11171. * Restricts the camera to viewing objects with the same layerMask.
  11172. * A camera with a layerMask of 1 will render spriteManager.layerMask & camera.layerMask!== 0
  11173. */
  11174. layerMask: number;
  11175. /**
  11176. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  11177. */
  11178. isPickable: boolean;
  11179. /**
  11180. * Gets the hosting scene
  11181. */
  11182. scene: Scene;
  11183. /**
  11184. * Specifies the rendering group id for this mesh (0 by default)
  11185. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  11186. */
  11187. renderingGroupId: number;
  11188. /**
  11189. * Defines the list of sprites managed by the manager.
  11190. */
  11191. sprites: Array<Sprite>;
  11192. /**
  11193. * Gets or sets the spritesheet texture
  11194. */
  11195. texture: Texture;
  11196. /** Defines the default width of a cell in the spritesheet */
  11197. cellWidth: number;
  11198. /** Defines the default height of a cell in the spritesheet */
  11199. cellHeight: number;
  11200. /**
  11201. * Tests the intersection of a sprite with a specific ray.
  11202. * @param ray The ray we are sending to test the collision
  11203. * @param camera The camera space we are sending rays in
  11204. * @param predicate A predicate allowing excluding sprites from the list of object to test
  11205. * @param fastCheck defines if the first intersection will be used (and not the closest)
  11206. * @returns picking info or null.
  11207. */
  11208. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  11209. /**
  11210. * Intersects the sprites with a ray
  11211. * @param ray defines the ray to intersect with
  11212. * @param camera defines the current active camera
  11213. * @param predicate defines a predicate used to select candidate sprites
  11214. * @returns null if no hit or a PickingInfo array
  11215. */
  11216. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  11217. /**
  11218. * Renders the list of sprites on screen.
  11219. */
  11220. render(): void;
  11221. }
  11222. /**
  11223. * Class used to manage multiple sprites on the same spritesheet
  11224. * @see https://doc.babylonjs.com/babylon101/sprites
  11225. */
  11226. export class SpriteManager implements ISpriteManager {
  11227. /** defines the manager's name */
  11228. name: string;
  11229. /** Define the Url to load snippets */
  11230. static SnippetUrl: string;
  11231. /** Snippet ID if the manager was created from the snippet server */
  11232. snippetId: string;
  11233. /** Gets the list of sprites */
  11234. sprites: Sprite[];
  11235. /** Gets or sets the rendering group id (0 by default) */
  11236. renderingGroupId: number;
  11237. /** Gets or sets camera layer mask */
  11238. layerMask: number;
  11239. /** Gets or sets a boolean indicating if the manager must consider scene fog when rendering */
  11240. fogEnabled: boolean;
  11241. /** Gets or sets a boolean indicating if the sprites are pickable */
  11242. isPickable: boolean;
  11243. /** Defines the default width of a cell in the spritesheet */
  11244. cellWidth: number;
  11245. /** Defines the default height of a cell in the spritesheet */
  11246. cellHeight: number;
  11247. /** Associative array from JSON sprite data file */
  11248. private _cellData;
  11249. /** Array of sprite names from JSON sprite data file */
  11250. private _spriteMap;
  11251. /** True when packed cell data from JSON file is ready*/
  11252. private _packedAndReady;
  11253. private _textureContent;
  11254. private _useInstancing;
  11255. /**
  11256. * An event triggered when the manager is disposed.
  11257. */
  11258. onDisposeObservable: Observable<SpriteManager>;
  11259. private _onDisposeObserver;
  11260. /**
  11261. * Callback called when the manager is disposed
  11262. */
  11263. set onDispose(callback: () => void);
  11264. private _capacity;
  11265. private _fromPacked;
  11266. private _spriteTexture;
  11267. private _epsilon;
  11268. private _scene;
  11269. private _vertexData;
  11270. private _buffer;
  11271. private _vertexBuffers;
  11272. private _spriteBuffer;
  11273. private _indexBuffer;
  11274. private _effectBase;
  11275. private _effectFog;
  11276. private _vertexBufferSize;
  11277. /**
  11278. * Gets or sets the unique id of the sprite
  11279. */
  11280. uniqueId: number;
  11281. /**
  11282. * Gets the array of sprites
  11283. */
  11284. get children(): Sprite[];
  11285. /**
  11286. * Gets the hosting scene
  11287. */
  11288. get scene(): Scene;
  11289. /**
  11290. * Gets the capacity of the manager
  11291. */
  11292. get capacity(): number;
  11293. /**
  11294. * Gets or sets the spritesheet texture
  11295. */
  11296. get texture(): Texture;
  11297. set texture(value: Texture);
  11298. private _blendMode;
  11299. /**
  11300. * Blend mode use to render the particle, it can be any of
  11301. * the static Constants.ALPHA_x properties provided in this class.
  11302. * Default value is Constants.ALPHA_COMBINE
  11303. */
  11304. get blendMode(): number;
  11305. set blendMode(blendMode: number);
  11306. /** Disables writing to the depth buffer when rendering the sprites.
  11307. * It can be handy to disable depth writing when using textures without alpha channel
  11308. * and setting some specific blend modes.
  11309. */
  11310. disableDepthWrite: boolean;
  11311. /**
  11312. * Creates a new sprite manager
  11313. * @param name defines the manager's name
  11314. * @param imgUrl defines the sprite sheet url
  11315. * @param capacity defines the maximum allowed number of sprites
  11316. * @param cellSize defines the size of a sprite cell
  11317. * @param scene defines the hosting scene
  11318. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  11319. * @param samplingMode defines the smapling mode to use with spritesheet
  11320. * @param fromPacked set to false; do not alter
  11321. * @param spriteJSON null otherwise a JSON object defining sprite sheet data; do not alter
  11322. */
  11323. constructor(
  11324. /** defines the manager's name */
  11325. name: string, imgUrl: string, capacity: number, cellSize: any, scene: Scene, epsilon?: number, samplingMode?: number, fromPacked?: boolean, spriteJSON?: any | null);
  11326. /**
  11327. * Returns the string "SpriteManager"
  11328. * @returns "SpriteManager"
  11329. */
  11330. getClassName(): string;
  11331. private _makePacked;
  11332. private _appendSpriteVertex;
  11333. private _checkTextureAlpha;
  11334. /**
  11335. * Intersects the sprites with a ray
  11336. * @param ray defines the ray to intersect with
  11337. * @param camera defines the current active camera
  11338. * @param predicate defines a predicate used to select candidate sprites
  11339. * @param fastCheck defines if a fast check only must be done (the first potential sprite is will be used and not the closer)
  11340. * @returns null if no hit or a PickingInfo
  11341. */
  11342. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  11343. /**
  11344. * Intersects the sprites with a ray
  11345. * @param ray defines the ray to intersect with
  11346. * @param camera defines the current active camera
  11347. * @param predicate defines a predicate used to select candidate sprites
  11348. * @returns null if no hit or a PickingInfo array
  11349. */
  11350. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  11351. /**
  11352. * Render all child sprites
  11353. */
  11354. render(): void;
  11355. /**
  11356. * Release associated resources
  11357. */
  11358. dispose(): void;
  11359. /**
  11360. * Serializes the sprite manager to a JSON object
  11361. * @param serializeTexture defines if the texture must be serialized as well
  11362. * @returns the JSON object
  11363. */
  11364. serialize(serializeTexture?: boolean): any;
  11365. /**
  11366. * Parses a JSON object to create a new sprite manager.
  11367. * @param parsedManager The JSON object to parse
  11368. * @param scene The scene to create the sprite managerin
  11369. * @param rootUrl The root url to use to load external dependencies like texture
  11370. * @returns the new sprite manager
  11371. */
  11372. static Parse(parsedManager: any, scene: Scene, rootUrl: string): SpriteManager;
  11373. /**
  11374. * Creates a sprite manager from a snippet saved in a remote file
  11375. * @param name defines the name of the sprite manager to create (can be null or empty to use the one from the json data)
  11376. * @param url defines the url to load from
  11377. * @param scene defines the hosting scene
  11378. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  11379. * @returns a promise that will resolve to the new sprite manager
  11380. */
  11381. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  11382. /**
  11383. * Creates a sprite manager from a snippet saved by the sprite editor
  11384. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  11385. * @param scene defines the hosting scene
  11386. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  11387. * @returns a promise that will resolve to the new sprite manager
  11388. */
  11389. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  11390. }
  11391. }
  11392. declare module "babylonjs/Misc/gradients" {
  11393. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  11394. /** Interface used by value gradients (color, factor, ...) */
  11395. export interface IValueGradient {
  11396. /**
  11397. * Gets or sets the gradient value (between 0 and 1)
  11398. */
  11399. gradient: number;
  11400. }
  11401. /** Class used to store color4 gradient */
  11402. export class ColorGradient implements IValueGradient {
  11403. /**
  11404. * Gets or sets the gradient value (between 0 and 1)
  11405. */
  11406. gradient: number;
  11407. /**
  11408. * Gets or sets first associated color
  11409. */
  11410. color1: Color4;
  11411. /**
  11412. * Gets or sets second associated color
  11413. */
  11414. color2?: Color4 | undefined;
  11415. /**
  11416. * Creates a new color4 gradient
  11417. * @param gradient gets or sets the gradient value (between 0 and 1)
  11418. * @param color1 gets or sets first associated color
  11419. * @param color2 gets or sets first second color
  11420. */
  11421. constructor(
  11422. /**
  11423. * Gets or sets the gradient value (between 0 and 1)
  11424. */
  11425. gradient: number,
  11426. /**
  11427. * Gets or sets first associated color
  11428. */
  11429. color1: Color4,
  11430. /**
  11431. * Gets or sets second associated color
  11432. */
  11433. color2?: Color4 | undefined);
  11434. /**
  11435. * Will get a color picked randomly between color1 and color2.
  11436. * If color2 is undefined then color1 will be used
  11437. * @param result defines the target Color4 to store the result in
  11438. */
  11439. getColorToRef(result: Color4): void;
  11440. }
  11441. /** Class used to store color 3 gradient */
  11442. export class Color3Gradient implements IValueGradient {
  11443. /**
  11444. * Gets or sets the gradient value (between 0 and 1)
  11445. */
  11446. gradient: number;
  11447. /**
  11448. * Gets or sets the associated color
  11449. */
  11450. color: Color3;
  11451. /**
  11452. * Creates a new color3 gradient
  11453. * @param gradient gets or sets the gradient value (between 0 and 1)
  11454. * @param color gets or sets associated color
  11455. */
  11456. constructor(
  11457. /**
  11458. * Gets or sets the gradient value (between 0 and 1)
  11459. */
  11460. gradient: number,
  11461. /**
  11462. * Gets or sets the associated color
  11463. */
  11464. color: Color3);
  11465. }
  11466. /** Class used to store factor gradient */
  11467. export class FactorGradient implements IValueGradient {
  11468. /**
  11469. * Gets or sets the gradient value (between 0 and 1)
  11470. */
  11471. gradient: number;
  11472. /**
  11473. * Gets or sets first associated factor
  11474. */
  11475. factor1: number;
  11476. /**
  11477. * Gets or sets second associated factor
  11478. */
  11479. factor2?: number | undefined;
  11480. /**
  11481. * Creates a new factor gradient
  11482. * @param gradient gets or sets the gradient value (between 0 and 1)
  11483. * @param factor1 gets or sets first associated factor
  11484. * @param factor2 gets or sets second associated factor
  11485. */
  11486. constructor(
  11487. /**
  11488. * Gets or sets the gradient value (between 0 and 1)
  11489. */
  11490. gradient: number,
  11491. /**
  11492. * Gets or sets first associated factor
  11493. */
  11494. factor1: number,
  11495. /**
  11496. * Gets or sets second associated factor
  11497. */
  11498. factor2?: number | undefined);
  11499. /**
  11500. * Will get a number picked randomly between factor1 and factor2.
  11501. * If factor2 is undefined then factor1 will be used
  11502. * @returns the picked number
  11503. */
  11504. getFactor(): number;
  11505. }
  11506. /**
  11507. * Helper used to simplify some generic gradient tasks
  11508. */
  11509. export class GradientHelper {
  11510. /**
  11511. * Gets the current gradient from an array of IValueGradient
  11512. * @param ratio defines the current ratio to get
  11513. * @param gradients defines the array of IValueGradient
  11514. * @param updateFunc defines the callback function used to get the final value from the selected gradients
  11515. */
  11516. static GetCurrentGradient(ratio: number, gradients: IValueGradient[], updateFunc: (current: IValueGradient, next: IValueGradient, scale: number) => void): void;
  11517. }
  11518. }
  11519. declare module "babylonjs/Engines/Extensions/engine.rawTexture" {
  11520. import { Nullable } from "babylonjs/types";
  11521. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  11522. import { Scene } from "babylonjs/scene";
  11523. module "babylonjs/Engines/thinEngine" {
  11524. interface ThinEngine {
  11525. /**
  11526. * Creates a raw texture
  11527. * @param data defines the data to store in the texture
  11528. * @param width defines the width of the texture
  11529. * @param height defines the height of the texture
  11530. * @param format defines the format of the data
  11531. * @param generateMipMaps defines if the engine should generate the mip levels
  11532. * @param invertY defines if data must be stored with Y axis inverted
  11533. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  11534. * @param compression defines the compression used (null by default)
  11535. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11536. * @returns the raw texture inside an InternalTexture
  11537. */
  11538. createRawTexture(data: Nullable<ArrayBufferView>, width: number, height: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, type: number): InternalTexture;
  11539. /**
  11540. * Update a raw texture
  11541. * @param texture defines the texture to update
  11542. * @param data defines the data to store in the texture
  11543. * @param format defines the format of the data
  11544. * @param invertY defines if data must be stored with Y axis inverted
  11545. */
  11546. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  11547. /**
  11548. * Update a raw texture
  11549. * @param texture defines the texture to update
  11550. * @param data defines the data to store in the texture
  11551. * @param format defines the format of the data
  11552. * @param invertY defines if data must be stored with Y axis inverted
  11553. * @param compression defines the compression used (null by default)
  11554. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11555. */
  11556. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, type: number): void;
  11557. /**
  11558. * Creates a new raw cube texture
  11559. * @param data defines the array of data to use to create each face
  11560. * @param size defines the size of the textures
  11561. * @param format defines the format of the data
  11562. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  11563. * @param generateMipMaps defines if the engine should generate the mip levels
  11564. * @param invertY defines if data must be stored with Y axis inverted
  11565. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  11566. * @param compression defines the compression used (null by default)
  11567. * @returns the cube texture as an InternalTexture
  11568. */
  11569. createRawCubeTexture(data: Nullable<ArrayBufferView[]>, size: number, format: number, type: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>): InternalTexture;
  11570. /**
  11571. * Update a raw cube texture
  11572. * @param texture defines the texture to udpdate
  11573. * @param data defines the data to store
  11574. * @param format defines the data format
  11575. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11576. * @param invertY defines if data must be stored with Y axis inverted
  11577. */
  11578. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean): void;
  11579. /**
  11580. * Update a raw cube texture
  11581. * @param texture defines the texture to udpdate
  11582. * @param data defines the data to store
  11583. * @param format defines the data format
  11584. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11585. * @param invertY defines if data must be stored with Y axis inverted
  11586. * @param compression defines the compression used (null by default)
  11587. */
  11588. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>): void;
  11589. /**
  11590. * Update a raw cube texture
  11591. * @param texture defines the texture to udpdate
  11592. * @param data defines the data to store
  11593. * @param format defines the data format
  11594. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11595. * @param invertY defines if data must be stored with Y axis inverted
  11596. * @param compression defines the compression used (null by default)
  11597. * @param level defines which level of the texture to update
  11598. */
  11599. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>, level: number): void;
  11600. /**
  11601. * Creates a new raw cube texture from a specified url
  11602. * @param url defines the url where the data is located
  11603. * @param scene defines the current scene
  11604. * @param size defines the size of the textures
  11605. * @param format defines the format of the data
  11606. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  11607. * @param noMipmap defines if the engine should avoid generating the mip levels
  11608. * @param callback defines a callback used to extract texture data from loaded data
  11609. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  11610. * @param onLoad defines a callback called when texture is loaded
  11611. * @param onError defines a callback called if there is an error
  11612. * @returns the cube texture as an InternalTexture
  11613. */
  11614. createRawCubeTextureFromUrl(url: string, scene: Nullable<Scene>, size: number, format: number, type: number, noMipmap: boolean, callback: (ArrayBuffer: ArrayBuffer) => Nullable<ArrayBufferView[]>, mipmapGenerator: Nullable<((faces: ArrayBufferView[]) => ArrayBufferView[][])>, onLoad: Nullable<() => void>, onError: Nullable<(message?: string, exception?: any) => void>): InternalTexture;
  11615. /**
  11616. * Creates a new raw cube texture from a specified url
  11617. * @param url defines the url where the data is located
  11618. * @param scene defines the current scene
  11619. * @param size defines the size of the textures
  11620. * @param format defines the format of the data
  11621. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  11622. * @param noMipmap defines if the engine should avoid generating the mip levels
  11623. * @param callback defines a callback used to extract texture data from loaded data
  11624. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  11625. * @param onLoad defines a callback called when texture is loaded
  11626. * @param onError defines a callback called if there is an error
  11627. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  11628. * @param invertY defines if data must be stored with Y axis inverted
  11629. * @returns the cube texture as an InternalTexture
  11630. */
  11631. createRawCubeTextureFromUrl(url: string, scene: Nullable<Scene>, size: number, format: number, type: number, noMipmap: boolean, callback: (ArrayBuffer: ArrayBuffer) => Nullable<ArrayBufferView[]>, mipmapGenerator: Nullable<((faces: ArrayBufferView[]) => ArrayBufferView[][])>, onLoad: Nullable<() => void>, onError: Nullable<(message?: string, exception?: any) => void>, samplingMode: number, invertY: boolean): InternalTexture;
  11632. /**
  11633. * Creates a new raw 3D texture
  11634. * @param data defines the data used to create the texture
  11635. * @param width defines the width of the texture
  11636. * @param height defines the height of the texture
  11637. * @param depth defines the depth of the texture
  11638. * @param format defines the format of the texture
  11639. * @param generateMipMaps defines if the engine must generate mip levels
  11640. * @param invertY defines if data must be stored with Y axis inverted
  11641. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  11642. * @param compression defines the compressed used (can be null)
  11643. * @param textureType defines the compressed used (can be null)
  11644. * @returns a new raw 3D texture (stored in an InternalTexture)
  11645. */
  11646. createRawTexture3D(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  11647. /**
  11648. * Update a raw 3D texture
  11649. * @param texture defines the texture to update
  11650. * @param data defines the data to store
  11651. * @param format defines the data format
  11652. * @param invertY defines if data must be stored with Y axis inverted
  11653. */
  11654. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  11655. /**
  11656. * Update a raw 3D texture
  11657. * @param texture defines the texture to update
  11658. * @param data defines the data to store
  11659. * @param format defines the data format
  11660. * @param invertY defines if data must be stored with Y axis inverted
  11661. * @param compression defines the used compression (can be null)
  11662. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  11663. */
  11664. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  11665. /**
  11666. * Creates a new raw 2D array texture
  11667. * @param data defines the data used to create the texture
  11668. * @param width defines the width of the texture
  11669. * @param height defines the height of the texture
  11670. * @param depth defines the number of layers of the texture
  11671. * @param format defines the format of the texture
  11672. * @param generateMipMaps defines if the engine must generate mip levels
  11673. * @param invertY defines if data must be stored with Y axis inverted
  11674. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  11675. * @param compression defines the compressed used (can be null)
  11676. * @param textureType defines the compressed used (can be null)
  11677. * @returns a new raw 2D array texture (stored in an InternalTexture)
  11678. */
  11679. createRawTexture2DArray(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  11680. /**
  11681. * Update a raw 2D array texture
  11682. * @param texture defines the texture to update
  11683. * @param data defines the data to store
  11684. * @param format defines the data format
  11685. * @param invertY defines if data must be stored with Y axis inverted
  11686. */
  11687. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  11688. /**
  11689. * Update a raw 2D array texture
  11690. * @param texture defines the texture to update
  11691. * @param data defines the data to store
  11692. * @param format defines the data format
  11693. * @param invertY defines if data must be stored with Y axis inverted
  11694. * @param compression defines the used compression (can be null)
  11695. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  11696. */
  11697. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  11698. }
  11699. }
  11700. }
  11701. declare module "babylonjs/Materials/Textures/rawTexture" {
  11702. import { Texture } from "babylonjs/Materials/Textures/texture";
  11703. import "babylonjs/Engines/Extensions/engine.rawTexture";
  11704. import { Nullable } from "babylonjs/types";
  11705. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  11706. import { Scene } from "babylonjs/scene";
  11707. /**
  11708. * Raw texture can help creating a texture directly from an array of data.
  11709. * This can be super useful if you either get the data from an uncompressed source or
  11710. * if you wish to create your texture pixel by pixel.
  11711. */
  11712. export class RawTexture extends Texture {
  11713. /**
  11714. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  11715. */
  11716. format: number;
  11717. /**
  11718. * Instantiates a new RawTexture.
  11719. * Raw texture can help creating a texture directly from an array of data.
  11720. * This can be super useful if you either get the data from an uncompressed source or
  11721. * if you wish to create your texture pixel by pixel.
  11722. * @param data define the array of data to use to create the texture
  11723. * @param width define the width of the texture
  11724. * @param height define the height of the texture
  11725. * @param format define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  11726. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11727. * @param generateMipMaps define whether mip maps should be generated or not
  11728. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11729. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11730. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  11731. */
  11732. constructor(data: ArrayBufferView, width: number, height: number,
  11733. /**
  11734. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  11735. */
  11736. format: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number);
  11737. /**
  11738. * Updates the texture underlying data.
  11739. * @param data Define the new data of the texture
  11740. */
  11741. update(data: ArrayBufferView): void;
  11742. /**
  11743. * Creates a luminance texture from some data.
  11744. * @param data Define the texture data
  11745. * @param width Define the width of the texture
  11746. * @param height Define the height of the texture
  11747. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11748. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11749. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11750. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11751. * @returns the luminance texture
  11752. */
  11753. static CreateLuminanceTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  11754. /**
  11755. * Creates a luminance alpha texture from some data.
  11756. * @param data Define the texture data
  11757. * @param width Define the width of the texture
  11758. * @param height Define the height of the texture
  11759. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11760. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11761. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11762. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11763. * @returns the luminance alpha texture
  11764. */
  11765. static CreateLuminanceAlphaTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  11766. /**
  11767. * Creates an alpha texture from some data.
  11768. * @param data Define the texture data
  11769. * @param width Define the width of the texture
  11770. * @param height Define the height of the texture
  11771. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11772. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11773. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11774. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11775. * @returns the alpha texture
  11776. */
  11777. static CreateAlphaTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  11778. /**
  11779. * Creates a RGB texture from some data.
  11780. * @param data Define the texture data
  11781. * @param width Define the width of the texture
  11782. * @param height Define the height of the texture
  11783. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11784. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11785. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11786. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11787. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  11788. * @returns the RGB alpha texture
  11789. */
  11790. static CreateRGBTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  11791. /**
  11792. * Creates a RGBA texture from some data.
  11793. * @param data Define the texture data
  11794. * @param width Define the width of the texture
  11795. * @param height Define the height of the texture
  11796. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11797. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11798. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11799. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11800. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  11801. * @returns the RGBA texture
  11802. */
  11803. static CreateRGBATexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  11804. /**
  11805. * Creates a R texture from some data.
  11806. * @param data Define the texture data
  11807. * @param width Define the width of the texture
  11808. * @param height Define the height of the texture
  11809. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11810. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11811. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11812. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11813. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  11814. * @returns the R texture
  11815. */
  11816. static CreateRTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  11817. }
  11818. }
  11819. declare module "babylonjs/Engines/Extensions/engine.dynamicBuffer" {
  11820. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  11821. import { IndicesArray, DataArray } from "babylonjs/types";
  11822. module "babylonjs/Engines/thinEngine" {
  11823. interface ThinEngine {
  11824. /**
  11825. * Update a dynamic index buffer
  11826. * @param indexBuffer defines the target index buffer
  11827. * @param indices defines the data to update
  11828. * @param offset defines the offset in the target index buffer where update should start
  11829. */
  11830. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  11831. /**
  11832. * Updates a dynamic vertex buffer.
  11833. * @param vertexBuffer the vertex buffer to update
  11834. * @param data the data used to update the vertex buffer
  11835. * @param byteOffset the byte offset of the data
  11836. * @param byteLength the byte length of the data
  11837. */
  11838. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  11839. }
  11840. }
  11841. }
  11842. declare module "babylonjs/Materials/Textures/Procedurals/proceduralTextureSceneComponent" {
  11843. import { Scene } from "babylonjs/scene";
  11844. import { ISceneComponent } from "babylonjs/sceneComponent";
  11845. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  11846. module "babylonjs/abstractScene" {
  11847. interface AbstractScene {
  11848. /**
  11849. * The list of procedural textures added to the scene
  11850. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  11851. */
  11852. proceduralTextures: Array<ProceduralTexture>;
  11853. }
  11854. }
  11855. /**
  11856. * Defines the Procedural Texture scene component responsible to manage any Procedural Texture
  11857. * in a given scene.
  11858. */
  11859. export class ProceduralTextureSceneComponent implements ISceneComponent {
  11860. /**
  11861. * The component name helpfull to identify the component in the list of scene components.
  11862. */
  11863. readonly name: string;
  11864. /**
  11865. * The scene the component belongs to.
  11866. */
  11867. scene: Scene;
  11868. /**
  11869. * Creates a new instance of the component for the given scene
  11870. * @param scene Defines the scene to register the component in
  11871. */
  11872. constructor(scene: Scene);
  11873. /**
  11874. * Registers the component in a given scene
  11875. */
  11876. register(): void;
  11877. /**
  11878. * Rebuilds the elements related to this component in case of
  11879. * context lost for instance.
  11880. */
  11881. rebuild(): void;
  11882. /**
  11883. * Disposes the component and the associated ressources.
  11884. */
  11885. dispose(): void;
  11886. private _beforeClear;
  11887. }
  11888. }
  11889. declare module "babylonjs/Engines/Extensions/engine.renderTargetCube" {
  11890. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  11891. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  11892. module "babylonjs/Engines/thinEngine" {
  11893. interface ThinEngine {
  11894. /**
  11895. * Creates a new render target cube texture
  11896. * @param size defines the size of the texture
  11897. * @param options defines the options used to create the texture
  11898. * @returns a new render target cube texture stored in an InternalTexture
  11899. */
  11900. createRenderTargetCubeTexture(size: number, options?: Partial<RenderTargetCreationOptions>): InternalTexture;
  11901. }
  11902. }
  11903. }
  11904. declare module "babylonjs/Shaders/procedural.vertex" {
  11905. /** @hidden */
  11906. export var proceduralVertexShader: {
  11907. name: string;
  11908. shader: string;
  11909. };
  11910. }
  11911. declare module "babylonjs/Materials/Textures/Procedurals/proceduralTexture" {
  11912. import { Observable } from "babylonjs/Misc/observable";
  11913. import { Nullable } from "babylonjs/types";
  11914. import { Scene } from "babylonjs/scene";
  11915. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  11916. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  11917. import { Effect } from "babylonjs/Materials/effect";
  11918. import { Texture } from "babylonjs/Materials/Textures/texture";
  11919. import "babylonjs/Engines/Extensions/engine.renderTarget";
  11920. import "babylonjs/Engines/Extensions/engine.renderTargetCube";
  11921. import "babylonjs/Shaders/procedural.vertex";
  11922. /**
  11923. * Procedural texturing is a way to programmatically create a texture. There are 2 types of procedural textures: code-only, and code that references some classic 2D images, sometimes calmpler' images.
  11924. * This is the base class of any Procedural texture and contains most of the shareable code.
  11925. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  11926. */
  11927. export class ProceduralTexture extends Texture {
  11928. /**
  11929. * Define if the texture is enabled or not (disabled texture will not render)
  11930. */
  11931. isEnabled: boolean;
  11932. /**
  11933. * Define if the texture must be cleared before rendering (default is true)
  11934. */
  11935. autoClear: boolean;
  11936. /**
  11937. * Callback called when the texture is generated
  11938. */
  11939. onGenerated: () => void;
  11940. /**
  11941. * Event raised when the texture is generated
  11942. */
  11943. onGeneratedObservable: Observable<ProceduralTexture>;
  11944. /** @hidden */
  11945. _generateMipMaps: boolean;
  11946. /** @hidden **/
  11947. _effect: Effect;
  11948. /** @hidden */
  11949. _textures: {
  11950. [key: string]: Texture;
  11951. };
  11952. /** @hidden */
  11953. protected _fallbackTexture: Nullable<Texture>;
  11954. private _size;
  11955. private _currentRefreshId;
  11956. private _frameId;
  11957. private _refreshRate;
  11958. private _vertexBuffers;
  11959. private _indexBuffer;
  11960. private _uniforms;
  11961. private _samplers;
  11962. private _fragment;
  11963. private _floats;
  11964. private _ints;
  11965. private _floatsArrays;
  11966. private _colors3;
  11967. private _colors4;
  11968. private _vectors2;
  11969. private _vectors3;
  11970. private _matrices;
  11971. private _fallbackTextureUsed;
  11972. private _fullEngine;
  11973. private _cachedDefines;
  11974. private _contentUpdateId;
  11975. private _contentData;
  11976. /**
  11977. * Instantiates a new procedural texture.
  11978. * Procedural texturing is a way to programmatically create a texture. There are 2 types of procedural textures: code-only, and code that references some classic 2D images, sometimes called 'refMaps' or 'sampler' images.
  11979. * This is the base class of any Procedural texture and contains most of the shareable code.
  11980. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  11981. * @param name Define the name of the texture
  11982. * @param size Define the size of the texture to create
  11983. * @param fragment Define the fragment shader to use to generate the texture or null if it is defined later
  11984. * @param scene Define the scene the texture belongs to
  11985. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  11986. * @param generateMipMaps Define if the texture should creates mip maps or not
  11987. * @param isCube Define if the texture is a cube texture or not (this will render each faces of the cube)
  11988. */
  11989. constructor(name: string, size: any, fragment: any, scene: Nullable<Scene>, fallbackTexture?: Nullable<Texture>, generateMipMaps?: boolean, isCube?: boolean);
  11990. /**
  11991. * The effect that is created when initializing the post process.
  11992. * @returns The created effect corresponding the the postprocess.
  11993. */
  11994. getEffect(): Effect;
  11995. /**
  11996. * Gets texture content (Use this function wisely as reading from a texture can be slow)
  11997. * @returns an ArrayBufferView (Uint8Array or Float32Array)
  11998. */
  11999. getContent(): Nullable<ArrayBufferView>;
  12000. private _createIndexBuffer;
  12001. /** @hidden */
  12002. _rebuild(): void;
  12003. /**
  12004. * Resets the texture in order to recreate its associated resources.
  12005. * This can be called in case of context loss
  12006. */
  12007. reset(): void;
  12008. protected _getDefines(): string;
  12009. /**
  12010. * Is the texture ready to be used ? (rendered at least once)
  12011. * @returns true if ready, otherwise, false.
  12012. */
  12013. isReady(): boolean;
  12014. /**
  12015. * Resets the refresh counter of the texture and start bak from scratch.
  12016. * Could be useful to regenerate the texture if it is setup to render only once.
  12017. */
  12018. resetRefreshCounter(): void;
  12019. /**
  12020. * Set the fragment shader to use in order to render the texture.
  12021. * @param fragment This can be set to a path (into the shader store) or to a json object containing a fragmentElement property.
  12022. */
  12023. setFragment(fragment: any): void;
  12024. /**
  12025. * Define the refresh rate of the texture or the rendering frequency.
  12026. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  12027. */
  12028. get refreshRate(): number;
  12029. set refreshRate(value: number);
  12030. /** @hidden */
  12031. _shouldRender(): boolean;
  12032. /**
  12033. * Get the size the texture is rendering at.
  12034. * @returns the size (texture is always squared)
  12035. */
  12036. getRenderSize(): number;
  12037. /**
  12038. * Resize the texture to new value.
  12039. * @param size Define the new size the texture should have
  12040. * @param generateMipMaps Define whether the new texture should create mip maps
  12041. */
  12042. resize(size: number, generateMipMaps: boolean): void;
  12043. private _checkUniform;
  12044. /**
  12045. * Set a texture in the shader program used to render.
  12046. * @param name Define the name of the uniform samplers as defined in the shader
  12047. * @param texture Define the texture to bind to this sampler
  12048. * @return the texture itself allowing "fluent" like uniform updates
  12049. */
  12050. setTexture(name: string, texture: Texture): ProceduralTexture;
  12051. /**
  12052. * Set a float in the shader.
  12053. * @param name Define the name of the uniform as defined in the shader
  12054. * @param value Define the value to give to the uniform
  12055. * @return the texture itself allowing "fluent" like uniform updates
  12056. */
  12057. setFloat(name: string, value: number): ProceduralTexture;
  12058. /**
  12059. * Set a int in the shader.
  12060. * @param name Define the name of the uniform as defined in the shader
  12061. * @param value Define the value to give to the uniform
  12062. * @return the texture itself allowing "fluent" like uniform updates
  12063. */
  12064. setInt(name: string, value: number): ProceduralTexture;
  12065. /**
  12066. * Set an array of floats in the shader.
  12067. * @param name Define the name of the uniform as defined in the shader
  12068. * @param value Define the value to give to the uniform
  12069. * @return the texture itself allowing "fluent" like uniform updates
  12070. */
  12071. setFloats(name: string, value: number[]): ProceduralTexture;
  12072. /**
  12073. * Set a vec3 in the shader from a Color3.
  12074. * @param name Define the name of the uniform as defined in the shader
  12075. * @param value Define the value to give to the uniform
  12076. * @return the texture itself allowing "fluent" like uniform updates
  12077. */
  12078. setColor3(name: string, value: Color3): ProceduralTexture;
  12079. /**
  12080. * Set a vec4 in the shader from a Color4.
  12081. * @param name Define the name of the uniform as defined in the shader
  12082. * @param value Define the value to give to the uniform
  12083. * @return the texture itself allowing "fluent" like uniform updates
  12084. */
  12085. setColor4(name: string, value: Color4): ProceduralTexture;
  12086. /**
  12087. * Set a vec2 in the shader from a Vector2.
  12088. * @param name Define the name of the uniform as defined in the shader
  12089. * @param value Define the value to give to the uniform
  12090. * @return the texture itself allowing "fluent" like uniform updates
  12091. */
  12092. setVector2(name: string, value: Vector2): ProceduralTexture;
  12093. /**
  12094. * Set a vec3 in the shader from a Vector3.
  12095. * @param name Define the name of the uniform as defined in the shader
  12096. * @param value Define the value to give to the uniform
  12097. * @return the texture itself allowing "fluent" like uniform updates
  12098. */
  12099. setVector3(name: string, value: Vector3): ProceduralTexture;
  12100. /**
  12101. * Set a mat4 in the shader from a MAtrix.
  12102. * @param name Define the name of the uniform as defined in the shader
  12103. * @param value Define the value to give to the uniform
  12104. * @return the texture itself allowing "fluent" like uniform updates
  12105. */
  12106. setMatrix(name: string, value: Matrix): ProceduralTexture;
  12107. /**
  12108. * Render the texture to its associated render target.
  12109. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  12110. */
  12111. render(useCameraPostProcess?: boolean): void;
  12112. /**
  12113. * Clone the texture.
  12114. * @returns the cloned texture
  12115. */
  12116. clone(): ProceduralTexture;
  12117. /**
  12118. * Dispose the texture and release its asoociated resources.
  12119. */
  12120. dispose(): void;
  12121. }
  12122. }
  12123. declare module "babylonjs/Particles/baseParticleSystem" {
  12124. import { Nullable } from "babylonjs/types";
  12125. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  12126. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  12127. import { ImageProcessingConfiguration, ImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  12128. import { ColorGradient, FactorGradient, Color3Gradient, IValueGradient } from "babylonjs/Misc/gradients";
  12129. import { BoxParticleEmitter, IParticleEmitterType, PointParticleEmitter, HemisphericParticleEmitter, SphereParticleEmitter, SphereDirectedParticleEmitter, CylinderParticleEmitter, CylinderDirectedParticleEmitter, ConeParticleEmitter } from "babylonjs/Particles/EmitterTypes/index";
  12130. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  12131. import { Color4 } from "babylonjs/Maths/math.color";
  12132. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  12133. import "babylonjs/Engines/Extensions/engine.dynamicBuffer";
  12134. import { Animation } from "babylonjs/Animations/animation";
  12135. import { Scene } from "babylonjs/scene";
  12136. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  12137. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  12138. /**
  12139. * This represents the base class for particle system in Babylon.
  12140. * Particles are often small sprites used to simulate hard-to-reproduce phenomena like fire, smoke, water, or abstract visual effects like magic glitter and faery dust.
  12141. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  12142. * @example https://doc.babylonjs.com/babylon101/particles
  12143. */
  12144. export class BaseParticleSystem {
  12145. /**
  12146. * Source color is added to the destination color without alpha affecting the result
  12147. */
  12148. static BLENDMODE_ONEONE: number;
  12149. /**
  12150. * Blend current color and particle color using particle’s alpha
  12151. */
  12152. static BLENDMODE_STANDARD: number;
  12153. /**
  12154. * Add current color and particle color multiplied by particle’s alpha
  12155. */
  12156. static BLENDMODE_ADD: number;
  12157. /**
  12158. * Multiply current color with particle color
  12159. */
  12160. static BLENDMODE_MULTIPLY: number;
  12161. /**
  12162. * Multiply current color with particle color then add current color and particle color multiplied by particle’s alpha
  12163. */
  12164. static BLENDMODE_MULTIPLYADD: number;
  12165. /**
  12166. * List of animations used by the particle system.
  12167. */
  12168. animations: Animation[];
  12169. /**
  12170. * Gets or sets the unique id of the particle system
  12171. */
  12172. uniqueId: number;
  12173. /**
  12174. * The id of the Particle system.
  12175. */
  12176. id: string;
  12177. /**
  12178. * The friendly name of the Particle system.
  12179. */
  12180. name: string;
  12181. /**
  12182. * Snippet ID if the particle system was created from the snippet server
  12183. */
  12184. snippetId: string;
  12185. /**
  12186. * The rendering group used by the Particle system to chose when to render.
  12187. */
  12188. renderingGroupId: number;
  12189. /**
  12190. * The emitter represents the Mesh or position we are attaching the particle system to.
  12191. */
  12192. emitter: Nullable<AbstractMesh | Vector3>;
  12193. /**
  12194. * The maximum number of particles to emit per frame
  12195. */
  12196. emitRate: number;
  12197. /**
  12198. * If you want to launch only a few particles at once, that can be done, as well.
  12199. */
  12200. manualEmitCount: number;
  12201. /**
  12202. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  12203. */
  12204. updateSpeed: number;
  12205. /**
  12206. * The amount of time the particle system is running (depends of the overall update speed).
  12207. */
  12208. targetStopDuration: number;
  12209. /**
  12210. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  12211. */
  12212. disposeOnStop: boolean;
  12213. /**
  12214. * Minimum power of emitting particles.
  12215. */
  12216. minEmitPower: number;
  12217. /**
  12218. * Maximum power of emitting particles.
  12219. */
  12220. maxEmitPower: number;
  12221. /**
  12222. * Minimum life time of emitting particles.
  12223. */
  12224. minLifeTime: number;
  12225. /**
  12226. * Maximum life time of emitting particles.
  12227. */
  12228. maxLifeTime: number;
  12229. /**
  12230. * Minimum Size of emitting particles.
  12231. */
  12232. minSize: number;
  12233. /**
  12234. * Maximum Size of emitting particles.
  12235. */
  12236. maxSize: number;
  12237. /**
  12238. * Minimum scale of emitting particles on X axis.
  12239. */
  12240. minScaleX: number;
  12241. /**
  12242. * Maximum scale of emitting particles on X axis.
  12243. */
  12244. maxScaleX: number;
  12245. /**
  12246. * Minimum scale of emitting particles on Y axis.
  12247. */
  12248. minScaleY: number;
  12249. /**
  12250. * Maximum scale of emitting particles on Y axis.
  12251. */
  12252. maxScaleY: number;
  12253. /**
  12254. * Gets or sets the minimal initial rotation in radians.
  12255. */
  12256. minInitialRotation: number;
  12257. /**
  12258. * Gets or sets the maximal initial rotation in radians.
  12259. */
  12260. maxInitialRotation: number;
  12261. /**
  12262. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  12263. */
  12264. minAngularSpeed: number;
  12265. /**
  12266. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  12267. */
  12268. maxAngularSpeed: number;
  12269. /**
  12270. * The texture used to render each particle. (this can be a spritesheet)
  12271. */
  12272. particleTexture: Nullable<BaseTexture>;
  12273. /**
  12274. * The layer mask we are rendering the particles through.
  12275. */
  12276. layerMask: number;
  12277. /**
  12278. * This can help using your own shader to render the particle system.
  12279. * The according effect will be created
  12280. */
  12281. customShader: any;
  12282. /**
  12283. * By default particle system starts as soon as they are created. This prevents the
  12284. * automatic start to happen and let you decide when to start emitting particles.
  12285. */
  12286. preventAutoStart: boolean;
  12287. private _noiseTexture;
  12288. /**
  12289. * Gets or sets a texture used to add random noise to particle positions
  12290. */
  12291. get noiseTexture(): Nullable<ProceduralTexture>;
  12292. set noiseTexture(value: Nullable<ProceduralTexture>);
  12293. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  12294. noiseStrength: Vector3;
  12295. /**
  12296. * Callback triggered when the particle animation is ending.
  12297. */
  12298. onAnimationEnd: Nullable<() => void>;
  12299. /**
  12300. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE or ParticleSystem.BLENDMODE_STANDARD.
  12301. */
  12302. blendMode: number;
  12303. /**
  12304. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  12305. * to override the particles.
  12306. */
  12307. forceDepthWrite: boolean;
  12308. /** Gets or sets a value indicating how many cycles (or frames) must be executed before first rendering (this value has to be set before starting the system). Default is 0 */
  12309. preWarmCycles: number;
  12310. /** Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1) */
  12311. preWarmStepOffset: number;
  12312. /**
  12313. * If using a spritesheet (isAnimationSheetEnabled) defines the speed of the sprite loop (default is 1 meaning the animation will play once during the entire particle lifetime)
  12314. */
  12315. spriteCellChangeSpeed: number;
  12316. /**
  12317. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  12318. */
  12319. startSpriteCellID: number;
  12320. /**
  12321. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  12322. */
  12323. endSpriteCellID: number;
  12324. /**
  12325. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  12326. */
  12327. spriteCellWidth: number;
  12328. /**
  12329. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  12330. */
  12331. spriteCellHeight: number;
  12332. /**
  12333. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  12334. */
  12335. spriteRandomStartCell: boolean;
  12336. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  12337. translationPivot: Vector2;
  12338. /** @hidden */
  12339. protected _isAnimationSheetEnabled: boolean;
  12340. /**
  12341. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  12342. */
  12343. beginAnimationOnStart: boolean;
  12344. /**
  12345. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  12346. */
  12347. beginAnimationFrom: number;
  12348. /**
  12349. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  12350. */
  12351. beginAnimationTo: number;
  12352. /**
  12353. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  12354. */
  12355. beginAnimationLoop: boolean;
  12356. /**
  12357. * Gets or sets a world offset applied to all particles
  12358. */
  12359. worldOffset: Vector3;
  12360. /**
  12361. * Gets or sets whether an animation sprite sheet is enabled or not on the particle system
  12362. */
  12363. get isAnimationSheetEnabled(): boolean;
  12364. set isAnimationSheetEnabled(value: boolean);
  12365. /**
  12366. * Get hosting scene
  12367. * @returns the scene
  12368. */
  12369. getScene(): Nullable<Scene>;
  12370. /**
  12371. * You can use gravity if you want to give an orientation to your particles.
  12372. */
  12373. gravity: Vector3;
  12374. protected _colorGradients: Nullable<Array<ColorGradient>>;
  12375. protected _sizeGradients: Nullable<Array<FactorGradient>>;
  12376. protected _lifeTimeGradients: Nullable<Array<FactorGradient>>;
  12377. protected _angularSpeedGradients: Nullable<Array<FactorGradient>>;
  12378. protected _velocityGradients: Nullable<Array<FactorGradient>>;
  12379. protected _limitVelocityGradients: Nullable<Array<FactorGradient>>;
  12380. protected _dragGradients: Nullable<Array<FactorGradient>>;
  12381. protected _emitRateGradients: Nullable<Array<FactorGradient>>;
  12382. protected _startSizeGradients: Nullable<Array<FactorGradient>>;
  12383. protected _rampGradients: Nullable<Array<Color3Gradient>>;
  12384. protected _colorRemapGradients: Nullable<Array<FactorGradient>>;
  12385. protected _alphaRemapGradients: Nullable<Array<FactorGradient>>;
  12386. protected _hasTargetStopDurationDependantGradient(): boolean | null;
  12387. /**
  12388. * Defines the delay in milliseconds before starting the system (0 by default)
  12389. */
  12390. startDelay: number;
  12391. /**
  12392. * Gets the current list of drag gradients.
  12393. * You must use addDragGradient and removeDragGradient to udpate this list
  12394. * @returns the list of drag gradients
  12395. */
  12396. getDragGradients(): Nullable<Array<FactorGradient>>;
  12397. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  12398. limitVelocityDamping: number;
  12399. /**
  12400. * Gets the current list of limit velocity gradients.
  12401. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  12402. * @returns the list of limit velocity gradients
  12403. */
  12404. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  12405. /**
  12406. * Gets the current list of color gradients.
  12407. * You must use addColorGradient and removeColorGradient to udpate this list
  12408. * @returns the list of color gradients
  12409. */
  12410. getColorGradients(): Nullable<Array<ColorGradient>>;
  12411. /**
  12412. * Gets the current list of size gradients.
  12413. * You must use addSizeGradient and removeSizeGradient to udpate this list
  12414. * @returns the list of size gradients
  12415. */
  12416. getSizeGradients(): Nullable<Array<FactorGradient>>;
  12417. /**
  12418. * Gets the current list of color remap gradients.
  12419. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  12420. * @returns the list of color remap gradients
  12421. */
  12422. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  12423. /**
  12424. * Gets the current list of alpha remap gradients.
  12425. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  12426. * @returns the list of alpha remap gradients
  12427. */
  12428. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  12429. /**
  12430. * Gets the current list of life time gradients.
  12431. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  12432. * @returns the list of life time gradients
  12433. */
  12434. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  12435. /**
  12436. * Gets the current list of angular speed gradients.
  12437. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  12438. * @returns the list of angular speed gradients
  12439. */
  12440. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  12441. /**
  12442. * Gets the current list of velocity gradients.
  12443. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  12444. * @returns the list of velocity gradients
  12445. */
  12446. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  12447. /**
  12448. * Gets the current list of start size gradients.
  12449. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  12450. * @returns the list of start size gradients
  12451. */
  12452. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  12453. /**
  12454. * Gets the current list of emit rate gradients.
  12455. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  12456. * @returns the list of emit rate gradients
  12457. */
  12458. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  12459. /**
  12460. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  12461. * This only works when particleEmitterTyps is a BoxParticleEmitter
  12462. */
  12463. get direction1(): Vector3;
  12464. set direction1(value: Vector3);
  12465. /**
  12466. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  12467. * This only works when particleEmitterTyps is a BoxParticleEmitter
  12468. */
  12469. get direction2(): Vector3;
  12470. set direction2(value: Vector3);
  12471. /**
  12472. * Minimum box point around our emitter. Our emitter is the center of particles source, but if you want your particles to emit from more than one point, then you can tell it to do so.
  12473. * This only works when particleEmitterTyps is a BoxParticleEmitter
  12474. */
  12475. get minEmitBox(): Vector3;
  12476. set minEmitBox(value: Vector3);
  12477. /**
  12478. * Maximum box point around our emitter. Our emitter is the center of particles source, but if you want your particles to emit from more than one point, then you can tell it to do so.
  12479. * This only works when particleEmitterTyps is a BoxParticleEmitter
  12480. */
  12481. get maxEmitBox(): Vector3;
  12482. set maxEmitBox(value: Vector3);
  12483. /**
  12484. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  12485. */
  12486. color1: Color4;
  12487. /**
  12488. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  12489. */
  12490. color2: Color4;
  12491. /**
  12492. * Color the particle will have at the end of its lifetime
  12493. */
  12494. colorDead: Color4;
  12495. /**
  12496. * An optional mask to filter some colors out of the texture, or filter a part of the alpha channel
  12497. */
  12498. textureMask: Color4;
  12499. /**
  12500. * The particle emitter type defines the emitter used by the particle system.
  12501. * It can be for example box, sphere, or cone...
  12502. */
  12503. particleEmitterType: IParticleEmitterType;
  12504. /** @hidden */
  12505. _isSubEmitter: boolean;
  12506. /**
  12507. * Gets or sets the billboard mode to use when isBillboardBased = true.
  12508. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  12509. */
  12510. billboardMode: number;
  12511. protected _isBillboardBased: boolean;
  12512. /**
  12513. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  12514. */
  12515. get isBillboardBased(): boolean;
  12516. set isBillboardBased(value: boolean);
  12517. /**
  12518. * The scene the particle system belongs to.
  12519. */
  12520. protected _scene: Nullable<Scene>;
  12521. /**
  12522. * The engine the particle system belongs to.
  12523. */
  12524. protected _engine: ThinEngine;
  12525. /**
  12526. * Local cache of defines for image processing.
  12527. */
  12528. protected _imageProcessingConfigurationDefines: ImageProcessingConfigurationDefines;
  12529. /**
  12530. * Default configuration related to image processing available in the standard Material.
  12531. */
  12532. protected _imageProcessingConfiguration: Nullable<ImageProcessingConfiguration>;
  12533. /**
  12534. * Gets the image processing configuration used either in this material.
  12535. */
  12536. get imageProcessingConfiguration(): Nullable<ImageProcessingConfiguration>;
  12537. /**
  12538. * Sets the Default image processing configuration used either in the this material.
  12539. *
  12540. * If sets to null, the scene one is in use.
  12541. */
  12542. set imageProcessingConfiguration(value: Nullable<ImageProcessingConfiguration>);
  12543. /**
  12544. * Attaches a new image processing configuration to the Standard Material.
  12545. * @param configuration
  12546. */
  12547. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  12548. /** @hidden */
  12549. protected _reset(): void;
  12550. /** @hidden */
  12551. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: Nullable<RawTexture>): BaseParticleSystem;
  12552. /**
  12553. * Instantiates a particle system.
  12554. * Particles are often small sprites used to simulate hard-to-reproduce phenomena like fire, smoke, water, or abstract visual effects like magic glitter and faery dust.
  12555. * @param name The name of the particle system
  12556. */
  12557. constructor(name: string);
  12558. /**
  12559. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  12560. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  12561. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  12562. * @returns the emitter
  12563. */
  12564. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  12565. /**
  12566. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  12567. * @param radius The radius of the hemisphere to emit from
  12568. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  12569. * @returns the emitter
  12570. */
  12571. createHemisphericEmitter(radius?: number, radiusRange?: number): HemisphericParticleEmitter;
  12572. /**
  12573. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  12574. * @param radius The radius of the sphere to emit from
  12575. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  12576. * @returns the emitter
  12577. */
  12578. createSphereEmitter(radius?: number, radiusRange?: number): SphereParticleEmitter;
  12579. /**
  12580. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  12581. * @param radius The radius of the sphere to emit from
  12582. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  12583. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  12584. * @returns the emitter
  12585. */
  12586. createDirectedSphereEmitter(radius?: number, direction1?: Vector3, direction2?: Vector3): SphereDirectedParticleEmitter;
  12587. /**
  12588. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  12589. * @param radius The radius of the emission cylinder
  12590. * @param height The height of the emission cylinder
  12591. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  12592. * @param directionRandomizer How much to randomize the particle direction [0-1]
  12593. * @returns the emitter
  12594. */
  12595. createCylinderEmitter(radius?: number, height?: number, radiusRange?: number, directionRandomizer?: number): CylinderParticleEmitter;
  12596. /**
  12597. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  12598. * @param radius The radius of the cylinder to emit from
  12599. * @param height The height of the emission cylinder
  12600. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  12601. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  12602. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  12603. * @returns the emitter
  12604. */
  12605. createDirectedCylinderEmitter(radius?: number, height?: number, radiusRange?: number, direction1?: Vector3, direction2?: Vector3): CylinderDirectedParticleEmitter;
  12606. /**
  12607. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  12608. * @param radius The radius of the cone to emit from
  12609. * @param angle The base angle of the cone
  12610. * @returns the emitter
  12611. */
  12612. createConeEmitter(radius?: number, angle?: number): ConeParticleEmitter;
  12613. /**
  12614. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  12615. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  12616. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  12617. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  12618. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  12619. * @returns the emitter
  12620. */
  12621. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  12622. }
  12623. }
  12624. declare module "babylonjs/Particles/subEmitter" {
  12625. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  12626. import { Scene } from "babylonjs/scene";
  12627. import { ParticleSystem } from "babylonjs/Particles/particleSystem";
  12628. /**
  12629. * Type of sub emitter
  12630. */
  12631. export enum SubEmitterType {
  12632. /**
  12633. * Attached to the particle over it's lifetime
  12634. */
  12635. ATTACHED = 0,
  12636. /**
  12637. * Created when the particle dies
  12638. */
  12639. END = 1
  12640. }
  12641. /**
  12642. * Sub emitter class used to emit particles from an existing particle
  12643. */
  12644. export class SubEmitter {
  12645. /**
  12646. * the particle system to be used by the sub emitter
  12647. */
  12648. particleSystem: ParticleSystem;
  12649. /**
  12650. * Type of the submitter (Default: END)
  12651. */
  12652. type: SubEmitterType;
  12653. /**
  12654. * If the particle should inherit the direction from the particle it's attached to. (+Y will face the direction the particle is moving) (Default: false)
  12655. * Note: This only is supported when using an emitter of type Mesh
  12656. */
  12657. inheritDirection: boolean;
  12658. /**
  12659. * How much of the attached particles speed should be added to the sub emitted particle (default: 0)
  12660. */
  12661. inheritedVelocityAmount: number;
  12662. /**
  12663. * Creates a sub emitter
  12664. * @param particleSystem the particle system to be used by the sub emitter
  12665. */
  12666. constructor(
  12667. /**
  12668. * the particle system to be used by the sub emitter
  12669. */
  12670. particleSystem: ParticleSystem);
  12671. /**
  12672. * Clones the sub emitter
  12673. * @returns the cloned sub emitter
  12674. */
  12675. clone(): SubEmitter;
  12676. /**
  12677. * Serialize current object to a JSON object
  12678. * @returns the serialized object
  12679. */
  12680. serialize(): any;
  12681. /** @hidden */
  12682. static _ParseParticleSystem(system: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string): ParticleSystem;
  12683. /**
  12684. * Creates a new SubEmitter from a serialized JSON version
  12685. * @param serializationObject defines the JSON object to read from
  12686. * @param sceneOrEngine defines the hosting scene or the hosting engine
  12687. * @param rootUrl defines the rootUrl for data loading
  12688. * @returns a new SubEmitter
  12689. */
  12690. static Parse(serializationObject: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string): SubEmitter;
  12691. /** Release associated resources */
  12692. dispose(): void;
  12693. }
  12694. }
  12695. declare module "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration" {
  12696. /** @hidden */
  12697. export var imageProcessingDeclaration: {
  12698. name: string;
  12699. shader: string;
  12700. };
  12701. }
  12702. declare module "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions" {
  12703. /** @hidden */
  12704. export var imageProcessingFunctions: {
  12705. name: string;
  12706. shader: string;
  12707. };
  12708. }
  12709. declare module "babylonjs/Shaders/particles.fragment" {
  12710. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  12711. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  12712. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  12713. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  12714. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  12715. /** @hidden */
  12716. export var particlesPixelShader: {
  12717. name: string;
  12718. shader: string;
  12719. };
  12720. }
  12721. declare module "babylonjs/Shaders/particles.vertex" {
  12722. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  12723. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  12724. /** @hidden */
  12725. export var particlesVertexShader: {
  12726. name: string;
  12727. shader: string;
  12728. };
  12729. }
  12730. declare module "babylonjs/Misc/interfaces/iClipPlanesHolder" {
  12731. import { Nullable } from "babylonjs/types";
  12732. import { Plane } from "babylonjs/Maths/math";
  12733. /**
  12734. * Interface used to define entities containing multiple clip planes
  12735. */
  12736. export interface IClipPlanesHolder {
  12737. /**
  12738. * Gets or sets the active clipplane 1
  12739. */
  12740. clipPlane: Nullable<Plane>;
  12741. /**
  12742. * Gets or sets the active clipplane 2
  12743. */
  12744. clipPlane2: Nullable<Plane>;
  12745. /**
  12746. * Gets or sets the active clipplane 3
  12747. */
  12748. clipPlane3: Nullable<Plane>;
  12749. /**
  12750. * Gets or sets the active clipplane 4
  12751. */
  12752. clipPlane4: Nullable<Plane>;
  12753. /**
  12754. * Gets or sets the active clipplane 5
  12755. */
  12756. clipPlane5: Nullable<Plane>;
  12757. /**
  12758. * Gets or sets the active clipplane 6
  12759. */
  12760. clipPlane6: Nullable<Plane>;
  12761. }
  12762. }
  12763. declare module "babylonjs/Materials/thinMaterialHelper" {
  12764. import { Effect } from "babylonjs/Materials/effect";
  12765. import { IClipPlanesHolder } from "babylonjs/Misc/interfaces/iClipPlanesHolder";
  12766. /**
  12767. * "Static Class" containing a few commonly used helper while dealing with material for rendering purpose.
  12768. *
  12769. * It is complementary with MaterialHelper but provides completely independent functions (for tree shaking sake)
  12770. *
  12771. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  12772. */
  12773. export class ThinMaterialHelper {
  12774. /**
  12775. * Binds the clip plane information from the holder to the effect.
  12776. * @param effect The effect we are binding the data to
  12777. * @param holder The entity containing the clip plane information
  12778. */
  12779. static BindClipPlane(effect: Effect, holder: IClipPlanesHolder): void;
  12780. }
  12781. }
  12782. declare module "babylonjs/Engines/Extensions/engine.alpha" {
  12783. module "babylonjs/Engines/thinEngine" {
  12784. interface ThinEngine {
  12785. /**
  12786. * Sets alpha constants used by some alpha blending modes
  12787. * @param r defines the red component
  12788. * @param g defines the green component
  12789. * @param b defines the blue component
  12790. * @param a defines the alpha component
  12791. */
  12792. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  12793. /**
  12794. * Sets the current alpha mode
  12795. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  12796. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  12797. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  12798. */
  12799. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  12800. /**
  12801. * Gets the current alpha mode
  12802. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  12803. * @returns the current alpha mode
  12804. */
  12805. getAlphaMode(): number;
  12806. /**
  12807. * Sets the current alpha equation
  12808. * @param equation defines the equation to use (one of the Engine.ALPHA_EQUATION_XXX)
  12809. */
  12810. setAlphaEquation(equation: number): void;
  12811. /**
  12812. * Gets the current alpha equation.
  12813. * @returns the current alpha equation
  12814. */
  12815. getAlphaEquation(): number;
  12816. }
  12817. }
  12818. }
  12819. declare module "babylonjs/Particles/particleSystem" {
  12820. import { Nullable } from "babylonjs/types";
  12821. import { FactorGradient, Color3Gradient } from "babylonjs/Misc/gradients";
  12822. import { Observable } from "babylonjs/Misc/observable";
  12823. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  12824. import { Effect } from "babylonjs/Materials/effect";
  12825. import { IDisposable } from "babylonjs/scene";
  12826. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  12827. import { BaseParticleSystem } from "babylonjs/Particles/baseParticleSystem";
  12828. import { Particle } from "babylonjs/Particles/particle";
  12829. import { SubEmitter } from "babylonjs/Particles/subEmitter";
  12830. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  12831. import "babylonjs/Shaders/particles.fragment";
  12832. import "babylonjs/Shaders/particles.vertex";
  12833. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  12834. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  12835. import "babylonjs/Engines/Extensions/engine.alpha";
  12836. import { Scene } from "babylonjs/scene";
  12837. /**
  12838. * This represents a particle system in Babylon.
  12839. * Particles are often small sprites used to simulate hard-to-reproduce phenomena like fire, smoke, water, or abstract visual effects like magic glitter and faery dust.
  12840. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  12841. * @example https://doc.babylonjs.com/babylon101/particles
  12842. */
  12843. export class ParticleSystem extends BaseParticleSystem implements IDisposable, IAnimatable, IParticleSystem {
  12844. /**
  12845. * Billboard mode will only apply to Y axis
  12846. */
  12847. static readonly BILLBOARDMODE_Y: number;
  12848. /**
  12849. * Billboard mode will apply to all axes
  12850. */
  12851. static readonly BILLBOARDMODE_ALL: number;
  12852. /**
  12853. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  12854. */
  12855. static readonly BILLBOARDMODE_STRETCHED: number;
  12856. /**
  12857. * This function can be defined to provide custom update for active particles.
  12858. * This function will be called instead of regular update (age, position, color, etc.).
  12859. * Do not forget that this function will be called on every frame so try to keep it simple and fast :)
  12860. */
  12861. updateFunction: (particles: Particle[]) => void;
  12862. private _emitterWorldMatrix;
  12863. /**
  12864. * This function can be defined to specify initial direction for every new particle.
  12865. * It by default use the emitterType defined function
  12866. */
  12867. startDirectionFunction: (worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  12868. /**
  12869. * This function can be defined to specify initial position for every new particle.
  12870. * It by default use the emitterType defined function
  12871. */
  12872. startPositionFunction: (worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  12873. /**
  12874. * @hidden
  12875. */
  12876. _inheritedVelocityOffset: Vector3;
  12877. /**
  12878. * An event triggered when the system is disposed
  12879. */
  12880. onDisposeObservable: Observable<IParticleSystem>;
  12881. private _onDisposeObserver;
  12882. /**
  12883. * Sets a callback that will be triggered when the system is disposed
  12884. */
  12885. set onDispose(callback: () => void);
  12886. private _particles;
  12887. private _epsilon;
  12888. private _capacity;
  12889. private _stockParticles;
  12890. private _newPartsExcess;
  12891. private _vertexData;
  12892. private _vertexBuffer;
  12893. private _vertexBuffers;
  12894. private _spriteBuffer;
  12895. private _indexBuffer;
  12896. private _effect;
  12897. private _customEffect;
  12898. private _cachedDefines;
  12899. private _scaledColorStep;
  12900. private _colorDiff;
  12901. private _scaledDirection;
  12902. private _scaledGravity;
  12903. private _currentRenderId;
  12904. private _alive;
  12905. private _useInstancing;
  12906. private _started;
  12907. private _stopped;
  12908. private _actualFrame;
  12909. private _scaledUpdateSpeed;
  12910. private _vertexBufferSize;
  12911. /** @hidden */
  12912. _currentEmitRateGradient: Nullable<FactorGradient>;
  12913. /** @hidden */
  12914. _currentEmitRate1: number;
  12915. /** @hidden */
  12916. _currentEmitRate2: number;
  12917. /** @hidden */
  12918. _currentStartSizeGradient: Nullable<FactorGradient>;
  12919. /** @hidden */
  12920. _currentStartSize1: number;
  12921. /** @hidden */
  12922. _currentStartSize2: number;
  12923. private readonly _rawTextureWidth;
  12924. private _rampGradientsTexture;
  12925. private _useRampGradients;
  12926. /** Gets or sets a matrix to use to compute projection */
  12927. defaultProjectionMatrix: Matrix;
  12928. /** Gets or sets a matrix to use to compute view */
  12929. defaultViewMatrix: Matrix;
  12930. /** Gets or sets a boolean indicating that ramp gradients must be used
  12931. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  12932. */
  12933. get useRampGradients(): boolean;
  12934. set useRampGradients(value: boolean);
  12935. /**
  12936. * The Sub-emitters templates that will be used to generate the sub particle system to be associated with the system, this property is used by the root particle system only.
  12937. * When a particle is spawned, an array will be chosen at random and all the emitters in that array will be attached to the particle. (Default: [])
  12938. */
  12939. subEmitters: Array<ParticleSystem | SubEmitter | Array<SubEmitter>>;
  12940. private _subEmitters;
  12941. /**
  12942. * @hidden
  12943. * If the particle systems emitter should be disposed when the particle system is disposed
  12944. */
  12945. _disposeEmitterOnDispose: boolean;
  12946. /**
  12947. * The current active Sub-systems, this property is used by the root particle system only.
  12948. */
  12949. activeSubSystems: Array<ParticleSystem>;
  12950. /**
  12951. * Specifies if the particles are updated in emitter local space or world space
  12952. */
  12953. isLocal: boolean;
  12954. private _rootParticleSystem;
  12955. /**
  12956. * Gets the current list of active particles
  12957. */
  12958. get particles(): Particle[];
  12959. /**
  12960. * Gets the number of particles active at the same time.
  12961. * @returns The number of active particles.
  12962. */
  12963. getActiveCount(): number;
  12964. /**
  12965. * Returns the string "ParticleSystem"
  12966. * @returns a string containing the class name
  12967. */
  12968. getClassName(): string;
  12969. /**
  12970. * Gets a boolean indicating that the system is stopping
  12971. * @returns true if the system is currently stopping
  12972. */
  12973. isStopping(): boolean;
  12974. /**
  12975. * Gets the custom effect used to render the particles
  12976. * @param blendMode Blend mode for which the effect should be retrieved
  12977. * @returns The effect
  12978. */
  12979. getCustomEffect(blendMode?: number): Nullable<Effect>;
  12980. /**
  12981. * Sets the custom effect used to render the particles
  12982. * @param effect The effect to set
  12983. * @param blendMode Blend mode for which the effect should be set
  12984. */
  12985. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  12986. /** @hidden */
  12987. private _onBeforeDrawParticlesObservable;
  12988. /**
  12989. * Observable that will be called just before the particles are drawn
  12990. */
  12991. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  12992. /**
  12993. * Gets the name of the particle vertex shader
  12994. */
  12995. get vertexShaderName(): string;
  12996. /**
  12997. * Instantiates a particle system.
  12998. * Particles are often small sprites used to simulate hard-to-reproduce phenomena like fire, smoke, water, or abstract visual effects like magic glitter and faery dust.
  12999. * @param name The name of the particle system
  13000. * @param capacity The max number of particles alive at the same time
  13001. * @param sceneOrEngine The scene the particle system belongs to or the engine to use if no scene
  13002. * @param customEffect a custom effect used to change the way particles are rendered by default
  13003. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  13004. * @param epsilon Offset used to render the particles
  13005. */
  13006. constructor(name: string, capacity: number, sceneOrEngine: Scene | ThinEngine, customEffect?: Nullable<Effect>, isAnimationSheetEnabled?: boolean, epsilon?: number);
  13007. private _addFactorGradient;
  13008. private _removeFactorGradient;
  13009. /**
  13010. * Adds a new life time gradient
  13011. * @param gradient defines the gradient to use (between 0 and 1)
  13012. * @param factor defines the life time factor to affect to the specified gradient
  13013. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13014. * @returns the current particle system
  13015. */
  13016. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13017. /**
  13018. * Remove a specific life time gradient
  13019. * @param gradient defines the gradient to remove
  13020. * @returns the current particle system
  13021. */
  13022. removeLifeTimeGradient(gradient: number): IParticleSystem;
  13023. /**
  13024. * Adds a new size gradient
  13025. * @param gradient defines the gradient to use (between 0 and 1)
  13026. * @param factor defines the size factor to affect to the specified gradient
  13027. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13028. * @returns the current particle system
  13029. */
  13030. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13031. /**
  13032. * Remove a specific size gradient
  13033. * @param gradient defines the gradient to remove
  13034. * @returns the current particle system
  13035. */
  13036. removeSizeGradient(gradient: number): IParticleSystem;
  13037. /**
  13038. * Adds a new color remap gradient
  13039. * @param gradient defines the gradient to use (between 0 and 1)
  13040. * @param min defines the color remap minimal range
  13041. * @param max defines the color remap maximal range
  13042. * @returns the current particle system
  13043. */
  13044. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  13045. /**
  13046. * Remove a specific color remap gradient
  13047. * @param gradient defines the gradient to remove
  13048. * @returns the current particle system
  13049. */
  13050. removeColorRemapGradient(gradient: number): IParticleSystem;
  13051. /**
  13052. * Adds a new alpha remap gradient
  13053. * @param gradient defines the gradient to use (between 0 and 1)
  13054. * @param min defines the alpha remap minimal range
  13055. * @param max defines the alpha remap maximal range
  13056. * @returns the current particle system
  13057. */
  13058. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  13059. /**
  13060. * Remove a specific alpha remap gradient
  13061. * @param gradient defines the gradient to remove
  13062. * @returns the current particle system
  13063. */
  13064. removeAlphaRemapGradient(gradient: number): IParticleSystem;
  13065. /**
  13066. * Adds a new angular speed gradient
  13067. * @param gradient defines the gradient to use (between 0 and 1)
  13068. * @param factor defines the angular speed to affect to the specified gradient
  13069. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13070. * @returns the current particle system
  13071. */
  13072. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13073. /**
  13074. * Remove a specific angular speed gradient
  13075. * @param gradient defines the gradient to remove
  13076. * @returns the current particle system
  13077. */
  13078. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  13079. /**
  13080. * Adds a new velocity gradient
  13081. * @param gradient defines the gradient to use (between 0 and 1)
  13082. * @param factor defines the velocity to affect to the specified gradient
  13083. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13084. * @returns the current particle system
  13085. */
  13086. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13087. /**
  13088. * Remove a specific velocity gradient
  13089. * @param gradient defines the gradient to remove
  13090. * @returns the current particle system
  13091. */
  13092. removeVelocityGradient(gradient: number): IParticleSystem;
  13093. /**
  13094. * Adds a new limit velocity gradient
  13095. * @param gradient defines the gradient to use (between 0 and 1)
  13096. * @param factor defines the limit velocity value to affect to the specified gradient
  13097. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13098. * @returns the current particle system
  13099. */
  13100. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13101. /**
  13102. * Remove a specific limit velocity gradient
  13103. * @param gradient defines the gradient to remove
  13104. * @returns the current particle system
  13105. */
  13106. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  13107. /**
  13108. * Adds a new drag gradient
  13109. * @param gradient defines the gradient to use (between 0 and 1)
  13110. * @param factor defines the drag value to affect to the specified gradient
  13111. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13112. * @returns the current particle system
  13113. */
  13114. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13115. /**
  13116. * Remove a specific drag gradient
  13117. * @param gradient defines the gradient to remove
  13118. * @returns the current particle system
  13119. */
  13120. removeDragGradient(gradient: number): IParticleSystem;
  13121. /**
  13122. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  13123. * @param gradient defines the gradient to use (between 0 and 1)
  13124. * @param factor defines the emit rate value to affect to the specified gradient
  13125. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13126. * @returns the current particle system
  13127. */
  13128. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13129. /**
  13130. * Remove a specific emit rate gradient
  13131. * @param gradient defines the gradient to remove
  13132. * @returns the current particle system
  13133. */
  13134. removeEmitRateGradient(gradient: number): IParticleSystem;
  13135. /**
  13136. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  13137. * @param gradient defines the gradient to use (between 0 and 1)
  13138. * @param factor defines the start size value to affect to the specified gradient
  13139. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13140. * @returns the current particle system
  13141. */
  13142. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13143. /**
  13144. * Remove a specific start size gradient
  13145. * @param gradient defines the gradient to remove
  13146. * @returns the current particle system
  13147. */
  13148. removeStartSizeGradient(gradient: number): IParticleSystem;
  13149. private _createRampGradientTexture;
  13150. /**
  13151. * Gets the current list of ramp gradients.
  13152. * You must use addRampGradient and removeRampGradient to udpate this list
  13153. * @returns the list of ramp gradients
  13154. */
  13155. getRampGradients(): Nullable<Array<Color3Gradient>>;
  13156. /** Force the system to rebuild all gradients that need to be resync */
  13157. forceRefreshGradients(): void;
  13158. private _syncRampGradientTexture;
  13159. /**
  13160. * Adds a new ramp gradient used to remap particle colors
  13161. * @param gradient defines the gradient to use (between 0 and 1)
  13162. * @param color defines the color to affect to the specified gradient
  13163. * @returns the current particle system
  13164. */
  13165. addRampGradient(gradient: number, color: Color3): ParticleSystem;
  13166. /**
  13167. * Remove a specific ramp gradient
  13168. * @param gradient defines the gradient to remove
  13169. * @returns the current particle system
  13170. */
  13171. removeRampGradient(gradient: number): ParticleSystem;
  13172. /**
  13173. * Adds a new color gradient
  13174. * @param gradient defines the gradient to use (between 0 and 1)
  13175. * @param color1 defines the color to affect to the specified gradient
  13176. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  13177. * @returns this particle system
  13178. */
  13179. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  13180. /**
  13181. * Remove a specific color gradient
  13182. * @param gradient defines the gradient to remove
  13183. * @returns this particle system
  13184. */
  13185. removeColorGradient(gradient: number): IParticleSystem;
  13186. private _fetchR;
  13187. protected _reset(): void;
  13188. private _resetEffect;
  13189. private _createVertexBuffers;
  13190. private _createIndexBuffer;
  13191. /**
  13192. * Gets the maximum number of particles active at the same time.
  13193. * @returns The max number of active particles.
  13194. */
  13195. getCapacity(): number;
  13196. /**
  13197. * Gets whether there are still active particles in the system.
  13198. * @returns True if it is alive, otherwise false.
  13199. */
  13200. isAlive(): boolean;
  13201. /**
  13202. * Gets if the system has been started. (Note: this will still be true after stop is called)
  13203. * @returns True if it has been started, otherwise false.
  13204. */
  13205. isStarted(): boolean;
  13206. private _prepareSubEmitterInternalArray;
  13207. /**
  13208. * Starts the particle system and begins to emit
  13209. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  13210. */
  13211. start(delay?: number): void;
  13212. /**
  13213. * Stops the particle system.
  13214. * @param stopSubEmitters if true it will stop the current system and all created sub-Systems if false it will stop the current root system only, this param is used by the root particle system only. the default value is true.
  13215. */
  13216. stop(stopSubEmitters?: boolean): void;
  13217. /**
  13218. * Remove all active particles
  13219. */
  13220. reset(): void;
  13221. /**
  13222. * @hidden (for internal use only)
  13223. */
  13224. _appendParticleVertex(index: number, particle: Particle, offsetX: number, offsetY: number): void;
  13225. /**
  13226. * "Recycles" one of the particle by copying it back to the "stock" of particles and removing it from the active list.
  13227. * Its lifetime will start back at 0.
  13228. */
  13229. recycleParticle: (particle: Particle) => void;
  13230. private _stopSubEmitters;
  13231. private _createParticle;
  13232. private _removeFromRoot;
  13233. private _emitFromParticle;
  13234. private _update;
  13235. /** @hidden */
  13236. static _GetAttributeNamesOrOptions(isAnimationSheetEnabled?: boolean, isBillboardBased?: boolean, useRampGradients?: boolean): string[];
  13237. /** @hidden */
  13238. static _GetEffectCreationOptions(isAnimationSheetEnabled?: boolean): string[];
  13239. /**
  13240. * Fill the defines array according to the current settings of the particle system
  13241. * @param defines Array to be updated
  13242. * @param blendMode blend mode to take into account when updating the array
  13243. */
  13244. fillDefines(defines: Array<string>, blendMode: number): void;
  13245. /**
  13246. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  13247. * @param uniforms Uniforms array to fill
  13248. * @param attributes Attributes array to fill
  13249. * @param samplers Samplers array to fill
  13250. */
  13251. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  13252. /** @hidden */
  13253. private _getEffect;
  13254. /**
  13255. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  13256. * @param preWarmOnly will prevent the system from updating the vertex buffer (default is false)
  13257. */
  13258. animate(preWarmOnly?: boolean): void;
  13259. private _appendParticleVertices;
  13260. /**
  13261. * Rebuilds the particle system.
  13262. */
  13263. rebuild(): void;
  13264. /**
  13265. * Is this system ready to be used/rendered
  13266. * @return true if the system is ready
  13267. */
  13268. isReady(): boolean;
  13269. private _render;
  13270. /**
  13271. * Renders the particle system in its current state.
  13272. * @returns the current number of particles
  13273. */
  13274. render(): number;
  13275. /**
  13276. * Disposes the particle system and free the associated resources
  13277. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  13278. */
  13279. dispose(disposeTexture?: boolean): void;
  13280. /**
  13281. * Clones the particle system.
  13282. * @param name The name of the cloned object
  13283. * @param newEmitter The new emitter to use
  13284. * @returns the cloned particle system
  13285. */
  13286. clone(name: string, newEmitter: any): ParticleSystem;
  13287. /**
  13288. * Serializes the particle system to a JSON object
  13289. * @param serializeTexture defines if the texture must be serialized as well
  13290. * @returns the JSON object
  13291. */
  13292. serialize(serializeTexture?: boolean): any;
  13293. /** @hidden */
  13294. static _Serialize(serializationObject: any, particleSystem: IParticleSystem, serializeTexture: boolean): void;
  13295. /** @hidden */
  13296. static _Parse(parsedParticleSystem: any, particleSystem: IParticleSystem, sceneOrEngine: Scene | ThinEngine, rootUrl: string): void;
  13297. /**
  13298. * Parses a JSON object to create a particle system.
  13299. * @param parsedParticleSystem The JSON object to parse
  13300. * @param sceneOrEngine The scene or the engine to create the particle system in
  13301. * @param rootUrl The root url to use to load external dependencies like texture
  13302. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  13303. * @returns the Parsed particle system
  13304. */
  13305. static Parse(parsedParticleSystem: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string, doNotStart?: boolean): ParticleSystem;
  13306. }
  13307. }
  13308. declare module "babylonjs/Particles/particle" {
  13309. import { Nullable } from "babylonjs/types";
  13310. import { Vector2, Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  13311. import { Color4 } from "babylonjs/Maths/math.color";
  13312. import { ParticleSystem } from "babylonjs/Particles/particleSystem";
  13313. import { SubEmitter } from "babylonjs/Particles/subEmitter";
  13314. import { ColorGradient, FactorGradient } from "babylonjs/Misc/gradients";
  13315. /**
  13316. * A particle represents one of the element emitted by a particle system.
  13317. * This is mainly define by its coordinates, direction, velocity and age.
  13318. */
  13319. export class Particle {
  13320. /**
  13321. * The particle system the particle belongs to.
  13322. */
  13323. particleSystem: ParticleSystem;
  13324. private static _Count;
  13325. /**
  13326. * Unique ID of the particle
  13327. */
  13328. id: number;
  13329. /**
  13330. * The world position of the particle in the scene.
  13331. */
  13332. position: Vector3;
  13333. /**
  13334. * The world direction of the particle in the scene.
  13335. */
  13336. direction: Vector3;
  13337. /**
  13338. * The color of the particle.
  13339. */
  13340. color: Color4;
  13341. /**
  13342. * The color change of the particle per step.
  13343. */
  13344. colorStep: Color4;
  13345. /**
  13346. * Defines how long will the life of the particle be.
  13347. */
  13348. lifeTime: number;
  13349. /**
  13350. * The current age of the particle.
  13351. */
  13352. age: number;
  13353. /**
  13354. * The current size of the particle.
  13355. */
  13356. size: number;
  13357. /**
  13358. * The current scale of the particle.
  13359. */
  13360. scale: Vector2;
  13361. /**
  13362. * The current angle of the particle.
  13363. */
  13364. angle: number;
  13365. /**
  13366. * Defines how fast is the angle changing.
  13367. */
  13368. angularSpeed: number;
  13369. /**
  13370. * Defines the cell index used by the particle to be rendered from a sprite.
  13371. */
  13372. cellIndex: number;
  13373. /**
  13374. * The information required to support color remapping
  13375. */
  13376. remapData: Vector4;
  13377. /** @hidden */
  13378. _randomCellOffset?: number;
  13379. /** @hidden */
  13380. _initialDirection: Nullable<Vector3>;
  13381. /** @hidden */
  13382. _attachedSubEmitters: Nullable<Array<SubEmitter>>;
  13383. /** @hidden */
  13384. _initialStartSpriteCellID: number;
  13385. /** @hidden */
  13386. _initialEndSpriteCellID: number;
  13387. /** @hidden */
  13388. _currentColorGradient: Nullable<ColorGradient>;
  13389. /** @hidden */
  13390. _currentColor1: Color4;
  13391. /** @hidden */
  13392. _currentColor2: Color4;
  13393. /** @hidden */
  13394. _currentSizeGradient: Nullable<FactorGradient>;
  13395. /** @hidden */
  13396. _currentSize1: number;
  13397. /** @hidden */
  13398. _currentSize2: number;
  13399. /** @hidden */
  13400. _currentAngularSpeedGradient: Nullable<FactorGradient>;
  13401. /** @hidden */
  13402. _currentAngularSpeed1: number;
  13403. /** @hidden */
  13404. _currentAngularSpeed2: number;
  13405. /** @hidden */
  13406. _currentVelocityGradient: Nullable<FactorGradient>;
  13407. /** @hidden */
  13408. _currentVelocity1: number;
  13409. /** @hidden */
  13410. _currentVelocity2: number;
  13411. /** @hidden */
  13412. _currentLimitVelocityGradient: Nullable<FactorGradient>;
  13413. /** @hidden */
  13414. _currentLimitVelocity1: number;
  13415. /** @hidden */
  13416. _currentLimitVelocity2: number;
  13417. /** @hidden */
  13418. _currentDragGradient: Nullable<FactorGradient>;
  13419. /** @hidden */
  13420. _currentDrag1: number;
  13421. /** @hidden */
  13422. _currentDrag2: number;
  13423. /** @hidden */
  13424. _randomNoiseCoordinates1: Vector3;
  13425. /** @hidden */
  13426. _randomNoiseCoordinates2: Vector3;
  13427. /** @hidden */
  13428. _localPosition?: Vector3;
  13429. /**
  13430. * Creates a new instance Particle
  13431. * @param particleSystem the particle system the particle belongs to
  13432. */
  13433. constructor(
  13434. /**
  13435. * The particle system the particle belongs to.
  13436. */
  13437. particleSystem: ParticleSystem);
  13438. private updateCellInfoFromSystem;
  13439. /**
  13440. * Defines how the sprite cell index is updated for the particle
  13441. */
  13442. updateCellIndex(): void;
  13443. /** @hidden */
  13444. _inheritParticleInfoToSubEmitter(subEmitter: SubEmitter): void;
  13445. /** @hidden */
  13446. _inheritParticleInfoToSubEmitters(): void;
  13447. /** @hidden */
  13448. _reset(): void;
  13449. /**
  13450. * Copy the properties of particle to another one.
  13451. * @param other the particle to copy the information to.
  13452. */
  13453. copyTo(other: Particle): void;
  13454. }
  13455. }
  13456. declare module "babylonjs/Particles/EmitterTypes/IParticleEmitterType" {
  13457. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13458. import { Effect } from "babylonjs/Materials/effect";
  13459. import { Particle } from "babylonjs/Particles/particle";
  13460. import { Nullable } from "babylonjs/types";
  13461. import { Scene } from "babylonjs/scene";
  13462. /**
  13463. * Particle emitter represents a volume emitting particles.
  13464. * This is the responsibility of the implementation to define the volume shape like cone/sphere/box.
  13465. */
  13466. export interface IParticleEmitterType {
  13467. /**
  13468. * Called by the particle System when the direction is computed for the created particle.
  13469. * @param worldMatrix is the world matrix of the particle system
  13470. * @param directionToUpdate is the direction vector to update with the result
  13471. * @param particle is the particle we are computed the direction for
  13472. * @param isLocal defines if the direction should be set in local space
  13473. */
  13474. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13475. /**
  13476. * Called by the particle System when the position is computed for the created particle.
  13477. * @param worldMatrix is the world matrix of the particle system
  13478. * @param positionToUpdate is the position vector to update with the result
  13479. * @param particle is the particle we are computed the position for
  13480. * @param isLocal defines if the position should be set in local space
  13481. */
  13482. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13483. /**
  13484. * Clones the current emitter and returns a copy of it
  13485. * @returns the new emitter
  13486. */
  13487. clone(): IParticleEmitterType;
  13488. /**
  13489. * Called by the GPUParticleSystem to setup the update shader
  13490. * @param effect defines the update shader
  13491. */
  13492. applyToShader(effect: Effect): void;
  13493. /**
  13494. * Returns a string to use to update the GPU particles update shader
  13495. * @returns the effect defines string
  13496. */
  13497. getEffectDefines(): string;
  13498. /**
  13499. * Returns a string representing the class name
  13500. * @returns a string containing the class name
  13501. */
  13502. getClassName(): string;
  13503. /**
  13504. * Serializes the particle system to a JSON object.
  13505. * @returns the JSON object
  13506. */
  13507. serialize(): any;
  13508. /**
  13509. * Parse properties from a JSON object
  13510. * @param serializationObject defines the JSON object
  13511. * @param scene defines the hosting scene
  13512. */
  13513. parse(serializationObject: any, scene: Nullable<Scene>): void;
  13514. }
  13515. }
  13516. declare module "babylonjs/Particles/EmitterTypes/boxParticleEmitter" {
  13517. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13518. import { Effect } from "babylonjs/Materials/effect";
  13519. import { Particle } from "babylonjs/Particles/particle";
  13520. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13521. /**
  13522. * Particle emitter emitting particles from the inside of a box.
  13523. * It emits the particles randomly between 2 given directions.
  13524. */
  13525. export class BoxParticleEmitter implements IParticleEmitterType {
  13526. /**
  13527. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  13528. */
  13529. direction1: Vector3;
  13530. /**
  13531. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  13532. */
  13533. direction2: Vector3;
  13534. /**
  13535. * Minimum box point around our emitter. Our emitter is the center of particles source, but if you want your particles to emit from more than one point, then you can tell it to do so.
  13536. */
  13537. minEmitBox: Vector3;
  13538. /**
  13539. * Maximum box point around our emitter. Our emitter is the center of particles source, but if you want your particles to emit from more than one point, then you can tell it to do so.
  13540. */
  13541. maxEmitBox: Vector3;
  13542. /**
  13543. * Creates a new instance BoxParticleEmitter
  13544. */
  13545. constructor();
  13546. /**
  13547. * Called by the particle System when the direction is computed for the created particle.
  13548. * @param worldMatrix is the world matrix of the particle system
  13549. * @param directionToUpdate is the direction vector to update with the result
  13550. * @param particle is the particle we are computed the direction for
  13551. * @param isLocal defines if the direction should be set in local space
  13552. */
  13553. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13554. /**
  13555. * Called by the particle System when the position is computed for the created particle.
  13556. * @param worldMatrix is the world matrix of the particle system
  13557. * @param positionToUpdate is the position vector to update with the result
  13558. * @param particle is the particle we are computed the position for
  13559. * @param isLocal defines if the position should be set in local space
  13560. */
  13561. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13562. /**
  13563. * Clones the current emitter and returns a copy of it
  13564. * @returns the new emitter
  13565. */
  13566. clone(): BoxParticleEmitter;
  13567. /**
  13568. * Called by the GPUParticleSystem to setup the update shader
  13569. * @param effect defines the update shader
  13570. */
  13571. applyToShader(effect: Effect): void;
  13572. /**
  13573. * Returns a string to use to update the GPU particles update shader
  13574. * @returns a string containng the defines string
  13575. */
  13576. getEffectDefines(): string;
  13577. /**
  13578. * Returns the string "BoxParticleEmitter"
  13579. * @returns a string containing the class name
  13580. */
  13581. getClassName(): string;
  13582. /**
  13583. * Serializes the particle system to a JSON object.
  13584. * @returns the JSON object
  13585. */
  13586. serialize(): any;
  13587. /**
  13588. * Parse properties from a JSON object
  13589. * @param serializationObject defines the JSON object
  13590. */
  13591. parse(serializationObject: any): void;
  13592. }
  13593. }
  13594. declare module "babylonjs/Particles/EmitterTypes/coneParticleEmitter" {
  13595. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13596. import { Effect } from "babylonjs/Materials/effect";
  13597. import { Particle } from "babylonjs/Particles/particle";
  13598. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13599. /**
  13600. * Particle emitter emitting particles from the inside of a cone.
  13601. * It emits the particles alongside the cone volume from the base to the particle.
  13602. * The emission direction might be randomized.
  13603. */
  13604. export class ConeParticleEmitter implements IParticleEmitterType {
  13605. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  13606. directionRandomizer: number;
  13607. private _radius;
  13608. private _angle;
  13609. private _height;
  13610. /**
  13611. * Gets or sets a value indicating where on the radius the start position should be picked (1 = everywhere, 0 = only surface)
  13612. */
  13613. radiusRange: number;
  13614. /**
  13615. * Gets or sets a value indicating where on the height the start position should be picked (1 = everywhere, 0 = only surface)
  13616. */
  13617. heightRange: number;
  13618. /**
  13619. * Gets or sets a value indicating if all the particles should be emitted from the spawn point only (the base of the cone)
  13620. */
  13621. emitFromSpawnPointOnly: boolean;
  13622. /**
  13623. * Gets or sets the radius of the emission cone
  13624. */
  13625. get radius(): number;
  13626. set radius(value: number);
  13627. /**
  13628. * Gets or sets the angle of the emission cone
  13629. */
  13630. get angle(): number;
  13631. set angle(value: number);
  13632. private _buildHeight;
  13633. /**
  13634. * Creates a new instance ConeParticleEmitter
  13635. * @param radius the radius of the emission cone (1 by default)
  13636. * @param angle the cone base angle (PI by default)
  13637. * @param directionRandomizer defines how much to randomize the particle direction [0-1] (default is 0)
  13638. */
  13639. constructor(radius?: number, angle?: number,
  13640. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  13641. directionRandomizer?: number);
  13642. /**
  13643. * Called by the particle System when the direction is computed for the created particle.
  13644. * @param worldMatrix is the world matrix of the particle system
  13645. * @param directionToUpdate is the direction vector to update with the result
  13646. * @param particle is the particle we are computed the direction for
  13647. * @param isLocal defines if the direction should be set in local space
  13648. */
  13649. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13650. /**
  13651. * Called by the particle System when the position is computed for the created particle.
  13652. * @param worldMatrix is the world matrix of the particle system
  13653. * @param positionToUpdate is the position vector to update with the result
  13654. * @param particle is the particle we are computed the position for
  13655. * @param isLocal defines if the position should be set in local space
  13656. */
  13657. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13658. /**
  13659. * Clones the current emitter and returns a copy of it
  13660. * @returns the new emitter
  13661. */
  13662. clone(): ConeParticleEmitter;
  13663. /**
  13664. * Called by the GPUParticleSystem to setup the update shader
  13665. * @param effect defines the update shader
  13666. */
  13667. applyToShader(effect: Effect): void;
  13668. /**
  13669. * Returns a string to use to update the GPU particles update shader
  13670. * @returns a string containng the defines string
  13671. */
  13672. getEffectDefines(): string;
  13673. /**
  13674. * Returns the string "ConeParticleEmitter"
  13675. * @returns a string containing the class name
  13676. */
  13677. getClassName(): string;
  13678. /**
  13679. * Serializes the particle system to a JSON object.
  13680. * @returns the JSON object
  13681. */
  13682. serialize(): any;
  13683. /**
  13684. * Parse properties from a JSON object
  13685. * @param serializationObject defines the JSON object
  13686. */
  13687. parse(serializationObject: any): void;
  13688. }
  13689. }
  13690. declare module "babylonjs/Particles/EmitterTypes/cylinderParticleEmitter" {
  13691. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13692. import { Effect } from "babylonjs/Materials/effect";
  13693. import { Particle } from "babylonjs/Particles/particle";
  13694. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13695. /**
  13696. * Particle emitter emitting particles from the inside of a cylinder.
  13697. * It emits the particles alongside the cylinder radius. The emission direction might be randomized.
  13698. */
  13699. export class CylinderParticleEmitter implements IParticleEmitterType {
  13700. /**
  13701. * The radius of the emission cylinder.
  13702. */
  13703. radius: number;
  13704. /**
  13705. * The height of the emission cylinder.
  13706. */
  13707. height: number;
  13708. /**
  13709. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  13710. */
  13711. radiusRange: number;
  13712. /**
  13713. * How much to randomize the particle direction [0-1].
  13714. */
  13715. directionRandomizer: number;
  13716. /**
  13717. * Creates a new instance CylinderParticleEmitter
  13718. * @param radius the radius of the emission cylinder (1 by default)
  13719. * @param height the height of the emission cylinder (1 by default)
  13720. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  13721. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  13722. */
  13723. constructor(
  13724. /**
  13725. * The radius of the emission cylinder.
  13726. */
  13727. radius?: number,
  13728. /**
  13729. * The height of the emission cylinder.
  13730. */
  13731. height?: number,
  13732. /**
  13733. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  13734. */
  13735. radiusRange?: number,
  13736. /**
  13737. * How much to randomize the particle direction [0-1].
  13738. */
  13739. directionRandomizer?: number);
  13740. /**
  13741. * Called by the particle System when the direction is computed for the created particle.
  13742. * @param worldMatrix is the world matrix of the particle system
  13743. * @param directionToUpdate is the direction vector to update with the result
  13744. * @param particle is the particle we are computed the direction for
  13745. * @param isLocal defines if the direction should be set in local space
  13746. */
  13747. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13748. /**
  13749. * Called by the particle System when the position is computed for the created particle.
  13750. * @param worldMatrix is the world matrix of the particle system
  13751. * @param positionToUpdate is the position vector to update with the result
  13752. * @param particle is the particle we are computed the position for
  13753. * @param isLocal defines if the position should be set in local space
  13754. */
  13755. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13756. /**
  13757. * Clones the current emitter and returns a copy of it
  13758. * @returns the new emitter
  13759. */
  13760. clone(): CylinderParticleEmitter;
  13761. /**
  13762. * Called by the GPUParticleSystem to setup the update shader
  13763. * @param effect defines the update shader
  13764. */
  13765. applyToShader(effect: Effect): void;
  13766. /**
  13767. * Returns a string to use to update the GPU particles update shader
  13768. * @returns a string containng the defines string
  13769. */
  13770. getEffectDefines(): string;
  13771. /**
  13772. * Returns the string "CylinderParticleEmitter"
  13773. * @returns a string containing the class name
  13774. */
  13775. getClassName(): string;
  13776. /**
  13777. * Serializes the particle system to a JSON object.
  13778. * @returns the JSON object
  13779. */
  13780. serialize(): any;
  13781. /**
  13782. * Parse properties from a JSON object
  13783. * @param serializationObject defines the JSON object
  13784. */
  13785. parse(serializationObject: any): void;
  13786. }
  13787. /**
  13788. * Particle emitter emitting particles from the inside of a cylinder.
  13789. * It emits the particles randomly between two vectors.
  13790. */
  13791. export class CylinderDirectedParticleEmitter extends CylinderParticleEmitter {
  13792. /**
  13793. * The min limit of the emission direction.
  13794. */
  13795. direction1: Vector3;
  13796. /**
  13797. * The max limit of the emission direction.
  13798. */
  13799. direction2: Vector3;
  13800. /**
  13801. * Creates a new instance CylinderDirectedParticleEmitter
  13802. * @param radius the radius of the emission cylinder (1 by default)
  13803. * @param height the height of the emission cylinder (1 by default)
  13804. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  13805. * @param direction1 the min limit of the emission direction (up vector by default)
  13806. * @param direction2 the max limit of the emission direction (up vector by default)
  13807. */
  13808. constructor(radius?: number, height?: number, radiusRange?: number,
  13809. /**
  13810. * The min limit of the emission direction.
  13811. */
  13812. direction1?: Vector3,
  13813. /**
  13814. * The max limit of the emission direction.
  13815. */
  13816. direction2?: Vector3);
  13817. /**
  13818. * Called by the particle System when the direction is computed for the created particle.
  13819. * @param worldMatrix is the world matrix of the particle system
  13820. * @param directionToUpdate is the direction vector to update with the result
  13821. * @param particle is the particle we are computed the direction for
  13822. */
  13823. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  13824. /**
  13825. * Clones the current emitter and returns a copy of it
  13826. * @returns the new emitter
  13827. */
  13828. clone(): CylinderDirectedParticleEmitter;
  13829. /**
  13830. * Called by the GPUParticleSystem to setup the update shader
  13831. * @param effect defines the update shader
  13832. */
  13833. applyToShader(effect: Effect): void;
  13834. /**
  13835. * Returns a string to use to update the GPU particles update shader
  13836. * @returns a string containng the defines string
  13837. */
  13838. getEffectDefines(): string;
  13839. /**
  13840. * Returns the string "CylinderDirectedParticleEmitter"
  13841. * @returns a string containing the class name
  13842. */
  13843. getClassName(): string;
  13844. /**
  13845. * Serializes the particle system to a JSON object.
  13846. * @returns the JSON object
  13847. */
  13848. serialize(): any;
  13849. /**
  13850. * Parse properties from a JSON object
  13851. * @param serializationObject defines the JSON object
  13852. */
  13853. parse(serializationObject: any): void;
  13854. }
  13855. }
  13856. declare module "babylonjs/Particles/EmitterTypes/hemisphericParticleEmitter" {
  13857. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13858. import { Effect } from "babylonjs/Materials/effect";
  13859. import { Particle } from "babylonjs/Particles/particle";
  13860. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13861. /**
  13862. * Particle emitter emitting particles from the inside of a hemisphere.
  13863. * It emits the particles alongside the hemisphere radius. The emission direction might be randomized.
  13864. */
  13865. export class HemisphericParticleEmitter implements IParticleEmitterType {
  13866. /**
  13867. * The radius of the emission hemisphere.
  13868. */
  13869. radius: number;
  13870. /**
  13871. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  13872. */
  13873. radiusRange: number;
  13874. /**
  13875. * How much to randomize the particle direction [0-1].
  13876. */
  13877. directionRandomizer: number;
  13878. /**
  13879. * Creates a new instance HemisphericParticleEmitter
  13880. * @param radius the radius of the emission hemisphere (1 by default)
  13881. * @param radiusRange the range of the emission hemisphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  13882. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  13883. */
  13884. constructor(
  13885. /**
  13886. * The radius of the emission hemisphere.
  13887. */
  13888. radius?: number,
  13889. /**
  13890. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  13891. */
  13892. radiusRange?: number,
  13893. /**
  13894. * How much to randomize the particle direction [0-1].
  13895. */
  13896. directionRandomizer?: number);
  13897. /**
  13898. * Called by the particle System when the direction is computed for the created particle.
  13899. * @param worldMatrix is the world matrix of the particle system
  13900. * @param directionToUpdate is the direction vector to update with the result
  13901. * @param particle is the particle we are computed the direction for
  13902. * @param isLocal defines if the direction should be set in local space
  13903. */
  13904. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13905. /**
  13906. * Called by the particle System when the position is computed for the created particle.
  13907. * @param worldMatrix is the world matrix of the particle system
  13908. * @param positionToUpdate is the position vector to update with the result
  13909. * @param particle is the particle we are computed the position for
  13910. * @param isLocal defines if the position should be set in local space
  13911. */
  13912. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13913. /**
  13914. * Clones the current emitter and returns a copy of it
  13915. * @returns the new emitter
  13916. */
  13917. clone(): HemisphericParticleEmitter;
  13918. /**
  13919. * Called by the GPUParticleSystem to setup the update shader
  13920. * @param effect defines the update shader
  13921. */
  13922. applyToShader(effect: Effect): void;
  13923. /**
  13924. * Returns a string to use to update the GPU particles update shader
  13925. * @returns a string containng the defines string
  13926. */
  13927. getEffectDefines(): string;
  13928. /**
  13929. * Returns the string "HemisphericParticleEmitter"
  13930. * @returns a string containing the class name
  13931. */
  13932. getClassName(): string;
  13933. /**
  13934. * Serializes the particle system to a JSON object.
  13935. * @returns the JSON object
  13936. */
  13937. serialize(): any;
  13938. /**
  13939. * Parse properties from a JSON object
  13940. * @param serializationObject defines the JSON object
  13941. */
  13942. parse(serializationObject: any): void;
  13943. }
  13944. }
  13945. declare module "babylonjs/Particles/EmitterTypes/pointParticleEmitter" {
  13946. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13947. import { Effect } from "babylonjs/Materials/effect";
  13948. import { Particle } from "babylonjs/Particles/particle";
  13949. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13950. /**
  13951. * Particle emitter emitting particles from a point.
  13952. * It emits the particles randomly between 2 given directions.
  13953. */
  13954. export class PointParticleEmitter implements IParticleEmitterType {
  13955. /**
  13956. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  13957. */
  13958. direction1: Vector3;
  13959. /**
  13960. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  13961. */
  13962. direction2: Vector3;
  13963. /**
  13964. * Creates a new instance PointParticleEmitter
  13965. */
  13966. constructor();
  13967. /**
  13968. * Called by the particle System when the direction is computed for the created particle.
  13969. * @param worldMatrix is the world matrix of the particle system
  13970. * @param directionToUpdate is the direction vector to update with the result
  13971. * @param particle is the particle we are computed the direction for
  13972. * @param isLocal defines if the direction should be set in local space
  13973. */
  13974. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13975. /**
  13976. * Called by the particle System when the position is computed for the created particle.
  13977. * @param worldMatrix is the world matrix of the particle system
  13978. * @param positionToUpdate is the position vector to update with the result
  13979. * @param particle is the particle we are computed the position for
  13980. * @param isLocal defines if the position should be set in local space
  13981. */
  13982. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13983. /**
  13984. * Clones the current emitter and returns a copy of it
  13985. * @returns the new emitter
  13986. */
  13987. clone(): PointParticleEmitter;
  13988. /**
  13989. * Called by the GPUParticleSystem to setup the update shader
  13990. * @param effect defines the update shader
  13991. */
  13992. applyToShader(effect: Effect): void;
  13993. /**
  13994. * Returns a string to use to update the GPU particles update shader
  13995. * @returns a string containng the defines string
  13996. */
  13997. getEffectDefines(): string;
  13998. /**
  13999. * Returns the string "PointParticleEmitter"
  14000. * @returns a string containing the class name
  14001. */
  14002. getClassName(): string;
  14003. /**
  14004. * Serializes the particle system to a JSON object.
  14005. * @returns the JSON object
  14006. */
  14007. serialize(): any;
  14008. /**
  14009. * Parse properties from a JSON object
  14010. * @param serializationObject defines the JSON object
  14011. */
  14012. parse(serializationObject: any): void;
  14013. }
  14014. }
  14015. declare module "babylonjs/Particles/EmitterTypes/sphereParticleEmitter" {
  14016. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  14017. import { Effect } from "babylonjs/Materials/effect";
  14018. import { Particle } from "babylonjs/Particles/particle";
  14019. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  14020. /**
  14021. * Particle emitter emitting particles from the inside of a sphere.
  14022. * It emits the particles alongside the sphere radius. The emission direction might be randomized.
  14023. */
  14024. export class SphereParticleEmitter implements IParticleEmitterType {
  14025. /**
  14026. * The radius of the emission sphere.
  14027. */
  14028. radius: number;
  14029. /**
  14030. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  14031. */
  14032. radiusRange: number;
  14033. /**
  14034. * How much to randomize the particle direction [0-1].
  14035. */
  14036. directionRandomizer: number;
  14037. /**
  14038. * Creates a new instance SphereParticleEmitter
  14039. * @param radius the radius of the emission sphere (1 by default)
  14040. * @param radiusRange the range of the emission sphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  14041. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  14042. */
  14043. constructor(
  14044. /**
  14045. * The radius of the emission sphere.
  14046. */
  14047. radius?: number,
  14048. /**
  14049. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  14050. */
  14051. radiusRange?: number,
  14052. /**
  14053. * How much to randomize the particle direction [0-1].
  14054. */
  14055. directionRandomizer?: number);
  14056. /**
  14057. * Called by the particle System when the direction is computed for the created particle.
  14058. * @param worldMatrix is the world matrix of the particle system
  14059. * @param directionToUpdate is the direction vector to update with the result
  14060. * @param particle is the particle we are computed the direction for
  14061. * @param isLocal defines if the direction should be set in local space
  14062. */
  14063. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14064. /**
  14065. * Called by the particle System when the position is computed for the created particle.
  14066. * @param worldMatrix is the world matrix of the particle system
  14067. * @param positionToUpdate is the position vector to update with the result
  14068. * @param particle is the particle we are computed the position for
  14069. * @param isLocal defines if the position should be set in local space
  14070. */
  14071. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14072. /**
  14073. * Clones the current emitter and returns a copy of it
  14074. * @returns the new emitter
  14075. */
  14076. clone(): SphereParticleEmitter;
  14077. /**
  14078. * Called by the GPUParticleSystem to setup the update shader
  14079. * @param effect defines the update shader
  14080. */
  14081. applyToShader(effect: Effect): void;
  14082. /**
  14083. * Returns a string to use to update the GPU particles update shader
  14084. * @returns a string containng the defines string
  14085. */
  14086. getEffectDefines(): string;
  14087. /**
  14088. * Returns the string "SphereParticleEmitter"
  14089. * @returns a string containing the class name
  14090. */
  14091. getClassName(): string;
  14092. /**
  14093. * Serializes the particle system to a JSON object.
  14094. * @returns the JSON object
  14095. */
  14096. serialize(): any;
  14097. /**
  14098. * Parse properties from a JSON object
  14099. * @param serializationObject defines the JSON object
  14100. */
  14101. parse(serializationObject: any): void;
  14102. }
  14103. /**
  14104. * Particle emitter emitting particles from the inside of a sphere.
  14105. * It emits the particles randomly between two vectors.
  14106. */
  14107. export class SphereDirectedParticleEmitter extends SphereParticleEmitter {
  14108. /**
  14109. * The min limit of the emission direction.
  14110. */
  14111. direction1: Vector3;
  14112. /**
  14113. * The max limit of the emission direction.
  14114. */
  14115. direction2: Vector3;
  14116. /**
  14117. * Creates a new instance SphereDirectedParticleEmitter
  14118. * @param radius the radius of the emission sphere (1 by default)
  14119. * @param direction1 the min limit of the emission direction (up vector by default)
  14120. * @param direction2 the max limit of the emission direction (up vector by default)
  14121. */
  14122. constructor(radius?: number,
  14123. /**
  14124. * The min limit of the emission direction.
  14125. */
  14126. direction1?: Vector3,
  14127. /**
  14128. * The max limit of the emission direction.
  14129. */
  14130. direction2?: Vector3);
  14131. /**
  14132. * Called by the particle System when the direction is computed for the created particle.
  14133. * @param worldMatrix is the world matrix of the particle system
  14134. * @param directionToUpdate is the direction vector to update with the result
  14135. * @param particle is the particle we are computed the direction for
  14136. */
  14137. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  14138. /**
  14139. * Clones the current emitter and returns a copy of it
  14140. * @returns the new emitter
  14141. */
  14142. clone(): SphereDirectedParticleEmitter;
  14143. /**
  14144. * Called by the GPUParticleSystem to setup the update shader
  14145. * @param effect defines the update shader
  14146. */
  14147. applyToShader(effect: Effect): void;
  14148. /**
  14149. * Returns a string to use to update the GPU particles update shader
  14150. * @returns a string containng the defines string
  14151. */
  14152. getEffectDefines(): string;
  14153. /**
  14154. * Returns the string "SphereDirectedParticleEmitter"
  14155. * @returns a string containing the class name
  14156. */
  14157. getClassName(): string;
  14158. /**
  14159. * Serializes the particle system to a JSON object.
  14160. * @returns the JSON object
  14161. */
  14162. serialize(): any;
  14163. /**
  14164. * Parse properties from a JSON object
  14165. * @param serializationObject defines the JSON object
  14166. */
  14167. parse(serializationObject: any): void;
  14168. }
  14169. }
  14170. declare module "babylonjs/Particles/EmitterTypes/customParticleEmitter" {
  14171. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  14172. import { Effect } from "babylonjs/Materials/effect";
  14173. import { Particle } from "babylonjs/Particles/particle";
  14174. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  14175. import { Nullable } from "babylonjs/types";
  14176. /**
  14177. * Particle emitter emitting particles from a custom list of positions.
  14178. */
  14179. export class CustomParticleEmitter implements IParticleEmitterType {
  14180. /**
  14181. * Gets or sets the position generator that will create the inital position of each particle.
  14182. * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  14183. */
  14184. particlePositionGenerator: (index: number, particle: Nullable<Particle>, outPosition: Vector3) => void;
  14185. /**
  14186. * Gets or sets the destination generator that will create the final destination of each particle.
  14187. * * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  14188. */
  14189. particleDestinationGenerator: (index: number, particle: Nullable<Particle>, outDestination: Vector3) => void;
  14190. /**
  14191. * Creates a new instance CustomParticleEmitter
  14192. */
  14193. constructor();
  14194. /**
  14195. * Called by the particle System when the direction is computed for the created particle.
  14196. * @param worldMatrix is the world matrix of the particle system
  14197. * @param directionToUpdate is the direction vector to update with the result
  14198. * @param particle is the particle we are computed the direction for
  14199. * @param isLocal defines if the direction should be set in local space
  14200. */
  14201. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14202. /**
  14203. * Called by the particle System when the position is computed for the created particle.
  14204. * @param worldMatrix is the world matrix of the particle system
  14205. * @param positionToUpdate is the position vector to update with the result
  14206. * @param particle is the particle we are computed the position for
  14207. * @param isLocal defines if the position should be set in local space
  14208. */
  14209. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14210. /**
  14211. * Clones the current emitter and returns a copy of it
  14212. * @returns the new emitter
  14213. */
  14214. clone(): CustomParticleEmitter;
  14215. /**
  14216. * Called by the GPUParticleSystem to setup the update shader
  14217. * @param effect defines the update shader
  14218. */
  14219. applyToShader(effect: Effect): void;
  14220. /**
  14221. * Returns a string to use to update the GPU particles update shader
  14222. * @returns a string containng the defines string
  14223. */
  14224. getEffectDefines(): string;
  14225. /**
  14226. * Returns the string "PointParticleEmitter"
  14227. * @returns a string containing the class name
  14228. */
  14229. getClassName(): string;
  14230. /**
  14231. * Serializes the particle system to a JSON object.
  14232. * @returns the JSON object
  14233. */
  14234. serialize(): any;
  14235. /**
  14236. * Parse properties from a JSON object
  14237. * @param serializationObject defines the JSON object
  14238. */
  14239. parse(serializationObject: any): void;
  14240. }
  14241. }
  14242. declare module "babylonjs/Particles/EmitterTypes/meshParticleEmitter" {
  14243. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  14244. import { Effect } from "babylonjs/Materials/effect";
  14245. import { Particle } from "babylonjs/Particles/particle";
  14246. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  14247. import { Nullable } from "babylonjs/types";
  14248. import { Scene } from "babylonjs/scene";
  14249. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  14250. /**
  14251. * Particle emitter emitting particles from the inside of a box.
  14252. * It emits the particles randomly between 2 given directions.
  14253. */
  14254. export class MeshParticleEmitter implements IParticleEmitterType {
  14255. private _indices;
  14256. private _positions;
  14257. private _normals;
  14258. private _storedNormal;
  14259. private _mesh;
  14260. /**
  14261. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  14262. */
  14263. direction1: Vector3;
  14264. /**
  14265. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  14266. */
  14267. direction2: Vector3;
  14268. /**
  14269. * Gets or sets a boolean indicating that particle directions must be built from mesh face normals
  14270. */
  14271. useMeshNormalsForDirection: boolean;
  14272. /** Defines the mesh to use as source */
  14273. get mesh(): Nullable<AbstractMesh>;
  14274. set mesh(value: Nullable<AbstractMesh>);
  14275. /**
  14276. * Creates a new instance MeshParticleEmitter
  14277. * @param mesh defines the mesh to use as source
  14278. */
  14279. constructor(mesh?: Nullable<AbstractMesh>);
  14280. /**
  14281. * Called by the particle System when the direction is computed for the created particle.
  14282. * @param worldMatrix is the world matrix of the particle system
  14283. * @param directionToUpdate is the direction vector to update with the result
  14284. * @param particle is the particle we are computed the direction for
  14285. * @param isLocal defines if the direction should be set in local space
  14286. */
  14287. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14288. /**
  14289. * Called by the particle System when the position is computed for the created particle.
  14290. * @param worldMatrix is the world matrix of the particle system
  14291. * @param positionToUpdate is the position vector to update with the result
  14292. * @param particle is the particle we are computed the position for
  14293. * @param isLocal defines if the position should be set in local space
  14294. */
  14295. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14296. /**
  14297. * Clones the current emitter and returns a copy of it
  14298. * @returns the new emitter
  14299. */
  14300. clone(): MeshParticleEmitter;
  14301. /**
  14302. * Called by the GPUParticleSystem to setup the update shader
  14303. * @param effect defines the update shader
  14304. */
  14305. applyToShader(effect: Effect): void;
  14306. /**
  14307. * Returns a string to use to update the GPU particles update shader
  14308. * @returns a string containng the defines string
  14309. */
  14310. getEffectDefines(): string;
  14311. /**
  14312. * Returns the string "BoxParticleEmitter"
  14313. * @returns a string containing the class name
  14314. */
  14315. getClassName(): string;
  14316. /**
  14317. * Serializes the particle system to a JSON object.
  14318. * @returns the JSON object
  14319. */
  14320. serialize(): any;
  14321. /**
  14322. * Parse properties from a JSON object
  14323. * @param serializationObject defines the JSON object
  14324. * @param scene defines the hosting scene
  14325. */
  14326. parse(serializationObject: any, scene: Nullable<Scene>): void;
  14327. }
  14328. }
  14329. declare module "babylonjs/Particles/EmitterTypes/index" {
  14330. export * from "babylonjs/Particles/EmitterTypes/boxParticleEmitter";
  14331. export * from "babylonjs/Particles/EmitterTypes/coneParticleEmitter";
  14332. export * from "babylonjs/Particles/EmitterTypes/cylinderParticleEmitter";
  14333. export * from "babylonjs/Particles/EmitterTypes/hemisphericParticleEmitter";
  14334. export * from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  14335. export * from "babylonjs/Particles/EmitterTypes/pointParticleEmitter";
  14336. export * from "babylonjs/Particles/EmitterTypes/sphereParticleEmitter";
  14337. export * from "babylonjs/Particles/EmitterTypes/customParticleEmitter";
  14338. export * from "babylonjs/Particles/EmitterTypes/meshParticleEmitter";
  14339. }
  14340. declare module "babylonjs/Particles/IParticleSystem" {
  14341. import { Nullable } from "babylonjs/types";
  14342. import { Vector2, Vector3, Matrix } from "babylonjs/Maths/math.vector";
  14343. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  14344. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  14345. import { BoxParticleEmitter, IParticleEmitterType, PointParticleEmitter, HemisphericParticleEmitter, SphereParticleEmitter, SphereDirectedParticleEmitter, CylinderParticleEmitter, ConeParticleEmitter } from "babylonjs/Particles/EmitterTypes/index";
  14346. import { Scene } from "babylonjs/scene";
  14347. import { ColorGradient, FactorGradient, Color3Gradient } from "babylonjs/Misc/gradients";
  14348. import { Effect } from "babylonjs/Materials/effect";
  14349. import { Observable } from "babylonjs/Misc/observable";
  14350. import { Animation } from "babylonjs/Animations/animation";
  14351. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  14352. /**
  14353. * Interface representing a particle system in Babylon.js.
  14354. * This groups the common functionalities that needs to be implemented in order to create a particle system.
  14355. * A particle system represents a way to manage particles from their emission to their animation and rendering.
  14356. */
  14357. export interface IParticleSystem {
  14358. /**
  14359. * List of animations used by the particle system.
  14360. */
  14361. animations: Animation[];
  14362. /**
  14363. * The id of the Particle system.
  14364. */
  14365. id: string;
  14366. /**
  14367. * The name of the Particle system.
  14368. */
  14369. name: string;
  14370. /**
  14371. * The emitter represents the Mesh or position we are attaching the particle system to.
  14372. */
  14373. emitter: Nullable<AbstractMesh | Vector3>;
  14374. /**
  14375. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  14376. */
  14377. isBillboardBased: boolean;
  14378. /**
  14379. * The rendering group used by the Particle system to chose when to render.
  14380. */
  14381. renderingGroupId: number;
  14382. /**
  14383. * The layer mask we are rendering the particles through.
  14384. */
  14385. layerMask: number;
  14386. /**
  14387. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  14388. */
  14389. updateSpeed: number;
  14390. /**
  14391. * The amount of time the particle system is running (depends of the overall update speed).
  14392. */
  14393. targetStopDuration: number;
  14394. /**
  14395. * The texture used to render each particle. (this can be a spritesheet)
  14396. */
  14397. particleTexture: Nullable<BaseTexture>;
  14398. /**
  14399. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE, ParticleSystem.BLENDMODE_STANDARD or ParticleSystem.BLENDMODE_ADD.
  14400. */
  14401. blendMode: number;
  14402. /**
  14403. * Minimum life time of emitting particles.
  14404. */
  14405. minLifeTime: number;
  14406. /**
  14407. * Maximum life time of emitting particles.
  14408. */
  14409. maxLifeTime: number;
  14410. /**
  14411. * Minimum Size of emitting particles.
  14412. */
  14413. minSize: number;
  14414. /**
  14415. * Maximum Size of emitting particles.
  14416. */
  14417. maxSize: number;
  14418. /**
  14419. * Minimum scale of emitting particles on X axis.
  14420. */
  14421. minScaleX: number;
  14422. /**
  14423. * Maximum scale of emitting particles on X axis.
  14424. */
  14425. maxScaleX: number;
  14426. /**
  14427. * Minimum scale of emitting particles on Y axis.
  14428. */
  14429. minScaleY: number;
  14430. /**
  14431. * Maximum scale of emitting particles on Y axis.
  14432. */
  14433. maxScaleY: number;
  14434. /**
  14435. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  14436. */
  14437. color1: Color4;
  14438. /**
  14439. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  14440. */
  14441. color2: Color4;
  14442. /**
  14443. * Color the particle will have at the end of its lifetime.
  14444. */
  14445. colorDead: Color4;
  14446. /**
  14447. * The maximum number of particles to emit per frame until we reach the activeParticleCount value
  14448. */
  14449. emitRate: number;
  14450. /**
  14451. * You can use gravity if you want to give an orientation to your particles.
  14452. */
  14453. gravity: Vector3;
  14454. /**
  14455. * Minimum power of emitting particles.
  14456. */
  14457. minEmitPower: number;
  14458. /**
  14459. * Maximum power of emitting particles.
  14460. */
  14461. maxEmitPower: number;
  14462. /**
  14463. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  14464. */
  14465. minAngularSpeed: number;
  14466. /**
  14467. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  14468. */
  14469. maxAngularSpeed: number;
  14470. /**
  14471. * Gets or sets the minimal initial rotation in radians.
  14472. */
  14473. minInitialRotation: number;
  14474. /**
  14475. * Gets or sets the maximal initial rotation in radians.
  14476. */
  14477. maxInitialRotation: number;
  14478. /**
  14479. * The particle emitter type defines the emitter used by the particle system.
  14480. * It can be for example box, sphere, or cone...
  14481. */
  14482. particleEmitterType: Nullable<IParticleEmitterType>;
  14483. /**
  14484. * Defines the delay in milliseconds before starting the system (0 by default)
  14485. */
  14486. startDelay: number;
  14487. /**
  14488. * Gets or sets a value indicating how many cycles (or frames) must be executed before first rendering (this value has to be set before starting the system). Default is 0
  14489. */
  14490. preWarmCycles: number;
  14491. /**
  14492. * Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1)
  14493. */
  14494. preWarmStepOffset: number;
  14495. /**
  14496. * If using a spritesheet (isAnimationSheetEnabled) defines the speed of the sprite loop (default is 1 meaning the animation will play once during the entire particle lifetime)
  14497. */
  14498. spriteCellChangeSpeed: number;
  14499. /**
  14500. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  14501. */
  14502. startSpriteCellID: number;
  14503. /**
  14504. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  14505. */
  14506. endSpriteCellID: number;
  14507. /**
  14508. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  14509. */
  14510. spriteCellWidth: number;
  14511. /**
  14512. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  14513. */
  14514. spriteCellHeight: number;
  14515. /**
  14516. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  14517. */
  14518. spriteRandomStartCell: boolean;
  14519. /**
  14520. * Gets or sets a boolean indicating if a spritesheet is used to animate the particles texture
  14521. */
  14522. isAnimationSheetEnabled: boolean;
  14523. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  14524. translationPivot: Vector2;
  14525. /**
  14526. * Gets or sets a texture used to add random noise to particle positions
  14527. */
  14528. noiseTexture: Nullable<BaseTexture>;
  14529. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  14530. noiseStrength: Vector3;
  14531. /**
  14532. * Gets or sets the billboard mode to use when isBillboardBased = true.
  14533. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  14534. */
  14535. billboardMode: number;
  14536. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  14537. limitVelocityDamping: number;
  14538. /**
  14539. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  14540. */
  14541. beginAnimationOnStart: boolean;
  14542. /**
  14543. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  14544. */
  14545. beginAnimationFrom: number;
  14546. /**
  14547. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  14548. */
  14549. beginAnimationTo: number;
  14550. /**
  14551. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  14552. */
  14553. beginAnimationLoop: boolean;
  14554. /**
  14555. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  14556. */
  14557. disposeOnStop: boolean;
  14558. /**
  14559. * Specifies if the particles are updated in emitter local space or world space
  14560. */
  14561. isLocal: boolean;
  14562. /** Snippet ID if the particle system was created from the snippet server */
  14563. snippetId: string;
  14564. /** Gets or sets a matrix to use to compute projection */
  14565. defaultProjectionMatrix: Matrix;
  14566. /**
  14567. * Gets the maximum number of particles active at the same time.
  14568. * @returns The max number of active particles.
  14569. */
  14570. getCapacity(): number;
  14571. /**
  14572. * Gets the number of particles active at the same time.
  14573. * @returns The number of active particles.
  14574. */
  14575. getActiveCount(): number;
  14576. /**
  14577. * Gets if the system has been started. (Note: this will still be true after stop is called)
  14578. * @returns True if it has been started, otherwise false.
  14579. */
  14580. isStarted(): boolean;
  14581. /**
  14582. * Animates the particle system for this frame.
  14583. */
  14584. animate(): void;
  14585. /**
  14586. * Renders the particle system in its current state.
  14587. * @returns the current number of particles
  14588. */
  14589. render(): number;
  14590. /**
  14591. * Dispose the particle system and frees its associated resources.
  14592. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  14593. */
  14594. dispose(disposeTexture?: boolean): void;
  14595. /**
  14596. * An event triggered when the system is disposed
  14597. */
  14598. onDisposeObservable: Observable<IParticleSystem>;
  14599. /**
  14600. * Clones the particle system.
  14601. * @param name The name of the cloned object
  14602. * @param newEmitter The new emitter to use
  14603. * @returns the cloned particle system
  14604. */
  14605. clone(name: string, newEmitter: any): Nullable<IParticleSystem>;
  14606. /**
  14607. * Serializes the particle system to a JSON object
  14608. * @param serializeTexture defines if the texture must be serialized as well
  14609. * @returns the JSON object
  14610. */
  14611. serialize(serializeTexture: boolean): any;
  14612. /**
  14613. * Rebuild the particle system
  14614. */
  14615. rebuild(): void;
  14616. /** Force the system to rebuild all gradients that need to be resync */
  14617. forceRefreshGradients(): void;
  14618. /**
  14619. * Starts the particle system and begins to emit
  14620. * @param delay defines the delay in milliseconds before starting the system (0 by default)
  14621. */
  14622. start(delay?: number): void;
  14623. /**
  14624. * Stops the particle system.
  14625. */
  14626. stop(): void;
  14627. /**
  14628. * Remove all active particles
  14629. */
  14630. reset(): void;
  14631. /**
  14632. * Gets a boolean indicating that the system is stopping
  14633. * @returns true if the system is currently stopping
  14634. */
  14635. isStopping(): boolean;
  14636. /**
  14637. * Is this system ready to be used/rendered
  14638. * @return true if the system is ready
  14639. */
  14640. isReady(): boolean;
  14641. /**
  14642. * Returns the string "ParticleSystem"
  14643. * @returns a string containing the class name
  14644. */
  14645. getClassName(): string;
  14646. /**
  14647. * Gets the custom effect used to render the particles
  14648. * @param blendMode Blend mode for which the effect should be retrieved
  14649. * @returns The effect
  14650. */
  14651. getCustomEffect(blendMode: number): Nullable<Effect>;
  14652. /**
  14653. * Sets the custom effect used to render the particles
  14654. * @param effect The effect to set
  14655. * @param blendMode Blend mode for which the effect should be set
  14656. */
  14657. setCustomEffect(effect: Nullable<Effect>, blendMode: number): void;
  14658. /**
  14659. * Fill the defines array according to the current settings of the particle system
  14660. * @param defines Array to be updated
  14661. * @param blendMode blend mode to take into account when updating the array
  14662. */
  14663. fillDefines(defines: Array<string>, blendMode: number): void;
  14664. /**
  14665. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  14666. * @param uniforms Uniforms array to fill
  14667. * @param attributes Attributes array to fill
  14668. * @param samplers Samplers array to fill
  14669. */
  14670. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  14671. /**
  14672. * Observable that will be called just before the particles are drawn
  14673. */
  14674. onBeforeDrawParticlesObservable: Observable<Nullable<Effect>>;
  14675. /**
  14676. * Gets the name of the particle vertex shader
  14677. */
  14678. vertexShaderName: string;
  14679. /**
  14680. * Adds a new color gradient
  14681. * @param gradient defines the gradient to use (between 0 and 1)
  14682. * @param color1 defines the color to affect to the specified gradient
  14683. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  14684. * @returns the current particle system
  14685. */
  14686. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  14687. /**
  14688. * Remove a specific color gradient
  14689. * @param gradient defines the gradient to remove
  14690. * @returns the current particle system
  14691. */
  14692. removeColorGradient(gradient: number): IParticleSystem;
  14693. /**
  14694. * Adds a new size gradient
  14695. * @param gradient defines the gradient to use (between 0 and 1)
  14696. * @param factor defines the size factor to affect to the specified gradient
  14697. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14698. * @returns the current particle system
  14699. */
  14700. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14701. /**
  14702. * Remove a specific size gradient
  14703. * @param gradient defines the gradient to remove
  14704. * @returns the current particle system
  14705. */
  14706. removeSizeGradient(gradient: number): IParticleSystem;
  14707. /**
  14708. * Gets the current list of color gradients.
  14709. * You must use addColorGradient and removeColorGradient to udpate this list
  14710. * @returns the list of color gradients
  14711. */
  14712. getColorGradients(): Nullable<Array<ColorGradient>>;
  14713. /**
  14714. * Gets the current list of size gradients.
  14715. * You must use addSizeGradient and removeSizeGradient to udpate this list
  14716. * @returns the list of size gradients
  14717. */
  14718. getSizeGradients(): Nullable<Array<FactorGradient>>;
  14719. /**
  14720. * Gets the current list of angular speed gradients.
  14721. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  14722. * @returns the list of angular speed gradients
  14723. */
  14724. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  14725. /**
  14726. * Adds a new angular speed gradient
  14727. * @param gradient defines the gradient to use (between 0 and 1)
  14728. * @param factor defines the angular speed to affect to the specified gradient
  14729. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14730. * @returns the current particle system
  14731. */
  14732. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14733. /**
  14734. * Remove a specific angular speed gradient
  14735. * @param gradient defines the gradient to remove
  14736. * @returns the current particle system
  14737. */
  14738. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  14739. /**
  14740. * Gets the current list of velocity gradients.
  14741. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  14742. * @returns the list of velocity gradients
  14743. */
  14744. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  14745. /**
  14746. * Adds a new velocity gradient
  14747. * @param gradient defines the gradient to use (between 0 and 1)
  14748. * @param factor defines the velocity to affect to the specified gradient
  14749. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14750. * @returns the current particle system
  14751. */
  14752. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14753. /**
  14754. * Remove a specific velocity gradient
  14755. * @param gradient defines the gradient to remove
  14756. * @returns the current particle system
  14757. */
  14758. removeVelocityGradient(gradient: number): IParticleSystem;
  14759. /**
  14760. * Gets the current list of limit velocity gradients.
  14761. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  14762. * @returns the list of limit velocity gradients
  14763. */
  14764. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  14765. /**
  14766. * Adds a new limit velocity gradient
  14767. * @param gradient defines the gradient to use (between 0 and 1)
  14768. * @param factor defines the limit velocity to affect to the specified gradient
  14769. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14770. * @returns the current particle system
  14771. */
  14772. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14773. /**
  14774. * Remove a specific limit velocity gradient
  14775. * @param gradient defines the gradient to remove
  14776. * @returns the current particle system
  14777. */
  14778. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  14779. /**
  14780. * Adds a new drag gradient
  14781. * @param gradient defines the gradient to use (between 0 and 1)
  14782. * @param factor defines the drag to affect to the specified gradient
  14783. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14784. * @returns the current particle system
  14785. */
  14786. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14787. /**
  14788. * Remove a specific drag gradient
  14789. * @param gradient defines the gradient to remove
  14790. * @returns the current particle system
  14791. */
  14792. removeDragGradient(gradient: number): IParticleSystem;
  14793. /**
  14794. * Gets the current list of drag gradients.
  14795. * You must use addDragGradient and removeDragGradient to udpate this list
  14796. * @returns the list of drag gradients
  14797. */
  14798. getDragGradients(): Nullable<Array<FactorGradient>>;
  14799. /**
  14800. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  14801. * @param gradient defines the gradient to use (between 0 and 1)
  14802. * @param factor defines the emit rate to affect to the specified gradient
  14803. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14804. * @returns the current particle system
  14805. */
  14806. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14807. /**
  14808. * Remove a specific emit rate gradient
  14809. * @param gradient defines the gradient to remove
  14810. * @returns the current particle system
  14811. */
  14812. removeEmitRateGradient(gradient: number): IParticleSystem;
  14813. /**
  14814. * Gets the current list of emit rate gradients.
  14815. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  14816. * @returns the list of emit rate gradients
  14817. */
  14818. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  14819. /**
  14820. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  14821. * @param gradient defines the gradient to use (between 0 and 1)
  14822. * @param factor defines the start size to affect to the specified gradient
  14823. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14824. * @returns the current particle system
  14825. */
  14826. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14827. /**
  14828. * Remove a specific start size gradient
  14829. * @param gradient defines the gradient to remove
  14830. * @returns the current particle system
  14831. */
  14832. removeStartSizeGradient(gradient: number): IParticleSystem;
  14833. /**
  14834. * Gets the current list of start size gradients.
  14835. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  14836. * @returns the list of start size gradients
  14837. */
  14838. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  14839. /**
  14840. * Adds a new life time gradient
  14841. * @param gradient defines the gradient to use (between 0 and 1)
  14842. * @param factor defines the life time factor to affect to the specified gradient
  14843. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14844. * @returns the current particle system
  14845. */
  14846. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14847. /**
  14848. * Remove a specific life time gradient
  14849. * @param gradient defines the gradient to remove
  14850. * @returns the current particle system
  14851. */
  14852. removeLifeTimeGradient(gradient: number): IParticleSystem;
  14853. /**
  14854. * Gets the current list of life time gradients.
  14855. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  14856. * @returns the list of life time gradients
  14857. */
  14858. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  14859. /**
  14860. * Gets the current list of color gradients.
  14861. * You must use addColorGradient and removeColorGradient to udpate this list
  14862. * @returns the list of color gradients
  14863. */
  14864. getColorGradients(): Nullable<Array<ColorGradient>>;
  14865. /**
  14866. * Adds a new ramp gradient used to remap particle colors
  14867. * @param gradient defines the gradient to use (between 0 and 1)
  14868. * @param color defines the color to affect to the specified gradient
  14869. * @returns the current particle system
  14870. */
  14871. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  14872. /**
  14873. * Gets the current list of ramp gradients.
  14874. * You must use addRampGradient and removeRampGradient to udpate this list
  14875. * @returns the list of ramp gradients
  14876. */
  14877. getRampGradients(): Nullable<Array<Color3Gradient>>;
  14878. /** Gets or sets a boolean indicating that ramp gradients must be used
  14879. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  14880. */
  14881. useRampGradients: boolean;
  14882. /**
  14883. * Adds a new color remap gradient
  14884. * @param gradient defines the gradient to use (between 0 and 1)
  14885. * @param min defines the color remap minimal range
  14886. * @param max defines the color remap maximal range
  14887. * @returns the current particle system
  14888. */
  14889. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  14890. /**
  14891. * Gets the current list of color remap gradients.
  14892. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  14893. * @returns the list of color remap gradients
  14894. */
  14895. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  14896. /**
  14897. * Adds a new alpha remap gradient
  14898. * @param gradient defines the gradient to use (between 0 and 1)
  14899. * @param min defines the alpha remap minimal range
  14900. * @param max defines the alpha remap maximal range
  14901. * @returns the current particle system
  14902. */
  14903. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  14904. /**
  14905. * Gets the current list of alpha remap gradients.
  14906. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  14907. * @returns the list of alpha remap gradients
  14908. */
  14909. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  14910. /**
  14911. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  14912. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  14913. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  14914. * @returns the emitter
  14915. */
  14916. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  14917. /**
  14918. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  14919. * @param radius The radius of the hemisphere to emit from
  14920. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  14921. * @returns the emitter
  14922. */
  14923. createHemisphericEmitter(radius: number, radiusRange: number): HemisphericParticleEmitter;
  14924. /**
  14925. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  14926. * @param radius The radius of the sphere to emit from
  14927. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  14928. * @returns the emitter
  14929. */
  14930. createSphereEmitter(radius: number, radiusRange: number): SphereParticleEmitter;
  14931. /**
  14932. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  14933. * @param radius The radius of the sphere to emit from
  14934. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  14935. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  14936. * @returns the emitter
  14937. */
  14938. createDirectedSphereEmitter(radius: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  14939. /**
  14940. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  14941. * @param radius The radius of the emission cylinder
  14942. * @param height The height of the emission cylinder
  14943. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  14944. * @param directionRandomizer How much to randomize the particle direction [0-1]
  14945. * @returns the emitter
  14946. */
  14947. createCylinderEmitter(radius: number, height: number, radiusRange: number, directionRandomizer: number): CylinderParticleEmitter;
  14948. /**
  14949. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  14950. * @param radius The radius of the cylinder to emit from
  14951. * @param height The height of the emission cylinder
  14952. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  14953. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  14954. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  14955. * @returns the emitter
  14956. */
  14957. createDirectedCylinderEmitter(radius: number, height: number, radiusRange: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  14958. /**
  14959. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  14960. * @param radius The radius of the cone to emit from
  14961. * @param angle The base angle of the cone
  14962. * @returns the emitter
  14963. */
  14964. createConeEmitter(radius: number, angle: number): ConeParticleEmitter;
  14965. /**
  14966. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  14967. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  14968. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  14969. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  14970. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  14971. * @returns the emitter
  14972. */
  14973. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  14974. /**
  14975. * Get hosting scene
  14976. * @returns the scene
  14977. */
  14978. getScene(): Nullable<Scene>;
  14979. }
  14980. }
  14981. declare module "babylonjs/Meshes/transformNode" {
  14982. import { DeepImmutable } from "babylonjs/types";
  14983. import { Observable } from "babylonjs/Misc/observable";
  14984. import { Nullable } from "babylonjs/types";
  14985. import { Camera } from "babylonjs/Cameras/camera";
  14986. import { Scene } from "babylonjs/scene";
  14987. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  14988. import { Node } from "babylonjs/node";
  14989. import { Bone } from "babylonjs/Bones/bone";
  14990. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  14991. import { Space } from "babylonjs/Maths/math.axis";
  14992. /**
  14993. * A TransformNode is an object that is not rendered but can be used as a center of transformation. This can decrease memory usage and increase rendering speed compared to using an empty mesh as a parent and is less complicated than using a pivot matrix.
  14994. * @see https://doc.babylonjs.com/how_to/transformnode
  14995. */
  14996. export class TransformNode extends Node {
  14997. /**
  14998. * Object will not rotate to face the camera
  14999. */
  15000. static BILLBOARDMODE_NONE: number;
  15001. /**
  15002. * Object will rotate to face the camera but only on the x axis
  15003. */
  15004. static BILLBOARDMODE_X: number;
  15005. /**
  15006. * Object will rotate to face the camera but only on the y axis
  15007. */
  15008. static BILLBOARDMODE_Y: number;
  15009. /**
  15010. * Object will rotate to face the camera but only on the z axis
  15011. */
  15012. static BILLBOARDMODE_Z: number;
  15013. /**
  15014. * Object will rotate to face the camera
  15015. */
  15016. static BILLBOARDMODE_ALL: number;
  15017. /**
  15018. * Object will rotate to face the camera's position instead of orientation
  15019. */
  15020. static BILLBOARDMODE_USE_POSITION: number;
  15021. private static _TmpRotation;
  15022. private static _TmpScaling;
  15023. private static _TmpTranslation;
  15024. private _forward;
  15025. private _forwardInverted;
  15026. private _up;
  15027. private _right;
  15028. private _rightInverted;
  15029. private _position;
  15030. private _rotation;
  15031. private _rotationQuaternion;
  15032. protected _scaling: Vector3;
  15033. protected _isDirty: boolean;
  15034. private _transformToBoneReferal;
  15035. private _isAbsoluteSynced;
  15036. private _billboardMode;
  15037. /**
  15038. * Gets or sets the billboard mode. Default is 0.
  15039. *
  15040. * | Value | Type | Description |
  15041. * | --- | --- | --- |
  15042. * | 0 | BILLBOARDMODE_NONE | |
  15043. * | 1 | BILLBOARDMODE_X | |
  15044. * | 2 | BILLBOARDMODE_Y | |
  15045. * | 4 | BILLBOARDMODE_Z | |
  15046. * | 7 | BILLBOARDMODE_ALL | |
  15047. *
  15048. */
  15049. get billboardMode(): number;
  15050. set billboardMode(value: number);
  15051. private _preserveParentRotationForBillboard;
  15052. /**
  15053. * Gets or sets a boolean indicating that parent rotation should be preserved when using billboards.
  15054. * This could be useful for glTF objects where parent rotation helps converting from right handed to left handed
  15055. */
  15056. get preserveParentRotationForBillboard(): boolean;
  15057. set preserveParentRotationForBillboard(value: boolean);
  15058. /**
  15059. * Multiplication factor on scale x/y/z when computing the world matrix. Eg. for a 1x1x1 cube setting this to 2 will make it a 2x2x2 cube
  15060. */
  15061. scalingDeterminant: number;
  15062. private _infiniteDistance;
  15063. /**
  15064. * Gets or sets the distance of the object to max, often used by skybox
  15065. */
  15066. get infiniteDistance(): boolean;
  15067. set infiniteDistance(value: boolean);
  15068. /**
  15069. * Gets or sets a boolean indicating that non uniform scaling (when at least one component is different from others) should be ignored.
  15070. * By default the system will update normals to compensate
  15071. */
  15072. ignoreNonUniformScaling: boolean;
  15073. /**
  15074. * Gets or sets a boolean indicating that even if rotationQuaternion is defined, you can keep updating rotation property and Babylon.js will just mix both
  15075. */
  15076. reIntegrateRotationIntoRotationQuaternion: boolean;
  15077. /** @hidden */
  15078. _poseMatrix: Nullable<Matrix>;
  15079. /** @hidden */
  15080. _localMatrix: Matrix;
  15081. private _usePivotMatrix;
  15082. private _absolutePosition;
  15083. private _absoluteScaling;
  15084. private _absoluteRotationQuaternion;
  15085. private _pivotMatrix;
  15086. private _pivotMatrixInverse;
  15087. /** @hidden */
  15088. _postMultiplyPivotMatrix: boolean;
  15089. protected _isWorldMatrixFrozen: boolean;
  15090. /** @hidden */
  15091. _indexInSceneTransformNodesArray: number;
  15092. /**
  15093. * An event triggered after the world matrix is updated
  15094. */
  15095. onAfterWorldMatrixUpdateObservable: Observable<TransformNode>;
  15096. constructor(name: string, scene?: Nullable<Scene>, isPure?: boolean);
  15097. /**
  15098. * Gets a string identifying the name of the class
  15099. * @returns "TransformNode" string
  15100. */
  15101. getClassName(): string;
  15102. /**
  15103. * Gets or set the node position (default is (0.0, 0.0, 0.0))
  15104. */
  15105. get position(): Vector3;
  15106. set position(newPosition: Vector3);
  15107. /**
  15108. * Gets or sets the rotation property : a Vector3 defining the rotation value in radians around each local axis X, Y, Z (default is (0.0, 0.0, 0.0)).
  15109. * If rotation quaternion is set, this Vector3 will be ignored and copy from the quaternion
  15110. */
  15111. get rotation(): Vector3;
  15112. set rotation(newRotation: Vector3);
  15113. /**
  15114. * Gets or sets the scaling property : a Vector3 defining the node scaling along each local axis X, Y, Z (default is (0.0, 0.0, 0.0)).
  15115. */
  15116. get scaling(): Vector3;
  15117. set scaling(newScaling: Vector3);
  15118. /**
  15119. * Gets or sets the rotation Quaternion property : this a Quaternion object defining the node rotation by using a unit quaternion (undefined by default, but can be null).
  15120. * If set, only the rotationQuaternion is then used to compute the node rotation (ie. node.rotation will be ignored)
  15121. */
  15122. get rotationQuaternion(): Nullable<Quaternion>;
  15123. set rotationQuaternion(quaternion: Nullable<Quaternion>);
  15124. /**
  15125. * The forward direction of that transform in world space.
  15126. */
  15127. get forward(): Vector3;
  15128. /**
  15129. * The up direction of that transform in world space.
  15130. */
  15131. get up(): Vector3;
  15132. /**
  15133. * The right direction of that transform in world space.
  15134. */
  15135. get right(): Vector3;
  15136. /**
  15137. * Copies the parameter passed Matrix into the mesh Pose matrix.
  15138. * @param matrix the matrix to copy the pose from
  15139. * @returns this TransformNode.
  15140. */
  15141. updatePoseMatrix(matrix: Matrix): TransformNode;
  15142. /**
  15143. * Returns the mesh Pose matrix.
  15144. * @returns the pose matrix
  15145. */
  15146. getPoseMatrix(): Matrix;
  15147. /** @hidden */
  15148. _isSynchronized(): boolean;
  15149. /** @hidden */
  15150. _initCache(): void;
  15151. /**
  15152. * Flag the transform node as dirty (Forcing it to update everything)
  15153. * @param property if set to "rotation" the objects rotationQuaternion will be set to null
  15154. * @returns this transform node
  15155. */
  15156. markAsDirty(property: string): TransformNode;
  15157. /**
  15158. * Returns the current mesh absolute position.
  15159. * Returns a Vector3.
  15160. */
  15161. get absolutePosition(): Vector3;
  15162. /**
  15163. * Returns the current mesh absolute scaling.
  15164. * Returns a Vector3.
  15165. */
  15166. get absoluteScaling(): Vector3;
  15167. /**
  15168. * Returns the current mesh absolute rotation.
  15169. * Returns a Quaternion.
  15170. */
  15171. get absoluteRotationQuaternion(): Quaternion;
  15172. /**
  15173. * Sets a new matrix to apply before all other transformation
  15174. * @param matrix defines the transform matrix
  15175. * @returns the current TransformNode
  15176. */
  15177. setPreTransformMatrix(matrix: Matrix): TransformNode;
  15178. /**
  15179. * Sets a new pivot matrix to the current node
  15180. * @param matrix defines the new pivot matrix to use
  15181. * @param postMultiplyPivotMatrix defines if the pivot matrix must be cancelled in the world matrix. When this parameter is set to true (default), the inverse of the pivot matrix is also applied at the end to cancel the transformation effect
  15182. * @returns the current TransformNode
  15183. */
  15184. setPivotMatrix(matrix: DeepImmutable<Matrix>, postMultiplyPivotMatrix?: boolean): TransformNode;
  15185. /**
  15186. * Returns the mesh pivot matrix.
  15187. * Default : Identity.
  15188. * @returns the matrix
  15189. */
  15190. getPivotMatrix(): Matrix;
  15191. /**
  15192. * Instantiate (when possible) or clone that node with its hierarchy
  15193. * @param newParent defines the new parent to use for the instance (or clone)
  15194. * @param options defines options to configure how copy is done
  15195. * @param onNewNodeCreated defines an option callback to call when a clone or an instance is created
  15196. * @returns an instance (or a clone) of the current node with its hiearchy
  15197. */
  15198. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  15199. doNotInstantiate: boolean;
  15200. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  15201. /**
  15202. * Prevents the World matrix to be computed any longer
  15203. * @param newWorldMatrix defines an optional matrix to use as world matrix
  15204. * @returns the TransformNode.
  15205. */
  15206. freezeWorldMatrix(newWorldMatrix?: Nullable<Matrix>): TransformNode;
  15207. /**
  15208. * Allows back the World matrix computation.
  15209. * @returns the TransformNode.
  15210. */
  15211. unfreezeWorldMatrix(): this;
  15212. /**
  15213. * True if the World matrix has been frozen.
  15214. */
  15215. get isWorldMatrixFrozen(): boolean;
  15216. /**
  15217. * Retuns the mesh absolute position in the World.
  15218. * @returns a Vector3.
  15219. */
  15220. getAbsolutePosition(): Vector3;
  15221. /**
  15222. * Sets the mesh absolute position in the World from a Vector3 or an Array(3).
  15223. * @param absolutePosition the absolute position to set
  15224. * @returns the TransformNode.
  15225. */
  15226. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  15227. /**
  15228. * Sets the mesh position in its local space.
  15229. * @param vector3 the position to set in localspace
  15230. * @returns the TransformNode.
  15231. */
  15232. setPositionWithLocalVector(vector3: Vector3): TransformNode;
  15233. /**
  15234. * Returns the mesh position in the local space from the current World matrix values.
  15235. * @returns a new Vector3.
  15236. */
  15237. getPositionExpressedInLocalSpace(): Vector3;
  15238. /**
  15239. * Translates the mesh along the passed Vector3 in its local space.
  15240. * @param vector3 the distance to translate in localspace
  15241. * @returns the TransformNode.
  15242. */
  15243. locallyTranslate(vector3: Vector3): TransformNode;
  15244. private static _lookAtVectorCache;
  15245. /**
  15246. * Orients a mesh towards a target point. Mesh must be drawn facing user.
  15247. * @param targetPoint the position (must be in same space as current mesh) to look at
  15248. * @param yawCor optional yaw (y-axis) correction in radians
  15249. * @param pitchCor optional pitch (x-axis) correction in radians
  15250. * @param rollCor optional roll (z-axis) correction in radians
  15251. * @param space the choosen space of the target
  15252. * @returns the TransformNode.
  15253. */
  15254. lookAt(targetPoint: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number, space?: Space): TransformNode;
  15255. /**
  15256. * Returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  15257. * This Vector3 is expressed in the World space.
  15258. * @param localAxis axis to rotate
  15259. * @returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  15260. */
  15261. getDirection(localAxis: Vector3): Vector3;
  15262. /**
  15263. * Sets the Vector3 "result" as the rotated Vector3 "localAxis" in the same rotation than the mesh.
  15264. * localAxis is expressed in the mesh local space.
  15265. * result is computed in the Wordl space from the mesh World matrix.
  15266. * @param localAxis axis to rotate
  15267. * @param result the resulting transformnode
  15268. * @returns this TransformNode.
  15269. */
  15270. getDirectionToRef(localAxis: Vector3, result: Vector3): TransformNode;
  15271. /**
  15272. * Sets this transform node rotation to the given local axis.
  15273. * @param localAxis the axis in local space
  15274. * @param yawCor optional yaw (y-axis) correction in radians
  15275. * @param pitchCor optional pitch (x-axis) correction in radians
  15276. * @param rollCor optional roll (z-axis) correction in radians
  15277. * @returns this TransformNode
  15278. */
  15279. setDirection(localAxis: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number): TransformNode;
  15280. /**
  15281. * Sets a new pivot point to the current node
  15282. * @param point defines the new pivot point to use
  15283. * @param space defines if the point is in world or local space (local by default)
  15284. * @returns the current TransformNode
  15285. */
  15286. setPivotPoint(point: Vector3, space?: Space): TransformNode;
  15287. /**
  15288. * Returns a new Vector3 set with the mesh pivot point coordinates in the local space.
  15289. * @returns the pivot point
  15290. */
  15291. getPivotPoint(): Vector3;
  15292. /**
  15293. * Sets the passed Vector3 "result" with the coordinates of the mesh pivot point in the local space.
  15294. * @param result the vector3 to store the result
  15295. * @returns this TransformNode.
  15296. */
  15297. getPivotPointToRef(result: Vector3): TransformNode;
  15298. /**
  15299. * Returns a new Vector3 set with the mesh pivot point World coordinates.
  15300. * @returns a new Vector3 set with the mesh pivot point World coordinates.
  15301. */
  15302. getAbsolutePivotPoint(): Vector3;
  15303. /**
  15304. * Sets the Vector3 "result" coordinates with the mesh pivot point World coordinates.
  15305. * @param result vector3 to store the result
  15306. * @returns this TransformNode.
  15307. */
  15308. getAbsolutePivotPointToRef(result: Vector3): TransformNode;
  15309. /**
  15310. * Defines the passed node as the parent of the current node.
  15311. * The node will remain exactly where it is and its position / rotation will be updated accordingly
  15312. * @see https://doc.babylonjs.com/how_to/parenting
  15313. * @param node the node ot set as the parent
  15314. * @returns this TransformNode.
  15315. */
  15316. setParent(node: Nullable<Node>): TransformNode;
  15317. private _nonUniformScaling;
  15318. /**
  15319. * True if the scaling property of this object is non uniform eg. (1,2,1)
  15320. */
  15321. get nonUniformScaling(): boolean;
  15322. /** @hidden */
  15323. _updateNonUniformScalingState(value: boolean): boolean;
  15324. /**
  15325. * Attach the current TransformNode to another TransformNode associated with a bone
  15326. * @param bone Bone affecting the TransformNode
  15327. * @param affectedTransformNode TransformNode associated with the bone
  15328. * @returns this object
  15329. */
  15330. attachToBone(bone: Bone, affectedTransformNode: TransformNode): TransformNode;
  15331. /**
  15332. * Detach the transform node if its associated with a bone
  15333. * @returns this object
  15334. */
  15335. detachFromBone(): TransformNode;
  15336. private static _rotationAxisCache;
  15337. /**
  15338. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in the given space.
  15339. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  15340. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  15341. * The passed axis is also normalized.
  15342. * @param axis the axis to rotate around
  15343. * @param amount the amount to rotate in radians
  15344. * @param space Space to rotate in (Default: local)
  15345. * @returns the TransformNode.
  15346. */
  15347. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  15348. /**
  15349. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in world space.
  15350. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  15351. * The passed axis is also normalized. .
  15352. * Method is based on http://www.euclideanspace.com/maths/geometry/affine/aroundPoint/index.htm
  15353. * @param point the point to rotate around
  15354. * @param axis the axis to rotate around
  15355. * @param amount the amount to rotate in radians
  15356. * @returns the TransformNode
  15357. */
  15358. rotateAround(point: Vector3, axis: Vector3, amount: number): TransformNode;
  15359. /**
  15360. * Translates the mesh along the axis vector for the passed distance in the given space.
  15361. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  15362. * @param axis the axis to translate in
  15363. * @param distance the distance to translate
  15364. * @param space Space to rotate in (Default: local)
  15365. * @returns the TransformNode.
  15366. */
  15367. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  15368. /**
  15369. * Adds a rotation step to the mesh current rotation.
  15370. * x, y, z are Euler angles expressed in radians.
  15371. * This methods updates the current mesh rotation, either mesh.rotation, either mesh.rotationQuaternion if it's set.
  15372. * This means this rotation is made in the mesh local space only.
  15373. * It's useful to set a custom rotation order different from the BJS standard one YXZ.
  15374. * Example : this rotates the mesh first around its local X axis, then around its local Z axis, finally around its local Y axis.
  15375. * ```javascript
  15376. * mesh.addRotation(x1, 0, 0).addRotation(0, 0, z2).addRotation(0, 0, y3);
  15377. * ```
  15378. * Note that `addRotation()` accumulates the passed rotation values to the current ones and computes the .rotation or .rotationQuaternion updated values.
  15379. * Under the hood, only quaternions are used. So it's a little faster is you use .rotationQuaternion because it doesn't need to translate them back to Euler angles.
  15380. * @param x Rotation to add
  15381. * @param y Rotation to add
  15382. * @param z Rotation to add
  15383. * @returns the TransformNode.
  15384. */
  15385. addRotation(x: number, y: number, z: number): TransformNode;
  15386. /**
  15387. * @hidden
  15388. */
  15389. protected _getEffectiveParent(): Nullable<Node>;
  15390. /**
  15391. * Computes the world matrix of the node
  15392. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  15393. * @returns the world matrix
  15394. */
  15395. computeWorldMatrix(force?: boolean): Matrix;
  15396. /**
  15397. * Resets this nodeTransform's local matrix to Matrix.Identity().
  15398. * @param independentOfChildren indicates if all child nodeTransform's world-space transform should be preserved.
  15399. */
  15400. resetLocalMatrix(independentOfChildren?: boolean): void;
  15401. protected _afterComputeWorldMatrix(): void;
  15402. /**
  15403. * If you'd like to be called back after the mesh position, rotation or scaling has been updated.
  15404. * @param func callback function to add
  15405. *
  15406. * @returns the TransformNode.
  15407. */
  15408. registerAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  15409. /**
  15410. * Removes a registered callback function.
  15411. * @param func callback function to remove
  15412. * @returns the TransformNode.
  15413. */
  15414. unregisterAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  15415. /**
  15416. * Gets the position of the current mesh in camera space
  15417. * @param camera defines the camera to use
  15418. * @returns a position
  15419. */
  15420. getPositionInCameraSpace(camera?: Nullable<Camera>): Vector3;
  15421. /**
  15422. * Returns the distance from the mesh to the active camera
  15423. * @param camera defines the camera to use
  15424. * @returns the distance
  15425. */
  15426. getDistanceToCamera(camera?: Nullable<Camera>): number;
  15427. /**
  15428. * Clone the current transform node
  15429. * @param name Name of the new clone
  15430. * @param newParent New parent for the clone
  15431. * @param doNotCloneChildren Do not clone children hierarchy
  15432. * @returns the new transform node
  15433. */
  15434. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<TransformNode>;
  15435. /**
  15436. * Serializes the objects information.
  15437. * @param currentSerializationObject defines the object to serialize in
  15438. * @returns the serialized object
  15439. */
  15440. serialize(currentSerializationObject?: any): any;
  15441. /**
  15442. * Returns a new TransformNode object parsed from the source provided.
  15443. * @param parsedTransformNode is the source.
  15444. * @param scene the scne the object belongs to
  15445. * @param rootUrl is a string, it's the root URL to prefix the `delayLoadingFile` property with
  15446. * @returns a new TransformNode object parsed from the source provided.
  15447. */
  15448. static Parse(parsedTransformNode: any, scene: Scene, rootUrl: string): TransformNode;
  15449. /**
  15450. * Get all child-transformNodes of this node
  15451. * @param directDescendantsOnly defines if true only direct descendants of 'this' will be considered, if false direct and also indirect (children of children, an so on in a recursive manner) descendants of 'this' will be considered
  15452. * @param predicate defines an optional predicate that will be called on every evaluated child, the predicate must return true for a given child to be part of the result, otherwise it will be ignored
  15453. * @returns an array of TransformNode
  15454. */
  15455. getChildTransformNodes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): TransformNode[];
  15456. /**
  15457. * Releases resources associated with this transform node.
  15458. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  15459. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  15460. */
  15461. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  15462. /**
  15463. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  15464. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  15465. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  15466. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  15467. * @returns the current mesh
  15468. */
  15469. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): TransformNode;
  15470. private _syncAbsoluteScalingAndRotation;
  15471. }
  15472. }
  15473. declare module "babylonjs/Animations/animationPropertiesOverride" {
  15474. /**
  15475. * Class used to override all child animations of a given target
  15476. */
  15477. export class AnimationPropertiesOverride {
  15478. /**
  15479. * Gets or sets a value indicating if animation blending must be used
  15480. */
  15481. enableBlending: boolean;
  15482. /**
  15483. * Gets or sets the blending speed to use when enableBlending is true
  15484. */
  15485. blendingSpeed: number;
  15486. /**
  15487. * Gets or sets the default loop mode to use
  15488. */
  15489. loopMode: number;
  15490. }
  15491. }
  15492. declare module "babylonjs/Bones/bone" {
  15493. import { Skeleton } from "babylonjs/Bones/skeleton";
  15494. import { Vector3, Quaternion, Matrix } from "babylonjs/Maths/math.vector";
  15495. import { Nullable } from "babylonjs/types";
  15496. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  15497. import { TransformNode } from "babylonjs/Meshes/transformNode";
  15498. import { Node } from "babylonjs/node";
  15499. import { Space } from "babylonjs/Maths/math.axis";
  15500. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  15501. /**
  15502. * Class used to store bone information
  15503. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  15504. */
  15505. export class Bone extends Node {
  15506. /**
  15507. * defines the bone name
  15508. */
  15509. name: string;
  15510. private static _tmpVecs;
  15511. private static _tmpQuat;
  15512. private static _tmpMats;
  15513. /**
  15514. * Gets the list of child bones
  15515. */
  15516. children: Bone[];
  15517. /** Gets the animations associated with this bone */
  15518. animations: import("babylonjs/Animations/animation").Animation[];
  15519. /**
  15520. * Gets or sets bone length
  15521. */
  15522. length: number;
  15523. /**
  15524. * @hidden Internal only
  15525. * Set this value to map this bone to a different index in the transform matrices
  15526. * Set this value to -1 to exclude the bone from the transform matrices
  15527. */
  15528. _index: Nullable<number>;
  15529. private _skeleton;
  15530. private _localMatrix;
  15531. private _restPose;
  15532. private _bindPose;
  15533. private _baseMatrix;
  15534. private _absoluteTransform;
  15535. private _invertedAbsoluteTransform;
  15536. private _parent;
  15537. private _scalingDeterminant;
  15538. private _worldTransform;
  15539. private _localScaling;
  15540. private _localRotation;
  15541. private _localPosition;
  15542. private _needToDecompose;
  15543. private _needToCompose;
  15544. /** @hidden */
  15545. _linkedTransformNode: Nullable<TransformNode>;
  15546. /** @hidden */
  15547. _waitingTransformNodeId: Nullable<string>;
  15548. /** @hidden */
  15549. get _matrix(): Matrix;
  15550. /** @hidden */
  15551. set _matrix(value: Matrix);
  15552. /**
  15553. * Create a new bone
  15554. * @param name defines the bone name
  15555. * @param skeleton defines the parent skeleton
  15556. * @param parentBone defines the parent (can be null if the bone is the root)
  15557. * @param localMatrix defines the local matrix
  15558. * @param restPose defines the rest pose matrix
  15559. * @param baseMatrix defines the base matrix
  15560. * @param index defines index of the bone in the hiearchy
  15561. */
  15562. constructor(
  15563. /**
  15564. * defines the bone name
  15565. */
  15566. name: string, skeleton: Skeleton, parentBone?: Nullable<Bone>, localMatrix?: Nullable<Matrix>, restPose?: Nullable<Matrix>, baseMatrix?: Nullable<Matrix>, index?: Nullable<number>);
  15567. /**
  15568. * Gets the current object class name.
  15569. * @return the class name
  15570. */
  15571. getClassName(): string;
  15572. /**
  15573. * Gets the parent skeleton
  15574. * @returns a skeleton
  15575. */
  15576. getSkeleton(): Skeleton;
  15577. /**
  15578. * Gets parent bone
  15579. * @returns a bone or null if the bone is the root of the bone hierarchy
  15580. */
  15581. getParent(): Nullable<Bone>;
  15582. /**
  15583. * Returns an array containing the root bones
  15584. * @returns an array containing the root bones
  15585. */
  15586. getChildren(): Array<Bone>;
  15587. /**
  15588. * Gets the node index in matrix array generated for rendering
  15589. * @returns the node index
  15590. */
  15591. getIndex(): number;
  15592. /**
  15593. * Sets the parent bone
  15594. * @param parent defines the parent (can be null if the bone is the root)
  15595. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  15596. */
  15597. setParent(parent: Nullable<Bone>, updateDifferenceMatrix?: boolean): void;
  15598. /**
  15599. * Gets the local matrix
  15600. * @returns a matrix
  15601. */
  15602. getLocalMatrix(): Matrix;
  15603. /**
  15604. * Gets the base matrix (initial matrix which remains unchanged)
  15605. * @returns a matrix
  15606. */
  15607. getBaseMatrix(): Matrix;
  15608. /**
  15609. * Gets the rest pose matrix
  15610. * @returns a matrix
  15611. */
  15612. getRestPose(): Matrix;
  15613. /**
  15614. * Sets the rest pose matrix
  15615. * @param matrix the local-space rest pose to set for this bone
  15616. */
  15617. setRestPose(matrix: Matrix): void;
  15618. /**
  15619. * Gets the bind pose matrix
  15620. * @returns the bind pose matrix
  15621. */
  15622. getBindPose(): Matrix;
  15623. /**
  15624. * Sets the bind pose matrix
  15625. * @param matrix the local-space bind pose to set for this bone
  15626. */
  15627. setBindPose(matrix: Matrix): void;
  15628. /**
  15629. * Gets a matrix used to store world matrix (ie. the matrix sent to shaders)
  15630. */
  15631. getWorldMatrix(): Matrix;
  15632. /**
  15633. * Sets the local matrix to rest pose matrix
  15634. */
  15635. returnToRest(): void;
  15636. /**
  15637. * Gets the inverse of the absolute transform matrix.
  15638. * This matrix will be multiplied by local matrix to get the difference matrix (ie. the difference between original state and current state)
  15639. * @returns a matrix
  15640. */
  15641. getInvertedAbsoluteTransform(): Matrix;
  15642. /**
  15643. * Gets the absolute transform matrix (ie base matrix * parent world matrix)
  15644. * @returns a matrix
  15645. */
  15646. getAbsoluteTransform(): Matrix;
  15647. /**
  15648. * Links with the given transform node.
  15649. * The local matrix of this bone is copied from the transform node every frame.
  15650. * @param transformNode defines the transform node to link to
  15651. */
  15652. linkTransformNode(transformNode: Nullable<TransformNode>): void;
  15653. /**
  15654. * Gets the node used to drive the bone's transformation
  15655. * @returns a transform node or null
  15656. */
  15657. getTransformNode(): Nullable<TransformNode>;
  15658. /** Gets or sets current position (in local space) */
  15659. get position(): Vector3;
  15660. set position(newPosition: Vector3);
  15661. /** Gets or sets current rotation (in local space) */
  15662. get rotation(): Vector3;
  15663. set rotation(newRotation: Vector3);
  15664. /** Gets or sets current rotation quaternion (in local space) */
  15665. get rotationQuaternion(): Quaternion;
  15666. set rotationQuaternion(newRotation: Quaternion);
  15667. /** Gets or sets current scaling (in local space) */
  15668. get scaling(): Vector3;
  15669. set scaling(newScaling: Vector3);
  15670. /**
  15671. * Gets the animation properties override
  15672. */
  15673. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  15674. private _decompose;
  15675. private _compose;
  15676. /**
  15677. * Update the base and local matrices
  15678. * @param matrix defines the new base or local matrix
  15679. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  15680. * @param updateLocalMatrix defines if the local matrix should be updated
  15681. */
  15682. updateMatrix(matrix: Matrix, updateDifferenceMatrix?: boolean, updateLocalMatrix?: boolean): void;
  15683. /** @hidden */
  15684. _updateDifferenceMatrix(rootMatrix?: Matrix, updateChildren?: boolean): void;
  15685. /**
  15686. * Flag the bone as dirty (Forcing it to update everything)
  15687. */
  15688. markAsDirty(): void;
  15689. /** @hidden */
  15690. _markAsDirtyAndCompose(): void;
  15691. private _markAsDirtyAndDecompose;
  15692. /**
  15693. * Translate the bone in local or world space
  15694. * @param vec The amount to translate the bone
  15695. * @param space The space that the translation is in
  15696. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15697. */
  15698. translate(vec: Vector3, space?: Space, mesh?: AbstractMesh): void;
  15699. /**
  15700. * Set the postion of the bone in local or world space
  15701. * @param position The position to set the bone
  15702. * @param space The space that the position is in
  15703. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15704. */
  15705. setPosition(position: Vector3, space?: Space, mesh?: AbstractMesh): void;
  15706. /**
  15707. * Set the absolute position of the bone (world space)
  15708. * @param position The position to set the bone
  15709. * @param mesh The mesh that this bone is attached to
  15710. */
  15711. setAbsolutePosition(position: Vector3, mesh?: AbstractMesh): void;
  15712. /**
  15713. * Scale the bone on the x, y and z axes (in local space)
  15714. * @param x The amount to scale the bone on the x axis
  15715. * @param y The amount to scale the bone on the y axis
  15716. * @param z The amount to scale the bone on the z axis
  15717. * @param scaleChildren sets this to true if children of the bone should be scaled as well (false by default)
  15718. */
  15719. scale(x: number, y: number, z: number, scaleChildren?: boolean): void;
  15720. /**
  15721. * Set the bone scaling in local space
  15722. * @param scale defines the scaling vector
  15723. */
  15724. setScale(scale: Vector3): void;
  15725. /**
  15726. * Gets the current scaling in local space
  15727. * @returns the current scaling vector
  15728. */
  15729. getScale(): Vector3;
  15730. /**
  15731. * Gets the current scaling in local space and stores it in a target vector
  15732. * @param result defines the target vector
  15733. */
  15734. getScaleToRef(result: Vector3): void;
  15735. /**
  15736. * Set the yaw, pitch, and roll of the bone in local or world space
  15737. * @param yaw The rotation of the bone on the y axis
  15738. * @param pitch The rotation of the bone on the x axis
  15739. * @param roll The rotation of the bone on the z axis
  15740. * @param space The space that the axes of rotation are in
  15741. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15742. */
  15743. setYawPitchRoll(yaw: number, pitch: number, roll: number, space?: Space, mesh?: AbstractMesh): void;
  15744. /**
  15745. * Add a rotation to the bone on an axis in local or world space
  15746. * @param axis The axis to rotate the bone on
  15747. * @param amount The amount to rotate the bone
  15748. * @param space The space that the axis is in
  15749. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15750. */
  15751. rotate(axis: Vector3, amount: number, space?: Space, mesh?: AbstractMesh): void;
  15752. /**
  15753. * Set the rotation of the bone to a particular axis angle in local or world space
  15754. * @param axis The axis to rotate the bone on
  15755. * @param angle The angle that the bone should be rotated to
  15756. * @param space The space that the axis is in
  15757. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15758. */
  15759. setAxisAngle(axis: Vector3, angle: number, space?: Space, mesh?: AbstractMesh): void;
  15760. /**
  15761. * Set the euler rotation of the bone in local of world space
  15762. * @param rotation The euler rotation that the bone should be set to
  15763. * @param space The space that the rotation is in
  15764. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15765. */
  15766. setRotation(rotation: Vector3, space?: Space, mesh?: AbstractMesh): void;
  15767. /**
  15768. * Set the quaternion rotation of the bone in local of world space
  15769. * @param quat The quaternion rotation that the bone should be set to
  15770. * @param space The space that the rotation is in
  15771. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15772. */
  15773. setRotationQuaternion(quat: Quaternion, space?: Space, mesh?: AbstractMesh): void;
  15774. /**
  15775. * Set the rotation matrix of the bone in local of world space
  15776. * @param rotMat The rotation matrix that the bone should be set to
  15777. * @param space The space that the rotation is in
  15778. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15779. */
  15780. setRotationMatrix(rotMat: Matrix, space?: Space, mesh?: AbstractMesh): void;
  15781. private _rotateWithMatrix;
  15782. private _getNegativeRotationToRef;
  15783. /**
  15784. * Get the position of the bone in local or world space
  15785. * @param space The space that the returned position is in
  15786. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15787. * @returns The position of the bone
  15788. */
  15789. getPosition(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  15790. /**
  15791. * Copy the position of the bone to a vector3 in local or world space
  15792. * @param space The space that the returned position is in
  15793. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15794. * @param result The vector3 to copy the position to
  15795. */
  15796. getPositionToRef(space: Space | undefined, mesh: Nullable<AbstractMesh>, result: Vector3): void;
  15797. /**
  15798. * Get the absolute position of the bone (world space)
  15799. * @param mesh The mesh that this bone is attached to
  15800. * @returns The absolute position of the bone
  15801. */
  15802. getAbsolutePosition(mesh?: Nullable<AbstractMesh>): Vector3;
  15803. /**
  15804. * Copy the absolute position of the bone (world space) to the result param
  15805. * @param mesh The mesh that this bone is attached to
  15806. * @param result The vector3 to copy the absolute position to
  15807. */
  15808. getAbsolutePositionToRef(mesh: AbstractMesh, result: Vector3): void;
  15809. /**
  15810. * Compute the absolute transforms of this bone and its children
  15811. */
  15812. computeAbsoluteTransforms(): void;
  15813. /**
  15814. * Get the world direction from an axis that is in the local space of the bone
  15815. * @param localAxis The local direction that is used to compute the world direction
  15816. * @param mesh The mesh that this bone is attached to
  15817. * @returns The world direction
  15818. */
  15819. getDirection(localAxis: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  15820. /**
  15821. * Copy the world direction to a vector3 from an axis that is in the local space of the bone
  15822. * @param localAxis The local direction that is used to compute the world direction
  15823. * @param mesh The mesh that this bone is attached to
  15824. * @param result The vector3 that the world direction will be copied to
  15825. */
  15826. getDirectionToRef(localAxis: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  15827. /**
  15828. * Get the euler rotation of the bone in local or world space
  15829. * @param space The space that the rotation should be in
  15830. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15831. * @returns The euler rotation
  15832. */
  15833. getRotation(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  15834. /**
  15835. * Copy the euler rotation of the bone to a vector3. The rotation can be in either local or world space
  15836. * @param space The space that the rotation should be in
  15837. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15838. * @param result The vector3 that the rotation should be copied to
  15839. */
  15840. getRotationToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  15841. /**
  15842. * Get the quaternion rotation of the bone in either local or world space
  15843. * @param space The space that the rotation should be in
  15844. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15845. * @returns The quaternion rotation
  15846. */
  15847. getRotationQuaternion(space?: Space, mesh?: Nullable<AbstractMesh>): Quaternion;
  15848. /**
  15849. * Copy the quaternion rotation of the bone to a quaternion. The rotation can be in either local or world space
  15850. * @param space The space that the rotation should be in
  15851. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15852. * @param result The quaternion that the rotation should be copied to
  15853. */
  15854. getRotationQuaternionToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Quaternion): void;
  15855. /**
  15856. * Get the rotation matrix of the bone in local or world space
  15857. * @param space The space that the rotation should be in
  15858. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15859. * @returns The rotation matrix
  15860. */
  15861. getRotationMatrix(space: Space | undefined, mesh: AbstractMesh): Matrix;
  15862. /**
  15863. * Copy the rotation matrix of the bone to a matrix. The rotation can be in either local or world space
  15864. * @param space The space that the rotation should be in
  15865. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15866. * @param result The quaternion that the rotation should be copied to
  15867. */
  15868. getRotationMatrixToRef(space: Space | undefined, mesh: AbstractMesh, result: Matrix): void;
  15869. /**
  15870. * Get the world position of a point that is in the local space of the bone
  15871. * @param position The local position
  15872. * @param mesh The mesh that this bone is attached to
  15873. * @returns The world position
  15874. */
  15875. getAbsolutePositionFromLocal(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  15876. /**
  15877. * Get the world position of a point that is in the local space of the bone and copy it to the result param
  15878. * @param position The local position
  15879. * @param mesh The mesh that this bone is attached to
  15880. * @param result The vector3 that the world position should be copied to
  15881. */
  15882. getAbsolutePositionFromLocalToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  15883. /**
  15884. * Get the local position of a point that is in world space
  15885. * @param position The world position
  15886. * @param mesh The mesh that this bone is attached to
  15887. * @returns The local position
  15888. */
  15889. getLocalPositionFromAbsolute(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  15890. /**
  15891. * Get the local position of a point that is in world space and copy it to the result param
  15892. * @param position The world position
  15893. * @param mesh The mesh that this bone is attached to
  15894. * @param result The vector3 that the local position should be copied to
  15895. */
  15896. getLocalPositionFromAbsoluteToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  15897. }
  15898. }
  15899. declare module "babylonjs/Animations/runtimeAnimation" {
  15900. import { Animation, _IAnimationState } from "babylonjs/Animations/animation";
  15901. import { Animatable } from "babylonjs/Animations/animatable";
  15902. import { Scene } from "babylonjs/scene";
  15903. /**
  15904. * Defines a runtime animation
  15905. */
  15906. export class RuntimeAnimation {
  15907. private _events;
  15908. /**
  15909. * The current frame of the runtime animation
  15910. */
  15911. private _currentFrame;
  15912. /**
  15913. * The animation used by the runtime animation
  15914. */
  15915. private _animation;
  15916. /**
  15917. * The target of the runtime animation
  15918. */
  15919. private _target;
  15920. /**
  15921. * The initiating animatable
  15922. */
  15923. private _host;
  15924. /**
  15925. * The original value of the runtime animation
  15926. */
  15927. private _originalValue;
  15928. /**
  15929. * The original blend value of the runtime animation
  15930. */
  15931. private _originalBlendValue;
  15932. /**
  15933. * The offsets cache of the runtime animation
  15934. */
  15935. private _offsetsCache;
  15936. /**
  15937. * The high limits cache of the runtime animation
  15938. */
  15939. private _highLimitsCache;
  15940. /**
  15941. * Specifies if the runtime animation has been stopped
  15942. */
  15943. private _stopped;
  15944. /**
  15945. * The blending factor of the runtime animation
  15946. */
  15947. private _blendingFactor;
  15948. /**
  15949. * The BabylonJS scene
  15950. */
  15951. private _scene;
  15952. /**
  15953. * The current value of the runtime animation
  15954. */
  15955. private _currentValue;
  15956. /** @hidden */
  15957. _animationState: _IAnimationState;
  15958. /**
  15959. * The active target of the runtime animation
  15960. */
  15961. private _activeTargets;
  15962. private _currentActiveTarget;
  15963. private _directTarget;
  15964. /**
  15965. * The target path of the runtime animation
  15966. */
  15967. private _targetPath;
  15968. /**
  15969. * The weight of the runtime animation
  15970. */
  15971. private _weight;
  15972. /**
  15973. * The ratio offset of the runtime animation
  15974. */
  15975. private _ratioOffset;
  15976. /**
  15977. * The previous delay of the runtime animation
  15978. */
  15979. private _previousDelay;
  15980. /**
  15981. * The previous ratio of the runtime animation
  15982. */
  15983. private _previousRatio;
  15984. private _enableBlending;
  15985. private _keys;
  15986. private _minFrame;
  15987. private _maxFrame;
  15988. private _minValue;
  15989. private _maxValue;
  15990. private _targetIsArray;
  15991. /**
  15992. * Gets the current frame of the runtime animation
  15993. */
  15994. get currentFrame(): number;
  15995. /**
  15996. * Gets the weight of the runtime animation
  15997. */
  15998. get weight(): number;
  15999. /**
  16000. * Gets the current value of the runtime animation
  16001. */
  16002. get currentValue(): any;
  16003. /**
  16004. * Gets the target path of the runtime animation
  16005. */
  16006. get targetPath(): string;
  16007. /**
  16008. * Gets the actual target of the runtime animation
  16009. */
  16010. get target(): any;
  16011. /**
  16012. * Gets the additive state of the runtime animation
  16013. */
  16014. get isAdditive(): boolean;
  16015. /** @hidden */
  16016. _onLoop: () => void;
  16017. /**
  16018. * Create a new RuntimeAnimation object
  16019. * @param target defines the target of the animation
  16020. * @param animation defines the source animation object
  16021. * @param scene defines the hosting scene
  16022. * @param host defines the initiating Animatable
  16023. */
  16024. constructor(target: any, animation: Animation, scene: Scene, host: Animatable);
  16025. private _preparePath;
  16026. /**
  16027. * Gets the animation from the runtime animation
  16028. */
  16029. get animation(): Animation;
  16030. /**
  16031. * Resets the runtime animation to the beginning
  16032. * @param restoreOriginal defines whether to restore the target property to the original value
  16033. */
  16034. reset(restoreOriginal?: boolean): void;
  16035. /**
  16036. * Specifies if the runtime animation is stopped
  16037. * @returns Boolean specifying if the runtime animation is stopped
  16038. */
  16039. isStopped(): boolean;
  16040. /**
  16041. * Disposes of the runtime animation
  16042. */
  16043. dispose(): void;
  16044. /**
  16045. * Apply the interpolated value to the target
  16046. * @param currentValue defines the value computed by the animation
  16047. * @param weight defines the weight to apply to this value (Defaults to 1.0)
  16048. */
  16049. setValue(currentValue: any, weight: number): void;
  16050. private _getOriginalValues;
  16051. private _setValue;
  16052. /**
  16053. * Gets the loop pmode of the runtime animation
  16054. * @returns Loop Mode
  16055. */
  16056. private _getCorrectLoopMode;
  16057. /**
  16058. * Move the current animation to a given frame
  16059. * @param frame defines the frame to move to
  16060. */
  16061. goToFrame(frame: number): void;
  16062. /**
  16063. * @hidden Internal use only
  16064. */
  16065. _prepareForSpeedRatioChange(newSpeedRatio: number): void;
  16066. /**
  16067. * Execute the current animation
  16068. * @param delay defines the delay to add to the current frame
  16069. * @param from defines the lower bound of the animation range
  16070. * @param to defines the upper bound of the animation range
  16071. * @param loop defines if the current animation must loop
  16072. * @param speedRatio defines the current speed ratio
  16073. * @param weight defines the weight of the animation (default is -1 so no weight)
  16074. * @param onLoop optional callback called when animation loops
  16075. * @returns a boolean indicating if the animation is running
  16076. */
  16077. animate(delay: number, from: number, to: number, loop: boolean, speedRatio: number, weight?: number): boolean;
  16078. }
  16079. }
  16080. declare module "babylonjs/Animations/animatable" {
  16081. import { Animation } from "babylonjs/Animations/animation";
  16082. import { RuntimeAnimation } from "babylonjs/Animations/runtimeAnimation";
  16083. import { Nullable } from "babylonjs/types";
  16084. import { Observable } from "babylonjs/Misc/observable";
  16085. import { Scene } from "babylonjs/scene";
  16086. import { Matrix, Quaternion, Vector3 } from "babylonjs/Maths/math.vector";
  16087. import { Node } from "babylonjs/node";
  16088. /**
  16089. * Class used to store an actual running animation
  16090. */
  16091. export class Animatable {
  16092. /** defines the target object */
  16093. target: any;
  16094. /** defines the starting frame number (default is 0) */
  16095. fromFrame: number;
  16096. /** defines the ending frame number (default is 100) */
  16097. toFrame: number;
  16098. /** defines if the animation must loop (default is false) */
  16099. loopAnimation: boolean;
  16100. /** defines a callback to call when animation ends if it is not looping */
  16101. onAnimationEnd?: (() => void) | null | undefined;
  16102. /** defines a callback to call when animation loops */
  16103. onAnimationLoop?: (() => void) | null | undefined;
  16104. /** defines whether the animation should be evaluated additively */
  16105. isAdditive: boolean;
  16106. private _localDelayOffset;
  16107. private _pausedDelay;
  16108. private _runtimeAnimations;
  16109. private _paused;
  16110. private _scene;
  16111. private _speedRatio;
  16112. private _weight;
  16113. private _syncRoot;
  16114. /**
  16115. * Gets or sets a boolean indicating if the animatable must be disposed and removed at the end of the animation.
  16116. * This will only apply for non looping animation (default is true)
  16117. */
  16118. disposeOnEnd: boolean;
  16119. /**
  16120. * Gets a boolean indicating if the animation has started
  16121. */
  16122. animationStarted: boolean;
  16123. /**
  16124. * Observer raised when the animation ends
  16125. */
  16126. onAnimationEndObservable: Observable<Animatable>;
  16127. /**
  16128. * Observer raised when the animation loops
  16129. */
  16130. onAnimationLoopObservable: Observable<Animatable>;
  16131. /**
  16132. * Gets the root Animatable used to synchronize and normalize animations
  16133. */
  16134. get syncRoot(): Nullable<Animatable>;
  16135. /**
  16136. * Gets the current frame of the first RuntimeAnimation
  16137. * Used to synchronize Animatables
  16138. */
  16139. get masterFrame(): number;
  16140. /**
  16141. * Gets or sets the animatable weight (-1.0 by default meaning not weighted)
  16142. */
  16143. get weight(): number;
  16144. set weight(value: number);
  16145. /**
  16146. * Gets or sets the speed ratio to apply to the animatable (1.0 by default)
  16147. */
  16148. get speedRatio(): number;
  16149. set speedRatio(value: number);
  16150. /**
  16151. * Creates a new Animatable
  16152. * @param scene defines the hosting scene
  16153. * @param target defines the target object
  16154. * @param fromFrame defines the starting frame number (default is 0)
  16155. * @param toFrame defines the ending frame number (default is 100)
  16156. * @param loopAnimation defines if the animation must loop (default is false)
  16157. * @param speedRatio defines the factor to apply to animation speed (default is 1)
  16158. * @param onAnimationEnd defines a callback to call when animation ends if it is not looping
  16159. * @param animations defines a group of animation to add to the new Animatable
  16160. * @param onAnimationLoop defines a callback to call when animation loops
  16161. * @param isAdditive defines whether the animation should be evaluated additively
  16162. */
  16163. constructor(scene: Scene,
  16164. /** defines the target object */
  16165. target: any,
  16166. /** defines the starting frame number (default is 0) */
  16167. fromFrame?: number,
  16168. /** defines the ending frame number (default is 100) */
  16169. toFrame?: number,
  16170. /** defines if the animation must loop (default is false) */
  16171. loopAnimation?: boolean, speedRatio?: number,
  16172. /** defines a callback to call when animation ends if it is not looping */
  16173. onAnimationEnd?: (() => void) | null | undefined, animations?: Animation[],
  16174. /** defines a callback to call when animation loops */
  16175. onAnimationLoop?: (() => void) | null | undefined,
  16176. /** defines whether the animation should be evaluated additively */
  16177. isAdditive?: boolean);
  16178. /**
  16179. * Synchronize and normalize current Animatable with a source Animatable
  16180. * This is useful when using animation weights and when animations are not of the same length
  16181. * @param root defines the root Animatable to synchronize with
  16182. * @returns the current Animatable
  16183. */
  16184. syncWith(root: Animatable): Animatable;
  16185. /**
  16186. * Gets the list of runtime animations
  16187. * @returns an array of RuntimeAnimation
  16188. */
  16189. getAnimations(): RuntimeAnimation[];
  16190. /**
  16191. * Adds more animations to the current animatable
  16192. * @param target defines the target of the animations
  16193. * @param animations defines the new animations to add
  16194. */
  16195. appendAnimations(target: any, animations: Animation[]): void;
  16196. /**
  16197. * Gets the source animation for a specific property
  16198. * @param property defines the propertyu to look for
  16199. * @returns null or the source animation for the given property
  16200. */
  16201. getAnimationByTargetProperty(property: string): Nullable<Animation>;
  16202. /**
  16203. * Gets the runtime animation for a specific property
  16204. * @param property defines the propertyu to look for
  16205. * @returns null or the runtime animation for the given property
  16206. */
  16207. getRuntimeAnimationByTargetProperty(property: string): Nullable<RuntimeAnimation>;
  16208. /**
  16209. * Resets the animatable to its original state
  16210. */
  16211. reset(): void;
  16212. /**
  16213. * Allows the animatable to blend with current running animations
  16214. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  16215. * @param blendingSpeed defines the blending speed to use
  16216. */
  16217. enableBlending(blendingSpeed: number): void;
  16218. /**
  16219. * Disable animation blending
  16220. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  16221. */
  16222. disableBlending(): void;
  16223. /**
  16224. * Jump directly to a given frame
  16225. * @param frame defines the frame to jump to
  16226. */
  16227. goToFrame(frame: number): void;
  16228. /**
  16229. * Pause the animation
  16230. */
  16231. pause(): void;
  16232. /**
  16233. * Restart the animation
  16234. */
  16235. restart(): void;
  16236. private _raiseOnAnimationEnd;
  16237. /**
  16238. * Stop and delete the current animation
  16239. * @param animationName defines a string used to only stop some of the runtime animations instead of all
  16240. * @param targetMask - a function that determines if the animation should be stopped based on its target (all animations will be stopped if both this and animationName are empty)
  16241. */
  16242. stop(animationName?: string, targetMask?: (target: any) => boolean): void;
  16243. /**
  16244. * Wait asynchronously for the animation to end
  16245. * @returns a promise which will be fullfilled when the animation ends
  16246. */
  16247. waitAsync(): Promise<Animatable>;
  16248. /** @hidden */
  16249. _animate(delay: number): boolean;
  16250. }
  16251. module "babylonjs/scene" {
  16252. interface Scene {
  16253. /** @hidden */
  16254. _registerTargetForLateAnimationBinding(runtimeAnimation: RuntimeAnimation, originalValue: any): void;
  16255. /** @hidden */
  16256. _processLateAnimationBindingsForMatrices(holder: {
  16257. totalWeight: number;
  16258. totalAdditiveWeight: number;
  16259. animations: RuntimeAnimation[];
  16260. additiveAnimations: RuntimeAnimation[];
  16261. originalValue: Matrix;
  16262. }): any;
  16263. /** @hidden */
  16264. _processLateAnimationBindingsForQuaternions(holder: {
  16265. totalWeight: number;
  16266. totalAdditiveWeight: number;
  16267. animations: RuntimeAnimation[];
  16268. additiveAnimations: RuntimeAnimation[];
  16269. originalValue: Quaternion;
  16270. }, refQuaternion: Quaternion): Quaternion;
  16271. /** @hidden */
  16272. _processLateAnimationBindings(): void;
  16273. /**
  16274. * Will start the animation sequence of a given target
  16275. * @param target defines the target
  16276. * @param from defines from which frame should animation start
  16277. * @param to defines until which frame should animation run.
  16278. * @param weight defines the weight to apply to the animation (1.0 by default)
  16279. * @param loop defines if the animation loops
  16280. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  16281. * @param onAnimationEnd defines the function to be executed when the animation ends
  16282. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  16283. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  16284. * @param onAnimationLoop defines the callback to call when an animation loops
  16285. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16286. * @returns the animatable object created for this animation
  16287. */
  16288. beginWeightedAnimation(target: any, from: number, to: number, weight: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable;
  16289. /**
  16290. * Will start the animation sequence of a given target
  16291. * @param target defines the target
  16292. * @param from defines from which frame should animation start
  16293. * @param to defines until which frame should animation run.
  16294. * @param loop defines if the animation loops
  16295. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  16296. * @param onAnimationEnd defines the function to be executed when the animation ends
  16297. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  16298. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  16299. * @param targetMask defines if the target should be animate if animations are present (this is called recursively on descendant animatables regardless of return value)
  16300. * @param onAnimationLoop defines the callback to call when an animation loops
  16301. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16302. * @returns the animatable object created for this animation
  16303. */
  16304. beginAnimation(target: any, from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, stopCurrent?: boolean, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable;
  16305. /**
  16306. * Will start the animation sequence of a given target and its hierarchy
  16307. * @param target defines the target
  16308. * @param directDescendantsOnly if true only direct descendants will be used, if false direct and also indirect (children of children, an so on in a recursive manner) descendants will be used.
  16309. * @param from defines from which frame should animation start
  16310. * @param to defines until which frame should animation run.
  16311. * @param loop defines if the animation loops
  16312. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  16313. * @param onAnimationEnd defines the function to be executed when the animation ends
  16314. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  16315. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  16316. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  16317. * @param onAnimationLoop defines the callback to call when an animation loops
  16318. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16319. * @returns the list of created animatables
  16320. */
  16321. beginHierarchyAnimation(target: any, directDescendantsOnly: boolean, from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, stopCurrent?: boolean, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable[];
  16322. /**
  16323. * Begin a new animation on a given node
  16324. * @param target defines the target where the animation will take place
  16325. * @param animations defines the list of animations to start
  16326. * @param from defines the initial value
  16327. * @param to defines the final value
  16328. * @param loop defines if you want animation to loop (off by default)
  16329. * @param speedRatio defines the speed ratio to apply to all animations
  16330. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  16331. * @param onAnimationLoop defines the callback to call when an animation loops
  16332. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16333. * @returns the list of created animatables
  16334. */
  16335. beginDirectAnimation(target: any, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable;
  16336. /**
  16337. * Begin a new animation on a given node and its hierarchy
  16338. * @param target defines the root node where the animation will take place
  16339. * @param directDescendantsOnly if true only direct descendants will be used, if false direct and also indirect (children of children, an so on in a recursive manner) descendants will be used.
  16340. * @param animations defines the list of animations to start
  16341. * @param from defines the initial value
  16342. * @param to defines the final value
  16343. * @param loop defines if you want animation to loop (off by default)
  16344. * @param speedRatio defines the speed ratio to apply to all animations
  16345. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  16346. * @param onAnimationLoop defines the callback to call when an animation loops
  16347. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16348. * @returns the list of animatables created for all nodes
  16349. */
  16350. beginDirectHierarchyAnimation(target: Node, directDescendantsOnly: boolean, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable[];
  16351. /**
  16352. * Gets the animatable associated with a specific target
  16353. * @param target defines the target of the animatable
  16354. * @returns the required animatable if found
  16355. */
  16356. getAnimatableByTarget(target: any): Nullable<Animatable>;
  16357. /**
  16358. * Gets all animatables associated with a given target
  16359. * @param target defines the target to look animatables for
  16360. * @returns an array of Animatables
  16361. */
  16362. getAllAnimatablesByTarget(target: any): Array<Animatable>;
  16363. /**
  16364. * Stops and removes all animations that have been applied to the scene
  16365. */
  16366. stopAllAnimations(): void;
  16367. /**
  16368. * Gets the current delta time used by animation engine
  16369. */
  16370. deltaTime: number;
  16371. }
  16372. }
  16373. module "babylonjs/Bones/bone" {
  16374. interface Bone {
  16375. /**
  16376. * Copy an animation range from another bone
  16377. * @param source defines the source bone
  16378. * @param rangeName defines the range name to copy
  16379. * @param frameOffset defines the frame offset
  16380. * @param rescaleAsRequired defines if rescaling must be applied if required
  16381. * @param skelDimensionsRatio defines the scaling ratio
  16382. * @returns true if operation was successful
  16383. */
  16384. copyAnimationRange(source: Bone, rangeName: string, frameOffset: number, rescaleAsRequired: boolean, skelDimensionsRatio: Nullable<Vector3>): boolean;
  16385. }
  16386. }
  16387. }
  16388. declare module "babylonjs/Bones/skeleton" {
  16389. import { Bone } from "babylonjs/Bones/bone";
  16390. import { Observable } from "babylonjs/Misc/observable";
  16391. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  16392. import { Scene } from "babylonjs/scene";
  16393. import { Nullable } from "babylonjs/types";
  16394. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  16395. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  16396. import { Animatable } from "babylonjs/Animations/animatable";
  16397. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  16398. import { Animation } from "babylonjs/Animations/animation";
  16399. import { AnimationRange } from "babylonjs/Animations/animationRange";
  16400. import { IInspectable } from "babylonjs/Misc/iInspectable";
  16401. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  16402. /**
  16403. * Class used to handle skinning animations
  16404. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  16405. */
  16406. export class Skeleton implements IAnimatable {
  16407. /** defines the skeleton name */
  16408. name: string;
  16409. /** defines the skeleton Id */
  16410. id: string;
  16411. /**
  16412. * Defines the list of child bones
  16413. */
  16414. bones: Bone[];
  16415. /**
  16416. * Defines an estimate of the dimension of the skeleton at rest
  16417. */
  16418. dimensionsAtRest: Vector3;
  16419. /**
  16420. * Defines a boolean indicating if the root matrix is provided by meshes or by the current skeleton (this is the default value)
  16421. */
  16422. needInitialSkinMatrix: boolean;
  16423. /**
  16424. * Defines a mesh that override the matrix used to get the world matrix (null by default).
  16425. */
  16426. overrideMesh: Nullable<AbstractMesh>;
  16427. /**
  16428. * Gets the list of animations attached to this skeleton
  16429. */
  16430. animations: Array<Animation>;
  16431. private _scene;
  16432. private _isDirty;
  16433. private _transformMatrices;
  16434. private _transformMatrixTexture;
  16435. private _meshesWithPoseMatrix;
  16436. private _animatables;
  16437. private _identity;
  16438. private _synchronizedWithMesh;
  16439. private _ranges;
  16440. private _lastAbsoluteTransformsUpdateId;
  16441. private _canUseTextureForBones;
  16442. private _uniqueId;
  16443. /** @hidden */
  16444. _numBonesWithLinkedTransformNode: number;
  16445. /** @hidden */
  16446. _hasWaitingData: Nullable<boolean>;
  16447. /** @hidden */
  16448. _waitingOverrideMeshId: Nullable<string>;
  16449. /**
  16450. * Specifies if the skeleton should be serialized
  16451. */
  16452. doNotSerialize: boolean;
  16453. private _useTextureToStoreBoneMatrices;
  16454. /**
  16455. * Gets or sets a boolean indicating that bone matrices should be stored as a texture instead of using shader uniforms (default is true).
  16456. * Please note that this option is not available if the hardware does not support it
  16457. */
  16458. get useTextureToStoreBoneMatrices(): boolean;
  16459. set useTextureToStoreBoneMatrices(value: boolean);
  16460. private _animationPropertiesOverride;
  16461. /**
  16462. * Gets or sets the animation properties override
  16463. */
  16464. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  16465. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  16466. /**
  16467. * List of inspectable custom properties (used by the Inspector)
  16468. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  16469. */
  16470. inspectableCustomProperties: IInspectable[];
  16471. /**
  16472. * An observable triggered before computing the skeleton's matrices
  16473. */
  16474. onBeforeComputeObservable: Observable<Skeleton>;
  16475. /**
  16476. * Gets a boolean indicating that the skeleton effectively stores matrices into a texture
  16477. */
  16478. get isUsingTextureForMatrices(): boolean;
  16479. /**
  16480. * Gets the unique ID of this skeleton
  16481. */
  16482. get uniqueId(): number;
  16483. /**
  16484. * Creates a new skeleton
  16485. * @param name defines the skeleton name
  16486. * @param id defines the skeleton Id
  16487. * @param scene defines the hosting scene
  16488. */
  16489. constructor(
  16490. /** defines the skeleton name */
  16491. name: string,
  16492. /** defines the skeleton Id */
  16493. id: string, scene: Scene);
  16494. /**
  16495. * Gets the current object class name.
  16496. * @return the class name
  16497. */
  16498. getClassName(): string;
  16499. /**
  16500. * Returns an array containing the root bones
  16501. * @returns an array containing the root bones
  16502. */
  16503. getChildren(): Array<Bone>;
  16504. /**
  16505. * Gets the list of transform matrices to send to shaders (one matrix per bone)
  16506. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  16507. * @returns a Float32Array containing matrices data
  16508. */
  16509. getTransformMatrices(mesh: AbstractMesh): Float32Array;
  16510. /**
  16511. * Gets the list of transform matrices to send to shaders inside a texture (one matrix per bone)
  16512. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  16513. * @returns a raw texture containing the data
  16514. */
  16515. getTransformMatrixTexture(mesh: AbstractMesh): Nullable<RawTexture>;
  16516. /**
  16517. * Gets the current hosting scene
  16518. * @returns a scene object
  16519. */
  16520. getScene(): Scene;
  16521. /**
  16522. * Gets a string representing the current skeleton data
  16523. * @param fullDetails defines a boolean indicating if we want a verbose version
  16524. * @returns a string representing the current skeleton data
  16525. */
  16526. toString(fullDetails?: boolean): string;
  16527. /**
  16528. * Get bone's index searching by name
  16529. * @param name defines bone's name to search for
  16530. * @return the indice of the bone. Returns -1 if not found
  16531. */
  16532. getBoneIndexByName(name: string): number;
  16533. /**
  16534. * Creater a new animation range
  16535. * @param name defines the name of the range
  16536. * @param from defines the start key
  16537. * @param to defines the end key
  16538. */
  16539. createAnimationRange(name: string, from: number, to: number): void;
  16540. /**
  16541. * Delete a specific animation range
  16542. * @param name defines the name of the range
  16543. * @param deleteFrames defines if frames must be removed as well
  16544. */
  16545. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  16546. /**
  16547. * Gets a specific animation range
  16548. * @param name defines the name of the range to look for
  16549. * @returns the requested animation range or null if not found
  16550. */
  16551. getAnimationRange(name: string): Nullable<AnimationRange>;
  16552. /**
  16553. * Gets the list of all animation ranges defined on this skeleton
  16554. * @returns an array
  16555. */
  16556. getAnimationRanges(): Nullable<AnimationRange>[];
  16557. /**
  16558. * Copy animation range from a source skeleton.
  16559. * This is not for a complete retargeting, only between very similar skeleton's with only possible bone length differences
  16560. * @param source defines the source skeleton
  16561. * @param name defines the name of the range to copy
  16562. * @param rescaleAsRequired defines if rescaling must be applied if required
  16563. * @returns true if operation was successful
  16564. */
  16565. copyAnimationRange(source: Skeleton, name: string, rescaleAsRequired?: boolean): boolean;
  16566. /**
  16567. * Forces the skeleton to go to rest pose
  16568. */
  16569. returnToRest(): void;
  16570. private _getHighestAnimationFrame;
  16571. /**
  16572. * Begin a specific animation range
  16573. * @param name defines the name of the range to start
  16574. * @param loop defines if looping must be turned on (false by default)
  16575. * @param speedRatio defines the speed ratio to apply (1 by default)
  16576. * @param onAnimationEnd defines a callback which will be called when animation will end
  16577. * @returns a new animatable
  16578. */
  16579. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  16580. /**
  16581. * Convert the keyframes for a range of animation on a skeleton to be relative to a given reference frame.
  16582. * @param skeleton defines the Skeleton containing the animation range to convert
  16583. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  16584. * @param range defines the name of the AnimationRange belonging to the Skeleton to convert
  16585. * @returns the original skeleton
  16586. */
  16587. static MakeAnimationAdditive(skeleton: Skeleton, referenceFrame: number | undefined, range: string): Nullable<Skeleton>;
  16588. /** @hidden */
  16589. _markAsDirty(): void;
  16590. /** @hidden */
  16591. _registerMeshWithPoseMatrix(mesh: AbstractMesh): void;
  16592. /** @hidden */
  16593. _unregisterMeshWithPoseMatrix(mesh: AbstractMesh): void;
  16594. private _computeTransformMatrices;
  16595. /**
  16596. * Build all resources required to render a skeleton
  16597. */
  16598. prepare(): void;
  16599. /**
  16600. * Gets the list of animatables currently running for this skeleton
  16601. * @returns an array of animatables
  16602. */
  16603. getAnimatables(): IAnimatable[];
  16604. /**
  16605. * Clone the current skeleton
  16606. * @param name defines the name of the new skeleton
  16607. * @param id defines the id of the new skeleton
  16608. * @returns the new skeleton
  16609. */
  16610. clone(name: string, id?: string): Skeleton;
  16611. /**
  16612. * Enable animation blending for this skeleton
  16613. * @param blendingSpeed defines the blending speed to apply
  16614. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  16615. */
  16616. enableBlending(blendingSpeed?: number): void;
  16617. /**
  16618. * Releases all resources associated with the current skeleton
  16619. */
  16620. dispose(): void;
  16621. /**
  16622. * Serialize the skeleton in a JSON object
  16623. * @returns a JSON object
  16624. */
  16625. serialize(): any;
  16626. /**
  16627. * Creates a new skeleton from serialized data
  16628. * @param parsedSkeleton defines the serialized data
  16629. * @param scene defines the hosting scene
  16630. * @returns a new skeleton
  16631. */
  16632. static Parse(parsedSkeleton: any, scene: Scene): Skeleton;
  16633. /**
  16634. * Compute all node absolute transforms
  16635. * @param forceUpdate defines if computation must be done even if cache is up to date
  16636. */
  16637. computeAbsoluteTransforms(forceUpdate?: boolean): void;
  16638. /**
  16639. * Gets the root pose matrix
  16640. * @returns a matrix
  16641. */
  16642. getPoseMatrix(): Nullable<Matrix>;
  16643. /**
  16644. * Sorts bones per internal index
  16645. */
  16646. sortBones(): void;
  16647. private _sortBones;
  16648. }
  16649. }
  16650. declare module "babylonjs/Meshes/instancedMesh" {
  16651. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  16652. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  16653. import { Camera } from "babylonjs/Cameras/camera";
  16654. import { Node } from "babylonjs/node";
  16655. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  16656. import { Mesh } from "babylonjs/Meshes/mesh";
  16657. import { Material } from "babylonjs/Materials/material";
  16658. import { Skeleton } from "babylonjs/Bones/skeleton";
  16659. import { Light } from "babylonjs/Lights/light";
  16660. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  16661. /**
  16662. * Creates an instance based on a source mesh.
  16663. */
  16664. export class InstancedMesh extends AbstractMesh {
  16665. private _sourceMesh;
  16666. private _currentLOD;
  16667. /** @hidden */
  16668. _indexInSourceMeshInstanceArray: number;
  16669. constructor(name: string, source: Mesh);
  16670. /**
  16671. * Returns the string "InstancedMesh".
  16672. */
  16673. getClassName(): string;
  16674. /** Gets the list of lights affecting that mesh */
  16675. get lightSources(): Light[];
  16676. _resyncLightSources(): void;
  16677. _resyncLightSource(light: Light): void;
  16678. _removeLightSource(light: Light, dispose: boolean): void;
  16679. /**
  16680. * If the source mesh receives shadows
  16681. */
  16682. get receiveShadows(): boolean;
  16683. /**
  16684. * The material of the source mesh
  16685. */
  16686. get material(): Nullable<Material>;
  16687. /**
  16688. * Visibility of the source mesh
  16689. */
  16690. get visibility(): number;
  16691. /**
  16692. * Skeleton of the source mesh
  16693. */
  16694. get skeleton(): Nullable<Skeleton>;
  16695. /**
  16696. * Rendering ground id of the source mesh
  16697. */
  16698. get renderingGroupId(): number;
  16699. set renderingGroupId(value: number);
  16700. /**
  16701. * Returns the total number of vertices (integer).
  16702. */
  16703. getTotalVertices(): number;
  16704. /**
  16705. * Returns a positive integer : the total number of indices in this mesh geometry.
  16706. * @returns the numner of indices or zero if the mesh has no geometry.
  16707. */
  16708. getTotalIndices(): number;
  16709. /**
  16710. * The source mesh of the instance
  16711. */
  16712. get sourceMesh(): Mesh;
  16713. /**
  16714. * Creates a new InstancedMesh object from the mesh model.
  16715. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  16716. * @param name defines the name of the new instance
  16717. * @returns a new InstancedMesh
  16718. */
  16719. createInstance(name: string): InstancedMesh;
  16720. /**
  16721. * Is this node ready to be used/rendered
  16722. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  16723. * @return {boolean} is it ready
  16724. */
  16725. isReady(completeCheck?: boolean): boolean;
  16726. /**
  16727. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  16728. * @param kind kind of verticies to retreive (eg. positons, normals, uvs, etc.)
  16729. * @param copyWhenShared If true (default false) and and if the mesh geometry is shared among some other meshes, the returned array is a copy of the internal one.
  16730. * @returns a float array or a Float32Array of the requested kind of data : positons, normals, uvs, etc.
  16731. */
  16732. getVerticesData(kind: string, copyWhenShared?: boolean): Nullable<FloatArray>;
  16733. /**
  16734. * Sets the vertex data of the mesh geometry for the requested `kind`.
  16735. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  16736. * The `data` are either a numeric array either a Float32Array.
  16737. * The parameter `updatable` is passed as is to the underlying Geometry object constructor (if initianilly none) or updater.
  16738. * The parameter `stride` is an optional positive integer, it is usually automatically deducted from the `kind` (3 for positions or normals, 2 for UV, etc).
  16739. * Note that a new underlying VertexBuffer object is created each call.
  16740. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  16741. *
  16742. * Possible `kind` values :
  16743. * - VertexBuffer.PositionKind
  16744. * - VertexBuffer.UVKind
  16745. * - VertexBuffer.UV2Kind
  16746. * - VertexBuffer.UV3Kind
  16747. * - VertexBuffer.UV4Kind
  16748. * - VertexBuffer.UV5Kind
  16749. * - VertexBuffer.UV6Kind
  16750. * - VertexBuffer.ColorKind
  16751. * - VertexBuffer.MatricesIndicesKind
  16752. * - VertexBuffer.MatricesIndicesExtraKind
  16753. * - VertexBuffer.MatricesWeightsKind
  16754. * - VertexBuffer.MatricesWeightsExtraKind
  16755. *
  16756. * Returns the Mesh.
  16757. */
  16758. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  16759. /**
  16760. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  16761. * If the mesh has no geometry, it is simply returned as it is.
  16762. * The `data` are either a numeric array either a Float32Array.
  16763. * No new underlying VertexBuffer object is created.
  16764. * If the `kind` is the `PositionKind` and if `updateExtends` is true, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  16765. * If the parameter `makeItUnique` is true, a new global geometry is created from this positions and is set to the mesh.
  16766. *
  16767. * Possible `kind` values :
  16768. * - VertexBuffer.PositionKind
  16769. * - VertexBuffer.UVKind
  16770. * - VertexBuffer.UV2Kind
  16771. * - VertexBuffer.UV3Kind
  16772. * - VertexBuffer.UV4Kind
  16773. * - VertexBuffer.UV5Kind
  16774. * - VertexBuffer.UV6Kind
  16775. * - VertexBuffer.ColorKind
  16776. * - VertexBuffer.MatricesIndicesKind
  16777. * - VertexBuffer.MatricesIndicesExtraKind
  16778. * - VertexBuffer.MatricesWeightsKind
  16779. * - VertexBuffer.MatricesWeightsExtraKind
  16780. *
  16781. * Returns the Mesh.
  16782. */
  16783. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): Mesh;
  16784. /**
  16785. * Sets the mesh indices.
  16786. * Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array).
  16787. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  16788. * This method creates a new index buffer each call.
  16789. * Returns the Mesh.
  16790. */
  16791. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>): Mesh;
  16792. /**
  16793. * Boolean : True if the mesh owns the requested kind of data.
  16794. */
  16795. isVerticesDataPresent(kind: string): boolean;
  16796. /**
  16797. * Returns an array of indices (IndicesArray).
  16798. */
  16799. getIndices(): Nullable<IndicesArray>;
  16800. get _positions(): Nullable<Vector3[]>;
  16801. /**
  16802. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  16803. * This means the mesh underlying bounding box and sphere are recomputed.
  16804. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  16805. * @returns the current mesh
  16806. */
  16807. refreshBoundingInfo(applySkeleton?: boolean): InstancedMesh;
  16808. /** @hidden */
  16809. _preActivate(): InstancedMesh;
  16810. /** @hidden */
  16811. _activate(renderId: number, intermediateRendering: boolean): boolean;
  16812. /** @hidden */
  16813. _postActivate(): void;
  16814. getWorldMatrix(): Matrix;
  16815. get isAnInstance(): boolean;
  16816. /**
  16817. * Returns the current associated LOD AbstractMesh.
  16818. */
  16819. getLOD(camera: Camera): AbstractMesh;
  16820. /** @hidden */
  16821. _preActivateForIntermediateRendering(renderId: number): Mesh;
  16822. /** @hidden */
  16823. _syncSubMeshes(): InstancedMesh;
  16824. /** @hidden */
  16825. _generatePointsArray(): boolean;
  16826. /** @hidden */
  16827. _updateBoundingInfo(): AbstractMesh;
  16828. /**
  16829. * Creates a new InstancedMesh from the current mesh.
  16830. * - name (string) : the cloned mesh name
  16831. * - newParent (optional Node) : the optional Node to parent the clone to.
  16832. * - doNotCloneChildren (optional boolean, default `false`) : if `true` the model children aren't cloned.
  16833. *
  16834. * Returns the clone.
  16835. */
  16836. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): InstancedMesh;
  16837. /**
  16838. * Disposes the InstancedMesh.
  16839. * Returns nothing.
  16840. */
  16841. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  16842. }
  16843. module "babylonjs/Meshes/mesh" {
  16844. interface Mesh {
  16845. /**
  16846. * Register a custom buffer that will be instanced
  16847. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  16848. * @param kind defines the buffer kind
  16849. * @param stride defines the stride in floats
  16850. */
  16851. registerInstancedBuffer(kind: string, stride: number): void;
  16852. /**
  16853. * true to use the edge renderer for all instances of this mesh
  16854. */
  16855. edgesShareWithInstances: boolean;
  16856. /** @hidden */
  16857. _userInstancedBuffersStorage: {
  16858. data: {
  16859. [key: string]: Float32Array;
  16860. };
  16861. sizes: {
  16862. [key: string]: number;
  16863. };
  16864. vertexBuffers: {
  16865. [key: string]: Nullable<VertexBuffer>;
  16866. };
  16867. strides: {
  16868. [key: string]: number;
  16869. };
  16870. };
  16871. }
  16872. }
  16873. module "babylonjs/Meshes/abstractMesh" {
  16874. interface AbstractMesh {
  16875. /**
  16876. * Object used to store instanced buffers defined by user
  16877. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  16878. */
  16879. instancedBuffers: {
  16880. [key: string]: any;
  16881. };
  16882. }
  16883. }
  16884. }
  16885. declare module "babylonjs/Materials/shaderMaterial" {
  16886. import { Nullable } from "babylonjs/types";
  16887. import { Scene } from "babylonjs/scene";
  16888. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  16889. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  16890. import { Mesh } from "babylonjs/Meshes/mesh";
  16891. import { SubMesh } from "babylonjs/Meshes/subMesh";
  16892. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  16893. import { Effect } from "babylonjs/Materials/effect";
  16894. import { Material } from "babylonjs/Materials/material";
  16895. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  16896. /**
  16897. * Defines the options associated with the creation of a shader material.
  16898. */
  16899. export interface IShaderMaterialOptions {
  16900. /**
  16901. * Does the material work in alpha blend mode
  16902. */
  16903. needAlphaBlending: boolean;
  16904. /**
  16905. * Does the material work in alpha test mode
  16906. */
  16907. needAlphaTesting: boolean;
  16908. /**
  16909. * The list of attribute names used in the shader
  16910. */
  16911. attributes: string[];
  16912. /**
  16913. * The list of unifrom names used in the shader
  16914. */
  16915. uniforms: string[];
  16916. /**
  16917. * The list of UBO names used in the shader
  16918. */
  16919. uniformBuffers: string[];
  16920. /**
  16921. * The list of sampler names used in the shader
  16922. */
  16923. samplers: string[];
  16924. /**
  16925. * The list of defines used in the shader
  16926. */
  16927. defines: string[];
  16928. }
  16929. /**
  16930. * The ShaderMaterial object has the necessary methods to pass data from your scene to the Vertex and Fragment Shaders and returns a material that can be applied to any mesh.
  16931. *
  16932. * This returned material effects how the mesh will look based on the code in the shaders.
  16933. *
  16934. * @see https://doc.babylonjs.com/how_to/shader_material
  16935. */
  16936. export class ShaderMaterial extends Material {
  16937. private _shaderPath;
  16938. private _options;
  16939. private _textures;
  16940. private _textureArrays;
  16941. private _floats;
  16942. private _ints;
  16943. private _floatsArrays;
  16944. private _colors3;
  16945. private _colors3Arrays;
  16946. private _colors4;
  16947. private _colors4Arrays;
  16948. private _vectors2;
  16949. private _vectors3;
  16950. private _vectors4;
  16951. private _matrices;
  16952. private _matrixArrays;
  16953. private _matrices3x3;
  16954. private _matrices2x2;
  16955. private _vectors2Arrays;
  16956. private _vectors3Arrays;
  16957. private _vectors4Arrays;
  16958. private _cachedWorldViewMatrix;
  16959. private _cachedWorldViewProjectionMatrix;
  16960. private _renderId;
  16961. private _multiview;
  16962. private _cachedDefines;
  16963. /** Define the Url to load snippets */
  16964. static SnippetUrl: string;
  16965. /** Snippet ID if the material was created from the snippet server */
  16966. snippetId: string;
  16967. /**
  16968. * Instantiate a new shader material.
  16969. * The ShaderMaterial object has the necessary methods to pass data from your scene to the Vertex and Fragment Shaders and returns a material that can be applied to any mesh.
  16970. * This returned material effects how the mesh will look based on the code in the shaders.
  16971. * @see https://doc.babylonjs.com/how_to/shader_material
  16972. * @param name Define the name of the material in the scene
  16973. * @param scene Define the scene the material belongs to
  16974. * @param shaderPath Defines the route to the shader code in one of three ways:
  16975. * * object: { vertex: "custom", fragment: "custom" }, used with Effect.ShadersStore["customVertexShader"] and Effect.ShadersStore["customFragmentShader"]
  16976. * * object: { vertexElement: "vertexShaderCode", fragmentElement: "fragmentShaderCode" }, used with shader code in script tags
  16977. * * object: { vertexSource: "vertex shader code string", fragmentSource: "fragment shader code string" } using with strings containing the shaders code
  16978. * * string: "./COMMON_NAME", used with external files COMMON_NAME.vertex.fx and COMMON_NAME.fragment.fx in index.html folder.
  16979. * @param options Define the options used to create the shader
  16980. */
  16981. constructor(name: string, scene: Scene, shaderPath: any, options?: Partial<IShaderMaterialOptions>);
  16982. /**
  16983. * Gets the shader path used to define the shader code
  16984. * It can be modified to trigger a new compilation
  16985. */
  16986. get shaderPath(): any;
  16987. /**
  16988. * Sets the shader path used to define the shader code
  16989. * It can be modified to trigger a new compilation
  16990. */
  16991. set shaderPath(shaderPath: any);
  16992. /**
  16993. * Gets the options used to compile the shader.
  16994. * They can be modified to trigger a new compilation
  16995. */
  16996. get options(): IShaderMaterialOptions;
  16997. /**
  16998. * Gets the current class name of the material e.g. "ShaderMaterial"
  16999. * Mainly use in serialization.
  17000. * @returns the class name
  17001. */
  17002. getClassName(): string;
  17003. /**
  17004. * Specifies if the material will require alpha blending
  17005. * @returns a boolean specifying if alpha blending is needed
  17006. */
  17007. needAlphaBlending(): boolean;
  17008. /**
  17009. * Specifies if this material should be rendered in alpha test mode
  17010. * @returns a boolean specifying if an alpha test is needed.
  17011. */
  17012. needAlphaTesting(): boolean;
  17013. private _checkUniform;
  17014. /**
  17015. * Set a texture in the shader.
  17016. * @param name Define the name of the uniform samplers as defined in the shader
  17017. * @param texture Define the texture to bind to this sampler
  17018. * @return the material itself allowing "fluent" like uniform updates
  17019. */
  17020. setTexture(name: string, texture: BaseTexture): ShaderMaterial;
  17021. /**
  17022. * Set a texture array in the shader.
  17023. * @param name Define the name of the uniform sampler array as defined in the shader
  17024. * @param textures Define the list of textures to bind to this sampler
  17025. * @return the material itself allowing "fluent" like uniform updates
  17026. */
  17027. setTextureArray(name: string, textures: BaseTexture[]): ShaderMaterial;
  17028. /**
  17029. * Set a float in the shader.
  17030. * @param name Define the name of the uniform as defined in the shader
  17031. * @param value Define the value to give to the uniform
  17032. * @return the material itself allowing "fluent" like uniform updates
  17033. */
  17034. setFloat(name: string, value: number): ShaderMaterial;
  17035. /**
  17036. * Set a int in the shader.
  17037. * @param name Define the name of the uniform as defined in the shader
  17038. * @param value Define the value to give to the uniform
  17039. * @return the material itself allowing "fluent" like uniform updates
  17040. */
  17041. setInt(name: string, value: number): ShaderMaterial;
  17042. /**
  17043. * Set an array of floats in the shader.
  17044. * @param name Define the name of the uniform as defined in the shader
  17045. * @param value Define the value to give to the uniform
  17046. * @return the material itself allowing "fluent" like uniform updates
  17047. */
  17048. setFloats(name: string, value: number[]): ShaderMaterial;
  17049. /**
  17050. * Set a vec3 in the shader from a Color3.
  17051. * @param name Define the name of the uniform as defined in the shader
  17052. * @param value Define the value to give to the uniform
  17053. * @return the material itself allowing "fluent" like uniform updates
  17054. */
  17055. setColor3(name: string, value: Color3): ShaderMaterial;
  17056. /**
  17057. * Set a vec3 array in the shader from a Color3 array.
  17058. * @param name Define the name of the uniform as defined in the shader
  17059. * @param value Define the value to give to the uniform
  17060. * @return the material itself allowing "fluent" like uniform updates
  17061. */
  17062. setColor3Array(name: string, value: Color3[]): ShaderMaterial;
  17063. /**
  17064. * Set a vec4 in the shader from a Color4.
  17065. * @param name Define the name of the uniform as defined in the shader
  17066. * @param value Define the value to give to the uniform
  17067. * @return the material itself allowing "fluent" like uniform updates
  17068. */
  17069. setColor4(name: string, value: Color4): ShaderMaterial;
  17070. /**
  17071. * Set a vec4 array in the shader from a Color4 array.
  17072. * @param name Define the name of the uniform as defined in the shader
  17073. * @param value Define the value to give to the uniform
  17074. * @return the material itself allowing "fluent" like uniform updates
  17075. */
  17076. setColor4Array(name: string, value: Color4[]): ShaderMaterial;
  17077. /**
  17078. * Set a vec2 in the shader from a Vector2.
  17079. * @param name Define the name of the uniform as defined in the shader
  17080. * @param value Define the value to give to the uniform
  17081. * @return the material itself allowing "fluent" like uniform updates
  17082. */
  17083. setVector2(name: string, value: Vector2): ShaderMaterial;
  17084. /**
  17085. * Set a vec3 in the shader from a Vector3.
  17086. * @param name Define the name of the uniform as defined in the shader
  17087. * @param value Define the value to give to the uniform
  17088. * @return the material itself allowing "fluent" like uniform updates
  17089. */
  17090. setVector3(name: string, value: Vector3): ShaderMaterial;
  17091. /**
  17092. * Set a vec4 in the shader from a Vector4.
  17093. * @param name Define the name of the uniform as defined in the shader
  17094. * @param value Define the value to give to the uniform
  17095. * @return the material itself allowing "fluent" like uniform updates
  17096. */
  17097. setVector4(name: string, value: Vector4): ShaderMaterial;
  17098. /**
  17099. * Set a mat4 in the shader from a Matrix.
  17100. * @param name Define the name of the uniform as defined in the shader
  17101. * @param value Define the value to give to the uniform
  17102. * @return the material itself allowing "fluent" like uniform updates
  17103. */
  17104. setMatrix(name: string, value: Matrix): ShaderMaterial;
  17105. /**
  17106. * Set a float32Array in the shader from a matrix array.
  17107. * @param name Define the name of the uniform as defined in the shader
  17108. * @param value Define the value to give to the uniform
  17109. * @return the material itself allowing "fluent" like uniform updates
  17110. */
  17111. setMatrices(name: string, value: Matrix[]): ShaderMaterial;
  17112. /**
  17113. * Set a mat3 in the shader from a Float32Array.
  17114. * @param name Define the name of the uniform as defined in the shader
  17115. * @param value Define the value to give to the uniform
  17116. * @return the material itself allowing "fluent" like uniform updates
  17117. */
  17118. setMatrix3x3(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  17119. /**
  17120. * Set a mat2 in the shader from a Float32Array.
  17121. * @param name Define the name of the uniform as defined in the shader
  17122. * @param value Define the value to give to the uniform
  17123. * @return the material itself allowing "fluent" like uniform updates
  17124. */
  17125. setMatrix2x2(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  17126. /**
  17127. * Set a vec2 array in the shader from a number array.
  17128. * @param name Define the name of the uniform as defined in the shader
  17129. * @param value Define the value to give to the uniform
  17130. * @return the material itself allowing "fluent" like uniform updates
  17131. */
  17132. setArray2(name: string, value: number[]): ShaderMaterial;
  17133. /**
  17134. * Set a vec3 array in the shader from a number array.
  17135. * @param name Define the name of the uniform as defined in the shader
  17136. * @param value Define the value to give to the uniform
  17137. * @return the material itself allowing "fluent" like uniform updates
  17138. */
  17139. setArray3(name: string, value: number[]): ShaderMaterial;
  17140. /**
  17141. * Set a vec4 array in the shader from a number array.
  17142. * @param name Define the name of the uniform as defined in the shader
  17143. * @param value Define the value to give to the uniform
  17144. * @return the material itself allowing "fluent" like uniform updates
  17145. */
  17146. setArray4(name: string, value: number[]): ShaderMaterial;
  17147. private _checkCache;
  17148. /**
  17149. * Specifies that the submesh is ready to be used
  17150. * @param mesh defines the mesh to check
  17151. * @param subMesh defines which submesh to check
  17152. * @param useInstances specifies that instances should be used
  17153. * @returns a boolean indicating that the submesh is ready or not
  17154. */
  17155. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  17156. /**
  17157. * Checks if the material is ready to render the requested mesh
  17158. * @param mesh Define the mesh to render
  17159. * @param useInstances Define whether or not the material is used with instances
  17160. * @returns true if ready, otherwise false
  17161. */
  17162. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  17163. /**
  17164. * Binds the world matrix to the material
  17165. * @param world defines the world transformation matrix
  17166. * @param effectOverride - If provided, use this effect instead of internal effect
  17167. */
  17168. bindOnlyWorldMatrix(world: Matrix, effectOverride?: Nullable<Effect>): void;
  17169. /**
  17170. * Binds the submesh to this material by preparing the effect and shader to draw
  17171. * @param world defines the world transformation matrix
  17172. * @param mesh defines the mesh containing the submesh
  17173. * @param subMesh defines the submesh to bind the material to
  17174. */
  17175. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  17176. /**
  17177. * Binds the material to the mesh
  17178. * @param world defines the world transformation matrix
  17179. * @param mesh defines the mesh to bind the material to
  17180. * @param effectOverride - If provided, use this effect instead of internal effect
  17181. */
  17182. bind(world: Matrix, mesh?: Mesh, effectOverride?: Nullable<Effect>): void;
  17183. protected _afterBind(mesh?: Mesh): void;
  17184. /**
  17185. * Gets the active textures from the material
  17186. * @returns an array of textures
  17187. */
  17188. getActiveTextures(): BaseTexture[];
  17189. /**
  17190. * Specifies if the material uses a texture
  17191. * @param texture defines the texture to check against the material
  17192. * @returns a boolean specifying if the material uses the texture
  17193. */
  17194. hasTexture(texture: BaseTexture): boolean;
  17195. /**
  17196. * Makes a duplicate of the material, and gives it a new name
  17197. * @param name defines the new name for the duplicated material
  17198. * @returns the cloned material
  17199. */
  17200. clone(name: string): ShaderMaterial;
  17201. /**
  17202. * Disposes the material
  17203. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  17204. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  17205. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  17206. */
  17207. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  17208. /**
  17209. * Serializes this material in a JSON representation
  17210. * @returns the serialized material object
  17211. */
  17212. serialize(): any;
  17213. /**
  17214. * Creates a shader material from parsed shader material data
  17215. * @param source defines the JSON represnetation of the material
  17216. * @param scene defines the hosting scene
  17217. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  17218. * @returns a new material
  17219. */
  17220. static Parse(source: any, scene: Scene, rootUrl: string): ShaderMaterial;
  17221. /**
  17222. * Creates a new ShaderMaterial from a snippet saved in a remote file
  17223. * @param name defines the name of the ShaderMaterial to create (can be null or empty to use the one from the json data)
  17224. * @param url defines the url to load from
  17225. * @param scene defines the hosting scene
  17226. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  17227. * @returns a promise that will resolve to the new ShaderMaterial
  17228. */
  17229. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  17230. /**
  17231. * Creates a ShaderMaterial from a snippet saved by the Inspector
  17232. * @param snippetId defines the snippet to load
  17233. * @param scene defines the hosting scene
  17234. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  17235. * @returns a promise that will resolve to the new ShaderMaterial
  17236. */
  17237. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  17238. }
  17239. }
  17240. declare module "babylonjs/Shaders/color.fragment" {
  17241. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  17242. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  17243. /** @hidden */
  17244. export var colorPixelShader: {
  17245. name: string;
  17246. shader: string;
  17247. };
  17248. }
  17249. declare module "babylonjs/Shaders/color.vertex" {
  17250. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  17251. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  17252. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  17253. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  17254. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  17255. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  17256. /** @hidden */
  17257. export var colorVertexShader: {
  17258. name: string;
  17259. shader: string;
  17260. };
  17261. }
  17262. declare module "babylonjs/Meshes/linesMesh" {
  17263. import { Nullable } from "babylonjs/types";
  17264. import { Scene } from "babylonjs/scene";
  17265. import { Color3 } from "babylonjs/Maths/math.color";
  17266. import { Node } from "babylonjs/node";
  17267. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17268. import { Mesh } from "babylonjs/Meshes/mesh";
  17269. import { InstancedMesh } from "babylonjs/Meshes/instancedMesh";
  17270. import { Effect } from "babylonjs/Materials/effect";
  17271. import { Material } from "babylonjs/Materials/material";
  17272. import "babylonjs/Shaders/color.fragment";
  17273. import "babylonjs/Shaders/color.vertex";
  17274. /**
  17275. * Line mesh
  17276. * @see https://doc.babylonjs.com/babylon101/parametric_shapes
  17277. */
  17278. export class LinesMesh extends Mesh {
  17279. /**
  17280. * If vertex color should be applied to the mesh
  17281. */
  17282. readonly useVertexColor?: boolean | undefined;
  17283. /**
  17284. * If vertex alpha should be applied to the mesh
  17285. */
  17286. readonly useVertexAlpha?: boolean | undefined;
  17287. /**
  17288. * Color of the line (Default: White)
  17289. */
  17290. color: Color3;
  17291. /**
  17292. * Alpha of the line (Default: 1)
  17293. */
  17294. alpha: number;
  17295. /**
  17296. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  17297. * This margin is expressed in world space coordinates, so its value may vary.
  17298. * Default value is 0.1
  17299. */
  17300. intersectionThreshold: number;
  17301. private _colorShader;
  17302. private color4;
  17303. /**
  17304. * Creates a new LinesMesh
  17305. * @param name defines the name
  17306. * @param scene defines the hosting scene
  17307. * @param parent defines the parent mesh if any
  17308. * @param source defines the optional source LinesMesh used to clone data from
  17309. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  17310. * When false, achieved by calling a clone(), also passing False.
  17311. * This will make creation of children, recursive.
  17312. * @param useVertexColor defines if this LinesMesh supports vertex color
  17313. * @param useVertexAlpha defines if this LinesMesh supports vertex alpha
  17314. */
  17315. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<LinesMesh>, doNotCloneChildren?: boolean,
  17316. /**
  17317. * If vertex color should be applied to the mesh
  17318. */
  17319. useVertexColor?: boolean | undefined,
  17320. /**
  17321. * If vertex alpha should be applied to the mesh
  17322. */
  17323. useVertexAlpha?: boolean | undefined);
  17324. private _addClipPlaneDefine;
  17325. private _removeClipPlaneDefine;
  17326. isReady(): boolean;
  17327. /**
  17328. * Returns the string "LineMesh"
  17329. */
  17330. getClassName(): string;
  17331. /**
  17332. * @hidden
  17333. */
  17334. get material(): Material;
  17335. /**
  17336. * @hidden
  17337. */
  17338. set material(value: Material);
  17339. /**
  17340. * @hidden
  17341. */
  17342. get checkCollisions(): boolean;
  17343. /** @hidden */
  17344. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  17345. /** @hidden */
  17346. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  17347. /**
  17348. * Disposes of the line mesh
  17349. * @param doNotRecurse If children should be disposed
  17350. */
  17351. dispose(doNotRecurse?: boolean): void;
  17352. /**
  17353. * Returns a new LineMesh object cloned from the current one.
  17354. */
  17355. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): LinesMesh;
  17356. /**
  17357. * Creates a new InstancedLinesMesh object from the mesh model.
  17358. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  17359. * @param name defines the name of the new instance
  17360. * @returns a new InstancedLinesMesh
  17361. */
  17362. createInstance(name: string): InstancedLinesMesh;
  17363. }
  17364. /**
  17365. * Creates an instance based on a source LinesMesh
  17366. */
  17367. export class InstancedLinesMesh extends InstancedMesh {
  17368. /**
  17369. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  17370. * This margin is expressed in world space coordinates, so its value may vary.
  17371. * Initilized with the intersectionThreshold value of the source LinesMesh
  17372. */
  17373. intersectionThreshold: number;
  17374. constructor(name: string, source: LinesMesh);
  17375. /**
  17376. * Returns the string "InstancedLinesMesh".
  17377. */
  17378. getClassName(): string;
  17379. }
  17380. }
  17381. declare module "babylonjs/Shaders/line.fragment" {
  17382. /** @hidden */
  17383. export var linePixelShader: {
  17384. name: string;
  17385. shader: string;
  17386. };
  17387. }
  17388. declare module "babylonjs/Shaders/line.vertex" {
  17389. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  17390. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  17391. /** @hidden */
  17392. export var lineVertexShader: {
  17393. name: string;
  17394. shader: string;
  17395. };
  17396. }
  17397. declare module "babylonjs/Rendering/edgesRenderer" {
  17398. import { Nullable } from "babylonjs/types";
  17399. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  17400. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17401. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  17402. import { IDisposable } from "babylonjs/scene";
  17403. import { ShaderMaterial } from "babylonjs/Materials/shaderMaterial";
  17404. import "babylonjs/Shaders/line.fragment";
  17405. import "babylonjs/Shaders/line.vertex";
  17406. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  17407. import { SmartArray } from "babylonjs/Misc/smartArray";
  17408. module "babylonjs/scene" {
  17409. interface Scene {
  17410. /** @hidden */
  17411. _edgeRenderLineShader: Nullable<ShaderMaterial>;
  17412. }
  17413. }
  17414. module "babylonjs/Meshes/abstractMesh" {
  17415. interface AbstractMesh {
  17416. /**
  17417. * Gets the edgesRenderer associated with the mesh
  17418. */
  17419. edgesRenderer: Nullable<EdgesRenderer>;
  17420. }
  17421. }
  17422. module "babylonjs/Meshes/linesMesh" {
  17423. interface LinesMesh {
  17424. /**
  17425. * Enables the edge rendering mode on the mesh.
  17426. * This mode makes the mesh edges visible
  17427. * @param epsilon defines the maximal distance between two angles to detect a face
  17428. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  17429. * @returns the currentAbstractMesh
  17430. * @see https://www.babylonjs-playground.com/#19O9TU#0
  17431. */
  17432. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  17433. }
  17434. }
  17435. module "babylonjs/Meshes/linesMesh" {
  17436. interface InstancedLinesMesh {
  17437. /**
  17438. * Enables the edge rendering mode on the mesh.
  17439. * This mode makes the mesh edges visible
  17440. * @param epsilon defines the maximal distance between two angles to detect a face
  17441. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  17442. * @returns the current InstancedLinesMesh
  17443. * @see https://www.babylonjs-playground.com/#19O9TU#0
  17444. */
  17445. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): InstancedLinesMesh;
  17446. }
  17447. }
  17448. /**
  17449. * Defines the minimum contract an Edges renderer should follow.
  17450. */
  17451. export interface IEdgesRenderer extends IDisposable {
  17452. /**
  17453. * Gets or sets a boolean indicating if the edgesRenderer is active
  17454. */
  17455. isEnabled: boolean;
  17456. /**
  17457. * Renders the edges of the attached mesh,
  17458. */
  17459. render(): void;
  17460. /**
  17461. * Checks wether or not the edges renderer is ready to render.
  17462. * @return true if ready, otherwise false.
  17463. */
  17464. isReady(): boolean;
  17465. /**
  17466. * List of instances to render in case the source mesh has instances
  17467. */
  17468. customInstances: SmartArray<Matrix>;
  17469. }
  17470. /**
  17471. * Defines the additional options of the edges renderer
  17472. */
  17473. export interface IEdgesRendererOptions {
  17474. /**
  17475. * Gets or sets a boolean indicating that the alternate edge finder algorithm must be used
  17476. * If not defined, the default value is true
  17477. */
  17478. useAlternateEdgeFinder?: boolean;
  17479. /**
  17480. * Gets or sets a boolean indicating that the vertex merger fast processing must be used.
  17481. * If not defined, the default value is true.
  17482. * You should normally leave it undefined (or set it to true), except if you see some artifacts in the edges rendering (can happen with complex geometries)
  17483. * This option is used only if useAlternateEdgeFinder = true
  17484. */
  17485. useFastVertexMerger?: boolean;
  17486. /**
  17487. * During edges processing, the vertices are merged if they are close enough: epsilonVertexMerge is the limit whithin which vertices are considered to be equal.
  17488. * The default value is 1e-6
  17489. * This option is used only if useAlternateEdgeFinder = true
  17490. */
  17491. epsilonVertexMerge?: number;
  17492. /**
  17493. * Gets or sets a boolean indicating that tessellation should be applied before finding the edges. You may need to activate this option if your geometry is a bit
  17494. * unusual, like having a vertex of a triangle in-between two vertices of an edge of another triangle. It happens often when using CSG to construct meshes.
  17495. * This option is used only if useAlternateEdgeFinder = true
  17496. */
  17497. applyTessellation?: boolean;
  17498. /**
  17499. * The limit under which 3 vertices are considered to be aligned. 3 vertices PQR are considered aligned if distance(PQ) + distance(QR) - distance(PR) < epsilonVertexAligned
  17500. * The default value is 1e-6
  17501. * This option is used only if useAlternateEdgeFinder = true
  17502. */
  17503. epsilonVertexAligned?: number;
  17504. }
  17505. /**
  17506. * This class is used to generate edges of the mesh that could then easily be rendered in a scene.
  17507. */
  17508. export class EdgesRenderer implements IEdgesRenderer {
  17509. /**
  17510. * Define the size of the edges with an orthographic camera
  17511. */
  17512. edgesWidthScalerForOrthographic: number;
  17513. /**
  17514. * Define the size of the edges with a perspective camera
  17515. */
  17516. edgesWidthScalerForPerspective: number;
  17517. protected _source: AbstractMesh;
  17518. protected _linesPositions: number[];
  17519. protected _linesNormals: number[];
  17520. protected _linesIndices: number[];
  17521. protected _epsilon: number;
  17522. protected _indicesCount: number;
  17523. protected _lineShader: ShaderMaterial;
  17524. protected _ib: DataBuffer;
  17525. protected _buffers: {
  17526. [key: string]: Nullable<VertexBuffer>;
  17527. };
  17528. protected _buffersForInstances: {
  17529. [key: string]: Nullable<VertexBuffer>;
  17530. };
  17531. protected _checkVerticesInsteadOfIndices: boolean;
  17532. protected _options: Nullable<IEdgesRendererOptions>;
  17533. private _meshRebuildObserver;
  17534. private _meshDisposeObserver;
  17535. /** Gets or sets a boolean indicating if the edgesRenderer is active */
  17536. isEnabled: boolean;
  17537. /**
  17538. * List of instances to render in case the source mesh has instances
  17539. */
  17540. customInstances: SmartArray<Matrix>;
  17541. private static GetShader;
  17542. /**
  17543. * Creates an instance of the EdgesRenderer. It is primarily use to display edges of a mesh.
  17544. * Beware when you use this class with complex objects as the adjacencies computation can be really long
  17545. * @param source Mesh used to create edges
  17546. * @param epsilon sum of angles in adjacency to check for edge
  17547. * @param checkVerticesInsteadOfIndices bases the edges detection on vertices vs indices. Note that this parameter is not used if options.useAlternateEdgeFinder = true
  17548. * @param generateEdgesLines - should generate Lines or only prepare resources.
  17549. * @param options The options to apply when generating the edges
  17550. */
  17551. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean, generateEdgesLines?: boolean, options?: IEdgesRendererOptions);
  17552. protected _prepareRessources(): void;
  17553. /** @hidden */
  17554. _rebuild(): void;
  17555. /**
  17556. * Releases the required resources for the edges renderer
  17557. */
  17558. dispose(): void;
  17559. protected _processEdgeForAdjacencies(pa: number, pb: number, p0: number, p1: number, p2: number): number;
  17560. protected _processEdgeForAdjacenciesWithVertices(pa: Vector3, pb: Vector3, p0: Vector3, p1: Vector3, p2: Vector3): number;
  17561. /**
  17562. * Checks if the pair of p0 and p1 is en edge
  17563. * @param faceIndex
  17564. * @param edge
  17565. * @param faceNormals
  17566. * @param p0
  17567. * @param p1
  17568. * @private
  17569. */
  17570. protected _checkEdge(faceIndex: number, edge: number, faceNormals: Array<Vector3>, p0: Vector3, p1: Vector3): void;
  17571. /**
  17572. * push line into the position, normal and index buffer
  17573. * @protected
  17574. */
  17575. protected createLine(p0: Vector3, p1: Vector3, offset: number): void;
  17576. /**
  17577. * See https://playground.babylonjs.com/#R3JR6V#1 for a visual display of the algorithm
  17578. */
  17579. private _tessellateTriangle;
  17580. private _generateEdgesLinesAlternate;
  17581. /**
  17582. * Generates lines edges from adjacencjes
  17583. * @private
  17584. */
  17585. _generateEdgesLines(): void;
  17586. /**
  17587. * Checks wether or not the edges renderer is ready to render.
  17588. * @return true if ready, otherwise false.
  17589. */
  17590. isReady(): boolean;
  17591. /**
  17592. * Renders the edges of the attached mesh,
  17593. */
  17594. render(): void;
  17595. }
  17596. /**
  17597. * LineEdgesRenderer for LineMeshes to remove unnecessary triangulation
  17598. */
  17599. export class LineEdgesRenderer extends EdgesRenderer {
  17600. /**
  17601. * This constructor turns off auto generating edges line in Edges Renderer to make it here.
  17602. * @param source LineMesh used to generate edges
  17603. * @param epsilon not important (specified angle for edge detection)
  17604. * @param checkVerticesInsteadOfIndices not important for LineMesh
  17605. */
  17606. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean);
  17607. /**
  17608. * Generate edges for each line in LinesMesh. Every Line should be rendered as edge.
  17609. */
  17610. _generateEdgesLines(): void;
  17611. }
  17612. }
  17613. declare module "babylonjs/Rendering/renderingGroup" {
  17614. import { SmartArray, SmartArrayNoDuplicate } from "babylonjs/Misc/smartArray";
  17615. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17616. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17617. import { Nullable } from "babylonjs/types";
  17618. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  17619. import { IEdgesRenderer } from "babylonjs/Rendering/edgesRenderer";
  17620. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  17621. import { Material } from "babylonjs/Materials/material";
  17622. import { Scene } from "babylonjs/scene";
  17623. /**
  17624. * This represents the object necessary to create a rendering group.
  17625. * This is exclusively used and created by the rendering manager.
  17626. * To modify the behavior, you use the available helpers in your scene or meshes.
  17627. * @hidden
  17628. */
  17629. export class RenderingGroup {
  17630. index: number;
  17631. private static _zeroVector;
  17632. private _scene;
  17633. private _opaqueSubMeshes;
  17634. private _transparentSubMeshes;
  17635. private _alphaTestSubMeshes;
  17636. private _depthOnlySubMeshes;
  17637. private _particleSystems;
  17638. private _spriteManagers;
  17639. private _opaqueSortCompareFn;
  17640. private _alphaTestSortCompareFn;
  17641. private _transparentSortCompareFn;
  17642. private _renderOpaque;
  17643. private _renderAlphaTest;
  17644. private _renderTransparent;
  17645. /** @hidden */
  17646. _edgesRenderers: SmartArrayNoDuplicate<IEdgesRenderer>;
  17647. onBeforeTransparentRendering: () => void;
  17648. /**
  17649. * Set the opaque sort comparison function.
  17650. * If null the sub meshes will be render in the order they were created
  17651. */
  17652. set opaqueSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  17653. /**
  17654. * Set the alpha test sort comparison function.
  17655. * If null the sub meshes will be render in the order they were created
  17656. */
  17657. set alphaTestSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  17658. /**
  17659. * Set the transparent sort comparison function.
  17660. * If null the sub meshes will be render in the order they were created
  17661. */
  17662. set transparentSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  17663. /**
  17664. * Creates a new rendering group.
  17665. * @param index The rendering group index
  17666. * @param opaqueSortCompareFn The opaque sort comparison function. If null no order is applied
  17667. * @param alphaTestSortCompareFn The alpha test sort comparison function. If null no order is applied
  17668. * @param transparentSortCompareFn The transparent sort comparison function. If null back to front + alpha index sort is applied
  17669. */
  17670. constructor(index: number, scene: Scene, opaqueSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>, alphaTestSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>, transparentSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>);
  17671. /**
  17672. * Render all the sub meshes contained in the group.
  17673. * @param customRenderFunction Used to override the default render behaviour of the group.
  17674. * @returns true if rendered some submeshes.
  17675. */
  17676. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, renderSprites: boolean, renderParticles: boolean, activeMeshes: Nullable<AbstractMesh[]>): void;
  17677. /**
  17678. * Renders the opaque submeshes in the order from the opaqueSortCompareFn.
  17679. * @param subMeshes The submeshes to render
  17680. */
  17681. private renderOpaqueSorted;
  17682. /**
  17683. * Renders the opaque submeshes in the order from the alphatestSortCompareFn.
  17684. * @param subMeshes The submeshes to render
  17685. */
  17686. private renderAlphaTestSorted;
  17687. /**
  17688. * Renders the opaque submeshes in the order from the transparentSortCompareFn.
  17689. * @param subMeshes The submeshes to render
  17690. */
  17691. private renderTransparentSorted;
  17692. /**
  17693. * Renders the submeshes in a specified order.
  17694. * @param subMeshes The submeshes to sort before render
  17695. * @param sortCompareFn The comparison function use to sort
  17696. * @param cameraPosition The camera position use to preprocess the submeshes to help sorting
  17697. * @param transparent Specifies to activate blending if true
  17698. */
  17699. private static renderSorted;
  17700. /**
  17701. * Renders the submeshes in the order they were dispatched (no sort applied).
  17702. * @param subMeshes The submeshes to render
  17703. */
  17704. private static renderUnsorted;
  17705. /**
  17706. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  17707. * are rendered back to front if in the same alpha index.
  17708. *
  17709. * @param a The first submesh
  17710. * @param b The second submesh
  17711. * @returns The result of the comparison
  17712. */
  17713. static defaultTransparentSortCompare(a: SubMesh, b: SubMesh): number;
  17714. /**
  17715. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  17716. * are rendered back to front.
  17717. *
  17718. * @param a The first submesh
  17719. * @param b The second submesh
  17720. * @returns The result of the comparison
  17721. */
  17722. static backToFrontSortCompare(a: SubMesh, b: SubMesh): number;
  17723. /**
  17724. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  17725. * are rendered front to back (prevent overdraw).
  17726. *
  17727. * @param a The first submesh
  17728. * @param b The second submesh
  17729. * @returns The result of the comparison
  17730. */
  17731. static frontToBackSortCompare(a: SubMesh, b: SubMesh): number;
  17732. /**
  17733. * Resets the different lists of submeshes to prepare a new frame.
  17734. */
  17735. prepare(): void;
  17736. dispose(): void;
  17737. /**
  17738. * Inserts the submesh in its correct queue depending on its material.
  17739. * @param subMesh The submesh to dispatch
  17740. * @param [mesh] Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  17741. * @param [material] Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  17742. */
  17743. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  17744. dispatchSprites(spriteManager: ISpriteManager): void;
  17745. dispatchParticles(particleSystem: IParticleSystem): void;
  17746. private _renderParticles;
  17747. private _renderSprites;
  17748. }
  17749. }
  17750. declare module "babylonjs/Rendering/renderingManager" {
  17751. import { Nullable } from "babylonjs/types";
  17752. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17753. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17754. import { SmartArray } from "babylonjs/Misc/smartArray";
  17755. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  17756. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  17757. import { Material } from "babylonjs/Materials/material";
  17758. import { Scene } from "babylonjs/scene";
  17759. import { Camera } from "babylonjs/Cameras/camera";
  17760. /**
  17761. * Interface describing the different options available in the rendering manager
  17762. * regarding Auto Clear between groups.
  17763. */
  17764. export interface IRenderingManagerAutoClearSetup {
  17765. /**
  17766. * Defines whether or not autoclear is enable.
  17767. */
  17768. autoClear: boolean;
  17769. /**
  17770. * Defines whether or not to autoclear the depth buffer.
  17771. */
  17772. depth: boolean;
  17773. /**
  17774. * Defines whether or not to autoclear the stencil buffer.
  17775. */
  17776. stencil: boolean;
  17777. }
  17778. /**
  17779. * This class is used by the onRenderingGroupObservable
  17780. */
  17781. export class RenderingGroupInfo {
  17782. /**
  17783. * The Scene that being rendered
  17784. */
  17785. scene: Scene;
  17786. /**
  17787. * The camera currently used for the rendering pass
  17788. */
  17789. camera: Nullable<Camera>;
  17790. /**
  17791. * The ID of the renderingGroup being processed
  17792. */
  17793. renderingGroupId: number;
  17794. }
  17795. /**
  17796. * This is the manager responsible of all the rendering for meshes sprites and particles.
  17797. * It is enable to manage the different groups as well as the different necessary sort functions.
  17798. * This should not be used directly aside of the few static configurations
  17799. */
  17800. export class RenderingManager {
  17801. /**
  17802. * The max id used for rendering groups (not included)
  17803. */
  17804. static MAX_RENDERINGGROUPS: number;
  17805. /**
  17806. * The min id used for rendering groups (included)
  17807. */
  17808. static MIN_RENDERINGGROUPS: number;
  17809. /**
  17810. * Used to globally prevent autoclearing scenes.
  17811. */
  17812. static AUTOCLEAR: boolean;
  17813. /**
  17814. * @hidden
  17815. */
  17816. _useSceneAutoClearSetup: boolean;
  17817. private _scene;
  17818. private _renderingGroups;
  17819. private _depthStencilBufferAlreadyCleaned;
  17820. private _autoClearDepthStencil;
  17821. private _customOpaqueSortCompareFn;
  17822. private _customAlphaTestSortCompareFn;
  17823. private _customTransparentSortCompareFn;
  17824. private _renderingGroupInfo;
  17825. /**
  17826. * Instantiates a new rendering group for a particular scene
  17827. * @param scene Defines the scene the groups belongs to
  17828. */
  17829. constructor(scene: Scene);
  17830. private _clearDepthStencilBuffer;
  17831. /**
  17832. * Renders the entire managed groups. This is used by the scene or the different rennder targets.
  17833. * @hidden
  17834. */
  17835. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, activeMeshes: Nullable<AbstractMesh[]>, renderParticles: boolean, renderSprites: boolean): void;
  17836. /**
  17837. * Resets the different information of the group to prepare a new frame
  17838. * @hidden
  17839. */
  17840. reset(): void;
  17841. /**
  17842. * Dispose and release the group and its associated resources.
  17843. * @hidden
  17844. */
  17845. dispose(): void;
  17846. /**
  17847. * Clear the info related to rendering groups preventing retention points during dispose.
  17848. */
  17849. freeRenderingGroups(): void;
  17850. private _prepareRenderingGroup;
  17851. /**
  17852. * Add a sprite manager to the rendering manager in order to render it this frame.
  17853. * @param spriteManager Define the sprite manager to render
  17854. */
  17855. dispatchSprites(spriteManager: ISpriteManager): void;
  17856. /**
  17857. * Add a particle system to the rendering manager in order to render it this frame.
  17858. * @param particleSystem Define the particle system to render
  17859. */
  17860. dispatchParticles(particleSystem: IParticleSystem): void;
  17861. /**
  17862. * Add a submesh to the manager in order to render it this frame
  17863. * @param subMesh The submesh to dispatch
  17864. * @param mesh Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  17865. * @param material Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  17866. */
  17867. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  17868. /**
  17869. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  17870. * This allowed control for front to back rendering or reversly depending of the special needs.
  17871. *
  17872. * @param renderingGroupId The rendering group id corresponding to its index
  17873. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  17874. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  17875. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  17876. */
  17877. setRenderingOrder(renderingGroupId: number, opaqueSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>, alphaTestSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>, transparentSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>): void;
  17878. /**
  17879. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  17880. *
  17881. * @param renderingGroupId The rendering group id corresponding to its index
  17882. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  17883. * @param depth Automatically clears depth between groups if true and autoClear is true.
  17884. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  17885. */
  17886. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  17887. /**
  17888. * Gets the current auto clear configuration for one rendering group of the rendering
  17889. * manager.
  17890. * @param index the rendering group index to get the information for
  17891. * @returns The auto clear setup for the requested rendering group
  17892. */
  17893. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  17894. }
  17895. }
  17896. declare module "babylonjs/Lights/Shadows/shadowGenerator" {
  17897. import { SmartArray } from "babylonjs/Misc/smartArray";
  17898. import { Nullable } from "babylonjs/types";
  17899. import { Scene } from "babylonjs/scene";
  17900. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  17901. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17902. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17903. import { Mesh } from "babylonjs/Meshes/mesh";
  17904. import { IShadowLight } from "babylonjs/Lights/shadowLight";
  17905. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  17906. import { Effect } from "babylonjs/Materials/effect";
  17907. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  17908. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  17909. import "babylonjs/Shaders/shadowMap.fragment";
  17910. import "babylonjs/Shaders/shadowMap.vertex";
  17911. import "babylonjs/Shaders/depthBoxBlur.fragment";
  17912. import "babylonjs/Shaders/ShadersInclude/shadowMapFragmentSoftTransparentShadow";
  17913. import { Observable } from "babylonjs/Misc/observable";
  17914. /**
  17915. * Defines the options associated with the creation of a custom shader for a shadow generator.
  17916. */
  17917. export interface ICustomShaderOptions {
  17918. /**
  17919. * Gets or sets the custom shader name to use
  17920. */
  17921. shaderName: string;
  17922. /**
  17923. * The list of attribute names used in the shader
  17924. */
  17925. attributes?: string[];
  17926. /**
  17927. * The list of unifrom names used in the shader
  17928. */
  17929. uniforms?: string[];
  17930. /**
  17931. * The list of sampler names used in the shader
  17932. */
  17933. samplers?: string[];
  17934. /**
  17935. * The list of defines used in the shader
  17936. */
  17937. defines?: string[];
  17938. }
  17939. /**
  17940. * Interface to implement to create a shadow generator compatible with BJS.
  17941. */
  17942. export interface IShadowGenerator {
  17943. /** Gets or set the id of the shadow generator. It will be the one from the light if not defined */
  17944. id: string;
  17945. /**
  17946. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  17947. * @returns The render target texture if present otherwise, null
  17948. */
  17949. getShadowMap(): Nullable<RenderTargetTexture>;
  17950. /**
  17951. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  17952. * @param subMesh The submesh we want to render in the shadow map
  17953. * @param useInstances Defines wether will draw in the map using instances
  17954. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  17955. * @returns true if ready otherwise, false
  17956. */
  17957. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  17958. /**
  17959. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  17960. * @param defines Defines of the material we want to update
  17961. * @param lightIndex Index of the light in the enabled light list of the material
  17962. */
  17963. prepareDefines(defines: MaterialDefines, lightIndex: number): void;
  17964. /**
  17965. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  17966. * defined in the generator but impacting the effect).
  17967. * It implies the unifroms available on the materials are the standard BJS ones.
  17968. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  17969. * @param effect The effect we are binfing the information for
  17970. */
  17971. bindShadowLight(lightIndex: string, effect: Effect): void;
  17972. /**
  17973. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  17974. * (eq to shadow prjection matrix * light transform matrix)
  17975. * @returns The transform matrix used to create the shadow map
  17976. */
  17977. getTransformMatrix(): Matrix;
  17978. /**
  17979. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  17980. * Cube and 2D textures for instance.
  17981. */
  17982. recreateShadowMap(): void;
  17983. /**
  17984. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  17985. * @param onCompiled Callback triggered at the and of the effects compilation
  17986. * @param options Sets of optional options forcing the compilation with different modes
  17987. */
  17988. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  17989. useInstances: boolean;
  17990. }>): void;
  17991. /**
  17992. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  17993. * @param options Sets of optional options forcing the compilation with different modes
  17994. * @returns A promise that resolves when the compilation completes
  17995. */
  17996. forceCompilationAsync(options?: Partial<{
  17997. useInstances: boolean;
  17998. }>): Promise<void>;
  17999. /**
  18000. * Serializes the shadow generator setup to a json object.
  18001. * @returns The serialized JSON object
  18002. */
  18003. serialize(): any;
  18004. /**
  18005. * Disposes the Shadow map and related Textures and effects.
  18006. */
  18007. dispose(): void;
  18008. }
  18009. /**
  18010. * Default implementation IShadowGenerator.
  18011. * This is the main object responsible of generating shadows in the framework.
  18012. * Documentation: https://doc.babylonjs.com/babylon101/shadows
  18013. */
  18014. export class ShadowGenerator implements IShadowGenerator {
  18015. /**
  18016. * Name of the shadow generator class
  18017. */
  18018. static CLASSNAME: string;
  18019. /**
  18020. * Shadow generator mode None: no filtering applied.
  18021. */
  18022. static readonly FILTER_NONE: number;
  18023. /**
  18024. * Shadow generator mode ESM: Exponential Shadow Mapping.
  18025. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  18026. */
  18027. static readonly FILTER_EXPONENTIALSHADOWMAP: number;
  18028. /**
  18029. * Shadow generator mode Poisson Sampling: Percentage Closer Filtering.
  18030. * (Multiple Tap around evenly distributed around the pixel are used to evaluate the shadow strength)
  18031. */
  18032. static readonly FILTER_POISSONSAMPLING: number;
  18033. /**
  18034. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping.
  18035. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  18036. */
  18037. static readonly FILTER_BLUREXPONENTIALSHADOWMAP: number;
  18038. /**
  18039. * Shadow generator mode ESM: Exponential Shadow Mapping using the inverse of the exponential preventing
  18040. * edge artifacts on steep falloff.
  18041. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  18042. */
  18043. static readonly FILTER_CLOSEEXPONENTIALSHADOWMAP: number;
  18044. /**
  18045. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping using the inverse of the exponential preventing
  18046. * edge artifacts on steep falloff.
  18047. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  18048. */
  18049. static readonly FILTER_BLURCLOSEEXPONENTIALSHADOWMAP: number;
  18050. /**
  18051. * Shadow generator mode PCF: Percentage Closer Filtering
  18052. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  18053. * (https://developer.nvidia.com/gpugems/GPUGems/gpugems_ch11.html)
  18054. */
  18055. static readonly FILTER_PCF: number;
  18056. /**
  18057. * Shadow generator mode PCSS: Percentage Closering Soft Shadow.
  18058. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  18059. * Contact Hardening
  18060. */
  18061. static readonly FILTER_PCSS: number;
  18062. /**
  18063. * Reserved for PCF and PCSS
  18064. * Highest Quality.
  18065. *
  18066. * Execute PCF on a 5*5 kernel improving a lot the shadow aliasing artifacts.
  18067. *
  18068. * Execute PCSS with 32 taps blocker search and 64 taps PCF.
  18069. */
  18070. static readonly QUALITY_HIGH: number;
  18071. /**
  18072. * Reserved for PCF and PCSS
  18073. * Good tradeoff for quality/perf cross devices
  18074. *
  18075. * Execute PCF on a 3*3 kernel.
  18076. *
  18077. * Execute PCSS with 16 taps blocker search and 32 taps PCF.
  18078. */
  18079. static readonly QUALITY_MEDIUM: number;
  18080. /**
  18081. * Reserved for PCF and PCSS
  18082. * The lowest quality but the fastest.
  18083. *
  18084. * Execute PCF on a 1*1 kernel.
  18085. *
  18086. * Execute PCSS with 16 taps blocker search and 16 taps PCF.
  18087. */
  18088. static readonly QUALITY_LOW: number;
  18089. /** Gets or set the id of the shadow generator. It will be the one from the light if not defined */
  18090. id: string;
  18091. /** Gets or sets the custom shader name to use */
  18092. customShaderOptions: ICustomShaderOptions;
  18093. /**
  18094. * Observable triggered before the shadow is rendered. Can be used to update internal effect state
  18095. */
  18096. onBeforeShadowMapRenderObservable: Observable<Effect>;
  18097. /**
  18098. * Observable triggered after the shadow is rendered. Can be used to restore internal effect state
  18099. */
  18100. onAfterShadowMapRenderObservable: Observable<Effect>;
  18101. /**
  18102. * Observable triggered before a mesh is rendered in the shadow map.
  18103. * Can be used to update internal effect state (that you can get from the onBeforeShadowMapRenderObservable)
  18104. */
  18105. onBeforeShadowMapRenderMeshObservable: Observable<Mesh>;
  18106. /**
  18107. * Observable triggered after a mesh is rendered in the shadow map.
  18108. * Can be used to update internal effect state (that you can get from the onAfterShadowMapRenderObservable)
  18109. */
  18110. onAfterShadowMapRenderMeshObservable: Observable<Mesh>;
  18111. protected _bias: number;
  18112. /**
  18113. * Gets the bias: offset applied on the depth preventing acnea (in light direction).
  18114. */
  18115. get bias(): number;
  18116. /**
  18117. * Sets the bias: offset applied on the depth preventing acnea (in light direction).
  18118. */
  18119. set bias(bias: number);
  18120. protected _normalBias: number;
  18121. /**
  18122. * Gets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  18123. */
  18124. get normalBias(): number;
  18125. /**
  18126. * Sets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  18127. */
  18128. set normalBias(normalBias: number);
  18129. protected _blurBoxOffset: number;
  18130. /**
  18131. * Gets the blur box offset: offset applied during the blur pass.
  18132. * Only useful if useKernelBlur = false
  18133. */
  18134. get blurBoxOffset(): number;
  18135. /**
  18136. * Sets the blur box offset: offset applied during the blur pass.
  18137. * Only useful if useKernelBlur = false
  18138. */
  18139. set blurBoxOffset(value: number);
  18140. protected _blurScale: number;
  18141. /**
  18142. * Gets the blur scale: scale of the blurred texture compared to the main shadow map.
  18143. * 2 means half of the size.
  18144. */
  18145. get blurScale(): number;
  18146. /**
  18147. * Sets the blur scale: scale of the blurred texture compared to the main shadow map.
  18148. * 2 means half of the size.
  18149. */
  18150. set blurScale(value: number);
  18151. protected _blurKernel: number;
  18152. /**
  18153. * Gets the blur kernel: kernel size of the blur pass.
  18154. * Only useful if useKernelBlur = true
  18155. */
  18156. get blurKernel(): number;
  18157. /**
  18158. * Sets the blur kernel: kernel size of the blur pass.
  18159. * Only useful if useKernelBlur = true
  18160. */
  18161. set blurKernel(value: number);
  18162. protected _useKernelBlur: boolean;
  18163. /**
  18164. * Gets whether the blur pass is a kernel blur (if true) or box blur.
  18165. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  18166. */
  18167. get useKernelBlur(): boolean;
  18168. /**
  18169. * Sets whether the blur pass is a kernel blur (if true) or box blur.
  18170. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  18171. */
  18172. set useKernelBlur(value: boolean);
  18173. protected _depthScale: number;
  18174. /**
  18175. * Gets the depth scale used in ESM mode.
  18176. */
  18177. get depthScale(): number;
  18178. /**
  18179. * Sets the depth scale used in ESM mode.
  18180. * This can override the scale stored on the light.
  18181. */
  18182. set depthScale(value: number);
  18183. protected _validateFilter(filter: number): number;
  18184. protected _filter: number;
  18185. /**
  18186. * Gets the current mode of the shadow generator (normal, PCF, ESM...).
  18187. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  18188. */
  18189. get filter(): number;
  18190. /**
  18191. * Sets the current mode of the shadow generator (normal, PCF, ESM...).
  18192. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  18193. */
  18194. set filter(value: number);
  18195. /**
  18196. * Gets if the current filter is set to Poisson Sampling.
  18197. */
  18198. get usePoissonSampling(): boolean;
  18199. /**
  18200. * Sets the current filter to Poisson Sampling.
  18201. */
  18202. set usePoissonSampling(value: boolean);
  18203. /**
  18204. * Gets if the current filter is set to ESM.
  18205. */
  18206. get useExponentialShadowMap(): boolean;
  18207. /**
  18208. * Sets the current filter is to ESM.
  18209. */
  18210. set useExponentialShadowMap(value: boolean);
  18211. /**
  18212. * Gets if the current filter is set to filtered ESM.
  18213. */
  18214. get useBlurExponentialShadowMap(): boolean;
  18215. /**
  18216. * Gets if the current filter is set to filtered ESM.
  18217. */
  18218. set useBlurExponentialShadowMap(value: boolean);
  18219. /**
  18220. * Gets if the current filter is set to "close ESM" (using the inverse of the
  18221. * exponential to prevent steep falloff artifacts).
  18222. */
  18223. get useCloseExponentialShadowMap(): boolean;
  18224. /**
  18225. * Sets the current filter to "close ESM" (using the inverse of the
  18226. * exponential to prevent steep falloff artifacts).
  18227. */
  18228. set useCloseExponentialShadowMap(value: boolean);
  18229. /**
  18230. * Gets if the current filter is set to filtered "close ESM" (using the inverse of the
  18231. * exponential to prevent steep falloff artifacts).
  18232. */
  18233. get useBlurCloseExponentialShadowMap(): boolean;
  18234. /**
  18235. * Sets the current filter to filtered "close ESM" (using the inverse of the
  18236. * exponential to prevent steep falloff artifacts).
  18237. */
  18238. set useBlurCloseExponentialShadowMap(value: boolean);
  18239. /**
  18240. * Gets if the current filter is set to "PCF" (percentage closer filtering).
  18241. */
  18242. get usePercentageCloserFiltering(): boolean;
  18243. /**
  18244. * Sets the current filter to "PCF" (percentage closer filtering).
  18245. */
  18246. set usePercentageCloserFiltering(value: boolean);
  18247. protected _filteringQuality: number;
  18248. /**
  18249. * Gets the PCF or PCSS Quality.
  18250. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  18251. */
  18252. get filteringQuality(): number;
  18253. /**
  18254. * Sets the PCF or PCSS Quality.
  18255. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  18256. */
  18257. set filteringQuality(filteringQuality: number);
  18258. /**
  18259. * Gets if the current filter is set to "PCSS" (contact hardening).
  18260. */
  18261. get useContactHardeningShadow(): boolean;
  18262. /**
  18263. * Sets the current filter to "PCSS" (contact hardening).
  18264. */
  18265. set useContactHardeningShadow(value: boolean);
  18266. protected _contactHardeningLightSizeUVRatio: number;
  18267. /**
  18268. * Gets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  18269. * Using a ratio helps keeping shape stability independently of the map size.
  18270. *
  18271. * It does not account for the light projection as it was having too much
  18272. * instability during the light setup or during light position changes.
  18273. *
  18274. * Only valid if useContactHardeningShadow is true.
  18275. */
  18276. get contactHardeningLightSizeUVRatio(): number;
  18277. /**
  18278. * Sets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  18279. * Using a ratio helps keeping shape stability independently of the map size.
  18280. *
  18281. * It does not account for the light projection as it was having too much
  18282. * instability during the light setup or during light position changes.
  18283. *
  18284. * Only valid if useContactHardeningShadow is true.
  18285. */
  18286. set contactHardeningLightSizeUVRatio(contactHardeningLightSizeUVRatio: number);
  18287. protected _darkness: number;
  18288. /** Gets or sets the actual darkness of a shadow */
  18289. get darkness(): number;
  18290. set darkness(value: number);
  18291. /**
  18292. * Returns the darkness value (float). This can only decrease the actual darkness of a shadow.
  18293. * 0 means strongest and 1 would means no shadow.
  18294. * @returns the darkness.
  18295. */
  18296. getDarkness(): number;
  18297. /**
  18298. * Sets the darkness value (float). This can only decrease the actual darkness of a shadow.
  18299. * @param darkness The darkness value 0 means strongest and 1 would means no shadow.
  18300. * @returns the shadow generator allowing fluent coding.
  18301. */
  18302. setDarkness(darkness: number): ShadowGenerator;
  18303. protected _transparencyShadow: boolean;
  18304. /** Gets or sets the ability to have transparent shadow */
  18305. get transparencyShadow(): boolean;
  18306. set transparencyShadow(value: boolean);
  18307. /**
  18308. * Sets the ability to have transparent shadow (boolean).
  18309. * @param transparent True if transparent else False
  18310. * @returns the shadow generator allowing fluent coding
  18311. */
  18312. setTransparencyShadow(transparent: boolean): ShadowGenerator;
  18313. /**
  18314. * Enables or disables shadows with varying strength based on the transparency
  18315. * When it is enabled, the strength of the shadow is taken equal to mesh.visibility
  18316. * If you enabled an alpha texture on your material, the alpha value red from the texture is also combined to compute the strength:
  18317. * mesh.visibility * alphaTexture.a
  18318. * Note that by definition transparencyShadow must be set to true for enableSoftTransparentShadow to work!
  18319. */
  18320. enableSoftTransparentShadow: boolean;
  18321. protected _shadowMap: Nullable<RenderTargetTexture>;
  18322. protected _shadowMap2: Nullable<RenderTargetTexture>;
  18323. /**
  18324. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  18325. * @returns The render target texture if present otherwise, null
  18326. */
  18327. getShadowMap(): Nullable<RenderTargetTexture>;
  18328. /**
  18329. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  18330. * @returns The render target texture if the shadow map is present otherwise, null
  18331. */
  18332. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  18333. /**
  18334. * Gets the class name of that object
  18335. * @returns "ShadowGenerator"
  18336. */
  18337. getClassName(): string;
  18338. /**
  18339. * Helper function to add a mesh and its descendants to the list of shadow casters.
  18340. * @param mesh Mesh to add
  18341. * @param includeDescendants boolean indicating if the descendants should be added. Default to true
  18342. * @returns the Shadow Generator itself
  18343. */
  18344. addShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  18345. /**
  18346. * Helper function to remove a mesh and its descendants from the list of shadow casters
  18347. * @param mesh Mesh to remove
  18348. * @param includeDescendants boolean indicating if the descendants should be removed. Default to true
  18349. * @returns the Shadow Generator itself
  18350. */
  18351. removeShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  18352. /**
  18353. * Controls the extent to which the shadows fade out at the edge of the frustum
  18354. */
  18355. frustumEdgeFalloff: number;
  18356. protected _light: IShadowLight;
  18357. /**
  18358. * Returns the associated light object.
  18359. * @returns the light generating the shadow
  18360. */
  18361. getLight(): IShadowLight;
  18362. /**
  18363. * If true the shadow map is generated by rendering the back face of the mesh instead of the front face.
  18364. * This can help with self-shadowing as the geometry making up the back of objects is slightly offset.
  18365. * It might on the other hand introduce peter panning.
  18366. */
  18367. forceBackFacesOnly: boolean;
  18368. protected _scene: Scene;
  18369. protected _lightDirection: Vector3;
  18370. protected _effect: Effect;
  18371. protected _viewMatrix: Matrix;
  18372. protected _projectionMatrix: Matrix;
  18373. protected _transformMatrix: Matrix;
  18374. protected _cachedPosition: Vector3;
  18375. protected _cachedDirection: Vector3;
  18376. protected _cachedDefines: string;
  18377. protected _currentRenderID: number;
  18378. protected _boxBlurPostprocess: Nullable<PostProcess>;
  18379. protected _kernelBlurXPostprocess: Nullable<PostProcess>;
  18380. protected _kernelBlurYPostprocess: Nullable<PostProcess>;
  18381. protected _blurPostProcesses: PostProcess[];
  18382. protected _mapSize: number;
  18383. protected _currentFaceIndex: number;
  18384. protected _currentFaceIndexCache: number;
  18385. protected _textureType: number;
  18386. protected _defaultTextureMatrix: Matrix;
  18387. protected _storedUniqueId: Nullable<number>;
  18388. /** @hidden */
  18389. static _SceneComponentInitialization: (scene: Scene) => void;
  18390. /**
  18391. * Creates a ShadowGenerator object.
  18392. * A ShadowGenerator is the required tool to use the shadows.
  18393. * Each light casting shadows needs to use its own ShadowGenerator.
  18394. * Documentation : https://doc.babylonjs.com/babylon101/shadows
  18395. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  18396. * @param light The light object generating the shadows.
  18397. * @param usefulFloatFirst By default the generator will try to use half float textures but if you need precision (for self shadowing for instance), you can use this option to enforce full float texture.
  18398. */
  18399. constructor(mapSize: number, light: IShadowLight, usefulFloatFirst?: boolean);
  18400. protected _initializeGenerator(): void;
  18401. protected _createTargetRenderTexture(): void;
  18402. protected _initializeShadowMap(): void;
  18403. protected _initializeBlurRTTAndPostProcesses(): void;
  18404. protected _renderForShadowMap(opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>): void;
  18405. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  18406. protected _renderSubMeshForShadowMap(subMesh: SubMesh, isTransparent?: boolean): void;
  18407. protected _applyFilterValues(): void;
  18408. /**
  18409. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  18410. * @param onCompiled Callback triggered at the and of the effects compilation
  18411. * @param options Sets of optional options forcing the compilation with different modes
  18412. */
  18413. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  18414. useInstances: boolean;
  18415. }>): void;
  18416. /**
  18417. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  18418. * @param options Sets of optional options forcing the compilation with different modes
  18419. * @returns A promise that resolves when the compilation completes
  18420. */
  18421. forceCompilationAsync(options?: Partial<{
  18422. useInstances: boolean;
  18423. }>): Promise<void>;
  18424. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  18425. private _prepareShadowDefines;
  18426. /**
  18427. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  18428. * @param subMesh The submesh we want to render in the shadow map
  18429. * @param useInstances Defines wether will draw in the map using instances
  18430. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  18431. * @returns true if ready otherwise, false
  18432. */
  18433. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  18434. /**
  18435. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  18436. * @param defines Defines of the material we want to update
  18437. * @param lightIndex Index of the light in the enabled light list of the material
  18438. */
  18439. prepareDefines(defines: any, lightIndex: number): void;
  18440. /**
  18441. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  18442. * defined in the generator but impacting the effect).
  18443. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  18444. * @param effect The effect we are binfing the information for
  18445. */
  18446. bindShadowLight(lightIndex: string, effect: Effect): void;
  18447. /**
  18448. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  18449. * (eq to shadow prjection matrix * light transform matrix)
  18450. * @returns The transform matrix used to create the shadow map
  18451. */
  18452. getTransformMatrix(): Matrix;
  18453. /**
  18454. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  18455. * Cube and 2D textures for instance.
  18456. */
  18457. recreateShadowMap(): void;
  18458. protected _disposeBlurPostProcesses(): void;
  18459. protected _disposeRTTandPostProcesses(): void;
  18460. /**
  18461. * Disposes the ShadowGenerator.
  18462. * Returns nothing.
  18463. */
  18464. dispose(): void;
  18465. /**
  18466. * Serializes the shadow generator setup to a json object.
  18467. * @returns The serialized JSON object
  18468. */
  18469. serialize(): any;
  18470. /**
  18471. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  18472. * @param parsedShadowGenerator The JSON object to parse
  18473. * @param scene The scene to create the shadow map for
  18474. * @param constr A function that builds a shadow generator or undefined to create an instance of the default shadow generator
  18475. * @returns The parsed shadow generator
  18476. */
  18477. static Parse(parsedShadowGenerator: any, scene: Scene, constr?: (mapSize: number, light: IShadowLight) => ShadowGenerator): ShadowGenerator;
  18478. }
  18479. }
  18480. declare module "babylonjs/Lights/light" {
  18481. import { Nullable } from "babylonjs/types";
  18482. import { Scene } from "babylonjs/scene";
  18483. import { Vector3 } from "babylonjs/Maths/math.vector";
  18484. import { Color3 } from "babylonjs/Maths/math.color";
  18485. import { Node } from "babylonjs/node";
  18486. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  18487. import { Effect } from "babylonjs/Materials/effect";
  18488. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  18489. import { IShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  18490. /**
  18491. * Base class of all the lights in Babylon. It groups all the generic information about lights.
  18492. * Lights are used, as you would expect, to affect how meshes are seen, in terms of both illumination and colour.
  18493. * All meshes allow light to pass through them unless shadow generation is activated. The default number of lights allowed is four but this can be increased.
  18494. */
  18495. export abstract class Light extends Node {
  18496. /**
  18497. * Falloff Default: light is falling off following the material specification:
  18498. * standard material is using standard falloff whereas pbr material can request special falloff per materials.
  18499. */
  18500. static readonly FALLOFF_DEFAULT: number;
  18501. /**
  18502. * Falloff Physical: light is falling off following the inverse squared distance law.
  18503. */
  18504. static readonly FALLOFF_PHYSICAL: number;
  18505. /**
  18506. * Falloff gltf: light is falling off as described in the gltf moving to PBR document
  18507. * to enhance interoperability with other engines.
  18508. */
  18509. static readonly FALLOFF_GLTF: number;
  18510. /**
  18511. * Falloff Standard: light is falling off like in the standard material
  18512. * to enhance interoperability with other materials.
  18513. */
  18514. static readonly FALLOFF_STANDARD: number;
  18515. /**
  18516. * If every light affecting the material is in this lightmapMode,
  18517. * material.lightmapTexture adds or multiplies
  18518. * (depends on material.useLightmapAsShadowmap)
  18519. * after every other light calculations.
  18520. */
  18521. static readonly LIGHTMAP_DEFAULT: number;
  18522. /**
  18523. * material.lightmapTexture as only diffuse lighting from this light
  18524. * adds only specular lighting from this light
  18525. * adds dynamic shadows
  18526. */
  18527. static readonly LIGHTMAP_SPECULAR: number;
  18528. /**
  18529. * material.lightmapTexture as only lighting
  18530. * no light calculation from this light
  18531. * only adds dynamic shadows from this light
  18532. */
  18533. static readonly LIGHTMAP_SHADOWSONLY: number;
  18534. /**
  18535. * Each light type uses the default quantity according to its type:
  18536. * point/spot lights use luminous intensity
  18537. * directional lights use illuminance
  18538. */
  18539. static readonly INTENSITYMODE_AUTOMATIC: number;
  18540. /**
  18541. * lumen (lm)
  18542. */
  18543. static readonly INTENSITYMODE_LUMINOUSPOWER: number;
  18544. /**
  18545. * candela (lm/sr)
  18546. */
  18547. static readonly INTENSITYMODE_LUMINOUSINTENSITY: number;
  18548. /**
  18549. * lux (lm/m^2)
  18550. */
  18551. static readonly INTENSITYMODE_ILLUMINANCE: number;
  18552. /**
  18553. * nit (cd/m^2)
  18554. */
  18555. static readonly INTENSITYMODE_LUMINANCE: number;
  18556. /**
  18557. * Light type const id of the point light.
  18558. */
  18559. static readonly LIGHTTYPEID_POINTLIGHT: number;
  18560. /**
  18561. * Light type const id of the directional light.
  18562. */
  18563. static readonly LIGHTTYPEID_DIRECTIONALLIGHT: number;
  18564. /**
  18565. * Light type const id of the spot light.
  18566. */
  18567. static readonly LIGHTTYPEID_SPOTLIGHT: number;
  18568. /**
  18569. * Light type const id of the hemispheric light.
  18570. */
  18571. static readonly LIGHTTYPEID_HEMISPHERICLIGHT: number;
  18572. /**
  18573. * Diffuse gives the basic color to an object.
  18574. */
  18575. diffuse: Color3;
  18576. /**
  18577. * Specular produces a highlight color on an object.
  18578. * Note: This is note affecting PBR materials.
  18579. */
  18580. specular: Color3;
  18581. /**
  18582. * Defines the falloff type for this light. This lets overrriding how punctual light are
  18583. * falling off base on range or angle.
  18584. * This can be set to any values in Light.FALLOFF_x.
  18585. *
  18586. * Note: This is only useful for PBR Materials at the moment. This could be extended if required to
  18587. * other types of materials.
  18588. */
  18589. falloffType: number;
  18590. /**
  18591. * Strength of the light.
  18592. * Note: By default it is define in the framework own unit.
  18593. * Note: In PBR materials the intensityMode can be use to chose what unit the intensity is defined in.
  18594. */
  18595. intensity: number;
  18596. private _range;
  18597. protected _inverseSquaredRange: number;
  18598. /**
  18599. * Defines how far from the source the light is impacting in scene units.
  18600. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  18601. */
  18602. get range(): number;
  18603. /**
  18604. * Defines how far from the source the light is impacting in scene units.
  18605. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  18606. */
  18607. set range(value: number);
  18608. /**
  18609. * Cached photometric scale default to 1.0 as the automatic intensity mode defaults to 1.0 for every type
  18610. * of light.
  18611. */
  18612. private _photometricScale;
  18613. private _intensityMode;
  18614. /**
  18615. * Gets the photometric scale used to interpret the intensity.
  18616. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  18617. */
  18618. get intensityMode(): number;
  18619. /**
  18620. * Sets the photometric scale used to interpret the intensity.
  18621. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  18622. */
  18623. set intensityMode(value: number);
  18624. private _radius;
  18625. /**
  18626. * Gets the light radius used by PBR Materials to simulate soft area lights.
  18627. */
  18628. get radius(): number;
  18629. /**
  18630. * sets the light radius used by PBR Materials to simulate soft area lights.
  18631. */
  18632. set radius(value: number);
  18633. private _renderPriority;
  18634. /**
  18635. * Defines the rendering priority of the lights. It can help in case of fallback or number of lights
  18636. * exceeding the number allowed of the materials.
  18637. */
  18638. renderPriority: number;
  18639. private _shadowEnabled;
  18640. /**
  18641. * Gets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  18642. * the current shadow generator.
  18643. */
  18644. get shadowEnabled(): boolean;
  18645. /**
  18646. * Sets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  18647. * the current shadow generator.
  18648. */
  18649. set shadowEnabled(value: boolean);
  18650. private _includedOnlyMeshes;
  18651. /**
  18652. * Gets the only meshes impacted by this light.
  18653. */
  18654. get includedOnlyMeshes(): AbstractMesh[];
  18655. /**
  18656. * Sets the only meshes impacted by this light.
  18657. */
  18658. set includedOnlyMeshes(value: AbstractMesh[]);
  18659. private _excludedMeshes;
  18660. /**
  18661. * Gets the meshes not impacted by this light.
  18662. */
  18663. get excludedMeshes(): AbstractMesh[];
  18664. /**
  18665. * Sets the meshes not impacted by this light.
  18666. */
  18667. set excludedMeshes(value: AbstractMesh[]);
  18668. private _excludeWithLayerMask;
  18669. /**
  18670. * Gets the layer id use to find what meshes are not impacted by the light.
  18671. * Inactive if 0
  18672. */
  18673. get excludeWithLayerMask(): number;
  18674. /**
  18675. * Sets the layer id use to find what meshes are not impacted by the light.
  18676. * Inactive if 0
  18677. */
  18678. set excludeWithLayerMask(value: number);
  18679. private _includeOnlyWithLayerMask;
  18680. /**
  18681. * Gets the layer id use to find what meshes are impacted by the light.
  18682. * Inactive if 0
  18683. */
  18684. get includeOnlyWithLayerMask(): number;
  18685. /**
  18686. * Sets the layer id use to find what meshes are impacted by the light.
  18687. * Inactive if 0
  18688. */
  18689. set includeOnlyWithLayerMask(value: number);
  18690. private _lightmapMode;
  18691. /**
  18692. * Gets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  18693. */
  18694. get lightmapMode(): number;
  18695. /**
  18696. * Sets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  18697. */
  18698. set lightmapMode(value: number);
  18699. /**
  18700. * Shadow generator associted to the light.
  18701. * @hidden Internal use only.
  18702. */
  18703. _shadowGenerator: Nullable<IShadowGenerator>;
  18704. /**
  18705. * @hidden Internal use only.
  18706. */
  18707. _excludedMeshesIds: string[];
  18708. /**
  18709. * @hidden Internal use only.
  18710. */
  18711. _includedOnlyMeshesIds: string[];
  18712. /**
  18713. * The current light unifom buffer.
  18714. * @hidden Internal use only.
  18715. */
  18716. _uniformBuffer: UniformBuffer;
  18717. /** @hidden */
  18718. _renderId: number;
  18719. /**
  18720. * Creates a Light object in the scene.
  18721. * Documentation : https://doc.babylonjs.com/babylon101/lights
  18722. * @param name The firendly name of the light
  18723. * @param scene The scene the light belongs too
  18724. */
  18725. constructor(name: string, scene: Scene);
  18726. protected abstract _buildUniformLayout(): void;
  18727. /**
  18728. * Sets the passed Effect "effect" with the Light information.
  18729. * @param effect The effect to update
  18730. * @param lightIndex The index of the light in the effect to update
  18731. * @returns The light
  18732. */
  18733. abstract transferToEffect(effect: Effect, lightIndex: string): Light;
  18734. /**
  18735. * Sets the passed Effect "effect" with the Light textures.
  18736. * @param effect The effect to update
  18737. * @param lightIndex The index of the light in the effect to update
  18738. * @returns The light
  18739. */
  18740. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  18741. /**
  18742. * Binds the lights information from the scene to the effect for the given mesh.
  18743. * @param lightIndex Light index
  18744. * @param scene The scene where the light belongs to
  18745. * @param effect The effect we are binding the data to
  18746. * @param useSpecular Defines if specular is supported
  18747. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  18748. */
  18749. _bindLight(lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  18750. /**
  18751. * Sets the passed Effect "effect" with the Light information.
  18752. * @param effect The effect to update
  18753. * @param lightDataUniformName The uniform used to store light data (position or direction)
  18754. * @returns The light
  18755. */
  18756. abstract transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  18757. /**
  18758. * Returns the string "Light".
  18759. * @returns the class name
  18760. */
  18761. getClassName(): string;
  18762. /** @hidden */
  18763. readonly _isLight: boolean;
  18764. /**
  18765. * Converts the light information to a readable string for debug purpose.
  18766. * @param fullDetails Supports for multiple levels of logging within scene loading
  18767. * @returns the human readable light info
  18768. */
  18769. toString(fullDetails?: boolean): string;
  18770. /** @hidden */
  18771. protected _syncParentEnabledState(): void;
  18772. /**
  18773. * Set the enabled state of this node.
  18774. * @param value - the new enabled state
  18775. */
  18776. setEnabled(value: boolean): void;
  18777. /**
  18778. * Returns the Light associated shadow generator if any.
  18779. * @return the associated shadow generator.
  18780. */
  18781. getShadowGenerator(): Nullable<IShadowGenerator>;
  18782. /**
  18783. * Returns a Vector3, the absolute light position in the World.
  18784. * @returns the world space position of the light
  18785. */
  18786. getAbsolutePosition(): Vector3;
  18787. /**
  18788. * Specifies if the light will affect the passed mesh.
  18789. * @param mesh The mesh to test against the light
  18790. * @return true the mesh is affected otherwise, false.
  18791. */
  18792. canAffectMesh(mesh: AbstractMesh): boolean;
  18793. /**
  18794. * Sort function to order lights for rendering.
  18795. * @param a First Light object to compare to second.
  18796. * @param b Second Light object to compare first.
  18797. * @return -1 to reduce's a's index relative to be, 0 for no change, 1 to increase a's index relative to b.
  18798. */
  18799. static CompareLightsPriority(a: Light, b: Light): number;
  18800. /**
  18801. * Releases resources associated with this node.
  18802. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  18803. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  18804. */
  18805. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  18806. /**
  18807. * Returns the light type ID (integer).
  18808. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  18809. */
  18810. getTypeID(): number;
  18811. /**
  18812. * Returns the intensity scaled by the Photometric Scale according to the light type and intensity mode.
  18813. * @returns the scaled intensity in intensity mode unit
  18814. */
  18815. getScaledIntensity(): number;
  18816. /**
  18817. * Returns a new Light object, named "name", from the current one.
  18818. * @param name The name of the cloned light
  18819. * @param newParent The parent of this light, if it has one
  18820. * @returns the new created light
  18821. */
  18822. clone(name: string, newParent?: Nullable<Node>): Nullable<Light>;
  18823. /**
  18824. * Serializes the current light into a Serialization object.
  18825. * @returns the serialized object.
  18826. */
  18827. serialize(): any;
  18828. /**
  18829. * Creates a new typed light from the passed type (integer) : point light = 0, directional light = 1, spot light = 2, hemispheric light = 3.
  18830. * This new light is named "name" and added to the passed scene.
  18831. * @param type Type according to the types available in Light.LIGHTTYPEID_x
  18832. * @param name The friendly name of the light
  18833. * @param scene The scene the new light will belong to
  18834. * @returns the constructor function
  18835. */
  18836. static GetConstructorFromName(type: number, name: string, scene: Scene): Nullable<() => Light>;
  18837. /**
  18838. * Parses the passed "parsedLight" and returns a new instanced Light from this parsing.
  18839. * @param parsedLight The JSON representation of the light
  18840. * @param scene The scene to create the parsed light in
  18841. * @returns the created light after parsing
  18842. */
  18843. static Parse(parsedLight: any, scene: Scene): Nullable<Light>;
  18844. private _hookArrayForExcluded;
  18845. private _hookArrayForIncludedOnly;
  18846. private _resyncMeshes;
  18847. /**
  18848. * Forces the meshes to update their light related information in their rendering used effects
  18849. * @hidden Internal Use Only
  18850. */
  18851. _markMeshesAsLightDirty(): void;
  18852. /**
  18853. * Recomputes the cached photometric scale if needed.
  18854. */
  18855. private _computePhotometricScale;
  18856. /**
  18857. * Returns the Photometric Scale according to the light type and intensity mode.
  18858. */
  18859. private _getPhotometricScale;
  18860. /**
  18861. * Reorder the light in the scene according to their defined priority.
  18862. * @hidden Internal Use Only
  18863. */
  18864. _reorderLightsInScene(): void;
  18865. /**
  18866. * Prepares the list of defines specific to the light type.
  18867. * @param defines the list of defines
  18868. * @param lightIndex defines the index of the light for the effect
  18869. */
  18870. abstract prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  18871. }
  18872. }
  18873. declare module "babylonjs/Cameras/targetCamera" {
  18874. import { Nullable } from "babylonjs/types";
  18875. import { Camera } from "babylonjs/Cameras/camera";
  18876. import { Scene } from "babylonjs/scene";
  18877. import { Quaternion, Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  18878. /**
  18879. * A target camera takes a mesh or position as a target and continues to look at it while it moves.
  18880. * This is the base of the follow, arc rotate cameras and Free camera
  18881. * @see https://doc.babylonjs.com/features/cameras
  18882. */
  18883. export class TargetCamera extends Camera {
  18884. private static _RigCamTransformMatrix;
  18885. private static _TargetTransformMatrix;
  18886. private static _TargetFocalPoint;
  18887. private _tmpUpVector;
  18888. private _tmpTargetVector;
  18889. /**
  18890. * Define the current direction the camera is moving to
  18891. */
  18892. cameraDirection: Vector3;
  18893. /**
  18894. * Define the current rotation the camera is rotating to
  18895. */
  18896. cameraRotation: Vector2;
  18897. /** Gets or sets a boolean indicating that the scaling of the parent hierarchy will not be taken in account by the camera */
  18898. ignoreParentScaling: boolean;
  18899. /**
  18900. * When set, the up vector of the camera will be updated by the rotation of the camera
  18901. */
  18902. updateUpVectorFromRotation: boolean;
  18903. private _tmpQuaternion;
  18904. /**
  18905. * Define the current rotation of the camera
  18906. */
  18907. rotation: Vector3;
  18908. /**
  18909. * Define the current rotation of the camera as a quaternion to prevent Gimbal lock
  18910. */
  18911. rotationQuaternion: Quaternion;
  18912. /**
  18913. * Define the current speed of the camera
  18914. */
  18915. speed: number;
  18916. /**
  18917. * Add constraint to the camera to prevent it to move freely in all directions and
  18918. * around all axis.
  18919. */
  18920. noRotationConstraint: boolean;
  18921. /**
  18922. * Reverses mouselook direction to 'natural' panning as opposed to traditional direct
  18923. * panning
  18924. */
  18925. invertRotation: boolean;
  18926. /**
  18927. * Speed multiplier for inverse camera panning
  18928. */
  18929. inverseRotationSpeed: number;
  18930. /**
  18931. * Define the current target of the camera as an object or a position.
  18932. */
  18933. lockedTarget: any;
  18934. /** @hidden */
  18935. _currentTarget: Vector3;
  18936. /** @hidden */
  18937. _initialFocalDistance: number;
  18938. /** @hidden */
  18939. _viewMatrix: Matrix;
  18940. /** @hidden */
  18941. _camMatrix: Matrix;
  18942. /** @hidden */
  18943. _cameraTransformMatrix: Matrix;
  18944. /** @hidden */
  18945. _cameraRotationMatrix: Matrix;
  18946. /** @hidden */
  18947. _referencePoint: Vector3;
  18948. /** @hidden */
  18949. _transformedReferencePoint: Vector3;
  18950. /** @hidden */
  18951. _reset: () => void;
  18952. private _defaultUp;
  18953. /**
  18954. * Instantiates a target camera that takes a mesh or position as a target and continues to look at it while it moves.
  18955. * This is the base of the follow, arc rotate cameras and Free camera
  18956. * @see https://doc.babylonjs.com/features/cameras
  18957. * @param name Defines the name of the camera in the scene
  18958. * @param position Defines the start position of the camera in the scene
  18959. * @param scene Defines the scene the camera belongs to
  18960. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  18961. */
  18962. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  18963. /**
  18964. * Gets the position in front of the camera at a given distance.
  18965. * @param distance The distance from the camera we want the position to be
  18966. * @returns the position
  18967. */
  18968. getFrontPosition(distance: number): Vector3;
  18969. /** @hidden */
  18970. _getLockedTargetPosition(): Nullable<Vector3>;
  18971. private _storedPosition;
  18972. private _storedRotation;
  18973. private _storedRotationQuaternion;
  18974. /**
  18975. * Store current camera state of the camera (fov, position, rotation, etc..)
  18976. * @returns the camera
  18977. */
  18978. storeState(): Camera;
  18979. /**
  18980. * Restored camera state. You must call storeState() first
  18981. * @returns whether it was successful or not
  18982. * @hidden
  18983. */
  18984. _restoreStateValues(): boolean;
  18985. /** @hidden */
  18986. _initCache(): void;
  18987. /** @hidden */
  18988. _updateCache(ignoreParentClass?: boolean): void;
  18989. /** @hidden */
  18990. _isSynchronizedViewMatrix(): boolean;
  18991. /** @hidden */
  18992. _computeLocalCameraSpeed(): number;
  18993. /**
  18994. * Defines the target the camera should look at.
  18995. * @param target Defines the new target as a Vector or a mesh
  18996. */
  18997. setTarget(target: Vector3): void;
  18998. /**
  18999. * Defines the target point of the camera.
  19000. * The camera looks towards it form the radius distance.
  19001. */
  19002. get target(): Vector3;
  19003. set target(value: Vector3);
  19004. /**
  19005. * Return the current target position of the camera. This value is expressed in local space.
  19006. * @returns the target position
  19007. */
  19008. getTarget(): Vector3;
  19009. /** @hidden */
  19010. _decideIfNeedsToMove(): boolean;
  19011. /** @hidden */
  19012. _updatePosition(): void;
  19013. /** @hidden */
  19014. _checkInputs(): void;
  19015. protected _updateCameraRotationMatrix(): void;
  19016. /**
  19017. * Update the up vector to apply the rotation of the camera (So if you changed the camera rotation.z this will let you update the up vector as well)
  19018. * @returns the current camera
  19019. */
  19020. private _rotateUpVectorWithCameraRotationMatrix;
  19021. private _cachedRotationZ;
  19022. private _cachedQuaternionRotationZ;
  19023. /** @hidden */
  19024. _getViewMatrix(): Matrix;
  19025. protected _computeViewMatrix(position: Vector3, target: Vector3, up: Vector3): void;
  19026. /**
  19027. * @hidden
  19028. */
  19029. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  19030. /**
  19031. * @hidden
  19032. */
  19033. _updateRigCameras(): void;
  19034. private _getRigCamPositionAndTarget;
  19035. /**
  19036. * Gets the current object class name.
  19037. * @return the class name
  19038. */
  19039. getClassName(): string;
  19040. }
  19041. }
  19042. declare module "babylonjs/Events/keyboardEvents" {
  19043. /**
  19044. * Gather the list of keyboard event types as constants.
  19045. */
  19046. export class KeyboardEventTypes {
  19047. /**
  19048. * The keydown event is fired when a key becomes active (pressed).
  19049. */
  19050. static readonly KEYDOWN: number;
  19051. /**
  19052. * The keyup event is fired when a key has been released.
  19053. */
  19054. static readonly KEYUP: number;
  19055. }
  19056. /**
  19057. * This class is used to store keyboard related info for the onKeyboardObservable event.
  19058. */
  19059. export class KeyboardInfo {
  19060. /**
  19061. * Defines the type of event (KeyboardEventTypes)
  19062. */
  19063. type: number;
  19064. /**
  19065. * Defines the related dom event
  19066. */
  19067. event: KeyboardEvent;
  19068. /**
  19069. * Instantiates a new keyboard info.
  19070. * This class is used to store keyboard related info for the onKeyboardObservable event.
  19071. * @param type Defines the type of event (KeyboardEventTypes)
  19072. * @param event Defines the related dom event
  19073. */
  19074. constructor(
  19075. /**
  19076. * Defines the type of event (KeyboardEventTypes)
  19077. */
  19078. type: number,
  19079. /**
  19080. * Defines the related dom event
  19081. */
  19082. event: KeyboardEvent);
  19083. }
  19084. /**
  19085. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  19086. * Set the skipOnKeyboardObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onKeyboardObservable
  19087. */
  19088. export class KeyboardInfoPre extends KeyboardInfo {
  19089. /**
  19090. * Defines the type of event (KeyboardEventTypes)
  19091. */
  19092. type: number;
  19093. /**
  19094. * Defines the related dom event
  19095. */
  19096. event: KeyboardEvent;
  19097. /**
  19098. * Defines whether the engine should skip the next onKeyboardObservable associated to this pre.
  19099. */
  19100. skipOnPointerObservable: boolean;
  19101. /**
  19102. * Instantiates a new keyboard pre info.
  19103. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  19104. * @param type Defines the type of event (KeyboardEventTypes)
  19105. * @param event Defines the related dom event
  19106. */
  19107. constructor(
  19108. /**
  19109. * Defines the type of event (KeyboardEventTypes)
  19110. */
  19111. type: number,
  19112. /**
  19113. * Defines the related dom event
  19114. */
  19115. event: KeyboardEvent);
  19116. }
  19117. }
  19118. declare module "babylonjs/Cameras/Inputs/freeCameraKeyboardMoveInput" {
  19119. import { Nullable } from "babylonjs/types";
  19120. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  19121. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  19122. /**
  19123. * Manage the keyboard inputs to control the movement of a free camera.
  19124. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19125. */
  19126. export class FreeCameraKeyboardMoveInput implements ICameraInput<FreeCamera> {
  19127. /**
  19128. * Defines the camera the input is attached to.
  19129. */
  19130. camera: FreeCamera;
  19131. /**
  19132. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  19133. */
  19134. keysUp: number[];
  19135. /**
  19136. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  19137. */
  19138. keysUpward: number[];
  19139. /**
  19140. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  19141. */
  19142. keysDown: number[];
  19143. /**
  19144. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  19145. */
  19146. keysDownward: number[];
  19147. /**
  19148. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  19149. */
  19150. keysLeft: number[];
  19151. /**
  19152. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  19153. */
  19154. keysRight: number[];
  19155. private _keys;
  19156. private _onCanvasBlurObserver;
  19157. private _onKeyboardObserver;
  19158. private _engine;
  19159. private _scene;
  19160. /**
  19161. * Attach the input controls to a specific dom element to get the input from.
  19162. * @param element Defines the element the controls should be listened from
  19163. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  19164. */
  19165. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  19166. /**
  19167. * Detach the current controls from the specified dom element.
  19168. * @param element Defines the element to stop listening the inputs from
  19169. */
  19170. detachControl(element: Nullable<HTMLElement>): void;
  19171. /**
  19172. * Update the current camera state depending on the inputs that have been used this frame.
  19173. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  19174. */
  19175. checkInputs(): void;
  19176. /**
  19177. * Gets the class name of the current intput.
  19178. * @returns the class name
  19179. */
  19180. getClassName(): string;
  19181. /** @hidden */
  19182. _onLostFocus(): void;
  19183. /**
  19184. * Get the friendly name associated with the input class.
  19185. * @returns the input friendly name
  19186. */
  19187. getSimpleName(): string;
  19188. }
  19189. }
  19190. declare module "babylonjs/Events/pointerEvents" {
  19191. import { Nullable } from "babylonjs/types";
  19192. import { Vector2 } from "babylonjs/Maths/math.vector";
  19193. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  19194. import { Ray } from "babylonjs/Culling/ray";
  19195. /**
  19196. * Gather the list of pointer event types as constants.
  19197. */
  19198. export class PointerEventTypes {
  19199. /**
  19200. * The pointerdown event is fired when a pointer becomes active. For mouse, it is fired when the device transitions from no buttons depressed to at least one button depressed. For touch, it is fired when physical contact is made with the digitizer. For pen, it is fired when the stylus makes physical contact with the digitizer.
  19201. */
  19202. static readonly POINTERDOWN: number;
  19203. /**
  19204. * The pointerup event is fired when a pointer is no longer active.
  19205. */
  19206. static readonly POINTERUP: number;
  19207. /**
  19208. * The pointermove event is fired when a pointer changes coordinates.
  19209. */
  19210. static readonly POINTERMOVE: number;
  19211. /**
  19212. * The pointerwheel event is fired when a mouse wheel has been rotated.
  19213. */
  19214. static readonly POINTERWHEEL: number;
  19215. /**
  19216. * The pointerpick event is fired when a mesh or sprite has been picked by the pointer.
  19217. */
  19218. static readonly POINTERPICK: number;
  19219. /**
  19220. * The pointertap event is fired when a the object has been touched and released without drag.
  19221. */
  19222. static readonly POINTERTAP: number;
  19223. /**
  19224. * The pointerdoubletap event is fired when a the object has been touched and released twice without drag.
  19225. */
  19226. static readonly POINTERDOUBLETAP: number;
  19227. }
  19228. /**
  19229. * Base class of pointer info types.
  19230. */
  19231. export class PointerInfoBase {
  19232. /**
  19233. * Defines the type of event (PointerEventTypes)
  19234. */
  19235. type: number;
  19236. /**
  19237. * Defines the related dom event
  19238. */
  19239. event: PointerEvent | MouseWheelEvent;
  19240. /**
  19241. * Instantiates the base class of pointers info.
  19242. * @param type Defines the type of event (PointerEventTypes)
  19243. * @param event Defines the related dom event
  19244. */
  19245. constructor(
  19246. /**
  19247. * Defines the type of event (PointerEventTypes)
  19248. */
  19249. type: number,
  19250. /**
  19251. * Defines the related dom event
  19252. */
  19253. event: PointerEvent | MouseWheelEvent);
  19254. }
  19255. /**
  19256. * This class is used to store pointer related info for the onPrePointerObservable event.
  19257. * Set the skipOnPointerObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onPointerObservable
  19258. */
  19259. export class PointerInfoPre extends PointerInfoBase {
  19260. /**
  19261. * Ray from a pointer if availible (eg. 6dof controller)
  19262. */
  19263. ray: Nullable<Ray>;
  19264. /**
  19265. * Defines the local position of the pointer on the canvas.
  19266. */
  19267. localPosition: Vector2;
  19268. /**
  19269. * Defines whether the engine should skip the next OnPointerObservable associated to this pre.
  19270. */
  19271. skipOnPointerObservable: boolean;
  19272. /**
  19273. * Instantiates a PointerInfoPre to store pointer related info to the onPrePointerObservable event.
  19274. * @param type Defines the type of event (PointerEventTypes)
  19275. * @param event Defines the related dom event
  19276. * @param localX Defines the local x coordinates of the pointer when the event occured
  19277. * @param localY Defines the local y coordinates of the pointer when the event occured
  19278. */
  19279. constructor(type: number, event: PointerEvent | MouseWheelEvent, localX: number, localY: number);
  19280. }
  19281. /**
  19282. * This type contains all the data related to a pointer event in Babylon.js.
  19283. * The event member is an instance of PointerEvent for all types except PointerWheel and is of type MouseWheelEvent when type equals PointerWheel. The different event types can be found in the PointerEventTypes class.
  19284. */
  19285. export class PointerInfo extends PointerInfoBase {
  19286. /**
  19287. * Defines the picking info associated to the info (if any)\
  19288. */
  19289. pickInfo: Nullable<PickingInfo>;
  19290. /**
  19291. * Instantiates a PointerInfo to store pointer related info to the onPointerObservable event.
  19292. * @param type Defines the type of event (PointerEventTypes)
  19293. * @param event Defines the related dom event
  19294. * @param pickInfo Defines the picking info associated to the info (if any)\
  19295. */
  19296. constructor(type: number, event: PointerEvent | MouseWheelEvent,
  19297. /**
  19298. * Defines the picking info associated to the info (if any)\
  19299. */
  19300. pickInfo: Nullable<PickingInfo>);
  19301. }
  19302. /**
  19303. * Data relating to a touch event on the screen.
  19304. */
  19305. export interface PointerTouch {
  19306. /**
  19307. * X coordinate of touch.
  19308. */
  19309. x: number;
  19310. /**
  19311. * Y coordinate of touch.
  19312. */
  19313. y: number;
  19314. /**
  19315. * Id of touch. Unique for each finger.
  19316. */
  19317. pointerId: number;
  19318. /**
  19319. * Event type passed from DOM.
  19320. */
  19321. type: any;
  19322. }
  19323. }
  19324. declare module "babylonjs/Cameras/Inputs/freeCameraMouseInput" {
  19325. import { Observable } from "babylonjs/Misc/observable";
  19326. import { Nullable } from "babylonjs/types";
  19327. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  19328. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  19329. /**
  19330. * Manage the mouse inputs to control the movement of a free camera.
  19331. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19332. */
  19333. export class FreeCameraMouseInput implements ICameraInput<FreeCamera> {
  19334. /**
  19335. * Define if touch is enabled in the mouse input
  19336. */
  19337. touchEnabled: boolean;
  19338. /**
  19339. * Defines the camera the input is attached to.
  19340. */
  19341. camera: FreeCamera;
  19342. /**
  19343. * Defines the buttons associated with the input to handle camera move.
  19344. */
  19345. buttons: number[];
  19346. /**
  19347. * Defines the pointer angular sensibility along the X and Y axis or how fast is the camera rotating.
  19348. */
  19349. angularSensibility: number;
  19350. private _pointerInput;
  19351. private _onMouseMove;
  19352. private _observer;
  19353. private previousPosition;
  19354. /**
  19355. * Observable for when a pointer move event occurs containing the move offset
  19356. */
  19357. onPointerMovedObservable: Observable<{
  19358. offsetX: number;
  19359. offsetY: number;
  19360. }>;
  19361. /**
  19362. * @hidden
  19363. * If the camera should be rotated automatically based on pointer movement
  19364. */
  19365. _allowCameraRotation: boolean;
  19366. /**
  19367. * Manage the mouse inputs to control the movement of a free camera.
  19368. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19369. * @param touchEnabled Defines if touch is enabled or not
  19370. */
  19371. constructor(
  19372. /**
  19373. * Define if touch is enabled in the mouse input
  19374. */
  19375. touchEnabled?: boolean);
  19376. /**
  19377. * Attach the input controls to a specific dom element to get the input from.
  19378. * @param element Defines the element the controls should be listened from
  19379. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  19380. */
  19381. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  19382. /**
  19383. * Called on JS contextmenu event.
  19384. * Override this method to provide functionality.
  19385. */
  19386. protected onContextMenu(evt: PointerEvent): void;
  19387. /**
  19388. * Detach the current controls from the specified dom element.
  19389. * @param element Defines the element to stop listening the inputs from
  19390. */
  19391. detachControl(element: Nullable<HTMLElement>): void;
  19392. /**
  19393. * Gets the class name of the current intput.
  19394. * @returns the class name
  19395. */
  19396. getClassName(): string;
  19397. /**
  19398. * Get the friendly name associated with the input class.
  19399. * @returns the input friendly name
  19400. */
  19401. getSimpleName(): string;
  19402. }
  19403. }
  19404. declare module "babylonjs/Cameras/Inputs/freeCameraTouchInput" {
  19405. import { Nullable } from "babylonjs/types";
  19406. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  19407. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  19408. /**
  19409. * Manage the touch inputs to control the movement of a free camera.
  19410. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19411. */
  19412. export class FreeCameraTouchInput implements ICameraInput<FreeCamera> {
  19413. /**
  19414. * Define if mouse events can be treated as touch events
  19415. */
  19416. allowMouse: boolean;
  19417. /**
  19418. * Defines the camera the input is attached to.
  19419. */
  19420. camera: FreeCamera;
  19421. /**
  19422. * Defines the touch sensibility for rotation.
  19423. * The higher the faster.
  19424. */
  19425. touchAngularSensibility: number;
  19426. /**
  19427. * Defines the touch sensibility for move.
  19428. * The higher the faster.
  19429. */
  19430. touchMoveSensibility: number;
  19431. private _offsetX;
  19432. private _offsetY;
  19433. private _pointerPressed;
  19434. private _pointerInput;
  19435. private _observer;
  19436. private _onLostFocus;
  19437. /**
  19438. * Manage the touch inputs to control the movement of a free camera.
  19439. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19440. * @param allowMouse Defines if mouse events can be treated as touch events
  19441. */
  19442. constructor(
  19443. /**
  19444. * Define if mouse events can be treated as touch events
  19445. */
  19446. allowMouse?: boolean);
  19447. /**
  19448. * Attach the input controls to a specific dom element to get the input from.
  19449. * @param element Defines the element the controls should be listened from
  19450. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  19451. */
  19452. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  19453. /**
  19454. * Detach the current controls from the specified dom element.
  19455. * @param element Defines the element to stop listening the inputs from
  19456. */
  19457. detachControl(element: Nullable<HTMLElement>): void;
  19458. /**
  19459. * Update the current camera state depending on the inputs that have been used this frame.
  19460. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  19461. */
  19462. checkInputs(): void;
  19463. /**
  19464. * Gets the class name of the current intput.
  19465. * @returns the class name
  19466. */
  19467. getClassName(): string;
  19468. /**
  19469. * Get the friendly name associated with the input class.
  19470. * @returns the input friendly name
  19471. */
  19472. getSimpleName(): string;
  19473. }
  19474. }
  19475. declare module "babylonjs/Cameras/freeCameraInputsManager" {
  19476. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  19477. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  19478. import { FreeCameraMouseInput } from "babylonjs/Cameras/Inputs/freeCameraMouseInput";
  19479. import { Nullable } from "babylonjs/types";
  19480. /**
  19481. * Default Inputs manager for the FreeCamera.
  19482. * It groups all the default supported inputs for ease of use.
  19483. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19484. */
  19485. export class FreeCameraInputsManager extends CameraInputsManager<FreeCamera> {
  19486. /**
  19487. * @hidden
  19488. */
  19489. _mouseInput: Nullable<FreeCameraMouseInput>;
  19490. /**
  19491. * Instantiates a new FreeCameraInputsManager.
  19492. * @param camera Defines the camera the inputs belong to
  19493. */
  19494. constructor(camera: FreeCamera);
  19495. /**
  19496. * Add keyboard input support to the input manager.
  19497. * @returns the current input manager
  19498. */
  19499. addKeyboard(): FreeCameraInputsManager;
  19500. /**
  19501. * Add mouse input support to the input manager.
  19502. * @param touchEnabled if the FreeCameraMouseInput should support touch (default: true)
  19503. * @returns the current input manager
  19504. */
  19505. addMouse(touchEnabled?: boolean): FreeCameraInputsManager;
  19506. /**
  19507. * Removes the mouse input support from the manager
  19508. * @returns the current input manager
  19509. */
  19510. removeMouse(): FreeCameraInputsManager;
  19511. /**
  19512. * Add touch input support to the input manager.
  19513. * @returns the current input manager
  19514. */
  19515. addTouch(): FreeCameraInputsManager;
  19516. /**
  19517. * Remove all attached input methods from a camera
  19518. */
  19519. clear(): void;
  19520. }
  19521. }
  19522. declare module "babylonjs/Cameras/freeCamera" {
  19523. import { Vector3 } from "babylonjs/Maths/math.vector";
  19524. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  19525. import { Scene } from "babylonjs/scene";
  19526. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  19527. import { FreeCameraInputsManager } from "babylonjs/Cameras/freeCameraInputsManager";
  19528. /**
  19529. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  19530. * Please consider using the new UniversalCamera instead as it adds more functionality like the gamepad.
  19531. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  19532. */
  19533. export class FreeCamera extends TargetCamera {
  19534. /**
  19535. * Define the collision ellipsoid of the camera.
  19536. * This is helpful to simulate a camera body like the player body around the camera
  19537. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  19538. */
  19539. ellipsoid: Vector3;
  19540. /**
  19541. * Define an offset for the position of the ellipsoid around the camera.
  19542. * This can be helpful to determine the center of the body near the gravity center of the body
  19543. * instead of its head.
  19544. */
  19545. ellipsoidOffset: Vector3;
  19546. /**
  19547. * Enable or disable collisions of the camera with the rest of the scene objects.
  19548. */
  19549. checkCollisions: boolean;
  19550. /**
  19551. * Enable or disable gravity on the camera.
  19552. */
  19553. applyGravity: boolean;
  19554. /**
  19555. * Define the input manager associated to the camera.
  19556. */
  19557. inputs: FreeCameraInputsManager;
  19558. /**
  19559. * Gets the input sensibility for a mouse input. (default is 2000.0)
  19560. * Higher values reduce sensitivity.
  19561. */
  19562. get angularSensibility(): number;
  19563. /**
  19564. * Sets the input sensibility for a mouse input. (default is 2000.0)
  19565. * Higher values reduce sensitivity.
  19566. */
  19567. set angularSensibility(value: number);
  19568. /**
  19569. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  19570. */
  19571. get keysUp(): number[];
  19572. set keysUp(value: number[]);
  19573. /**
  19574. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  19575. */
  19576. get keysUpward(): number[];
  19577. set keysUpward(value: number[]);
  19578. /**
  19579. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  19580. */
  19581. get keysDown(): number[];
  19582. set keysDown(value: number[]);
  19583. /**
  19584. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  19585. */
  19586. get keysDownward(): number[];
  19587. set keysDownward(value: number[]);
  19588. /**
  19589. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  19590. */
  19591. get keysLeft(): number[];
  19592. set keysLeft(value: number[]);
  19593. /**
  19594. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  19595. */
  19596. get keysRight(): number[];
  19597. set keysRight(value: number[]);
  19598. /**
  19599. * Event raised when the camera collide with a mesh in the scene.
  19600. */
  19601. onCollide: (collidedMesh: AbstractMesh) => void;
  19602. private _collider;
  19603. private _needMoveForGravity;
  19604. private _oldPosition;
  19605. private _diffPosition;
  19606. private _newPosition;
  19607. /** @hidden */
  19608. _localDirection: Vector3;
  19609. /** @hidden */
  19610. _transformedDirection: Vector3;
  19611. /**
  19612. * Instantiates a Free Camera.
  19613. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  19614. * Please consider using the new UniversalCamera instead as it adds more functionality like touch to this camera.
  19615. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  19616. * @param name Define the name of the camera in the scene
  19617. * @param position Define the start position of the camera in the scene
  19618. * @param scene Define the scene the camera belongs to
  19619. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  19620. */
  19621. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  19622. /**
  19623. * Attached controls to the current camera.
  19624. * @param element Defines the element the controls should be listened from
  19625. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  19626. */
  19627. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  19628. /**
  19629. * Detach the current controls from the camera.
  19630. * The camera will stop reacting to inputs.
  19631. * @param element Defines the element to stop listening the inputs from
  19632. */
  19633. detachControl(element: HTMLElement): void;
  19634. private _collisionMask;
  19635. /**
  19636. * Define a collision mask to limit the list of object the camera can collide with
  19637. */
  19638. get collisionMask(): number;
  19639. set collisionMask(mask: number);
  19640. /** @hidden */
  19641. _collideWithWorld(displacement: Vector3): void;
  19642. private _onCollisionPositionChange;
  19643. /** @hidden */
  19644. _checkInputs(): void;
  19645. /** @hidden */
  19646. _decideIfNeedsToMove(): boolean;
  19647. /** @hidden */
  19648. _updatePosition(): void;
  19649. /**
  19650. * Destroy the camera and release the current resources hold by it.
  19651. */
  19652. dispose(): void;
  19653. /**
  19654. * Gets the current object class name.
  19655. * @return the class name
  19656. */
  19657. getClassName(): string;
  19658. }
  19659. }
  19660. declare module "babylonjs/Gamepads/gamepad" {
  19661. import { Observable } from "babylonjs/Misc/observable";
  19662. /**
  19663. * Represents a gamepad control stick position
  19664. */
  19665. export class StickValues {
  19666. /**
  19667. * The x component of the control stick
  19668. */
  19669. x: number;
  19670. /**
  19671. * The y component of the control stick
  19672. */
  19673. y: number;
  19674. /**
  19675. * Initializes the gamepad x and y control stick values
  19676. * @param x The x component of the gamepad control stick value
  19677. * @param y The y component of the gamepad control stick value
  19678. */
  19679. constructor(
  19680. /**
  19681. * The x component of the control stick
  19682. */
  19683. x: number,
  19684. /**
  19685. * The y component of the control stick
  19686. */
  19687. y: number);
  19688. }
  19689. /**
  19690. * An interface which manages callbacks for gamepad button changes
  19691. */
  19692. export interface GamepadButtonChanges {
  19693. /**
  19694. * Called when a gamepad has been changed
  19695. */
  19696. changed: boolean;
  19697. /**
  19698. * Called when a gamepad press event has been triggered
  19699. */
  19700. pressChanged: boolean;
  19701. /**
  19702. * Called when a touch event has been triggered
  19703. */
  19704. touchChanged: boolean;
  19705. /**
  19706. * Called when a value has changed
  19707. */
  19708. valueChanged: boolean;
  19709. }
  19710. /**
  19711. * Represents a gamepad
  19712. */
  19713. export class Gamepad {
  19714. /**
  19715. * The id of the gamepad
  19716. */
  19717. id: string;
  19718. /**
  19719. * The index of the gamepad
  19720. */
  19721. index: number;
  19722. /**
  19723. * The browser gamepad
  19724. */
  19725. browserGamepad: any;
  19726. /**
  19727. * Specifies what type of gamepad this represents
  19728. */
  19729. type: number;
  19730. private _leftStick;
  19731. private _rightStick;
  19732. /** @hidden */
  19733. _isConnected: boolean;
  19734. private _leftStickAxisX;
  19735. private _leftStickAxisY;
  19736. private _rightStickAxisX;
  19737. private _rightStickAxisY;
  19738. /**
  19739. * Triggered when the left control stick has been changed
  19740. */
  19741. private _onleftstickchanged;
  19742. /**
  19743. * Triggered when the right control stick has been changed
  19744. */
  19745. private _onrightstickchanged;
  19746. /**
  19747. * Represents a gamepad controller
  19748. */
  19749. static GAMEPAD: number;
  19750. /**
  19751. * Represents a generic controller
  19752. */
  19753. static GENERIC: number;
  19754. /**
  19755. * Represents an XBox controller
  19756. */
  19757. static XBOX: number;
  19758. /**
  19759. * Represents a pose-enabled controller
  19760. */
  19761. static POSE_ENABLED: number;
  19762. /**
  19763. * Represents an Dual Shock controller
  19764. */
  19765. static DUALSHOCK: number;
  19766. /**
  19767. * Specifies whether the left control stick should be Y-inverted
  19768. */
  19769. protected _invertLeftStickY: boolean;
  19770. /**
  19771. * Specifies if the gamepad has been connected
  19772. */
  19773. get isConnected(): boolean;
  19774. /**
  19775. * Initializes the gamepad
  19776. * @param id The id of the gamepad
  19777. * @param index The index of the gamepad
  19778. * @param browserGamepad The browser gamepad
  19779. * @param leftStickX The x component of the left joystick
  19780. * @param leftStickY The y component of the left joystick
  19781. * @param rightStickX The x component of the right joystick
  19782. * @param rightStickY The y component of the right joystick
  19783. */
  19784. constructor(
  19785. /**
  19786. * The id of the gamepad
  19787. */
  19788. id: string,
  19789. /**
  19790. * The index of the gamepad
  19791. */
  19792. index: number,
  19793. /**
  19794. * The browser gamepad
  19795. */
  19796. browserGamepad: any, leftStickX?: number, leftStickY?: number, rightStickX?: number, rightStickY?: number);
  19797. /**
  19798. * Callback triggered when the left joystick has changed
  19799. * @param callback
  19800. */
  19801. onleftstickchanged(callback: (values: StickValues) => void): void;
  19802. /**
  19803. * Callback triggered when the right joystick has changed
  19804. * @param callback
  19805. */
  19806. onrightstickchanged(callback: (values: StickValues) => void): void;
  19807. /**
  19808. * Gets the left joystick
  19809. */
  19810. get leftStick(): StickValues;
  19811. /**
  19812. * Sets the left joystick values
  19813. */
  19814. set leftStick(newValues: StickValues);
  19815. /**
  19816. * Gets the right joystick
  19817. */
  19818. get rightStick(): StickValues;
  19819. /**
  19820. * Sets the right joystick value
  19821. */
  19822. set rightStick(newValues: StickValues);
  19823. /**
  19824. * Updates the gamepad joystick positions
  19825. */
  19826. update(): void;
  19827. /**
  19828. * Disposes the gamepad
  19829. */
  19830. dispose(): void;
  19831. }
  19832. /**
  19833. * Represents a generic gamepad
  19834. */
  19835. export class GenericPad extends Gamepad {
  19836. private _buttons;
  19837. private _onbuttondown;
  19838. private _onbuttonup;
  19839. /**
  19840. * Observable triggered when a button has been pressed
  19841. */
  19842. onButtonDownObservable: Observable<number>;
  19843. /**
  19844. * Observable triggered when a button has been released
  19845. */
  19846. onButtonUpObservable: Observable<number>;
  19847. /**
  19848. * Callback triggered when a button has been pressed
  19849. * @param callback Called when a button has been pressed
  19850. */
  19851. onbuttondown(callback: (buttonPressed: number) => void): void;
  19852. /**
  19853. * Callback triggered when a button has been released
  19854. * @param callback Called when a button has been released
  19855. */
  19856. onbuttonup(callback: (buttonReleased: number) => void): void;
  19857. /**
  19858. * Initializes the generic gamepad
  19859. * @param id The id of the generic gamepad
  19860. * @param index The index of the generic gamepad
  19861. * @param browserGamepad The browser gamepad
  19862. */
  19863. constructor(id: string, index: number, browserGamepad: any);
  19864. private _setButtonValue;
  19865. /**
  19866. * Updates the generic gamepad
  19867. */
  19868. update(): void;
  19869. /**
  19870. * Disposes the generic gamepad
  19871. */
  19872. dispose(): void;
  19873. }
  19874. }
  19875. declare module "babylonjs/Gamepads/Controllers/poseEnabledController" {
  19876. import { Observable } from "babylonjs/Misc/observable";
  19877. import { Nullable } from "babylonjs/types";
  19878. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  19879. import { TransformNode } from "babylonjs/Meshes/transformNode";
  19880. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  19881. import { Ray } from "babylonjs/Culling/ray";
  19882. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  19883. import { PoseControlled, DevicePose } from "babylonjs/Cameras/VR/webVRCamera";
  19884. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  19885. /**
  19886. * Defines the types of pose enabled controllers that are supported
  19887. */
  19888. export enum PoseEnabledControllerType {
  19889. /**
  19890. * HTC Vive
  19891. */
  19892. VIVE = 0,
  19893. /**
  19894. * Oculus Rift
  19895. */
  19896. OCULUS = 1,
  19897. /**
  19898. * Windows mixed reality
  19899. */
  19900. WINDOWS = 2,
  19901. /**
  19902. * Samsung gear VR
  19903. */
  19904. GEAR_VR = 3,
  19905. /**
  19906. * Google Daydream
  19907. */
  19908. DAYDREAM = 4,
  19909. /**
  19910. * Generic
  19911. */
  19912. GENERIC = 5
  19913. }
  19914. /**
  19915. * Defines the MutableGamepadButton interface for the state of a gamepad button
  19916. */
  19917. export interface MutableGamepadButton {
  19918. /**
  19919. * Value of the button/trigger
  19920. */
  19921. value: number;
  19922. /**
  19923. * If the button/trigger is currently touched
  19924. */
  19925. touched: boolean;
  19926. /**
  19927. * If the button/trigger is currently pressed
  19928. */
  19929. pressed: boolean;
  19930. }
  19931. /**
  19932. * Defines the ExtendedGamepadButton interface for a gamepad button which includes state provided by a pose controller
  19933. * @hidden
  19934. */
  19935. export interface ExtendedGamepadButton extends GamepadButton {
  19936. /**
  19937. * If the button/trigger is currently pressed
  19938. */
  19939. readonly pressed: boolean;
  19940. /**
  19941. * If the button/trigger is currently touched
  19942. */
  19943. readonly touched: boolean;
  19944. /**
  19945. * Value of the button/trigger
  19946. */
  19947. readonly value: number;
  19948. }
  19949. /** @hidden */
  19950. export interface _GamePadFactory {
  19951. /**
  19952. * Returns whether or not the current gamepad can be created for this type of controller.
  19953. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  19954. * @returns true if it can be created, otherwise false
  19955. */
  19956. canCreate(gamepadInfo: any): boolean;
  19957. /**
  19958. * Creates a new instance of the Gamepad.
  19959. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  19960. * @returns the new gamepad instance
  19961. */
  19962. create(gamepadInfo: any): Gamepad;
  19963. }
  19964. /**
  19965. * Defines the PoseEnabledControllerHelper object that is used initialize a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  19966. */
  19967. export class PoseEnabledControllerHelper {
  19968. /** @hidden */
  19969. static _ControllerFactories: _GamePadFactory[];
  19970. /** @hidden */
  19971. static _DefaultControllerFactory: Nullable<(gamepadInfo: any) => Gamepad>;
  19972. /**
  19973. * Initializes a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  19974. * @param vrGamepad the gamepad to initialized
  19975. * @returns a vr controller of the type the gamepad identified as
  19976. */
  19977. static InitiateController(vrGamepad: any): Gamepad;
  19978. }
  19979. /**
  19980. * Defines the PoseEnabledController object that contains state of a vr capable controller
  19981. */
  19982. export class PoseEnabledController extends Gamepad implements PoseControlled {
  19983. /**
  19984. * If the controller is used in a webXR session
  19985. */
  19986. isXR: boolean;
  19987. private _deviceRoomPosition;
  19988. private _deviceRoomRotationQuaternion;
  19989. /**
  19990. * The device position in babylon space
  19991. */
  19992. devicePosition: Vector3;
  19993. /**
  19994. * The device rotation in babylon space
  19995. */
  19996. deviceRotationQuaternion: Quaternion;
  19997. /**
  19998. * The scale factor of the device in babylon space
  19999. */
  20000. deviceScaleFactor: number;
  20001. /**
  20002. * (Likely devicePosition should be used instead) The device position in its room space
  20003. */
  20004. position: Vector3;
  20005. /**
  20006. * (Likely deviceRotationQuaternion should be used instead) The device rotation in its room space
  20007. */
  20008. rotationQuaternion: Quaternion;
  20009. /**
  20010. * The type of controller (Eg. Windows mixed reality)
  20011. */
  20012. controllerType: PoseEnabledControllerType;
  20013. protected _calculatedPosition: Vector3;
  20014. private _calculatedRotation;
  20015. /**
  20016. * The raw pose from the device
  20017. */
  20018. rawPose: DevicePose;
  20019. private _trackPosition;
  20020. private _maxRotationDistFromHeadset;
  20021. private _draggedRoomRotation;
  20022. /**
  20023. * @hidden
  20024. */
  20025. _disableTrackPosition(fixedPosition: Vector3): void;
  20026. /**
  20027. * Internal, the mesh attached to the controller
  20028. * @hidden
  20029. */
  20030. _mesh: Nullable<AbstractMesh>;
  20031. private _poseControlledCamera;
  20032. private _leftHandSystemQuaternion;
  20033. /**
  20034. * Internal, matrix used to convert room space to babylon space
  20035. * @hidden
  20036. */
  20037. _deviceToWorld: Matrix;
  20038. /**
  20039. * Node to be used when casting a ray from the controller
  20040. * @hidden
  20041. */
  20042. _pointingPoseNode: Nullable<TransformNode>;
  20043. /**
  20044. * Name of the child mesh that can be used to cast a ray from the controller
  20045. */
  20046. static readonly POINTING_POSE: string;
  20047. /**
  20048. * Creates a new PoseEnabledController from a gamepad
  20049. * @param browserGamepad the gamepad that the PoseEnabledController should be created from
  20050. */
  20051. constructor(browserGamepad: any);
  20052. private _workingMatrix;
  20053. /**
  20054. * Updates the state of the pose enbaled controller and mesh based on the current position and rotation of the controller
  20055. */
  20056. update(): void;
  20057. /**
  20058. * Updates only the pose device and mesh without doing any button event checking
  20059. */
  20060. protected _updatePoseAndMesh(): void;
  20061. /**
  20062. * Updates the state of the pose enbaled controller based on the raw pose data from the device
  20063. * @param poseData raw pose fromthe device
  20064. */
  20065. updateFromDevice(poseData: DevicePose): void;
  20066. /**
  20067. * @hidden
  20068. */
  20069. _meshAttachedObservable: Observable<AbstractMesh>;
  20070. /**
  20071. * Attaches a mesh to the controller
  20072. * @param mesh the mesh to be attached
  20073. */
  20074. attachToMesh(mesh: AbstractMesh): void;
  20075. /**
  20076. * Attaches the controllers mesh to a camera
  20077. * @param camera the camera the mesh should be attached to
  20078. */
  20079. attachToPoseControlledCamera(camera: TargetCamera): void;
  20080. /**
  20081. * Disposes of the controller
  20082. */
  20083. dispose(): void;
  20084. /**
  20085. * The mesh that is attached to the controller
  20086. */
  20087. get mesh(): Nullable<AbstractMesh>;
  20088. /**
  20089. * Gets the ray of the controller in the direction the controller is pointing
  20090. * @param length the length the resulting ray should be
  20091. * @returns a ray in the direction the controller is pointing
  20092. */
  20093. getForwardRay(length?: number): Ray;
  20094. }
  20095. }
  20096. declare module "babylonjs/Gamepads/Controllers/webVRController" {
  20097. import { Observable } from "babylonjs/Misc/observable";
  20098. import { Scene } from "babylonjs/scene";
  20099. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20100. import { PoseEnabledController, ExtendedGamepadButton, MutableGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  20101. import { StickValues, GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  20102. import { Nullable } from "babylonjs/types";
  20103. /**
  20104. * Defines the WebVRController object that represents controllers tracked in 3D space
  20105. */
  20106. export abstract class WebVRController extends PoseEnabledController {
  20107. /**
  20108. * Internal, the default controller model for the controller
  20109. */
  20110. protected _defaultModel: Nullable<AbstractMesh>;
  20111. /**
  20112. * Fired when the trigger state has changed
  20113. */
  20114. onTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  20115. /**
  20116. * Fired when the main button state has changed
  20117. */
  20118. onMainButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  20119. /**
  20120. * Fired when the secondary button state has changed
  20121. */
  20122. onSecondaryButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  20123. /**
  20124. * Fired when the pad state has changed
  20125. */
  20126. onPadStateChangedObservable: Observable<ExtendedGamepadButton>;
  20127. /**
  20128. * Fired when controllers stick values have changed
  20129. */
  20130. onPadValuesChangedObservable: Observable<StickValues>;
  20131. /**
  20132. * Array of button availible on the controller
  20133. */
  20134. protected _buttons: Array<MutableGamepadButton>;
  20135. private _onButtonStateChange;
  20136. /**
  20137. * Fired when a controller button's state has changed
  20138. * @param callback the callback containing the button that was modified
  20139. */
  20140. onButtonStateChange(callback: (controlledIndex: number, buttonIndex: number, state: ExtendedGamepadButton) => void): void;
  20141. /**
  20142. * X and Y axis corresponding to the controllers joystick
  20143. */
  20144. pad: StickValues;
  20145. /**
  20146. * 'left' or 'right', see https://w3c.github.io/gamepad/extensions.html#gamepadhand-enum
  20147. */
  20148. hand: string;
  20149. /**
  20150. * The default controller model for the controller
  20151. */
  20152. get defaultModel(): Nullable<AbstractMesh>;
  20153. /**
  20154. * Creates a new WebVRController from a gamepad
  20155. * @param vrGamepad the gamepad that the WebVRController should be created from
  20156. */
  20157. constructor(vrGamepad: any);
  20158. /**
  20159. * Updates the state of the controller and mesh based on the current position and rotation of the controller
  20160. */
  20161. update(): void;
  20162. /**
  20163. * Function to be called when a button is modified
  20164. */
  20165. protected abstract _handleButtonChange(buttonIdx: number, value: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  20166. /**
  20167. * Loads a mesh and attaches it to the controller
  20168. * @param scene the scene the mesh should be added to
  20169. * @param meshLoaded callback for when the mesh has been loaded
  20170. */
  20171. abstract initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  20172. private _setButtonValue;
  20173. private _changes;
  20174. private _checkChanges;
  20175. /**
  20176. * Disposes of th webVRCOntroller
  20177. */
  20178. dispose(): void;
  20179. }
  20180. }
  20181. declare module "babylonjs/Lights/hemisphericLight" {
  20182. import { Nullable } from "babylonjs/types";
  20183. import { Scene } from "babylonjs/scene";
  20184. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  20185. import { Color3 } from "babylonjs/Maths/math.color";
  20186. import { Effect } from "babylonjs/Materials/effect";
  20187. import { Light } from "babylonjs/Lights/light";
  20188. import { IShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  20189. /**
  20190. * The HemisphericLight simulates the ambient environment light,
  20191. * so the passed direction is the light reflection direction, not the incoming direction.
  20192. */
  20193. export class HemisphericLight extends Light {
  20194. /**
  20195. * The groundColor is the light in the opposite direction to the one specified during creation.
  20196. * You can think of the diffuse and specular light as coming from the centre of the object in the given direction and the groundColor light in the opposite direction.
  20197. */
  20198. groundColor: Color3;
  20199. /**
  20200. * The light reflection direction, not the incoming direction.
  20201. */
  20202. direction: Vector3;
  20203. /**
  20204. * Creates a HemisphericLight object in the scene according to the passed direction (Vector3).
  20205. * The HemisphericLight simulates the ambient environment light, so the passed direction is the light reflection direction, not the incoming direction.
  20206. * The HemisphericLight can't cast shadows.
  20207. * Documentation : https://doc.babylonjs.com/babylon101/lights
  20208. * @param name The friendly name of the light
  20209. * @param direction The direction of the light reflection
  20210. * @param scene The scene the light belongs to
  20211. */
  20212. constructor(name: string, direction: Vector3, scene: Scene);
  20213. protected _buildUniformLayout(): void;
  20214. /**
  20215. * Returns the string "HemisphericLight".
  20216. * @return The class name
  20217. */
  20218. getClassName(): string;
  20219. /**
  20220. * Sets the HemisphericLight direction towards the passed target (Vector3).
  20221. * Returns the updated direction.
  20222. * @param target The target the direction should point to
  20223. * @return The computed direction
  20224. */
  20225. setDirectionToTarget(target: Vector3): Vector3;
  20226. /**
  20227. * Returns the shadow generator associated to the light.
  20228. * @returns Always null for hemispheric lights because it does not support shadows.
  20229. */
  20230. getShadowGenerator(): Nullable<IShadowGenerator>;
  20231. /**
  20232. * Sets the passed Effect object with the HemisphericLight normalized direction and color and the passed name (string).
  20233. * @param effect The effect to update
  20234. * @param lightIndex The index of the light in the effect to update
  20235. * @returns The hemispheric light
  20236. */
  20237. transferToEffect(effect: Effect, lightIndex: string): HemisphericLight;
  20238. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  20239. /**
  20240. * Computes the world matrix of the node
  20241. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  20242. * @param useWasUpdatedFlag defines a reserved property
  20243. * @returns the world matrix
  20244. */
  20245. computeWorldMatrix(): Matrix;
  20246. /**
  20247. * Returns the integer 3.
  20248. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  20249. */
  20250. getTypeID(): number;
  20251. /**
  20252. * Prepares the list of defines specific to the light type.
  20253. * @param defines the list of defines
  20254. * @param lightIndex defines the index of the light for the effect
  20255. */
  20256. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  20257. }
  20258. }
  20259. declare module "babylonjs/Shaders/vrMultiviewToSingleview.fragment" {
  20260. /** @hidden */
  20261. export var vrMultiviewToSingleviewPixelShader: {
  20262. name: string;
  20263. shader: string;
  20264. };
  20265. }
  20266. declare module "babylonjs/Materials/Textures/MultiviewRenderTarget" {
  20267. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  20268. import { Scene } from "babylonjs/scene";
  20269. /**
  20270. * Renders to multiple views with a single draw call
  20271. * @see https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/
  20272. */
  20273. export class MultiviewRenderTarget extends RenderTargetTexture {
  20274. /**
  20275. * Creates a multiview render target
  20276. * @param scene scene used with the render target
  20277. * @param size the size of the render target (used for each view)
  20278. */
  20279. constructor(scene: Scene, size?: number | {
  20280. width: number;
  20281. height: number;
  20282. } | {
  20283. ratio: number;
  20284. });
  20285. /**
  20286. * @hidden
  20287. * @param faceIndex the face index, if its a cube texture
  20288. */
  20289. _bindFrameBuffer(faceIndex?: number): void;
  20290. /**
  20291. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  20292. * @returns the view count
  20293. */
  20294. getViewCount(): number;
  20295. }
  20296. }
  20297. declare module "babylonjs/Engines/Extensions/engine.multiview" {
  20298. import { Camera } from "babylonjs/Cameras/camera";
  20299. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  20300. import { Nullable } from "babylonjs/types";
  20301. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  20302. import { Matrix } from "babylonjs/Maths/math.vector";
  20303. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  20304. module "babylonjs/Engines/engine" {
  20305. interface Engine {
  20306. /**
  20307. * Creates a new multiview render target
  20308. * @param width defines the width of the texture
  20309. * @param height defines the height of the texture
  20310. * @returns the created multiview texture
  20311. */
  20312. createMultiviewRenderTargetTexture(width: number, height: number): InternalTexture;
  20313. /**
  20314. * Binds a multiview framebuffer to be drawn to
  20315. * @param multiviewTexture texture to bind
  20316. */
  20317. bindMultiviewFramebuffer(multiviewTexture: InternalTexture): void;
  20318. }
  20319. }
  20320. module "babylonjs/Cameras/camera" {
  20321. interface Camera {
  20322. /**
  20323. * @hidden
  20324. * For cameras that cannot use multiview images to display directly. (e.g. webVR camera will render to multiview texture, then copy to each eye texture and go from there)
  20325. */
  20326. _useMultiviewToSingleView: boolean;
  20327. /**
  20328. * @hidden
  20329. * For cameras that cannot use multiview images to display directly. (e.g. webVR camera will render to multiview texture, then copy to each eye texture and go from there)
  20330. */
  20331. _multiviewTexture: Nullable<RenderTargetTexture>;
  20332. /**
  20333. * @hidden
  20334. * ensures the multiview texture of the camera exists and has the specified width/height
  20335. * @param width height to set on the multiview texture
  20336. * @param height width to set on the multiview texture
  20337. */
  20338. _resizeOrCreateMultiviewTexture(width: number, height: number): void;
  20339. }
  20340. }
  20341. module "babylonjs/scene" {
  20342. interface Scene {
  20343. /** @hidden */
  20344. _transformMatrixR: Matrix;
  20345. /** @hidden */
  20346. _multiviewSceneUbo: Nullable<UniformBuffer>;
  20347. /** @hidden */
  20348. _createMultiviewUbo(): void;
  20349. /** @hidden */
  20350. _updateMultiviewUbo(viewR?: Matrix, projectionR?: Matrix): void;
  20351. /** @hidden */
  20352. _renderMultiviewToSingleView(camera: Camera): void;
  20353. }
  20354. }
  20355. }
  20356. declare module "babylonjs/PostProcesses/vrMultiviewToSingleviewPostProcess" {
  20357. import { Camera } from "babylonjs/Cameras/camera";
  20358. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  20359. import "babylonjs/Shaders/vrMultiviewToSingleview.fragment";
  20360. import "babylonjs/Engines/Extensions/engine.multiview";
  20361. /**
  20362. * VRMultiviewToSingleview used to convert multiview texture arrays to standard textures for scenarios such as webVR
  20363. * This will not be used for webXR as it supports displaying texture arrays directly
  20364. */
  20365. export class VRMultiviewToSingleviewPostProcess extends PostProcess {
  20366. /**
  20367. * Gets a string identifying the name of the class
  20368. * @returns "VRMultiviewToSingleviewPostProcess" string
  20369. */
  20370. getClassName(): string;
  20371. /**
  20372. * Initializes a VRMultiviewToSingleview
  20373. * @param name name of the post process
  20374. * @param camera camera to be applied to
  20375. * @param scaleFactor scaling factor to the size of the output texture
  20376. */
  20377. constructor(name: string, camera: Camera, scaleFactor: number);
  20378. }
  20379. }
  20380. declare module "babylonjs/Cameras/RigModes/webVRRigMode" { }
  20381. declare module "babylonjs/Engines/Extensions/engine.webVR" {
  20382. import { Nullable } from "babylonjs/types";
  20383. import { Size } from "babylonjs/Maths/math.size";
  20384. import { Observable } from "babylonjs/Misc/observable";
  20385. import { WebVROptions } from "babylonjs/Cameras/VR/webVRCamera";
  20386. /**
  20387. * Interface used to define additional presentation attributes
  20388. */
  20389. export interface IVRPresentationAttributes {
  20390. /**
  20391. * Defines a boolean indicating that we want to get 72hz mode on Oculus Browser (default is off eg. 60hz)
  20392. */
  20393. highRefreshRate: boolean;
  20394. /**
  20395. * Enables foveation in VR to improve perf. 0 none, 1 low, 2 medium, 3 high (Default is 1)
  20396. */
  20397. foveationLevel: number;
  20398. }
  20399. module "babylonjs/Engines/engine" {
  20400. interface Engine {
  20401. /** @hidden */
  20402. _vrDisplay: any;
  20403. /** @hidden */
  20404. _vrSupported: boolean;
  20405. /** @hidden */
  20406. _oldSize: Size;
  20407. /** @hidden */
  20408. _oldHardwareScaleFactor: number;
  20409. /** @hidden */
  20410. _vrExclusivePointerMode: boolean;
  20411. /** @hidden */
  20412. _webVRInitPromise: Promise<IDisplayChangedEventArgs>;
  20413. /** @hidden */
  20414. _onVRDisplayPointerRestricted: () => void;
  20415. /** @hidden */
  20416. _onVRDisplayPointerUnrestricted: () => void;
  20417. /** @hidden */
  20418. _onVrDisplayConnect: Nullable<(display: any) => void>;
  20419. /** @hidden */
  20420. _onVrDisplayDisconnect: Nullable<() => void>;
  20421. /** @hidden */
  20422. _onVrDisplayPresentChange: Nullable<() => void>;
  20423. /**
  20424. * Observable signaled when VR display mode changes
  20425. */
  20426. onVRDisplayChangedObservable: Observable<IDisplayChangedEventArgs>;
  20427. /**
  20428. * Observable signaled when VR request present is complete
  20429. */
  20430. onVRRequestPresentComplete: Observable<boolean>;
  20431. /**
  20432. * Observable signaled when VR request present starts
  20433. */
  20434. onVRRequestPresentStart: Observable<Engine>;
  20435. /**
  20436. * Gets a boolean indicating that the engine is currently in VR exclusive mode for the pointers
  20437. * @see https://docs.microsoft.com/en-us/microsoft-edge/webvr/essentials#mouse-input
  20438. */
  20439. isInVRExclusivePointerMode: boolean;
  20440. /**
  20441. * Gets a boolean indicating if a webVR device was detected
  20442. * @returns true if a webVR device was detected
  20443. */
  20444. isVRDevicePresent(): boolean;
  20445. /**
  20446. * Gets the current webVR device
  20447. * @returns the current webVR device (or null)
  20448. */
  20449. getVRDevice(): any;
  20450. /**
  20451. * Initializes a webVR display and starts listening to display change events
  20452. * The onVRDisplayChangedObservable will be notified upon these changes
  20453. * @returns A promise containing a VRDisplay and if vr is supported
  20454. */
  20455. initWebVRAsync(): Promise<IDisplayChangedEventArgs>;
  20456. /** @hidden */
  20457. _getVRDisplaysAsync(): Promise<IDisplayChangedEventArgs>;
  20458. /**
  20459. * Gets or sets the presentation attributes used to configure VR rendering
  20460. */
  20461. vrPresentationAttributes?: IVRPresentationAttributes;
  20462. /**
  20463. * Call this function to switch to webVR mode
  20464. * Will do nothing if webVR is not supported or if there is no webVR device
  20465. * @param options the webvr options provided to the camera. mainly used for multiview
  20466. * @see https://doc.babylonjs.com/how_to/webvr_camera
  20467. */
  20468. enableVR(options: WebVROptions): void;
  20469. /** @hidden */
  20470. _onVRFullScreenTriggered(): void;
  20471. }
  20472. }
  20473. }
  20474. declare module "babylonjs/Cameras/VR/webVRCamera" {
  20475. import { Nullable } from "babylonjs/types";
  20476. import { Observable } from "babylonjs/Misc/observable";
  20477. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  20478. import { Scene } from "babylonjs/scene";
  20479. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  20480. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  20481. import { Node } from "babylonjs/node";
  20482. import { Ray } from "babylonjs/Culling/ray";
  20483. import "babylonjs/Cameras/RigModes/webVRRigMode";
  20484. import "babylonjs/Engines/Extensions/engine.webVR";
  20485. /**
  20486. * This is a copy of VRPose. See https://developer.mozilla.org/en-US/docs/Web/API/VRPose
  20487. * IMPORTANT!! The data is right-hand data.
  20488. * @export
  20489. * @interface DevicePose
  20490. */
  20491. export interface DevicePose {
  20492. /**
  20493. * The position of the device, values in array are [x,y,z].
  20494. */
  20495. readonly position: Nullable<Float32Array>;
  20496. /**
  20497. * The linearVelocity of the device, values in array are [x,y,z].
  20498. */
  20499. readonly linearVelocity: Nullable<Float32Array>;
  20500. /**
  20501. * The linearAcceleration of the device, values in array are [x,y,z].
  20502. */
  20503. readonly linearAcceleration: Nullable<Float32Array>;
  20504. /**
  20505. * The orientation of the device in a quaternion array, values in array are [x,y,z,w].
  20506. */
  20507. readonly orientation: Nullable<Float32Array>;
  20508. /**
  20509. * The angularVelocity of the device, values in array are [x,y,z].
  20510. */
  20511. readonly angularVelocity: Nullable<Float32Array>;
  20512. /**
  20513. * The angularAcceleration of the device, values in array are [x,y,z].
  20514. */
  20515. readonly angularAcceleration: Nullable<Float32Array>;
  20516. }
  20517. /**
  20518. * Interface representing a pose controlled object in Babylon.
  20519. * A pose controlled object has both regular pose values as well as pose values
  20520. * from an external device such as a VR head mounted display
  20521. */
  20522. export interface PoseControlled {
  20523. /**
  20524. * The position of the object in babylon space.
  20525. */
  20526. position: Vector3;
  20527. /**
  20528. * The rotation quaternion of the object in babylon space.
  20529. */
  20530. rotationQuaternion: Quaternion;
  20531. /**
  20532. * The position of the device in babylon space.
  20533. */
  20534. devicePosition?: Vector3;
  20535. /**
  20536. * The rotation quaternion of the device in babylon space.
  20537. */
  20538. deviceRotationQuaternion: Quaternion;
  20539. /**
  20540. * The raw pose coming from the device.
  20541. */
  20542. rawPose: Nullable<DevicePose>;
  20543. /**
  20544. * The scale of the device to be used when translating from device space to babylon space.
  20545. */
  20546. deviceScaleFactor: number;
  20547. /**
  20548. * Updates the poseControlled values based on the input device pose.
  20549. * @param poseData the pose data to update the object with
  20550. */
  20551. updateFromDevice(poseData: DevicePose): void;
  20552. }
  20553. /**
  20554. * Set of options to customize the webVRCamera
  20555. */
  20556. export interface WebVROptions {
  20557. /**
  20558. * Sets if the webVR camera should be tracked to the vrDevice. (default: true)
  20559. */
  20560. trackPosition?: boolean;
  20561. /**
  20562. * Sets the scale of the vrDevice in babylon space. (default: 1)
  20563. */
  20564. positionScale?: number;
  20565. /**
  20566. * If there are more than one VRDisplays, this will choose the display matching this name. (default: pick first vrDisplay)
  20567. */
  20568. displayName?: string;
  20569. /**
  20570. * Should the native controller meshes be initialized. (default: true)
  20571. */
  20572. controllerMeshes?: boolean;
  20573. /**
  20574. * Creating a default HemiLight only on controllers. (default: true)
  20575. */
  20576. defaultLightingOnControllers?: boolean;
  20577. /**
  20578. * If you don't want to use the default VR button of the helper. (default: false)
  20579. */
  20580. useCustomVRButton?: boolean;
  20581. /**
  20582. * If you'd like to provide your own button to the VRHelper. (default: standard babylon vr button)
  20583. */
  20584. customVRButton?: HTMLButtonElement;
  20585. /**
  20586. * To change the length of the ray for gaze/controllers. Will be scaled by positionScale. (default: 100)
  20587. */
  20588. rayLength?: number;
  20589. /**
  20590. * To change the default offset from the ground to account for user's height in meters. Will be scaled by positionScale. (default: 1.7)
  20591. */
  20592. defaultHeight?: number;
  20593. /**
  20594. * If multiview should be used if availible (default: false)
  20595. */
  20596. useMultiview?: boolean;
  20597. }
  20598. /**
  20599. * This represents a WebVR camera.
  20600. * The WebVR camera is Babylon's simple interface to interaction with Windows Mixed Reality, HTC Vive and Oculus Rift.
  20601. * @example https://doc.babylonjs.com/how_to/webvr_camera
  20602. */
  20603. export class WebVRFreeCamera extends FreeCamera implements PoseControlled {
  20604. private webVROptions;
  20605. /**
  20606. * @hidden
  20607. * The vrDisplay tied to the camera. See https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay
  20608. */
  20609. _vrDevice: any;
  20610. /**
  20611. * The rawPose of the vrDevice.
  20612. */
  20613. rawPose: Nullable<DevicePose>;
  20614. private _onVREnabled;
  20615. private _specsVersion;
  20616. private _attached;
  20617. private _frameData;
  20618. protected _descendants: Array<Node>;
  20619. private _deviceRoomPosition;
  20620. /** @hidden */
  20621. _deviceRoomRotationQuaternion: Quaternion;
  20622. private _standingMatrix;
  20623. /**
  20624. * Represents device position in babylon space.
  20625. */
  20626. devicePosition: Vector3;
  20627. /**
  20628. * Represents device rotation in babylon space.
  20629. */
  20630. deviceRotationQuaternion: Quaternion;
  20631. /**
  20632. * The scale of the device to be used when translating from device space to babylon space.
  20633. */
  20634. deviceScaleFactor: number;
  20635. private _deviceToWorld;
  20636. private _worldToDevice;
  20637. /**
  20638. * References to the webVR controllers for the vrDevice.
  20639. */
  20640. controllers: Array<WebVRController>;
  20641. /**
  20642. * Emits an event when a controller is attached.
  20643. */
  20644. onControllersAttachedObservable: Observable<WebVRController[]>;
  20645. /**
  20646. * Emits an event when a controller's mesh has been loaded;
  20647. */
  20648. onControllerMeshLoadedObservable: Observable<WebVRController>;
  20649. /**
  20650. * Emits an event when the HMD's pose has been updated.
  20651. */
  20652. onPoseUpdatedFromDeviceObservable: Observable<any>;
  20653. private _poseSet;
  20654. /**
  20655. * If the rig cameras be used as parent instead of this camera.
  20656. */
  20657. rigParenting: boolean;
  20658. private _lightOnControllers;
  20659. private _defaultHeight?;
  20660. /**
  20661. * Instantiates a WebVRFreeCamera.
  20662. * @param name The name of the WebVRFreeCamera
  20663. * @param position The starting anchor position for the camera
  20664. * @param scene The scene the camera belongs to
  20665. * @param webVROptions a set of customizable options for the webVRCamera
  20666. */
  20667. constructor(name: string, position: Vector3, scene: Scene, webVROptions?: WebVROptions);
  20668. /**
  20669. * Gets the device distance from the ground in meters.
  20670. * @returns the distance in meters from the vrDevice to ground in device space. If standing matrix is not supported for the vrDevice 0 is returned.
  20671. */
  20672. deviceDistanceToRoomGround(): number;
  20673. /**
  20674. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  20675. * @param callback will be called when the standing matrix is set. Callback parameter is if the standing matrix is supported.
  20676. */
  20677. useStandingMatrix(callback?: (bool: boolean) => void): void;
  20678. /**
  20679. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  20680. * @returns A promise with a boolean set to if the standing matrix is supported.
  20681. */
  20682. useStandingMatrixAsync(): Promise<boolean>;
  20683. /**
  20684. * Disposes the camera
  20685. */
  20686. dispose(): void;
  20687. /**
  20688. * Gets a vrController by name.
  20689. * @param name The name of the controller to retreive
  20690. * @returns the controller matching the name specified or null if not found
  20691. */
  20692. getControllerByName(name: string): Nullable<WebVRController>;
  20693. private _leftController;
  20694. /**
  20695. * The controller corresponding to the users left hand.
  20696. */
  20697. get leftController(): Nullable<WebVRController>;
  20698. private _rightController;
  20699. /**
  20700. * The controller corresponding to the users right hand.
  20701. */
  20702. get rightController(): Nullable<WebVRController>;
  20703. /**
  20704. * Casts a ray forward from the vrCamera's gaze.
  20705. * @param length Length of the ray (default: 100)
  20706. * @returns the ray corresponding to the gaze
  20707. */
  20708. getForwardRay(length?: number): Ray;
  20709. /**
  20710. * @hidden
  20711. * Updates the camera based on device's frame data
  20712. */
  20713. _checkInputs(): void;
  20714. /**
  20715. * Updates the poseControlled values based on the input device pose.
  20716. * @param poseData Pose coming from the device
  20717. */
  20718. updateFromDevice(poseData: DevicePose): void;
  20719. private _htmlElementAttached;
  20720. private _detachIfAttached;
  20721. /**
  20722. * WebVR's attach control will start broadcasting frames to the device.
  20723. * Note that in certain browsers (chrome for example) this function must be called
  20724. * within a user-interaction callback. Example:
  20725. * <pre> scene.onPointerDown = function() { camera.attachControl(canvas); }</pre>
  20726. *
  20727. * @param element html element to attach the vrDevice to
  20728. * @param noPreventDefault prevent the default html element operation when attaching the vrDevice
  20729. */
  20730. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  20731. /**
  20732. * Detaches the camera from the html element and disables VR
  20733. *
  20734. * @param element html element to detach from
  20735. */
  20736. detachControl(element: HTMLElement): void;
  20737. /**
  20738. * @returns the name of this class
  20739. */
  20740. getClassName(): string;
  20741. /**
  20742. * Calls resetPose on the vrDisplay
  20743. * See: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/resetPose
  20744. */
  20745. resetToCurrentRotation(): void;
  20746. /**
  20747. * @hidden
  20748. * Updates the rig cameras (left and right eye)
  20749. */
  20750. _updateRigCameras(): void;
  20751. private _workingVector;
  20752. private _oneVector;
  20753. private _workingMatrix;
  20754. private updateCacheCalled;
  20755. private _correctPositionIfNotTrackPosition;
  20756. /**
  20757. * @hidden
  20758. * Updates the cached values of the camera
  20759. * @param ignoreParentClass ignores updating the parent class's cache (default: false)
  20760. */
  20761. _updateCache(ignoreParentClass?: boolean): void;
  20762. /**
  20763. * @hidden
  20764. * Get current device position in babylon world
  20765. */
  20766. _computeDevicePosition(): void;
  20767. /**
  20768. * Updates the current device position and rotation in the babylon world
  20769. */
  20770. update(): void;
  20771. /**
  20772. * @hidden
  20773. * Gets the view matrix of this camera (Always set to identity as left and right eye cameras contain the actual view matrix)
  20774. * @returns an identity matrix
  20775. */
  20776. _getViewMatrix(): Matrix;
  20777. private _tmpMatrix;
  20778. /**
  20779. * This function is called by the two RIG cameras.
  20780. * 'this' is the left or right camera (and NOT (!!!) the WebVRFreeCamera instance)
  20781. * @hidden
  20782. */
  20783. _getWebVRViewMatrix(): Matrix;
  20784. /** @hidden */
  20785. _getWebVRProjectionMatrix(): Matrix;
  20786. private _onGamepadConnectedObserver;
  20787. private _onGamepadDisconnectedObserver;
  20788. private _updateCacheWhenTrackingDisabledObserver;
  20789. /**
  20790. * Initializes the controllers and their meshes
  20791. */
  20792. initControllers(): void;
  20793. }
  20794. }
  20795. declare module "babylonjs/Materials/materialHelper" {
  20796. import { Nullable } from "babylonjs/types";
  20797. import { Scene } from "babylonjs/scene";
  20798. import { Engine } from "babylonjs/Engines/engine";
  20799. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20800. import { Light } from "babylonjs/Lights/light";
  20801. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  20802. import { Effect, IEffectCreationOptions } from "babylonjs/Materials/effect";
  20803. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  20804. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  20805. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  20806. /**
  20807. * "Static Class" containing the most commonly used helper while dealing with material for rendering purpose.
  20808. *
  20809. * It contains the basic tools to help defining defines, binding uniform for the common part of the materials.
  20810. *
  20811. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  20812. */
  20813. export class MaterialHelper {
  20814. /**
  20815. * Bind the current view position to an effect.
  20816. * @param effect The effect to be bound
  20817. * @param scene The scene the eyes position is used from
  20818. * @param variableName name of the shader variable that will hold the eye position
  20819. */
  20820. static BindEyePosition(effect: Effect, scene: Scene, variableName?: string): void;
  20821. /**
  20822. * Helps preparing the defines values about the UVs in used in the effect.
  20823. * UVs are shared as much as we can accross channels in the shaders.
  20824. * @param texture The texture we are preparing the UVs for
  20825. * @param defines The defines to update
  20826. * @param key The channel key "diffuse", "specular"... used in the shader
  20827. */
  20828. static PrepareDefinesForMergedUV(texture: BaseTexture, defines: any, key: string): void;
  20829. /**
  20830. * Binds a texture matrix value to its corrsponding uniform
  20831. * @param texture The texture to bind the matrix for
  20832. * @param uniformBuffer The uniform buffer receivin the data
  20833. * @param key The channel key "diffuse", "specular"... used in the shader
  20834. */
  20835. static BindTextureMatrix(texture: BaseTexture, uniformBuffer: UniformBuffer, key: string): void;
  20836. /**
  20837. * Gets the current status of the fog (should it be enabled?)
  20838. * @param mesh defines the mesh to evaluate for fog support
  20839. * @param scene defines the hosting scene
  20840. * @returns true if fog must be enabled
  20841. */
  20842. static GetFogState(mesh: AbstractMesh, scene: Scene): boolean;
  20843. /**
  20844. * Helper used to prepare the list of defines associated with misc. values for shader compilation
  20845. * @param mesh defines the current mesh
  20846. * @param scene defines the current scene
  20847. * @param useLogarithmicDepth defines if logarithmic depth has to be turned on
  20848. * @param pointsCloud defines if point cloud rendering has to be turned on
  20849. * @param fogEnabled defines if fog has to be turned on
  20850. * @param alphaTest defines if alpha testing has to be turned on
  20851. * @param defines defines the current list of defines
  20852. */
  20853. static PrepareDefinesForMisc(mesh: AbstractMesh, scene: Scene, useLogarithmicDepth: boolean, pointsCloud: boolean, fogEnabled: boolean, alphaTest: boolean, defines: any): void;
  20854. /**
  20855. * Helper used to prepare the list of defines associated with frame values for shader compilation
  20856. * @param scene defines the current scene
  20857. * @param engine defines the current engine
  20858. * @param defines specifies the list of active defines
  20859. * @param useInstances defines if instances have to be turned on
  20860. * @param useClipPlane defines if clip plane have to be turned on
  20861. * @param useInstances defines if instances have to be turned on
  20862. * @param useThinInstances defines if thin instances have to be turned on
  20863. */
  20864. static PrepareDefinesForFrameBoundValues(scene: Scene, engine: Engine, defines: any, useInstances: boolean, useClipPlane?: Nullable<boolean>, useThinInstances?: boolean): void;
  20865. /**
  20866. * Prepares the defines for bones
  20867. * @param mesh The mesh containing the geometry data we will draw
  20868. * @param defines The defines to update
  20869. */
  20870. static PrepareDefinesForBones(mesh: AbstractMesh, defines: any): void;
  20871. /**
  20872. * Prepares the defines for morph targets
  20873. * @param mesh The mesh containing the geometry data we will draw
  20874. * @param defines The defines to update
  20875. */
  20876. static PrepareDefinesForMorphTargets(mesh: AbstractMesh, defines: any): void;
  20877. /**
  20878. * Prepares the defines used in the shader depending on the attributes data available in the mesh
  20879. * @param mesh The mesh containing the geometry data we will draw
  20880. * @param defines The defines to update
  20881. * @param useVertexColor Precise whether vertex colors should be used or not (override mesh info)
  20882. * @param useBones Precise whether bones should be used or not (override mesh info)
  20883. * @param useMorphTargets Precise whether morph targets should be used or not (override mesh info)
  20884. * @param useVertexAlpha Precise whether vertex alpha should be used or not (override mesh info)
  20885. * @returns false if defines are considered not dirty and have not been checked
  20886. */
  20887. static PrepareDefinesForAttributes(mesh: AbstractMesh, defines: any, useVertexColor: boolean, useBones: boolean, useMorphTargets?: boolean, useVertexAlpha?: boolean): boolean;
  20888. /**
  20889. * Prepares the defines related to multiview
  20890. * @param scene The scene we are intending to draw
  20891. * @param defines The defines to update
  20892. */
  20893. static PrepareDefinesForMultiview(scene: Scene, defines: any): void;
  20894. /**
  20895. * Prepares the defines related to the prepass
  20896. * @param scene The scene we are intending to draw
  20897. * @param defines The defines to update
  20898. * @param canRenderToMRT Indicates if this material renders to several textures in the prepass
  20899. */
  20900. static PrepareDefinesForPrePass(scene: Scene, defines: any, canRenderToMRT: boolean): void;
  20901. /**
  20902. * Prepares the defines related to the light information passed in parameter
  20903. * @param scene The scene we are intending to draw
  20904. * @param mesh The mesh the effect is compiling for
  20905. * @param light The light the effect is compiling for
  20906. * @param lightIndex The index of the light
  20907. * @param defines The defines to update
  20908. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  20909. * @param state Defines the current state regarding what is needed (normals, etc...)
  20910. */
  20911. static PrepareDefinesForLight(scene: Scene, mesh: AbstractMesh, light: Light, lightIndex: number, defines: any, specularSupported: boolean, state: {
  20912. needNormals: boolean;
  20913. needRebuild: boolean;
  20914. shadowEnabled: boolean;
  20915. specularEnabled: boolean;
  20916. lightmapMode: boolean;
  20917. }): void;
  20918. /**
  20919. * Prepares the defines related to the light information passed in parameter
  20920. * @param scene The scene we are intending to draw
  20921. * @param mesh The mesh the effect is compiling for
  20922. * @param defines The defines to update
  20923. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  20924. * @param maxSimultaneousLights Specfies how manuy lights can be added to the effect at max
  20925. * @param disableLighting Specifies whether the lighting is disabled (override scene and light)
  20926. * @returns true if normals will be required for the rest of the effect
  20927. */
  20928. static PrepareDefinesForLights(scene: Scene, mesh: AbstractMesh, defines: any, specularSupported: boolean, maxSimultaneousLights?: number, disableLighting?: boolean): boolean;
  20929. /**
  20930. * Prepares the uniforms and samplers list to be used in the effect (for a specific light)
  20931. * @param lightIndex defines the light index
  20932. * @param uniformsList The uniform list
  20933. * @param samplersList The sampler list
  20934. * @param projectedLightTexture defines if projected texture must be used
  20935. * @param uniformBuffersList defines an optional list of uniform buffers
  20936. */
  20937. static PrepareUniformsAndSamplersForLight(lightIndex: number, uniformsList: string[], samplersList: string[], projectedLightTexture?: any, uniformBuffersList?: Nullable<string[]>): void;
  20938. /**
  20939. * Prepares the uniforms and samplers list to be used in the effect
  20940. * @param uniformsListOrOptions The uniform names to prepare or an EffectCreationOptions containing the liist and extra information
  20941. * @param samplersList The sampler list
  20942. * @param defines The defines helping in the list generation
  20943. * @param maxSimultaneousLights The maximum number of simultanous light allowed in the effect
  20944. */
  20945. static PrepareUniformsAndSamplersList(uniformsListOrOptions: string[] | IEffectCreationOptions, samplersList?: string[], defines?: any, maxSimultaneousLights?: number): void;
  20946. /**
  20947. * This helps decreasing rank by rank the shadow quality (0 being the highest rank and quality)
  20948. * @param defines The defines to update while falling back
  20949. * @param fallbacks The authorized effect fallbacks
  20950. * @param maxSimultaneousLights The maximum number of lights allowed
  20951. * @param rank the current rank of the Effect
  20952. * @returns The newly affected rank
  20953. */
  20954. static HandleFallbacksForShadows(defines: any, fallbacks: EffectFallbacks, maxSimultaneousLights?: number, rank?: number): number;
  20955. private static _TmpMorphInfluencers;
  20956. /**
  20957. * Prepares the list of attributes required for morph targets according to the effect defines.
  20958. * @param attribs The current list of supported attribs
  20959. * @param mesh The mesh to prepare the morph targets attributes for
  20960. * @param influencers The number of influencers
  20961. */
  20962. static PrepareAttributesForMorphTargetsInfluencers(attribs: string[], mesh: AbstractMesh, influencers: number): void;
  20963. /**
  20964. * Prepares the list of attributes required for morph targets according to the effect defines.
  20965. * @param attribs The current list of supported attribs
  20966. * @param mesh The mesh to prepare the morph targets attributes for
  20967. * @param defines The current Defines of the effect
  20968. */
  20969. static PrepareAttributesForMorphTargets(attribs: string[], mesh: AbstractMesh, defines: any): void;
  20970. /**
  20971. * Prepares the list of attributes required for bones according to the effect defines.
  20972. * @param attribs The current list of supported attribs
  20973. * @param mesh The mesh to prepare the bones attributes for
  20974. * @param defines The current Defines of the effect
  20975. * @param fallbacks The current efffect fallback strategy
  20976. */
  20977. static PrepareAttributesForBones(attribs: string[], mesh: AbstractMesh, defines: any, fallbacks: EffectFallbacks): void;
  20978. /**
  20979. * Check and prepare the list of attributes required for instances according to the effect defines.
  20980. * @param attribs The current list of supported attribs
  20981. * @param defines The current MaterialDefines of the effect
  20982. */
  20983. static PrepareAttributesForInstances(attribs: string[], defines: MaterialDefines): void;
  20984. /**
  20985. * Add the list of attributes required for instances to the attribs array.
  20986. * @param attribs The current list of supported attribs
  20987. */
  20988. static PushAttributesForInstances(attribs: string[]): void;
  20989. /**
  20990. * Binds the light information to the effect.
  20991. * @param light The light containing the generator
  20992. * @param effect The effect we are binding the data to
  20993. * @param lightIndex The light index in the effect used to render
  20994. */
  20995. static BindLightProperties(light: Light, effect: Effect, lightIndex: number): void;
  20996. /**
  20997. * Binds the lights information from the scene to the effect for the given mesh.
  20998. * @param light Light to bind
  20999. * @param lightIndex Light index
  21000. * @param scene The scene where the light belongs to
  21001. * @param effect The effect we are binding the data to
  21002. * @param useSpecular Defines if specular is supported
  21003. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  21004. */
  21005. static BindLight(light: Light, lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  21006. /**
  21007. * Binds the lights information from the scene to the effect for the given mesh.
  21008. * @param scene The scene the lights belongs to
  21009. * @param mesh The mesh we are binding the information to render
  21010. * @param effect The effect we are binding the data to
  21011. * @param defines The generated defines for the effect
  21012. * @param maxSimultaneousLights The maximum number of light that can be bound to the effect
  21013. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  21014. */
  21015. static BindLights(scene: Scene, mesh: AbstractMesh, effect: Effect, defines: any, maxSimultaneousLights?: number, rebuildInParallel?: boolean): void;
  21016. private static _tempFogColor;
  21017. /**
  21018. * Binds the fog information from the scene to the effect for the given mesh.
  21019. * @param scene The scene the lights belongs to
  21020. * @param mesh The mesh we are binding the information to render
  21021. * @param effect The effect we are binding the data to
  21022. * @param linearSpace Defines if the fog effect is applied in linear space
  21023. */
  21024. static BindFogParameters(scene: Scene, mesh: AbstractMesh, effect: Effect, linearSpace?: boolean): void;
  21025. /**
  21026. * Binds the bones information from the mesh to the effect.
  21027. * @param mesh The mesh we are binding the information to render
  21028. * @param effect The effect we are binding the data to
  21029. */
  21030. static BindBonesParameters(mesh?: AbstractMesh, effect?: Effect): void;
  21031. /**
  21032. * Binds the morph targets information from the mesh to the effect.
  21033. * @param abstractMesh The mesh we are binding the information to render
  21034. * @param effect The effect we are binding the data to
  21035. */
  21036. static BindMorphTargetParameters(abstractMesh: AbstractMesh, effect: Effect): void;
  21037. /**
  21038. * Binds the logarithmic depth information from the scene to the effect for the given defines.
  21039. * @param defines The generated defines used in the effect
  21040. * @param effect The effect we are binding the data to
  21041. * @param scene The scene we are willing to render with logarithmic scale for
  21042. */
  21043. static BindLogDepth(defines: any, effect: Effect, scene: Scene): void;
  21044. /**
  21045. * Binds the clip plane information from the scene to the effect.
  21046. * @param scene The scene the clip plane information are extracted from
  21047. * @param effect The effect we are binding the data to
  21048. */
  21049. static BindClipPlane(effect: Effect, scene: Scene): void;
  21050. }
  21051. }
  21052. declare module "babylonjs/Materials/Node/Blocks/Input/inputBlock" {
  21053. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21054. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  21055. import { NodeMaterialSystemValues } from "babylonjs/Materials/Node/Enums/nodeMaterialSystemValues";
  21056. import { Nullable } from "babylonjs/types";
  21057. import { Effect } from "babylonjs/Materials/effect";
  21058. import { Matrix } from "babylonjs/Maths/math.vector";
  21059. import { Scene } from "babylonjs/scene";
  21060. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21061. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21062. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  21063. import { AnimatedInputBlockTypes } from "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes";
  21064. import { Observable } from "babylonjs/Misc/observable";
  21065. /**
  21066. * Block used to expose an input value
  21067. */
  21068. export class InputBlock extends NodeMaterialBlock {
  21069. private _mode;
  21070. private _associatedVariableName;
  21071. private _storedValue;
  21072. private _valueCallback;
  21073. private _type;
  21074. private _animationType;
  21075. /** Gets or set a value used to limit the range of float values */
  21076. min: number;
  21077. /** Gets or set a value used to limit the range of float values */
  21078. max: number;
  21079. /** Gets or set a value indicating that this input can only get 0 and 1 values */
  21080. isBoolean: boolean;
  21081. /** Gets or sets a value used by the Node Material editor to determine how to configure the current value if it is a matrix */
  21082. matrixMode: number;
  21083. /** @hidden */
  21084. _systemValue: Nullable<NodeMaterialSystemValues>;
  21085. /** Gets or sets a boolean indicating that this input can be edited in the Inspector (false by default) */
  21086. visibleInInspector: boolean;
  21087. /** Gets or sets a boolean indicating that the value of this input will not change after a build */
  21088. isConstant: boolean;
  21089. /** Gets or sets the group to use to display this block in the Inspector */
  21090. groupInInspector: string;
  21091. /** Gets an observable raised when the value is changed */
  21092. onValueChangedObservable: Observable<InputBlock>;
  21093. /**
  21094. * Gets or sets the connection point type (default is float)
  21095. */
  21096. get type(): NodeMaterialBlockConnectionPointTypes;
  21097. /**
  21098. * Creates a new InputBlock
  21099. * @param name defines the block name
  21100. * @param target defines the target of that block (Vertex by default)
  21101. * @param type defines the type of the input (can be set to NodeMaterialBlockConnectionPointTypes.AutoDetect)
  21102. */
  21103. constructor(name: string, target?: NodeMaterialBlockTargets, type?: NodeMaterialBlockConnectionPointTypes);
  21104. /**
  21105. * Validates if a name is a reserve word.
  21106. * @param newName the new name to be given to the node.
  21107. * @returns false if the name is a reserve word, else true.
  21108. */
  21109. validateBlockName(newName: string): boolean;
  21110. /**
  21111. * Gets the output component
  21112. */
  21113. get output(): NodeMaterialConnectionPoint;
  21114. /**
  21115. * Set the source of this connection point to a vertex attribute
  21116. * @param attributeName defines the attribute name (position, uv, normal, etc...). If not specified it will take the connection point name
  21117. * @returns the current connection point
  21118. */
  21119. setAsAttribute(attributeName?: string): InputBlock;
  21120. /**
  21121. * Set the source of this connection point to a system value
  21122. * @param value define the system value to use (world, view, etc...) or null to switch to manual value
  21123. * @returns the current connection point
  21124. */
  21125. setAsSystemValue(value: Nullable<NodeMaterialSystemValues>): InputBlock;
  21126. /**
  21127. * Gets or sets the value of that point.
  21128. * Please note that this value will be ignored if valueCallback is defined
  21129. */
  21130. get value(): any;
  21131. set value(value: any);
  21132. /**
  21133. * Gets or sets a callback used to get the value of that point.
  21134. * Please note that setting this value will force the connection point to ignore the value property
  21135. */
  21136. get valueCallback(): () => any;
  21137. set valueCallback(value: () => any);
  21138. /**
  21139. * Gets or sets the associated variable name in the shader
  21140. */
  21141. get associatedVariableName(): string;
  21142. set associatedVariableName(value: string);
  21143. /** Gets or sets the type of animation applied to the input */
  21144. get animationType(): AnimatedInputBlockTypes;
  21145. set animationType(value: AnimatedInputBlockTypes);
  21146. /**
  21147. * Gets a boolean indicating that this connection point not defined yet
  21148. */
  21149. get isUndefined(): boolean;
  21150. /**
  21151. * Gets or sets a boolean indicating that this connection point is coming from an uniform.
  21152. * In this case the connection point name must be the name of the uniform to use.
  21153. * Can only be set on inputs
  21154. */
  21155. get isUniform(): boolean;
  21156. set isUniform(value: boolean);
  21157. /**
  21158. * Gets or sets a boolean indicating that this connection point is coming from an attribute.
  21159. * In this case the connection point name must be the name of the attribute to use
  21160. * Can only be set on inputs
  21161. */
  21162. get isAttribute(): boolean;
  21163. set isAttribute(value: boolean);
  21164. /**
  21165. * Gets or sets a boolean indicating that this connection point is generating a varying variable.
  21166. * Can only be set on exit points
  21167. */
  21168. get isVarying(): boolean;
  21169. set isVarying(value: boolean);
  21170. /**
  21171. * Gets a boolean indicating that the current connection point is a system value
  21172. */
  21173. get isSystemValue(): boolean;
  21174. /**
  21175. * Gets or sets the current well known value or null if not defined as a system value
  21176. */
  21177. get systemValue(): Nullable<NodeMaterialSystemValues>;
  21178. set systemValue(value: Nullable<NodeMaterialSystemValues>);
  21179. /**
  21180. * Gets the current class name
  21181. * @returns the class name
  21182. */
  21183. getClassName(): string;
  21184. /**
  21185. * Animate the input if animationType !== None
  21186. * @param scene defines the rendering scene
  21187. */
  21188. animate(scene: Scene): void;
  21189. private _emitDefine;
  21190. initialize(state: NodeMaterialBuildState): void;
  21191. /**
  21192. * Set the input block to its default value (based on its type)
  21193. */
  21194. setDefaultValue(): void;
  21195. private _emitConstant;
  21196. /** @hidden */
  21197. get _noContextSwitch(): boolean;
  21198. private _emit;
  21199. /** @hidden */
  21200. _transmitWorld(effect: Effect, world: Matrix, worldView: Matrix, worldViewProjection: Matrix): void;
  21201. /** @hidden */
  21202. _transmit(effect: Effect, scene: Scene): void;
  21203. protected _buildBlock(state: NodeMaterialBuildState): void;
  21204. protected _dumpPropertiesCode(): string;
  21205. dispose(): void;
  21206. serialize(): any;
  21207. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21208. }
  21209. }
  21210. declare module "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint" {
  21211. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  21212. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  21213. import { Nullable } from "babylonjs/types";
  21214. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  21215. import { Observable } from "babylonjs/Misc/observable";
  21216. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21217. /**
  21218. * Enum used to define the compatibility state between two connection points
  21219. */
  21220. export enum NodeMaterialConnectionPointCompatibilityStates {
  21221. /** Points are compatibles */
  21222. Compatible = 0,
  21223. /** Points are incompatible because of their types */
  21224. TypeIncompatible = 1,
  21225. /** Points are incompatible because of their targets (vertex vs fragment) */
  21226. TargetIncompatible = 2
  21227. }
  21228. /**
  21229. * Defines the direction of a connection point
  21230. */
  21231. export enum NodeMaterialConnectionPointDirection {
  21232. /** Input */
  21233. Input = 0,
  21234. /** Output */
  21235. Output = 1
  21236. }
  21237. /**
  21238. * Defines a connection point for a block
  21239. */
  21240. export class NodeMaterialConnectionPoint {
  21241. /** @hidden */
  21242. _ownerBlock: NodeMaterialBlock;
  21243. /** @hidden */
  21244. _connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  21245. private _endpoints;
  21246. private _associatedVariableName;
  21247. private _direction;
  21248. /** @hidden */
  21249. _typeConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  21250. /** @hidden */
  21251. _linkedConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  21252. private _type;
  21253. /** @hidden */
  21254. _enforceAssociatedVariableName: boolean;
  21255. /** Gets the direction of the point */
  21256. get direction(): NodeMaterialConnectionPointDirection;
  21257. /** Indicates that this connection point needs dual validation before being connected to another point */
  21258. needDualDirectionValidation: boolean;
  21259. /**
  21260. * Gets or sets the additional types supported by this connection point
  21261. */
  21262. acceptedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  21263. /**
  21264. * Gets or sets the additional types excluded by this connection point
  21265. */
  21266. excludedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  21267. /**
  21268. * Observable triggered when this point is connected
  21269. */
  21270. onConnectionObservable: Observable<NodeMaterialConnectionPoint>;
  21271. /**
  21272. * Gets or sets the associated variable name in the shader
  21273. */
  21274. get associatedVariableName(): string;
  21275. set associatedVariableName(value: string);
  21276. /** Get the inner type (ie AutoDetect for instance instead of the inferred one) */
  21277. get innerType(): NodeMaterialBlockConnectionPointTypes;
  21278. /**
  21279. * Gets or sets the connection point type (default is float)
  21280. */
  21281. get type(): NodeMaterialBlockConnectionPointTypes;
  21282. set type(value: NodeMaterialBlockConnectionPointTypes);
  21283. /**
  21284. * Gets or sets the connection point name
  21285. */
  21286. name: string;
  21287. /**
  21288. * Gets or sets the connection point name
  21289. */
  21290. displayName: string;
  21291. /**
  21292. * Gets or sets a boolean indicating that this connection point can be omitted
  21293. */
  21294. isOptional: boolean;
  21295. /**
  21296. * Gets or sets a boolean indicating that this connection point is exposed on a frame
  21297. */
  21298. isExposedOnFrame: boolean;
  21299. /**
  21300. * Gets or sets a string indicating that this uniform must be defined under a #ifdef
  21301. */
  21302. define: string;
  21303. /** @hidden */
  21304. _prioritizeVertex: boolean;
  21305. private _target;
  21306. /** Gets or sets the target of that connection point */
  21307. get target(): NodeMaterialBlockTargets;
  21308. set target(value: NodeMaterialBlockTargets);
  21309. /**
  21310. * Gets a boolean indicating that the current point is connected to another NodeMaterialBlock
  21311. */
  21312. get isConnected(): boolean;
  21313. /**
  21314. * Gets a boolean indicating that the current point is connected to an input block
  21315. */
  21316. get isConnectedToInputBlock(): boolean;
  21317. /**
  21318. * Gets a the connected input block (if any)
  21319. */
  21320. get connectInputBlock(): Nullable<InputBlock>;
  21321. /** Get the other side of the connection (if any) */
  21322. get connectedPoint(): Nullable<NodeMaterialConnectionPoint>;
  21323. /** Get the block that owns this connection point */
  21324. get ownerBlock(): NodeMaterialBlock;
  21325. /** Get the block connected on the other side of this connection (if any) */
  21326. get sourceBlock(): Nullable<NodeMaterialBlock>;
  21327. /** Get the block connected on the endpoints of this connection (if any) */
  21328. get connectedBlocks(): Array<NodeMaterialBlock>;
  21329. /** Gets the list of connected endpoints */
  21330. get endpoints(): NodeMaterialConnectionPoint[];
  21331. /** Gets a boolean indicating if that output point is connected to at least one input */
  21332. get hasEndpoints(): boolean;
  21333. /** Gets a boolean indicating that this connection will be used in the vertex shader */
  21334. get isConnectedInVertexShader(): boolean;
  21335. /** Gets a boolean indicating that this connection will be used in the fragment shader */
  21336. get isConnectedInFragmentShader(): boolean;
  21337. /**
  21338. * Creates a block suitable to be used as an input for this input point.
  21339. * If null is returned, a block based on the point type will be created.
  21340. * @returns The returned string parameter is the name of the output point of NodeMaterialBlock (first parameter of the returned array) that can be connected to the input
  21341. */
  21342. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  21343. /**
  21344. * Creates a new connection point
  21345. * @param name defines the connection point name
  21346. * @param ownerBlock defines the block hosting this connection point
  21347. * @param direction defines the direction of the connection point
  21348. */
  21349. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection);
  21350. /**
  21351. * Gets the current class name e.g. "NodeMaterialConnectionPoint"
  21352. * @returns the class name
  21353. */
  21354. getClassName(): string;
  21355. /**
  21356. * Gets a boolean indicating if the current point can be connected to another point
  21357. * @param connectionPoint defines the other connection point
  21358. * @returns a boolean
  21359. */
  21360. canConnectTo(connectionPoint: NodeMaterialConnectionPoint): boolean;
  21361. /**
  21362. * Gets a number indicating if the current point can be connected to another point
  21363. * @param connectionPoint defines the other connection point
  21364. * @returns a number defining the compatibility state
  21365. */
  21366. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  21367. /**
  21368. * Connect this point to another connection point
  21369. * @param connectionPoint defines the other connection point
  21370. * @param ignoreConstraints defines if the system will ignore connection type constraints (default is false)
  21371. * @returns the current connection point
  21372. */
  21373. connectTo(connectionPoint: NodeMaterialConnectionPoint, ignoreConstraints?: boolean): NodeMaterialConnectionPoint;
  21374. /**
  21375. * Disconnect this point from one of his endpoint
  21376. * @param endpoint defines the other connection point
  21377. * @returns the current connection point
  21378. */
  21379. disconnectFrom(endpoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPoint;
  21380. /**
  21381. * Serializes this point in a JSON representation
  21382. * @param isInput defines if the connection point is an input (default is true)
  21383. * @returns the serialized point object
  21384. */
  21385. serialize(isInput?: boolean): any;
  21386. /**
  21387. * Release resources
  21388. */
  21389. dispose(): void;
  21390. }
  21391. }
  21392. declare module "babylonjs/Materials/Node/Enums/nodeMaterialModes" {
  21393. /**
  21394. * Enum used to define the material modes
  21395. */
  21396. export enum NodeMaterialModes {
  21397. /** Regular material */
  21398. Material = 0,
  21399. /** For post process */
  21400. PostProcess = 1,
  21401. /** For particle system */
  21402. Particle = 2
  21403. }
  21404. }
  21405. declare module "babylonjs/Materials/Node/Blocks/Dual/textureBlock" {
  21406. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21407. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21408. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  21409. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21410. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21411. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21412. import { Effect } from "babylonjs/Materials/effect";
  21413. import { Mesh } from "babylonjs/Meshes/mesh";
  21414. import { Nullable } from "babylonjs/types";
  21415. import { Texture } from "babylonjs/Materials/Textures/texture";
  21416. import { Scene } from "babylonjs/scene";
  21417. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  21418. /**
  21419. * Block used to read a texture from a sampler
  21420. */
  21421. export class TextureBlock extends NodeMaterialBlock {
  21422. private _defineName;
  21423. private _linearDefineName;
  21424. private _gammaDefineName;
  21425. private _tempTextureRead;
  21426. private _samplerName;
  21427. private _transformedUVName;
  21428. private _textureTransformName;
  21429. private _textureInfoName;
  21430. private _mainUVName;
  21431. private _mainUVDefineName;
  21432. private _fragmentOnly;
  21433. /**
  21434. * Gets or sets the texture associated with the node
  21435. */
  21436. texture: Nullable<Texture>;
  21437. /**
  21438. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  21439. */
  21440. convertToGammaSpace: boolean;
  21441. /**
  21442. * Gets or sets a boolean indicating if content needs to be converted to linear space
  21443. */
  21444. convertToLinearSpace: boolean;
  21445. /**
  21446. * Create a new TextureBlock
  21447. * @param name defines the block name
  21448. */
  21449. constructor(name: string, fragmentOnly?: boolean);
  21450. /**
  21451. * Gets the current class name
  21452. * @returns the class name
  21453. */
  21454. getClassName(): string;
  21455. /**
  21456. * Gets the uv input component
  21457. */
  21458. get uv(): NodeMaterialConnectionPoint;
  21459. /**
  21460. * Gets the rgba output component
  21461. */
  21462. get rgba(): NodeMaterialConnectionPoint;
  21463. /**
  21464. * Gets the rgb output component
  21465. */
  21466. get rgb(): NodeMaterialConnectionPoint;
  21467. /**
  21468. * Gets the r output component
  21469. */
  21470. get r(): NodeMaterialConnectionPoint;
  21471. /**
  21472. * Gets the g output component
  21473. */
  21474. get g(): NodeMaterialConnectionPoint;
  21475. /**
  21476. * Gets the b output component
  21477. */
  21478. get b(): NodeMaterialConnectionPoint;
  21479. /**
  21480. * Gets the a output component
  21481. */
  21482. get a(): NodeMaterialConnectionPoint;
  21483. get target(): NodeMaterialBlockTargets;
  21484. autoConfigure(material: NodeMaterial): void;
  21485. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  21486. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21487. isReady(): boolean;
  21488. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  21489. private get _isMixed();
  21490. private _injectVertexCode;
  21491. private _writeTextureRead;
  21492. private _writeOutput;
  21493. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  21494. protected _dumpPropertiesCode(): string;
  21495. serialize(): any;
  21496. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21497. }
  21498. }
  21499. declare module "babylonjs/Shaders/ShadersInclude/reflectionFunction" {
  21500. /** @hidden */
  21501. export var reflectionFunction: {
  21502. name: string;
  21503. shader: string;
  21504. };
  21505. }
  21506. declare module "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock" {
  21507. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21508. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21509. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21510. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21511. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21512. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21513. import { Effect } from "babylonjs/Materials/effect";
  21514. import { Mesh } from "babylonjs/Meshes/mesh";
  21515. import { Nullable } from "babylonjs/types";
  21516. import { Scene } from "babylonjs/scene";
  21517. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  21518. /**
  21519. * Base block used to read a reflection texture from a sampler
  21520. */
  21521. export abstract class ReflectionTextureBaseBlock extends NodeMaterialBlock {
  21522. /** @hidden */
  21523. _define3DName: string;
  21524. /** @hidden */
  21525. _defineCubicName: string;
  21526. /** @hidden */
  21527. _defineExplicitName: string;
  21528. /** @hidden */
  21529. _defineProjectionName: string;
  21530. /** @hidden */
  21531. _defineLocalCubicName: string;
  21532. /** @hidden */
  21533. _defineSphericalName: string;
  21534. /** @hidden */
  21535. _definePlanarName: string;
  21536. /** @hidden */
  21537. _defineEquirectangularName: string;
  21538. /** @hidden */
  21539. _defineMirroredEquirectangularFixedName: string;
  21540. /** @hidden */
  21541. _defineEquirectangularFixedName: string;
  21542. /** @hidden */
  21543. _defineSkyboxName: string;
  21544. /** @hidden */
  21545. _defineOppositeZ: string;
  21546. /** @hidden */
  21547. _cubeSamplerName: string;
  21548. /** @hidden */
  21549. _2DSamplerName: string;
  21550. protected _positionUVWName: string;
  21551. protected _directionWName: string;
  21552. protected _reflectionVectorName: string;
  21553. /** @hidden */
  21554. _reflectionCoordsName: string;
  21555. /** @hidden */
  21556. _reflectionMatrixName: string;
  21557. protected _reflectionColorName: string;
  21558. /**
  21559. * Gets or sets the texture associated with the node
  21560. */
  21561. texture: Nullable<BaseTexture>;
  21562. /**
  21563. * Create a new ReflectionTextureBaseBlock
  21564. * @param name defines the block name
  21565. */
  21566. constructor(name: string);
  21567. /**
  21568. * Gets the current class name
  21569. * @returns the class name
  21570. */
  21571. getClassName(): string;
  21572. /**
  21573. * Gets the world position input component
  21574. */
  21575. abstract get position(): NodeMaterialConnectionPoint;
  21576. /**
  21577. * Gets the world position input component
  21578. */
  21579. abstract get worldPosition(): NodeMaterialConnectionPoint;
  21580. /**
  21581. * Gets the world normal input component
  21582. */
  21583. abstract get worldNormal(): NodeMaterialConnectionPoint;
  21584. /**
  21585. * Gets the world input component
  21586. */
  21587. abstract get world(): NodeMaterialConnectionPoint;
  21588. /**
  21589. * Gets the camera (or eye) position component
  21590. */
  21591. abstract get cameraPosition(): NodeMaterialConnectionPoint;
  21592. /**
  21593. * Gets the view input component
  21594. */
  21595. abstract get view(): NodeMaterialConnectionPoint;
  21596. protected _getTexture(): Nullable<BaseTexture>;
  21597. autoConfigure(material: NodeMaterial): void;
  21598. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21599. isReady(): boolean;
  21600. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  21601. /**
  21602. * Gets the code to inject in the vertex shader
  21603. * @param state current state of the node material building
  21604. * @returns the shader code
  21605. */
  21606. handleVertexSide(state: NodeMaterialBuildState): string;
  21607. /**
  21608. * Handles the inits for the fragment code path
  21609. * @param state node material build state
  21610. */
  21611. handleFragmentSideInits(state: NodeMaterialBuildState): void;
  21612. /**
  21613. * Generates the reflection coords code for the fragment code path
  21614. * @param worldNormalVarName name of the world normal variable
  21615. * @param worldPos name of the world position variable. If not provided, will use the world position connected to this block
  21616. * @param onlyReflectionVector if true, generates code only for the reflection vector computation, not for the reflection coordinates
  21617. * @returns the shader code
  21618. */
  21619. handleFragmentSideCodeReflectionCoords(worldNormalVarName: string, worldPos?: string, onlyReflectionVector?: boolean): string;
  21620. /**
  21621. * Generates the reflection color code for the fragment code path
  21622. * @param lodVarName name of the lod variable
  21623. * @param swizzleLookupTexture swizzle to use for the final color variable
  21624. * @returns the shader code
  21625. */
  21626. handleFragmentSideCodeReflectionColor(lodVarName?: string, swizzleLookupTexture?: string): string;
  21627. /**
  21628. * Generates the code corresponding to the connected output points
  21629. * @param state node material build state
  21630. * @param varName name of the variable to output
  21631. * @returns the shader code
  21632. */
  21633. writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  21634. protected _buildBlock(state: NodeMaterialBuildState): this;
  21635. protected _dumpPropertiesCode(): string;
  21636. serialize(): any;
  21637. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21638. }
  21639. }
  21640. declare module "babylonjs/Materials/Node/nodeMaterialConnectionPointCustomObject" {
  21641. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21642. import { NodeMaterialConnectionPoint, NodeMaterialConnectionPointDirection, NodeMaterialConnectionPointCompatibilityStates } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21643. import { Nullable } from "babylonjs/types";
  21644. /**
  21645. * Defines a connection point to be used for points with a custom object type
  21646. */
  21647. export class NodeMaterialConnectionPointCustomObject<T extends NodeMaterialBlock> extends NodeMaterialConnectionPoint {
  21648. private _blockType;
  21649. private _blockName;
  21650. private _nameForCheking?;
  21651. /**
  21652. * Creates a new connection point
  21653. * @param name defines the connection point name
  21654. * @param ownerBlock defines the block hosting this connection point
  21655. * @param direction defines the direction of the connection point
  21656. */
  21657. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection, _blockType: new (...args: any[]) => T, _blockName: string, _nameForCheking?: string | undefined);
  21658. /**
  21659. * Gets a number indicating if the current point can be connected to another point
  21660. * @param connectionPoint defines the other connection point
  21661. * @returns a number defining the compatibility state
  21662. */
  21663. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  21664. /**
  21665. * Creates a block suitable to be used as an input for this input point.
  21666. * If null is returned, a block based on the point type will be created.
  21667. * @returns The returned string parameter is the name of the output point of NodeMaterialBlock (first parameter of the returned array) that can be connected to the input
  21668. */
  21669. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  21670. }
  21671. }
  21672. declare module "babylonjs/Materials/Node/nodeMaterialDecorator" {
  21673. /**
  21674. * Enum defining the type of properties that can be edited in the property pages in the NME
  21675. */
  21676. export enum PropertyTypeForEdition {
  21677. /** property is a boolean */
  21678. Boolean = 0,
  21679. /** property is a float */
  21680. Float = 1,
  21681. /** property is a Vector2 */
  21682. Vector2 = 2,
  21683. /** property is a list of values */
  21684. List = 3
  21685. }
  21686. /**
  21687. * Interface that defines an option in a variable of type list
  21688. */
  21689. export interface IEditablePropertyListOption {
  21690. /** label of the option */
  21691. "label": string;
  21692. /** value of the option */
  21693. "value": number;
  21694. }
  21695. /**
  21696. * Interface that defines the options available for an editable property
  21697. */
  21698. export interface IEditablePropertyOption {
  21699. /** min value */
  21700. "min"?: number;
  21701. /** max value */
  21702. "max"?: number;
  21703. /** notifiers: indicates which actions to take when the property is changed */
  21704. "notifiers"?: {
  21705. /** the material should be rebuilt */
  21706. "rebuild"?: boolean;
  21707. /** the preview should be updated */
  21708. "update"?: boolean;
  21709. };
  21710. /** list of the options for a variable of type list */
  21711. "options"?: IEditablePropertyListOption[];
  21712. }
  21713. /**
  21714. * Interface that describes an editable property
  21715. */
  21716. export interface IPropertyDescriptionForEdition {
  21717. /** name of the property */
  21718. "propertyName": string;
  21719. /** display name of the property */
  21720. "displayName": string;
  21721. /** type of the property */
  21722. "type": PropertyTypeForEdition;
  21723. /** group of the property - all properties with the same group value will be displayed in a specific section */
  21724. "groupName": string;
  21725. /** options for the property */
  21726. "options": IEditablePropertyOption;
  21727. }
  21728. /**
  21729. * Decorator that flags a property in a node material block as being editable
  21730. */
  21731. export function editableInPropertyPage(displayName: string, propertyType?: PropertyTypeForEdition, groupName?: string, options?: IEditablePropertyOption): (target: any, propertyKey: string) => void;
  21732. }
  21733. declare module "babylonjs/Materials/Node/Blocks/PBR/refractionBlock" {
  21734. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21735. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21736. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21737. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21738. import { Nullable } from "babylonjs/types";
  21739. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21740. import { Mesh } from "babylonjs/Meshes/mesh";
  21741. import { SubMesh } from "babylonjs/Meshes/subMesh";
  21742. import { Effect } from "babylonjs/Materials/effect";
  21743. import { Scene } from "babylonjs/scene";
  21744. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21745. /**
  21746. * Block used to implement the refraction part of the sub surface module of the PBR material
  21747. */
  21748. export class RefractionBlock extends NodeMaterialBlock {
  21749. /** @hidden */
  21750. _define3DName: string;
  21751. /** @hidden */
  21752. _refractionMatrixName: string;
  21753. /** @hidden */
  21754. _defineLODRefractionAlpha: string;
  21755. /** @hidden */
  21756. _defineLinearSpecularRefraction: string;
  21757. /** @hidden */
  21758. _defineOppositeZ: string;
  21759. /** @hidden */
  21760. _cubeSamplerName: string;
  21761. /** @hidden */
  21762. _2DSamplerName: string;
  21763. /** @hidden */
  21764. _vRefractionMicrosurfaceInfosName: string;
  21765. /** @hidden */
  21766. _vRefractionInfosName: string;
  21767. private _scene;
  21768. /**
  21769. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  21770. * Materials half opaque for instance using refraction could benefit from this control.
  21771. */
  21772. linkRefractionWithTransparency: boolean;
  21773. /**
  21774. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  21775. */
  21776. invertRefractionY: boolean;
  21777. /**
  21778. * Gets or sets the texture associated with the node
  21779. */
  21780. texture: Nullable<BaseTexture>;
  21781. /**
  21782. * Create a new RefractionBlock
  21783. * @param name defines the block name
  21784. */
  21785. constructor(name: string);
  21786. /**
  21787. * Gets the current class name
  21788. * @returns the class name
  21789. */
  21790. getClassName(): string;
  21791. /**
  21792. * Gets the intensity input component
  21793. */
  21794. get intensity(): NodeMaterialConnectionPoint;
  21795. /**
  21796. * Gets the index of refraction input component
  21797. */
  21798. get indexOfRefraction(): NodeMaterialConnectionPoint;
  21799. /**
  21800. * Gets the tint at distance input component
  21801. */
  21802. get tintAtDistance(): NodeMaterialConnectionPoint;
  21803. /**
  21804. * Gets the view input component
  21805. */
  21806. get view(): NodeMaterialConnectionPoint;
  21807. /**
  21808. * Gets the refraction object output component
  21809. */
  21810. get refraction(): NodeMaterialConnectionPoint;
  21811. /**
  21812. * Returns true if the block has a texture
  21813. */
  21814. get hasTexture(): boolean;
  21815. protected _getTexture(): Nullable<BaseTexture>;
  21816. autoConfigure(material: NodeMaterial): void;
  21817. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21818. isReady(): boolean;
  21819. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  21820. /**
  21821. * Gets the main code of the block (fragment side)
  21822. * @param state current state of the node material building
  21823. * @returns the shader code
  21824. */
  21825. getCode(state: NodeMaterialBuildState): string;
  21826. protected _buildBlock(state: NodeMaterialBuildState): this;
  21827. protected _dumpPropertiesCode(): string;
  21828. serialize(): any;
  21829. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21830. }
  21831. }
  21832. declare module "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock" {
  21833. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21834. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21835. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  21836. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21837. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21838. import { NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21839. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21840. import { Nullable } from "babylonjs/types";
  21841. import { Scene } from "babylonjs/scene";
  21842. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  21843. /**
  21844. * Base block used as input for post process
  21845. */
  21846. export class CurrentScreenBlock extends NodeMaterialBlock {
  21847. private _samplerName;
  21848. private _linearDefineName;
  21849. private _gammaDefineName;
  21850. private _mainUVName;
  21851. private _tempTextureRead;
  21852. /**
  21853. * Gets or sets the texture associated with the node
  21854. */
  21855. texture: Nullable<BaseTexture>;
  21856. /**
  21857. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  21858. */
  21859. convertToGammaSpace: boolean;
  21860. /**
  21861. * Gets or sets a boolean indicating if content needs to be converted to linear space
  21862. */
  21863. convertToLinearSpace: boolean;
  21864. /**
  21865. * Create a new CurrentScreenBlock
  21866. * @param name defines the block name
  21867. */
  21868. constructor(name: string);
  21869. /**
  21870. * Gets the current class name
  21871. * @returns the class name
  21872. */
  21873. getClassName(): string;
  21874. /**
  21875. * Gets the uv input component
  21876. */
  21877. get uv(): NodeMaterialConnectionPoint;
  21878. /**
  21879. * Gets the rgba output component
  21880. */
  21881. get rgba(): NodeMaterialConnectionPoint;
  21882. /**
  21883. * Gets the rgb output component
  21884. */
  21885. get rgb(): NodeMaterialConnectionPoint;
  21886. /**
  21887. * Gets the r output component
  21888. */
  21889. get r(): NodeMaterialConnectionPoint;
  21890. /**
  21891. * Gets the g output component
  21892. */
  21893. get g(): NodeMaterialConnectionPoint;
  21894. /**
  21895. * Gets the b output component
  21896. */
  21897. get b(): NodeMaterialConnectionPoint;
  21898. /**
  21899. * Gets the a output component
  21900. */
  21901. get a(): NodeMaterialConnectionPoint;
  21902. /**
  21903. * Initialize the block and prepare the context for build
  21904. * @param state defines the state that will be used for the build
  21905. */
  21906. initialize(state: NodeMaterialBuildState): void;
  21907. get target(): NodeMaterialBlockTargets;
  21908. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21909. isReady(): boolean;
  21910. private _injectVertexCode;
  21911. private _writeTextureRead;
  21912. private _writeOutput;
  21913. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  21914. serialize(): any;
  21915. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21916. }
  21917. }
  21918. declare module "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock" {
  21919. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21920. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21921. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21922. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21923. import { NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21924. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21925. import { Nullable } from "babylonjs/types";
  21926. import { Scene } from "babylonjs/scene";
  21927. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  21928. /**
  21929. * Base block used for the particle texture
  21930. */
  21931. export class ParticleTextureBlock extends NodeMaterialBlock {
  21932. private _samplerName;
  21933. private _linearDefineName;
  21934. private _gammaDefineName;
  21935. private _tempTextureRead;
  21936. /**
  21937. * Gets or sets the texture associated with the node
  21938. */
  21939. texture: Nullable<BaseTexture>;
  21940. /**
  21941. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  21942. */
  21943. convertToGammaSpace: boolean;
  21944. /**
  21945. * Gets or sets a boolean indicating if content needs to be converted to linear space
  21946. */
  21947. convertToLinearSpace: boolean;
  21948. /**
  21949. * Create a new ParticleTextureBlock
  21950. * @param name defines the block name
  21951. */
  21952. constructor(name: string);
  21953. /**
  21954. * Gets the current class name
  21955. * @returns the class name
  21956. */
  21957. getClassName(): string;
  21958. /**
  21959. * Gets the uv input component
  21960. */
  21961. get uv(): NodeMaterialConnectionPoint;
  21962. /**
  21963. * Gets the rgba output component
  21964. */
  21965. get rgba(): NodeMaterialConnectionPoint;
  21966. /**
  21967. * Gets the rgb output component
  21968. */
  21969. get rgb(): NodeMaterialConnectionPoint;
  21970. /**
  21971. * Gets the r output component
  21972. */
  21973. get r(): NodeMaterialConnectionPoint;
  21974. /**
  21975. * Gets the g output component
  21976. */
  21977. get g(): NodeMaterialConnectionPoint;
  21978. /**
  21979. * Gets the b output component
  21980. */
  21981. get b(): NodeMaterialConnectionPoint;
  21982. /**
  21983. * Gets the a output component
  21984. */
  21985. get a(): NodeMaterialConnectionPoint;
  21986. /**
  21987. * Initialize the block and prepare the context for build
  21988. * @param state defines the state that will be used for the build
  21989. */
  21990. initialize(state: NodeMaterialBuildState): void;
  21991. autoConfigure(material: NodeMaterial): void;
  21992. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21993. isReady(): boolean;
  21994. private _writeOutput;
  21995. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  21996. serialize(): any;
  21997. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21998. }
  21999. }
  22000. declare module "babylonjs/Materials/Node/nodeMaterialBuildStateSharedData" {
  22001. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22002. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22003. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  22004. import { TextureBlock } from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  22005. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  22006. import { RefractionBlock } from "babylonjs/Materials/Node/Blocks/PBR/refractionBlock";
  22007. import { CurrentScreenBlock } from "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock";
  22008. import { ParticleTextureBlock } from "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock";
  22009. import { Scene } from "babylonjs/scene";
  22010. /**
  22011. * Class used to store shared data between 2 NodeMaterialBuildState
  22012. */
  22013. export class NodeMaterialBuildStateSharedData {
  22014. /**
  22015. * Gets the list of emitted varyings
  22016. */
  22017. temps: string[];
  22018. /**
  22019. * Gets the list of emitted varyings
  22020. */
  22021. varyings: string[];
  22022. /**
  22023. * Gets the varying declaration string
  22024. */
  22025. varyingDeclaration: string;
  22026. /**
  22027. * Input blocks
  22028. */
  22029. inputBlocks: InputBlock[];
  22030. /**
  22031. * Input blocks
  22032. */
  22033. textureBlocks: (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  22034. /**
  22035. * Bindable blocks (Blocks that need to set data to the effect)
  22036. */
  22037. bindableBlocks: NodeMaterialBlock[];
  22038. /**
  22039. * List of blocks that can provide a compilation fallback
  22040. */
  22041. blocksWithFallbacks: NodeMaterialBlock[];
  22042. /**
  22043. * List of blocks that can provide a define update
  22044. */
  22045. blocksWithDefines: NodeMaterialBlock[];
  22046. /**
  22047. * List of blocks that can provide a repeatable content
  22048. */
  22049. repeatableContentBlocks: NodeMaterialBlock[];
  22050. /**
  22051. * List of blocks that can provide a dynamic list of uniforms
  22052. */
  22053. dynamicUniformBlocks: NodeMaterialBlock[];
  22054. /**
  22055. * List of blocks that can block the isReady function for the material
  22056. */
  22057. blockingBlocks: NodeMaterialBlock[];
  22058. /**
  22059. * Gets the list of animated inputs
  22060. */
  22061. animatedInputs: InputBlock[];
  22062. /**
  22063. * Build Id used to avoid multiple recompilations
  22064. */
  22065. buildId: number;
  22066. /** List of emitted variables */
  22067. variableNames: {
  22068. [key: string]: number;
  22069. };
  22070. /** List of emitted defines */
  22071. defineNames: {
  22072. [key: string]: number;
  22073. };
  22074. /** Should emit comments? */
  22075. emitComments: boolean;
  22076. /** Emit build activity */
  22077. verbose: boolean;
  22078. /** Gets or sets the hosting scene */
  22079. scene: Scene;
  22080. /**
  22081. * Gets the compilation hints emitted at compilation time
  22082. */
  22083. hints: {
  22084. needWorldViewMatrix: boolean;
  22085. needWorldViewProjectionMatrix: boolean;
  22086. needAlphaBlending: boolean;
  22087. needAlphaTesting: boolean;
  22088. };
  22089. /**
  22090. * List of compilation checks
  22091. */
  22092. checks: {
  22093. emitVertex: boolean;
  22094. emitFragment: boolean;
  22095. notConnectedNonOptionalInputs: NodeMaterialConnectionPoint[];
  22096. };
  22097. /**
  22098. * Is vertex program allowed to be empty?
  22099. */
  22100. allowEmptyVertexProgram: boolean;
  22101. /** Creates a new shared data */
  22102. constructor();
  22103. /**
  22104. * Emits console errors and exceptions if there is a failing check
  22105. */
  22106. emitErrors(): void;
  22107. }
  22108. }
  22109. declare module "babylonjs/Materials/Node/nodeMaterialBuildState" {
  22110. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  22111. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  22112. import { NodeMaterialBuildStateSharedData } from "babylonjs/Materials/Node/nodeMaterialBuildStateSharedData";
  22113. /**
  22114. * Class used to store node based material build state
  22115. */
  22116. export class NodeMaterialBuildState {
  22117. /** Gets or sets a boolean indicating if the current state can emit uniform buffers */
  22118. supportUniformBuffers: boolean;
  22119. /**
  22120. * Gets the list of emitted attributes
  22121. */
  22122. attributes: string[];
  22123. /**
  22124. * Gets the list of emitted uniforms
  22125. */
  22126. uniforms: string[];
  22127. /**
  22128. * Gets the list of emitted constants
  22129. */
  22130. constants: string[];
  22131. /**
  22132. * Gets the list of emitted samplers
  22133. */
  22134. samplers: string[];
  22135. /**
  22136. * Gets the list of emitted functions
  22137. */
  22138. functions: {
  22139. [key: string]: string;
  22140. };
  22141. /**
  22142. * Gets the list of emitted extensions
  22143. */
  22144. extensions: {
  22145. [key: string]: string;
  22146. };
  22147. /**
  22148. * Gets the target of the compilation state
  22149. */
  22150. target: NodeMaterialBlockTargets;
  22151. /**
  22152. * Gets the list of emitted counters
  22153. */
  22154. counters: {
  22155. [key: string]: number;
  22156. };
  22157. /**
  22158. * Shared data between multiple NodeMaterialBuildState instances
  22159. */
  22160. sharedData: NodeMaterialBuildStateSharedData;
  22161. /** @hidden */
  22162. _vertexState: NodeMaterialBuildState;
  22163. /** @hidden */
  22164. _attributeDeclaration: string;
  22165. /** @hidden */
  22166. _uniformDeclaration: string;
  22167. /** @hidden */
  22168. _constantDeclaration: string;
  22169. /** @hidden */
  22170. _samplerDeclaration: string;
  22171. /** @hidden */
  22172. _varyingTransfer: string;
  22173. /** @hidden */
  22174. _injectAtEnd: string;
  22175. private _repeatableContentAnchorIndex;
  22176. /** @hidden */
  22177. _builtCompilationString: string;
  22178. /**
  22179. * Gets the emitted compilation strings
  22180. */
  22181. compilationString: string;
  22182. /**
  22183. * Finalize the compilation strings
  22184. * @param state defines the current compilation state
  22185. */
  22186. finalize(state: NodeMaterialBuildState): void;
  22187. /** @hidden */
  22188. get _repeatableContentAnchor(): string;
  22189. /** @hidden */
  22190. _getFreeVariableName(prefix: string): string;
  22191. /** @hidden */
  22192. _getFreeDefineName(prefix: string): string;
  22193. /** @hidden */
  22194. _excludeVariableName(name: string): void;
  22195. /** @hidden */
  22196. _emit2DSampler(name: string): void;
  22197. /** @hidden */
  22198. _getGLType(type: NodeMaterialBlockConnectionPointTypes): string;
  22199. /** @hidden */
  22200. _emitExtension(name: string, extension: string, define?: string): void;
  22201. /** @hidden */
  22202. _emitFunction(name: string, code: string, comments: string): void;
  22203. /** @hidden */
  22204. _emitCodeFromInclude(includeName: string, comments: string, options?: {
  22205. replaceStrings?: {
  22206. search: RegExp;
  22207. replace: string;
  22208. }[];
  22209. repeatKey?: string;
  22210. }): string;
  22211. /** @hidden */
  22212. _emitFunctionFromInclude(includeName: string, comments: string, options?: {
  22213. repeatKey?: string;
  22214. removeAttributes?: boolean;
  22215. removeUniforms?: boolean;
  22216. removeVaryings?: boolean;
  22217. removeIfDef?: boolean;
  22218. replaceStrings?: {
  22219. search: RegExp;
  22220. replace: string;
  22221. }[];
  22222. }, storeKey?: string): void;
  22223. /** @hidden */
  22224. _registerTempVariable(name: string): boolean;
  22225. /** @hidden */
  22226. _emitVaryingFromString(name: string, type: string, define?: string, notDefine?: boolean): boolean;
  22227. /** @hidden */
  22228. _emitUniformFromString(name: string, type: string, define?: string, notDefine?: boolean): void;
  22229. /** @hidden */
  22230. _emitFloat(value: number): string;
  22231. }
  22232. }
  22233. declare module "babylonjs/Misc/uniqueIdGenerator" {
  22234. /**
  22235. * Helper class used to generate session unique ID
  22236. */
  22237. export class UniqueIdGenerator {
  22238. private static _UniqueIdCounter;
  22239. /**
  22240. * Gets an unique (relatively to the current scene) Id
  22241. */
  22242. static get UniqueId(): number;
  22243. }
  22244. }
  22245. declare module "babylonjs/Materials/Node/nodeMaterialBlock" {
  22246. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  22247. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22248. import { Nullable } from "babylonjs/types";
  22249. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22250. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  22251. import { Effect } from "babylonjs/Materials/effect";
  22252. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22253. import { Mesh } from "babylonjs/Meshes/mesh";
  22254. import { SubMesh } from "babylonjs/Meshes/subMesh";
  22255. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  22256. import { Scene } from "babylonjs/scene";
  22257. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  22258. /**
  22259. * Defines a block that can be used inside a node based material
  22260. */
  22261. export class NodeMaterialBlock {
  22262. private _buildId;
  22263. private _buildTarget;
  22264. private _target;
  22265. private _isFinalMerger;
  22266. private _isInput;
  22267. private _name;
  22268. protected _isUnique: boolean;
  22269. /** Gets or sets a boolean indicating that only one input can be connected at a time */
  22270. inputsAreExclusive: boolean;
  22271. /** @hidden */
  22272. _codeVariableName: string;
  22273. /** @hidden */
  22274. _inputs: NodeMaterialConnectionPoint[];
  22275. /** @hidden */
  22276. _outputs: NodeMaterialConnectionPoint[];
  22277. /** @hidden */
  22278. _preparationId: number;
  22279. /**
  22280. * Gets the name of the block
  22281. */
  22282. get name(): string;
  22283. /**
  22284. * Sets the name of the block. Will check if the name is valid.
  22285. */
  22286. set name(newName: string);
  22287. /**
  22288. * Gets or sets the unique id of the node
  22289. */
  22290. uniqueId: number;
  22291. /**
  22292. * Gets or sets the comments associated with this block
  22293. */
  22294. comments: string;
  22295. /**
  22296. * Gets a boolean indicating that this block can only be used once per NodeMaterial
  22297. */
  22298. get isUnique(): boolean;
  22299. /**
  22300. * Gets a boolean indicating that this block is an end block (e.g. it is generating a system value)
  22301. */
  22302. get isFinalMerger(): boolean;
  22303. /**
  22304. * Gets a boolean indicating that this block is an input (e.g. it sends data to the shader)
  22305. */
  22306. get isInput(): boolean;
  22307. /**
  22308. * Gets or sets the build Id
  22309. */
  22310. get buildId(): number;
  22311. set buildId(value: number);
  22312. /**
  22313. * Gets or sets the target of the block
  22314. */
  22315. get target(): NodeMaterialBlockTargets;
  22316. set target(value: NodeMaterialBlockTargets);
  22317. /**
  22318. * Gets the list of input points
  22319. */
  22320. get inputs(): NodeMaterialConnectionPoint[];
  22321. /** Gets the list of output points */
  22322. get outputs(): NodeMaterialConnectionPoint[];
  22323. /**
  22324. * Find an input by its name
  22325. * @param name defines the name of the input to look for
  22326. * @returns the input or null if not found
  22327. */
  22328. getInputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  22329. /**
  22330. * Find an output by its name
  22331. * @param name defines the name of the outputto look for
  22332. * @returns the output or null if not found
  22333. */
  22334. getOutputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  22335. /**
  22336. * Creates a new NodeMaterialBlock
  22337. * @param name defines the block name
  22338. * @param target defines the target of that block (Vertex by default)
  22339. * @param isFinalMerger defines a boolean indicating that this block is an end block (e.g. it is generating a system value). Default is false
  22340. * @param isInput defines a boolean indicating that this block is an input (e.g. it sends data to the shader). Default is false
  22341. */
  22342. constructor(name: string, target?: NodeMaterialBlockTargets, isFinalMerger?: boolean, isInput?: boolean);
  22343. /**
  22344. * Initialize the block and prepare the context for build
  22345. * @param state defines the state that will be used for the build
  22346. */
  22347. initialize(state: NodeMaterialBuildState): void;
  22348. /**
  22349. * Bind data to effect. Will only be called for blocks with isBindable === true
  22350. * @param effect defines the effect to bind data to
  22351. * @param nodeMaterial defines the hosting NodeMaterial
  22352. * @param mesh defines the mesh that will be rendered
  22353. * @param subMesh defines the submesh that will be rendered
  22354. */
  22355. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  22356. protected _declareOutput(output: NodeMaterialConnectionPoint, state: NodeMaterialBuildState): string;
  22357. protected _writeVariable(currentPoint: NodeMaterialConnectionPoint): string;
  22358. protected _writeFloat(value: number): string;
  22359. /**
  22360. * Gets the current class name e.g. "NodeMaterialBlock"
  22361. * @returns the class name
  22362. */
  22363. getClassName(): string;
  22364. /**
  22365. * Register a new input. Must be called inside a block constructor
  22366. * @param name defines the connection point name
  22367. * @param type defines the connection point type
  22368. * @param isOptional defines a boolean indicating that this input can be omitted
  22369. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  22370. * @param point an already created connection point. If not provided, create a new one
  22371. * @returns the current block
  22372. */
  22373. registerInput(name: string, type: NodeMaterialBlockConnectionPointTypes, isOptional?: boolean, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  22374. /**
  22375. * Register a new output. Must be called inside a block constructor
  22376. * @param name defines the connection point name
  22377. * @param type defines the connection point type
  22378. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  22379. * @param point an already created connection point. If not provided, create a new one
  22380. * @returns the current block
  22381. */
  22382. registerOutput(name: string, type: NodeMaterialBlockConnectionPointTypes, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  22383. /**
  22384. * Will return the first available input e.g. the first one which is not an uniform or an attribute
  22385. * @param forOutput defines an optional connection point to check compatibility with
  22386. * @returns the first available input or null
  22387. */
  22388. getFirstAvailableInput(forOutput?: Nullable<NodeMaterialConnectionPoint>): Nullable<NodeMaterialConnectionPoint>;
  22389. /**
  22390. * Will return the first available output e.g. the first one which is not yet connected and not a varying
  22391. * @param forBlock defines an optional block to check compatibility with
  22392. * @returns the first available input or null
  22393. */
  22394. getFirstAvailableOutput(forBlock?: Nullable<NodeMaterialBlock>): Nullable<NodeMaterialConnectionPoint>;
  22395. /**
  22396. * Gets the sibling of the given output
  22397. * @param current defines the current output
  22398. * @returns the next output in the list or null
  22399. */
  22400. getSiblingOutput(current: NodeMaterialConnectionPoint): Nullable<NodeMaterialConnectionPoint>;
  22401. /**
  22402. * Connect current block with another block
  22403. * @param other defines the block to connect with
  22404. * @param options define the various options to help pick the right connections
  22405. * @returns the current block
  22406. */
  22407. connectTo(other: NodeMaterialBlock, options?: {
  22408. input?: string;
  22409. output?: string;
  22410. outputSwizzle?: string;
  22411. }): this | undefined;
  22412. protected _buildBlock(state: NodeMaterialBuildState): void;
  22413. /**
  22414. * Add uniforms, samplers and uniform buffers at compilation time
  22415. * @param state defines the state to update
  22416. * @param nodeMaterial defines the node material requesting the update
  22417. * @param defines defines the material defines to update
  22418. * @param uniformBuffers defines the list of uniform buffer names
  22419. */
  22420. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  22421. /**
  22422. * Add potential fallbacks if shader compilation fails
  22423. * @param mesh defines the mesh to be rendered
  22424. * @param fallbacks defines the current prioritized list of fallbacks
  22425. */
  22426. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  22427. /**
  22428. * Initialize defines for shader compilation
  22429. * @param mesh defines the mesh to be rendered
  22430. * @param nodeMaterial defines the node material requesting the update
  22431. * @param defines defines the material defines to update
  22432. * @param useInstances specifies that instances should be used
  22433. */
  22434. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  22435. /**
  22436. * Update defines for shader compilation
  22437. * @param mesh defines the mesh to be rendered
  22438. * @param nodeMaterial defines the node material requesting the update
  22439. * @param defines defines the material defines to update
  22440. * @param useInstances specifies that instances should be used
  22441. * @param subMesh defines which submesh to render
  22442. */
  22443. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  22444. /**
  22445. * Lets the block try to connect some inputs automatically
  22446. * @param material defines the hosting NodeMaterial
  22447. */
  22448. autoConfigure(material: NodeMaterial): void;
  22449. /**
  22450. * Function called when a block is declared as repeatable content generator
  22451. * @param vertexShaderState defines the current compilation state for the vertex shader
  22452. * @param fragmentShaderState defines the current compilation state for the fragment shader
  22453. * @param mesh defines the mesh to be rendered
  22454. * @param defines defines the material defines to update
  22455. */
  22456. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  22457. /**
  22458. * Checks if the block is ready
  22459. * @param mesh defines the mesh to be rendered
  22460. * @param nodeMaterial defines the node material requesting the update
  22461. * @param defines defines the material defines to update
  22462. * @param useInstances specifies that instances should be used
  22463. * @returns true if the block is ready
  22464. */
  22465. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): boolean;
  22466. protected _linkConnectionTypes(inputIndex0: number, inputIndex1: number): void;
  22467. private _processBuild;
  22468. /**
  22469. * Validates the new name for the block node.
  22470. * @param newName the new name to be given to the node.
  22471. * @returns false if the name is a reserve word, else true.
  22472. */
  22473. validateBlockName(newName: string): boolean;
  22474. /**
  22475. * Compile the current node and generate the shader code
  22476. * @param state defines the current compilation state (uniforms, samplers, current string)
  22477. * @param activeBlocks defines the list of active blocks (i.e. blocks to compile)
  22478. * @returns true if already built
  22479. */
  22480. build(state: NodeMaterialBuildState, activeBlocks: NodeMaterialBlock[]): boolean;
  22481. protected _inputRename(name: string): string;
  22482. protected _outputRename(name: string): string;
  22483. protected _dumpPropertiesCode(): string;
  22484. /** @hidden */
  22485. _dumpCode(uniqueNames: string[], alreadyDumped: NodeMaterialBlock[]): string;
  22486. /** @hidden */
  22487. _dumpCodeForOutputConnections(alreadyDumped: NodeMaterialBlock[]): string;
  22488. /**
  22489. * Clone the current block to a new identical block
  22490. * @param scene defines the hosting scene
  22491. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  22492. * @returns a copy of the current block
  22493. */
  22494. clone(scene: Scene, rootUrl?: string): Nullable<NodeMaterialBlock>;
  22495. /**
  22496. * Serializes this block in a JSON representation
  22497. * @returns the serialized block object
  22498. */
  22499. serialize(): any;
  22500. /** @hidden */
  22501. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  22502. private _deserializePortDisplayNamesAndExposedOnFrame;
  22503. /**
  22504. * Release resources
  22505. */
  22506. dispose(): void;
  22507. }
  22508. }
  22509. declare module "babylonjs/Materials/pushMaterial" {
  22510. import { Nullable } from "babylonjs/types";
  22511. import { Scene } from "babylonjs/scene";
  22512. import { Matrix } from "babylonjs/Maths/math.vector";
  22513. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22514. import { Mesh } from "babylonjs/Meshes/mesh";
  22515. import { Material } from "babylonjs/Materials/material";
  22516. import { Effect } from "babylonjs/Materials/effect";
  22517. import { SubMesh } from "babylonjs/Meshes/subMesh";
  22518. /**
  22519. * Base class of materials working in push mode in babylon JS
  22520. * @hidden
  22521. */
  22522. export class PushMaterial extends Material {
  22523. protected _activeEffect: Effect;
  22524. protected _normalMatrix: Matrix;
  22525. constructor(name: string, scene: Scene);
  22526. getEffect(): Effect;
  22527. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  22528. protected _isReadyForSubMesh(subMesh: SubMesh): boolean;
  22529. /**
  22530. * Binds the given world matrix to the active effect
  22531. *
  22532. * @param world the matrix to bind
  22533. */
  22534. bindOnlyWorldMatrix(world: Matrix): void;
  22535. /**
  22536. * Binds the given normal matrix to the active effect
  22537. *
  22538. * @param normalMatrix the matrix to bind
  22539. */
  22540. bindOnlyNormalMatrix(normalMatrix: Matrix): void;
  22541. bind(world: Matrix, mesh?: Mesh): void;
  22542. protected _afterBind(mesh: Mesh, effect?: Nullable<Effect>): void;
  22543. protected _mustRebind(scene: Scene, effect: Effect, visibility?: number): boolean;
  22544. }
  22545. }
  22546. declare module "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer" {
  22547. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22548. /**
  22549. * Root class for all node material optimizers
  22550. */
  22551. export class NodeMaterialOptimizer {
  22552. /**
  22553. * Function used to optimize a NodeMaterial graph
  22554. * @param vertexOutputNodes defines the list of output nodes for the vertex shader
  22555. * @param fragmentOutputNodes defines the list of output nodes for the fragment shader
  22556. */
  22557. optimize(vertexOutputNodes: NodeMaterialBlock[], fragmentOutputNodes: NodeMaterialBlock[]): void;
  22558. }
  22559. }
  22560. declare module "babylonjs/Materials/Node/Blocks/transformBlock" {
  22561. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22562. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22563. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22564. import { Scene } from "babylonjs/scene";
  22565. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22566. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  22567. import { SubMesh } from "babylonjs/Meshes/subMesh";
  22568. /**
  22569. * Block used to transform a vector (2, 3 or 4) with a matrix. It will generate a Vector4
  22570. */
  22571. export class TransformBlock extends NodeMaterialBlock {
  22572. /**
  22573. * Defines the value to use to complement W value to transform it to a Vector4
  22574. */
  22575. complementW: number;
  22576. /**
  22577. * Defines the value to use to complement z value to transform it to a Vector4
  22578. */
  22579. complementZ: number;
  22580. /**
  22581. * Creates a new TransformBlock
  22582. * @param name defines the block name
  22583. */
  22584. constructor(name: string);
  22585. /**
  22586. * Gets the current class name
  22587. * @returns the class name
  22588. */
  22589. getClassName(): string;
  22590. /**
  22591. * Gets the vector input
  22592. */
  22593. get vector(): NodeMaterialConnectionPoint;
  22594. /**
  22595. * Gets the output component
  22596. */
  22597. get output(): NodeMaterialConnectionPoint;
  22598. /**
  22599. * Gets the xyz output component
  22600. */
  22601. get xyz(): NodeMaterialConnectionPoint;
  22602. /**
  22603. * Gets the matrix transform input
  22604. */
  22605. get transform(): NodeMaterialConnectionPoint;
  22606. protected _buildBlock(state: NodeMaterialBuildState): this;
  22607. /**
  22608. * Update defines for shader compilation
  22609. * @param mesh defines the mesh to be rendered
  22610. * @param nodeMaterial defines the node material requesting the update
  22611. * @param defines defines the material defines to update
  22612. * @param useInstances specifies that instances should be used
  22613. * @param subMesh defines which submesh to render
  22614. */
  22615. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  22616. serialize(): any;
  22617. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  22618. protected _dumpPropertiesCode(): string;
  22619. }
  22620. }
  22621. declare module "babylonjs/Materials/Node/Blocks/Vertex/vertexOutputBlock" {
  22622. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22623. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22624. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22625. /**
  22626. * Block used to output the vertex position
  22627. */
  22628. export class VertexOutputBlock extends NodeMaterialBlock {
  22629. /**
  22630. * Creates a new VertexOutputBlock
  22631. * @param name defines the block name
  22632. */
  22633. constructor(name: string);
  22634. /**
  22635. * Gets the current class name
  22636. * @returns the class name
  22637. */
  22638. getClassName(): string;
  22639. /**
  22640. * Gets the vector input component
  22641. */
  22642. get vector(): NodeMaterialConnectionPoint;
  22643. protected _buildBlock(state: NodeMaterialBuildState): this;
  22644. }
  22645. }
  22646. declare module "babylonjs/Materials/Node/Blocks/Fragment/fragmentOutputBlock" {
  22647. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22648. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22649. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22650. /**
  22651. * Block used to output the final color
  22652. */
  22653. export class FragmentOutputBlock extends NodeMaterialBlock {
  22654. /**
  22655. * Create a new FragmentOutputBlock
  22656. * @param name defines the block name
  22657. */
  22658. constructor(name: string);
  22659. /**
  22660. * Gets the current class name
  22661. * @returns the class name
  22662. */
  22663. getClassName(): string;
  22664. /**
  22665. * Gets the rgba input component
  22666. */
  22667. get rgba(): NodeMaterialConnectionPoint;
  22668. /**
  22669. * Gets the rgb input component
  22670. */
  22671. get rgb(): NodeMaterialConnectionPoint;
  22672. /**
  22673. * Gets the a input component
  22674. */
  22675. get a(): NodeMaterialConnectionPoint;
  22676. protected _buildBlock(state: NodeMaterialBuildState): this;
  22677. }
  22678. }
  22679. declare module "babylonjs/Materials/Node/Blocks/Particle/particleRampGradientBlock" {
  22680. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22681. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22682. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22683. /**
  22684. * Block used for the particle ramp gradient section
  22685. */
  22686. export class ParticleRampGradientBlock extends NodeMaterialBlock {
  22687. /**
  22688. * Create a new ParticleRampGradientBlock
  22689. * @param name defines the block name
  22690. */
  22691. constructor(name: string);
  22692. /**
  22693. * Gets the current class name
  22694. * @returns the class name
  22695. */
  22696. getClassName(): string;
  22697. /**
  22698. * Gets the color input component
  22699. */
  22700. get color(): NodeMaterialConnectionPoint;
  22701. /**
  22702. * Gets the rampColor output component
  22703. */
  22704. get rampColor(): NodeMaterialConnectionPoint;
  22705. /**
  22706. * Initialize the block and prepare the context for build
  22707. * @param state defines the state that will be used for the build
  22708. */
  22709. initialize(state: NodeMaterialBuildState): void;
  22710. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  22711. }
  22712. }
  22713. declare module "babylonjs/Materials/Node/Blocks/Particle/particleBlendMultiplyBlock" {
  22714. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22715. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22716. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22717. /**
  22718. * Block used for the particle blend multiply section
  22719. */
  22720. export class ParticleBlendMultiplyBlock extends NodeMaterialBlock {
  22721. /**
  22722. * Create a new ParticleBlendMultiplyBlock
  22723. * @param name defines the block name
  22724. */
  22725. constructor(name: string);
  22726. /**
  22727. * Gets the current class name
  22728. * @returns the class name
  22729. */
  22730. getClassName(): string;
  22731. /**
  22732. * Gets the color input component
  22733. */
  22734. get color(): NodeMaterialConnectionPoint;
  22735. /**
  22736. * Gets the alphaTexture input component
  22737. */
  22738. get alphaTexture(): NodeMaterialConnectionPoint;
  22739. /**
  22740. * Gets the alphaColor input component
  22741. */
  22742. get alphaColor(): NodeMaterialConnectionPoint;
  22743. /**
  22744. * Gets the blendColor output component
  22745. */
  22746. get blendColor(): NodeMaterialConnectionPoint;
  22747. /**
  22748. * Initialize the block and prepare the context for build
  22749. * @param state defines the state that will be used for the build
  22750. */
  22751. initialize(state: NodeMaterialBuildState): void;
  22752. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  22753. }
  22754. }
  22755. declare module "babylonjs/Materials/Node/Blocks/vectorMergerBlock" {
  22756. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22757. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22758. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22759. /**
  22760. * Block used to create a Vector2/3/4 out of individual inputs (one for each component)
  22761. */
  22762. export class VectorMergerBlock extends NodeMaterialBlock {
  22763. /**
  22764. * Create a new VectorMergerBlock
  22765. * @param name defines the block name
  22766. */
  22767. constructor(name: string);
  22768. /**
  22769. * Gets the current class name
  22770. * @returns the class name
  22771. */
  22772. getClassName(): string;
  22773. /**
  22774. * Gets the xyz component (input)
  22775. */
  22776. get xyzIn(): NodeMaterialConnectionPoint;
  22777. /**
  22778. * Gets the xy component (input)
  22779. */
  22780. get xyIn(): NodeMaterialConnectionPoint;
  22781. /**
  22782. * Gets the x component (input)
  22783. */
  22784. get x(): NodeMaterialConnectionPoint;
  22785. /**
  22786. * Gets the y component (input)
  22787. */
  22788. get y(): NodeMaterialConnectionPoint;
  22789. /**
  22790. * Gets the z component (input)
  22791. */
  22792. get z(): NodeMaterialConnectionPoint;
  22793. /**
  22794. * Gets the w component (input)
  22795. */
  22796. get w(): NodeMaterialConnectionPoint;
  22797. /**
  22798. * Gets the xyzw component (output)
  22799. */
  22800. get xyzw(): NodeMaterialConnectionPoint;
  22801. /**
  22802. * Gets the xyz component (output)
  22803. */
  22804. get xyzOut(): NodeMaterialConnectionPoint;
  22805. /**
  22806. * Gets the xy component (output)
  22807. */
  22808. get xyOut(): NodeMaterialConnectionPoint;
  22809. /**
  22810. * Gets the xy component (output)
  22811. * @deprecated Please use xyOut instead.
  22812. */
  22813. get xy(): NodeMaterialConnectionPoint;
  22814. /**
  22815. * Gets the xyz component (output)
  22816. * @deprecated Please use xyzOut instead.
  22817. */
  22818. get xyz(): NodeMaterialConnectionPoint;
  22819. protected _buildBlock(state: NodeMaterialBuildState): this;
  22820. }
  22821. }
  22822. declare module "babylonjs/Materials/Node/Blocks/remapBlock" {
  22823. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22824. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22825. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22826. import { Vector2 } from "babylonjs/Maths/math.vector";
  22827. import { Scene } from "babylonjs/scene";
  22828. /**
  22829. * Block used to remap a float from a range to a new one
  22830. */
  22831. export class RemapBlock extends NodeMaterialBlock {
  22832. /**
  22833. * Gets or sets the source range
  22834. */
  22835. sourceRange: Vector2;
  22836. /**
  22837. * Gets or sets the target range
  22838. */
  22839. targetRange: Vector2;
  22840. /**
  22841. * Creates a new RemapBlock
  22842. * @param name defines the block name
  22843. */
  22844. constructor(name: string);
  22845. /**
  22846. * Gets the current class name
  22847. * @returns the class name
  22848. */
  22849. getClassName(): string;
  22850. /**
  22851. * Gets the input component
  22852. */
  22853. get input(): NodeMaterialConnectionPoint;
  22854. /**
  22855. * Gets the source min input component
  22856. */
  22857. get sourceMin(): NodeMaterialConnectionPoint;
  22858. /**
  22859. * Gets the source max input component
  22860. */
  22861. get sourceMax(): NodeMaterialConnectionPoint;
  22862. /**
  22863. * Gets the target min input component
  22864. */
  22865. get targetMin(): NodeMaterialConnectionPoint;
  22866. /**
  22867. * Gets the target max input component
  22868. */
  22869. get targetMax(): NodeMaterialConnectionPoint;
  22870. /**
  22871. * Gets the output component
  22872. */
  22873. get output(): NodeMaterialConnectionPoint;
  22874. protected _buildBlock(state: NodeMaterialBuildState): this;
  22875. protected _dumpPropertiesCode(): string;
  22876. serialize(): any;
  22877. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  22878. }
  22879. }
  22880. declare module "babylonjs/Materials/Node/Blocks/multiplyBlock" {
  22881. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22882. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22883. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22884. /**
  22885. * Block used to multiply 2 values
  22886. */
  22887. export class MultiplyBlock extends NodeMaterialBlock {
  22888. /**
  22889. * Creates a new MultiplyBlock
  22890. * @param name defines the block name
  22891. */
  22892. constructor(name: string);
  22893. /**
  22894. * Gets the current class name
  22895. * @returns the class name
  22896. */
  22897. getClassName(): string;
  22898. /**
  22899. * Gets the left operand input component
  22900. */
  22901. get left(): NodeMaterialConnectionPoint;
  22902. /**
  22903. * Gets the right operand input component
  22904. */
  22905. get right(): NodeMaterialConnectionPoint;
  22906. /**
  22907. * Gets the output component
  22908. */
  22909. get output(): NodeMaterialConnectionPoint;
  22910. protected _buildBlock(state: NodeMaterialBuildState): this;
  22911. }
  22912. }
  22913. declare module "babylonjs/Materials/Node/Blocks/colorSplitterBlock" {
  22914. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22915. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22916. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22917. /**
  22918. * Block used to expand a Color3/4 into 4 outputs (one for each component)
  22919. */
  22920. export class ColorSplitterBlock extends NodeMaterialBlock {
  22921. /**
  22922. * Create a new ColorSplitterBlock
  22923. * @param name defines the block name
  22924. */
  22925. constructor(name: string);
  22926. /**
  22927. * Gets the current class name
  22928. * @returns the class name
  22929. */
  22930. getClassName(): string;
  22931. /**
  22932. * Gets the rgba component (input)
  22933. */
  22934. get rgba(): NodeMaterialConnectionPoint;
  22935. /**
  22936. * Gets the rgb component (input)
  22937. */
  22938. get rgbIn(): NodeMaterialConnectionPoint;
  22939. /**
  22940. * Gets the rgb component (output)
  22941. */
  22942. get rgbOut(): NodeMaterialConnectionPoint;
  22943. /**
  22944. * Gets the r component (output)
  22945. */
  22946. get r(): NodeMaterialConnectionPoint;
  22947. /**
  22948. * Gets the g component (output)
  22949. */
  22950. get g(): NodeMaterialConnectionPoint;
  22951. /**
  22952. * Gets the b component (output)
  22953. */
  22954. get b(): NodeMaterialConnectionPoint;
  22955. /**
  22956. * Gets the a component (output)
  22957. */
  22958. get a(): NodeMaterialConnectionPoint;
  22959. protected _inputRename(name: string): string;
  22960. protected _outputRename(name: string): string;
  22961. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  22962. }
  22963. }
  22964. declare module "babylonjs/Materials/Node/nodeMaterial" {
  22965. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22966. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  22967. import { Scene } from "babylonjs/scene";
  22968. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22969. import { Matrix } from "babylonjs/Maths/math.vector";
  22970. import { Mesh } from "babylonjs/Meshes/mesh";
  22971. import { Engine } from "babylonjs/Engines/engine";
  22972. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  22973. import { Observable } from "babylonjs/Misc/observable";
  22974. import { SubMesh } from "babylonjs/Meshes/subMesh";
  22975. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  22976. import { NodeMaterialOptimizer } from "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer";
  22977. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  22978. import { Nullable } from "babylonjs/types";
  22979. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  22980. import { TextureBlock } from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  22981. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  22982. import { RefractionBlock } from "babylonjs/Materials/Node/Blocks/PBR/refractionBlock";
  22983. import { CurrentScreenBlock } from "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock";
  22984. import { ParticleTextureBlock } from "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock";
  22985. import { Effect } from "babylonjs/Materials/effect";
  22986. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  22987. import { Camera } from "babylonjs/Cameras/camera";
  22988. import { NodeMaterialModes } from "babylonjs/Materials/Node/Enums/nodeMaterialModes";
  22989. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  22990. /**
  22991. * Interface used to configure the node material editor
  22992. */
  22993. export interface INodeMaterialEditorOptions {
  22994. /** Define the URl to load node editor script */
  22995. editorURL?: string;
  22996. }
  22997. /** @hidden */
  22998. export class NodeMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  22999. NORMAL: boolean;
  23000. TANGENT: boolean;
  23001. UV1: boolean;
  23002. /** BONES */
  23003. NUM_BONE_INFLUENCERS: number;
  23004. BonesPerMesh: number;
  23005. BONETEXTURE: boolean;
  23006. /** MORPH TARGETS */
  23007. MORPHTARGETS: boolean;
  23008. MORPHTARGETS_NORMAL: boolean;
  23009. MORPHTARGETS_TANGENT: boolean;
  23010. MORPHTARGETS_UV: boolean;
  23011. NUM_MORPH_INFLUENCERS: number;
  23012. /** IMAGE PROCESSING */
  23013. IMAGEPROCESSING: boolean;
  23014. VIGNETTE: boolean;
  23015. VIGNETTEBLENDMODEMULTIPLY: boolean;
  23016. VIGNETTEBLENDMODEOPAQUE: boolean;
  23017. TONEMAPPING: boolean;
  23018. TONEMAPPING_ACES: boolean;
  23019. CONTRAST: boolean;
  23020. EXPOSURE: boolean;
  23021. COLORCURVES: boolean;
  23022. COLORGRADING: boolean;
  23023. COLORGRADING3D: boolean;
  23024. SAMPLER3DGREENDEPTH: boolean;
  23025. SAMPLER3DBGRMAP: boolean;
  23026. IMAGEPROCESSINGPOSTPROCESS: boolean;
  23027. /** MISC. */
  23028. BUMPDIRECTUV: number;
  23029. constructor();
  23030. setValue(name: string, value: any, markAsUnprocessedIfDirty?: boolean): void;
  23031. }
  23032. /**
  23033. * Class used to configure NodeMaterial
  23034. */
  23035. export interface INodeMaterialOptions {
  23036. /**
  23037. * Defines if blocks should emit comments
  23038. */
  23039. emitComments: boolean;
  23040. }
  23041. /**
  23042. * Class used to create a node based material built by assembling shader blocks
  23043. */
  23044. export class NodeMaterial extends PushMaterial {
  23045. private static _BuildIdGenerator;
  23046. private _options;
  23047. private _vertexCompilationState;
  23048. private _fragmentCompilationState;
  23049. private _sharedData;
  23050. private _buildId;
  23051. private _buildWasSuccessful;
  23052. private _cachedWorldViewMatrix;
  23053. private _cachedWorldViewProjectionMatrix;
  23054. private _optimizers;
  23055. private _animationFrame;
  23056. /** Define the Url to load node editor script */
  23057. static EditorURL: string;
  23058. /** Define the Url to load snippets */
  23059. static SnippetUrl: string;
  23060. /** Gets or sets a boolean indicating that node materials should not deserialize textures from json / snippet content */
  23061. static IgnoreTexturesAtLoadTime: boolean;
  23062. private BJSNODEMATERIALEDITOR;
  23063. /** Get the inspector from bundle or global */
  23064. private _getGlobalNodeMaterialEditor;
  23065. /**
  23066. * Snippet ID if the material was created from the snippet server
  23067. */
  23068. snippetId: string;
  23069. /**
  23070. * Gets or sets data used by visual editor
  23071. * @see https://nme.babylonjs.com
  23072. */
  23073. editorData: any;
  23074. /**
  23075. * Gets or sets a boolean indicating that alpha value must be ignored (This will turn alpha blending off even if an alpha value is produced by the material)
  23076. */
  23077. ignoreAlpha: boolean;
  23078. /**
  23079. * Defines the maximum number of lights that can be used in the material
  23080. */
  23081. maxSimultaneousLights: number;
  23082. /**
  23083. * Observable raised when the material is built
  23084. */
  23085. onBuildObservable: Observable<NodeMaterial>;
  23086. /**
  23087. * Gets or sets the root nodes of the material vertex shader
  23088. */
  23089. _vertexOutputNodes: NodeMaterialBlock[];
  23090. /**
  23091. * Gets or sets the root nodes of the material fragment (pixel) shader
  23092. */
  23093. _fragmentOutputNodes: NodeMaterialBlock[];
  23094. /** Gets or sets options to control the node material overall behavior */
  23095. get options(): INodeMaterialOptions;
  23096. set options(options: INodeMaterialOptions);
  23097. /**
  23098. * Default configuration related to image processing available in the standard Material.
  23099. */
  23100. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  23101. /**
  23102. * Gets the image processing configuration used either in this material.
  23103. */
  23104. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  23105. /**
  23106. * Sets the Default image processing configuration used either in the this material.
  23107. *
  23108. * If sets to null, the scene one is in use.
  23109. */
  23110. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  23111. /**
  23112. * Gets an array of blocks that needs to be serialized even if they are not yet connected
  23113. */
  23114. attachedBlocks: NodeMaterialBlock[];
  23115. /**
  23116. * Specifies the mode of the node material
  23117. * @hidden
  23118. */
  23119. _mode: NodeMaterialModes;
  23120. /**
  23121. * Gets the mode property
  23122. */
  23123. get mode(): NodeMaterialModes;
  23124. /**
  23125. * Create a new node based material
  23126. * @param name defines the material name
  23127. * @param scene defines the hosting scene
  23128. * @param options defines creation option
  23129. */
  23130. constructor(name: string, scene?: Scene, options?: Partial<INodeMaterialOptions>);
  23131. /**
  23132. * Gets the current class name of the material e.g. "NodeMaterial"
  23133. * @returns the class name
  23134. */
  23135. getClassName(): string;
  23136. /**
  23137. * Keep track of the image processing observer to allow dispose and replace.
  23138. */
  23139. private _imageProcessingObserver;
  23140. /**
  23141. * Attaches a new image processing configuration to the Standard Material.
  23142. * @param configuration
  23143. */
  23144. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  23145. /**
  23146. * Get a block by its name
  23147. * @param name defines the name of the block to retrieve
  23148. * @returns the required block or null if not found
  23149. */
  23150. getBlockByName(name: string): Nullable<NodeMaterialBlock>;
  23151. /**
  23152. * Get a block by its name
  23153. * @param predicate defines the predicate used to find the good candidate
  23154. * @returns the required block or null if not found
  23155. */
  23156. getBlockByPredicate(predicate: (block: NodeMaterialBlock) => boolean): Nullable<NodeMaterialBlock>;
  23157. /**
  23158. * Get an input block by its name
  23159. * @param predicate defines the predicate used to find the good candidate
  23160. * @returns the required input block or null if not found
  23161. */
  23162. getInputBlockByPredicate(predicate: (block: InputBlock) => boolean): Nullable<InputBlock>;
  23163. /**
  23164. * Gets the list of input blocks attached to this material
  23165. * @returns an array of InputBlocks
  23166. */
  23167. getInputBlocks(): InputBlock[];
  23168. /**
  23169. * Adds a new optimizer to the list of optimizers
  23170. * @param optimizer defines the optimizers to add
  23171. * @returns the current material
  23172. */
  23173. registerOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  23174. /**
  23175. * Remove an optimizer from the list of optimizers
  23176. * @param optimizer defines the optimizers to remove
  23177. * @returns the current material
  23178. */
  23179. unregisterOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  23180. /**
  23181. * Add a new block to the list of output nodes
  23182. * @param node defines the node to add
  23183. * @returns the current material
  23184. */
  23185. addOutputNode(node: NodeMaterialBlock): this;
  23186. /**
  23187. * Remove a block from the list of root nodes
  23188. * @param node defines the node to remove
  23189. * @returns the current material
  23190. */
  23191. removeOutputNode(node: NodeMaterialBlock): this;
  23192. private _addVertexOutputNode;
  23193. private _removeVertexOutputNode;
  23194. private _addFragmentOutputNode;
  23195. private _removeFragmentOutputNode;
  23196. /**
  23197. * Specifies if the material will require alpha blending
  23198. * @returns a boolean specifying if alpha blending is needed
  23199. */
  23200. needAlphaBlending(): boolean;
  23201. /**
  23202. * Specifies if this material should be rendered in alpha test mode
  23203. * @returns a boolean specifying if an alpha test is needed.
  23204. */
  23205. needAlphaTesting(): boolean;
  23206. private _initializeBlock;
  23207. private _resetDualBlocks;
  23208. /**
  23209. * Remove a block from the current node material
  23210. * @param block defines the block to remove
  23211. */
  23212. removeBlock(block: NodeMaterialBlock): void;
  23213. /**
  23214. * Build the material and generates the inner effect
  23215. * @param verbose defines if the build should log activity
  23216. */
  23217. build(verbose?: boolean): void;
  23218. /**
  23219. * Runs an otpimization phase to try to improve the shader code
  23220. */
  23221. optimize(): void;
  23222. private _prepareDefinesForAttributes;
  23223. /**
  23224. * Create a post process from the material
  23225. * @param camera The camera to apply the render pass to.
  23226. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  23227. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  23228. * @param engine The engine which the post process will be applied. (default: current engine)
  23229. * @param reusable If the post process can be reused on the same frame. (default: false)
  23230. * @param textureType Type of textures used when performing the post process. (default: 0)
  23231. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  23232. * @returns the post process created
  23233. */
  23234. createPostProcess(camera: Nullable<Camera>, options?: number | PostProcessOptions, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, textureFormat?: number): PostProcess;
  23235. /**
  23236. * Create the post process effect from the material
  23237. * @param postProcess The post process to create the effect for
  23238. */
  23239. createEffectForPostProcess(postProcess: PostProcess): void;
  23240. private _createEffectOrPostProcess;
  23241. private _createEffectForParticles;
  23242. /**
  23243. * Create the effect to be used as the custom effect for a particle system
  23244. * @param particleSystem Particle system to create the effect for
  23245. * @param onCompiled defines a function to call when the effect creation is successful
  23246. * @param onError defines a function to call when the effect creation has failed
  23247. */
  23248. createEffectForParticles(particleSystem: IParticleSystem, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  23249. private _processDefines;
  23250. /**
  23251. * Get if the submesh is ready to be used and all its information available.
  23252. * Child classes can use it to update shaders
  23253. * @param mesh defines the mesh to check
  23254. * @param subMesh defines which submesh to check
  23255. * @param useInstances specifies that instances should be used
  23256. * @returns a boolean indicating that the submesh is ready or not
  23257. */
  23258. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  23259. /**
  23260. * Get a string representing the shaders built by the current node graph
  23261. */
  23262. get compiledShaders(): string;
  23263. /**
  23264. * Binds the world matrix to the material
  23265. * @param world defines the world transformation matrix
  23266. */
  23267. bindOnlyWorldMatrix(world: Matrix): void;
  23268. /**
  23269. * Binds the submesh to this material by preparing the effect and shader to draw
  23270. * @param world defines the world transformation matrix
  23271. * @param mesh defines the mesh containing the submesh
  23272. * @param subMesh defines the submesh to bind the material to
  23273. */
  23274. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  23275. /**
  23276. * Gets the active textures from the material
  23277. * @returns an array of textures
  23278. */
  23279. getActiveTextures(): BaseTexture[];
  23280. /**
  23281. * Gets the list of texture blocks
  23282. * @returns an array of texture blocks
  23283. */
  23284. getTextureBlocks(): (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  23285. /**
  23286. * Specifies if the material uses a texture
  23287. * @param texture defines the texture to check against the material
  23288. * @returns a boolean specifying if the material uses the texture
  23289. */
  23290. hasTexture(texture: BaseTexture): boolean;
  23291. /**
  23292. * Disposes the material
  23293. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  23294. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  23295. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  23296. */
  23297. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  23298. /** Creates the node editor window. */
  23299. private _createNodeEditor;
  23300. /**
  23301. * Launch the node material editor
  23302. * @param config Define the configuration of the editor
  23303. * @return a promise fulfilled when the node editor is visible
  23304. */
  23305. edit(config?: INodeMaterialEditorOptions): Promise<void>;
  23306. /**
  23307. * Clear the current material
  23308. */
  23309. clear(): void;
  23310. /**
  23311. * Clear the current material and set it to a default state
  23312. */
  23313. setToDefault(): void;
  23314. /**
  23315. * Clear the current material and set it to a default state for post process
  23316. */
  23317. setToDefaultPostProcess(): void;
  23318. /**
  23319. * Clear the current material and set it to a default state for particle
  23320. */
  23321. setToDefaultParticle(): void;
  23322. /**
  23323. * Loads the current Node Material from a url pointing to a file save by the Node Material Editor
  23324. * @param url defines the url to load from
  23325. * @returns a promise that will fullfil when the material is fully loaded
  23326. */
  23327. loadAsync(url: string): Promise<void>;
  23328. private _gatherBlocks;
  23329. /**
  23330. * Generate a string containing the code declaration required to create an equivalent of this material
  23331. * @returns a string
  23332. */
  23333. generateCode(): string;
  23334. /**
  23335. * Serializes this material in a JSON representation
  23336. * @returns the serialized material object
  23337. */
  23338. serialize(selectedBlocks?: NodeMaterialBlock[]): any;
  23339. private _restoreConnections;
  23340. /**
  23341. * Clear the current graph and load a new one from a serialization object
  23342. * @param source defines the JSON representation of the material
  23343. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  23344. * @param merge defines whether or not the source must be merged or replace the current content
  23345. */
  23346. loadFromSerialization(source: any, rootUrl?: string, merge?: boolean): void;
  23347. /**
  23348. * Makes a duplicate of the current material.
  23349. * @param name - name to use for the new material.
  23350. */
  23351. clone(name: string): NodeMaterial;
  23352. /**
  23353. * Creates a node material from parsed material data
  23354. * @param source defines the JSON representation of the material
  23355. * @param scene defines the hosting scene
  23356. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  23357. * @returns a new node material
  23358. */
  23359. static Parse(source: any, scene: Scene, rootUrl?: string): NodeMaterial;
  23360. /**
  23361. * Creates a node material from a snippet saved in a remote file
  23362. * @param name defines the name of the material to create
  23363. * @param url defines the url to load from
  23364. * @param scene defines the hosting scene
  23365. * @returns a promise that will resolve to the new node material
  23366. */
  23367. static ParseFromFileAsync(name: string, url: string, scene: Scene): Promise<NodeMaterial>;
  23368. /**
  23369. * Creates a node material from a snippet saved by the node material editor
  23370. * @param snippetId defines the snippet to load
  23371. * @param scene defines the hosting scene
  23372. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  23373. * @param nodeMaterial defines a node material to update (instead of creating a new one)
  23374. * @returns a promise that will resolve to the new node material
  23375. */
  23376. static ParseFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string, nodeMaterial?: NodeMaterial): Promise<NodeMaterial>;
  23377. /**
  23378. * Creates a new node material set to default basic configuration
  23379. * @param name defines the name of the material
  23380. * @param scene defines the hosting scene
  23381. * @returns a new NodeMaterial
  23382. */
  23383. static CreateDefault(name: string, scene?: Scene): NodeMaterial;
  23384. }
  23385. }
  23386. declare module "babylonjs/PostProcesses/postProcess" {
  23387. import { Nullable } from "babylonjs/types";
  23388. import { SmartArray } from "babylonjs/Misc/smartArray";
  23389. import { Observable } from "babylonjs/Misc/observable";
  23390. import { Vector2 } from "babylonjs/Maths/math.vector";
  23391. import { Camera } from "babylonjs/Cameras/camera";
  23392. import { Effect } from "babylonjs/Materials/effect";
  23393. import "babylonjs/Shaders/postprocess.vertex";
  23394. import { IInspectable } from "babylonjs/Misc/iInspectable";
  23395. import { Engine } from "babylonjs/Engines/engine";
  23396. import { Color4 } from "babylonjs/Maths/math.color";
  23397. import "babylonjs/Engines/Extensions/engine.renderTarget";
  23398. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  23399. import { Scene } from "babylonjs/scene";
  23400. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  23401. /**
  23402. * Size options for a post process
  23403. */
  23404. export type PostProcessOptions = {
  23405. width: number;
  23406. height: number;
  23407. };
  23408. /**
  23409. * PostProcess can be used to apply a shader to a texture after it has been rendered
  23410. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  23411. */
  23412. export class PostProcess {
  23413. /**
  23414. * Gets or sets the unique id of the post process
  23415. */
  23416. uniqueId: number;
  23417. /** Name of the PostProcess. */
  23418. name: string;
  23419. /**
  23420. * Width of the texture to apply the post process on
  23421. */
  23422. width: number;
  23423. /**
  23424. * Height of the texture to apply the post process on
  23425. */
  23426. height: number;
  23427. /**
  23428. * Gets the node material used to create this postprocess (null if the postprocess was manually created)
  23429. */
  23430. nodeMaterialSource: Nullable<NodeMaterial>;
  23431. /**
  23432. * Internal, reference to the location where this postprocess was output to. (Typically the texture on the next postprocess in the chain)
  23433. * @hidden
  23434. */
  23435. _outputTexture: Nullable<InternalTexture>;
  23436. /**
  23437. * Sampling mode used by the shader
  23438. * See https://doc.babylonjs.com/classes/3.1/texture
  23439. */
  23440. renderTargetSamplingMode: number;
  23441. /**
  23442. * Clear color to use when screen clearing
  23443. */
  23444. clearColor: Color4;
  23445. /**
  23446. * If the buffer needs to be cleared before applying the post process. (default: true)
  23447. * Should be set to false if shader will overwrite all previous pixels.
  23448. */
  23449. autoClear: boolean;
  23450. /**
  23451. * Type of alpha mode to use when performing the post process (default: Engine.ALPHA_DISABLE)
  23452. */
  23453. alphaMode: number;
  23454. /**
  23455. * Sets the setAlphaBlendConstants of the babylon engine
  23456. */
  23457. alphaConstants: Color4;
  23458. /**
  23459. * Animations to be used for the post processing
  23460. */
  23461. animations: import("babylonjs/Animations/animation").Animation[];
  23462. /**
  23463. * Enable Pixel Perfect mode where texture is not scaled to be power of 2.
  23464. * Can only be used on a single postprocess or on the last one of a chain. (default: false)
  23465. */
  23466. enablePixelPerfectMode: boolean;
  23467. /**
  23468. * Force the postprocess to be applied without taking in account viewport
  23469. */
  23470. forceFullscreenViewport: boolean;
  23471. /**
  23472. * List of inspectable custom properties (used by the Inspector)
  23473. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  23474. */
  23475. inspectableCustomProperties: IInspectable[];
  23476. /**
  23477. * Scale mode for the post process (default: Engine.SCALEMODE_FLOOR)
  23478. *
  23479. * | Value | Type | Description |
  23480. * | ----- | ----------------------------------- | ----------- |
  23481. * | 1 | SCALEMODE_FLOOR | [engine.scalemode_floor](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_floor) |
  23482. * | 2 | SCALEMODE_NEAREST | [engine.scalemode_nearest](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_nearest) |
  23483. * | 3 | SCALEMODE_CEILING | [engine.scalemode_ceiling](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_ceiling) |
  23484. *
  23485. */
  23486. scaleMode: number;
  23487. /**
  23488. * Force textures to be a power of two (default: false)
  23489. */
  23490. alwaysForcePOT: boolean;
  23491. private _samples;
  23492. /**
  23493. * Number of sample textures (default: 1)
  23494. */
  23495. get samples(): number;
  23496. set samples(n: number);
  23497. /**
  23498. * Modify the scale of the post process to be the same as the viewport (default: false)
  23499. */
  23500. adaptScaleToCurrentViewport: boolean;
  23501. private _camera;
  23502. protected _scene: Scene;
  23503. private _engine;
  23504. private _options;
  23505. private _reusable;
  23506. private _textureType;
  23507. private _textureFormat;
  23508. /**
  23509. * Smart array of input and output textures for the post process.
  23510. * @hidden
  23511. */
  23512. _textures: SmartArray<import("babylonjs/Materials/Textures/internalTexture").InternalTexture>;
  23513. /**
  23514. * The index in _textures that corresponds to the output texture.
  23515. * @hidden
  23516. */
  23517. _currentRenderTextureInd: number;
  23518. private _effect;
  23519. private _samplers;
  23520. private _fragmentUrl;
  23521. private _vertexUrl;
  23522. private _parameters;
  23523. private _scaleRatio;
  23524. protected _indexParameters: any;
  23525. private _shareOutputWithPostProcess;
  23526. private _texelSize;
  23527. private _forcedOutputTexture;
  23528. /**
  23529. * Returns the fragment url or shader name used in the post process.
  23530. * @returns the fragment url or name in the shader store.
  23531. */
  23532. getEffectName(): string;
  23533. /**
  23534. * An event triggered when the postprocess is activated.
  23535. */
  23536. onActivateObservable: Observable<Camera>;
  23537. private _onActivateObserver;
  23538. /**
  23539. * A function that is added to the onActivateObservable
  23540. */
  23541. set onActivate(callback: Nullable<(camera: Camera) => void>);
  23542. /**
  23543. * An event triggered when the postprocess changes its size.
  23544. */
  23545. onSizeChangedObservable: Observable<PostProcess>;
  23546. private _onSizeChangedObserver;
  23547. /**
  23548. * A function that is added to the onSizeChangedObservable
  23549. */
  23550. set onSizeChanged(callback: (postProcess: PostProcess) => void);
  23551. /**
  23552. * An event triggered when the postprocess applies its effect.
  23553. */
  23554. onApplyObservable: Observable<Effect>;
  23555. private _onApplyObserver;
  23556. /**
  23557. * A function that is added to the onApplyObservable
  23558. */
  23559. set onApply(callback: (effect: Effect) => void);
  23560. /**
  23561. * An event triggered before rendering the postprocess
  23562. */
  23563. onBeforeRenderObservable: Observable<Effect>;
  23564. private _onBeforeRenderObserver;
  23565. /**
  23566. * A function that is added to the onBeforeRenderObservable
  23567. */
  23568. set onBeforeRender(callback: (effect: Effect) => void);
  23569. /**
  23570. * An event triggered after rendering the postprocess
  23571. */
  23572. onAfterRenderObservable: Observable<Effect>;
  23573. private _onAfterRenderObserver;
  23574. /**
  23575. * A function that is added to the onAfterRenderObservable
  23576. */
  23577. set onAfterRender(callback: (efect: Effect) => void);
  23578. /**
  23579. * The input texture for this post process and the output texture of the previous post process. When added to a pipeline the previous post process will
  23580. * render it's output into this texture and this texture will be used as textureSampler in the fragment shader of this post process.
  23581. */
  23582. get inputTexture(): InternalTexture;
  23583. set inputTexture(value: InternalTexture);
  23584. /**
  23585. * Since inputTexture should always be defined, if we previously manually set `inputTexture`,
  23586. * the only way to unset it is to use this function to restore its internal state
  23587. */
  23588. restoreDefaultInputTexture(): void;
  23589. /**
  23590. * Gets the camera which post process is applied to.
  23591. * @returns The camera the post process is applied to.
  23592. */
  23593. getCamera(): Camera;
  23594. /**
  23595. * Gets the texel size of the postprocess.
  23596. * See https://en.wikipedia.org/wiki/Texel_(graphics)
  23597. */
  23598. get texelSize(): Vector2;
  23599. /**
  23600. * Creates a new instance PostProcess
  23601. * @param name The name of the PostProcess.
  23602. * @param fragmentUrl The url of the fragment shader to be used.
  23603. * @param parameters Array of the names of uniform non-sampler2D variables that will be passed to the shader.
  23604. * @param samplers Array of the names of uniform sampler2D variables that will be passed to the shader.
  23605. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  23606. * @param camera The camera to apply the render pass to.
  23607. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  23608. * @param engine The engine which the post process will be applied. (default: current engine)
  23609. * @param reusable If the post process can be reused on the same frame. (default: false)
  23610. * @param defines String of defines that will be set when running the fragment shader. (default: null)
  23611. * @param textureType Type of textures used when performing the post process. (default: 0)
  23612. * @param vertexUrl The url of the vertex shader to be used. (default: "postprocess")
  23613. * @param indexParameters The index parameters to be used for babylons include syntax "#include<kernelBlurVaryingDeclaration>[0..varyingCount]". (default: undefined) See usage in babylon.blurPostProcess.ts and kernelBlur.vertex.fx
  23614. * @param blockCompilation If the shader should not be compiled imediatly. (default: false)
  23615. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  23616. */
  23617. constructor(name: string, fragmentUrl: string, parameters: Nullable<string[]>, samplers: Nullable<string[]>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, defines?: Nullable<string>, textureType?: number, vertexUrl?: string, indexParameters?: any, blockCompilation?: boolean, textureFormat?: number);
  23618. /**
  23619. * Gets a string identifying the name of the class
  23620. * @returns "PostProcess" string
  23621. */
  23622. getClassName(): string;
  23623. /**
  23624. * Gets the engine which this post process belongs to.
  23625. * @returns The engine the post process was enabled with.
  23626. */
  23627. getEngine(): Engine;
  23628. /**
  23629. * The effect that is created when initializing the post process.
  23630. * @returns The created effect corresponding the the postprocess.
  23631. */
  23632. getEffect(): Effect;
  23633. /**
  23634. * To avoid multiple redundant textures for multiple post process, the output the output texture for this post process can be shared with another.
  23635. * @param postProcess The post process to share the output with.
  23636. * @returns This post process.
  23637. */
  23638. shareOutputWith(postProcess: PostProcess): PostProcess;
  23639. /**
  23640. * Reverses the effect of calling shareOutputWith and returns the post process back to its original state.
  23641. * This should be called if the post process that shares output with this post process is disabled/disposed.
  23642. */
  23643. useOwnOutput(): void;
  23644. /**
  23645. * Updates the effect with the current post process compile time values and recompiles the shader.
  23646. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  23647. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  23648. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  23649. * @param indexParameters The index parameters to be used for babylons include syntax "#include<kernelBlurVaryingDeclaration>[0..varyingCount]". (default: undefined) See usage in babylon.blurPostProcess.ts and kernelBlur.vertex.fx
  23650. * @param onCompiled Called when the shader has been compiled.
  23651. * @param onError Called if there is an error when compiling a shader.
  23652. * @param vertexUrl The url of the vertex shader to be used (default: the one given at construction time)
  23653. * @param fragmentUrl The url of the fragment shader to be used (default: the one given at construction time)
  23654. */
  23655. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void, vertexUrl?: string, fragmentUrl?: string): void;
  23656. /**
  23657. * The post process is reusable if it can be used multiple times within one frame.
  23658. * @returns If the post process is reusable
  23659. */
  23660. isReusable(): boolean;
  23661. /** invalidate frameBuffer to hint the postprocess to create a depth buffer */
  23662. markTextureDirty(): void;
  23663. /**
  23664. * Activates the post process by intializing the textures to be used when executed. Notifies onActivateObservable.
  23665. * When this post process is used in a pipeline, this is call will bind the input texture of this post process to the output of the previous.
  23666. * @param camera The camera that will be used in the post process. This camera will be used when calling onActivateObservable.
  23667. * @param sourceTexture The source texture to be inspected to get the width and height if not specified in the post process constructor. (default: null)
  23668. * @param forceDepthStencil If true, a depth and stencil buffer will be generated. (default: false)
  23669. * @returns The target texture that was bound to be written to.
  23670. */
  23671. activate(camera: Nullable<Camera>, sourceTexture?: Nullable<InternalTexture>, forceDepthStencil?: boolean): InternalTexture;
  23672. /**
  23673. * If the post process is supported.
  23674. */
  23675. get isSupported(): boolean;
  23676. /**
  23677. * The aspect ratio of the output texture.
  23678. */
  23679. get aspectRatio(): number;
  23680. /**
  23681. * Get a value indicating if the post-process is ready to be used
  23682. * @returns true if the post-process is ready (shader is compiled)
  23683. */
  23684. isReady(): boolean;
  23685. /**
  23686. * Binds all textures and uniforms to the shader, this will be run on every pass.
  23687. * @returns the effect corresponding to this post process. Null if not compiled or not ready.
  23688. */
  23689. apply(): Nullable<Effect>;
  23690. private _disposeTextures;
  23691. /**
  23692. * Disposes the post process.
  23693. * @param camera The camera to dispose the post process on.
  23694. */
  23695. dispose(camera?: Camera): void;
  23696. /**
  23697. * Serializes the particle system to a JSON object
  23698. * @returns the JSON object
  23699. */
  23700. serialize(): any;
  23701. /**
  23702. * Creates a material from parsed material data
  23703. * @param parsedPostProcess defines parsed post process data
  23704. * @param scene defines the hosting scene
  23705. * @param rootUrl defines the root URL to use to load textures
  23706. * @returns a new post process
  23707. */
  23708. static Parse(parsedPostProcess: any, scene: Scene, rootUrl: string): Nullable<PostProcess>;
  23709. }
  23710. }
  23711. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration" {
  23712. /** @hidden */
  23713. export var kernelBlurVaryingDeclaration: {
  23714. name: string;
  23715. shader: string;
  23716. };
  23717. }
  23718. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurFragment" {
  23719. /** @hidden */
  23720. export var kernelBlurFragment: {
  23721. name: string;
  23722. shader: string;
  23723. };
  23724. }
  23725. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurFragment2" {
  23726. /** @hidden */
  23727. export var kernelBlurFragment2: {
  23728. name: string;
  23729. shader: string;
  23730. };
  23731. }
  23732. declare module "babylonjs/Shaders/kernelBlur.fragment" {
  23733. import "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration";
  23734. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  23735. import "babylonjs/Shaders/ShadersInclude/kernelBlurFragment";
  23736. import "babylonjs/Shaders/ShadersInclude/kernelBlurFragment2";
  23737. /** @hidden */
  23738. export var kernelBlurPixelShader: {
  23739. name: string;
  23740. shader: string;
  23741. };
  23742. }
  23743. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurVertex" {
  23744. /** @hidden */
  23745. export var kernelBlurVertex: {
  23746. name: string;
  23747. shader: string;
  23748. };
  23749. }
  23750. declare module "babylonjs/Shaders/kernelBlur.vertex" {
  23751. import "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration";
  23752. import "babylonjs/Shaders/ShadersInclude/kernelBlurVertex";
  23753. /** @hidden */
  23754. export var kernelBlurVertexShader: {
  23755. name: string;
  23756. shader: string;
  23757. };
  23758. }
  23759. declare module "babylonjs/PostProcesses/blurPostProcess" {
  23760. import { Vector2 } from "babylonjs/Maths/math.vector";
  23761. import { Nullable } from "babylonjs/types";
  23762. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  23763. import { Camera } from "babylonjs/Cameras/camera";
  23764. import { Effect } from "babylonjs/Materials/effect";
  23765. import { Engine } from "babylonjs/Engines/engine";
  23766. import "babylonjs/Shaders/kernelBlur.fragment";
  23767. import "babylonjs/Shaders/kernelBlur.vertex";
  23768. import { Scene } from "babylonjs/scene";
  23769. /**
  23770. * The Blur Post Process which blurs an image based on a kernel and direction.
  23771. * Can be used twice in x and y directions to perform a guassian blur in two passes.
  23772. */
  23773. export class BlurPostProcess extends PostProcess {
  23774. private blockCompilation;
  23775. protected _kernel: number;
  23776. protected _idealKernel: number;
  23777. protected _packedFloat: boolean;
  23778. private _staticDefines;
  23779. /** The direction in which to blur the image. */
  23780. direction: Vector2;
  23781. /**
  23782. * Sets the length in pixels of the blur sample region
  23783. */
  23784. set kernel(v: number);
  23785. /**
  23786. * Gets the length in pixels of the blur sample region
  23787. */
  23788. get kernel(): number;
  23789. /**
  23790. * Sets wether or not the blur needs to unpack/repack floats
  23791. */
  23792. set packedFloat(v: boolean);
  23793. /**
  23794. * Gets wether or not the blur is unpacking/repacking floats
  23795. */
  23796. get packedFloat(): boolean;
  23797. /**
  23798. * Gets a string identifying the name of the class
  23799. * @returns "BlurPostProcess" string
  23800. */
  23801. getClassName(): string;
  23802. /**
  23803. * Creates a new instance BlurPostProcess
  23804. * @param name The name of the effect.
  23805. * @param direction The direction in which to blur the image.
  23806. * @param kernel The size of the kernel to be used when computing the blur. eg. Size of 3 will blur the center pixel by 2 pixels surrounding it.
  23807. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  23808. * @param camera The camera to apply the render pass to.
  23809. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  23810. * @param engine The engine which the post process will be applied. (default: current engine)
  23811. * @param reusable If the post process can be reused on the same frame. (default: false)
  23812. * @param textureType Type of textures used when performing the post process. (default: 0)
  23813. * @param blockCompilation If compilation of the shader should not be done in the constructor. The updateEffect method can be used to compile the shader at a later time. (default: false)
  23814. */
  23815. constructor(name: string, direction: Vector2, kernel: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, defines?: string, blockCompilation?: boolean);
  23816. /**
  23817. * Updates the effect with the current post process compile time values and recompiles the shader.
  23818. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  23819. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  23820. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  23821. * @param indexParameters The index parameters to be used for babylons include syntax "#include<kernelBlurVaryingDeclaration>[0..varyingCount]". (default: undefined) See usage in babylon.blurPostProcess.ts and kernelBlur.vertex.fx
  23822. * @param onCompiled Called when the shader has been compiled.
  23823. * @param onError Called if there is an error when compiling a shader.
  23824. */
  23825. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  23826. protected _updateParameters(onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  23827. /**
  23828. * Best kernels are odd numbers that when divided by 2, their integer part is even, so 5, 9 or 13.
  23829. * Other odd kernels optimize correctly but require proportionally more samples, even kernels are
  23830. * possible but will produce minor visual artifacts. Since each new kernel requires a new shader we
  23831. * want to minimize kernel changes, having gaps between physical kernels is helpful in that regard.
  23832. * The gaps between physical kernels are compensated for in the weighting of the samples
  23833. * @param idealKernel Ideal blur kernel.
  23834. * @return Nearest best kernel.
  23835. */
  23836. protected _nearestBestKernel(idealKernel: number): number;
  23837. /**
  23838. * Calculates the value of a Gaussian distribution with sigma 3 at a given point.
  23839. * @param x The point on the Gaussian distribution to sample.
  23840. * @return the value of the Gaussian function at x.
  23841. */
  23842. protected _gaussianWeight(x: number): number;
  23843. /**
  23844. * Generates a string that can be used as a floating point number in GLSL.
  23845. * @param x Value to print.
  23846. * @param decimalFigures Number of decimal places to print the number to (excluding trailing 0s).
  23847. * @return GLSL float string.
  23848. */
  23849. protected _glslFloat(x: number, decimalFigures?: number): string;
  23850. /** @hidden */
  23851. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<BlurPostProcess>;
  23852. }
  23853. }
  23854. declare module "babylonjs/Materials/Textures/mirrorTexture" {
  23855. import { Scene } from "babylonjs/scene";
  23856. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  23857. import { Plane } from "babylonjs/Maths/math.plane";
  23858. /**
  23859. * Mirror texture can be used to simulate the view from a mirror in a scene.
  23860. * It will dynamically be rendered every frame to adapt to the camera point of view.
  23861. * You can then easily use it as a reflectionTexture on a flat surface.
  23862. * In case the surface is not a plane, please consider relying on reflection probes.
  23863. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  23864. */
  23865. export class MirrorTexture extends RenderTargetTexture {
  23866. private scene;
  23867. /**
  23868. * Define the reflection plane we want to use. The mirrorPlane is usually set to the constructed reflector.
  23869. * It is possible to directly set the mirrorPlane by directly using a Plane(a, b, c, d) where a, b and c give the plane normal vector (a, b, c) and d is a scalar displacement from the mirrorPlane to the origin. However in all but the very simplest of situations it is more straight forward to set it to the reflector as stated in the doc.
  23870. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  23871. */
  23872. mirrorPlane: Plane;
  23873. /**
  23874. * Define the blur ratio used to blur the reflection if needed.
  23875. */
  23876. set blurRatio(value: number);
  23877. get blurRatio(): number;
  23878. /**
  23879. * Define the adaptive blur kernel used to blur the reflection if needed.
  23880. * This will autocompute the closest best match for the `blurKernel`
  23881. */
  23882. set adaptiveBlurKernel(value: number);
  23883. /**
  23884. * Define the blur kernel used to blur the reflection if needed.
  23885. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  23886. */
  23887. set blurKernel(value: number);
  23888. /**
  23889. * Define the blur kernel on the X Axis used to blur the reflection if needed.
  23890. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  23891. */
  23892. set blurKernelX(value: number);
  23893. get blurKernelX(): number;
  23894. /**
  23895. * Define the blur kernel on the Y Axis used to blur the reflection if needed.
  23896. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  23897. */
  23898. set blurKernelY(value: number);
  23899. get blurKernelY(): number;
  23900. private _autoComputeBlurKernel;
  23901. protected _onRatioRescale(): void;
  23902. private _updateGammaSpace;
  23903. private _imageProcessingConfigChangeObserver;
  23904. private _transformMatrix;
  23905. private _mirrorMatrix;
  23906. private _savedViewMatrix;
  23907. private _blurX;
  23908. private _blurY;
  23909. private _adaptiveBlurKernel;
  23910. private _blurKernelX;
  23911. private _blurKernelY;
  23912. private _blurRatio;
  23913. /**
  23914. * Instantiates a Mirror Texture.
  23915. * Mirror texture can be used to simulate the view from a mirror in a scene.
  23916. * It will dynamically be rendered every frame to adapt to the camera point of view.
  23917. * You can then easily use it as a reflectionTexture on a flat surface.
  23918. * In case the surface is not a plane, please consider relying on reflection probes.
  23919. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  23920. * @param name
  23921. * @param size
  23922. * @param scene
  23923. * @param generateMipMaps
  23924. * @param type
  23925. * @param samplingMode
  23926. * @param generateDepthBuffer
  23927. */
  23928. constructor(name: string, size: number | {
  23929. width: number;
  23930. height: number;
  23931. } | {
  23932. ratio: number;
  23933. }, scene: Scene, generateMipMaps?: boolean, type?: number, samplingMode?: number, generateDepthBuffer?: boolean);
  23934. private _preparePostProcesses;
  23935. /**
  23936. * Clone the mirror texture.
  23937. * @returns the cloned texture
  23938. */
  23939. clone(): MirrorTexture;
  23940. /**
  23941. * Serialize the texture to a JSON representation you could use in Parse later on
  23942. * @returns the serialized JSON representation
  23943. */
  23944. serialize(): any;
  23945. /**
  23946. * Dispose the texture and release its associated resources.
  23947. */
  23948. dispose(): void;
  23949. }
  23950. }
  23951. declare module "babylonjs/Materials/Textures/texture" {
  23952. import { Observable } from "babylonjs/Misc/observable";
  23953. import { Nullable } from "babylonjs/types";
  23954. import { Matrix } from "babylonjs/Maths/math.vector";
  23955. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  23956. import { IInspectable } from "babylonjs/Misc/iInspectable";
  23957. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  23958. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  23959. import { MirrorTexture } from "babylonjs/Materials/Textures/mirrorTexture";
  23960. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  23961. import { Scene } from "babylonjs/scene";
  23962. /**
  23963. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  23964. * @see https://doc.babylonjs.com/babylon101/materials#texture
  23965. */
  23966. export class Texture extends BaseTexture {
  23967. /**
  23968. * Gets or sets a general boolean used to indicate that textures containing direct data (buffers) must be saved as part of the serialization process
  23969. */
  23970. static SerializeBuffers: boolean;
  23971. /** @hidden */
  23972. static _CubeTextureParser: (jsonTexture: any, scene: Scene, rootUrl: string) => CubeTexture;
  23973. /** @hidden */
  23974. static _CreateMirror: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => MirrorTexture;
  23975. /** @hidden */
  23976. static _CreateRenderTargetTexture: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => RenderTargetTexture;
  23977. /** nearest is mag = nearest and min = nearest and mip = linear */
  23978. static readonly NEAREST_SAMPLINGMODE: number;
  23979. /** nearest is mag = nearest and min = nearest and mip = linear */
  23980. static readonly NEAREST_NEAREST_MIPLINEAR: number;
  23981. /** Bilinear is mag = linear and min = linear and mip = nearest */
  23982. static readonly BILINEAR_SAMPLINGMODE: number;
  23983. /** Bilinear is mag = linear and min = linear and mip = nearest */
  23984. static readonly LINEAR_LINEAR_MIPNEAREST: number;
  23985. /** Trilinear is mag = linear and min = linear and mip = linear */
  23986. static readonly TRILINEAR_SAMPLINGMODE: number;
  23987. /** Trilinear is mag = linear and min = linear and mip = linear */
  23988. static readonly LINEAR_LINEAR_MIPLINEAR: number;
  23989. /** mag = nearest and min = nearest and mip = nearest */
  23990. static readonly NEAREST_NEAREST_MIPNEAREST: number;
  23991. /** mag = nearest and min = linear and mip = nearest */
  23992. static readonly NEAREST_LINEAR_MIPNEAREST: number;
  23993. /** mag = nearest and min = linear and mip = linear */
  23994. static readonly NEAREST_LINEAR_MIPLINEAR: number;
  23995. /** mag = nearest and min = linear and mip = none */
  23996. static readonly NEAREST_LINEAR: number;
  23997. /** mag = nearest and min = nearest and mip = none */
  23998. static readonly NEAREST_NEAREST: number;
  23999. /** mag = linear and min = nearest and mip = nearest */
  24000. static readonly LINEAR_NEAREST_MIPNEAREST: number;
  24001. /** mag = linear and min = nearest and mip = linear */
  24002. static readonly LINEAR_NEAREST_MIPLINEAR: number;
  24003. /** mag = linear and min = linear and mip = none */
  24004. static readonly LINEAR_LINEAR: number;
  24005. /** mag = linear and min = nearest and mip = none */
  24006. static readonly LINEAR_NEAREST: number;
  24007. /** Explicit coordinates mode */
  24008. static readonly EXPLICIT_MODE: number;
  24009. /** Spherical coordinates mode */
  24010. static readonly SPHERICAL_MODE: number;
  24011. /** Planar coordinates mode */
  24012. static readonly PLANAR_MODE: number;
  24013. /** Cubic coordinates mode */
  24014. static readonly CUBIC_MODE: number;
  24015. /** Projection coordinates mode */
  24016. static readonly PROJECTION_MODE: number;
  24017. /** Inverse Cubic coordinates mode */
  24018. static readonly SKYBOX_MODE: number;
  24019. /** Inverse Cubic coordinates mode */
  24020. static readonly INVCUBIC_MODE: number;
  24021. /** Equirectangular coordinates mode */
  24022. static readonly EQUIRECTANGULAR_MODE: number;
  24023. /** Equirectangular Fixed coordinates mode */
  24024. static readonly FIXED_EQUIRECTANGULAR_MODE: number;
  24025. /** Equirectangular Fixed Mirrored coordinates mode */
  24026. static readonly FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  24027. /** Texture is not repeating outside of 0..1 UVs */
  24028. static readonly CLAMP_ADDRESSMODE: number;
  24029. /** Texture is repeating outside of 0..1 UVs */
  24030. static readonly WRAP_ADDRESSMODE: number;
  24031. /** Texture is repeating and mirrored */
  24032. static readonly MIRROR_ADDRESSMODE: number;
  24033. /**
  24034. * Gets or sets a boolean which defines if the texture url must be build from the serialized URL instead of just using the name and loading them side by side with the scene file
  24035. */
  24036. static UseSerializedUrlIfAny: boolean;
  24037. /**
  24038. * Define the url of the texture.
  24039. */
  24040. url: Nullable<string>;
  24041. /**
  24042. * Define an offset on the texture to offset the u coordinates of the UVs
  24043. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  24044. */
  24045. uOffset: number;
  24046. /**
  24047. * Define an offset on the texture to offset the v coordinates of the UVs
  24048. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  24049. */
  24050. vOffset: number;
  24051. /**
  24052. * Define an offset on the texture to scale the u coordinates of the UVs
  24053. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  24054. */
  24055. uScale: number;
  24056. /**
  24057. * Define an offset on the texture to scale the v coordinates of the UVs
  24058. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  24059. */
  24060. vScale: number;
  24061. /**
  24062. * Define an offset on the texture to rotate around the u coordinates of the UVs
  24063. * @see https://doc.babylonjs.com/how_to/more_materials
  24064. */
  24065. uAng: number;
  24066. /**
  24067. * Define an offset on the texture to rotate around the v coordinates of the UVs
  24068. * @see https://doc.babylonjs.com/how_to/more_materials
  24069. */
  24070. vAng: number;
  24071. /**
  24072. * Define an offset on the texture to rotate around the w coordinates of the UVs (in case of 3d texture)
  24073. * @see https://doc.babylonjs.com/how_to/more_materials
  24074. */
  24075. wAng: number;
  24076. /**
  24077. * Defines the center of rotation (U)
  24078. */
  24079. uRotationCenter: number;
  24080. /**
  24081. * Defines the center of rotation (V)
  24082. */
  24083. vRotationCenter: number;
  24084. /**
  24085. * Defines the center of rotation (W)
  24086. */
  24087. wRotationCenter: number;
  24088. /**
  24089. * Are mip maps generated for this texture or not.
  24090. */
  24091. get noMipmap(): boolean;
  24092. /**
  24093. * List of inspectable custom properties (used by the Inspector)
  24094. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  24095. */
  24096. inspectableCustomProperties: Nullable<IInspectable[]>;
  24097. private _noMipmap;
  24098. /** @hidden */
  24099. _invertY: boolean;
  24100. private _rowGenerationMatrix;
  24101. private _cachedTextureMatrix;
  24102. private _projectionModeMatrix;
  24103. private _t0;
  24104. private _t1;
  24105. private _t2;
  24106. private _cachedUOffset;
  24107. private _cachedVOffset;
  24108. private _cachedUScale;
  24109. private _cachedVScale;
  24110. private _cachedUAng;
  24111. private _cachedVAng;
  24112. private _cachedWAng;
  24113. private _cachedProjectionMatrixId;
  24114. private _cachedCoordinatesMode;
  24115. /** @hidden */
  24116. protected _initialSamplingMode: number;
  24117. /** @hidden */
  24118. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  24119. private _deleteBuffer;
  24120. protected _format: Nullable<number>;
  24121. private _delayedOnLoad;
  24122. private _delayedOnError;
  24123. private _mimeType?;
  24124. /** Returns the texture mime type if it was defined by a loader (undefined else) */
  24125. get mimeType(): string | undefined;
  24126. /**
  24127. * Observable triggered once the texture has been loaded.
  24128. */
  24129. onLoadObservable: Observable<Texture>;
  24130. protected _isBlocking: boolean;
  24131. /**
  24132. * Is the texture preventing material to render while loading.
  24133. * If false, a default texture will be used instead of the loading one during the preparation step.
  24134. */
  24135. set isBlocking(value: boolean);
  24136. get isBlocking(): boolean;
  24137. /**
  24138. * Get the current sampling mode associated with the texture.
  24139. */
  24140. get samplingMode(): number;
  24141. /**
  24142. * Gets a boolean indicating if the texture needs to be inverted on the y axis during loading
  24143. */
  24144. get invertY(): boolean;
  24145. /**
  24146. * Instantiates a new texture.
  24147. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  24148. * @see https://doc.babylonjs.com/babylon101/materials#texture
  24149. * @param url defines the url of the picture to load as a texture
  24150. * @param sceneOrEngine defines the scene or engine the texture will belong to
  24151. * @param noMipmap defines if the texture will require mip maps or not
  24152. * @param invertY defines if the texture needs to be inverted on the y axis during loading
  24153. * @param samplingMode defines the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  24154. * @param onLoad defines a callback triggered when the texture has been loaded
  24155. * @param onError defines a callback triggered when an error occurred during the loading session
  24156. * @param buffer defines the buffer to load the texture from in case the texture is loaded from a buffer representation
  24157. * @param deleteBuffer defines if the buffer we are loading the texture from should be deleted after load
  24158. * @param format defines the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  24159. * @param mimeType defines an optional mime type information
  24160. */
  24161. constructor(url: Nullable<string>, sceneOrEngine: Nullable<Scene | ThinEngine>, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>, deleteBuffer?: boolean, format?: number, mimeType?: string);
  24162. /**
  24163. * Update the url (and optional buffer) of this texture if url was null during construction.
  24164. * @param url the url of the texture
  24165. * @param buffer the buffer of the texture (defaults to null)
  24166. * @param onLoad callback called when the texture is loaded (defaults to null)
  24167. */
  24168. updateURL(url: string, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob>, onLoad?: () => void): void;
  24169. /**
  24170. * Finish the loading sequence of a texture flagged as delayed load.
  24171. * @hidden
  24172. */
  24173. delayLoad(): void;
  24174. private _prepareRowForTextureGeneration;
  24175. /**
  24176. * Get the current texture matrix which includes the requested offsetting, tiling and rotation components.
  24177. * @returns the transform matrix of the texture.
  24178. */
  24179. getTextureMatrix(uBase?: number): Matrix;
  24180. /**
  24181. * Get the current matrix used to apply reflection. This is useful to rotate an environment texture for instance.
  24182. * @returns The reflection texture transform
  24183. */
  24184. getReflectionTextureMatrix(): Matrix;
  24185. /**
  24186. * Clones the texture.
  24187. * @returns the cloned texture
  24188. */
  24189. clone(): Texture;
  24190. /**
  24191. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  24192. * @returns The JSON representation of the texture
  24193. */
  24194. serialize(): any;
  24195. /**
  24196. * Get the current class name of the texture useful for serialization or dynamic coding.
  24197. * @returns "Texture"
  24198. */
  24199. getClassName(): string;
  24200. /**
  24201. * Dispose the texture and release its associated resources.
  24202. */
  24203. dispose(): void;
  24204. /**
  24205. * Parse the JSON representation of a texture in order to recreate the texture in the given scene.
  24206. * @param parsedTexture Define the JSON representation of the texture
  24207. * @param scene Define the scene the parsed texture should be instantiated in
  24208. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  24209. * @returns The parsed texture if successful
  24210. */
  24211. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<BaseTexture>;
  24212. /**
  24213. * Creates a texture from its base 64 representation.
  24214. * @param data Define the base64 payload without the data: prefix
  24215. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  24216. * @param scene Define the scene the texture should belong to
  24217. * @param noMipmap Forces the texture to not create mip map information if true
  24218. * @param invertY define if the texture needs to be inverted on the y axis during loading
  24219. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  24220. * @param onLoad define a callback triggered when the texture has been loaded
  24221. * @param onError define a callback triggered when an error occurred during the loading session
  24222. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  24223. * @returns the created texture
  24224. */
  24225. static CreateFromBase64String(data: string, name: string, scene: Scene, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<() => void>, format?: number): Texture;
  24226. /**
  24227. * Creates a texture from its data: representation. (data: will be added in case only the payload has been passed in)
  24228. * @param data Define the base64 payload without the data: prefix
  24229. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  24230. * @param buffer define the buffer to load the texture from in case the texture is loaded from a buffer representation
  24231. * @param scene Define the scene the texture should belong to
  24232. * @param deleteBuffer define if the buffer we are loading the texture from should be deleted after load
  24233. * @param noMipmap Forces the texture to not create mip map information if true
  24234. * @param invertY define if the texture needs to be inverted on the y axis during loading
  24235. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  24236. * @param onLoad define a callback triggered when the texture has been loaded
  24237. * @param onError define a callback triggered when an error occurred during the loading session
  24238. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  24239. * @returns the created texture
  24240. */
  24241. static LoadFromDataString(name: string, buffer: any, scene: Scene, deleteBuffer?: boolean, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>, format?: number): Texture;
  24242. }
  24243. }
  24244. declare module "babylonjs/PostProcesses/postProcessManager" {
  24245. import { Nullable } from "babylonjs/types";
  24246. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  24247. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  24248. import { Scene } from "babylonjs/scene";
  24249. /**
  24250. * PostProcessManager is used to manage one or more post processes or post process pipelines
  24251. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  24252. */
  24253. export class PostProcessManager {
  24254. private _scene;
  24255. private _indexBuffer;
  24256. private _vertexBuffers;
  24257. /**
  24258. * Creates a new instance PostProcess
  24259. * @param scene The scene that the post process is associated with.
  24260. */
  24261. constructor(scene: Scene);
  24262. private _prepareBuffers;
  24263. private _buildIndexBuffer;
  24264. /**
  24265. * Rebuilds the vertex buffers of the manager.
  24266. * @hidden
  24267. */
  24268. _rebuild(): void;
  24269. /**
  24270. * Prepares a frame to be run through a post process.
  24271. * @param sourceTexture The input texture to the post procesess. (default: null)
  24272. * @param postProcesses An array of post processes to be run. (default: null)
  24273. * @returns True if the post processes were able to be run.
  24274. * @hidden
  24275. */
  24276. _prepareFrame(sourceTexture?: Nullable<InternalTexture>, postProcesses?: Nullable<PostProcess[]>): boolean;
  24277. /**
  24278. * Manually render a set of post processes to a texture.
  24279. * Please note, the frame buffer won't be unbound after the call in case you have more render to do.
  24280. * @param postProcesses An array of post processes to be run.
  24281. * @param targetTexture The target texture to render to.
  24282. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight
  24283. * @param faceIndex defines the face to render to if a cubemap is defined as the target
  24284. * @param lodLevel defines which lod of the texture to render to
  24285. * @param doNotBindFrambuffer If set to true, assumes that the framebuffer has been bound previously
  24286. */
  24287. directRender(postProcesses: PostProcess[], targetTexture?: Nullable<InternalTexture>, forceFullscreenViewport?: boolean, faceIndex?: number, lodLevel?: number, doNotBindFrambuffer?: boolean): void;
  24288. /**
  24289. * Finalize the result of the output of the postprocesses.
  24290. * @param doNotPresent If true the result will not be displayed to the screen.
  24291. * @param targetTexture The target texture to render to.
  24292. * @param faceIndex The index of the face to bind the target texture to.
  24293. * @param postProcesses The array of post processes to render.
  24294. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight (default: false)
  24295. * @hidden
  24296. */
  24297. _finalizeFrame(doNotPresent?: boolean, targetTexture?: InternalTexture, faceIndex?: number, postProcesses?: Array<PostProcess>, forceFullscreenViewport?: boolean): void;
  24298. /**
  24299. * Disposes of the post process manager.
  24300. */
  24301. dispose(): void;
  24302. }
  24303. }
  24304. declare module "babylonjs/Materials/Textures/renderTargetTexture" {
  24305. import { Observable } from "babylonjs/Misc/observable";
  24306. import { SmartArray } from "babylonjs/Misc/smartArray";
  24307. import { Nullable, Immutable } from "babylonjs/types";
  24308. import { Camera } from "babylonjs/Cameras/camera";
  24309. import { Scene } from "babylonjs/scene";
  24310. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  24311. import { Color4 } from "babylonjs/Maths/math.color";
  24312. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  24313. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  24314. import { SubMesh } from "babylonjs/Meshes/subMesh";
  24315. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  24316. import { Texture } from "babylonjs/Materials/Textures/texture";
  24317. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  24318. import { RenderingManager } from "babylonjs/Rendering/renderingManager";
  24319. import "babylonjs/Engines/Extensions/engine.renderTarget";
  24320. import "babylonjs/Engines/Extensions/engine.renderTargetCube";
  24321. import { Engine } from "babylonjs/Engines/engine";
  24322. /**
  24323. * This Helps creating a texture that will be created from a camera in your scene.
  24324. * It is basically a dynamic texture that could be used to create special effects for instance.
  24325. * Actually, It is the base of lot of effects in the framework like post process, shadows, effect layers and rendering pipelines...
  24326. */
  24327. export class RenderTargetTexture extends Texture {
  24328. /**
  24329. * The texture will only be rendered once which can be useful to improve performance if everything in your render is static for instance.
  24330. */
  24331. static readonly REFRESHRATE_RENDER_ONCE: number;
  24332. /**
  24333. * The texture will only be rendered rendered every frame and is recomended for dynamic contents.
  24334. */
  24335. static readonly REFRESHRATE_RENDER_ONEVERYFRAME: number;
  24336. /**
  24337. * The texture will be rendered every 2 frames which could be enough if your dynamic objects are not
  24338. * the central point of your effect and can save a lot of performances.
  24339. */
  24340. static readonly REFRESHRATE_RENDER_ONEVERYTWOFRAMES: number;
  24341. /**
  24342. * Use this predicate to dynamically define the list of mesh you want to render.
  24343. * If set, the renderList property will be overwritten.
  24344. */
  24345. renderListPredicate: (AbstractMesh: AbstractMesh) => boolean;
  24346. private _renderList;
  24347. /**
  24348. * Use this list to define the list of mesh you want to render.
  24349. */
  24350. get renderList(): Nullable<Array<AbstractMesh>>;
  24351. set renderList(value: Nullable<Array<AbstractMesh>>);
  24352. /**
  24353. * Use this function to overload the renderList array at rendering time.
  24354. * Return null to render with the curent renderList, else return the list of meshes to use for rendering.
  24355. * For 2DArray RTT, layerOrFace is the index of the layer that is going to be rendered, else it is the faceIndex of
  24356. * the cube (if the RTT is a cube, else layerOrFace=0).
  24357. * The renderList passed to the function is the current render list (the one that will be used if the function returns null).
  24358. * The length of this list is passed through renderListLength: don't use renderList.length directly because the array can
  24359. * hold dummy elements!
  24360. */
  24361. getCustomRenderList: (layerOrFace: number, renderList: Nullable<Immutable<Array<AbstractMesh>>>, renderListLength: number) => Nullable<Array<AbstractMesh>>;
  24362. private _hookArray;
  24363. /**
  24364. * Define if particles should be rendered in your texture.
  24365. */
  24366. renderParticles: boolean;
  24367. /**
  24368. * Define if sprites should be rendered in your texture.
  24369. */
  24370. renderSprites: boolean;
  24371. /**
  24372. * Define the camera used to render the texture.
  24373. */
  24374. activeCamera: Nullable<Camera>;
  24375. /**
  24376. * Override the mesh isReady function with your own one.
  24377. */
  24378. customIsReadyFunction: (mesh: AbstractMesh, refreshRate: number) => boolean;
  24379. /**
  24380. * Override the render function of the texture with your own one.
  24381. */
  24382. customRenderFunction: (opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>, beforeTransparents?: () => void) => void;
  24383. /**
  24384. * Define if camera post processes should be use while rendering the texture.
  24385. */
  24386. useCameraPostProcesses: boolean;
  24387. /**
  24388. * Define if the camera viewport should be respected while rendering the texture or if the render should be done to the entire texture.
  24389. */
  24390. ignoreCameraViewport: boolean;
  24391. private _postProcessManager;
  24392. private _postProcesses;
  24393. private _resizeObserver;
  24394. /**
  24395. * An event triggered when the texture is unbind.
  24396. */
  24397. onBeforeBindObservable: Observable<RenderTargetTexture>;
  24398. /**
  24399. * An event triggered when the texture is unbind.
  24400. */
  24401. onAfterUnbindObservable: Observable<RenderTargetTexture>;
  24402. private _onAfterUnbindObserver;
  24403. /**
  24404. * Set a after unbind callback in the texture.
  24405. * This has been kept for backward compatibility and use of onAfterUnbindObservable is recommended.
  24406. */
  24407. set onAfterUnbind(callback: () => void);
  24408. /**
  24409. * An event triggered before rendering the texture
  24410. */
  24411. onBeforeRenderObservable: Observable<number>;
  24412. private _onBeforeRenderObserver;
  24413. /**
  24414. * Set a before render callback in the texture.
  24415. * This has been kept for backward compatibility and use of onBeforeRenderObservable is recommended.
  24416. */
  24417. set onBeforeRender(callback: (faceIndex: number) => void);
  24418. /**
  24419. * An event triggered after rendering the texture
  24420. */
  24421. onAfterRenderObservable: Observable<number>;
  24422. private _onAfterRenderObserver;
  24423. /**
  24424. * Set a after render callback in the texture.
  24425. * This has been kept for backward compatibility and use of onAfterRenderObservable is recommended.
  24426. */
  24427. set onAfterRender(callback: (faceIndex: number) => void);
  24428. /**
  24429. * An event triggered after the texture clear
  24430. */
  24431. onClearObservable: Observable<Engine>;
  24432. private _onClearObserver;
  24433. /**
  24434. * Set a clear callback in the texture.
  24435. * This has been kept for backward compatibility and use of onClearObservable is recommended.
  24436. */
  24437. set onClear(callback: (Engine: Engine) => void);
  24438. /**
  24439. * An event triggered when the texture is resized.
  24440. */
  24441. onResizeObservable: Observable<RenderTargetTexture>;
  24442. /**
  24443. * Define the clear color of the Render Target if it should be different from the scene.
  24444. */
  24445. clearColor: Color4;
  24446. protected _size: number | {
  24447. width: number;
  24448. height: number;
  24449. layers?: number;
  24450. };
  24451. protected _initialSizeParameter: number | {
  24452. width: number;
  24453. height: number;
  24454. } | {
  24455. ratio: number;
  24456. };
  24457. protected _sizeRatio: Nullable<number>;
  24458. /** @hidden */
  24459. _generateMipMaps: boolean;
  24460. protected _renderingManager: RenderingManager;
  24461. /** @hidden */
  24462. _waitingRenderList?: string[];
  24463. protected _doNotChangeAspectRatio: boolean;
  24464. protected _currentRefreshId: number;
  24465. protected _refreshRate: number;
  24466. protected _textureMatrix: Matrix;
  24467. protected _samples: number;
  24468. protected _renderTargetOptions: RenderTargetCreationOptions;
  24469. /**
  24470. * Gets render target creation options that were used.
  24471. */
  24472. get renderTargetOptions(): RenderTargetCreationOptions;
  24473. protected _onRatioRescale(): void;
  24474. /**
  24475. * Gets or sets the center of the bounding box associated with the texture (when in cube mode)
  24476. * It must define where the camera used to render the texture is set
  24477. */
  24478. boundingBoxPosition: Vector3;
  24479. private _boundingBoxSize;
  24480. /**
  24481. * Gets or sets the size of the bounding box associated with the texture (when in cube mode)
  24482. * When defined, the cubemap will switch to local mode
  24483. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  24484. * @example https://www.babylonjs-playground.com/#RNASML
  24485. */
  24486. set boundingBoxSize(value: Vector3);
  24487. get boundingBoxSize(): Vector3;
  24488. /**
  24489. * In case the RTT has been created with a depth texture, get the associated
  24490. * depth texture.
  24491. * Otherwise, return null.
  24492. */
  24493. get depthStencilTexture(): Nullable<InternalTexture>;
  24494. /**
  24495. * Instantiate a render target texture. This is mainly used to render of screen the scene to for instance apply post processse
  24496. * or used a shadow, depth texture...
  24497. * @param name The friendly name of the texture
  24498. * @param size The size of the RTT (number if square, or {width: number, height:number} or {ratio:} to define a ratio from the main scene)
  24499. * @param scene The scene the RTT belongs to. The latest created scene will be used if not precised.
  24500. * @param generateMipMaps True if mip maps need to be generated after render.
  24501. * @param doNotChangeAspectRatio True to not change the aspect ratio of the scene in the RTT
  24502. * @param type The type of the buffer in the RTT (int, half float, float...)
  24503. * @param isCube True if a cube texture needs to be created
  24504. * @param samplingMode The sampling mode to be usedwith the render target (Linear, Nearest...)
  24505. * @param generateDepthBuffer True to generate a depth buffer
  24506. * @param generateStencilBuffer True to generate a stencil buffer
  24507. * @param isMulti True if multiple textures need to be created (Draw Buffers)
  24508. * @param format The internal format of the buffer in the RTT (RED, RG, RGB, RGBA, ALPHA...)
  24509. * @param delayAllocation if the texture allocation should be delayed (default: false)
  24510. */
  24511. constructor(name: string, size: number | {
  24512. width: number;
  24513. height: number;
  24514. layers?: number;
  24515. } | {
  24516. ratio: number;
  24517. }, scene: Nullable<Scene>, generateMipMaps?: boolean, doNotChangeAspectRatio?: boolean, type?: number, isCube?: boolean, samplingMode?: number, generateDepthBuffer?: boolean, generateStencilBuffer?: boolean, isMulti?: boolean, format?: number, delayAllocation?: boolean);
  24518. /**
  24519. * Creates a depth stencil texture.
  24520. * This is only available in WebGL 2 or with the depth texture extension available.
  24521. * @param comparisonFunction Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode
  24522. * @param bilinearFiltering Specifies whether or not bilinear filtering is enable on the texture
  24523. * @param generateStencil Specifies whether or not a stencil should be allocated in the texture
  24524. */
  24525. createDepthStencilTexture(comparisonFunction?: number, bilinearFiltering?: boolean, generateStencil?: boolean): void;
  24526. private _processSizeParameter;
  24527. /**
  24528. * Define the number of samples to use in case of MSAA.
  24529. * It defaults to one meaning no MSAA has been enabled.
  24530. */
  24531. get samples(): number;
  24532. set samples(value: number);
  24533. /**
  24534. * Resets the refresh counter of the texture and start bak from scratch.
  24535. * Could be useful to regenerate the texture if it is setup to render only once.
  24536. */
  24537. resetRefreshCounter(): void;
  24538. /**
  24539. * Define the refresh rate of the texture or the rendering frequency.
  24540. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  24541. */
  24542. get refreshRate(): number;
  24543. set refreshRate(value: number);
  24544. /**
  24545. * Adds a post process to the render target rendering passes.
  24546. * @param postProcess define the post process to add
  24547. */
  24548. addPostProcess(postProcess: PostProcess): void;
  24549. /**
  24550. * Clear all the post processes attached to the render target
  24551. * @param dispose define if the cleared post processesshould also be disposed (false by default)
  24552. */
  24553. clearPostProcesses(dispose?: boolean): void;
  24554. /**
  24555. * Remove one of the post process from the list of attached post processes to the texture
  24556. * @param postProcess define the post process to remove from the list
  24557. */
  24558. removePostProcess(postProcess: PostProcess): void;
  24559. /** @hidden */
  24560. _shouldRender(): boolean;
  24561. /**
  24562. * Gets the actual render size of the texture.
  24563. * @returns the width of the render size
  24564. */
  24565. getRenderSize(): number;
  24566. /**
  24567. * Gets the actual render width of the texture.
  24568. * @returns the width of the render size
  24569. */
  24570. getRenderWidth(): number;
  24571. /**
  24572. * Gets the actual render height of the texture.
  24573. * @returns the height of the render size
  24574. */
  24575. getRenderHeight(): number;
  24576. /**
  24577. * Gets the actual number of layers of the texture.
  24578. * @returns the number of layers
  24579. */
  24580. getRenderLayers(): number;
  24581. /**
  24582. * Get if the texture can be rescaled or not.
  24583. */
  24584. get canRescale(): boolean;
  24585. /**
  24586. * Resize the texture using a ratio.
  24587. * @param ratio the ratio to apply to the texture size in order to compute the new target size
  24588. */
  24589. scale(ratio: number): void;
  24590. /**
  24591. * Get the texture reflection matrix used to rotate/transform the reflection.
  24592. * @returns the reflection matrix
  24593. */
  24594. getReflectionTextureMatrix(): Matrix;
  24595. /**
  24596. * Resize the texture to a new desired size.
  24597. * Be carrefull as it will recreate all the data in the new texture.
  24598. * @param size Define the new size. It can be:
  24599. * - a number for squared texture,
  24600. * - an object containing { width: number, height: number }
  24601. * - or an object containing a ratio { ratio: number }
  24602. */
  24603. resize(size: number | {
  24604. width: number;
  24605. height: number;
  24606. } | {
  24607. ratio: number;
  24608. }): void;
  24609. private _defaultRenderListPrepared;
  24610. /**
  24611. * Renders all the objects from the render list into the texture.
  24612. * @param useCameraPostProcess Define if camera post processes should be used during the rendering
  24613. * @param dumpForDebug Define if the rendering result should be dumped (copied) for debugging purpose
  24614. */
  24615. render(useCameraPostProcess?: boolean, dumpForDebug?: boolean): void;
  24616. private _bestReflectionRenderTargetDimension;
  24617. private _prepareRenderingManager;
  24618. /**
  24619. * @hidden
  24620. * @param faceIndex face index to bind to if this is a cubetexture
  24621. * @param layer defines the index of the texture to bind in the array
  24622. */
  24623. _bindFrameBuffer(faceIndex?: number, layer?: number): void;
  24624. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  24625. private renderToTarget;
  24626. /**
  24627. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  24628. * This allowed control for front to back rendering or reversly depending of the special needs.
  24629. *
  24630. * @param renderingGroupId The rendering group id corresponding to its index
  24631. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  24632. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  24633. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  24634. */
  24635. setRenderingOrder(renderingGroupId: number, opaqueSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>, alphaTestSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>, transparentSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>): void;
  24636. /**
  24637. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  24638. *
  24639. * @param renderingGroupId The rendering group id corresponding to its index
  24640. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  24641. */
  24642. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  24643. /**
  24644. * Clones the texture.
  24645. * @returns the cloned texture
  24646. */
  24647. clone(): RenderTargetTexture;
  24648. /**
  24649. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  24650. * @returns The JSON representation of the texture
  24651. */
  24652. serialize(): any;
  24653. /**
  24654. * This will remove the attached framebuffer objects. The texture will not be able to be used as render target anymore
  24655. */
  24656. disposeFramebufferObjects(): void;
  24657. /**
  24658. * Dispose the texture and release its associated resources.
  24659. */
  24660. dispose(): void;
  24661. /** @hidden */
  24662. _rebuild(): void;
  24663. /**
  24664. * Clear the info related to rendering groups preventing retention point in material dispose.
  24665. */
  24666. freeRenderingGroups(): void;
  24667. /**
  24668. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  24669. * @returns the view count
  24670. */
  24671. getViewCount(): number;
  24672. }
  24673. }
  24674. declare module "babylonjs/Misc/guid" {
  24675. /**
  24676. * Class used to manipulate GUIDs
  24677. */
  24678. export class GUID {
  24679. /**
  24680. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  24681. * Be aware Math.random() could cause collisions, but:
  24682. * "All but 6 of the 128 bits of the ID are randomly generated, which means that for any two ids, there's a 1 in 2^^122 (or 5.3x10^^36) chance they'll collide"
  24683. * @returns a pseudo random id
  24684. */
  24685. static RandomId(): string;
  24686. }
  24687. }
  24688. declare module "babylonjs/Materials/shadowDepthWrapper" {
  24689. import { Nullable } from "babylonjs/types";
  24690. import { Scene } from "babylonjs/scene";
  24691. import { SubMesh } from "babylonjs/Meshes/subMesh";
  24692. import { Material } from "babylonjs/Materials/material";
  24693. import { Effect } from "babylonjs/Materials/effect";
  24694. import { ShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  24695. /**
  24696. * Options to be used when creating a shadow depth material
  24697. */
  24698. export interface IIOptionShadowDepthMaterial {
  24699. /** Variables in the vertex shader code that need to have their names remapped.
  24700. * The format is: ["var_name", "var_remapped_name", "var_name", "var_remapped_name", ...]
  24701. * "var_name" should be either: worldPos or vNormalW
  24702. * So, if the variable holding the world position in your vertex shader is not named worldPos, you must tell the system
  24703. * the name to use instead by using: ["worldPos", "myWorldPosVar"] assuming the variable is named myWorldPosVar in your code.
  24704. * If the normal must also be remapped: ["worldPos", "myWorldPosVar", "vNormalW", "myWorldNormal"]
  24705. */
  24706. remappedVariables?: string[];
  24707. /** Set standalone to true if the base material wrapped by ShadowDepthMaterial is not used for a regular object but for depth shadow generation only */
  24708. standalone?: boolean;
  24709. }
  24710. /**
  24711. * Class that can be used to wrap a base material to generate accurate shadows when using custom vertex/fragment code in the base material
  24712. */
  24713. export class ShadowDepthWrapper {
  24714. private _scene;
  24715. private _options?;
  24716. private _baseMaterial;
  24717. private _onEffectCreatedObserver;
  24718. private _subMeshToEffect;
  24719. private _subMeshToDepthEffect;
  24720. private _meshes;
  24721. /** @hidden */
  24722. _matriceNames: any;
  24723. /** Gets the standalone status of the wrapper */
  24724. get standalone(): boolean;
  24725. /** Gets the base material the wrapper is built upon */
  24726. get baseMaterial(): Material;
  24727. /**
  24728. * Instantiate a new shadow depth wrapper.
  24729. * It works by injecting some specific code in the vertex/fragment shaders of the base material and is used by a shadow generator to
  24730. * generate the shadow depth map. For more information, please refer to the documentation:
  24731. * https://doc.babylonjs.com/babylon101/shadows
  24732. * @param baseMaterial Material to wrap
  24733. * @param scene Define the scene the material belongs to
  24734. * @param options Options used to create the wrapper
  24735. */
  24736. constructor(baseMaterial: Material, scene: Scene, options?: IIOptionShadowDepthMaterial);
  24737. /**
  24738. * Gets the effect to use to generate the depth map
  24739. * @param subMesh subMesh to get the effect for
  24740. * @param shadowGenerator shadow generator to get the effect for
  24741. * @returns the effect to use to generate the depth map for the subMesh + shadow generator specified
  24742. */
  24743. getEffect(subMesh: Nullable<SubMesh>, shadowGenerator: ShadowGenerator): Nullable<Effect>;
  24744. /**
  24745. * Specifies that the submesh is ready to be used for depth rendering
  24746. * @param subMesh submesh to check
  24747. * @param defines the list of defines to take into account when checking the effect
  24748. * @param shadowGenerator combined with subMesh, it defines the effect to check
  24749. * @param useInstances specifies that instances should be used
  24750. * @returns a boolean indicating that the submesh is ready or not
  24751. */
  24752. isReadyForSubMesh(subMesh: SubMesh, defines: string[], shadowGenerator: ShadowGenerator, useInstances: boolean): boolean;
  24753. /**
  24754. * Disposes the resources
  24755. */
  24756. dispose(): void;
  24757. private _makeEffect;
  24758. }
  24759. }
  24760. declare module "babylonjs/Engines/Extensions/engine.multiRender" {
  24761. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  24762. import { IMultiRenderTargetOptions } from "babylonjs/Materials/Textures/multiRenderTarget";
  24763. import { Nullable } from "babylonjs/types";
  24764. module "babylonjs/Engines/thinEngine" {
  24765. interface ThinEngine {
  24766. /**
  24767. * Unbind a list of render target textures from the webGL context
  24768. * This is used only when drawBuffer extension or webGL2 are active
  24769. * @param textures defines the render target textures to unbind
  24770. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  24771. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  24772. */
  24773. unBindMultiColorAttachmentFramebuffer(textures: InternalTexture[], disableGenerateMipMaps: boolean, onBeforeUnbind?: () => void): void;
  24774. /**
  24775. * Create a multi render target texture
  24776. * @see https://doc.babylonjs.com/features/webgl2#multiple-render-target
  24777. * @param size defines the size of the texture
  24778. * @param options defines the creation options
  24779. * @returns the cube texture as an InternalTexture
  24780. */
  24781. createMultipleRenderTarget(size: any, options: IMultiRenderTargetOptions): InternalTexture[];
  24782. /**
  24783. * Update the sample count for a given multiple render target texture
  24784. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  24785. * @param textures defines the textures to update
  24786. * @param samples defines the sample count to set
  24787. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  24788. */
  24789. updateMultipleRenderTargetTextureSampleCount(textures: Nullable<InternalTexture[]>, samples: number): number;
  24790. /**
  24791. * Select a subsets of attachments to draw to.
  24792. * @param attachments gl attachments
  24793. */
  24794. bindAttachments(attachments: number[]): void;
  24795. }
  24796. }
  24797. }
  24798. declare module "babylonjs/Materials/Textures/multiRenderTarget" {
  24799. import { Scene } from "babylonjs/scene";
  24800. import { Engine } from "babylonjs/Engines/engine";
  24801. import { Texture } from "babylonjs/Materials/Textures/texture";
  24802. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  24803. import "babylonjs/Engines/Extensions/engine.multiRender";
  24804. /**
  24805. * Creation options of the multi render target texture.
  24806. */
  24807. export interface IMultiRenderTargetOptions {
  24808. /**
  24809. * Define if the texture needs to create mip maps after render.
  24810. */
  24811. generateMipMaps?: boolean;
  24812. /**
  24813. * Define the types of all the draw buffers we want to create
  24814. */
  24815. types?: number[];
  24816. /**
  24817. * Define the sampling modes of all the draw buffers we want to create
  24818. */
  24819. samplingModes?: number[];
  24820. /**
  24821. * Define if a depth buffer is required
  24822. */
  24823. generateDepthBuffer?: boolean;
  24824. /**
  24825. * Define if a stencil buffer is required
  24826. */
  24827. generateStencilBuffer?: boolean;
  24828. /**
  24829. * Define if a depth texture is required instead of a depth buffer
  24830. */
  24831. generateDepthTexture?: boolean;
  24832. /**
  24833. * Define the number of desired draw buffers
  24834. */
  24835. textureCount?: number;
  24836. /**
  24837. * Define if aspect ratio should be adapted to the texture or stay the scene one
  24838. */
  24839. doNotChangeAspectRatio?: boolean;
  24840. /**
  24841. * Define the default type of the buffers we are creating
  24842. */
  24843. defaultType?: number;
  24844. }
  24845. /**
  24846. * A multi render target, like a render target provides the ability to render to a texture.
  24847. * Unlike the render target, it can render to several draw buffers in one draw.
  24848. * This is specially interesting in deferred rendering or for any effects requiring more than
  24849. * just one color from a single pass.
  24850. */
  24851. export class MultiRenderTarget extends RenderTargetTexture {
  24852. private _internalTextures;
  24853. private _textures;
  24854. private _multiRenderTargetOptions;
  24855. private _count;
  24856. /**
  24857. * Get if draw buffers are currently supported by the used hardware and browser.
  24858. */
  24859. get isSupported(): boolean;
  24860. /**
  24861. * Get the list of textures generated by the multi render target.
  24862. */
  24863. get textures(): Texture[];
  24864. /**
  24865. * Gets the number of textures in this MRT. This number can be different from `_textures.length` in case a depth texture is generated.
  24866. */
  24867. get count(): number;
  24868. /**
  24869. * Get the depth texture generated by the multi render target if options.generateDepthTexture has been set
  24870. */
  24871. get depthTexture(): Texture;
  24872. /**
  24873. * Set the wrapping mode on U of all the textures we are rendering to.
  24874. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  24875. */
  24876. set wrapU(wrap: number);
  24877. /**
  24878. * Set the wrapping mode on V of all the textures we are rendering to.
  24879. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  24880. */
  24881. set wrapV(wrap: number);
  24882. /**
  24883. * Instantiate a new multi render target texture.
  24884. * A multi render target, like a render target provides the ability to render to a texture.
  24885. * Unlike the render target, it can render to several draw buffers in one draw.
  24886. * This is specially interesting in deferred rendering or for any effects requiring more than
  24887. * just one color from a single pass.
  24888. * @param name Define the name of the texture
  24889. * @param size Define the size of the buffers to render to
  24890. * @param count Define the number of target we are rendering into
  24891. * @param scene Define the scene the texture belongs to
  24892. * @param options Define the options used to create the multi render target
  24893. */
  24894. constructor(name: string, size: any, count: number, scene: Scene, options?: IMultiRenderTargetOptions);
  24895. /** @hidden */
  24896. _rebuild(): void;
  24897. private _createInternalTextures;
  24898. private _createTextures;
  24899. /**
  24900. * Define the number of samples used if MSAA is enabled.
  24901. */
  24902. get samples(): number;
  24903. set samples(value: number);
  24904. /**
  24905. * Resize all the textures in the multi render target.
  24906. * Be carrefull as it will recreate all the data in the new texture.
  24907. * @param size Define the new size
  24908. */
  24909. resize(size: any): void;
  24910. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  24911. /**
  24912. * Dispose the render targets and their associated resources
  24913. */
  24914. dispose(): void;
  24915. /**
  24916. * Release all the underlying texture used as draw buffers.
  24917. */
  24918. releaseInternalTextures(): void;
  24919. }
  24920. }
  24921. declare module "babylonjs/Shaders/imageProcessing.fragment" {
  24922. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  24923. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  24924. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  24925. /** @hidden */
  24926. export var imageProcessingPixelShader: {
  24927. name: string;
  24928. shader: string;
  24929. };
  24930. }
  24931. declare module "babylonjs/PostProcesses/imageProcessingPostProcess" {
  24932. import { Nullable } from "babylonjs/types";
  24933. import { Color4 } from "babylonjs/Maths/math.color";
  24934. import { Camera } from "babylonjs/Cameras/camera";
  24935. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  24936. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  24937. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  24938. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  24939. import { Engine } from "babylonjs/Engines/engine";
  24940. import "babylonjs/Shaders/imageProcessing.fragment";
  24941. import "babylonjs/Shaders/postprocess.vertex";
  24942. /**
  24943. * ImageProcessingPostProcess
  24944. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#imageprocessing
  24945. */
  24946. export class ImageProcessingPostProcess extends PostProcess {
  24947. /**
  24948. * Default configuration related to image processing available in the PBR Material.
  24949. */
  24950. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  24951. /**
  24952. * Gets the image processing configuration used either in this material.
  24953. */
  24954. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  24955. /**
  24956. * Sets the Default image processing configuration used either in the this material.
  24957. *
  24958. * If sets to null, the scene one is in use.
  24959. */
  24960. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  24961. /**
  24962. * Keep track of the image processing observer to allow dispose and replace.
  24963. */
  24964. private _imageProcessingObserver;
  24965. /**
  24966. * Attaches a new image processing configuration to the PBR Material.
  24967. * @param configuration
  24968. */
  24969. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>, doNotBuild?: boolean): void;
  24970. /**
  24971. * If the post process is supported.
  24972. */
  24973. get isSupported(): boolean;
  24974. /**
  24975. * Gets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  24976. */
  24977. get colorCurves(): Nullable<ColorCurves>;
  24978. /**
  24979. * Sets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  24980. */
  24981. set colorCurves(value: Nullable<ColorCurves>);
  24982. /**
  24983. * Gets wether the color curves effect is enabled.
  24984. */
  24985. get colorCurvesEnabled(): boolean;
  24986. /**
  24987. * Sets wether the color curves effect is enabled.
  24988. */
  24989. set colorCurvesEnabled(value: boolean);
  24990. /**
  24991. * Gets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  24992. */
  24993. get colorGradingTexture(): Nullable<BaseTexture>;
  24994. /**
  24995. * Sets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  24996. */
  24997. set colorGradingTexture(value: Nullable<BaseTexture>);
  24998. /**
  24999. * Gets wether the color grading effect is enabled.
  25000. */
  25001. get colorGradingEnabled(): boolean;
  25002. /**
  25003. * Gets wether the color grading effect is enabled.
  25004. */
  25005. set colorGradingEnabled(value: boolean);
  25006. /**
  25007. * Gets exposure used in the effect.
  25008. */
  25009. get exposure(): number;
  25010. /**
  25011. * Sets exposure used in the effect.
  25012. */
  25013. set exposure(value: number);
  25014. /**
  25015. * Gets wether tonemapping is enabled or not.
  25016. */
  25017. get toneMappingEnabled(): boolean;
  25018. /**
  25019. * Sets wether tonemapping is enabled or not
  25020. */
  25021. set toneMappingEnabled(value: boolean);
  25022. /**
  25023. * Gets the type of tone mapping effect.
  25024. */
  25025. get toneMappingType(): number;
  25026. /**
  25027. * Sets the type of tone mapping effect.
  25028. */
  25029. set toneMappingType(value: number);
  25030. /**
  25031. * Gets contrast used in the effect.
  25032. */
  25033. get contrast(): number;
  25034. /**
  25035. * Sets contrast used in the effect.
  25036. */
  25037. set contrast(value: number);
  25038. /**
  25039. * Gets Vignette stretch size.
  25040. */
  25041. get vignetteStretch(): number;
  25042. /**
  25043. * Sets Vignette stretch size.
  25044. */
  25045. set vignetteStretch(value: number);
  25046. /**
  25047. * Gets Vignette centre X Offset.
  25048. */
  25049. get vignetteCentreX(): number;
  25050. /**
  25051. * Sets Vignette centre X Offset.
  25052. */
  25053. set vignetteCentreX(value: number);
  25054. /**
  25055. * Gets Vignette centre Y Offset.
  25056. */
  25057. get vignetteCentreY(): number;
  25058. /**
  25059. * Sets Vignette centre Y Offset.
  25060. */
  25061. set vignetteCentreY(value: number);
  25062. /**
  25063. * Gets Vignette weight or intensity of the vignette effect.
  25064. */
  25065. get vignetteWeight(): number;
  25066. /**
  25067. * Sets Vignette weight or intensity of the vignette effect.
  25068. */
  25069. set vignetteWeight(value: number);
  25070. /**
  25071. * Gets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  25072. * if vignetteEnabled is set to true.
  25073. */
  25074. get vignetteColor(): Color4;
  25075. /**
  25076. * Sets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  25077. * if vignetteEnabled is set to true.
  25078. */
  25079. set vignetteColor(value: Color4);
  25080. /**
  25081. * Gets Camera field of view used by the Vignette effect.
  25082. */
  25083. get vignetteCameraFov(): number;
  25084. /**
  25085. * Sets Camera field of view used by the Vignette effect.
  25086. */
  25087. set vignetteCameraFov(value: number);
  25088. /**
  25089. * Gets the vignette blend mode allowing different kind of effect.
  25090. */
  25091. get vignetteBlendMode(): number;
  25092. /**
  25093. * Sets the vignette blend mode allowing different kind of effect.
  25094. */
  25095. set vignetteBlendMode(value: number);
  25096. /**
  25097. * Gets wether the vignette effect is enabled.
  25098. */
  25099. get vignetteEnabled(): boolean;
  25100. /**
  25101. * Sets wether the vignette effect is enabled.
  25102. */
  25103. set vignetteEnabled(value: boolean);
  25104. private _fromLinearSpace;
  25105. /**
  25106. * Gets wether the input of the processing is in Gamma or Linear Space.
  25107. */
  25108. get fromLinearSpace(): boolean;
  25109. /**
  25110. * Sets wether the input of the processing is in Gamma or Linear Space.
  25111. */
  25112. set fromLinearSpace(value: boolean);
  25113. /**
  25114. * Defines cache preventing GC.
  25115. */
  25116. private _defines;
  25117. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, imageProcessingConfiguration?: ImageProcessingConfiguration);
  25118. /**
  25119. * "ImageProcessingPostProcess"
  25120. * @returns "ImageProcessingPostProcess"
  25121. */
  25122. getClassName(): string;
  25123. /**
  25124. * @hidden
  25125. */
  25126. _updateParameters(): void;
  25127. dispose(camera?: Camera): void;
  25128. }
  25129. }
  25130. declare module "babylonjs/Shaders/ShadersInclude/fibonacci" {
  25131. /** @hidden */
  25132. export var fibonacci: {
  25133. name: string;
  25134. shader: string;
  25135. };
  25136. }
  25137. declare module "babylonjs/Shaders/ShadersInclude/subSurfaceScatteringFunctions" {
  25138. /** @hidden */
  25139. export var subSurfaceScatteringFunctions: {
  25140. name: string;
  25141. shader: string;
  25142. };
  25143. }
  25144. declare module "babylonjs/Shaders/ShadersInclude/diffusionProfile" {
  25145. /** @hidden */
  25146. export var diffusionProfile: {
  25147. name: string;
  25148. shader: string;
  25149. };
  25150. }
  25151. declare module "babylonjs/Shaders/subSurfaceScattering.fragment" {
  25152. import "babylonjs/Shaders/ShadersInclude/fibonacci";
  25153. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  25154. import "babylonjs/Shaders/ShadersInclude/subSurfaceScatteringFunctions";
  25155. import "babylonjs/Shaders/ShadersInclude/diffusionProfile";
  25156. /** @hidden */
  25157. export var subSurfaceScatteringPixelShader: {
  25158. name: string;
  25159. shader: string;
  25160. };
  25161. }
  25162. declare module "babylonjs/PostProcesses/subSurfaceScatteringPostProcess" {
  25163. import { Nullable } from "babylonjs/types";
  25164. import { Camera } from "babylonjs/Cameras/camera";
  25165. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  25166. import { Engine } from "babylonjs/Engines/engine";
  25167. import { Scene } from "babylonjs/scene";
  25168. import "babylonjs/Shaders/imageProcessing.fragment";
  25169. import "babylonjs/Shaders/subSurfaceScattering.fragment";
  25170. import "babylonjs/Shaders/postprocess.vertex";
  25171. /**
  25172. * Sub surface scattering post process
  25173. */
  25174. export class SubSurfaceScatteringPostProcess extends PostProcess {
  25175. /**
  25176. * Gets a string identifying the name of the class
  25177. * @returns "SubSurfaceScatteringPostProcess" string
  25178. */
  25179. getClassName(): string;
  25180. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  25181. }
  25182. }
  25183. declare module "babylonjs/Rendering/prePassEffectConfiguration" {
  25184. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  25185. /**
  25186. * Interface for defining prepass effects in the prepass post-process pipeline
  25187. */
  25188. export interface PrePassEffectConfiguration {
  25189. /**
  25190. * Post process to attach for this effect
  25191. */
  25192. postProcess: PostProcess;
  25193. /**
  25194. * Is the effect enabled
  25195. */
  25196. enabled: boolean;
  25197. /**
  25198. * Disposes the effect configuration
  25199. */
  25200. dispose(): void;
  25201. /**
  25202. * Disposes the effect configuration
  25203. */
  25204. createPostProcess: () => PostProcess;
  25205. }
  25206. }
  25207. declare module "babylonjs/Rendering/subSurfaceConfiguration" {
  25208. import { Scene } from "babylonjs/scene";
  25209. import { Color3 } from "babylonjs/Maths/math.color";
  25210. import { SubSurfaceScatteringPostProcess } from "babylonjs/PostProcesses/subSurfaceScatteringPostProcess";
  25211. import { PrePassEffectConfiguration } from "babylonjs/Rendering/prePassEffectConfiguration";
  25212. /**
  25213. * Contains all parameters needed for the prepass to perform
  25214. * screen space subsurface scattering
  25215. */
  25216. export class SubSurfaceConfiguration implements PrePassEffectConfiguration {
  25217. private _ssDiffusionS;
  25218. private _ssFilterRadii;
  25219. private _ssDiffusionD;
  25220. /**
  25221. * Post process to attach for screen space subsurface scattering
  25222. */
  25223. postProcess: SubSurfaceScatteringPostProcess;
  25224. /**
  25225. * Diffusion profile color for subsurface scattering
  25226. */
  25227. get ssDiffusionS(): number[];
  25228. /**
  25229. * Diffusion profile max color channel value for subsurface scattering
  25230. */
  25231. get ssDiffusionD(): number[];
  25232. /**
  25233. * Diffusion profile filter radius for subsurface scattering
  25234. */
  25235. get ssFilterRadii(): number[];
  25236. /**
  25237. * Is subsurface enabled
  25238. */
  25239. enabled: boolean;
  25240. /**
  25241. * Diffusion profile colors for subsurface scattering
  25242. * You can add one diffusion color using `addDiffusionProfile` on `scene.prePassRenderer`
  25243. * See ...
  25244. * Note that you can only store up to 5 of them
  25245. */
  25246. ssDiffusionProfileColors: Color3[];
  25247. /**
  25248. * Defines the ratio real world => scene units.
  25249. * Used for subsurface scattering
  25250. */
  25251. metersPerUnit: number;
  25252. private _scene;
  25253. /**
  25254. * Builds a subsurface configuration object
  25255. * @param scene The scene
  25256. */
  25257. constructor(scene: Scene);
  25258. /**
  25259. * Adds a new diffusion profile.
  25260. * Useful for more realistic subsurface scattering on diverse materials.
  25261. * @param color The color of the diffusion profile. Should be the average color of the material.
  25262. * @return The index of the diffusion profile for the material subsurface configuration
  25263. */
  25264. addDiffusionProfile(color: Color3): number;
  25265. /**
  25266. * Creates the sss post process
  25267. * @return The created post process
  25268. */
  25269. createPostProcess(): SubSurfaceScatteringPostProcess;
  25270. /**
  25271. * Deletes all diffusion profiles.
  25272. * Note that in order to render subsurface scattering, you should have at least 1 diffusion profile.
  25273. */
  25274. clearAllDiffusionProfiles(): void;
  25275. /**
  25276. * Disposes this object
  25277. */
  25278. dispose(): void;
  25279. /**
  25280. * @hidden
  25281. * https://zero-radiance.github.io/post/sampling-diffusion/
  25282. *
  25283. * Importance sample the normalized diffuse reflectance profile for the computed value of 's'.
  25284. * ------------------------------------------------------------------------------------
  25285. * R[r, phi, s] = s * (Exp[-r * s] + Exp[-r * s / 3]) / (8 * Pi * r)
  25286. * PDF[r, phi, s] = r * R[r, phi, s]
  25287. * CDF[r, s] = 1 - 1/4 * Exp[-r * s] - 3/4 * Exp[-r * s / 3]
  25288. * ------------------------------------------------------------------------------------
  25289. * We importance sample the color channel with the widest scattering distance.
  25290. */
  25291. getDiffusionProfileParameters(color: Color3): number;
  25292. /**
  25293. * Performs sampling of a Normalized Burley diffusion profile in polar coordinates.
  25294. * 'u' is the random number (the value of the CDF): [0, 1).
  25295. * rcp(s) = 1 / ShapeParam = ScatteringDistance.
  25296. * Returns the sampled radial distance, s.t. (u = 0 -> r = 0) and (u = 1 -> r = Inf).
  25297. */
  25298. private _sampleBurleyDiffusionProfile;
  25299. }
  25300. }
  25301. declare module "babylonjs/Rendering/prePassRenderer" {
  25302. import { MultiRenderTarget } from "babylonjs/Materials/Textures/multiRenderTarget";
  25303. import { Scene } from "babylonjs/scene";
  25304. import { ImageProcessingPostProcess } from "babylonjs/PostProcesses/imageProcessingPostProcess";
  25305. import { Effect } from "babylonjs/Materials/effect";
  25306. import { SubSurfaceConfiguration } from "babylonjs/Rendering/subSurfaceConfiguration";
  25307. /**
  25308. * Renders a pre pass of the scene
  25309. * This means every mesh in the scene will be rendered to a render target texture
  25310. * And then this texture will be composited to the rendering canvas with post processes
  25311. * It is necessary for effects like subsurface scattering or deferred shading
  25312. */
  25313. export class PrePassRenderer {
  25314. /** @hidden */
  25315. static _SceneComponentInitialization: (scene: Scene) => void;
  25316. private _scene;
  25317. private _engine;
  25318. private _isDirty;
  25319. /**
  25320. * Number of textures in the multi render target texture where the scene is directly rendered
  25321. */
  25322. readonly mrtCount: number;
  25323. /**
  25324. * The render target where the scene is directly rendered
  25325. */
  25326. prePassRT: MultiRenderTarget;
  25327. private _mrtTypes;
  25328. private _multiRenderAttachments;
  25329. private _defaultAttachments;
  25330. private _clearAttachments;
  25331. private _postProcesses;
  25332. private readonly _clearColor;
  25333. /**
  25334. * Image processing post process for composition
  25335. */
  25336. imageProcessingPostProcess: ImageProcessingPostProcess;
  25337. /**
  25338. * Configuration for sub surface scattering post process
  25339. */
  25340. subSurfaceConfiguration: SubSurfaceConfiguration;
  25341. /**
  25342. * Should materials render their geometry on the MRT
  25343. */
  25344. materialsShouldRenderGeometry: boolean;
  25345. /**
  25346. * Should materials render the irradiance information on the MRT
  25347. */
  25348. materialsShouldRenderIrradiance: boolean;
  25349. private _enabled;
  25350. /**
  25351. * Indicates if the prepass is enabled
  25352. */
  25353. get enabled(): boolean;
  25354. /**
  25355. * How many samples are used for MSAA of the scene render target
  25356. */
  25357. get samples(): number;
  25358. set samples(n: number);
  25359. /**
  25360. * Instanciates a prepass renderer
  25361. * @param scene The scene
  25362. */
  25363. constructor(scene: Scene);
  25364. private _initializeAttachments;
  25365. private _createCompositionEffect;
  25366. /**
  25367. * Indicates if rendering a prepass is supported
  25368. */
  25369. get isSupported(): boolean;
  25370. /**
  25371. * Sets the proper output textures to draw in the engine.
  25372. * @param effect The effect that is drawn. It can be or not be compatible with drawing to several output textures.
  25373. */
  25374. bindAttachmentsForEffect(effect: Effect): void;
  25375. /**
  25376. * @hidden
  25377. */
  25378. _beforeCameraDraw(): void;
  25379. /**
  25380. * @hidden
  25381. */
  25382. _afterCameraDraw(): void;
  25383. private _checkRTSize;
  25384. private _bindFrameBuffer;
  25385. /**
  25386. * Clears the scene render target (in the sense of settings pixels to the scene clear color value)
  25387. */
  25388. clear(): void;
  25389. private _setState;
  25390. private _enable;
  25391. private _disable;
  25392. private _resetPostProcessChain;
  25393. private _bindPostProcessChain;
  25394. /**
  25395. * Marks the prepass renderer as dirty, triggering a check if the prepass is necessary for the next rendering.
  25396. */
  25397. markAsDirty(): void;
  25398. private _update;
  25399. /**
  25400. * Disposes the prepass renderer.
  25401. */
  25402. dispose(): void;
  25403. }
  25404. }
  25405. declare module "babylonjs/Materials/material" {
  25406. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  25407. import { SmartArray } from "babylonjs/Misc/smartArray";
  25408. import { Observable } from "babylonjs/Misc/observable";
  25409. import { Nullable } from "babylonjs/types";
  25410. import { Scene } from "babylonjs/scene";
  25411. import { Matrix } from "babylonjs/Maths/math.vector";
  25412. import { SubMesh } from "babylonjs/Meshes/subMesh";
  25413. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  25414. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  25415. import { Effect } from "babylonjs/Materials/effect";
  25416. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  25417. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  25418. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  25419. import { IInspectable } from "babylonjs/Misc/iInspectable";
  25420. import { ShadowDepthWrapper } from "babylonjs/Materials/shadowDepthWrapper";
  25421. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  25422. import { Mesh } from "babylonjs/Meshes/mesh";
  25423. import { Animation } from "babylonjs/Animations/animation";
  25424. /**
  25425. * Options for compiling materials.
  25426. */
  25427. export interface IMaterialCompilationOptions {
  25428. /**
  25429. * Defines whether clip planes are enabled.
  25430. */
  25431. clipPlane: boolean;
  25432. /**
  25433. * Defines whether instances are enabled.
  25434. */
  25435. useInstances: boolean;
  25436. }
  25437. /**
  25438. * Options passed when calling customShaderNameResolve
  25439. */
  25440. export interface ICustomShaderNameResolveOptions {
  25441. /**
  25442. * If provided, will be called two times with the vertex and fragment code so that this code can be updated before it is compiled by the GPU
  25443. */
  25444. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  25445. }
  25446. /**
  25447. * Base class for the main features of a material in Babylon.js
  25448. */
  25449. export class Material implements IAnimatable {
  25450. /**
  25451. * Returns the triangle fill mode
  25452. */
  25453. static readonly TriangleFillMode: number;
  25454. /**
  25455. * Returns the wireframe mode
  25456. */
  25457. static readonly WireFrameFillMode: number;
  25458. /**
  25459. * Returns the point fill mode
  25460. */
  25461. static readonly PointFillMode: number;
  25462. /**
  25463. * Returns the point list draw mode
  25464. */
  25465. static readonly PointListDrawMode: number;
  25466. /**
  25467. * Returns the line list draw mode
  25468. */
  25469. static readonly LineListDrawMode: number;
  25470. /**
  25471. * Returns the line loop draw mode
  25472. */
  25473. static readonly LineLoopDrawMode: number;
  25474. /**
  25475. * Returns the line strip draw mode
  25476. */
  25477. static readonly LineStripDrawMode: number;
  25478. /**
  25479. * Returns the triangle strip draw mode
  25480. */
  25481. static readonly TriangleStripDrawMode: number;
  25482. /**
  25483. * Returns the triangle fan draw mode
  25484. */
  25485. static readonly TriangleFanDrawMode: number;
  25486. /**
  25487. * Stores the clock-wise side orientation
  25488. */
  25489. static readonly ClockWiseSideOrientation: number;
  25490. /**
  25491. * Stores the counter clock-wise side orientation
  25492. */
  25493. static readonly CounterClockWiseSideOrientation: number;
  25494. /**
  25495. * The dirty texture flag value
  25496. */
  25497. static readonly TextureDirtyFlag: number;
  25498. /**
  25499. * The dirty light flag value
  25500. */
  25501. static readonly LightDirtyFlag: number;
  25502. /**
  25503. * The dirty fresnel flag value
  25504. */
  25505. static readonly FresnelDirtyFlag: number;
  25506. /**
  25507. * The dirty attribute flag value
  25508. */
  25509. static readonly AttributesDirtyFlag: number;
  25510. /**
  25511. * The dirty misc flag value
  25512. */
  25513. static readonly MiscDirtyFlag: number;
  25514. /**
  25515. * The all dirty flag value
  25516. */
  25517. static readonly AllDirtyFlag: number;
  25518. /**
  25519. * MaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  25520. */
  25521. static readonly MATERIAL_OPAQUE: number;
  25522. /**
  25523. * MaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  25524. */
  25525. static readonly MATERIAL_ALPHATEST: number;
  25526. /**
  25527. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  25528. */
  25529. static readonly MATERIAL_ALPHABLEND: number;
  25530. /**
  25531. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  25532. * They are also discarded below the alpha cutoff threshold to improve performances.
  25533. */
  25534. static readonly MATERIAL_ALPHATESTANDBLEND: number;
  25535. /**
  25536. * The Whiteout method is used to blend normals.
  25537. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  25538. */
  25539. static readonly MATERIAL_NORMALBLENDMETHOD_WHITEOUT: number;
  25540. /**
  25541. * The Reoriented Normal Mapping method is used to blend normals.
  25542. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  25543. */
  25544. static readonly MATERIAL_NORMALBLENDMETHOD_RNM: number;
  25545. /**
  25546. * Custom callback helping to override the default shader used in the material.
  25547. */
  25548. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: MaterialDefines | string[], attributes?: string[], options?: ICustomShaderNameResolveOptions) => string;
  25549. /**
  25550. * Custom shadow depth material to use for shadow rendering instead of the in-built one
  25551. */
  25552. shadowDepthWrapper: Nullable<ShadowDepthWrapper>;
  25553. /**
  25554. * Gets or sets a boolean indicating that the material is allowed (if supported) to do shader hot swapping.
  25555. * This means that the material can keep using a previous shader while a new one is being compiled.
  25556. * This is mostly used when shader parallel compilation is supported (true by default)
  25557. */
  25558. allowShaderHotSwapping: boolean;
  25559. /**
  25560. * The ID of the material
  25561. */
  25562. id: string;
  25563. /**
  25564. * Gets or sets the unique id of the material
  25565. */
  25566. uniqueId: number;
  25567. /**
  25568. * The name of the material
  25569. */
  25570. name: string;
  25571. /**
  25572. * Gets or sets user defined metadata
  25573. */
  25574. metadata: any;
  25575. /**
  25576. * For internal use only. Please do not use.
  25577. */
  25578. reservedDataStore: any;
  25579. /**
  25580. * Specifies if the ready state should be checked on each call
  25581. */
  25582. checkReadyOnEveryCall: boolean;
  25583. /**
  25584. * Specifies if the ready state should be checked once
  25585. */
  25586. checkReadyOnlyOnce: boolean;
  25587. /**
  25588. * The state of the material
  25589. */
  25590. state: string;
  25591. /**
  25592. * If the material can be rendered to several textures with MRT extension
  25593. */
  25594. get canRenderToMRT(): boolean;
  25595. /**
  25596. * The alpha value of the material
  25597. */
  25598. protected _alpha: number;
  25599. /**
  25600. * List of inspectable custom properties (used by the Inspector)
  25601. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  25602. */
  25603. inspectableCustomProperties: IInspectable[];
  25604. /**
  25605. * Sets the alpha value of the material
  25606. */
  25607. set alpha(value: number);
  25608. /**
  25609. * Gets the alpha value of the material
  25610. */
  25611. get alpha(): number;
  25612. /**
  25613. * Specifies if back face culling is enabled
  25614. */
  25615. protected _backFaceCulling: boolean;
  25616. /**
  25617. * Sets the back-face culling state
  25618. */
  25619. set backFaceCulling(value: boolean);
  25620. /**
  25621. * Gets the back-face culling state
  25622. */
  25623. get backFaceCulling(): boolean;
  25624. /**
  25625. * Stores the value for side orientation
  25626. */
  25627. sideOrientation: number;
  25628. /**
  25629. * Callback triggered when the material is compiled
  25630. */
  25631. onCompiled: Nullable<(effect: Effect) => void>;
  25632. /**
  25633. * Callback triggered when an error occurs
  25634. */
  25635. onError: Nullable<(effect: Effect, errors: string) => void>;
  25636. /**
  25637. * Callback triggered to get the render target textures
  25638. */
  25639. getRenderTargetTextures: Nullable<() => SmartArray<RenderTargetTexture>>;
  25640. /**
  25641. * Gets a boolean indicating that current material needs to register RTT
  25642. */
  25643. get hasRenderTargetTextures(): boolean;
  25644. /**
  25645. * Specifies if the material should be serialized
  25646. */
  25647. doNotSerialize: boolean;
  25648. /**
  25649. * @hidden
  25650. */
  25651. _storeEffectOnSubMeshes: boolean;
  25652. /**
  25653. * Stores the animations for the material
  25654. */
  25655. animations: Nullable<Array<Animation>>;
  25656. /**
  25657. * An event triggered when the material is disposed
  25658. */
  25659. onDisposeObservable: Observable<Material>;
  25660. /**
  25661. * An observer which watches for dispose events
  25662. */
  25663. private _onDisposeObserver;
  25664. private _onUnBindObservable;
  25665. /**
  25666. * Called during a dispose event
  25667. */
  25668. set onDispose(callback: () => void);
  25669. private _onBindObservable;
  25670. /**
  25671. * An event triggered when the material is bound
  25672. */
  25673. get onBindObservable(): Observable<AbstractMesh>;
  25674. /**
  25675. * An observer which watches for bind events
  25676. */
  25677. private _onBindObserver;
  25678. /**
  25679. * Called during a bind event
  25680. */
  25681. set onBind(callback: (Mesh: AbstractMesh) => void);
  25682. /**
  25683. * An event triggered when the material is unbound
  25684. */
  25685. get onUnBindObservable(): Observable<Material>;
  25686. protected _onEffectCreatedObservable: Nullable<Observable<{
  25687. effect: Effect;
  25688. subMesh: Nullable<SubMesh>;
  25689. }>>;
  25690. /**
  25691. * An event triggered when the effect is (re)created
  25692. */
  25693. get onEffectCreatedObservable(): Observable<{
  25694. effect: Effect;
  25695. subMesh: Nullable<SubMesh>;
  25696. }>;
  25697. /**
  25698. * Stores the value of the alpha mode
  25699. */
  25700. private _alphaMode;
  25701. /**
  25702. * Sets the value of the alpha mode.
  25703. *
  25704. * | Value | Type | Description |
  25705. * | --- | --- | --- |
  25706. * | 0 | ALPHA_DISABLE | |
  25707. * | 1 | ALPHA_ADD | |
  25708. * | 2 | ALPHA_COMBINE | |
  25709. * | 3 | ALPHA_SUBTRACT | |
  25710. * | 4 | ALPHA_MULTIPLY | |
  25711. * | 5 | ALPHA_MAXIMIZED | |
  25712. * | 6 | ALPHA_ONEONE | |
  25713. * | 7 | ALPHA_PREMULTIPLIED | |
  25714. * | 8 | ALPHA_PREMULTIPLIED_PORTERDUFF | |
  25715. * | 9 | ALPHA_INTERPOLATE | |
  25716. * | 10 | ALPHA_SCREENMODE | |
  25717. *
  25718. */
  25719. set alphaMode(value: number);
  25720. /**
  25721. * Gets the value of the alpha mode
  25722. */
  25723. get alphaMode(): number;
  25724. /**
  25725. * Stores the state of the need depth pre-pass value
  25726. */
  25727. private _needDepthPrePass;
  25728. /**
  25729. * Sets the need depth pre-pass value
  25730. */
  25731. set needDepthPrePass(value: boolean);
  25732. /**
  25733. * Gets the depth pre-pass value
  25734. */
  25735. get needDepthPrePass(): boolean;
  25736. /**
  25737. * Specifies if depth writing should be disabled
  25738. */
  25739. disableDepthWrite: boolean;
  25740. /**
  25741. * Specifies if color writing should be disabled
  25742. */
  25743. disableColorWrite: boolean;
  25744. /**
  25745. * Specifies if depth writing should be forced
  25746. */
  25747. forceDepthWrite: boolean;
  25748. /**
  25749. * Specifies the depth function that should be used. 0 means the default engine function
  25750. */
  25751. depthFunction: number;
  25752. /**
  25753. * Specifies if there should be a separate pass for culling
  25754. */
  25755. separateCullingPass: boolean;
  25756. /**
  25757. * Stores the state specifing if fog should be enabled
  25758. */
  25759. private _fogEnabled;
  25760. /**
  25761. * Sets the state for enabling fog
  25762. */
  25763. set fogEnabled(value: boolean);
  25764. /**
  25765. * Gets the value of the fog enabled state
  25766. */
  25767. get fogEnabled(): boolean;
  25768. /**
  25769. * Stores the size of points
  25770. */
  25771. pointSize: number;
  25772. /**
  25773. * Stores the z offset value
  25774. */
  25775. zOffset: number;
  25776. get wireframe(): boolean;
  25777. /**
  25778. * Sets the state of wireframe mode
  25779. */
  25780. set wireframe(value: boolean);
  25781. /**
  25782. * Gets the value specifying if point clouds are enabled
  25783. */
  25784. get pointsCloud(): boolean;
  25785. /**
  25786. * Sets the state of point cloud mode
  25787. */
  25788. set pointsCloud(value: boolean);
  25789. /**
  25790. * Gets the material fill mode
  25791. */
  25792. get fillMode(): number;
  25793. /**
  25794. * Sets the material fill mode
  25795. */
  25796. set fillMode(value: number);
  25797. /**
  25798. * @hidden
  25799. * Stores the effects for the material
  25800. */
  25801. _effect: Nullable<Effect>;
  25802. /**
  25803. * Specifies if uniform buffers should be used
  25804. */
  25805. private _useUBO;
  25806. /**
  25807. * Stores a reference to the scene
  25808. */
  25809. private _scene;
  25810. /**
  25811. * Stores the fill mode state
  25812. */
  25813. private _fillMode;
  25814. /**
  25815. * Specifies if the depth write state should be cached
  25816. */
  25817. private _cachedDepthWriteState;
  25818. /**
  25819. * Specifies if the color write state should be cached
  25820. */
  25821. private _cachedColorWriteState;
  25822. /**
  25823. * Specifies if the depth function state should be cached
  25824. */
  25825. private _cachedDepthFunctionState;
  25826. /**
  25827. * Stores the uniform buffer
  25828. */
  25829. protected _uniformBuffer: UniformBuffer;
  25830. /** @hidden */
  25831. _indexInSceneMaterialArray: number;
  25832. /** @hidden */
  25833. meshMap: Nullable<{
  25834. [id: string]: AbstractMesh | undefined;
  25835. }>;
  25836. /**
  25837. * Creates a material instance
  25838. * @param name defines the name of the material
  25839. * @param scene defines the scene to reference
  25840. * @param doNotAdd specifies if the material should be added to the scene
  25841. */
  25842. constructor(name: string, scene: Scene, doNotAdd?: boolean);
  25843. /**
  25844. * Returns a string representation of the current material
  25845. * @param fullDetails defines a boolean indicating which levels of logging is desired
  25846. * @returns a string with material information
  25847. */
  25848. toString(fullDetails?: boolean): string;
  25849. /**
  25850. * Gets the class name of the material
  25851. * @returns a string with the class name of the material
  25852. */
  25853. getClassName(): string;
  25854. /**
  25855. * Specifies if updates for the material been locked
  25856. */
  25857. get isFrozen(): boolean;
  25858. /**
  25859. * Locks updates for the material
  25860. */
  25861. freeze(): void;
  25862. /**
  25863. * Unlocks updates for the material
  25864. */
  25865. unfreeze(): void;
  25866. /**
  25867. * Specifies if the material is ready to be used
  25868. * @param mesh defines the mesh to check
  25869. * @param useInstances specifies if instances should be used
  25870. * @returns a boolean indicating if the material is ready to be used
  25871. */
  25872. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  25873. /**
  25874. * Specifies that the submesh is ready to be used
  25875. * @param mesh defines the mesh to check
  25876. * @param subMesh defines which submesh to check
  25877. * @param useInstances specifies that instances should be used
  25878. * @returns a boolean indicating that the submesh is ready or not
  25879. */
  25880. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  25881. /**
  25882. * Returns the material effect
  25883. * @returns the effect associated with the material
  25884. */
  25885. getEffect(): Nullable<Effect>;
  25886. /**
  25887. * Returns the current scene
  25888. * @returns a Scene
  25889. */
  25890. getScene(): Scene;
  25891. /**
  25892. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  25893. */
  25894. protected _forceAlphaTest: boolean;
  25895. /**
  25896. * The transparency mode of the material.
  25897. */
  25898. protected _transparencyMode: Nullable<number>;
  25899. /**
  25900. * Gets the current transparency mode.
  25901. */
  25902. get transparencyMode(): Nullable<number>;
  25903. /**
  25904. * Sets the transparency mode of the material.
  25905. *
  25906. * | Value | Type | Description |
  25907. * | ----- | ----------------------------------- | ----------- |
  25908. * | 0 | OPAQUE | |
  25909. * | 1 | ALPHATEST | |
  25910. * | 2 | ALPHABLEND | |
  25911. * | 3 | ALPHATESTANDBLEND | |
  25912. *
  25913. */
  25914. set transparencyMode(value: Nullable<number>);
  25915. /**
  25916. * Returns true if alpha blending should be disabled.
  25917. */
  25918. protected get _disableAlphaBlending(): boolean;
  25919. /**
  25920. * Specifies whether or not this material should be rendered in alpha blend mode.
  25921. * @returns a boolean specifying if alpha blending is needed
  25922. */
  25923. needAlphaBlending(): boolean;
  25924. /**
  25925. * Specifies if the mesh will require alpha blending
  25926. * @param mesh defines the mesh to check
  25927. * @returns a boolean specifying if alpha blending is needed for the mesh
  25928. */
  25929. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  25930. /**
  25931. * Specifies whether or not this material should be rendered in alpha test mode.
  25932. * @returns a boolean specifying if an alpha test is needed.
  25933. */
  25934. needAlphaTesting(): boolean;
  25935. /**
  25936. * Specifies if material alpha testing should be turned on for the mesh
  25937. * @param mesh defines the mesh to check
  25938. */
  25939. protected _shouldTurnAlphaTestOn(mesh: AbstractMesh): boolean;
  25940. /**
  25941. * Gets the texture used for the alpha test
  25942. * @returns the texture to use for alpha testing
  25943. */
  25944. getAlphaTestTexture(): Nullable<BaseTexture>;
  25945. /**
  25946. * Marks the material to indicate that it needs to be re-calculated
  25947. */
  25948. markDirty(): void;
  25949. /** @hidden */
  25950. _preBind(effect?: Effect, overrideOrientation?: Nullable<number>): boolean;
  25951. /**
  25952. * Binds the material to the mesh
  25953. * @param world defines the world transformation matrix
  25954. * @param mesh defines the mesh to bind the material to
  25955. */
  25956. bind(world: Matrix, mesh?: Mesh): void;
  25957. /**
  25958. * Binds the submesh to the material
  25959. * @param world defines the world transformation matrix
  25960. * @param mesh defines the mesh containing the submesh
  25961. * @param subMesh defines the submesh to bind the material to
  25962. */
  25963. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  25964. /**
  25965. * Binds the world matrix to the material
  25966. * @param world defines the world transformation matrix
  25967. */
  25968. bindOnlyWorldMatrix(world: Matrix): void;
  25969. /**
  25970. * Binds the scene's uniform buffer to the effect.
  25971. * @param effect defines the effect to bind to the scene uniform buffer
  25972. * @param sceneUbo defines the uniform buffer storing scene data
  25973. */
  25974. bindSceneUniformBuffer(effect: Effect, sceneUbo: UniformBuffer): void;
  25975. /**
  25976. * Binds the view matrix to the effect
  25977. * @param effect defines the effect to bind the view matrix to
  25978. */
  25979. bindView(effect: Effect): void;
  25980. /**
  25981. * Binds the view projection matrix to the effect
  25982. * @param effect defines the effect to bind the view projection matrix to
  25983. */
  25984. bindViewProjection(effect: Effect): void;
  25985. /**
  25986. * Processes to execute after binding the material to a mesh
  25987. * @param mesh defines the rendered mesh
  25988. */
  25989. protected _afterBind(mesh?: Mesh): void;
  25990. /**
  25991. * Unbinds the material from the mesh
  25992. */
  25993. unbind(): void;
  25994. /**
  25995. * Gets the active textures from the material
  25996. * @returns an array of textures
  25997. */
  25998. getActiveTextures(): BaseTexture[];
  25999. /**
  26000. * Specifies if the material uses a texture
  26001. * @param texture defines the texture to check against the material
  26002. * @returns a boolean specifying if the material uses the texture
  26003. */
  26004. hasTexture(texture: BaseTexture): boolean;
  26005. /**
  26006. * Makes a duplicate of the material, and gives it a new name
  26007. * @param name defines the new name for the duplicated material
  26008. * @returns the cloned material
  26009. */
  26010. clone(name: string): Nullable<Material>;
  26011. /**
  26012. * Gets the meshes bound to the material
  26013. * @returns an array of meshes bound to the material
  26014. */
  26015. getBindedMeshes(): AbstractMesh[];
  26016. /**
  26017. * Force shader compilation
  26018. * @param mesh defines the mesh associated with this material
  26019. * @param onCompiled defines a function to execute once the material is compiled
  26020. * @param options defines the options to configure the compilation
  26021. * @param onError defines a function to execute if the material fails compiling
  26022. */
  26023. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>, onError?: (reason: string) => void): void;
  26024. /**
  26025. * Force shader compilation
  26026. * @param mesh defines the mesh that will use this material
  26027. * @param options defines additional options for compiling the shaders
  26028. * @returns a promise that resolves when the compilation completes
  26029. */
  26030. forceCompilationAsync(mesh: AbstractMesh, options?: Partial<IMaterialCompilationOptions>): Promise<void>;
  26031. private static readonly _AllDirtyCallBack;
  26032. private static readonly _ImageProcessingDirtyCallBack;
  26033. private static readonly _TextureDirtyCallBack;
  26034. private static readonly _FresnelDirtyCallBack;
  26035. private static readonly _MiscDirtyCallBack;
  26036. private static readonly _LightsDirtyCallBack;
  26037. private static readonly _AttributeDirtyCallBack;
  26038. private static _FresnelAndMiscDirtyCallBack;
  26039. private static _TextureAndMiscDirtyCallBack;
  26040. private static readonly _DirtyCallbackArray;
  26041. private static readonly _RunDirtyCallBacks;
  26042. /**
  26043. * Marks a define in the material to indicate that it needs to be re-computed
  26044. * @param flag defines a flag used to determine which parts of the material have to be marked as dirty
  26045. */
  26046. markAsDirty(flag: number): void;
  26047. /**
  26048. * Marks all submeshes of a material to indicate that their material defines need to be re-calculated
  26049. * @param func defines a function which checks material defines against the submeshes
  26050. */
  26051. protected _markAllSubMeshesAsDirty(func: (defines: MaterialDefines) => void): void;
  26052. /**
  26053. * Indicates that the scene should check if the rendering now needs a prepass
  26054. */
  26055. protected _markScenePrePassDirty(): void;
  26056. /**
  26057. * Indicates that we need to re-calculated for all submeshes
  26058. */
  26059. protected _markAllSubMeshesAsAllDirty(): void;
  26060. /**
  26061. * Indicates that image processing needs to be re-calculated for all submeshes
  26062. */
  26063. protected _markAllSubMeshesAsImageProcessingDirty(): void;
  26064. /**
  26065. * Indicates that textures need to be re-calculated for all submeshes
  26066. */
  26067. protected _markAllSubMeshesAsTexturesDirty(): void;
  26068. /**
  26069. * Indicates that fresnel needs to be re-calculated for all submeshes
  26070. */
  26071. protected _markAllSubMeshesAsFresnelDirty(): void;
  26072. /**
  26073. * Indicates that fresnel and misc need to be re-calculated for all submeshes
  26074. */
  26075. protected _markAllSubMeshesAsFresnelAndMiscDirty(): void;
  26076. /**
  26077. * Indicates that lights need to be re-calculated for all submeshes
  26078. */
  26079. protected _markAllSubMeshesAsLightsDirty(): void;
  26080. /**
  26081. * Indicates that attributes need to be re-calculated for all submeshes
  26082. */
  26083. protected _markAllSubMeshesAsAttributesDirty(): void;
  26084. /**
  26085. * Indicates that misc needs to be re-calculated for all submeshes
  26086. */
  26087. protected _markAllSubMeshesAsMiscDirty(): void;
  26088. /**
  26089. * Indicates that textures and misc need to be re-calculated for all submeshes
  26090. */
  26091. protected _markAllSubMeshesAsTexturesAndMiscDirty(): void;
  26092. /**
  26093. * Sets the required values to the prepass renderer.
  26094. * @param prePassRenderer defines the prepass renderer to setup.
  26095. * @returns true if the pre pass is needed.
  26096. */
  26097. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  26098. /**
  26099. * Disposes the material
  26100. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  26101. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  26102. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  26103. */
  26104. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  26105. /** @hidden */
  26106. private releaseVertexArrayObject;
  26107. /**
  26108. * Serializes this material
  26109. * @returns the serialized material object
  26110. */
  26111. serialize(): any;
  26112. /**
  26113. * Creates a material from parsed material data
  26114. * @param parsedMaterial defines parsed material data
  26115. * @param scene defines the hosting scene
  26116. * @param rootUrl defines the root URL to use to load textures
  26117. * @returns a new material
  26118. */
  26119. static Parse(parsedMaterial: any, scene: Scene, rootUrl: string): Nullable<Material>;
  26120. }
  26121. }
  26122. declare module "babylonjs/Materials/multiMaterial" {
  26123. import { Nullable } from "babylonjs/types";
  26124. import { Scene } from "babylonjs/scene";
  26125. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  26126. import { SubMesh } from "babylonjs/Meshes/subMesh";
  26127. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  26128. import { Material } from "babylonjs/Materials/material";
  26129. /**
  26130. * A multi-material is used to apply different materials to different parts of the same object without the need of
  26131. * separate meshes. This can be use to improve performances.
  26132. * @see https://doc.babylonjs.com/how_to/multi_materials
  26133. */
  26134. export class MultiMaterial extends Material {
  26135. private _subMaterials;
  26136. /**
  26137. * Gets or Sets the list of Materials used within the multi material.
  26138. * They need to be ordered according to the submeshes order in the associated mesh
  26139. */
  26140. get subMaterials(): Nullable<Material>[];
  26141. set subMaterials(value: Nullable<Material>[]);
  26142. /**
  26143. * Function used to align with Node.getChildren()
  26144. * @returns the list of Materials used within the multi material
  26145. */
  26146. getChildren(): Nullable<Material>[];
  26147. /**
  26148. * Instantiates a new Multi Material
  26149. * A multi-material is used to apply different materials to different parts of the same object without the need of
  26150. * separate meshes. This can be use to improve performances.
  26151. * @see https://doc.babylonjs.com/how_to/multi_materials
  26152. * @param name Define the name in the scene
  26153. * @param scene Define the scene the material belongs to
  26154. */
  26155. constructor(name: string, scene: Scene);
  26156. private _hookArray;
  26157. /**
  26158. * Get one of the submaterial by its index in the submaterials array
  26159. * @param index The index to look the sub material at
  26160. * @returns The Material if the index has been defined
  26161. */
  26162. getSubMaterial(index: number): Nullable<Material>;
  26163. /**
  26164. * Get the list of active textures for the whole sub materials list.
  26165. * @returns All the textures that will be used during the rendering
  26166. */
  26167. getActiveTextures(): BaseTexture[];
  26168. /**
  26169. * Gets the current class name of the material e.g. "MultiMaterial"
  26170. * Mainly use in serialization.
  26171. * @returns the class name
  26172. */
  26173. getClassName(): string;
  26174. /**
  26175. * Checks if the material is ready to render the requested sub mesh
  26176. * @param mesh Define the mesh the submesh belongs to
  26177. * @param subMesh Define the sub mesh to look readyness for
  26178. * @param useInstances Define whether or not the material is used with instances
  26179. * @returns true if ready, otherwise false
  26180. */
  26181. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  26182. /**
  26183. * Clones the current material and its related sub materials
  26184. * @param name Define the name of the newly cloned material
  26185. * @param cloneChildren Define if submaterial will be cloned or shared with the parent instance
  26186. * @returns the cloned material
  26187. */
  26188. clone(name: string, cloneChildren?: boolean): MultiMaterial;
  26189. /**
  26190. * Serializes the materials into a JSON representation.
  26191. * @returns the JSON representation
  26192. */
  26193. serialize(): any;
  26194. /**
  26195. * Dispose the material and release its associated resources
  26196. * @param forceDisposeEffect Define if we want to force disposing the associated effect (if false the shader is not released and could be reuse later on)
  26197. * @param forceDisposeTextures Define if we want to force disposing the associated textures (if false, they will not be disposed and can still be use elsewhere in the app)
  26198. * @param forceDisposeChildren Define if we want to force disposing the associated submaterials (if false, they will not be disposed and can still be use elsewhere in the app)
  26199. */
  26200. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, forceDisposeChildren?: boolean): void;
  26201. /**
  26202. * Creates a MultiMaterial from parsed MultiMaterial data.
  26203. * @param parsedMultiMaterial defines parsed MultiMaterial data.
  26204. * @param scene defines the hosting scene
  26205. * @returns a new MultiMaterial
  26206. */
  26207. static ParseMultiMaterial(parsedMultiMaterial: any, scene: Scene): MultiMaterial;
  26208. }
  26209. }
  26210. declare module "babylonjs/Meshes/subMesh" {
  26211. import { Nullable, IndicesArray, DeepImmutable, FloatArray } from "babylonjs/types";
  26212. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  26213. import { Engine } from "babylonjs/Engines/engine";
  26214. import { IntersectionInfo } from "babylonjs/Collisions/intersectionInfo";
  26215. import { ICullable, BoundingInfo } from "babylonjs/Culling/boundingInfo";
  26216. import { Effect } from "babylonjs/Materials/effect";
  26217. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  26218. import { Plane } from "babylonjs/Maths/math.plane";
  26219. import { Collider } from "babylonjs/Collisions/collider";
  26220. import { Material } from "babylonjs/Materials/material";
  26221. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  26222. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  26223. import { Mesh } from "babylonjs/Meshes/mesh";
  26224. import { Ray } from "babylonjs/Culling/ray";
  26225. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  26226. /**
  26227. * Defines a subdivision inside a mesh
  26228. */
  26229. export class SubMesh implements ICullable {
  26230. /** the material index to use */
  26231. materialIndex: number;
  26232. /** vertex index start */
  26233. verticesStart: number;
  26234. /** vertices count */
  26235. verticesCount: number;
  26236. /** index start */
  26237. indexStart: number;
  26238. /** indices count */
  26239. indexCount: number;
  26240. /** @hidden */
  26241. _materialDefines: Nullable<MaterialDefines>;
  26242. /** @hidden */
  26243. _materialEffect: Nullable<Effect>;
  26244. /** @hidden */
  26245. _effectOverride: Nullable<Effect>;
  26246. /**
  26247. * Gets material defines used by the effect associated to the sub mesh
  26248. */
  26249. get materialDefines(): Nullable<MaterialDefines>;
  26250. /**
  26251. * Sets material defines used by the effect associated to the sub mesh
  26252. */
  26253. set materialDefines(defines: Nullable<MaterialDefines>);
  26254. /**
  26255. * Gets associated effect
  26256. */
  26257. get effect(): Nullable<Effect>;
  26258. /**
  26259. * Sets associated effect (effect used to render this submesh)
  26260. * @param effect defines the effect to associate with
  26261. * @param defines defines the set of defines used to compile this effect
  26262. */
  26263. setEffect(effect: Nullable<Effect>, defines?: Nullable<MaterialDefines>): void;
  26264. /** @hidden */
  26265. _linesIndexCount: number;
  26266. private _mesh;
  26267. private _renderingMesh;
  26268. private _boundingInfo;
  26269. private _linesIndexBuffer;
  26270. /** @hidden */
  26271. _lastColliderWorldVertices: Nullable<Vector3[]>;
  26272. /** @hidden */
  26273. _trianglePlanes: Plane[];
  26274. /** @hidden */
  26275. _lastColliderTransformMatrix: Nullable<Matrix>;
  26276. /** @hidden */
  26277. _renderId: number;
  26278. /** @hidden */
  26279. _alphaIndex: number;
  26280. /** @hidden */
  26281. _distanceToCamera: number;
  26282. /** @hidden */
  26283. _id: number;
  26284. private _currentMaterial;
  26285. /**
  26286. * Add a new submesh to a mesh
  26287. * @param materialIndex defines the material index to use
  26288. * @param verticesStart defines vertex index start
  26289. * @param verticesCount defines vertices count
  26290. * @param indexStart defines index start
  26291. * @param indexCount defines indices count
  26292. * @param mesh defines the parent mesh
  26293. * @param renderingMesh defines an optional rendering mesh
  26294. * @param createBoundingBox defines if bounding box should be created for this submesh
  26295. * @returns the new submesh
  26296. */
  26297. static AddToMesh(materialIndex: number, verticesStart: number, verticesCount: number, indexStart: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean): SubMesh;
  26298. /**
  26299. * Creates a new submesh
  26300. * @param materialIndex defines the material index to use
  26301. * @param verticesStart defines vertex index start
  26302. * @param verticesCount defines vertices count
  26303. * @param indexStart defines index start
  26304. * @param indexCount defines indices count
  26305. * @param mesh defines the parent mesh
  26306. * @param renderingMesh defines an optional rendering mesh
  26307. * @param createBoundingBox defines if bounding box should be created for this submesh
  26308. * @param addToMesh defines a boolean indicating that the submesh must be added to the mesh.subMeshes array (true by default)
  26309. */
  26310. constructor(
  26311. /** the material index to use */
  26312. materialIndex: number,
  26313. /** vertex index start */
  26314. verticesStart: number,
  26315. /** vertices count */
  26316. verticesCount: number,
  26317. /** index start */
  26318. indexStart: number,
  26319. /** indices count */
  26320. indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean, addToMesh?: boolean);
  26321. /**
  26322. * Returns true if this submesh covers the entire parent mesh
  26323. * @ignorenaming
  26324. */
  26325. get IsGlobal(): boolean;
  26326. /**
  26327. * Returns the submesh BoudingInfo object
  26328. * @returns current bounding info (or mesh's one if the submesh is global)
  26329. */
  26330. getBoundingInfo(): BoundingInfo;
  26331. /**
  26332. * Sets the submesh BoundingInfo
  26333. * @param boundingInfo defines the new bounding info to use
  26334. * @returns the SubMesh
  26335. */
  26336. setBoundingInfo(boundingInfo: BoundingInfo): SubMesh;
  26337. /**
  26338. * Returns the mesh of the current submesh
  26339. * @return the parent mesh
  26340. */
  26341. getMesh(): AbstractMesh;
  26342. /**
  26343. * Returns the rendering mesh of the submesh
  26344. * @returns the rendering mesh (could be different from parent mesh)
  26345. */
  26346. getRenderingMesh(): Mesh;
  26347. /**
  26348. * Returns the replacement mesh of the submesh
  26349. * @returns the replacement mesh (could be different from parent mesh)
  26350. */
  26351. getReplacementMesh(): Nullable<AbstractMesh>;
  26352. /**
  26353. * Returns the effective mesh of the submesh
  26354. * @returns the effective mesh (could be different from parent mesh)
  26355. */
  26356. getEffectiveMesh(): AbstractMesh;
  26357. /**
  26358. * Returns the submesh material
  26359. * @returns null or the current material
  26360. */
  26361. getMaterial(): Nullable<Material>;
  26362. private _IsMultiMaterial;
  26363. /**
  26364. * Sets a new updated BoundingInfo object to the submesh
  26365. * @param data defines an optional position array to use to determine the bounding info
  26366. * @returns the SubMesh
  26367. */
  26368. refreshBoundingInfo(data?: Nullable<FloatArray>): SubMesh;
  26369. /** @hidden */
  26370. _checkCollision(collider: Collider): boolean;
  26371. /**
  26372. * Updates the submesh BoundingInfo
  26373. * @param world defines the world matrix to use to update the bounding info
  26374. * @returns the submesh
  26375. */
  26376. updateBoundingInfo(world: DeepImmutable<Matrix>): SubMesh;
  26377. /**
  26378. * True is the submesh bounding box intersects the frustum defined by the passed array of planes.
  26379. * @param frustumPlanes defines the frustum planes
  26380. * @returns true if the submesh is intersecting with the frustum
  26381. */
  26382. isInFrustum(frustumPlanes: Plane[]): boolean;
  26383. /**
  26384. * True is the submesh bounding box is completely inside the frustum defined by the passed array of planes
  26385. * @param frustumPlanes defines the frustum planes
  26386. * @returns true if the submesh is inside the frustum
  26387. */
  26388. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  26389. /**
  26390. * Renders the submesh
  26391. * @param enableAlphaMode defines if alpha needs to be used
  26392. * @returns the submesh
  26393. */
  26394. render(enableAlphaMode: boolean): SubMesh;
  26395. /**
  26396. * @hidden
  26397. */
  26398. _getLinesIndexBuffer(indices: IndicesArray, engine: Engine): DataBuffer;
  26399. /**
  26400. * Checks if the submesh intersects with a ray
  26401. * @param ray defines the ray to test
  26402. * @returns true is the passed ray intersects the submesh bounding box
  26403. */
  26404. canIntersects(ray: Ray): boolean;
  26405. /**
  26406. * Intersects current submesh with a ray
  26407. * @param ray defines the ray to test
  26408. * @param positions defines mesh's positions array
  26409. * @param indices defines mesh's indices array
  26410. * @param fastCheck defines if the first intersection will be used (and not the closest)
  26411. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  26412. * @returns intersection info or null if no intersection
  26413. */
  26414. intersects(ray: Ray, positions: Vector3[], indices: IndicesArray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<IntersectionInfo>;
  26415. /** @hidden */
  26416. private _intersectLines;
  26417. /** @hidden */
  26418. private _intersectUnIndexedLines;
  26419. /** @hidden */
  26420. private _intersectTriangles;
  26421. /** @hidden */
  26422. private _intersectUnIndexedTriangles;
  26423. /** @hidden */
  26424. _rebuild(): void;
  26425. /**
  26426. * Creates a new submesh from the passed mesh
  26427. * @param newMesh defines the new hosting mesh
  26428. * @param newRenderingMesh defines an optional rendering mesh
  26429. * @returns the new submesh
  26430. */
  26431. clone(newMesh: AbstractMesh, newRenderingMesh?: Mesh): SubMesh;
  26432. /**
  26433. * Release associated resources
  26434. */
  26435. dispose(): void;
  26436. /**
  26437. * Gets the class name
  26438. * @returns the string "SubMesh".
  26439. */
  26440. getClassName(): string;
  26441. /**
  26442. * Creates a new submesh from indices data
  26443. * @param materialIndex the index of the main mesh material
  26444. * @param startIndex the index where to start the copy in the mesh indices array
  26445. * @param indexCount the number of indices to copy then from the startIndex
  26446. * @param mesh the main mesh to create the submesh from
  26447. * @param renderingMesh the optional rendering mesh
  26448. * @returns a new submesh
  26449. */
  26450. static CreateFromIndices(materialIndex: number, startIndex: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh): SubMesh;
  26451. }
  26452. }
  26453. declare module "babylonjs/Loading/sceneLoaderFlags" {
  26454. /**
  26455. * Class used to represent data loading progression
  26456. */
  26457. export class SceneLoaderFlags {
  26458. private static _ForceFullSceneLoadingForIncremental;
  26459. private static _ShowLoadingScreen;
  26460. private static _CleanBoneMatrixWeights;
  26461. private static _loggingLevel;
  26462. /**
  26463. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  26464. */
  26465. static get ForceFullSceneLoadingForIncremental(): boolean;
  26466. static set ForceFullSceneLoadingForIncremental(value: boolean);
  26467. /**
  26468. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  26469. */
  26470. static get ShowLoadingScreen(): boolean;
  26471. static set ShowLoadingScreen(value: boolean);
  26472. /**
  26473. * Defines the current logging level (while loading the scene)
  26474. * @ignorenaming
  26475. */
  26476. static get loggingLevel(): number;
  26477. static set loggingLevel(value: number);
  26478. /**
  26479. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  26480. */
  26481. static get CleanBoneMatrixWeights(): boolean;
  26482. static set CleanBoneMatrixWeights(value: boolean);
  26483. }
  26484. }
  26485. declare module "babylonjs/Meshes/geometry" {
  26486. import { Nullable, FloatArray, DataArray, IndicesArray } from "babylonjs/types";
  26487. import { Scene } from "babylonjs/scene";
  26488. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  26489. import { Engine } from "babylonjs/Engines/engine";
  26490. import { IGetSetVerticesData, VertexData } from "babylonjs/Meshes/mesh.vertexData";
  26491. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  26492. import { Effect } from "babylonjs/Materials/effect";
  26493. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  26494. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  26495. import { Mesh } from "babylonjs/Meshes/mesh";
  26496. /**
  26497. * Class used to store geometry data (vertex buffers + index buffer)
  26498. */
  26499. export class Geometry implements IGetSetVerticesData {
  26500. /**
  26501. * Gets or sets the ID of the geometry
  26502. */
  26503. id: string;
  26504. /**
  26505. * Gets or sets the unique ID of the geometry
  26506. */
  26507. uniqueId: number;
  26508. /**
  26509. * Gets the delay loading state of the geometry (none by default which means not delayed)
  26510. */
  26511. delayLoadState: number;
  26512. /**
  26513. * Gets the file containing the data to load when running in delay load state
  26514. */
  26515. delayLoadingFile: Nullable<string>;
  26516. /**
  26517. * Callback called when the geometry is updated
  26518. */
  26519. onGeometryUpdated: (geometry: Geometry, kind?: string) => void;
  26520. private _scene;
  26521. private _engine;
  26522. private _meshes;
  26523. private _totalVertices;
  26524. /** @hidden */
  26525. _indices: IndicesArray;
  26526. /** @hidden */
  26527. _vertexBuffers: {
  26528. [key: string]: VertexBuffer;
  26529. };
  26530. private _isDisposed;
  26531. private _extend;
  26532. private _boundingBias;
  26533. /** @hidden */
  26534. _delayInfo: Array<string>;
  26535. private _indexBuffer;
  26536. private _indexBufferIsUpdatable;
  26537. /** @hidden */
  26538. _boundingInfo: Nullable<BoundingInfo>;
  26539. /** @hidden */
  26540. _delayLoadingFunction: Nullable<(any: any, geometry: Geometry) => void>;
  26541. /** @hidden */
  26542. _softwareSkinningFrameId: number;
  26543. private _vertexArrayObjects;
  26544. private _updatable;
  26545. /** @hidden */
  26546. _positions: Nullable<Vector3[]>;
  26547. /**
  26548. * Gets or sets the Bias Vector to apply on the bounding elements (box/sphere), the max extend is computed as v += v * bias.x + bias.y, the min is computed as v -= v * bias.x + bias.y
  26549. */
  26550. get boundingBias(): Vector2;
  26551. /**
  26552. * Gets or sets the Bias Vector to apply on the bounding elements (box/sphere), the max extend is computed as v += v * bias.x + bias.y, the min is computed as v -= v * bias.x + bias.y
  26553. */
  26554. set boundingBias(value: Vector2);
  26555. /**
  26556. * Static function used to attach a new empty geometry to a mesh
  26557. * @param mesh defines the mesh to attach the geometry to
  26558. * @returns the new Geometry
  26559. */
  26560. static CreateGeometryForMesh(mesh: Mesh): Geometry;
  26561. /** Get the list of meshes using this geometry */
  26562. get meshes(): Mesh[];
  26563. /**
  26564. * If set to true (false by defaut), the bounding info applied to the meshes sharing this geometry will be the bounding info defined at the class level
  26565. * and won't be computed based on the vertex positions (which is what we get when useBoundingInfoFromGeometry = false)
  26566. */
  26567. useBoundingInfoFromGeometry: boolean;
  26568. /**
  26569. * Creates a new geometry
  26570. * @param id defines the unique ID
  26571. * @param scene defines the hosting scene
  26572. * @param vertexData defines the VertexData used to get geometry data
  26573. * @param updatable defines if geometry must be updatable (false by default)
  26574. * @param mesh defines the mesh that will be associated with the geometry
  26575. */
  26576. constructor(id: string, scene: Scene, vertexData?: VertexData, updatable?: boolean, mesh?: Nullable<Mesh>);
  26577. /**
  26578. * Gets the current extend of the geometry
  26579. */
  26580. get extend(): {
  26581. minimum: Vector3;
  26582. maximum: Vector3;
  26583. };
  26584. /**
  26585. * Gets the hosting scene
  26586. * @returns the hosting Scene
  26587. */
  26588. getScene(): Scene;
  26589. /**
  26590. * Gets the hosting engine
  26591. * @returns the hosting Engine
  26592. */
  26593. getEngine(): Engine;
  26594. /**
  26595. * Defines if the geometry is ready to use
  26596. * @returns true if the geometry is ready to be used
  26597. */
  26598. isReady(): boolean;
  26599. /**
  26600. * Gets a value indicating that the geometry should not be serialized
  26601. */
  26602. get doNotSerialize(): boolean;
  26603. /** @hidden */
  26604. _rebuild(): void;
  26605. /**
  26606. * Affects all geometry data in one call
  26607. * @param vertexData defines the geometry data
  26608. * @param updatable defines if the geometry must be flagged as updatable (false as default)
  26609. */
  26610. setAllVerticesData(vertexData: VertexData, updatable?: boolean): void;
  26611. /**
  26612. * Set specific vertex data
  26613. * @param kind defines the data kind (Position, normal, etc...)
  26614. * @param data defines the vertex data to use
  26615. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  26616. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  26617. */
  26618. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): void;
  26619. /**
  26620. * Removes a specific vertex data
  26621. * @param kind defines the data kind (Position, normal, etc...)
  26622. */
  26623. removeVerticesData(kind: string): void;
  26624. /**
  26625. * Affect a vertex buffer to the geometry. the vertexBuffer.getKind() function is used to determine where to store the data
  26626. * @param buffer defines the vertex buffer to use
  26627. * @param totalVertices defines the total number of vertices for position kind (could be null)
  26628. */
  26629. setVerticesBuffer(buffer: VertexBuffer, totalVertices?: Nullable<number>): void;
  26630. /**
  26631. * Update a specific vertex buffer
  26632. * This function will directly update the underlying DataBuffer according to the passed numeric array or Float32Array
  26633. * It will do nothing if the buffer is not updatable
  26634. * @param kind defines the data kind (Position, normal, etc...)
  26635. * @param data defines the data to use
  26636. * @param offset defines the offset in the target buffer where to store the data
  26637. * @param useBytes set to true if the offset is in bytes
  26638. */
  26639. updateVerticesDataDirectly(kind: string, data: DataArray, offset: number, useBytes?: boolean): void;
  26640. /**
  26641. * Update a specific vertex buffer
  26642. * This function will create a new buffer if the current one is not updatable
  26643. * @param kind defines the data kind (Position, normal, etc...)
  26644. * @param data defines the data to use
  26645. * @param updateExtends defines if the geometry extends must be recomputed (false by default)
  26646. */
  26647. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean): void;
  26648. private _updateBoundingInfo;
  26649. /** @hidden */
  26650. _bind(effect: Nullable<Effect>, indexToBind?: Nullable<DataBuffer>): void;
  26651. /**
  26652. * Gets total number of vertices
  26653. * @returns the total number of vertices
  26654. */
  26655. getTotalVertices(): number;
  26656. /**
  26657. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  26658. * @param kind defines the data kind (Position, normal, etc...)
  26659. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  26660. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  26661. * @returns a float array containing vertex data
  26662. */
  26663. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  26664. /**
  26665. * Returns a boolean defining if the vertex data for the requested `kind` is updatable
  26666. * @param kind defines the data kind (Position, normal, etc...)
  26667. * @returns true if the vertex buffer with the specified kind is updatable
  26668. */
  26669. isVertexBufferUpdatable(kind: string): boolean;
  26670. /**
  26671. * Gets a specific vertex buffer
  26672. * @param kind defines the data kind (Position, normal, etc...)
  26673. * @returns a VertexBuffer
  26674. */
  26675. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  26676. /**
  26677. * Returns all vertex buffers
  26678. * @return an object holding all vertex buffers indexed by kind
  26679. */
  26680. getVertexBuffers(): Nullable<{
  26681. [key: string]: VertexBuffer;
  26682. }>;
  26683. /**
  26684. * Gets a boolean indicating if specific vertex buffer is present
  26685. * @param kind defines the data kind (Position, normal, etc...)
  26686. * @returns true if data is present
  26687. */
  26688. isVerticesDataPresent(kind: string): boolean;
  26689. /**
  26690. * Gets a list of all attached data kinds (Position, normal, etc...)
  26691. * @returns a list of string containing all kinds
  26692. */
  26693. getVerticesDataKinds(): string[];
  26694. /**
  26695. * Update index buffer
  26696. * @param indices defines the indices to store in the index buffer
  26697. * @param offset defines the offset in the target buffer where to store the data
  26698. * @param gpuMemoryOnly defines a boolean indicating that only the GPU memory must be updated leaving the CPU version of the indices unchanged (false by default)
  26699. */
  26700. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): void;
  26701. /**
  26702. * Creates a new index buffer
  26703. * @param indices defines the indices to store in the index buffer
  26704. * @param totalVertices defines the total number of vertices (could be null)
  26705. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  26706. */
  26707. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): void;
  26708. /**
  26709. * Return the total number of indices
  26710. * @returns the total number of indices
  26711. */
  26712. getTotalIndices(): number;
  26713. /**
  26714. * Gets the index buffer array
  26715. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  26716. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  26717. * @returns the index buffer array
  26718. */
  26719. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  26720. /**
  26721. * Gets the index buffer
  26722. * @return the index buffer
  26723. */
  26724. getIndexBuffer(): Nullable<DataBuffer>;
  26725. /** @hidden */
  26726. _releaseVertexArrayObject(effect?: Nullable<Effect>): void;
  26727. /**
  26728. * Release the associated resources for a specific mesh
  26729. * @param mesh defines the source mesh
  26730. * @param shouldDispose defines if the geometry must be disposed if there is no more mesh pointing to it
  26731. */
  26732. releaseForMesh(mesh: Mesh, shouldDispose?: boolean): void;
  26733. /**
  26734. * Apply current geometry to a given mesh
  26735. * @param mesh defines the mesh to apply geometry to
  26736. */
  26737. applyToMesh(mesh: Mesh): void;
  26738. private _updateExtend;
  26739. private _applyToMesh;
  26740. private notifyUpdate;
  26741. /**
  26742. * Load the geometry if it was flagged as delay loaded
  26743. * @param scene defines the hosting scene
  26744. * @param onLoaded defines a callback called when the geometry is loaded
  26745. */
  26746. load(scene: Scene, onLoaded?: () => void): void;
  26747. private _queueLoad;
  26748. /**
  26749. * Invert the geometry to move from a right handed system to a left handed one.
  26750. */
  26751. toLeftHanded(): void;
  26752. /** @hidden */
  26753. _resetPointsArrayCache(): void;
  26754. /** @hidden */
  26755. _generatePointsArray(): boolean;
  26756. /**
  26757. * Gets a value indicating if the geometry is disposed
  26758. * @returns true if the geometry was disposed
  26759. */
  26760. isDisposed(): boolean;
  26761. private _disposeVertexArrayObjects;
  26762. /**
  26763. * Free all associated resources
  26764. */
  26765. dispose(): void;
  26766. /**
  26767. * Clone the current geometry into a new geometry
  26768. * @param id defines the unique ID of the new geometry
  26769. * @returns a new geometry object
  26770. */
  26771. copy(id: string): Geometry;
  26772. /**
  26773. * Serialize the current geometry info (and not the vertices data) into a JSON object
  26774. * @return a JSON representation of the current geometry data (without the vertices data)
  26775. */
  26776. serialize(): any;
  26777. private toNumberArray;
  26778. /**
  26779. * Serialize all vertices data into a JSON oject
  26780. * @returns a JSON representation of the current geometry data
  26781. */
  26782. serializeVerticeData(): any;
  26783. /**
  26784. * Extracts a clone of a mesh geometry
  26785. * @param mesh defines the source mesh
  26786. * @param id defines the unique ID of the new geometry object
  26787. * @returns the new geometry object
  26788. */
  26789. static ExtractFromMesh(mesh: Mesh, id: string): Nullable<Geometry>;
  26790. /**
  26791. * You should now use Tools.RandomId(), this method is still here for legacy reasons.
  26792. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  26793. * Be aware Math.random() could cause collisions, but:
  26794. * "All but 6 of the 128 bits of the ID are randomly generated, which means that for any two ids, there's a 1 in 2^^122 (or 5.3x10^^36) chance they'll collide"
  26795. * @returns a string containing a new GUID
  26796. */
  26797. static RandomId(): string;
  26798. /** @hidden */
  26799. static _ImportGeometry(parsedGeometry: any, mesh: Mesh): void;
  26800. private static _CleanMatricesWeights;
  26801. /**
  26802. * Create a new geometry from persisted data (Using .babylon file format)
  26803. * @param parsedVertexData defines the persisted data
  26804. * @param scene defines the hosting scene
  26805. * @param rootUrl defines the root url to use to load assets (like delayed data)
  26806. * @returns the new geometry object
  26807. */
  26808. static Parse(parsedVertexData: any, scene: Scene, rootUrl: string): Nullable<Geometry>;
  26809. }
  26810. }
  26811. declare module "babylonjs/Meshes/mesh.vertexData" {
  26812. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  26813. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  26814. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  26815. import { Geometry } from "babylonjs/Meshes/geometry";
  26816. import { Mesh } from "babylonjs/Meshes/mesh";
  26817. /**
  26818. * Define an interface for all classes that will get and set the data on vertices
  26819. */
  26820. export interface IGetSetVerticesData {
  26821. /**
  26822. * Gets a boolean indicating if specific vertex data is present
  26823. * @param kind defines the vertex data kind to use
  26824. * @returns true is data kind is present
  26825. */
  26826. isVerticesDataPresent(kind: string): boolean;
  26827. /**
  26828. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  26829. * @param kind defines the data kind (Position, normal, etc...)
  26830. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  26831. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  26832. * @returns a float array containing vertex data
  26833. */
  26834. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  26835. /**
  26836. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  26837. * @param copyWhenShared If true (default false) and and if the mesh geometry is shared among some other meshes, the returned array is a copy of the internal one.
  26838. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  26839. * @returns the indices array or an empty array if the mesh has no geometry
  26840. */
  26841. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  26842. /**
  26843. * Set specific vertex data
  26844. * @param kind defines the data kind (Position, normal, etc...)
  26845. * @param data defines the vertex data to use
  26846. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  26847. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  26848. */
  26849. setVerticesData(kind: string, data: FloatArray, updatable: boolean): void;
  26850. /**
  26851. * Update a specific associated vertex buffer
  26852. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  26853. * - VertexBuffer.PositionKind
  26854. * - VertexBuffer.UVKind
  26855. * - VertexBuffer.UV2Kind
  26856. * - VertexBuffer.UV3Kind
  26857. * - VertexBuffer.UV4Kind
  26858. * - VertexBuffer.UV5Kind
  26859. * - VertexBuffer.UV6Kind
  26860. * - VertexBuffer.ColorKind
  26861. * - VertexBuffer.MatricesIndicesKind
  26862. * - VertexBuffer.MatricesIndicesExtraKind
  26863. * - VertexBuffer.MatricesWeightsKind
  26864. * - VertexBuffer.MatricesWeightsExtraKind
  26865. * @param data defines the data source
  26866. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  26867. * @param makeItUnique defines if the geometry associated with the mesh must be cloned to make the change only for this mesh (and not all meshes associated with the same geometry)
  26868. */
  26869. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): void;
  26870. /**
  26871. * Creates a new index buffer
  26872. * @param indices defines the indices to store in the index buffer
  26873. * @param totalVertices defines the total number of vertices (could be null)
  26874. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  26875. */
  26876. setIndices(indices: IndicesArray, totalVertices: Nullable<number>, updatable?: boolean): void;
  26877. }
  26878. /**
  26879. * This class contains the various kinds of data on every vertex of a mesh used in determining its shape and appearance
  26880. */
  26881. export class VertexData {
  26882. /**
  26883. * Mesh side orientation : usually the external or front surface
  26884. */
  26885. static readonly FRONTSIDE: number;
  26886. /**
  26887. * Mesh side orientation : usually the internal or back surface
  26888. */
  26889. static readonly BACKSIDE: number;
  26890. /**
  26891. * Mesh side orientation : both internal and external or front and back surfaces
  26892. */
  26893. static readonly DOUBLESIDE: number;
  26894. /**
  26895. * Mesh side orientation : by default, `FRONTSIDE`
  26896. */
  26897. static readonly DEFAULTSIDE: number;
  26898. /**
  26899. * An array of the x, y, z position of each vertex [...., x, y, z, .....]
  26900. */
  26901. positions: Nullable<FloatArray>;
  26902. /**
  26903. * An array of the x, y, z normal vector of each vertex [...., x, y, z, .....]
  26904. */
  26905. normals: Nullable<FloatArray>;
  26906. /**
  26907. * An array of the x, y, z tangent vector of each vertex [...., x, y, z, .....]
  26908. */
  26909. tangents: Nullable<FloatArray>;
  26910. /**
  26911. * An array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26912. */
  26913. uvs: Nullable<FloatArray>;
  26914. /**
  26915. * A second array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26916. */
  26917. uvs2: Nullable<FloatArray>;
  26918. /**
  26919. * A third array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26920. */
  26921. uvs3: Nullable<FloatArray>;
  26922. /**
  26923. * A fourth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26924. */
  26925. uvs4: Nullable<FloatArray>;
  26926. /**
  26927. * A fifth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26928. */
  26929. uvs5: Nullable<FloatArray>;
  26930. /**
  26931. * A sixth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26932. */
  26933. uvs6: Nullable<FloatArray>;
  26934. /**
  26935. * An array of the r, g, b, a, color of each vertex [...., r, g, b, a, .....]
  26936. */
  26937. colors: Nullable<FloatArray>;
  26938. /**
  26939. * An array containing the list of indices to the array of matrices produced by bones, each vertex have up to 4 indices (8 if the matricesIndicesExtra is set).
  26940. */
  26941. matricesIndices: Nullable<FloatArray>;
  26942. /**
  26943. * An array containing the list of weights defining the weight of each indexed matrix in the final computation
  26944. */
  26945. matricesWeights: Nullable<FloatArray>;
  26946. /**
  26947. * An array extending the number of possible indices
  26948. */
  26949. matricesIndicesExtra: Nullable<FloatArray>;
  26950. /**
  26951. * An array extending the number of possible weights when the number of indices is extended
  26952. */
  26953. matricesWeightsExtra: Nullable<FloatArray>;
  26954. /**
  26955. * An array of i, j, k the three vertex indices required for each triangular facet [...., i, j, k .....]
  26956. */
  26957. indices: Nullable<IndicesArray>;
  26958. /**
  26959. * Uses the passed data array to set the set the values for the specified kind of data
  26960. * @param data a linear array of floating numbers
  26961. * @param kind the type of data that is being set, eg positions, colors etc
  26962. */
  26963. set(data: FloatArray, kind: string): void;
  26964. /**
  26965. * Associates the vertexData to the passed Mesh.
  26966. * Sets it as updatable or not (default `false`)
  26967. * @param mesh the mesh the vertexData is applied to
  26968. * @param updatable when used and having the value true allows new data to update the vertexData
  26969. * @returns the VertexData
  26970. */
  26971. applyToMesh(mesh: Mesh, updatable?: boolean): VertexData;
  26972. /**
  26973. * Associates the vertexData to the passed Geometry.
  26974. * Sets it as updatable or not (default `false`)
  26975. * @param geometry the geometry the vertexData is applied to
  26976. * @param updatable when used and having the value true allows new data to update the vertexData
  26977. * @returns VertexData
  26978. */
  26979. applyToGeometry(geometry: Geometry, updatable?: boolean): VertexData;
  26980. /**
  26981. * Updates the associated mesh
  26982. * @param mesh the mesh to be updated
  26983. * @param updateExtends when true the mesh BoundingInfo will be renewed when and if position kind is updated, optional with default false
  26984. * @param makeItUnique when true, and when and if position kind is updated, a new global geometry will be created from these positions and set to the mesh, optional with default false
  26985. * @returns VertexData
  26986. */
  26987. updateMesh(mesh: Mesh): VertexData;
  26988. /**
  26989. * Updates the associated geometry
  26990. * @param geometry the geometry to be updated
  26991. * @param updateExtends when true BoundingInfo will be renewed when and if position kind is updated, optional with default false
  26992. * @param makeItUnique when true, and when and if position kind is updated, a new global geometry will be created from these positions and set to the mesh, optional with default false
  26993. * @returns VertexData.
  26994. */
  26995. updateGeometry(geometry: Geometry): VertexData;
  26996. private _applyTo;
  26997. private _update;
  26998. /**
  26999. * Transforms each position and each normal of the vertexData according to the passed Matrix
  27000. * @param matrix the transforming matrix
  27001. * @returns the VertexData
  27002. */
  27003. transform(matrix: Matrix): VertexData;
  27004. /**
  27005. * Merges the passed VertexData into the current one
  27006. * @param other the VertexData to be merged into the current one
  27007. * @param use32BitsIndices defines a boolean indicating if indices must be store in a 32 bits array
  27008. * @returns the modified VertexData
  27009. */
  27010. merge(other: VertexData, use32BitsIndices?: boolean): VertexData;
  27011. private _mergeElement;
  27012. private _validate;
  27013. /**
  27014. * Serializes the VertexData
  27015. * @returns a serialized object
  27016. */
  27017. serialize(): any;
  27018. /**
  27019. * Extracts the vertexData from a mesh
  27020. * @param mesh the mesh from which to extract the VertexData
  27021. * @param copyWhenShared defines if the VertexData must be cloned when shared between multiple meshes, optional, default false
  27022. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  27023. * @returns the object VertexData associated to the passed mesh
  27024. */
  27025. static ExtractFromMesh(mesh: Mesh, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  27026. /**
  27027. * Extracts the vertexData from the geometry
  27028. * @param geometry the geometry from which to extract the VertexData
  27029. * @param copyWhenShared defines if the VertexData must be cloned when the geometrty is shared between multiple meshes, optional, default false
  27030. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  27031. * @returns the object VertexData associated to the passed mesh
  27032. */
  27033. static ExtractFromGeometry(geometry: Geometry, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  27034. private static _ExtractFrom;
  27035. /**
  27036. * Creates the VertexData for a Ribbon
  27037. * @param options an object used to set the following optional parameters for the ribbon, required but can be empty
  27038. * * pathArray array of paths, each of which an array of successive Vector3
  27039. * * closeArray creates a seam between the first and the last paths of the pathArray, optional, default false
  27040. * * closePath creates a seam between the first and the last points of each path of the path array, optional, default false
  27041. * * offset a positive integer, only used when pathArray contains a single path (offset = 10 means the point 1 is joined to the point 11), default rounded half size of the pathArray length
  27042. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27043. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27044. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27045. * * invertUV swaps in the U and V coordinates when applying a texture, optional, default false
  27046. * * uvs a linear array, of length 2 * number of vertices, of custom UV values, optional
  27047. * * colors a linear array, of length 4 * number of vertices, of custom color values, optional
  27048. * @returns the VertexData of the ribbon
  27049. */
  27050. static CreateRibbon(options: {
  27051. pathArray: Vector3[][];
  27052. closeArray?: boolean;
  27053. closePath?: boolean;
  27054. offset?: number;
  27055. sideOrientation?: number;
  27056. frontUVs?: Vector4;
  27057. backUVs?: Vector4;
  27058. invertUV?: boolean;
  27059. uvs?: Vector2[];
  27060. colors?: Color4[];
  27061. }): VertexData;
  27062. /**
  27063. * Creates the VertexData for a box
  27064. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27065. * * size sets the width, height and depth of the box to the value of size, optional default 1
  27066. * * width sets the width (x direction) of the box, overwrites the width set by size, optional, default size
  27067. * * height sets the height (y direction) of the box, overwrites the height set by size, optional, default size
  27068. * * depth sets the depth (z direction) of the box, overwrites the depth set by size, optional, default size
  27069. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  27070. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  27071. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27072. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27073. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27074. * @returns the VertexData of the box
  27075. */
  27076. static CreateBox(options: {
  27077. size?: number;
  27078. width?: number;
  27079. height?: number;
  27080. depth?: number;
  27081. faceUV?: Vector4[];
  27082. faceColors?: Color4[];
  27083. sideOrientation?: number;
  27084. frontUVs?: Vector4;
  27085. backUVs?: Vector4;
  27086. }): VertexData;
  27087. /**
  27088. * Creates the VertexData for a tiled box
  27089. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27090. * * faceTiles sets the pattern, tile size and number of tiles for a face
  27091. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  27092. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  27093. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27094. * @returns the VertexData of the box
  27095. */
  27096. static CreateTiledBox(options: {
  27097. pattern?: number;
  27098. width?: number;
  27099. height?: number;
  27100. depth?: number;
  27101. tileSize?: number;
  27102. tileWidth?: number;
  27103. tileHeight?: number;
  27104. alignHorizontal?: number;
  27105. alignVertical?: number;
  27106. faceUV?: Vector4[];
  27107. faceColors?: Color4[];
  27108. sideOrientation?: number;
  27109. }): VertexData;
  27110. /**
  27111. * Creates the VertexData for a tiled plane
  27112. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27113. * * pattern a limited pattern arrangement depending on the number
  27114. * * tileSize sets the width, height and depth of the tile to the value of size, optional default 1
  27115. * * tileWidth sets the width (x direction) of the tile, overwrites the width set by size, optional, default size
  27116. * * tileHeight sets the height (y direction) of the tile, overwrites the height set by size, optional, default size
  27117. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27118. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27119. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27120. * @returns the VertexData of the tiled plane
  27121. */
  27122. static CreateTiledPlane(options: {
  27123. pattern?: number;
  27124. tileSize?: number;
  27125. tileWidth?: number;
  27126. tileHeight?: number;
  27127. size?: number;
  27128. width?: number;
  27129. height?: number;
  27130. alignHorizontal?: number;
  27131. alignVertical?: number;
  27132. sideOrientation?: number;
  27133. frontUVs?: Vector4;
  27134. backUVs?: Vector4;
  27135. }): VertexData;
  27136. /**
  27137. * Creates the VertexData for an ellipsoid, defaults to a sphere
  27138. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27139. * * segments sets the number of horizontal strips optional, default 32
  27140. * * diameter sets the axes dimensions, diameterX, diameterY and diameterZ to the value of diameter, optional default 1
  27141. * * diameterX sets the diameterX (x direction) of the ellipsoid, overwrites the diameterX set by diameter, optional, default diameter
  27142. * * diameterY sets the diameterY (y direction) of the ellipsoid, overwrites the diameterY set by diameter, optional, default diameter
  27143. * * diameterZ sets the diameterZ (z direction) of the ellipsoid, overwrites the diameterZ set by diameter, optional, default diameter
  27144. * * arc a number from 0 to 1, to create an unclosed ellipsoid based on the fraction of the circumference (latitude) given by the arc value, optional, default 1
  27145. * * slice a number from 0 to 1, to create an unclosed ellipsoid based on the fraction of the height (latitude) given by the arc value, optional, default 1
  27146. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27147. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27148. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27149. * @returns the VertexData of the ellipsoid
  27150. */
  27151. static CreateSphere(options: {
  27152. segments?: number;
  27153. diameter?: number;
  27154. diameterX?: number;
  27155. diameterY?: number;
  27156. diameterZ?: number;
  27157. arc?: number;
  27158. slice?: number;
  27159. sideOrientation?: number;
  27160. frontUVs?: Vector4;
  27161. backUVs?: Vector4;
  27162. }): VertexData;
  27163. /**
  27164. * Creates the VertexData for a cylinder, cone or prism
  27165. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27166. * * height sets the height (y direction) of the cylinder, optional, default 2
  27167. * * diameterTop sets the diameter of the top of the cone, overwrites diameter, optional, default diameter
  27168. * * diameterBottom sets the diameter of the bottom of the cone, overwrites diameter, optional, default diameter
  27169. * * diameter sets the diameter of the top and bottom of the cone, optional default 1
  27170. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  27171. * * subdivisions` the number of rings along the cylinder height, optional, default 1
  27172. * * arc a number from 0 to 1, to create an unclosed cylinder based on the fraction of the circumference given by the arc value, optional, default 1
  27173. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  27174. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  27175. * * hasRings when true makes each subdivision independantly treated as a face for faceUV and faceColors, optional, default false
  27176. * * enclose when true closes an open cylinder by adding extra flat faces between the height axis and vertical edges, think cut cake
  27177. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27178. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27179. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27180. * @returns the VertexData of the cylinder, cone or prism
  27181. */
  27182. static CreateCylinder(options: {
  27183. height?: number;
  27184. diameterTop?: number;
  27185. diameterBottom?: number;
  27186. diameter?: number;
  27187. tessellation?: number;
  27188. subdivisions?: number;
  27189. arc?: number;
  27190. faceColors?: Color4[];
  27191. faceUV?: Vector4[];
  27192. hasRings?: boolean;
  27193. enclose?: boolean;
  27194. sideOrientation?: number;
  27195. frontUVs?: Vector4;
  27196. backUVs?: Vector4;
  27197. }): VertexData;
  27198. /**
  27199. * Creates the VertexData for a torus
  27200. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27201. * * diameter the diameter of the torus, optional default 1
  27202. * * thickness the diameter of the tube forming the torus, optional default 0.5
  27203. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  27204. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27205. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27206. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27207. * @returns the VertexData of the torus
  27208. */
  27209. static CreateTorus(options: {
  27210. diameter?: number;
  27211. thickness?: number;
  27212. tessellation?: number;
  27213. sideOrientation?: number;
  27214. frontUVs?: Vector4;
  27215. backUVs?: Vector4;
  27216. }): VertexData;
  27217. /**
  27218. * Creates the VertexData of the LineSystem
  27219. * @param options an object used to set the following optional parameters for the LineSystem, required but can be empty
  27220. * - lines an array of lines, each line being an array of successive Vector3
  27221. * - colors an array of line colors, each of the line colors being an array of successive Color4, one per line point
  27222. * @returns the VertexData of the LineSystem
  27223. */
  27224. static CreateLineSystem(options: {
  27225. lines: Vector3[][];
  27226. colors?: Nullable<Color4[][]>;
  27227. }): VertexData;
  27228. /**
  27229. * Create the VertexData for a DashedLines
  27230. * @param options an object used to set the following optional parameters for the DashedLines, required but can be empty
  27231. * - points an array successive Vector3
  27232. * - dashSize the size of the dashes relative to the dash number, optional, default 3
  27233. * - gapSize the size of the gap between two successive dashes relative to the dash number, optional, default 1
  27234. * - dashNb the intended total number of dashes, optional, default 200
  27235. * @returns the VertexData for the DashedLines
  27236. */
  27237. static CreateDashedLines(options: {
  27238. points: Vector3[];
  27239. dashSize?: number;
  27240. gapSize?: number;
  27241. dashNb?: number;
  27242. }): VertexData;
  27243. /**
  27244. * Creates the VertexData for a Ground
  27245. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  27246. * - width the width (x direction) of the ground, optional, default 1
  27247. * - height the height (z direction) of the ground, optional, default 1
  27248. * - subdivisions the number of subdivisions per side, optional, default 1
  27249. * @returns the VertexData of the Ground
  27250. */
  27251. static CreateGround(options: {
  27252. width?: number;
  27253. height?: number;
  27254. subdivisions?: number;
  27255. subdivisionsX?: number;
  27256. subdivisionsY?: number;
  27257. }): VertexData;
  27258. /**
  27259. * Creates the VertexData for a TiledGround by subdividing the ground into tiles
  27260. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  27261. * * xmin the ground minimum X coordinate, optional, default -1
  27262. * * zmin the ground minimum Z coordinate, optional, default -1
  27263. * * xmax the ground maximum X coordinate, optional, default 1
  27264. * * zmax the ground maximum Z coordinate, optional, default 1
  27265. * * subdivisions a javascript object {w: positive integer, h: positive integer}, `w` and `h` are the numbers of subdivisions on the ground width and height creating 'tiles', default {w: 6, h: 6}
  27266. * * precision a javascript object {w: positive integer, h: positive integer}, `w` and `h` are the numbers of subdivisions on the tile width and height, default {w: 2, h: 2}
  27267. * @returns the VertexData of the TiledGround
  27268. */
  27269. static CreateTiledGround(options: {
  27270. xmin: number;
  27271. zmin: number;
  27272. xmax: number;
  27273. zmax: number;
  27274. subdivisions?: {
  27275. w: number;
  27276. h: number;
  27277. };
  27278. precision?: {
  27279. w: number;
  27280. h: number;
  27281. };
  27282. }): VertexData;
  27283. /**
  27284. * Creates the VertexData of the Ground designed from a heightmap
  27285. * @param options an object used to set the following parameters for the Ground, required and provided by MeshBuilder.CreateGroundFromHeightMap
  27286. * * width the width (x direction) of the ground
  27287. * * height the height (z direction) of the ground
  27288. * * subdivisions the number of subdivisions per side
  27289. * * minHeight the minimum altitude on the ground, optional, default 0
  27290. * * maxHeight the maximum altitude on the ground, optional default 1
  27291. * * colorFilter the filter to apply to the image pixel colors to compute the height, optional Color3, default (0.3, 0.59, 0.11)
  27292. * * buffer the array holding the image color data
  27293. * * bufferWidth the width of image
  27294. * * bufferHeight the height of image
  27295. * * alphaFilter Remove any data where the alpha channel is below this value, defaults 0 (all data visible)
  27296. * @returns the VertexData of the Ground designed from a heightmap
  27297. */
  27298. static CreateGroundFromHeightMap(options: {
  27299. width: number;
  27300. height: number;
  27301. subdivisions: number;
  27302. minHeight: number;
  27303. maxHeight: number;
  27304. colorFilter: Color3;
  27305. buffer: Uint8Array;
  27306. bufferWidth: number;
  27307. bufferHeight: number;
  27308. alphaFilter: number;
  27309. }): VertexData;
  27310. /**
  27311. * Creates the VertexData for a Plane
  27312. * @param options an object used to set the following optional parameters for the plane, required but can be empty
  27313. * * size sets the width and height of the plane to the value of size, optional default 1
  27314. * * width sets the width (x direction) of the plane, overwrites the width set by size, optional, default size
  27315. * * height sets the height (y direction) of the plane, overwrites the height set by size, optional, default size
  27316. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27317. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27318. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27319. * @returns the VertexData of the box
  27320. */
  27321. static CreatePlane(options: {
  27322. size?: number;
  27323. width?: number;
  27324. height?: number;
  27325. sideOrientation?: number;
  27326. frontUVs?: Vector4;
  27327. backUVs?: Vector4;
  27328. }): VertexData;
  27329. /**
  27330. * Creates the VertexData of the Disc or regular Polygon
  27331. * @param options an object used to set the following optional parameters for the disc, required but can be empty
  27332. * * radius the radius of the disc, optional default 0.5
  27333. * * tessellation the number of polygon sides, optional, default 64
  27334. * * arc a number from 0 to 1, to create an unclosed polygon based on the fraction of the circumference given by the arc value, optional, default 1
  27335. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27336. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27337. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27338. * @returns the VertexData of the box
  27339. */
  27340. static CreateDisc(options: {
  27341. radius?: number;
  27342. tessellation?: number;
  27343. arc?: number;
  27344. sideOrientation?: number;
  27345. frontUVs?: Vector4;
  27346. backUVs?: Vector4;
  27347. }): VertexData;
  27348. /**
  27349. * Creates the VertexData for an irregular Polygon in the XoZ plane using a mesh built by polygonTriangulation.build()
  27350. * All parameters are provided by MeshBuilder.CreatePolygon as needed
  27351. * @param polygon a mesh built from polygonTriangulation.build()
  27352. * @param sideOrientation takes the values Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27353. * @param fUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  27354. * @param fColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  27355. * @param frontUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27356. * @param backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27357. * @param wrap a boolean, default false, when true and fUVs used texture is wrapped around all sides, when false texture is applied side
  27358. * @returns the VertexData of the Polygon
  27359. */
  27360. static CreatePolygon(polygon: Mesh, sideOrientation: number, fUV?: Vector4[], fColors?: Color4[], frontUVs?: Vector4, backUVs?: Vector4, wrap?: boolean): VertexData;
  27361. /**
  27362. * Creates the VertexData of the IcoSphere
  27363. * @param options an object used to set the following optional parameters for the IcoSphere, required but can be empty
  27364. * * radius the radius of the IcoSphere, optional default 1
  27365. * * radiusX allows stretching in the x direction, optional, default radius
  27366. * * radiusY allows stretching in the y direction, optional, default radius
  27367. * * radiusZ allows stretching in the z direction, optional, default radius
  27368. * * flat when true creates a flat shaded mesh, optional, default true
  27369. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  27370. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27371. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27372. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27373. * @returns the VertexData of the IcoSphere
  27374. */
  27375. static CreateIcoSphere(options: {
  27376. radius?: number;
  27377. radiusX?: number;
  27378. radiusY?: number;
  27379. radiusZ?: number;
  27380. flat?: boolean;
  27381. subdivisions?: number;
  27382. sideOrientation?: number;
  27383. frontUVs?: Vector4;
  27384. backUVs?: Vector4;
  27385. }): VertexData;
  27386. /**
  27387. * Creates the VertexData for a Polyhedron
  27388. * @param options an object used to set the following optional parameters for the polyhedron, required but can be empty
  27389. * * type provided types are:
  27390. * * 0 : Tetrahedron, 1 : Octahedron, 2 : Dodecahedron, 3 : Icosahedron, 4 : Rhombicuboctahedron, 5 : Triangular Prism, 6 : Pentagonal Prism, 7 : Hexagonal Prism, 8 : Square Pyramid (J1)
  27391. * * 9 : Pentagonal Pyramid (J2), 10 : Triangular Dipyramid (J12), 11 : Pentagonal Dipyramid (J13), 12 : Elongated Square Dipyramid (J15), 13 : Elongated Pentagonal Dipyramid (J16), 14 : Elongated Pentagonal Cupola (J20)
  27392. * * size the size of the IcoSphere, optional default 1
  27393. * * sizeX allows stretching in the x direction, optional, default size
  27394. * * sizeY allows stretching in the y direction, optional, default size
  27395. * * sizeZ allows stretching in the z direction, optional, default size
  27396. * * custom a number that overwrites the type to create from an extended set of polyhedron from https://www.babylonjs-playground.com/#21QRSK#15 with minimised editor
  27397. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  27398. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  27399. * * flat when true creates a flat shaded mesh, optional, default true
  27400. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  27401. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27402. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27403. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27404. * @returns the VertexData of the Polyhedron
  27405. */
  27406. static CreatePolyhedron(options: {
  27407. type?: number;
  27408. size?: number;
  27409. sizeX?: number;
  27410. sizeY?: number;
  27411. sizeZ?: number;
  27412. custom?: any;
  27413. faceUV?: Vector4[];
  27414. faceColors?: Color4[];
  27415. flat?: boolean;
  27416. sideOrientation?: number;
  27417. frontUVs?: Vector4;
  27418. backUVs?: Vector4;
  27419. }): VertexData;
  27420. /**
  27421. * Creates the VertexData for a TorusKnot
  27422. * @param options an object used to set the following optional parameters for the TorusKnot, required but can be empty
  27423. * * radius the radius of the torus knot, optional, default 2
  27424. * * tube the thickness of the tube, optional, default 0.5
  27425. * * radialSegments the number of sides on each tube segments, optional, default 32
  27426. * * tubularSegments the number of tubes to decompose the knot into, optional, default 32
  27427. * * p the number of windings around the z axis, optional, default 2
  27428. * * q the number of windings around the x axis, optional, default 3
  27429. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27430. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27431. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27432. * @returns the VertexData of the Torus Knot
  27433. */
  27434. static CreateTorusKnot(options: {
  27435. radius?: number;
  27436. tube?: number;
  27437. radialSegments?: number;
  27438. tubularSegments?: number;
  27439. p?: number;
  27440. q?: number;
  27441. sideOrientation?: number;
  27442. frontUVs?: Vector4;
  27443. backUVs?: Vector4;
  27444. }): VertexData;
  27445. /**
  27446. * Compute normals for given positions and indices
  27447. * @param positions an array of vertex positions, [...., x, y, z, ......]
  27448. * @param indices an array of indices in groups of three for each triangular facet, [...., i, j, k, ......]
  27449. * @param normals an array of vertex normals, [...., x, y, z, ......]
  27450. * @param options an object used to set the following optional parameters for the TorusKnot, optional
  27451. * * facetNormals : optional array of facet normals (vector3)
  27452. * * facetPositions : optional array of facet positions (vector3)
  27453. * * facetPartitioning : optional partitioning array. facetPositions is required for facetPartitioning computation
  27454. * * ratio : optional partitioning ratio / bounding box, required for facetPartitioning computation
  27455. * * bInfo : optional bounding info, required for facetPartitioning computation
  27456. * * bbSize : optional bounding box size data, required for facetPartitioning computation
  27457. * * subDiv : optional partitioning data about subdivsions on each axis (int), required for facetPartitioning computation
  27458. * * useRightHandedSystem: optional boolean to for right handed system computation
  27459. * * depthSort : optional boolean to enable the facet depth sort computation
  27460. * * distanceTo : optional Vector3 to compute the facet depth from this location
  27461. * * depthSortedFacets : optional array of depthSortedFacets to store the facet distances from the reference location
  27462. */
  27463. static ComputeNormals(positions: any, indices: any, normals: any, options?: {
  27464. facetNormals?: any;
  27465. facetPositions?: any;
  27466. facetPartitioning?: any;
  27467. ratio?: number;
  27468. bInfo?: any;
  27469. bbSize?: Vector3;
  27470. subDiv?: any;
  27471. useRightHandedSystem?: boolean;
  27472. depthSort?: boolean;
  27473. distanceTo?: Vector3;
  27474. depthSortedFacets?: any;
  27475. }): void;
  27476. /** @hidden */
  27477. static _ComputeSides(sideOrientation: number, positions: FloatArray, indices: FloatArray, normals: FloatArray, uvs: FloatArray, frontUVs?: Vector4, backUVs?: Vector4): void;
  27478. /**
  27479. * Applies VertexData created from the imported parameters to the geometry
  27480. * @param parsedVertexData the parsed data from an imported file
  27481. * @param geometry the geometry to apply the VertexData to
  27482. */
  27483. static ImportVertexData(parsedVertexData: any, geometry: Geometry): void;
  27484. }
  27485. }
  27486. declare module "babylonjs/Morph/morphTarget" {
  27487. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  27488. import { Observable } from "babylonjs/Misc/observable";
  27489. import { Nullable, FloatArray } from "babylonjs/types";
  27490. import { Scene } from "babylonjs/scene";
  27491. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  27492. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  27493. /**
  27494. * Defines a target to use with MorphTargetManager
  27495. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  27496. */
  27497. export class MorphTarget implements IAnimatable {
  27498. /** defines the name of the target */
  27499. name: string;
  27500. /**
  27501. * Gets or sets the list of animations
  27502. */
  27503. animations: import("babylonjs/Animations/animation").Animation[];
  27504. private _scene;
  27505. private _positions;
  27506. private _normals;
  27507. private _tangents;
  27508. private _uvs;
  27509. private _influence;
  27510. private _uniqueId;
  27511. /**
  27512. * Observable raised when the influence changes
  27513. */
  27514. onInfluenceChanged: Observable<boolean>;
  27515. /** @hidden */
  27516. _onDataLayoutChanged: Observable<void>;
  27517. /**
  27518. * Gets or sets the influence of this target (ie. its weight in the overall morphing)
  27519. */
  27520. get influence(): number;
  27521. set influence(influence: number);
  27522. /**
  27523. * Gets or sets the id of the morph Target
  27524. */
  27525. id: string;
  27526. private _animationPropertiesOverride;
  27527. /**
  27528. * Gets or sets the animation properties override
  27529. */
  27530. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  27531. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  27532. /**
  27533. * Creates a new MorphTarget
  27534. * @param name defines the name of the target
  27535. * @param influence defines the influence to use
  27536. * @param scene defines the scene the morphtarget belongs to
  27537. */
  27538. constructor(
  27539. /** defines the name of the target */
  27540. name: string, influence?: number, scene?: Nullable<Scene>);
  27541. /**
  27542. * Gets the unique ID of this manager
  27543. */
  27544. get uniqueId(): number;
  27545. /**
  27546. * Gets a boolean defining if the target contains position data
  27547. */
  27548. get hasPositions(): boolean;
  27549. /**
  27550. * Gets a boolean defining if the target contains normal data
  27551. */
  27552. get hasNormals(): boolean;
  27553. /**
  27554. * Gets a boolean defining if the target contains tangent data
  27555. */
  27556. get hasTangents(): boolean;
  27557. /**
  27558. * Gets a boolean defining if the target contains texture coordinates data
  27559. */
  27560. get hasUVs(): boolean;
  27561. /**
  27562. * Affects position data to this target
  27563. * @param data defines the position data to use
  27564. */
  27565. setPositions(data: Nullable<FloatArray>): void;
  27566. /**
  27567. * Gets the position data stored in this target
  27568. * @returns a FloatArray containing the position data (or null if not present)
  27569. */
  27570. getPositions(): Nullable<FloatArray>;
  27571. /**
  27572. * Affects normal data to this target
  27573. * @param data defines the normal data to use
  27574. */
  27575. setNormals(data: Nullable<FloatArray>): void;
  27576. /**
  27577. * Gets the normal data stored in this target
  27578. * @returns a FloatArray containing the normal data (or null if not present)
  27579. */
  27580. getNormals(): Nullable<FloatArray>;
  27581. /**
  27582. * Affects tangent data to this target
  27583. * @param data defines the tangent data to use
  27584. */
  27585. setTangents(data: Nullable<FloatArray>): void;
  27586. /**
  27587. * Gets the tangent data stored in this target
  27588. * @returns a FloatArray containing the tangent data (or null if not present)
  27589. */
  27590. getTangents(): Nullable<FloatArray>;
  27591. /**
  27592. * Affects texture coordinates data to this target
  27593. * @param data defines the texture coordinates data to use
  27594. */
  27595. setUVs(data: Nullable<FloatArray>): void;
  27596. /**
  27597. * Gets the texture coordinates data stored in this target
  27598. * @returns a FloatArray containing the texture coordinates data (or null if not present)
  27599. */
  27600. getUVs(): Nullable<FloatArray>;
  27601. /**
  27602. * Clone the current target
  27603. * @returns a new MorphTarget
  27604. */
  27605. clone(): MorphTarget;
  27606. /**
  27607. * Serializes the current target into a Serialization object
  27608. * @returns the serialized object
  27609. */
  27610. serialize(): any;
  27611. /**
  27612. * Returns the string "MorphTarget"
  27613. * @returns "MorphTarget"
  27614. */
  27615. getClassName(): string;
  27616. /**
  27617. * Creates a new target from serialized data
  27618. * @param serializationObject defines the serialized data to use
  27619. * @returns a new MorphTarget
  27620. */
  27621. static Parse(serializationObject: any): MorphTarget;
  27622. /**
  27623. * Creates a MorphTarget from mesh data
  27624. * @param mesh defines the source mesh
  27625. * @param name defines the name to use for the new target
  27626. * @param influence defines the influence to attach to the target
  27627. * @returns a new MorphTarget
  27628. */
  27629. static FromMesh(mesh: AbstractMesh, name?: string, influence?: number): MorphTarget;
  27630. }
  27631. }
  27632. declare module "babylonjs/Morph/morphTargetManager" {
  27633. import { Nullable } from "babylonjs/types";
  27634. import { Scene } from "babylonjs/scene";
  27635. import { MorphTarget } from "babylonjs/Morph/morphTarget";
  27636. /**
  27637. * This class is used to deform meshes using morphing between different targets
  27638. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  27639. */
  27640. export class MorphTargetManager {
  27641. private _targets;
  27642. private _targetInfluenceChangedObservers;
  27643. private _targetDataLayoutChangedObservers;
  27644. private _activeTargets;
  27645. private _scene;
  27646. private _influences;
  27647. private _supportsNormals;
  27648. private _supportsTangents;
  27649. private _supportsUVs;
  27650. private _vertexCount;
  27651. private _uniqueId;
  27652. private _tempInfluences;
  27653. /**
  27654. * Gets or sets a boolean indicating if normals must be morphed
  27655. */
  27656. enableNormalMorphing: boolean;
  27657. /**
  27658. * Gets or sets a boolean indicating if tangents must be morphed
  27659. */
  27660. enableTangentMorphing: boolean;
  27661. /**
  27662. * Gets or sets a boolean indicating if UV must be morphed
  27663. */
  27664. enableUVMorphing: boolean;
  27665. /**
  27666. * Creates a new MorphTargetManager
  27667. * @param scene defines the current scene
  27668. */
  27669. constructor(scene?: Nullable<Scene>);
  27670. /**
  27671. * Gets the unique ID of this manager
  27672. */
  27673. get uniqueId(): number;
  27674. /**
  27675. * Gets the number of vertices handled by this manager
  27676. */
  27677. get vertexCount(): number;
  27678. /**
  27679. * Gets a boolean indicating if this manager supports morphing of normals
  27680. */
  27681. get supportsNormals(): boolean;
  27682. /**
  27683. * Gets a boolean indicating if this manager supports morphing of tangents
  27684. */
  27685. get supportsTangents(): boolean;
  27686. /**
  27687. * Gets a boolean indicating if this manager supports morphing of texture coordinates
  27688. */
  27689. get supportsUVs(): boolean;
  27690. /**
  27691. * Gets the number of targets stored in this manager
  27692. */
  27693. get numTargets(): number;
  27694. /**
  27695. * Gets the number of influencers (ie. the number of targets with influences > 0)
  27696. */
  27697. get numInfluencers(): number;
  27698. /**
  27699. * Gets the list of influences (one per target)
  27700. */
  27701. get influences(): Float32Array;
  27702. /**
  27703. * Gets the active target at specified index. An active target is a target with an influence > 0
  27704. * @param index defines the index to check
  27705. * @returns the requested target
  27706. */
  27707. getActiveTarget(index: number): MorphTarget;
  27708. /**
  27709. * Gets the target at specified index
  27710. * @param index defines the index to check
  27711. * @returns the requested target
  27712. */
  27713. getTarget(index: number): MorphTarget;
  27714. /**
  27715. * Add a new target to this manager
  27716. * @param target defines the target to add
  27717. */
  27718. addTarget(target: MorphTarget): void;
  27719. /**
  27720. * Removes a target from the manager
  27721. * @param target defines the target to remove
  27722. */
  27723. removeTarget(target: MorphTarget): void;
  27724. /**
  27725. * Clone the current manager
  27726. * @returns a new MorphTargetManager
  27727. */
  27728. clone(): MorphTargetManager;
  27729. /**
  27730. * Serializes the current manager into a Serialization object
  27731. * @returns the serialized object
  27732. */
  27733. serialize(): any;
  27734. private _syncActiveTargets;
  27735. /**
  27736. * Syncrhonize the targets with all the meshes using this morph target manager
  27737. */
  27738. synchronize(): void;
  27739. /**
  27740. * Creates a new MorphTargetManager from serialized data
  27741. * @param serializationObject defines the serialized data
  27742. * @param scene defines the hosting scene
  27743. * @returns the new MorphTargetManager
  27744. */
  27745. static Parse(serializationObject: any, scene: Scene): MorphTargetManager;
  27746. }
  27747. }
  27748. declare module "babylonjs/Meshes/meshLODLevel" {
  27749. import { Mesh } from "babylonjs/Meshes/mesh";
  27750. import { Nullable } from "babylonjs/types";
  27751. /**
  27752. * Class used to represent a specific level of detail of a mesh
  27753. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  27754. */
  27755. export class MeshLODLevel {
  27756. /** Defines the distance where this level should start being displayed */
  27757. distance: number;
  27758. /** Defines the mesh to use to render this level */
  27759. mesh: Nullable<Mesh>;
  27760. /**
  27761. * Creates a new LOD level
  27762. * @param distance defines the distance where this level should star being displayed
  27763. * @param mesh defines the mesh to use to render this level
  27764. */
  27765. constructor(
  27766. /** Defines the distance where this level should start being displayed */
  27767. distance: number,
  27768. /** Defines the mesh to use to render this level */
  27769. mesh: Nullable<Mesh>);
  27770. }
  27771. }
  27772. declare module "babylonjs/Misc/canvasGenerator" {
  27773. /**
  27774. * Helper class used to generate a canvas to manipulate images
  27775. */
  27776. export class CanvasGenerator {
  27777. /**
  27778. * Create a new canvas (or offscreen canvas depending on the context)
  27779. * @param width defines the expected width
  27780. * @param height defines the expected height
  27781. * @return a new canvas or offscreen canvas
  27782. */
  27783. static CreateCanvas(width: number, height: number): HTMLCanvasElement | OffscreenCanvas;
  27784. }
  27785. }
  27786. declare module "babylonjs/Meshes/groundMesh" {
  27787. import { Scene } from "babylonjs/scene";
  27788. import { Vector3 } from "babylonjs/Maths/math.vector";
  27789. import { Mesh } from "babylonjs/Meshes/mesh";
  27790. /**
  27791. * Mesh representing the gorund
  27792. */
  27793. export class GroundMesh extends Mesh {
  27794. /** If octree should be generated */
  27795. generateOctree: boolean;
  27796. private _heightQuads;
  27797. /** @hidden */
  27798. _subdivisionsX: number;
  27799. /** @hidden */
  27800. _subdivisionsY: number;
  27801. /** @hidden */
  27802. _width: number;
  27803. /** @hidden */
  27804. _height: number;
  27805. /** @hidden */
  27806. _minX: number;
  27807. /** @hidden */
  27808. _maxX: number;
  27809. /** @hidden */
  27810. _minZ: number;
  27811. /** @hidden */
  27812. _maxZ: number;
  27813. constructor(name: string, scene: Scene);
  27814. /**
  27815. * "GroundMesh"
  27816. * @returns "GroundMesh"
  27817. */
  27818. getClassName(): string;
  27819. /**
  27820. * The minimum of x and y subdivisions
  27821. */
  27822. get subdivisions(): number;
  27823. /**
  27824. * X subdivisions
  27825. */
  27826. get subdivisionsX(): number;
  27827. /**
  27828. * Y subdivisions
  27829. */
  27830. get subdivisionsY(): number;
  27831. /**
  27832. * This function will update an octree to help to select the right submeshes for rendering, picking and collision computations.
  27833. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  27834. * @param chunksCount the number of subdivisions for x and y
  27835. * @param octreeBlocksSize (Default: 32)
  27836. */
  27837. optimize(chunksCount: number, octreeBlocksSize?: number): void;
  27838. /**
  27839. * Returns a height (y) value in the Worl system :
  27840. * the ground altitude at the coordinates (x, z) expressed in the World system.
  27841. * @param x x coordinate
  27842. * @param z z coordinate
  27843. * @returns the ground y position if (x, z) are outside the ground surface.
  27844. */
  27845. getHeightAtCoordinates(x: number, z: number): number;
  27846. /**
  27847. * Returns a normalized vector (Vector3) orthogonal to the ground
  27848. * at the ground coordinates (x, z) expressed in the World system.
  27849. * @param x x coordinate
  27850. * @param z z coordinate
  27851. * @returns Vector3(0.0, 1.0, 0.0) if (x, z) are outside the ground surface.
  27852. */
  27853. getNormalAtCoordinates(x: number, z: number): Vector3;
  27854. /**
  27855. * Updates the Vector3 passed a reference with a normalized vector orthogonal to the ground
  27856. * at the ground coordinates (x, z) expressed in the World system.
  27857. * Doesn't uptade the reference Vector3 if (x, z) are outside the ground surface.
  27858. * @param x x coordinate
  27859. * @param z z coordinate
  27860. * @param ref vector to store the result
  27861. * @returns the GroundMesh.
  27862. */
  27863. getNormalAtCoordinatesToRef(x: number, z: number, ref: Vector3): GroundMesh;
  27864. /**
  27865. * Force the heights to be recomputed for getHeightAtCoordinates() or getNormalAtCoordinates()
  27866. * if the ground has been updated.
  27867. * This can be used in the render loop.
  27868. * @returns the GroundMesh.
  27869. */
  27870. updateCoordinateHeights(): GroundMesh;
  27871. private _getFacetAt;
  27872. private _initHeightQuads;
  27873. private _computeHeightQuads;
  27874. /**
  27875. * Serializes this ground mesh
  27876. * @param serializationObject object to write serialization to
  27877. */
  27878. serialize(serializationObject: any): void;
  27879. /**
  27880. * Parses a serialized ground mesh
  27881. * @param parsedMesh the serialized mesh
  27882. * @param scene the scene to create the ground mesh in
  27883. * @returns the created ground mesh
  27884. */
  27885. static Parse(parsedMesh: any, scene: Scene): GroundMesh;
  27886. }
  27887. }
  27888. declare module "babylonjs/Physics/physicsJoint" {
  27889. import { Vector3 } from "babylonjs/Maths/math.vector";
  27890. import { IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  27891. /**
  27892. * Interface for Physics-Joint data
  27893. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  27894. */
  27895. export interface PhysicsJointData {
  27896. /**
  27897. * The main pivot of the joint
  27898. */
  27899. mainPivot?: Vector3;
  27900. /**
  27901. * The connected pivot of the joint
  27902. */
  27903. connectedPivot?: Vector3;
  27904. /**
  27905. * The main axis of the joint
  27906. */
  27907. mainAxis?: Vector3;
  27908. /**
  27909. * The connected axis of the joint
  27910. */
  27911. connectedAxis?: Vector3;
  27912. /**
  27913. * The collision of the joint
  27914. */
  27915. collision?: boolean;
  27916. /**
  27917. * Native Oimo/Cannon/Energy data
  27918. */
  27919. nativeParams?: any;
  27920. }
  27921. /**
  27922. * This is a holder class for the physics joint created by the physics plugin
  27923. * It holds a set of functions to control the underlying joint
  27924. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  27925. */
  27926. export class PhysicsJoint {
  27927. /**
  27928. * The type of the physics joint
  27929. */
  27930. type: number;
  27931. /**
  27932. * The data for the physics joint
  27933. */
  27934. jointData: PhysicsJointData;
  27935. private _physicsJoint;
  27936. protected _physicsPlugin: IPhysicsEnginePlugin;
  27937. /**
  27938. * Initializes the physics joint
  27939. * @param type The type of the physics joint
  27940. * @param jointData The data for the physics joint
  27941. */
  27942. constructor(
  27943. /**
  27944. * The type of the physics joint
  27945. */
  27946. type: number,
  27947. /**
  27948. * The data for the physics joint
  27949. */
  27950. jointData: PhysicsJointData);
  27951. /**
  27952. * Gets the physics joint
  27953. */
  27954. get physicsJoint(): any;
  27955. /**
  27956. * Sets the physics joint
  27957. */
  27958. set physicsJoint(newJoint: any);
  27959. /**
  27960. * Sets the physics plugin
  27961. */
  27962. set physicsPlugin(physicsPlugin: IPhysicsEnginePlugin);
  27963. /**
  27964. * Execute a function that is physics-plugin specific.
  27965. * @param {Function} func the function that will be executed.
  27966. * It accepts two parameters: the physics world and the physics joint
  27967. */
  27968. executeNativeFunction(func: (world: any, physicsJoint: any) => void): void;
  27969. /**
  27970. * Distance-Joint type
  27971. */
  27972. static DistanceJoint: number;
  27973. /**
  27974. * Hinge-Joint type
  27975. */
  27976. static HingeJoint: number;
  27977. /**
  27978. * Ball-and-Socket joint type
  27979. */
  27980. static BallAndSocketJoint: number;
  27981. /**
  27982. * Wheel-Joint type
  27983. */
  27984. static WheelJoint: number;
  27985. /**
  27986. * Slider-Joint type
  27987. */
  27988. static SliderJoint: number;
  27989. /**
  27990. * Prismatic-Joint type
  27991. */
  27992. static PrismaticJoint: number;
  27993. /**
  27994. * Universal-Joint type
  27995. * ENERGY FTW! (compare with this - @see http://ode-wiki.org/wiki/index.php?title=Manual:_Joint_Types_and_Functions)
  27996. */
  27997. static UniversalJoint: number;
  27998. /**
  27999. * Hinge-Joint 2 type
  28000. */
  28001. static Hinge2Joint: number;
  28002. /**
  28003. * Point to Point Joint type. Similar to a Ball-Joint. Different in parameters
  28004. */
  28005. static PointToPointJoint: number;
  28006. /**
  28007. * Spring-Joint type
  28008. */
  28009. static SpringJoint: number;
  28010. /**
  28011. * Lock-Joint type
  28012. */
  28013. static LockJoint: number;
  28014. }
  28015. /**
  28016. * A class representing a physics distance joint
  28017. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28018. */
  28019. export class DistanceJoint extends PhysicsJoint {
  28020. /**
  28021. *
  28022. * @param jointData The data for the Distance-Joint
  28023. */
  28024. constructor(jointData: DistanceJointData);
  28025. /**
  28026. * Update the predefined distance.
  28027. * @param maxDistance The maximum preferred distance
  28028. * @param minDistance The minimum preferred distance
  28029. */
  28030. updateDistance(maxDistance: number, minDistance?: number): void;
  28031. }
  28032. /**
  28033. * Represents a Motor-Enabled Joint
  28034. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28035. */
  28036. export class MotorEnabledJoint extends PhysicsJoint implements IMotorEnabledJoint {
  28037. /**
  28038. * Initializes the Motor-Enabled Joint
  28039. * @param type The type of the joint
  28040. * @param jointData The physica joint data for the joint
  28041. */
  28042. constructor(type: number, jointData: PhysicsJointData);
  28043. /**
  28044. * Set the motor values.
  28045. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28046. * @param force the force to apply
  28047. * @param maxForce max force for this motor.
  28048. */
  28049. setMotor(force?: number, maxForce?: number): void;
  28050. /**
  28051. * Set the motor's limits.
  28052. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28053. * @param upperLimit The upper limit of the motor
  28054. * @param lowerLimit The lower limit of the motor
  28055. */
  28056. setLimit(upperLimit: number, lowerLimit?: number): void;
  28057. }
  28058. /**
  28059. * This class represents a single physics Hinge-Joint
  28060. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28061. */
  28062. export class HingeJoint extends MotorEnabledJoint {
  28063. /**
  28064. * Initializes the Hinge-Joint
  28065. * @param jointData The joint data for the Hinge-Joint
  28066. */
  28067. constructor(jointData: PhysicsJointData);
  28068. /**
  28069. * Set the motor values.
  28070. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28071. * @param {number} force the force to apply
  28072. * @param {number} maxForce max force for this motor.
  28073. */
  28074. setMotor(force?: number, maxForce?: number): void;
  28075. /**
  28076. * Set the motor's limits.
  28077. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28078. * @param upperLimit The upper limit of the motor
  28079. * @param lowerLimit The lower limit of the motor
  28080. */
  28081. setLimit(upperLimit: number, lowerLimit?: number): void;
  28082. }
  28083. /**
  28084. * This class represents a dual hinge physics joint (same as wheel joint)
  28085. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28086. */
  28087. export class Hinge2Joint extends MotorEnabledJoint {
  28088. /**
  28089. * Initializes the Hinge2-Joint
  28090. * @param jointData The joint data for the Hinge2-Joint
  28091. */
  28092. constructor(jointData: PhysicsJointData);
  28093. /**
  28094. * Set the motor values.
  28095. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28096. * @param {number} targetSpeed the speed the motor is to reach
  28097. * @param {number} maxForce max force for this motor.
  28098. * @param {motorIndex} the motor's index, 0 or 1.
  28099. */
  28100. setMotor(targetSpeed?: number, maxForce?: number, motorIndex?: number): void;
  28101. /**
  28102. * Set the motor limits.
  28103. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28104. * @param {number} upperLimit the upper limit
  28105. * @param {number} lowerLimit lower limit
  28106. * @param {motorIndex} the motor's index, 0 or 1.
  28107. */
  28108. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  28109. }
  28110. /**
  28111. * Interface for a motor enabled joint
  28112. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28113. */
  28114. export interface IMotorEnabledJoint {
  28115. /**
  28116. * Physics joint
  28117. */
  28118. physicsJoint: any;
  28119. /**
  28120. * Sets the motor of the motor-enabled joint
  28121. * @param force The force of the motor
  28122. * @param maxForce The maximum force of the motor
  28123. * @param motorIndex The index of the motor
  28124. */
  28125. setMotor(force?: number, maxForce?: number, motorIndex?: number): void;
  28126. /**
  28127. * Sets the limit of the motor
  28128. * @param upperLimit The upper limit of the motor
  28129. * @param lowerLimit The lower limit of the motor
  28130. * @param motorIndex The index of the motor
  28131. */
  28132. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  28133. }
  28134. /**
  28135. * Joint data for a Distance-Joint
  28136. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28137. */
  28138. export interface DistanceJointData extends PhysicsJointData {
  28139. /**
  28140. * Max distance the 2 joint objects can be apart
  28141. */
  28142. maxDistance: number;
  28143. }
  28144. /**
  28145. * Joint data from a spring joint
  28146. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28147. */
  28148. export interface SpringJointData extends PhysicsJointData {
  28149. /**
  28150. * Length of the spring
  28151. */
  28152. length: number;
  28153. /**
  28154. * Stiffness of the spring
  28155. */
  28156. stiffness: number;
  28157. /**
  28158. * Damping of the spring
  28159. */
  28160. damping: number;
  28161. /** this callback will be called when applying the force to the impostors. */
  28162. forceApplicationCallback: () => void;
  28163. }
  28164. }
  28165. declare module "babylonjs/Physics/physicsRaycastResult" {
  28166. import { Vector3 } from "babylonjs/Maths/math.vector";
  28167. /**
  28168. * Holds the data for the raycast result
  28169. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28170. */
  28171. export class PhysicsRaycastResult {
  28172. private _hasHit;
  28173. private _hitDistance;
  28174. private _hitNormalWorld;
  28175. private _hitPointWorld;
  28176. private _rayFromWorld;
  28177. private _rayToWorld;
  28178. /**
  28179. * Gets if there was a hit
  28180. */
  28181. get hasHit(): boolean;
  28182. /**
  28183. * Gets the distance from the hit
  28184. */
  28185. get hitDistance(): number;
  28186. /**
  28187. * Gets the hit normal/direction in the world
  28188. */
  28189. get hitNormalWorld(): Vector3;
  28190. /**
  28191. * Gets the hit point in the world
  28192. */
  28193. get hitPointWorld(): Vector3;
  28194. /**
  28195. * Gets the ray "start point" of the ray in the world
  28196. */
  28197. get rayFromWorld(): Vector3;
  28198. /**
  28199. * Gets the ray "end point" of the ray in the world
  28200. */
  28201. get rayToWorld(): Vector3;
  28202. /**
  28203. * Sets the hit data (normal & point in world space)
  28204. * @param hitNormalWorld defines the normal in world space
  28205. * @param hitPointWorld defines the point in world space
  28206. */
  28207. setHitData(hitNormalWorld: IXYZ, hitPointWorld: IXYZ): void;
  28208. /**
  28209. * Sets the distance from the start point to the hit point
  28210. * @param distance
  28211. */
  28212. setHitDistance(distance: number): void;
  28213. /**
  28214. * Calculates the distance manually
  28215. */
  28216. calculateHitDistance(): void;
  28217. /**
  28218. * Resets all the values to default
  28219. * @param from The from point on world space
  28220. * @param to The to point on world space
  28221. */
  28222. reset(from?: Vector3, to?: Vector3): void;
  28223. }
  28224. /**
  28225. * Interface for the size containing width and height
  28226. */
  28227. interface IXYZ {
  28228. /**
  28229. * X
  28230. */
  28231. x: number;
  28232. /**
  28233. * Y
  28234. */
  28235. y: number;
  28236. /**
  28237. * Z
  28238. */
  28239. z: number;
  28240. }
  28241. }
  28242. declare module "babylonjs/Physics/IPhysicsEngine" {
  28243. import { Nullable } from "babylonjs/types";
  28244. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  28245. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  28246. import { PhysicsImpostor, IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  28247. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  28248. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  28249. /**
  28250. * Interface used to describe a physics joint
  28251. */
  28252. export interface PhysicsImpostorJoint {
  28253. /** Defines the main impostor to which the joint is linked */
  28254. mainImpostor: PhysicsImpostor;
  28255. /** Defines the impostor that is connected to the main impostor using this joint */
  28256. connectedImpostor: PhysicsImpostor;
  28257. /** Defines the joint itself */
  28258. joint: PhysicsJoint;
  28259. }
  28260. /** @hidden */
  28261. export interface IPhysicsEnginePlugin {
  28262. world: any;
  28263. name: string;
  28264. setGravity(gravity: Vector3): void;
  28265. setTimeStep(timeStep: number): void;
  28266. getTimeStep(): number;
  28267. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  28268. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  28269. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  28270. generatePhysicsBody(impostor: PhysicsImpostor): void;
  28271. removePhysicsBody(impostor: PhysicsImpostor): void;
  28272. generateJoint(joint: PhysicsImpostorJoint): void;
  28273. removeJoint(joint: PhysicsImpostorJoint): void;
  28274. isSupported(): boolean;
  28275. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  28276. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  28277. setLinearVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  28278. setAngularVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  28279. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  28280. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  28281. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  28282. getBodyMass(impostor: PhysicsImpostor): number;
  28283. getBodyFriction(impostor: PhysicsImpostor): number;
  28284. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  28285. getBodyRestitution(impostor: PhysicsImpostor): number;
  28286. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  28287. getBodyPressure?(impostor: PhysicsImpostor): number;
  28288. setBodyPressure?(impostor: PhysicsImpostor, pressure: number): void;
  28289. getBodyStiffness?(impostor: PhysicsImpostor): number;
  28290. setBodyStiffness?(impostor: PhysicsImpostor, stiffness: number): void;
  28291. getBodyVelocityIterations?(impostor: PhysicsImpostor): number;
  28292. setBodyVelocityIterations?(impostor: PhysicsImpostor, velocityIterations: number): void;
  28293. getBodyPositionIterations?(impostor: PhysicsImpostor): number;
  28294. setBodyPositionIterations?(impostor: PhysicsImpostor, positionIterations: number): void;
  28295. appendAnchor?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  28296. appendHook?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  28297. sleepBody(impostor: PhysicsImpostor): void;
  28298. wakeUpBody(impostor: PhysicsImpostor): void;
  28299. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  28300. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  28301. setMotor(joint: IMotorEnabledJoint, speed: number, maxForce?: number, motorIndex?: number): void;
  28302. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  28303. getRadius(impostor: PhysicsImpostor): number;
  28304. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  28305. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  28306. dispose(): void;
  28307. }
  28308. /**
  28309. * Interface used to define a physics engine
  28310. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28311. */
  28312. export interface IPhysicsEngine {
  28313. /**
  28314. * Gets the gravity vector used by the simulation
  28315. */
  28316. gravity: Vector3;
  28317. /**
  28318. * Sets the gravity vector used by the simulation
  28319. * @param gravity defines the gravity vector to use
  28320. */
  28321. setGravity(gravity: Vector3): void;
  28322. /**
  28323. * Set the time step of the physics engine.
  28324. * Default is 1/60.
  28325. * To slow it down, enter 1/600 for example.
  28326. * To speed it up, 1/30
  28327. * @param newTimeStep the new timestep to apply to this world.
  28328. */
  28329. setTimeStep(newTimeStep: number): void;
  28330. /**
  28331. * Get the time step of the physics engine.
  28332. * @returns the current time step
  28333. */
  28334. getTimeStep(): number;
  28335. /**
  28336. * Set the sub time step of the physics engine.
  28337. * Default is 0 meaning there is no sub steps
  28338. * To increase physics resolution precision, set a small value (like 1 ms)
  28339. * @param subTimeStep defines the new sub timestep used for physics resolution.
  28340. */
  28341. setSubTimeStep(subTimeStep: number): void;
  28342. /**
  28343. * Get the sub time step of the physics engine.
  28344. * @returns the current sub time step
  28345. */
  28346. getSubTimeStep(): number;
  28347. /**
  28348. * Release all resources
  28349. */
  28350. dispose(): void;
  28351. /**
  28352. * Gets the name of the current physics plugin
  28353. * @returns the name of the plugin
  28354. */
  28355. getPhysicsPluginName(): string;
  28356. /**
  28357. * Adding a new impostor for the impostor tracking.
  28358. * This will be done by the impostor itself.
  28359. * @param impostor the impostor to add
  28360. */
  28361. addImpostor(impostor: PhysicsImpostor): void;
  28362. /**
  28363. * Remove an impostor from the engine.
  28364. * This impostor and its mesh will not longer be updated by the physics engine.
  28365. * @param impostor the impostor to remove
  28366. */
  28367. removeImpostor(impostor: PhysicsImpostor): void;
  28368. /**
  28369. * Add a joint to the physics engine
  28370. * @param mainImpostor defines the main impostor to which the joint is added.
  28371. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  28372. * @param joint defines the joint that will connect both impostors.
  28373. */
  28374. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  28375. /**
  28376. * Removes a joint from the simulation
  28377. * @param mainImpostor defines the impostor used with the joint
  28378. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  28379. * @param joint defines the joint to remove
  28380. */
  28381. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  28382. /**
  28383. * Gets the current plugin used to run the simulation
  28384. * @returns current plugin
  28385. */
  28386. getPhysicsPlugin(): IPhysicsEnginePlugin;
  28387. /**
  28388. * Gets the list of physic impostors
  28389. * @returns an array of PhysicsImpostor
  28390. */
  28391. getImpostors(): Array<PhysicsImpostor>;
  28392. /**
  28393. * Gets the impostor for a physics enabled object
  28394. * @param object defines the object impersonated by the impostor
  28395. * @returns the PhysicsImpostor or null if not found
  28396. */
  28397. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  28398. /**
  28399. * Gets the impostor for a physics body object
  28400. * @param body defines physics body used by the impostor
  28401. * @returns the PhysicsImpostor or null if not found
  28402. */
  28403. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  28404. /**
  28405. * Does a raycast in the physics world
  28406. * @param from when should the ray start?
  28407. * @param to when should the ray end?
  28408. * @returns PhysicsRaycastResult
  28409. */
  28410. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  28411. /**
  28412. * Called by the scene. No need to call it.
  28413. * @param delta defines the timespam between frames
  28414. */
  28415. _step(delta: number): void;
  28416. }
  28417. }
  28418. declare module "babylonjs/Physics/physicsImpostor" {
  28419. import { Nullable, IndicesArray } from "babylonjs/types";
  28420. import { Vector3, Matrix, Quaternion } from "babylonjs/Maths/math.vector";
  28421. import { TransformNode } from "babylonjs/Meshes/transformNode";
  28422. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  28423. import { Scene } from "babylonjs/scene";
  28424. import { Bone } from "babylonjs/Bones/bone";
  28425. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  28426. import { PhysicsJoint, PhysicsJointData } from "babylonjs/Physics/physicsJoint";
  28427. import { Space } from "babylonjs/Maths/math.axis";
  28428. /**
  28429. * The interface for the physics imposter parameters
  28430. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28431. */
  28432. export interface PhysicsImpostorParameters {
  28433. /**
  28434. * The mass of the physics imposter
  28435. */
  28436. mass: number;
  28437. /**
  28438. * The friction of the physics imposter
  28439. */
  28440. friction?: number;
  28441. /**
  28442. * The coefficient of restitution of the physics imposter
  28443. */
  28444. restitution?: number;
  28445. /**
  28446. * The native options of the physics imposter
  28447. */
  28448. nativeOptions?: any;
  28449. /**
  28450. * Specifies if the parent should be ignored
  28451. */
  28452. ignoreParent?: boolean;
  28453. /**
  28454. * Specifies if bi-directional transformations should be disabled
  28455. */
  28456. disableBidirectionalTransformation?: boolean;
  28457. /**
  28458. * The pressure inside the physics imposter, soft object only
  28459. */
  28460. pressure?: number;
  28461. /**
  28462. * The stiffness the physics imposter, soft object only
  28463. */
  28464. stiffness?: number;
  28465. /**
  28466. * The number of iterations used in maintaining consistent vertex velocities, soft object only
  28467. */
  28468. velocityIterations?: number;
  28469. /**
  28470. * The number of iterations used in maintaining consistent vertex positions, soft object only
  28471. */
  28472. positionIterations?: number;
  28473. /**
  28474. * The number used to fix points on a cloth (0, 1, 2, 4, 8) or rope (0, 1, 2) only
  28475. * 0 None, 1, back left or top, 2, back right or bottom, 4, front left, 8, front right
  28476. * Add to fix multiple points
  28477. */
  28478. fixedPoints?: number;
  28479. /**
  28480. * The collision margin around a soft object
  28481. */
  28482. margin?: number;
  28483. /**
  28484. * The collision margin around a soft object
  28485. */
  28486. damping?: number;
  28487. /**
  28488. * The path for a rope based on an extrusion
  28489. */
  28490. path?: any;
  28491. /**
  28492. * The shape of an extrusion used for a rope based on an extrusion
  28493. */
  28494. shape?: any;
  28495. }
  28496. /**
  28497. * Interface for a physics-enabled object
  28498. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28499. */
  28500. export interface IPhysicsEnabledObject {
  28501. /**
  28502. * The position of the physics-enabled object
  28503. */
  28504. position: Vector3;
  28505. /**
  28506. * The rotation of the physics-enabled object
  28507. */
  28508. rotationQuaternion: Nullable<Quaternion>;
  28509. /**
  28510. * The scale of the physics-enabled object
  28511. */
  28512. scaling: Vector3;
  28513. /**
  28514. * The rotation of the physics-enabled object
  28515. */
  28516. rotation?: Vector3;
  28517. /**
  28518. * The parent of the physics-enabled object
  28519. */
  28520. parent?: any;
  28521. /**
  28522. * The bounding info of the physics-enabled object
  28523. * @returns The bounding info of the physics-enabled object
  28524. */
  28525. getBoundingInfo(): BoundingInfo;
  28526. /**
  28527. * Computes the world matrix
  28528. * @param force Specifies if the world matrix should be computed by force
  28529. * @returns A world matrix
  28530. */
  28531. computeWorldMatrix(force: boolean): Matrix;
  28532. /**
  28533. * Gets the world matrix
  28534. * @returns A world matrix
  28535. */
  28536. getWorldMatrix?(): Matrix;
  28537. /**
  28538. * Gets the child meshes
  28539. * @param directDescendantsOnly Specifies if only direct-descendants should be obtained
  28540. * @returns An array of abstract meshes
  28541. */
  28542. getChildMeshes?(directDescendantsOnly?: boolean): Array<AbstractMesh>;
  28543. /**
  28544. * Gets the vertex data
  28545. * @param kind The type of vertex data
  28546. * @returns A nullable array of numbers, or a float32 array
  28547. */
  28548. getVerticesData(kind: string): Nullable<Array<number> | Float32Array>;
  28549. /**
  28550. * Gets the indices from the mesh
  28551. * @returns A nullable array of index arrays
  28552. */
  28553. getIndices?(): Nullable<IndicesArray>;
  28554. /**
  28555. * Gets the scene from the mesh
  28556. * @returns the indices array or null
  28557. */
  28558. getScene?(): Scene;
  28559. /**
  28560. * Gets the absolute position from the mesh
  28561. * @returns the absolute position
  28562. */
  28563. getAbsolutePosition(): Vector3;
  28564. /**
  28565. * Gets the absolute pivot point from the mesh
  28566. * @returns the absolute pivot point
  28567. */
  28568. getAbsolutePivotPoint(): Vector3;
  28569. /**
  28570. * Rotates the mesh
  28571. * @param axis The axis of rotation
  28572. * @param amount The amount of rotation
  28573. * @param space The space of the rotation
  28574. * @returns The rotation transform node
  28575. */
  28576. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  28577. /**
  28578. * Translates the mesh
  28579. * @param axis The axis of translation
  28580. * @param distance The distance of translation
  28581. * @param space The space of the translation
  28582. * @returns The transform node
  28583. */
  28584. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  28585. /**
  28586. * Sets the absolute position of the mesh
  28587. * @param absolutePosition The absolute position of the mesh
  28588. * @returns The transform node
  28589. */
  28590. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  28591. /**
  28592. * Gets the class name of the mesh
  28593. * @returns The class name
  28594. */
  28595. getClassName(): string;
  28596. }
  28597. /**
  28598. * Represents a physics imposter
  28599. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28600. */
  28601. export class PhysicsImpostor {
  28602. /**
  28603. * The physics-enabled object used as the physics imposter
  28604. */
  28605. object: IPhysicsEnabledObject;
  28606. /**
  28607. * The type of the physics imposter
  28608. */
  28609. type: number;
  28610. private _options;
  28611. private _scene?;
  28612. /**
  28613. * The default object size of the imposter
  28614. */
  28615. static DEFAULT_OBJECT_SIZE: Vector3;
  28616. /**
  28617. * The identity quaternion of the imposter
  28618. */
  28619. static IDENTITY_QUATERNION: Quaternion;
  28620. /** @hidden */
  28621. _pluginData: any;
  28622. private _physicsEngine;
  28623. private _physicsBody;
  28624. private _bodyUpdateRequired;
  28625. private _onBeforePhysicsStepCallbacks;
  28626. private _onAfterPhysicsStepCallbacks;
  28627. /** @hidden */
  28628. _onPhysicsCollideCallbacks: Array<{
  28629. callback: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void;
  28630. otherImpostors: Array<PhysicsImpostor>;
  28631. }>;
  28632. private _deltaPosition;
  28633. private _deltaRotation;
  28634. private _deltaRotationConjugated;
  28635. /** @hidden */
  28636. _isFromLine: boolean;
  28637. private _parent;
  28638. private _isDisposed;
  28639. private static _tmpVecs;
  28640. private static _tmpQuat;
  28641. /**
  28642. * Specifies if the physics imposter is disposed
  28643. */
  28644. get isDisposed(): boolean;
  28645. /**
  28646. * Gets the mass of the physics imposter
  28647. */
  28648. get mass(): number;
  28649. set mass(value: number);
  28650. /**
  28651. * Gets the coefficient of friction
  28652. */
  28653. get friction(): number;
  28654. /**
  28655. * Sets the coefficient of friction
  28656. */
  28657. set friction(value: number);
  28658. /**
  28659. * Gets the coefficient of restitution
  28660. */
  28661. get restitution(): number;
  28662. /**
  28663. * Sets the coefficient of restitution
  28664. */
  28665. set restitution(value: number);
  28666. /**
  28667. * Gets the pressure of a soft body; only supported by the AmmoJSPlugin
  28668. */
  28669. get pressure(): number;
  28670. /**
  28671. * Sets the pressure of a soft body; only supported by the AmmoJSPlugin
  28672. */
  28673. set pressure(value: number);
  28674. /**
  28675. * Gets the stiffness of a soft body; only supported by the AmmoJSPlugin
  28676. */
  28677. get stiffness(): number;
  28678. /**
  28679. * Sets the stiffness of a soft body; only supported by the AmmoJSPlugin
  28680. */
  28681. set stiffness(value: number);
  28682. /**
  28683. * Gets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  28684. */
  28685. get velocityIterations(): number;
  28686. /**
  28687. * Sets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  28688. */
  28689. set velocityIterations(value: number);
  28690. /**
  28691. * Gets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  28692. */
  28693. get positionIterations(): number;
  28694. /**
  28695. * Sets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  28696. */
  28697. set positionIterations(value: number);
  28698. /**
  28699. * The unique id of the physics imposter
  28700. * set by the physics engine when adding this impostor to the array
  28701. */
  28702. uniqueId: number;
  28703. /**
  28704. * @hidden
  28705. */
  28706. soft: boolean;
  28707. /**
  28708. * @hidden
  28709. */
  28710. segments: number;
  28711. private _joints;
  28712. /**
  28713. * Initializes the physics imposter
  28714. * @param object The physics-enabled object used as the physics imposter
  28715. * @param type The type of the physics imposter
  28716. * @param _options The options for the physics imposter
  28717. * @param _scene The Babylon scene
  28718. */
  28719. constructor(
  28720. /**
  28721. * The physics-enabled object used as the physics imposter
  28722. */
  28723. object: IPhysicsEnabledObject,
  28724. /**
  28725. * The type of the physics imposter
  28726. */
  28727. type: number, _options?: PhysicsImpostorParameters, _scene?: Scene | undefined);
  28728. /**
  28729. * This function will completly initialize this impostor.
  28730. * It will create a new body - but only if this mesh has no parent.
  28731. * If it has, this impostor will not be used other than to define the impostor
  28732. * of the child mesh.
  28733. * @hidden
  28734. */
  28735. _init(): void;
  28736. private _getPhysicsParent;
  28737. /**
  28738. * Should a new body be generated.
  28739. * @returns boolean specifying if body initialization is required
  28740. */
  28741. isBodyInitRequired(): boolean;
  28742. /**
  28743. * Sets the updated scaling
  28744. * @param updated Specifies if the scaling is updated
  28745. */
  28746. setScalingUpdated(): void;
  28747. /**
  28748. * Force a regeneration of this or the parent's impostor's body.
  28749. * Use under cautious - This will remove all joints already implemented.
  28750. */
  28751. forceUpdate(): void;
  28752. /**
  28753. * Gets the body that holds this impostor. Either its own, or its parent.
  28754. */
  28755. get physicsBody(): any;
  28756. /**
  28757. * Get the parent of the physics imposter
  28758. * @returns Physics imposter or null
  28759. */
  28760. get parent(): Nullable<PhysicsImpostor>;
  28761. /**
  28762. * Sets the parent of the physics imposter
  28763. */
  28764. set parent(value: Nullable<PhysicsImpostor>);
  28765. /**
  28766. * Set the physics body. Used mainly by the physics engine/plugin
  28767. */
  28768. set physicsBody(physicsBody: any);
  28769. /**
  28770. * Resets the update flags
  28771. */
  28772. resetUpdateFlags(): void;
  28773. /**
  28774. * Gets the object extend size
  28775. * @returns the object extend size
  28776. */
  28777. getObjectExtendSize(): Vector3;
  28778. /**
  28779. * Gets the object center
  28780. * @returns The object center
  28781. */
  28782. getObjectCenter(): Vector3;
  28783. /**
  28784. * Get a specific parameter from the options parameters
  28785. * @param paramName The object parameter name
  28786. * @returns The object parameter
  28787. */
  28788. getParam(paramName: string): any;
  28789. /**
  28790. * Sets a specific parameter in the options given to the physics plugin
  28791. * @param paramName The parameter name
  28792. * @param value The value of the parameter
  28793. */
  28794. setParam(paramName: string, value: number): void;
  28795. /**
  28796. * Specifically change the body's mass option. Won't recreate the physics body object
  28797. * @param mass The mass of the physics imposter
  28798. */
  28799. setMass(mass: number): void;
  28800. /**
  28801. * Gets the linear velocity
  28802. * @returns linear velocity or null
  28803. */
  28804. getLinearVelocity(): Nullable<Vector3>;
  28805. /**
  28806. * Sets the linear velocity
  28807. * @param velocity linear velocity or null
  28808. */
  28809. setLinearVelocity(velocity: Nullable<Vector3>): void;
  28810. /**
  28811. * Gets the angular velocity
  28812. * @returns angular velocity or null
  28813. */
  28814. getAngularVelocity(): Nullable<Vector3>;
  28815. /**
  28816. * Sets the angular velocity
  28817. * @param velocity The velocity or null
  28818. */
  28819. setAngularVelocity(velocity: Nullable<Vector3>): void;
  28820. /**
  28821. * Execute a function with the physics plugin native code
  28822. * Provide a function the will have two variables - the world object and the physics body object
  28823. * @param func The function to execute with the physics plugin native code
  28824. */
  28825. executeNativeFunction(func: (world: any, physicsBody: any) => void): void;
  28826. /**
  28827. * Register a function that will be executed before the physics world is stepping forward
  28828. * @param func The function to execute before the physics world is stepped forward
  28829. */
  28830. registerBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  28831. /**
  28832. * Unregister a function that will be executed before the physics world is stepping forward
  28833. * @param func The function to execute before the physics world is stepped forward
  28834. */
  28835. unregisterBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  28836. /**
  28837. * Register a function that will be executed after the physics step
  28838. * @param func The function to execute after physics step
  28839. */
  28840. registerAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  28841. /**
  28842. * Unregisters a function that will be executed after the physics step
  28843. * @param func The function to execute after physics step
  28844. */
  28845. unregisterAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  28846. /**
  28847. * register a function that will be executed when this impostor collides against a different body
  28848. * @param collideAgainst Physics imposter, or array of physics imposters to collide against
  28849. * @param func Callback that is executed on collision
  28850. */
  28851. registerOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void): void;
  28852. /**
  28853. * Unregisters the physics imposter on contact
  28854. * @param collideAgainst The physics object to collide against
  28855. * @param func Callback to execute on collision
  28856. */
  28857. unregisterOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor | Array<PhysicsImpostor>) => void): void;
  28858. private _tmpQuat;
  28859. private _tmpQuat2;
  28860. /**
  28861. * Get the parent rotation
  28862. * @returns The parent rotation
  28863. */
  28864. getParentsRotation(): Quaternion;
  28865. /**
  28866. * this function is executed by the physics engine.
  28867. */
  28868. beforeStep: () => void;
  28869. /**
  28870. * this function is executed by the physics engine
  28871. */
  28872. afterStep: () => void;
  28873. /**
  28874. * Legacy collision detection event support
  28875. */
  28876. onCollideEvent: Nullable<(collider: PhysicsImpostor, collidedWith: PhysicsImpostor) => void>;
  28877. /**
  28878. * event and body object due to cannon's event-based architecture.
  28879. */
  28880. onCollide: (e: {
  28881. body: any;
  28882. }) => void;
  28883. /**
  28884. * Apply a force
  28885. * @param force The force to apply
  28886. * @param contactPoint The contact point for the force
  28887. * @returns The physics imposter
  28888. */
  28889. applyForce(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  28890. /**
  28891. * Apply an impulse
  28892. * @param force The impulse force
  28893. * @param contactPoint The contact point for the impulse force
  28894. * @returns The physics imposter
  28895. */
  28896. applyImpulse(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  28897. /**
  28898. * A help function to create a joint
  28899. * @param otherImpostor A physics imposter used to create a joint
  28900. * @param jointType The type of joint
  28901. * @param jointData The data for the joint
  28902. * @returns The physics imposter
  28903. */
  28904. createJoint(otherImpostor: PhysicsImpostor, jointType: number, jointData: PhysicsJointData): PhysicsImpostor;
  28905. /**
  28906. * Add a joint to this impostor with a different impostor
  28907. * @param otherImpostor A physics imposter used to add a joint
  28908. * @param joint The joint to add
  28909. * @returns The physics imposter
  28910. */
  28911. addJoint(otherImpostor: PhysicsImpostor, joint: PhysicsJoint): PhysicsImpostor;
  28912. /**
  28913. * Add an anchor to a cloth impostor
  28914. * @param otherImpostor rigid impostor to anchor to
  28915. * @param width ratio across width from 0 to 1
  28916. * @param height ratio up height from 0 to 1
  28917. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  28918. * @param noCollisionBetweenLinkedBodies when true collisions between cloth impostor and anchor are ignored; default false
  28919. * @returns impostor the soft imposter
  28920. */
  28921. addAnchor(otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  28922. /**
  28923. * Add a hook to a rope impostor
  28924. * @param otherImpostor rigid impostor to anchor to
  28925. * @param length ratio across rope from 0 to 1
  28926. * @param influence the elasticity between rope impostor and anchor from 0, very stretchy to 1, little strech
  28927. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  28928. * @returns impostor the rope imposter
  28929. */
  28930. addHook(otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  28931. /**
  28932. * Will keep this body still, in a sleep mode.
  28933. * @returns the physics imposter
  28934. */
  28935. sleep(): PhysicsImpostor;
  28936. /**
  28937. * Wake the body up.
  28938. * @returns The physics imposter
  28939. */
  28940. wakeUp(): PhysicsImpostor;
  28941. /**
  28942. * Clones the physics imposter
  28943. * @param newObject The physics imposter clones to this physics-enabled object
  28944. * @returns A nullable physics imposter
  28945. */
  28946. clone(newObject: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  28947. /**
  28948. * Disposes the physics imposter
  28949. */
  28950. dispose(): void;
  28951. /**
  28952. * Sets the delta position
  28953. * @param position The delta position amount
  28954. */
  28955. setDeltaPosition(position: Vector3): void;
  28956. /**
  28957. * Sets the delta rotation
  28958. * @param rotation The delta rotation amount
  28959. */
  28960. setDeltaRotation(rotation: Quaternion): void;
  28961. /**
  28962. * Gets the box size of the physics imposter and stores the result in the input parameter
  28963. * @param result Stores the box size
  28964. * @returns The physics imposter
  28965. */
  28966. getBoxSizeToRef(result: Vector3): PhysicsImpostor;
  28967. /**
  28968. * Gets the radius of the physics imposter
  28969. * @returns Radius of the physics imposter
  28970. */
  28971. getRadius(): number;
  28972. /**
  28973. * Sync a bone with this impostor
  28974. * @param bone The bone to sync to the impostor.
  28975. * @param boneMesh The mesh that the bone is influencing.
  28976. * @param jointPivot The pivot of the joint / bone in local space.
  28977. * @param distToJoint Optional distance from the impostor to the joint.
  28978. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  28979. */
  28980. syncBoneWithImpostor(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion): void;
  28981. /**
  28982. * Sync impostor to a bone
  28983. * @param bone The bone that the impostor will be synced to.
  28984. * @param boneMesh The mesh that the bone is influencing.
  28985. * @param jointPivot The pivot of the joint / bone in local space.
  28986. * @param distToJoint Optional distance from the impostor to the joint.
  28987. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  28988. * @param boneAxis Optional vector3 axis the bone is aligned with
  28989. */
  28990. syncImpostorWithBone(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion, boneAxis?: Vector3): void;
  28991. /**
  28992. * No-Imposter type
  28993. */
  28994. static NoImpostor: number;
  28995. /**
  28996. * Sphere-Imposter type
  28997. */
  28998. static SphereImpostor: number;
  28999. /**
  29000. * Box-Imposter type
  29001. */
  29002. static BoxImpostor: number;
  29003. /**
  29004. * Plane-Imposter type
  29005. */
  29006. static PlaneImpostor: number;
  29007. /**
  29008. * Mesh-imposter type
  29009. */
  29010. static MeshImpostor: number;
  29011. /**
  29012. * Capsule-Impostor type (Ammo.js plugin only)
  29013. */
  29014. static CapsuleImpostor: number;
  29015. /**
  29016. * Cylinder-Imposter type
  29017. */
  29018. static CylinderImpostor: number;
  29019. /**
  29020. * Particle-Imposter type
  29021. */
  29022. static ParticleImpostor: number;
  29023. /**
  29024. * Heightmap-Imposter type
  29025. */
  29026. static HeightmapImpostor: number;
  29027. /**
  29028. * ConvexHull-Impostor type (Ammo.js plugin only)
  29029. */
  29030. static ConvexHullImpostor: number;
  29031. /**
  29032. * Custom-Imposter type (Ammo.js plugin only)
  29033. */
  29034. static CustomImpostor: number;
  29035. /**
  29036. * Rope-Imposter type
  29037. */
  29038. static RopeImpostor: number;
  29039. /**
  29040. * Cloth-Imposter type
  29041. */
  29042. static ClothImpostor: number;
  29043. /**
  29044. * Softbody-Imposter type
  29045. */
  29046. static SoftbodyImpostor: number;
  29047. }
  29048. }
  29049. declare module "babylonjs/Meshes/mesh" {
  29050. import { Observable } from "babylonjs/Misc/observable";
  29051. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  29052. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  29053. import { Camera } from "babylonjs/Cameras/camera";
  29054. import { Scene } from "babylonjs/scene";
  29055. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  29056. import { Color4 } from "babylonjs/Maths/math.color";
  29057. import { Engine } from "babylonjs/Engines/engine";
  29058. import { Node } from "babylonjs/node";
  29059. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  29060. import { IGetSetVerticesData } from "babylonjs/Meshes/mesh.vertexData";
  29061. import { Buffer } from "babylonjs/Meshes/buffer";
  29062. import { Geometry } from "babylonjs/Meshes/geometry";
  29063. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  29064. import { SubMesh } from "babylonjs/Meshes/subMesh";
  29065. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  29066. import { Effect } from "babylonjs/Materials/effect";
  29067. import { Material } from "babylonjs/Materials/material";
  29068. import { Skeleton } from "babylonjs/Bones/skeleton";
  29069. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  29070. import { MeshLODLevel } from "babylonjs/Meshes/meshLODLevel";
  29071. import { Path3D } from "babylonjs/Maths/math.path";
  29072. import { Plane } from "babylonjs/Maths/math.plane";
  29073. import { TransformNode } from "babylonjs/Meshes/transformNode";
  29074. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  29075. import { InstancedMesh } from "babylonjs/Meshes/instancedMesh";
  29076. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  29077. import { IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  29078. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  29079. /**
  29080. * @hidden
  29081. **/
  29082. export class _CreationDataStorage {
  29083. closePath?: boolean;
  29084. closeArray?: boolean;
  29085. idx: number[];
  29086. dashSize: number;
  29087. gapSize: number;
  29088. path3D: Path3D;
  29089. pathArray: Vector3[][];
  29090. arc: number;
  29091. radius: number;
  29092. cap: number;
  29093. tessellation: number;
  29094. }
  29095. /**
  29096. * @hidden
  29097. **/
  29098. class _InstanceDataStorage {
  29099. visibleInstances: any;
  29100. batchCache: _InstancesBatch;
  29101. instancesBufferSize: number;
  29102. instancesBuffer: Nullable<Buffer>;
  29103. instancesData: Float32Array;
  29104. overridenInstanceCount: number;
  29105. isFrozen: boolean;
  29106. previousBatch: Nullable<_InstancesBatch>;
  29107. hardwareInstancedRendering: boolean;
  29108. sideOrientation: number;
  29109. manualUpdate: boolean;
  29110. }
  29111. /**
  29112. * @hidden
  29113. **/
  29114. export class _InstancesBatch {
  29115. mustReturn: boolean;
  29116. visibleInstances: Nullable<import("babylonjs/Meshes/instancedMesh").InstancedMesh[]>[];
  29117. renderSelf: boolean[];
  29118. hardwareInstancedRendering: boolean[];
  29119. }
  29120. /**
  29121. * @hidden
  29122. **/
  29123. class _ThinInstanceDataStorage {
  29124. instancesCount: number;
  29125. matrixBuffer: Nullable<Buffer>;
  29126. matrixBufferSize: number;
  29127. matrixData: Nullable<Float32Array>;
  29128. boundingVectors: Array<Vector3>;
  29129. worldMatrices: Nullable<Matrix[]>;
  29130. }
  29131. /**
  29132. * Class used to represent renderable models
  29133. */
  29134. export class Mesh extends AbstractMesh implements IGetSetVerticesData {
  29135. /**
  29136. * Mesh side orientation : usually the external or front surface
  29137. */
  29138. static readonly FRONTSIDE: number;
  29139. /**
  29140. * Mesh side orientation : usually the internal or back surface
  29141. */
  29142. static readonly BACKSIDE: number;
  29143. /**
  29144. * Mesh side orientation : both internal and external or front and back surfaces
  29145. */
  29146. static readonly DOUBLESIDE: number;
  29147. /**
  29148. * Mesh side orientation : by default, `FRONTSIDE`
  29149. */
  29150. static readonly DEFAULTSIDE: number;
  29151. /**
  29152. * Mesh cap setting : no cap
  29153. */
  29154. static readonly NO_CAP: number;
  29155. /**
  29156. * Mesh cap setting : one cap at the beginning of the mesh
  29157. */
  29158. static readonly CAP_START: number;
  29159. /**
  29160. * Mesh cap setting : one cap at the end of the mesh
  29161. */
  29162. static readonly CAP_END: number;
  29163. /**
  29164. * Mesh cap setting : two caps, one at the beginning and one at the end of the mesh
  29165. */
  29166. static readonly CAP_ALL: number;
  29167. /**
  29168. * Mesh pattern setting : no flip or rotate
  29169. */
  29170. static readonly NO_FLIP: number;
  29171. /**
  29172. * Mesh pattern setting : flip (reflect in y axis) alternate tiles on each row or column
  29173. */
  29174. static readonly FLIP_TILE: number;
  29175. /**
  29176. * Mesh pattern setting : rotate (180degs) alternate tiles on each row or column
  29177. */
  29178. static readonly ROTATE_TILE: number;
  29179. /**
  29180. * Mesh pattern setting : flip (reflect in y axis) all tiles on alternate rows
  29181. */
  29182. static readonly FLIP_ROW: number;
  29183. /**
  29184. * Mesh pattern setting : rotate (180degs) all tiles on alternate rows
  29185. */
  29186. static readonly ROTATE_ROW: number;
  29187. /**
  29188. * Mesh pattern setting : flip and rotate alternate tiles on each row or column
  29189. */
  29190. static readonly FLIP_N_ROTATE_TILE: number;
  29191. /**
  29192. * Mesh pattern setting : rotate pattern and rotate
  29193. */
  29194. static readonly FLIP_N_ROTATE_ROW: number;
  29195. /**
  29196. * Mesh tile positioning : part tiles same on left/right or top/bottom
  29197. */
  29198. static readonly CENTER: number;
  29199. /**
  29200. * Mesh tile positioning : part tiles on left
  29201. */
  29202. static readonly LEFT: number;
  29203. /**
  29204. * Mesh tile positioning : part tiles on right
  29205. */
  29206. static readonly RIGHT: number;
  29207. /**
  29208. * Mesh tile positioning : part tiles on top
  29209. */
  29210. static readonly TOP: number;
  29211. /**
  29212. * Mesh tile positioning : part tiles on bottom
  29213. */
  29214. static readonly BOTTOM: number;
  29215. /**
  29216. * Gets the default side orientation.
  29217. * @param orientation the orientation to value to attempt to get
  29218. * @returns the default orientation
  29219. * @hidden
  29220. */
  29221. static _GetDefaultSideOrientation(orientation?: number): number;
  29222. private _internalMeshDataInfo;
  29223. get computeBonesUsingShaders(): boolean;
  29224. set computeBonesUsingShaders(value: boolean);
  29225. /**
  29226. * An event triggered before rendering the mesh
  29227. */
  29228. get onBeforeRenderObservable(): Observable<Mesh>;
  29229. /**
  29230. * An event triggered before binding the mesh
  29231. */
  29232. get onBeforeBindObservable(): Observable<Mesh>;
  29233. /**
  29234. * An event triggered after rendering the mesh
  29235. */
  29236. get onAfterRenderObservable(): Observable<Mesh>;
  29237. /**
  29238. * An event triggered before drawing the mesh
  29239. */
  29240. get onBeforeDrawObservable(): Observable<Mesh>;
  29241. private _onBeforeDrawObserver;
  29242. /**
  29243. * Sets a callback to call before drawing the mesh. It is recommended to use onBeforeDrawObservable instead
  29244. */
  29245. set onBeforeDraw(callback: () => void);
  29246. get hasInstances(): boolean;
  29247. get hasThinInstances(): boolean;
  29248. /**
  29249. * Gets the delay loading state of the mesh (when delay loading is turned on)
  29250. * @see https://doc.babylonjs.com/how_to/using_the_incremental_loading_system
  29251. */
  29252. delayLoadState: number;
  29253. /**
  29254. * Gets the list of instances created from this mesh
  29255. * it is not supposed to be modified manually.
  29256. * Note also that the order of the InstancedMesh wihin the array is not significant and might change.
  29257. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  29258. */
  29259. instances: import("babylonjs/Meshes/instancedMesh").InstancedMesh[];
  29260. /**
  29261. * Gets the file containing delay loading data for this mesh
  29262. */
  29263. delayLoadingFile: string;
  29264. /** @hidden */
  29265. _binaryInfo: any;
  29266. /**
  29267. * User defined function used to change how LOD level selection is done
  29268. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29269. */
  29270. onLODLevelSelection: (distance: number, mesh: Mesh, selectedLevel: Nullable<Mesh>) => void;
  29271. /**
  29272. * Gets or sets the morph target manager
  29273. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  29274. */
  29275. get morphTargetManager(): Nullable<MorphTargetManager>;
  29276. set morphTargetManager(value: Nullable<MorphTargetManager>);
  29277. /** @hidden */
  29278. _creationDataStorage: Nullable<_CreationDataStorage>;
  29279. /** @hidden */
  29280. _geometry: Nullable<Geometry>;
  29281. /** @hidden */
  29282. _delayInfo: Array<string>;
  29283. /** @hidden */
  29284. _delayLoadingFunction: (any: any, mesh: Mesh) => void;
  29285. /** @hidden */
  29286. _instanceDataStorage: _InstanceDataStorage;
  29287. /** @hidden */
  29288. _thinInstanceDataStorage: _ThinInstanceDataStorage;
  29289. private _effectiveMaterial;
  29290. /** @hidden */
  29291. _shouldGenerateFlatShading: boolean;
  29292. /** @hidden */
  29293. _originalBuilderSideOrientation: number;
  29294. /**
  29295. * Use this property to change the original side orientation defined at construction time
  29296. */
  29297. overrideMaterialSideOrientation: Nullable<number>;
  29298. /**
  29299. * Gets the source mesh (the one used to clone this one from)
  29300. */
  29301. get source(): Nullable<Mesh>;
  29302. /**
  29303. * Gets the list of clones of this mesh
  29304. * The scene must have been constructed with useClonedMeshMap=true for this to work!
  29305. * Note that useClonedMeshMap=true is the default setting
  29306. */
  29307. get cloneMeshMap(): Nullable<{
  29308. [id: string]: Mesh | undefined;
  29309. }>;
  29310. /**
  29311. * Gets or sets a boolean indicating that this mesh does not use index buffer
  29312. */
  29313. get isUnIndexed(): boolean;
  29314. set isUnIndexed(value: boolean);
  29315. /** Gets the array buffer used to store the instanced buffer used for instances' world matrices */
  29316. get worldMatrixInstancedBuffer(): Float32Array;
  29317. /** Gets or sets a boolean indicating that the update of the instance buffer of the world matrices is manual */
  29318. get manualUpdateOfWorldMatrixInstancedBuffer(): boolean;
  29319. set manualUpdateOfWorldMatrixInstancedBuffer(value: boolean);
  29320. /**
  29321. * @constructor
  29322. * @param name The value used by scene.getMeshByName() to do a lookup.
  29323. * @param scene The scene to add this mesh to.
  29324. * @param parent The parent of this mesh, if it has one
  29325. * @param source An optional Mesh from which geometry is shared, cloned.
  29326. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  29327. * When false, achieved by calling a clone(), also passing False.
  29328. * This will make creation of children, recursive.
  29329. * @param clonePhysicsImpostor When cloning, include cloning mesh physics impostor, default True.
  29330. */
  29331. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<Mesh>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean);
  29332. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  29333. doNotInstantiate: boolean;
  29334. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  29335. /**
  29336. * Gets the class name
  29337. * @returns the string "Mesh".
  29338. */
  29339. getClassName(): string;
  29340. /** @hidden */
  29341. get _isMesh(): boolean;
  29342. /**
  29343. * Returns a description of this mesh
  29344. * @param fullDetails define if full details about this mesh must be used
  29345. * @returns a descriptive string representing this mesh
  29346. */
  29347. toString(fullDetails?: boolean): string;
  29348. /** @hidden */
  29349. _unBindEffect(): void;
  29350. /**
  29351. * Gets a boolean indicating if this mesh has LOD
  29352. */
  29353. get hasLODLevels(): boolean;
  29354. /**
  29355. * Gets the list of MeshLODLevel associated with the current mesh
  29356. * @returns an array of MeshLODLevel
  29357. */
  29358. getLODLevels(): MeshLODLevel[];
  29359. private _sortLODLevels;
  29360. /**
  29361. * Add a mesh as LOD level triggered at the given distance.
  29362. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29363. * @param distance The distance from the center of the object to show this level
  29364. * @param mesh The mesh to be added as LOD level (can be null)
  29365. * @return This mesh (for chaining)
  29366. */
  29367. addLODLevel(distance: number, mesh: Nullable<Mesh>): Mesh;
  29368. /**
  29369. * Returns the LOD level mesh at the passed distance or null if not found.
  29370. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29371. * @param distance The distance from the center of the object to show this level
  29372. * @returns a Mesh or `null`
  29373. */
  29374. getLODLevelAtDistance(distance: number): Nullable<Mesh>;
  29375. /**
  29376. * Remove a mesh from the LOD array
  29377. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29378. * @param mesh defines the mesh to be removed
  29379. * @return This mesh (for chaining)
  29380. */
  29381. removeLODLevel(mesh: Mesh): Mesh;
  29382. /**
  29383. * Returns the registered LOD mesh distant from the parameter `camera` position if any, else returns the current mesh.
  29384. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29385. * @param camera defines the camera to use to compute distance
  29386. * @param boundingSphere defines a custom bounding sphere to use instead of the one from this mesh
  29387. * @return This mesh (for chaining)
  29388. */
  29389. getLOD(camera: Camera, boundingSphere?: BoundingSphere): Nullable<AbstractMesh>;
  29390. /**
  29391. * Gets the mesh internal Geometry object
  29392. */
  29393. get geometry(): Nullable<Geometry>;
  29394. /**
  29395. * Returns the total number of vertices within the mesh geometry or zero if the mesh has no geometry.
  29396. * @returns the total number of vertices
  29397. */
  29398. getTotalVertices(): number;
  29399. /**
  29400. * Returns the content of an associated vertex buffer
  29401. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  29402. * - VertexBuffer.PositionKind
  29403. * - VertexBuffer.UVKind
  29404. * - VertexBuffer.UV2Kind
  29405. * - VertexBuffer.UV3Kind
  29406. * - VertexBuffer.UV4Kind
  29407. * - VertexBuffer.UV5Kind
  29408. * - VertexBuffer.UV6Kind
  29409. * - VertexBuffer.ColorKind
  29410. * - VertexBuffer.MatricesIndicesKind
  29411. * - VertexBuffer.MatricesIndicesExtraKind
  29412. * - VertexBuffer.MatricesWeightsKind
  29413. * - VertexBuffer.MatricesWeightsExtraKind
  29414. * @param copyWhenShared defines a boolean indicating that if the mesh geometry is shared among some other meshes, the returned array is a copy of the internal one
  29415. * @param forceCopy defines a boolean forcing the copy of the buffer no matter what the value of copyWhenShared is
  29416. * @returns a FloatArray or null if the mesh has no geometry or no vertex buffer for this kind.
  29417. */
  29418. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  29419. /**
  29420. * Returns the mesh VertexBuffer object from the requested `kind`
  29421. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  29422. * - VertexBuffer.PositionKind
  29423. * - VertexBuffer.NormalKind
  29424. * - VertexBuffer.UVKind
  29425. * - VertexBuffer.UV2Kind
  29426. * - VertexBuffer.UV3Kind
  29427. * - VertexBuffer.UV4Kind
  29428. * - VertexBuffer.UV5Kind
  29429. * - VertexBuffer.UV6Kind
  29430. * - VertexBuffer.ColorKind
  29431. * - VertexBuffer.MatricesIndicesKind
  29432. * - VertexBuffer.MatricesIndicesExtraKind
  29433. * - VertexBuffer.MatricesWeightsKind
  29434. * - VertexBuffer.MatricesWeightsExtraKind
  29435. * @returns a FloatArray or null if the mesh has no vertex buffer for this kind.
  29436. */
  29437. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  29438. /**
  29439. * Tests if a specific vertex buffer is associated with this mesh
  29440. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  29441. * - VertexBuffer.PositionKind
  29442. * - VertexBuffer.NormalKind
  29443. * - VertexBuffer.UVKind
  29444. * - VertexBuffer.UV2Kind
  29445. * - VertexBuffer.UV3Kind
  29446. * - VertexBuffer.UV4Kind
  29447. * - VertexBuffer.UV5Kind
  29448. * - VertexBuffer.UV6Kind
  29449. * - VertexBuffer.ColorKind
  29450. * - VertexBuffer.MatricesIndicesKind
  29451. * - VertexBuffer.MatricesIndicesExtraKind
  29452. * - VertexBuffer.MatricesWeightsKind
  29453. * - VertexBuffer.MatricesWeightsExtraKind
  29454. * @returns a boolean
  29455. */
  29456. isVerticesDataPresent(kind: string): boolean;
  29457. /**
  29458. * Returns a boolean defining if the vertex data for the requested `kind` is updatable.
  29459. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  29460. * - VertexBuffer.PositionKind
  29461. * - VertexBuffer.UVKind
  29462. * - VertexBuffer.UV2Kind
  29463. * - VertexBuffer.UV3Kind
  29464. * - VertexBuffer.UV4Kind
  29465. * - VertexBuffer.UV5Kind
  29466. * - VertexBuffer.UV6Kind
  29467. * - VertexBuffer.ColorKind
  29468. * - VertexBuffer.MatricesIndicesKind
  29469. * - VertexBuffer.MatricesIndicesExtraKind
  29470. * - VertexBuffer.MatricesWeightsKind
  29471. * - VertexBuffer.MatricesWeightsExtraKind
  29472. * @returns a boolean
  29473. */
  29474. isVertexBufferUpdatable(kind: string): boolean;
  29475. /**
  29476. * Returns a string which contains the list of existing `kinds` of Vertex Data associated with this mesh.
  29477. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  29478. * - VertexBuffer.PositionKind
  29479. * - VertexBuffer.NormalKind
  29480. * - VertexBuffer.UVKind
  29481. * - VertexBuffer.UV2Kind
  29482. * - VertexBuffer.UV3Kind
  29483. * - VertexBuffer.UV4Kind
  29484. * - VertexBuffer.UV5Kind
  29485. * - VertexBuffer.UV6Kind
  29486. * - VertexBuffer.ColorKind
  29487. * - VertexBuffer.MatricesIndicesKind
  29488. * - VertexBuffer.MatricesIndicesExtraKind
  29489. * - VertexBuffer.MatricesWeightsKind
  29490. * - VertexBuffer.MatricesWeightsExtraKind
  29491. * @returns an array of strings
  29492. */
  29493. getVerticesDataKinds(): string[];
  29494. /**
  29495. * Returns a positive integer : the total number of indices in this mesh geometry.
  29496. * @returns the numner of indices or zero if the mesh has no geometry.
  29497. */
  29498. getTotalIndices(): number;
  29499. /**
  29500. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  29501. * @param copyWhenShared If true (default false) and and if the mesh geometry is shared among some other meshes, the returned array is a copy of the internal one.
  29502. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  29503. * @returns the indices array or an empty array if the mesh has no geometry
  29504. */
  29505. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  29506. get isBlocked(): boolean;
  29507. /**
  29508. * Determine if the current mesh is ready to be rendered
  29509. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  29510. * @param forceInstanceSupport will check if the mesh will be ready when used with instances (false by default)
  29511. * @returns true if all associated assets are ready (material, textures, shaders)
  29512. */
  29513. isReady(completeCheck?: boolean, forceInstanceSupport?: boolean): boolean;
  29514. /**
  29515. * Gets a boolean indicating if the normals aren't to be recomputed on next mesh `positions` array update. This property is pertinent only for updatable parametric shapes.
  29516. */
  29517. get areNormalsFrozen(): boolean;
  29518. /**
  29519. * This function affects parametric shapes on vertex position update only : ribbons, tubes, etc. It has no effect at all on other shapes. It prevents the mesh normals from being recomputed on next `positions` array update.
  29520. * @returns the current mesh
  29521. */
  29522. freezeNormals(): Mesh;
  29523. /**
  29524. * This function affects parametric shapes on vertex position update only : ribbons, tubes, etc. It has no effect at all on other shapes. It reactivates the mesh normals computation if it was previously frozen
  29525. * @returns the current mesh
  29526. */
  29527. unfreezeNormals(): Mesh;
  29528. /**
  29529. * Sets a value overriding the instance count. Only applicable when custom instanced InterleavedVertexBuffer are used rather than InstancedMeshs
  29530. */
  29531. set overridenInstanceCount(count: number);
  29532. /** @hidden */
  29533. _preActivate(): Mesh;
  29534. /** @hidden */
  29535. _preActivateForIntermediateRendering(renderId: number): Mesh;
  29536. /** @hidden */
  29537. _registerInstanceForRenderId(instance: InstancedMesh, renderId: number): Mesh;
  29538. protected _afterComputeWorldMatrix(): void;
  29539. /** @hidden */
  29540. _postActivate(): void;
  29541. /**
  29542. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  29543. * This means the mesh underlying bounding box and sphere are recomputed.
  29544. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  29545. * @returns the current mesh
  29546. */
  29547. refreshBoundingInfo(applySkeleton?: boolean): Mesh;
  29548. /** @hidden */
  29549. _createGlobalSubMesh(force: boolean): Nullable<SubMesh>;
  29550. /**
  29551. * This function will subdivide the mesh into multiple submeshes
  29552. * @param count defines the expected number of submeshes
  29553. */
  29554. subdivide(count: number): void;
  29555. /**
  29556. * Copy a FloatArray into a specific associated vertex buffer
  29557. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  29558. * - VertexBuffer.PositionKind
  29559. * - VertexBuffer.UVKind
  29560. * - VertexBuffer.UV2Kind
  29561. * - VertexBuffer.UV3Kind
  29562. * - VertexBuffer.UV4Kind
  29563. * - VertexBuffer.UV5Kind
  29564. * - VertexBuffer.UV6Kind
  29565. * - VertexBuffer.ColorKind
  29566. * - VertexBuffer.MatricesIndicesKind
  29567. * - VertexBuffer.MatricesIndicesExtraKind
  29568. * - VertexBuffer.MatricesWeightsKind
  29569. * - VertexBuffer.MatricesWeightsExtraKind
  29570. * @param data defines the data source
  29571. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  29572. * @param stride defines the data stride size (can be null)
  29573. * @returns the current mesh
  29574. */
  29575. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  29576. /**
  29577. * Delete a vertex buffer associated with this mesh
  29578. * @param kind defines which buffer to delete (positions, indices, normals, etc). Possible `kind` values :
  29579. * - VertexBuffer.PositionKind
  29580. * - VertexBuffer.UVKind
  29581. * - VertexBuffer.UV2Kind
  29582. * - VertexBuffer.UV3Kind
  29583. * - VertexBuffer.UV4Kind
  29584. * - VertexBuffer.UV5Kind
  29585. * - VertexBuffer.UV6Kind
  29586. * - VertexBuffer.ColorKind
  29587. * - VertexBuffer.MatricesIndicesKind
  29588. * - VertexBuffer.MatricesIndicesExtraKind
  29589. * - VertexBuffer.MatricesWeightsKind
  29590. * - VertexBuffer.MatricesWeightsExtraKind
  29591. */
  29592. removeVerticesData(kind: string): void;
  29593. /**
  29594. * Flags an associated vertex buffer as updatable
  29595. * @param kind defines which buffer to use (positions, indices, normals, etc). Possible `kind` values :
  29596. * - VertexBuffer.PositionKind
  29597. * - VertexBuffer.UVKind
  29598. * - VertexBuffer.UV2Kind
  29599. * - VertexBuffer.UV3Kind
  29600. * - VertexBuffer.UV4Kind
  29601. * - VertexBuffer.UV5Kind
  29602. * - VertexBuffer.UV6Kind
  29603. * - VertexBuffer.ColorKind
  29604. * - VertexBuffer.MatricesIndicesKind
  29605. * - VertexBuffer.MatricesIndicesExtraKind
  29606. * - VertexBuffer.MatricesWeightsKind
  29607. * - VertexBuffer.MatricesWeightsExtraKind
  29608. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  29609. */
  29610. markVerticesDataAsUpdatable(kind: string, updatable?: boolean): void;
  29611. /**
  29612. * Sets the mesh global Vertex Buffer
  29613. * @param buffer defines the buffer to use
  29614. * @returns the current mesh
  29615. */
  29616. setVerticesBuffer(buffer: VertexBuffer): Mesh;
  29617. /**
  29618. * Update a specific associated vertex buffer
  29619. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  29620. * - VertexBuffer.PositionKind
  29621. * - VertexBuffer.UVKind
  29622. * - VertexBuffer.UV2Kind
  29623. * - VertexBuffer.UV3Kind
  29624. * - VertexBuffer.UV4Kind
  29625. * - VertexBuffer.UV5Kind
  29626. * - VertexBuffer.UV6Kind
  29627. * - VertexBuffer.ColorKind
  29628. * - VertexBuffer.MatricesIndicesKind
  29629. * - VertexBuffer.MatricesIndicesExtraKind
  29630. * - VertexBuffer.MatricesWeightsKind
  29631. * - VertexBuffer.MatricesWeightsExtraKind
  29632. * @param data defines the data source
  29633. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  29634. * @param makeItUnique defines if the geometry associated with the mesh must be cloned to make the change only for this mesh (and not all meshes associated with the same geometry)
  29635. * @returns the current mesh
  29636. */
  29637. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  29638. /**
  29639. * This method updates the vertex positions of an updatable mesh according to the `positionFunction` returned values.
  29640. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#other-shapes-updatemeshpositions
  29641. * @param positionFunction is a simple JS function what is passed the mesh `positions` array. It doesn't need to return anything
  29642. * @param computeNormals is a boolean (default true) to enable/disable the mesh normal recomputation after the vertex position update
  29643. * @returns the current mesh
  29644. */
  29645. updateMeshPositions(positionFunction: (data: FloatArray) => void, computeNormals?: boolean): Mesh;
  29646. /**
  29647. * Creates a un-shared specific occurence of the geometry for the mesh.
  29648. * @returns the current mesh
  29649. */
  29650. makeGeometryUnique(): Mesh;
  29651. /**
  29652. * Set the index buffer of this mesh
  29653. * @param indices defines the source data
  29654. * @param totalVertices defines the total number of vertices referenced by this index data (can be null)
  29655. * @param updatable defines if the updated index buffer must be flagged as updatable (default is false)
  29656. * @returns the current mesh
  29657. */
  29658. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): AbstractMesh;
  29659. /**
  29660. * Update the current index buffer
  29661. * @param indices defines the source data
  29662. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  29663. * @param gpuMemoryOnly defines a boolean indicating that only the GPU memory must be updated leaving the CPU version of the indices unchanged (false by default)
  29664. * @returns the current mesh
  29665. */
  29666. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  29667. /**
  29668. * Invert the geometry to move from a right handed system to a left handed one.
  29669. * @returns the current mesh
  29670. */
  29671. toLeftHanded(): Mesh;
  29672. /** @hidden */
  29673. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  29674. /** @hidden */
  29675. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  29676. /**
  29677. * Registers for this mesh a javascript function called just before the rendering process
  29678. * @param func defines the function to call before rendering this mesh
  29679. * @returns the current mesh
  29680. */
  29681. registerBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  29682. /**
  29683. * Disposes a previously registered javascript function called before the rendering
  29684. * @param func defines the function to remove
  29685. * @returns the current mesh
  29686. */
  29687. unregisterBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  29688. /**
  29689. * Registers for this mesh a javascript function called just after the rendering is complete
  29690. * @param func defines the function to call after rendering this mesh
  29691. * @returns the current mesh
  29692. */
  29693. registerAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  29694. /**
  29695. * Disposes a previously registered javascript function called after the rendering.
  29696. * @param func defines the function to remove
  29697. * @returns the current mesh
  29698. */
  29699. unregisterAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  29700. /** @hidden */
  29701. _getInstancesRenderList(subMeshId: number, isReplacementMode?: boolean): _InstancesBatch;
  29702. /** @hidden */
  29703. _renderWithInstances(subMesh: SubMesh, fillMode: number, batch: _InstancesBatch, effect: Effect, engine: Engine): Mesh;
  29704. /** @hidden */
  29705. _renderWithThinInstances(subMesh: SubMesh, fillMode: number, effect: Effect, engine: Engine): void;
  29706. /** @hidden */
  29707. _processInstancedBuffers(visibleInstances: InstancedMesh[], renderSelf: boolean): void;
  29708. /** @hidden */
  29709. _processRendering(renderingMesh: AbstractMesh, subMesh: SubMesh, effect: Effect, fillMode: number, batch: _InstancesBatch, hardwareInstancedRendering: boolean, onBeforeDraw: (isInstance: boolean, world: Matrix, effectiveMaterial?: Material) => void, effectiveMaterial?: Material): Mesh;
  29710. /** @hidden */
  29711. _rebuild(): void;
  29712. /** @hidden */
  29713. _freeze(): void;
  29714. /** @hidden */
  29715. _unFreeze(): void;
  29716. /**
  29717. * Triggers the draw call for the mesh. Usually, you don't need to call this method by your own because the mesh rendering is handled by the scene rendering manager
  29718. * @param subMesh defines the subMesh to render
  29719. * @param enableAlphaMode defines if alpha mode can be changed
  29720. * @param effectiveMeshReplacement defines an optional mesh used to provide info for the rendering
  29721. * @returns the current mesh
  29722. */
  29723. render(subMesh: SubMesh, enableAlphaMode: boolean, effectiveMeshReplacement?: AbstractMesh): Mesh;
  29724. private _onBeforeDraw;
  29725. /**
  29726. * Renormalize the mesh and patch it up if there are no weights
  29727. * Similar to normalization by adding the weights compute the reciprocal and multiply all elements, this wil ensure that everything adds to 1.
  29728. * However in the case of zero weights then we set just a single influence to 1.
  29729. * We check in the function for extra's present and if so we use the normalizeSkinWeightsWithExtras rather than the FourWeights version.
  29730. */
  29731. cleanMatrixWeights(): void;
  29732. private normalizeSkinFourWeights;
  29733. private normalizeSkinWeightsAndExtra;
  29734. /**
  29735. * ValidateSkinning is used to determine that a mesh has valid skinning data along with skin metrics, if missing weights,
  29736. * or not normalized it is returned as invalid mesh the string can be used for console logs, or on screen messages to let
  29737. * the user know there was an issue with importing the mesh
  29738. * @returns a validation object with skinned, valid and report string
  29739. */
  29740. validateSkinning(): {
  29741. skinned: boolean;
  29742. valid: boolean;
  29743. report: string;
  29744. };
  29745. /** @hidden */
  29746. _checkDelayState(): Mesh;
  29747. private _queueLoad;
  29748. /**
  29749. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  29750. * A mesh is in the frustum if its bounding box intersects the frustum
  29751. * @param frustumPlanes defines the frustum to test
  29752. * @returns true if the mesh is in the frustum planes
  29753. */
  29754. isInFrustum(frustumPlanes: Plane[]): boolean;
  29755. /**
  29756. * Sets the mesh material by the material or multiMaterial `id` property
  29757. * @param id is a string identifying the material or the multiMaterial
  29758. * @returns the current mesh
  29759. */
  29760. setMaterialByID(id: string): Mesh;
  29761. /**
  29762. * Returns as a new array populated with the mesh material and/or skeleton, if any.
  29763. * @returns an array of IAnimatable
  29764. */
  29765. getAnimatables(): IAnimatable[];
  29766. /**
  29767. * Modifies the mesh geometry according to the passed transformation matrix.
  29768. * This method returns nothing but it really modifies the mesh even if it's originally not set as updatable.
  29769. * The mesh normals are modified using the same transformation.
  29770. * Note that, under the hood, this method sets a new VertexBuffer each call.
  29771. * @param transform defines the transform matrix to use
  29772. * @see https://doc.babylonjs.com/resources/baking_transformations
  29773. * @returns the current mesh
  29774. */
  29775. bakeTransformIntoVertices(transform: Matrix): Mesh;
  29776. /**
  29777. * Modifies the mesh geometry according to its own current World Matrix.
  29778. * The mesh World Matrix is then reset.
  29779. * This method returns nothing but really modifies the mesh even if it's originally not set as updatable.
  29780. * Note that, under the hood, this method sets a new VertexBuffer each call.
  29781. * @see https://doc.babylonjs.com/resources/baking_transformations
  29782. * @param bakeIndependenlyOfChildren indicates whether to preserve all child nodes' World Matrix during baking
  29783. * @returns the current mesh
  29784. */
  29785. bakeCurrentTransformIntoVertices(bakeIndependenlyOfChildren?: boolean): Mesh;
  29786. /** @hidden */
  29787. get _positions(): Nullable<Vector3[]>;
  29788. /** @hidden */
  29789. _resetPointsArrayCache(): Mesh;
  29790. /** @hidden */
  29791. _generatePointsArray(): boolean;
  29792. /**
  29793. * Returns a new Mesh object generated from the current mesh properties.
  29794. * This method must not get confused with createInstance()
  29795. * @param name is a string, the name given to the new mesh
  29796. * @param newParent can be any Node object (default `null`)
  29797. * @param doNotCloneChildren allows/denies the recursive cloning of the original mesh children if any (default `false`)
  29798. * @param clonePhysicsImpostor allows/denies the cloning in the same time of the original mesh `body` used by the physics engine, if any (default `true`)
  29799. * @returns a new mesh
  29800. */
  29801. clone(name?: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean): Mesh;
  29802. /**
  29803. * Releases resources associated with this mesh.
  29804. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  29805. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  29806. */
  29807. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  29808. /** @hidden */
  29809. _disposeInstanceSpecificData(): void;
  29810. /** @hidden */
  29811. _disposeThinInstanceSpecificData(): void;
  29812. /**
  29813. * Modifies the mesh geometry according to a displacement map.
  29814. * A displacement map is a colored image. Each pixel color value (actually a gradient computed from red, green, blue values) will give the displacement to apply to each mesh vertex.
  29815. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  29816. * @param url is a string, the URL from the image file is to be downloaded.
  29817. * @param minHeight is the lower limit of the displacement.
  29818. * @param maxHeight is the upper limit of the displacement.
  29819. * @param onSuccess is an optional Javascript function to be called just after the mesh is modified. It is passed the modified mesh and must return nothing.
  29820. * @param uvOffset is an optional vector2 used to offset UV.
  29821. * @param uvScale is an optional vector2 used to scale UV.
  29822. * @param forceUpdate defines whether or not to force an update of the generated buffers. This is useful to apply on a deserialized model for instance.
  29823. * @returns the Mesh.
  29824. */
  29825. applyDisplacementMap(url: string, minHeight: number, maxHeight: number, onSuccess?: (mesh: Mesh) => void, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  29826. /**
  29827. * Modifies the mesh geometry according to a displacementMap buffer.
  29828. * A displacement map is a colored image. Each pixel color value (actually a gradient computed from red, green, blue values) will give the displacement to apply to each mesh vertex.
  29829. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  29830. * @param buffer is a `Uint8Array` buffer containing series of `Uint8` lower than 255, the red, green, blue and alpha values of each successive pixel.
  29831. * @param heightMapWidth is the width of the buffer image.
  29832. * @param heightMapHeight is the height of the buffer image.
  29833. * @param minHeight is the lower limit of the displacement.
  29834. * @param maxHeight is the upper limit of the displacement.
  29835. * @param onSuccess is an optional Javascript function to be called just after the mesh is modified. It is passed the modified mesh and must return nothing.
  29836. * @param uvOffset is an optional vector2 used to offset UV.
  29837. * @param uvScale is an optional vector2 used to scale UV.
  29838. * @param forceUpdate defines whether or not to force an update of the generated buffers. This is useful to apply on a deserialized model for instance.
  29839. * @returns the Mesh.
  29840. */
  29841. applyDisplacementMapFromBuffer(buffer: Uint8Array, heightMapWidth: number, heightMapHeight: number, minHeight: number, maxHeight: number, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  29842. /**
  29843. * Modify the mesh to get a flat shading rendering.
  29844. * This means each mesh facet will then have its own normals. Usually new vertices are added in the mesh geometry to get this result.
  29845. * Warning : the mesh is really modified even if not set originally as updatable and, under the hood, a new VertexBuffer is allocated.
  29846. * @returns current mesh
  29847. */
  29848. convertToFlatShadedMesh(): Mesh;
  29849. /**
  29850. * This method removes all the mesh indices and add new vertices (duplication) in order to unfold facets into buffers.
  29851. * In other words, more vertices, no more indices and a single bigger VBO.
  29852. * The mesh is really modified even if not set originally as updatable. Under the hood, a new VertexBuffer is allocated.
  29853. * @returns current mesh
  29854. */
  29855. convertToUnIndexedMesh(): Mesh;
  29856. /**
  29857. * Inverses facet orientations.
  29858. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  29859. * @param flipNormals will also inverts the normals
  29860. * @returns current mesh
  29861. */
  29862. flipFaces(flipNormals?: boolean): Mesh;
  29863. /**
  29864. * Increase the number of facets and hence vertices in a mesh
  29865. * Vertex normals are interpolated from existing vertex normals
  29866. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  29867. * @param numberPerEdge the number of new vertices to add to each edge of a facet, optional default 1
  29868. */
  29869. increaseVertices(numberPerEdge: number): void;
  29870. /**
  29871. * Force adjacent facets to share vertices and remove any facets that have all vertices in a line
  29872. * This will undo any application of covertToFlatShadedMesh
  29873. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  29874. */
  29875. forceSharedVertices(): void;
  29876. /** @hidden */
  29877. static _instancedMeshFactory(name: string, mesh: Mesh): InstancedMesh;
  29878. /** @hidden */
  29879. static _PhysicsImpostorParser(scene: Scene, physicObject: IPhysicsEnabledObject, jsonObject: any): PhysicsImpostor;
  29880. /**
  29881. * Creates a new InstancedMesh object from the mesh model.
  29882. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  29883. * @param name defines the name of the new instance
  29884. * @returns a new InstancedMesh
  29885. */
  29886. createInstance(name: string): InstancedMesh;
  29887. /**
  29888. * Synchronises all the mesh instance submeshes to the current mesh submeshes, if any.
  29889. * After this call, all the mesh instances have the same submeshes than the current mesh.
  29890. * @returns the current mesh
  29891. */
  29892. synchronizeInstances(): Mesh;
  29893. /**
  29894. * Optimization of the mesh's indices, in case a mesh has duplicated vertices.
  29895. * The function will only reorder the indices and will not remove unused vertices to avoid problems with submeshes.
  29896. * This should be used together with the simplification to avoid disappearing triangles.
  29897. * @param successCallback an optional success callback to be called after the optimization finished.
  29898. * @returns the current mesh
  29899. */
  29900. optimizeIndices(successCallback?: (mesh?: Mesh) => void): Mesh;
  29901. /**
  29902. * Serialize current mesh
  29903. * @param serializationObject defines the object which will receive the serialization data
  29904. */
  29905. serialize(serializationObject: any): void;
  29906. /** @hidden */
  29907. _syncGeometryWithMorphTargetManager(): void;
  29908. /** @hidden */
  29909. static _GroundMeshParser: (parsedMesh: any, scene: Scene) => Mesh;
  29910. /**
  29911. * Returns a new Mesh object parsed from the source provided.
  29912. * @param parsedMesh is the source
  29913. * @param scene defines the hosting scene
  29914. * @param rootUrl is the root URL to prefix the `delayLoadingFile` property with
  29915. * @returns a new Mesh
  29916. */
  29917. static Parse(parsedMesh: any, scene: Scene, rootUrl: string): Mesh;
  29918. /**
  29919. * Creates a ribbon mesh. Please consider using the same method from the MeshBuilder class instead
  29920. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  29921. * @param name defines the name of the mesh to create
  29922. * @param pathArray is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry.
  29923. * @param closeArray creates a seam between the first and the last paths of the path array (default is false)
  29924. * @param closePath creates a seam between the first and the last points of each path of the path array
  29925. * @param offset is taken in account only if the `pathArray` is containing a single path
  29926. * @param scene defines the hosting scene
  29927. * @param updatable defines if the mesh must be flagged as updatable
  29928. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29929. * @param instance defines an instance of an existing Ribbon object to be updated with the passed `pathArray` parameter (https://doc.babylonjs.com/how_to/How_to_dynamically_morph_a_mesh#ribbon)
  29930. * @returns a new Mesh
  29931. */
  29932. static CreateRibbon(name: string, pathArray: Vector3[][], closeArray: boolean, closePath: boolean, offset: number, scene?: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  29933. /**
  29934. * Creates a plane polygonal mesh. By default, this is a disc. Please consider using the same method from the MeshBuilder class instead
  29935. * @param name defines the name of the mesh to create
  29936. * @param radius sets the radius size (float) of the polygon (default 0.5)
  29937. * @param tessellation sets the number of polygon sides (positive integer, default 64). So a tessellation valued to 3 will build a triangle, to 4 a square, etc
  29938. * @param scene defines the hosting scene
  29939. * @param updatable defines if the mesh must be flagged as updatable
  29940. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29941. * @returns a new Mesh
  29942. */
  29943. static CreateDisc(name: string, radius: number, tessellation: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  29944. /**
  29945. * Creates a box mesh. Please consider using the same method from the MeshBuilder class instead
  29946. * @param name defines the name of the mesh to create
  29947. * @param size sets the size (float) of each box side (default 1)
  29948. * @param scene defines the hosting scene
  29949. * @param updatable defines if the mesh must be flagged as updatable
  29950. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29951. * @returns a new Mesh
  29952. */
  29953. static CreateBox(name: string, size: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  29954. /**
  29955. * Creates a sphere mesh. Please consider using the same method from the MeshBuilder class instead
  29956. * @param name defines the name of the mesh to create
  29957. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  29958. * @param diameter sets the diameter size (float) of the sphere (default 1)
  29959. * @param scene defines the hosting scene
  29960. * @param updatable defines if the mesh must be flagged as updatable
  29961. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29962. * @returns a new Mesh
  29963. */
  29964. static CreateSphere(name: string, segments: number, diameter: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  29965. /**
  29966. * Creates a hemisphere mesh. Please consider using the same method from the MeshBuilder class instead
  29967. * @param name defines the name of the mesh to create
  29968. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  29969. * @param diameter sets the diameter size (float) of the sphere (default 1)
  29970. * @param scene defines the hosting scene
  29971. * @returns a new Mesh
  29972. */
  29973. static CreateHemisphere(name: string, segments: number, diameter: number, scene?: Scene): Mesh;
  29974. /**
  29975. * Creates a cylinder or a cone mesh. Please consider using the same method from the MeshBuilder class instead
  29976. * @param name defines the name of the mesh to create
  29977. * @param height sets the height size (float) of the cylinder/cone (float, default 2)
  29978. * @param diameterTop set the top cap diameter (floats, default 1)
  29979. * @param diameterBottom set the bottom cap diameter (floats, default 1). This value can't be zero
  29980. * @param tessellation sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance
  29981. * @param subdivisions sets the number of rings along the cylinder height (positive integer, default 1)
  29982. * @param scene defines the hosting scene
  29983. * @param updatable defines if the mesh must be flagged as updatable
  29984. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29985. * @returns a new Mesh
  29986. */
  29987. static CreateCylinder(name: string, height: number, diameterTop: number, diameterBottom: number, tessellation: number, subdivisions: any, scene?: Scene, updatable?: any, sideOrientation?: number): Mesh;
  29988. /**
  29989. * Creates a torus mesh. Please consider using the same method from the MeshBuilder class instead
  29990. * @param name defines the name of the mesh to create
  29991. * @param diameter sets the diameter size (float) of the torus (default 1)
  29992. * @param thickness sets the diameter size of the tube of the torus (float, default 0.5)
  29993. * @param tessellation sets the number of torus sides (postive integer, default 16)
  29994. * @param scene defines the hosting scene
  29995. * @param updatable defines if the mesh must be flagged as updatable
  29996. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29997. * @returns a new Mesh
  29998. */
  29999. static CreateTorus(name: string, diameter: number, thickness: number, tessellation: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  30000. /**
  30001. * Creates a torus knot mesh. Please consider using the same method from the MeshBuilder class instead
  30002. * @param name defines the name of the mesh to create
  30003. * @param radius sets the global radius size (float) of the torus knot (default 2)
  30004. * @param tube sets the diameter size of the tube of the torus (float, default 0.5)
  30005. * @param radialSegments sets the number of sides on each tube segments (positive integer, default 32)
  30006. * @param tubularSegments sets the number of tubes to decompose the knot into (positive integer, default 32)
  30007. * @param p the number of windings on X axis (positive integers, default 2)
  30008. * @param q the number of windings on Y axis (positive integers, default 3)
  30009. * @param scene defines the hosting scene
  30010. * @param updatable defines if the mesh must be flagged as updatable
  30011. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30012. * @returns a new Mesh
  30013. */
  30014. static CreateTorusKnot(name: string, radius: number, tube: number, radialSegments: number, tubularSegments: number, p: number, q: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  30015. /**
  30016. * Creates a line mesh. Please consider using the same method from the MeshBuilder class instead.
  30017. * @param name defines the name of the mesh to create
  30018. * @param points is an array successive Vector3
  30019. * @param scene defines the hosting scene
  30020. * @param updatable defines if the mesh must be flagged as updatable
  30021. * @param instance is an instance of an existing LineMesh object to be updated with the passed `points` parameter (https://doc.babylonjs.com/how_to/How_to_dynamically_morph_a_mesh#lines-and-dashedlines).
  30022. * @returns a new Mesh
  30023. */
  30024. static CreateLines(name: string, points: Vector3[], scene?: Nullable<Scene>, updatable?: boolean, instance?: Nullable<LinesMesh>): LinesMesh;
  30025. /**
  30026. * Creates a dashed line mesh. Please consider using the same method from the MeshBuilder class instead
  30027. * @param name defines the name of the mesh to create
  30028. * @param points is an array successive Vector3
  30029. * @param dashSize is the size of the dashes relatively the dash number (positive float, default 3)
  30030. * @param gapSize is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  30031. * @param dashNb is the intended total number of dashes (positive integer, default 200)
  30032. * @param scene defines the hosting scene
  30033. * @param updatable defines if the mesh must be flagged as updatable
  30034. * @param instance is an instance of an existing LineMesh object to be updated with the passed `points` parameter (https://doc.babylonjs.com/how_to/How_to_dynamically_morph_a_mesh#lines-and-dashedlines)
  30035. * @returns a new Mesh
  30036. */
  30037. static CreateDashedLines(name: string, points: Vector3[], dashSize: number, gapSize: number, dashNb: number, scene?: Nullable<Scene>, updatable?: boolean, instance?: LinesMesh): LinesMesh;
  30038. /**
  30039. * Creates a polygon mesh.Please consider using the same method from the MeshBuilder class instead
  30040. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh.
  30041. * The parameter `shape` is a required array of successive Vector3 representing the corners of the polygon in th XoZ plane, that is y = 0 for all vectors.
  30042. * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  30043. * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  30044. * Remember you can only change the shape positions, not their number when updating a polygon.
  30045. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  30046. * @param name defines the name of the mesh to create
  30047. * @param shape is a required array of successive Vector3 representing the corners of the polygon in th XoZ plane, that is y = 0 for all vectors
  30048. * @param scene defines the hosting scene
  30049. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  30050. * @param updatable defines if the mesh must be flagged as updatable
  30051. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30052. * @param earcutInjection can be used to inject your own earcut reference
  30053. * @returns a new Mesh
  30054. */
  30055. static CreatePolygon(name: string, shape: Vector3[], scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  30056. /**
  30057. * Creates an extruded polygon mesh, with depth in the Y direction. Please consider using the same method from the MeshBuilder class instead.
  30058. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-non-regular-polygon
  30059. * @param name defines the name of the mesh to create
  30060. * @param shape is a required array of successive Vector3 representing the corners of the polygon in th XoZ plane, that is y = 0 for all vectors
  30061. * @param depth defines the height of extrusion
  30062. * @param scene defines the hosting scene
  30063. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  30064. * @param updatable defines if the mesh must be flagged as updatable
  30065. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30066. * @param earcutInjection can be used to inject your own earcut reference
  30067. * @returns a new Mesh
  30068. */
  30069. static ExtrudePolygon(name: string, shape: Vector3[], depth: number, scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  30070. /**
  30071. * Creates an extruded shape mesh.
  30072. * The extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters. Please consider using the same method from the MeshBuilder class instead
  30073. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  30074. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  30075. * @param name defines the name of the mesh to create
  30076. * @param shape is a required array of successive Vector3. This array depicts the shape to be extruded in its local space : the shape must be designed in the xOy plane and will be extruded along the Z axis
  30077. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  30078. * @param scale is the value to scale the shape
  30079. * @param rotation is the angle value to rotate the shape each step (each path point), from the former step (so rotation added each step) along the curve
  30080. * @param cap sets the way the extruded shape is capped. Possible values : Mesh.NO_CAP (default), Mesh.CAP_START, Mesh.CAP_END, Mesh.CAP_ALL
  30081. * @param scene defines the hosting scene
  30082. * @param updatable defines if the mesh must be flagged as updatable
  30083. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30084. * @param instance is an instance of an existing ExtrudedShape object to be updated with the passed `shape`, `path`, `scale` or `rotation` parameters (https://doc.babylonjs.com/how_to/How_to_dynamically_morph_a_mesh#extruded-shape)
  30085. * @returns a new Mesh
  30086. */
  30087. static ExtrudeShape(name: string, shape: Vector3[], path: Vector3[], scale: number, rotation: number, cap: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  30088. /**
  30089. * Creates an custom extruded shape mesh.
  30090. * The custom extrusion is a parametric shape.
  30091. * It has no predefined shape. Its final shape will depend on the input parameters.
  30092. * Please consider using the same method from the MeshBuilder class instead
  30093. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  30094. * @param name defines the name of the mesh to create
  30095. * @param shape is a required array of successive Vector3. This array depicts the shape to be extruded in its local space : the shape must be designed in the xOy plane and will be extruded along the Z axis
  30096. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  30097. * @param scaleFunction is a custom Javascript function called on each path point
  30098. * @param rotationFunction is a custom Javascript function called on each path point
  30099. * @param ribbonCloseArray forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  30100. * @param ribbonClosePath forces the extrusion underlying ribbon to close its `pathArray`
  30101. * @param cap sets the way the extruded shape is capped. Possible values : Mesh.NO_CAP (default), Mesh.CAP_START, Mesh.CAP_END, Mesh.CAP_ALL
  30102. * @param scene defines the hosting scene
  30103. * @param updatable defines if the mesh must be flagged as updatable
  30104. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30105. * @param instance is an instance of an existing ExtrudedShape object to be updated with the passed `shape`, `path`, `scale` or `rotation` parameters (https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#extruded-shape)
  30106. * @returns a new Mesh
  30107. */
  30108. static ExtrudeShapeCustom(name: string, shape: Vector3[], path: Vector3[], scaleFunction: Function, rotationFunction: Function, ribbonCloseArray: boolean, ribbonClosePath: boolean, cap: number, scene: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  30109. /**
  30110. * Creates lathe mesh.
  30111. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe.
  30112. * Please consider using the same method from the MeshBuilder class instead
  30113. * @param name defines the name of the mesh to create
  30114. * @param shape is a required array of successive Vector3. This array depicts the shape to be rotated in its local space : the shape must be designed in the xOy plane and will be rotated around the Y axis. It's usually a 2D shape, so the Vector3 z coordinates are often set to zero
  30115. * @param radius is the radius value of the lathe
  30116. * @param tessellation is the side number of the lathe.
  30117. * @param scene defines the hosting scene
  30118. * @param updatable defines if the mesh must be flagged as updatable
  30119. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30120. * @returns a new Mesh
  30121. */
  30122. static CreateLathe(name: string, shape: Vector3[], radius: number, tessellation: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  30123. /**
  30124. * Creates a plane mesh. Please consider using the same method from the MeshBuilder class instead
  30125. * @param name defines the name of the mesh to create
  30126. * @param size sets the size (float) of both sides of the plane at once (default 1)
  30127. * @param scene defines the hosting scene
  30128. * @param updatable defines if the mesh must be flagged as updatable
  30129. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30130. * @returns a new Mesh
  30131. */
  30132. static CreatePlane(name: string, size: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  30133. /**
  30134. * Creates a ground mesh.
  30135. * Please consider using the same method from the MeshBuilder class instead
  30136. * @param name defines the name of the mesh to create
  30137. * @param width set the width of the ground
  30138. * @param height set the height of the ground
  30139. * @param subdivisions sets the number of subdivisions per side
  30140. * @param scene defines the hosting scene
  30141. * @param updatable defines if the mesh must be flagged as updatable
  30142. * @returns a new Mesh
  30143. */
  30144. static CreateGround(name: string, width: number, height: number, subdivisions: number, scene?: Scene, updatable?: boolean): Mesh;
  30145. /**
  30146. * Creates a tiled ground mesh.
  30147. * Please consider using the same method from the MeshBuilder class instead
  30148. * @param name defines the name of the mesh to create
  30149. * @param xmin set the ground minimum X coordinate
  30150. * @param zmin set the ground minimum Y coordinate
  30151. * @param xmax set the ground maximum X coordinate
  30152. * @param zmax set the ground maximum Z coordinate
  30153. * @param subdivisions is an object `{w: positive integer, h: positive integer}` (default `{w: 6, h: 6}`). `w` and `h` are the numbers of subdivisions on the ground width and height. Each subdivision is called a tile
  30154. * @param precision is an object `{w: positive integer, h: positive integer}` (default `{w: 2, h: 2}`). `w` and `h` are the numbers of subdivisions on the ground width and height of each tile
  30155. * @param scene defines the hosting scene
  30156. * @param updatable defines if the mesh must be flagged as updatable
  30157. * @returns a new Mesh
  30158. */
  30159. static CreateTiledGround(name: string, xmin: number, zmin: number, xmax: number, zmax: number, subdivisions: {
  30160. w: number;
  30161. h: number;
  30162. }, precision: {
  30163. w: number;
  30164. h: number;
  30165. }, scene: Scene, updatable?: boolean): Mesh;
  30166. /**
  30167. * Creates a ground mesh from a height map.
  30168. * Please consider using the same method from the MeshBuilder class instead
  30169. * @see https://doc.babylonjs.com/babylon101/height_map
  30170. * @param name defines the name of the mesh to create
  30171. * @param url sets the URL of the height map image resource
  30172. * @param width set the ground width size
  30173. * @param height set the ground height size
  30174. * @param subdivisions sets the number of subdivision per side
  30175. * @param minHeight is the minimum altitude on the ground
  30176. * @param maxHeight is the maximum altitude on the ground
  30177. * @param scene defines the hosting scene
  30178. * @param updatable defines if the mesh must be flagged as updatable
  30179. * @param onReady is a callback function that will be called once the mesh is built (the height map download can last some time)
  30180. * @param alphaFilter will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  30181. * @returns a new Mesh
  30182. */
  30183. static CreateGroundFromHeightMap(name: string, url: string, width: number, height: number, subdivisions: number, minHeight: number, maxHeight: number, scene: Scene, updatable?: boolean, onReady?: (mesh: GroundMesh) => void, alphaFilter?: number): GroundMesh;
  30184. /**
  30185. * Creates a tube mesh.
  30186. * The tube is a parametric shape.
  30187. * It has no predefined shape. Its final shape will depend on the input parameters.
  30188. * Please consider using the same method from the MeshBuilder class instead
  30189. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  30190. * @param name defines the name of the mesh to create
  30191. * @param path is a required array of successive Vector3. It is the curve used as the axis of the tube
  30192. * @param radius sets the tube radius size
  30193. * @param tessellation is the number of sides on the tubular surface
  30194. * @param radiusFunction is a custom function. If it is not null, it overwrittes the parameter `radius`. This function is called on each point of the tube path and is passed the index `i` of the i-th point and the distance of this point from the first point of the path
  30195. * @param cap sets the way the extruded shape is capped. Possible values : Mesh.NO_CAP (default), Mesh.CAP_START, Mesh.CAP_END, Mesh.CAP_ALL
  30196. * @param scene defines the hosting scene
  30197. * @param updatable defines if the mesh must be flagged as updatable
  30198. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30199. * @param instance is an instance of an existing Tube object to be updated with the passed `pathArray` parameter (https://doc.babylonjs.com/how_to/How_to_dynamically_morph_a_mesh#tube)
  30200. * @returns a new Mesh
  30201. */
  30202. static CreateTube(name: string, path: Vector3[], radius: number, tessellation: number, radiusFunction: {
  30203. (i: number, distance: number): number;
  30204. }, cap: number, scene: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  30205. /**
  30206. * Creates a polyhedron mesh.
  30207. * Please consider using the same method from the MeshBuilder class instead.
  30208. * * The parameter `type` (positive integer, max 14, default 0) sets the polyhedron type to build among the 15 embbeded types. Please refer to the type sheet in the tutorial to choose the wanted type
  30209. * * The parameter `size` (positive float, default 1) sets the polygon size
  30210. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  30211. * * You can build other polyhedron types than the 15 embbeded ones by setting the parameter `custom` (`polyhedronObject`, default null). If you set the parameter `custom`, this overwrittes the parameter `type`
  30212. * * A `polyhedronObject` is a formatted javascript object. You'll find a full file with pre-set polyhedra here : https://github.com/BabylonJS/Extensions/tree/master/Polyhedron
  30213. * * You can set the color and the UV of each side of the polyhedron with the parameters `faceColors` (Color4, default `(1, 1, 1, 1)`) and faceUV (Vector4, default `(0, 0, 1, 1)`)
  30214. * * To understand how to set `faceUV` or `faceColors`, please read this by considering the right number of faces of your polyhedron, instead of only 6 for the box : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  30215. * * The parameter `flat` (boolean, default true). If set to false, it gives the polyhedron a single global face, so less vertices and shared normals. In this case, `faceColors` and `faceUV` are ignored
  30216. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  30217. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  30218. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  30219. * @param name defines the name of the mesh to create
  30220. * @param options defines the options used to create the mesh
  30221. * @param scene defines the hosting scene
  30222. * @returns a new Mesh
  30223. */
  30224. static CreatePolyhedron(name: string, options: {
  30225. type?: number;
  30226. size?: number;
  30227. sizeX?: number;
  30228. sizeY?: number;
  30229. sizeZ?: number;
  30230. custom?: any;
  30231. faceUV?: Vector4[];
  30232. faceColors?: Color4[];
  30233. updatable?: boolean;
  30234. sideOrientation?: number;
  30235. }, scene: Scene): Mesh;
  30236. /**
  30237. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  30238. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  30239. * * You can set some different icosphere dimensions, for instance to build an ellipsoid, by using the parameters `radiusX`, `radiusY` and `radiusZ` (all by default have the same value than `radius`)
  30240. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  30241. * * The parameter `flat` (boolean, default true) gives each side its own normals. Set it to false to get a smooth continuous light reflection on the surface
  30242. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  30243. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  30244. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  30245. * @param name defines the name of the mesh
  30246. * @param options defines the options used to create the mesh
  30247. * @param scene defines the hosting scene
  30248. * @returns a new Mesh
  30249. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  30250. */
  30251. static CreateIcoSphere(name: string, options: {
  30252. radius?: number;
  30253. flat?: boolean;
  30254. subdivisions?: number;
  30255. sideOrientation?: number;
  30256. updatable?: boolean;
  30257. }, scene: Scene): Mesh;
  30258. /**
  30259. * Creates a decal mesh.
  30260. * Please consider using the same method from the MeshBuilder class instead.
  30261. * A decal is a mesh usually applied as a model onto the surface of another mesh
  30262. * @param name defines the name of the mesh
  30263. * @param sourceMesh defines the mesh receiving the decal
  30264. * @param position sets the position of the decal in world coordinates
  30265. * @param normal sets the normal of the mesh where the decal is applied onto in world coordinates
  30266. * @param size sets the decal scaling
  30267. * @param angle sets the angle to rotate the decal
  30268. * @returns a new Mesh
  30269. */
  30270. static CreateDecal(name: string, sourceMesh: AbstractMesh, position: Vector3, normal: Vector3, size: Vector3, angle: number): Mesh;
  30271. /**
  30272. * Prepare internal position array for software CPU skinning
  30273. * @returns original positions used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh
  30274. */
  30275. setPositionsForCPUSkinning(): Float32Array;
  30276. /**
  30277. * Prepare internal normal array for software CPU skinning
  30278. * @returns original normals used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh.
  30279. */
  30280. setNormalsForCPUSkinning(): Float32Array;
  30281. /**
  30282. * Updates the vertex buffer by applying transformation from the bones
  30283. * @param skeleton defines the skeleton to apply to current mesh
  30284. * @returns the current mesh
  30285. */
  30286. applySkeleton(skeleton: Skeleton): Mesh;
  30287. /**
  30288. * Returns an object containing a min and max Vector3 which are the minimum and maximum vectors of each mesh bounding box from the passed array, in the world coordinates
  30289. * @param meshes defines the list of meshes to scan
  30290. * @returns an object `{min:` Vector3`, max:` Vector3`}`
  30291. */
  30292. static MinMax(meshes: AbstractMesh[]): {
  30293. min: Vector3;
  30294. max: Vector3;
  30295. };
  30296. /**
  30297. * Returns the center of the `{min:` Vector3`, max:` Vector3`}` or the center of MinMax vector3 computed from a mesh array
  30298. * @param meshesOrMinMaxVector could be an array of meshes or a `{min:` Vector3`, max:` Vector3`}` object
  30299. * @returns a vector3
  30300. */
  30301. static Center(meshesOrMinMaxVector: {
  30302. min: Vector3;
  30303. max: Vector3;
  30304. } | AbstractMesh[]): Vector3;
  30305. /**
  30306. * Merge the array of meshes into a single mesh for performance reasons.
  30307. * @param meshes defines he vertices source. They should all be of the same material. Entries can empty
  30308. * @param disposeSource when true (default), dispose of the vertices from the source meshes
  30309. * @param allow32BitsIndices when the sum of the vertices > 64k, this must be set to true
  30310. * @param meshSubclass when set, vertices inserted into this Mesh. Meshes can then be merged into a Mesh sub-class.
  30311. * @param subdivideWithSubMeshes when true (false default), subdivide mesh to his subMesh array with meshes source.
  30312. * @param multiMultiMaterials when true (false default), subdivide mesh and accept multiple multi materials, ignores subdivideWithSubMeshes.
  30313. * @returns a new mesh
  30314. */
  30315. static MergeMeshes(meshes: Array<Mesh>, disposeSource?: boolean, allow32BitsIndices?: boolean, meshSubclass?: Mesh, subdivideWithSubMeshes?: boolean, multiMultiMaterials?: boolean): Nullable<Mesh>;
  30316. /** @hidden */
  30317. addInstance(instance: InstancedMesh): void;
  30318. /** @hidden */
  30319. removeInstance(instance: InstancedMesh): void;
  30320. }
  30321. }
  30322. declare module "babylonjs/Cameras/camera" {
  30323. import { SmartArray } from "babylonjs/Misc/smartArray";
  30324. import { Observable } from "babylonjs/Misc/observable";
  30325. import { Nullable } from "babylonjs/types";
  30326. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  30327. import { Scene } from "babylonjs/scene";
  30328. import { Matrix, Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  30329. import { Node } from "babylonjs/node";
  30330. import { Mesh } from "babylonjs/Meshes/mesh";
  30331. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  30332. import { ICullable } from "babylonjs/Culling/boundingInfo";
  30333. import { Viewport } from "babylonjs/Maths/math.viewport";
  30334. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  30335. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  30336. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  30337. import { Ray } from "babylonjs/Culling/ray";
  30338. /**
  30339. * This is the base class of all the camera used in the application.
  30340. * @see https://doc.babylonjs.com/features/cameras
  30341. */
  30342. export class Camera extends Node {
  30343. /** @hidden */
  30344. static _createDefaultParsedCamera: (name: string, scene: Scene) => Camera;
  30345. /**
  30346. * This is the default projection mode used by the cameras.
  30347. * It helps recreating a feeling of perspective and better appreciate depth.
  30348. * This is the best way to simulate real life cameras.
  30349. */
  30350. static readonly PERSPECTIVE_CAMERA: number;
  30351. /**
  30352. * This helps creating camera with an orthographic mode.
  30353. * Orthographic is commonly used in engineering as a means to produce object specifications that communicate dimensions unambiguously, each line of 1 unit length (cm, meter..whatever) will appear to have the same length everywhere on the drawing. This allows the drafter to dimension only a subset of lines and let the reader know that other lines of that length on the drawing are also that length in reality. Every parallel line in the drawing is also parallel in the object.
  30354. */
  30355. static readonly ORTHOGRAPHIC_CAMERA: number;
  30356. /**
  30357. * This is the default FOV mode for perspective cameras.
  30358. * This setting aligns the upper and lower bounds of the viewport to the upper and lower bounds of the camera frustum.
  30359. */
  30360. static readonly FOVMODE_VERTICAL_FIXED: number;
  30361. /**
  30362. * This setting aligns the left and right bounds of the viewport to the left and right bounds of the camera frustum.
  30363. */
  30364. static readonly FOVMODE_HORIZONTAL_FIXED: number;
  30365. /**
  30366. * This specifies ther is no need for a camera rig.
  30367. * Basically only one eye is rendered corresponding to the camera.
  30368. */
  30369. static readonly RIG_MODE_NONE: number;
  30370. /**
  30371. * Simulates a camera Rig with one blue eye and one red eye.
  30372. * This can be use with 3d blue and red glasses.
  30373. */
  30374. static readonly RIG_MODE_STEREOSCOPIC_ANAGLYPH: number;
  30375. /**
  30376. * Defines that both eyes of the camera will be rendered side by side with a parallel target.
  30377. */
  30378. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_PARALLEL: number;
  30379. /**
  30380. * Defines that both eyes of the camera will be rendered side by side with a none parallel target.
  30381. */
  30382. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_CROSSEYED: number;
  30383. /**
  30384. * Defines that both eyes of the camera will be rendered over under each other.
  30385. */
  30386. static readonly RIG_MODE_STEREOSCOPIC_OVERUNDER: number;
  30387. /**
  30388. * Defines that both eyes of the camera will be rendered on successive lines interlaced for passive 3d monitors.
  30389. */
  30390. static readonly RIG_MODE_STEREOSCOPIC_INTERLACED: number;
  30391. /**
  30392. * Defines that both eyes of the camera should be renderered in a VR mode (carbox).
  30393. */
  30394. static readonly RIG_MODE_VR: number;
  30395. /**
  30396. * Defines that both eyes of the camera should be renderered in a VR mode (webVR).
  30397. */
  30398. static readonly RIG_MODE_WEBVR: number;
  30399. /**
  30400. * Custom rig mode allowing rig cameras to be populated manually with any number of cameras
  30401. */
  30402. static readonly RIG_MODE_CUSTOM: number;
  30403. /**
  30404. * Defines if by default attaching controls should prevent the default javascript event to continue.
  30405. */
  30406. static ForceAttachControlToAlwaysPreventDefault: boolean;
  30407. /**
  30408. * Define the input manager associated with the camera.
  30409. */
  30410. inputs: CameraInputsManager<Camera>;
  30411. /** @hidden */
  30412. _position: Vector3;
  30413. /**
  30414. * Define the current local position of the camera in the scene
  30415. */
  30416. get position(): Vector3;
  30417. set position(newPosition: Vector3);
  30418. protected _upVector: Vector3;
  30419. /**
  30420. * The vector the camera should consider as up.
  30421. * (default is Vector3(0, 1, 0) aka Vector3.Up())
  30422. */
  30423. set upVector(vec: Vector3);
  30424. get upVector(): Vector3;
  30425. /**
  30426. * Define the current limit on the left side for an orthographic camera
  30427. * In scene unit
  30428. */
  30429. orthoLeft: Nullable<number>;
  30430. /**
  30431. * Define the current limit on the right side for an orthographic camera
  30432. * In scene unit
  30433. */
  30434. orthoRight: Nullable<number>;
  30435. /**
  30436. * Define the current limit on the bottom side for an orthographic camera
  30437. * In scene unit
  30438. */
  30439. orthoBottom: Nullable<number>;
  30440. /**
  30441. * Define the current limit on the top side for an orthographic camera
  30442. * In scene unit
  30443. */
  30444. orthoTop: Nullable<number>;
  30445. /**
  30446. * Field Of View is set in Radians. (default is 0.8)
  30447. */
  30448. fov: number;
  30449. /**
  30450. * Define the minimum distance the camera can see from.
  30451. * This is important to note that the depth buffer are not infinite and the closer it starts
  30452. * the more your scene might encounter depth fighting issue.
  30453. */
  30454. minZ: number;
  30455. /**
  30456. * Define the maximum distance the camera can see to.
  30457. * This is important to note that the depth buffer are not infinite and the further it end
  30458. * the more your scene might encounter depth fighting issue.
  30459. */
  30460. maxZ: number;
  30461. /**
  30462. * Define the default inertia of the camera.
  30463. * This helps giving a smooth feeling to the camera movement.
  30464. */
  30465. inertia: number;
  30466. /**
  30467. * Define the mode of the camera (Camera.PERSPECTIVE_CAMERA or Camera.ORTHOGRAPHIC_CAMERA)
  30468. */
  30469. mode: number;
  30470. /**
  30471. * Define whether the camera is intermediate.
  30472. * This is useful to not present the output directly to the screen in case of rig without post process for instance
  30473. */
  30474. isIntermediate: boolean;
  30475. /**
  30476. * Define the viewport of the camera.
  30477. * This correspond to the portion of the screen the camera will render to in normalized 0 to 1 unit.
  30478. */
  30479. viewport: Viewport;
  30480. /**
  30481. * Restricts the camera to viewing objects with the same layerMask.
  30482. * A camera with a layerMask of 1 will render mesh.layerMask & camera.layerMask!== 0
  30483. */
  30484. layerMask: number;
  30485. /**
  30486. * fovMode sets the camera frustum bounds to the viewport bounds. (default is FOVMODE_VERTICAL_FIXED)
  30487. */
  30488. fovMode: number;
  30489. /**
  30490. * Rig mode of the camera.
  30491. * This is useful to create the camera with two "eyes" instead of one to create VR or stereoscopic scenes.
  30492. * This is normally controlled byt the camera themselves as internal use.
  30493. */
  30494. cameraRigMode: number;
  30495. /**
  30496. * Defines the distance between both "eyes" in case of a RIG
  30497. */
  30498. interaxialDistance: number;
  30499. /**
  30500. * Defines if stereoscopic rendering is done side by side or over under.
  30501. */
  30502. isStereoscopicSideBySide: boolean;
  30503. /**
  30504. * Defines the list of custom render target which are rendered to and then used as the input to this camera's render. Eg. display another camera view on a TV in the main scene
  30505. * This is pretty helpfull if you wish to make a camera render to a texture you could reuse somewhere
  30506. * else in the scene. (Eg. security camera)
  30507. *
  30508. * To change the final output target of the camera, camera.outputRenderTarget should be used instead (eg. webXR renders to a render target corrisponding to an HMD)
  30509. */
  30510. customRenderTargets: import("babylonjs/Materials/Textures/renderTargetTexture").RenderTargetTexture[];
  30511. /**
  30512. * When set, the camera will render to this render target instead of the default canvas
  30513. *
  30514. * If the desire is to use the output of a camera as a texture in the scene consider using camera.customRenderTargets instead
  30515. */
  30516. outputRenderTarget: Nullable<RenderTargetTexture>;
  30517. /**
  30518. * Observable triggered when the camera view matrix has changed.
  30519. */
  30520. onViewMatrixChangedObservable: Observable<Camera>;
  30521. /**
  30522. * Observable triggered when the camera Projection matrix has changed.
  30523. */
  30524. onProjectionMatrixChangedObservable: Observable<Camera>;
  30525. /**
  30526. * Observable triggered when the inputs have been processed.
  30527. */
  30528. onAfterCheckInputsObservable: Observable<Camera>;
  30529. /**
  30530. * Observable triggered when reset has been called and applied to the camera.
  30531. */
  30532. onRestoreStateObservable: Observable<Camera>;
  30533. /**
  30534. * Is this camera a part of a rig system?
  30535. */
  30536. isRigCamera: boolean;
  30537. /**
  30538. * If isRigCamera set to true this will be set with the parent camera.
  30539. * The parent camera is not (!) necessarily the .parent of this camera (like in the case of XR)
  30540. */
  30541. rigParent?: Camera;
  30542. /** @hidden */
  30543. _cameraRigParams: any;
  30544. /** @hidden */
  30545. _rigCameras: Camera[];
  30546. /** @hidden */
  30547. _rigPostProcess: Nullable<PostProcess>;
  30548. protected _webvrViewMatrix: Matrix;
  30549. /** @hidden */
  30550. _skipRendering: boolean;
  30551. /** @hidden */
  30552. _projectionMatrix: Matrix;
  30553. /** @hidden */
  30554. _postProcesses: Nullable<import("babylonjs/PostProcesses/postProcess").PostProcess>[];
  30555. /** @hidden */
  30556. _activeMeshes: SmartArray<AbstractMesh>;
  30557. protected _globalPosition: Vector3;
  30558. /** @hidden */
  30559. _computedViewMatrix: Matrix;
  30560. private _doNotComputeProjectionMatrix;
  30561. private _transformMatrix;
  30562. private _frustumPlanes;
  30563. private _refreshFrustumPlanes;
  30564. private _storedFov;
  30565. private _stateStored;
  30566. /**
  30567. * Instantiates a new camera object.
  30568. * This should not be used directly but through the inherited cameras: ArcRotate, Free...
  30569. * @see https://doc.babylonjs.com/features/cameras
  30570. * @param name Defines the name of the camera in the scene
  30571. * @param position Defines the position of the camera
  30572. * @param scene Defines the scene the camera belongs too
  30573. * @param setActiveOnSceneIfNoneActive Defines if the camera should be set as active after creation if no other camera have been defined in the scene
  30574. */
  30575. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  30576. /**
  30577. * Store current camera state (fov, position, etc..)
  30578. * @returns the camera
  30579. */
  30580. storeState(): Camera;
  30581. /**
  30582. * Restores the camera state values if it has been stored. You must call storeState() first
  30583. */
  30584. protected _restoreStateValues(): boolean;
  30585. /**
  30586. * Restored camera state. You must call storeState() first.
  30587. * @returns true if restored and false otherwise
  30588. */
  30589. restoreState(): boolean;
  30590. /**
  30591. * Gets the class name of the camera.
  30592. * @returns the class name
  30593. */
  30594. getClassName(): string;
  30595. /** @hidden */
  30596. readonly _isCamera: boolean;
  30597. /**
  30598. * Gets a string representation of the camera useful for debug purpose.
  30599. * @param fullDetails Defines that a more verboe level of logging is required
  30600. * @returns the string representation
  30601. */
  30602. toString(fullDetails?: boolean): string;
  30603. /**
  30604. * Gets the current world space position of the camera.
  30605. */
  30606. get globalPosition(): Vector3;
  30607. /**
  30608. * Gets the list of active meshes this frame (meshes no culled or excluded by lod s in the frame)
  30609. * @returns the active meshe list
  30610. */
  30611. getActiveMeshes(): SmartArray<AbstractMesh>;
  30612. /**
  30613. * Check whether a mesh is part of the current active mesh list of the camera
  30614. * @param mesh Defines the mesh to check
  30615. * @returns true if active, false otherwise
  30616. */
  30617. isActiveMesh(mesh: Mesh): boolean;
  30618. /**
  30619. * Is this camera ready to be used/rendered
  30620. * @param completeCheck defines if a complete check (including post processes) has to be done (false by default)
  30621. * @return true if the camera is ready
  30622. */
  30623. isReady(completeCheck?: boolean): boolean;
  30624. /** @hidden */
  30625. _initCache(): void;
  30626. /** @hidden */
  30627. _updateCache(ignoreParentClass?: boolean): void;
  30628. /** @hidden */
  30629. _isSynchronized(): boolean;
  30630. /** @hidden */
  30631. _isSynchronizedViewMatrix(): boolean;
  30632. /** @hidden */
  30633. _isSynchronizedProjectionMatrix(): boolean;
  30634. /**
  30635. * Attach the input controls to a specific dom element to get the input from.
  30636. * @param element Defines the element the controls should be listened from
  30637. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  30638. */
  30639. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  30640. /**
  30641. * Detach the current controls from the specified dom element.
  30642. * @param element Defines the element to stop listening the inputs from
  30643. */
  30644. detachControl(element: HTMLElement): void;
  30645. /**
  30646. * Update the camera state according to the different inputs gathered during the frame.
  30647. */
  30648. update(): void;
  30649. /** @hidden */
  30650. _checkInputs(): void;
  30651. /** @hidden */
  30652. get rigCameras(): Camera[];
  30653. /**
  30654. * Gets the post process used by the rig cameras
  30655. */
  30656. get rigPostProcess(): Nullable<PostProcess>;
  30657. /**
  30658. * Internal, gets the first post proces.
  30659. * @returns the first post process to be run on this camera.
  30660. */
  30661. _getFirstPostProcess(): Nullable<PostProcess>;
  30662. private _cascadePostProcessesToRigCams;
  30663. /**
  30664. * Attach a post process to the camera.
  30665. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  30666. * @param postProcess The post process to attach to the camera
  30667. * @param insertAt The position of the post process in case several of them are in use in the scene
  30668. * @returns the position the post process has been inserted at
  30669. */
  30670. attachPostProcess(postProcess: PostProcess, insertAt?: Nullable<number>): number;
  30671. /**
  30672. * Detach a post process to the camera.
  30673. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  30674. * @param postProcess The post process to detach from the camera
  30675. */
  30676. detachPostProcess(postProcess: PostProcess): void;
  30677. /**
  30678. * Gets the current world matrix of the camera
  30679. */
  30680. getWorldMatrix(): Matrix;
  30681. /** @hidden */
  30682. _getViewMatrix(): Matrix;
  30683. /**
  30684. * Gets the current view matrix of the camera.
  30685. * @param force forces the camera to recompute the matrix without looking at the cached state
  30686. * @returns the view matrix
  30687. */
  30688. getViewMatrix(force?: boolean): Matrix;
  30689. /**
  30690. * Freeze the projection matrix.
  30691. * It will prevent the cache check of the camera projection compute and can speed up perf
  30692. * if no parameter of the camera are meant to change
  30693. * @param projection Defines manually a projection if necessary
  30694. */
  30695. freezeProjectionMatrix(projection?: Matrix): void;
  30696. /**
  30697. * Unfreeze the projection matrix if it has previously been freezed by freezeProjectionMatrix.
  30698. */
  30699. unfreezeProjectionMatrix(): void;
  30700. /**
  30701. * Gets the current projection matrix of the camera.
  30702. * @param force forces the camera to recompute the matrix without looking at the cached state
  30703. * @returns the projection matrix
  30704. */
  30705. getProjectionMatrix(force?: boolean): Matrix;
  30706. /**
  30707. * Gets the transformation matrix (ie. the multiplication of view by projection matrices)
  30708. * @returns a Matrix
  30709. */
  30710. getTransformationMatrix(): Matrix;
  30711. private _updateFrustumPlanes;
  30712. /**
  30713. * Checks if a cullable object (mesh...) is in the camera frustum
  30714. * This checks the bounding box center. See isCompletelyInFrustum for a full bounding check
  30715. * @param target The object to check
  30716. * @param checkRigCameras If the rig cameras should be checked (eg. with webVR camera both eyes should be checked) (Default: false)
  30717. * @returns true if the object is in frustum otherwise false
  30718. */
  30719. isInFrustum(target: ICullable, checkRigCameras?: boolean): boolean;
  30720. /**
  30721. * Checks if a cullable object (mesh...) is in the camera frustum
  30722. * Unlike isInFrustum this cheks the full bounding box
  30723. * @param target The object to check
  30724. * @returns true if the object is in frustum otherwise false
  30725. */
  30726. isCompletelyInFrustum(target: ICullable): boolean;
  30727. /**
  30728. * Gets a ray in the forward direction from the camera.
  30729. * @param length Defines the length of the ray to create
  30730. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  30731. * @param origin Defines the start point of the ray which defaults to the camera position
  30732. * @returns the forward ray
  30733. */
  30734. getForwardRay(length?: number, transform?: Matrix, origin?: Vector3): Ray;
  30735. /**
  30736. * Gets a ray in the forward direction from the camera.
  30737. * @param refRay the ray to (re)use when setting the values
  30738. * @param length Defines the length of the ray to create
  30739. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  30740. * @param origin Defines the start point of the ray which defaults to the camera position
  30741. * @returns the forward ray
  30742. */
  30743. getForwardRayToRef(refRay: Ray, length?: number, transform?: Matrix, origin?: Vector3): Ray;
  30744. /**
  30745. * Releases resources associated with this node.
  30746. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  30747. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  30748. */
  30749. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  30750. /** @hidden */
  30751. _isLeftCamera: boolean;
  30752. /**
  30753. * Gets the left camera of a rig setup in case of Rigged Camera
  30754. */
  30755. get isLeftCamera(): boolean;
  30756. /** @hidden */
  30757. _isRightCamera: boolean;
  30758. /**
  30759. * Gets the right camera of a rig setup in case of Rigged Camera
  30760. */
  30761. get isRightCamera(): boolean;
  30762. /**
  30763. * Gets the left camera of a rig setup in case of Rigged Camera
  30764. */
  30765. get leftCamera(): Nullable<FreeCamera>;
  30766. /**
  30767. * Gets the right camera of a rig setup in case of Rigged Camera
  30768. */
  30769. get rightCamera(): Nullable<FreeCamera>;
  30770. /**
  30771. * Gets the left camera target of a rig setup in case of Rigged Camera
  30772. * @returns the target position
  30773. */
  30774. getLeftTarget(): Nullable<Vector3>;
  30775. /**
  30776. * Gets the right camera target of a rig setup in case of Rigged Camera
  30777. * @returns the target position
  30778. */
  30779. getRightTarget(): Nullable<Vector3>;
  30780. /**
  30781. * @hidden
  30782. */
  30783. setCameraRigMode(mode: number, rigParams: any): void;
  30784. /** @hidden */
  30785. static _setStereoscopicRigMode(camera: Camera): void;
  30786. /** @hidden */
  30787. static _setStereoscopicAnaglyphRigMode(camera: Camera): void;
  30788. /** @hidden */
  30789. static _setVRRigMode(camera: Camera, rigParams: any): void;
  30790. /** @hidden */
  30791. static _setWebVRRigMode(camera: Camera, rigParams: any): void;
  30792. /** @hidden */
  30793. _getVRProjectionMatrix(): Matrix;
  30794. protected _updateCameraRotationMatrix(): void;
  30795. protected _updateWebVRCameraRotationMatrix(): void;
  30796. /**
  30797. * This function MUST be overwritten by the different WebVR cameras available.
  30798. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  30799. * @hidden
  30800. */
  30801. _getWebVRProjectionMatrix(): Matrix;
  30802. /**
  30803. * This function MUST be overwritten by the different WebVR cameras available.
  30804. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  30805. * @hidden
  30806. */
  30807. _getWebVRViewMatrix(): Matrix;
  30808. /** @hidden */
  30809. setCameraRigParameter(name: string, value: any): void;
  30810. /**
  30811. * needs to be overridden by children so sub has required properties to be copied
  30812. * @hidden
  30813. */
  30814. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  30815. /**
  30816. * May need to be overridden by children
  30817. * @hidden
  30818. */
  30819. _updateRigCameras(): void;
  30820. /** @hidden */
  30821. _setupInputs(): void;
  30822. /**
  30823. * Serialiaze the camera setup to a json represention
  30824. * @returns the JSON representation
  30825. */
  30826. serialize(): any;
  30827. /**
  30828. * Clones the current camera.
  30829. * @param name The cloned camera name
  30830. * @returns the cloned camera
  30831. */
  30832. clone(name: string): Camera;
  30833. /**
  30834. * Gets the direction of the camera relative to a given local axis.
  30835. * @param localAxis Defines the reference axis to provide a relative direction.
  30836. * @return the direction
  30837. */
  30838. getDirection(localAxis: Vector3): Vector3;
  30839. /**
  30840. * Returns the current camera absolute rotation
  30841. */
  30842. get absoluteRotation(): Quaternion;
  30843. /**
  30844. * Gets the direction of the camera relative to a given local axis into a passed vector.
  30845. * @param localAxis Defines the reference axis to provide a relative direction.
  30846. * @param result Defines the vector to store the result in
  30847. */
  30848. getDirectionToRef(localAxis: Vector3, result: Vector3): void;
  30849. /**
  30850. * Gets a camera constructor for a given camera type
  30851. * @param type The type of the camera to construct (should be equal to one of the camera class name)
  30852. * @param name The name of the camera the result will be able to instantiate
  30853. * @param scene The scene the result will construct the camera in
  30854. * @param interaxial_distance In case of stereoscopic setup, the distance between both eyes
  30855. * @param isStereoscopicSideBySide In case of stereoscopic setup, should the sereo be side b side
  30856. * @returns a factory method to construc the camera
  30857. */
  30858. static GetConstructorFromName(type: string, name: string, scene: Scene, interaxial_distance?: number, isStereoscopicSideBySide?: boolean): () => Camera;
  30859. /**
  30860. * Compute the world matrix of the camera.
  30861. * @returns the camera world matrix
  30862. */
  30863. computeWorldMatrix(): Matrix;
  30864. /**
  30865. * Parse a JSON and creates the camera from the parsed information
  30866. * @param parsedCamera The JSON to parse
  30867. * @param scene The scene to instantiate the camera in
  30868. * @returns the newly constructed camera
  30869. */
  30870. static Parse(parsedCamera: any, scene: Scene): Camera;
  30871. }
  30872. }
  30873. declare module "babylonjs/Meshes/Builders/discBuilder" {
  30874. import { Nullable } from "babylonjs/types";
  30875. import { Scene } from "babylonjs/scene";
  30876. import { Vector4 } from "babylonjs/Maths/math.vector";
  30877. import { Mesh } from "babylonjs/Meshes/mesh";
  30878. /**
  30879. * Class containing static functions to help procedurally build meshes
  30880. */
  30881. export class DiscBuilder {
  30882. /**
  30883. * Creates a plane polygonal mesh. By default, this is a disc
  30884. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  30885. * * The parameter `tessellation` sets the number of polygon sides (positive integer, default 64). So a tessellation valued to 3 will build a triangle, to 4 a square, etc
  30886. * * You can create an unclosed polygon with the parameter `arc` (positive float, default 1), valued between 0 and 1, what is the ratio of the circumference : 2 x PI x ratio
  30887. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  30888. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  30889. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  30890. * @param name defines the name of the mesh
  30891. * @param options defines the options used to create the mesh
  30892. * @param scene defines the hosting scene
  30893. * @returns the plane polygonal mesh
  30894. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  30895. */
  30896. static CreateDisc(name: string, options: {
  30897. radius?: number;
  30898. tessellation?: number;
  30899. arc?: number;
  30900. updatable?: boolean;
  30901. sideOrientation?: number;
  30902. frontUVs?: Vector4;
  30903. backUVs?: Vector4;
  30904. }, scene?: Nullable<Scene>): Mesh;
  30905. }
  30906. }
  30907. declare module "babylonjs/Materials/fresnelParameters" {
  30908. import { DeepImmutable } from "babylonjs/types";
  30909. import { Color3 } from "babylonjs/Maths/math.color";
  30910. /**
  30911. * Options to be used when creating a FresnelParameters.
  30912. */
  30913. export type IFresnelParametersCreationOptions = {
  30914. /**
  30915. * Define the color used on edges (grazing angle)
  30916. */
  30917. leftColor?: Color3;
  30918. /**
  30919. * Define the color used on center
  30920. */
  30921. rightColor?: Color3;
  30922. /**
  30923. * Define bias applied to computed fresnel term
  30924. */
  30925. bias?: number;
  30926. /**
  30927. * Defined the power exponent applied to fresnel term
  30928. */
  30929. power?: number;
  30930. /**
  30931. * Define if the fresnel effect is enable or not.
  30932. */
  30933. isEnabled?: boolean;
  30934. };
  30935. /**
  30936. * Serialized format for FresnelParameters.
  30937. */
  30938. export type IFresnelParametersSerialized = {
  30939. /**
  30940. * Define the color used on edges (grazing angle) [as an array]
  30941. */
  30942. leftColor: number[];
  30943. /**
  30944. * Define the color used on center [as an array]
  30945. */
  30946. rightColor: number[];
  30947. /**
  30948. * Define bias applied to computed fresnel term
  30949. */
  30950. bias: number;
  30951. /**
  30952. * Defined the power exponent applied to fresnel term
  30953. */
  30954. power?: number;
  30955. /**
  30956. * Define if the fresnel effect is enable or not.
  30957. */
  30958. isEnabled: boolean;
  30959. };
  30960. /**
  30961. * This represents all the required information to add a fresnel effect on a material:
  30962. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  30963. */
  30964. export class FresnelParameters {
  30965. private _isEnabled;
  30966. /**
  30967. * Define if the fresnel effect is enable or not.
  30968. */
  30969. get isEnabled(): boolean;
  30970. set isEnabled(value: boolean);
  30971. /**
  30972. * Define the color used on edges (grazing angle)
  30973. */
  30974. leftColor: Color3;
  30975. /**
  30976. * Define the color used on center
  30977. */
  30978. rightColor: Color3;
  30979. /**
  30980. * Define bias applied to computed fresnel term
  30981. */
  30982. bias: number;
  30983. /**
  30984. * Defined the power exponent applied to fresnel term
  30985. */
  30986. power: number;
  30987. /**
  30988. * Creates a new FresnelParameters object.
  30989. *
  30990. * @param options provide your own settings to optionally to override defaults
  30991. */
  30992. constructor(options?: IFresnelParametersCreationOptions);
  30993. /**
  30994. * Clones the current fresnel and its valuues
  30995. * @returns a clone fresnel configuration
  30996. */
  30997. clone(): FresnelParameters;
  30998. /**
  30999. * Determines equality between FresnelParameters objects
  31000. * @param otherFresnelParameters defines the second operand
  31001. * @returns true if the power, bias, leftColor, rightColor and isEnabled values are equal to the given ones
  31002. */
  31003. equals(otherFresnelParameters: DeepImmutable<FresnelParameters>): boolean;
  31004. /**
  31005. * Serializes the current fresnel parameters to a JSON representation.
  31006. * @return the JSON serialization
  31007. */
  31008. serialize(): IFresnelParametersSerialized;
  31009. /**
  31010. * Parse a JSON object and deserialize it to a new Fresnel parameter object.
  31011. * @param parsedFresnelParameters Define the JSON representation
  31012. * @returns the parsed parameters
  31013. */
  31014. static Parse(parsedFresnelParameters: IFresnelParametersSerialized): FresnelParameters;
  31015. }
  31016. }
  31017. declare module "babylonjs/Materials/materialFlags" {
  31018. /**
  31019. * This groups all the flags used to control the materials channel.
  31020. */
  31021. export class MaterialFlags {
  31022. private static _DiffuseTextureEnabled;
  31023. /**
  31024. * Are diffuse textures enabled in the application.
  31025. */
  31026. static get DiffuseTextureEnabled(): boolean;
  31027. static set DiffuseTextureEnabled(value: boolean);
  31028. private static _DetailTextureEnabled;
  31029. /**
  31030. * Are detail textures enabled in the application.
  31031. */
  31032. static get DetailTextureEnabled(): boolean;
  31033. static set DetailTextureEnabled(value: boolean);
  31034. private static _AmbientTextureEnabled;
  31035. /**
  31036. * Are ambient textures enabled in the application.
  31037. */
  31038. static get AmbientTextureEnabled(): boolean;
  31039. static set AmbientTextureEnabled(value: boolean);
  31040. private static _OpacityTextureEnabled;
  31041. /**
  31042. * Are opacity textures enabled in the application.
  31043. */
  31044. static get OpacityTextureEnabled(): boolean;
  31045. static set OpacityTextureEnabled(value: boolean);
  31046. private static _ReflectionTextureEnabled;
  31047. /**
  31048. * Are reflection textures enabled in the application.
  31049. */
  31050. static get ReflectionTextureEnabled(): boolean;
  31051. static set ReflectionTextureEnabled(value: boolean);
  31052. private static _EmissiveTextureEnabled;
  31053. /**
  31054. * Are emissive textures enabled in the application.
  31055. */
  31056. static get EmissiveTextureEnabled(): boolean;
  31057. static set EmissiveTextureEnabled(value: boolean);
  31058. private static _SpecularTextureEnabled;
  31059. /**
  31060. * Are specular textures enabled in the application.
  31061. */
  31062. static get SpecularTextureEnabled(): boolean;
  31063. static set SpecularTextureEnabled(value: boolean);
  31064. private static _BumpTextureEnabled;
  31065. /**
  31066. * Are bump textures enabled in the application.
  31067. */
  31068. static get BumpTextureEnabled(): boolean;
  31069. static set BumpTextureEnabled(value: boolean);
  31070. private static _LightmapTextureEnabled;
  31071. /**
  31072. * Are lightmap textures enabled in the application.
  31073. */
  31074. static get LightmapTextureEnabled(): boolean;
  31075. static set LightmapTextureEnabled(value: boolean);
  31076. private static _RefractionTextureEnabled;
  31077. /**
  31078. * Are refraction textures enabled in the application.
  31079. */
  31080. static get RefractionTextureEnabled(): boolean;
  31081. static set RefractionTextureEnabled(value: boolean);
  31082. private static _ColorGradingTextureEnabled;
  31083. /**
  31084. * Are color grading textures enabled in the application.
  31085. */
  31086. static get ColorGradingTextureEnabled(): boolean;
  31087. static set ColorGradingTextureEnabled(value: boolean);
  31088. private static _FresnelEnabled;
  31089. /**
  31090. * Are fresnels enabled in the application.
  31091. */
  31092. static get FresnelEnabled(): boolean;
  31093. static set FresnelEnabled(value: boolean);
  31094. private static _ClearCoatTextureEnabled;
  31095. /**
  31096. * Are clear coat textures enabled in the application.
  31097. */
  31098. static get ClearCoatTextureEnabled(): boolean;
  31099. static set ClearCoatTextureEnabled(value: boolean);
  31100. private static _ClearCoatBumpTextureEnabled;
  31101. /**
  31102. * Are clear coat bump textures enabled in the application.
  31103. */
  31104. static get ClearCoatBumpTextureEnabled(): boolean;
  31105. static set ClearCoatBumpTextureEnabled(value: boolean);
  31106. private static _ClearCoatTintTextureEnabled;
  31107. /**
  31108. * Are clear coat tint textures enabled in the application.
  31109. */
  31110. static get ClearCoatTintTextureEnabled(): boolean;
  31111. static set ClearCoatTintTextureEnabled(value: boolean);
  31112. private static _SheenTextureEnabled;
  31113. /**
  31114. * Are sheen textures enabled in the application.
  31115. */
  31116. static get SheenTextureEnabled(): boolean;
  31117. static set SheenTextureEnabled(value: boolean);
  31118. private static _AnisotropicTextureEnabled;
  31119. /**
  31120. * Are anisotropic textures enabled in the application.
  31121. */
  31122. static get AnisotropicTextureEnabled(): boolean;
  31123. static set AnisotropicTextureEnabled(value: boolean);
  31124. private static _ThicknessTextureEnabled;
  31125. /**
  31126. * Are thickness textures enabled in the application.
  31127. */
  31128. static get ThicknessTextureEnabled(): boolean;
  31129. static set ThicknessTextureEnabled(value: boolean);
  31130. }
  31131. }
  31132. declare module "babylonjs/Shaders/ShadersInclude/defaultFragmentDeclaration" {
  31133. /** @hidden */
  31134. export var defaultFragmentDeclaration: {
  31135. name: string;
  31136. shader: string;
  31137. };
  31138. }
  31139. declare module "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration" {
  31140. /** @hidden */
  31141. export var defaultUboDeclaration: {
  31142. name: string;
  31143. shader: string;
  31144. };
  31145. }
  31146. declare module "babylonjs/Shaders/ShadersInclude/prePassDeclaration" {
  31147. /** @hidden */
  31148. export var prePassDeclaration: {
  31149. name: string;
  31150. shader: string;
  31151. };
  31152. }
  31153. declare module "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration" {
  31154. /** @hidden */
  31155. export var lightFragmentDeclaration: {
  31156. name: string;
  31157. shader: string;
  31158. };
  31159. }
  31160. declare module "babylonjs/Shaders/ShadersInclude/lightUboDeclaration" {
  31161. /** @hidden */
  31162. export var lightUboDeclaration: {
  31163. name: string;
  31164. shader: string;
  31165. };
  31166. }
  31167. declare module "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions" {
  31168. /** @hidden */
  31169. export var lightsFragmentFunctions: {
  31170. name: string;
  31171. shader: string;
  31172. };
  31173. }
  31174. declare module "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions" {
  31175. /** @hidden */
  31176. export var shadowsFragmentFunctions: {
  31177. name: string;
  31178. shader: string;
  31179. };
  31180. }
  31181. declare module "babylonjs/Shaders/ShadersInclude/fresnelFunction" {
  31182. /** @hidden */
  31183. export var fresnelFunction: {
  31184. name: string;
  31185. shader: string;
  31186. };
  31187. }
  31188. declare module "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions" {
  31189. /** @hidden */
  31190. export var bumpFragmentMainFunctions: {
  31191. name: string;
  31192. shader: string;
  31193. };
  31194. }
  31195. declare module "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions" {
  31196. /** @hidden */
  31197. export var bumpFragmentFunctions: {
  31198. name: string;
  31199. shader: string;
  31200. };
  31201. }
  31202. declare module "babylonjs/Shaders/ShadersInclude/logDepthDeclaration" {
  31203. /** @hidden */
  31204. export var logDepthDeclaration: {
  31205. name: string;
  31206. shader: string;
  31207. };
  31208. }
  31209. declare module "babylonjs/Shaders/ShadersInclude/bumpFragment" {
  31210. /** @hidden */
  31211. export var bumpFragment: {
  31212. name: string;
  31213. shader: string;
  31214. };
  31215. }
  31216. declare module "babylonjs/Shaders/ShadersInclude/depthPrePass" {
  31217. /** @hidden */
  31218. export var depthPrePass: {
  31219. name: string;
  31220. shader: string;
  31221. };
  31222. }
  31223. declare module "babylonjs/Shaders/ShadersInclude/lightFragment" {
  31224. /** @hidden */
  31225. export var lightFragment: {
  31226. name: string;
  31227. shader: string;
  31228. };
  31229. }
  31230. declare module "babylonjs/Shaders/ShadersInclude/logDepthFragment" {
  31231. /** @hidden */
  31232. export var logDepthFragment: {
  31233. name: string;
  31234. shader: string;
  31235. };
  31236. }
  31237. declare module "babylonjs/Shaders/default.fragment" {
  31238. import "babylonjs/Shaders/ShadersInclude/defaultFragmentDeclaration";
  31239. import "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration";
  31240. import "babylonjs/Shaders/ShadersInclude/prePassDeclaration";
  31241. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  31242. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  31243. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  31244. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  31245. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  31246. import "babylonjs/Shaders/ShadersInclude/fresnelFunction";
  31247. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  31248. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  31249. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  31250. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  31251. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  31252. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  31253. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  31254. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  31255. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  31256. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  31257. import "babylonjs/Shaders/ShadersInclude/depthPrePass";
  31258. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  31259. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  31260. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  31261. /** @hidden */
  31262. export var defaultPixelShader: {
  31263. name: string;
  31264. shader: string;
  31265. };
  31266. }
  31267. declare module "babylonjs/Shaders/ShadersInclude/defaultVertexDeclaration" {
  31268. /** @hidden */
  31269. export var defaultVertexDeclaration: {
  31270. name: string;
  31271. shader: string;
  31272. };
  31273. }
  31274. declare module "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration" {
  31275. /** @hidden */
  31276. export var bumpVertexDeclaration: {
  31277. name: string;
  31278. shader: string;
  31279. };
  31280. }
  31281. declare module "babylonjs/Shaders/ShadersInclude/bumpVertex" {
  31282. /** @hidden */
  31283. export var bumpVertex: {
  31284. name: string;
  31285. shader: string;
  31286. };
  31287. }
  31288. declare module "babylonjs/Shaders/ShadersInclude/fogVertex" {
  31289. /** @hidden */
  31290. export var fogVertex: {
  31291. name: string;
  31292. shader: string;
  31293. };
  31294. }
  31295. declare module "babylonjs/Shaders/ShadersInclude/shadowsVertex" {
  31296. /** @hidden */
  31297. export var shadowsVertex: {
  31298. name: string;
  31299. shader: string;
  31300. };
  31301. }
  31302. declare module "babylonjs/Shaders/ShadersInclude/pointCloudVertex" {
  31303. /** @hidden */
  31304. export var pointCloudVertex: {
  31305. name: string;
  31306. shader: string;
  31307. };
  31308. }
  31309. declare module "babylonjs/Shaders/ShadersInclude/logDepthVertex" {
  31310. /** @hidden */
  31311. export var logDepthVertex: {
  31312. name: string;
  31313. shader: string;
  31314. };
  31315. }
  31316. declare module "babylonjs/Shaders/default.vertex" {
  31317. import "babylonjs/Shaders/ShadersInclude/defaultVertexDeclaration";
  31318. import "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration";
  31319. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  31320. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  31321. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  31322. import "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration";
  31323. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  31324. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  31325. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  31326. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  31327. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  31328. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  31329. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  31330. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  31331. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  31332. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  31333. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  31334. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  31335. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  31336. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  31337. import "babylonjs/Shaders/ShadersInclude/pointCloudVertex";
  31338. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  31339. /** @hidden */
  31340. export var defaultVertexShader: {
  31341. name: string;
  31342. shader: string;
  31343. };
  31344. }
  31345. declare module "babylonjs/Materials/material.detailMapConfiguration" {
  31346. import { Nullable } from "babylonjs/types";
  31347. import { Scene } from "babylonjs/scene";
  31348. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  31349. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  31350. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  31351. /**
  31352. * @hidden
  31353. */
  31354. export interface IMaterialDetailMapDefines {
  31355. DETAIL: boolean;
  31356. DETAILDIRECTUV: number;
  31357. DETAIL_NORMALBLENDMETHOD: number;
  31358. /** @hidden */
  31359. _areTexturesDirty: boolean;
  31360. }
  31361. /**
  31362. * Define the code related to the detail map parameters of a material
  31363. *
  31364. * Inspired from:
  31365. * Unity: https://docs.unity3d.com/Packages/com.unity.render-pipelines.high-definition@9.0/manual/Mask-Map-and-Detail-Map.html and https://docs.unity3d.com/Manual/StandardShaderMaterialParameterDetail.html
  31366. * Unreal: https://docs.unrealengine.com/en-US/Engine/Rendering/Materials/HowTo/DetailTexturing/index.html
  31367. * Cryengine: https://docs.cryengine.com/display/SDKDOC2/Detail+Maps
  31368. */
  31369. export class DetailMapConfiguration {
  31370. private _texture;
  31371. /**
  31372. * The detail texture of the material.
  31373. */
  31374. texture: Nullable<BaseTexture>;
  31375. /**
  31376. * Defines how strongly the detail diffuse/albedo channel is blended with the regular diffuse/albedo texture
  31377. * Bigger values mean stronger blending
  31378. */
  31379. diffuseBlendLevel: number;
  31380. /**
  31381. * Defines how strongly the detail roughness channel is blended with the regular roughness value
  31382. * Bigger values mean stronger blending. Only used with PBR materials
  31383. */
  31384. roughnessBlendLevel: number;
  31385. /**
  31386. * Defines how strong the bump effect from the detail map is
  31387. * Bigger values mean stronger effect
  31388. */
  31389. bumpLevel: number;
  31390. private _normalBlendMethod;
  31391. /**
  31392. * The method used to blend the bump and detail normals together
  31393. */
  31394. normalBlendMethod: number;
  31395. private _isEnabled;
  31396. /**
  31397. * Enable or disable the detail map on this material
  31398. */
  31399. isEnabled: boolean;
  31400. /** @hidden */
  31401. private _internalMarkAllSubMeshesAsTexturesDirty;
  31402. /** @hidden */
  31403. _markAllSubMeshesAsTexturesDirty(): void;
  31404. /**
  31405. * Instantiate a new detail map
  31406. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  31407. */
  31408. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  31409. /**
  31410. * Gets whether the submesh is ready to be used or not.
  31411. * @param defines the list of "defines" to update.
  31412. * @param scene defines the scene the material belongs to.
  31413. * @returns - boolean indicating that the submesh is ready or not.
  31414. */
  31415. isReadyForSubMesh(defines: IMaterialDetailMapDefines, scene: Scene): boolean;
  31416. /**
  31417. * Update the defines for detail map usage
  31418. * @param defines the list of "defines" to update.
  31419. * @param scene defines the scene the material belongs to.
  31420. */
  31421. prepareDefines(defines: IMaterialDetailMapDefines, scene: Scene): void;
  31422. /**
  31423. * Binds the material data.
  31424. * @param uniformBuffer defines the Uniform buffer to fill in.
  31425. * @param scene defines the scene the material belongs to.
  31426. * @param isFrozen defines whether the material is frozen or not.
  31427. */
  31428. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  31429. /**
  31430. * Checks to see if a texture is used in the material.
  31431. * @param texture - Base texture to use.
  31432. * @returns - Boolean specifying if a texture is used in the material.
  31433. */
  31434. hasTexture(texture: BaseTexture): boolean;
  31435. /**
  31436. * Returns an array of the actively used textures.
  31437. * @param activeTextures Array of BaseTextures
  31438. */
  31439. getActiveTextures(activeTextures: BaseTexture[]): void;
  31440. /**
  31441. * Returns the animatable textures.
  31442. * @param animatables Array of animatable textures.
  31443. */
  31444. getAnimatables(animatables: IAnimatable[]): void;
  31445. /**
  31446. * Disposes the resources of the material.
  31447. * @param forceDisposeTextures - Forces the disposal of all textures.
  31448. */
  31449. dispose(forceDisposeTextures?: boolean): void;
  31450. /**
  31451. * Get the current class name useful for serialization or dynamic coding.
  31452. * @returns "DetailMap"
  31453. */
  31454. getClassName(): string;
  31455. /**
  31456. * Add the required uniforms to the current list.
  31457. * @param uniforms defines the current uniform list.
  31458. */
  31459. static AddUniforms(uniforms: string[]): void;
  31460. /**
  31461. * Add the required samplers to the current list.
  31462. * @param samplers defines the current sampler list.
  31463. */
  31464. static AddSamplers(samplers: string[]): void;
  31465. /**
  31466. * Add the required uniforms to the current buffer.
  31467. * @param uniformBuffer defines the current uniform buffer.
  31468. */
  31469. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  31470. /**
  31471. * Makes a duplicate of the current instance into another one.
  31472. * @param detailMap define the instance where to copy the info
  31473. */
  31474. copyTo(detailMap: DetailMapConfiguration): void;
  31475. /**
  31476. * Serializes this detail map instance
  31477. * @returns - An object with the serialized instance.
  31478. */
  31479. serialize(): any;
  31480. /**
  31481. * Parses a detail map setting from a serialized object.
  31482. * @param source - Serialized object.
  31483. * @param scene Defines the scene we are parsing for
  31484. * @param rootUrl Defines the rootUrl to load from
  31485. */
  31486. parse(source: any, scene: Scene, rootUrl: string): void;
  31487. }
  31488. }
  31489. declare module "babylonjs/Materials/standardMaterial" {
  31490. import { SmartArray } from "babylonjs/Misc/smartArray";
  31491. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  31492. import { Nullable } from "babylonjs/types";
  31493. import { Scene } from "babylonjs/scene";
  31494. import { Matrix } from "babylonjs/Maths/math.vector";
  31495. import { Color3 } from "babylonjs/Maths/math.color";
  31496. import { SubMesh } from "babylonjs/Meshes/subMesh";
  31497. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  31498. import { Mesh } from "babylonjs/Meshes/mesh";
  31499. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  31500. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  31501. import { FresnelParameters } from "babylonjs/Materials/fresnelParameters";
  31502. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  31503. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  31504. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  31505. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  31506. import "babylonjs/Shaders/default.fragment";
  31507. import "babylonjs/Shaders/default.vertex";
  31508. import { IMaterialDetailMapDefines, DetailMapConfiguration } from "babylonjs/Materials/material.detailMapConfiguration";
  31509. /** @hidden */
  31510. export class StandardMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialDetailMapDefines {
  31511. MAINUV1: boolean;
  31512. MAINUV2: boolean;
  31513. DIFFUSE: boolean;
  31514. DIFFUSEDIRECTUV: number;
  31515. DETAIL: boolean;
  31516. DETAILDIRECTUV: number;
  31517. DETAIL_NORMALBLENDMETHOD: number;
  31518. AMBIENT: boolean;
  31519. AMBIENTDIRECTUV: number;
  31520. OPACITY: boolean;
  31521. OPACITYDIRECTUV: number;
  31522. OPACITYRGB: boolean;
  31523. REFLECTION: boolean;
  31524. EMISSIVE: boolean;
  31525. EMISSIVEDIRECTUV: number;
  31526. SPECULAR: boolean;
  31527. SPECULARDIRECTUV: number;
  31528. BUMP: boolean;
  31529. BUMPDIRECTUV: number;
  31530. PARALLAX: boolean;
  31531. PARALLAXOCCLUSION: boolean;
  31532. SPECULAROVERALPHA: boolean;
  31533. CLIPPLANE: boolean;
  31534. CLIPPLANE2: boolean;
  31535. CLIPPLANE3: boolean;
  31536. CLIPPLANE4: boolean;
  31537. CLIPPLANE5: boolean;
  31538. CLIPPLANE6: boolean;
  31539. ALPHATEST: boolean;
  31540. DEPTHPREPASS: boolean;
  31541. ALPHAFROMDIFFUSE: boolean;
  31542. POINTSIZE: boolean;
  31543. FOG: boolean;
  31544. SPECULARTERM: boolean;
  31545. DIFFUSEFRESNEL: boolean;
  31546. OPACITYFRESNEL: boolean;
  31547. REFLECTIONFRESNEL: boolean;
  31548. REFRACTIONFRESNEL: boolean;
  31549. EMISSIVEFRESNEL: boolean;
  31550. FRESNEL: boolean;
  31551. NORMAL: boolean;
  31552. UV1: boolean;
  31553. UV2: boolean;
  31554. VERTEXCOLOR: boolean;
  31555. VERTEXALPHA: boolean;
  31556. NUM_BONE_INFLUENCERS: number;
  31557. BonesPerMesh: number;
  31558. BONETEXTURE: boolean;
  31559. INSTANCES: boolean;
  31560. THIN_INSTANCES: boolean;
  31561. GLOSSINESS: boolean;
  31562. ROUGHNESS: boolean;
  31563. EMISSIVEASILLUMINATION: boolean;
  31564. LINKEMISSIVEWITHDIFFUSE: boolean;
  31565. REFLECTIONFRESNELFROMSPECULAR: boolean;
  31566. LIGHTMAP: boolean;
  31567. LIGHTMAPDIRECTUV: number;
  31568. OBJECTSPACE_NORMALMAP: boolean;
  31569. USELIGHTMAPASSHADOWMAP: boolean;
  31570. REFLECTIONMAP_3D: boolean;
  31571. REFLECTIONMAP_SPHERICAL: boolean;
  31572. REFLECTIONMAP_PLANAR: boolean;
  31573. REFLECTIONMAP_CUBIC: boolean;
  31574. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  31575. REFLECTIONMAP_PROJECTION: boolean;
  31576. REFLECTIONMAP_SKYBOX: boolean;
  31577. REFLECTIONMAP_EXPLICIT: boolean;
  31578. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  31579. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  31580. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  31581. INVERTCUBICMAP: boolean;
  31582. LOGARITHMICDEPTH: boolean;
  31583. REFRACTION: boolean;
  31584. REFRACTIONMAP_3D: boolean;
  31585. REFLECTIONOVERALPHA: boolean;
  31586. TWOSIDEDLIGHTING: boolean;
  31587. SHADOWFLOAT: boolean;
  31588. MORPHTARGETS: boolean;
  31589. MORPHTARGETS_NORMAL: boolean;
  31590. MORPHTARGETS_TANGENT: boolean;
  31591. MORPHTARGETS_UV: boolean;
  31592. NUM_MORPH_INFLUENCERS: number;
  31593. NONUNIFORMSCALING: boolean;
  31594. PREMULTIPLYALPHA: boolean;
  31595. ALPHATEST_AFTERALLALPHACOMPUTATIONS: boolean;
  31596. ALPHABLEND: boolean;
  31597. PREPASS: boolean;
  31598. SCENE_MRT_COUNT: number;
  31599. RGBDLIGHTMAP: boolean;
  31600. RGBDREFLECTION: boolean;
  31601. RGBDREFRACTION: boolean;
  31602. IMAGEPROCESSING: boolean;
  31603. VIGNETTE: boolean;
  31604. VIGNETTEBLENDMODEMULTIPLY: boolean;
  31605. VIGNETTEBLENDMODEOPAQUE: boolean;
  31606. TONEMAPPING: boolean;
  31607. TONEMAPPING_ACES: boolean;
  31608. CONTRAST: boolean;
  31609. COLORCURVES: boolean;
  31610. COLORGRADING: boolean;
  31611. COLORGRADING3D: boolean;
  31612. SAMPLER3DGREENDEPTH: boolean;
  31613. SAMPLER3DBGRMAP: boolean;
  31614. IMAGEPROCESSINGPOSTPROCESS: boolean;
  31615. MULTIVIEW: boolean;
  31616. /**
  31617. * If the reflection texture on this material is in linear color space
  31618. * @hidden
  31619. */
  31620. IS_REFLECTION_LINEAR: boolean;
  31621. /**
  31622. * If the refraction texture on this material is in linear color space
  31623. * @hidden
  31624. */
  31625. IS_REFRACTION_LINEAR: boolean;
  31626. EXPOSURE: boolean;
  31627. constructor();
  31628. setReflectionMode(modeToEnable: string): void;
  31629. }
  31630. /**
  31631. * This is the default material used in Babylon. It is the best trade off between quality
  31632. * and performances.
  31633. * @see https://doc.babylonjs.com/babylon101/materials
  31634. */
  31635. export class StandardMaterial extends PushMaterial {
  31636. private _diffuseTexture;
  31637. /**
  31638. * The basic texture of the material as viewed under a light.
  31639. */
  31640. diffuseTexture: Nullable<BaseTexture>;
  31641. private _ambientTexture;
  31642. /**
  31643. * AKA Occlusion Texture in other nomenclature, it helps adding baked shadows into your material.
  31644. */
  31645. ambientTexture: Nullable<BaseTexture>;
  31646. private _opacityTexture;
  31647. /**
  31648. * Define the transparency of the material from a texture.
  31649. * The final alpha value can be read either from the red channel (if texture.getAlphaFromRGB is false)
  31650. * or from the luminance or the current texel (if texture.getAlphaFromRGB is true)
  31651. */
  31652. opacityTexture: Nullable<BaseTexture>;
  31653. private _reflectionTexture;
  31654. /**
  31655. * Define the texture used to display the reflection.
  31656. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  31657. */
  31658. reflectionTexture: Nullable<BaseTexture>;
  31659. private _emissiveTexture;
  31660. /**
  31661. * Define texture of the material as if self lit.
  31662. * This will be mixed in the final result even in the absence of light.
  31663. */
  31664. emissiveTexture: Nullable<BaseTexture>;
  31665. private _specularTexture;
  31666. /**
  31667. * Define how the color and intensity of the highlight given by the light in the material.
  31668. */
  31669. specularTexture: Nullable<BaseTexture>;
  31670. private _bumpTexture;
  31671. /**
  31672. * Bump mapping is a technique to simulate bump and dents on a rendered surface.
  31673. * These are made by creating a normal map from an image. The means to do this can be found on the web, a search for 'normal map generator' will bring up free and paid for methods of doing this.
  31674. * @see https://doc.babylonjs.com/how_to/more_materials#bump-map
  31675. */
  31676. bumpTexture: Nullable<BaseTexture>;
  31677. private _lightmapTexture;
  31678. /**
  31679. * Complex lighting can be computationally expensive to compute at runtime.
  31680. * To save on computation, lightmaps may be used to store calculated lighting in a texture which will be applied to a given mesh.
  31681. * @see https://doc.babylonjs.com/babylon101/lights#lightmaps
  31682. */
  31683. lightmapTexture: Nullable<BaseTexture>;
  31684. private _refractionTexture;
  31685. /**
  31686. * Define the texture used to display the refraction.
  31687. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  31688. */
  31689. refractionTexture: Nullable<BaseTexture>;
  31690. /**
  31691. * The color of the material lit by the environmental background lighting.
  31692. * @see https://doc.babylonjs.com/babylon101/materials#ambient-color-example
  31693. */
  31694. ambientColor: Color3;
  31695. /**
  31696. * The basic color of the material as viewed under a light.
  31697. */
  31698. diffuseColor: Color3;
  31699. /**
  31700. * Define how the color and intensity of the highlight given by the light in the material.
  31701. */
  31702. specularColor: Color3;
  31703. /**
  31704. * Define the color of the material as if self lit.
  31705. * This will be mixed in the final result even in the absence of light.
  31706. */
  31707. emissiveColor: Color3;
  31708. /**
  31709. * Defines how sharp are the highlights in the material.
  31710. * The bigger the value the sharper giving a more glossy feeling to the result.
  31711. * Reversely, the smaller the value the blurrier giving a more rough feeling to the result.
  31712. */
  31713. specularPower: number;
  31714. private _useAlphaFromDiffuseTexture;
  31715. /**
  31716. * Does the transparency come from the diffuse texture alpha channel.
  31717. */
  31718. useAlphaFromDiffuseTexture: boolean;
  31719. private _useEmissiveAsIllumination;
  31720. /**
  31721. * If true, the emissive value is added into the end result, otherwise it is multiplied in.
  31722. */
  31723. useEmissiveAsIllumination: boolean;
  31724. private _linkEmissiveWithDiffuse;
  31725. /**
  31726. * If true, some kind of energy conservation will prevent the end result to be more than 1 by reducing
  31727. * the emissive level when the final color is close to one.
  31728. */
  31729. linkEmissiveWithDiffuse: boolean;
  31730. private _useSpecularOverAlpha;
  31731. /**
  31732. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  31733. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  31734. */
  31735. useSpecularOverAlpha: boolean;
  31736. private _useReflectionOverAlpha;
  31737. /**
  31738. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  31739. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  31740. */
  31741. useReflectionOverAlpha: boolean;
  31742. private _disableLighting;
  31743. /**
  31744. * Does lights from the scene impacts this material.
  31745. * It can be a nice trick for performance to disable lighting on a fully emissive material.
  31746. */
  31747. disableLighting: boolean;
  31748. private _useObjectSpaceNormalMap;
  31749. /**
  31750. * Allows using an object space normal map (instead of tangent space).
  31751. */
  31752. useObjectSpaceNormalMap: boolean;
  31753. private _useParallax;
  31754. /**
  31755. * Is parallax enabled or not.
  31756. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  31757. */
  31758. useParallax: boolean;
  31759. private _useParallaxOcclusion;
  31760. /**
  31761. * Is parallax occlusion enabled or not.
  31762. * If true, the outcome is way more realistic than traditional Parallax but you can expect a performance hit that worthes consideration.
  31763. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  31764. */
  31765. useParallaxOcclusion: boolean;
  31766. /**
  31767. * Apply a scaling factor that determine which "depth" the height map should reprensent. A value between 0.05 and 0.1 is reasonnable in Parallax, you can reach 0.2 using Parallax Occlusion.
  31768. */
  31769. parallaxScaleBias: number;
  31770. private _roughness;
  31771. /**
  31772. * Helps to define how blurry the reflections should appears in the material.
  31773. */
  31774. roughness: number;
  31775. /**
  31776. * In case of refraction, define the value of the index of refraction.
  31777. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  31778. */
  31779. indexOfRefraction: number;
  31780. /**
  31781. * Invert the refraction texture alongside the y axis.
  31782. * It can be useful with procedural textures or probe for instance.
  31783. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  31784. */
  31785. invertRefractionY: boolean;
  31786. /**
  31787. * Defines the alpha limits in alpha test mode.
  31788. */
  31789. alphaCutOff: number;
  31790. private _useLightmapAsShadowmap;
  31791. /**
  31792. * In case of light mapping, define whether the map contains light or shadow informations.
  31793. */
  31794. useLightmapAsShadowmap: boolean;
  31795. private _diffuseFresnelParameters;
  31796. /**
  31797. * Define the diffuse fresnel parameters of the material.
  31798. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31799. */
  31800. diffuseFresnelParameters: FresnelParameters;
  31801. private _opacityFresnelParameters;
  31802. /**
  31803. * Define the opacity fresnel parameters of the material.
  31804. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31805. */
  31806. opacityFresnelParameters: FresnelParameters;
  31807. private _reflectionFresnelParameters;
  31808. /**
  31809. * Define the reflection fresnel parameters of the material.
  31810. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31811. */
  31812. reflectionFresnelParameters: FresnelParameters;
  31813. private _refractionFresnelParameters;
  31814. /**
  31815. * Define the refraction fresnel parameters of the material.
  31816. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31817. */
  31818. refractionFresnelParameters: FresnelParameters;
  31819. private _emissiveFresnelParameters;
  31820. /**
  31821. * Define the emissive fresnel parameters of the material.
  31822. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31823. */
  31824. emissiveFresnelParameters: FresnelParameters;
  31825. private _useReflectionFresnelFromSpecular;
  31826. /**
  31827. * If true automatically deducts the fresnels values from the material specularity.
  31828. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31829. */
  31830. useReflectionFresnelFromSpecular: boolean;
  31831. private _useGlossinessFromSpecularMapAlpha;
  31832. /**
  31833. * Defines if the glossiness/roughness of the material should be read from the specular map alpha channel
  31834. */
  31835. useGlossinessFromSpecularMapAlpha: boolean;
  31836. private _maxSimultaneousLights;
  31837. /**
  31838. * Defines the maximum number of lights that can be used in the material
  31839. */
  31840. maxSimultaneousLights: number;
  31841. private _invertNormalMapX;
  31842. /**
  31843. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  31844. */
  31845. invertNormalMapX: boolean;
  31846. private _invertNormalMapY;
  31847. /**
  31848. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  31849. */
  31850. invertNormalMapY: boolean;
  31851. private _twoSidedLighting;
  31852. /**
  31853. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  31854. */
  31855. twoSidedLighting: boolean;
  31856. /**
  31857. * Default configuration related to image processing available in the standard Material.
  31858. */
  31859. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  31860. /**
  31861. * Gets the image processing configuration used either in this material.
  31862. */
  31863. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  31864. /**
  31865. * Sets the Default image processing configuration used either in the this material.
  31866. *
  31867. * If sets to null, the scene one is in use.
  31868. */
  31869. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  31870. /**
  31871. * Keep track of the image processing observer to allow dispose and replace.
  31872. */
  31873. private _imageProcessingObserver;
  31874. /**
  31875. * Attaches a new image processing configuration to the Standard Material.
  31876. * @param configuration
  31877. */
  31878. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  31879. /**
  31880. * Gets wether the color curves effect is enabled.
  31881. */
  31882. get cameraColorCurvesEnabled(): boolean;
  31883. /**
  31884. * Sets wether the color curves effect is enabled.
  31885. */
  31886. set cameraColorCurvesEnabled(value: boolean);
  31887. /**
  31888. * Gets wether the color grading effect is enabled.
  31889. */
  31890. get cameraColorGradingEnabled(): boolean;
  31891. /**
  31892. * Gets wether the color grading effect is enabled.
  31893. */
  31894. set cameraColorGradingEnabled(value: boolean);
  31895. /**
  31896. * Gets wether tonemapping is enabled or not.
  31897. */
  31898. get cameraToneMappingEnabled(): boolean;
  31899. /**
  31900. * Sets wether tonemapping is enabled or not
  31901. */
  31902. set cameraToneMappingEnabled(value: boolean);
  31903. /**
  31904. * The camera exposure used on this material.
  31905. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  31906. * This corresponds to a photographic exposure.
  31907. */
  31908. get cameraExposure(): number;
  31909. /**
  31910. * The camera exposure used on this material.
  31911. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  31912. * This corresponds to a photographic exposure.
  31913. */
  31914. set cameraExposure(value: number);
  31915. /**
  31916. * Gets The camera contrast used on this material.
  31917. */
  31918. get cameraContrast(): number;
  31919. /**
  31920. * Sets The camera contrast used on this material.
  31921. */
  31922. set cameraContrast(value: number);
  31923. /**
  31924. * Gets the Color Grading 2D Lookup Texture.
  31925. */
  31926. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  31927. /**
  31928. * Sets the Color Grading 2D Lookup Texture.
  31929. */
  31930. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  31931. /**
  31932. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  31933. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  31934. * These are similar to controls found in many professional imaging or colorist software. The global controls are applied to the entire image. For advanced tuning, extra controls are provided to adjust the shadow, midtone and highlight areas of the image;
  31935. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  31936. */
  31937. get cameraColorCurves(): Nullable<ColorCurves>;
  31938. /**
  31939. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  31940. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  31941. * These are similar to controls found in many professional imaging or colorist software. The global controls are applied to the entire image. For advanced tuning, extra controls are provided to adjust the shadow, midtone and highlight areas of the image;
  31942. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  31943. */
  31944. set cameraColorCurves(value: Nullable<ColorCurves>);
  31945. /**
  31946. * Can this material render to several textures at once
  31947. */
  31948. get canRenderToMRT(): boolean;
  31949. /**
  31950. * Defines the detail map parameters for the material.
  31951. */
  31952. readonly detailMap: DetailMapConfiguration;
  31953. protected _renderTargets: SmartArray<RenderTargetTexture>;
  31954. protected _worldViewProjectionMatrix: Matrix;
  31955. protected _globalAmbientColor: Color3;
  31956. protected _useLogarithmicDepth: boolean;
  31957. protected _rebuildInParallel: boolean;
  31958. /**
  31959. * Instantiates a new standard material.
  31960. * This is the default material used in Babylon. It is the best trade off between quality
  31961. * and performances.
  31962. * @see https://doc.babylonjs.com/babylon101/materials
  31963. * @param name Define the name of the material in the scene
  31964. * @param scene Define the scene the material belong to
  31965. */
  31966. constructor(name: string, scene: Scene);
  31967. /**
  31968. * Gets a boolean indicating that current material needs to register RTT
  31969. */
  31970. get hasRenderTargetTextures(): boolean;
  31971. /**
  31972. * Gets the current class name of the material e.g. "StandardMaterial"
  31973. * Mainly use in serialization.
  31974. * @returns the class name
  31975. */
  31976. getClassName(): string;
  31977. /**
  31978. * In case the depth buffer does not allow enough depth precision for your scene (might be the case in large scenes)
  31979. * You can try switching to logarithmic depth.
  31980. * @see https://doc.babylonjs.com/how_to/using_logarithmic_depth_buffer
  31981. */
  31982. get useLogarithmicDepth(): boolean;
  31983. set useLogarithmicDepth(value: boolean);
  31984. /**
  31985. * Specifies if the material will require alpha blending
  31986. * @returns a boolean specifying if alpha blending is needed
  31987. */
  31988. needAlphaBlending(): boolean;
  31989. /**
  31990. * Specifies if this material should be rendered in alpha test mode
  31991. * @returns a boolean specifying if an alpha test is needed.
  31992. */
  31993. needAlphaTesting(): boolean;
  31994. protected _shouldUseAlphaFromDiffuseTexture(): boolean;
  31995. /**
  31996. * Get the texture used for alpha test purpose.
  31997. * @returns the diffuse texture in case of the standard material.
  31998. */
  31999. getAlphaTestTexture(): Nullable<BaseTexture>;
  32000. /**
  32001. * Get if the submesh is ready to be used and all its information available.
  32002. * Child classes can use it to update shaders
  32003. * @param mesh defines the mesh to check
  32004. * @param subMesh defines which submesh to check
  32005. * @param useInstances specifies that instances should be used
  32006. * @returns a boolean indicating that the submesh is ready or not
  32007. */
  32008. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  32009. /**
  32010. * Builds the material UBO layouts.
  32011. * Used internally during the effect preparation.
  32012. */
  32013. buildUniformLayout(): void;
  32014. /**
  32015. * Unbinds the material from the mesh
  32016. */
  32017. unbind(): void;
  32018. /**
  32019. * Binds the submesh to this material by preparing the effect and shader to draw
  32020. * @param world defines the world transformation matrix
  32021. * @param mesh defines the mesh containing the submesh
  32022. * @param subMesh defines the submesh to bind the material to
  32023. */
  32024. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  32025. /**
  32026. * Get the list of animatables in the material.
  32027. * @returns the list of animatables object used in the material
  32028. */
  32029. getAnimatables(): IAnimatable[];
  32030. /**
  32031. * Gets the active textures from the material
  32032. * @returns an array of textures
  32033. */
  32034. getActiveTextures(): BaseTexture[];
  32035. /**
  32036. * Specifies if the material uses a texture
  32037. * @param texture defines the texture to check against the material
  32038. * @returns a boolean specifying if the material uses the texture
  32039. */
  32040. hasTexture(texture: BaseTexture): boolean;
  32041. /**
  32042. * Disposes the material
  32043. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  32044. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  32045. */
  32046. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  32047. /**
  32048. * Makes a duplicate of the material, and gives it a new name
  32049. * @param name defines the new name for the duplicated material
  32050. * @returns the cloned material
  32051. */
  32052. clone(name: string): StandardMaterial;
  32053. /**
  32054. * Serializes this material in a JSON representation
  32055. * @returns the serialized material object
  32056. */
  32057. serialize(): any;
  32058. /**
  32059. * Creates a standard material from parsed material data
  32060. * @param source defines the JSON representation of the material
  32061. * @param scene defines the hosting scene
  32062. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  32063. * @returns a new standard material
  32064. */
  32065. static Parse(source: any, scene: Scene, rootUrl: string): StandardMaterial;
  32066. /**
  32067. * Are diffuse textures enabled in the application.
  32068. */
  32069. static get DiffuseTextureEnabled(): boolean;
  32070. static set DiffuseTextureEnabled(value: boolean);
  32071. /**
  32072. * Are detail textures enabled in the application.
  32073. */
  32074. static get DetailTextureEnabled(): boolean;
  32075. static set DetailTextureEnabled(value: boolean);
  32076. /**
  32077. * Are ambient textures enabled in the application.
  32078. */
  32079. static get AmbientTextureEnabled(): boolean;
  32080. static set AmbientTextureEnabled(value: boolean);
  32081. /**
  32082. * Are opacity textures enabled in the application.
  32083. */
  32084. static get OpacityTextureEnabled(): boolean;
  32085. static set OpacityTextureEnabled(value: boolean);
  32086. /**
  32087. * Are reflection textures enabled in the application.
  32088. */
  32089. static get ReflectionTextureEnabled(): boolean;
  32090. static set ReflectionTextureEnabled(value: boolean);
  32091. /**
  32092. * Are emissive textures enabled in the application.
  32093. */
  32094. static get EmissiveTextureEnabled(): boolean;
  32095. static set EmissiveTextureEnabled(value: boolean);
  32096. /**
  32097. * Are specular textures enabled in the application.
  32098. */
  32099. static get SpecularTextureEnabled(): boolean;
  32100. static set SpecularTextureEnabled(value: boolean);
  32101. /**
  32102. * Are bump textures enabled in the application.
  32103. */
  32104. static get BumpTextureEnabled(): boolean;
  32105. static set BumpTextureEnabled(value: boolean);
  32106. /**
  32107. * Are lightmap textures enabled in the application.
  32108. */
  32109. static get LightmapTextureEnabled(): boolean;
  32110. static set LightmapTextureEnabled(value: boolean);
  32111. /**
  32112. * Are refraction textures enabled in the application.
  32113. */
  32114. static get RefractionTextureEnabled(): boolean;
  32115. static set RefractionTextureEnabled(value: boolean);
  32116. /**
  32117. * Are color grading textures enabled in the application.
  32118. */
  32119. static get ColorGradingTextureEnabled(): boolean;
  32120. static set ColorGradingTextureEnabled(value: boolean);
  32121. /**
  32122. * Are fresnels enabled in the application.
  32123. */
  32124. static get FresnelEnabled(): boolean;
  32125. static set FresnelEnabled(value: boolean);
  32126. }
  32127. }
  32128. declare module "babylonjs/Particles/solidParticleSystem" {
  32129. import { Nullable } from "babylonjs/types";
  32130. import { Mesh } from "babylonjs/Meshes/mesh";
  32131. import { Scene, IDisposable } from "babylonjs/scene";
  32132. import { DepthSortedParticle, SolidParticle, SolidParticleVertex } from "babylonjs/Particles/solidParticle";
  32133. import { Material } from "babylonjs/Materials/material";
  32134. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  32135. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  32136. /**
  32137. * The SPS is a single updatable mesh. The solid particles are simply separate parts or faces fo this big mesh.
  32138. *As it is just a mesh, the SPS has all the same properties than any other BJS mesh : not more, not less. It can be scaled, rotated, translated, enlighted, textured, moved, etc.
  32139. * The SPS is also a particle system. It provides some methods to manage the particles.
  32140. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  32141. *
  32142. * Full documentation here : https://doc.babylonjs.com/how_to/Solid_Particle_System
  32143. */
  32144. export class SolidParticleSystem implements IDisposable {
  32145. /**
  32146. * The SPS array of Solid Particle objects. Just access each particle as with any classic array.
  32147. * Example : var p = SPS.particles[i];
  32148. */
  32149. particles: SolidParticle[];
  32150. /**
  32151. * The SPS total number of particles. Read only. Use SPS.counter instead if you need to set your own value.
  32152. */
  32153. nbParticles: number;
  32154. /**
  32155. * If the particles must ever face the camera (default false). Useful for planar particles.
  32156. */
  32157. billboard: boolean;
  32158. /**
  32159. * Recompute normals when adding a shape
  32160. */
  32161. recomputeNormals: boolean;
  32162. /**
  32163. * This a counter ofr your own usage. It's not set by any SPS functions.
  32164. */
  32165. counter: number;
  32166. /**
  32167. * The SPS name. This name is also given to the underlying mesh.
  32168. */
  32169. name: string;
  32170. /**
  32171. * The SPS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  32172. */
  32173. mesh: Mesh;
  32174. /**
  32175. * This empty object is intended to store some SPS specific or temporary values in order to lower the Garbage Collector activity.
  32176. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#garbage-collector-concerns
  32177. */
  32178. vars: any;
  32179. /**
  32180. * This array is populated when the SPS is set as 'pickable'.
  32181. * Each key of this array is a `faceId` value that you can get from a pickResult object.
  32182. * Each element of this array is an object `{idx: int, faceId: int}`.
  32183. * `idx` is the picked particle index in the `SPS.particles` array
  32184. * `faceId` is the picked face index counted within this particle.
  32185. * This array is the first element of the pickedBySubMesh array : sps.pickBySubMesh[0].
  32186. * It's not pertinent to use it when using a SPS with the support for MultiMaterial enabled.
  32187. * Use the method SPS.pickedParticle(pickingInfo) instead.
  32188. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  32189. */
  32190. pickedParticles: {
  32191. idx: number;
  32192. faceId: number;
  32193. }[];
  32194. /**
  32195. * This array is populated when the SPS is set as 'pickable'
  32196. * Each key of this array is a submesh index.
  32197. * Each element of this array is a second array defined like this :
  32198. * Each key of this second array is a `faceId` value that you can get from a pickResult object.
  32199. * Each element of this second array is an object `{idx: int, faceId: int}`.
  32200. * `idx` is the picked particle index in the `SPS.particles` array
  32201. * `faceId` is the picked face index counted within this particle.
  32202. * It's better to use the method SPS.pickedParticle(pickingInfo) rather than using directly this array.
  32203. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  32204. */
  32205. pickedBySubMesh: {
  32206. idx: number;
  32207. faceId: number;
  32208. }[][];
  32209. /**
  32210. * This array is populated when `enableDepthSort` is set to true.
  32211. * Each element of this array is an instance of the class DepthSortedParticle.
  32212. */
  32213. depthSortedParticles: DepthSortedParticle[];
  32214. /**
  32215. * If the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster). (Internal use only)
  32216. * @hidden
  32217. */
  32218. _bSphereOnly: boolean;
  32219. /**
  32220. * A number to multiply the boundind sphere radius by in order to reduce it for instance. (Internal use only)
  32221. * @hidden
  32222. */
  32223. _bSphereRadiusFactor: number;
  32224. private _scene;
  32225. private _positions;
  32226. private _indices;
  32227. private _normals;
  32228. private _colors;
  32229. private _uvs;
  32230. private _indices32;
  32231. private _positions32;
  32232. private _normals32;
  32233. private _fixedNormal32;
  32234. private _colors32;
  32235. private _uvs32;
  32236. private _index;
  32237. private _updatable;
  32238. private _pickable;
  32239. private _isVisibilityBoxLocked;
  32240. private _alwaysVisible;
  32241. private _depthSort;
  32242. private _expandable;
  32243. private _shapeCounter;
  32244. private _copy;
  32245. private _color;
  32246. private _computeParticleColor;
  32247. private _computeParticleTexture;
  32248. private _computeParticleRotation;
  32249. private _computeParticleVertex;
  32250. private _computeBoundingBox;
  32251. private _depthSortParticles;
  32252. private _camera;
  32253. private _mustUnrotateFixedNormals;
  32254. private _particlesIntersect;
  32255. private _needs32Bits;
  32256. private _isNotBuilt;
  32257. private _lastParticleId;
  32258. private _idxOfId;
  32259. private _multimaterialEnabled;
  32260. private _useModelMaterial;
  32261. private _indicesByMaterial;
  32262. private _materialIndexes;
  32263. private _depthSortFunction;
  32264. private _materialSortFunction;
  32265. private _materials;
  32266. private _multimaterial;
  32267. private _materialIndexesById;
  32268. private _defaultMaterial;
  32269. private _autoUpdateSubMeshes;
  32270. private _tmpVertex;
  32271. /**
  32272. * Creates a SPS (Solid Particle System) object.
  32273. * @param name (String) is the SPS name, this will be the underlying mesh name.
  32274. * @param scene (Scene) is the scene in which the SPS is added.
  32275. * @param options defines the options of the sps e.g.
  32276. * * updatable (optional boolean, default true) : if the SPS must be updatable or immutable.
  32277. * * isPickable (optional boolean, default false) : if the solid particles must be pickable.
  32278. * * enableDepthSort (optional boolean, default false) : if the solid particles must be sorted in the geometry according to their distance to the camera.
  32279. * * useModelMaterial (optional boolean, defaut false) : if the model materials must be used to create the SPS multimaterial. This enables the multimaterial supports of the SPS.
  32280. * * enableMultiMaterial (optional boolean, default false) : if the solid particles can be given different materials.
  32281. * * expandable (optional boolean, default false) : if particles can still be added after the initial SPS mesh creation.
  32282. * * particleIntersection (optional boolean, default false) : if the solid particle intersections must be computed.
  32283. * * boundingSphereOnly (optional boolean, default false) : if the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster).
  32284. * * bSphereRadiusFactor (optional float, default 1.0) : a number to multiply the boundind sphere radius by in order to reduce it for instance.
  32285. * @example bSphereRadiusFactor = 1.0 / Math.sqrt(3.0) => the bounding sphere exactly matches a spherical mesh.
  32286. */
  32287. constructor(name: string, scene: Scene, options?: {
  32288. updatable?: boolean;
  32289. isPickable?: boolean;
  32290. enableDepthSort?: boolean;
  32291. particleIntersection?: boolean;
  32292. boundingSphereOnly?: boolean;
  32293. bSphereRadiusFactor?: number;
  32294. expandable?: boolean;
  32295. useModelMaterial?: boolean;
  32296. enableMultiMaterial?: boolean;
  32297. });
  32298. /**
  32299. * Builds the SPS underlying mesh. Returns a standard Mesh.
  32300. * If no model shape was added to the SPS, the returned mesh is just a single triangular plane.
  32301. * @returns the created mesh
  32302. */
  32303. buildMesh(): Mesh;
  32304. /**
  32305. * Digests the mesh and generates as many solid particles in the system as wanted. Returns the SPS.
  32306. * These particles will have the same geometry than the mesh parts and will be positioned at the same localisation than the mesh original places.
  32307. * Thus the particles generated from `digest()` have their property `position` set yet.
  32308. * @param mesh ( Mesh ) is the mesh to be digested
  32309. * @param options {facetNb} (optional integer, default 1) is the number of mesh facets per particle, this parameter is overriden by the parameter `number` if any
  32310. * {delta} (optional integer, default 0) is the random extra number of facets per particle , each particle will have between `facetNb` and `facetNb + delta` facets
  32311. * {number} (optional positive integer) is the wanted number of particles : each particle is built with `mesh_total_facets / number` facets
  32312. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  32313. * @returns the current SPS
  32314. */
  32315. digest(mesh: Mesh, options?: {
  32316. facetNb?: number;
  32317. number?: number;
  32318. delta?: number;
  32319. storage?: [];
  32320. }): SolidParticleSystem;
  32321. /**
  32322. * Unrotate the fixed normals in case the mesh was built with pre-rotated particles, ex : use of positionFunction in addShape()
  32323. * @hidden
  32324. */
  32325. private _unrotateFixedNormals;
  32326. /**
  32327. * Resets the temporary working copy particle
  32328. * @hidden
  32329. */
  32330. private _resetCopy;
  32331. /**
  32332. * Inserts the shape model geometry in the global SPS mesh by updating the positions, indices, normals, colors, uvs arrays
  32333. * @param p the current index in the positions array to be updated
  32334. * @param ind the current index in the indices array
  32335. * @param shape a Vector3 array, the shape geometry
  32336. * @param positions the positions array to be updated
  32337. * @param meshInd the shape indices array
  32338. * @param indices the indices array to be updated
  32339. * @param meshUV the shape uv array
  32340. * @param uvs the uv array to be updated
  32341. * @param meshCol the shape color array
  32342. * @param colors the color array to be updated
  32343. * @param meshNor the shape normals array
  32344. * @param normals the normals array to be updated
  32345. * @param idx the particle index
  32346. * @param idxInShape the particle index in its shape
  32347. * @param options the addShape() method passed options
  32348. * @model the particle model
  32349. * @hidden
  32350. */
  32351. private _meshBuilder;
  32352. /**
  32353. * Returns a shape Vector3 array from positions float array
  32354. * @param positions float array
  32355. * @returns a vector3 array
  32356. * @hidden
  32357. */
  32358. private _posToShape;
  32359. /**
  32360. * Returns a shapeUV array from a float uvs (array deep copy)
  32361. * @param uvs as a float array
  32362. * @returns a shapeUV array
  32363. * @hidden
  32364. */
  32365. private _uvsToShapeUV;
  32366. /**
  32367. * Adds a new particle object in the particles array
  32368. * @param idx particle index in particles array
  32369. * @param id particle id
  32370. * @param idxpos positionIndex : the starting index of the particle vertices in the SPS "positions" array
  32371. * @param idxind indiceIndex : he starting index of the particle indices in the SPS "indices" array
  32372. * @param model particle ModelShape object
  32373. * @param shapeId model shape identifier
  32374. * @param idxInShape index of the particle in the current model
  32375. * @param bInfo model bounding info object
  32376. * @param storage target storage array, if any
  32377. * @hidden
  32378. */
  32379. private _addParticle;
  32380. /**
  32381. * Adds some particles to the SPS from the model shape. Returns the shape id.
  32382. * Please read the doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#create-an-immutable-sps
  32383. * @param mesh is any Mesh object that will be used as a model for the solid particles.
  32384. * @param nb (positive integer) the number of particles to be created from this model
  32385. * @param options {positionFunction} is an optional javascript function to called for each particle on SPS creation.
  32386. * {vertexFunction} is an optional javascript function to called for each vertex of each particle on SPS creation
  32387. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  32388. * @returns the number of shapes in the system
  32389. */
  32390. addShape(mesh: Mesh, nb: number, options?: {
  32391. positionFunction?: any;
  32392. vertexFunction?: any;
  32393. storage?: [];
  32394. }): number;
  32395. /**
  32396. * Rebuilds a particle back to its just built status : if needed, recomputes the custom positions and vertices
  32397. * @hidden
  32398. */
  32399. private _rebuildParticle;
  32400. /**
  32401. * Rebuilds the whole mesh and updates the VBO : custom positions and vertices are recomputed if needed.
  32402. * @param reset boolean, default false : if the particles must be reset at position and rotation zero, scaling 1, color white, initial UVs and not parented.
  32403. * @returns the SPS.
  32404. */
  32405. rebuildMesh(reset?: boolean): SolidParticleSystem;
  32406. /** Removes the particles from the start-th to the end-th included from an expandable SPS (required).
  32407. * Returns an array with the removed particles.
  32408. * If the number of particles to remove is lower than zero or greater than the global remaining particle number, then an empty array is returned.
  32409. * The SPS can't be empty so at least one particle needs to remain in place.
  32410. * Under the hood, the VertexData array, so the VBO buffer, is recreated each call.
  32411. * @param start index of the first particle to remove
  32412. * @param end index of the last particle to remove (included)
  32413. * @returns an array populated with the removed particles
  32414. */
  32415. removeParticles(start: number, end: number): SolidParticle[];
  32416. /**
  32417. * Inserts some pre-created particles in the solid particle system so that they can be managed by setParticles().
  32418. * @param solidParticleArray an array populated with Solid Particles objects
  32419. * @returns the SPS
  32420. */
  32421. insertParticlesFromArray(solidParticleArray: SolidParticle[]): SolidParticleSystem;
  32422. /**
  32423. * Creates a new particle and modifies the SPS mesh geometry :
  32424. * - calls _meshBuilder() to increase the SPS mesh geometry step by step
  32425. * - calls _addParticle() to populate the particle array
  32426. * factorized code from addShape() and insertParticlesFromArray()
  32427. * @param idx particle index in the particles array
  32428. * @param i particle index in its shape
  32429. * @param modelShape particle ModelShape object
  32430. * @param shape shape vertex array
  32431. * @param meshInd shape indices array
  32432. * @param meshUV shape uv array
  32433. * @param meshCol shape color array
  32434. * @param meshNor shape normals array
  32435. * @param bbInfo shape bounding info
  32436. * @param storage target particle storage
  32437. * @options addShape() passed options
  32438. * @hidden
  32439. */
  32440. private _insertNewParticle;
  32441. /**
  32442. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  32443. * This method calls `updateParticle()` for each particle of the SPS.
  32444. * For an animated SPS, it is usually called within the render loop.
  32445. * This methods does nothing if called on a non updatable or not yet built SPS. Example : buildMesh() not called after having added or removed particles from an expandable SPS.
  32446. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  32447. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  32448. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  32449. * @returns the SPS.
  32450. */
  32451. setParticles(start?: number, end?: number, update?: boolean): SolidParticleSystem;
  32452. /**
  32453. * Disposes the SPS.
  32454. */
  32455. dispose(): void;
  32456. /** Returns an object {idx: numbern faceId: number} for the picked particle from the passed pickingInfo object.
  32457. * idx is the particle index in the SPS
  32458. * faceId is the picked face index counted within this particle.
  32459. * Returns null if the pickInfo can't identify a picked particle.
  32460. * @param pickingInfo (PickingInfo object)
  32461. * @returns {idx: number, faceId: number} or null
  32462. */
  32463. pickedParticle(pickingInfo: PickingInfo): Nullable<{
  32464. idx: number;
  32465. faceId: number;
  32466. }>;
  32467. /**
  32468. * Returns a SolidParticle object from its identifier : particle.id
  32469. * @param id (integer) the particle Id
  32470. * @returns the searched particle or null if not found in the SPS.
  32471. */
  32472. getParticleById(id: number): Nullable<SolidParticle>;
  32473. /**
  32474. * Returns a new array populated with the particles having the passed shapeId.
  32475. * @param shapeId (integer) the shape identifier
  32476. * @returns a new solid particle array
  32477. */
  32478. getParticlesByShapeId(shapeId: number): SolidParticle[];
  32479. /**
  32480. * Populates the passed array "ref" with the particles having the passed shapeId.
  32481. * @param shapeId the shape identifier
  32482. * @returns the SPS
  32483. * @param ref
  32484. */
  32485. getParticlesByShapeIdToRef(shapeId: number, ref: SolidParticle[]): SolidParticleSystem;
  32486. /**
  32487. * Computes the required SubMeshes according the materials assigned to the particles.
  32488. * @returns the solid particle system.
  32489. * Does nothing if called before the SPS mesh is built.
  32490. */
  32491. computeSubMeshes(): SolidParticleSystem;
  32492. /**
  32493. * Sorts the solid particles by material when MultiMaterial is enabled.
  32494. * Updates the indices32 array.
  32495. * Updates the indicesByMaterial array.
  32496. * Updates the mesh indices array.
  32497. * @returns the SPS
  32498. * @hidden
  32499. */
  32500. private _sortParticlesByMaterial;
  32501. /**
  32502. * Sets the material indexes by id materialIndexesById[id] = materialIndex
  32503. * @hidden
  32504. */
  32505. private _setMaterialIndexesById;
  32506. /**
  32507. * Returns an array with unique values of Materials from the passed array
  32508. * @param array the material array to be checked and filtered
  32509. * @hidden
  32510. */
  32511. private _filterUniqueMaterialId;
  32512. /**
  32513. * Sets a new Standard Material as _defaultMaterial if not already set.
  32514. * @hidden
  32515. */
  32516. private _setDefaultMaterial;
  32517. /**
  32518. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  32519. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32520. * @returns the SPS.
  32521. */
  32522. refreshVisibleSize(): SolidParticleSystem;
  32523. /**
  32524. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  32525. * @param size the size (float) of the visibility box
  32526. * note : this doesn't lock the SPS mesh bounding box.
  32527. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32528. */
  32529. setVisibilityBox(size: number): void;
  32530. /**
  32531. * Gets whether the SPS as always visible or not
  32532. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32533. */
  32534. get isAlwaysVisible(): boolean;
  32535. /**
  32536. * Sets the SPS as always visible or not
  32537. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32538. */
  32539. set isAlwaysVisible(val: boolean);
  32540. /**
  32541. * Sets the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  32542. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32543. */
  32544. set isVisibilityBoxLocked(val: boolean);
  32545. /**
  32546. * Gets if the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  32547. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32548. */
  32549. get isVisibilityBoxLocked(): boolean;
  32550. /**
  32551. * Tells to `setParticles()` to compute the particle rotations or not.
  32552. * Default value : true. The SPS is faster when it's set to false.
  32553. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  32554. */
  32555. set computeParticleRotation(val: boolean);
  32556. /**
  32557. * Tells to `setParticles()` to compute the particle colors or not.
  32558. * Default value : true. The SPS is faster when it's set to false.
  32559. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  32560. */
  32561. set computeParticleColor(val: boolean);
  32562. set computeParticleTexture(val: boolean);
  32563. /**
  32564. * Tells to `setParticles()` to call the vertex function for each vertex of each particle, or not.
  32565. * Default value : false. The SPS is faster when it's set to false.
  32566. * Note : the particle custom vertex positions aren't stored values.
  32567. */
  32568. set computeParticleVertex(val: boolean);
  32569. /**
  32570. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  32571. */
  32572. set computeBoundingBox(val: boolean);
  32573. /**
  32574. * Tells to `setParticles()` to sort or not the distance between each particle and the camera.
  32575. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  32576. * Default : `true`
  32577. */
  32578. set depthSortParticles(val: boolean);
  32579. /**
  32580. * Gets if `setParticles()` computes the particle rotations or not.
  32581. * Default value : true. The SPS is faster when it's set to false.
  32582. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  32583. */
  32584. get computeParticleRotation(): boolean;
  32585. /**
  32586. * Gets if `setParticles()` computes the particle colors or not.
  32587. * Default value : true. The SPS is faster when it's set to false.
  32588. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  32589. */
  32590. get computeParticleColor(): boolean;
  32591. /**
  32592. * Gets if `setParticles()` computes the particle textures or not.
  32593. * Default value : true. The SPS is faster when it's set to false.
  32594. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  32595. */
  32596. get computeParticleTexture(): boolean;
  32597. /**
  32598. * Gets if `setParticles()` calls the vertex function for each vertex of each particle, or not.
  32599. * Default value : false. The SPS is faster when it's set to false.
  32600. * Note : the particle custom vertex positions aren't stored values.
  32601. */
  32602. get computeParticleVertex(): boolean;
  32603. /**
  32604. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  32605. */
  32606. get computeBoundingBox(): boolean;
  32607. /**
  32608. * Gets if `setParticles()` sorts or not the distance between each particle and the camera.
  32609. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  32610. * Default : `true`
  32611. */
  32612. get depthSortParticles(): boolean;
  32613. /**
  32614. * Gets if the SPS is created as expandable at construction time.
  32615. * Default : `false`
  32616. */
  32617. get expandable(): boolean;
  32618. /**
  32619. * Gets if the SPS supports the Multi Materials
  32620. */
  32621. get multimaterialEnabled(): boolean;
  32622. /**
  32623. * Gets if the SPS uses the model materials for its own multimaterial.
  32624. */
  32625. get useModelMaterial(): boolean;
  32626. /**
  32627. * The SPS used material array.
  32628. */
  32629. get materials(): Material[];
  32630. /**
  32631. * Sets the SPS MultiMaterial from the passed materials.
  32632. * Note : the passed array is internally copied and not used then by reference.
  32633. * @param materials an array of material objects. This array indexes are the materialIndex values of the particles.
  32634. */
  32635. setMultiMaterial(materials: Material[]): void;
  32636. /**
  32637. * The SPS computed multimaterial object
  32638. */
  32639. get multimaterial(): MultiMaterial;
  32640. set multimaterial(mm: MultiMaterial);
  32641. /**
  32642. * If the subMeshes must be updated on the next call to setParticles()
  32643. */
  32644. get autoUpdateSubMeshes(): boolean;
  32645. set autoUpdateSubMeshes(val: boolean);
  32646. /**
  32647. * This function does nothing. It may be overwritten to set all the particle first values.
  32648. * The SPS doesn't call this function, you may have to call it by your own.
  32649. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  32650. */
  32651. initParticles(): void;
  32652. /**
  32653. * This function does nothing. It may be overwritten to recycle a particle.
  32654. * The SPS doesn't call this function, you may have to call it by your own.
  32655. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  32656. * @param particle The particle to recycle
  32657. * @returns the recycled particle
  32658. */
  32659. recycleParticle(particle: SolidParticle): SolidParticle;
  32660. /**
  32661. * Updates a particle : this function should be overwritten by the user.
  32662. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  32663. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  32664. * @example : just set a particle position or velocity and recycle conditions
  32665. * @param particle The particle to update
  32666. * @returns the updated particle
  32667. */
  32668. updateParticle(particle: SolidParticle): SolidParticle;
  32669. /**
  32670. * Updates a vertex of a particle : it can be overwritten by the user.
  32671. * This will be called on each vertex particle by `setParticles()` if `computeParticleVertex` is set to true only.
  32672. * @param particle the current particle
  32673. * @param vertex the current vertex of the current particle : a SolidParticleVertex object
  32674. * @param pt the index of the current vertex in the particle shape
  32675. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#update-each-particle-shape
  32676. * @example : just set a vertex particle position or color
  32677. * @returns the sps
  32678. */
  32679. updateParticleVertex(particle: SolidParticle, vertex: SolidParticleVertex, pt: number): SolidParticleSystem;
  32680. /**
  32681. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  32682. * This does nothing and may be overwritten by the user.
  32683. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  32684. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  32685. * @param update the boolean update value actually passed to setParticles()
  32686. */
  32687. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  32688. /**
  32689. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  32690. * This will be passed three parameters.
  32691. * This does nothing and may be overwritten by the user.
  32692. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  32693. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  32694. * @param update the boolean update value actually passed to setParticles()
  32695. */
  32696. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  32697. }
  32698. }
  32699. declare module "babylonjs/Particles/solidParticle" {
  32700. import { Nullable } from "babylonjs/types";
  32701. import { Vector3, Matrix, Quaternion, Vector4, Vector2 } from "babylonjs/Maths/math.vector";
  32702. import { Color4 } from "babylonjs/Maths/math.color";
  32703. import { Mesh } from "babylonjs/Meshes/mesh";
  32704. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  32705. import { SolidParticleSystem } from "babylonjs/Particles/solidParticleSystem";
  32706. import { Plane } from "babylonjs/Maths/math.plane";
  32707. import { Material } from "babylonjs/Materials/material";
  32708. /**
  32709. * Represents one particle of a solid particle system.
  32710. */
  32711. export class SolidParticle {
  32712. /**
  32713. * particle global index
  32714. */
  32715. idx: number;
  32716. /**
  32717. * particle identifier
  32718. */
  32719. id: number;
  32720. /**
  32721. * The color of the particle
  32722. */
  32723. color: Nullable<Color4>;
  32724. /**
  32725. * The world space position of the particle.
  32726. */
  32727. position: Vector3;
  32728. /**
  32729. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  32730. */
  32731. rotation: Vector3;
  32732. /**
  32733. * The world space rotation quaternion of the particle.
  32734. */
  32735. rotationQuaternion: Nullable<Quaternion>;
  32736. /**
  32737. * The scaling of the particle.
  32738. */
  32739. scaling: Vector3;
  32740. /**
  32741. * The uvs of the particle.
  32742. */
  32743. uvs: Vector4;
  32744. /**
  32745. * The current speed of the particle.
  32746. */
  32747. velocity: Vector3;
  32748. /**
  32749. * The pivot point in the particle local space.
  32750. */
  32751. pivot: Vector3;
  32752. /**
  32753. * Must the particle be translated from its pivot point in its local space ?
  32754. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  32755. * Default : false
  32756. */
  32757. translateFromPivot: boolean;
  32758. /**
  32759. * Is the particle active or not ?
  32760. */
  32761. alive: boolean;
  32762. /**
  32763. * Is the particle visible or not ?
  32764. */
  32765. isVisible: boolean;
  32766. /**
  32767. * Index of this particle in the global "positions" array (Internal use)
  32768. * @hidden
  32769. */
  32770. _pos: number;
  32771. /**
  32772. * @hidden Index of this particle in the global "indices" array (Internal use)
  32773. */
  32774. _ind: number;
  32775. /**
  32776. * @hidden ModelShape of this particle (Internal use)
  32777. */
  32778. _model: ModelShape;
  32779. /**
  32780. * ModelShape id of this particle
  32781. */
  32782. shapeId: number;
  32783. /**
  32784. * Index of the particle in its shape id
  32785. */
  32786. idxInShape: number;
  32787. /**
  32788. * @hidden Reference to the shape model BoundingInfo object (Internal use)
  32789. */
  32790. _modelBoundingInfo: BoundingInfo;
  32791. /**
  32792. * @hidden Particle BoundingInfo object (Internal use)
  32793. */
  32794. _boundingInfo: BoundingInfo;
  32795. /**
  32796. * @hidden Reference to the SPS what the particle belongs to (Internal use)
  32797. */
  32798. _sps: SolidParticleSystem;
  32799. /**
  32800. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  32801. */
  32802. _stillInvisible: boolean;
  32803. /**
  32804. * @hidden Last computed particle rotation matrix
  32805. */
  32806. _rotationMatrix: number[];
  32807. /**
  32808. * Parent particle Id, if any.
  32809. * Default null.
  32810. */
  32811. parentId: Nullable<number>;
  32812. /**
  32813. * The particle material identifier (integer) when MultiMaterials are enabled in the SPS.
  32814. */
  32815. materialIndex: Nullable<number>;
  32816. /**
  32817. * Custom object or properties.
  32818. */
  32819. props: Nullable<any>;
  32820. /**
  32821. * The culling strategy to use to check whether the solid particle must be culled or not when using isInFrustum().
  32822. * The possible values are :
  32823. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  32824. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  32825. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  32826. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  32827. * The default value for solid particles is AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  32828. * Please read each static variable documentation in the class AbstractMesh to get details about the culling process.
  32829. * */
  32830. cullingStrategy: number;
  32831. /**
  32832. * @hidden Internal global position in the SPS.
  32833. */
  32834. _globalPosition: Vector3;
  32835. /**
  32836. * Creates a Solid Particle object.
  32837. * Don't create particles manually, use instead the Solid Particle System internal tools like _addParticle()
  32838. * @param particleIndex (integer) is the particle index in the Solid Particle System pool.
  32839. * @param particleId (integer) is the particle identifier. Unless some particles are removed from the SPS, it's the same value than the particle idx.
  32840. * @param positionIndex (integer) is the starting index of the particle vertices in the SPS "positions" array.
  32841. * @param indiceIndex (integer) is the starting index of the particle indices in the SPS "indices" array.
  32842. * @param model (ModelShape) is a reference to the model shape on what the particle is designed.
  32843. * @param shapeId (integer) is the model shape identifier in the SPS.
  32844. * @param idxInShape (integer) is the index of the particle in the current model (ex: the 10th box of addShape(box, 30))
  32845. * @param sps defines the sps it is associated to
  32846. * @param modelBoundingInfo is the reference to the model BoundingInfo used for intersection computations.
  32847. * @param materialIndex is the particle material identifier (integer) when the MultiMaterials are enabled in the SPS.
  32848. */
  32849. constructor(particleIndex: number, particleId: number, positionIndex: number, indiceIndex: number, model: Nullable<ModelShape>, shapeId: number, idxInShape: number, sps: SolidParticleSystem, modelBoundingInfo?: Nullable<BoundingInfo>, materialIndex?: Nullable<number>);
  32850. /**
  32851. * Copies the particle property values into the existing target : position, rotation, scaling, uvs, colors, pivot, parent, visibility, alive
  32852. * @param target the particle target
  32853. * @returns the current particle
  32854. */
  32855. copyToRef(target: SolidParticle): SolidParticle;
  32856. /**
  32857. * Legacy support, changed scale to scaling
  32858. */
  32859. get scale(): Vector3;
  32860. /**
  32861. * Legacy support, changed scale to scaling
  32862. */
  32863. set scale(scale: Vector3);
  32864. /**
  32865. * Legacy support, changed quaternion to rotationQuaternion
  32866. */
  32867. get quaternion(): Nullable<Quaternion>;
  32868. /**
  32869. * Legacy support, changed quaternion to rotationQuaternion
  32870. */
  32871. set quaternion(q: Nullable<Quaternion>);
  32872. /**
  32873. * Returns a boolean. True if the particle intersects another particle or another mesh, else false.
  32874. * The intersection is computed on the particle bounding sphere and Axis Aligned Bounding Box (AABB)
  32875. * @param target is the object (solid particle or mesh) what the intersection is computed against.
  32876. * @returns true if it intersects
  32877. */
  32878. intersectsMesh(target: Mesh | SolidParticle): boolean;
  32879. /**
  32880. * Returns `true` if the solid particle is within the frustum defined by the passed array of planes.
  32881. * A particle is in the frustum if its bounding box intersects the frustum
  32882. * @param frustumPlanes defines the frustum to test
  32883. * @returns true if the particle is in the frustum planes
  32884. */
  32885. isInFrustum(frustumPlanes: Plane[]): boolean;
  32886. /**
  32887. * get the rotation matrix of the particle
  32888. * @hidden
  32889. */
  32890. getRotationMatrix(m: Matrix): void;
  32891. }
  32892. /**
  32893. * Represents the shape of the model used by one particle of a solid particle system.
  32894. * SPS internal tool, don't use it manually.
  32895. */
  32896. export class ModelShape {
  32897. /**
  32898. * The shape id
  32899. * @hidden
  32900. */
  32901. shapeID: number;
  32902. /**
  32903. * flat array of model positions (internal use)
  32904. * @hidden
  32905. */
  32906. _shape: Vector3[];
  32907. /**
  32908. * flat array of model UVs (internal use)
  32909. * @hidden
  32910. */
  32911. _shapeUV: number[];
  32912. /**
  32913. * color array of the model
  32914. * @hidden
  32915. */
  32916. _shapeColors: number[];
  32917. /**
  32918. * indices array of the model
  32919. * @hidden
  32920. */
  32921. _indices: number[];
  32922. /**
  32923. * normals array of the model
  32924. * @hidden
  32925. */
  32926. _normals: number[];
  32927. /**
  32928. * length of the shape in the model indices array (internal use)
  32929. * @hidden
  32930. */
  32931. _indicesLength: number;
  32932. /**
  32933. * Custom position function (internal use)
  32934. * @hidden
  32935. */
  32936. _positionFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>;
  32937. /**
  32938. * Custom vertex function (internal use)
  32939. * @hidden
  32940. */
  32941. _vertexFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>;
  32942. /**
  32943. * Model material (internal use)
  32944. * @hidden
  32945. */
  32946. _material: Nullable<Material>;
  32947. /**
  32948. * Creates a ModelShape object. This is an internal simplified reference to a mesh used as for a model to replicate particles from by the SPS.
  32949. * SPS internal tool, don't use it manually.
  32950. * @hidden
  32951. */
  32952. constructor(id: number, shape: Vector3[], indices: number[], normals: number[], colors: number[], shapeUV: number[], posFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>, vtxFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>, material: Nullable<Material>);
  32953. }
  32954. /**
  32955. * Represents a Depth Sorted Particle in the solid particle system.
  32956. * @hidden
  32957. */
  32958. export class DepthSortedParticle {
  32959. /**
  32960. * Particle index
  32961. */
  32962. idx: number;
  32963. /**
  32964. * Index of the particle in the "indices" array
  32965. */
  32966. ind: number;
  32967. /**
  32968. * Length of the particle shape in the "indices" array
  32969. */
  32970. indicesLength: number;
  32971. /**
  32972. * Squared distance from the particle to the camera
  32973. */
  32974. sqDistance: number;
  32975. /**
  32976. * Material index when used with MultiMaterials
  32977. */
  32978. materialIndex: number;
  32979. /**
  32980. * Creates a new sorted particle
  32981. * @param materialIndex
  32982. */
  32983. constructor(idx: number, ind: number, indLength: number, materialIndex: number);
  32984. }
  32985. /**
  32986. * Represents a solid particle vertex
  32987. */
  32988. export class SolidParticleVertex {
  32989. /**
  32990. * Vertex position
  32991. */
  32992. position: Vector3;
  32993. /**
  32994. * Vertex color
  32995. */
  32996. color: Color4;
  32997. /**
  32998. * Vertex UV
  32999. */
  33000. uv: Vector2;
  33001. /**
  33002. * Creates a new solid particle vertex
  33003. */
  33004. constructor();
  33005. /** Vertex x coordinate */
  33006. get x(): number;
  33007. set x(val: number);
  33008. /** Vertex y coordinate */
  33009. get y(): number;
  33010. set y(val: number);
  33011. /** Vertex z coordinate */
  33012. get z(): number;
  33013. set z(val: number);
  33014. }
  33015. }
  33016. declare module "babylonjs/Collisions/meshCollisionData" {
  33017. import { Collider } from "babylonjs/Collisions/collider";
  33018. import { Vector3 } from "babylonjs/Maths/math.vector";
  33019. import { Nullable } from "babylonjs/types";
  33020. import { Observer } from "babylonjs/Misc/observable";
  33021. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  33022. /**
  33023. * @hidden
  33024. */
  33025. export class _MeshCollisionData {
  33026. _checkCollisions: boolean;
  33027. _collisionMask: number;
  33028. _collisionGroup: number;
  33029. _surroundingMeshes: Nullable<AbstractMesh[]>;
  33030. _collider: Nullable<Collider>;
  33031. _oldPositionForCollisions: Vector3;
  33032. _diffPositionForCollisions: Vector3;
  33033. _onCollideObserver: Nullable<Observer<AbstractMesh>>;
  33034. _onCollisionPositionChangeObserver: Nullable<Observer<Vector3>>;
  33035. }
  33036. }
  33037. declare module "babylonjs/Meshes/abstractMesh" {
  33038. import { Observable } from "babylonjs/Misc/observable";
  33039. import { Nullable, FloatArray, IndicesArray, DeepImmutable } from "babylonjs/types";
  33040. import { Camera } from "babylonjs/Cameras/camera";
  33041. import { Scene, IDisposable } from "babylonjs/scene";
  33042. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  33043. import { Node } from "babylonjs/node";
  33044. import { IGetSetVerticesData } from "babylonjs/Meshes/mesh.vertexData";
  33045. import { TransformNode } from "babylonjs/Meshes/transformNode";
  33046. import { SubMesh } from "babylonjs/Meshes/subMesh";
  33047. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  33048. import { ICullable, BoundingInfo } from "babylonjs/Culling/boundingInfo";
  33049. import { Material } from "babylonjs/Materials/material";
  33050. import { Light } from "babylonjs/Lights/light";
  33051. import { Skeleton } from "babylonjs/Bones/skeleton";
  33052. import { IEdgesRenderer } from "babylonjs/Rendering/edgesRenderer";
  33053. import { SolidParticle } from "babylonjs/Particles/solidParticle";
  33054. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  33055. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  33056. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  33057. import { Plane } from "babylonjs/Maths/math.plane";
  33058. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  33059. import { Ray } from "babylonjs/Culling/ray";
  33060. import { Collider } from "babylonjs/Collisions/collider";
  33061. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  33062. import { RenderingGroup } from "babylonjs/Rendering/renderingGroup";
  33063. /** @hidden */
  33064. class _FacetDataStorage {
  33065. facetPositions: Vector3[];
  33066. facetNormals: Vector3[];
  33067. facetPartitioning: number[][];
  33068. facetNb: number;
  33069. partitioningSubdivisions: number;
  33070. partitioningBBoxRatio: number;
  33071. facetDataEnabled: boolean;
  33072. facetParameters: any;
  33073. bbSize: Vector3;
  33074. subDiv: {
  33075. max: number;
  33076. X: number;
  33077. Y: number;
  33078. Z: number;
  33079. };
  33080. facetDepthSort: boolean;
  33081. facetDepthSortEnabled: boolean;
  33082. depthSortedIndices: IndicesArray;
  33083. depthSortedFacets: {
  33084. ind: number;
  33085. sqDistance: number;
  33086. }[];
  33087. facetDepthSortFunction: (f1: {
  33088. ind: number;
  33089. sqDistance: number;
  33090. }, f2: {
  33091. ind: number;
  33092. sqDistance: number;
  33093. }) => number;
  33094. facetDepthSortFrom: Vector3;
  33095. facetDepthSortOrigin: Vector3;
  33096. invertedMatrix: Matrix;
  33097. }
  33098. /**
  33099. * @hidden
  33100. **/
  33101. class _InternalAbstractMeshDataInfo {
  33102. _hasVertexAlpha: boolean;
  33103. _useVertexColors: boolean;
  33104. _numBoneInfluencers: number;
  33105. _applyFog: boolean;
  33106. _receiveShadows: boolean;
  33107. _facetData: _FacetDataStorage;
  33108. _visibility: number;
  33109. _skeleton: Nullable<Skeleton>;
  33110. _layerMask: number;
  33111. _computeBonesUsingShaders: boolean;
  33112. _isActive: boolean;
  33113. _onlyForInstances: boolean;
  33114. _isActiveIntermediate: boolean;
  33115. _onlyForInstancesIntermediate: boolean;
  33116. _actAsRegularMesh: boolean;
  33117. }
  33118. /**
  33119. * Class used to store all common mesh properties
  33120. */
  33121. export class AbstractMesh extends TransformNode implements IDisposable, ICullable, IGetSetVerticesData {
  33122. /** No occlusion */
  33123. static OCCLUSION_TYPE_NONE: number;
  33124. /** Occlusion set to optimisitic */
  33125. static OCCLUSION_TYPE_OPTIMISTIC: number;
  33126. /** Occlusion set to strict */
  33127. static OCCLUSION_TYPE_STRICT: number;
  33128. /** Use an accurante occlusion algorithm */
  33129. static OCCLUSION_ALGORITHM_TYPE_ACCURATE: number;
  33130. /** Use a conservative occlusion algorithm */
  33131. static OCCLUSION_ALGORITHM_TYPE_CONSERVATIVE: number;
  33132. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  33133. * Test order :
  33134. * Is the bounding sphere outside the frustum ?
  33135. * If not, are the bounding box vertices outside the frustum ?
  33136. * It not, then the cullable object is in the frustum.
  33137. */
  33138. static readonly CULLINGSTRATEGY_STANDARD: number;
  33139. /** Culling strategy : Bounding Sphere Only.
  33140. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  33141. * It's also less accurate than the standard because some not visible objects can still be selected.
  33142. * Test : is the bounding sphere outside the frustum ?
  33143. * If not, then the cullable object is in the frustum.
  33144. */
  33145. static readonly CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  33146. /** Culling strategy : Optimistic Inclusion.
  33147. * This in an inclusion test first, then the standard exclusion test.
  33148. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  33149. * This could also be a little slower than the standard test when the tested object center is not the frustum but one of its bounding box vertex is still inside.
  33150. * Anyway, it's as accurate as the standard strategy.
  33151. * Test :
  33152. * Is the cullable object bounding sphere center in the frustum ?
  33153. * If not, apply the default culling strategy.
  33154. */
  33155. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  33156. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  33157. * This in an inclusion test first, then the bounding sphere only exclusion test.
  33158. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  33159. * This could also be a little slower than the BoundingSphereOnly strategy when the tested object center is not in the frustum but its bounding sphere still intersects it.
  33160. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  33161. * Test :
  33162. * Is the cullable object bounding sphere center in the frustum ?
  33163. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  33164. */
  33165. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  33166. /**
  33167. * No billboard
  33168. */
  33169. static get BILLBOARDMODE_NONE(): number;
  33170. /** Billboard on X axis */
  33171. static get BILLBOARDMODE_X(): number;
  33172. /** Billboard on Y axis */
  33173. static get BILLBOARDMODE_Y(): number;
  33174. /** Billboard on Z axis */
  33175. static get BILLBOARDMODE_Z(): number;
  33176. /** Billboard on all axes */
  33177. static get BILLBOARDMODE_ALL(): number;
  33178. /** Billboard on using position instead of orientation */
  33179. static get BILLBOARDMODE_USE_POSITION(): number;
  33180. /** @hidden */
  33181. _internalAbstractMeshDataInfo: _InternalAbstractMeshDataInfo;
  33182. /**
  33183. * The culling strategy to use to check whether the mesh must be rendered or not.
  33184. * This value can be changed at any time and will be used on the next render mesh selection.
  33185. * The possible values are :
  33186. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  33187. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  33188. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  33189. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  33190. * Please read each static variable documentation to get details about the culling process.
  33191. * */
  33192. cullingStrategy: number;
  33193. /**
  33194. * Gets the number of facets in the mesh
  33195. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  33196. */
  33197. get facetNb(): number;
  33198. /**
  33199. * Gets or set the number (integer) of subdivisions per axis in the partioning space
  33200. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  33201. */
  33202. get partitioningSubdivisions(): number;
  33203. set partitioningSubdivisions(nb: number);
  33204. /**
  33205. * The ratio (float) to apply to the bouding box size to set to the partioning space.
  33206. * Ex : 1.01 (default) the partioning space is 1% bigger than the bounding box
  33207. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  33208. */
  33209. get partitioningBBoxRatio(): number;
  33210. set partitioningBBoxRatio(ratio: number);
  33211. /**
  33212. * Gets or sets a boolean indicating that the facets must be depth sorted on next call to `updateFacetData()`.
  33213. * Works only for updatable meshes.
  33214. * Doesn't work with multi-materials
  33215. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  33216. */
  33217. get mustDepthSortFacets(): boolean;
  33218. set mustDepthSortFacets(sort: boolean);
  33219. /**
  33220. * The location (Vector3) where the facet depth sort must be computed from.
  33221. * By default, the active camera position.
  33222. * Used only when facet depth sort is enabled
  33223. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  33224. */
  33225. get facetDepthSortFrom(): Vector3;
  33226. set facetDepthSortFrom(location: Vector3);
  33227. /**
  33228. * gets a boolean indicating if facetData is enabled
  33229. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  33230. */
  33231. get isFacetDataEnabled(): boolean;
  33232. /** @hidden */
  33233. _updateNonUniformScalingState(value: boolean): boolean;
  33234. /**
  33235. * An event triggered when this mesh collides with another one
  33236. */
  33237. onCollideObservable: Observable<AbstractMesh>;
  33238. /** Set a function to call when this mesh collides with another one */
  33239. set onCollide(callback: () => void);
  33240. /**
  33241. * An event triggered when the collision's position changes
  33242. */
  33243. onCollisionPositionChangeObservable: Observable<Vector3>;
  33244. /** Set a function to call when the collision's position changes */
  33245. set onCollisionPositionChange(callback: () => void);
  33246. /**
  33247. * An event triggered when material is changed
  33248. */
  33249. onMaterialChangedObservable: Observable<AbstractMesh>;
  33250. /**
  33251. * Gets or sets the orientation for POV movement & rotation
  33252. */
  33253. definedFacingForward: boolean;
  33254. /** @hidden */
  33255. _occlusionQuery: Nullable<WebGLQuery>;
  33256. /** @hidden */
  33257. _renderingGroup: Nullable<RenderingGroup>;
  33258. /**
  33259. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  33260. */
  33261. get visibility(): number;
  33262. /**
  33263. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  33264. */
  33265. set visibility(value: number);
  33266. /** Gets or sets the alpha index used to sort transparent meshes
  33267. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#alpha-index
  33268. */
  33269. alphaIndex: number;
  33270. /**
  33271. * Gets or sets a boolean indicating if the mesh is visible (renderable). Default is true
  33272. */
  33273. isVisible: boolean;
  33274. /**
  33275. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  33276. */
  33277. isPickable: boolean;
  33278. /** Gets or sets a boolean indicating that bounding boxes of subMeshes must be rendered as well (false by default) */
  33279. showSubMeshesBoundingBox: boolean;
  33280. /** Gets or sets a boolean indicating if the mesh must be considered as a ray blocker for lens flares (false by default)
  33281. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  33282. */
  33283. isBlocker: boolean;
  33284. /**
  33285. * Gets or sets a boolean indicating that pointer move events must be supported on this mesh (false by default)
  33286. */
  33287. enablePointerMoveEvents: boolean;
  33288. private _renderingGroupId;
  33289. /**
  33290. * Specifies the rendering group id for this mesh (0 by default)
  33291. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  33292. */
  33293. get renderingGroupId(): number;
  33294. set renderingGroupId(value: number);
  33295. private _material;
  33296. /** Gets or sets current material */
  33297. get material(): Nullable<Material>;
  33298. set material(value: Nullable<Material>);
  33299. /**
  33300. * Gets or sets a boolean indicating that this mesh can receive realtime shadows
  33301. * @see https://doc.babylonjs.com/babylon101/shadows
  33302. */
  33303. get receiveShadows(): boolean;
  33304. set receiveShadows(value: boolean);
  33305. /** Defines color to use when rendering outline */
  33306. outlineColor: Color3;
  33307. /** Define width to use when rendering outline */
  33308. outlineWidth: number;
  33309. /** Defines color to use when rendering overlay */
  33310. overlayColor: Color3;
  33311. /** Defines alpha to use when rendering overlay */
  33312. overlayAlpha: number;
  33313. /** Gets or sets a boolean indicating that this mesh contains vertex color data with alpha values */
  33314. get hasVertexAlpha(): boolean;
  33315. set hasVertexAlpha(value: boolean);
  33316. /** Gets or sets a boolean indicating that this mesh needs to use vertex color data to render (if this kind of vertex data is available in the geometry) */
  33317. get useVertexColors(): boolean;
  33318. set useVertexColors(value: boolean);
  33319. /**
  33320. * Gets or sets a boolean indicating that bone animations must be computed by the CPU (false by default)
  33321. */
  33322. get computeBonesUsingShaders(): boolean;
  33323. set computeBonesUsingShaders(value: boolean);
  33324. /** Gets or sets the number of allowed bone influences per vertex (4 by default) */
  33325. get numBoneInfluencers(): number;
  33326. set numBoneInfluencers(value: number);
  33327. /** Gets or sets a boolean indicating that this mesh will allow fog to be rendered on it (true by default) */
  33328. get applyFog(): boolean;
  33329. set applyFog(value: boolean);
  33330. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes selection (true by default) */
  33331. useOctreeForRenderingSelection: boolean;
  33332. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes picking (true by default) */
  33333. useOctreeForPicking: boolean;
  33334. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes collision (true by default) */
  33335. useOctreeForCollisions: boolean;
  33336. /**
  33337. * Gets or sets the current layer mask (default is 0x0FFFFFFF)
  33338. * @see https://doc.babylonjs.com/how_to/layermasks_and_multi-cam_textures
  33339. */
  33340. get layerMask(): number;
  33341. set layerMask(value: number);
  33342. /**
  33343. * True if the mesh must be rendered in any case (this will shortcut the frustum clipping phase)
  33344. */
  33345. alwaysSelectAsActiveMesh: boolean;
  33346. /**
  33347. * Gets or sets a boolean indicating that the bounding info does not need to be kept in sync (for performance reason)
  33348. */
  33349. doNotSyncBoundingInfo: boolean;
  33350. /**
  33351. * Gets or sets the current action manager
  33352. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  33353. */
  33354. actionManager: Nullable<AbstractActionManager>;
  33355. private _meshCollisionData;
  33356. /**
  33357. * Gets or sets the ellipsoid used to impersonate this mesh when using collision engine (default is (0.5, 1, 0.5))
  33358. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33359. */
  33360. ellipsoid: Vector3;
  33361. /**
  33362. * Gets or sets the ellipsoid offset used to impersonate this mesh when using collision engine (default is (0, 0, 0))
  33363. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33364. */
  33365. ellipsoidOffset: Vector3;
  33366. /**
  33367. * Gets or sets a collision mask used to mask collisions (default is -1).
  33368. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  33369. */
  33370. get collisionMask(): number;
  33371. set collisionMask(mask: number);
  33372. /**
  33373. * Gets or sets the current collision group mask (-1 by default).
  33374. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  33375. */
  33376. get collisionGroup(): number;
  33377. set collisionGroup(mask: number);
  33378. /**
  33379. * Gets or sets current surrounding meshes (null by default).
  33380. *
  33381. * By default collision detection is tested against every mesh in the scene.
  33382. * It is possible to set surroundingMeshes to a defined list of meshes and then only these specified
  33383. * meshes will be tested for the collision.
  33384. *
  33385. * Note: if set to an empty array no collision will happen when this mesh is moved.
  33386. */
  33387. get surroundingMeshes(): Nullable<AbstractMesh[]>;
  33388. set surroundingMeshes(meshes: Nullable<AbstractMesh[]>);
  33389. /**
  33390. * Defines edge width used when edgesRenderer is enabled
  33391. * @see https://www.babylonjs-playground.com/#10OJSG#13
  33392. */
  33393. edgesWidth: number;
  33394. /**
  33395. * Defines edge color used when edgesRenderer is enabled
  33396. * @see https://www.babylonjs-playground.com/#10OJSG#13
  33397. */
  33398. edgesColor: Color4;
  33399. /** @hidden */
  33400. _edgesRenderer: Nullable<IEdgesRenderer>;
  33401. /** @hidden */
  33402. _masterMesh: Nullable<AbstractMesh>;
  33403. /** @hidden */
  33404. _boundingInfo: Nullable<BoundingInfo>;
  33405. /** @hidden */
  33406. _renderId: number;
  33407. /**
  33408. * Gets or sets the list of subMeshes
  33409. * @see https://doc.babylonjs.com/how_to/multi_materials
  33410. */
  33411. subMeshes: SubMesh[];
  33412. /** @hidden */
  33413. _intersectionsInProgress: AbstractMesh[];
  33414. /** @hidden */
  33415. _unIndexed: boolean;
  33416. /** @hidden */
  33417. _lightSources: Light[];
  33418. /** Gets the list of lights affecting that mesh */
  33419. get lightSources(): Light[];
  33420. /** @hidden */
  33421. get _positions(): Nullable<Vector3[]>;
  33422. /** @hidden */
  33423. _waitingData: {
  33424. lods: Nullable<any>;
  33425. actions: Nullable<any>;
  33426. freezeWorldMatrix: Nullable<boolean>;
  33427. };
  33428. /** @hidden */
  33429. _bonesTransformMatrices: Nullable<Float32Array>;
  33430. /** @hidden */
  33431. _transformMatrixTexture: Nullable<RawTexture>;
  33432. /**
  33433. * Gets or sets a skeleton to apply skining transformations
  33434. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  33435. */
  33436. set skeleton(value: Nullable<Skeleton>);
  33437. get skeleton(): Nullable<Skeleton>;
  33438. /**
  33439. * An event triggered when the mesh is rebuilt.
  33440. */
  33441. onRebuildObservable: Observable<AbstractMesh>;
  33442. /**
  33443. * Creates a new AbstractMesh
  33444. * @param name defines the name of the mesh
  33445. * @param scene defines the hosting scene
  33446. */
  33447. constructor(name: string, scene?: Nullable<Scene>);
  33448. /**
  33449. * Returns the string "AbstractMesh"
  33450. * @returns "AbstractMesh"
  33451. */
  33452. getClassName(): string;
  33453. /**
  33454. * Gets a string representation of the current mesh
  33455. * @param fullDetails defines a boolean indicating if full details must be included
  33456. * @returns a string representation of the current mesh
  33457. */
  33458. toString(fullDetails?: boolean): string;
  33459. /**
  33460. * @hidden
  33461. */
  33462. protected _getEffectiveParent(): Nullable<Node>;
  33463. /** @hidden */
  33464. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  33465. /** @hidden */
  33466. _rebuild(): void;
  33467. /** @hidden */
  33468. _resyncLightSources(): void;
  33469. /** @hidden */
  33470. _resyncLightSource(light: Light): void;
  33471. /** @hidden */
  33472. _unBindEffect(): void;
  33473. /** @hidden */
  33474. _removeLightSource(light: Light, dispose: boolean): void;
  33475. private _markSubMeshesAsDirty;
  33476. /** @hidden */
  33477. _markSubMeshesAsLightDirty(dispose?: boolean): void;
  33478. /** @hidden */
  33479. _markSubMeshesAsAttributesDirty(): void;
  33480. /** @hidden */
  33481. _markSubMeshesAsMiscDirty(): void;
  33482. /**
  33483. * Gets or sets a Vector3 depicting the mesh scaling along each local axis X, Y, Z. Default is (1.0, 1.0, 1.0)
  33484. */
  33485. get scaling(): Vector3;
  33486. set scaling(newScaling: Vector3);
  33487. /**
  33488. * Returns true if the mesh is blocked. Implemented by child classes
  33489. */
  33490. get isBlocked(): boolean;
  33491. /**
  33492. * Returns the mesh itself by default. Implemented by child classes
  33493. * @param camera defines the camera to use to pick the right LOD level
  33494. * @returns the currentAbstractMesh
  33495. */
  33496. getLOD(camera: Camera): Nullable<AbstractMesh>;
  33497. /**
  33498. * Returns 0 by default. Implemented by child classes
  33499. * @returns an integer
  33500. */
  33501. getTotalVertices(): number;
  33502. /**
  33503. * Returns a positive integer : the total number of indices in this mesh geometry.
  33504. * @returns the numner of indices or zero if the mesh has no geometry.
  33505. */
  33506. getTotalIndices(): number;
  33507. /**
  33508. * Returns null by default. Implemented by child classes
  33509. * @returns null
  33510. */
  33511. getIndices(): Nullable<IndicesArray>;
  33512. /**
  33513. * Returns the array of the requested vertex data kind. Implemented by child classes
  33514. * @param kind defines the vertex data kind to use
  33515. * @returns null
  33516. */
  33517. getVerticesData(kind: string): Nullable<FloatArray>;
  33518. /**
  33519. * Sets the vertex data of the mesh geometry for the requested `kind`.
  33520. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  33521. * Note that a new underlying VertexBuffer object is created each call.
  33522. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  33523. * @param kind defines vertex data kind:
  33524. * * VertexBuffer.PositionKind
  33525. * * VertexBuffer.UVKind
  33526. * * VertexBuffer.UV2Kind
  33527. * * VertexBuffer.UV3Kind
  33528. * * VertexBuffer.UV4Kind
  33529. * * VertexBuffer.UV5Kind
  33530. * * VertexBuffer.UV6Kind
  33531. * * VertexBuffer.ColorKind
  33532. * * VertexBuffer.MatricesIndicesKind
  33533. * * VertexBuffer.MatricesIndicesExtraKind
  33534. * * VertexBuffer.MatricesWeightsKind
  33535. * * VertexBuffer.MatricesWeightsExtraKind
  33536. * @param data defines the data source
  33537. * @param updatable defines if the data must be flagged as updatable (or static)
  33538. * @param stride defines the vertex stride (size of an entire vertex). Can be null and in this case will be deduced from vertex data kind
  33539. * @returns the current mesh
  33540. */
  33541. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  33542. /**
  33543. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  33544. * If the mesh has no geometry, it is simply returned as it is.
  33545. * @param kind defines vertex data kind:
  33546. * * VertexBuffer.PositionKind
  33547. * * VertexBuffer.UVKind
  33548. * * VertexBuffer.UV2Kind
  33549. * * VertexBuffer.UV3Kind
  33550. * * VertexBuffer.UV4Kind
  33551. * * VertexBuffer.UV5Kind
  33552. * * VertexBuffer.UV6Kind
  33553. * * VertexBuffer.ColorKind
  33554. * * VertexBuffer.MatricesIndicesKind
  33555. * * VertexBuffer.MatricesIndicesExtraKind
  33556. * * VertexBuffer.MatricesWeightsKind
  33557. * * VertexBuffer.MatricesWeightsExtraKind
  33558. * @param data defines the data source
  33559. * @param updateExtends If `kind` is `PositionKind` and if `updateExtends` is true, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed
  33560. * @param makeItUnique If true, a new global geometry is created from this data and is set to the mesh
  33561. * @returns the current mesh
  33562. */
  33563. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  33564. /**
  33565. * Sets the mesh indices,
  33566. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  33567. * @param indices Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array)
  33568. * @param totalVertices Defines the total number of vertices
  33569. * @returns the current mesh
  33570. */
  33571. setIndices(indices: IndicesArray, totalVertices: Nullable<number>): AbstractMesh;
  33572. /**
  33573. * Gets a boolean indicating if specific vertex data is present
  33574. * @param kind defines the vertex data kind to use
  33575. * @returns true is data kind is present
  33576. */
  33577. isVerticesDataPresent(kind: string): boolean;
  33578. /**
  33579. * Returns the mesh BoundingInfo object or creates a new one and returns if it was undefined.
  33580. * Note that it returns a shallow bounding of the mesh (i.e. it does not include children).
  33581. * To get the full bounding of all children, call `getHierarchyBoundingVectors` instead.
  33582. * @returns a BoundingInfo
  33583. */
  33584. getBoundingInfo(): BoundingInfo;
  33585. /**
  33586. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  33587. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  33588. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  33589. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  33590. * @returns the current mesh
  33591. */
  33592. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): AbstractMesh;
  33593. /**
  33594. * Overwrite the current bounding info
  33595. * @param boundingInfo defines the new bounding info
  33596. * @returns the current mesh
  33597. */
  33598. setBoundingInfo(boundingInfo: BoundingInfo): AbstractMesh;
  33599. /** Gets a boolean indicating if this mesh has skinning data and an attached skeleton */
  33600. get useBones(): boolean;
  33601. /** @hidden */
  33602. _preActivate(): void;
  33603. /** @hidden */
  33604. _preActivateForIntermediateRendering(renderId: number): void;
  33605. /** @hidden */
  33606. _activate(renderId: number, intermediateRendering: boolean): boolean;
  33607. /** @hidden */
  33608. _postActivate(): void;
  33609. /** @hidden */
  33610. _freeze(): void;
  33611. /** @hidden */
  33612. _unFreeze(): void;
  33613. /**
  33614. * Gets the current world matrix
  33615. * @returns a Matrix
  33616. */
  33617. getWorldMatrix(): Matrix;
  33618. /** @hidden */
  33619. _getWorldMatrixDeterminant(): number;
  33620. /**
  33621. * Gets a boolean indicating if this mesh is an instance or a regular mesh
  33622. */
  33623. get isAnInstance(): boolean;
  33624. /**
  33625. * Gets a boolean indicating if this mesh has instances
  33626. */
  33627. get hasInstances(): boolean;
  33628. /**
  33629. * Gets a boolean indicating if this mesh has thin instances
  33630. */
  33631. get hasThinInstances(): boolean;
  33632. /**
  33633. * Perform relative position change from the point of view of behind the front of the mesh.
  33634. * This is performed taking into account the meshes current rotation, so you do not have to care.
  33635. * Supports definition of mesh facing forward or backward
  33636. * @param amountRight defines the distance on the right axis
  33637. * @param amountUp defines the distance on the up axis
  33638. * @param amountForward defines the distance on the forward axis
  33639. * @returns the current mesh
  33640. */
  33641. movePOV(amountRight: number, amountUp: number, amountForward: number): AbstractMesh;
  33642. /**
  33643. * Calculate relative position change from the point of view of behind the front of the mesh.
  33644. * This is performed taking into account the meshes current rotation, so you do not have to care.
  33645. * Supports definition of mesh facing forward or backward
  33646. * @param amountRight defines the distance on the right axis
  33647. * @param amountUp defines the distance on the up axis
  33648. * @param amountForward defines the distance on the forward axis
  33649. * @returns the new displacement vector
  33650. */
  33651. calcMovePOV(amountRight: number, amountUp: number, amountForward: number): Vector3;
  33652. /**
  33653. * Perform relative rotation change from the point of view of behind the front of the mesh.
  33654. * Supports definition of mesh facing forward or backward
  33655. * @param flipBack defines the flip
  33656. * @param twirlClockwise defines the twirl
  33657. * @param tiltRight defines the tilt
  33658. * @returns the current mesh
  33659. */
  33660. rotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): AbstractMesh;
  33661. /**
  33662. * Calculate relative rotation change from the point of view of behind the front of the mesh.
  33663. * Supports definition of mesh facing forward or backward.
  33664. * @param flipBack defines the flip
  33665. * @param twirlClockwise defines the twirl
  33666. * @param tiltRight defines the tilt
  33667. * @returns the new rotation vector
  33668. */
  33669. calcRotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): Vector3;
  33670. /**
  33671. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  33672. * This means the mesh underlying bounding box and sphere are recomputed.
  33673. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  33674. * @returns the current mesh
  33675. */
  33676. refreshBoundingInfo(applySkeleton?: boolean): AbstractMesh;
  33677. /** @hidden */
  33678. _refreshBoundingInfo(data: Nullable<FloatArray>, bias: Nullable<Vector2>): void;
  33679. /** @hidden */
  33680. _getPositionData(applySkeleton: boolean): Nullable<FloatArray>;
  33681. /** @hidden */
  33682. _updateBoundingInfo(): AbstractMesh;
  33683. /** @hidden */
  33684. _updateSubMeshesBoundingInfo(matrix: DeepImmutable<Matrix>): AbstractMesh;
  33685. /** @hidden */
  33686. protected _afterComputeWorldMatrix(): void;
  33687. /** @hidden */
  33688. get _effectiveMesh(): AbstractMesh;
  33689. /**
  33690. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  33691. * A mesh is in the frustum if its bounding box intersects the frustum
  33692. * @param frustumPlanes defines the frustum to test
  33693. * @returns true if the mesh is in the frustum planes
  33694. */
  33695. isInFrustum(frustumPlanes: Plane[]): boolean;
  33696. /**
  33697. * Returns `true` if the mesh is completely in the frustum defined be the passed array of planes.
  33698. * A mesh is completely in the frustum if its bounding box it completely inside the frustum.
  33699. * @param frustumPlanes defines the frustum to test
  33700. * @returns true if the mesh is completely in the frustum planes
  33701. */
  33702. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  33703. /**
  33704. * True if the mesh intersects another mesh or a SolidParticle object
  33705. * @param mesh defines a target mesh or SolidParticle to test
  33706. * @param precise Unless the parameter `precise` is set to `true` the intersection is computed according to Axis Aligned Bounding Boxes (AABB), else according to OBB (Oriented BBoxes)
  33707. * @param includeDescendants Can be set to true to test if the mesh defined in parameters intersects with the current mesh or any child meshes
  33708. * @returns true if there is an intersection
  33709. */
  33710. intersectsMesh(mesh: AbstractMesh | SolidParticle, precise?: boolean, includeDescendants?: boolean): boolean;
  33711. /**
  33712. * Returns true if the passed point (Vector3) is inside the mesh bounding box
  33713. * @param point defines the point to test
  33714. * @returns true if there is an intersection
  33715. */
  33716. intersectsPoint(point: Vector3): boolean;
  33717. /**
  33718. * Gets or sets a boolean indicating that this mesh can be used in the collision engine
  33719. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33720. */
  33721. get checkCollisions(): boolean;
  33722. set checkCollisions(collisionEnabled: boolean);
  33723. /**
  33724. * Gets Collider object used to compute collisions (not physics)
  33725. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33726. */
  33727. get collider(): Nullable<Collider>;
  33728. /**
  33729. * Move the mesh using collision engine
  33730. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33731. * @param displacement defines the requested displacement vector
  33732. * @returns the current mesh
  33733. */
  33734. moveWithCollisions(displacement: Vector3): AbstractMesh;
  33735. private _onCollisionPositionChange;
  33736. /** @hidden */
  33737. _collideForSubMesh(subMesh: SubMesh, transformMatrix: Matrix, collider: Collider): AbstractMesh;
  33738. /** @hidden */
  33739. _processCollisionsForSubMeshes(collider: Collider, transformMatrix: Matrix): AbstractMesh;
  33740. /** @hidden */
  33741. _checkCollision(collider: Collider): AbstractMesh;
  33742. /** @hidden */
  33743. _generatePointsArray(): boolean;
  33744. /**
  33745. * Checks if the passed Ray intersects with the mesh
  33746. * @param ray defines the ray to use
  33747. * @param fastCheck defines if fast mode (but less precise) must be used (false by default)
  33748. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  33749. * @param onlyBoundingInfo defines a boolean indicating if picking should only happen using bounding info (false by default)
  33750. * @param worldToUse defines the world matrix to use to get the world coordinate of the intersection point
  33751. * @returns the picking info
  33752. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  33753. */
  33754. intersects(ray: Ray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate, onlyBoundingInfo?: boolean, worldToUse?: Matrix): PickingInfo;
  33755. /**
  33756. * Clones the current mesh
  33757. * @param name defines the mesh name
  33758. * @param newParent defines the new mesh parent
  33759. * @param doNotCloneChildren defines a boolean indicating that children must not be cloned (false by default)
  33760. * @returns the new mesh
  33761. */
  33762. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  33763. /**
  33764. * Disposes all the submeshes of the current meshnp
  33765. * @returns the current mesh
  33766. */
  33767. releaseSubMeshes(): AbstractMesh;
  33768. /**
  33769. * Releases resources associated with this abstract mesh.
  33770. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  33771. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  33772. */
  33773. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  33774. /**
  33775. * Adds the passed mesh as a child to the current mesh
  33776. * @param mesh defines the child mesh
  33777. * @returns the current mesh
  33778. */
  33779. addChild(mesh: AbstractMesh): AbstractMesh;
  33780. /**
  33781. * Removes the passed mesh from the current mesh children list
  33782. * @param mesh defines the child mesh
  33783. * @returns the current mesh
  33784. */
  33785. removeChild(mesh: AbstractMesh): AbstractMesh;
  33786. /** @hidden */
  33787. private _initFacetData;
  33788. /**
  33789. * Updates the mesh facetData arrays and the internal partitioning when the mesh is morphed or updated.
  33790. * This method can be called within the render loop.
  33791. * You don't need to call this method by yourself in the render loop when you update/morph a mesh with the methods CreateXXX() as they automatically manage this computation
  33792. * @returns the current mesh
  33793. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33794. */
  33795. updateFacetData(): AbstractMesh;
  33796. /**
  33797. * Returns the facetLocalNormals array.
  33798. * The normals are expressed in the mesh local spac
  33799. * @returns an array of Vector3
  33800. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33801. */
  33802. getFacetLocalNormals(): Vector3[];
  33803. /**
  33804. * Returns the facetLocalPositions array.
  33805. * The facet positions are expressed in the mesh local space
  33806. * @returns an array of Vector3
  33807. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33808. */
  33809. getFacetLocalPositions(): Vector3[];
  33810. /**
  33811. * Returns the facetLocalPartioning array
  33812. * @returns an array of array of numbers
  33813. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33814. */
  33815. getFacetLocalPartitioning(): number[][];
  33816. /**
  33817. * Returns the i-th facet position in the world system.
  33818. * This method allocates a new Vector3 per call
  33819. * @param i defines the facet index
  33820. * @returns a new Vector3
  33821. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33822. */
  33823. getFacetPosition(i: number): Vector3;
  33824. /**
  33825. * Sets the reference Vector3 with the i-th facet position in the world system
  33826. * @param i defines the facet index
  33827. * @param ref defines the target vector
  33828. * @returns the current mesh
  33829. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33830. */
  33831. getFacetPositionToRef(i: number, ref: Vector3): AbstractMesh;
  33832. /**
  33833. * Returns the i-th facet normal in the world system.
  33834. * This method allocates a new Vector3 per call
  33835. * @param i defines the facet index
  33836. * @returns a new Vector3
  33837. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33838. */
  33839. getFacetNormal(i: number): Vector3;
  33840. /**
  33841. * Sets the reference Vector3 with the i-th facet normal in the world system
  33842. * @param i defines the facet index
  33843. * @param ref defines the target vector
  33844. * @returns the current mesh
  33845. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33846. */
  33847. getFacetNormalToRef(i: number, ref: Vector3): this;
  33848. /**
  33849. * Returns the facets (in an array) in the same partitioning block than the one the passed coordinates are located (expressed in the mesh local system)
  33850. * @param x defines x coordinate
  33851. * @param y defines y coordinate
  33852. * @param z defines z coordinate
  33853. * @returns the array of facet indexes
  33854. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33855. */
  33856. getFacetsAtLocalCoordinates(x: number, y: number, z: number): Nullable<number[]>;
  33857. /**
  33858. * Returns the closest mesh facet index at (x,y,z) World coordinates, null if not found
  33859. * @param projected sets as the (x,y,z) world projection on the facet
  33860. * @param checkFace if true (default false), only the facet "facing" to (x,y,z) or only the ones "turning their backs", according to the parameter "facing" are returned
  33861. * @param facing if facing and checkFace are true, only the facet "facing" to (x, y, z) are returned : positive dot (x, y, z) * facet position. If facing si false and checkFace is true, only the facet "turning their backs" to (x, y, z) are returned : negative dot (x, y, z) * facet position
  33862. * @param x defines x coordinate
  33863. * @param y defines y coordinate
  33864. * @param z defines z coordinate
  33865. * @returns the face index if found (or null instead)
  33866. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33867. */
  33868. getClosestFacetAtCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  33869. /**
  33870. * Returns the closest mesh facet index at (x,y,z) local coordinates, null if not found
  33871. * @param projected sets as the (x,y,z) local projection on the facet
  33872. * @param checkFace if true (default false), only the facet "facing" to (x,y,z) or only the ones "turning their backs", according to the parameter "facing" are returned
  33873. * @param facing if facing and checkFace are true, only the facet "facing" to (x, y, z) are returned : positive dot (x, y, z) * facet position. If facing si false and checkFace is true, only the facet "turning their backs" to (x, y, z) are returned : negative dot (x, y, z) * facet position
  33874. * @param x defines x coordinate
  33875. * @param y defines y coordinate
  33876. * @param z defines z coordinate
  33877. * @returns the face index if found (or null instead)
  33878. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33879. */
  33880. getClosestFacetAtLocalCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  33881. /**
  33882. * Returns the object "parameter" set with all the expected parameters for facetData computation by ComputeNormals()
  33883. * @returns the parameters
  33884. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33885. */
  33886. getFacetDataParameters(): any;
  33887. /**
  33888. * Disables the feature FacetData and frees the related memory
  33889. * @returns the current mesh
  33890. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33891. */
  33892. disableFacetData(): AbstractMesh;
  33893. /**
  33894. * Updates the AbstractMesh indices array
  33895. * @param indices defines the data source
  33896. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  33897. * @param gpuMemoryOnly defines a boolean indicating that only the GPU memory must be updated leaving the CPU version of the indices unchanged (false by default)
  33898. * @returns the current mesh
  33899. */
  33900. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  33901. /**
  33902. * Creates new normals data for the mesh
  33903. * @param updatable defines if the normal vertex buffer must be flagged as updatable
  33904. * @returns the current mesh
  33905. */
  33906. createNormals(updatable: boolean): AbstractMesh;
  33907. /**
  33908. * Align the mesh with a normal
  33909. * @param normal defines the normal to use
  33910. * @param upDirection can be used to redefined the up vector to use (will use the (0, 1, 0) by default)
  33911. * @returns the current mesh
  33912. */
  33913. alignWithNormal(normal: Vector3, upDirection?: Vector3): AbstractMesh;
  33914. /** @hidden */
  33915. _checkOcclusionQuery(): boolean;
  33916. /**
  33917. * Disables the mesh edge rendering mode
  33918. * @returns the currentAbstractMesh
  33919. */
  33920. disableEdgesRendering(): AbstractMesh;
  33921. /**
  33922. * Enables the edge rendering mode on the mesh.
  33923. * This mode makes the mesh edges visible
  33924. * @param epsilon defines the maximal distance between two angles to detect a face
  33925. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  33926. * @returns the currentAbstractMesh
  33927. * @see https://www.babylonjs-playground.com/#19O9TU#0
  33928. */
  33929. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  33930. /**
  33931. * This function returns all of the particle systems in the scene that use the mesh as an emitter.
  33932. * @returns an array of particle systems in the scene that use the mesh as an emitter
  33933. */
  33934. getConnectedParticleSystems(): IParticleSystem[];
  33935. }
  33936. }
  33937. declare module "babylonjs/Actions/actionEvent" {
  33938. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  33939. import { Nullable } from "babylonjs/types";
  33940. import { Sprite } from "babylonjs/Sprites/sprite";
  33941. import { Scene } from "babylonjs/scene";
  33942. import { Vector2 } from "babylonjs/Maths/math.vector";
  33943. /**
  33944. * Interface used to define ActionEvent
  33945. */
  33946. export interface IActionEvent {
  33947. /** The mesh or sprite that triggered the action */
  33948. source: any;
  33949. /** The X mouse cursor position at the time of the event */
  33950. pointerX: number;
  33951. /** The Y mouse cursor position at the time of the event */
  33952. pointerY: number;
  33953. /** The mesh that is currently pointed at (can be null) */
  33954. meshUnderPointer: Nullable<AbstractMesh>;
  33955. /** the original (browser) event that triggered the ActionEvent */
  33956. sourceEvent?: any;
  33957. /** additional data for the event */
  33958. additionalData?: any;
  33959. }
  33960. /**
  33961. * ActionEvent is the event being sent when an action is triggered.
  33962. */
  33963. export class ActionEvent implements IActionEvent {
  33964. /** The mesh or sprite that triggered the action */
  33965. source: any;
  33966. /** The X mouse cursor position at the time of the event */
  33967. pointerX: number;
  33968. /** The Y mouse cursor position at the time of the event */
  33969. pointerY: number;
  33970. /** The mesh that is currently pointed at (can be null) */
  33971. meshUnderPointer: Nullable<AbstractMesh>;
  33972. /** the original (browser) event that triggered the ActionEvent */
  33973. sourceEvent?: any;
  33974. /** additional data for the event */
  33975. additionalData?: any;
  33976. /**
  33977. * Creates a new ActionEvent
  33978. * @param source The mesh or sprite that triggered the action
  33979. * @param pointerX The X mouse cursor position at the time of the event
  33980. * @param pointerY The Y mouse cursor position at the time of the event
  33981. * @param meshUnderPointer The mesh that is currently pointed at (can be null)
  33982. * @param sourceEvent the original (browser) event that triggered the ActionEvent
  33983. * @param additionalData additional data for the event
  33984. */
  33985. constructor(
  33986. /** The mesh or sprite that triggered the action */
  33987. source: any,
  33988. /** The X mouse cursor position at the time of the event */
  33989. pointerX: number,
  33990. /** The Y mouse cursor position at the time of the event */
  33991. pointerY: number,
  33992. /** The mesh that is currently pointed at (can be null) */
  33993. meshUnderPointer: Nullable<AbstractMesh>,
  33994. /** the original (browser) event that triggered the ActionEvent */
  33995. sourceEvent?: any,
  33996. /** additional data for the event */
  33997. additionalData?: any);
  33998. /**
  33999. * Helper function to auto-create an ActionEvent from a source mesh.
  34000. * @param source The source mesh that triggered the event
  34001. * @param evt The original (browser) event
  34002. * @param additionalData additional data for the event
  34003. * @returns the new ActionEvent
  34004. */
  34005. static CreateNew(source: AbstractMesh, evt?: Event, additionalData?: any): ActionEvent;
  34006. /**
  34007. * Helper function to auto-create an ActionEvent from a source sprite
  34008. * @param source The source sprite that triggered the event
  34009. * @param scene Scene associated with the sprite
  34010. * @param evt The original (browser) event
  34011. * @param additionalData additional data for the event
  34012. * @returns the new ActionEvent
  34013. */
  34014. static CreateNewFromSprite(source: Sprite, scene: Scene, evt?: Event, additionalData?: any): ActionEvent;
  34015. /**
  34016. * Helper function to auto-create an ActionEvent from a scene. If triggered by a mesh use ActionEvent.CreateNew
  34017. * @param scene the scene where the event occurred
  34018. * @param evt The original (browser) event
  34019. * @returns the new ActionEvent
  34020. */
  34021. static CreateNewFromScene(scene: Scene, evt: Event): ActionEvent;
  34022. /**
  34023. * Helper function to auto-create an ActionEvent from a primitive
  34024. * @param prim defines the target primitive
  34025. * @param pointerPos defines the pointer position
  34026. * @param evt The original (browser) event
  34027. * @param additionalData additional data for the event
  34028. * @returns the new ActionEvent
  34029. */
  34030. static CreateNewFromPrimitive(prim: any, pointerPos: Vector2, evt?: Event, additionalData?: any): ActionEvent;
  34031. }
  34032. }
  34033. declare module "babylonjs/Actions/abstractActionManager" {
  34034. import { IDisposable } from "babylonjs/scene";
  34035. import { IActionEvent } from "babylonjs/Actions/actionEvent";
  34036. import { IAction } from "babylonjs/Actions/action";
  34037. import { Nullable } from "babylonjs/types";
  34038. /**
  34039. * Abstract class used to decouple action Manager from scene and meshes.
  34040. * Do not instantiate.
  34041. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  34042. */
  34043. export abstract class AbstractActionManager implements IDisposable {
  34044. /** Gets the list of active triggers */
  34045. static Triggers: {
  34046. [key: string]: number;
  34047. };
  34048. /** Gets the cursor to use when hovering items */
  34049. hoverCursor: string;
  34050. /** Gets the list of actions */
  34051. actions: IAction[];
  34052. /**
  34053. * Gets or sets a boolean indicating that the manager is recursive meaning that it can trigger action from children
  34054. */
  34055. isRecursive: boolean;
  34056. /**
  34057. * Releases all associated resources
  34058. */
  34059. abstract dispose(): void;
  34060. /**
  34061. * Does this action manager has pointer triggers
  34062. */
  34063. abstract get hasPointerTriggers(): boolean;
  34064. /**
  34065. * Does this action manager has pick triggers
  34066. */
  34067. abstract get hasPickTriggers(): boolean;
  34068. /**
  34069. * Process a specific trigger
  34070. * @param trigger defines the trigger to process
  34071. * @param evt defines the event details to be processed
  34072. */
  34073. abstract processTrigger(trigger: number, evt?: IActionEvent): void;
  34074. /**
  34075. * Does this action manager handles actions of any of the given triggers
  34076. * @param triggers defines the triggers to be tested
  34077. * @return a boolean indicating whether one (or more) of the triggers is handled
  34078. */
  34079. abstract hasSpecificTriggers(triggers: number[]): boolean;
  34080. /**
  34081. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  34082. * speed.
  34083. * @param triggerA defines the trigger to be tested
  34084. * @param triggerB defines the trigger to be tested
  34085. * @return a boolean indicating whether one (or more) of the triggers is handled
  34086. */
  34087. abstract hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  34088. /**
  34089. * Does this action manager handles actions of a given trigger
  34090. * @param trigger defines the trigger to be tested
  34091. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  34092. * @return whether the trigger is handled
  34093. */
  34094. abstract hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  34095. /**
  34096. * Serialize this manager to a JSON object
  34097. * @param name defines the property name to store this manager
  34098. * @returns a JSON representation of this manager
  34099. */
  34100. abstract serialize(name: string): any;
  34101. /**
  34102. * Registers an action to this action manager
  34103. * @param action defines the action to be registered
  34104. * @return the action amended (prepared) after registration
  34105. */
  34106. abstract registerAction(action: IAction): Nullable<IAction>;
  34107. /**
  34108. * Unregisters an action to this action manager
  34109. * @param action defines the action to be unregistered
  34110. * @return a boolean indicating whether the action has been unregistered
  34111. */
  34112. abstract unregisterAction(action: IAction): Boolean;
  34113. /**
  34114. * Does exist one action manager with at least one trigger
  34115. **/
  34116. static get HasTriggers(): boolean;
  34117. /**
  34118. * Does exist one action manager with at least one pick trigger
  34119. **/
  34120. static get HasPickTriggers(): boolean;
  34121. /**
  34122. * Does exist one action manager that handles actions of a given trigger
  34123. * @param trigger defines the trigger to be tested
  34124. * @return a boolean indicating whether the trigger is handeled by at least one action manager
  34125. **/
  34126. static HasSpecificTrigger(trigger: number): boolean;
  34127. }
  34128. }
  34129. declare module "babylonjs/node" {
  34130. import { Scene } from "babylonjs/scene";
  34131. import { Nullable } from "babylonjs/types";
  34132. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  34133. import { Engine } from "babylonjs/Engines/engine";
  34134. import { IBehaviorAware, Behavior } from "babylonjs/Behaviors/behavior";
  34135. import { Observable } from "babylonjs/Misc/observable";
  34136. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  34137. import { IInspectable } from "babylonjs/Misc/iInspectable";
  34138. import { Animatable } from "babylonjs/Animations/animatable";
  34139. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  34140. import { Animation } from "babylonjs/Animations/animation";
  34141. import { AnimationRange } from "babylonjs/Animations/animationRange";
  34142. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  34143. /**
  34144. * Defines how a node can be built from a string name.
  34145. */
  34146. export type NodeConstructor = (name: string, scene: Scene, options?: any) => () => Node;
  34147. /**
  34148. * Node is the basic class for all scene objects (Mesh, Light, Camera.)
  34149. */
  34150. export class Node implements IBehaviorAware<Node> {
  34151. /** @hidden */
  34152. static _AnimationRangeFactory: (name: string, from: number, to: number) => AnimationRange;
  34153. private static _NodeConstructors;
  34154. /**
  34155. * Add a new node constructor
  34156. * @param type defines the type name of the node to construct
  34157. * @param constructorFunc defines the constructor function
  34158. */
  34159. static AddNodeConstructor(type: string, constructorFunc: NodeConstructor): void;
  34160. /**
  34161. * Returns a node constructor based on type name
  34162. * @param type defines the type name
  34163. * @param name defines the new node name
  34164. * @param scene defines the hosting scene
  34165. * @param options defines optional options to transmit to constructors
  34166. * @returns the new constructor or null
  34167. */
  34168. static Construct(type: string, name: string, scene: Scene, options?: any): Nullable<() => Node>;
  34169. /**
  34170. * Gets or sets the name of the node
  34171. */
  34172. name: string;
  34173. /**
  34174. * Gets or sets the id of the node
  34175. */
  34176. id: string;
  34177. /**
  34178. * Gets or sets the unique id of the node
  34179. */
  34180. uniqueId: number;
  34181. /**
  34182. * Gets or sets a string used to store user defined state for the node
  34183. */
  34184. state: string;
  34185. /**
  34186. * Gets or sets an object used to store user defined information for the node
  34187. */
  34188. metadata: any;
  34189. /**
  34190. * For internal use only. Please do not use.
  34191. */
  34192. reservedDataStore: any;
  34193. /**
  34194. * List of inspectable custom properties (used by the Inspector)
  34195. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  34196. */
  34197. inspectableCustomProperties: IInspectable[];
  34198. private _doNotSerialize;
  34199. /**
  34200. * Gets or sets a boolean used to define if the node must be serialized
  34201. */
  34202. get doNotSerialize(): boolean;
  34203. set doNotSerialize(value: boolean);
  34204. /** @hidden */
  34205. _isDisposed: boolean;
  34206. /**
  34207. * Gets a list of Animations associated with the node
  34208. */
  34209. animations: import("babylonjs/Animations/animation").Animation[];
  34210. protected _ranges: {
  34211. [name: string]: Nullable<AnimationRange>;
  34212. };
  34213. /**
  34214. * Callback raised when the node is ready to be used
  34215. */
  34216. onReady: Nullable<(node: Node) => void>;
  34217. private _isEnabled;
  34218. private _isParentEnabled;
  34219. private _isReady;
  34220. /** @hidden */
  34221. _currentRenderId: number;
  34222. private _parentUpdateId;
  34223. /** @hidden */
  34224. _childUpdateId: number;
  34225. /** @hidden */
  34226. _waitingParentId: Nullable<string>;
  34227. /** @hidden */
  34228. _scene: Scene;
  34229. /** @hidden */
  34230. _cache: any;
  34231. private _parentNode;
  34232. private _children;
  34233. /** @hidden */
  34234. _worldMatrix: Matrix;
  34235. /** @hidden */
  34236. _worldMatrixDeterminant: number;
  34237. /** @hidden */
  34238. _worldMatrixDeterminantIsDirty: boolean;
  34239. /** @hidden */
  34240. private _sceneRootNodesIndex;
  34241. /**
  34242. * Gets a boolean indicating if the node has been disposed
  34243. * @returns true if the node was disposed
  34244. */
  34245. isDisposed(): boolean;
  34246. /**
  34247. * Gets or sets the parent of the node (without keeping the current position in the scene)
  34248. * @see https://doc.babylonjs.com/how_to/parenting
  34249. */
  34250. set parent(parent: Nullable<Node>);
  34251. get parent(): Nullable<Node>;
  34252. /** @hidden */
  34253. _addToSceneRootNodes(): void;
  34254. /** @hidden */
  34255. _removeFromSceneRootNodes(): void;
  34256. private _animationPropertiesOverride;
  34257. /**
  34258. * Gets or sets the animation properties override
  34259. */
  34260. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  34261. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  34262. /**
  34263. * Gets a string identifying the name of the class
  34264. * @returns "Node" string
  34265. */
  34266. getClassName(): string;
  34267. /** @hidden */
  34268. readonly _isNode: boolean;
  34269. /**
  34270. * An event triggered when the mesh is disposed
  34271. */
  34272. onDisposeObservable: Observable<Node>;
  34273. private _onDisposeObserver;
  34274. /**
  34275. * Sets a callback that will be raised when the node will be disposed
  34276. */
  34277. set onDispose(callback: () => void);
  34278. /**
  34279. * Creates a new Node
  34280. * @param name the name and id to be given to this node
  34281. * @param scene the scene this node will be added to
  34282. */
  34283. constructor(name: string, scene?: Nullable<Scene>);
  34284. /**
  34285. * Gets the scene of the node
  34286. * @returns a scene
  34287. */
  34288. getScene(): Scene;
  34289. /**
  34290. * Gets the engine of the node
  34291. * @returns a Engine
  34292. */
  34293. getEngine(): Engine;
  34294. private _behaviors;
  34295. /**
  34296. * Attach a behavior to the node
  34297. * @see https://doc.babylonjs.com/features/behaviour
  34298. * @param behavior defines the behavior to attach
  34299. * @param attachImmediately defines that the behavior must be attached even if the scene is still loading
  34300. * @returns the current Node
  34301. */
  34302. addBehavior(behavior: Behavior<Node>, attachImmediately?: boolean): Node;
  34303. /**
  34304. * Remove an attached behavior
  34305. * @see https://doc.babylonjs.com/features/behaviour
  34306. * @param behavior defines the behavior to attach
  34307. * @returns the current Node
  34308. */
  34309. removeBehavior(behavior: Behavior<Node>): Node;
  34310. /**
  34311. * Gets the list of attached behaviors
  34312. * @see https://doc.babylonjs.com/features/behaviour
  34313. */
  34314. get behaviors(): Behavior<Node>[];
  34315. /**
  34316. * Gets an attached behavior by name
  34317. * @param name defines the name of the behavior to look for
  34318. * @see https://doc.babylonjs.com/features/behaviour
  34319. * @returns null if behavior was not found else the requested behavior
  34320. */
  34321. getBehaviorByName(name: string): Nullable<Behavior<Node>>;
  34322. /**
  34323. * Returns the latest update of the World matrix
  34324. * @returns a Matrix
  34325. */
  34326. getWorldMatrix(): Matrix;
  34327. /** @hidden */
  34328. _getWorldMatrixDeterminant(): number;
  34329. /**
  34330. * Returns directly the latest state of the mesh World matrix.
  34331. * A Matrix is returned.
  34332. */
  34333. get worldMatrixFromCache(): Matrix;
  34334. /** @hidden */
  34335. _initCache(): void;
  34336. /** @hidden */
  34337. updateCache(force?: boolean): void;
  34338. /** @hidden */
  34339. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  34340. /** @hidden */
  34341. _updateCache(ignoreParentClass?: boolean): void;
  34342. /** @hidden */
  34343. _isSynchronized(): boolean;
  34344. /** @hidden */
  34345. _markSyncedWithParent(): void;
  34346. /** @hidden */
  34347. isSynchronizedWithParent(): boolean;
  34348. /** @hidden */
  34349. isSynchronized(): boolean;
  34350. /**
  34351. * Is this node ready to be used/rendered
  34352. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  34353. * @return true if the node is ready
  34354. */
  34355. isReady(completeCheck?: boolean): boolean;
  34356. /**
  34357. * Is this node enabled?
  34358. * If the node has a parent, all ancestors will be checked and false will be returned if any are false (not enabled), otherwise will return true
  34359. * @param checkAncestors indicates if this method should check the ancestors. The default is to check the ancestors. If set to false, the method will return the value of this node without checking ancestors
  34360. * @return whether this node (and its parent) is enabled
  34361. */
  34362. isEnabled(checkAncestors?: boolean): boolean;
  34363. /** @hidden */
  34364. protected _syncParentEnabledState(): void;
  34365. /**
  34366. * Set the enabled state of this node
  34367. * @param value defines the new enabled state
  34368. */
  34369. setEnabled(value: boolean): void;
  34370. /**
  34371. * Is this node a descendant of the given node?
  34372. * The function will iterate up the hierarchy until the ancestor was found or no more parents defined
  34373. * @param ancestor defines the parent node to inspect
  34374. * @returns a boolean indicating if this node is a descendant of the given node
  34375. */
  34376. isDescendantOf(ancestor: Node): boolean;
  34377. /** @hidden */
  34378. _getDescendants(results: Node[], directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): void;
  34379. /**
  34380. * Will return all nodes that have this node as ascendant
  34381. * @param directDescendantsOnly defines if true only direct descendants of 'this' will be considered, if false direct and also indirect (children of children, an so on in a recursive manner) descendants of 'this' will be considered
  34382. * @param predicate defines an optional predicate that will be called on every evaluated child, the predicate must return true for a given child to be part of the result, otherwise it will be ignored
  34383. * @return all children nodes of all types
  34384. */
  34385. getDescendants(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): Node[];
  34386. /**
  34387. * Get all child-meshes of this node
  34388. * @param directDescendantsOnly defines if true only direct descendants of 'this' will be considered, if false direct and also indirect (children of children, an so on in a recursive manner) descendants of 'this' will be considered (Default: false)
  34389. * @param predicate defines an optional predicate that will be called on every evaluated child, the predicate must return true for a given child to be part of the result, otherwise it will be ignored
  34390. * @returns an array of AbstractMesh
  34391. */
  34392. getChildMeshes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): AbstractMesh[];
  34393. /**
  34394. * Get all direct children of this node
  34395. * @param predicate defines an optional predicate that will be called on every evaluated child, the predicate must return true for a given child to be part of the result, otherwise it will be ignored
  34396. * @param directDescendantsOnly defines if true only direct descendants of 'this' will be considered, if false direct and also indirect (children of children, an so on in a recursive manner) descendants of 'this' will be considered (Default: true)
  34397. * @returns an array of Node
  34398. */
  34399. getChildren(predicate?: (node: Node) => boolean, directDescendantsOnly?: boolean): Node[];
  34400. /** @hidden */
  34401. _setReady(state: boolean): void;
  34402. /**
  34403. * Get an animation by name
  34404. * @param name defines the name of the animation to look for
  34405. * @returns null if not found else the requested animation
  34406. */
  34407. getAnimationByName(name: string): Nullable<Animation>;
  34408. /**
  34409. * Creates an animation range for this node
  34410. * @param name defines the name of the range
  34411. * @param from defines the starting key
  34412. * @param to defines the end key
  34413. */
  34414. createAnimationRange(name: string, from: number, to: number): void;
  34415. /**
  34416. * Delete a specific animation range
  34417. * @param name defines the name of the range to delete
  34418. * @param deleteFrames defines if animation frames from the range must be deleted as well
  34419. */
  34420. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  34421. /**
  34422. * Get an animation range by name
  34423. * @param name defines the name of the animation range to look for
  34424. * @returns null if not found else the requested animation range
  34425. */
  34426. getAnimationRange(name: string): Nullable<AnimationRange>;
  34427. /**
  34428. * Gets the list of all animation ranges defined on this node
  34429. * @returns an array
  34430. */
  34431. getAnimationRanges(): Nullable<AnimationRange>[];
  34432. /**
  34433. * Will start the animation sequence
  34434. * @param name defines the range frames for animation sequence
  34435. * @param loop defines if the animation should loop (false by default)
  34436. * @param speedRatio defines the speed factor in which to run the animation (1 by default)
  34437. * @param onAnimationEnd defines a function to be executed when the animation ended (undefined by default)
  34438. * @returns the object created for this animation. If range does not exist, it will return null
  34439. */
  34440. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  34441. /**
  34442. * Serialize animation ranges into a JSON compatible object
  34443. * @returns serialization object
  34444. */
  34445. serializeAnimationRanges(): any;
  34446. /**
  34447. * Computes the world matrix of the node
  34448. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  34449. * @returns the world matrix
  34450. */
  34451. computeWorldMatrix(force?: boolean): Matrix;
  34452. /**
  34453. * Releases resources associated with this node.
  34454. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  34455. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  34456. */
  34457. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  34458. /**
  34459. * Parse animation range data from a serialization object and store them into a given node
  34460. * @param node defines where to store the animation ranges
  34461. * @param parsedNode defines the serialization object to read data from
  34462. * @param scene defines the hosting scene
  34463. */
  34464. static ParseAnimationRanges(node: Node, parsedNode: any, scene: Scene): void;
  34465. /**
  34466. * Return the minimum and maximum world vectors of the entire hierarchy under current node
  34467. * @param includeDescendants Include bounding info from descendants as well (true by default)
  34468. * @param predicate defines a callback function that can be customize to filter what meshes should be included in the list used to compute the bounding vectors
  34469. * @returns the new bounding vectors
  34470. */
  34471. getHierarchyBoundingVectors(includeDescendants?: boolean, predicate?: Nullable<(abstractMesh: AbstractMesh) => boolean>): {
  34472. min: Vector3;
  34473. max: Vector3;
  34474. };
  34475. }
  34476. }
  34477. declare module "babylonjs/Animations/animation" {
  34478. import { IEasingFunction, EasingFunction } from "babylonjs/Animations/easing";
  34479. import { Vector3, Quaternion, Vector2, Matrix } from "babylonjs/Maths/math.vector";
  34480. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  34481. import { Nullable } from "babylonjs/types";
  34482. import { Scene } from "babylonjs/scene";
  34483. import { IAnimationKey } from "babylonjs/Animations/animationKey";
  34484. import { AnimationRange } from "babylonjs/Animations/animationRange";
  34485. import { AnimationEvent } from "babylonjs/Animations/animationEvent";
  34486. import { Node } from "babylonjs/node";
  34487. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  34488. import { Size } from "babylonjs/Maths/math.size";
  34489. import { Animatable } from "babylonjs/Animations/animatable";
  34490. import { RuntimeAnimation } from "babylonjs/Animations/runtimeAnimation";
  34491. /**
  34492. * @hidden
  34493. */
  34494. export class _IAnimationState {
  34495. key: number;
  34496. repeatCount: number;
  34497. workValue?: any;
  34498. loopMode?: number;
  34499. offsetValue?: any;
  34500. highLimitValue?: any;
  34501. }
  34502. /**
  34503. * Class used to store any kind of animation
  34504. */
  34505. export class Animation {
  34506. /**Name of the animation */
  34507. name: string;
  34508. /**Property to animate */
  34509. targetProperty: string;
  34510. /**The frames per second of the animation */
  34511. framePerSecond: number;
  34512. /**The data type of the animation */
  34513. dataType: number;
  34514. /**The loop mode of the animation */
  34515. loopMode?: number | undefined;
  34516. /**Specifies if blending should be enabled */
  34517. enableBlending?: boolean | undefined;
  34518. /**
  34519. * Use matrix interpolation instead of using direct key value when animating matrices
  34520. */
  34521. static AllowMatricesInterpolation: boolean;
  34522. /**
  34523. * When matrix interpolation is enabled, this boolean forces the system to use Matrix.DecomposeLerp instead of Matrix.Lerp. Interpolation is more precise but slower
  34524. */
  34525. static AllowMatrixDecomposeForInterpolation: boolean;
  34526. /** Define the Url to load snippets */
  34527. static SnippetUrl: string;
  34528. /** Snippet ID if the animation was created from the snippet server */
  34529. snippetId: string;
  34530. /**
  34531. * Stores the key frames of the animation
  34532. */
  34533. private _keys;
  34534. /**
  34535. * Stores the easing function of the animation
  34536. */
  34537. private _easingFunction;
  34538. /**
  34539. * @hidden Internal use only
  34540. */
  34541. _runtimeAnimations: import("babylonjs/Animations/runtimeAnimation").RuntimeAnimation[];
  34542. /**
  34543. * The set of event that will be linked to this animation
  34544. */
  34545. private _events;
  34546. /**
  34547. * Stores an array of target property paths
  34548. */
  34549. targetPropertyPath: string[];
  34550. /**
  34551. * Stores the blending speed of the animation
  34552. */
  34553. blendingSpeed: number;
  34554. /**
  34555. * Stores the animation ranges for the animation
  34556. */
  34557. private _ranges;
  34558. /**
  34559. * @hidden Internal use
  34560. */
  34561. static _PrepareAnimation(name: string, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction): Nullable<Animation>;
  34562. /**
  34563. * Sets up an animation
  34564. * @param property The property to animate
  34565. * @param animationType The animation type to apply
  34566. * @param framePerSecond The frames per second of the animation
  34567. * @param easingFunction The easing function used in the animation
  34568. * @returns The created animation
  34569. */
  34570. static CreateAnimation(property: string, animationType: number, framePerSecond: number, easingFunction: EasingFunction): Animation;
  34571. /**
  34572. * Create and start an animation on a node
  34573. * @param name defines the name of the global animation that will be run on all nodes
  34574. * @param node defines the root node where the animation will take place
  34575. * @param targetProperty defines property to animate
  34576. * @param framePerSecond defines the number of frame per second yo use
  34577. * @param totalFrame defines the number of frames in total
  34578. * @param from defines the initial value
  34579. * @param to defines the final value
  34580. * @param loopMode defines which loop mode you want to use (off by default)
  34581. * @param easingFunction defines the easing function to use (linear by default)
  34582. * @param onAnimationEnd defines the callback to call when animation end
  34583. * @returns the animatable created for this animation
  34584. */
  34585. static CreateAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  34586. /**
  34587. * Create and start an animation on a node and its descendants
  34588. * @param name defines the name of the global animation that will be run on all nodes
  34589. * @param node defines the root node where the animation will take place
  34590. * @param directDescendantsOnly if true only direct descendants will be used, if false direct and also indirect (children of children, an so on in a recursive manner) descendants will be used
  34591. * @param targetProperty defines property to animate
  34592. * @param framePerSecond defines the number of frame per second to use
  34593. * @param totalFrame defines the number of frames in total
  34594. * @param from defines the initial value
  34595. * @param to defines the final value
  34596. * @param loopMode defines which loop mode you want to use (off by default)
  34597. * @param easingFunction defines the easing function to use (linear by default)
  34598. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  34599. * @returns the list of animatables created for all nodes
  34600. * @example https://www.babylonjs-playground.com/#MH0VLI
  34601. */
  34602. static CreateAndStartHierarchyAnimation(name: string, node: Node, directDescendantsOnly: boolean, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable[]>;
  34603. /**
  34604. * Creates a new animation, merges it with the existing animations and starts it
  34605. * @param name Name of the animation
  34606. * @param node Node which contains the scene that begins the animations
  34607. * @param targetProperty Specifies which property to animate
  34608. * @param framePerSecond The frames per second of the animation
  34609. * @param totalFrame The total number of frames
  34610. * @param from The frame at the beginning of the animation
  34611. * @param to The frame at the end of the animation
  34612. * @param loopMode Specifies the loop mode of the animation
  34613. * @param easingFunction (Optional) The easing function of the animation, which allow custom mathematical formulas for animations
  34614. * @param onAnimationEnd Callback to run once the animation is complete
  34615. * @returns Nullable animation
  34616. */
  34617. static CreateMergeAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  34618. /**
  34619. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  34620. * @param sourceAnimation defines the Animation containing keyframes to convert
  34621. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  34622. * @param range defines the name of the AnimationRange belonging to the Animation to convert
  34623. * @param cloneOriginal defines whether or not to clone the animation and convert the clone or convert the original animation (default is false)
  34624. * @param clonedName defines the name of the resulting cloned Animation if cloneOriginal is true
  34625. * @returns a new Animation if cloneOriginal is true or the original Animation if cloneOriginal is false
  34626. */
  34627. static MakeAnimationAdditive(sourceAnimation: Animation, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): Animation;
  34628. /**
  34629. * Transition property of an host to the target Value
  34630. * @param property The property to transition
  34631. * @param targetValue The target Value of the property
  34632. * @param host The object where the property to animate belongs
  34633. * @param scene Scene used to run the animation
  34634. * @param frameRate Framerate (in frame/s) to use
  34635. * @param transition The transition type we want to use
  34636. * @param duration The duration of the animation, in milliseconds
  34637. * @param onAnimationEnd Callback trigger at the end of the animation
  34638. * @returns Nullable animation
  34639. */
  34640. static TransitionTo(property: string, targetValue: any, host: any, scene: Scene, frameRate: number, transition: Animation, duration: number, onAnimationEnd?: Nullable<() => void>): Nullable<Animatable>;
  34641. /**
  34642. * Return the array of runtime animations currently using this animation
  34643. */
  34644. get runtimeAnimations(): RuntimeAnimation[];
  34645. /**
  34646. * Specifies if any of the runtime animations are currently running
  34647. */
  34648. get hasRunningRuntimeAnimations(): boolean;
  34649. /**
  34650. * Initializes the animation
  34651. * @param name Name of the animation
  34652. * @param targetProperty Property to animate
  34653. * @param framePerSecond The frames per second of the animation
  34654. * @param dataType The data type of the animation
  34655. * @param loopMode The loop mode of the animation
  34656. * @param enableBlending Specifies if blending should be enabled
  34657. */
  34658. constructor(
  34659. /**Name of the animation */
  34660. name: string,
  34661. /**Property to animate */
  34662. targetProperty: string,
  34663. /**The frames per second of the animation */
  34664. framePerSecond: number,
  34665. /**The data type of the animation */
  34666. dataType: number,
  34667. /**The loop mode of the animation */
  34668. loopMode?: number | undefined,
  34669. /**Specifies if blending should be enabled */
  34670. enableBlending?: boolean | undefined);
  34671. /**
  34672. * Converts the animation to a string
  34673. * @param fullDetails support for multiple levels of logging within scene loading
  34674. * @returns String form of the animation
  34675. */
  34676. toString(fullDetails?: boolean): string;
  34677. /**
  34678. * Add an event to this animation
  34679. * @param event Event to add
  34680. */
  34681. addEvent(event: AnimationEvent): void;
  34682. /**
  34683. * Remove all events found at the given frame
  34684. * @param frame The frame to remove events from
  34685. */
  34686. removeEvents(frame: number): void;
  34687. /**
  34688. * Retrieves all the events from the animation
  34689. * @returns Events from the animation
  34690. */
  34691. getEvents(): AnimationEvent[];
  34692. /**
  34693. * Creates an animation range
  34694. * @param name Name of the animation range
  34695. * @param from Starting frame of the animation range
  34696. * @param to Ending frame of the animation
  34697. */
  34698. createRange(name: string, from: number, to: number): void;
  34699. /**
  34700. * Deletes an animation range by name
  34701. * @param name Name of the animation range to delete
  34702. * @param deleteFrames Specifies if the key frames for the range should also be deleted (true) or not (false)
  34703. */
  34704. deleteRange(name: string, deleteFrames?: boolean): void;
  34705. /**
  34706. * Gets the animation range by name, or null if not defined
  34707. * @param name Name of the animation range
  34708. * @returns Nullable animation range
  34709. */
  34710. getRange(name: string): Nullable<AnimationRange>;
  34711. /**
  34712. * Gets the key frames from the animation
  34713. * @returns The key frames of the animation
  34714. */
  34715. getKeys(): Array<IAnimationKey>;
  34716. /**
  34717. * Gets the highest frame rate of the animation
  34718. * @returns Highest frame rate of the animation
  34719. */
  34720. getHighestFrame(): number;
  34721. /**
  34722. * Gets the easing function of the animation
  34723. * @returns Easing function of the animation
  34724. */
  34725. getEasingFunction(): IEasingFunction;
  34726. /**
  34727. * Sets the easing function of the animation
  34728. * @param easingFunction A custom mathematical formula for animation
  34729. */
  34730. setEasingFunction(easingFunction: EasingFunction): void;
  34731. /**
  34732. * Interpolates a scalar linearly
  34733. * @param startValue Start value of the animation curve
  34734. * @param endValue End value of the animation curve
  34735. * @param gradient Scalar amount to interpolate
  34736. * @returns Interpolated scalar value
  34737. */
  34738. floatInterpolateFunction(startValue: number, endValue: number, gradient: number): number;
  34739. /**
  34740. * Interpolates a scalar cubically
  34741. * @param startValue Start value of the animation curve
  34742. * @param outTangent End tangent of the animation
  34743. * @param endValue End value of the animation curve
  34744. * @param inTangent Start tangent of the animation curve
  34745. * @param gradient Scalar amount to interpolate
  34746. * @returns Interpolated scalar value
  34747. */
  34748. floatInterpolateFunctionWithTangents(startValue: number, outTangent: number, endValue: number, inTangent: number, gradient: number): number;
  34749. /**
  34750. * Interpolates a quaternion using a spherical linear interpolation
  34751. * @param startValue Start value of the animation curve
  34752. * @param endValue End value of the animation curve
  34753. * @param gradient Scalar amount to interpolate
  34754. * @returns Interpolated quaternion value
  34755. */
  34756. quaternionInterpolateFunction(startValue: Quaternion, endValue: Quaternion, gradient: number): Quaternion;
  34757. /**
  34758. * Interpolates a quaternion cubically
  34759. * @param startValue Start value of the animation curve
  34760. * @param outTangent End tangent of the animation curve
  34761. * @param endValue End value of the animation curve
  34762. * @param inTangent Start tangent of the animation curve
  34763. * @param gradient Scalar amount to interpolate
  34764. * @returns Interpolated quaternion value
  34765. */
  34766. quaternionInterpolateFunctionWithTangents(startValue: Quaternion, outTangent: Quaternion, endValue: Quaternion, inTangent: Quaternion, gradient: number): Quaternion;
  34767. /**
  34768. * Interpolates a Vector3 linearl
  34769. * @param startValue Start value of the animation curve
  34770. * @param endValue End value of the animation curve
  34771. * @param gradient Scalar amount to interpolate
  34772. * @returns Interpolated scalar value
  34773. */
  34774. vector3InterpolateFunction(startValue: Vector3, endValue: Vector3, gradient: number): Vector3;
  34775. /**
  34776. * Interpolates a Vector3 cubically
  34777. * @param startValue Start value of the animation curve
  34778. * @param outTangent End tangent of the animation
  34779. * @param endValue End value of the animation curve
  34780. * @param inTangent Start tangent of the animation curve
  34781. * @param gradient Scalar amount to interpolate
  34782. * @returns InterpolatedVector3 value
  34783. */
  34784. vector3InterpolateFunctionWithTangents(startValue: Vector3, outTangent: Vector3, endValue: Vector3, inTangent: Vector3, gradient: number): Vector3;
  34785. /**
  34786. * Interpolates a Vector2 linearly
  34787. * @param startValue Start value of the animation curve
  34788. * @param endValue End value of the animation curve
  34789. * @param gradient Scalar amount to interpolate
  34790. * @returns Interpolated Vector2 value
  34791. */
  34792. vector2InterpolateFunction(startValue: Vector2, endValue: Vector2, gradient: number): Vector2;
  34793. /**
  34794. * Interpolates a Vector2 cubically
  34795. * @param startValue Start value of the animation curve
  34796. * @param outTangent End tangent of the animation
  34797. * @param endValue End value of the animation curve
  34798. * @param inTangent Start tangent of the animation curve
  34799. * @param gradient Scalar amount to interpolate
  34800. * @returns Interpolated Vector2 value
  34801. */
  34802. vector2InterpolateFunctionWithTangents(startValue: Vector2, outTangent: Vector2, endValue: Vector2, inTangent: Vector2, gradient: number): Vector2;
  34803. /**
  34804. * Interpolates a size linearly
  34805. * @param startValue Start value of the animation curve
  34806. * @param endValue End value of the animation curve
  34807. * @param gradient Scalar amount to interpolate
  34808. * @returns Interpolated Size value
  34809. */
  34810. sizeInterpolateFunction(startValue: Size, endValue: Size, gradient: number): Size;
  34811. /**
  34812. * Interpolates a Color3 linearly
  34813. * @param startValue Start value of the animation curve
  34814. * @param endValue End value of the animation curve
  34815. * @param gradient Scalar amount to interpolate
  34816. * @returns Interpolated Color3 value
  34817. */
  34818. color3InterpolateFunction(startValue: Color3, endValue: Color3, gradient: number): Color3;
  34819. /**
  34820. * Interpolates a Color4 linearly
  34821. * @param startValue Start value of the animation curve
  34822. * @param endValue End value of the animation curve
  34823. * @param gradient Scalar amount to interpolate
  34824. * @returns Interpolated Color3 value
  34825. */
  34826. color4InterpolateFunction(startValue: Color4, endValue: Color4, gradient: number): Color4;
  34827. /**
  34828. * @hidden Internal use only
  34829. */
  34830. _getKeyValue(value: any): any;
  34831. /**
  34832. * @hidden Internal use only
  34833. */
  34834. _interpolate(currentFrame: number, state: _IAnimationState): any;
  34835. /**
  34836. * Defines the function to use to interpolate matrices
  34837. * @param startValue defines the start matrix
  34838. * @param endValue defines the end matrix
  34839. * @param gradient defines the gradient between both matrices
  34840. * @param result defines an optional target matrix where to store the interpolation
  34841. * @returns the interpolated matrix
  34842. */
  34843. matrixInterpolateFunction(startValue: Matrix, endValue: Matrix, gradient: number, result?: Matrix): Matrix;
  34844. /**
  34845. * Makes a copy of the animation
  34846. * @returns Cloned animation
  34847. */
  34848. clone(): Animation;
  34849. /**
  34850. * Sets the key frames of the animation
  34851. * @param values The animation key frames to set
  34852. */
  34853. setKeys(values: Array<IAnimationKey>): void;
  34854. /**
  34855. * Serializes the animation to an object
  34856. * @returns Serialized object
  34857. */
  34858. serialize(): any;
  34859. /**
  34860. * Float animation type
  34861. */
  34862. static readonly ANIMATIONTYPE_FLOAT: number;
  34863. /**
  34864. * Vector3 animation type
  34865. */
  34866. static readonly ANIMATIONTYPE_VECTOR3: number;
  34867. /**
  34868. * Quaternion animation type
  34869. */
  34870. static readonly ANIMATIONTYPE_QUATERNION: number;
  34871. /**
  34872. * Matrix animation type
  34873. */
  34874. static readonly ANIMATIONTYPE_MATRIX: number;
  34875. /**
  34876. * Color3 animation type
  34877. */
  34878. static readonly ANIMATIONTYPE_COLOR3: number;
  34879. /**
  34880. * Color3 animation type
  34881. */
  34882. static readonly ANIMATIONTYPE_COLOR4: number;
  34883. /**
  34884. * Vector2 animation type
  34885. */
  34886. static readonly ANIMATIONTYPE_VECTOR2: number;
  34887. /**
  34888. * Size animation type
  34889. */
  34890. static readonly ANIMATIONTYPE_SIZE: number;
  34891. /**
  34892. * Relative Loop Mode
  34893. */
  34894. static readonly ANIMATIONLOOPMODE_RELATIVE: number;
  34895. /**
  34896. * Cycle Loop Mode
  34897. */
  34898. static readonly ANIMATIONLOOPMODE_CYCLE: number;
  34899. /**
  34900. * Constant Loop Mode
  34901. */
  34902. static readonly ANIMATIONLOOPMODE_CONSTANT: number;
  34903. /** @hidden */
  34904. static _UniversalLerp(left: any, right: any, amount: number): any;
  34905. /**
  34906. * Parses an animation object and creates an animation
  34907. * @param parsedAnimation Parsed animation object
  34908. * @returns Animation object
  34909. */
  34910. static Parse(parsedAnimation: any): Animation;
  34911. /**
  34912. * Appends the serialized animations from the source animations
  34913. * @param source Source containing the animations
  34914. * @param destination Target to store the animations
  34915. */
  34916. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  34917. /**
  34918. * Creates a new animation or an array of animations from a snippet saved in a remote file
  34919. * @param name defines the name of the animation to create (can be null or empty to use the one from the json data)
  34920. * @param url defines the url to load from
  34921. * @returns a promise that will resolve to the new animation or an array of animations
  34922. */
  34923. static ParseFromFileAsync(name: Nullable<string>, url: string): Promise<Animation | Array<Animation>>;
  34924. /**
  34925. * Creates an animation or an array of animations from a snippet saved by the Inspector
  34926. * @param snippetId defines the snippet to load
  34927. * @returns a promise that will resolve to the new animation or a new array of animations
  34928. */
  34929. static CreateFromSnippetAsync(snippetId: string): Promise<Animation | Array<Animation>>;
  34930. }
  34931. }
  34932. declare module "babylonjs/Animations/animatable.interface" {
  34933. import { Nullable } from "babylonjs/types";
  34934. import { Animation } from "babylonjs/Animations/animation";
  34935. /**
  34936. * Interface containing an array of animations
  34937. */
  34938. export interface IAnimatable {
  34939. /**
  34940. * Array of animations
  34941. */
  34942. animations: Nullable<Array<Animation>>;
  34943. }
  34944. }
  34945. declare module "babylonjs/Misc/decorators" {
  34946. import { Nullable } from "babylonjs/types";
  34947. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  34948. import { Scene } from "babylonjs/scene";
  34949. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  34950. import { FresnelParameters } from "babylonjs/Materials/fresnelParameters";
  34951. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  34952. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  34953. export function expandToProperty(callback: string, targetKey?: Nullable<string>): (target: any, propertyKey: string) => void;
  34954. export function serialize(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34955. export function serializeAsTexture(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34956. export function serializeAsColor3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34957. export function serializeAsFresnelParameters(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34958. export function serializeAsVector2(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34959. export function serializeAsVector3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34960. export function serializeAsMeshReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34961. export function serializeAsColorCurves(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34962. export function serializeAsColor4(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34963. export function serializeAsImageProcessingConfiguration(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34964. export function serializeAsQuaternion(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34965. export function serializeAsMatrix(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34966. /**
  34967. * Decorator used to define property that can be serialized as reference to a camera
  34968. * @param sourceName defines the name of the property to decorate
  34969. */
  34970. export function serializeAsCameraReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34971. /**
  34972. * Class used to help serialization objects
  34973. */
  34974. export class SerializationHelper {
  34975. /** @hidden */
  34976. static _ImageProcessingConfigurationParser: (sourceProperty: any) => ImageProcessingConfiguration;
  34977. /** @hidden */
  34978. static _FresnelParametersParser: (sourceProperty: any) => FresnelParameters;
  34979. /** @hidden */
  34980. static _ColorCurvesParser: (sourceProperty: any) => ColorCurves;
  34981. /** @hidden */
  34982. static _TextureParser: (sourceProperty: any, scene: Scene, rootUrl: string) => Nullable<BaseTexture>;
  34983. /**
  34984. * Appends the serialized animations from the source animations
  34985. * @param source Source containing the animations
  34986. * @param destination Target to store the animations
  34987. */
  34988. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  34989. /**
  34990. * Static function used to serialized a specific entity
  34991. * @param entity defines the entity to serialize
  34992. * @param serializationObject defines the optional target obecjt where serialization data will be stored
  34993. * @returns a JSON compatible object representing the serialization of the entity
  34994. */
  34995. static Serialize<T>(entity: T, serializationObject?: any): any;
  34996. /**
  34997. * Creates a new entity from a serialization data object
  34998. * @param creationFunction defines a function used to instanciated the new entity
  34999. * @param source defines the source serialization data
  35000. * @param scene defines the hosting scene
  35001. * @param rootUrl defines the root url for resources
  35002. * @returns a new entity
  35003. */
  35004. static Parse<T>(creationFunction: () => T, source: any, scene: Nullable<Scene>, rootUrl?: Nullable<string>): T;
  35005. /**
  35006. * Clones an object
  35007. * @param creationFunction defines the function used to instanciate the new object
  35008. * @param source defines the source object
  35009. * @returns the cloned object
  35010. */
  35011. static Clone<T>(creationFunction: () => T, source: T): T;
  35012. /**
  35013. * Instanciates a new object based on a source one (some data will be shared between both object)
  35014. * @param creationFunction defines the function used to instanciate the new object
  35015. * @param source defines the source object
  35016. * @returns the new object
  35017. */
  35018. static Instanciate<T>(creationFunction: () => T, source: T): T;
  35019. }
  35020. }
  35021. declare module "babylonjs/Materials/Textures/baseTexture" {
  35022. import { Observable } from "babylonjs/Misc/observable";
  35023. import { Nullable } from "babylonjs/types";
  35024. import { Scene } from "babylonjs/scene";
  35025. import { Matrix } from "babylonjs/Maths/math.vector";
  35026. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  35027. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  35028. import { ISize } from "babylonjs/Maths/math.size";
  35029. import "babylonjs/Misc/fileTools";
  35030. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  35031. /**
  35032. * Base class of all the textures in babylon.
  35033. * It groups all the common properties the materials, post process, lights... might need
  35034. * in order to make a correct use of the texture.
  35035. */
  35036. export class BaseTexture implements IAnimatable {
  35037. /**
  35038. * Default anisotropic filtering level for the application.
  35039. * It is set to 4 as a good tradeoff between perf and quality.
  35040. */
  35041. static DEFAULT_ANISOTROPIC_FILTERING_LEVEL: number;
  35042. /**
  35043. * Gets or sets the unique id of the texture
  35044. */
  35045. uniqueId: number;
  35046. /**
  35047. * Define the name of the texture.
  35048. */
  35049. name: string;
  35050. /**
  35051. * Gets or sets an object used to store user defined information.
  35052. */
  35053. metadata: any;
  35054. /**
  35055. * For internal use only. Please do not use.
  35056. */
  35057. reservedDataStore: any;
  35058. private _hasAlpha;
  35059. /**
  35060. * Define if the texture is having a usable alpha value (can be use for transparency or glossiness for instance).
  35061. */
  35062. set hasAlpha(value: boolean);
  35063. get hasAlpha(): boolean;
  35064. /**
  35065. * Defines if the alpha value should be determined via the rgb values.
  35066. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  35067. */
  35068. getAlphaFromRGB: boolean;
  35069. /**
  35070. * Intensity or strength of the texture.
  35071. * It is commonly used by materials to fine tune the intensity of the texture
  35072. */
  35073. level: number;
  35074. /**
  35075. * Define the UV chanel to use starting from 0 and defaulting to 0.
  35076. * This is part of the texture as textures usually maps to one uv set.
  35077. */
  35078. coordinatesIndex: number;
  35079. protected _coordinatesMode: number;
  35080. /**
  35081. * How a texture is mapped.
  35082. *
  35083. * | Value | Type | Description |
  35084. * | ----- | ----------------------------------- | ----------- |
  35085. * | 0 | EXPLICIT_MODE | |
  35086. * | 1 | SPHERICAL_MODE | |
  35087. * | 2 | PLANAR_MODE | |
  35088. * | 3 | CUBIC_MODE | |
  35089. * | 4 | PROJECTION_MODE | |
  35090. * | 5 | SKYBOX_MODE | |
  35091. * | 6 | INVCUBIC_MODE | |
  35092. * | 7 | EQUIRECTANGULAR_MODE | |
  35093. * | 8 | FIXED_EQUIRECTANGULAR_MODE | |
  35094. * | 9 | FIXED_EQUIRECTANGULAR_MIRRORED_MODE | |
  35095. */
  35096. set coordinatesMode(value: number);
  35097. get coordinatesMode(): number;
  35098. private _wrapU;
  35099. /**
  35100. * | Value | Type | Description |
  35101. * | ----- | ------------------ | ----------- |
  35102. * | 0 | CLAMP_ADDRESSMODE | |
  35103. * | 1 | WRAP_ADDRESSMODE | |
  35104. * | 2 | MIRROR_ADDRESSMODE | |
  35105. */
  35106. get wrapU(): number;
  35107. set wrapU(value: number);
  35108. private _wrapV;
  35109. /**
  35110. * | Value | Type | Description |
  35111. * | ----- | ------------------ | ----------- |
  35112. * | 0 | CLAMP_ADDRESSMODE | |
  35113. * | 1 | WRAP_ADDRESSMODE | |
  35114. * | 2 | MIRROR_ADDRESSMODE | |
  35115. */
  35116. get wrapV(): number;
  35117. set wrapV(value: number);
  35118. /**
  35119. * | Value | Type | Description |
  35120. * | ----- | ------------------ | ----------- |
  35121. * | 0 | CLAMP_ADDRESSMODE | |
  35122. * | 1 | WRAP_ADDRESSMODE | |
  35123. * | 2 | MIRROR_ADDRESSMODE | |
  35124. */
  35125. wrapR: number;
  35126. /**
  35127. * With compliant hardware and browser (supporting anisotropic filtering)
  35128. * this defines the level of anisotropic filtering in the texture.
  35129. * The higher the better but the slower. This defaults to 4 as it seems to be the best tradeoff.
  35130. */
  35131. anisotropicFilteringLevel: number;
  35132. /**
  35133. * Define if the texture is a cube texture or if false a 2d texture.
  35134. */
  35135. get isCube(): boolean;
  35136. set isCube(value: boolean);
  35137. /**
  35138. * Define if the texture is a 3d texture (webgl 2) or if false a 2d texture.
  35139. */
  35140. get is3D(): boolean;
  35141. set is3D(value: boolean);
  35142. /**
  35143. * Define if the texture is a 2d array texture (webgl 2) or if false a 2d texture.
  35144. */
  35145. get is2DArray(): boolean;
  35146. set is2DArray(value: boolean);
  35147. private _gammaSpace;
  35148. /**
  35149. * Define if the texture contains data in gamma space (most of the png/jpg aside bump).
  35150. * HDR texture are usually stored in linear space.
  35151. * This only impacts the PBR and Background materials
  35152. */
  35153. get gammaSpace(): boolean;
  35154. set gammaSpace(gamma: boolean);
  35155. /**
  35156. * Gets or sets whether or not the texture contains RGBD data.
  35157. */
  35158. get isRGBD(): boolean;
  35159. set isRGBD(value: boolean);
  35160. /**
  35161. * Is Z inverted in the texture (useful in a cube texture).
  35162. */
  35163. invertZ: boolean;
  35164. /**
  35165. * Are mip maps generated for this texture or not.
  35166. */
  35167. get noMipmap(): boolean;
  35168. /**
  35169. * @hidden
  35170. */
  35171. lodLevelInAlpha: boolean;
  35172. /**
  35173. * With prefiltered texture, defined the offset used during the prefiltering steps.
  35174. */
  35175. get lodGenerationOffset(): number;
  35176. set lodGenerationOffset(value: number);
  35177. /**
  35178. * With prefiltered texture, defined the scale used during the prefiltering steps.
  35179. */
  35180. get lodGenerationScale(): number;
  35181. set lodGenerationScale(value: number);
  35182. /**
  35183. * With prefiltered texture, defined if the specular generation is based on a linear ramp.
  35184. * By default we are using a log2 of the linear roughness helping to keep a better resolution for
  35185. * average roughness values.
  35186. */
  35187. get linearSpecularLOD(): boolean;
  35188. set linearSpecularLOD(value: boolean);
  35189. /**
  35190. * In case a better definition than spherical harmonics is required for the diffuse part of the environment.
  35191. * You can set the irradiance texture to rely on a texture instead of the spherical approach.
  35192. * This texture need to have the same characteristics than its parent (Cube vs 2d, coordinates mode, Gamma/Linear, RGBD).
  35193. */
  35194. get irradianceTexture(): Nullable<BaseTexture>;
  35195. set irradianceTexture(value: Nullable<BaseTexture>);
  35196. /**
  35197. * Define if the texture is a render target.
  35198. */
  35199. isRenderTarget: boolean;
  35200. /**
  35201. * Define the unique id of the texture in the scene.
  35202. */
  35203. get uid(): string;
  35204. /** @hidden */
  35205. _prefiltered: boolean;
  35206. /**
  35207. * Return a string representation of the texture.
  35208. * @returns the texture as a string
  35209. */
  35210. toString(): string;
  35211. /**
  35212. * Get the class name of the texture.
  35213. * @returns "BaseTexture"
  35214. */
  35215. getClassName(): string;
  35216. /**
  35217. * Define the list of animation attached to the texture.
  35218. */
  35219. animations: import("babylonjs/Animations/animation").Animation[];
  35220. /**
  35221. * An event triggered when the texture is disposed.
  35222. */
  35223. onDisposeObservable: Observable<BaseTexture>;
  35224. private _onDisposeObserver;
  35225. /**
  35226. * Callback triggered when the texture has been disposed.
  35227. * Kept for back compatibility, you can use the onDisposeObservable instead.
  35228. */
  35229. set onDispose(callback: () => void);
  35230. /**
  35231. * Define the current state of the loading sequence when in delayed load mode.
  35232. */
  35233. delayLoadState: number;
  35234. protected _scene: Nullable<Scene>;
  35235. protected _engine: Nullable<ThinEngine>;
  35236. /** @hidden */
  35237. _texture: Nullable<InternalTexture>;
  35238. private _uid;
  35239. /**
  35240. * Define if the texture is preventinga material to render or not.
  35241. * If not and the texture is not ready, the engine will use a default black texture instead.
  35242. */
  35243. get isBlocking(): boolean;
  35244. /**
  35245. * Instantiates a new BaseTexture.
  35246. * Base class of all the textures in babylon.
  35247. * It groups all the common properties the materials, post process, lights... might need
  35248. * in order to make a correct use of the texture.
  35249. * @param sceneOrEngine Define the scene or engine the texture blongs to
  35250. */
  35251. constructor(sceneOrEngine: Nullable<Scene | ThinEngine>);
  35252. /**
  35253. * Get the scene the texture belongs to.
  35254. * @returns the scene or null if undefined
  35255. */
  35256. getScene(): Nullable<Scene>;
  35257. /** @hidden */
  35258. protected _getEngine(): Nullable<ThinEngine>;
  35259. /**
  35260. * Get the texture transform matrix used to offset tile the texture for istance.
  35261. * @returns the transformation matrix
  35262. */
  35263. getTextureMatrix(): Matrix;
  35264. /**
  35265. * Get the texture reflection matrix used to rotate/transform the reflection.
  35266. * @returns the reflection matrix
  35267. */
  35268. getReflectionTextureMatrix(): Matrix;
  35269. /**
  35270. * Get the underlying lower level texture from Babylon.
  35271. * @returns the insternal texture
  35272. */
  35273. getInternalTexture(): Nullable<InternalTexture>;
  35274. /**
  35275. * Get if the texture is ready to be consumed (either it is ready or it is not blocking)
  35276. * @returns true if ready or not blocking
  35277. */
  35278. isReadyOrNotBlocking(): boolean;
  35279. /**
  35280. * Get if the texture is ready to be used (downloaded, converted, mip mapped...).
  35281. * @returns true if fully ready
  35282. */
  35283. isReady(): boolean;
  35284. private _cachedSize;
  35285. /**
  35286. * Get the size of the texture.
  35287. * @returns the texture size.
  35288. */
  35289. getSize(): ISize;
  35290. /**
  35291. * Get the base size of the texture.
  35292. * It can be different from the size if the texture has been resized for POT for instance
  35293. * @returns the base size
  35294. */
  35295. getBaseSize(): ISize;
  35296. /**
  35297. * Update the sampling mode of the texture.
  35298. * Default is Trilinear mode.
  35299. *
  35300. * | Value | Type | Description |
  35301. * | ----- | ------------------ | ----------- |
  35302. * | 1 | NEAREST_SAMPLINGMODE or NEAREST_NEAREST_MIPLINEAR | Nearest is: mag = nearest, min = nearest, mip = linear |
  35303. * | 2 | BILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPNEAREST | Bilinear is: mag = linear, min = linear, mip = nearest |
  35304. * | 3 | TRILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPLINEAR | Trilinear is: mag = linear, min = linear, mip = linear |
  35305. * | 4 | NEAREST_NEAREST_MIPNEAREST | |
  35306. * | 5 | NEAREST_LINEAR_MIPNEAREST | |
  35307. * | 6 | NEAREST_LINEAR_MIPLINEAR | |
  35308. * | 7 | NEAREST_LINEAR | |
  35309. * | 8 | NEAREST_NEAREST | |
  35310. * | 9 | LINEAR_NEAREST_MIPNEAREST | |
  35311. * | 10 | LINEAR_NEAREST_MIPLINEAR | |
  35312. * | 11 | LINEAR_LINEAR | |
  35313. * | 12 | LINEAR_NEAREST | |
  35314. *
  35315. * > _mag_: magnification filter (close to the viewer)
  35316. * > _min_: minification filter (far from the viewer)
  35317. * > _mip_: filter used between mip map levels
  35318. *@param samplingMode Define the new sampling mode of the texture
  35319. */
  35320. updateSamplingMode(samplingMode: number): void;
  35321. /**
  35322. * Scales the texture if is `canRescale()`
  35323. * @param ratio the resize factor we want to use to rescale
  35324. */
  35325. scale(ratio: number): void;
  35326. /**
  35327. * Get if the texture can rescale.
  35328. */
  35329. get canRescale(): boolean;
  35330. /** @hidden */
  35331. _getFromCache(url: Nullable<string>, noMipmap: boolean, sampling?: number, invertY?: boolean): Nullable<InternalTexture>;
  35332. /** @hidden */
  35333. _rebuild(): void;
  35334. /**
  35335. * Triggers the load sequence in delayed load mode.
  35336. */
  35337. delayLoad(): void;
  35338. /**
  35339. * Clones the texture.
  35340. * @returns the cloned texture
  35341. */
  35342. clone(): Nullable<BaseTexture>;
  35343. /**
  35344. * Get the texture underlying type (INT, FLOAT...)
  35345. */
  35346. get textureType(): number;
  35347. /**
  35348. * Get the texture underlying format (RGB, RGBA...)
  35349. */
  35350. get textureFormat(): number;
  35351. /**
  35352. * Indicates that textures need to be re-calculated for all materials
  35353. */
  35354. protected _markAllSubMeshesAsTexturesDirty(): void;
  35355. /**
  35356. * Reads the pixels stored in the webgl texture and returns them as an ArrayBuffer.
  35357. * This will returns an RGBA array buffer containing either in values (0-255) or
  35358. * float values (0-1) depending of the underlying buffer type.
  35359. * @param faceIndex defines the face of the texture to read (in case of cube texture)
  35360. * @param level defines the LOD level of the texture to read (in case of Mip Maps)
  35361. * @param buffer defines a user defined buffer to fill with data (can be null)
  35362. * @returns The Array buffer containing the pixels data.
  35363. */
  35364. readPixels(faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): Nullable<ArrayBufferView>;
  35365. /**
  35366. * Release and destroy the underlying lower level texture aka internalTexture.
  35367. */
  35368. releaseInternalTexture(): void;
  35369. /** @hidden */
  35370. get _lodTextureHigh(): Nullable<BaseTexture>;
  35371. /** @hidden */
  35372. get _lodTextureMid(): Nullable<BaseTexture>;
  35373. /** @hidden */
  35374. get _lodTextureLow(): Nullable<BaseTexture>;
  35375. /**
  35376. * Dispose the texture and release its associated resources.
  35377. */
  35378. dispose(): void;
  35379. /**
  35380. * Serialize the texture into a JSON representation that can be parsed later on.
  35381. * @returns the JSON representation of the texture
  35382. */
  35383. serialize(): any;
  35384. /**
  35385. * Helper function to be called back once a list of texture contains only ready textures.
  35386. * @param textures Define the list of textures to wait for
  35387. * @param callback Define the callback triggered once the entire list will be ready
  35388. */
  35389. static WhenAllReady(textures: BaseTexture[], callback: () => void): void;
  35390. private static _isScene;
  35391. }
  35392. }
  35393. declare module "babylonjs/Materials/effect" {
  35394. import { Observable } from "babylonjs/Misc/observable";
  35395. import { Nullable } from "babylonjs/types";
  35396. import { IDisposable } from "babylonjs/scene";
  35397. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  35398. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  35399. import { IMatrixLike, IVector2Like, IVector3Like, IVector4Like, IColor3Like, IColor4Like } from "babylonjs/Maths/math.like";
  35400. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  35401. import { IEffectFallbacks } from "babylonjs/Materials/iEffectFallbacks";
  35402. import { Engine } from "babylonjs/Engines/engine";
  35403. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  35404. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  35405. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  35406. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  35407. /**
  35408. * Options to be used when creating an effect.
  35409. */
  35410. export interface IEffectCreationOptions {
  35411. /**
  35412. * Atrributes that will be used in the shader.
  35413. */
  35414. attributes: string[];
  35415. /**
  35416. * Uniform varible names that will be set in the shader.
  35417. */
  35418. uniformsNames: string[];
  35419. /**
  35420. * Uniform buffer variable names that will be set in the shader.
  35421. */
  35422. uniformBuffersNames: string[];
  35423. /**
  35424. * Sampler texture variable names that will be set in the shader.
  35425. */
  35426. samplers: string[];
  35427. /**
  35428. * Define statements that will be set in the shader.
  35429. */
  35430. defines: any;
  35431. /**
  35432. * Possible fallbacks for this effect to improve performance when needed.
  35433. */
  35434. fallbacks: Nullable<IEffectFallbacks>;
  35435. /**
  35436. * Callback that will be called when the shader is compiled.
  35437. */
  35438. onCompiled: Nullable<(effect: Effect) => void>;
  35439. /**
  35440. * Callback that will be called if an error occurs during shader compilation.
  35441. */
  35442. onError: Nullable<(effect: Effect, errors: string) => void>;
  35443. /**
  35444. * Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  35445. */
  35446. indexParameters?: any;
  35447. /**
  35448. * Max number of lights that can be used in the shader.
  35449. */
  35450. maxSimultaneousLights?: number;
  35451. /**
  35452. * See https://developer.mozilla.org/en-US/docs/Web/API/WebGL2RenderingContext/transformFeedbackVaryings
  35453. */
  35454. transformFeedbackVaryings?: Nullable<string[]>;
  35455. /**
  35456. * 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
  35457. */
  35458. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  35459. /**
  35460. * Is this effect rendering to several color attachments ?
  35461. */
  35462. multiTarget?: boolean;
  35463. }
  35464. /**
  35465. * Effect containing vertex and fragment shader that can be executed on an object.
  35466. */
  35467. export class Effect implements IDisposable {
  35468. /**
  35469. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  35470. */
  35471. static ShadersRepository: string;
  35472. /**
  35473. * Enable logging of the shader code when a compilation error occurs
  35474. */
  35475. static LogShaderCodeOnCompilationError: boolean;
  35476. /**
  35477. * Name of the effect.
  35478. */
  35479. name: any;
  35480. /**
  35481. * String container all the define statements that should be set on the shader.
  35482. */
  35483. defines: string;
  35484. /**
  35485. * Callback that will be called when the shader is compiled.
  35486. */
  35487. onCompiled: Nullable<(effect: Effect) => void>;
  35488. /**
  35489. * Callback that will be called if an error occurs during shader compilation.
  35490. */
  35491. onError: Nullable<(effect: Effect, errors: string) => void>;
  35492. /**
  35493. * Callback that will be called when effect is bound.
  35494. */
  35495. onBind: Nullable<(effect: Effect) => void>;
  35496. /**
  35497. * Unique ID of the effect.
  35498. */
  35499. uniqueId: number;
  35500. /**
  35501. * Observable that will be called when the shader is compiled.
  35502. * It is recommended to use executeWhenCompile() or to make sure that scene.isReady() is called to get this observable raised.
  35503. */
  35504. onCompileObservable: Observable<Effect>;
  35505. /**
  35506. * Observable that will be called if an error occurs during shader compilation.
  35507. */
  35508. onErrorObservable: Observable<Effect>;
  35509. /** @hidden */
  35510. _onBindObservable: Nullable<Observable<Effect>>;
  35511. /**
  35512. * @hidden
  35513. * Specifies if the effect was previously ready
  35514. */
  35515. _wasPreviouslyReady: boolean;
  35516. /**
  35517. * Observable that will be called when effect is bound.
  35518. */
  35519. get onBindObservable(): Observable<Effect>;
  35520. /** @hidden */
  35521. _bonesComputationForcedToCPU: boolean;
  35522. /** @hidden */
  35523. _multiTarget: boolean;
  35524. private static _uniqueIdSeed;
  35525. private _engine;
  35526. private _uniformBuffersNames;
  35527. private _uniformBuffersNamesList;
  35528. private _uniformsNames;
  35529. private _samplerList;
  35530. private _samplers;
  35531. private _isReady;
  35532. private _compilationError;
  35533. private _allFallbacksProcessed;
  35534. private _attributesNames;
  35535. private _attributes;
  35536. private _attributeLocationByName;
  35537. private _uniforms;
  35538. /**
  35539. * Key for the effect.
  35540. * @hidden
  35541. */
  35542. _key: string;
  35543. private _indexParameters;
  35544. private _fallbacks;
  35545. private _vertexSourceCode;
  35546. private _fragmentSourceCode;
  35547. private _vertexSourceCodeOverride;
  35548. private _fragmentSourceCodeOverride;
  35549. private _transformFeedbackVaryings;
  35550. /**
  35551. * Compiled shader to webGL program.
  35552. * @hidden
  35553. */
  35554. _pipelineContext: Nullable<IPipelineContext>;
  35555. private _valueCache;
  35556. private static _baseCache;
  35557. /**
  35558. * Instantiates an effect.
  35559. * An effect can be used to create/manage/execute vertex and fragment shaders.
  35560. * @param baseName Name of the effect.
  35561. * @param attributesNamesOrOptions List of attribute names that will be passed to the shader or set of all options to create the effect.
  35562. * @param uniformsNamesOrEngine List of uniform variable names that will be passed to the shader or the engine that will be used to render effect.
  35563. * @param samplers List of sampler variables that will be passed to the shader.
  35564. * @param engine Engine to be used to render the effect
  35565. * @param defines Define statements to be added to the shader.
  35566. * @param fallbacks Possible fallbacks for this effect to improve performance when needed.
  35567. * @param onCompiled Callback that will be called when the shader is compiled.
  35568. * @param onError Callback that will be called if an error occurs during shader compilation.
  35569. * @param indexParameters Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  35570. */
  35571. 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);
  35572. private _useFinalCode;
  35573. /**
  35574. * Unique key for this effect
  35575. */
  35576. get key(): string;
  35577. /**
  35578. * If the effect has been compiled and prepared.
  35579. * @returns if the effect is compiled and prepared.
  35580. */
  35581. isReady(): boolean;
  35582. private _isReadyInternal;
  35583. /**
  35584. * The engine the effect was initialized with.
  35585. * @returns the engine.
  35586. */
  35587. getEngine(): Engine;
  35588. /**
  35589. * The pipeline context for this effect
  35590. * @returns the associated pipeline context
  35591. */
  35592. getPipelineContext(): Nullable<IPipelineContext>;
  35593. /**
  35594. * The set of names of attribute variables for the shader.
  35595. * @returns An array of attribute names.
  35596. */
  35597. getAttributesNames(): string[];
  35598. /**
  35599. * Returns the attribute at the given index.
  35600. * @param index The index of the attribute.
  35601. * @returns The location of the attribute.
  35602. */
  35603. getAttributeLocation(index: number): number;
  35604. /**
  35605. * Returns the attribute based on the name of the variable.
  35606. * @param name of the attribute to look up.
  35607. * @returns the attribute location.
  35608. */
  35609. getAttributeLocationByName(name: string): number;
  35610. /**
  35611. * The number of attributes.
  35612. * @returns the numnber of attributes.
  35613. */
  35614. getAttributesCount(): number;
  35615. /**
  35616. * Gets the index of a uniform variable.
  35617. * @param uniformName of the uniform to look up.
  35618. * @returns the index.
  35619. */
  35620. getUniformIndex(uniformName: string): number;
  35621. /**
  35622. * Returns the attribute based on the name of the variable.
  35623. * @param uniformName of the uniform to look up.
  35624. * @returns the location of the uniform.
  35625. */
  35626. getUniform(uniformName: string): Nullable<WebGLUniformLocation>;
  35627. /**
  35628. * Returns an array of sampler variable names
  35629. * @returns The array of sampler variable names.
  35630. */
  35631. getSamplers(): string[];
  35632. /**
  35633. * Returns an array of uniform variable names
  35634. * @returns The array of uniform variable names.
  35635. */
  35636. getUniformNames(): string[];
  35637. /**
  35638. * Returns an array of uniform buffer variable names
  35639. * @returns The array of uniform buffer variable names.
  35640. */
  35641. getUniformBuffersNames(): string[];
  35642. /**
  35643. * Returns the index parameters used to create the effect
  35644. * @returns The index parameters object
  35645. */
  35646. getIndexParameters(): any;
  35647. /**
  35648. * The error from the last compilation.
  35649. * @returns the error string.
  35650. */
  35651. getCompilationError(): string;
  35652. /**
  35653. * Gets a boolean indicating that all fallbacks were used during compilation
  35654. * @returns true if all fallbacks were used
  35655. */
  35656. allFallbacksProcessed(): boolean;
  35657. /**
  35658. * Adds a callback to the onCompiled observable and call the callback imediatly if already ready.
  35659. * @param func The callback to be used.
  35660. */
  35661. executeWhenCompiled(func: (effect: Effect) => void): void;
  35662. private _checkIsReady;
  35663. private _loadShader;
  35664. /**
  35665. * Gets the vertex shader source code of this effect
  35666. */
  35667. get vertexSourceCode(): string;
  35668. /**
  35669. * Gets the fragment shader source code of this effect
  35670. */
  35671. get fragmentSourceCode(): string;
  35672. /**
  35673. * Recompiles the webGL program
  35674. * @param vertexSourceCode The source code for the vertex shader.
  35675. * @param fragmentSourceCode The source code for the fragment shader.
  35676. * @param onCompiled Callback called when completed.
  35677. * @param onError Callback called on error.
  35678. * @hidden
  35679. */
  35680. _rebuildProgram(vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (pipelineContext: IPipelineContext) => void, onError: (message: string) => void): void;
  35681. /**
  35682. * Prepares the effect
  35683. * @hidden
  35684. */
  35685. _prepareEffect(): void;
  35686. private _getShaderCodeAndErrorLine;
  35687. private _processCompilationErrors;
  35688. /**
  35689. * Checks if the effect is supported. (Must be called after compilation)
  35690. */
  35691. get isSupported(): boolean;
  35692. /**
  35693. * Binds a texture to the engine to be used as output of the shader.
  35694. * @param channel Name of the output variable.
  35695. * @param texture Texture to bind.
  35696. * @hidden
  35697. */
  35698. _bindTexture(channel: string, texture: Nullable<InternalTexture>): void;
  35699. /**
  35700. * Sets a texture on the engine to be used in the shader.
  35701. * @param channel Name of the sampler variable.
  35702. * @param texture Texture to set.
  35703. */
  35704. setTexture(channel: string, texture: Nullable<BaseTexture>): void;
  35705. /**
  35706. * Sets a depth stencil texture from a render target on the engine to be used in the shader.
  35707. * @param channel Name of the sampler variable.
  35708. * @param texture Texture to set.
  35709. */
  35710. setDepthStencilTexture(channel: string, texture: Nullable<RenderTargetTexture>): void;
  35711. /**
  35712. * Sets an array of textures on the engine to be used in the shader.
  35713. * @param channel Name of the variable.
  35714. * @param textures Textures to set.
  35715. */
  35716. setTextureArray(channel: string, textures: BaseTexture[]): void;
  35717. /**
  35718. * 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)
  35719. * @param channel Name of the sampler variable.
  35720. * @param postProcess Post process to get the input texture from.
  35721. */
  35722. setTextureFromPostProcess(channel: string, postProcess: Nullable<PostProcess>): void;
  35723. /**
  35724. * (Warning! setTextureFromPostProcessOutput may be desired instead)
  35725. * 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)
  35726. * @param channel Name of the sampler variable.
  35727. * @param postProcess Post process to get the output texture from.
  35728. */
  35729. setTextureFromPostProcessOutput(channel: string, postProcess: Nullable<PostProcess>): void;
  35730. /** @hidden */
  35731. _cacheMatrix(uniformName: string, matrix: IMatrixLike): boolean;
  35732. /** @hidden */
  35733. _cacheFloat2(uniformName: string, x: number, y: number): boolean;
  35734. /** @hidden */
  35735. _cacheFloat3(uniformName: string, x: number, y: number, z: number): boolean;
  35736. /** @hidden */
  35737. _cacheFloat4(uniformName: string, x: number, y: number, z: number, w: number): boolean;
  35738. /**
  35739. * Binds a buffer to a uniform.
  35740. * @param buffer Buffer to bind.
  35741. * @param name Name of the uniform variable to bind to.
  35742. */
  35743. bindUniformBuffer(buffer: DataBuffer, name: string): void;
  35744. /**
  35745. * Binds block to a uniform.
  35746. * @param blockName Name of the block to bind.
  35747. * @param index Index to bind.
  35748. */
  35749. bindUniformBlock(blockName: string, index: number): void;
  35750. /**
  35751. * Sets an interger value on a uniform variable.
  35752. * @param uniformName Name of the variable.
  35753. * @param value Value to be set.
  35754. * @returns this effect.
  35755. */
  35756. setInt(uniformName: string, value: number): Effect;
  35757. /**
  35758. * Sets an int array on a uniform variable.
  35759. * @param uniformName Name of the variable.
  35760. * @param array array to be set.
  35761. * @returns this effect.
  35762. */
  35763. setIntArray(uniformName: string, array: Int32Array): Effect;
  35764. /**
  35765. * 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)
  35766. * @param uniformName Name of the variable.
  35767. * @param array array to be set.
  35768. * @returns this effect.
  35769. */
  35770. setIntArray2(uniformName: string, array: Int32Array): Effect;
  35771. /**
  35772. * 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)
  35773. * @param uniformName Name of the variable.
  35774. * @param array array to be set.
  35775. * @returns this effect.
  35776. */
  35777. setIntArray3(uniformName: string, array: Int32Array): Effect;
  35778. /**
  35779. * 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)
  35780. * @param uniformName Name of the variable.
  35781. * @param array array to be set.
  35782. * @returns this effect.
  35783. */
  35784. setIntArray4(uniformName: string, array: Int32Array): Effect;
  35785. /**
  35786. * Sets an float array on a uniform variable.
  35787. * @param uniformName Name of the variable.
  35788. * @param array array to be set.
  35789. * @returns this effect.
  35790. */
  35791. setFloatArray(uniformName: string, array: Float32Array): Effect;
  35792. /**
  35793. * 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)
  35794. * @param uniformName Name of the variable.
  35795. * @param array array to be set.
  35796. * @returns this effect.
  35797. */
  35798. setFloatArray2(uniformName: string, array: Float32Array): Effect;
  35799. /**
  35800. * 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)
  35801. * @param uniformName Name of the variable.
  35802. * @param array array to be set.
  35803. * @returns this effect.
  35804. */
  35805. setFloatArray3(uniformName: string, array: Float32Array): Effect;
  35806. /**
  35807. * 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)
  35808. * @param uniformName Name of the variable.
  35809. * @param array array to be set.
  35810. * @returns this effect.
  35811. */
  35812. setFloatArray4(uniformName: string, array: Float32Array): Effect;
  35813. /**
  35814. * Sets an array on a uniform variable.
  35815. * @param uniformName Name of the variable.
  35816. * @param array array to be set.
  35817. * @returns this effect.
  35818. */
  35819. setArray(uniformName: string, array: number[]): Effect;
  35820. /**
  35821. * 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)
  35822. * @param uniformName Name of the variable.
  35823. * @param array array to be set.
  35824. * @returns this effect.
  35825. */
  35826. setArray2(uniformName: string, array: number[]): Effect;
  35827. /**
  35828. * 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)
  35829. * @param uniformName Name of the variable.
  35830. * @param array array to be set.
  35831. * @returns this effect.
  35832. */
  35833. setArray3(uniformName: string, array: number[]): Effect;
  35834. /**
  35835. * 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)
  35836. * @param uniformName Name of the variable.
  35837. * @param array array to be set.
  35838. * @returns this effect.
  35839. */
  35840. setArray4(uniformName: string, array: number[]): Effect;
  35841. /**
  35842. * Sets matrices on a uniform variable.
  35843. * @param uniformName Name of the variable.
  35844. * @param matrices matrices to be set.
  35845. * @returns this effect.
  35846. */
  35847. setMatrices(uniformName: string, matrices: Float32Array | Array<number>): Effect;
  35848. /**
  35849. * Sets matrix on a uniform variable.
  35850. * @param uniformName Name of the variable.
  35851. * @param matrix matrix to be set.
  35852. * @returns this effect.
  35853. */
  35854. setMatrix(uniformName: string, matrix: IMatrixLike): Effect;
  35855. /**
  35856. * 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)
  35857. * @param uniformName Name of the variable.
  35858. * @param matrix matrix to be set.
  35859. * @returns this effect.
  35860. */
  35861. setMatrix3x3(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  35862. /**
  35863. * Sets a 2x2 matrix on a uniform variable. (Speicified as [1,2,3,4] will result in [1,2][3,4] matrix)
  35864. * @param uniformName Name of the variable.
  35865. * @param matrix matrix to be set.
  35866. * @returns this effect.
  35867. */
  35868. setMatrix2x2(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  35869. /**
  35870. * Sets a float on a uniform variable.
  35871. * @param uniformName Name of the variable.
  35872. * @param value value to be set.
  35873. * @returns this effect.
  35874. */
  35875. setFloat(uniformName: string, value: number): Effect;
  35876. /**
  35877. * Sets a boolean on a uniform variable.
  35878. * @param uniformName Name of the variable.
  35879. * @param bool value to be set.
  35880. * @returns this effect.
  35881. */
  35882. setBool(uniformName: string, bool: boolean): Effect;
  35883. /**
  35884. * Sets a Vector2 on a uniform variable.
  35885. * @param uniformName Name of the variable.
  35886. * @param vector2 vector2 to be set.
  35887. * @returns this effect.
  35888. */
  35889. setVector2(uniformName: string, vector2: IVector2Like): Effect;
  35890. /**
  35891. * Sets a float2 on a uniform variable.
  35892. * @param uniformName Name of the variable.
  35893. * @param x First float in float2.
  35894. * @param y Second float in float2.
  35895. * @returns this effect.
  35896. */
  35897. setFloat2(uniformName: string, x: number, y: number): Effect;
  35898. /**
  35899. * Sets a Vector3 on a uniform variable.
  35900. * @param uniformName Name of the variable.
  35901. * @param vector3 Value to be set.
  35902. * @returns this effect.
  35903. */
  35904. setVector3(uniformName: string, vector3: IVector3Like): Effect;
  35905. /**
  35906. * Sets a float3 on a uniform variable.
  35907. * @param uniformName Name of the variable.
  35908. * @param x First float in float3.
  35909. * @param y Second float in float3.
  35910. * @param z Third float in float3.
  35911. * @returns this effect.
  35912. */
  35913. setFloat3(uniformName: string, x: number, y: number, z: number): Effect;
  35914. /**
  35915. * Sets a Vector4 on a uniform variable.
  35916. * @param uniformName Name of the variable.
  35917. * @param vector4 Value to be set.
  35918. * @returns this effect.
  35919. */
  35920. setVector4(uniformName: string, vector4: IVector4Like): Effect;
  35921. /**
  35922. * Sets a float4 on a uniform variable.
  35923. * @param uniformName Name of the variable.
  35924. * @param x First float in float4.
  35925. * @param y Second float in float4.
  35926. * @param z Third float in float4.
  35927. * @param w Fourth float in float4.
  35928. * @returns this effect.
  35929. */
  35930. setFloat4(uniformName: string, x: number, y: number, z: number, w: number): Effect;
  35931. /**
  35932. * Sets a Color3 on a uniform variable.
  35933. * @param uniformName Name of the variable.
  35934. * @param color3 Value to be set.
  35935. * @returns this effect.
  35936. */
  35937. setColor3(uniformName: string, color3: IColor3Like): Effect;
  35938. /**
  35939. * Sets a Color4 on a uniform variable.
  35940. * @param uniformName Name of the variable.
  35941. * @param color3 Value to be set.
  35942. * @param alpha Alpha value to be set.
  35943. * @returns this effect.
  35944. */
  35945. setColor4(uniformName: string, color3: IColor3Like, alpha: number): Effect;
  35946. /**
  35947. * Sets a Color4 on a uniform variable
  35948. * @param uniformName defines the name of the variable
  35949. * @param color4 defines the value to be set
  35950. * @returns this effect.
  35951. */
  35952. setDirectColor4(uniformName: string, color4: IColor4Like): Effect;
  35953. /** Release all associated resources */
  35954. dispose(): void;
  35955. /**
  35956. * This function will add a new shader to the shader store
  35957. * @param name the name of the shader
  35958. * @param pixelShader optional pixel shader content
  35959. * @param vertexShader optional vertex shader content
  35960. */
  35961. static RegisterShader(name: string, pixelShader?: string, vertexShader?: string): void;
  35962. /**
  35963. * Store of each shader (The can be looked up using effect.key)
  35964. */
  35965. static ShadersStore: {
  35966. [key: string]: string;
  35967. };
  35968. /**
  35969. * Store of each included file for a shader (The can be looked up using effect.key)
  35970. */
  35971. static IncludesShadersStore: {
  35972. [key: string]: string;
  35973. };
  35974. /**
  35975. * Resets the cache of effects.
  35976. */
  35977. static ResetCache(): void;
  35978. }
  35979. }
  35980. declare module "babylonjs/Engines/engineCapabilities" {
  35981. /**
  35982. * Interface used to describe the capabilities of the engine relatively to the current browser
  35983. */
  35984. export interface EngineCapabilities {
  35985. /** Maximum textures units per fragment shader */
  35986. maxTexturesImageUnits: number;
  35987. /** Maximum texture units per vertex shader */
  35988. maxVertexTextureImageUnits: number;
  35989. /** Maximum textures units in the entire pipeline */
  35990. maxCombinedTexturesImageUnits: number;
  35991. /** Maximum texture size */
  35992. maxTextureSize: number;
  35993. /** Maximum texture samples */
  35994. maxSamples?: number;
  35995. /** Maximum cube texture size */
  35996. maxCubemapTextureSize: number;
  35997. /** Maximum render texture size */
  35998. maxRenderTextureSize: number;
  35999. /** Maximum number of vertex attributes */
  36000. maxVertexAttribs: number;
  36001. /** Maximum number of varyings */
  36002. maxVaryingVectors: number;
  36003. /** Maximum number of uniforms per vertex shader */
  36004. maxVertexUniformVectors: number;
  36005. /** Maximum number of uniforms per fragment shader */
  36006. maxFragmentUniformVectors: number;
  36007. /** Defines if standard derivates (dx/dy) are supported */
  36008. standardDerivatives: boolean;
  36009. /** Defines if s3tc texture compression is supported */
  36010. s3tc?: WEBGL_compressed_texture_s3tc;
  36011. /** Defines if pvrtc texture compression is supported */
  36012. pvrtc: any;
  36013. /** Defines if etc1 texture compression is supported */
  36014. etc1: any;
  36015. /** Defines if etc2 texture compression is supported */
  36016. etc2: any;
  36017. /** Defines if astc texture compression is supported */
  36018. astc: any;
  36019. /** Defines if bptc texture compression is supported */
  36020. bptc: any;
  36021. /** Defines if float textures are supported */
  36022. textureFloat: boolean;
  36023. /** Defines if vertex array objects are supported */
  36024. vertexArrayObject: boolean;
  36025. /** Gets the webgl extension for anisotropic filtering (null if not supported) */
  36026. textureAnisotropicFilterExtension?: EXT_texture_filter_anisotropic;
  36027. /** Gets the maximum level of anisotropy supported */
  36028. maxAnisotropy: number;
  36029. /** Defines if instancing is supported */
  36030. instancedArrays: boolean;
  36031. /** Defines if 32 bits indices are supported */
  36032. uintIndices: boolean;
  36033. /** Defines if high precision shaders are supported */
  36034. highPrecisionShaderSupported: boolean;
  36035. /** Defines if depth reading in the fragment shader is supported */
  36036. fragmentDepthSupported: boolean;
  36037. /** Defines if float texture linear filtering is supported*/
  36038. textureFloatLinearFiltering: boolean;
  36039. /** Defines if rendering to float textures is supported */
  36040. textureFloatRender: boolean;
  36041. /** Defines if half float textures are supported*/
  36042. textureHalfFloat: boolean;
  36043. /** Defines if half float texture linear filtering is supported*/
  36044. textureHalfFloatLinearFiltering: boolean;
  36045. /** Defines if rendering to half float textures is supported */
  36046. textureHalfFloatRender: boolean;
  36047. /** Defines if textureLOD shader command is supported */
  36048. textureLOD: boolean;
  36049. /** Defines if draw buffers extension is supported */
  36050. drawBuffersExtension: boolean;
  36051. /** Defines if depth textures are supported */
  36052. depthTextureExtension: boolean;
  36053. /** Defines if float color buffer are supported */
  36054. colorBufferFloat: boolean;
  36055. /** Gets disjoint timer query extension (null if not supported) */
  36056. timerQuery?: EXT_disjoint_timer_query;
  36057. /** Defines if timestamp can be used with timer query */
  36058. canUseTimestampForTimerQuery: boolean;
  36059. /** Defines if multiview is supported (https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/) */
  36060. multiview?: any;
  36061. /** Defines if oculus multiview is supported (https://developer.oculus.com/documentation/oculus-browser/latest/concepts/browser-multiview/) */
  36062. oculusMultiview?: any;
  36063. /** Function used to let the system compiles shaders in background */
  36064. parallelShaderCompile?: {
  36065. COMPLETION_STATUS_KHR: number;
  36066. };
  36067. /** Max number of texture samples for MSAA */
  36068. maxMSAASamples: number;
  36069. /** Defines if the blend min max extension is supported */
  36070. blendMinMax: boolean;
  36071. }
  36072. }
  36073. declare module "babylonjs/States/depthCullingState" {
  36074. import { Nullable } from "babylonjs/types";
  36075. /**
  36076. * @hidden
  36077. **/
  36078. export class DepthCullingState {
  36079. private _isDepthTestDirty;
  36080. private _isDepthMaskDirty;
  36081. private _isDepthFuncDirty;
  36082. private _isCullFaceDirty;
  36083. private _isCullDirty;
  36084. private _isZOffsetDirty;
  36085. private _isFrontFaceDirty;
  36086. private _depthTest;
  36087. private _depthMask;
  36088. private _depthFunc;
  36089. private _cull;
  36090. private _cullFace;
  36091. private _zOffset;
  36092. private _frontFace;
  36093. /**
  36094. * Initializes the state.
  36095. */
  36096. constructor();
  36097. get isDirty(): boolean;
  36098. get zOffset(): number;
  36099. set zOffset(value: number);
  36100. get cullFace(): Nullable<number>;
  36101. set cullFace(value: Nullable<number>);
  36102. get cull(): Nullable<boolean>;
  36103. set cull(value: Nullable<boolean>);
  36104. get depthFunc(): Nullable<number>;
  36105. set depthFunc(value: Nullable<number>);
  36106. get depthMask(): boolean;
  36107. set depthMask(value: boolean);
  36108. get depthTest(): boolean;
  36109. set depthTest(value: boolean);
  36110. get frontFace(): Nullable<number>;
  36111. set frontFace(value: Nullable<number>);
  36112. reset(): void;
  36113. apply(gl: WebGLRenderingContext): void;
  36114. }
  36115. }
  36116. declare module "babylonjs/States/stencilState" {
  36117. /**
  36118. * @hidden
  36119. **/
  36120. export class StencilState {
  36121. /** 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 */
  36122. static readonly ALWAYS: number;
  36123. /** Passed to stencilOperation to specify that stencil value must be kept */
  36124. static readonly KEEP: number;
  36125. /** Passed to stencilOperation to specify that stencil value must be replaced */
  36126. static readonly REPLACE: number;
  36127. private _isStencilTestDirty;
  36128. private _isStencilMaskDirty;
  36129. private _isStencilFuncDirty;
  36130. private _isStencilOpDirty;
  36131. private _stencilTest;
  36132. private _stencilMask;
  36133. private _stencilFunc;
  36134. private _stencilFuncRef;
  36135. private _stencilFuncMask;
  36136. private _stencilOpStencilFail;
  36137. private _stencilOpDepthFail;
  36138. private _stencilOpStencilDepthPass;
  36139. get isDirty(): boolean;
  36140. get stencilFunc(): number;
  36141. set stencilFunc(value: number);
  36142. get stencilFuncRef(): number;
  36143. set stencilFuncRef(value: number);
  36144. get stencilFuncMask(): number;
  36145. set stencilFuncMask(value: number);
  36146. get stencilOpStencilFail(): number;
  36147. set stencilOpStencilFail(value: number);
  36148. get stencilOpDepthFail(): number;
  36149. set stencilOpDepthFail(value: number);
  36150. get stencilOpStencilDepthPass(): number;
  36151. set stencilOpStencilDepthPass(value: number);
  36152. get stencilMask(): number;
  36153. set stencilMask(value: number);
  36154. get stencilTest(): boolean;
  36155. set stencilTest(value: boolean);
  36156. constructor();
  36157. reset(): void;
  36158. apply(gl: WebGLRenderingContext): void;
  36159. }
  36160. }
  36161. declare module "babylonjs/States/alphaCullingState" {
  36162. /**
  36163. * @hidden
  36164. **/
  36165. export class AlphaState {
  36166. private _isAlphaBlendDirty;
  36167. private _isBlendFunctionParametersDirty;
  36168. private _isBlendEquationParametersDirty;
  36169. private _isBlendConstantsDirty;
  36170. private _alphaBlend;
  36171. private _blendFunctionParameters;
  36172. private _blendEquationParameters;
  36173. private _blendConstants;
  36174. /**
  36175. * Initializes the state.
  36176. */
  36177. constructor();
  36178. get isDirty(): boolean;
  36179. get alphaBlend(): boolean;
  36180. set alphaBlend(value: boolean);
  36181. setAlphaBlendConstants(r: number, g: number, b: number, a: number): void;
  36182. setAlphaBlendFunctionParameters(value0: number, value1: number, value2: number, value3: number): void;
  36183. setAlphaEquationParameters(rgb: number, alpha: number): void;
  36184. reset(): void;
  36185. apply(gl: WebGLRenderingContext): void;
  36186. }
  36187. }
  36188. declare module "babylonjs/Engines/WebGL/webGL2ShaderProcessors" {
  36189. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  36190. /** @hidden */
  36191. export class WebGL2ShaderProcessor implements IShaderProcessor {
  36192. attributeProcessor(attribute: string): string;
  36193. varyingProcessor(varying: string, isFragment: boolean): string;
  36194. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  36195. }
  36196. }
  36197. declare module "babylonjs/Engines/instancingAttributeInfo" {
  36198. /**
  36199. * Interface for attribute information associated with buffer instanciation
  36200. */
  36201. export interface InstancingAttributeInfo {
  36202. /**
  36203. * Name of the GLSL attribute
  36204. * if attribute index is not specified, this is used to retrieve the index from the effect
  36205. */
  36206. attributeName: string;
  36207. /**
  36208. * Index/offset of the attribute in the vertex shader
  36209. * if not specified, this will be computes from the name.
  36210. */
  36211. index?: number;
  36212. /**
  36213. * size of the attribute, 1, 2, 3 or 4
  36214. */
  36215. attributeSize: number;
  36216. /**
  36217. * Offset of the data in the Vertex Buffer acting as the instancing buffer
  36218. */
  36219. offset: number;
  36220. /**
  36221. * Modifies the rate at which generic vertex attributes advance when rendering multiple instances
  36222. * default to 1
  36223. */
  36224. divisor?: number;
  36225. /**
  36226. * type of the attribute, gl.BYTE, gl.UNSIGNED_BYTE, gl.SHORT, gl.UNSIGNED_SHORT, gl.FIXED, gl.FLOAT.
  36227. * default is FLOAT
  36228. */
  36229. attributeType?: number;
  36230. /**
  36231. * normalization of fixed-point data. behavior unclear, use FALSE, default is FALSE
  36232. */
  36233. normalized?: boolean;
  36234. }
  36235. }
  36236. declare module "babylonjs/Engines/Extensions/engine.videoTexture" {
  36237. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  36238. import { Nullable } from "babylonjs/types";
  36239. module "babylonjs/Engines/thinEngine" {
  36240. interface ThinEngine {
  36241. /**
  36242. * Update a video texture
  36243. * @param texture defines the texture to update
  36244. * @param video defines the video element to use
  36245. * @param invertY defines if data must be stored with Y axis inverted
  36246. */
  36247. updateVideoTexture(texture: Nullable<InternalTexture>, video: HTMLVideoElement, invertY: boolean): void;
  36248. }
  36249. }
  36250. }
  36251. declare module "babylonjs/Engines/Extensions/engine.dynamicTexture" {
  36252. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  36253. import { Nullable } from "babylonjs/types";
  36254. module "babylonjs/Engines/thinEngine" {
  36255. interface ThinEngine {
  36256. /**
  36257. * Creates a dynamic texture
  36258. * @param width defines the width of the texture
  36259. * @param height defines the height of the texture
  36260. * @param generateMipMaps defines if the engine should generate the mip levels
  36261. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  36262. * @returns the dynamic texture inside an InternalTexture
  36263. */
  36264. createDynamicTexture(width: number, height: number, generateMipMaps: boolean, samplingMode: number): InternalTexture;
  36265. /**
  36266. * Update the content of a dynamic texture
  36267. * @param texture defines the texture to update
  36268. * @param canvas defines the canvas containing the source
  36269. * @param invertY defines if data must be stored with Y axis inverted
  36270. * @param premulAlpha defines if alpha is stored as premultiplied
  36271. * @param format defines the format of the data
  36272. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  36273. */
  36274. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement | OffscreenCanvas, invertY: boolean, premulAlpha?: boolean, format?: number, forceBindTexture?: boolean): void;
  36275. }
  36276. }
  36277. }
  36278. declare module "babylonjs/Materials/Textures/videoTexture" {
  36279. import { Observable } from "babylonjs/Misc/observable";
  36280. import { Nullable } from "babylonjs/types";
  36281. import { Scene } from "babylonjs/scene";
  36282. import { Texture } from "babylonjs/Materials/Textures/texture";
  36283. import "babylonjs/Engines/Extensions/engine.videoTexture";
  36284. import "babylonjs/Engines/Extensions/engine.dynamicTexture";
  36285. /**
  36286. * Settings for finer control over video usage
  36287. */
  36288. export interface VideoTextureSettings {
  36289. /**
  36290. * Applies `autoplay` to video, if specified
  36291. */
  36292. autoPlay?: boolean;
  36293. /**
  36294. * Applies `loop` to video, if specified
  36295. */
  36296. loop?: boolean;
  36297. /**
  36298. * Automatically updates internal texture from video at every frame in the render loop
  36299. */
  36300. autoUpdateTexture: boolean;
  36301. /**
  36302. * Image src displayed during the video loading or until the user interacts with the video.
  36303. */
  36304. poster?: string;
  36305. }
  36306. /**
  36307. * If you want to display a video in your scene, this is the special texture for that.
  36308. * This special texture works similar to other textures, with the exception of a few parameters.
  36309. * @see https://doc.babylonjs.com/how_to/video_texture
  36310. */
  36311. export class VideoTexture extends Texture {
  36312. /**
  36313. * Tells whether textures will be updated automatically or user is required to call `updateTexture` manually
  36314. */
  36315. readonly autoUpdateTexture: boolean;
  36316. /**
  36317. * The video instance used by the texture internally
  36318. */
  36319. readonly video: HTMLVideoElement;
  36320. private _onUserActionRequestedObservable;
  36321. /**
  36322. * Event triggerd when a dom action is required by the user to play the video.
  36323. * This happens due to recent changes in browser policies preventing video to auto start.
  36324. */
  36325. get onUserActionRequestedObservable(): Observable<Texture>;
  36326. private _generateMipMaps;
  36327. private _stillImageCaptured;
  36328. private _displayingPosterTexture;
  36329. private _settings;
  36330. private _createInternalTextureOnEvent;
  36331. private _frameId;
  36332. private _currentSrc;
  36333. /**
  36334. * Creates a video texture.
  36335. * If you want to display a video in your scene, this is the special texture for that.
  36336. * This special texture works similar to other textures, with the exception of a few parameters.
  36337. * @see https://doc.babylonjs.com/how_to/video_texture
  36338. * @param name optional name, will detect from video source, if not defined
  36339. * @param src can be used to provide an url, array of urls or an already setup HTML video element.
  36340. * @param scene is obviously the current scene.
  36341. * @param generateMipMaps can be used to turn on mipmaps (Can be expensive for videoTextures because they are often updated).
  36342. * @param invertY is false by default but can be used to invert video on Y axis
  36343. * @param samplingMode controls the sampling method and is set to TRILINEAR_SAMPLINGMODE by default
  36344. * @param settings allows finer control over video usage
  36345. */
  36346. constructor(name: Nullable<string>, src: string | string[] | HTMLVideoElement, scene: Nullable<Scene>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, settings?: VideoTextureSettings);
  36347. private _getName;
  36348. private _getVideo;
  36349. private _createInternalTexture;
  36350. private reset;
  36351. /**
  36352. * @hidden Internal method to initiate `update`.
  36353. */
  36354. _rebuild(): void;
  36355. /**
  36356. * Update Texture in the `auto` mode. Does not do anything if `settings.autoUpdateTexture` is false.
  36357. */
  36358. update(): void;
  36359. /**
  36360. * Update Texture in `manual` mode. Does not do anything if not visible or paused.
  36361. * @param isVisible Visibility state, detected by user using `scene.getActiveMeshes()` or othervise.
  36362. */
  36363. updateTexture(isVisible: boolean): void;
  36364. protected _updateInternalTexture: () => void;
  36365. /**
  36366. * Change video content. Changing video instance or setting multiple urls (as in constructor) is not supported.
  36367. * @param url New url.
  36368. */
  36369. updateURL(url: string): void;
  36370. /**
  36371. * Clones the texture.
  36372. * @returns the cloned texture
  36373. */
  36374. clone(): VideoTexture;
  36375. /**
  36376. * Dispose the texture and release its associated resources.
  36377. */
  36378. dispose(): void;
  36379. /**
  36380. * Creates a video texture straight from a stream.
  36381. * @param scene Define the scene the texture should be created in
  36382. * @param stream Define the stream the texture should be created from
  36383. * @returns The created video texture as a promise
  36384. */
  36385. static CreateFromStreamAsync(scene: Scene, stream: MediaStream): Promise<VideoTexture>;
  36386. /**
  36387. * Creates a video texture straight from your WebCam video feed.
  36388. * @param scene Define the scene the texture should be created in
  36389. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  36390. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  36391. * @returns The created video texture as a promise
  36392. */
  36393. static CreateFromWebCamAsync(scene: Scene, constraints: {
  36394. minWidth: number;
  36395. maxWidth: number;
  36396. minHeight: number;
  36397. maxHeight: number;
  36398. deviceId: string;
  36399. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): Promise<VideoTexture>;
  36400. /**
  36401. * Creates a video texture straight from your WebCam video feed.
  36402. * @param scene Define the scene the texture should be created in
  36403. * @param onReady Define a callback to triggered once the texture will be ready
  36404. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  36405. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  36406. */
  36407. static CreateFromWebCam(scene: Scene, onReady: (videoTexture: VideoTexture) => void, constraints: {
  36408. minWidth: number;
  36409. maxWidth: number;
  36410. minHeight: number;
  36411. maxHeight: number;
  36412. deviceId: string;
  36413. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): void;
  36414. }
  36415. }
  36416. declare module "babylonjs/Engines/thinEngine" {
  36417. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  36418. import { Effect, IEffectCreationOptions } from "babylonjs/Materials/effect";
  36419. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  36420. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  36421. import { Nullable, DataArray, IndicesArray } from "babylonjs/types";
  36422. import { EngineCapabilities } from "babylonjs/Engines/engineCapabilities";
  36423. import { Observable } from "babylonjs/Misc/observable";
  36424. import { DepthCullingState } from "babylonjs/States/depthCullingState";
  36425. import { StencilState } from "babylonjs/States/stencilState";
  36426. import { AlphaState } from "babylonjs/States/alphaCullingState";
  36427. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  36428. import { IViewportLike, IColor4Like } from "babylonjs/Maths/math.like";
  36429. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  36430. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  36431. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  36432. import { WebGLPipelineContext } from "babylonjs/Engines/WebGL/webGLPipelineContext";
  36433. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  36434. import { InstancingAttributeInfo } from "babylonjs/Engines/instancingAttributeInfo";
  36435. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  36436. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  36437. import { IEffectFallbacks } from "babylonjs/Materials/iEffectFallbacks";
  36438. import { IWebRequest } from "babylonjs/Misc/interfaces/iWebRequest";
  36439. import { WebRequest } from "babylonjs/Misc/webRequest";
  36440. import { LoadFileError } from "babylonjs/Misc/fileTools";
  36441. /**
  36442. * Defines the interface used by objects working like Scene
  36443. * @hidden
  36444. */
  36445. export interface ISceneLike {
  36446. _addPendingData(data: any): void;
  36447. _removePendingData(data: any): void;
  36448. offlineProvider: IOfflineProvider;
  36449. }
  36450. /**
  36451. * Information about the current host
  36452. */
  36453. export interface HostInformation {
  36454. /**
  36455. * Defines if the current host is a mobile
  36456. */
  36457. isMobile: boolean;
  36458. }
  36459. /** Interface defining initialization parameters for Engine class */
  36460. export interface EngineOptions extends WebGLContextAttributes {
  36461. /**
  36462. * Defines if the engine should no exceed a specified device ratio
  36463. * @see https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio
  36464. */
  36465. limitDeviceRatio?: number;
  36466. /**
  36467. * Defines if webvr should be enabled automatically
  36468. * @see https://doc.babylonjs.com/how_to/webvr_camera
  36469. */
  36470. autoEnableWebVR?: boolean;
  36471. /**
  36472. * Defines if webgl2 should be turned off even if supported
  36473. * @see https://doc.babylonjs.com/features/webgl2
  36474. */
  36475. disableWebGL2Support?: boolean;
  36476. /**
  36477. * Defines if webaudio should be initialized as well
  36478. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  36479. */
  36480. audioEngine?: boolean;
  36481. /**
  36482. * Defines if animations should run using a deterministic lock step
  36483. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  36484. */
  36485. deterministicLockstep?: boolean;
  36486. /** Defines the maximum steps to use with deterministic lock step mode */
  36487. lockstepMaxSteps?: number;
  36488. /** Defines the seconds between each deterministic lock step */
  36489. timeStep?: number;
  36490. /**
  36491. * Defines that engine should ignore context lost events
  36492. * If this event happens when this parameter is true, you will have to reload the page to restore rendering
  36493. */
  36494. doNotHandleContextLost?: boolean;
  36495. /**
  36496. * Defines that engine should ignore modifying touch action attribute and style
  36497. * If not handle, you might need to set it up on your side for expected touch devices behavior.
  36498. */
  36499. doNotHandleTouchAction?: boolean;
  36500. /**
  36501. * Defines that engine should compile shaders with high precision floats (if supported). True by default
  36502. */
  36503. useHighPrecisionFloats?: boolean;
  36504. /**
  36505. * Make the canvas XR Compatible for XR sessions
  36506. */
  36507. xrCompatible?: boolean;
  36508. /**
  36509. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  36510. */
  36511. useHighPrecisionMatrix?: boolean;
  36512. }
  36513. /**
  36514. * The base engine class (root of all engines)
  36515. */
  36516. export class ThinEngine {
  36517. /** Use this array to turn off some WebGL2 features on known buggy browsers version */
  36518. static ExceptionList: ({
  36519. key: string;
  36520. capture: string;
  36521. captureConstraint: number;
  36522. targets: string[];
  36523. } | {
  36524. key: string;
  36525. capture: null;
  36526. captureConstraint: null;
  36527. targets: string[];
  36528. })[];
  36529. /** @hidden */
  36530. static _TextureLoaders: IInternalTextureLoader[];
  36531. /**
  36532. * Returns the current npm package of the sdk
  36533. */
  36534. static get NpmPackage(): string;
  36535. /**
  36536. * Returns the current version of the framework
  36537. */
  36538. static get Version(): string;
  36539. /**
  36540. * Returns a string describing the current engine
  36541. */
  36542. get description(): string;
  36543. /**
  36544. * Gets or sets the epsilon value used by collision engine
  36545. */
  36546. static CollisionsEpsilon: number;
  36547. /**
  36548. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  36549. */
  36550. static get ShadersRepository(): string;
  36551. static set ShadersRepository(value: string);
  36552. /** @hidden */
  36553. _shaderProcessor: IShaderProcessor;
  36554. /**
  36555. * Gets or sets a boolean that indicates if textures must be forced to power of 2 size even if not required
  36556. */
  36557. forcePOTTextures: boolean;
  36558. /**
  36559. * Gets a boolean indicating if the engine is currently rendering in fullscreen mode
  36560. */
  36561. isFullscreen: boolean;
  36562. /**
  36563. * Gets or sets a boolean indicating if back faces must be culled (true by default)
  36564. */
  36565. cullBackFaces: boolean;
  36566. /**
  36567. * Gets or sets a boolean indicating if the engine must keep rendering even if the window is not in foregroun
  36568. */
  36569. renderEvenInBackground: boolean;
  36570. /**
  36571. * Gets or sets a boolean indicating that cache can be kept between frames
  36572. */
  36573. preventCacheWipeBetweenFrames: boolean;
  36574. /** Gets or sets a boolean indicating if the engine should validate programs after compilation */
  36575. validateShaderPrograms: boolean;
  36576. /**
  36577. * Gets or sets a boolean indicating if depth buffer should be reverse, going from far to near.
  36578. * This can provide greater z depth for distant objects.
  36579. */
  36580. useReverseDepthBuffer: boolean;
  36581. /**
  36582. * Gets or sets a boolean indicating that uniform buffers must be disabled even if they are supported
  36583. */
  36584. disableUniformBuffers: boolean;
  36585. /** @hidden */
  36586. _uniformBuffers: UniformBuffer[];
  36587. /**
  36588. * Gets a boolean indicating that the engine supports uniform buffers
  36589. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  36590. */
  36591. get supportsUniformBuffers(): boolean;
  36592. /** @hidden */
  36593. _gl: WebGLRenderingContext;
  36594. /** @hidden */
  36595. _webGLVersion: number;
  36596. protected _renderingCanvas: Nullable<HTMLCanvasElement>;
  36597. protected _windowIsBackground: boolean;
  36598. protected _creationOptions: EngineOptions;
  36599. protected _highPrecisionShadersAllowed: boolean;
  36600. /** @hidden */
  36601. get _shouldUseHighPrecisionShader(): boolean;
  36602. /**
  36603. * Gets a boolean indicating that only power of 2 textures are supported
  36604. * Please note that you can still use non power of 2 textures but in this case the engine will forcefully convert them
  36605. */
  36606. get needPOTTextures(): boolean;
  36607. /** @hidden */
  36608. _badOS: boolean;
  36609. /** @hidden */
  36610. _badDesktopOS: boolean;
  36611. private _hardwareScalingLevel;
  36612. /** @hidden */
  36613. _caps: EngineCapabilities;
  36614. private _isStencilEnable;
  36615. private _glVersion;
  36616. private _glRenderer;
  36617. private _glVendor;
  36618. /** @hidden */
  36619. _videoTextureSupported: boolean;
  36620. protected _renderingQueueLaunched: boolean;
  36621. protected _activeRenderLoops: (() => void)[];
  36622. /**
  36623. * Observable signaled when a context lost event is raised
  36624. */
  36625. onContextLostObservable: Observable<ThinEngine>;
  36626. /**
  36627. * Observable signaled when a context restored event is raised
  36628. */
  36629. onContextRestoredObservable: Observable<ThinEngine>;
  36630. private _onContextLost;
  36631. private _onContextRestored;
  36632. protected _contextWasLost: boolean;
  36633. /** @hidden */
  36634. _doNotHandleContextLost: boolean;
  36635. /**
  36636. * Gets or sets a boolean indicating if resources should be retained to be able to handle context lost events
  36637. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#handling-webgl-context-lost
  36638. */
  36639. get doNotHandleContextLost(): boolean;
  36640. set doNotHandleContextLost(value: boolean);
  36641. /**
  36642. * Gets or sets a boolean indicating that vertex array object must be disabled even if they are supported
  36643. */
  36644. disableVertexArrayObjects: boolean;
  36645. /** @hidden */
  36646. protected _colorWrite: boolean;
  36647. /** @hidden */
  36648. protected _colorWriteChanged: boolean;
  36649. /** @hidden */
  36650. protected _depthCullingState: DepthCullingState;
  36651. /** @hidden */
  36652. protected _stencilState: StencilState;
  36653. /** @hidden */
  36654. _alphaState: AlphaState;
  36655. /** @hidden */
  36656. _alphaMode: number;
  36657. /** @hidden */
  36658. _alphaEquation: number;
  36659. /** @hidden */
  36660. _internalTexturesCache: InternalTexture[];
  36661. /** @hidden */
  36662. protected _activeChannel: number;
  36663. private _currentTextureChannel;
  36664. /** @hidden */
  36665. protected _boundTexturesCache: {
  36666. [key: string]: Nullable<InternalTexture>;
  36667. };
  36668. /** @hidden */
  36669. protected _currentEffect: Nullable<Effect>;
  36670. /** @hidden */
  36671. protected _currentProgram: Nullable<WebGLProgram>;
  36672. private _compiledEffects;
  36673. private _vertexAttribArraysEnabled;
  36674. /** @hidden */
  36675. protected _cachedViewport: Nullable<IViewportLike>;
  36676. private _cachedVertexArrayObject;
  36677. /** @hidden */
  36678. protected _cachedVertexBuffers: any;
  36679. /** @hidden */
  36680. protected _cachedIndexBuffer: Nullable<DataBuffer>;
  36681. /** @hidden */
  36682. protected _cachedEffectForVertexBuffers: Nullable<Effect>;
  36683. /** @hidden */
  36684. _currentRenderTarget: Nullable<InternalTexture>;
  36685. private _uintIndicesCurrentlySet;
  36686. protected _currentBoundBuffer: Nullable<WebGLBuffer>[];
  36687. /** @hidden */
  36688. _currentFramebuffer: Nullable<WebGLFramebuffer>;
  36689. /** @hidden */
  36690. _dummyFramebuffer: Nullable<WebGLFramebuffer>;
  36691. private _currentBufferPointers;
  36692. private _currentInstanceLocations;
  36693. private _currentInstanceBuffers;
  36694. private _textureUnits;
  36695. /** @hidden */
  36696. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  36697. /** @hidden */
  36698. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  36699. /** @hidden */
  36700. _boundRenderFunction: any;
  36701. private _vaoRecordInProgress;
  36702. private _mustWipeVertexAttributes;
  36703. private _emptyTexture;
  36704. private _emptyCubeTexture;
  36705. private _emptyTexture3D;
  36706. private _emptyTexture2DArray;
  36707. /** @hidden */
  36708. _frameHandler: number;
  36709. private _nextFreeTextureSlots;
  36710. private _maxSimultaneousTextures;
  36711. private _activeRequests;
  36712. /** @hidden */
  36713. _transformTextureUrl: Nullable<(url: string) => string>;
  36714. /**
  36715. * Gets information about the current host
  36716. */
  36717. hostInformation: HostInformation;
  36718. protected get _supportsHardwareTextureRescaling(): boolean;
  36719. private _framebufferDimensionsObject;
  36720. /**
  36721. * sets the object from which width and height will be taken from when getting render width and height
  36722. * Will fallback to the gl object
  36723. * @param dimensions the framebuffer width and height that will be used.
  36724. */
  36725. set framebufferDimensionsObject(dimensions: Nullable<{
  36726. framebufferWidth: number;
  36727. framebufferHeight: number;
  36728. }>);
  36729. /**
  36730. * Gets the current viewport
  36731. */
  36732. get currentViewport(): Nullable<IViewportLike>;
  36733. /**
  36734. * Gets the default empty texture
  36735. */
  36736. get emptyTexture(): InternalTexture;
  36737. /**
  36738. * Gets the default empty 3D texture
  36739. */
  36740. get emptyTexture3D(): InternalTexture;
  36741. /**
  36742. * Gets the default empty 2D array texture
  36743. */
  36744. get emptyTexture2DArray(): InternalTexture;
  36745. /**
  36746. * Gets the default empty cube texture
  36747. */
  36748. get emptyCubeTexture(): InternalTexture;
  36749. /**
  36750. * Defines whether the engine has been created with the premultipliedAlpha option on or not.
  36751. */
  36752. readonly premultipliedAlpha: boolean;
  36753. /**
  36754. * Observable event triggered before each texture is initialized
  36755. */
  36756. onBeforeTextureInitObservable: Observable<import("babylonjs/Materials/Textures/texture").Texture>;
  36757. /**
  36758. * Creates a new engine
  36759. * @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
  36760. * @param antialias defines enable antialiasing (default: false)
  36761. * @param options defines further options to be sent to the getContext() function
  36762. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  36763. */
  36764. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext | WebGL2RenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  36765. private _rebuildInternalTextures;
  36766. private _rebuildEffects;
  36767. /**
  36768. * Gets a boolean indicating if all created effects are ready
  36769. * @returns true if all effects are ready
  36770. */
  36771. areAllEffectsReady(): boolean;
  36772. protected _rebuildBuffers(): void;
  36773. protected _initGLContext(): void;
  36774. /**
  36775. * Gets version of the current webGL context
  36776. */
  36777. get webGLVersion(): number;
  36778. /**
  36779. * Gets a string identifying the name of the class
  36780. * @returns "Engine" string
  36781. */
  36782. getClassName(): string;
  36783. /**
  36784. * Returns true if the stencil buffer has been enabled through the creation option of the context.
  36785. */
  36786. get isStencilEnable(): boolean;
  36787. /** @hidden */
  36788. _prepareWorkingCanvas(): void;
  36789. /**
  36790. * Reset the texture cache to empty state
  36791. */
  36792. resetTextureCache(): void;
  36793. /**
  36794. * Gets an object containing information about the current webGL context
  36795. * @returns an object containing the vender, the renderer and the version of the current webGL context
  36796. */
  36797. getGlInfo(): {
  36798. vendor: string;
  36799. renderer: string;
  36800. version: string;
  36801. };
  36802. /**
  36803. * Defines the hardware scaling level.
  36804. * By default the hardware scaling level is computed from the window device ratio.
  36805. * 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.
  36806. * @param level defines the level to use
  36807. */
  36808. setHardwareScalingLevel(level: number): void;
  36809. /**
  36810. * Gets the current hardware scaling level.
  36811. * By default the hardware scaling level is computed from the window device ratio.
  36812. * 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.
  36813. * @returns a number indicating the current hardware scaling level
  36814. */
  36815. getHardwareScalingLevel(): number;
  36816. /**
  36817. * Gets the list of loaded textures
  36818. * @returns an array containing all loaded textures
  36819. */
  36820. getLoadedTexturesCache(): InternalTexture[];
  36821. /**
  36822. * Gets the object containing all engine capabilities
  36823. * @returns the EngineCapabilities object
  36824. */
  36825. getCaps(): EngineCapabilities;
  36826. /**
  36827. * stop executing a render loop function and remove it from the execution array
  36828. * @param renderFunction defines the function to be removed. If not provided all functions will be removed.
  36829. */
  36830. stopRenderLoop(renderFunction?: () => void): void;
  36831. /** @hidden */
  36832. _renderLoop(): void;
  36833. /**
  36834. * Gets the HTML canvas attached with the current webGL context
  36835. * @returns a HTML canvas
  36836. */
  36837. getRenderingCanvas(): Nullable<HTMLCanvasElement>;
  36838. /**
  36839. * Gets host window
  36840. * @returns the host window object
  36841. */
  36842. getHostWindow(): Nullable<Window>;
  36843. /**
  36844. * Gets the current render width
  36845. * @param useScreen defines if screen size must be used (or the current render target if any)
  36846. * @returns a number defining the current render width
  36847. */
  36848. getRenderWidth(useScreen?: boolean): number;
  36849. /**
  36850. * Gets the current render height
  36851. * @param useScreen defines if screen size must be used (or the current render target if any)
  36852. * @returns a number defining the current render height
  36853. */
  36854. getRenderHeight(useScreen?: boolean): number;
  36855. /**
  36856. * Can be used to override the current requestAnimationFrame requester.
  36857. * @hidden
  36858. */
  36859. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  36860. /**
  36861. * Register and execute a render loop. The engine can have more than one render function
  36862. * @param renderFunction defines the function to continuously execute
  36863. */
  36864. runRenderLoop(renderFunction: () => void): void;
  36865. /**
  36866. * Clear the current render buffer or the current render target (if any is set up)
  36867. * @param color defines the color to use
  36868. * @param backBuffer defines if the back buffer must be cleared
  36869. * @param depth defines if the depth buffer must be cleared
  36870. * @param stencil defines if the stencil buffer must be cleared
  36871. */
  36872. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  36873. private _viewportCached;
  36874. /** @hidden */
  36875. _viewport(x: number, y: number, width: number, height: number): void;
  36876. /**
  36877. * Set the WebGL's viewport
  36878. * @param viewport defines the viewport element to be used
  36879. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  36880. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  36881. */
  36882. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  36883. /**
  36884. * Begin a new frame
  36885. */
  36886. beginFrame(): void;
  36887. /**
  36888. * Enf the current frame
  36889. */
  36890. endFrame(): void;
  36891. /**
  36892. * Resize the view according to the canvas' size
  36893. */
  36894. resize(): void;
  36895. /**
  36896. * Force a specific size of the canvas
  36897. * @param width defines the new canvas' width
  36898. * @param height defines the new canvas' height
  36899. * @returns true if the size was changed
  36900. */
  36901. setSize(width: number, height: number): boolean;
  36902. /**
  36903. * Binds the frame buffer to the specified texture.
  36904. * @param texture The texture to render to or null for the default canvas
  36905. * @param faceIndex The face of the texture to render to in case of cube texture
  36906. * @param requiredWidth The width of the target to render to
  36907. * @param requiredHeight The height of the target to render to
  36908. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  36909. * @param lodLevel defines the lod level to bind to the frame buffer
  36910. * @param layer defines the 2d array index to bind to frame buffer to
  36911. */
  36912. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean, lodLevel?: number, layer?: number): void;
  36913. /** @hidden */
  36914. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  36915. /**
  36916. * Unbind the current render target texture from the webGL context
  36917. * @param texture defines the render target texture to unbind
  36918. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  36919. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  36920. */
  36921. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  36922. /**
  36923. * Force a webGL flush (ie. a flush of all waiting webGL commands)
  36924. */
  36925. flushFramebuffer(): void;
  36926. /**
  36927. * Unbind the current render target and bind the default framebuffer
  36928. */
  36929. restoreDefaultFramebuffer(): void;
  36930. /** @hidden */
  36931. protected _resetVertexBufferBinding(): void;
  36932. /**
  36933. * Creates a vertex buffer
  36934. * @param data the data for the vertex buffer
  36935. * @returns the new WebGL static buffer
  36936. */
  36937. createVertexBuffer(data: DataArray): DataBuffer;
  36938. private _createVertexBuffer;
  36939. /**
  36940. * Creates a dynamic vertex buffer
  36941. * @param data the data for the dynamic vertex buffer
  36942. * @returns the new WebGL dynamic buffer
  36943. */
  36944. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  36945. protected _resetIndexBufferBinding(): void;
  36946. /**
  36947. * Creates a new index buffer
  36948. * @param indices defines the content of the index buffer
  36949. * @param updatable defines if the index buffer must be updatable
  36950. * @returns a new webGL buffer
  36951. */
  36952. createIndexBuffer(indices: IndicesArray, updatable?: boolean): DataBuffer;
  36953. protected _normalizeIndexData(indices: IndicesArray): Uint16Array | Uint32Array;
  36954. /**
  36955. * Bind a webGL buffer to the webGL context
  36956. * @param buffer defines the buffer to bind
  36957. */
  36958. bindArrayBuffer(buffer: Nullable<DataBuffer>): void;
  36959. protected bindIndexBuffer(buffer: Nullable<DataBuffer>): void;
  36960. private bindBuffer;
  36961. /**
  36962. * update the bound buffer with the given data
  36963. * @param data defines the data to update
  36964. */
  36965. updateArrayBuffer(data: Float32Array): void;
  36966. private _vertexAttribPointer;
  36967. /** @hidden */
  36968. _bindIndexBufferWithCache(indexBuffer: Nullable<DataBuffer>): void;
  36969. private _bindVertexBuffersAttributes;
  36970. /**
  36971. * Records a vertex array object
  36972. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  36973. * @param vertexBuffers defines the list of vertex buffers to store
  36974. * @param indexBuffer defines the index buffer to store
  36975. * @param effect defines the effect to store
  36976. * @returns the new vertex array object
  36977. */
  36978. recordVertexArrayObject(vertexBuffers: {
  36979. [key: string]: VertexBuffer;
  36980. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): WebGLVertexArrayObject;
  36981. /**
  36982. * Bind a specific vertex array object
  36983. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  36984. * @param vertexArrayObject defines the vertex array object to bind
  36985. * @param indexBuffer defines the index buffer to bind
  36986. */
  36987. bindVertexArrayObject(vertexArrayObject: WebGLVertexArrayObject, indexBuffer: Nullable<DataBuffer>): void;
  36988. /**
  36989. * Bind webGl buffers directly to the webGL context
  36990. * @param vertexBuffer defines the vertex buffer to bind
  36991. * @param indexBuffer defines the index buffer to bind
  36992. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  36993. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  36994. * @param effect defines the effect associated with the vertex buffer
  36995. */
  36996. bindBuffersDirectly(vertexBuffer: DataBuffer, indexBuffer: DataBuffer, vertexDeclaration: number[], vertexStrideSize: number, effect: Effect): void;
  36997. private _unbindVertexArrayObject;
  36998. /**
  36999. * Bind a list of vertex buffers to the webGL context
  37000. * @param vertexBuffers defines the list of vertex buffers to bind
  37001. * @param indexBuffer defines the index buffer to bind
  37002. * @param effect defines the effect associated with the vertex buffers
  37003. */
  37004. bindBuffers(vertexBuffers: {
  37005. [key: string]: Nullable<VertexBuffer>;
  37006. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): void;
  37007. /**
  37008. * Unbind all instance attributes
  37009. */
  37010. unbindInstanceAttributes(): void;
  37011. /**
  37012. * Release and free the memory of a vertex array object
  37013. * @param vao defines the vertex array object to delete
  37014. */
  37015. releaseVertexArrayObject(vao: WebGLVertexArrayObject): void;
  37016. /** @hidden */
  37017. _releaseBuffer(buffer: DataBuffer): boolean;
  37018. protected _deleteBuffer(buffer: DataBuffer): void;
  37019. /**
  37020. * Update the content of a webGL buffer used with instanciation and bind it to the webGL context
  37021. * @param instancesBuffer defines the webGL buffer to update and bind
  37022. * @param data defines the data to store in the buffer
  37023. * @param offsetLocations defines the offsets or attributes information used to determine where data must be stored in the buffer
  37024. */
  37025. updateAndBindInstancesBuffer(instancesBuffer: DataBuffer, data: Float32Array, offsetLocations: number[] | InstancingAttributeInfo[]): void;
  37026. /**
  37027. * Bind the content of a webGL buffer used with instantiation
  37028. * @param instancesBuffer defines the webGL buffer to bind
  37029. * @param attributesInfo defines the offsets or attributes information used to determine where data must be stored in the buffer
  37030. * @param computeStride defines Whether to compute the strides from the info or use the default 0
  37031. */
  37032. bindInstancesBuffer(instancesBuffer: DataBuffer, attributesInfo: InstancingAttributeInfo[], computeStride?: boolean): void;
  37033. /**
  37034. * Disable the instance attribute corresponding to the name in parameter
  37035. * @param name defines the name of the attribute to disable
  37036. */
  37037. disableInstanceAttributeByName(name: string): void;
  37038. /**
  37039. * Disable the instance attribute corresponding to the location in parameter
  37040. * @param attributeLocation defines the attribute location of the attribute to disable
  37041. */
  37042. disableInstanceAttribute(attributeLocation: number): void;
  37043. /**
  37044. * Disable the attribute corresponding to the location in parameter
  37045. * @param attributeLocation defines the attribute location of the attribute to disable
  37046. */
  37047. disableAttributeByIndex(attributeLocation: number): void;
  37048. /**
  37049. * Send a draw order
  37050. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  37051. * @param indexStart defines the starting index
  37052. * @param indexCount defines the number of index to draw
  37053. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  37054. */
  37055. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  37056. /**
  37057. * Draw a list of points
  37058. * @param verticesStart defines the index of first vertex to draw
  37059. * @param verticesCount defines the count of vertices to draw
  37060. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  37061. */
  37062. drawPointClouds(verticesStart: number, verticesCount: number, instancesCount?: number): void;
  37063. /**
  37064. * Draw a list of unindexed primitives
  37065. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  37066. * @param verticesStart defines the index of first vertex to draw
  37067. * @param verticesCount defines the count of vertices to draw
  37068. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  37069. */
  37070. drawUnIndexed(useTriangles: boolean, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  37071. /**
  37072. * Draw a list of indexed primitives
  37073. * @param fillMode defines the primitive to use
  37074. * @param indexStart defines the starting index
  37075. * @param indexCount defines the number of index to draw
  37076. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  37077. */
  37078. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  37079. /**
  37080. * Draw a list of unindexed primitives
  37081. * @param fillMode defines the primitive to use
  37082. * @param verticesStart defines the index of first vertex to draw
  37083. * @param verticesCount defines the count of vertices to draw
  37084. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  37085. */
  37086. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  37087. private _drawMode;
  37088. /** @hidden */
  37089. protected _reportDrawCall(): void;
  37090. /** @hidden */
  37091. _releaseEffect(effect: Effect): void;
  37092. /** @hidden */
  37093. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  37094. /**
  37095. * Create a new effect (used to store vertex/fragment shaders)
  37096. * @param baseName defines the base name of the effect (The name of file without .fragment.fx or .vertex.fx)
  37097. * @param attributesNamesOrOptions defines either a list of attribute names or an IEffectCreationOptions object
  37098. * @param uniformsNamesOrEngine defines either a list of uniform names or the engine to use
  37099. * @param samplers defines an array of string used to represent textures
  37100. * @param defines defines the string containing the defines to use to compile the shaders
  37101. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  37102. * @param onCompiled defines a function to call when the effect creation is successful
  37103. * @param onError defines a function to call when the effect creation has failed
  37104. * @param indexParameters defines an object containing the index values to use to compile shaders (like the maximum number of simultaneous lights)
  37105. * @returns the new Effect
  37106. */
  37107. 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;
  37108. protected static _ConcatenateShader(source: string, defines: Nullable<string>, shaderVersion?: string): string;
  37109. private _compileShader;
  37110. private _compileRawShader;
  37111. /** @hidden */
  37112. _getShaderSource(shader: WebGLShader): Nullable<string>;
  37113. /**
  37114. * Directly creates a webGL program
  37115. * @param pipelineContext defines the pipeline context to attach to
  37116. * @param vertexCode defines the vertex shader code to use
  37117. * @param fragmentCode defines the fragment shader code to use
  37118. * @param context defines the webGL context to use (if not set, the current one will be used)
  37119. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  37120. * @returns the new webGL program
  37121. */
  37122. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  37123. /**
  37124. * Creates a webGL program
  37125. * @param pipelineContext defines the pipeline context to attach to
  37126. * @param vertexCode defines the vertex shader code to use
  37127. * @param fragmentCode defines the fragment shader code to use
  37128. * @param defines defines the string containing the defines to use to compile the shaders
  37129. * @param context defines the webGL context to use (if not set, the current one will be used)
  37130. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  37131. * @returns the new webGL program
  37132. */
  37133. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  37134. /**
  37135. * Creates a new pipeline context
  37136. * @returns the new pipeline
  37137. */
  37138. createPipelineContext(): IPipelineContext;
  37139. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  37140. protected _finalizePipelineContext(pipelineContext: WebGLPipelineContext): void;
  37141. /** @hidden */
  37142. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  37143. /** @hidden */
  37144. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  37145. /** @hidden */
  37146. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  37147. /**
  37148. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  37149. * @param pipelineContext defines the pipeline context to use
  37150. * @param uniformsNames defines the list of uniform names
  37151. * @returns an array of webGL uniform locations
  37152. */
  37153. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  37154. /**
  37155. * Gets the lsit of active attributes for a given webGL program
  37156. * @param pipelineContext defines the pipeline context to use
  37157. * @param attributesNames defines the list of attribute names to get
  37158. * @returns an array of indices indicating the offset of each attribute
  37159. */
  37160. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  37161. /**
  37162. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  37163. * @param effect defines the effect to activate
  37164. */
  37165. enableEffect(effect: Nullable<Effect>): void;
  37166. /**
  37167. * Set the value of an uniform to a number (int)
  37168. * @param uniform defines the webGL uniform location where to store the value
  37169. * @param value defines the int number to store
  37170. */
  37171. setInt(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  37172. /**
  37173. * Set the value of an uniform to an array of int32
  37174. * @param uniform defines the webGL uniform location where to store the value
  37175. * @param array defines the array of int32 to store
  37176. */
  37177. setIntArray(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  37178. /**
  37179. * Set the value of an uniform to an array of int32 (stored as vec2)
  37180. * @param uniform defines the webGL uniform location where to store the value
  37181. * @param array defines the array of int32 to store
  37182. */
  37183. setIntArray2(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  37184. /**
  37185. * Set the value of an uniform to an array of int32 (stored as vec3)
  37186. * @param uniform defines the webGL uniform location where to store the value
  37187. * @param array defines the array of int32 to store
  37188. */
  37189. setIntArray3(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  37190. /**
  37191. * Set the value of an uniform to an array of int32 (stored as vec4)
  37192. * @param uniform defines the webGL uniform location where to store the value
  37193. * @param array defines the array of int32 to store
  37194. */
  37195. setIntArray4(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  37196. /**
  37197. * Set the value of an uniform to an array of number
  37198. * @param uniform defines the webGL uniform location where to store the value
  37199. * @param array defines the array of number to store
  37200. */
  37201. setArray(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  37202. /**
  37203. * Set the value of an uniform to an array of number (stored as vec2)
  37204. * @param uniform defines the webGL uniform location where to store the value
  37205. * @param array defines the array of number to store
  37206. */
  37207. setArray2(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  37208. /**
  37209. * Set the value of an uniform to an array of number (stored as vec3)
  37210. * @param uniform defines the webGL uniform location where to store the value
  37211. * @param array defines the array of number to store
  37212. */
  37213. setArray3(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  37214. /**
  37215. * Set the value of an uniform to an array of number (stored as vec4)
  37216. * @param uniform defines the webGL uniform location where to store the value
  37217. * @param array defines the array of number to store
  37218. */
  37219. setArray4(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  37220. /**
  37221. * Set the value of an uniform to an array of float32 (stored as matrices)
  37222. * @param uniform defines the webGL uniform location where to store the value
  37223. * @param matrices defines the array of float32 to store
  37224. */
  37225. setMatrices(uniform: Nullable<WebGLUniformLocation>, matrices: Float32Array): void;
  37226. /**
  37227. * Set the value of an uniform to a matrix (3x3)
  37228. * @param uniform defines the webGL uniform location where to store the value
  37229. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  37230. */
  37231. setMatrix3x3(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  37232. /**
  37233. * Set the value of an uniform to a matrix (2x2)
  37234. * @param uniform defines the webGL uniform location where to store the value
  37235. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  37236. */
  37237. setMatrix2x2(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  37238. /**
  37239. * Set the value of an uniform to a number (float)
  37240. * @param uniform defines the webGL uniform location where to store the value
  37241. * @param value defines the float number to store
  37242. */
  37243. setFloat(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  37244. /**
  37245. * Set the value of an uniform to a vec2
  37246. * @param uniform defines the webGL uniform location where to store the value
  37247. * @param x defines the 1st component of the value
  37248. * @param y defines the 2nd component of the value
  37249. */
  37250. setFloat2(uniform: Nullable<WebGLUniformLocation>, x: number, y: number): void;
  37251. /**
  37252. * Set the value of an uniform to a vec3
  37253. * @param uniform defines the webGL uniform location where to store the value
  37254. * @param x defines the 1st component of the value
  37255. * @param y defines the 2nd component of the value
  37256. * @param z defines the 3rd component of the value
  37257. */
  37258. setFloat3(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number): void;
  37259. /**
  37260. * Set the value of an uniform to a vec4
  37261. * @param uniform defines the webGL uniform location where to store the value
  37262. * @param x defines the 1st component of the value
  37263. * @param y defines the 2nd component of the value
  37264. * @param z defines the 3rd component of the value
  37265. * @param w defines the 4th component of the value
  37266. */
  37267. setFloat4(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number, w: number): void;
  37268. /**
  37269. * Apply all cached states (depth, culling, stencil and alpha)
  37270. */
  37271. applyStates(): void;
  37272. /**
  37273. * Enable or disable color writing
  37274. * @param enable defines the state to set
  37275. */
  37276. setColorWrite(enable: boolean): void;
  37277. /**
  37278. * Gets a boolean indicating if color writing is enabled
  37279. * @returns the current color writing state
  37280. */
  37281. getColorWrite(): boolean;
  37282. /**
  37283. * Gets the depth culling state manager
  37284. */
  37285. get depthCullingState(): DepthCullingState;
  37286. /**
  37287. * Gets the alpha state manager
  37288. */
  37289. get alphaState(): AlphaState;
  37290. /**
  37291. * Gets the stencil state manager
  37292. */
  37293. get stencilState(): StencilState;
  37294. /**
  37295. * Clears the list of texture accessible through engine.
  37296. * This can help preventing texture load conflict due to name collision.
  37297. */
  37298. clearInternalTexturesCache(): void;
  37299. /**
  37300. * Force the entire cache to be cleared
  37301. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  37302. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  37303. */
  37304. wipeCaches(bruteForce?: boolean): void;
  37305. /** @hidden */
  37306. _getSamplingParameters(samplingMode: number, generateMipMaps: boolean): {
  37307. min: number;
  37308. mag: number;
  37309. };
  37310. /** @hidden */
  37311. _createTexture(): WebGLTexture;
  37312. /**
  37313. * Usually called from Texture.ts.
  37314. * Passed information to create a WebGLTexture
  37315. * @param url defines a value which contains one of the following:
  37316. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  37317. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  37318. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  37319. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  37320. * @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)
  37321. * @param scene needed for loading to the correct scene
  37322. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  37323. * @param onLoad optional callback to be called upon successful completion
  37324. * @param onError optional callback to be called upon failure
  37325. * @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
  37326. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  37327. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  37328. * @param forcedExtension defines the extension to use to pick the right loader
  37329. * @param mimeType defines an optional mime type
  37330. * @returns a InternalTexture for assignment back into BABYLON.Texture
  37331. */
  37332. 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;
  37333. /**
  37334. * Loads an image as an HTMLImageElement.
  37335. * @param input url string, ArrayBuffer, or Blob to load
  37336. * @param onLoad callback called when the image successfully loads
  37337. * @param onError callback called when the image fails to load
  37338. * @param offlineProvider offline provider for caching
  37339. * @param mimeType optional mime type
  37340. * @returns the HTMLImageElement of the loaded image
  37341. * @hidden
  37342. */
  37343. 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>;
  37344. /**
  37345. * @hidden
  37346. */
  37347. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  37348. private _unpackFlipYCached;
  37349. /**
  37350. * In case you are sharing the context with other applications, it might
  37351. * be interested to not cache the unpack flip y state to ensure a consistent
  37352. * value would be set.
  37353. */
  37354. enableUnpackFlipYCached: boolean;
  37355. /** @hidden */
  37356. _unpackFlipY(value: boolean): void;
  37357. /** @hidden */
  37358. _getUnpackAlignement(): number;
  37359. private _getTextureTarget;
  37360. /**
  37361. * Update the sampling mode of a given texture
  37362. * @param samplingMode defines the required sampling mode
  37363. * @param texture defines the texture to update
  37364. * @param generateMipMaps defines whether to generate mipmaps for the texture
  37365. */
  37366. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture, generateMipMaps?: boolean): void;
  37367. /**
  37368. * Update the sampling mode of a given texture
  37369. * @param texture defines the texture to update
  37370. * @param wrapU defines the texture wrap mode of the u coordinates
  37371. * @param wrapV defines the texture wrap mode of the v coordinates
  37372. * @param wrapR defines the texture wrap mode of the r coordinates
  37373. */
  37374. updateTextureWrappingMode(texture: InternalTexture, wrapU: Nullable<number>, wrapV?: Nullable<number>, wrapR?: Nullable<number>): void;
  37375. /** @hidden */
  37376. _setupDepthStencilTexture(internalTexture: InternalTexture, size: number | {
  37377. width: number;
  37378. height: number;
  37379. layers?: number;
  37380. }, generateStencil: boolean, bilinearFiltering: boolean, comparisonFunction: number): void;
  37381. /** @hidden */
  37382. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  37383. /** @hidden */
  37384. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number, babylonInternalFormat?: number, useTextureWidthAndHeight?: boolean): void;
  37385. /**
  37386. * Update a portion of an internal texture
  37387. * @param texture defines the texture to update
  37388. * @param imageData defines the data to store into the texture
  37389. * @param xOffset defines the x coordinates of the update rectangle
  37390. * @param yOffset defines the y coordinates of the update rectangle
  37391. * @param width defines the width of the update rectangle
  37392. * @param height defines the height of the update rectangle
  37393. * @param faceIndex defines the face index if texture is a cube (0 by default)
  37394. * @param lod defines the lod level to update (0 by default)
  37395. */
  37396. updateTextureData(texture: InternalTexture, imageData: ArrayBufferView, xOffset: number, yOffset: number, width: number, height: number, faceIndex?: number, lod?: number): void;
  37397. /** @hidden */
  37398. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  37399. protected _prepareWebGLTextureContinuation(texture: InternalTexture, scene: Nullable<ISceneLike>, noMipmap: boolean, isCompressed: boolean, samplingMode: number): void;
  37400. private _prepareWebGLTexture;
  37401. /** @hidden */
  37402. _setupFramebufferDepthAttachments(generateStencilBuffer: boolean, generateDepthBuffer: boolean, width: number, height: number, samples?: number): Nullable<WebGLRenderbuffer>;
  37403. private _getDepthStencilBuffer;
  37404. /** @hidden */
  37405. _releaseFramebufferObjects(texture: InternalTexture): void;
  37406. /** @hidden */
  37407. _releaseTexture(texture: InternalTexture): void;
  37408. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  37409. protected _setProgram(program: WebGLProgram): void;
  37410. protected _boundUniforms: {
  37411. [key: number]: WebGLUniformLocation;
  37412. };
  37413. /**
  37414. * Binds an effect to the webGL context
  37415. * @param effect defines the effect to bind
  37416. */
  37417. bindSamplers(effect: Effect): void;
  37418. private _activateCurrentTexture;
  37419. /** @hidden */
  37420. _bindTextureDirectly(target: number, texture: Nullable<InternalTexture>, forTextureDataUpdate?: boolean, force?: boolean): boolean;
  37421. /** @hidden */
  37422. _bindTexture(channel: number, texture: Nullable<InternalTexture>): void;
  37423. /**
  37424. * Unbind all textures from the webGL context
  37425. */
  37426. unbindAllTextures(): void;
  37427. /**
  37428. * Sets a texture to the according uniform.
  37429. * @param channel The texture channel
  37430. * @param uniform The uniform to set
  37431. * @param texture The texture to apply
  37432. */
  37433. setTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<BaseTexture>): void;
  37434. private _bindSamplerUniformToChannel;
  37435. private _getTextureWrapMode;
  37436. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  37437. /**
  37438. * Sets an array of texture to the webGL context
  37439. * @param channel defines the channel where the texture array must be set
  37440. * @param uniform defines the associated uniform location
  37441. * @param textures defines the array of textures to bind
  37442. */
  37443. setTextureArray(channel: number, uniform: Nullable<WebGLUniformLocation>, textures: BaseTexture[]): void;
  37444. /** @hidden */
  37445. _setAnisotropicLevel(target: number, internalTexture: InternalTexture, anisotropicFilteringLevel: number): void;
  37446. private _setTextureParameterFloat;
  37447. private _setTextureParameterInteger;
  37448. /**
  37449. * Unbind all vertex attributes from the webGL context
  37450. */
  37451. unbindAllAttributes(): void;
  37452. /**
  37453. * 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
  37454. */
  37455. releaseEffects(): void;
  37456. /**
  37457. * Dispose and release all associated resources
  37458. */
  37459. dispose(): void;
  37460. /**
  37461. * Attach a new callback raised when context lost event is fired
  37462. * @param callback defines the callback to call
  37463. */
  37464. attachContextLostEvent(callback: ((event: WebGLContextEvent) => void)): void;
  37465. /**
  37466. * Attach a new callback raised when context restored event is fired
  37467. * @param callback defines the callback to call
  37468. */
  37469. attachContextRestoredEvent(callback: ((event: WebGLContextEvent) => void)): void;
  37470. /**
  37471. * Get the current error code of the webGL context
  37472. * @returns the error code
  37473. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  37474. */
  37475. getError(): number;
  37476. private _canRenderToFloatFramebuffer;
  37477. private _canRenderToHalfFloatFramebuffer;
  37478. private _canRenderToFramebuffer;
  37479. /** @hidden */
  37480. _getWebGLTextureType(type: number): number;
  37481. /** @hidden */
  37482. _getInternalFormat(format: number): number;
  37483. /** @hidden */
  37484. _getRGBABufferInternalSizedFormat(type: number, format?: number): number;
  37485. /** @hidden */
  37486. _getRGBAMultiSampleBufferFormat(type: number): number;
  37487. /** @hidden */
  37488. _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;
  37489. /**
  37490. * Loads a file from a url
  37491. * @param url url to load
  37492. * @param onSuccess callback called when the file successfully loads
  37493. * @param onProgress callback called while file is loading (if the server supports this mode)
  37494. * @param offlineProvider defines the offline provider for caching
  37495. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  37496. * @param onError callback called when the file fails to load
  37497. * @returns a file request object
  37498. * @hidden
  37499. */
  37500. 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;
  37501. /**
  37502. * Reads pixels from the current frame buffer. Please note that this function can be slow
  37503. * @param x defines the x coordinate of the rectangle where pixels must be read
  37504. * @param y defines the y coordinate of the rectangle where pixels must be read
  37505. * @param width defines the width of the rectangle where pixels must be read
  37506. * @param height defines the height of the rectangle where pixels must be read
  37507. * @param hasAlpha defines whether the output should have alpha or not (defaults to true)
  37508. * @returns a Uint8Array containing RGBA colors
  37509. */
  37510. readPixels(x: number, y: number, width: number, height: number, hasAlpha?: boolean): Uint8Array;
  37511. private static _isSupported;
  37512. /**
  37513. * Gets a boolean indicating if the engine can be instanciated (ie. if a webGL context can be found)
  37514. * @returns true if the engine can be created
  37515. * @ignorenaming
  37516. */
  37517. static isSupported(): boolean;
  37518. /**
  37519. * Find the next highest power of two.
  37520. * @param x Number to start search from.
  37521. * @return Next highest power of two.
  37522. */
  37523. static CeilingPOT(x: number): number;
  37524. /**
  37525. * Find the next lowest power of two.
  37526. * @param x Number to start search from.
  37527. * @return Next lowest power of two.
  37528. */
  37529. static FloorPOT(x: number): number;
  37530. /**
  37531. * Find the nearest power of two.
  37532. * @param x Number to start search from.
  37533. * @return Next nearest power of two.
  37534. */
  37535. static NearestPOT(x: number): number;
  37536. /**
  37537. * Get the closest exponent of two
  37538. * @param value defines the value to approximate
  37539. * @param max defines the maximum value to return
  37540. * @param mode defines how to define the closest value
  37541. * @returns closest exponent of two of the given value
  37542. */
  37543. static GetExponentOfTwo(value: number, max: number, mode?: number): number;
  37544. /**
  37545. * Queue a new function into the requested animation frame pool (ie. this function will be executed byt the browser for the next frame)
  37546. * @param func - the function to be called
  37547. * @param requester - the object that will request the next frame. Falls back to window.
  37548. * @returns frame number
  37549. */
  37550. static QueueNewFrame(func: () => void, requester?: any): number;
  37551. /**
  37552. * Gets host document
  37553. * @returns the host document object
  37554. */
  37555. getHostDocument(): Nullable<Document>;
  37556. }
  37557. }
  37558. declare module "babylonjs/Maths/sphericalPolynomial" {
  37559. import { Vector3 } from "babylonjs/Maths/math.vector";
  37560. import { Color3 } from "babylonjs/Maths/math.color";
  37561. /**
  37562. * Class representing spherical harmonics coefficients to the 3rd degree
  37563. */
  37564. export class SphericalHarmonics {
  37565. /**
  37566. * Defines whether or not the harmonics have been prescaled for rendering.
  37567. */
  37568. preScaled: boolean;
  37569. /**
  37570. * The l0,0 coefficients of the spherical harmonics
  37571. */
  37572. l00: Vector3;
  37573. /**
  37574. * The l1,-1 coefficients of the spherical harmonics
  37575. */
  37576. l1_1: Vector3;
  37577. /**
  37578. * The l1,0 coefficients of the spherical harmonics
  37579. */
  37580. l10: Vector3;
  37581. /**
  37582. * The l1,1 coefficients of the spherical harmonics
  37583. */
  37584. l11: Vector3;
  37585. /**
  37586. * The l2,-2 coefficients of the spherical harmonics
  37587. */
  37588. l2_2: Vector3;
  37589. /**
  37590. * The l2,-1 coefficients of the spherical harmonics
  37591. */
  37592. l2_1: Vector3;
  37593. /**
  37594. * The l2,0 coefficients of the spherical harmonics
  37595. */
  37596. l20: Vector3;
  37597. /**
  37598. * The l2,1 coefficients of the spherical harmonics
  37599. */
  37600. l21: Vector3;
  37601. /**
  37602. * The l2,2 coefficients of the spherical harmonics
  37603. */
  37604. l22: Vector3;
  37605. /**
  37606. * Adds a light to the spherical harmonics
  37607. * @param direction the direction of the light
  37608. * @param color the color of the light
  37609. * @param deltaSolidAngle the delta solid angle of the light
  37610. */
  37611. addLight(direction: Vector3, color: Color3, deltaSolidAngle: number): void;
  37612. /**
  37613. * Scales the spherical harmonics by the given amount
  37614. * @param scale the amount to scale
  37615. */
  37616. scaleInPlace(scale: number): void;
  37617. /**
  37618. * Convert from incident radiance (Li) to irradiance (E) by applying convolution with the cosine-weighted hemisphere.
  37619. *
  37620. * ```
  37621. * E_lm = A_l * L_lm
  37622. * ```
  37623. *
  37624. * In spherical harmonics this convolution amounts to scaling factors for each frequency band.
  37625. * This corresponds to equation 5 in "An Efficient Representation for Irradiance Environment Maps", where
  37626. * the scaling factors are given in equation 9.
  37627. */
  37628. convertIncidentRadianceToIrradiance(): void;
  37629. /**
  37630. * Convert from irradiance to outgoing radiance for Lambertian BDRF, suitable for efficient shader evaluation.
  37631. *
  37632. * ```
  37633. * L = (1/pi) * E * rho
  37634. * ```
  37635. *
  37636. * This is done by an additional scale by 1/pi, so is a fairly trivial operation but important conceptually.
  37637. */
  37638. convertIrradianceToLambertianRadiance(): void;
  37639. /**
  37640. * Integrates the reconstruction coefficients directly in to the SH preventing further
  37641. * required operations at run time.
  37642. *
  37643. * This is simply done by scaling back the SH with Ylm constants parameter.
  37644. * The trigonometric part being applied by the shader at run time.
  37645. */
  37646. preScaleForRendering(): void;
  37647. /**
  37648. * Constructs a spherical harmonics from an array.
  37649. * @param data defines the 9x3 coefficients (l00, l1-1, l10, l11, l2-2, l2-1, l20, l21, l22)
  37650. * @returns the spherical harmonics
  37651. */
  37652. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalHarmonics;
  37653. /**
  37654. * Gets the spherical harmonics from polynomial
  37655. * @param polynomial the spherical polynomial
  37656. * @returns the spherical harmonics
  37657. */
  37658. static FromPolynomial(polynomial: SphericalPolynomial): SphericalHarmonics;
  37659. }
  37660. /**
  37661. * Class representing spherical polynomial coefficients to the 3rd degree
  37662. */
  37663. export class SphericalPolynomial {
  37664. private _harmonics;
  37665. /**
  37666. * The spherical harmonics used to create the polynomials.
  37667. */
  37668. get preScaledHarmonics(): SphericalHarmonics;
  37669. /**
  37670. * The x coefficients of the spherical polynomial
  37671. */
  37672. x: Vector3;
  37673. /**
  37674. * The y coefficients of the spherical polynomial
  37675. */
  37676. y: Vector3;
  37677. /**
  37678. * The z coefficients of the spherical polynomial
  37679. */
  37680. z: Vector3;
  37681. /**
  37682. * The xx coefficients of the spherical polynomial
  37683. */
  37684. xx: Vector3;
  37685. /**
  37686. * The yy coefficients of the spherical polynomial
  37687. */
  37688. yy: Vector3;
  37689. /**
  37690. * The zz coefficients of the spherical polynomial
  37691. */
  37692. zz: Vector3;
  37693. /**
  37694. * The xy coefficients of the spherical polynomial
  37695. */
  37696. xy: Vector3;
  37697. /**
  37698. * The yz coefficients of the spherical polynomial
  37699. */
  37700. yz: Vector3;
  37701. /**
  37702. * The zx coefficients of the spherical polynomial
  37703. */
  37704. zx: Vector3;
  37705. /**
  37706. * Adds an ambient color to the spherical polynomial
  37707. * @param color the color to add
  37708. */
  37709. addAmbient(color: Color3): void;
  37710. /**
  37711. * Scales the spherical polynomial by the given amount
  37712. * @param scale the amount to scale
  37713. */
  37714. scaleInPlace(scale: number): void;
  37715. /**
  37716. * Gets the spherical polynomial from harmonics
  37717. * @param harmonics the spherical harmonics
  37718. * @returns the spherical polynomial
  37719. */
  37720. static FromHarmonics(harmonics: SphericalHarmonics): SphericalPolynomial;
  37721. /**
  37722. * Constructs a spherical polynomial from an array.
  37723. * @param data defines the 9x3 coefficients (x, y, z, xx, yy, zz, yz, zx, xy)
  37724. * @returns the spherical polynomial
  37725. */
  37726. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalPolynomial;
  37727. }
  37728. }
  37729. declare module "babylonjs/Materials/Textures/internalTexture" {
  37730. import { Observable } from "babylonjs/Misc/observable";
  37731. import { Nullable, int } from "babylonjs/types";
  37732. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  37733. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  37734. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  37735. /**
  37736. * Defines the source of the internal texture
  37737. */
  37738. export enum InternalTextureSource {
  37739. /**
  37740. * The source of the texture data is unknown
  37741. */
  37742. Unknown = 0,
  37743. /**
  37744. * Texture data comes from an URL
  37745. */
  37746. Url = 1,
  37747. /**
  37748. * Texture data is only used for temporary storage
  37749. */
  37750. Temp = 2,
  37751. /**
  37752. * Texture data comes from raw data (ArrayBuffer)
  37753. */
  37754. Raw = 3,
  37755. /**
  37756. * Texture content is dynamic (video or dynamic texture)
  37757. */
  37758. Dynamic = 4,
  37759. /**
  37760. * Texture content is generated by rendering to it
  37761. */
  37762. RenderTarget = 5,
  37763. /**
  37764. * Texture content is part of a multi render target process
  37765. */
  37766. MultiRenderTarget = 6,
  37767. /**
  37768. * Texture data comes from a cube data file
  37769. */
  37770. Cube = 7,
  37771. /**
  37772. * Texture data comes from a raw cube data
  37773. */
  37774. CubeRaw = 8,
  37775. /**
  37776. * Texture data come from a prefiltered cube data file
  37777. */
  37778. CubePrefiltered = 9,
  37779. /**
  37780. * Texture content is raw 3D data
  37781. */
  37782. Raw3D = 10,
  37783. /**
  37784. * Texture content is raw 2D array data
  37785. */
  37786. Raw2DArray = 11,
  37787. /**
  37788. * Texture content is a depth texture
  37789. */
  37790. Depth = 12,
  37791. /**
  37792. * Texture data comes from a raw cube data encoded with RGBD
  37793. */
  37794. CubeRawRGBD = 13
  37795. }
  37796. /**
  37797. * Class used to store data associated with WebGL texture data for the engine
  37798. * This class should not be used directly
  37799. */
  37800. export class InternalTexture {
  37801. /** @hidden */
  37802. static _UpdateRGBDAsync: (internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number) => Promise<void>;
  37803. /**
  37804. * Defines if the texture is ready
  37805. */
  37806. isReady: boolean;
  37807. /**
  37808. * Defines if the texture is a cube texture
  37809. */
  37810. isCube: boolean;
  37811. /**
  37812. * Defines if the texture contains 3D data
  37813. */
  37814. is3D: boolean;
  37815. /**
  37816. * Defines if the texture contains 2D array data
  37817. */
  37818. is2DArray: boolean;
  37819. /**
  37820. * Defines if the texture contains multiview data
  37821. */
  37822. isMultiview: boolean;
  37823. /**
  37824. * Gets the URL used to load this texture
  37825. */
  37826. url: string;
  37827. /**
  37828. * Gets the sampling mode of the texture
  37829. */
  37830. samplingMode: number;
  37831. /**
  37832. * Gets a boolean indicating if the texture needs mipmaps generation
  37833. */
  37834. generateMipMaps: boolean;
  37835. /**
  37836. * Gets the number of samples used by the texture (WebGL2+ only)
  37837. */
  37838. samples: number;
  37839. /**
  37840. * Gets the type of the texture (int, float...)
  37841. */
  37842. type: number;
  37843. /**
  37844. * Gets the format of the texture (RGB, RGBA...)
  37845. */
  37846. format: number;
  37847. /**
  37848. * Observable called when the texture is loaded
  37849. */
  37850. onLoadedObservable: Observable<InternalTexture>;
  37851. /**
  37852. * Gets the width of the texture
  37853. */
  37854. width: number;
  37855. /**
  37856. * Gets the height of the texture
  37857. */
  37858. height: number;
  37859. /**
  37860. * Gets the depth of the texture
  37861. */
  37862. depth: number;
  37863. /**
  37864. * Gets the initial width of the texture (It could be rescaled if the current system does not support non power of two textures)
  37865. */
  37866. baseWidth: number;
  37867. /**
  37868. * Gets the initial height of the texture (It could be rescaled if the current system does not support non power of two textures)
  37869. */
  37870. baseHeight: number;
  37871. /**
  37872. * Gets the initial depth of the texture (It could be rescaled if the current system does not support non power of two textures)
  37873. */
  37874. baseDepth: number;
  37875. /**
  37876. * Gets a boolean indicating if the texture is inverted on Y axis
  37877. */
  37878. invertY: boolean;
  37879. /** @hidden */
  37880. _invertVScale: boolean;
  37881. /** @hidden */
  37882. _associatedChannel: number;
  37883. /** @hidden */
  37884. _source: InternalTextureSource;
  37885. /** @hidden */
  37886. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  37887. /** @hidden */
  37888. _bufferView: Nullable<ArrayBufferView>;
  37889. /** @hidden */
  37890. _bufferViewArray: Nullable<ArrayBufferView[]>;
  37891. /** @hidden */
  37892. _bufferViewArrayArray: Nullable<ArrayBufferView[][]>;
  37893. /** @hidden */
  37894. _size: number;
  37895. /** @hidden */
  37896. _extension: string;
  37897. /** @hidden */
  37898. _files: Nullable<string[]>;
  37899. /** @hidden */
  37900. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  37901. /** @hidden */
  37902. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  37903. /** @hidden */
  37904. _framebuffer: Nullable<WebGLFramebuffer>;
  37905. /** @hidden */
  37906. _depthStencilBuffer: Nullable<WebGLRenderbuffer>;
  37907. /** @hidden */
  37908. _MSAAFramebuffer: Nullable<WebGLFramebuffer>;
  37909. /** @hidden */
  37910. _MSAARenderBuffer: Nullable<WebGLRenderbuffer>;
  37911. /** @hidden */
  37912. _attachments: Nullable<number[]>;
  37913. /** @hidden */
  37914. _textureArray: Nullable<InternalTexture[]>;
  37915. /** @hidden */
  37916. _cachedCoordinatesMode: Nullable<number>;
  37917. /** @hidden */
  37918. _cachedWrapU: Nullable<number>;
  37919. /** @hidden */
  37920. _cachedWrapV: Nullable<number>;
  37921. /** @hidden */
  37922. _cachedWrapR: Nullable<number>;
  37923. /** @hidden */
  37924. _cachedAnisotropicFilteringLevel: Nullable<number>;
  37925. /** @hidden */
  37926. _isDisabled: boolean;
  37927. /** @hidden */
  37928. _compression: Nullable<string>;
  37929. /** @hidden */
  37930. _generateStencilBuffer: boolean;
  37931. /** @hidden */
  37932. _generateDepthBuffer: boolean;
  37933. /** @hidden */
  37934. _comparisonFunction: number;
  37935. /** @hidden */
  37936. _sphericalPolynomial: Nullable<SphericalPolynomial>;
  37937. /** @hidden */
  37938. _lodGenerationScale: number;
  37939. /** @hidden */
  37940. _lodGenerationOffset: number;
  37941. /** @hidden */
  37942. _depthStencilTexture: Nullable<InternalTexture>;
  37943. /** @hidden */
  37944. _colorTextureArray: Nullable<WebGLTexture>;
  37945. /** @hidden */
  37946. _depthStencilTextureArray: Nullable<WebGLTexture>;
  37947. /** @hidden */
  37948. _lodTextureHigh: Nullable<BaseTexture>;
  37949. /** @hidden */
  37950. _lodTextureMid: Nullable<BaseTexture>;
  37951. /** @hidden */
  37952. _lodTextureLow: Nullable<BaseTexture>;
  37953. /** @hidden */
  37954. _isRGBD: boolean;
  37955. /** @hidden */
  37956. _linearSpecularLOD: boolean;
  37957. /** @hidden */
  37958. _irradianceTexture: Nullable<BaseTexture>;
  37959. /** @hidden */
  37960. _webGLTexture: Nullable<WebGLTexture>;
  37961. /** @hidden */
  37962. _references: number;
  37963. /** @hidden */
  37964. _gammaSpace: Nullable<boolean>;
  37965. private _engine;
  37966. /**
  37967. * Gets the Engine the texture belongs to.
  37968. * @returns The babylon engine
  37969. */
  37970. getEngine(): ThinEngine;
  37971. /**
  37972. * Gets the data source type of the texture
  37973. */
  37974. get source(): InternalTextureSource;
  37975. /**
  37976. * Creates a new InternalTexture
  37977. * @param engine defines the engine to use
  37978. * @param source defines the type of data that will be used
  37979. * @param delayAllocation if the texture allocation should be delayed (default: false)
  37980. */
  37981. constructor(engine: ThinEngine, source: InternalTextureSource, delayAllocation?: boolean);
  37982. /**
  37983. * Increments the number of references (ie. the number of Texture that point to it)
  37984. */
  37985. incrementReferences(): void;
  37986. /**
  37987. * Change the size of the texture (not the size of the content)
  37988. * @param width defines the new width
  37989. * @param height defines the new height
  37990. * @param depth defines the new depth (1 by default)
  37991. */
  37992. updateSize(width: int, height: int, depth?: int): void;
  37993. /** @hidden */
  37994. _rebuild(): void;
  37995. /** @hidden */
  37996. _swapAndDie(target: InternalTexture): void;
  37997. /**
  37998. * Dispose the current allocated resources
  37999. */
  38000. dispose(): void;
  38001. }
  38002. }
  38003. declare module "babylonjs/Audio/analyser" {
  38004. import { Scene } from "babylonjs/scene";
  38005. /**
  38006. * Class used to work with sound analyzer using fast fourier transform (FFT)
  38007. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  38008. */
  38009. export class Analyser {
  38010. /**
  38011. * Gets or sets the smoothing
  38012. * @ignorenaming
  38013. */
  38014. SMOOTHING: number;
  38015. /**
  38016. * Gets or sets the FFT table size
  38017. * @ignorenaming
  38018. */
  38019. FFT_SIZE: number;
  38020. /**
  38021. * Gets or sets the bar graph amplitude
  38022. * @ignorenaming
  38023. */
  38024. BARGRAPHAMPLITUDE: number;
  38025. /**
  38026. * Gets or sets the position of the debug canvas
  38027. * @ignorenaming
  38028. */
  38029. DEBUGCANVASPOS: {
  38030. x: number;
  38031. y: number;
  38032. };
  38033. /**
  38034. * Gets or sets the debug canvas size
  38035. * @ignorenaming
  38036. */
  38037. DEBUGCANVASSIZE: {
  38038. width: number;
  38039. height: number;
  38040. };
  38041. private _byteFreqs;
  38042. private _byteTime;
  38043. private _floatFreqs;
  38044. private _webAudioAnalyser;
  38045. private _debugCanvas;
  38046. private _debugCanvasContext;
  38047. private _scene;
  38048. private _registerFunc;
  38049. private _audioEngine;
  38050. /**
  38051. * Creates a new analyser
  38052. * @param scene defines hosting scene
  38053. */
  38054. constructor(scene: Scene);
  38055. /**
  38056. * Get the number of data values you will have to play with for the visualization
  38057. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/frequencyBinCount
  38058. * @returns a number
  38059. */
  38060. getFrequencyBinCount(): number;
  38061. /**
  38062. * Gets the current frequency data as a byte array
  38063. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  38064. * @returns a Uint8Array
  38065. */
  38066. getByteFrequencyData(): Uint8Array;
  38067. /**
  38068. * Gets the current waveform as a byte array
  38069. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteTimeDomainData
  38070. * @returns a Uint8Array
  38071. */
  38072. getByteTimeDomainData(): Uint8Array;
  38073. /**
  38074. * Gets the current frequency data as a float array
  38075. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  38076. * @returns a Float32Array
  38077. */
  38078. getFloatFrequencyData(): Float32Array;
  38079. /**
  38080. * Renders the debug canvas
  38081. */
  38082. drawDebugCanvas(): void;
  38083. /**
  38084. * Stops rendering the debug canvas and removes it
  38085. */
  38086. stopDebugCanvas(): void;
  38087. /**
  38088. * Connects two audio nodes
  38089. * @param inputAudioNode defines first node to connect
  38090. * @param outputAudioNode defines second node to connect
  38091. */
  38092. connectAudioNodes(inputAudioNode: AudioNode, outputAudioNode: AudioNode): void;
  38093. /**
  38094. * Releases all associated resources
  38095. */
  38096. dispose(): void;
  38097. }
  38098. }
  38099. declare module "babylonjs/Audio/audioEngine" {
  38100. import { IDisposable } from "babylonjs/scene";
  38101. import { Analyser } from "babylonjs/Audio/analyser";
  38102. import { Nullable } from "babylonjs/types";
  38103. import { Observable } from "babylonjs/Misc/observable";
  38104. /**
  38105. * This represents an audio engine and it is responsible
  38106. * to play, synchronize and analyse sounds throughout the application.
  38107. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  38108. */
  38109. export interface IAudioEngine extends IDisposable {
  38110. /**
  38111. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  38112. */
  38113. readonly canUseWebAudio: boolean;
  38114. /**
  38115. * Gets the current AudioContext if available.
  38116. */
  38117. readonly audioContext: Nullable<AudioContext>;
  38118. /**
  38119. * The master gain node defines the global audio volume of your audio engine.
  38120. */
  38121. readonly masterGain: GainNode;
  38122. /**
  38123. * Gets whether or not mp3 are supported by your browser.
  38124. */
  38125. readonly isMP3supported: boolean;
  38126. /**
  38127. * Gets whether or not ogg are supported by your browser.
  38128. */
  38129. readonly isOGGsupported: boolean;
  38130. /**
  38131. * Defines if Babylon should emit a warning if WebAudio is not supported.
  38132. * @ignoreNaming
  38133. */
  38134. WarnedWebAudioUnsupported: boolean;
  38135. /**
  38136. * Defines if the audio engine relies on a custom unlocked button.
  38137. * In this case, the embedded button will not be displayed.
  38138. */
  38139. useCustomUnlockedButton: boolean;
  38140. /**
  38141. * Gets whether or not the audio engine is unlocked (require first a user gesture on some browser).
  38142. */
  38143. readonly unlocked: boolean;
  38144. /**
  38145. * Event raised when audio has been unlocked on the browser.
  38146. */
  38147. onAudioUnlockedObservable: Observable<AudioEngine>;
  38148. /**
  38149. * Event raised when audio has been locked on the browser.
  38150. */
  38151. onAudioLockedObservable: Observable<AudioEngine>;
  38152. /**
  38153. * Flags the audio engine in Locked state.
  38154. * This happens due to new browser policies preventing audio to autoplay.
  38155. */
  38156. lock(): void;
  38157. /**
  38158. * Unlocks the audio engine once a user action has been done on the dom.
  38159. * This is helpful to resume play once browser policies have been satisfied.
  38160. */
  38161. unlock(): void;
  38162. /**
  38163. * Gets the global volume sets on the master gain.
  38164. * @returns the global volume if set or -1 otherwise
  38165. */
  38166. getGlobalVolume(): number;
  38167. /**
  38168. * Sets the global volume of your experience (sets on the master gain).
  38169. * @param newVolume Defines the new global volume of the application
  38170. */
  38171. setGlobalVolume(newVolume: number): void;
  38172. /**
  38173. * Connect the audio engine to an audio analyser allowing some amazing
  38174. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  38175. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  38176. * @param analyser The analyser to connect to the engine
  38177. */
  38178. connectToAnalyser(analyser: Analyser): void;
  38179. }
  38180. /**
  38181. * This represents the default audio engine used in babylon.
  38182. * It is responsible to play, synchronize and analyse sounds throughout the application.
  38183. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  38184. */
  38185. export class AudioEngine implements IAudioEngine {
  38186. private _audioContext;
  38187. private _audioContextInitialized;
  38188. private _muteButton;
  38189. private _hostElement;
  38190. /**
  38191. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  38192. */
  38193. canUseWebAudio: boolean;
  38194. /**
  38195. * The master gain node defines the global audio volume of your audio engine.
  38196. */
  38197. masterGain: GainNode;
  38198. /**
  38199. * Defines if Babylon should emit a warning if WebAudio is not supported.
  38200. * @ignoreNaming
  38201. */
  38202. WarnedWebAudioUnsupported: boolean;
  38203. /**
  38204. * Gets whether or not mp3 are supported by your browser.
  38205. */
  38206. isMP3supported: boolean;
  38207. /**
  38208. * Gets whether or not ogg are supported by your browser.
  38209. */
  38210. isOGGsupported: boolean;
  38211. /**
  38212. * Gets whether audio has been unlocked on the device.
  38213. * Some Browsers have strong restrictions about Audio and won t autoplay unless
  38214. * a user interaction has happened.
  38215. */
  38216. unlocked: boolean;
  38217. /**
  38218. * Defines if the audio engine relies on a custom unlocked button.
  38219. * In this case, the embedded button will not be displayed.
  38220. */
  38221. useCustomUnlockedButton: boolean;
  38222. /**
  38223. * Event raised when audio has been unlocked on the browser.
  38224. */
  38225. onAudioUnlockedObservable: Observable<AudioEngine>;
  38226. /**
  38227. * Event raised when audio has been locked on the browser.
  38228. */
  38229. onAudioLockedObservable: Observable<AudioEngine>;
  38230. /**
  38231. * Gets the current AudioContext if available.
  38232. */
  38233. get audioContext(): Nullable<AudioContext>;
  38234. private _connectedAnalyser;
  38235. /**
  38236. * Instantiates a new audio engine.
  38237. *
  38238. * There should be only one per page as some browsers restrict the number
  38239. * of audio contexts you can create.
  38240. * @param hostElement defines the host element where to display the mute icon if necessary
  38241. */
  38242. constructor(hostElement?: Nullable<HTMLElement>);
  38243. /**
  38244. * Flags the audio engine in Locked state.
  38245. * This happens due to new browser policies preventing audio to autoplay.
  38246. */
  38247. lock(): void;
  38248. /**
  38249. * Unlocks the audio engine once a user action has been done on the dom.
  38250. * This is helpful to resume play once browser policies have been satisfied.
  38251. */
  38252. unlock(): void;
  38253. private _resumeAudioContext;
  38254. private _initializeAudioContext;
  38255. private _tryToRun;
  38256. private _triggerRunningState;
  38257. private _triggerSuspendedState;
  38258. private _displayMuteButton;
  38259. private _moveButtonToTopLeft;
  38260. private _onResize;
  38261. private _hideMuteButton;
  38262. /**
  38263. * Destroy and release the resources associated with the audio ccontext.
  38264. */
  38265. dispose(): void;
  38266. /**
  38267. * Gets the global volume sets on the master gain.
  38268. * @returns the global volume if set or -1 otherwise
  38269. */
  38270. getGlobalVolume(): number;
  38271. /**
  38272. * Sets the global volume of your experience (sets on the master gain).
  38273. * @param newVolume Defines the new global volume of the application
  38274. */
  38275. setGlobalVolume(newVolume: number): void;
  38276. /**
  38277. * Connect the audio engine to an audio analyser allowing some amazing
  38278. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  38279. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  38280. * @param analyser The analyser to connect to the engine
  38281. */
  38282. connectToAnalyser(analyser: Analyser): void;
  38283. }
  38284. }
  38285. declare module "babylonjs/Loading/loadingScreen" {
  38286. /**
  38287. * Interface used to present a loading screen while loading a scene
  38288. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  38289. */
  38290. export interface ILoadingScreen {
  38291. /**
  38292. * Function called to display the loading screen
  38293. */
  38294. displayLoadingUI: () => void;
  38295. /**
  38296. * Function called to hide the loading screen
  38297. */
  38298. hideLoadingUI: () => void;
  38299. /**
  38300. * Gets or sets the color to use for the background
  38301. */
  38302. loadingUIBackgroundColor: string;
  38303. /**
  38304. * Gets or sets the text to display while loading
  38305. */
  38306. loadingUIText: string;
  38307. }
  38308. /**
  38309. * Class used for the default loading screen
  38310. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  38311. */
  38312. export class DefaultLoadingScreen implements ILoadingScreen {
  38313. private _renderingCanvas;
  38314. private _loadingText;
  38315. private _loadingDivBackgroundColor;
  38316. private _loadingDiv;
  38317. private _loadingTextDiv;
  38318. /** Gets or sets the logo url to use for the default loading screen */
  38319. static DefaultLogoUrl: string;
  38320. /** Gets or sets the spinner url to use for the default loading screen */
  38321. static DefaultSpinnerUrl: string;
  38322. /**
  38323. * Creates a new default loading screen
  38324. * @param _renderingCanvas defines the canvas used to render the scene
  38325. * @param _loadingText defines the default text to display
  38326. * @param _loadingDivBackgroundColor defines the default background color
  38327. */
  38328. constructor(_renderingCanvas: HTMLCanvasElement, _loadingText?: string, _loadingDivBackgroundColor?: string);
  38329. /**
  38330. * Function called to display the loading screen
  38331. */
  38332. displayLoadingUI(): void;
  38333. /**
  38334. * Function called to hide the loading screen
  38335. */
  38336. hideLoadingUI(): void;
  38337. /**
  38338. * Gets or sets the text to display while loading
  38339. */
  38340. set loadingUIText(text: string);
  38341. get loadingUIText(): string;
  38342. /**
  38343. * Gets or sets the color to use for the background
  38344. */
  38345. get loadingUIBackgroundColor(): string;
  38346. set loadingUIBackgroundColor(color: string);
  38347. private _resizeLoadingUI;
  38348. }
  38349. }
  38350. declare module "babylonjs/Misc/customAnimationFrameRequester" {
  38351. /**
  38352. * Interface for any object that can request an animation frame
  38353. */
  38354. export interface ICustomAnimationFrameRequester {
  38355. /**
  38356. * This function will be called when the render loop is ready. If this is not populated, the engine's renderloop function will be called
  38357. */
  38358. renderFunction?: Function;
  38359. /**
  38360. * Called to request the next frame to render to
  38361. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame
  38362. */
  38363. requestAnimationFrame: Function;
  38364. /**
  38365. * You can pass this value to cancelAnimationFrame() to cancel the refresh callback request
  38366. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame#Return_value
  38367. */
  38368. requestID?: number;
  38369. }
  38370. }
  38371. declare module "babylonjs/Misc/performanceMonitor" {
  38372. /**
  38373. * Performance monitor tracks rolling average frame-time and frame-time variance over a user defined sliding-window
  38374. */
  38375. export class PerformanceMonitor {
  38376. private _enabled;
  38377. private _rollingFrameTime;
  38378. private _lastFrameTimeMs;
  38379. /**
  38380. * constructor
  38381. * @param frameSampleSize The number of samples required to saturate the sliding window
  38382. */
  38383. constructor(frameSampleSize?: number);
  38384. /**
  38385. * Samples current frame
  38386. * @param timeMs A timestamp in milliseconds of the current frame to compare with other frames
  38387. */
  38388. sampleFrame(timeMs?: number): void;
  38389. /**
  38390. * Returns the average frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  38391. */
  38392. get averageFrameTime(): number;
  38393. /**
  38394. * Returns the variance frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  38395. */
  38396. get averageFrameTimeVariance(): number;
  38397. /**
  38398. * Returns the frame time of the most recent frame
  38399. */
  38400. get instantaneousFrameTime(): number;
  38401. /**
  38402. * Returns the average framerate in frames per second over the sliding window (or the subset of frames sampled so far)
  38403. */
  38404. get averageFPS(): number;
  38405. /**
  38406. * Returns the average framerate in frames per second using the most recent frame time
  38407. */
  38408. get instantaneousFPS(): number;
  38409. /**
  38410. * Returns true if enough samples have been taken to completely fill the sliding window
  38411. */
  38412. get isSaturated(): boolean;
  38413. /**
  38414. * Enables contributions to the sliding window sample set
  38415. */
  38416. enable(): void;
  38417. /**
  38418. * Disables contributions to the sliding window sample set
  38419. * Samples will not be interpolated over the disabled period
  38420. */
  38421. disable(): void;
  38422. /**
  38423. * Returns true if sampling is enabled
  38424. */
  38425. get isEnabled(): boolean;
  38426. /**
  38427. * Resets performance monitor
  38428. */
  38429. reset(): void;
  38430. }
  38431. /**
  38432. * RollingAverage
  38433. *
  38434. * Utility to efficiently compute the rolling average and variance over a sliding window of samples
  38435. */
  38436. export class RollingAverage {
  38437. /**
  38438. * Current average
  38439. */
  38440. average: number;
  38441. /**
  38442. * Current variance
  38443. */
  38444. variance: number;
  38445. protected _samples: Array<number>;
  38446. protected _sampleCount: number;
  38447. protected _pos: number;
  38448. protected _m2: number;
  38449. /**
  38450. * constructor
  38451. * @param length The number of samples required to saturate the sliding window
  38452. */
  38453. constructor(length: number);
  38454. /**
  38455. * Adds a sample to the sample set
  38456. * @param v The sample value
  38457. */
  38458. add(v: number): void;
  38459. /**
  38460. * Returns previously added values or null if outside of history or outside the sliding window domain
  38461. * @param i Index in history. For example, pass 0 for the most recent value and 1 for the value before that
  38462. * @return Value previously recorded with add() or null if outside of range
  38463. */
  38464. history(i: number): number;
  38465. /**
  38466. * Returns true if enough samples have been taken to completely fill the sliding window
  38467. * @return true if sample-set saturated
  38468. */
  38469. isSaturated(): boolean;
  38470. /**
  38471. * Resets the rolling average (equivalent to 0 samples taken so far)
  38472. */
  38473. reset(): void;
  38474. /**
  38475. * Wraps a value around the sample range boundaries
  38476. * @param i Position in sample range, for example if the sample length is 5, and i is -3, then 2 will be returned.
  38477. * @return Wrapped position in sample range
  38478. */
  38479. protected _wrapPosition(i: number): number;
  38480. }
  38481. }
  38482. declare module "babylonjs/Misc/perfCounter" {
  38483. /**
  38484. * This class is used to track a performance counter which is number based.
  38485. * The user has access to many properties which give statistics of different nature.
  38486. *
  38487. * The implementer can track two kinds of Performance Counter: time and count.
  38488. * 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.
  38489. * 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.
  38490. */
  38491. export class PerfCounter {
  38492. /**
  38493. * Gets or sets a global boolean to turn on and off all the counters
  38494. */
  38495. static Enabled: boolean;
  38496. /**
  38497. * Returns the smallest value ever
  38498. */
  38499. get min(): number;
  38500. /**
  38501. * Returns the biggest value ever
  38502. */
  38503. get max(): number;
  38504. /**
  38505. * Returns the average value since the performance counter is running
  38506. */
  38507. get average(): number;
  38508. /**
  38509. * Returns the average value of the last second the counter was monitored
  38510. */
  38511. get lastSecAverage(): number;
  38512. /**
  38513. * Returns the current value
  38514. */
  38515. get current(): number;
  38516. /**
  38517. * Gets the accumulated total
  38518. */
  38519. get total(): number;
  38520. /**
  38521. * Gets the total value count
  38522. */
  38523. get count(): number;
  38524. /**
  38525. * Creates a new counter
  38526. */
  38527. constructor();
  38528. /**
  38529. * Call this method to start monitoring a new frame.
  38530. * 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.
  38531. */
  38532. fetchNewFrame(): void;
  38533. /**
  38534. * Call this method to monitor a count of something (e.g. mesh drawn in viewport count)
  38535. * @param newCount the count value to add to the monitored count
  38536. * @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.
  38537. */
  38538. addCount(newCount: number, fetchResult: boolean): void;
  38539. /**
  38540. * Start monitoring this performance counter
  38541. */
  38542. beginMonitoring(): void;
  38543. /**
  38544. * Compute the time lapsed since the previous beginMonitoring() call.
  38545. * @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
  38546. */
  38547. endMonitoring(newFrame?: boolean): void;
  38548. private _fetchResult;
  38549. private _startMonitoringTime;
  38550. private _min;
  38551. private _max;
  38552. private _average;
  38553. private _current;
  38554. private _totalValueCount;
  38555. private _totalAccumulated;
  38556. private _lastSecAverage;
  38557. private _lastSecAccumulated;
  38558. private _lastSecTime;
  38559. private _lastSecValueCount;
  38560. }
  38561. }
  38562. declare module "babylonjs/Engines/Extensions/engine.readTexture" {
  38563. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  38564. import { Nullable } from "babylonjs/types";
  38565. module "babylonjs/Engines/thinEngine" {
  38566. interface ThinEngine {
  38567. /** @hidden */
  38568. _readTexturePixels(texture: InternalTexture, width: number, height: number, faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): ArrayBufferView;
  38569. }
  38570. }
  38571. }
  38572. declare module "babylonjs/Engines/engine" {
  38573. import { Observable } from "babylonjs/Misc/observable";
  38574. import { Nullable } from "babylonjs/types";
  38575. import { Scene } from "babylonjs/scene";
  38576. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  38577. import { IAudioEngine } from "babylonjs/Audio/audioEngine";
  38578. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  38579. import { ILoadingScreen } from "babylonjs/Loading/loadingScreen";
  38580. import { WebGLPipelineContext } from "babylonjs/Engines/WebGL/webGLPipelineContext";
  38581. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  38582. import { ICustomAnimationFrameRequester } from "babylonjs/Misc/customAnimationFrameRequester";
  38583. import { ThinEngine, EngineOptions } from "babylonjs/Engines/thinEngine";
  38584. import { IViewportLike, IColor4Like } from "babylonjs/Maths/math.like";
  38585. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  38586. import { PerformanceMonitor } from "babylonjs/Misc/performanceMonitor";
  38587. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  38588. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  38589. import "babylonjs/Engines/Extensions/engine.alpha";
  38590. import "babylonjs/Engines/Extensions/engine.readTexture";
  38591. import "babylonjs/Engines/Extensions/engine.dynamicBuffer";
  38592. import { Material } from "babylonjs/Materials/material";
  38593. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  38594. /**
  38595. * Defines the interface used by display changed events
  38596. */
  38597. export interface IDisplayChangedEventArgs {
  38598. /** Gets the vrDisplay object (if any) */
  38599. vrDisplay: Nullable<any>;
  38600. /** Gets a boolean indicating if webVR is supported */
  38601. vrSupported: boolean;
  38602. }
  38603. /**
  38604. * Defines the interface used by objects containing a viewport (like a camera)
  38605. */
  38606. interface IViewportOwnerLike {
  38607. /**
  38608. * Gets or sets the viewport
  38609. */
  38610. viewport: IViewportLike;
  38611. }
  38612. /**
  38613. * The engine class is responsible for interfacing with all lower-level APIs such as WebGL and Audio
  38614. */
  38615. export class Engine extends ThinEngine {
  38616. /** Defines that alpha blending is disabled */
  38617. static readonly ALPHA_DISABLE: number;
  38618. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  38619. static readonly ALPHA_ADD: number;
  38620. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  38621. static readonly ALPHA_COMBINE: number;
  38622. /** Defines that alpha blending to DEST - SRC * DEST */
  38623. static readonly ALPHA_SUBTRACT: number;
  38624. /** Defines that alpha blending to SRC * DEST */
  38625. static readonly ALPHA_MULTIPLY: number;
  38626. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  38627. static readonly ALPHA_MAXIMIZED: number;
  38628. /** Defines that alpha blending to SRC + DEST */
  38629. static readonly ALPHA_ONEONE: number;
  38630. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  38631. static readonly ALPHA_PREMULTIPLIED: number;
  38632. /**
  38633. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  38634. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  38635. */
  38636. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  38637. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  38638. static readonly ALPHA_INTERPOLATE: number;
  38639. /**
  38640. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  38641. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  38642. */
  38643. static readonly ALPHA_SCREENMODE: number;
  38644. /** Defines that the ressource is not delayed*/
  38645. static readonly DELAYLOADSTATE_NONE: number;
  38646. /** Defines that the ressource was successfully delay loaded */
  38647. static readonly DELAYLOADSTATE_LOADED: number;
  38648. /** Defines that the ressource is currently delay loading */
  38649. static readonly DELAYLOADSTATE_LOADING: number;
  38650. /** Defines that the ressource is delayed and has not started loading */
  38651. static readonly DELAYLOADSTATE_NOTLOADED: number;
  38652. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  38653. static readonly NEVER: number;
  38654. /** 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 */
  38655. static readonly ALWAYS: number;
  38656. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  38657. static readonly LESS: number;
  38658. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  38659. static readonly EQUAL: number;
  38660. /** 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 */
  38661. static readonly LEQUAL: number;
  38662. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  38663. static readonly GREATER: number;
  38664. /** 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 */
  38665. static readonly GEQUAL: number;
  38666. /** 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 */
  38667. static readonly NOTEQUAL: number;
  38668. /** Passed to stencilOperation to specify that stencil value must be kept */
  38669. static readonly KEEP: number;
  38670. /** Passed to stencilOperation to specify that stencil value must be replaced */
  38671. static readonly REPLACE: number;
  38672. /** Passed to stencilOperation to specify that stencil value must be incremented */
  38673. static readonly INCR: number;
  38674. /** Passed to stencilOperation to specify that stencil value must be decremented */
  38675. static readonly DECR: number;
  38676. /** Passed to stencilOperation to specify that stencil value must be inverted */
  38677. static readonly INVERT: number;
  38678. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  38679. static readonly INCR_WRAP: number;
  38680. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  38681. static readonly DECR_WRAP: number;
  38682. /** Texture is not repeating outside of 0..1 UVs */
  38683. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  38684. /** Texture is repeating outside of 0..1 UVs */
  38685. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  38686. /** Texture is repeating and mirrored */
  38687. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  38688. /** ALPHA */
  38689. static readonly TEXTUREFORMAT_ALPHA: number;
  38690. /** LUMINANCE */
  38691. static readonly TEXTUREFORMAT_LUMINANCE: number;
  38692. /** LUMINANCE_ALPHA */
  38693. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  38694. /** RGB */
  38695. static readonly TEXTUREFORMAT_RGB: number;
  38696. /** RGBA */
  38697. static readonly TEXTUREFORMAT_RGBA: number;
  38698. /** RED */
  38699. static readonly TEXTUREFORMAT_RED: number;
  38700. /** RED (2nd reference) */
  38701. static readonly TEXTUREFORMAT_R: number;
  38702. /** RG */
  38703. static readonly TEXTUREFORMAT_RG: number;
  38704. /** RED_INTEGER */
  38705. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  38706. /** RED_INTEGER (2nd reference) */
  38707. static readonly TEXTUREFORMAT_R_INTEGER: number;
  38708. /** RG_INTEGER */
  38709. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  38710. /** RGB_INTEGER */
  38711. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  38712. /** RGBA_INTEGER */
  38713. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  38714. /** UNSIGNED_BYTE */
  38715. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  38716. /** UNSIGNED_BYTE (2nd reference) */
  38717. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  38718. /** FLOAT */
  38719. static readonly TEXTURETYPE_FLOAT: number;
  38720. /** HALF_FLOAT */
  38721. static readonly TEXTURETYPE_HALF_FLOAT: number;
  38722. /** BYTE */
  38723. static readonly TEXTURETYPE_BYTE: number;
  38724. /** SHORT */
  38725. static readonly TEXTURETYPE_SHORT: number;
  38726. /** UNSIGNED_SHORT */
  38727. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  38728. /** INT */
  38729. static readonly TEXTURETYPE_INT: number;
  38730. /** UNSIGNED_INT */
  38731. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  38732. /** UNSIGNED_SHORT_4_4_4_4 */
  38733. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  38734. /** UNSIGNED_SHORT_5_5_5_1 */
  38735. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  38736. /** UNSIGNED_SHORT_5_6_5 */
  38737. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  38738. /** UNSIGNED_INT_2_10_10_10_REV */
  38739. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  38740. /** UNSIGNED_INT_24_8 */
  38741. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  38742. /** UNSIGNED_INT_10F_11F_11F_REV */
  38743. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  38744. /** UNSIGNED_INT_5_9_9_9_REV */
  38745. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  38746. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  38747. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  38748. /** nearest is mag = nearest and min = nearest and mip = linear */
  38749. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  38750. /** Bilinear is mag = linear and min = linear and mip = nearest */
  38751. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  38752. /** Trilinear is mag = linear and min = linear and mip = linear */
  38753. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  38754. /** nearest is mag = nearest and min = nearest and mip = linear */
  38755. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  38756. /** Bilinear is mag = linear and min = linear and mip = nearest */
  38757. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  38758. /** Trilinear is mag = linear and min = linear and mip = linear */
  38759. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  38760. /** mag = nearest and min = nearest and mip = nearest */
  38761. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  38762. /** mag = nearest and min = linear and mip = nearest */
  38763. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  38764. /** mag = nearest and min = linear and mip = linear */
  38765. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  38766. /** mag = nearest and min = linear and mip = none */
  38767. static readonly TEXTURE_NEAREST_LINEAR: number;
  38768. /** mag = nearest and min = nearest and mip = none */
  38769. static readonly TEXTURE_NEAREST_NEAREST: number;
  38770. /** mag = linear and min = nearest and mip = nearest */
  38771. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  38772. /** mag = linear and min = nearest and mip = linear */
  38773. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  38774. /** mag = linear and min = linear and mip = none */
  38775. static readonly TEXTURE_LINEAR_LINEAR: number;
  38776. /** mag = linear and min = nearest and mip = none */
  38777. static readonly TEXTURE_LINEAR_NEAREST: number;
  38778. /** Explicit coordinates mode */
  38779. static readonly TEXTURE_EXPLICIT_MODE: number;
  38780. /** Spherical coordinates mode */
  38781. static readonly TEXTURE_SPHERICAL_MODE: number;
  38782. /** Planar coordinates mode */
  38783. static readonly TEXTURE_PLANAR_MODE: number;
  38784. /** Cubic coordinates mode */
  38785. static readonly TEXTURE_CUBIC_MODE: number;
  38786. /** Projection coordinates mode */
  38787. static readonly TEXTURE_PROJECTION_MODE: number;
  38788. /** Skybox coordinates mode */
  38789. static readonly TEXTURE_SKYBOX_MODE: number;
  38790. /** Inverse Cubic coordinates mode */
  38791. static readonly TEXTURE_INVCUBIC_MODE: number;
  38792. /** Equirectangular coordinates mode */
  38793. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  38794. /** Equirectangular Fixed coordinates mode */
  38795. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  38796. /** Equirectangular Fixed Mirrored coordinates mode */
  38797. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  38798. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  38799. static readonly SCALEMODE_FLOOR: number;
  38800. /** Defines that texture rescaling will look for the nearest power of 2 size */
  38801. static readonly SCALEMODE_NEAREST: number;
  38802. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  38803. static readonly SCALEMODE_CEILING: number;
  38804. /**
  38805. * Returns the current npm package of the sdk
  38806. */
  38807. static get NpmPackage(): string;
  38808. /**
  38809. * Returns the current version of the framework
  38810. */
  38811. static get Version(): string;
  38812. /** Gets the list of created engines */
  38813. static get Instances(): Engine[];
  38814. /**
  38815. * Gets the latest created engine
  38816. */
  38817. static get LastCreatedEngine(): Nullable<Engine>;
  38818. /**
  38819. * Gets the latest created scene
  38820. */
  38821. static get LastCreatedScene(): Nullable<Scene>;
  38822. /**
  38823. * Will flag all materials in all scenes in all engines as dirty to trigger new shader compilation
  38824. * @param flag defines which part of the materials must be marked as dirty
  38825. * @param predicate defines a predicate used to filter which materials should be affected
  38826. */
  38827. static MarkAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  38828. /**
  38829. * Method called to create the default loading screen.
  38830. * This can be overriden in your own app.
  38831. * @param canvas The rendering canvas element
  38832. * @returns The loading screen
  38833. */
  38834. static DefaultLoadingScreenFactory(canvas: HTMLCanvasElement): ILoadingScreen;
  38835. /**
  38836. * Method called to create the default rescale post process on each engine.
  38837. */
  38838. static _RescalePostProcessFactory: Nullable<(engine: Engine) => PostProcess>;
  38839. /**
  38840. * Gets or sets a boolean to enable/disable IndexedDB support and avoid XHR on .manifest
  38841. **/
  38842. enableOfflineSupport: boolean;
  38843. /**
  38844. * 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)
  38845. **/
  38846. disableManifestCheck: boolean;
  38847. /**
  38848. * Gets the list of created scenes
  38849. */
  38850. scenes: Scene[];
  38851. /**
  38852. * Event raised when a new scene is created
  38853. */
  38854. onNewSceneAddedObservable: Observable<Scene>;
  38855. /**
  38856. * Gets the list of created postprocesses
  38857. */
  38858. postProcesses: import("babylonjs/PostProcesses/postProcess").PostProcess[];
  38859. /**
  38860. * Gets a boolean indicating if the pointer is currently locked
  38861. */
  38862. isPointerLock: boolean;
  38863. /**
  38864. * Observable event triggered each time the rendering canvas is resized
  38865. */
  38866. onResizeObservable: Observable<Engine>;
  38867. /**
  38868. * Observable event triggered each time the canvas loses focus
  38869. */
  38870. onCanvasBlurObservable: Observable<Engine>;
  38871. /**
  38872. * Observable event triggered each time the canvas gains focus
  38873. */
  38874. onCanvasFocusObservable: Observable<Engine>;
  38875. /**
  38876. * Observable event triggered each time the canvas receives pointerout event
  38877. */
  38878. onCanvasPointerOutObservable: Observable<PointerEvent>;
  38879. /**
  38880. * Observable raised when the engine begins a new frame
  38881. */
  38882. onBeginFrameObservable: Observable<Engine>;
  38883. /**
  38884. * If set, will be used to request the next animation frame for the render loop
  38885. */
  38886. customAnimationFrameRequester: Nullable<ICustomAnimationFrameRequester>;
  38887. /**
  38888. * Observable raised when the engine ends the current frame
  38889. */
  38890. onEndFrameObservable: Observable<Engine>;
  38891. /**
  38892. * Observable raised when the engine is about to compile a shader
  38893. */
  38894. onBeforeShaderCompilationObservable: Observable<Engine>;
  38895. /**
  38896. * Observable raised when the engine has jsut compiled a shader
  38897. */
  38898. onAfterShaderCompilationObservable: Observable<Engine>;
  38899. /**
  38900. * Gets the audio engine
  38901. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  38902. * @ignorenaming
  38903. */
  38904. static audioEngine: IAudioEngine;
  38905. /**
  38906. * Default AudioEngine factory responsible of creating the Audio Engine.
  38907. * By default, this will create a BabylonJS Audio Engine if the workload has been embedded.
  38908. */
  38909. static AudioEngineFactory: (hostElement: Nullable<HTMLElement>) => IAudioEngine;
  38910. /**
  38911. * Default offline support factory responsible of creating a tool used to store data locally.
  38912. * By default, this will create a Database object if the workload has been embedded.
  38913. */
  38914. static OfflineProviderFactory: (urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck: boolean) => IOfflineProvider;
  38915. private _loadingScreen;
  38916. private _pointerLockRequested;
  38917. private _rescalePostProcess;
  38918. private _deterministicLockstep;
  38919. private _lockstepMaxSteps;
  38920. private _timeStep;
  38921. protected get _supportsHardwareTextureRescaling(): boolean;
  38922. private _fps;
  38923. private _deltaTime;
  38924. /** @hidden */
  38925. _drawCalls: PerfCounter;
  38926. /** 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 */
  38927. canvasTabIndex: number;
  38928. /**
  38929. * Turn this value on if you want to pause FPS computation when in background
  38930. */
  38931. disablePerformanceMonitorInBackground: boolean;
  38932. private _performanceMonitor;
  38933. /**
  38934. * Gets the performance monitor attached to this engine
  38935. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  38936. */
  38937. get performanceMonitor(): PerformanceMonitor;
  38938. private _onFocus;
  38939. private _onBlur;
  38940. private _onCanvasPointerOut;
  38941. private _onCanvasBlur;
  38942. private _onCanvasFocus;
  38943. private _onFullscreenChange;
  38944. private _onPointerLockChange;
  38945. /**
  38946. * Gets the HTML element used to attach event listeners
  38947. * @returns a HTML element
  38948. */
  38949. getInputElement(): Nullable<HTMLElement>;
  38950. /**
  38951. * Creates a new engine
  38952. * @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
  38953. * @param antialias defines enable antialiasing (default: false)
  38954. * @param options defines further options to be sent to the getContext() function
  38955. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  38956. */
  38957. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  38958. /**
  38959. * Gets current aspect ratio
  38960. * @param viewportOwner defines the camera to use to get the aspect ratio
  38961. * @param useScreen defines if screen size must be used (or the current render target if any)
  38962. * @returns a number defining the aspect ratio
  38963. */
  38964. getAspectRatio(viewportOwner: IViewportOwnerLike, useScreen?: boolean): number;
  38965. /**
  38966. * Gets current screen aspect ratio
  38967. * @returns a number defining the aspect ratio
  38968. */
  38969. getScreenAspectRatio(): number;
  38970. /**
  38971. * Gets the client rect of the HTML canvas attached with the current webGL context
  38972. * @returns a client rectanglee
  38973. */
  38974. getRenderingCanvasClientRect(): Nullable<ClientRect>;
  38975. /**
  38976. * Gets the client rect of the HTML element used for events
  38977. * @returns a client rectanglee
  38978. */
  38979. getInputElementClientRect(): Nullable<ClientRect>;
  38980. /**
  38981. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  38982. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  38983. * @returns true if engine is in deterministic lock step mode
  38984. */
  38985. isDeterministicLockStep(): boolean;
  38986. /**
  38987. * Gets the max steps when engine is running in deterministic lock step
  38988. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  38989. * @returns the max steps
  38990. */
  38991. getLockstepMaxSteps(): number;
  38992. /**
  38993. * Returns the time in ms between steps when using deterministic lock step.
  38994. * @returns time step in (ms)
  38995. */
  38996. getTimeStep(): number;
  38997. /**
  38998. * Force the mipmap generation for the given render target texture
  38999. * @param texture defines the render target texture to use
  39000. * @param unbind defines whether or not to unbind the texture after generation. Defaults to true.
  39001. */
  39002. generateMipMapsForCubemap(texture: InternalTexture, unbind?: boolean): void;
  39003. /** States */
  39004. /**
  39005. * Set various states to the webGL context
  39006. * @param culling defines backface culling state
  39007. * @param zOffset defines the value to apply to zOffset (0 by default)
  39008. * @param force defines if states must be applied even if cache is up to date
  39009. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  39010. */
  39011. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  39012. /**
  39013. * Set the z offset to apply to current rendering
  39014. * @param value defines the offset to apply
  39015. */
  39016. setZOffset(value: number): void;
  39017. /**
  39018. * Gets the current value of the zOffset
  39019. * @returns the current zOffset state
  39020. */
  39021. getZOffset(): number;
  39022. /**
  39023. * Enable or disable depth buffering
  39024. * @param enable defines the state to set
  39025. */
  39026. setDepthBuffer(enable: boolean): void;
  39027. /**
  39028. * Gets a boolean indicating if depth writing is enabled
  39029. * @returns the current depth writing state
  39030. */
  39031. getDepthWrite(): boolean;
  39032. /**
  39033. * Enable or disable depth writing
  39034. * @param enable defines the state to set
  39035. */
  39036. setDepthWrite(enable: boolean): void;
  39037. /**
  39038. * Gets a boolean indicating if stencil buffer is enabled
  39039. * @returns the current stencil buffer state
  39040. */
  39041. getStencilBuffer(): boolean;
  39042. /**
  39043. * Enable or disable the stencil buffer
  39044. * @param enable defines if the stencil buffer must be enabled or disabled
  39045. */
  39046. setStencilBuffer(enable: boolean): void;
  39047. /**
  39048. * Gets the current stencil mask
  39049. * @returns a number defining the new stencil mask to use
  39050. */
  39051. getStencilMask(): number;
  39052. /**
  39053. * Sets the current stencil mask
  39054. * @param mask defines the new stencil mask to use
  39055. */
  39056. setStencilMask(mask: number): void;
  39057. /**
  39058. * Gets the current stencil function
  39059. * @returns a number defining the stencil function to use
  39060. */
  39061. getStencilFunction(): number;
  39062. /**
  39063. * Gets the current stencil reference value
  39064. * @returns a number defining the stencil reference value to use
  39065. */
  39066. getStencilFunctionReference(): number;
  39067. /**
  39068. * Gets the current stencil mask
  39069. * @returns a number defining the stencil mask to use
  39070. */
  39071. getStencilFunctionMask(): number;
  39072. /**
  39073. * Sets the current stencil function
  39074. * @param stencilFunc defines the new stencil function to use
  39075. */
  39076. setStencilFunction(stencilFunc: number): void;
  39077. /**
  39078. * Sets the current stencil reference
  39079. * @param reference defines the new stencil reference to use
  39080. */
  39081. setStencilFunctionReference(reference: number): void;
  39082. /**
  39083. * Sets the current stencil mask
  39084. * @param mask defines the new stencil mask to use
  39085. */
  39086. setStencilFunctionMask(mask: number): void;
  39087. /**
  39088. * Gets the current stencil operation when stencil fails
  39089. * @returns a number defining stencil operation to use when stencil fails
  39090. */
  39091. getStencilOperationFail(): number;
  39092. /**
  39093. * Gets the current stencil operation when depth fails
  39094. * @returns a number defining stencil operation to use when depth fails
  39095. */
  39096. getStencilOperationDepthFail(): number;
  39097. /**
  39098. * Gets the current stencil operation when stencil passes
  39099. * @returns a number defining stencil operation to use when stencil passes
  39100. */
  39101. getStencilOperationPass(): number;
  39102. /**
  39103. * Sets the stencil operation to use when stencil fails
  39104. * @param operation defines the stencil operation to use when stencil fails
  39105. */
  39106. setStencilOperationFail(operation: number): void;
  39107. /**
  39108. * Sets the stencil operation to use when depth fails
  39109. * @param operation defines the stencil operation to use when depth fails
  39110. */
  39111. setStencilOperationDepthFail(operation: number): void;
  39112. /**
  39113. * Sets the stencil operation to use when stencil passes
  39114. * @param operation defines the stencil operation to use when stencil passes
  39115. */
  39116. setStencilOperationPass(operation: number): void;
  39117. /**
  39118. * Sets a boolean indicating if the dithering state is enabled or disabled
  39119. * @param value defines the dithering state
  39120. */
  39121. setDitheringState(value: boolean): void;
  39122. /**
  39123. * Sets a boolean indicating if the rasterizer state is enabled or disabled
  39124. * @param value defines the rasterizer state
  39125. */
  39126. setRasterizerState(value: boolean): void;
  39127. /**
  39128. * Gets the current depth function
  39129. * @returns a number defining the depth function
  39130. */
  39131. getDepthFunction(): Nullable<number>;
  39132. /**
  39133. * Sets the current depth function
  39134. * @param depthFunc defines the function to use
  39135. */
  39136. setDepthFunction(depthFunc: number): void;
  39137. /**
  39138. * Sets the current depth function to GREATER
  39139. */
  39140. setDepthFunctionToGreater(): void;
  39141. /**
  39142. * Sets the current depth function to GEQUAL
  39143. */
  39144. setDepthFunctionToGreaterOrEqual(): void;
  39145. /**
  39146. * Sets the current depth function to LESS
  39147. */
  39148. setDepthFunctionToLess(): void;
  39149. /**
  39150. * Sets the current depth function to LEQUAL
  39151. */
  39152. setDepthFunctionToLessOrEqual(): void;
  39153. private _cachedStencilBuffer;
  39154. private _cachedStencilFunction;
  39155. private _cachedStencilMask;
  39156. private _cachedStencilOperationPass;
  39157. private _cachedStencilOperationFail;
  39158. private _cachedStencilOperationDepthFail;
  39159. private _cachedStencilReference;
  39160. /**
  39161. * Caches the the state of the stencil buffer
  39162. */
  39163. cacheStencilState(): void;
  39164. /**
  39165. * Restores the state of the stencil buffer
  39166. */
  39167. restoreStencilState(): void;
  39168. /**
  39169. * Directly set the WebGL Viewport
  39170. * @param x defines the x coordinate of the viewport (in screen space)
  39171. * @param y defines the y coordinate of the viewport (in screen space)
  39172. * @param width defines the width of the viewport (in screen space)
  39173. * @param height defines the height of the viewport (in screen space)
  39174. * @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
  39175. */
  39176. setDirectViewport(x: number, y: number, width: number, height: number): Nullable<IViewportLike>;
  39177. /**
  39178. * Executes a scissor clear (ie. a clear on a specific portion of the screen)
  39179. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  39180. * @param y defines the y-coordinate of the corner of the clear rectangle
  39181. * @param width defines the width of the clear rectangle
  39182. * @param height defines the height of the clear rectangle
  39183. * @param clearColor defines the clear color
  39184. */
  39185. scissorClear(x: number, y: number, width: number, height: number, clearColor: IColor4Like): void;
  39186. /**
  39187. * Enable scissor test on a specific rectangle (ie. render will only be executed on a specific portion of the screen)
  39188. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  39189. * @param y defines the y-coordinate of the corner of the clear rectangle
  39190. * @param width defines the width of the clear rectangle
  39191. * @param height defines the height of the clear rectangle
  39192. */
  39193. enableScissor(x: number, y: number, width: number, height: number): void;
  39194. /**
  39195. * Disable previously set scissor test rectangle
  39196. */
  39197. disableScissor(): void;
  39198. protected _reportDrawCall(): void;
  39199. /**
  39200. * Initializes a webVR display and starts listening to display change events
  39201. * The onVRDisplayChangedObservable will be notified upon these changes
  39202. * @returns The onVRDisplayChangedObservable
  39203. */
  39204. initWebVR(): Observable<IDisplayChangedEventArgs>;
  39205. /** @hidden */
  39206. _prepareVRComponent(): void;
  39207. /** @hidden */
  39208. _connectVREvents(canvas?: HTMLCanvasElement, document?: any): void;
  39209. /** @hidden */
  39210. _submitVRFrame(): void;
  39211. /**
  39212. * Call this function to leave webVR mode
  39213. * Will do nothing if webVR is not supported or if there is no webVR device
  39214. * @see https://doc.babylonjs.com/how_to/webvr_camera
  39215. */
  39216. disableVR(): void;
  39217. /**
  39218. * Gets a boolean indicating that the system is in VR mode and is presenting
  39219. * @returns true if VR mode is engaged
  39220. */
  39221. isVRPresenting(): boolean;
  39222. /** @hidden */
  39223. _requestVRFrame(): void;
  39224. /** @hidden */
  39225. _loadFileAsync(url: string, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  39226. /**
  39227. * Gets the source code of the vertex shader associated with a specific webGL program
  39228. * @param program defines the program to use
  39229. * @returns a string containing the source code of the vertex shader associated with the program
  39230. */
  39231. getVertexShaderSource(program: WebGLProgram): Nullable<string>;
  39232. /**
  39233. * Gets the source code of the fragment shader associated with a specific webGL program
  39234. * @param program defines the program to use
  39235. * @returns a string containing the source code of the fragment shader associated with the program
  39236. */
  39237. getFragmentShaderSource(program: WebGLProgram): Nullable<string>;
  39238. /**
  39239. * Sets a depth stencil texture from a render target to the according uniform.
  39240. * @param channel The texture channel
  39241. * @param uniform The uniform to set
  39242. * @param texture The render target texture containing the depth stencil texture to apply
  39243. */
  39244. setDepthStencilTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<RenderTargetTexture>): void;
  39245. /**
  39246. * Sets a texture to the webGL context from a postprocess
  39247. * @param channel defines the channel to use
  39248. * @param postProcess defines the source postprocess
  39249. */
  39250. setTextureFromPostProcess(channel: number, postProcess: Nullable<PostProcess>): void;
  39251. /**
  39252. * Binds the output of the passed in post process to the texture channel specified
  39253. * @param channel The channel the texture should be bound to
  39254. * @param postProcess The post process which's output should be bound
  39255. */
  39256. setTextureFromPostProcessOutput(channel: number, postProcess: Nullable<PostProcess>): void;
  39257. protected _rebuildBuffers(): void;
  39258. /** @hidden */
  39259. _renderFrame(): void;
  39260. _renderLoop(): void;
  39261. /** @hidden */
  39262. _renderViews(): boolean;
  39263. /**
  39264. * Toggle full screen mode
  39265. * @param requestPointerLock defines if a pointer lock should be requested from the user
  39266. */
  39267. switchFullscreen(requestPointerLock: boolean): void;
  39268. /**
  39269. * Enters full screen mode
  39270. * @param requestPointerLock defines if a pointer lock should be requested from the user
  39271. */
  39272. enterFullscreen(requestPointerLock: boolean): void;
  39273. /**
  39274. * Exits full screen mode
  39275. */
  39276. exitFullscreen(): void;
  39277. /**
  39278. * Enters Pointerlock mode
  39279. */
  39280. enterPointerlock(): void;
  39281. /**
  39282. * Exits Pointerlock mode
  39283. */
  39284. exitPointerlock(): void;
  39285. /**
  39286. * Begin a new frame
  39287. */
  39288. beginFrame(): void;
  39289. /**
  39290. * Enf the current frame
  39291. */
  39292. endFrame(): void;
  39293. resize(): void;
  39294. /**
  39295. * Force a specific size of the canvas
  39296. * @param width defines the new canvas' width
  39297. * @param height defines the new canvas' height
  39298. * @returns true if the size was changed
  39299. */
  39300. setSize(width: number, height: number): boolean;
  39301. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  39302. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  39303. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  39304. _releaseTexture(texture: InternalTexture): void;
  39305. /**
  39306. * @hidden
  39307. * Rescales a texture
  39308. * @param source input texutre
  39309. * @param destination destination texture
  39310. * @param scene scene to use to render the resize
  39311. * @param internalFormat format to use when resizing
  39312. * @param onComplete callback to be called when resize has completed
  39313. */
  39314. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  39315. /**
  39316. * Gets the current framerate
  39317. * @returns a number representing the framerate
  39318. */
  39319. getFps(): number;
  39320. /**
  39321. * Gets the time spent between current and previous frame
  39322. * @returns a number representing the delta time in ms
  39323. */
  39324. getDeltaTime(): number;
  39325. private _measureFps;
  39326. /** @hidden */
  39327. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement | ImageBitmap, faceIndex?: number, lod?: number): void;
  39328. /**
  39329. * Updates the sample count of a render target texture
  39330. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  39331. * @param texture defines the texture to update
  39332. * @param samples defines the sample count to set
  39333. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  39334. */
  39335. updateRenderTargetTextureSampleCount(texture: Nullable<InternalTexture>, samples: number): number;
  39336. /**
  39337. * Updates a depth texture Comparison Mode and Function.
  39338. * If the comparison Function is equal to 0, the mode will be set to none.
  39339. * Otherwise, this only works in webgl 2 and requires a shadow sampler in the shader.
  39340. * @param texture The texture to set the comparison function for
  39341. * @param comparisonFunction The comparison function to set, 0 if no comparison required
  39342. */
  39343. updateTextureComparisonFunction(texture: InternalTexture, comparisonFunction: number): void;
  39344. /**
  39345. * Creates a webGL buffer to use with instanciation
  39346. * @param capacity defines the size of the buffer
  39347. * @returns the webGL buffer
  39348. */
  39349. createInstancesBuffer(capacity: number): DataBuffer;
  39350. /**
  39351. * Delete a webGL buffer used with instanciation
  39352. * @param buffer defines the webGL buffer to delete
  39353. */
  39354. deleteInstancesBuffer(buffer: WebGLBuffer): void;
  39355. private _clientWaitAsync;
  39356. /** @hidden */
  39357. _readPixelsAsync(x: number, y: number, w: number, h: number, format: number, type: number, outputBuffer: ArrayBufferView): Promise<ArrayBufferView> | null;
  39358. dispose(): void;
  39359. private _disableTouchAction;
  39360. /**
  39361. * Display the loading screen
  39362. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39363. */
  39364. displayLoadingUI(): void;
  39365. /**
  39366. * Hide the loading screen
  39367. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39368. */
  39369. hideLoadingUI(): void;
  39370. /**
  39371. * Gets the current loading screen object
  39372. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39373. */
  39374. get loadingScreen(): ILoadingScreen;
  39375. /**
  39376. * Sets the current loading screen object
  39377. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39378. */
  39379. set loadingScreen(loadingScreen: ILoadingScreen);
  39380. /**
  39381. * Sets the current loading screen text
  39382. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39383. */
  39384. set loadingUIText(text: string);
  39385. /**
  39386. * Sets the current loading screen background color
  39387. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39388. */
  39389. set loadingUIBackgroundColor(color: string);
  39390. /** Pointerlock and fullscreen */
  39391. /**
  39392. * Ask the browser to promote the current element to pointerlock mode
  39393. * @param element defines the DOM element to promote
  39394. */
  39395. static _RequestPointerlock(element: HTMLElement): void;
  39396. /**
  39397. * Asks the browser to exit pointerlock mode
  39398. */
  39399. static _ExitPointerlock(): void;
  39400. /**
  39401. * Ask the browser to promote the current element to fullscreen rendering mode
  39402. * @param element defines the DOM element to promote
  39403. */
  39404. static _RequestFullscreen(element: HTMLElement): void;
  39405. /**
  39406. * Asks the browser to exit fullscreen mode
  39407. */
  39408. static _ExitFullscreen(): void;
  39409. }
  39410. }
  39411. declare module "babylonjs/Engines/engineStore" {
  39412. import { Nullable } from "babylonjs/types";
  39413. import { Engine } from "babylonjs/Engines/engine";
  39414. import { Scene } from "babylonjs/scene";
  39415. /**
  39416. * The engine store class is responsible to hold all the instances of Engine and Scene created
  39417. * during the life time of the application.
  39418. */
  39419. export class EngineStore {
  39420. /** Gets the list of created engines */
  39421. static Instances: import("babylonjs/Engines/engine").Engine[];
  39422. /** @hidden */
  39423. static _LastCreatedScene: Nullable<Scene>;
  39424. /**
  39425. * Gets the latest created engine
  39426. */
  39427. static get LastCreatedEngine(): Nullable<Engine>;
  39428. /**
  39429. * Gets the latest created scene
  39430. */
  39431. static get LastCreatedScene(): Nullable<Scene>;
  39432. /**
  39433. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  39434. * @ignorenaming
  39435. */
  39436. static UseFallbackTexture: boolean;
  39437. /**
  39438. * Texture content used if a texture cannot loaded
  39439. * @ignorenaming
  39440. */
  39441. static FallbackTexture: string;
  39442. }
  39443. }
  39444. declare module "babylonjs/Misc/promise" {
  39445. /**
  39446. * Helper class that provides a small promise polyfill
  39447. */
  39448. export class PromisePolyfill {
  39449. /**
  39450. * Static function used to check if the polyfill is required
  39451. * If this is the case then the function will inject the polyfill to window.Promise
  39452. * @param force defines a boolean used to force the injection (mostly for testing purposes)
  39453. */
  39454. static Apply(force?: boolean): void;
  39455. }
  39456. }
  39457. declare module "babylonjs/Misc/interfaces/screenshotSize" {
  39458. /**
  39459. * Interface for screenshot methods with describe argument called `size` as object with options
  39460. * @link https://doc.babylonjs.com/api/classes/babylon.screenshottools
  39461. */
  39462. export interface IScreenshotSize {
  39463. /**
  39464. * number in pixels for canvas height
  39465. */
  39466. height?: number;
  39467. /**
  39468. * multiplier allowing render at a higher or lower resolution
  39469. * If value is defined then height and width will be ignored and taken from camera
  39470. */
  39471. precision?: number;
  39472. /**
  39473. * number in pixels for canvas width
  39474. */
  39475. width?: number;
  39476. }
  39477. }
  39478. declare module "babylonjs/Misc/tools" {
  39479. import { Nullable, float } from "babylonjs/types";
  39480. import { DomManagement } from "babylonjs/Misc/domManagement";
  39481. import { WebRequest } from "babylonjs/Misc/webRequest";
  39482. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  39483. import { ReadFileError } from "babylonjs/Misc/fileTools";
  39484. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  39485. import { IScreenshotSize } from "babylonjs/Misc/interfaces/screenshotSize";
  39486. import { Camera } from "babylonjs/Cameras/camera";
  39487. import { Engine } from "babylonjs/Engines/engine";
  39488. interface IColor4Like {
  39489. r: float;
  39490. g: float;
  39491. b: float;
  39492. a: float;
  39493. }
  39494. /**
  39495. * Class containing a set of static utilities functions
  39496. */
  39497. export class Tools {
  39498. /**
  39499. * Gets or sets the base URL to use to load assets
  39500. */
  39501. static get BaseUrl(): string;
  39502. static set BaseUrl(value: string);
  39503. /**
  39504. * Enable/Disable Custom HTTP Request Headers globally.
  39505. * default = false
  39506. * @see CustomRequestHeaders
  39507. */
  39508. static UseCustomRequestHeaders: boolean;
  39509. /**
  39510. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  39511. * i.e. when loading files, where the server/service expects an Authorization header
  39512. */
  39513. static CustomRequestHeaders: {
  39514. [key: string]: string;
  39515. };
  39516. /**
  39517. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  39518. */
  39519. static get DefaultRetryStrategy(): (url: string, request: WebRequest, retryIndex: number) => number;
  39520. static set DefaultRetryStrategy(strategy: (url: string, request: WebRequest, retryIndex: number) => number);
  39521. /**
  39522. * Default behaviour for cors in the application.
  39523. * It can be a string if the expected behavior is identical in the entire app.
  39524. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  39525. */
  39526. static get CorsBehavior(): string | ((url: string | string[]) => string);
  39527. static set CorsBehavior(value: string | ((url: string | string[]) => string));
  39528. /**
  39529. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  39530. * @ignorenaming
  39531. */
  39532. static get UseFallbackTexture(): boolean;
  39533. static set UseFallbackTexture(value: boolean);
  39534. /**
  39535. * Use this object to register external classes like custom textures or material
  39536. * to allow the laoders to instantiate them
  39537. */
  39538. static get RegisteredExternalClasses(): {
  39539. [key: string]: Object;
  39540. };
  39541. static set RegisteredExternalClasses(classes: {
  39542. [key: string]: Object;
  39543. });
  39544. /**
  39545. * Texture content used if a texture cannot loaded
  39546. * @ignorenaming
  39547. */
  39548. static get fallbackTexture(): string;
  39549. static set fallbackTexture(value: string);
  39550. /**
  39551. * Read the content of a byte array at a specified coordinates (taking in account wrapping)
  39552. * @param u defines the coordinate on X axis
  39553. * @param v defines the coordinate on Y axis
  39554. * @param width defines the width of the source data
  39555. * @param height defines the height of the source data
  39556. * @param pixels defines the source byte array
  39557. * @param color defines the output color
  39558. */
  39559. static FetchToRef(u: number, v: number, width: number, height: number, pixels: Uint8Array, color: IColor4Like): void;
  39560. /**
  39561. * Interpolates between a and b via alpha
  39562. * @param a The lower value (returned when alpha = 0)
  39563. * @param b The upper value (returned when alpha = 1)
  39564. * @param alpha The interpolation-factor
  39565. * @return The mixed value
  39566. */
  39567. static Mix(a: number, b: number, alpha: number): number;
  39568. /**
  39569. * Tries to instantiate a new object from a given class name
  39570. * @param className defines the class name to instantiate
  39571. * @returns the new object or null if the system was not able to do the instantiation
  39572. */
  39573. static Instantiate(className: string): any;
  39574. /**
  39575. * Provides a slice function that will work even on IE
  39576. * @param data defines the array to slice
  39577. * @param start defines the start of the data (optional)
  39578. * @param end defines the end of the data (optional)
  39579. * @returns the new sliced array
  39580. */
  39581. static Slice<T>(data: T, start?: number, end?: number): T;
  39582. /**
  39583. * Polyfill for setImmediate
  39584. * @param action defines the action to execute after the current execution block
  39585. */
  39586. static SetImmediate(action: () => void): void;
  39587. /**
  39588. * Function indicating if a number is an exponent of 2
  39589. * @param value defines the value to test
  39590. * @returns true if the value is an exponent of 2
  39591. */
  39592. static IsExponentOfTwo(value: number): boolean;
  39593. private static _tmpFloatArray;
  39594. /**
  39595. * Returns the nearest 32-bit single precision float representation of a Number
  39596. * @param value A Number. If the parameter is of a different type, it will get converted
  39597. * to a number or to NaN if it cannot be converted
  39598. * @returns number
  39599. */
  39600. static FloatRound(value: number): number;
  39601. /**
  39602. * Extracts the filename from a path
  39603. * @param path defines the path to use
  39604. * @returns the filename
  39605. */
  39606. static GetFilename(path: string): string;
  39607. /**
  39608. * Extracts the "folder" part of a path (everything before the filename).
  39609. * @param uri The URI to extract the info from
  39610. * @param returnUnchangedIfNoSlash Do not touch the URI if no slashes are present
  39611. * @returns The "folder" part of the path
  39612. */
  39613. static GetFolderPath(uri: string, returnUnchangedIfNoSlash?: boolean): string;
  39614. /**
  39615. * Extracts text content from a DOM element hierarchy
  39616. * Back Compat only, please use DomManagement.GetDOMTextContent instead.
  39617. */
  39618. static GetDOMTextContent: typeof DomManagement.GetDOMTextContent;
  39619. /**
  39620. * Convert an angle in radians to degrees
  39621. * @param angle defines the angle to convert
  39622. * @returns the angle in degrees
  39623. */
  39624. static ToDegrees(angle: number): number;
  39625. /**
  39626. * Convert an angle in degrees to radians
  39627. * @param angle defines the angle to convert
  39628. * @returns the angle in radians
  39629. */
  39630. static ToRadians(angle: number): number;
  39631. /**
  39632. * Returns an array if obj is not an array
  39633. * @param obj defines the object to evaluate as an array
  39634. * @param allowsNullUndefined defines a boolean indicating if obj is allowed to be null or undefined
  39635. * @returns either obj directly if obj is an array or a new array containing obj
  39636. */
  39637. static MakeArray(obj: any, allowsNullUndefined?: boolean): Nullable<Array<any>>;
  39638. /**
  39639. * Gets the pointer prefix to use
  39640. * @param engine defines the engine we are finding the prefix for
  39641. * @returns "pointer" if touch is enabled. Else returns "mouse"
  39642. */
  39643. static GetPointerPrefix(engine: Engine): string;
  39644. /**
  39645. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  39646. * @param url define the url we are trying
  39647. * @param element define the dom element where to configure the cors policy
  39648. */
  39649. static SetCorsBehavior(url: string | string[], element: {
  39650. crossOrigin: string | null;
  39651. }): void;
  39652. /**
  39653. * Removes unwanted characters from an url
  39654. * @param url defines the url to clean
  39655. * @returns the cleaned url
  39656. */
  39657. static CleanUrl(url: string): string;
  39658. /**
  39659. * Gets or sets a function used to pre-process url before using them to load assets
  39660. */
  39661. static get PreprocessUrl(): (url: string) => string;
  39662. static set PreprocessUrl(processor: (url: string) => string);
  39663. /**
  39664. * Loads an image as an HTMLImageElement.
  39665. * @param input url string, ArrayBuffer, or Blob to load
  39666. * @param onLoad callback called when the image successfully loads
  39667. * @param onError callback called when the image fails to load
  39668. * @param offlineProvider offline provider for caching
  39669. * @param mimeType optional mime type
  39670. * @returns the HTMLImageElement of the loaded image
  39671. */
  39672. static LoadImage(input: string | ArrayBuffer | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  39673. /**
  39674. * Loads a file from a url
  39675. * @param url url string, ArrayBuffer, or Blob to load
  39676. * @param onSuccess callback called when the file successfully loads
  39677. * @param onProgress callback called while file is loading (if the server supports this mode)
  39678. * @param offlineProvider defines the offline provider for caching
  39679. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  39680. * @param onError callback called when the file fails to load
  39681. * @returns a file request object
  39682. */
  39683. 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;
  39684. /**
  39685. * Loads a file from a url
  39686. * @param url the file url to load
  39687. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  39688. * @returns a promise containing an ArrayBuffer corresponding to the loaded file
  39689. */
  39690. static LoadFileAsync(url: string, useArrayBuffer?: boolean): Promise<ArrayBuffer | string>;
  39691. /**
  39692. * Load a script (identified by an url). When the url returns, the
  39693. * content of this file is added into a new script element, attached to the DOM (body element)
  39694. * @param scriptUrl defines the url of the script to laod
  39695. * @param onSuccess defines the callback called when the script is loaded
  39696. * @param onError defines the callback to call if an error occurs
  39697. * @param scriptId defines the id of the script element
  39698. */
  39699. static LoadScript(scriptUrl: string, onSuccess: () => void, onError?: (message?: string, exception?: any) => void, scriptId?: string): void;
  39700. /**
  39701. * Load an asynchronous script (identified by an url). When the url returns, the
  39702. * content of this file is added into a new script element, attached to the DOM (body element)
  39703. * @param scriptUrl defines the url of the script to laod
  39704. * @param scriptId defines the id of the script element
  39705. * @returns a promise request object
  39706. */
  39707. static LoadScriptAsync(scriptUrl: string, scriptId?: string): Promise<void>;
  39708. /**
  39709. * Loads a file from a blob
  39710. * @param fileToLoad defines the blob to use
  39711. * @param callback defines the callback to call when data is loaded
  39712. * @param progressCallback defines the callback to call during loading process
  39713. * @returns a file request object
  39714. */
  39715. static ReadFileAsDataURL(fileToLoad: Blob, callback: (data: any) => void, progressCallback: (ev: ProgressEvent) => any): IFileRequest;
  39716. /**
  39717. * Reads a file from a File object
  39718. * @param file defines the file to load
  39719. * @param onSuccess defines the callback to call when data is loaded
  39720. * @param onProgress defines the callback to call during loading process
  39721. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  39722. * @param onError defines the callback to call when an error occurs
  39723. * @returns a file request object
  39724. */
  39725. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  39726. /**
  39727. * Creates a data url from a given string content
  39728. * @param content defines the content to convert
  39729. * @returns the new data url link
  39730. */
  39731. static FileAsURL(content: string): string;
  39732. /**
  39733. * Format the given number to a specific decimal format
  39734. * @param value defines the number to format
  39735. * @param decimals defines the number of decimals to use
  39736. * @returns the formatted string
  39737. */
  39738. static Format(value: number, decimals?: number): string;
  39739. /**
  39740. * Tries to copy an object by duplicating every property
  39741. * @param source defines the source object
  39742. * @param destination defines the target object
  39743. * @param doNotCopyList defines a list of properties to avoid
  39744. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  39745. */
  39746. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  39747. /**
  39748. * Gets a boolean indicating if the given object has no own property
  39749. * @param obj defines the object to test
  39750. * @returns true if object has no own property
  39751. */
  39752. static IsEmpty(obj: any): boolean;
  39753. /**
  39754. * Function used to register events at window level
  39755. * @param windowElement defines the Window object to use
  39756. * @param events defines the events to register
  39757. */
  39758. static RegisterTopRootEvents(windowElement: Window, events: {
  39759. name: string;
  39760. handler: Nullable<(e: FocusEvent) => any>;
  39761. }[]): void;
  39762. /**
  39763. * Function used to unregister events from window level
  39764. * @param windowElement defines the Window object to use
  39765. * @param events defines the events to unregister
  39766. */
  39767. static UnregisterTopRootEvents(windowElement: Window, events: {
  39768. name: string;
  39769. handler: Nullable<(e: FocusEvent) => any>;
  39770. }[]): void;
  39771. /**
  39772. * @ignore
  39773. */
  39774. static _ScreenshotCanvas: HTMLCanvasElement;
  39775. /**
  39776. * Dumps the current bound framebuffer
  39777. * @param width defines the rendering width
  39778. * @param height defines the rendering height
  39779. * @param engine defines the hosting engine
  39780. * @param successCallback defines the callback triggered once the data are available
  39781. * @param mimeType defines the mime type of the result
  39782. * @param fileName defines the filename to download. If present, the result will automatically be downloaded
  39783. */
  39784. static DumpFramebuffer(width: number, height: number, engine: Engine, successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  39785. /**
  39786. * Converts the canvas data to blob.
  39787. * This acts as a polyfill for browsers not supporting the to blob function.
  39788. * @param canvas Defines the canvas to extract the data from
  39789. * @param successCallback Defines the callback triggered once the data are available
  39790. * @param mimeType Defines the mime type of the result
  39791. */
  39792. static ToBlob(canvas: HTMLCanvasElement, successCallback: (blob: Nullable<Blob>) => void, mimeType?: string): void;
  39793. /**
  39794. * Encodes the canvas data to base 64 or automatically download the result if filename is defined
  39795. * @param successCallback defines the callback triggered once the data are available
  39796. * @param mimeType defines the mime type of the result
  39797. * @param fileName defines he filename to download. If present, the result will automatically be downloaded
  39798. */
  39799. static EncodeScreenshotCanvasData(successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  39800. /**
  39801. * Downloads a blob in the browser
  39802. * @param blob defines the blob to download
  39803. * @param fileName defines the name of the downloaded file
  39804. */
  39805. static Download(blob: Blob, fileName: string): void;
  39806. /**
  39807. * Captures a screenshot of the current rendering
  39808. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  39809. * @param engine defines the rendering engine
  39810. * @param camera defines the source camera
  39811. * @param size This parameter can be set to a single number or to an object with the
  39812. * following (optional) properties: precision, width, height. If a single number is passed,
  39813. * it will be used for both width and height. If an object is passed, the screenshot size
  39814. * will be derived from the parameters. The precision property is a multiplier allowing
  39815. * rendering at a higher or lower resolution
  39816. * @param successCallback defines the callback receives a single parameter which contains the
  39817. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  39818. * src parameter of an <img> to display it
  39819. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  39820. * Check your browser for supported MIME types
  39821. */
  39822. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  39823. /**
  39824. * Captures a screenshot of the current rendering
  39825. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  39826. * @param engine defines the rendering engine
  39827. * @param camera defines the source camera
  39828. * @param size This parameter can be set to a single number or to an object with the
  39829. * following (optional) properties: precision, width, height. If a single number is passed,
  39830. * it will be used for both width and height. If an object is passed, the screenshot size
  39831. * will be derived from the parameters. The precision property is a multiplier allowing
  39832. * rendering at a higher or lower resolution
  39833. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  39834. * Check your browser for supported MIME types
  39835. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  39836. * to the src parameter of an <img> to display it
  39837. */
  39838. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string): Promise<string>;
  39839. /**
  39840. * Generates an image screenshot from the specified camera.
  39841. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  39842. * @param engine The engine to use for rendering
  39843. * @param camera The camera to use for rendering
  39844. * @param size This parameter can be set to a single number or to an object with the
  39845. * following (optional) properties: precision, width, height. If a single number is passed,
  39846. * it will be used for both width and height. If an object is passed, the screenshot size
  39847. * will be derived from the parameters. The precision property is a multiplier allowing
  39848. * rendering at a higher or lower resolution
  39849. * @param successCallback The callback receives a single parameter which contains the
  39850. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  39851. * src parameter of an <img> to display it
  39852. * @param mimeType The MIME type of the screenshot image (default: image/png).
  39853. * Check your browser for supported MIME types
  39854. * @param samples Texture samples (default: 1)
  39855. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  39856. * @param fileName A name for for the downloaded file.
  39857. */
  39858. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  39859. /**
  39860. * Generates an image screenshot from the specified camera.
  39861. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  39862. * @param engine The engine to use for rendering
  39863. * @param camera The camera to use for rendering
  39864. * @param size This parameter can be set to a single number or to an object with the
  39865. * following (optional) properties: precision, width, height. If a single number is passed,
  39866. * it will be used for both width and height. If an object is passed, the screenshot size
  39867. * will be derived from the parameters. The precision property is a multiplier allowing
  39868. * rendering at a higher or lower resolution
  39869. * @param mimeType The MIME type of the screenshot image (default: image/png).
  39870. * Check your browser for supported MIME types
  39871. * @param samples Texture samples (default: 1)
  39872. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  39873. * @param fileName A name for for the downloaded file.
  39874. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  39875. * to the src parameter of an <img> to display it
  39876. */
  39877. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  39878. /**
  39879. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  39880. * Be aware Math.random() could cause collisions, but:
  39881. * "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"
  39882. * @returns a pseudo random id
  39883. */
  39884. static RandomId(): string;
  39885. /**
  39886. * Test if the given uri is a base64 string
  39887. * @param uri The uri to test
  39888. * @return True if the uri is a base64 string or false otherwise
  39889. */
  39890. static IsBase64(uri: string): boolean;
  39891. /**
  39892. * Decode the given base64 uri.
  39893. * @param uri The uri to decode
  39894. * @return The decoded base64 data.
  39895. */
  39896. static DecodeBase64(uri: string): ArrayBuffer;
  39897. /**
  39898. * Gets the absolute url.
  39899. * @param url the input url
  39900. * @return the absolute url
  39901. */
  39902. static GetAbsoluteUrl(url: string): string;
  39903. /**
  39904. * No log
  39905. */
  39906. static readonly NoneLogLevel: number;
  39907. /**
  39908. * Only message logs
  39909. */
  39910. static readonly MessageLogLevel: number;
  39911. /**
  39912. * Only warning logs
  39913. */
  39914. static readonly WarningLogLevel: number;
  39915. /**
  39916. * Only error logs
  39917. */
  39918. static readonly ErrorLogLevel: number;
  39919. /**
  39920. * All logs
  39921. */
  39922. static readonly AllLogLevel: number;
  39923. /**
  39924. * Gets a value indicating the number of loading errors
  39925. * @ignorenaming
  39926. */
  39927. static get errorsCount(): number;
  39928. /**
  39929. * Callback called when a new log is added
  39930. */
  39931. static OnNewCacheEntry: (entry: string) => void;
  39932. /**
  39933. * Log a message to the console
  39934. * @param message defines the message to log
  39935. */
  39936. static Log(message: string): void;
  39937. /**
  39938. * Write a warning message to the console
  39939. * @param message defines the message to log
  39940. */
  39941. static Warn(message: string): void;
  39942. /**
  39943. * Write an error message to the console
  39944. * @param message defines the message to log
  39945. */
  39946. static Error(message: string): void;
  39947. /**
  39948. * Gets current log cache (list of logs)
  39949. */
  39950. static get LogCache(): string;
  39951. /**
  39952. * Clears the log cache
  39953. */
  39954. static ClearLogCache(): void;
  39955. /**
  39956. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  39957. */
  39958. static set LogLevels(level: number);
  39959. /**
  39960. * Checks if the window object exists
  39961. * Back Compat only, please use DomManagement.IsWindowObjectExist instead.
  39962. */
  39963. static IsWindowObjectExist: typeof DomManagement.IsWindowObjectExist;
  39964. /**
  39965. * No performance log
  39966. */
  39967. static readonly PerformanceNoneLogLevel: number;
  39968. /**
  39969. * Use user marks to log performance
  39970. */
  39971. static readonly PerformanceUserMarkLogLevel: number;
  39972. /**
  39973. * Log performance to the console
  39974. */
  39975. static readonly PerformanceConsoleLogLevel: number;
  39976. private static _performance;
  39977. /**
  39978. * Sets the current performance log level
  39979. */
  39980. static set PerformanceLogLevel(level: number);
  39981. private static _StartPerformanceCounterDisabled;
  39982. private static _EndPerformanceCounterDisabled;
  39983. private static _StartUserMark;
  39984. private static _EndUserMark;
  39985. private static _StartPerformanceConsole;
  39986. private static _EndPerformanceConsole;
  39987. /**
  39988. * Starts a performance counter
  39989. */
  39990. static StartPerformanceCounter: (counterName: string, condition?: boolean) => void;
  39991. /**
  39992. * Ends a specific performance coutner
  39993. */
  39994. static EndPerformanceCounter: (counterName: string, condition?: boolean) => void;
  39995. /**
  39996. * Gets either window.performance.now() if supported or Date.now() else
  39997. */
  39998. static get Now(): number;
  39999. /**
  40000. * This method will return the name of the class used to create the instance of the given object.
  40001. * It will works only on Javascript basic data types (number, string, ...) and instance of class declared with the @className decorator.
  40002. * @param object the object to get the class name from
  40003. * @param isType defines if the object is actually a type
  40004. * @returns the name of the class, will be "object" for a custom data type not using the @className decorator
  40005. */
  40006. static GetClassName(object: any, isType?: boolean): string;
  40007. /**
  40008. * Gets the first element of an array satisfying a given predicate
  40009. * @param array defines the array to browse
  40010. * @param predicate defines the predicate to use
  40011. * @returns null if not found or the element
  40012. */
  40013. static First<T>(array: Array<T>, predicate: (item: T) => boolean): Nullable<T>;
  40014. /**
  40015. * This method will return the name of the full name of the class, including its owning module (if any).
  40016. * 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).
  40017. * @param object the object to get the class name from
  40018. * @param isType defines if the object is actually a type
  40019. * @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.
  40020. * @ignorenaming
  40021. */
  40022. static getFullClassName(object: any, isType?: boolean): Nullable<string>;
  40023. /**
  40024. * Returns a promise that resolves after the given amount of time.
  40025. * @param delay Number of milliseconds to delay
  40026. * @returns Promise that resolves after the given amount of time
  40027. */
  40028. static DelayAsync(delay: number): Promise<void>;
  40029. /**
  40030. * Utility function to detect if the current user agent is Safari
  40031. * @returns whether or not the current user agent is safari
  40032. */
  40033. static IsSafari(): boolean;
  40034. }
  40035. /**
  40036. * Use this className as a decorator on a given class definition to add it a name and optionally its module.
  40037. * You can then use the Tools.getClassName(obj) on an instance to retrieve its class name.
  40038. * This method is the only way to get it done in all cases, even if the .js file declaring the class is minified
  40039. * @param name The name of the class, case should be preserved
  40040. * @param module The name of the Module hosting the class, optional, but strongly recommended to specify if possible. Case should be preserved.
  40041. */
  40042. export function className(name: string, module?: string): (target: Object) => void;
  40043. /**
  40044. * An implementation of a loop for asynchronous functions.
  40045. */
  40046. export class AsyncLoop {
  40047. /**
  40048. * Defines the number of iterations for the loop
  40049. */
  40050. iterations: number;
  40051. /**
  40052. * Defines the current index of the loop.
  40053. */
  40054. index: number;
  40055. private _done;
  40056. private _fn;
  40057. private _successCallback;
  40058. /**
  40059. * Constructor.
  40060. * @param iterations the number of iterations.
  40061. * @param func the function to run each iteration
  40062. * @param successCallback the callback that will be called upon succesful execution
  40063. * @param offset starting offset.
  40064. */
  40065. constructor(
  40066. /**
  40067. * Defines the number of iterations for the loop
  40068. */
  40069. iterations: number, func: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number);
  40070. /**
  40071. * Execute the next iteration. Must be called after the last iteration was finished.
  40072. */
  40073. executeNext(): void;
  40074. /**
  40075. * Break the loop and run the success callback.
  40076. */
  40077. breakLoop(): void;
  40078. /**
  40079. * Create and run an async loop.
  40080. * @param iterations the number of iterations.
  40081. * @param fn the function to run each iteration
  40082. * @param successCallback the callback that will be called upon succesful execution
  40083. * @param offset starting offset.
  40084. * @returns the created async loop object
  40085. */
  40086. static Run(iterations: number, fn: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number): AsyncLoop;
  40087. /**
  40088. * A for-loop that will run a given number of iterations synchronous and the rest async.
  40089. * @param iterations total number of iterations
  40090. * @param syncedIterations number of synchronous iterations in each async iteration.
  40091. * @param fn the function to call each iteration.
  40092. * @param callback a success call back that will be called when iterating stops.
  40093. * @param breakFunction a break condition (optional)
  40094. * @param timeout timeout settings for the setTimeout function. default - 0.
  40095. * @returns the created async loop object
  40096. */
  40097. static SyncAsyncForLoop(iterations: number, syncedIterations: number, fn: (iteration: number) => void, callback: () => void, breakFunction?: () => boolean, timeout?: number): AsyncLoop;
  40098. }
  40099. }
  40100. declare module "babylonjs/Misc/stringDictionary" {
  40101. import { Nullable } from "babylonjs/types";
  40102. /**
  40103. * This class implement a typical dictionary using a string as key and the generic type T as value.
  40104. * The underlying implementation relies on an associative array to ensure the best performances.
  40105. * The value can be anything including 'null' but except 'undefined'
  40106. */
  40107. export class StringDictionary<T> {
  40108. /**
  40109. * This will clear this dictionary and copy the content from the 'source' one.
  40110. * If the T value is a custom object, it won't be copied/cloned, the same object will be used
  40111. * @param source the dictionary to take the content from and copy to this dictionary
  40112. */
  40113. copyFrom(source: StringDictionary<T>): void;
  40114. /**
  40115. * Get a value based from its key
  40116. * @param key the given key to get the matching value from
  40117. * @return the value if found, otherwise undefined is returned
  40118. */
  40119. get(key: string): T | undefined;
  40120. /**
  40121. * Get a value from its key or add it if it doesn't exist.
  40122. * This method will ensure you that a given key/data will be present in the dictionary.
  40123. * @param key the given key to get the matching value from
  40124. * @param factory the factory that will create the value if the key is not present in the dictionary.
  40125. * The factory will only be invoked if there's no data for the given key.
  40126. * @return the value corresponding to the key.
  40127. */
  40128. getOrAddWithFactory(key: string, factory: (key: string) => T): T;
  40129. /**
  40130. * Get a value from its key if present in the dictionary otherwise add it
  40131. * @param key the key to get the value from
  40132. * @param val if there's no such key/value pair in the dictionary add it with this value
  40133. * @return the value corresponding to the key
  40134. */
  40135. getOrAdd(key: string, val: T): T;
  40136. /**
  40137. * Check if there's a given key in the dictionary
  40138. * @param key the key to check for
  40139. * @return true if the key is present, false otherwise
  40140. */
  40141. contains(key: string): boolean;
  40142. /**
  40143. * Add a new key and its corresponding value
  40144. * @param key the key to add
  40145. * @param value the value corresponding to the key
  40146. * @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
  40147. */
  40148. add(key: string, value: T): boolean;
  40149. /**
  40150. * Update a specific value associated to a key
  40151. * @param key defines the key to use
  40152. * @param value defines the value to store
  40153. * @returns true if the value was updated (or false if the key was not found)
  40154. */
  40155. set(key: string, value: T): boolean;
  40156. /**
  40157. * Get the element of the given key and remove it from the dictionary
  40158. * @param key defines the key to search
  40159. * @returns the value associated with the key or null if not found
  40160. */
  40161. getAndRemove(key: string): Nullable<T>;
  40162. /**
  40163. * Remove a key/value from the dictionary.
  40164. * @param key the key to remove
  40165. * @return true if the item was successfully deleted, false if no item with such key exist in the dictionary
  40166. */
  40167. remove(key: string): boolean;
  40168. /**
  40169. * Clear the whole content of the dictionary
  40170. */
  40171. clear(): void;
  40172. /**
  40173. * Gets the current count
  40174. */
  40175. get count(): number;
  40176. /**
  40177. * Execute a callback on each key/val of the dictionary.
  40178. * Note that you can remove any element in this dictionary in the callback implementation
  40179. * @param callback the callback to execute on a given key/value pair
  40180. */
  40181. forEach(callback: (key: string, val: T) => void): void;
  40182. /**
  40183. * Execute a callback on every occurrence of the dictionary until it returns a valid TRes object.
  40184. * If the callback returns null or undefined the method will iterate to the next key/value pair
  40185. * Note that you can remove any element in this dictionary in the callback implementation
  40186. * @param callback the callback to execute, if it return a valid T instanced object the enumeration will stop and the object will be returned
  40187. * @returns the first item
  40188. */
  40189. first<TRes>(callback: (key: string, val: T) => TRes): TRes | null;
  40190. private _count;
  40191. private _data;
  40192. }
  40193. }
  40194. declare module "babylonjs/Collisions/collisionCoordinator" {
  40195. import { Nullable } from "babylonjs/types";
  40196. import { Scene } from "babylonjs/scene";
  40197. import { Vector3 } from "babylonjs/Maths/math.vector";
  40198. import { Collider } from "babylonjs/Collisions/collider";
  40199. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  40200. /** @hidden */
  40201. export interface ICollisionCoordinator {
  40202. createCollider(): Collider;
  40203. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: Nullable<AbstractMesh>, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  40204. init(scene: Scene): void;
  40205. }
  40206. /** @hidden */
  40207. export class DefaultCollisionCoordinator implements ICollisionCoordinator {
  40208. private _scene;
  40209. private _scaledPosition;
  40210. private _scaledVelocity;
  40211. private _finalPosition;
  40212. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: AbstractMesh, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  40213. createCollider(): Collider;
  40214. init(scene: Scene): void;
  40215. private _collideWithWorld;
  40216. }
  40217. }
  40218. declare module "babylonjs/Inputs/scene.inputManager" {
  40219. import { Nullable } from "babylonjs/types";
  40220. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  40221. import { Vector2 } from "babylonjs/Maths/math.vector";
  40222. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  40223. import { Scene } from "babylonjs/scene";
  40224. /**
  40225. * Class used to manage all inputs for the scene.
  40226. */
  40227. export class InputManager {
  40228. /** The distance in pixel that you have to move to prevent some events */
  40229. static DragMovementThreshold: number;
  40230. /** Time in milliseconds to wait to raise long press events if button is still pressed */
  40231. static LongPressDelay: number;
  40232. /** Time in milliseconds with two consecutive clicks will be considered as a double click */
  40233. static DoubleClickDelay: number;
  40234. /** If you need to check double click without raising a single click at first click, enable this flag */
  40235. static ExclusiveDoubleClickMode: boolean;
  40236. /** 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. */
  40237. private _alreadyAttached;
  40238. private _wheelEventName;
  40239. private _onPointerMove;
  40240. private _onPointerDown;
  40241. private _onPointerUp;
  40242. private _initClickEvent;
  40243. private _initActionManager;
  40244. private _delayedSimpleClick;
  40245. private _delayedSimpleClickTimeout;
  40246. private _previousDelayedSimpleClickTimeout;
  40247. private _meshPickProceed;
  40248. private _previousButtonPressed;
  40249. private _currentPickResult;
  40250. private _previousPickResult;
  40251. private _totalPointersPressed;
  40252. private _doubleClickOccured;
  40253. private _pointerOverMesh;
  40254. private _pickedDownMesh;
  40255. private _pickedUpMesh;
  40256. private _pointerX;
  40257. private _pointerY;
  40258. private _unTranslatedPointerX;
  40259. private _unTranslatedPointerY;
  40260. private _startingPointerPosition;
  40261. private _previousStartingPointerPosition;
  40262. private _startingPointerTime;
  40263. private _previousStartingPointerTime;
  40264. private _pointerCaptures;
  40265. private _meshUnderPointerId;
  40266. private _onKeyDown;
  40267. private _onKeyUp;
  40268. private _onCanvasFocusObserver;
  40269. private _onCanvasBlurObserver;
  40270. private _scene;
  40271. /**
  40272. * Creates a new InputManager
  40273. * @param scene defines the hosting scene
  40274. */
  40275. constructor(scene: Scene);
  40276. /**
  40277. * Gets the mesh that is currently under the pointer
  40278. */
  40279. get meshUnderPointer(): Nullable<AbstractMesh>;
  40280. /**
  40281. * When using more than one pointer (for example in XR) you can get the mesh under the specific pointer
  40282. * @param pointerId the pointer id to use
  40283. * @returns The mesh under this pointer id or null if not found
  40284. */
  40285. getMeshUnderPointerByPointerId(pointerId: number): Nullable<AbstractMesh>;
  40286. /**
  40287. * Gets the pointer coordinates in 2D without any translation (ie. straight out of the pointer event)
  40288. */
  40289. get unTranslatedPointer(): Vector2;
  40290. /**
  40291. * Gets or sets the current on-screen X position of the pointer
  40292. */
  40293. get pointerX(): number;
  40294. set pointerX(value: number);
  40295. /**
  40296. * Gets or sets the current on-screen Y position of the pointer
  40297. */
  40298. get pointerY(): number;
  40299. set pointerY(value: number);
  40300. private _updatePointerPosition;
  40301. private _processPointerMove;
  40302. private _setRayOnPointerInfo;
  40303. private _checkPrePointerObservable;
  40304. /**
  40305. * Use this method to simulate a pointer move 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. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  40311. /**
  40312. * Use this method to simulate a pointer down on a mesh
  40313. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  40314. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  40315. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  40316. */
  40317. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  40318. private _processPointerDown;
  40319. /** @hidden */
  40320. _isPointerSwiping(): boolean;
  40321. /**
  40322. * Use this method to simulate a pointer up on a mesh
  40323. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  40324. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  40325. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  40326. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  40327. */
  40328. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): void;
  40329. private _processPointerUp;
  40330. /**
  40331. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  40332. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  40333. * @returns true if the pointer was captured
  40334. */
  40335. isPointerCaptured(pointerId?: number): boolean;
  40336. /**
  40337. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  40338. * @param attachUp defines if you want to attach events to pointerup
  40339. * @param attachDown defines if you want to attach events to pointerdown
  40340. * @param attachMove defines if you want to attach events to pointermove
  40341. * @param elementToAttachTo defines the target DOM element to attach to (will use the canvas by default)
  40342. */
  40343. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean, elementToAttachTo?: Nullable<HTMLElement>): void;
  40344. /**
  40345. * Detaches all event handlers
  40346. */
  40347. detachControl(): void;
  40348. /**
  40349. * Force the value of meshUnderPointer
  40350. * @param mesh defines the mesh to use
  40351. * @param pointerId optional pointer id when using more than one pointer. Defaults to 0
  40352. */
  40353. setPointerOverMesh(mesh: Nullable<AbstractMesh>, pointerId?: number): void;
  40354. /**
  40355. * Gets the mesh under the pointer
  40356. * @returns a Mesh or null if no mesh is under the pointer
  40357. */
  40358. getPointerOverMesh(): Nullable<AbstractMesh>;
  40359. }
  40360. }
  40361. declare module "babylonjs/Animations/animationGroup" {
  40362. import { Animatable } from "babylonjs/Animations/animatable";
  40363. import { Animation } from "babylonjs/Animations/animation";
  40364. import { Scene, IDisposable } from "babylonjs/scene";
  40365. import { Observable } from "babylonjs/Misc/observable";
  40366. import { Nullable } from "babylonjs/types";
  40367. import "babylonjs/Animations/animatable";
  40368. /**
  40369. * This class defines the direct association between an animation and a target
  40370. */
  40371. export class TargetedAnimation {
  40372. /**
  40373. * Animation to perform
  40374. */
  40375. animation: Animation;
  40376. /**
  40377. * Target to animate
  40378. */
  40379. target: any;
  40380. /**
  40381. * Returns the string "TargetedAnimation"
  40382. * @returns "TargetedAnimation"
  40383. */
  40384. getClassName(): string;
  40385. /**
  40386. * Serialize the object
  40387. * @returns the JSON object representing the current entity
  40388. */
  40389. serialize(): any;
  40390. }
  40391. /**
  40392. * Use this class to create coordinated animations on multiple targets
  40393. */
  40394. export class AnimationGroup implements IDisposable {
  40395. /** The name of the animation group */
  40396. name: string;
  40397. private _scene;
  40398. private _targetedAnimations;
  40399. private _animatables;
  40400. private _from;
  40401. private _to;
  40402. private _isStarted;
  40403. private _isPaused;
  40404. private _speedRatio;
  40405. private _loopAnimation;
  40406. private _isAdditive;
  40407. /**
  40408. * Gets or sets the unique id of the node
  40409. */
  40410. uniqueId: number;
  40411. /**
  40412. * This observable will notify when one animation have ended
  40413. */
  40414. onAnimationEndObservable: Observable<TargetedAnimation>;
  40415. /**
  40416. * Observer raised when one animation loops
  40417. */
  40418. onAnimationLoopObservable: Observable<TargetedAnimation>;
  40419. /**
  40420. * Observer raised when all animations have looped
  40421. */
  40422. onAnimationGroupLoopObservable: Observable<AnimationGroup>;
  40423. /**
  40424. * This observable will notify when all animations have ended.
  40425. */
  40426. onAnimationGroupEndObservable: Observable<AnimationGroup>;
  40427. /**
  40428. * This observable will notify when all animations have paused.
  40429. */
  40430. onAnimationGroupPauseObservable: Observable<AnimationGroup>;
  40431. /**
  40432. * This observable will notify when all animations are playing.
  40433. */
  40434. onAnimationGroupPlayObservable: Observable<AnimationGroup>;
  40435. /**
  40436. * Gets the first frame
  40437. */
  40438. get from(): number;
  40439. /**
  40440. * Gets the last frame
  40441. */
  40442. get to(): number;
  40443. /**
  40444. * Define if the animations are started
  40445. */
  40446. get isStarted(): boolean;
  40447. /**
  40448. * Gets a value indicating that the current group is playing
  40449. */
  40450. get isPlaying(): boolean;
  40451. /**
  40452. * Gets or sets the speed ratio to use for all animations
  40453. */
  40454. get speedRatio(): number;
  40455. /**
  40456. * Gets or sets the speed ratio to use for all animations
  40457. */
  40458. set speedRatio(value: number);
  40459. /**
  40460. * Gets or sets if all animations should loop or not
  40461. */
  40462. get loopAnimation(): boolean;
  40463. set loopAnimation(value: boolean);
  40464. /**
  40465. * Gets or sets if all animations should be evaluated additively
  40466. */
  40467. get isAdditive(): boolean;
  40468. set isAdditive(value: boolean);
  40469. /**
  40470. * Gets the targeted animations for this animation group
  40471. */
  40472. get targetedAnimations(): Array<TargetedAnimation>;
  40473. /**
  40474. * returning the list of animatables controlled by this animation group.
  40475. */
  40476. get animatables(): Array<Animatable>;
  40477. /**
  40478. * Gets the list of target animations
  40479. */
  40480. get children(): TargetedAnimation[];
  40481. /**
  40482. * Instantiates a new Animation Group.
  40483. * This helps managing several animations at once.
  40484. * @see https://doc.babylonjs.com/how_to/group
  40485. * @param name Defines the name of the group
  40486. * @param scene Defines the scene the group belongs to
  40487. */
  40488. constructor(
  40489. /** The name of the animation group */
  40490. name: string, scene?: Nullable<Scene>);
  40491. /**
  40492. * Add an animation (with its target) in the group
  40493. * @param animation defines the animation we want to add
  40494. * @param target defines the target of the animation
  40495. * @returns the TargetedAnimation object
  40496. */
  40497. addTargetedAnimation(animation: Animation, target: any): TargetedAnimation;
  40498. /**
  40499. * This function will normalize every animation in the group to make sure they all go from beginFrame to endFrame
  40500. * It can add constant keys at begin or end
  40501. * @param beginFrame defines the new begin frame for all animations or the smallest begin frame of all animations if null (defaults to null)
  40502. * @param endFrame defines the new end frame for all animations or the largest end frame of all animations if null (defaults to null)
  40503. * @returns the animation group
  40504. */
  40505. normalize(beginFrame?: Nullable<number>, endFrame?: Nullable<number>): AnimationGroup;
  40506. private _animationLoopCount;
  40507. private _animationLoopFlags;
  40508. private _processLoop;
  40509. /**
  40510. * Start all animations on given targets
  40511. * @param loop defines if animations must loop
  40512. * @param speedRatio defines the ratio to apply to animation speed (1 by default)
  40513. * @param from defines the from key (optional)
  40514. * @param to defines the to key (optional)
  40515. * @param isAdditive defines the additive state for the resulting animatables (optional)
  40516. * @returns the current animation group
  40517. */
  40518. start(loop?: boolean, speedRatio?: number, from?: number, to?: number, isAdditive?: boolean): AnimationGroup;
  40519. /**
  40520. * Pause all animations
  40521. * @returns the animation group
  40522. */
  40523. pause(): AnimationGroup;
  40524. /**
  40525. * Play all animations to initial state
  40526. * This function will start() the animations if they were not started or will restart() them if they were paused
  40527. * @param loop defines if animations must loop
  40528. * @returns the animation group
  40529. */
  40530. play(loop?: boolean): AnimationGroup;
  40531. /**
  40532. * Reset all animations to initial state
  40533. * @returns the animation group
  40534. */
  40535. reset(): AnimationGroup;
  40536. /**
  40537. * Restart animations from key 0
  40538. * @returns the animation group
  40539. */
  40540. restart(): AnimationGroup;
  40541. /**
  40542. * Stop all animations
  40543. * @returns the animation group
  40544. */
  40545. stop(): AnimationGroup;
  40546. /**
  40547. * Set animation weight for all animatables
  40548. * @param weight defines the weight to use
  40549. * @return the animationGroup
  40550. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  40551. */
  40552. setWeightForAllAnimatables(weight: number): AnimationGroup;
  40553. /**
  40554. * Synchronize and normalize all animatables with a source animatable
  40555. * @param root defines the root animatable to synchronize with
  40556. * @return the animationGroup
  40557. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  40558. */
  40559. syncAllAnimationsWith(root: Animatable): AnimationGroup;
  40560. /**
  40561. * Goes to a specific frame in this animation group
  40562. * @param frame the frame number to go to
  40563. * @return the animationGroup
  40564. */
  40565. goToFrame(frame: number): AnimationGroup;
  40566. /**
  40567. * Dispose all associated resources
  40568. */
  40569. dispose(): void;
  40570. private _checkAnimationGroupEnded;
  40571. /**
  40572. * Clone the current animation group and returns a copy
  40573. * @param newName defines the name of the new group
  40574. * @param targetConverter defines an optional function used to convert current animation targets to new ones
  40575. * @returns the new aniamtion group
  40576. */
  40577. clone(newName: string, targetConverter?: (oldTarget: any) => any): AnimationGroup;
  40578. /**
  40579. * Serializes the animationGroup to an object
  40580. * @returns Serialized object
  40581. */
  40582. serialize(): any;
  40583. /**
  40584. * Returns a new AnimationGroup object parsed from the source provided.
  40585. * @param parsedAnimationGroup defines the source
  40586. * @param scene defines the scene that will receive the animationGroup
  40587. * @returns a new AnimationGroup
  40588. */
  40589. static Parse(parsedAnimationGroup: any, scene: Scene): AnimationGroup;
  40590. /**
  40591. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  40592. * @param sourceAnimationGroup defines the AnimationGroup containing animations to convert
  40593. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  40594. * @param range defines the name of the AnimationRange belonging to the animations in the group to convert
  40595. * @param cloneOriginal defines whether or not to clone the group and convert the clone or convert the original group (default is false)
  40596. * @param clonedName defines the name of the resulting cloned AnimationGroup if cloneOriginal is true
  40597. * @returns a new AnimationGroup if cloneOriginal is true or the original AnimationGroup if cloneOriginal is false
  40598. */
  40599. static MakeAnimationAdditive(sourceAnimationGroup: AnimationGroup, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): AnimationGroup;
  40600. /**
  40601. * Returns the string "AnimationGroup"
  40602. * @returns "AnimationGroup"
  40603. */
  40604. getClassName(): string;
  40605. /**
  40606. * Creates a detailled string about the object
  40607. * @param fullDetails defines if the output string will support multiple levels of logging within scene loading
  40608. * @returns a string representing the object
  40609. */
  40610. toString(fullDetails?: boolean): string;
  40611. }
  40612. }
  40613. declare module "babylonjs/scene" {
  40614. import { Nullable } from "babylonjs/types";
  40615. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  40616. import { Observable } from "babylonjs/Misc/observable";
  40617. import { SmartArrayNoDuplicate, SmartArray, ISmartArrayLike } from "babylonjs/Misc/smartArray";
  40618. import { Vector2, Vector3, Matrix } from "babylonjs/Maths/math.vector";
  40619. import { Geometry } from "babylonjs/Meshes/geometry";
  40620. import { TransformNode } from "babylonjs/Meshes/transformNode";
  40621. import { SubMesh } from "babylonjs/Meshes/subMesh";
  40622. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  40623. import { Mesh } from "babylonjs/Meshes/mesh";
  40624. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  40625. import { Bone } from "babylonjs/Bones/bone";
  40626. import { Skeleton } from "babylonjs/Bones/skeleton";
  40627. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  40628. import { Camera } from "babylonjs/Cameras/camera";
  40629. import { AbstractScene } from "babylonjs/abstractScene";
  40630. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  40631. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  40632. import { Material } from "babylonjs/Materials/material";
  40633. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  40634. import { Effect } from "babylonjs/Materials/effect";
  40635. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  40636. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  40637. import { Light } from "babylonjs/Lights/light";
  40638. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  40639. import { ICollisionCoordinator } from "babylonjs/Collisions/collisionCoordinator";
  40640. import { PointerEventTypes, PointerInfoPre, PointerInfo } from "babylonjs/Events/pointerEvents";
  40641. import { KeyboardInfoPre, KeyboardInfo } from "babylonjs/Events/keyboardEvents";
  40642. import { PostProcessManager } from "babylonjs/PostProcesses/postProcessManager";
  40643. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  40644. import { RenderingGroupInfo, IRenderingManagerAutoClearSetup } from "babylonjs/Rendering/renderingManager";
  40645. import { ISceneComponent, ISceneSerializableComponent, Stage, SimpleStageAction, RenderTargetsStageAction, RenderTargetStageAction, MeshStageAction, EvaluateSubMeshStageAction, ActiveMeshStageAction, CameraStageAction, RenderingGroupStageAction, RenderingMeshStageAction, PointerMoveStageAction, PointerUpDownStageAction, CameraStageFrameBufferAction } from "babylonjs/sceneComponent";
  40646. import { Engine } from "babylonjs/Engines/engine";
  40647. import { Node } from "babylonjs/node";
  40648. import { MorphTarget } from "babylonjs/Morph/morphTarget";
  40649. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  40650. import { WebRequest } from "babylonjs/Misc/webRequest";
  40651. import { InputManager } from "babylonjs/Inputs/scene.inputManager";
  40652. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  40653. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  40654. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  40655. import { Plane } from "babylonjs/Maths/math.plane";
  40656. import { LoadFileError, RequestFileError, ReadFileError } from "babylonjs/Misc/fileTools";
  40657. import { IClipPlanesHolder } from "babylonjs/Misc/interfaces/iClipPlanesHolder";
  40658. import { Ray } from "babylonjs/Culling/ray";
  40659. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  40660. import { Animation } from "babylonjs/Animations/animation";
  40661. import { Animatable } from "babylonjs/Animations/animatable";
  40662. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  40663. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  40664. import { Collider } from "babylonjs/Collisions/collider";
  40665. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  40666. /**
  40667. * Define an interface for all classes that will hold resources
  40668. */
  40669. export interface IDisposable {
  40670. /**
  40671. * Releases all held resources
  40672. */
  40673. dispose(): void;
  40674. }
  40675. /** Interface defining initialization parameters for Scene class */
  40676. export interface SceneOptions {
  40677. /**
  40678. * Defines that scene should keep up-to-date a map of geometry to enable fast look-up by uniqueId
  40679. * It will improve performance when the number of geometries becomes important.
  40680. */
  40681. useGeometryUniqueIdsMap?: boolean;
  40682. /**
  40683. * Defines that each material of the scene should keep up-to-date a map of referencing meshes for fast diposing
  40684. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  40685. */
  40686. useMaterialMeshMap?: boolean;
  40687. /**
  40688. * Defines that each mesh of the scene should keep up-to-date a map of referencing cloned meshes for fast diposing
  40689. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  40690. */
  40691. useClonedMeshMap?: boolean;
  40692. /** Defines if the creation of the scene should impact the engine (Eg. UtilityLayer's scene) */
  40693. virtual?: boolean;
  40694. }
  40695. /**
  40696. * Represents a scene to be rendered by the engine.
  40697. * @see https://doc.babylonjs.com/features/scene
  40698. */
  40699. export class Scene extends AbstractScene implements IAnimatable, IClipPlanesHolder {
  40700. /** The fog is deactivated */
  40701. static readonly FOGMODE_NONE: number;
  40702. /** The fog density is following an exponential function */
  40703. static readonly FOGMODE_EXP: number;
  40704. /** The fog density is following an exponential function faster than FOGMODE_EXP */
  40705. static readonly FOGMODE_EXP2: number;
  40706. /** The fog density is following a linear function. */
  40707. static readonly FOGMODE_LINEAR: number;
  40708. /**
  40709. * Gets or sets the minimum deltatime when deterministic lock step is enabled
  40710. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  40711. */
  40712. static MinDeltaTime: number;
  40713. /**
  40714. * Gets or sets the maximum deltatime when deterministic lock step is enabled
  40715. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  40716. */
  40717. static MaxDeltaTime: number;
  40718. /**
  40719. * Factory used to create the default material.
  40720. * @param name The name of the material to create
  40721. * @param scene The scene to create the material for
  40722. * @returns The default material
  40723. */
  40724. static DefaultMaterialFactory(scene: Scene): Material;
  40725. /**
  40726. * Factory used to create the a collision coordinator.
  40727. * @returns The collision coordinator
  40728. */
  40729. static CollisionCoordinatorFactory(): ICollisionCoordinator;
  40730. /** @hidden */
  40731. _inputManager: InputManager;
  40732. /** Define this parameter if you are using multiple cameras and you want to specify which one should be used for pointer position */
  40733. cameraToUseForPointers: Nullable<Camera>;
  40734. /** @hidden */
  40735. readonly _isScene: boolean;
  40736. /** @hidden */
  40737. _blockEntityCollection: boolean;
  40738. /**
  40739. * Gets or sets a boolean that indicates if the scene must clear the render buffer before rendering a frame
  40740. */
  40741. autoClear: boolean;
  40742. /**
  40743. * Gets or sets a boolean that indicates if the scene must clear the depth and stencil buffers before rendering a frame
  40744. */
  40745. autoClearDepthAndStencil: boolean;
  40746. /**
  40747. * Defines the color used to clear the render buffer (Default is (0.2, 0.2, 0.3, 1.0))
  40748. */
  40749. clearColor: Color4;
  40750. /**
  40751. * Defines the color used to simulate the ambient color (Default is (0, 0, 0))
  40752. */
  40753. ambientColor: Color3;
  40754. /**
  40755. * This is use to store the default BRDF lookup for PBR materials in your scene.
  40756. * It should only be one of the following (if not the default embedded one):
  40757. * * For uncorrelated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = false) : https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  40758. * * For correlated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedBRDF.dds
  40759. * * For correlated multi scattering BRDF (pbr.brdf.useEnergyConservation = true and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  40760. * The material properties need to be setup according to the type of texture in use.
  40761. */
  40762. environmentBRDFTexture: BaseTexture;
  40763. /**
  40764. * Texture used in all pbr material as the reflection texture.
  40765. * As in the majority of the scene they are the same (exception for multi room and so on),
  40766. * this is easier to reference from here than from all the materials.
  40767. */
  40768. get environmentTexture(): Nullable<BaseTexture>;
  40769. /**
  40770. * Texture used in all pbr material as the reflection texture.
  40771. * As in the majority of the scene they are the same (exception for multi room and so on),
  40772. * this is easier to set here than in all the materials.
  40773. */
  40774. set environmentTexture(value: Nullable<BaseTexture>);
  40775. /** @hidden */
  40776. protected _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 reference from here than from all the materials.
  40782. */
  40783. get environmentIntensity(): number;
  40784. /**
  40785. * Intensity of the environment in all pbr material.
  40786. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  40787. * As in the majority of the scene they are the same (exception for multi room and so on),
  40788. * this is easier to set here than in all the materials.
  40789. */
  40790. set environmentIntensity(value: number);
  40791. /** @hidden */
  40792. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  40793. /**
  40794. * Default image processing configuration used either in the rendering
  40795. * Forward main pass or through the imageProcessingPostProcess if present.
  40796. * As in the majority of the scene they are the same (exception for multi camera),
  40797. * this is easier to reference from here than from all the materials and post process.
  40798. *
  40799. * No setter as we it is a shared configuration, you can set the values instead.
  40800. */
  40801. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  40802. private _forceWireframe;
  40803. /**
  40804. * Gets or sets a boolean indicating if all rendering must be done in wireframe
  40805. */
  40806. set forceWireframe(value: boolean);
  40807. get forceWireframe(): boolean;
  40808. private _skipFrustumClipping;
  40809. /**
  40810. * Gets or sets a boolean indicating if we should skip the frustum clipping part of the active meshes selection
  40811. */
  40812. set skipFrustumClipping(value: boolean);
  40813. get skipFrustumClipping(): boolean;
  40814. private _forcePointsCloud;
  40815. /**
  40816. * Gets or sets a boolean indicating if all rendering must be done in point cloud
  40817. */
  40818. set forcePointsCloud(value: boolean);
  40819. get forcePointsCloud(): boolean;
  40820. /**
  40821. * Gets or sets the active clipplane 1
  40822. */
  40823. clipPlane: Nullable<Plane>;
  40824. /**
  40825. * Gets or sets the active clipplane 2
  40826. */
  40827. clipPlane2: Nullable<Plane>;
  40828. /**
  40829. * Gets or sets the active clipplane 3
  40830. */
  40831. clipPlane3: Nullable<Plane>;
  40832. /**
  40833. * Gets or sets the active clipplane 4
  40834. */
  40835. clipPlane4: Nullable<Plane>;
  40836. /**
  40837. * Gets or sets the active clipplane 5
  40838. */
  40839. clipPlane5: Nullable<Plane>;
  40840. /**
  40841. * Gets or sets the active clipplane 6
  40842. */
  40843. clipPlane6: Nullable<Plane>;
  40844. /**
  40845. * Gets or sets a boolean indicating if animations are enabled
  40846. */
  40847. animationsEnabled: boolean;
  40848. private _animationPropertiesOverride;
  40849. /**
  40850. * Gets or sets the animation properties override
  40851. */
  40852. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  40853. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  40854. /**
  40855. * Gets or sets a boolean indicating if a constant deltatime has to be used
  40856. * This is mostly useful for testing purposes when you do not want the animations to scale with the framerate
  40857. */
  40858. useConstantAnimationDeltaTime: boolean;
  40859. /**
  40860. * Gets or sets a boolean indicating if the scene must keep the meshUnderPointer property updated
  40861. * Please note that it requires to run a ray cast through the scene on every frame
  40862. */
  40863. constantlyUpdateMeshUnderPointer: boolean;
  40864. /**
  40865. * Defines the HTML cursor to use when hovering over interactive elements
  40866. */
  40867. hoverCursor: string;
  40868. /**
  40869. * Defines the HTML default cursor to use (empty by default)
  40870. */
  40871. defaultCursor: string;
  40872. /**
  40873. * Defines whether cursors are handled by the scene.
  40874. */
  40875. doNotHandleCursors: boolean;
  40876. /**
  40877. * This is used to call preventDefault() on pointer down
  40878. * in order to block unwanted artifacts like system double clicks
  40879. */
  40880. preventDefaultOnPointerDown: boolean;
  40881. /**
  40882. * This is used to call preventDefault() on pointer up
  40883. * in order to block unwanted artifacts like system double clicks
  40884. */
  40885. preventDefaultOnPointerUp: boolean;
  40886. /**
  40887. * Gets or sets user defined metadata
  40888. */
  40889. metadata: any;
  40890. /**
  40891. * For internal use only. Please do not use.
  40892. */
  40893. reservedDataStore: any;
  40894. /**
  40895. * Gets the name of the plugin used to load this scene (null by default)
  40896. */
  40897. loadingPluginName: string;
  40898. /**
  40899. * Use this array to add regular expressions used to disable offline support for specific urls
  40900. */
  40901. disableOfflineSupportExceptionRules: RegExp[];
  40902. /**
  40903. * An event triggered when the scene is disposed.
  40904. */
  40905. onDisposeObservable: Observable<Scene>;
  40906. private _onDisposeObserver;
  40907. /** Sets a function to be executed when this scene is disposed. */
  40908. set onDispose(callback: () => void);
  40909. /**
  40910. * An event triggered before rendering the scene (right after animations and physics)
  40911. */
  40912. onBeforeRenderObservable: Observable<Scene>;
  40913. private _onBeforeRenderObserver;
  40914. /** Sets a function to be executed before rendering this scene */
  40915. set beforeRender(callback: Nullable<() => void>);
  40916. /**
  40917. * An event triggered after rendering the scene
  40918. */
  40919. onAfterRenderObservable: Observable<Scene>;
  40920. /**
  40921. * An event triggered after rendering the scene for an active camera (When scene.render is called this will be called after each camera)
  40922. */
  40923. onAfterRenderCameraObservable: Observable<Camera>;
  40924. private _onAfterRenderObserver;
  40925. /** Sets a function to be executed after rendering this scene */
  40926. set afterRender(callback: Nullable<() => void>);
  40927. /**
  40928. * An event triggered before animating the scene
  40929. */
  40930. onBeforeAnimationsObservable: Observable<Scene>;
  40931. /**
  40932. * An event triggered after animations processing
  40933. */
  40934. onAfterAnimationsObservable: Observable<Scene>;
  40935. /**
  40936. * An event triggered before draw calls are ready to be sent
  40937. */
  40938. onBeforeDrawPhaseObservable: Observable<Scene>;
  40939. /**
  40940. * An event triggered after draw calls have been sent
  40941. */
  40942. onAfterDrawPhaseObservable: Observable<Scene>;
  40943. /**
  40944. * An event triggered when the scene is ready
  40945. */
  40946. onReadyObservable: Observable<Scene>;
  40947. /**
  40948. * An event triggered before rendering a camera
  40949. */
  40950. onBeforeCameraRenderObservable: Observable<Camera>;
  40951. private _onBeforeCameraRenderObserver;
  40952. /** Sets a function to be executed before rendering a camera*/
  40953. set beforeCameraRender(callback: () => void);
  40954. /**
  40955. * An event triggered after rendering a camera
  40956. */
  40957. onAfterCameraRenderObservable: Observable<Camera>;
  40958. private _onAfterCameraRenderObserver;
  40959. /** Sets a function to be executed after rendering a camera*/
  40960. set afterCameraRender(callback: () => void);
  40961. /**
  40962. * An event triggered when active meshes evaluation is about to start
  40963. */
  40964. onBeforeActiveMeshesEvaluationObservable: Observable<Scene>;
  40965. /**
  40966. * An event triggered when active meshes evaluation is done
  40967. */
  40968. onAfterActiveMeshesEvaluationObservable: Observable<Scene>;
  40969. /**
  40970. * An event triggered when particles rendering is about to start
  40971. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  40972. */
  40973. onBeforeParticlesRenderingObservable: Observable<Scene>;
  40974. /**
  40975. * An event triggered when particles rendering is done
  40976. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  40977. */
  40978. onAfterParticlesRenderingObservable: Observable<Scene>;
  40979. /**
  40980. * An event triggered when SceneLoader.Append or SceneLoader.Load or SceneLoader.ImportMesh were successfully executed
  40981. */
  40982. onDataLoadedObservable: Observable<Scene>;
  40983. /**
  40984. * An event triggered when a camera is created
  40985. */
  40986. onNewCameraAddedObservable: Observable<Camera>;
  40987. /**
  40988. * An event triggered when a camera is removed
  40989. */
  40990. onCameraRemovedObservable: Observable<Camera>;
  40991. /**
  40992. * An event triggered when a light is created
  40993. */
  40994. onNewLightAddedObservable: Observable<Light>;
  40995. /**
  40996. * An event triggered when a light is removed
  40997. */
  40998. onLightRemovedObservable: Observable<Light>;
  40999. /**
  41000. * An event triggered when a geometry is created
  41001. */
  41002. onNewGeometryAddedObservable: Observable<Geometry>;
  41003. /**
  41004. * An event triggered when a geometry is removed
  41005. */
  41006. onGeometryRemovedObservable: Observable<Geometry>;
  41007. /**
  41008. * An event triggered when a transform node is created
  41009. */
  41010. onNewTransformNodeAddedObservable: Observable<TransformNode>;
  41011. /**
  41012. * An event triggered when a transform node is removed
  41013. */
  41014. onTransformNodeRemovedObservable: Observable<TransformNode>;
  41015. /**
  41016. * An event triggered when a mesh is created
  41017. */
  41018. onNewMeshAddedObservable: Observable<AbstractMesh>;
  41019. /**
  41020. * An event triggered when a mesh is removed
  41021. */
  41022. onMeshRemovedObservable: Observable<AbstractMesh>;
  41023. /**
  41024. * An event triggered when a skeleton is created
  41025. */
  41026. onNewSkeletonAddedObservable: Observable<Skeleton>;
  41027. /**
  41028. * An event triggered when a skeleton is removed
  41029. */
  41030. onSkeletonRemovedObservable: Observable<Skeleton>;
  41031. /**
  41032. * An event triggered when a material is created
  41033. */
  41034. onNewMaterialAddedObservable: Observable<Material>;
  41035. /**
  41036. * An event triggered when a material is removed
  41037. */
  41038. onMaterialRemovedObservable: Observable<Material>;
  41039. /**
  41040. * An event triggered when a texture is created
  41041. */
  41042. onNewTextureAddedObservable: Observable<BaseTexture>;
  41043. /**
  41044. * An event triggered when a texture is removed
  41045. */
  41046. onTextureRemovedObservable: Observable<BaseTexture>;
  41047. /**
  41048. * An event triggered when render targets are about to be rendered
  41049. * Can happen multiple times per frame.
  41050. */
  41051. onBeforeRenderTargetsRenderObservable: Observable<Scene>;
  41052. /**
  41053. * An event triggered when render targets were rendered.
  41054. * Can happen multiple times per frame.
  41055. */
  41056. onAfterRenderTargetsRenderObservable: Observable<Scene>;
  41057. /**
  41058. * An event triggered before calculating deterministic simulation step
  41059. */
  41060. onBeforeStepObservable: Observable<Scene>;
  41061. /**
  41062. * An event triggered after calculating deterministic simulation step
  41063. */
  41064. onAfterStepObservable: Observable<Scene>;
  41065. /**
  41066. * An event triggered when the activeCamera property is updated
  41067. */
  41068. onActiveCameraChanged: Observable<Scene>;
  41069. /**
  41070. * This Observable will be triggered before rendering each renderingGroup of each rendered camera.
  41071. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  41072. * If you wish to register an Observer only for a given set of renderingGroup, use the mask with a combination of the renderingGroup index elevated to the power of two (1 for renderingGroup 0, 2 for renderingrOup1, 4 for 2 and 8 for 3)
  41073. */
  41074. onBeforeRenderingGroupObservable: Observable<RenderingGroupInfo>;
  41075. /**
  41076. * This Observable will be triggered after rendering each renderingGroup of each rendered camera.
  41077. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  41078. * 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)
  41079. */
  41080. onAfterRenderingGroupObservable: Observable<RenderingGroupInfo>;
  41081. /**
  41082. * This Observable will when a mesh has been imported into the scene.
  41083. */
  41084. onMeshImportedObservable: Observable<AbstractMesh>;
  41085. /**
  41086. * This Observable will when an animation file has been imported into the scene.
  41087. */
  41088. onAnimationFileImportedObservable: Observable<Scene>;
  41089. /**
  41090. * Gets or sets a user defined funtion to select LOD from a mesh and a camera.
  41091. * By default this function is undefined and Babylon.js will select LOD based on distance to camera
  41092. */
  41093. customLODSelector: (mesh: AbstractMesh, camera: Camera) => Nullable<AbstractMesh>;
  41094. /** @hidden */
  41095. _registeredForLateAnimationBindings: SmartArrayNoDuplicate<any>;
  41096. /**
  41097. * Gets or sets a predicate used to select candidate meshes for a pointer down event
  41098. */
  41099. pointerDownPredicate: (Mesh: AbstractMesh) => boolean;
  41100. /**
  41101. * Gets or sets a predicate used to select candidate meshes for a pointer up event
  41102. */
  41103. pointerUpPredicate: (Mesh: AbstractMesh) => boolean;
  41104. /**
  41105. * Gets or sets a predicate used to select candidate meshes for a pointer move event
  41106. */
  41107. pointerMovePredicate: (Mesh: AbstractMesh) => boolean;
  41108. /** Callback called when a pointer move is detected */
  41109. onPointerMove: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  41110. /** Callback called when a pointer down is detected */
  41111. onPointerDown: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  41112. /** Callback called when a pointer up is detected */
  41113. onPointerUp: (evt: PointerEvent, pickInfo: Nullable<PickingInfo>, type: PointerEventTypes) => void;
  41114. /** Callback called when a pointer pick is detected */
  41115. onPointerPick: (evt: PointerEvent, pickInfo: PickingInfo) => void;
  41116. /**
  41117. * 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).
  41118. * You have the possibility to skip the process and the call to onPointerObservable by setting PointerInfoPre.skipOnPointerObservable to true
  41119. */
  41120. onPrePointerObservable: Observable<PointerInfoPre>;
  41121. /**
  41122. * Observable event triggered each time an input event is received from the rendering canvas
  41123. */
  41124. onPointerObservable: Observable<PointerInfo>;
  41125. /**
  41126. * Gets the pointer coordinates without any translation (ie. straight out of the pointer event)
  41127. */
  41128. get unTranslatedPointer(): Vector2;
  41129. /**
  41130. * Gets or sets the distance in pixel that you have to move to prevent some events. Default is 10 pixels
  41131. */
  41132. static get DragMovementThreshold(): number;
  41133. static set DragMovementThreshold(value: number);
  41134. /**
  41135. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 500 ms
  41136. */
  41137. static get LongPressDelay(): number;
  41138. static set LongPressDelay(value: number);
  41139. /**
  41140. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 300 ms
  41141. */
  41142. static get DoubleClickDelay(): number;
  41143. static set DoubleClickDelay(value: number);
  41144. /** If you need to check double click without raising a single click at first click, enable this flag */
  41145. static get ExclusiveDoubleClickMode(): boolean;
  41146. static set ExclusiveDoubleClickMode(value: boolean);
  41147. /** @hidden */
  41148. _mirroredCameraPosition: Nullable<Vector3>;
  41149. /**
  41150. * This observable event is triggered when any keyboard event si raised and registered during Scene.attachControl()
  41151. * You have the possibility to skip the process and the call to onKeyboardObservable by setting KeyboardInfoPre.skipOnPointerObservable to true
  41152. */
  41153. onPreKeyboardObservable: Observable<KeyboardInfoPre>;
  41154. /**
  41155. * Observable event triggered each time an keyboard event is received from the hosting window
  41156. */
  41157. onKeyboardObservable: Observable<KeyboardInfo>;
  41158. private _useRightHandedSystem;
  41159. /**
  41160. * Gets or sets a boolean indicating if the scene must use right-handed coordinates system
  41161. */
  41162. set useRightHandedSystem(value: boolean);
  41163. get useRightHandedSystem(): boolean;
  41164. private _timeAccumulator;
  41165. private _currentStepId;
  41166. private _currentInternalStep;
  41167. /**
  41168. * Sets the step Id used by deterministic lock step
  41169. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  41170. * @param newStepId defines the step Id
  41171. */
  41172. setStepId(newStepId: number): void;
  41173. /**
  41174. * Gets the step Id used by deterministic lock step
  41175. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  41176. * @returns the step Id
  41177. */
  41178. getStepId(): number;
  41179. /**
  41180. * Gets the internal step used by deterministic lock step
  41181. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  41182. * @returns the internal step
  41183. */
  41184. getInternalStep(): number;
  41185. private _fogEnabled;
  41186. /**
  41187. * Gets or sets a boolean indicating if fog is enabled on this scene
  41188. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41189. * (Default is true)
  41190. */
  41191. set fogEnabled(value: boolean);
  41192. get fogEnabled(): boolean;
  41193. private _fogMode;
  41194. /**
  41195. * Gets or sets the fog mode to use
  41196. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41197. * | mode | value |
  41198. * | --- | --- |
  41199. * | FOGMODE_NONE | 0 |
  41200. * | FOGMODE_EXP | 1 |
  41201. * | FOGMODE_EXP2 | 2 |
  41202. * | FOGMODE_LINEAR | 3 |
  41203. */
  41204. set fogMode(value: number);
  41205. get fogMode(): number;
  41206. /**
  41207. * Gets or sets the fog color to use
  41208. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41209. * (Default is Color3(0.2, 0.2, 0.3))
  41210. */
  41211. fogColor: Color3;
  41212. /**
  41213. * Gets or sets the fog density to use
  41214. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41215. * (Default is 0.1)
  41216. */
  41217. fogDensity: number;
  41218. /**
  41219. * Gets or sets the fog start distance to use
  41220. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41221. * (Default is 0)
  41222. */
  41223. fogStart: number;
  41224. /**
  41225. * Gets or sets the fog end distance to use
  41226. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41227. * (Default is 1000)
  41228. */
  41229. fogEnd: number;
  41230. /**
  41231. * Flag indicating that the frame buffer binding is handled by another component
  41232. */
  41233. prePass: boolean;
  41234. private _shadowsEnabled;
  41235. /**
  41236. * Gets or sets a boolean indicating if shadows are enabled on this scene
  41237. */
  41238. set shadowsEnabled(value: boolean);
  41239. get shadowsEnabled(): boolean;
  41240. private _lightsEnabled;
  41241. /**
  41242. * Gets or sets a boolean indicating if lights are enabled on this scene
  41243. */
  41244. set lightsEnabled(value: boolean);
  41245. get lightsEnabled(): boolean;
  41246. /** All of the active cameras added to this scene. */
  41247. activeCameras: Camera[];
  41248. /** @hidden */
  41249. _activeCamera: Nullable<Camera>;
  41250. /** Gets or sets the current active camera */
  41251. get activeCamera(): Nullable<Camera>;
  41252. set activeCamera(value: Nullable<Camera>);
  41253. private _defaultMaterial;
  41254. /** The default material used on meshes when no material is affected */
  41255. get defaultMaterial(): Material;
  41256. /** The default material used on meshes when no material is affected */
  41257. set defaultMaterial(value: Material);
  41258. private _texturesEnabled;
  41259. /**
  41260. * Gets or sets a boolean indicating if textures are enabled on this scene
  41261. */
  41262. set texturesEnabled(value: boolean);
  41263. get texturesEnabled(): boolean;
  41264. /**
  41265. * Gets or sets a boolean indicating if physic engines are enabled on this scene
  41266. */
  41267. physicsEnabled: boolean;
  41268. /**
  41269. * Gets or sets a boolean indicating if particles are enabled on this scene
  41270. */
  41271. particlesEnabled: boolean;
  41272. /**
  41273. * Gets or sets a boolean indicating if sprites are enabled on this scene
  41274. */
  41275. spritesEnabled: boolean;
  41276. private _skeletonsEnabled;
  41277. /**
  41278. * Gets or sets a boolean indicating if skeletons are enabled on this scene
  41279. */
  41280. set skeletonsEnabled(value: boolean);
  41281. get skeletonsEnabled(): boolean;
  41282. /**
  41283. * Gets or sets a boolean indicating if lens flares are enabled on this scene
  41284. */
  41285. lensFlaresEnabled: boolean;
  41286. /**
  41287. * Gets or sets a boolean indicating if collisions are enabled on this scene
  41288. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  41289. */
  41290. collisionsEnabled: boolean;
  41291. private _collisionCoordinator;
  41292. /** @hidden */
  41293. get collisionCoordinator(): ICollisionCoordinator;
  41294. /**
  41295. * Defines the gravity applied to this scene (used only for collisions)
  41296. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  41297. */
  41298. gravity: Vector3;
  41299. /**
  41300. * Gets or sets a boolean indicating if postprocesses are enabled on this scene
  41301. */
  41302. postProcessesEnabled: boolean;
  41303. /**
  41304. * Gets the current postprocess manager
  41305. */
  41306. postProcessManager: PostProcessManager;
  41307. /**
  41308. * Gets or sets a boolean indicating if render targets are enabled on this scene
  41309. */
  41310. renderTargetsEnabled: boolean;
  41311. /**
  41312. * Gets or sets a boolean indicating if next render targets must be dumped as image for debugging purposes
  41313. * We recommend not using it and instead rely on Spector.js: http://spector.babylonjs.com
  41314. */
  41315. dumpNextRenderTargets: boolean;
  41316. /**
  41317. * The list of user defined render targets added to the scene
  41318. */
  41319. customRenderTargets: RenderTargetTexture[];
  41320. /**
  41321. * Defines if texture loading must be delayed
  41322. * If true, textures will only be loaded when they need to be rendered
  41323. */
  41324. useDelayedTextureLoading: boolean;
  41325. /**
  41326. * Gets the list of meshes imported to the scene through SceneLoader
  41327. */
  41328. importedMeshesFiles: String[];
  41329. /**
  41330. * Gets or sets a boolean indicating if probes are enabled on this scene
  41331. */
  41332. probesEnabled: boolean;
  41333. /**
  41334. * Gets or sets the current offline provider to use to store scene data
  41335. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  41336. */
  41337. offlineProvider: IOfflineProvider;
  41338. /**
  41339. * Gets or sets the action manager associated with the scene
  41340. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  41341. */
  41342. actionManager: AbstractActionManager;
  41343. private _meshesForIntersections;
  41344. /**
  41345. * Gets or sets a boolean indicating if procedural textures are enabled on this scene
  41346. */
  41347. proceduralTexturesEnabled: boolean;
  41348. private _engine;
  41349. private _totalVertices;
  41350. /** @hidden */
  41351. _activeIndices: PerfCounter;
  41352. /** @hidden */
  41353. _activeParticles: PerfCounter;
  41354. /** @hidden */
  41355. _activeBones: PerfCounter;
  41356. private _animationRatio;
  41357. /** @hidden */
  41358. _animationTimeLast: number;
  41359. /** @hidden */
  41360. _animationTime: number;
  41361. /**
  41362. * Gets or sets a general scale for animation speed
  41363. * @see https://www.babylonjs-playground.com/#IBU2W7#3
  41364. */
  41365. animationTimeScale: number;
  41366. /** @hidden */
  41367. _cachedMaterial: Nullable<Material>;
  41368. /** @hidden */
  41369. _cachedEffect: Nullable<Effect>;
  41370. /** @hidden */
  41371. _cachedVisibility: Nullable<number>;
  41372. private _renderId;
  41373. private _frameId;
  41374. private _executeWhenReadyTimeoutId;
  41375. private _intermediateRendering;
  41376. private _viewUpdateFlag;
  41377. private _projectionUpdateFlag;
  41378. /** @hidden */
  41379. _toBeDisposed: Nullable<IDisposable>[];
  41380. private _activeRequests;
  41381. /** @hidden */
  41382. _pendingData: any[];
  41383. private _isDisposed;
  41384. /**
  41385. * Gets or sets a boolean indicating that all submeshes of active meshes must be rendered
  41386. * Use this boolean to avoid computing frustum clipping on submeshes (This could help when you are CPU bound)
  41387. */
  41388. dispatchAllSubMeshesOfActiveMeshes: boolean;
  41389. private _activeMeshes;
  41390. private _processedMaterials;
  41391. private _renderTargets;
  41392. /** @hidden */
  41393. _activeParticleSystems: SmartArray<IParticleSystem>;
  41394. private _activeSkeletons;
  41395. private _softwareSkinnedMeshes;
  41396. private _renderingManager;
  41397. /** @hidden */
  41398. _activeAnimatables: import("babylonjs/Animations/animatable").Animatable[];
  41399. private _transformMatrix;
  41400. private _sceneUbo;
  41401. /** @hidden */
  41402. _viewMatrix: Matrix;
  41403. private _projectionMatrix;
  41404. /** @hidden */
  41405. _forcedViewPosition: Nullable<Vector3>;
  41406. /** @hidden */
  41407. _frustumPlanes: Plane[];
  41408. /**
  41409. * Gets the list of frustum planes (built from the active camera)
  41410. */
  41411. get frustumPlanes(): Plane[];
  41412. /**
  41413. * Gets or sets a boolean indicating if lights must be sorted by priority (off by default)
  41414. * This is useful if there are more lights that the maximum simulteanous authorized
  41415. */
  41416. requireLightSorting: boolean;
  41417. /** @hidden */
  41418. readonly useMaterialMeshMap: boolean;
  41419. /** @hidden */
  41420. readonly useClonedMeshMap: boolean;
  41421. private _externalData;
  41422. private _uid;
  41423. /**
  41424. * @hidden
  41425. * Backing store of defined scene components.
  41426. */
  41427. _components: ISceneComponent[];
  41428. /**
  41429. * @hidden
  41430. * Backing store of defined scene components.
  41431. */
  41432. _serializableComponents: ISceneSerializableComponent[];
  41433. /**
  41434. * List of components to register on the next registration step.
  41435. */
  41436. private _transientComponents;
  41437. /**
  41438. * Registers the transient components if needed.
  41439. */
  41440. private _registerTransientComponents;
  41441. /**
  41442. * @hidden
  41443. * Add a component to the scene.
  41444. * Note that the ccomponent could be registered on th next frame if this is called after
  41445. * the register component stage.
  41446. * @param component Defines the component to add to the scene
  41447. */
  41448. _addComponent(component: ISceneComponent): void;
  41449. /**
  41450. * @hidden
  41451. * Gets a component from the scene.
  41452. * @param name defines the name of the component to retrieve
  41453. * @returns the component or null if not present
  41454. */
  41455. _getComponent(name: string): Nullable<ISceneComponent>;
  41456. /**
  41457. * @hidden
  41458. * Defines the actions happening before camera updates.
  41459. */
  41460. _beforeCameraUpdateStage: Stage<SimpleStageAction>;
  41461. /**
  41462. * @hidden
  41463. * Defines the actions happening before clear the canvas.
  41464. */
  41465. _beforeClearStage: Stage<SimpleStageAction>;
  41466. /**
  41467. * @hidden
  41468. * Defines the actions when collecting render targets for the frame.
  41469. */
  41470. _gatherRenderTargetsStage: Stage<RenderTargetsStageAction>;
  41471. /**
  41472. * @hidden
  41473. * Defines the actions happening for one camera in the frame.
  41474. */
  41475. _gatherActiveCameraRenderTargetsStage: Stage<RenderTargetsStageAction>;
  41476. /**
  41477. * @hidden
  41478. * Defines the actions happening during the per mesh ready checks.
  41479. */
  41480. _isReadyForMeshStage: Stage<MeshStageAction>;
  41481. /**
  41482. * @hidden
  41483. * Defines the actions happening before evaluate active mesh checks.
  41484. */
  41485. _beforeEvaluateActiveMeshStage: Stage<SimpleStageAction>;
  41486. /**
  41487. * @hidden
  41488. * Defines the actions happening during the evaluate sub mesh checks.
  41489. */
  41490. _evaluateSubMeshStage: Stage<EvaluateSubMeshStageAction>;
  41491. /**
  41492. * @hidden
  41493. * Defines the actions happening during the active mesh stage.
  41494. */
  41495. _activeMeshStage: Stage<ActiveMeshStageAction>;
  41496. /**
  41497. * @hidden
  41498. * Defines the actions happening during the per camera render target step.
  41499. */
  41500. _cameraDrawRenderTargetStage: Stage<CameraStageFrameBufferAction>;
  41501. /**
  41502. * @hidden
  41503. * Defines the actions happening just before the active camera is drawing.
  41504. */
  41505. _beforeCameraDrawStage: Stage<CameraStageAction>;
  41506. /**
  41507. * @hidden
  41508. * Defines the actions happening just before a render target is drawing.
  41509. */
  41510. _beforeRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  41511. /**
  41512. * @hidden
  41513. * Defines the actions happening just before a rendering group is drawing.
  41514. */
  41515. _beforeRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  41516. /**
  41517. * @hidden
  41518. * Defines the actions happening just before a mesh is drawing.
  41519. */
  41520. _beforeRenderingMeshStage: Stage<RenderingMeshStageAction>;
  41521. /**
  41522. * @hidden
  41523. * Defines the actions happening just after a mesh has been drawn.
  41524. */
  41525. _afterRenderingMeshStage: Stage<RenderingMeshStageAction>;
  41526. /**
  41527. * @hidden
  41528. * Defines the actions happening just after a rendering group has been drawn.
  41529. */
  41530. _afterRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  41531. /**
  41532. * @hidden
  41533. * Defines the actions happening just after the active camera has been drawn.
  41534. */
  41535. _afterCameraDrawStage: Stage<CameraStageAction>;
  41536. /**
  41537. * @hidden
  41538. * Defines the actions happening just after a render target has been drawn.
  41539. */
  41540. _afterRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  41541. /**
  41542. * @hidden
  41543. * Defines the actions happening just after rendering all cameras and computing intersections.
  41544. */
  41545. _afterRenderStage: Stage<SimpleStageAction>;
  41546. /**
  41547. * @hidden
  41548. * Defines the actions happening when a pointer move event happens.
  41549. */
  41550. _pointerMoveStage: Stage<PointerMoveStageAction>;
  41551. /**
  41552. * @hidden
  41553. * Defines the actions happening when a pointer down event happens.
  41554. */
  41555. _pointerDownStage: Stage<PointerUpDownStageAction>;
  41556. /**
  41557. * @hidden
  41558. * Defines the actions happening when a pointer up event happens.
  41559. */
  41560. _pointerUpStage: Stage<PointerUpDownStageAction>;
  41561. /**
  41562. * an optional map from Geometry Id to Geometry index in the 'geometries' array
  41563. */
  41564. private geometriesByUniqueId;
  41565. /**
  41566. * Creates a new Scene
  41567. * @param engine defines the engine to use to render this scene
  41568. * @param options defines the scene options
  41569. */
  41570. constructor(engine: Engine, options?: SceneOptions);
  41571. /**
  41572. * Gets a string identifying the name of the class
  41573. * @returns "Scene" string
  41574. */
  41575. getClassName(): string;
  41576. private _defaultMeshCandidates;
  41577. /**
  41578. * @hidden
  41579. */
  41580. _getDefaultMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  41581. private _defaultSubMeshCandidates;
  41582. /**
  41583. * @hidden
  41584. */
  41585. _getDefaultSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  41586. /**
  41587. * Sets the default candidate providers for the scene.
  41588. * This sets the getActiveMeshCandidates, getActiveSubMeshCandidates, getIntersectingSubMeshCandidates
  41589. * and getCollidingSubMeshCandidates to their default function
  41590. */
  41591. setDefaultCandidateProviders(): void;
  41592. /**
  41593. * Gets the mesh that is currently under the pointer
  41594. */
  41595. get meshUnderPointer(): Nullable<AbstractMesh>;
  41596. /**
  41597. * Gets or sets the current on-screen X position of the pointer
  41598. */
  41599. get pointerX(): number;
  41600. set pointerX(value: number);
  41601. /**
  41602. * Gets or sets the current on-screen Y position of the pointer
  41603. */
  41604. get pointerY(): number;
  41605. set pointerY(value: number);
  41606. /**
  41607. * Gets the cached material (ie. the latest rendered one)
  41608. * @returns the cached material
  41609. */
  41610. getCachedMaterial(): Nullable<Material>;
  41611. /**
  41612. * Gets the cached effect (ie. the latest rendered one)
  41613. * @returns the cached effect
  41614. */
  41615. getCachedEffect(): Nullable<Effect>;
  41616. /**
  41617. * Gets the cached visibility state (ie. the latest rendered one)
  41618. * @returns the cached visibility state
  41619. */
  41620. getCachedVisibility(): Nullable<number>;
  41621. /**
  41622. * Gets a boolean indicating if the current material / effect / visibility must be bind again
  41623. * @param material defines the current material
  41624. * @param effect defines the current effect
  41625. * @param visibility defines the current visibility state
  41626. * @returns true if one parameter is not cached
  41627. */
  41628. isCachedMaterialInvalid(material: Material, effect: Effect, visibility?: number): boolean;
  41629. /**
  41630. * Gets the engine associated with the scene
  41631. * @returns an Engine
  41632. */
  41633. getEngine(): Engine;
  41634. /**
  41635. * Gets the total number of vertices rendered per frame
  41636. * @returns the total number of vertices rendered per frame
  41637. */
  41638. getTotalVertices(): number;
  41639. /**
  41640. * Gets the performance counter for total vertices
  41641. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  41642. */
  41643. get totalVerticesPerfCounter(): PerfCounter;
  41644. /**
  41645. * Gets the total number of active indices rendered per frame (You can deduce the number of rendered triangles by dividing this number by 3)
  41646. * @returns the total number of active indices rendered per frame
  41647. */
  41648. getActiveIndices(): number;
  41649. /**
  41650. * Gets the performance counter for active indices
  41651. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  41652. */
  41653. get totalActiveIndicesPerfCounter(): PerfCounter;
  41654. /**
  41655. * Gets the total number of active particles rendered per frame
  41656. * @returns the total number of active particles rendered per frame
  41657. */
  41658. getActiveParticles(): number;
  41659. /**
  41660. * Gets the performance counter for active particles
  41661. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  41662. */
  41663. get activeParticlesPerfCounter(): PerfCounter;
  41664. /**
  41665. * Gets the total number of active bones rendered per frame
  41666. * @returns the total number of active bones rendered per frame
  41667. */
  41668. getActiveBones(): number;
  41669. /**
  41670. * Gets the performance counter for active bones
  41671. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  41672. */
  41673. get activeBonesPerfCounter(): PerfCounter;
  41674. /**
  41675. * Gets the array of active meshes
  41676. * @returns an array of AbstractMesh
  41677. */
  41678. getActiveMeshes(): SmartArray<AbstractMesh>;
  41679. /**
  41680. * Gets the animation ratio (which is 1.0 is the scene renders at 60fps and 2 if the scene renders at 30fps, etc.)
  41681. * @returns a number
  41682. */
  41683. getAnimationRatio(): number;
  41684. /**
  41685. * Gets an unique Id for the current render phase
  41686. * @returns a number
  41687. */
  41688. getRenderId(): number;
  41689. /**
  41690. * Gets an unique Id for the current frame
  41691. * @returns a number
  41692. */
  41693. getFrameId(): number;
  41694. /** Call this function if you want to manually increment the render Id*/
  41695. incrementRenderId(): void;
  41696. private _createUbo;
  41697. /**
  41698. * Use this method to simulate a pointer move on a mesh
  41699. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  41700. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  41701. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  41702. * @returns the current scene
  41703. */
  41704. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  41705. /**
  41706. * Use this method to simulate a pointer down on a mesh
  41707. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  41708. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  41709. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  41710. * @returns the current scene
  41711. */
  41712. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  41713. /**
  41714. * Use this method to simulate a pointer up on a mesh
  41715. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  41716. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  41717. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  41718. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  41719. * @returns the current scene
  41720. */
  41721. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): Scene;
  41722. /**
  41723. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  41724. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  41725. * @returns true if the pointer was captured
  41726. */
  41727. isPointerCaptured(pointerId?: number): boolean;
  41728. /**
  41729. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  41730. * @param attachUp defines if you want to attach events to pointerup
  41731. * @param attachDown defines if you want to attach events to pointerdown
  41732. * @param attachMove defines if you want to attach events to pointermove
  41733. */
  41734. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  41735. /** Detaches all event handlers*/
  41736. detachControl(): void;
  41737. /**
  41738. * This function will check if the scene can be rendered (textures are loaded, shaders are compiled)
  41739. * Delay loaded resources are not taking in account
  41740. * @return true if all required resources are ready
  41741. */
  41742. isReady(): boolean;
  41743. /** Resets all cached information relative to material (including effect and visibility) */
  41744. resetCachedMaterial(): void;
  41745. /**
  41746. * Registers a function to be called before every frame render
  41747. * @param func defines the function to register
  41748. */
  41749. registerBeforeRender(func: () => void): void;
  41750. /**
  41751. * Unregisters a function called before every frame render
  41752. * @param func defines the function to unregister
  41753. */
  41754. unregisterBeforeRender(func: () => void): void;
  41755. /**
  41756. * Registers a function to be called after every frame render
  41757. * @param func defines the function to register
  41758. */
  41759. registerAfterRender(func: () => void): void;
  41760. /**
  41761. * Unregisters a function called after every frame render
  41762. * @param func defines the function to unregister
  41763. */
  41764. unregisterAfterRender(func: () => void): void;
  41765. private _executeOnceBeforeRender;
  41766. /**
  41767. * The provided function will run before render once and will be disposed afterwards.
  41768. * A timeout delay can be provided so that the function will be executed in N ms.
  41769. * The timeout is using the browser's native setTimeout so time percision cannot be guaranteed.
  41770. * @param func The function to be executed.
  41771. * @param timeout optional delay in ms
  41772. */
  41773. executeOnceBeforeRender(func: () => void, timeout?: number): void;
  41774. /** @hidden */
  41775. _addPendingData(data: any): void;
  41776. /** @hidden */
  41777. _removePendingData(data: any): void;
  41778. /**
  41779. * Returns the number of items waiting to be loaded
  41780. * @returns the number of items waiting to be loaded
  41781. */
  41782. getWaitingItemsCount(): number;
  41783. /**
  41784. * Returns a boolean indicating if the scene is still loading data
  41785. */
  41786. get isLoading(): boolean;
  41787. /**
  41788. * Registers a function to be executed when the scene is ready
  41789. * @param {Function} func - the function to be executed
  41790. */
  41791. executeWhenReady(func: () => void): void;
  41792. /**
  41793. * Returns a promise that resolves when the scene is ready
  41794. * @returns A promise that resolves when the scene is ready
  41795. */
  41796. whenReadyAsync(): Promise<void>;
  41797. /** @hidden */
  41798. _checkIsReady(): void;
  41799. /**
  41800. * Gets all animatable attached to the scene
  41801. */
  41802. get animatables(): Animatable[];
  41803. /**
  41804. * Resets the last animation time frame.
  41805. * Useful to override when animations start running when loading a scene for the first time.
  41806. */
  41807. resetLastAnimationTimeFrame(): void;
  41808. /**
  41809. * Gets the current view matrix
  41810. * @returns a Matrix
  41811. */
  41812. getViewMatrix(): Matrix;
  41813. /**
  41814. * Gets the current projection matrix
  41815. * @returns a Matrix
  41816. */
  41817. getProjectionMatrix(): Matrix;
  41818. /**
  41819. * Gets the current transform matrix
  41820. * @returns a Matrix made of View * Projection
  41821. */
  41822. getTransformMatrix(): Matrix;
  41823. /**
  41824. * Sets the current transform matrix
  41825. * @param viewL defines the View matrix to use
  41826. * @param projectionL defines the Projection matrix to use
  41827. * @param viewR defines the right View matrix to use (if provided)
  41828. * @param projectionR defines the right Projection matrix to use (if provided)
  41829. */
  41830. setTransformMatrix(viewL: Matrix, projectionL: Matrix, viewR?: Matrix, projectionR?: Matrix): void;
  41831. /**
  41832. * Gets the uniform buffer used to store scene data
  41833. * @returns a UniformBuffer
  41834. */
  41835. getSceneUniformBuffer(): UniformBuffer;
  41836. /**
  41837. * Gets an unique (relatively to the current scene) Id
  41838. * @returns an unique number for the scene
  41839. */
  41840. getUniqueId(): number;
  41841. /**
  41842. * Add a mesh to the list of scene's meshes
  41843. * @param newMesh defines the mesh to add
  41844. * @param recursive if all child meshes should also be added to the scene
  41845. */
  41846. addMesh(newMesh: AbstractMesh, recursive?: boolean): void;
  41847. /**
  41848. * Remove a mesh for the list of scene's meshes
  41849. * @param toRemove defines the mesh to remove
  41850. * @param recursive if all child meshes should also be removed from the scene
  41851. * @returns the index where the mesh was in the mesh list
  41852. */
  41853. removeMesh(toRemove: AbstractMesh, recursive?: boolean): number;
  41854. /**
  41855. * Add a transform node to the list of scene's transform nodes
  41856. * @param newTransformNode defines the transform node to add
  41857. */
  41858. addTransformNode(newTransformNode: TransformNode): void;
  41859. /**
  41860. * Remove a transform node for the list of scene's transform nodes
  41861. * @param toRemove defines the transform node to remove
  41862. * @returns the index where the transform node was in the transform node list
  41863. */
  41864. removeTransformNode(toRemove: TransformNode): number;
  41865. /**
  41866. * Remove a skeleton for the list of scene's skeletons
  41867. * @param toRemove defines the skeleton to remove
  41868. * @returns the index where the skeleton was in the skeleton list
  41869. */
  41870. removeSkeleton(toRemove: Skeleton): number;
  41871. /**
  41872. * Remove a morph target for the list of scene's morph targets
  41873. * @param toRemove defines the morph target to remove
  41874. * @returns the index where the morph target was in the morph target list
  41875. */
  41876. removeMorphTargetManager(toRemove: MorphTargetManager): number;
  41877. /**
  41878. * Remove a light for the list of scene's lights
  41879. * @param toRemove defines the light to remove
  41880. * @returns the index where the light was in the light list
  41881. */
  41882. removeLight(toRemove: Light): number;
  41883. /**
  41884. * Remove a camera for the list of scene's cameras
  41885. * @param toRemove defines the camera to remove
  41886. * @returns the index where the camera was in the camera list
  41887. */
  41888. removeCamera(toRemove: Camera): number;
  41889. /**
  41890. * Remove a particle system for the list of scene's particle systems
  41891. * @param toRemove defines the particle system to remove
  41892. * @returns the index where the particle system was in the particle system list
  41893. */
  41894. removeParticleSystem(toRemove: IParticleSystem): number;
  41895. /**
  41896. * Remove a animation for the list of scene's animations
  41897. * @param toRemove defines the animation to remove
  41898. * @returns the index where the animation was in the animation list
  41899. */
  41900. removeAnimation(toRemove: Animation): number;
  41901. /**
  41902. * Will stop the animation of the given target
  41903. * @param target - the target
  41904. * @param animationName - the name of the animation to stop (all animations will be stopped if both this and targetMask are empty)
  41905. * @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)
  41906. */
  41907. stopAnimation(target: any, animationName?: string, targetMask?: (target: any) => boolean): void;
  41908. /**
  41909. * Removes the given animation group from this scene.
  41910. * @param toRemove The animation group to remove
  41911. * @returns The index of the removed animation group
  41912. */
  41913. removeAnimationGroup(toRemove: AnimationGroup): number;
  41914. /**
  41915. * Removes the given multi-material from this scene.
  41916. * @param toRemove The multi-material to remove
  41917. * @returns The index of the removed multi-material
  41918. */
  41919. removeMultiMaterial(toRemove: MultiMaterial): number;
  41920. /**
  41921. * Removes the given material from this scene.
  41922. * @param toRemove The material to remove
  41923. * @returns The index of the removed material
  41924. */
  41925. removeMaterial(toRemove: Material): number;
  41926. /**
  41927. * Removes the given action manager from this scene.
  41928. * @param toRemove The action manager to remove
  41929. * @returns The index of the removed action manager
  41930. */
  41931. removeActionManager(toRemove: AbstractActionManager): number;
  41932. /**
  41933. * Removes the given texture from this scene.
  41934. * @param toRemove The texture to remove
  41935. * @returns The index of the removed texture
  41936. */
  41937. removeTexture(toRemove: BaseTexture): number;
  41938. /**
  41939. * Adds the given light to this scene
  41940. * @param newLight The light to add
  41941. */
  41942. addLight(newLight: Light): void;
  41943. /**
  41944. * Sorts the list list based on light priorities
  41945. */
  41946. sortLightsByPriority(): void;
  41947. /**
  41948. * Adds the given camera to this scene
  41949. * @param newCamera The camera to add
  41950. */
  41951. addCamera(newCamera: Camera): void;
  41952. /**
  41953. * Adds the given skeleton to this scene
  41954. * @param newSkeleton The skeleton to add
  41955. */
  41956. addSkeleton(newSkeleton: Skeleton): void;
  41957. /**
  41958. * Adds the given particle system to this scene
  41959. * @param newParticleSystem The particle system to add
  41960. */
  41961. addParticleSystem(newParticleSystem: IParticleSystem): void;
  41962. /**
  41963. * Adds the given animation to this scene
  41964. * @param newAnimation The animation to add
  41965. */
  41966. addAnimation(newAnimation: Animation): void;
  41967. /**
  41968. * Adds the given animation group to this scene.
  41969. * @param newAnimationGroup The animation group to add
  41970. */
  41971. addAnimationGroup(newAnimationGroup: AnimationGroup): void;
  41972. /**
  41973. * Adds the given multi-material to this scene
  41974. * @param newMultiMaterial The multi-material to add
  41975. */
  41976. addMultiMaterial(newMultiMaterial: MultiMaterial): void;
  41977. /**
  41978. * Adds the given material to this scene
  41979. * @param newMaterial The material to add
  41980. */
  41981. addMaterial(newMaterial: Material): void;
  41982. /**
  41983. * Adds the given morph target to this scene
  41984. * @param newMorphTargetManager The morph target to add
  41985. */
  41986. addMorphTargetManager(newMorphTargetManager: MorphTargetManager): void;
  41987. /**
  41988. * Adds the given geometry to this scene
  41989. * @param newGeometry The geometry to add
  41990. */
  41991. addGeometry(newGeometry: Geometry): void;
  41992. /**
  41993. * Adds the given action manager to this scene
  41994. * @param newActionManager The action manager to add
  41995. */
  41996. addActionManager(newActionManager: AbstractActionManager): void;
  41997. /**
  41998. * Adds the given texture to this scene.
  41999. * @param newTexture The texture to add
  42000. */
  42001. addTexture(newTexture: BaseTexture): void;
  42002. /**
  42003. * Switch active camera
  42004. * @param newCamera defines the new active camera
  42005. * @param attachControl defines if attachControl must be called for the new active camera (default: true)
  42006. */
  42007. switchActiveCamera(newCamera: Camera, attachControl?: boolean): void;
  42008. /**
  42009. * sets the active camera of the scene using its ID
  42010. * @param id defines the camera's ID
  42011. * @return the new active camera or null if none found.
  42012. */
  42013. setActiveCameraByID(id: string): Nullable<Camera>;
  42014. /**
  42015. * sets the active camera of the scene using its name
  42016. * @param name defines the camera's name
  42017. * @returns the new active camera or null if none found.
  42018. */
  42019. setActiveCameraByName(name: string): Nullable<Camera>;
  42020. /**
  42021. * get an animation group using its name
  42022. * @param name defines the material's name
  42023. * @return the animation group or null if none found.
  42024. */
  42025. getAnimationGroupByName(name: string): Nullable<AnimationGroup>;
  42026. /**
  42027. * Get a material using its unique id
  42028. * @param uniqueId defines the material's unique id
  42029. * @return the material or null if none found.
  42030. */
  42031. getMaterialByUniqueID(uniqueId: number): Nullable<Material>;
  42032. /**
  42033. * get a material using its id
  42034. * @param id defines the material's ID
  42035. * @return the material or null if none found.
  42036. */
  42037. getMaterialByID(id: string): Nullable<Material>;
  42038. /**
  42039. * Gets a the last added material using a given id
  42040. * @param id defines the material's ID
  42041. * @return the last material with the given id or null if none found.
  42042. */
  42043. getLastMaterialByID(id: string): Nullable<Material>;
  42044. /**
  42045. * Gets a material using its name
  42046. * @param name defines the material's name
  42047. * @return the material or null if none found.
  42048. */
  42049. getMaterialByName(name: string): Nullable<Material>;
  42050. /**
  42051. * Get a texture using its unique id
  42052. * @param uniqueId defines the texture's unique id
  42053. * @return the texture or null if none found.
  42054. */
  42055. getTextureByUniqueID(uniqueId: number): Nullable<BaseTexture>;
  42056. /**
  42057. * Gets a camera using its id
  42058. * @param id defines the id to look for
  42059. * @returns the camera or null if not found
  42060. */
  42061. getCameraByID(id: string): Nullable<Camera>;
  42062. /**
  42063. * Gets a camera using its unique id
  42064. * @param uniqueId defines the unique id to look for
  42065. * @returns the camera or null if not found
  42066. */
  42067. getCameraByUniqueID(uniqueId: number): Nullable<Camera>;
  42068. /**
  42069. * Gets a camera using its name
  42070. * @param name defines the camera's name
  42071. * @return the camera or null if none found.
  42072. */
  42073. getCameraByName(name: string): Nullable<Camera>;
  42074. /**
  42075. * Gets a bone using its id
  42076. * @param id defines the bone's id
  42077. * @return the bone or null if not found
  42078. */
  42079. getBoneByID(id: string): Nullable<Bone>;
  42080. /**
  42081. * Gets a bone using its id
  42082. * @param name defines the bone's name
  42083. * @return the bone or null if not found
  42084. */
  42085. getBoneByName(name: string): Nullable<Bone>;
  42086. /**
  42087. * Gets a light node using its name
  42088. * @param name defines the the light's name
  42089. * @return the light or null if none found.
  42090. */
  42091. getLightByName(name: string): Nullable<Light>;
  42092. /**
  42093. * Gets a light node using its id
  42094. * @param id defines the light's id
  42095. * @return the light or null if none found.
  42096. */
  42097. getLightByID(id: string): Nullable<Light>;
  42098. /**
  42099. * Gets a light node using its scene-generated unique ID
  42100. * @param uniqueId defines the light's unique id
  42101. * @return the light or null if none found.
  42102. */
  42103. getLightByUniqueID(uniqueId: number): Nullable<Light>;
  42104. /**
  42105. * Gets a particle system by id
  42106. * @param id defines the particle system id
  42107. * @return the corresponding system or null if none found
  42108. */
  42109. getParticleSystemByID(id: string): Nullable<IParticleSystem>;
  42110. /**
  42111. * Gets a geometry using its ID
  42112. * @param id defines the geometry's id
  42113. * @return the geometry or null if none found.
  42114. */
  42115. getGeometryByID(id: string): Nullable<Geometry>;
  42116. private _getGeometryByUniqueID;
  42117. /**
  42118. * Add a new geometry to this scene
  42119. * @param geometry defines the geometry to be added to the scene.
  42120. * @param force defines if the geometry must be pushed even if a geometry with this id already exists
  42121. * @return a boolean defining if the geometry was added or not
  42122. */
  42123. pushGeometry(geometry: Geometry, force?: boolean): boolean;
  42124. /**
  42125. * Removes an existing geometry
  42126. * @param geometry defines the geometry to be removed from the scene
  42127. * @return a boolean defining if the geometry was removed or not
  42128. */
  42129. removeGeometry(geometry: Geometry): boolean;
  42130. /**
  42131. * Gets the list of geometries attached to the scene
  42132. * @returns an array of Geometry
  42133. */
  42134. getGeometries(): Geometry[];
  42135. /**
  42136. * Gets the first added mesh found of a given ID
  42137. * @param id defines the id to search for
  42138. * @return the mesh found or null if not found at all
  42139. */
  42140. getMeshByID(id: string): Nullable<AbstractMesh>;
  42141. /**
  42142. * Gets a list of meshes using their id
  42143. * @param id defines the id to search for
  42144. * @returns a list of meshes
  42145. */
  42146. getMeshesByID(id: string): Array<AbstractMesh>;
  42147. /**
  42148. * Gets the first added transform node found of a given ID
  42149. * @param id defines the id to search for
  42150. * @return the found transform node or null if not found at all.
  42151. */
  42152. getTransformNodeByID(id: string): Nullable<TransformNode>;
  42153. /**
  42154. * Gets a transform node with its auto-generated unique id
  42155. * @param uniqueId efines the unique id to search for
  42156. * @return the found transform node or null if not found at all.
  42157. */
  42158. getTransformNodeByUniqueID(uniqueId: number): Nullable<TransformNode>;
  42159. /**
  42160. * Gets a list of transform nodes using their id
  42161. * @param id defines the id to search for
  42162. * @returns a list of transform nodes
  42163. */
  42164. getTransformNodesByID(id: string): Array<TransformNode>;
  42165. /**
  42166. * Gets a mesh with its auto-generated unique id
  42167. * @param uniqueId defines the unique id to search for
  42168. * @return the found mesh or null if not found at all.
  42169. */
  42170. getMeshByUniqueID(uniqueId: number): Nullable<AbstractMesh>;
  42171. /**
  42172. * Gets a the last added mesh using a given id
  42173. * @param id defines the id to search for
  42174. * @return the found mesh or null if not found at all.
  42175. */
  42176. getLastMeshByID(id: string): Nullable<AbstractMesh>;
  42177. /**
  42178. * Gets a the last added node (Mesh, Camera, Light) using a given id
  42179. * @param id defines the id to search for
  42180. * @return the found node or null if not found at all
  42181. */
  42182. getLastEntryByID(id: string): Nullable<Node>;
  42183. /**
  42184. * Gets a node (Mesh, Camera, Light) using a given id
  42185. * @param id defines the id to search for
  42186. * @return the found node or null if not found at all
  42187. */
  42188. getNodeByID(id: string): Nullable<Node>;
  42189. /**
  42190. * Gets a node (Mesh, Camera, Light) using a given name
  42191. * @param name defines the name to search for
  42192. * @return the found node or null if not found at all.
  42193. */
  42194. getNodeByName(name: string): Nullable<Node>;
  42195. /**
  42196. * Gets a mesh using a given name
  42197. * @param name defines the name to search for
  42198. * @return the found mesh or null if not found at all.
  42199. */
  42200. getMeshByName(name: string): Nullable<AbstractMesh>;
  42201. /**
  42202. * Gets a transform node using a given name
  42203. * @param name defines the name to search for
  42204. * @return the found transform node or null if not found at all.
  42205. */
  42206. getTransformNodeByName(name: string): Nullable<TransformNode>;
  42207. /**
  42208. * Gets a skeleton using a given id (if many are found, this function will pick the last one)
  42209. * @param id defines the id to search for
  42210. * @return the found skeleton or null if not found at all.
  42211. */
  42212. getLastSkeletonByID(id: string): Nullable<Skeleton>;
  42213. /**
  42214. * Gets a skeleton using a given auto generated unique id
  42215. * @param uniqueId defines the unique id to search for
  42216. * @return the found skeleton or null if not found at all.
  42217. */
  42218. getSkeletonByUniqueId(uniqueId: number): Nullable<Skeleton>;
  42219. /**
  42220. * Gets a skeleton using a given id (if many are found, this function will pick the first one)
  42221. * @param id defines the id to search for
  42222. * @return the found skeleton or null if not found at all.
  42223. */
  42224. getSkeletonById(id: string): Nullable<Skeleton>;
  42225. /**
  42226. * Gets a skeleton using a given name
  42227. * @param name defines the name to search for
  42228. * @return the found skeleton or null if not found at all.
  42229. */
  42230. getSkeletonByName(name: string): Nullable<Skeleton>;
  42231. /**
  42232. * Gets a morph target manager using a given id (if many are found, this function will pick the last one)
  42233. * @param id defines the id to search for
  42234. * @return the found morph target manager or null if not found at all.
  42235. */
  42236. getMorphTargetManagerById(id: number): Nullable<MorphTargetManager>;
  42237. /**
  42238. * Gets a morph target using a given id (if many are found, this function will pick the first one)
  42239. * @param id defines the id to search for
  42240. * @return the found morph target or null if not found at all.
  42241. */
  42242. getMorphTargetById(id: string): Nullable<MorphTarget>;
  42243. /**
  42244. * Gets a morph target using a given name (if many are found, this function will pick the first one)
  42245. * @param name defines the name to search for
  42246. * @return the found morph target or null if not found at all.
  42247. */
  42248. getMorphTargetByName(name: string): Nullable<MorphTarget>;
  42249. /**
  42250. * Gets a post process using a given name (if many are found, this function will pick the first one)
  42251. * @param name defines the name to search for
  42252. * @return the found post process or null if not found at all.
  42253. */
  42254. getPostProcessByName(name: string): Nullable<PostProcess>;
  42255. /**
  42256. * Gets a boolean indicating if the given mesh is active
  42257. * @param mesh defines the mesh to look for
  42258. * @returns true if the mesh is in the active list
  42259. */
  42260. isActiveMesh(mesh: AbstractMesh): boolean;
  42261. /**
  42262. * Return a unique id as a string which can serve as an identifier for the scene
  42263. */
  42264. get uid(): string;
  42265. /**
  42266. * Add an externaly attached data from its key.
  42267. * This method call will fail and return false, if such key already exists.
  42268. * If you don't care and just want to get the data no matter what, use the more convenient getOrAddExternalDataWithFactory() method.
  42269. * @param key the unique key that identifies the data
  42270. * @param data the data object to associate to the key for this Engine instance
  42271. * @return true if no such key were already present and the data was added successfully, false otherwise
  42272. */
  42273. addExternalData<T>(key: string, data: T): boolean;
  42274. /**
  42275. * Get an externaly attached data from its key
  42276. * @param key the unique key that identifies the data
  42277. * @return the associated data, if present (can be null), or undefined if not present
  42278. */
  42279. getExternalData<T>(key: string): Nullable<T>;
  42280. /**
  42281. * Get an externaly attached data from its key, create it using a factory if it's not already present
  42282. * @param key the unique key that identifies the data
  42283. * @param factory the factory that will be called to create the instance if and only if it doesn't exists
  42284. * @return the associated data, can be null if the factory returned null.
  42285. */
  42286. getOrAddExternalDataWithFactory<T>(key: string, factory: (k: string) => T): T;
  42287. /**
  42288. * Remove an externaly attached data from the Engine instance
  42289. * @param key the unique key that identifies the data
  42290. * @return true if the data was successfully removed, false if it doesn't exist
  42291. */
  42292. removeExternalData(key: string): boolean;
  42293. private _evaluateSubMesh;
  42294. /**
  42295. * Clear the processed materials smart array preventing retention point in material dispose.
  42296. */
  42297. freeProcessedMaterials(): void;
  42298. private _preventFreeActiveMeshesAndRenderingGroups;
  42299. /** Gets or sets a boolean blocking all the calls to freeActiveMeshes and freeRenderingGroups
  42300. * It can be used in order to prevent going through methods freeRenderingGroups and freeActiveMeshes several times to improve performance
  42301. * when disposing several meshes in a row or a hierarchy of meshes.
  42302. * When used, it is the responsability of the user to blockfreeActiveMeshesAndRenderingGroups back to false.
  42303. */
  42304. get blockfreeActiveMeshesAndRenderingGroups(): boolean;
  42305. set blockfreeActiveMeshesAndRenderingGroups(value: boolean);
  42306. /**
  42307. * Clear the active meshes smart array preventing retention point in mesh dispose.
  42308. */
  42309. freeActiveMeshes(): void;
  42310. /**
  42311. * Clear the info related to rendering groups preventing retention points during dispose.
  42312. */
  42313. freeRenderingGroups(): void;
  42314. /** @hidden */
  42315. _isInIntermediateRendering(): boolean;
  42316. /**
  42317. * Lambda returning the list of potentially active meshes.
  42318. */
  42319. getActiveMeshCandidates: () => ISmartArrayLike<AbstractMesh>;
  42320. /**
  42321. * Lambda returning the list of potentially active sub meshes.
  42322. */
  42323. getActiveSubMeshCandidates: (mesh: AbstractMesh) => ISmartArrayLike<SubMesh>;
  42324. /**
  42325. * Lambda returning the list of potentially intersecting sub meshes.
  42326. */
  42327. getIntersectingSubMeshCandidates: (mesh: AbstractMesh, localRay: Ray) => ISmartArrayLike<SubMesh>;
  42328. /**
  42329. * Lambda returning the list of potentially colliding sub meshes.
  42330. */
  42331. getCollidingSubMeshCandidates: (mesh: AbstractMesh, collider: Collider) => ISmartArrayLike<SubMesh>;
  42332. private _activeMeshesFrozen;
  42333. private _skipEvaluateActiveMeshesCompletely;
  42334. /**
  42335. * Use this function to stop evaluating active meshes. The current list will be keep alive between frames
  42336. * @param skipEvaluateActiveMeshes defines an optional boolean indicating that the evaluate active meshes step must be completely skipped
  42337. * @returns the current scene
  42338. */
  42339. freezeActiveMeshes(skipEvaluateActiveMeshes?: boolean): Scene;
  42340. /**
  42341. * Use this function to restart evaluating active meshes on every frame
  42342. * @returns the current scene
  42343. */
  42344. unfreezeActiveMeshes(): Scene;
  42345. private _evaluateActiveMeshes;
  42346. private _activeMesh;
  42347. /**
  42348. * Update the transform matrix to update from the current active camera
  42349. * @param force defines a boolean used to force the update even if cache is up to date
  42350. */
  42351. updateTransformMatrix(force?: boolean): void;
  42352. private _bindFrameBuffer;
  42353. /** @hidden */
  42354. _allowPostProcessClearColor: boolean;
  42355. /** @hidden */
  42356. _renderForCamera(camera: Camera, rigParent?: Camera): void;
  42357. private _processSubCameras;
  42358. private _checkIntersections;
  42359. /** @hidden */
  42360. _advancePhysicsEngineStep(step: number): void;
  42361. /**
  42362. * User updatable function that will return a deterministic frame time when engine is in deterministic lock step mode
  42363. */
  42364. getDeterministicFrameTime: () => number;
  42365. /** @hidden */
  42366. _animate(): void;
  42367. /** Execute all animations (for a frame) */
  42368. animate(): void;
  42369. /**
  42370. * Render the scene
  42371. * @param updateCameras defines a boolean indicating if cameras must update according to their inputs (true by default)
  42372. * @param ignoreAnimations defines a boolean indicating if animations should not be executed (false by default)
  42373. */
  42374. render(updateCameras?: boolean, ignoreAnimations?: boolean): void;
  42375. /**
  42376. * Freeze all materials
  42377. * A frozen material will not be updatable but should be faster to render
  42378. */
  42379. freezeMaterials(): void;
  42380. /**
  42381. * Unfreeze all materials
  42382. * A frozen material will not be updatable but should be faster to render
  42383. */
  42384. unfreezeMaterials(): void;
  42385. /**
  42386. * Releases all held ressources
  42387. */
  42388. dispose(): void;
  42389. /**
  42390. * Gets if the scene is already disposed
  42391. */
  42392. get isDisposed(): boolean;
  42393. /**
  42394. * Call this function to reduce memory footprint of the scene.
  42395. * Vertex buffers will not store CPU data anymore (this will prevent picking, collisions or physics to work correctly)
  42396. */
  42397. clearCachedVertexData(): void;
  42398. /**
  42399. * This function will remove the local cached buffer data from texture.
  42400. * It will save memory but will prevent the texture from being rebuilt
  42401. */
  42402. cleanCachedTextureBuffer(): void;
  42403. /**
  42404. * Get the world extend vectors with an optional filter
  42405. *
  42406. * @param filterPredicate the predicate - which meshes should be included when calculating the world size
  42407. * @returns {{ min: Vector3; max: Vector3 }} min and max vectors
  42408. */
  42409. getWorldExtends(filterPredicate?: (mesh: AbstractMesh) => boolean): {
  42410. min: Vector3;
  42411. max: Vector3;
  42412. };
  42413. /**
  42414. * Creates a ray that can be used to pick in the scene
  42415. * @param x defines the x coordinate of the origin (on-screen)
  42416. * @param y defines the y coordinate of the origin (on-screen)
  42417. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  42418. * @param camera defines the camera to use for the picking
  42419. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  42420. * @returns a Ray
  42421. */
  42422. createPickingRay(x: number, y: number, world: Matrix, camera: Nullable<Camera>, cameraViewSpace?: boolean): Ray;
  42423. /**
  42424. * Creates a ray that can be used to pick in the scene
  42425. * @param x defines the x coordinate of the origin (on-screen)
  42426. * @param y defines the y coordinate of the origin (on-screen)
  42427. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  42428. * @param result defines the ray where to store the picking ray
  42429. * @param camera defines the camera to use for the picking
  42430. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  42431. * @returns the current scene
  42432. */
  42433. createPickingRayToRef(x: number, y: number, world: Matrix, result: Ray, camera: Nullable<Camera>, cameraViewSpace?: boolean): Scene;
  42434. /**
  42435. * Creates a ray that can be used to pick in the scene
  42436. * @param x defines the x coordinate of the origin (on-screen)
  42437. * @param y defines the y coordinate of the origin (on-screen)
  42438. * @param camera defines the camera to use for the picking
  42439. * @returns a Ray
  42440. */
  42441. createPickingRayInCameraSpace(x: number, y: number, camera?: Camera): Ray;
  42442. /**
  42443. * Creates a ray that can be used to pick in the scene
  42444. * @param x defines the x coordinate of the origin (on-screen)
  42445. * @param y defines the y coordinate of the origin (on-screen)
  42446. * @param result defines the ray where to store the picking ray
  42447. * @param camera defines the camera to use for the picking
  42448. * @returns the current scene
  42449. */
  42450. createPickingRayInCameraSpaceToRef(x: number, y: number, result: Ray, camera?: Camera): Scene;
  42451. /** Launch a ray to try to pick a mesh in the scene
  42452. * @param x position on screen
  42453. * @param y position on screen
  42454. * @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
  42455. * @param fastCheck defines if the first intersection will be used (and not the closest)
  42456. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  42457. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  42458. * @returns a PickingInfo
  42459. */
  42460. pick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  42461. /** Launch a ray to try to pick a mesh in the scene using only bounding information of the main mesh (not using submeshes)
  42462. * @param x position on screen
  42463. * @param y position on screen
  42464. * @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
  42465. * @param fastCheck defines if the first intersection will be used (and not the closest)
  42466. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  42467. * @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)
  42468. */
  42469. pickWithBoundingInfo(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>): Nullable<PickingInfo>;
  42470. /** Use the given ray to pick a mesh in the scene
  42471. * @param ray The ray to use to pick meshes
  42472. * @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
  42473. * @param fastCheck defines if the first intersection will be used (and not the closest)
  42474. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  42475. * @returns a PickingInfo
  42476. */
  42477. pickWithRay(ray: Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  42478. /**
  42479. * Launch a ray to try to pick a mesh in the scene
  42480. * @param x X position on screen
  42481. * @param y Y position on screen
  42482. * @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
  42483. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  42484. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  42485. * @returns an array of PickingInfo
  42486. */
  42487. multiPick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, camera?: Camera, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  42488. /**
  42489. * Launch a ray to try to pick a mesh in the scene
  42490. * @param ray Ray to use
  42491. * @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
  42492. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  42493. * @returns an array of PickingInfo
  42494. */
  42495. multiPickWithRay(ray: Ray, predicate: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  42496. /**
  42497. * Force the value of meshUnderPointer
  42498. * @param mesh defines the mesh to use
  42499. * @param pointerId optional pointer id when using more than one pointer
  42500. */
  42501. setPointerOverMesh(mesh: Nullable<AbstractMesh>, pointerId?: number): void;
  42502. /**
  42503. * Gets the mesh under the pointer
  42504. * @returns a Mesh or null if no mesh is under the pointer
  42505. */
  42506. getPointerOverMesh(): Nullable<AbstractMesh>;
  42507. /** @hidden */
  42508. _rebuildGeometries(): void;
  42509. /** @hidden */
  42510. _rebuildTextures(): void;
  42511. private _getByTags;
  42512. /**
  42513. * Get a list of meshes 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 Mesh
  42517. */
  42518. getMeshesByTags(tagsQuery: string, forEach?: (mesh: AbstractMesh) => void): Mesh[];
  42519. /**
  42520. * Get a list of cameras 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 Camera
  42524. */
  42525. getCamerasByTags(tagsQuery: string, forEach?: (camera: Camera) => void): Camera[];
  42526. /**
  42527. * Get a list of lights 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 Light
  42531. */
  42532. getLightsByTags(tagsQuery: string, forEach?: (light: Light) => void): Light[];
  42533. /**
  42534. * Get a list of materials 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 Material
  42538. */
  42539. getMaterialByTags(tagsQuery: string, forEach?: (material: Material) => void): Material[];
  42540. /**
  42541. * Get a list of transform nodes by tags
  42542. * @param tagsQuery defines the tags query to use
  42543. * @param forEach defines a predicate used to filter results
  42544. * @returns an array of TransformNode
  42545. */
  42546. getTransformNodesByTags(tagsQuery: string, forEach?: (transform: TransformNode) => void): TransformNode[];
  42547. /**
  42548. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  42549. * This allowed control for front to back rendering or reversly depending of the special needs.
  42550. *
  42551. * @param renderingGroupId The rendering group id corresponding to its index
  42552. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  42553. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  42554. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  42555. */
  42556. 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;
  42557. /**
  42558. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  42559. *
  42560. * @param renderingGroupId The rendering group id corresponding to its index
  42561. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  42562. * @param depth Automatically clears depth between groups if true and autoClear is true.
  42563. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  42564. */
  42565. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  42566. /**
  42567. * Gets the current auto clear configuration for one rendering group of the rendering
  42568. * manager.
  42569. * @param index the rendering group index to get the information for
  42570. * @returns The auto clear setup for the requested rendering group
  42571. */
  42572. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  42573. private _blockMaterialDirtyMechanism;
  42574. /** Gets or sets a boolean blocking all the calls to markAllMaterialsAsDirty (ie. the materials won't be updated if they are out of sync) */
  42575. get blockMaterialDirtyMechanism(): boolean;
  42576. set blockMaterialDirtyMechanism(value: boolean);
  42577. /**
  42578. * Will flag all materials as dirty to trigger new shader compilation
  42579. * @param flag defines the flag used to specify which material part must be marked as dirty
  42580. * @param predicate If not null, it will be used to specifiy if a material has to be marked as dirty
  42581. */
  42582. markAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  42583. /** @hidden */
  42584. _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;
  42585. /** @hidden */
  42586. _loadFileAsync(url: string, onProgress?: (data: any) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  42587. /** @hidden */
  42588. _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;
  42589. /** @hidden */
  42590. _requestFileAsync(url: string, onProgress?: (ev: ProgressEvent) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onOpened?: (request: WebRequest) => void): Promise<string | ArrayBuffer>;
  42591. /** @hidden */
  42592. _readFile(file: File, onSuccess: (data: string | ArrayBuffer) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  42593. /** @hidden */
  42594. _readFileAsync(file: File, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  42595. }
  42596. }
  42597. declare module "babylonjs/assetContainer" {
  42598. import { AbstractScene } from "babylonjs/abstractScene";
  42599. import { Scene } from "babylonjs/scene";
  42600. import { Mesh } from "babylonjs/Meshes/mesh";
  42601. import { TransformNode } from "babylonjs/Meshes/transformNode";
  42602. import { Skeleton } from "babylonjs/Bones/skeleton";
  42603. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  42604. import { Animatable } from "babylonjs/Animations/animatable";
  42605. import { Nullable } from "babylonjs/types";
  42606. import { Node } from "babylonjs/node";
  42607. /**
  42608. * Set of assets to keep when moving a scene into an asset container.
  42609. */
  42610. export class KeepAssets extends AbstractScene {
  42611. }
  42612. /**
  42613. * Class used to store the output of the AssetContainer.instantiateAllMeshesToScene function
  42614. */
  42615. export class InstantiatedEntries {
  42616. /**
  42617. * List of new root nodes (eg. nodes with no parent)
  42618. */
  42619. rootNodes: TransformNode[];
  42620. /**
  42621. * List of new skeletons
  42622. */
  42623. skeletons: Skeleton[];
  42624. /**
  42625. * List of new animation groups
  42626. */
  42627. animationGroups: AnimationGroup[];
  42628. }
  42629. /**
  42630. * Container with a set of assets that can be added or removed from a scene.
  42631. */
  42632. export class AssetContainer extends AbstractScene {
  42633. private _wasAddedToScene;
  42634. /**
  42635. * The scene the AssetContainer belongs to.
  42636. */
  42637. scene: Scene;
  42638. /**
  42639. * Instantiates an AssetContainer.
  42640. * @param scene The scene the AssetContainer belongs to.
  42641. */
  42642. constructor(scene: Scene);
  42643. /**
  42644. * Instantiate or clone all meshes and add the new ones to the scene.
  42645. * Skeletons and animation groups will all be cloned
  42646. * @param nameFunction defines an optional function used to get new names for clones
  42647. * @param cloneMaterials defines an optional boolean that defines if materials must be cloned as well (false by default)
  42648. * @returns a list of rootNodes, skeletons and aniamtion groups that were duplicated
  42649. */
  42650. instantiateModelsToScene(nameFunction?: (sourceName: string) => string, cloneMaterials?: boolean): InstantiatedEntries;
  42651. /**
  42652. * Adds all the assets from the container to the scene.
  42653. */
  42654. addAllToScene(): void;
  42655. /**
  42656. * Removes all the assets in the container from the scene
  42657. */
  42658. removeAllFromScene(): void;
  42659. /**
  42660. * Disposes all the assets in the container
  42661. */
  42662. dispose(): void;
  42663. private _moveAssets;
  42664. /**
  42665. * Removes all the assets contained in the scene and adds them to the container.
  42666. * @param keepAssets Set of assets to keep in the scene. (default: empty)
  42667. */
  42668. moveAllFromScene(keepAssets?: KeepAssets): void;
  42669. /**
  42670. * 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.
  42671. * @returns the root mesh
  42672. */
  42673. createRootMesh(): Mesh;
  42674. /**
  42675. * Merge animations (direct and animation groups) from this asset container into a scene
  42676. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  42677. * @param animatables set of animatables to retarget to a node from the scene
  42678. * @param targetConverter defines a function used to convert animation targets from the asset container to the scene (default: search node by name)
  42679. * @returns an array of the new AnimationGroup added to the scene (empty array if none)
  42680. */
  42681. mergeAnimationsTo(scene: Scene | null | undefined, animatables: Animatable[], targetConverter?: Nullable<(target: any) => Nullable<Node>>): AnimationGroup[];
  42682. }
  42683. }
  42684. declare module "babylonjs/abstractScene" {
  42685. import { Scene } from "babylonjs/scene";
  42686. import { Nullable } from "babylonjs/types";
  42687. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  42688. import { TransformNode } from "babylonjs/Meshes/transformNode";
  42689. import { Geometry } from "babylonjs/Meshes/geometry";
  42690. import { Skeleton } from "babylonjs/Bones/skeleton";
  42691. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  42692. import { AssetContainer } from "babylonjs/assetContainer";
  42693. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  42694. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  42695. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  42696. import { Material } from "babylonjs/Materials/material";
  42697. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  42698. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  42699. import { Camera } from "babylonjs/Cameras/camera";
  42700. import { Light } from "babylonjs/Lights/light";
  42701. import { Node } from "babylonjs/node";
  42702. import { Animation } from "babylonjs/Animations/animation";
  42703. /**
  42704. * Defines how the parser contract is defined.
  42705. * These parsers are used to parse a list of specific assets (like particle systems, etc..)
  42706. */
  42707. export type BabylonFileParser = (parsedData: any, scene: Scene, container: AssetContainer, rootUrl: string) => void;
  42708. /**
  42709. * Defines how the individual parser contract is defined.
  42710. * These parser can parse an individual asset
  42711. */
  42712. export type IndividualBabylonFileParser = (parsedData: any, scene: Scene, rootUrl: string) => any;
  42713. /**
  42714. * Base class of the scene acting as a container for the different elements composing a scene.
  42715. * This class is dynamically extended by the different components of the scene increasing
  42716. * flexibility and reducing coupling
  42717. */
  42718. export abstract class AbstractScene {
  42719. /**
  42720. * Stores the list of available parsers in the application.
  42721. */
  42722. private static _BabylonFileParsers;
  42723. /**
  42724. * Stores the list of available individual parsers in the application.
  42725. */
  42726. private static _IndividualBabylonFileParsers;
  42727. /**
  42728. * Adds a parser in the list of available ones
  42729. * @param name Defines the name of the parser
  42730. * @param parser Defines the parser to add
  42731. */
  42732. static AddParser(name: string, parser: BabylonFileParser): void;
  42733. /**
  42734. * Gets a general parser from the list of avaialble ones
  42735. * @param name Defines the name of the parser
  42736. * @returns the requested parser or null
  42737. */
  42738. static GetParser(name: string): Nullable<BabylonFileParser>;
  42739. /**
  42740. * Adds n individual parser in the list of available ones
  42741. * @param name Defines the name of the parser
  42742. * @param parser Defines the parser to add
  42743. */
  42744. static AddIndividualParser(name: string, parser: IndividualBabylonFileParser): void;
  42745. /**
  42746. * Gets an individual parser from the list of avaialble ones
  42747. * @param name Defines the name of the parser
  42748. * @returns the requested parser or null
  42749. */
  42750. static GetIndividualParser(name: string): Nullable<IndividualBabylonFileParser>;
  42751. /**
  42752. * Parser json data and populate both a scene and its associated container object
  42753. * @param jsonData Defines the data to parse
  42754. * @param scene Defines the scene to parse the data for
  42755. * @param container Defines the container attached to the parsing sequence
  42756. * @param rootUrl Defines the root url of the data
  42757. */
  42758. static Parse(jsonData: any, scene: Scene, container: AssetContainer, rootUrl: string): void;
  42759. /**
  42760. * Gets the list of root nodes (ie. nodes with no parent)
  42761. */
  42762. rootNodes: Node[];
  42763. /** All of the cameras added to this scene
  42764. * @see https://doc.babylonjs.com/babylon101/cameras
  42765. */
  42766. cameras: Camera[];
  42767. /**
  42768. * All of the lights added to this scene
  42769. * @see https://doc.babylonjs.com/babylon101/lights
  42770. */
  42771. lights: Light[];
  42772. /**
  42773. * All of the (abstract) meshes added to this scene
  42774. */
  42775. meshes: AbstractMesh[];
  42776. /**
  42777. * The list of skeletons added to the scene
  42778. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  42779. */
  42780. skeletons: Skeleton[];
  42781. /**
  42782. * All of the particle systems added to this scene
  42783. * @see https://doc.babylonjs.com/babylon101/particles
  42784. */
  42785. particleSystems: IParticleSystem[];
  42786. /**
  42787. * Gets a list of Animations associated with the scene
  42788. */
  42789. animations: Animation[];
  42790. /**
  42791. * All of the animation groups added to this scene
  42792. * @see https://doc.babylonjs.com/how_to/group
  42793. */
  42794. animationGroups: AnimationGroup[];
  42795. /**
  42796. * All of the multi-materials added to this scene
  42797. * @see https://doc.babylonjs.com/how_to/multi_materials
  42798. */
  42799. multiMaterials: MultiMaterial[];
  42800. /**
  42801. * All of the materials added to this scene
  42802. * In the context of a Scene, it is not supposed to be modified manually.
  42803. * Any addition or removal should be done using the addMaterial and removeMaterial Scene methods.
  42804. * Note also that the order of the Material within the array is not significant and might change.
  42805. * @see https://doc.babylonjs.com/babylon101/materials
  42806. */
  42807. materials: Material[];
  42808. /**
  42809. * The list of morph target managers added to the scene
  42810. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh
  42811. */
  42812. morphTargetManagers: MorphTargetManager[];
  42813. /**
  42814. * The list of geometries used in the scene.
  42815. */
  42816. geometries: Geometry[];
  42817. /**
  42818. * All of the tranform nodes added to this scene
  42819. * In the context of a Scene, it is not supposed to be modified manually.
  42820. * Any addition or removal should be done using the addTransformNode and removeTransformNode Scene methods.
  42821. * Note also that the order of the TransformNode wihin the array is not significant and might change.
  42822. * @see https://doc.babylonjs.com/how_to/transformnode
  42823. */
  42824. transformNodes: TransformNode[];
  42825. /**
  42826. * ActionManagers available on the scene.
  42827. */
  42828. actionManagers: AbstractActionManager[];
  42829. /**
  42830. * Textures to keep.
  42831. */
  42832. textures: BaseTexture[];
  42833. /** @hidden */
  42834. protected _environmentTexture: Nullable<BaseTexture>;
  42835. /**
  42836. * Texture used in all pbr material as the reflection texture.
  42837. * As in the majority of the scene they are the same (exception for multi room and so on),
  42838. * this is easier to reference from here than from all the materials.
  42839. */
  42840. get environmentTexture(): Nullable<BaseTexture>;
  42841. set environmentTexture(value: Nullable<BaseTexture>);
  42842. /**
  42843. * The list of postprocesses added to the scene
  42844. */
  42845. postProcesses: import("babylonjs/PostProcesses/postProcess").PostProcess[];
  42846. /**
  42847. * @returns all meshes, lights, cameras, transformNodes and bones
  42848. */
  42849. getNodes(): Array<Node>;
  42850. }
  42851. }
  42852. declare module "babylonjs/Audio/sound" {
  42853. import { Observable } from "babylonjs/Misc/observable";
  42854. import { Vector3 } from "babylonjs/Maths/math.vector";
  42855. import { Nullable } from "babylonjs/types";
  42856. import { Scene } from "babylonjs/scene";
  42857. import { TransformNode } from "babylonjs/Meshes/transformNode";
  42858. /**
  42859. * Interface used to define options for Sound class
  42860. */
  42861. export interface ISoundOptions {
  42862. /**
  42863. * Does the sound autoplay once loaded.
  42864. */
  42865. autoplay?: boolean;
  42866. /**
  42867. * Does the sound loop after it finishes playing once.
  42868. */
  42869. loop?: boolean;
  42870. /**
  42871. * Sound's volume
  42872. */
  42873. volume?: number;
  42874. /**
  42875. * Is it a spatial sound?
  42876. */
  42877. spatialSound?: boolean;
  42878. /**
  42879. * Maximum distance to hear that sound
  42880. */
  42881. maxDistance?: number;
  42882. /**
  42883. * Uses user defined attenuation function
  42884. */
  42885. useCustomAttenuation?: boolean;
  42886. /**
  42887. * Define the roll off factor of spatial sounds.
  42888. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42889. */
  42890. rolloffFactor?: number;
  42891. /**
  42892. * Define the reference distance the sound should be heard perfectly.
  42893. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42894. */
  42895. refDistance?: number;
  42896. /**
  42897. * Define the distance attenuation model the sound will follow.
  42898. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42899. */
  42900. distanceModel?: string;
  42901. /**
  42902. * Defines the playback speed (1 by default)
  42903. */
  42904. playbackRate?: number;
  42905. /**
  42906. * Defines if the sound is from a streaming source
  42907. */
  42908. streaming?: boolean;
  42909. /**
  42910. * Defines an optional length (in seconds) inside the sound file
  42911. */
  42912. length?: number;
  42913. /**
  42914. * Defines an optional offset (in seconds) inside the sound file
  42915. */
  42916. offset?: number;
  42917. /**
  42918. * If true, URLs will not be required to state the audio file codec to use.
  42919. */
  42920. skipCodecCheck?: boolean;
  42921. }
  42922. /**
  42923. * Defines a sound that can be played in the application.
  42924. * The sound can either be an ambient track or a simple sound played in reaction to a user action.
  42925. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  42926. */
  42927. export class Sound {
  42928. /**
  42929. * The name of the sound in the scene.
  42930. */
  42931. name: string;
  42932. /**
  42933. * Does the sound autoplay once loaded.
  42934. */
  42935. autoplay: boolean;
  42936. /**
  42937. * Does the sound loop after it finishes playing once.
  42938. */
  42939. loop: boolean;
  42940. /**
  42941. * Does the sound use a custom attenuation curve to simulate the falloff
  42942. * happening when the source gets further away from the camera.
  42943. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  42944. */
  42945. useCustomAttenuation: boolean;
  42946. /**
  42947. * The sound track id this sound belongs to.
  42948. */
  42949. soundTrackId: number;
  42950. /**
  42951. * Is this sound currently played.
  42952. */
  42953. isPlaying: boolean;
  42954. /**
  42955. * Is this sound currently paused.
  42956. */
  42957. isPaused: boolean;
  42958. /**
  42959. * Does this sound enables spatial sound.
  42960. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42961. */
  42962. spatialSound: boolean;
  42963. /**
  42964. * Define the reference distance the sound should be heard perfectly.
  42965. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42966. */
  42967. refDistance: number;
  42968. /**
  42969. * Define the roll off factor of spatial sounds.
  42970. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42971. */
  42972. rolloffFactor: number;
  42973. /**
  42974. * Define the max distance the sound should be heard (intensity just became 0 at this point).
  42975. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42976. */
  42977. maxDistance: number;
  42978. /**
  42979. * Define the distance attenuation model the sound will follow.
  42980. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42981. */
  42982. distanceModel: string;
  42983. /**
  42984. * @hidden
  42985. * Back Compat
  42986. **/
  42987. onended: () => any;
  42988. /**
  42989. * Gets or sets an object used to store user defined information for the sound.
  42990. */
  42991. metadata: any;
  42992. /**
  42993. * Observable event when the current playing sound finishes.
  42994. */
  42995. onEndedObservable: Observable<Sound>;
  42996. private _panningModel;
  42997. private _playbackRate;
  42998. private _streaming;
  42999. private _startTime;
  43000. private _startOffset;
  43001. private _position;
  43002. /** @hidden */
  43003. _positionInEmitterSpace: boolean;
  43004. private _localDirection;
  43005. private _volume;
  43006. private _isReadyToPlay;
  43007. private _isDirectional;
  43008. private _readyToPlayCallback;
  43009. private _audioBuffer;
  43010. private _soundSource;
  43011. private _streamingSource;
  43012. private _soundPanner;
  43013. private _soundGain;
  43014. private _inputAudioNode;
  43015. private _outputAudioNode;
  43016. private _coneInnerAngle;
  43017. private _coneOuterAngle;
  43018. private _coneOuterGain;
  43019. private _scene;
  43020. private _connectedTransformNode;
  43021. private _customAttenuationFunction;
  43022. private _registerFunc;
  43023. private _isOutputConnected;
  43024. private _htmlAudioElement;
  43025. private _urlType;
  43026. private _length?;
  43027. private _offset?;
  43028. /** @hidden */
  43029. static _SceneComponentInitialization: (scene: Scene) => void;
  43030. /**
  43031. * Create a sound and attach it to a scene
  43032. * @param name Name of your sound
  43033. * @param urlOrArrayBuffer Url to the sound to load async or ArrayBuffer, it also works with MediaStreams
  43034. * @param scene defines the scene the sound belongs to
  43035. * @param readyToPlayCallback Provide a callback function if you'd like to load your code once the sound is ready to be played
  43036. * @param options Objects to provide with the current available options: autoplay, loop, volume, spatialSound, maxDistance, rolloffFactor, refDistance, distanceModel, panningModel, streaming
  43037. */
  43038. constructor(name: string, urlOrArrayBuffer: any, scene: Scene, readyToPlayCallback?: Nullable<() => void>, options?: ISoundOptions);
  43039. /**
  43040. * Release the sound and its associated resources
  43041. */
  43042. dispose(): void;
  43043. /**
  43044. * Gets if the sounds is ready to be played or not.
  43045. * @returns true if ready, otherwise false
  43046. */
  43047. isReady(): boolean;
  43048. private _soundLoaded;
  43049. /**
  43050. * Sets the data of the sound from an audiobuffer
  43051. * @param audioBuffer The audioBuffer containing the data
  43052. */
  43053. setAudioBuffer(audioBuffer: AudioBuffer): void;
  43054. /**
  43055. * Updates the current sounds options such as maxdistance, loop...
  43056. * @param options A JSON object containing values named as the object properties
  43057. */
  43058. updateOptions(options: ISoundOptions): void;
  43059. private _createSpatialParameters;
  43060. private _updateSpatialParameters;
  43061. /**
  43062. * Switch the panning model to HRTF:
  43063. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  43064. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43065. */
  43066. switchPanningModelToHRTF(): void;
  43067. /**
  43068. * Switch the panning model to Equal Power:
  43069. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  43070. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43071. */
  43072. switchPanningModelToEqualPower(): void;
  43073. private _switchPanningModel;
  43074. /**
  43075. * Connect this sound to a sound track audio node like gain...
  43076. * @param soundTrackAudioNode the sound track audio node to connect to
  43077. */
  43078. connectToSoundTrackAudioNode(soundTrackAudioNode: AudioNode): void;
  43079. /**
  43080. * Transform this sound into a directional source
  43081. * @param coneInnerAngle Size of the inner cone in degree
  43082. * @param coneOuterAngle Size of the outer cone in degree
  43083. * @param coneOuterGain Volume of the sound outside the outer cone (between 0.0 and 1.0)
  43084. */
  43085. setDirectionalCone(coneInnerAngle: number, coneOuterAngle: number, coneOuterGain: number): void;
  43086. /**
  43087. * Gets or sets the inner angle for the directional cone.
  43088. */
  43089. get directionalConeInnerAngle(): number;
  43090. /**
  43091. * Gets or sets the inner angle for the directional cone.
  43092. */
  43093. set directionalConeInnerAngle(value: number);
  43094. /**
  43095. * Gets or sets the outer angle for the directional cone.
  43096. */
  43097. get directionalConeOuterAngle(): number;
  43098. /**
  43099. * Gets or sets the outer angle for the directional cone.
  43100. */
  43101. set directionalConeOuterAngle(value: number);
  43102. /**
  43103. * Sets the position of the emitter if spatial sound is enabled
  43104. * @param newPosition Defines the new posisiton
  43105. */
  43106. setPosition(newPosition: Vector3): void;
  43107. /**
  43108. * Sets the local direction of the emitter if spatial sound is enabled
  43109. * @param newLocalDirection Defines the new local direction
  43110. */
  43111. setLocalDirectionToMesh(newLocalDirection: Vector3): void;
  43112. private _updateDirection;
  43113. /** @hidden */
  43114. updateDistanceFromListener(): void;
  43115. /**
  43116. * Sets a new custom attenuation function for the sound.
  43117. * @param callback Defines the function used for the attenuation
  43118. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  43119. */
  43120. setAttenuationFunction(callback: (currentVolume: number, currentDistance: number, maxDistance: number, refDistance: number, rolloffFactor: number) => number): void;
  43121. /**
  43122. * Play the sound
  43123. * @param time (optional) Start the sound after X seconds. Start immediately (0) by default.
  43124. * @param offset (optional) Start the sound at a specific time in seconds
  43125. * @param length (optional) Sound duration (in seconds)
  43126. */
  43127. play(time?: number, offset?: number, length?: number): void;
  43128. private _onended;
  43129. /**
  43130. * Stop the sound
  43131. * @param time (optional) Stop the sound after X seconds. Stop immediately (0) by default.
  43132. */
  43133. stop(time?: number): void;
  43134. /**
  43135. * Put the sound in pause
  43136. */
  43137. pause(): void;
  43138. /**
  43139. * Sets a dedicated volume for this sounds
  43140. * @param newVolume Define the new volume of the sound
  43141. * @param time Define time for gradual change to new volume
  43142. */
  43143. setVolume(newVolume: number, time?: number): void;
  43144. /**
  43145. * Set the sound play back rate
  43146. * @param newPlaybackRate Define the playback rate the sound should be played at
  43147. */
  43148. setPlaybackRate(newPlaybackRate: number): void;
  43149. /**
  43150. * Gets the volume of the sound.
  43151. * @returns the volume of the sound
  43152. */
  43153. getVolume(): number;
  43154. /**
  43155. * Attach the sound to a dedicated mesh
  43156. * @param transformNode The transform node to connect the sound with
  43157. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  43158. */
  43159. attachToMesh(transformNode: TransformNode): void;
  43160. /**
  43161. * Detach the sound from the previously attached mesh
  43162. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  43163. */
  43164. detachFromMesh(): void;
  43165. private _onRegisterAfterWorldMatrixUpdate;
  43166. /**
  43167. * Clone the current sound in the scene.
  43168. * @returns the new sound clone
  43169. */
  43170. clone(): Nullable<Sound>;
  43171. /**
  43172. * Gets the current underlying audio buffer containing the data
  43173. * @returns the audio buffer
  43174. */
  43175. getAudioBuffer(): Nullable<AudioBuffer>;
  43176. /**
  43177. * Gets the WebAudio AudioBufferSourceNode, lets you keep track of and stop instances of this Sound.
  43178. * @returns the source node
  43179. */
  43180. getSoundSource(): Nullable<AudioBufferSourceNode>;
  43181. /**
  43182. * Gets the WebAudio GainNode, gives you precise control over the gain of instances of this Sound.
  43183. * @returns the gain node
  43184. */
  43185. getSoundGain(): Nullable<GainNode>;
  43186. /**
  43187. * Serializes the Sound in a JSON representation
  43188. * @returns the JSON representation of the sound
  43189. */
  43190. serialize(): any;
  43191. /**
  43192. * Parse a JSON representation of a sound to innstantiate in a given scene
  43193. * @param parsedSound Define the JSON representation of the sound (usually coming from the serialize method)
  43194. * @param scene Define the scene the new parsed sound should be created in
  43195. * @param rootUrl Define the rooturl of the load in case we need to fetch relative dependencies
  43196. * @param sourceSound Define a cound place holder if do not need to instantiate a new one
  43197. * @returns the newly parsed sound
  43198. */
  43199. static Parse(parsedSound: any, scene: Scene, rootUrl: string, sourceSound?: Sound): Sound;
  43200. }
  43201. }
  43202. declare module "babylonjs/Actions/directAudioActions" {
  43203. import { Action } from "babylonjs/Actions/action";
  43204. import { Condition } from "babylonjs/Actions/condition";
  43205. import { Sound } from "babylonjs/Audio/sound";
  43206. /**
  43207. * This defines an action helpful to play a defined sound on a triggered action.
  43208. */
  43209. export class PlaySoundAction extends Action {
  43210. private _sound;
  43211. /**
  43212. * Instantiate the action
  43213. * @param triggerOptions defines the trigger options
  43214. * @param sound defines the sound to play
  43215. * @param condition defines the trigger related conditions
  43216. */
  43217. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  43218. /** @hidden */
  43219. _prepare(): void;
  43220. /**
  43221. * Execute the action and play the sound.
  43222. */
  43223. execute(): void;
  43224. /**
  43225. * Serializes the actions and its related information.
  43226. * @param parent defines the object to serialize in
  43227. * @returns the serialized object
  43228. */
  43229. serialize(parent: any): any;
  43230. }
  43231. /**
  43232. * This defines an action helpful to stop a defined sound on a triggered action.
  43233. */
  43234. export class StopSoundAction extends Action {
  43235. private _sound;
  43236. /**
  43237. * Instantiate the action
  43238. * @param triggerOptions defines the trigger options
  43239. * @param sound defines the sound to stop
  43240. * @param condition defines the trigger related conditions
  43241. */
  43242. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  43243. /** @hidden */
  43244. _prepare(): void;
  43245. /**
  43246. * Execute the action and stop the sound.
  43247. */
  43248. execute(): void;
  43249. /**
  43250. * Serializes the actions and its related information.
  43251. * @param parent defines the object to serialize in
  43252. * @returns the serialized object
  43253. */
  43254. serialize(parent: any): any;
  43255. }
  43256. }
  43257. declare module "babylonjs/Actions/interpolateValueAction" {
  43258. import { Action } from "babylonjs/Actions/action";
  43259. import { Condition } from "babylonjs/Actions/condition";
  43260. import { Observable } from "babylonjs/Misc/observable";
  43261. /**
  43262. * This defines an action responsible to change the value of a property
  43263. * by interpolating between its current value and the newly set one once triggered.
  43264. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  43265. */
  43266. export class InterpolateValueAction extends Action {
  43267. /**
  43268. * Defines the path of the property where the value should be interpolated
  43269. */
  43270. propertyPath: string;
  43271. /**
  43272. * Defines the target value at the end of the interpolation.
  43273. */
  43274. value: any;
  43275. /**
  43276. * Defines the time it will take for the property to interpolate to the value.
  43277. */
  43278. duration: number;
  43279. /**
  43280. * Defines if the other scene animations should be stopped when the action has been triggered
  43281. */
  43282. stopOtherAnimations?: boolean;
  43283. /**
  43284. * Defines a callback raised once the interpolation animation has been done.
  43285. */
  43286. onInterpolationDone?: () => void;
  43287. /**
  43288. * Observable triggered once the interpolation animation has been done.
  43289. */
  43290. onInterpolationDoneObservable: Observable<InterpolateValueAction>;
  43291. private _target;
  43292. private _effectiveTarget;
  43293. private _property;
  43294. /**
  43295. * Instantiate the action
  43296. * @param triggerOptions defines the trigger options
  43297. * @param target defines the object containing the value to interpolate
  43298. * @param propertyPath defines the path to the property in the target object
  43299. * @param value defines the target value at the end of the interpolation
  43300. * @param duration deines the time it will take for the property to interpolate to the value.
  43301. * @param condition defines the trigger related conditions
  43302. * @param stopOtherAnimations defines if the other scene animations should be stopped when the action has been triggered
  43303. * @param onInterpolationDone defines a callback raised once the interpolation animation has been done
  43304. */
  43305. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, duration?: number, condition?: Condition, stopOtherAnimations?: boolean, onInterpolationDone?: () => void);
  43306. /** @hidden */
  43307. _prepare(): void;
  43308. /**
  43309. * Execute the action starts the value interpolation.
  43310. */
  43311. execute(): void;
  43312. /**
  43313. * Serializes the actions and its related information.
  43314. * @param parent defines the object to serialize in
  43315. * @returns the serialized object
  43316. */
  43317. serialize(parent: any): any;
  43318. }
  43319. }
  43320. declare module "babylonjs/Actions/index" {
  43321. export * from "babylonjs/Actions/abstractActionManager";
  43322. export * from "babylonjs/Actions/action";
  43323. export * from "babylonjs/Actions/actionEvent";
  43324. export * from "babylonjs/Actions/actionManager";
  43325. export * from "babylonjs/Actions/condition";
  43326. export * from "babylonjs/Actions/directActions";
  43327. export * from "babylonjs/Actions/directAudioActions";
  43328. export * from "babylonjs/Actions/interpolateValueAction";
  43329. }
  43330. declare module "babylonjs/Animations/index" {
  43331. export * from "babylonjs/Animations/animatable";
  43332. export * from "babylonjs/Animations/animation";
  43333. export * from "babylonjs/Animations/animationGroup";
  43334. export * from "babylonjs/Animations/animationPropertiesOverride";
  43335. export * from "babylonjs/Animations/easing";
  43336. export * from "babylonjs/Animations/runtimeAnimation";
  43337. export * from "babylonjs/Animations/animationEvent";
  43338. export * from "babylonjs/Animations/animationGroup";
  43339. export * from "babylonjs/Animations/animationKey";
  43340. export * from "babylonjs/Animations/animationRange";
  43341. export * from "babylonjs/Animations/animatable.interface";
  43342. }
  43343. declare module "babylonjs/Audio/soundTrack" {
  43344. import { Sound } from "babylonjs/Audio/sound";
  43345. import { Analyser } from "babylonjs/Audio/analyser";
  43346. import { Scene } from "babylonjs/scene";
  43347. /**
  43348. * Options allowed during the creation of a sound track.
  43349. */
  43350. export interface ISoundTrackOptions {
  43351. /**
  43352. * The volume the sound track should take during creation
  43353. */
  43354. volume?: number;
  43355. /**
  43356. * Define if the sound track is the main sound track of the scene
  43357. */
  43358. mainTrack?: boolean;
  43359. }
  43360. /**
  43361. * It could be useful to isolate your music & sounds on several tracks to better manage volume on a grouped instance of sounds.
  43362. * It will be also used in a future release to apply effects on a specific track.
  43363. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  43364. */
  43365. export class SoundTrack {
  43366. /**
  43367. * The unique identifier of the sound track in the scene.
  43368. */
  43369. id: number;
  43370. /**
  43371. * The list of sounds included in the sound track.
  43372. */
  43373. soundCollection: Array<Sound>;
  43374. private _outputAudioNode;
  43375. private _scene;
  43376. private _connectedAnalyser;
  43377. private _options;
  43378. private _isInitialized;
  43379. /**
  43380. * Creates a new sound track.
  43381. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  43382. * @param scene Define the scene the sound track belongs to
  43383. * @param options
  43384. */
  43385. constructor(scene: Scene, options?: ISoundTrackOptions);
  43386. private _initializeSoundTrackAudioGraph;
  43387. /**
  43388. * Release the sound track and its associated resources
  43389. */
  43390. dispose(): void;
  43391. /**
  43392. * Adds a sound to this sound track
  43393. * @param sound define the cound to add
  43394. * @ignoreNaming
  43395. */
  43396. AddSound(sound: Sound): void;
  43397. /**
  43398. * Removes a sound to this sound track
  43399. * @param sound define the cound to remove
  43400. * @ignoreNaming
  43401. */
  43402. RemoveSound(sound: Sound): void;
  43403. /**
  43404. * Set a global volume for the full sound track.
  43405. * @param newVolume Define the new volume of the sound track
  43406. */
  43407. setVolume(newVolume: number): void;
  43408. /**
  43409. * Switch the panning model to HRTF:
  43410. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  43411. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43412. */
  43413. switchPanningModelToHRTF(): void;
  43414. /**
  43415. * Switch the panning model to Equal Power:
  43416. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  43417. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43418. */
  43419. switchPanningModelToEqualPower(): void;
  43420. /**
  43421. * Connect the sound track to an audio analyser allowing some amazing
  43422. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  43423. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  43424. * @param analyser The analyser to connect to the engine
  43425. */
  43426. connectToAnalyser(analyser: Analyser): void;
  43427. }
  43428. }
  43429. declare module "babylonjs/Audio/audioSceneComponent" {
  43430. import { Sound } from "babylonjs/Audio/sound";
  43431. import { SoundTrack } from "babylonjs/Audio/soundTrack";
  43432. import { Nullable } from "babylonjs/types";
  43433. import { Vector3 } from "babylonjs/Maths/math.vector";
  43434. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  43435. import { Scene } from "babylonjs/scene";
  43436. import { AbstractScene } from "babylonjs/abstractScene";
  43437. import "babylonjs/Audio/audioEngine";
  43438. module "babylonjs/abstractScene" {
  43439. interface AbstractScene {
  43440. /**
  43441. * The list of sounds used in the scene.
  43442. */
  43443. sounds: Nullable<Array<Sound>>;
  43444. }
  43445. }
  43446. module "babylonjs/scene" {
  43447. interface Scene {
  43448. /**
  43449. * @hidden
  43450. * Backing field
  43451. */
  43452. _mainSoundTrack: SoundTrack;
  43453. /**
  43454. * The main sound track played by the scene.
  43455. * It cotains your primary collection of sounds.
  43456. */
  43457. mainSoundTrack: SoundTrack;
  43458. /**
  43459. * The list of sound tracks added to the scene
  43460. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  43461. */
  43462. soundTracks: Nullable<Array<SoundTrack>>;
  43463. /**
  43464. * Gets a sound using a given name
  43465. * @param name defines the name to search for
  43466. * @return the found sound or null if not found at all.
  43467. */
  43468. getSoundByName(name: string): Nullable<Sound>;
  43469. /**
  43470. * Gets or sets if audio support is enabled
  43471. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  43472. */
  43473. audioEnabled: boolean;
  43474. /**
  43475. * Gets or sets if audio will be output to headphones
  43476. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  43477. */
  43478. headphone: boolean;
  43479. /**
  43480. * Gets or sets custom audio listener position provider
  43481. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  43482. */
  43483. audioListenerPositionProvider: Nullable<() => Vector3>;
  43484. /**
  43485. * Gets or sets a refresh rate when using 3D audio positioning
  43486. */
  43487. audioPositioningRefreshRate: number;
  43488. }
  43489. }
  43490. /**
  43491. * Defines the sound scene component responsible to manage any sounds
  43492. * in a given scene.
  43493. */
  43494. export class AudioSceneComponent implements ISceneSerializableComponent {
  43495. private static _CameraDirectionLH;
  43496. private static _CameraDirectionRH;
  43497. /**
  43498. * The component name helpfull to identify the component in the list of scene components.
  43499. */
  43500. readonly name: string;
  43501. /**
  43502. * The scene the component belongs to.
  43503. */
  43504. scene: Scene;
  43505. private _audioEnabled;
  43506. /**
  43507. * Gets whether audio is enabled or not.
  43508. * Please use related enable/disable method to switch state.
  43509. */
  43510. get audioEnabled(): boolean;
  43511. private _headphone;
  43512. /**
  43513. * Gets whether audio is outputing to headphone or not.
  43514. * Please use the according Switch methods to change output.
  43515. */
  43516. get headphone(): boolean;
  43517. /**
  43518. * Gets or sets a refresh rate when using 3D audio positioning
  43519. */
  43520. audioPositioningRefreshRate: number;
  43521. private _audioListenerPositionProvider;
  43522. /**
  43523. * Gets the current audio listener position provider
  43524. */
  43525. get audioListenerPositionProvider(): Nullable<() => Vector3>;
  43526. /**
  43527. * Sets a custom listener position for all sounds in the scene
  43528. * By default, this is the position of the first active camera
  43529. */
  43530. set audioListenerPositionProvider(value: Nullable<() => Vector3>);
  43531. /**
  43532. * Creates a new instance of the component for the given scene
  43533. * @param scene Defines the scene to register the component in
  43534. */
  43535. constructor(scene: Scene);
  43536. /**
  43537. * Registers the component in a given scene
  43538. */
  43539. register(): void;
  43540. /**
  43541. * Rebuilds the elements related to this component in case of
  43542. * context lost for instance.
  43543. */
  43544. rebuild(): void;
  43545. /**
  43546. * Serializes the component data to the specified json object
  43547. * @param serializationObject The object to serialize to
  43548. */
  43549. serialize(serializationObject: any): void;
  43550. /**
  43551. * Adds all the elements from the container to the scene
  43552. * @param container the container holding the elements
  43553. */
  43554. addFromContainer(container: AbstractScene): void;
  43555. /**
  43556. * Removes all the elements in the container from the scene
  43557. * @param container contains the elements to remove
  43558. * @param dispose if the removed element should be disposed (default: false)
  43559. */
  43560. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  43561. /**
  43562. * Disposes the component and the associated ressources.
  43563. */
  43564. dispose(): void;
  43565. /**
  43566. * Disables audio in the associated scene.
  43567. */
  43568. disableAudio(): void;
  43569. /**
  43570. * Enables audio in the associated scene.
  43571. */
  43572. enableAudio(): void;
  43573. /**
  43574. * Switch audio to headphone output.
  43575. */
  43576. switchAudioModeForHeadphones(): void;
  43577. /**
  43578. * Switch audio to normal speakers.
  43579. */
  43580. switchAudioModeForNormalSpeakers(): void;
  43581. private _cachedCameraDirection;
  43582. private _cachedCameraPosition;
  43583. private _lastCheck;
  43584. private _afterRender;
  43585. }
  43586. }
  43587. declare module "babylonjs/Audio/weightedsound" {
  43588. import { Sound } from "babylonjs/Audio/sound";
  43589. /**
  43590. * Wraps one or more Sound objects and selects one with random weight for playback.
  43591. */
  43592. export class WeightedSound {
  43593. /** When true a Sound will be selected and played when the current playing Sound completes. */
  43594. loop: boolean;
  43595. private _coneInnerAngle;
  43596. private _coneOuterAngle;
  43597. private _volume;
  43598. /** A Sound is currently playing. */
  43599. isPlaying: boolean;
  43600. /** A Sound is currently paused. */
  43601. isPaused: boolean;
  43602. private _sounds;
  43603. private _weights;
  43604. private _currentIndex?;
  43605. /**
  43606. * Creates a new WeightedSound from the list of sounds given.
  43607. * @param loop When true a Sound will be selected and played when the current playing Sound completes.
  43608. * @param sounds Array of Sounds that will be selected from.
  43609. * @param weights Array of number values for selection weights; length must equal sounds, values will be normalized to 1
  43610. */
  43611. constructor(loop: boolean, sounds: Sound[], weights: number[]);
  43612. /**
  43613. * The size of cone in degrees for a directional sound in which there will be no attenuation.
  43614. */
  43615. get directionalConeInnerAngle(): number;
  43616. /**
  43617. * The size of cone in degress for a directional sound in which there will be no attenuation.
  43618. */
  43619. set directionalConeInnerAngle(value: number);
  43620. /**
  43621. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  43622. * Listener angles between innerAngle and outerAngle will falloff linearly.
  43623. */
  43624. get directionalConeOuterAngle(): number;
  43625. /**
  43626. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  43627. * Listener angles between innerAngle and outerAngle will falloff linearly.
  43628. */
  43629. set directionalConeOuterAngle(value: number);
  43630. /**
  43631. * Playback volume.
  43632. */
  43633. get volume(): number;
  43634. /**
  43635. * Playback volume.
  43636. */
  43637. set volume(value: number);
  43638. private _onended;
  43639. /**
  43640. * Suspend playback
  43641. */
  43642. pause(): void;
  43643. /**
  43644. * Stop playback
  43645. */
  43646. stop(): void;
  43647. /**
  43648. * Start playback.
  43649. * @param startOffset Position the clip head at a specific time in seconds.
  43650. */
  43651. play(startOffset?: number): void;
  43652. }
  43653. }
  43654. declare module "babylonjs/Audio/index" {
  43655. export * from "babylonjs/Audio/analyser";
  43656. export * from "babylonjs/Audio/audioEngine";
  43657. export * from "babylonjs/Audio/audioSceneComponent";
  43658. export * from "babylonjs/Audio/sound";
  43659. export * from "babylonjs/Audio/soundTrack";
  43660. export * from "babylonjs/Audio/weightedsound";
  43661. }
  43662. declare module "babylonjs/Behaviors/Cameras/bouncingBehavior" {
  43663. import { Behavior } from "babylonjs/Behaviors/behavior";
  43664. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  43665. import { BackEase } from "babylonjs/Animations/easing";
  43666. /**
  43667. * Add a bouncing effect to an ArcRotateCamera when reaching a specified minimum and maximum radius
  43668. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  43669. */
  43670. export class BouncingBehavior implements Behavior<ArcRotateCamera> {
  43671. /**
  43672. * Gets the name of the behavior.
  43673. */
  43674. get name(): string;
  43675. /**
  43676. * The easing function used by animations
  43677. */
  43678. static EasingFunction: BackEase;
  43679. /**
  43680. * The easing mode used by animations
  43681. */
  43682. static EasingMode: number;
  43683. /**
  43684. * The duration of the animation, in milliseconds
  43685. */
  43686. transitionDuration: number;
  43687. /**
  43688. * Length of the distance animated by the transition when lower radius is reached
  43689. */
  43690. lowerRadiusTransitionRange: number;
  43691. /**
  43692. * Length of the distance animated by the transition when upper radius is reached
  43693. */
  43694. upperRadiusTransitionRange: number;
  43695. private _autoTransitionRange;
  43696. /**
  43697. * Gets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  43698. */
  43699. get autoTransitionRange(): boolean;
  43700. /**
  43701. * Sets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  43702. * Transition ranges will be set to 5% of the bounding box diagonal in world space
  43703. */
  43704. set autoTransitionRange(value: boolean);
  43705. private _attachedCamera;
  43706. private _onAfterCheckInputsObserver;
  43707. private _onMeshTargetChangedObserver;
  43708. /**
  43709. * Initializes the behavior.
  43710. */
  43711. init(): void;
  43712. /**
  43713. * Attaches the behavior to its arc rotate camera.
  43714. * @param camera Defines the camera to attach the behavior to
  43715. */
  43716. attach(camera: ArcRotateCamera): void;
  43717. /**
  43718. * Detaches the behavior from its current arc rotate camera.
  43719. */
  43720. detach(): void;
  43721. private _radiusIsAnimating;
  43722. private _radiusBounceTransition;
  43723. private _animatables;
  43724. private _cachedWheelPrecision;
  43725. /**
  43726. * Checks if the camera radius is at the specified limit. Takes into account animation locks.
  43727. * @param radiusLimit The limit to check against.
  43728. * @return Bool to indicate if at limit.
  43729. */
  43730. private _isRadiusAtLimit;
  43731. /**
  43732. * Applies an animation to the radius of the camera, extending by the radiusDelta.
  43733. * @param radiusDelta The delta by which to animate to. Can be negative.
  43734. */
  43735. private _applyBoundRadiusAnimation;
  43736. /**
  43737. * Removes all animation locks. Allows new animations to be added to any of the camera properties.
  43738. */
  43739. protected _clearAnimationLocks(): void;
  43740. /**
  43741. * Stops and removes all animations that have been applied to the camera
  43742. */
  43743. stopAllAnimations(): void;
  43744. }
  43745. }
  43746. declare module "babylonjs/Behaviors/Cameras/framingBehavior" {
  43747. import { Behavior } from "babylonjs/Behaviors/behavior";
  43748. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  43749. import { ExponentialEase } from "babylonjs/Animations/easing";
  43750. import { Nullable } from "babylonjs/types";
  43751. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  43752. import { Vector3 } from "babylonjs/Maths/math.vector";
  43753. /**
  43754. * 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.
  43755. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  43756. */
  43757. export class FramingBehavior implements Behavior<ArcRotateCamera> {
  43758. /**
  43759. * Gets the name of the behavior.
  43760. */
  43761. get name(): string;
  43762. private _mode;
  43763. private _radiusScale;
  43764. private _positionScale;
  43765. private _defaultElevation;
  43766. private _elevationReturnTime;
  43767. private _elevationReturnWaitTime;
  43768. private _zoomStopsAnimation;
  43769. private _framingTime;
  43770. /**
  43771. * The easing function used by animations
  43772. */
  43773. static EasingFunction: ExponentialEase;
  43774. /**
  43775. * The easing mode used by animations
  43776. */
  43777. static EasingMode: number;
  43778. /**
  43779. * Sets the current mode used by the behavior
  43780. */
  43781. set mode(mode: number);
  43782. /**
  43783. * Gets current mode used by the behavior.
  43784. */
  43785. get mode(): number;
  43786. /**
  43787. * Sets the scale applied to the radius (1 by default)
  43788. */
  43789. set radiusScale(radius: number);
  43790. /**
  43791. * Gets the scale applied to the radius
  43792. */
  43793. get radiusScale(): number;
  43794. /**
  43795. * Sets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  43796. */
  43797. set positionScale(scale: number);
  43798. /**
  43799. * Gets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  43800. */
  43801. get positionScale(): number;
  43802. /**
  43803. * Sets the angle above/below the horizontal plane to return to when the return to default elevation idle
  43804. * behaviour is triggered, in radians.
  43805. */
  43806. set defaultElevation(elevation: number);
  43807. /**
  43808. * Gets the angle above/below the horizontal plane to return to when the return to default elevation idle
  43809. * behaviour is triggered, in radians.
  43810. */
  43811. get defaultElevation(): number;
  43812. /**
  43813. * Sets the time (in milliseconds) taken to return to the default beta position.
  43814. * Negative value indicates camera should not return to default.
  43815. */
  43816. set elevationReturnTime(speed: number);
  43817. /**
  43818. * Gets the time (in milliseconds) taken to return to the default beta position.
  43819. * Negative value indicates camera should not return to default.
  43820. */
  43821. get elevationReturnTime(): number;
  43822. /**
  43823. * Sets the delay (in milliseconds) taken before the camera returns to the default beta position.
  43824. */
  43825. set elevationReturnWaitTime(time: number);
  43826. /**
  43827. * Gets the delay (in milliseconds) taken before the camera returns to the default beta position.
  43828. */
  43829. get elevationReturnWaitTime(): number;
  43830. /**
  43831. * Sets the flag that indicates if user zooming should stop animation.
  43832. */
  43833. set zoomStopsAnimation(flag: boolean);
  43834. /**
  43835. * Gets the flag that indicates if user zooming should stop animation.
  43836. */
  43837. get zoomStopsAnimation(): boolean;
  43838. /**
  43839. * Sets the transition time when framing the mesh, in milliseconds
  43840. */
  43841. set framingTime(time: number);
  43842. /**
  43843. * Gets the transition time when framing the mesh, in milliseconds
  43844. */
  43845. get framingTime(): number;
  43846. /**
  43847. * Define if the behavior should automatically change the configured
  43848. * camera limits and sensibilities.
  43849. */
  43850. autoCorrectCameraLimitsAndSensibility: boolean;
  43851. private _onPrePointerObservableObserver;
  43852. private _onAfterCheckInputsObserver;
  43853. private _onMeshTargetChangedObserver;
  43854. private _attachedCamera;
  43855. private _isPointerDown;
  43856. private _lastInteractionTime;
  43857. /**
  43858. * Initializes the behavior.
  43859. */
  43860. init(): void;
  43861. /**
  43862. * Attaches the behavior to its arc rotate camera.
  43863. * @param camera Defines the camera to attach the behavior to
  43864. */
  43865. attach(camera: ArcRotateCamera): void;
  43866. /**
  43867. * Detaches the behavior from its current arc rotate camera.
  43868. */
  43869. detach(): void;
  43870. private _animatables;
  43871. private _betaIsAnimating;
  43872. private _betaTransition;
  43873. private _radiusTransition;
  43874. private _vectorTransition;
  43875. /**
  43876. * Targets the given mesh and updates zoom level accordingly.
  43877. * @param mesh The mesh to target.
  43878. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  43879. * @param onAnimationEnd Callback triggered at the end of the framing animation
  43880. */
  43881. zoomOnMesh(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  43882. /**
  43883. * Targets the given mesh with its children and updates zoom level accordingly.
  43884. * @param mesh The mesh to target.
  43885. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  43886. * @param onAnimationEnd Callback triggered at the end of the framing animation
  43887. */
  43888. zoomOnMeshHierarchy(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  43889. /**
  43890. * Targets the given meshes with their children and updates zoom level accordingly.
  43891. * @param meshes The mesh to target.
  43892. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  43893. * @param onAnimationEnd Callback triggered at the end of the framing animation
  43894. */
  43895. zoomOnMeshesHierarchy(meshes: AbstractMesh[], focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  43896. /**
  43897. * Targets the bounding box info defined by its extends and updates zoom level accordingly.
  43898. * @param minimumWorld Determines the smaller position of the bounding box extend
  43899. * @param maximumWorld Determines the bigger position of the bounding box extend
  43900. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  43901. * @param onAnimationEnd Callback triggered at the end of the framing animation
  43902. */
  43903. zoomOnBoundingInfo(minimumWorld: Vector3, maximumWorld: Vector3, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  43904. /**
  43905. * Calculates the lowest radius for the camera based on the bounding box of the mesh.
  43906. * @param mesh The mesh on which to base the calculation. mesh boundingInfo used to estimate necessary
  43907. * frustum width.
  43908. * @return The minimum distance from the primary mesh's center point at which the camera must be kept in order
  43909. * to fully enclose the mesh in the viewing frustum.
  43910. */
  43911. protected _calculateLowerRadiusFromModelBoundingSphere(minimumWorld: Vector3, maximumWorld: Vector3): number;
  43912. /**
  43913. * Keeps the camera above the ground plane. If the user pulls the camera below the ground plane, the camera
  43914. * is automatically returned to its default position (expected to be above ground plane).
  43915. */
  43916. private _maintainCameraAboveGround;
  43917. /**
  43918. * Returns the frustum slope based on the canvas ratio and camera FOV
  43919. * @returns The frustum slope represented as a Vector2 with X and Y slopes
  43920. */
  43921. private _getFrustumSlope;
  43922. /**
  43923. * Removes all animation locks. Allows new animations to be added to any of the arcCamera properties.
  43924. */
  43925. private _clearAnimationLocks;
  43926. /**
  43927. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  43928. */
  43929. private _applyUserInteraction;
  43930. /**
  43931. * Stops and removes all animations that have been applied to the camera
  43932. */
  43933. stopAllAnimations(): void;
  43934. /**
  43935. * Gets a value indicating if the user is moving the camera
  43936. */
  43937. get isUserIsMoving(): boolean;
  43938. /**
  43939. * The camera can move all the way towards the mesh.
  43940. */
  43941. static IgnoreBoundsSizeMode: number;
  43942. /**
  43943. * The camera is not allowed to zoom closer to the mesh than the point at which the adjusted bounding sphere touches the frustum sides
  43944. */
  43945. static FitFrustumSidesMode: number;
  43946. }
  43947. }
  43948. declare module "babylonjs/Cameras/Inputs/BaseCameraPointersInput" {
  43949. import { Nullable } from "babylonjs/types";
  43950. import { Camera } from "babylonjs/Cameras/camera";
  43951. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  43952. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  43953. /**
  43954. * Base class for Camera Pointer Inputs.
  43955. * See FollowCameraPointersInput in src/Cameras/Inputs/followCameraPointersInput.ts
  43956. * for example usage.
  43957. */
  43958. export abstract class BaseCameraPointersInput implements ICameraInput<Camera> {
  43959. /**
  43960. * Defines the camera the input is attached to.
  43961. */
  43962. abstract camera: Camera;
  43963. /**
  43964. * Whether keyboard modifier keys are pressed at time of last mouse event.
  43965. */
  43966. protected _altKey: boolean;
  43967. protected _ctrlKey: boolean;
  43968. protected _metaKey: boolean;
  43969. protected _shiftKey: boolean;
  43970. /**
  43971. * Which mouse buttons were pressed at time of last mouse event.
  43972. * https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/buttons
  43973. */
  43974. protected _buttonsPressed: number;
  43975. /**
  43976. * Defines the buttons associated with the input to handle camera move.
  43977. */
  43978. buttons: number[];
  43979. /**
  43980. * Attach the input controls to a specific dom element to get the input from.
  43981. * @param element Defines the element the controls should be listened from
  43982. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  43983. */
  43984. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  43985. /**
  43986. * Detach the current controls from the specified dom element.
  43987. * @param element Defines the element to stop listening the inputs from
  43988. */
  43989. detachControl(element: Nullable<HTMLElement>): void;
  43990. /**
  43991. * Gets the class name of the current input.
  43992. * @returns the class name
  43993. */
  43994. getClassName(): string;
  43995. /**
  43996. * Get the friendly name associated with the input class.
  43997. * @returns the input friendly name
  43998. */
  43999. getSimpleName(): string;
  44000. /**
  44001. * Called on pointer POINTERDOUBLETAP event.
  44002. * Override this method to provide functionality on POINTERDOUBLETAP event.
  44003. */
  44004. protected onDoubleTap(type: string): void;
  44005. /**
  44006. * Called on pointer POINTERMOVE event if only a single touch is active.
  44007. * Override this method to provide functionality.
  44008. */
  44009. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  44010. /**
  44011. * Called on pointer POINTERMOVE event if multiple touches are active.
  44012. * Override this method to provide functionality.
  44013. */
  44014. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  44015. /**
  44016. * Called on JS contextmenu event.
  44017. * Override this method to provide functionality.
  44018. */
  44019. protected onContextMenu(evt: PointerEvent): void;
  44020. /**
  44021. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  44022. * press.
  44023. * Override this method to provide functionality.
  44024. */
  44025. protected onButtonDown(evt: PointerEvent): void;
  44026. /**
  44027. * Called each time a new POINTERUP event occurs. Ie, for each button
  44028. * release.
  44029. * Override this method to provide functionality.
  44030. */
  44031. protected onButtonUp(evt: PointerEvent): void;
  44032. /**
  44033. * Called when window becomes inactive.
  44034. * Override this method to provide functionality.
  44035. */
  44036. protected onLostFocus(): void;
  44037. private _pointerInput;
  44038. private _observer;
  44039. private _onLostFocus;
  44040. private pointA;
  44041. private pointB;
  44042. }
  44043. }
  44044. declare module "babylonjs/Cameras/Inputs/arcRotateCameraPointersInput" {
  44045. import { Nullable } from "babylonjs/types";
  44046. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44047. import { BaseCameraPointersInput } from "babylonjs/Cameras/Inputs/BaseCameraPointersInput";
  44048. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  44049. /**
  44050. * Manage the pointers inputs to control an arc rotate camera.
  44051. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  44052. */
  44053. export class ArcRotateCameraPointersInput extends BaseCameraPointersInput {
  44054. /**
  44055. * Defines the camera the input is attached to.
  44056. */
  44057. camera: ArcRotateCamera;
  44058. /**
  44059. * Gets the class name of the current input.
  44060. * @returns the class name
  44061. */
  44062. getClassName(): string;
  44063. /**
  44064. * Defines the buttons associated with the input to handle camera move.
  44065. */
  44066. buttons: number[];
  44067. /**
  44068. * Defines the pointer angular sensibility along the X axis or how fast is
  44069. * the camera rotating.
  44070. */
  44071. angularSensibilityX: number;
  44072. /**
  44073. * Defines the pointer angular sensibility along the Y axis or how fast is
  44074. * the camera rotating.
  44075. */
  44076. angularSensibilityY: number;
  44077. /**
  44078. * Defines the pointer pinch precision or how fast is the camera zooming.
  44079. */
  44080. pinchPrecision: number;
  44081. /**
  44082. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  44083. * from 0.
  44084. * It defines the percentage of current camera.radius to use as delta when
  44085. * pinch zoom is used.
  44086. */
  44087. pinchDeltaPercentage: number;
  44088. /**
  44089. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  44090. * that any object in the plane at the camera's target point will scale
  44091. * perfectly with finger motion.
  44092. * Overrides pinchDeltaPercentage and pinchPrecision.
  44093. */
  44094. useNaturalPinchZoom: boolean;
  44095. /**
  44096. * Defines the pointer panning sensibility or how fast is the camera moving.
  44097. */
  44098. panningSensibility: number;
  44099. /**
  44100. * Defines whether panning (2 fingers swipe) is enabled through multitouch.
  44101. */
  44102. multiTouchPanning: boolean;
  44103. /**
  44104. * Defines whether panning is enabled for both pan (2 fingers swipe) and
  44105. * zoom (pinch) through multitouch.
  44106. */
  44107. multiTouchPanAndZoom: boolean;
  44108. /**
  44109. * Revers pinch action direction.
  44110. */
  44111. pinchInwards: boolean;
  44112. private _isPanClick;
  44113. private _twoFingerActivityCount;
  44114. private _isPinching;
  44115. /**
  44116. * Called on pointer POINTERMOVE event if only a single touch is active.
  44117. */
  44118. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  44119. /**
  44120. * Called on pointer POINTERDOUBLETAP event.
  44121. */
  44122. protected onDoubleTap(type: string): void;
  44123. /**
  44124. * Called on pointer POINTERMOVE event if multiple touches are active.
  44125. */
  44126. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  44127. /**
  44128. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  44129. * press.
  44130. */
  44131. protected onButtonDown(evt: PointerEvent): void;
  44132. /**
  44133. * Called each time a new POINTERUP event occurs. Ie, for each button
  44134. * release.
  44135. */
  44136. protected onButtonUp(evt: PointerEvent): void;
  44137. /**
  44138. * Called when window becomes inactive.
  44139. */
  44140. protected onLostFocus(): void;
  44141. }
  44142. }
  44143. declare module "babylonjs/Cameras/Inputs/arcRotateCameraKeyboardMoveInput" {
  44144. import { Nullable } from "babylonjs/types";
  44145. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44146. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  44147. /**
  44148. * Manage the keyboard inputs to control the movement of an arc rotate camera.
  44149. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  44150. */
  44151. export class ArcRotateCameraKeyboardMoveInput implements ICameraInput<ArcRotateCamera> {
  44152. /**
  44153. * Defines the camera the input is attached to.
  44154. */
  44155. camera: ArcRotateCamera;
  44156. /**
  44157. * Defines the list of key codes associated with the up action (increase alpha)
  44158. */
  44159. keysUp: number[];
  44160. /**
  44161. * Defines the list of key codes associated with the down action (decrease alpha)
  44162. */
  44163. keysDown: number[];
  44164. /**
  44165. * Defines the list of key codes associated with the left action (increase beta)
  44166. */
  44167. keysLeft: number[];
  44168. /**
  44169. * Defines the list of key codes associated with the right action (decrease beta)
  44170. */
  44171. keysRight: number[];
  44172. /**
  44173. * Defines the list of key codes associated with the reset action.
  44174. * Those keys reset the camera to its last stored state (with the method camera.storeState())
  44175. */
  44176. keysReset: number[];
  44177. /**
  44178. * Defines the panning sensibility of the inputs.
  44179. * (How fast is the camera panning)
  44180. */
  44181. panningSensibility: number;
  44182. /**
  44183. * Defines the zooming sensibility of the inputs.
  44184. * (How fast is the camera zooming)
  44185. */
  44186. zoomingSensibility: number;
  44187. /**
  44188. * Defines whether maintaining the alt key down switch the movement mode from
  44189. * orientation to zoom.
  44190. */
  44191. useAltToZoom: boolean;
  44192. /**
  44193. * Rotation speed of the camera
  44194. */
  44195. angularSpeed: number;
  44196. private _keys;
  44197. private _ctrlPressed;
  44198. private _altPressed;
  44199. private _onCanvasBlurObserver;
  44200. private _onKeyboardObserver;
  44201. private _engine;
  44202. private _scene;
  44203. /**
  44204. * Attach the input controls to a specific dom element to get the input from.
  44205. * @param element Defines the element the controls should be listened from
  44206. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  44207. */
  44208. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  44209. /**
  44210. * Detach the current controls from the specified dom element.
  44211. * @param element Defines the element to stop listening the inputs from
  44212. */
  44213. detachControl(element: Nullable<HTMLElement>): void;
  44214. /**
  44215. * Update the current camera state depending on the inputs that have been used this frame.
  44216. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  44217. */
  44218. checkInputs(): void;
  44219. /**
  44220. * Gets the class name of the current intput.
  44221. * @returns the class name
  44222. */
  44223. getClassName(): string;
  44224. /**
  44225. * Get the friendly name associated with the input class.
  44226. * @returns the input friendly name
  44227. */
  44228. getSimpleName(): string;
  44229. }
  44230. }
  44231. declare module "babylonjs/Cameras/Inputs/arcRotateCameraMouseWheelInput" {
  44232. import { Nullable } from "babylonjs/types";
  44233. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44234. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  44235. /**
  44236. * Manage the mouse wheel inputs to control an arc rotate camera.
  44237. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  44238. */
  44239. export class ArcRotateCameraMouseWheelInput implements ICameraInput<ArcRotateCamera> {
  44240. /**
  44241. * Defines the camera the input is attached to.
  44242. */
  44243. camera: ArcRotateCamera;
  44244. /**
  44245. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  44246. */
  44247. wheelPrecision: number;
  44248. /**
  44249. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  44250. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  44251. */
  44252. wheelDeltaPercentage: number;
  44253. private _wheel;
  44254. private _observer;
  44255. private computeDeltaFromMouseWheelLegacyEvent;
  44256. /**
  44257. * Attach the input controls to a specific dom element to get the input from.
  44258. * @param element Defines the element the controls should be listened from
  44259. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  44260. */
  44261. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  44262. /**
  44263. * Detach the current controls from the specified dom element.
  44264. * @param element Defines the element to stop listening the inputs from
  44265. */
  44266. detachControl(element: Nullable<HTMLElement>): void;
  44267. /**
  44268. * Gets the class name of the current intput.
  44269. * @returns the class name
  44270. */
  44271. getClassName(): string;
  44272. /**
  44273. * Get the friendly name associated with the input class.
  44274. * @returns the input friendly name
  44275. */
  44276. getSimpleName(): string;
  44277. }
  44278. }
  44279. declare module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  44280. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44281. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  44282. /**
  44283. * Default Inputs manager for the ArcRotateCamera.
  44284. * It groups all the default supported inputs for ease of use.
  44285. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  44286. */
  44287. export class ArcRotateCameraInputsManager extends CameraInputsManager<ArcRotateCamera> {
  44288. /**
  44289. * Instantiates a new ArcRotateCameraInputsManager.
  44290. * @param camera Defines the camera the inputs belong to
  44291. */
  44292. constructor(camera: ArcRotateCamera);
  44293. /**
  44294. * Add mouse wheel input support to the input manager.
  44295. * @returns the current input manager
  44296. */
  44297. addMouseWheel(): ArcRotateCameraInputsManager;
  44298. /**
  44299. * Add pointers input support to the input manager.
  44300. * @returns the current input manager
  44301. */
  44302. addPointers(): ArcRotateCameraInputsManager;
  44303. /**
  44304. * Add keyboard input support to the input manager.
  44305. * @returns the current input manager
  44306. */
  44307. addKeyboard(): ArcRotateCameraInputsManager;
  44308. }
  44309. }
  44310. declare module "babylonjs/Cameras/arcRotateCamera" {
  44311. import { Observable } from "babylonjs/Misc/observable";
  44312. import { Nullable } from "babylonjs/types";
  44313. import { Scene } from "babylonjs/scene";
  44314. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  44315. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44316. import { AutoRotationBehavior } from "babylonjs/Behaviors/Cameras/autoRotationBehavior";
  44317. import { BouncingBehavior } from "babylonjs/Behaviors/Cameras/bouncingBehavior";
  44318. import { FramingBehavior } from "babylonjs/Behaviors/Cameras/framingBehavior";
  44319. import { Camera } from "babylonjs/Cameras/camera";
  44320. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  44321. import { ArcRotateCameraInputsManager } from "babylonjs/Cameras/arcRotateCameraInputsManager";
  44322. import { Collider } from "babylonjs/Collisions/collider";
  44323. /**
  44324. * This represents an orbital type of camera.
  44325. *
  44326. * 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.
  44327. * 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.
  44328. * @see https://doc.babylonjs.com/babylon101/cameras#arc-rotate-camera
  44329. */
  44330. export class ArcRotateCamera extends TargetCamera {
  44331. /**
  44332. * Defines the rotation angle of the camera along the longitudinal axis.
  44333. */
  44334. alpha: number;
  44335. /**
  44336. * Defines the rotation angle of the camera along the latitudinal axis.
  44337. */
  44338. beta: number;
  44339. /**
  44340. * Defines the radius of the camera from it s target point.
  44341. */
  44342. radius: number;
  44343. protected _target: Vector3;
  44344. protected _targetHost: Nullable<AbstractMesh>;
  44345. /**
  44346. * Defines the target point of the camera.
  44347. * The camera looks towards it form the radius distance.
  44348. * Please note that you can set the target to a mesh and thus the target will be copied from mesh.position
  44349. */
  44350. get target(): Vector3;
  44351. set target(value: Vector3);
  44352. /**
  44353. * Define the current local position of the camera in the scene
  44354. */
  44355. get position(): Vector3;
  44356. set position(newPosition: Vector3);
  44357. protected _upToYMatrix: Matrix;
  44358. protected _YToUpMatrix: Matrix;
  44359. /**
  44360. * The vector the camera should consider as up. (default is Vector3(0, 1, 0) as returned by Vector3.Up())
  44361. * Setting this will copy the given vector to the camera's upVector, and set rotation matrices to and from Y up.
  44362. * DO NOT set the up vector using copyFrom or copyFromFloats, as this bypasses setting the above matrices.
  44363. */
  44364. set upVector(vec: Vector3);
  44365. get upVector(): Vector3;
  44366. /**
  44367. * Sets the Y-up to camera up-vector rotation matrix, and the up-vector to Y-up rotation matrix.
  44368. */
  44369. setMatUp(): void;
  44370. /**
  44371. * Current inertia value on the longitudinal axis.
  44372. * The bigger this number the longer it will take for the camera to stop.
  44373. */
  44374. inertialAlphaOffset: number;
  44375. /**
  44376. * Current inertia value on the latitudinal axis.
  44377. * The bigger this number the longer it will take for the camera to stop.
  44378. */
  44379. inertialBetaOffset: number;
  44380. /**
  44381. * Current inertia value on the radius axis.
  44382. * The bigger this number the longer it will take for the camera to stop.
  44383. */
  44384. inertialRadiusOffset: number;
  44385. /**
  44386. * Minimum allowed angle on the longitudinal axis.
  44387. * This can help limiting how the Camera is able to move in the scene.
  44388. */
  44389. lowerAlphaLimit: Nullable<number>;
  44390. /**
  44391. * Maximum allowed angle on the longitudinal axis.
  44392. * This can help limiting how the Camera is able to move in the scene.
  44393. */
  44394. upperAlphaLimit: Nullable<number>;
  44395. /**
  44396. * Minimum allowed angle on the latitudinal axis.
  44397. * This can help limiting how the Camera is able to move in the scene.
  44398. */
  44399. lowerBetaLimit: number;
  44400. /**
  44401. * Maximum allowed angle on the latitudinal axis.
  44402. * This can help limiting how the Camera is able to move in the scene.
  44403. */
  44404. upperBetaLimit: number;
  44405. /**
  44406. * Minimum allowed distance of the camera to the target (The camera can not get closer).
  44407. * This can help limiting how the Camera is able to move in the scene.
  44408. */
  44409. lowerRadiusLimit: Nullable<number>;
  44410. /**
  44411. * Maximum allowed distance of the camera to the target (The camera can not get further).
  44412. * This can help limiting how the Camera is able to move in the scene.
  44413. */
  44414. upperRadiusLimit: Nullable<number>;
  44415. /**
  44416. * Defines the current inertia value used during panning of the camera along the X axis.
  44417. */
  44418. inertialPanningX: number;
  44419. /**
  44420. * Defines the current inertia value used during panning of the camera along the Y axis.
  44421. */
  44422. inertialPanningY: number;
  44423. /**
  44424. * Defines the distance used to consider the camera in pan mode vs pinch/zoom.
  44425. * Basically if your fingers moves away from more than this distance you will be considered
  44426. * in pinch mode.
  44427. */
  44428. pinchToPanMaxDistance: number;
  44429. /**
  44430. * Defines the maximum distance the camera can pan.
  44431. * This could help keeping the cammera always in your scene.
  44432. */
  44433. panningDistanceLimit: Nullable<number>;
  44434. /**
  44435. * Defines the target of the camera before paning.
  44436. */
  44437. panningOriginTarget: Vector3;
  44438. /**
  44439. * Defines the value of the inertia used during panning.
  44440. * 0 would mean stop inertia and one would mean no decelleration at all.
  44441. */
  44442. panningInertia: number;
  44443. /**
  44444. * Gets or Set the pointer angular sensibility along the X axis or how fast is the camera rotating.
  44445. */
  44446. get angularSensibilityX(): number;
  44447. set angularSensibilityX(value: number);
  44448. /**
  44449. * Gets or Set the pointer angular sensibility along the Y axis or how fast is the camera rotating.
  44450. */
  44451. get angularSensibilityY(): number;
  44452. set angularSensibilityY(value: number);
  44453. /**
  44454. * Gets or Set the pointer pinch precision or how fast is the camera zooming.
  44455. */
  44456. get pinchPrecision(): number;
  44457. set pinchPrecision(value: number);
  44458. /**
  44459. * Gets or Set the pointer pinch delta percentage or how fast is the camera zooming.
  44460. * It will be used instead of pinchDeltaPrecision if different from 0.
  44461. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  44462. */
  44463. get pinchDeltaPercentage(): number;
  44464. set pinchDeltaPercentage(value: number);
  44465. /**
  44466. * Gets or Set the pointer use natural pinch zoom to override the pinch precision
  44467. * and pinch delta percentage.
  44468. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  44469. * that any object in the plane at the camera's target point will scale
  44470. * perfectly with finger motion.
  44471. */
  44472. get useNaturalPinchZoom(): boolean;
  44473. set useNaturalPinchZoom(value: boolean);
  44474. /**
  44475. * Gets or Set the pointer panning sensibility or how fast is the camera moving.
  44476. */
  44477. get panningSensibility(): number;
  44478. set panningSensibility(value: number);
  44479. /**
  44480. * Gets or Set the list of keyboard keys used to control beta angle in a positive direction.
  44481. */
  44482. get keysUp(): number[];
  44483. set keysUp(value: number[]);
  44484. /**
  44485. * Gets or Set the list of keyboard keys used to control beta angle in a negative direction.
  44486. */
  44487. get keysDown(): number[];
  44488. set keysDown(value: number[]);
  44489. /**
  44490. * Gets or Set the list of keyboard keys used to control alpha angle in a negative direction.
  44491. */
  44492. get keysLeft(): number[];
  44493. set keysLeft(value: number[]);
  44494. /**
  44495. * Gets or Set the list of keyboard keys used to control alpha angle in a positive direction.
  44496. */
  44497. get keysRight(): number[];
  44498. set keysRight(value: number[]);
  44499. /**
  44500. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  44501. */
  44502. get wheelPrecision(): number;
  44503. set wheelPrecision(value: number);
  44504. /**
  44505. * Gets or Set the mouse wheel delta percentage or how fast is the camera zooming.
  44506. * It will be used instead of pinchDeltaPrecision if different from 0.
  44507. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  44508. */
  44509. get wheelDeltaPercentage(): number;
  44510. set wheelDeltaPercentage(value: number);
  44511. /**
  44512. * Defines how much the radius should be scaled while zomming on a particular mesh (through the zoomOn function)
  44513. */
  44514. zoomOnFactor: number;
  44515. /**
  44516. * Defines a screen offset for the camera position.
  44517. */
  44518. targetScreenOffset: Vector2;
  44519. /**
  44520. * Allows the camera to be completely reversed.
  44521. * If false the camera can not arrive upside down.
  44522. */
  44523. allowUpsideDown: boolean;
  44524. /**
  44525. * Define if double tap/click is used to restore the previously saved state of the camera.
  44526. */
  44527. useInputToRestoreState: boolean;
  44528. /** @hidden */
  44529. _viewMatrix: Matrix;
  44530. /** @hidden */
  44531. _useCtrlForPanning: boolean;
  44532. /** @hidden */
  44533. _panningMouseButton: number;
  44534. /**
  44535. * Defines the input associated to the camera.
  44536. */
  44537. inputs: ArcRotateCameraInputsManager;
  44538. /** @hidden */
  44539. _reset: () => void;
  44540. /**
  44541. * Defines the allowed panning axis.
  44542. */
  44543. panningAxis: Vector3;
  44544. protected _localDirection: Vector3;
  44545. protected _transformedDirection: Vector3;
  44546. private _bouncingBehavior;
  44547. /**
  44548. * Gets the bouncing behavior of the camera if it has been enabled.
  44549. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  44550. */
  44551. get bouncingBehavior(): Nullable<BouncingBehavior>;
  44552. /**
  44553. * Defines if the bouncing behavior of the camera is enabled on the camera.
  44554. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  44555. */
  44556. get useBouncingBehavior(): boolean;
  44557. set useBouncingBehavior(value: boolean);
  44558. private _framingBehavior;
  44559. /**
  44560. * Gets the framing behavior of the camera if it has been enabled.
  44561. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  44562. */
  44563. get framingBehavior(): Nullable<FramingBehavior>;
  44564. /**
  44565. * Defines if the framing behavior of the camera is enabled on the camera.
  44566. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  44567. */
  44568. get useFramingBehavior(): boolean;
  44569. set useFramingBehavior(value: boolean);
  44570. private _autoRotationBehavior;
  44571. /**
  44572. * Gets the auto rotation behavior of the camera if it has been enabled.
  44573. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  44574. */
  44575. get autoRotationBehavior(): Nullable<AutoRotationBehavior>;
  44576. /**
  44577. * Defines if the auto rotation behavior of the camera is enabled on the camera.
  44578. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  44579. */
  44580. get useAutoRotationBehavior(): boolean;
  44581. set useAutoRotationBehavior(value: boolean);
  44582. /**
  44583. * Observable triggered when the mesh target has been changed on the camera.
  44584. */
  44585. onMeshTargetChangedObservable: Observable<Nullable<AbstractMesh>>;
  44586. /**
  44587. * Event raised when the camera is colliding with a mesh.
  44588. */
  44589. onCollide: (collidedMesh: AbstractMesh) => void;
  44590. /**
  44591. * Defines whether the camera should check collision with the objects oh the scene.
  44592. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#how-can-i-do-this
  44593. */
  44594. checkCollisions: boolean;
  44595. /**
  44596. * Defines the collision radius of the camera.
  44597. * This simulates a sphere around the camera.
  44598. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  44599. */
  44600. collisionRadius: Vector3;
  44601. protected _collider: Collider;
  44602. protected _previousPosition: Vector3;
  44603. protected _collisionVelocity: Vector3;
  44604. protected _newPosition: Vector3;
  44605. protected _previousAlpha: number;
  44606. protected _previousBeta: number;
  44607. protected _previousRadius: number;
  44608. protected _collisionTriggered: boolean;
  44609. protected _targetBoundingCenter: Nullable<Vector3>;
  44610. private _computationVector;
  44611. /**
  44612. * Instantiates a new ArcRotateCamera in a given scene
  44613. * @param name Defines the name of the camera
  44614. * @param alpha Defines the camera rotation along the logitudinal axis
  44615. * @param beta Defines the camera rotation along the latitudinal axis
  44616. * @param radius Defines the camera distance from its target
  44617. * @param target Defines the camera target
  44618. * @param scene Defines the scene the camera belongs to
  44619. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  44620. */
  44621. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  44622. /** @hidden */
  44623. _initCache(): void;
  44624. /** @hidden */
  44625. _updateCache(ignoreParentClass?: boolean): void;
  44626. protected _getTargetPosition(): Vector3;
  44627. private _storedAlpha;
  44628. private _storedBeta;
  44629. private _storedRadius;
  44630. private _storedTarget;
  44631. private _storedTargetScreenOffset;
  44632. /**
  44633. * Stores the current state of the camera (alpha, beta, radius and target)
  44634. * @returns the camera itself
  44635. */
  44636. storeState(): Camera;
  44637. /**
  44638. * @hidden
  44639. * Restored camera state. You must call storeState() first
  44640. */
  44641. _restoreStateValues(): boolean;
  44642. /** @hidden */
  44643. _isSynchronizedViewMatrix(): boolean;
  44644. /**
  44645. * Attached controls to the current camera.
  44646. * @param element Defines the element the controls should be listened from
  44647. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  44648. * @param useCtrlForPanning Defines whether ctrl is used for paning within the controls
  44649. * @param panningMouseButton Defines whether panning is allowed through mouse click button
  44650. */
  44651. attachControl(element: HTMLElement, noPreventDefault?: boolean, useCtrlForPanning?: boolean, panningMouseButton?: number): void;
  44652. /**
  44653. * Detach the current controls from the camera.
  44654. * The camera will stop reacting to inputs.
  44655. * @param element Defines the element to stop listening the inputs from
  44656. */
  44657. detachControl(element: HTMLElement): void;
  44658. /** @hidden */
  44659. _checkInputs(): void;
  44660. protected _checkLimits(): void;
  44661. /**
  44662. * Rebuilds angles (alpha, beta) and radius from the give position and target
  44663. */
  44664. rebuildAnglesAndRadius(): void;
  44665. /**
  44666. * Use a position to define the current camera related information like alpha, beta and radius
  44667. * @param position Defines the position to set the camera at
  44668. */
  44669. setPosition(position: Vector3): void;
  44670. /**
  44671. * Defines the target the camera should look at.
  44672. * This will automatically adapt alpha beta and radius to fit within the new target.
  44673. * @param target Defines the new target as a Vector or a mesh
  44674. * @param toBoundingCenter In case of a mesh target, defines whether to target the mesh position or its bounding information center
  44675. * @param allowSamePosition If false, prevents reapplying the new computed position if it is identical to the current one (optim)
  44676. */
  44677. setTarget(target: AbstractMesh | Vector3, toBoundingCenter?: boolean, allowSamePosition?: boolean): void;
  44678. /** @hidden */
  44679. _getViewMatrix(): Matrix;
  44680. protected _onCollisionPositionChange: (collisionId: number, newPosition: Vector3, collidedMesh?: Nullable<AbstractMesh>) => void;
  44681. /**
  44682. * Zooms on a mesh to be at the min distance where we could see it fully in the current viewport.
  44683. * @param meshes Defines the mesh to zoom on
  44684. * @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)
  44685. */
  44686. zoomOn(meshes?: AbstractMesh[], doNotUpdateMaxZ?: boolean): void;
  44687. /**
  44688. * Focus on a mesh or a bounding box. This adapts the target and maxRadius if necessary but does not update the current radius.
  44689. * The target will be changed but the radius
  44690. * @param meshesOrMinMaxVectorAndDistance Defines the mesh or bounding info to focus on
  44691. * @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)
  44692. */
  44693. focusOn(meshesOrMinMaxVectorAndDistance: AbstractMesh[] | {
  44694. min: Vector3;
  44695. max: Vector3;
  44696. distance: number;
  44697. }, doNotUpdateMaxZ?: boolean): void;
  44698. /**
  44699. * @override
  44700. * Override Camera.createRigCamera
  44701. */
  44702. createRigCamera(name: string, cameraIndex: number): Camera;
  44703. /**
  44704. * @hidden
  44705. * @override
  44706. * Override Camera._updateRigCameras
  44707. */
  44708. _updateRigCameras(): void;
  44709. /**
  44710. * Destroy the camera and release the current resources hold by it.
  44711. */
  44712. dispose(): void;
  44713. /**
  44714. * Gets the current object class name.
  44715. * @return the class name
  44716. */
  44717. getClassName(): string;
  44718. }
  44719. }
  44720. declare module "babylonjs/Behaviors/Cameras/autoRotationBehavior" {
  44721. import { Behavior } from "babylonjs/Behaviors/behavior";
  44722. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44723. /**
  44724. * The autoRotation behavior (AutoRotationBehavior) is designed to create a smooth rotation of an ArcRotateCamera when there is no user interaction.
  44725. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  44726. */
  44727. export class AutoRotationBehavior implements Behavior<ArcRotateCamera> {
  44728. /**
  44729. * Gets the name of the behavior.
  44730. */
  44731. get name(): string;
  44732. private _zoomStopsAnimation;
  44733. private _idleRotationSpeed;
  44734. private _idleRotationWaitTime;
  44735. private _idleRotationSpinupTime;
  44736. /**
  44737. * Sets the flag that indicates if user zooming should stop animation.
  44738. */
  44739. set zoomStopsAnimation(flag: boolean);
  44740. /**
  44741. * Gets the flag that indicates if user zooming should stop animation.
  44742. */
  44743. get zoomStopsAnimation(): boolean;
  44744. /**
  44745. * Sets the default speed at which the camera rotates around the model.
  44746. */
  44747. set idleRotationSpeed(speed: number);
  44748. /**
  44749. * Gets the default speed at which the camera rotates around the model.
  44750. */
  44751. get idleRotationSpeed(): number;
  44752. /**
  44753. * Sets the time (in milliseconds) to wait after user interaction before the camera starts rotating.
  44754. */
  44755. set idleRotationWaitTime(time: number);
  44756. /**
  44757. * Gets the time (milliseconds) to wait after user interaction before the camera starts rotating.
  44758. */
  44759. get idleRotationWaitTime(): number;
  44760. /**
  44761. * Sets the time (milliseconds) to take to spin up to the full idle rotation speed.
  44762. */
  44763. set idleRotationSpinupTime(time: number);
  44764. /**
  44765. * Gets the time (milliseconds) to take to spin up to the full idle rotation speed.
  44766. */
  44767. get idleRotationSpinupTime(): number;
  44768. /**
  44769. * Gets a value indicating if the camera is currently rotating because of this behavior
  44770. */
  44771. get rotationInProgress(): boolean;
  44772. private _onPrePointerObservableObserver;
  44773. private _onAfterCheckInputsObserver;
  44774. private _attachedCamera;
  44775. private _isPointerDown;
  44776. private _lastFrameTime;
  44777. private _lastInteractionTime;
  44778. private _cameraRotationSpeed;
  44779. /**
  44780. * Initializes the behavior.
  44781. */
  44782. init(): void;
  44783. /**
  44784. * Attaches the behavior to its arc rotate camera.
  44785. * @param camera Defines the camera to attach the behavior to
  44786. */
  44787. attach(camera: ArcRotateCamera): void;
  44788. /**
  44789. * Detaches the behavior from its current arc rotate camera.
  44790. */
  44791. detach(): void;
  44792. /**
  44793. * Returns true if user is scrolling.
  44794. * @return true if user is scrolling.
  44795. */
  44796. private _userIsZooming;
  44797. private _lastFrameRadius;
  44798. private _shouldAnimationStopForInteraction;
  44799. /**
  44800. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  44801. */
  44802. private _applyUserInteraction;
  44803. private _userIsMoving;
  44804. }
  44805. }
  44806. declare module "babylonjs/Behaviors/Cameras/index" {
  44807. export * from "babylonjs/Behaviors/Cameras/autoRotationBehavior";
  44808. export * from "babylonjs/Behaviors/Cameras/bouncingBehavior";
  44809. export * from "babylonjs/Behaviors/Cameras/framingBehavior";
  44810. }
  44811. declare module "babylonjs/Behaviors/Meshes/attachToBoxBehavior" {
  44812. import { Mesh } from "babylonjs/Meshes/mesh";
  44813. import { TransformNode } from "babylonjs/Meshes/transformNode";
  44814. import { Behavior } from "babylonjs/Behaviors/behavior";
  44815. /**
  44816. * A behavior that when attached to a mesh will will place a specified node on the meshes face pointing towards the camera
  44817. */
  44818. export class AttachToBoxBehavior implements Behavior<Mesh> {
  44819. private ui;
  44820. /**
  44821. * The name of the behavior
  44822. */
  44823. name: string;
  44824. /**
  44825. * The distance away from the face of the mesh that the UI should be attached to (default: 0.15)
  44826. */
  44827. distanceAwayFromFace: number;
  44828. /**
  44829. * The distance from the bottom of the face that the UI should be attached to (default: 0.15)
  44830. */
  44831. distanceAwayFromBottomOfFace: number;
  44832. private _faceVectors;
  44833. private _target;
  44834. private _scene;
  44835. private _onRenderObserver;
  44836. private _tmpMatrix;
  44837. private _tmpVector;
  44838. /**
  44839. * Creates the AttachToBoxBehavior, used to attach UI to the closest face of the box to a camera
  44840. * @param ui The transform node that should be attched to the mesh
  44841. */
  44842. constructor(ui: TransformNode);
  44843. /**
  44844. * Initializes the behavior
  44845. */
  44846. init(): void;
  44847. private _closestFace;
  44848. private _zeroVector;
  44849. private _lookAtTmpMatrix;
  44850. private _lookAtToRef;
  44851. /**
  44852. * Attaches the AttachToBoxBehavior to the passed in mesh
  44853. * @param target The mesh that the specified node will be attached to
  44854. */
  44855. attach(target: Mesh): void;
  44856. /**
  44857. * Detaches the behavior from the mesh
  44858. */
  44859. detach(): void;
  44860. }
  44861. }
  44862. declare module "babylonjs/Behaviors/Meshes/fadeInOutBehavior" {
  44863. import { Behavior } from "babylonjs/Behaviors/behavior";
  44864. import { Mesh } from "babylonjs/Meshes/mesh";
  44865. /**
  44866. * A behavior that when attached to a mesh will allow the mesh to fade in and out
  44867. */
  44868. export class FadeInOutBehavior implements Behavior<Mesh> {
  44869. /**
  44870. * Time in milliseconds to delay before fading in (Default: 0)
  44871. */
  44872. delay: number;
  44873. /**
  44874. * Time in milliseconds for the mesh to fade in (Default: 300)
  44875. */
  44876. fadeInTime: number;
  44877. private _millisecondsPerFrame;
  44878. private _hovered;
  44879. private _hoverValue;
  44880. private _ownerNode;
  44881. /**
  44882. * Instatiates the FadeInOutBehavior
  44883. */
  44884. constructor();
  44885. /**
  44886. * The name of the behavior
  44887. */
  44888. get name(): string;
  44889. /**
  44890. * Initializes the behavior
  44891. */
  44892. init(): void;
  44893. /**
  44894. * Attaches the fade behavior on the passed in mesh
  44895. * @param ownerNode The mesh that will be faded in/out once attached
  44896. */
  44897. attach(ownerNode: Mesh): void;
  44898. /**
  44899. * Detaches the behavior from the mesh
  44900. */
  44901. detach(): void;
  44902. /**
  44903. * Triggers the mesh to begin fading in or out
  44904. * @param value if the object should fade in or out (true to fade in)
  44905. */
  44906. fadeIn(value: boolean): void;
  44907. private _update;
  44908. private _setAllVisibility;
  44909. }
  44910. }
  44911. declare module "babylonjs/Misc/pivotTools" {
  44912. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44913. /**
  44914. * Class containing a set of static utilities functions for managing Pivots
  44915. * @hidden
  44916. */
  44917. export class PivotTools {
  44918. private static _PivotCached;
  44919. private static _OldPivotPoint;
  44920. private static _PivotTranslation;
  44921. private static _PivotTmpVector;
  44922. private static _PivotPostMultiplyPivotMatrix;
  44923. /** @hidden */
  44924. static _RemoveAndStorePivotPoint(mesh: AbstractMesh): void;
  44925. /** @hidden */
  44926. static _RestorePivotPoint(mesh: AbstractMesh): void;
  44927. }
  44928. }
  44929. declare module "babylonjs/Meshes/Builders/planeBuilder" {
  44930. import { Scene } from "babylonjs/scene";
  44931. import { Vector4 } from "babylonjs/Maths/math.vector";
  44932. import { Mesh } from "babylonjs/Meshes/mesh";
  44933. import { Nullable } from "babylonjs/types";
  44934. import { Plane } from "babylonjs/Maths/math.plane";
  44935. /**
  44936. * Class containing static functions to help procedurally build meshes
  44937. */
  44938. export class PlaneBuilder {
  44939. /**
  44940. * Creates a plane mesh
  44941. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  44942. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  44943. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  44944. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  44945. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  44946. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  44947. * @param name defines the name of the mesh
  44948. * @param options defines the options used to create the mesh
  44949. * @param scene defines the hosting scene
  44950. * @returns the plane mesh
  44951. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  44952. */
  44953. static CreatePlane(name: string, options: {
  44954. size?: number;
  44955. width?: number;
  44956. height?: number;
  44957. sideOrientation?: number;
  44958. frontUVs?: Vector4;
  44959. backUVs?: Vector4;
  44960. updatable?: boolean;
  44961. sourcePlane?: Plane;
  44962. }, scene?: Nullable<Scene>): Mesh;
  44963. }
  44964. }
  44965. declare module "babylonjs/Behaviors/Meshes/pointerDragBehavior" {
  44966. import { Behavior } from "babylonjs/Behaviors/behavior";
  44967. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44968. import { Observable } from "babylonjs/Misc/observable";
  44969. import { Vector3 } from "babylonjs/Maths/math.vector";
  44970. import { Ray } from "babylonjs/Culling/ray";
  44971. import "babylonjs/Meshes/Builders/planeBuilder";
  44972. /**
  44973. * A behavior that when attached to a mesh will allow the mesh to be dragged around the screen based on pointer events
  44974. */
  44975. export class PointerDragBehavior implements Behavior<AbstractMesh> {
  44976. private static _AnyMouseID;
  44977. /**
  44978. * Abstract mesh the behavior is set on
  44979. */
  44980. attachedNode: AbstractMesh;
  44981. private _dragPlane;
  44982. private _scene;
  44983. private _pointerObserver;
  44984. private _beforeRenderObserver;
  44985. private static _planeScene;
  44986. private _useAlternatePickedPointAboveMaxDragAngleDragSpeed;
  44987. /**
  44988. * 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)
  44989. */
  44990. maxDragAngle: number;
  44991. /**
  44992. * @hidden
  44993. */
  44994. _useAlternatePickedPointAboveMaxDragAngle: boolean;
  44995. /**
  44996. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  44997. */
  44998. currentDraggingPointerID: number;
  44999. /**
  45000. * The last position where the pointer hit the drag plane in world space
  45001. */
  45002. lastDragPosition: Vector3;
  45003. /**
  45004. * If the behavior is currently in a dragging state
  45005. */
  45006. dragging: boolean;
  45007. /**
  45008. * 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)
  45009. */
  45010. dragDeltaRatio: number;
  45011. /**
  45012. * If the drag plane orientation should be updated during the dragging (Default: true)
  45013. */
  45014. updateDragPlane: boolean;
  45015. private _debugMode;
  45016. private _moving;
  45017. /**
  45018. * Fires each time the attached mesh is dragged with the pointer
  45019. * * delta between last drag position and current drag position in world space
  45020. * * dragDistance along the drag axis
  45021. * * dragPlaneNormal normal of the current drag plane used during the drag
  45022. * * dragPlanePoint in world space where the drag intersects the drag plane
  45023. */
  45024. onDragObservable: Observable<{
  45025. delta: Vector3;
  45026. dragPlanePoint: Vector3;
  45027. dragPlaneNormal: Vector3;
  45028. dragDistance: number;
  45029. pointerId: number;
  45030. }>;
  45031. /**
  45032. * Fires each time a drag begins (eg. mouse down on mesh)
  45033. */
  45034. onDragStartObservable: Observable<{
  45035. dragPlanePoint: Vector3;
  45036. pointerId: number;
  45037. }>;
  45038. /**
  45039. * Fires each time a drag ends (eg. mouse release after drag)
  45040. */
  45041. onDragEndObservable: Observable<{
  45042. dragPlanePoint: Vector3;
  45043. pointerId: number;
  45044. }>;
  45045. /**
  45046. * If the attached mesh should be moved when dragged
  45047. */
  45048. moveAttached: boolean;
  45049. /**
  45050. * If the drag behavior will react to drag events (Default: true)
  45051. */
  45052. enabled: boolean;
  45053. /**
  45054. * If pointer events should start and release the drag (Default: true)
  45055. */
  45056. startAndReleaseDragOnPointerEvents: boolean;
  45057. /**
  45058. * If camera controls should be detached during the drag
  45059. */
  45060. detachCameraControls: boolean;
  45061. /**
  45062. * If set, the drag plane/axis will be rotated based on the attached mesh's world rotation (Default: true)
  45063. */
  45064. useObjectOrientationForDragging: boolean;
  45065. private _options;
  45066. /**
  45067. * Gets the options used by the behavior
  45068. */
  45069. get options(): {
  45070. dragAxis?: Vector3;
  45071. dragPlaneNormal?: Vector3;
  45072. };
  45073. /**
  45074. * Sets the options used by the behavior
  45075. */
  45076. set options(options: {
  45077. dragAxis?: Vector3;
  45078. dragPlaneNormal?: Vector3;
  45079. });
  45080. /**
  45081. * Creates a pointer drag behavior that can be attached to a mesh
  45082. * @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)
  45083. */
  45084. constructor(options?: {
  45085. dragAxis?: Vector3;
  45086. dragPlaneNormal?: Vector3;
  45087. });
  45088. /**
  45089. * Predicate to determine if it is valid to move the object to a new position when it is moved
  45090. */
  45091. validateDrag: (targetPosition: Vector3) => boolean;
  45092. /**
  45093. * The name of the behavior
  45094. */
  45095. get name(): string;
  45096. /**
  45097. * Initializes the behavior
  45098. */
  45099. init(): void;
  45100. private _tmpVector;
  45101. private _alternatePickedPoint;
  45102. private _worldDragAxis;
  45103. private _targetPosition;
  45104. private _attachedElement;
  45105. /**
  45106. * Attaches the drag behavior the passed in mesh
  45107. * @param ownerNode The mesh that will be dragged around once attached
  45108. * @param predicate Predicate to use for pick filtering
  45109. */
  45110. attach(ownerNode: AbstractMesh, predicate?: (m: AbstractMesh) => boolean): void;
  45111. /**
  45112. * Force relase the drag action by code.
  45113. */
  45114. releaseDrag(): void;
  45115. private _startDragRay;
  45116. private _lastPointerRay;
  45117. /**
  45118. * Simulates the start of a pointer drag event on the behavior
  45119. * @param pointerId pointerID of the pointer that should be simulated (Default: Any mouse pointer ID)
  45120. * @param fromRay initial ray of the pointer to be simulated (Default: Ray from camera to attached mesh)
  45121. * @param startPickedPoint picked point of the pointer to be simulated (Default: attached mesh position)
  45122. */
  45123. startDrag(pointerId?: number, fromRay?: Ray, startPickedPoint?: Vector3): void;
  45124. private _startDrag;
  45125. private _dragDelta;
  45126. private _moveDrag;
  45127. private _pickWithRayOnDragPlane;
  45128. private _pointA;
  45129. private _pointC;
  45130. private _localAxis;
  45131. private _lookAt;
  45132. private _updateDragPlanePosition;
  45133. /**
  45134. * Detaches the behavior from the mesh
  45135. */
  45136. detach(): void;
  45137. }
  45138. }
  45139. declare module "babylonjs/Behaviors/Meshes/multiPointerScaleBehavior" {
  45140. import { Mesh } from "babylonjs/Meshes/mesh";
  45141. import { Behavior } from "babylonjs/Behaviors/behavior";
  45142. /**
  45143. * A behavior that when attached to a mesh will allow the mesh to be scaled
  45144. */
  45145. export class MultiPointerScaleBehavior implements Behavior<Mesh> {
  45146. private _dragBehaviorA;
  45147. private _dragBehaviorB;
  45148. private _startDistance;
  45149. private _initialScale;
  45150. private _targetScale;
  45151. private _ownerNode;
  45152. private _sceneRenderObserver;
  45153. /**
  45154. * Instantiate a new behavior that when attached to a mesh will allow the mesh to be scaled
  45155. */
  45156. constructor();
  45157. /**
  45158. * The name of the behavior
  45159. */
  45160. get name(): string;
  45161. /**
  45162. * Initializes the behavior
  45163. */
  45164. init(): void;
  45165. private _getCurrentDistance;
  45166. /**
  45167. * Attaches the scale behavior the passed in mesh
  45168. * @param ownerNode The mesh that will be scaled around once attached
  45169. */
  45170. attach(ownerNode: Mesh): void;
  45171. /**
  45172. * Detaches the behavior from the mesh
  45173. */
  45174. detach(): void;
  45175. }
  45176. }
  45177. declare module "babylonjs/Behaviors/Meshes/sixDofDragBehavior" {
  45178. import { Behavior } from "babylonjs/Behaviors/behavior";
  45179. import { Mesh } from "babylonjs/Meshes/mesh";
  45180. import { Observable } from "babylonjs/Misc/observable";
  45181. /**
  45182. * 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
  45183. */
  45184. export class SixDofDragBehavior implements Behavior<Mesh> {
  45185. private static _virtualScene;
  45186. private _ownerNode;
  45187. private _sceneRenderObserver;
  45188. private _scene;
  45189. private _targetPosition;
  45190. private _virtualOriginMesh;
  45191. private _virtualDragMesh;
  45192. private _pointerObserver;
  45193. private _moving;
  45194. private _startingOrientation;
  45195. private _attachedElement;
  45196. /**
  45197. * 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)
  45198. */
  45199. private zDragFactor;
  45200. /**
  45201. * If the object should rotate to face the drag origin
  45202. */
  45203. rotateDraggedObject: boolean;
  45204. /**
  45205. * If the behavior is currently in a dragging state
  45206. */
  45207. dragging: boolean;
  45208. /**
  45209. * 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)
  45210. */
  45211. dragDeltaRatio: number;
  45212. /**
  45213. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  45214. */
  45215. currentDraggingPointerID: number;
  45216. /**
  45217. * If camera controls should be detached during the drag
  45218. */
  45219. detachCameraControls: boolean;
  45220. /**
  45221. * Fires each time a drag starts
  45222. */
  45223. onDragStartObservable: Observable<{}>;
  45224. /**
  45225. * Fires each time a drag ends (eg. mouse release after drag)
  45226. */
  45227. onDragEndObservable: Observable<{}>;
  45228. /**
  45229. * 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
  45230. */
  45231. constructor();
  45232. /**
  45233. * The name of the behavior
  45234. */
  45235. get name(): string;
  45236. /**
  45237. * Initializes the behavior
  45238. */
  45239. init(): void;
  45240. /**
  45241. * In the case of multiplea active cameras, the cameraToUseForPointers should be used if set instead of active camera
  45242. */
  45243. private get _pointerCamera();
  45244. /**
  45245. * Attaches the scale behavior the passed in mesh
  45246. * @param ownerNode The mesh that will be scaled around once attached
  45247. */
  45248. attach(ownerNode: Mesh): void;
  45249. /**
  45250. * Detaches the behavior from the mesh
  45251. */
  45252. detach(): void;
  45253. }
  45254. }
  45255. declare module "babylonjs/Behaviors/Meshes/index" {
  45256. export * from "babylonjs/Behaviors/Meshes/attachToBoxBehavior";
  45257. export * from "babylonjs/Behaviors/Meshes/fadeInOutBehavior";
  45258. export * from "babylonjs/Behaviors/Meshes/multiPointerScaleBehavior";
  45259. export * from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  45260. export * from "babylonjs/Behaviors/Meshes/sixDofDragBehavior";
  45261. }
  45262. declare module "babylonjs/Behaviors/index" {
  45263. export * from "babylonjs/Behaviors/behavior";
  45264. export * from "babylonjs/Behaviors/Cameras/index";
  45265. export * from "babylonjs/Behaviors/Meshes/index";
  45266. }
  45267. declare module "babylonjs/Bones/boneIKController" {
  45268. import { Bone } from "babylonjs/Bones/bone";
  45269. import { Vector3 } from "babylonjs/Maths/math.vector";
  45270. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45271. import { Nullable } from "babylonjs/types";
  45272. /**
  45273. * Class used to apply inverse kinematics to bones
  45274. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#boneikcontroller
  45275. */
  45276. export class BoneIKController {
  45277. private static _tmpVecs;
  45278. private static _tmpQuat;
  45279. private static _tmpMats;
  45280. /**
  45281. * Gets or sets the target mesh
  45282. */
  45283. targetMesh: AbstractMesh;
  45284. /** Gets or sets the mesh used as pole */
  45285. poleTargetMesh: AbstractMesh;
  45286. /**
  45287. * Gets or sets the bone used as pole
  45288. */
  45289. poleTargetBone: Nullable<Bone>;
  45290. /**
  45291. * Gets or sets the target position
  45292. */
  45293. targetPosition: Vector3;
  45294. /**
  45295. * Gets or sets the pole target position
  45296. */
  45297. poleTargetPosition: Vector3;
  45298. /**
  45299. * Gets or sets the pole target local offset
  45300. */
  45301. poleTargetLocalOffset: Vector3;
  45302. /**
  45303. * Gets or sets the pole angle
  45304. */
  45305. poleAngle: number;
  45306. /**
  45307. * Gets or sets the mesh associated with the controller
  45308. */
  45309. mesh: AbstractMesh;
  45310. /**
  45311. * 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)
  45312. */
  45313. slerpAmount: number;
  45314. private _bone1Quat;
  45315. private _bone1Mat;
  45316. private _bone2Ang;
  45317. private _bone1;
  45318. private _bone2;
  45319. private _bone1Length;
  45320. private _bone2Length;
  45321. private _maxAngle;
  45322. private _maxReach;
  45323. private _rightHandedSystem;
  45324. private _bendAxis;
  45325. private _slerping;
  45326. private _adjustRoll;
  45327. /**
  45328. * Gets or sets maximum allowed angle
  45329. */
  45330. get maxAngle(): number;
  45331. set maxAngle(value: number);
  45332. /**
  45333. * Creates a new BoneIKController
  45334. * @param mesh defines the mesh to control
  45335. * @param bone defines the bone to control
  45336. * @param options defines options to set up the controller
  45337. */
  45338. constructor(mesh: AbstractMesh, bone: Bone, options?: {
  45339. targetMesh?: AbstractMesh;
  45340. poleTargetMesh?: AbstractMesh;
  45341. poleTargetBone?: Bone;
  45342. poleTargetLocalOffset?: Vector3;
  45343. poleAngle?: number;
  45344. bendAxis?: Vector3;
  45345. maxAngle?: number;
  45346. slerpAmount?: number;
  45347. });
  45348. private _setMaxAngle;
  45349. /**
  45350. * Force the controller to update the bones
  45351. */
  45352. update(): void;
  45353. }
  45354. }
  45355. declare module "babylonjs/Bones/boneLookController" {
  45356. import { Vector3 } from "babylonjs/Maths/math.vector";
  45357. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45358. import { Bone } from "babylonjs/Bones/bone";
  45359. import { Space } from "babylonjs/Maths/math.axis";
  45360. /**
  45361. * Class used to make a bone look toward a point in space
  45362. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#bonelookcontroller
  45363. */
  45364. export class BoneLookController {
  45365. private static _tmpVecs;
  45366. private static _tmpQuat;
  45367. private static _tmpMats;
  45368. /**
  45369. * The target Vector3 that the bone will look at
  45370. */
  45371. target: Vector3;
  45372. /**
  45373. * The mesh that the bone is attached to
  45374. */
  45375. mesh: AbstractMesh;
  45376. /**
  45377. * The bone that will be looking to the target
  45378. */
  45379. bone: Bone;
  45380. /**
  45381. * The up axis of the coordinate system that is used when the bone is rotated
  45382. */
  45383. upAxis: Vector3;
  45384. /**
  45385. * The space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD
  45386. */
  45387. upAxisSpace: Space;
  45388. /**
  45389. * Used to make an adjustment to the yaw of the bone
  45390. */
  45391. adjustYaw: number;
  45392. /**
  45393. * Used to make an adjustment to the pitch of the bone
  45394. */
  45395. adjustPitch: number;
  45396. /**
  45397. * Used to make an adjustment to the roll of the bone
  45398. */
  45399. adjustRoll: number;
  45400. /**
  45401. * 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)
  45402. */
  45403. slerpAmount: number;
  45404. private _minYaw;
  45405. private _maxYaw;
  45406. private _minPitch;
  45407. private _maxPitch;
  45408. private _minYawSin;
  45409. private _minYawCos;
  45410. private _maxYawSin;
  45411. private _maxYawCos;
  45412. private _midYawConstraint;
  45413. private _minPitchTan;
  45414. private _maxPitchTan;
  45415. private _boneQuat;
  45416. private _slerping;
  45417. private _transformYawPitch;
  45418. private _transformYawPitchInv;
  45419. private _firstFrameSkipped;
  45420. private _yawRange;
  45421. private _fowardAxis;
  45422. /**
  45423. * Gets or sets the minimum yaw angle that the bone can look to
  45424. */
  45425. get minYaw(): number;
  45426. set minYaw(value: number);
  45427. /**
  45428. * Gets or sets the maximum yaw angle that the bone can look to
  45429. */
  45430. get maxYaw(): number;
  45431. set maxYaw(value: number);
  45432. /**
  45433. * Gets or sets the minimum pitch angle that the bone can look to
  45434. */
  45435. get minPitch(): number;
  45436. set minPitch(value: number);
  45437. /**
  45438. * Gets or sets the maximum pitch angle that the bone can look to
  45439. */
  45440. get maxPitch(): number;
  45441. set maxPitch(value: number);
  45442. /**
  45443. * Create a BoneLookController
  45444. * @param mesh the mesh that the bone belongs to
  45445. * @param bone the bone that will be looking to the target
  45446. * @param target the target Vector3 to look at
  45447. * @param options optional settings:
  45448. * * maxYaw: the maximum angle the bone will yaw to
  45449. * * minYaw: the minimum angle the bone will yaw to
  45450. * * maxPitch: the maximum angle the bone will pitch to
  45451. * * minPitch: the minimum angle the bone will yaw to
  45452. * * slerpAmount: set the between 0 and 1 to make the bone slerp to the target.
  45453. * * upAxis: the up axis of the coordinate system
  45454. * * upAxisSpace: the space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD.
  45455. * * yawAxis: set yawAxis if the bone does not yaw on the y axis
  45456. * * pitchAxis: set pitchAxis if the bone does not pitch on the x axis
  45457. * * adjustYaw: used to make an adjustment to the yaw of the bone
  45458. * * adjustPitch: used to make an adjustment to the pitch of the bone
  45459. * * adjustRoll: used to make an adjustment to the roll of the bone
  45460. **/
  45461. constructor(mesh: AbstractMesh, bone: Bone, target: Vector3, options?: {
  45462. maxYaw?: number;
  45463. minYaw?: number;
  45464. maxPitch?: number;
  45465. minPitch?: number;
  45466. slerpAmount?: number;
  45467. upAxis?: Vector3;
  45468. upAxisSpace?: Space;
  45469. yawAxis?: Vector3;
  45470. pitchAxis?: Vector3;
  45471. adjustYaw?: number;
  45472. adjustPitch?: number;
  45473. adjustRoll?: number;
  45474. });
  45475. /**
  45476. * Update the bone to look at the target. This should be called before the scene is rendered (use scene.registerBeforeRender())
  45477. */
  45478. update(): void;
  45479. private _getAngleDiff;
  45480. private _getAngleBetween;
  45481. private _isAngleBetween;
  45482. }
  45483. }
  45484. declare module "babylonjs/Bones/index" {
  45485. export * from "babylonjs/Bones/bone";
  45486. export * from "babylonjs/Bones/boneIKController";
  45487. export * from "babylonjs/Bones/boneLookController";
  45488. export * from "babylonjs/Bones/skeleton";
  45489. }
  45490. declare module "babylonjs/Cameras/Inputs/arcRotateCameraGamepadInput" {
  45491. import { Nullable } from "babylonjs/types";
  45492. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  45493. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45494. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  45495. /**
  45496. * Manage the gamepad inputs to control an arc rotate camera.
  45497. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45498. */
  45499. export class ArcRotateCameraGamepadInput implements ICameraInput<ArcRotateCamera> {
  45500. /**
  45501. * Defines the camera the input is attached to.
  45502. */
  45503. camera: ArcRotateCamera;
  45504. /**
  45505. * Defines the gamepad the input is gathering event from.
  45506. */
  45507. gamepad: Nullable<Gamepad>;
  45508. /**
  45509. * Defines the gamepad rotation sensiblity.
  45510. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  45511. */
  45512. gamepadRotationSensibility: number;
  45513. /**
  45514. * Defines the gamepad move sensiblity.
  45515. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  45516. */
  45517. gamepadMoveSensibility: number;
  45518. private _yAxisScale;
  45519. /**
  45520. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  45521. */
  45522. get invertYAxis(): boolean;
  45523. set invertYAxis(value: boolean);
  45524. private _onGamepadConnectedObserver;
  45525. private _onGamepadDisconnectedObserver;
  45526. /**
  45527. * Attach the input controls to a specific dom element to get the input from.
  45528. * @param element Defines the element the controls should be listened from
  45529. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  45530. */
  45531. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45532. /**
  45533. * Detach the current controls from the specified dom element.
  45534. * @param element Defines the element to stop listening the inputs from
  45535. */
  45536. detachControl(element: Nullable<HTMLElement>): void;
  45537. /**
  45538. * Update the current camera state depending on the inputs that have been used this frame.
  45539. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  45540. */
  45541. checkInputs(): void;
  45542. /**
  45543. * Gets the class name of the current intput.
  45544. * @returns the class name
  45545. */
  45546. getClassName(): string;
  45547. /**
  45548. * Get the friendly name associated with the input class.
  45549. * @returns the input friendly name
  45550. */
  45551. getSimpleName(): string;
  45552. }
  45553. }
  45554. declare module "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput" {
  45555. import { Nullable } from "babylonjs/types";
  45556. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  45557. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45558. module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  45559. interface ArcRotateCameraInputsManager {
  45560. /**
  45561. * Add orientation input support to the input manager.
  45562. * @returns the current input manager
  45563. */
  45564. addVRDeviceOrientation(): ArcRotateCameraInputsManager;
  45565. }
  45566. }
  45567. /**
  45568. * Manage the device orientation inputs (gyroscope) to control an arc rotate camera.
  45569. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45570. */
  45571. export class ArcRotateCameraVRDeviceOrientationInput implements ICameraInput<ArcRotateCamera> {
  45572. /**
  45573. * Defines the camera the input is attached to.
  45574. */
  45575. camera: ArcRotateCamera;
  45576. /**
  45577. * Defines a correction factor applied on the alpha value retrieved from the orientation events.
  45578. */
  45579. alphaCorrection: number;
  45580. /**
  45581. * Defines a correction factor applied on the gamma value retrieved from the orientation events.
  45582. */
  45583. gammaCorrection: number;
  45584. private _alpha;
  45585. private _gamma;
  45586. private _dirty;
  45587. private _deviceOrientationHandler;
  45588. /**
  45589. * Instantiate a new ArcRotateCameraVRDeviceOrientationInput.
  45590. */
  45591. constructor();
  45592. /**
  45593. * Attach the input controls to a specific dom element to get the input from.
  45594. * @param element Defines the element the controls should be listened from
  45595. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  45596. */
  45597. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45598. /** @hidden */
  45599. _onOrientationEvent(evt: DeviceOrientationEvent): void;
  45600. /**
  45601. * Update the current camera state depending on the inputs that have been used this frame.
  45602. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  45603. */
  45604. checkInputs(): void;
  45605. /**
  45606. * Detach the current controls from the specified dom element.
  45607. * @param element Defines the element to stop listening the inputs from
  45608. */
  45609. detachControl(element: Nullable<HTMLElement>): void;
  45610. /**
  45611. * Gets the class name of the current intput.
  45612. * @returns the class name
  45613. */
  45614. getClassName(): string;
  45615. /**
  45616. * Get the friendly name associated with the input class.
  45617. * @returns the input friendly name
  45618. */
  45619. getSimpleName(): string;
  45620. }
  45621. }
  45622. declare module "babylonjs/Cameras/Inputs/flyCameraMouseInput" {
  45623. import { Nullable } from "babylonjs/types";
  45624. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45625. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  45626. /**
  45627. * Listen to mouse events to control the camera.
  45628. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45629. */
  45630. export class FlyCameraMouseInput implements ICameraInput<FlyCamera> {
  45631. /**
  45632. * Defines the camera the input is attached to.
  45633. */
  45634. camera: FlyCamera;
  45635. /**
  45636. * Defines if touch is enabled. (Default is true.)
  45637. */
  45638. touchEnabled: boolean;
  45639. /**
  45640. * Defines the buttons associated with the input to handle camera rotation.
  45641. */
  45642. buttons: number[];
  45643. /**
  45644. * Assign buttons for Yaw control.
  45645. */
  45646. buttonsYaw: number[];
  45647. /**
  45648. * Assign buttons for Pitch control.
  45649. */
  45650. buttonsPitch: number[];
  45651. /**
  45652. * Assign buttons for Roll control.
  45653. */
  45654. buttonsRoll: number[];
  45655. /**
  45656. * Detect if any button is being pressed while mouse is moved.
  45657. * -1 = Mouse locked.
  45658. * 0 = Left button.
  45659. * 1 = Middle Button.
  45660. * 2 = Right Button.
  45661. */
  45662. activeButton: number;
  45663. /**
  45664. * Defines the pointer's angular sensibility, to control the camera rotation speed.
  45665. * Higher values reduce its sensitivity.
  45666. */
  45667. angularSensibility: number;
  45668. private _mousemoveCallback;
  45669. private _observer;
  45670. private _rollObserver;
  45671. private previousPosition;
  45672. private noPreventDefault;
  45673. private element;
  45674. /**
  45675. * Listen to mouse events to control the camera.
  45676. * @param touchEnabled Define if touch is enabled. (Default is true.)
  45677. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45678. */
  45679. constructor(touchEnabled?: boolean);
  45680. /**
  45681. * Attach the mouse control to the HTML DOM element.
  45682. * @param element Defines the element that listens to the input events.
  45683. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault().
  45684. */
  45685. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45686. /**
  45687. * Detach the current controls from the specified dom element.
  45688. * @param element Defines the element to stop listening the inputs from
  45689. */
  45690. detachControl(element: Nullable<HTMLElement>): void;
  45691. /**
  45692. * Gets the class name of the current input.
  45693. * @returns the class name.
  45694. */
  45695. getClassName(): string;
  45696. /**
  45697. * Get the friendly name associated with the input class.
  45698. * @returns the input's friendly name.
  45699. */
  45700. getSimpleName(): string;
  45701. private _pointerInput;
  45702. private _onMouseMove;
  45703. /**
  45704. * Rotate camera by mouse offset.
  45705. */
  45706. private rotateCamera;
  45707. }
  45708. }
  45709. declare module "babylonjs/Cameras/flyCameraInputsManager" {
  45710. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  45711. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  45712. /**
  45713. * Default Inputs manager for the FlyCamera.
  45714. * It groups all the default supported inputs for ease of use.
  45715. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45716. */
  45717. export class FlyCameraInputsManager extends CameraInputsManager<FlyCamera> {
  45718. /**
  45719. * Instantiates a new FlyCameraInputsManager.
  45720. * @param camera Defines the camera the inputs belong to.
  45721. */
  45722. constructor(camera: FlyCamera);
  45723. /**
  45724. * Add keyboard input support to the input manager.
  45725. * @returns the new FlyCameraKeyboardMoveInput().
  45726. */
  45727. addKeyboard(): FlyCameraInputsManager;
  45728. /**
  45729. * Add mouse input support to the input manager.
  45730. * @param touchEnabled Enable touch screen support.
  45731. * @returns the new FlyCameraMouseInput().
  45732. */
  45733. addMouse(touchEnabled?: boolean): FlyCameraInputsManager;
  45734. }
  45735. }
  45736. declare module "babylonjs/Cameras/flyCamera" {
  45737. import { Scene } from "babylonjs/scene";
  45738. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  45739. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45740. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  45741. import { FlyCameraInputsManager } from "babylonjs/Cameras/flyCameraInputsManager";
  45742. /**
  45743. * This is a flying camera, designed for 3D movement and rotation in all directions,
  45744. * such as in a 3D Space Shooter or a Flight Simulator.
  45745. */
  45746. export class FlyCamera extends TargetCamera {
  45747. /**
  45748. * Define the collision ellipsoid of the camera.
  45749. * This is helpful for simulating a camera body, like a player's body.
  45750. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  45751. */
  45752. ellipsoid: Vector3;
  45753. /**
  45754. * Define an offset for the position of the ellipsoid around the camera.
  45755. * This can be helpful if the camera is attached away from the player's body center,
  45756. * such as at its head.
  45757. */
  45758. ellipsoidOffset: Vector3;
  45759. /**
  45760. * Enable or disable collisions of the camera with the rest of the scene objects.
  45761. */
  45762. checkCollisions: boolean;
  45763. /**
  45764. * Enable or disable gravity on the camera.
  45765. */
  45766. applyGravity: boolean;
  45767. /**
  45768. * Define the current direction the camera is moving to.
  45769. */
  45770. cameraDirection: Vector3;
  45771. /**
  45772. * Define the current local rotation of the camera as a quaternion to prevent Gimbal lock.
  45773. * This overrides and empties cameraRotation.
  45774. */
  45775. rotationQuaternion: Quaternion;
  45776. /**
  45777. * Track Roll to maintain the wanted Rolling when looking around.
  45778. */
  45779. _trackRoll: number;
  45780. /**
  45781. * Slowly correct the Roll to its original value after a Pitch+Yaw rotation.
  45782. */
  45783. rollCorrect: number;
  45784. /**
  45785. * Mimic a banked turn, Rolling the camera when Yawing.
  45786. * It's recommended to use rollCorrect = 10 for faster banking correction.
  45787. */
  45788. bankedTurn: boolean;
  45789. /**
  45790. * Limit in radians for how much Roll banking will add. (Default: 90°)
  45791. */
  45792. bankedTurnLimit: number;
  45793. /**
  45794. * Value of 0 disables the banked Roll.
  45795. * Value of 1 is equal to the Yaw angle in radians.
  45796. */
  45797. bankedTurnMultiplier: number;
  45798. /**
  45799. * The inputs manager loads all the input sources, such as keyboard and mouse.
  45800. */
  45801. inputs: FlyCameraInputsManager;
  45802. /**
  45803. * Gets the input sensibility for mouse input.
  45804. * Higher values reduce sensitivity.
  45805. */
  45806. get angularSensibility(): number;
  45807. /**
  45808. * Sets the input sensibility for a mouse input.
  45809. * Higher values reduce sensitivity.
  45810. */
  45811. set angularSensibility(value: number);
  45812. /**
  45813. * Get the keys for camera movement forward.
  45814. */
  45815. get keysForward(): number[];
  45816. /**
  45817. * Set the keys for camera movement forward.
  45818. */
  45819. set keysForward(value: number[]);
  45820. /**
  45821. * Get the keys for camera movement backward.
  45822. */
  45823. get keysBackward(): number[];
  45824. set keysBackward(value: number[]);
  45825. /**
  45826. * Get the keys for camera movement up.
  45827. */
  45828. get keysUp(): number[];
  45829. /**
  45830. * Set the keys for camera movement up.
  45831. */
  45832. set keysUp(value: number[]);
  45833. /**
  45834. * Get the keys for camera movement down.
  45835. */
  45836. get keysDown(): number[];
  45837. /**
  45838. * Set the keys for camera movement down.
  45839. */
  45840. set keysDown(value: number[]);
  45841. /**
  45842. * Get the keys for camera movement left.
  45843. */
  45844. get keysLeft(): number[];
  45845. /**
  45846. * Set the keys for camera movement left.
  45847. */
  45848. set keysLeft(value: number[]);
  45849. /**
  45850. * Set the keys for camera movement right.
  45851. */
  45852. get keysRight(): number[];
  45853. /**
  45854. * Set the keys for camera movement right.
  45855. */
  45856. set keysRight(value: number[]);
  45857. /**
  45858. * Event raised when the camera collides with a mesh in the scene.
  45859. */
  45860. onCollide: (collidedMesh: AbstractMesh) => void;
  45861. private _collider;
  45862. private _needMoveForGravity;
  45863. private _oldPosition;
  45864. private _diffPosition;
  45865. private _newPosition;
  45866. /** @hidden */
  45867. _localDirection: Vector3;
  45868. /** @hidden */
  45869. _transformedDirection: Vector3;
  45870. /**
  45871. * Instantiates a FlyCamera.
  45872. * This is a flying camera, designed for 3D movement and rotation in all directions,
  45873. * such as in a 3D Space Shooter or a Flight Simulator.
  45874. * @param name Define the name of the camera in the scene.
  45875. * @param position Define the starting position of the camera in the scene.
  45876. * @param scene Define the scene the camera belongs to.
  45877. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active, if no other camera has been defined as active.
  45878. */
  45879. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  45880. /**
  45881. * Attach a control to the HTML DOM element.
  45882. * @param element Defines the element that listens to the input events.
  45883. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault(). https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault
  45884. */
  45885. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45886. /**
  45887. * Detach a control from the HTML DOM element.
  45888. * The camera will stop reacting to that input.
  45889. * @param element Defines the element that listens to the input events.
  45890. */
  45891. detachControl(element: HTMLElement): void;
  45892. private _collisionMask;
  45893. /**
  45894. * Get the mask that the camera ignores in collision events.
  45895. */
  45896. get collisionMask(): number;
  45897. /**
  45898. * Set the mask that the camera ignores in collision events.
  45899. */
  45900. set collisionMask(mask: number);
  45901. /** @hidden */
  45902. _collideWithWorld(displacement: Vector3): void;
  45903. /** @hidden */
  45904. private _onCollisionPositionChange;
  45905. /** @hidden */
  45906. _checkInputs(): void;
  45907. /** @hidden */
  45908. _decideIfNeedsToMove(): boolean;
  45909. /** @hidden */
  45910. _updatePosition(): void;
  45911. /**
  45912. * Restore the Roll to its target value at the rate specified.
  45913. * @param rate - Higher means slower restoring.
  45914. * @hidden
  45915. */
  45916. restoreRoll(rate: number): void;
  45917. /**
  45918. * Destroy the camera and release the current resources held by it.
  45919. */
  45920. dispose(): void;
  45921. /**
  45922. * Get the current object class name.
  45923. * @returns the class name.
  45924. */
  45925. getClassName(): string;
  45926. }
  45927. }
  45928. declare module "babylonjs/Cameras/Inputs/flyCameraKeyboardInput" {
  45929. import { Nullable } from "babylonjs/types";
  45930. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45931. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  45932. /**
  45933. * Listen to keyboard events to control the camera.
  45934. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45935. */
  45936. export class FlyCameraKeyboardInput implements ICameraInput<FlyCamera> {
  45937. /**
  45938. * Defines the camera the input is attached to.
  45939. */
  45940. camera: FlyCamera;
  45941. /**
  45942. * The list of keyboard keys used to control the forward move of the camera.
  45943. */
  45944. keysForward: number[];
  45945. /**
  45946. * The list of keyboard keys used to control the backward move of the camera.
  45947. */
  45948. keysBackward: number[];
  45949. /**
  45950. * The list of keyboard keys used to control the forward move of the camera.
  45951. */
  45952. keysUp: number[];
  45953. /**
  45954. * The list of keyboard keys used to control the backward move of the camera.
  45955. */
  45956. keysDown: number[];
  45957. /**
  45958. * The list of keyboard keys used to control the right strafe move of the camera.
  45959. */
  45960. keysRight: number[];
  45961. /**
  45962. * The list of keyboard keys used to control the left strafe move of the camera.
  45963. */
  45964. keysLeft: number[];
  45965. private _keys;
  45966. private _onCanvasBlurObserver;
  45967. private _onKeyboardObserver;
  45968. private _engine;
  45969. private _scene;
  45970. /**
  45971. * Attach the input controls to a specific dom element to get the input from.
  45972. * @param element Defines the element the controls should be listened from
  45973. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  45974. */
  45975. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45976. /**
  45977. * Detach the current controls from the specified dom element.
  45978. * @param element Defines the element to stop listening the inputs from
  45979. */
  45980. detachControl(element: Nullable<HTMLElement>): void;
  45981. /**
  45982. * Gets the class name of the current intput.
  45983. * @returns the class name
  45984. */
  45985. getClassName(): string;
  45986. /** @hidden */
  45987. _onLostFocus(e: FocusEvent): void;
  45988. /**
  45989. * Get the friendly name associated with the input class.
  45990. * @returns the input friendly name
  45991. */
  45992. getSimpleName(): string;
  45993. /**
  45994. * Update the current camera state depending on the inputs that have been used this frame.
  45995. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  45996. */
  45997. checkInputs(): void;
  45998. }
  45999. }
  46000. declare module "babylonjs/Cameras/Inputs/followCameraMouseWheelInput" {
  46001. import { Nullable } from "babylonjs/types";
  46002. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  46003. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  46004. /**
  46005. * Manage the mouse wheel inputs to control a follow camera.
  46006. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46007. */
  46008. export class FollowCameraMouseWheelInput implements ICameraInput<FollowCamera> {
  46009. /**
  46010. * Defines the camera the input is attached to.
  46011. */
  46012. camera: FollowCamera;
  46013. /**
  46014. * Moue wheel controls zoom. (Mouse wheel modifies camera.radius value.)
  46015. */
  46016. axisControlRadius: boolean;
  46017. /**
  46018. * Moue wheel controls height. (Mouse wheel modifies camera.heightOffset value.)
  46019. */
  46020. axisControlHeight: boolean;
  46021. /**
  46022. * Moue wheel controls angle. (Mouse wheel modifies camera.rotationOffset value.)
  46023. */
  46024. axisControlRotation: boolean;
  46025. /**
  46026. * Gets or Set the mouse wheel precision or how fast is the camera moves in
  46027. * relation to mouseWheel events.
  46028. */
  46029. wheelPrecision: number;
  46030. /**
  46031. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  46032. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  46033. */
  46034. wheelDeltaPercentage: number;
  46035. private _wheel;
  46036. private _observer;
  46037. /**
  46038. * Attach the input controls to a specific dom element to get the input from.
  46039. * @param element Defines the element the controls should be listened from
  46040. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46041. */
  46042. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46043. /**
  46044. * Detach the current controls from the specified dom element.
  46045. * @param element Defines the element to stop listening the inputs from
  46046. */
  46047. detachControl(element: Nullable<HTMLElement>): void;
  46048. /**
  46049. * Gets the class name of the current intput.
  46050. * @returns the class name
  46051. */
  46052. getClassName(): string;
  46053. /**
  46054. * Get the friendly name associated with the input class.
  46055. * @returns the input friendly name
  46056. */
  46057. getSimpleName(): string;
  46058. }
  46059. }
  46060. declare module "babylonjs/Cameras/Inputs/followCameraPointersInput" {
  46061. import { Nullable } from "babylonjs/types";
  46062. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  46063. import { BaseCameraPointersInput } from "babylonjs/Cameras/Inputs/BaseCameraPointersInput";
  46064. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  46065. /**
  46066. * Manage the pointers inputs to control an follow camera.
  46067. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46068. */
  46069. export class FollowCameraPointersInput extends BaseCameraPointersInput {
  46070. /**
  46071. * Defines the camera the input is attached to.
  46072. */
  46073. camera: FollowCamera;
  46074. /**
  46075. * Gets the class name of the current input.
  46076. * @returns the class name
  46077. */
  46078. getClassName(): string;
  46079. /**
  46080. * Defines the pointer angular sensibility along the X axis or how fast is
  46081. * the camera rotating.
  46082. * A negative number will reverse the axis direction.
  46083. */
  46084. angularSensibilityX: number;
  46085. /**
  46086. * Defines the pointer angular sensibility along the Y axis or how fast is
  46087. * the camera rotating.
  46088. * A negative number will reverse the axis direction.
  46089. */
  46090. angularSensibilityY: number;
  46091. /**
  46092. * Defines the pointer pinch precision or how fast is the camera zooming.
  46093. * A negative number will reverse the axis direction.
  46094. */
  46095. pinchPrecision: number;
  46096. /**
  46097. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  46098. * from 0.
  46099. * It defines the percentage of current camera.radius to use as delta when
  46100. * pinch zoom is used.
  46101. */
  46102. pinchDeltaPercentage: number;
  46103. /**
  46104. * Pointer X axis controls zoom. (X axis modifies camera.radius value.)
  46105. */
  46106. axisXControlRadius: boolean;
  46107. /**
  46108. * Pointer X axis controls height. (X axis modifies camera.heightOffset value.)
  46109. */
  46110. axisXControlHeight: boolean;
  46111. /**
  46112. * Pointer X axis controls angle. (X axis modifies camera.rotationOffset value.)
  46113. */
  46114. axisXControlRotation: boolean;
  46115. /**
  46116. * Pointer Y axis controls zoom. (Y axis modifies camera.radius value.)
  46117. */
  46118. axisYControlRadius: boolean;
  46119. /**
  46120. * Pointer Y axis controls height. (Y axis modifies camera.heightOffset value.)
  46121. */
  46122. axisYControlHeight: boolean;
  46123. /**
  46124. * Pointer Y axis controls angle. (Y axis modifies camera.rotationOffset value.)
  46125. */
  46126. axisYControlRotation: boolean;
  46127. /**
  46128. * Pinch controls zoom. (Pinch modifies camera.radius value.)
  46129. */
  46130. axisPinchControlRadius: boolean;
  46131. /**
  46132. * Pinch controls height. (Pinch modifies camera.heightOffset value.)
  46133. */
  46134. axisPinchControlHeight: boolean;
  46135. /**
  46136. * Pinch controls angle. (Pinch modifies camera.rotationOffset value.)
  46137. */
  46138. axisPinchControlRotation: boolean;
  46139. /**
  46140. * Log error messages if basic misconfiguration has occurred.
  46141. */
  46142. warningEnable: boolean;
  46143. protected onTouch(pointA: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  46144. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  46145. private _warningCounter;
  46146. private _warning;
  46147. }
  46148. }
  46149. declare module "babylonjs/Cameras/followCameraInputsManager" {
  46150. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  46151. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  46152. /**
  46153. * Default Inputs manager for the FollowCamera.
  46154. * It groups all the default supported inputs for ease of use.
  46155. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46156. */
  46157. export class FollowCameraInputsManager extends CameraInputsManager<FollowCamera> {
  46158. /**
  46159. * Instantiates a new FollowCameraInputsManager.
  46160. * @param camera Defines the camera the inputs belong to
  46161. */
  46162. constructor(camera: FollowCamera);
  46163. /**
  46164. * Add keyboard input support to the input manager.
  46165. * @returns the current input manager
  46166. */
  46167. addKeyboard(): FollowCameraInputsManager;
  46168. /**
  46169. * Add mouse wheel input support to the input manager.
  46170. * @returns the current input manager
  46171. */
  46172. addMouseWheel(): FollowCameraInputsManager;
  46173. /**
  46174. * Add pointers input support to the input manager.
  46175. * @returns the current input manager
  46176. */
  46177. addPointers(): FollowCameraInputsManager;
  46178. /**
  46179. * Add orientation input support to the input manager.
  46180. * @returns the current input manager
  46181. */
  46182. addVRDeviceOrientation(): FollowCameraInputsManager;
  46183. }
  46184. }
  46185. declare module "babylonjs/Cameras/followCamera" {
  46186. import { Nullable } from "babylonjs/types";
  46187. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  46188. import { Scene } from "babylonjs/scene";
  46189. import { Vector3 } from "babylonjs/Maths/math.vector";
  46190. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  46191. import { FollowCameraInputsManager } from "babylonjs/Cameras/followCameraInputsManager";
  46192. /**
  46193. * A follow camera takes a mesh as a target and follows it as it moves. Both a free camera version followCamera and
  46194. * an arc rotate version arcFollowCamera are available.
  46195. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  46196. */
  46197. export class FollowCamera extends TargetCamera {
  46198. /**
  46199. * Distance the follow camera should follow an object at
  46200. */
  46201. radius: number;
  46202. /**
  46203. * Minimum allowed distance of the camera to the axis of rotation
  46204. * (The camera can not get closer).
  46205. * This can help limiting how the Camera is able to move in the scene.
  46206. */
  46207. lowerRadiusLimit: Nullable<number>;
  46208. /**
  46209. * Maximum allowed distance of the camera to the axis of rotation
  46210. * (The camera can not get further).
  46211. * This can help limiting how the Camera is able to move in the scene.
  46212. */
  46213. upperRadiusLimit: Nullable<number>;
  46214. /**
  46215. * Define a rotation offset between the camera and the object it follows
  46216. */
  46217. rotationOffset: number;
  46218. /**
  46219. * Minimum allowed angle to camera position relative to target object.
  46220. * This can help limiting how the Camera is able to move in the scene.
  46221. */
  46222. lowerRotationOffsetLimit: Nullable<number>;
  46223. /**
  46224. * Maximum allowed angle to camera position relative to target object.
  46225. * This can help limiting how the Camera is able to move in the scene.
  46226. */
  46227. upperRotationOffsetLimit: Nullable<number>;
  46228. /**
  46229. * Define a height offset between the camera and the object it follows.
  46230. * It can help following an object from the top (like a car chaing a plane)
  46231. */
  46232. heightOffset: number;
  46233. /**
  46234. * Minimum allowed height of camera position relative to target object.
  46235. * This can help limiting how the Camera is able to move in the scene.
  46236. */
  46237. lowerHeightOffsetLimit: Nullable<number>;
  46238. /**
  46239. * Maximum allowed height of camera position relative to target object.
  46240. * This can help limiting how the Camera is able to move in the scene.
  46241. */
  46242. upperHeightOffsetLimit: Nullable<number>;
  46243. /**
  46244. * Define how fast the camera can accelerate to follow it s target.
  46245. */
  46246. cameraAcceleration: number;
  46247. /**
  46248. * Define the speed limit of the camera following an object.
  46249. */
  46250. maxCameraSpeed: number;
  46251. /**
  46252. * Define the target of the camera.
  46253. */
  46254. lockedTarget: Nullable<AbstractMesh>;
  46255. /**
  46256. * Defines the input associated with the camera.
  46257. */
  46258. inputs: FollowCameraInputsManager;
  46259. /**
  46260. * Instantiates the follow camera.
  46261. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  46262. * @param name Define the name of the camera in the scene
  46263. * @param position Define the position of the camera
  46264. * @param scene Define the scene the camera belong to
  46265. * @param lockedTarget Define the target of the camera
  46266. */
  46267. constructor(name: string, position: Vector3, scene: Scene, lockedTarget?: Nullable<AbstractMesh>);
  46268. private _follow;
  46269. /**
  46270. * Attached controls to the current camera.
  46271. * @param element Defines the element the controls should be listened from
  46272. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46273. */
  46274. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46275. /**
  46276. * Detach the current controls from the camera.
  46277. * The camera will stop reacting to inputs.
  46278. * @param element Defines the element to stop listening the inputs from
  46279. */
  46280. detachControl(element: HTMLElement): void;
  46281. /** @hidden */
  46282. _checkInputs(): void;
  46283. private _checkLimits;
  46284. /**
  46285. * Gets the camera class name.
  46286. * @returns the class name
  46287. */
  46288. getClassName(): string;
  46289. }
  46290. /**
  46291. * Arc Rotate version of the follow camera.
  46292. * It still follows a Defined mesh but in an Arc Rotate Camera fashion.
  46293. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  46294. */
  46295. export class ArcFollowCamera extends TargetCamera {
  46296. /** The longitudinal angle of the camera */
  46297. alpha: number;
  46298. /** The latitudinal angle of the camera */
  46299. beta: number;
  46300. /** The radius of the camera from its target */
  46301. radius: number;
  46302. private _cartesianCoordinates;
  46303. /** Define the camera target (the mesh it should follow) */
  46304. private _meshTarget;
  46305. /**
  46306. * Instantiates a new ArcFollowCamera
  46307. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  46308. * @param name Define the name of the camera
  46309. * @param alpha Define the rotation angle of the camera around the logitudinal axis
  46310. * @param beta Define the rotation angle of the camera around the elevation axis
  46311. * @param radius Define the radius of the camera from its target point
  46312. * @param target Define the target of the camera
  46313. * @param scene Define the scene the camera belongs to
  46314. */
  46315. constructor(name: string,
  46316. /** The longitudinal angle of the camera */
  46317. alpha: number,
  46318. /** The latitudinal angle of the camera */
  46319. beta: number,
  46320. /** The radius of the camera from its target */
  46321. radius: number,
  46322. /** Define the camera target (the mesh it should follow) */
  46323. target: Nullable<AbstractMesh>, scene: Scene);
  46324. private _follow;
  46325. /** @hidden */
  46326. _checkInputs(): void;
  46327. /**
  46328. * Returns the class name of the object.
  46329. * It is mostly used internally for serialization purposes.
  46330. */
  46331. getClassName(): string;
  46332. }
  46333. }
  46334. declare module "babylonjs/Cameras/Inputs/followCameraKeyboardMoveInput" {
  46335. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  46336. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  46337. import { Nullable } from "babylonjs/types";
  46338. /**
  46339. * Manage the keyboard inputs to control the movement of a follow camera.
  46340. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46341. */
  46342. export class FollowCameraKeyboardMoveInput implements ICameraInput<FollowCamera> {
  46343. /**
  46344. * Defines the camera the input is attached to.
  46345. */
  46346. camera: FollowCamera;
  46347. /**
  46348. * Defines the list of key codes associated with the up action (increase heightOffset)
  46349. */
  46350. keysHeightOffsetIncr: number[];
  46351. /**
  46352. * Defines the list of key codes associated with the down action (decrease heightOffset)
  46353. */
  46354. keysHeightOffsetDecr: number[];
  46355. /**
  46356. * Defines whether the Alt modifier key is required to move up/down (alter heightOffset)
  46357. */
  46358. keysHeightOffsetModifierAlt: boolean;
  46359. /**
  46360. * Defines whether the Ctrl modifier key is required to move up/down (alter heightOffset)
  46361. */
  46362. keysHeightOffsetModifierCtrl: boolean;
  46363. /**
  46364. * Defines whether the Shift modifier key is required to move up/down (alter heightOffset)
  46365. */
  46366. keysHeightOffsetModifierShift: boolean;
  46367. /**
  46368. * Defines the list of key codes associated with the left action (increase rotationOffset)
  46369. */
  46370. keysRotationOffsetIncr: number[];
  46371. /**
  46372. * Defines the list of key codes associated with the right action (decrease rotationOffset)
  46373. */
  46374. keysRotationOffsetDecr: number[];
  46375. /**
  46376. * Defines whether the Alt modifier key is required to move left/right (alter rotationOffset)
  46377. */
  46378. keysRotationOffsetModifierAlt: boolean;
  46379. /**
  46380. * Defines whether the Ctrl modifier key is required to move left/right (alter rotationOffset)
  46381. */
  46382. keysRotationOffsetModifierCtrl: boolean;
  46383. /**
  46384. * Defines whether the Shift modifier key is required to move left/right (alter rotationOffset)
  46385. */
  46386. keysRotationOffsetModifierShift: boolean;
  46387. /**
  46388. * Defines the list of key codes associated with the zoom-in action (decrease radius)
  46389. */
  46390. keysRadiusIncr: number[];
  46391. /**
  46392. * Defines the list of key codes associated with the zoom-out action (increase radius)
  46393. */
  46394. keysRadiusDecr: number[];
  46395. /**
  46396. * Defines whether the Alt modifier key is required to zoom in/out (alter radius value)
  46397. */
  46398. keysRadiusModifierAlt: boolean;
  46399. /**
  46400. * Defines whether the Ctrl modifier key is required to zoom in/out (alter radius value)
  46401. */
  46402. keysRadiusModifierCtrl: boolean;
  46403. /**
  46404. * Defines whether the Shift modifier key is required to zoom in/out (alter radius value)
  46405. */
  46406. keysRadiusModifierShift: boolean;
  46407. /**
  46408. * Defines the rate of change of heightOffset.
  46409. */
  46410. heightSensibility: number;
  46411. /**
  46412. * Defines the rate of change of rotationOffset.
  46413. */
  46414. rotationSensibility: number;
  46415. /**
  46416. * Defines the rate of change of radius.
  46417. */
  46418. radiusSensibility: number;
  46419. private _keys;
  46420. private _ctrlPressed;
  46421. private _altPressed;
  46422. private _shiftPressed;
  46423. private _onCanvasBlurObserver;
  46424. private _onKeyboardObserver;
  46425. private _engine;
  46426. private _scene;
  46427. /**
  46428. * Attach the input controls to a specific dom element to get the input from.
  46429. * @param element Defines the element the controls should be listened from
  46430. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46431. */
  46432. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46433. /**
  46434. * Detach the current controls from the specified dom element.
  46435. * @param element Defines the element to stop listening the inputs from
  46436. */
  46437. detachControl(element: Nullable<HTMLElement>): void;
  46438. /**
  46439. * Update the current camera state depending on the inputs that have been used this frame.
  46440. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  46441. */
  46442. checkInputs(): void;
  46443. /**
  46444. * Gets the class name of the current input.
  46445. * @returns the class name
  46446. */
  46447. getClassName(): string;
  46448. /**
  46449. * Get the friendly name associated with the input class.
  46450. * @returns the input friendly name
  46451. */
  46452. getSimpleName(): string;
  46453. /**
  46454. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  46455. * allow modification of the heightOffset value.
  46456. */
  46457. private _modifierHeightOffset;
  46458. /**
  46459. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  46460. * allow modification of the rotationOffset value.
  46461. */
  46462. private _modifierRotationOffset;
  46463. /**
  46464. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  46465. * allow modification of the radius value.
  46466. */
  46467. private _modifierRadius;
  46468. }
  46469. }
  46470. declare module "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput" {
  46471. import { Nullable } from "babylonjs/types";
  46472. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  46473. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46474. import { Observable } from "babylonjs/Misc/observable";
  46475. module "babylonjs/Cameras/freeCameraInputsManager" {
  46476. interface FreeCameraInputsManager {
  46477. /**
  46478. * @hidden
  46479. */
  46480. _deviceOrientationInput: Nullable<FreeCameraDeviceOrientationInput>;
  46481. /**
  46482. * Add orientation input support to the input manager.
  46483. * @returns the current input manager
  46484. */
  46485. addDeviceOrientation(): FreeCameraInputsManager;
  46486. }
  46487. }
  46488. /**
  46489. * Takes information about the orientation of the device as reported by the deviceorientation event to orient the camera.
  46490. * Screen rotation is taken into account.
  46491. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46492. */
  46493. export class FreeCameraDeviceOrientationInput implements ICameraInput<FreeCamera> {
  46494. private _camera;
  46495. private _screenOrientationAngle;
  46496. private _constantTranform;
  46497. private _screenQuaternion;
  46498. private _alpha;
  46499. private _beta;
  46500. private _gamma;
  46501. /**
  46502. * Can be used to detect if a device orientation sensor is available on a device
  46503. * @param timeout amount of time in milliseconds to wait for a response from the sensor (default: infinite)
  46504. * @returns a promise that will resolve on orientation change
  46505. */
  46506. static WaitForOrientationChangeAsync(timeout?: number): Promise<unknown>;
  46507. /**
  46508. * @hidden
  46509. */
  46510. _onDeviceOrientationChangedObservable: Observable<void>;
  46511. /**
  46512. * Instantiates a new input
  46513. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46514. */
  46515. constructor();
  46516. /**
  46517. * Define the camera controlled by the input.
  46518. */
  46519. get camera(): FreeCamera;
  46520. set camera(camera: FreeCamera);
  46521. /**
  46522. * Attach the input controls to a specific dom element to get the input from.
  46523. * @param element Defines the element the controls should be listened from
  46524. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46525. */
  46526. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46527. private _orientationChanged;
  46528. private _deviceOrientation;
  46529. /**
  46530. * Detach the current controls from the specified dom element.
  46531. * @param element Defines the element to stop listening the inputs from
  46532. */
  46533. detachControl(element: Nullable<HTMLElement>): void;
  46534. /**
  46535. * Update the current camera state depending on the inputs that have been used this frame.
  46536. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  46537. */
  46538. checkInputs(): void;
  46539. /**
  46540. * Gets the class name of the current intput.
  46541. * @returns the class name
  46542. */
  46543. getClassName(): string;
  46544. /**
  46545. * Get the friendly name associated with the input class.
  46546. * @returns the input friendly name
  46547. */
  46548. getSimpleName(): string;
  46549. }
  46550. }
  46551. declare module "babylonjs/Cameras/Inputs/freeCameraGamepadInput" {
  46552. import { Nullable } from "babylonjs/types";
  46553. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  46554. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46555. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  46556. /**
  46557. * Manage the gamepad inputs to control a free camera.
  46558. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46559. */
  46560. export class FreeCameraGamepadInput implements ICameraInput<FreeCamera> {
  46561. /**
  46562. * Define the camera the input is attached to.
  46563. */
  46564. camera: FreeCamera;
  46565. /**
  46566. * Define the Gamepad controlling the input
  46567. */
  46568. gamepad: Nullable<Gamepad>;
  46569. /**
  46570. * Defines the gamepad rotation sensiblity.
  46571. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  46572. */
  46573. gamepadAngularSensibility: number;
  46574. /**
  46575. * Defines the gamepad move sensiblity.
  46576. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  46577. */
  46578. gamepadMoveSensibility: number;
  46579. private _yAxisScale;
  46580. /**
  46581. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  46582. */
  46583. get invertYAxis(): boolean;
  46584. set invertYAxis(value: boolean);
  46585. private _onGamepadConnectedObserver;
  46586. private _onGamepadDisconnectedObserver;
  46587. private _cameraTransform;
  46588. private _deltaTransform;
  46589. private _vector3;
  46590. private _vector2;
  46591. /**
  46592. * Attach the input controls to a specific dom element to get the input from.
  46593. * @param element Defines the element the controls should be listened from
  46594. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46595. */
  46596. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46597. /**
  46598. * Detach the current controls from the specified dom element.
  46599. * @param element Defines the element to stop listening the inputs from
  46600. */
  46601. detachControl(element: Nullable<HTMLElement>): void;
  46602. /**
  46603. * Update the current camera state depending on the inputs that have been used this frame.
  46604. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  46605. */
  46606. checkInputs(): void;
  46607. /**
  46608. * Gets the class name of the current intput.
  46609. * @returns the class name
  46610. */
  46611. getClassName(): string;
  46612. /**
  46613. * Get the friendly name associated with the input class.
  46614. * @returns the input friendly name
  46615. */
  46616. getSimpleName(): string;
  46617. }
  46618. }
  46619. declare module "babylonjs/Misc/virtualJoystick" {
  46620. import { Nullable } from "babylonjs/types";
  46621. import { Vector3 } from "babylonjs/Maths/math.vector";
  46622. /**
  46623. * Defines the potential axis of a Joystick
  46624. */
  46625. export enum JoystickAxis {
  46626. /** X axis */
  46627. X = 0,
  46628. /** Y axis */
  46629. Y = 1,
  46630. /** Z axis */
  46631. Z = 2
  46632. }
  46633. /**
  46634. * Represents the different customization options available
  46635. * for VirtualJoystick
  46636. */
  46637. interface VirtualJoystickCustomizations {
  46638. /**
  46639. * Size of the joystick's puck
  46640. */
  46641. puckSize: number;
  46642. /**
  46643. * Size of the joystick's container
  46644. */
  46645. containerSize: number;
  46646. /**
  46647. * Color of the joystick && puck
  46648. */
  46649. color: string;
  46650. /**
  46651. * Image URL for the joystick's puck
  46652. */
  46653. puckImage?: string;
  46654. /**
  46655. * Image URL for the joystick's container
  46656. */
  46657. containerImage?: string;
  46658. /**
  46659. * Defines the unmoving position of the joystick container
  46660. */
  46661. position?: {
  46662. x: number;
  46663. y: number;
  46664. };
  46665. /**
  46666. * Defines whether or not the joystick container is always visible
  46667. */
  46668. alwaysVisible: boolean;
  46669. /**
  46670. * Defines whether or not to limit the movement of the puck to the joystick's container
  46671. */
  46672. limitToContainer: boolean;
  46673. }
  46674. /**
  46675. * Class used to define virtual joystick (used in touch mode)
  46676. */
  46677. export class VirtualJoystick {
  46678. /**
  46679. * Gets or sets a boolean indicating that left and right values must be inverted
  46680. */
  46681. reverseLeftRight: boolean;
  46682. /**
  46683. * Gets or sets a boolean indicating that up and down values must be inverted
  46684. */
  46685. reverseUpDown: boolean;
  46686. /**
  46687. * Gets the offset value for the position (ie. the change of the position value)
  46688. */
  46689. deltaPosition: Vector3;
  46690. /**
  46691. * Gets a boolean indicating if the virtual joystick was pressed
  46692. */
  46693. pressed: boolean;
  46694. /**
  46695. * Canvas the virtual joystick will render onto, default z-index of this is 5
  46696. */
  46697. static Canvas: Nullable<HTMLCanvasElement>;
  46698. /**
  46699. * boolean indicating whether or not the joystick's puck's movement should be limited to the joystick's container area
  46700. */
  46701. limitToContainer: boolean;
  46702. private static _globalJoystickIndex;
  46703. private static _alwaysVisibleSticks;
  46704. private static vjCanvasContext;
  46705. private static vjCanvasWidth;
  46706. private static vjCanvasHeight;
  46707. private static halfWidth;
  46708. private static _GetDefaultOptions;
  46709. private _action;
  46710. private _axisTargetedByLeftAndRight;
  46711. private _axisTargetedByUpAndDown;
  46712. private _joystickSensibility;
  46713. private _inversedSensibility;
  46714. private _joystickPointerID;
  46715. private _joystickColor;
  46716. private _joystickPointerPos;
  46717. private _joystickPreviousPointerPos;
  46718. private _joystickPointerStartPos;
  46719. private _deltaJoystickVector;
  46720. private _leftJoystick;
  46721. private _touches;
  46722. private _joystickPosition;
  46723. private _alwaysVisible;
  46724. private _puckImage;
  46725. private _containerImage;
  46726. private _joystickPuckSize;
  46727. private _joystickContainerSize;
  46728. private _clearPuckSize;
  46729. private _clearContainerSize;
  46730. private _clearPuckSizeOffset;
  46731. private _clearContainerSizeOffset;
  46732. private _onPointerDownHandlerRef;
  46733. private _onPointerMoveHandlerRef;
  46734. private _onPointerUpHandlerRef;
  46735. private _onResize;
  46736. /**
  46737. * Creates a new virtual joystick
  46738. * @param leftJoystick defines that the joystick is for left hand (false by default)
  46739. * @param customizations Defines the options we want to customize the VirtualJoystick
  46740. */
  46741. constructor(leftJoystick?: boolean, customizations?: Partial<VirtualJoystickCustomizations>);
  46742. /**
  46743. * Defines joystick sensibility (ie. the ratio beteen a physical move and virtual joystick position change)
  46744. * @param newJoystickSensibility defines the new sensibility
  46745. */
  46746. setJoystickSensibility(newJoystickSensibility: number): void;
  46747. private _onPointerDown;
  46748. private _onPointerMove;
  46749. private _onPointerUp;
  46750. /**
  46751. * Change the color of the virtual joystick
  46752. * @param newColor a string that must be a CSS color value (like "red") or the hexa value (like "#FF0000")
  46753. */
  46754. setJoystickColor(newColor: string): void;
  46755. /**
  46756. * Size of the joystick's container
  46757. */
  46758. set containerSize(newSize: number);
  46759. get containerSize(): number;
  46760. /**
  46761. * Size of the joystick's puck
  46762. */
  46763. set puckSize(newSize: number);
  46764. get puckSize(): number;
  46765. /**
  46766. * Clears the set position of the joystick
  46767. */
  46768. clearPosition(): void;
  46769. /**
  46770. * Defines whether or not the joystick container is always visible
  46771. */
  46772. set alwaysVisible(value: boolean);
  46773. get alwaysVisible(): boolean;
  46774. /**
  46775. * Sets the constant position of the Joystick container
  46776. * @param x X axis coordinate
  46777. * @param y Y axis coordinate
  46778. */
  46779. setPosition(x: number, y: number): void;
  46780. /**
  46781. * Defines a callback to call when the joystick is touched
  46782. * @param action defines the callback
  46783. */
  46784. setActionOnTouch(action: () => any): void;
  46785. /**
  46786. * Defines which axis you'd like to control for left & right
  46787. * @param axis defines the axis to use
  46788. */
  46789. setAxisForLeftRight(axis: JoystickAxis): void;
  46790. /**
  46791. * Defines which axis you'd like to control for up & down
  46792. * @param axis defines the axis to use
  46793. */
  46794. setAxisForUpDown(axis: JoystickAxis): void;
  46795. /**
  46796. * Clears the canvas from the previous puck / container draw
  46797. */
  46798. private _clearPreviousDraw;
  46799. /**
  46800. * Loads `urlPath` to be used for the container's image
  46801. * @param urlPath defines the urlPath of an image to use
  46802. */
  46803. setContainerImage(urlPath: string): void;
  46804. /**
  46805. * Loads `urlPath` to be used for the puck's image
  46806. * @param urlPath defines the urlPath of an image to use
  46807. */
  46808. setPuckImage(urlPath: string): void;
  46809. /**
  46810. * Draws the Virtual Joystick's container
  46811. */
  46812. private _drawContainer;
  46813. /**
  46814. * Draws the Virtual Joystick's puck
  46815. */
  46816. private _drawPuck;
  46817. private _drawVirtualJoystick;
  46818. /**
  46819. * Release internal HTML canvas
  46820. */
  46821. releaseCanvas(): void;
  46822. }
  46823. }
  46824. declare module "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput" {
  46825. import { VirtualJoystick } from "babylonjs/Misc/virtualJoystick";
  46826. import { Nullable } from "babylonjs/types";
  46827. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  46828. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46829. module "babylonjs/Cameras/freeCameraInputsManager" {
  46830. interface FreeCameraInputsManager {
  46831. /**
  46832. * Add virtual joystick input support to the input manager.
  46833. * @returns the current input manager
  46834. */
  46835. addVirtualJoystick(): FreeCameraInputsManager;
  46836. }
  46837. }
  46838. /**
  46839. * Manage the Virtual Joystick inputs to control the movement of a free camera.
  46840. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46841. */
  46842. export class FreeCameraVirtualJoystickInput implements ICameraInput<FreeCamera> {
  46843. /**
  46844. * Defines the camera the input is attached to.
  46845. */
  46846. camera: FreeCamera;
  46847. private _leftjoystick;
  46848. private _rightjoystick;
  46849. /**
  46850. * Gets the left stick of the virtual joystick.
  46851. * @returns The virtual Joystick
  46852. */
  46853. getLeftJoystick(): VirtualJoystick;
  46854. /**
  46855. * Gets the right stick of the virtual joystick.
  46856. * @returns The virtual Joystick
  46857. */
  46858. getRightJoystick(): VirtualJoystick;
  46859. /**
  46860. * Update the current camera state depending on the inputs that have been used this frame.
  46861. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  46862. */
  46863. checkInputs(): void;
  46864. /**
  46865. * Attach the input controls to a specific dom element to get the input from.
  46866. * @param element Defines the element the controls should be listened from
  46867. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46868. */
  46869. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46870. /**
  46871. * Detach the current controls from the specified dom element.
  46872. * @param element Defines the element to stop listening the inputs from
  46873. */
  46874. detachControl(element: Nullable<HTMLElement>): void;
  46875. /**
  46876. * Gets the class name of the current intput.
  46877. * @returns the class name
  46878. */
  46879. getClassName(): string;
  46880. /**
  46881. * Get the friendly name associated with the input class.
  46882. * @returns the input friendly name
  46883. */
  46884. getSimpleName(): string;
  46885. }
  46886. }
  46887. declare module "babylonjs/Cameras/Inputs/index" {
  46888. export * from "babylonjs/Cameras/Inputs/arcRotateCameraGamepadInput";
  46889. export * from "babylonjs/Cameras/Inputs/arcRotateCameraKeyboardMoveInput";
  46890. export * from "babylonjs/Cameras/Inputs/arcRotateCameraMouseWheelInput";
  46891. export * from "babylonjs/Cameras/Inputs/arcRotateCameraPointersInput";
  46892. export * from "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput";
  46893. export * from "babylonjs/Cameras/Inputs/flyCameraKeyboardInput";
  46894. export * from "babylonjs/Cameras/Inputs/flyCameraMouseInput";
  46895. export * from "babylonjs/Cameras/Inputs/followCameraKeyboardMoveInput";
  46896. export * from "babylonjs/Cameras/Inputs/followCameraMouseWheelInput";
  46897. export * from "babylonjs/Cameras/Inputs/followCameraPointersInput";
  46898. export * from "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput";
  46899. export * from "babylonjs/Cameras/Inputs/freeCameraGamepadInput";
  46900. export * from "babylonjs/Cameras/Inputs/freeCameraKeyboardMoveInput";
  46901. export * from "babylonjs/Cameras/Inputs/freeCameraMouseInput";
  46902. export * from "babylonjs/Cameras/Inputs/freeCameraTouchInput";
  46903. export * from "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput";
  46904. }
  46905. declare module "babylonjs/Cameras/touchCamera" {
  46906. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46907. import { Scene } from "babylonjs/scene";
  46908. import { Vector3 } from "babylonjs/Maths/math.vector";
  46909. /**
  46910. * This represents a FPS type of camera controlled by touch.
  46911. * This is like a universal camera minus the Gamepad controls.
  46912. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  46913. */
  46914. export class TouchCamera extends FreeCamera {
  46915. /**
  46916. * Defines the touch sensibility for rotation.
  46917. * The higher the faster.
  46918. */
  46919. get touchAngularSensibility(): number;
  46920. set touchAngularSensibility(value: number);
  46921. /**
  46922. * Defines the touch sensibility for move.
  46923. * The higher the faster.
  46924. */
  46925. get touchMoveSensibility(): number;
  46926. set touchMoveSensibility(value: number);
  46927. /**
  46928. * Instantiates a new touch camera.
  46929. * This represents a FPS type of camera controlled by touch.
  46930. * This is like a universal camera minus the Gamepad controls.
  46931. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  46932. * @param name Define the name of the camera in the scene
  46933. * @param position Define the start position of the camera in the scene
  46934. * @param scene Define the scene the camera belongs to
  46935. */
  46936. constructor(name: string, position: Vector3, scene: Scene);
  46937. /**
  46938. * Gets the current object class name.
  46939. * @return the class name
  46940. */
  46941. getClassName(): string;
  46942. /** @hidden */
  46943. _setupInputs(): void;
  46944. }
  46945. }
  46946. declare module "babylonjs/Cameras/deviceOrientationCamera" {
  46947. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46948. import { Scene } from "babylonjs/scene";
  46949. import { Vector3 } from "babylonjs/Maths/math.vector";
  46950. import "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput";
  46951. import { Axis } from "babylonjs/Maths/math.axis";
  46952. /**
  46953. * This is a camera specifically designed to react to device orientation events such as a modern mobile device
  46954. * being tilted forward or back and left or right.
  46955. */
  46956. export class DeviceOrientationCamera extends FreeCamera {
  46957. private _initialQuaternion;
  46958. private _quaternionCache;
  46959. private _tmpDragQuaternion;
  46960. private _disablePointerInputWhenUsingDeviceOrientation;
  46961. /**
  46962. * Creates a new device orientation camera
  46963. * @param name The name of the camera
  46964. * @param position The start position camera
  46965. * @param scene The scene the camera belongs to
  46966. */
  46967. constructor(name: string, position: Vector3, scene: Scene);
  46968. /**
  46969. * Gets or sets a boolean indicating that pointer input must be disabled on first orientation sensor update (Default: true)
  46970. */
  46971. get disablePointerInputWhenUsingDeviceOrientation(): boolean;
  46972. set disablePointerInputWhenUsingDeviceOrientation(value: boolean);
  46973. private _dragFactor;
  46974. /**
  46975. * Enabled turning on the y axis when the orientation sensor is active
  46976. * @param dragFactor the factor that controls the turn speed (default: 1/300)
  46977. */
  46978. enableHorizontalDragging(dragFactor?: number): void;
  46979. /**
  46980. * Gets the current instance class name ("DeviceOrientationCamera").
  46981. * This helps avoiding instanceof at run time.
  46982. * @returns the class name
  46983. */
  46984. getClassName(): string;
  46985. /**
  46986. * @hidden
  46987. * Checks and applies the current values of the inputs to the camera. (Internal use only)
  46988. */
  46989. _checkInputs(): void;
  46990. /**
  46991. * Reset the camera to its default orientation on the specified axis only.
  46992. * @param axis The axis to reset
  46993. */
  46994. resetToCurrentRotation(axis?: Axis): void;
  46995. }
  46996. }
  46997. declare module "babylonjs/Gamepads/xboxGamepad" {
  46998. import { Observable } from "babylonjs/Misc/observable";
  46999. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  47000. /**
  47001. * Defines supported buttons for XBox360 compatible gamepads
  47002. */
  47003. export enum Xbox360Button {
  47004. /** A */
  47005. A = 0,
  47006. /** B */
  47007. B = 1,
  47008. /** X */
  47009. X = 2,
  47010. /** Y */
  47011. Y = 3,
  47012. /** Left button */
  47013. LB = 4,
  47014. /** Right button */
  47015. RB = 5,
  47016. /** Back */
  47017. Back = 8,
  47018. /** Start */
  47019. Start = 9,
  47020. /** Left stick */
  47021. LeftStick = 10,
  47022. /** Right stick */
  47023. RightStick = 11
  47024. }
  47025. /** Defines values for XBox360 DPad */
  47026. export enum Xbox360Dpad {
  47027. /** Up */
  47028. Up = 12,
  47029. /** Down */
  47030. Down = 13,
  47031. /** Left */
  47032. Left = 14,
  47033. /** Right */
  47034. Right = 15
  47035. }
  47036. /**
  47037. * Defines a XBox360 gamepad
  47038. */
  47039. export class Xbox360Pad extends Gamepad {
  47040. private _leftTrigger;
  47041. private _rightTrigger;
  47042. private _onlefttriggerchanged;
  47043. private _onrighttriggerchanged;
  47044. private _onbuttondown;
  47045. private _onbuttonup;
  47046. private _ondpaddown;
  47047. private _ondpadup;
  47048. /** Observable raised when a button is pressed */
  47049. onButtonDownObservable: Observable<Xbox360Button>;
  47050. /** Observable raised when a button is released */
  47051. onButtonUpObservable: Observable<Xbox360Button>;
  47052. /** Observable raised when a pad is pressed */
  47053. onPadDownObservable: Observable<Xbox360Dpad>;
  47054. /** Observable raised when a pad is released */
  47055. onPadUpObservable: Observable<Xbox360Dpad>;
  47056. private _buttonA;
  47057. private _buttonB;
  47058. private _buttonX;
  47059. private _buttonY;
  47060. private _buttonBack;
  47061. private _buttonStart;
  47062. private _buttonLB;
  47063. private _buttonRB;
  47064. private _buttonLeftStick;
  47065. private _buttonRightStick;
  47066. private _dPadUp;
  47067. private _dPadDown;
  47068. private _dPadLeft;
  47069. private _dPadRight;
  47070. private _isXboxOnePad;
  47071. /**
  47072. * Creates a new XBox360 gamepad object
  47073. * @param id defines the id of this gamepad
  47074. * @param index defines its index
  47075. * @param gamepad defines the internal HTML gamepad object
  47076. * @param xboxOne defines if it is a XBox One gamepad
  47077. */
  47078. constructor(id: string, index: number, gamepad: any, xboxOne?: boolean);
  47079. /**
  47080. * Defines the callback to call when left trigger is pressed
  47081. * @param callback defines the callback to use
  47082. */
  47083. onlefttriggerchanged(callback: (value: number) => void): void;
  47084. /**
  47085. * Defines the callback to call when right trigger is pressed
  47086. * @param callback defines the callback to use
  47087. */
  47088. onrighttriggerchanged(callback: (value: number) => void): void;
  47089. /**
  47090. * Gets the left trigger value
  47091. */
  47092. get leftTrigger(): number;
  47093. /**
  47094. * Sets the left trigger value
  47095. */
  47096. set leftTrigger(newValue: number);
  47097. /**
  47098. * Gets the right trigger value
  47099. */
  47100. get rightTrigger(): number;
  47101. /**
  47102. * Sets the right trigger value
  47103. */
  47104. set rightTrigger(newValue: number);
  47105. /**
  47106. * Defines the callback to call when a button is pressed
  47107. * @param callback defines the callback to use
  47108. */
  47109. onbuttondown(callback: (buttonPressed: Xbox360Button) => void): void;
  47110. /**
  47111. * Defines the callback to call when a button is released
  47112. * @param callback defines the callback to use
  47113. */
  47114. onbuttonup(callback: (buttonReleased: Xbox360Button) => void): void;
  47115. /**
  47116. * Defines the callback to call when a pad is pressed
  47117. * @param callback defines the callback to use
  47118. */
  47119. ondpaddown(callback: (dPadPressed: Xbox360Dpad) => void): void;
  47120. /**
  47121. * Defines the callback to call when a pad is released
  47122. * @param callback defines the callback to use
  47123. */
  47124. ondpadup(callback: (dPadReleased: Xbox360Dpad) => void): void;
  47125. private _setButtonValue;
  47126. private _setDPadValue;
  47127. /**
  47128. * Gets the value of the `A` button
  47129. */
  47130. get buttonA(): number;
  47131. /**
  47132. * Sets the value of the `A` button
  47133. */
  47134. set buttonA(value: number);
  47135. /**
  47136. * Gets the value of the `B` button
  47137. */
  47138. get buttonB(): number;
  47139. /**
  47140. * Sets the value of the `B` button
  47141. */
  47142. set buttonB(value: number);
  47143. /**
  47144. * Gets the value of the `X` button
  47145. */
  47146. get buttonX(): number;
  47147. /**
  47148. * Sets the value of the `X` button
  47149. */
  47150. set buttonX(value: number);
  47151. /**
  47152. * Gets the value of the `Y` button
  47153. */
  47154. get buttonY(): number;
  47155. /**
  47156. * Sets the value of the `Y` button
  47157. */
  47158. set buttonY(value: number);
  47159. /**
  47160. * Gets the value of the `Start` button
  47161. */
  47162. get buttonStart(): number;
  47163. /**
  47164. * Sets the value of the `Start` button
  47165. */
  47166. set buttonStart(value: number);
  47167. /**
  47168. * Gets the value of the `Back` button
  47169. */
  47170. get buttonBack(): number;
  47171. /**
  47172. * Sets the value of the `Back` button
  47173. */
  47174. set buttonBack(value: number);
  47175. /**
  47176. * Gets the value of the `Left` button
  47177. */
  47178. get buttonLB(): number;
  47179. /**
  47180. * Sets the value of the `Left` button
  47181. */
  47182. set buttonLB(value: number);
  47183. /**
  47184. * Gets the value of the `Right` button
  47185. */
  47186. get buttonRB(): number;
  47187. /**
  47188. * Sets the value of the `Right` button
  47189. */
  47190. set buttonRB(value: number);
  47191. /**
  47192. * Gets the value of the Left joystick
  47193. */
  47194. get buttonLeftStick(): number;
  47195. /**
  47196. * Sets the value of the Left joystick
  47197. */
  47198. set buttonLeftStick(value: number);
  47199. /**
  47200. * Gets the value of the Right joystick
  47201. */
  47202. get buttonRightStick(): number;
  47203. /**
  47204. * Sets the value of the Right joystick
  47205. */
  47206. set buttonRightStick(value: number);
  47207. /**
  47208. * Gets the value of D-pad up
  47209. */
  47210. get dPadUp(): number;
  47211. /**
  47212. * Sets the value of D-pad up
  47213. */
  47214. set dPadUp(value: number);
  47215. /**
  47216. * Gets the value of D-pad down
  47217. */
  47218. get dPadDown(): number;
  47219. /**
  47220. * Sets the value of D-pad down
  47221. */
  47222. set dPadDown(value: number);
  47223. /**
  47224. * Gets the value of D-pad left
  47225. */
  47226. get dPadLeft(): number;
  47227. /**
  47228. * Sets the value of D-pad left
  47229. */
  47230. set dPadLeft(value: number);
  47231. /**
  47232. * Gets the value of D-pad right
  47233. */
  47234. get dPadRight(): number;
  47235. /**
  47236. * Sets the value of D-pad right
  47237. */
  47238. set dPadRight(value: number);
  47239. /**
  47240. * Force the gamepad to synchronize with device values
  47241. */
  47242. update(): void;
  47243. /**
  47244. * Disposes the gamepad
  47245. */
  47246. dispose(): void;
  47247. }
  47248. }
  47249. declare module "babylonjs/Gamepads/dualShockGamepad" {
  47250. import { Observable } from "babylonjs/Misc/observable";
  47251. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  47252. /**
  47253. * Defines supported buttons for DualShock compatible gamepads
  47254. */
  47255. export enum DualShockButton {
  47256. /** Cross */
  47257. Cross = 0,
  47258. /** Circle */
  47259. Circle = 1,
  47260. /** Square */
  47261. Square = 2,
  47262. /** Triangle */
  47263. Triangle = 3,
  47264. /** L1 */
  47265. L1 = 4,
  47266. /** R1 */
  47267. R1 = 5,
  47268. /** Share */
  47269. Share = 8,
  47270. /** Options */
  47271. Options = 9,
  47272. /** Left stick */
  47273. LeftStick = 10,
  47274. /** Right stick */
  47275. RightStick = 11
  47276. }
  47277. /** Defines values for DualShock DPad */
  47278. export enum DualShockDpad {
  47279. /** Up */
  47280. Up = 12,
  47281. /** Down */
  47282. Down = 13,
  47283. /** Left */
  47284. Left = 14,
  47285. /** Right */
  47286. Right = 15
  47287. }
  47288. /**
  47289. * Defines a DualShock gamepad
  47290. */
  47291. export class DualShockPad extends Gamepad {
  47292. private _leftTrigger;
  47293. private _rightTrigger;
  47294. private _onlefttriggerchanged;
  47295. private _onrighttriggerchanged;
  47296. private _onbuttondown;
  47297. private _onbuttonup;
  47298. private _ondpaddown;
  47299. private _ondpadup;
  47300. /** Observable raised when a button is pressed */
  47301. onButtonDownObservable: Observable<DualShockButton>;
  47302. /** Observable raised when a button is released */
  47303. onButtonUpObservable: Observable<DualShockButton>;
  47304. /** Observable raised when a pad is pressed */
  47305. onPadDownObservable: Observable<DualShockDpad>;
  47306. /** Observable raised when a pad is released */
  47307. onPadUpObservable: Observable<DualShockDpad>;
  47308. private _buttonCross;
  47309. private _buttonCircle;
  47310. private _buttonSquare;
  47311. private _buttonTriangle;
  47312. private _buttonShare;
  47313. private _buttonOptions;
  47314. private _buttonL1;
  47315. private _buttonR1;
  47316. private _buttonLeftStick;
  47317. private _buttonRightStick;
  47318. private _dPadUp;
  47319. private _dPadDown;
  47320. private _dPadLeft;
  47321. private _dPadRight;
  47322. /**
  47323. * Creates a new DualShock gamepad object
  47324. * @param id defines the id of this gamepad
  47325. * @param index defines its index
  47326. * @param gamepad defines the internal HTML gamepad object
  47327. */
  47328. constructor(id: string, index: number, gamepad: any);
  47329. /**
  47330. * Defines the callback to call when left trigger is pressed
  47331. * @param callback defines the callback to use
  47332. */
  47333. onlefttriggerchanged(callback: (value: number) => void): void;
  47334. /**
  47335. * Defines the callback to call when right trigger is pressed
  47336. * @param callback defines the callback to use
  47337. */
  47338. onrighttriggerchanged(callback: (value: number) => void): void;
  47339. /**
  47340. * Gets the left trigger value
  47341. */
  47342. get leftTrigger(): number;
  47343. /**
  47344. * Sets the left trigger value
  47345. */
  47346. set leftTrigger(newValue: number);
  47347. /**
  47348. * Gets the right trigger value
  47349. */
  47350. get rightTrigger(): number;
  47351. /**
  47352. * Sets the right trigger value
  47353. */
  47354. set rightTrigger(newValue: number);
  47355. /**
  47356. * Defines the callback to call when a button is pressed
  47357. * @param callback defines the callback to use
  47358. */
  47359. onbuttondown(callback: (buttonPressed: DualShockButton) => void): void;
  47360. /**
  47361. * Defines the callback to call when a button is released
  47362. * @param callback defines the callback to use
  47363. */
  47364. onbuttonup(callback: (buttonReleased: DualShockButton) => void): void;
  47365. /**
  47366. * Defines the callback to call when a pad is pressed
  47367. * @param callback defines the callback to use
  47368. */
  47369. ondpaddown(callback: (dPadPressed: DualShockDpad) => void): void;
  47370. /**
  47371. * Defines the callback to call when a pad is released
  47372. * @param callback defines the callback to use
  47373. */
  47374. ondpadup(callback: (dPadReleased: DualShockDpad) => void): void;
  47375. private _setButtonValue;
  47376. private _setDPadValue;
  47377. /**
  47378. * Gets the value of the `Cross` button
  47379. */
  47380. get buttonCross(): number;
  47381. /**
  47382. * Sets the value of the `Cross` button
  47383. */
  47384. set buttonCross(value: number);
  47385. /**
  47386. * Gets the value of the `Circle` button
  47387. */
  47388. get buttonCircle(): number;
  47389. /**
  47390. * Sets the value of the `Circle` button
  47391. */
  47392. set buttonCircle(value: number);
  47393. /**
  47394. * Gets the value of the `Square` button
  47395. */
  47396. get buttonSquare(): number;
  47397. /**
  47398. * Sets the value of the `Square` button
  47399. */
  47400. set buttonSquare(value: number);
  47401. /**
  47402. * Gets the value of the `Triangle` button
  47403. */
  47404. get buttonTriangle(): number;
  47405. /**
  47406. * Sets the value of the `Triangle` button
  47407. */
  47408. set buttonTriangle(value: number);
  47409. /**
  47410. * Gets the value of the `Options` button
  47411. */
  47412. get buttonOptions(): number;
  47413. /**
  47414. * Sets the value of the `Options` button
  47415. */
  47416. set buttonOptions(value: number);
  47417. /**
  47418. * Gets the value of the `Share` button
  47419. */
  47420. get buttonShare(): number;
  47421. /**
  47422. * Sets the value of the `Share` button
  47423. */
  47424. set buttonShare(value: number);
  47425. /**
  47426. * Gets the value of the `L1` button
  47427. */
  47428. get buttonL1(): number;
  47429. /**
  47430. * Sets the value of the `L1` button
  47431. */
  47432. set buttonL1(value: number);
  47433. /**
  47434. * Gets the value of the `R1` button
  47435. */
  47436. get buttonR1(): number;
  47437. /**
  47438. * Sets the value of the `R1` button
  47439. */
  47440. set buttonR1(value: number);
  47441. /**
  47442. * Gets the value of the Left joystick
  47443. */
  47444. get buttonLeftStick(): number;
  47445. /**
  47446. * Sets the value of the Left joystick
  47447. */
  47448. set buttonLeftStick(value: number);
  47449. /**
  47450. * Gets the value of the Right joystick
  47451. */
  47452. get buttonRightStick(): number;
  47453. /**
  47454. * Sets the value of the Right joystick
  47455. */
  47456. set buttonRightStick(value: number);
  47457. /**
  47458. * Gets the value of D-pad up
  47459. */
  47460. get dPadUp(): number;
  47461. /**
  47462. * Sets the value of D-pad up
  47463. */
  47464. set dPadUp(value: number);
  47465. /**
  47466. * Gets the value of D-pad down
  47467. */
  47468. get dPadDown(): number;
  47469. /**
  47470. * Sets the value of D-pad down
  47471. */
  47472. set dPadDown(value: number);
  47473. /**
  47474. * Gets the value of D-pad left
  47475. */
  47476. get dPadLeft(): number;
  47477. /**
  47478. * Sets the value of D-pad left
  47479. */
  47480. set dPadLeft(value: number);
  47481. /**
  47482. * Gets the value of D-pad right
  47483. */
  47484. get dPadRight(): number;
  47485. /**
  47486. * Sets the value of D-pad right
  47487. */
  47488. set dPadRight(value: number);
  47489. /**
  47490. * Force the gamepad to synchronize with device values
  47491. */
  47492. update(): void;
  47493. /**
  47494. * Disposes the gamepad
  47495. */
  47496. dispose(): void;
  47497. }
  47498. }
  47499. declare module "babylonjs/Gamepads/gamepadManager" {
  47500. import { Observable } from "babylonjs/Misc/observable";
  47501. import { Nullable } from "babylonjs/types";
  47502. import { Scene } from "babylonjs/scene";
  47503. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  47504. /**
  47505. * Manager for handling gamepads
  47506. */
  47507. export class GamepadManager {
  47508. private _scene?;
  47509. private _babylonGamepads;
  47510. private _oneGamepadConnected;
  47511. /** @hidden */
  47512. _isMonitoring: boolean;
  47513. private _gamepadEventSupported;
  47514. private _gamepadSupport?;
  47515. /**
  47516. * observable to be triggered when the gamepad controller has been connected
  47517. */
  47518. onGamepadConnectedObservable: Observable<Gamepad>;
  47519. /**
  47520. * observable to be triggered when the gamepad controller has been disconnected
  47521. */
  47522. onGamepadDisconnectedObservable: Observable<Gamepad>;
  47523. private _onGamepadConnectedEvent;
  47524. private _onGamepadDisconnectedEvent;
  47525. /**
  47526. * Initializes the gamepad manager
  47527. * @param _scene BabylonJS scene
  47528. */
  47529. constructor(_scene?: Scene | undefined);
  47530. /**
  47531. * The gamepads in the game pad manager
  47532. */
  47533. get gamepads(): Gamepad[];
  47534. /**
  47535. * Get the gamepad controllers based on type
  47536. * @param type The type of gamepad controller
  47537. * @returns Nullable gamepad
  47538. */
  47539. getGamepadByType(type?: number): Nullable<Gamepad>;
  47540. /**
  47541. * Disposes the gamepad manager
  47542. */
  47543. dispose(): void;
  47544. private _addNewGamepad;
  47545. private _startMonitoringGamepads;
  47546. private _stopMonitoringGamepads;
  47547. /** @hidden */
  47548. _checkGamepadsStatus(): void;
  47549. private _updateGamepadObjects;
  47550. }
  47551. }
  47552. declare module "babylonjs/Gamepads/gamepadSceneComponent" {
  47553. import { Nullable } from "babylonjs/types";
  47554. import { Scene } from "babylonjs/scene";
  47555. import { ISceneComponent } from "babylonjs/sceneComponent";
  47556. import { GamepadManager } from "babylonjs/Gamepads/gamepadManager";
  47557. module "babylonjs/scene" {
  47558. interface Scene {
  47559. /** @hidden */
  47560. _gamepadManager: Nullable<GamepadManager>;
  47561. /**
  47562. * Gets the gamepad manager associated with the scene
  47563. * @see https://doc.babylonjs.com/how_to/how_to_use_gamepads
  47564. */
  47565. gamepadManager: GamepadManager;
  47566. }
  47567. }
  47568. module "babylonjs/Cameras/freeCameraInputsManager" {
  47569. /**
  47570. * Interface representing a free camera inputs manager
  47571. */
  47572. interface FreeCameraInputsManager {
  47573. /**
  47574. * Adds gamepad input support to the FreeCameraInputsManager.
  47575. * @returns the FreeCameraInputsManager
  47576. */
  47577. addGamepad(): FreeCameraInputsManager;
  47578. }
  47579. }
  47580. module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  47581. /**
  47582. * Interface representing an arc rotate camera inputs manager
  47583. */
  47584. interface ArcRotateCameraInputsManager {
  47585. /**
  47586. * Adds gamepad input support to the ArcRotateCamera InputManager.
  47587. * @returns the camera inputs manager
  47588. */
  47589. addGamepad(): ArcRotateCameraInputsManager;
  47590. }
  47591. }
  47592. /**
  47593. * Defines the gamepad scene component responsible to manage gamepads in a given scene
  47594. */
  47595. export class GamepadSystemSceneComponent implements ISceneComponent {
  47596. /**
  47597. * The component name helpfull to identify the component in the list of scene components.
  47598. */
  47599. readonly name: string;
  47600. /**
  47601. * The scene the component belongs to.
  47602. */
  47603. scene: Scene;
  47604. /**
  47605. * Creates a new instance of the component for the given scene
  47606. * @param scene Defines the scene to register the component in
  47607. */
  47608. constructor(scene: Scene);
  47609. /**
  47610. * Registers the component in a given scene
  47611. */
  47612. register(): void;
  47613. /**
  47614. * Rebuilds the elements related to this component in case of
  47615. * context lost for instance.
  47616. */
  47617. rebuild(): void;
  47618. /**
  47619. * Disposes the component and the associated ressources
  47620. */
  47621. dispose(): void;
  47622. private _beforeCameraUpdate;
  47623. }
  47624. }
  47625. declare module "babylonjs/Cameras/universalCamera" {
  47626. import { TouchCamera } from "babylonjs/Cameras/touchCamera";
  47627. import { Scene } from "babylonjs/scene";
  47628. import { Vector3 } from "babylonjs/Maths/math.vector";
  47629. import "babylonjs/Gamepads/gamepadSceneComponent";
  47630. /**
  47631. * 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,
  47632. * which still works and will still be found in many Playgrounds.
  47633. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  47634. */
  47635. export class UniversalCamera extends TouchCamera {
  47636. /**
  47637. * Defines the gamepad rotation sensiblity.
  47638. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  47639. */
  47640. get gamepadAngularSensibility(): number;
  47641. set gamepadAngularSensibility(value: number);
  47642. /**
  47643. * Defines the gamepad move sensiblity.
  47644. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  47645. */
  47646. get gamepadMoveSensibility(): number;
  47647. set gamepadMoveSensibility(value: number);
  47648. /**
  47649. * 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,
  47650. * which still works and will still be found in many Playgrounds.
  47651. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  47652. * @param name Define the name of the camera in the scene
  47653. * @param position Define the start position of the camera in the scene
  47654. * @param scene Define the scene the camera belongs to
  47655. */
  47656. constructor(name: string, position: Vector3, scene: Scene);
  47657. /**
  47658. * Gets the current object class name.
  47659. * @return the class name
  47660. */
  47661. getClassName(): string;
  47662. }
  47663. }
  47664. declare module "babylonjs/Cameras/gamepadCamera" {
  47665. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  47666. import { Scene } from "babylonjs/scene";
  47667. import { Vector3 } from "babylonjs/Maths/math.vector";
  47668. /**
  47669. * This represents a FPS type of camera. This is only here for back compat purpose.
  47670. * Please use the UniversalCamera instead as both are identical.
  47671. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  47672. */
  47673. export class GamepadCamera extends UniversalCamera {
  47674. /**
  47675. * Instantiates a new Gamepad Camera
  47676. * This represents a FPS type of camera. This is only here for back compat purpose.
  47677. * Please use the UniversalCamera instead as both are identical.
  47678. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  47679. * @param name Define the name of the camera in the scene
  47680. * @param position Define the start position of the camera in the scene
  47681. * @param scene Define the scene the camera belongs to
  47682. */
  47683. constructor(name: string, position: Vector3, scene: Scene);
  47684. /**
  47685. * Gets the current object class name.
  47686. * @return the class name
  47687. */
  47688. getClassName(): string;
  47689. }
  47690. }
  47691. declare module "babylonjs/Shaders/pass.fragment" {
  47692. /** @hidden */
  47693. export var passPixelShader: {
  47694. name: string;
  47695. shader: string;
  47696. };
  47697. }
  47698. declare module "babylonjs/Shaders/passCube.fragment" {
  47699. /** @hidden */
  47700. export var passCubePixelShader: {
  47701. name: string;
  47702. shader: string;
  47703. };
  47704. }
  47705. declare module "babylonjs/PostProcesses/passPostProcess" {
  47706. import { Nullable } from "babylonjs/types";
  47707. import { Camera } from "babylonjs/Cameras/camera";
  47708. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  47709. import { Engine } from "babylonjs/Engines/engine";
  47710. import "babylonjs/Shaders/pass.fragment";
  47711. import "babylonjs/Shaders/passCube.fragment";
  47712. import { Scene } from "babylonjs/scene";
  47713. /**
  47714. * PassPostProcess which produces an output the same as it's input
  47715. */
  47716. export class PassPostProcess extends PostProcess {
  47717. /**
  47718. * Gets a string identifying the name of the class
  47719. * @returns "PassPostProcess" string
  47720. */
  47721. getClassName(): string;
  47722. /**
  47723. * Creates the PassPostProcess
  47724. * @param name The name of the effect.
  47725. * @param options The required width/height ratio to downsize to before computing the render pass.
  47726. * @param camera The camera to apply the render pass to.
  47727. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  47728. * @param engine The engine which the post process will be applied. (default: current engine)
  47729. * @param reusable If the post process can be reused on the same frame. (default: false)
  47730. * @param textureType The type of texture to be used when performing the post processing.
  47731. * @param blockCompilation If compilation of the shader should not be done in the constructor. The updateEffect method can be used to compile the shader at a later time. (default: false)
  47732. */
  47733. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  47734. /** @hidden */
  47735. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): PassPostProcess;
  47736. }
  47737. /**
  47738. * PassCubePostProcess which produces an output the same as it's input (which must be a cube texture)
  47739. */
  47740. export class PassCubePostProcess extends PostProcess {
  47741. private _face;
  47742. /**
  47743. * Gets or sets the cube face to display.
  47744. * * 0 is +X
  47745. * * 1 is -X
  47746. * * 2 is +Y
  47747. * * 3 is -Y
  47748. * * 4 is +Z
  47749. * * 5 is -Z
  47750. */
  47751. get face(): number;
  47752. set face(value: number);
  47753. /**
  47754. * Gets a string identifying the name of the class
  47755. * @returns "PassCubePostProcess" string
  47756. */
  47757. getClassName(): string;
  47758. /**
  47759. * Creates the PassCubePostProcess
  47760. * @param name The name of the effect.
  47761. * @param options The required width/height ratio to downsize to before computing the render pass.
  47762. * @param camera The camera to apply the render pass to.
  47763. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  47764. * @param engine The engine which the post process will be applied. (default: current engine)
  47765. * @param reusable If the post process can be reused on the same frame. (default: false)
  47766. * @param textureType The type of texture to be used when performing the post processing.
  47767. * @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)
  47768. */
  47769. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  47770. /** @hidden */
  47771. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): PassCubePostProcess;
  47772. }
  47773. }
  47774. declare module "babylonjs/Shaders/anaglyph.fragment" {
  47775. /** @hidden */
  47776. export var anaglyphPixelShader: {
  47777. name: string;
  47778. shader: string;
  47779. };
  47780. }
  47781. declare module "babylonjs/PostProcesses/anaglyphPostProcess" {
  47782. import { Engine } from "babylonjs/Engines/engine";
  47783. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  47784. import { Camera } from "babylonjs/Cameras/camera";
  47785. import "babylonjs/Shaders/anaglyph.fragment";
  47786. /**
  47787. * Postprocess used to generate anaglyphic rendering
  47788. */
  47789. export class AnaglyphPostProcess extends PostProcess {
  47790. private _passedProcess;
  47791. /**
  47792. * Gets a string identifying the name of the class
  47793. * @returns "AnaglyphPostProcess" string
  47794. */
  47795. getClassName(): string;
  47796. /**
  47797. * Creates a new AnaglyphPostProcess
  47798. * @param name defines postprocess name
  47799. * @param options defines creation options or target ratio scale
  47800. * @param rigCameras defines cameras using this postprocess
  47801. * @param samplingMode defines required sampling mode (BABYLON.Texture.NEAREST_SAMPLINGMODE by default)
  47802. * @param engine defines hosting engine
  47803. * @param reusable defines if the postprocess will be reused multiple times per frame
  47804. */
  47805. constructor(name: string, options: number | PostProcessOptions, rigCameras: Camera[], samplingMode?: number, engine?: Engine, reusable?: boolean);
  47806. }
  47807. }
  47808. declare module "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode" { }
  47809. declare module "babylonjs/Cameras/Stereoscopic/anaglyphArcRotateCamera" {
  47810. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  47811. import { Scene } from "babylonjs/scene";
  47812. import { Vector3 } from "babylonjs/Maths/math.vector";
  47813. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  47814. /**
  47815. * Camera used to simulate anaglyphic rendering (based on ArcRotateCamera)
  47816. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  47817. */
  47818. export class AnaglyphArcRotateCamera extends ArcRotateCamera {
  47819. /**
  47820. * Creates a new AnaglyphArcRotateCamera
  47821. * @param name defines camera name
  47822. * @param alpha defines alpha angle (in radians)
  47823. * @param beta defines beta angle (in radians)
  47824. * @param radius defines radius
  47825. * @param target defines camera target
  47826. * @param interaxialDistance defines distance between each color axis
  47827. * @param scene defines the hosting scene
  47828. */
  47829. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, scene: Scene);
  47830. /**
  47831. * Gets camera class name
  47832. * @returns AnaglyphArcRotateCamera
  47833. */
  47834. getClassName(): string;
  47835. }
  47836. }
  47837. declare module "babylonjs/Cameras/Stereoscopic/anaglyphFreeCamera" {
  47838. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  47839. import { Scene } from "babylonjs/scene";
  47840. import { Vector3 } from "babylonjs/Maths/math.vector";
  47841. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  47842. /**
  47843. * Camera used to simulate anaglyphic rendering (based on FreeCamera)
  47844. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  47845. */
  47846. export class AnaglyphFreeCamera extends FreeCamera {
  47847. /**
  47848. * Creates a new AnaglyphFreeCamera
  47849. * @param name defines camera name
  47850. * @param position defines initial position
  47851. * @param interaxialDistance defines distance between each color axis
  47852. * @param scene defines the hosting scene
  47853. */
  47854. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  47855. /**
  47856. * Gets camera class name
  47857. * @returns AnaglyphFreeCamera
  47858. */
  47859. getClassName(): string;
  47860. }
  47861. }
  47862. declare module "babylonjs/Cameras/Stereoscopic/anaglyphGamepadCamera" {
  47863. import { GamepadCamera } from "babylonjs/Cameras/gamepadCamera";
  47864. import { Scene } from "babylonjs/scene";
  47865. import { Vector3 } from "babylonjs/Maths/math.vector";
  47866. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  47867. /**
  47868. * Camera used to simulate anaglyphic rendering (based on GamepadCamera)
  47869. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  47870. */
  47871. export class AnaglyphGamepadCamera extends GamepadCamera {
  47872. /**
  47873. * Creates a new AnaglyphGamepadCamera
  47874. * @param name defines camera name
  47875. * @param position defines initial position
  47876. * @param interaxialDistance defines distance between each color axis
  47877. * @param scene defines the hosting scene
  47878. */
  47879. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  47880. /**
  47881. * Gets camera class name
  47882. * @returns AnaglyphGamepadCamera
  47883. */
  47884. getClassName(): string;
  47885. }
  47886. }
  47887. declare module "babylonjs/Cameras/Stereoscopic/anaglyphUniversalCamera" {
  47888. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  47889. import { Scene } from "babylonjs/scene";
  47890. import { Vector3 } from "babylonjs/Maths/math.vector";
  47891. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  47892. /**
  47893. * Camera used to simulate anaglyphic rendering (based on UniversalCamera)
  47894. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  47895. */
  47896. export class AnaglyphUniversalCamera extends UniversalCamera {
  47897. /**
  47898. * Creates a new AnaglyphUniversalCamera
  47899. * @param name defines camera name
  47900. * @param position defines initial position
  47901. * @param interaxialDistance defines distance between each color axis
  47902. * @param scene defines the hosting scene
  47903. */
  47904. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  47905. /**
  47906. * Gets camera class name
  47907. * @returns AnaglyphUniversalCamera
  47908. */
  47909. getClassName(): string;
  47910. }
  47911. }
  47912. declare module "babylonjs/Cameras/RigModes/stereoscopicRigMode" { }
  47913. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicArcRotateCamera" {
  47914. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  47915. import { Scene } from "babylonjs/scene";
  47916. import { Vector3 } from "babylonjs/Maths/math.vector";
  47917. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  47918. /**
  47919. * Camera used to simulate stereoscopic rendering (based on ArcRotateCamera)
  47920. * @see https://doc.babylonjs.com/features/cameras
  47921. */
  47922. export class StereoscopicArcRotateCamera extends ArcRotateCamera {
  47923. /**
  47924. * Creates a new StereoscopicArcRotateCamera
  47925. * @param name defines camera name
  47926. * @param alpha defines alpha angle (in radians)
  47927. * @param beta defines beta angle (in radians)
  47928. * @param radius defines radius
  47929. * @param target defines camera target
  47930. * @param interaxialDistance defines distance between each color axis
  47931. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  47932. * @param scene defines the hosting scene
  47933. */
  47934. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  47935. /**
  47936. * Gets camera class name
  47937. * @returns StereoscopicArcRotateCamera
  47938. */
  47939. getClassName(): string;
  47940. }
  47941. }
  47942. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicFreeCamera" {
  47943. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  47944. import { Scene } from "babylonjs/scene";
  47945. import { Vector3 } from "babylonjs/Maths/math.vector";
  47946. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  47947. /**
  47948. * Camera used to simulate stereoscopic rendering (based on FreeCamera)
  47949. * @see https://doc.babylonjs.com/features/cameras
  47950. */
  47951. export class StereoscopicFreeCamera extends FreeCamera {
  47952. /**
  47953. * Creates a new StereoscopicFreeCamera
  47954. * @param name defines camera name
  47955. * @param position defines initial position
  47956. * @param interaxialDistance defines distance between each color axis
  47957. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  47958. * @param scene defines the hosting scene
  47959. */
  47960. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  47961. /**
  47962. * Gets camera class name
  47963. * @returns StereoscopicFreeCamera
  47964. */
  47965. getClassName(): string;
  47966. }
  47967. }
  47968. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicGamepadCamera" {
  47969. import { GamepadCamera } from "babylonjs/Cameras/gamepadCamera";
  47970. import { Scene } from "babylonjs/scene";
  47971. import { Vector3 } from "babylonjs/Maths/math.vector";
  47972. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  47973. /**
  47974. * Camera used to simulate stereoscopic rendering (based on GamepadCamera)
  47975. * @see https://doc.babylonjs.com/features/cameras
  47976. */
  47977. export class StereoscopicGamepadCamera extends GamepadCamera {
  47978. /**
  47979. * Creates a new StereoscopicGamepadCamera
  47980. * @param name defines camera name
  47981. * @param position defines initial position
  47982. * @param interaxialDistance defines distance between each color axis
  47983. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  47984. * @param scene defines the hosting scene
  47985. */
  47986. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  47987. /**
  47988. * Gets camera class name
  47989. * @returns StereoscopicGamepadCamera
  47990. */
  47991. getClassName(): string;
  47992. }
  47993. }
  47994. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicUniversalCamera" {
  47995. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  47996. import { Scene } from "babylonjs/scene";
  47997. import { Vector3 } from "babylonjs/Maths/math.vector";
  47998. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  47999. /**
  48000. * Camera used to simulate stereoscopic rendering (based on UniversalCamera)
  48001. * @see https://doc.babylonjs.com/features/cameras
  48002. */
  48003. export class StereoscopicUniversalCamera extends UniversalCamera {
  48004. /**
  48005. * Creates a new StereoscopicUniversalCamera
  48006. * @param name defines camera name
  48007. * @param position defines initial position
  48008. * @param interaxialDistance defines distance between each color axis
  48009. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  48010. * @param scene defines the hosting scene
  48011. */
  48012. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  48013. /**
  48014. * Gets camera class name
  48015. * @returns StereoscopicUniversalCamera
  48016. */
  48017. getClassName(): string;
  48018. }
  48019. }
  48020. declare module "babylonjs/Cameras/Stereoscopic/index" {
  48021. export * from "babylonjs/Cameras/Stereoscopic/anaglyphArcRotateCamera";
  48022. export * from "babylonjs/Cameras/Stereoscopic/anaglyphFreeCamera";
  48023. export * from "babylonjs/Cameras/Stereoscopic/anaglyphGamepadCamera";
  48024. export * from "babylonjs/Cameras/Stereoscopic/anaglyphUniversalCamera";
  48025. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicArcRotateCamera";
  48026. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicFreeCamera";
  48027. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicGamepadCamera";
  48028. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicUniversalCamera";
  48029. }
  48030. declare module "babylonjs/Cameras/virtualJoysticksCamera" {
  48031. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  48032. import { Scene } from "babylonjs/scene";
  48033. import { Vector3 } from "babylonjs/Maths/math.vector";
  48034. import "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput";
  48035. /**
  48036. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  48037. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  48038. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  48039. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  48040. */
  48041. export class VirtualJoysticksCamera extends FreeCamera {
  48042. /**
  48043. * Intantiates a VirtualJoysticksCamera. It can be useful in First Person Shooter game for instance.
  48044. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  48045. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  48046. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  48047. * @param name Define the name of the camera in the scene
  48048. * @param position Define the start position of the camera in the scene
  48049. * @param scene Define the scene the camera belongs to
  48050. */
  48051. constructor(name: string, position: Vector3, scene: Scene);
  48052. /**
  48053. * Gets the current object class name.
  48054. * @return the class name
  48055. */
  48056. getClassName(): string;
  48057. }
  48058. }
  48059. declare module "babylonjs/Cameras/VR/vrCameraMetrics" {
  48060. import { Matrix } from "babylonjs/Maths/math.vector";
  48061. /**
  48062. * This represents all the required metrics to create a VR camera.
  48063. * @see https://doc.babylonjs.com/babylon101/cameras#device-orientation-camera
  48064. */
  48065. export class VRCameraMetrics {
  48066. /**
  48067. * Define the horizontal resolution off the screen.
  48068. */
  48069. hResolution: number;
  48070. /**
  48071. * Define the vertical resolution off the screen.
  48072. */
  48073. vResolution: number;
  48074. /**
  48075. * Define the horizontal screen size.
  48076. */
  48077. hScreenSize: number;
  48078. /**
  48079. * Define the vertical screen size.
  48080. */
  48081. vScreenSize: number;
  48082. /**
  48083. * Define the vertical screen center position.
  48084. */
  48085. vScreenCenter: number;
  48086. /**
  48087. * Define the distance of the eyes to the screen.
  48088. */
  48089. eyeToScreenDistance: number;
  48090. /**
  48091. * Define the distance between both lenses
  48092. */
  48093. lensSeparationDistance: number;
  48094. /**
  48095. * Define the distance between both viewer's eyes.
  48096. */
  48097. interpupillaryDistance: number;
  48098. /**
  48099. * Define the distortion factor of the VR postprocess.
  48100. * Please, touch with care.
  48101. */
  48102. distortionK: number[];
  48103. /**
  48104. * Define the chromatic aberration correction factors for the VR post process.
  48105. */
  48106. chromaAbCorrection: number[];
  48107. /**
  48108. * Define the scale factor of the post process.
  48109. * The smaller the better but the slower.
  48110. */
  48111. postProcessScaleFactor: number;
  48112. /**
  48113. * Define an offset for the lens center.
  48114. */
  48115. lensCenterOffset: number;
  48116. /**
  48117. * Define if the current vr camera should compensate the distortion of the lense or not.
  48118. */
  48119. compensateDistortion: boolean;
  48120. /**
  48121. * Defines if multiview should be enabled when rendering (Default: false)
  48122. */
  48123. multiviewEnabled: boolean;
  48124. /**
  48125. * Gets the rendering aspect ratio based on the provided resolutions.
  48126. */
  48127. get aspectRatio(): number;
  48128. /**
  48129. * Gets the aspect ratio based on the FOV, scale factors, and real screen sizes.
  48130. */
  48131. get aspectRatioFov(): number;
  48132. /**
  48133. * @hidden
  48134. */
  48135. get leftHMatrix(): Matrix;
  48136. /**
  48137. * @hidden
  48138. */
  48139. get rightHMatrix(): Matrix;
  48140. /**
  48141. * @hidden
  48142. */
  48143. get leftPreViewMatrix(): Matrix;
  48144. /**
  48145. * @hidden
  48146. */
  48147. get rightPreViewMatrix(): Matrix;
  48148. /**
  48149. * Get the default VRMetrics based on the most generic setup.
  48150. * @returns the default vr metrics
  48151. */
  48152. static GetDefault(): VRCameraMetrics;
  48153. }
  48154. }
  48155. declare module "babylonjs/Shaders/vrDistortionCorrection.fragment" {
  48156. /** @hidden */
  48157. export var vrDistortionCorrectionPixelShader: {
  48158. name: string;
  48159. shader: string;
  48160. };
  48161. }
  48162. declare module "babylonjs/PostProcesses/vrDistortionCorrectionPostProcess" {
  48163. import { Camera } from "babylonjs/Cameras/camera";
  48164. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  48165. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  48166. import "babylonjs/Shaders/vrDistortionCorrection.fragment";
  48167. /**
  48168. * VRDistortionCorrectionPostProcess used for mobile VR
  48169. */
  48170. export class VRDistortionCorrectionPostProcess extends PostProcess {
  48171. private _isRightEye;
  48172. private _distortionFactors;
  48173. private _postProcessScaleFactor;
  48174. private _lensCenterOffset;
  48175. private _scaleIn;
  48176. private _scaleFactor;
  48177. private _lensCenter;
  48178. /**
  48179. * Gets a string identifying the name of the class
  48180. * @returns "VRDistortionCorrectionPostProcess" string
  48181. */
  48182. getClassName(): string;
  48183. /**
  48184. * Initializes the VRDistortionCorrectionPostProcess
  48185. * @param name The name of the effect.
  48186. * @param camera The camera to apply the render pass to.
  48187. * @param isRightEye If this is for the right eye distortion
  48188. * @param vrMetrics All the required metrics for the VR camera
  48189. */
  48190. constructor(name: string, camera: Camera, isRightEye: boolean, vrMetrics: VRCameraMetrics);
  48191. }
  48192. }
  48193. declare module "babylonjs/Cameras/RigModes/vrRigMode" { }
  48194. declare module "babylonjs/Cameras/VR/vrDeviceOrientationArcRotateCamera" {
  48195. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  48196. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  48197. import { Scene } from "babylonjs/scene";
  48198. import { Vector3 } from "babylonjs/Maths/math.vector";
  48199. import "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput";
  48200. import "babylonjs/Cameras/RigModes/vrRigMode";
  48201. /**
  48202. * Camera used to simulate VR rendering (based on ArcRotateCamera)
  48203. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  48204. */
  48205. export class VRDeviceOrientationArcRotateCamera extends ArcRotateCamera {
  48206. /**
  48207. * Creates a new VRDeviceOrientationArcRotateCamera
  48208. * @param name defines camera name
  48209. * @param alpha defines the camera rotation along the logitudinal axis
  48210. * @param beta defines the camera rotation along the latitudinal axis
  48211. * @param radius defines the camera distance from its target
  48212. * @param target defines the camera target
  48213. * @param scene defines the scene the camera belongs to
  48214. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  48215. * @param vrCameraMetrics defines the vr metrics associated to the camera
  48216. */
  48217. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  48218. /**
  48219. * Gets camera class name
  48220. * @returns VRDeviceOrientationArcRotateCamera
  48221. */
  48222. getClassName(): string;
  48223. }
  48224. }
  48225. declare module "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera" {
  48226. import { DeviceOrientationCamera } from "babylonjs/Cameras/deviceOrientationCamera";
  48227. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  48228. import { Scene } from "babylonjs/scene";
  48229. import { Vector3 } from "babylonjs/Maths/math.vector";
  48230. import "babylonjs/Cameras/RigModes/vrRigMode";
  48231. /**
  48232. * Camera used to simulate VR rendering (based on FreeCamera)
  48233. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  48234. */
  48235. export class VRDeviceOrientationFreeCamera extends DeviceOrientationCamera {
  48236. /**
  48237. * Creates a new VRDeviceOrientationFreeCamera
  48238. * @param name defines camera name
  48239. * @param position defines the start position of the camera
  48240. * @param scene defines the scene the camera belongs to
  48241. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  48242. * @param vrCameraMetrics defines the vr metrics associated to the camera
  48243. */
  48244. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  48245. /**
  48246. * Gets camera class name
  48247. * @returns VRDeviceOrientationFreeCamera
  48248. */
  48249. getClassName(): string;
  48250. }
  48251. }
  48252. declare module "babylonjs/Cameras/VR/vrDeviceOrientationGamepadCamera" {
  48253. import { VRDeviceOrientationFreeCamera } from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  48254. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  48255. import { Scene } from "babylonjs/scene";
  48256. import { Vector3 } from "babylonjs/Maths/math.vector";
  48257. import "babylonjs/Gamepads/gamepadSceneComponent";
  48258. /**
  48259. * Camera used to simulate VR rendering (based on VRDeviceOrientationFreeCamera)
  48260. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  48261. */
  48262. export class VRDeviceOrientationGamepadCamera extends VRDeviceOrientationFreeCamera {
  48263. /**
  48264. * Creates a new VRDeviceOrientationGamepadCamera
  48265. * @param name defines camera name
  48266. * @param position defines the start position of the camera
  48267. * @param scene defines the scene the camera belongs to
  48268. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  48269. * @param vrCameraMetrics defines the vr metrics associated to the camera
  48270. */
  48271. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  48272. /**
  48273. * Gets camera class name
  48274. * @returns VRDeviceOrientationGamepadCamera
  48275. */
  48276. getClassName(): string;
  48277. }
  48278. }
  48279. declare module "babylonjs/Materials/Textures/dynamicTexture" {
  48280. import { Scene } from "babylonjs/scene";
  48281. import { Texture } from "babylonjs/Materials/Textures/texture";
  48282. import "babylonjs/Engines/Extensions/engine.dynamicTexture";
  48283. /**
  48284. * A class extending Texture allowing drawing on a texture
  48285. * @see https://doc.babylonjs.com/how_to/dynamictexture
  48286. */
  48287. export class DynamicTexture extends Texture {
  48288. private _generateMipMaps;
  48289. private _canvas;
  48290. private _context;
  48291. /**
  48292. * Creates a DynamicTexture
  48293. * @param name defines the name of the texture
  48294. * @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
  48295. * @param scene defines the scene where you want the texture
  48296. * @param generateMipMaps defines the use of MinMaps or not (default is false)
  48297. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  48298. * @param format defines the texture format to use (default is Engine.TEXTUREFORMAT_RGBA)
  48299. */
  48300. constructor(name: string, options: any, scene: Scene | null | undefined, generateMipMaps: boolean, samplingMode?: number, format?: number);
  48301. /**
  48302. * Get the current class name of the texture useful for serialization or dynamic coding.
  48303. * @returns "DynamicTexture"
  48304. */
  48305. getClassName(): string;
  48306. /**
  48307. * Gets the current state of canRescale
  48308. */
  48309. get canRescale(): boolean;
  48310. private _recreate;
  48311. /**
  48312. * Scales the texture
  48313. * @param ratio the scale factor to apply to both width and height
  48314. */
  48315. scale(ratio: number): void;
  48316. /**
  48317. * Resizes the texture
  48318. * @param width the new width
  48319. * @param height the new height
  48320. */
  48321. scaleTo(width: number, height: number): void;
  48322. /**
  48323. * Gets the context of the canvas used by the texture
  48324. * @returns the canvas context of the dynamic texture
  48325. */
  48326. getContext(): CanvasRenderingContext2D;
  48327. /**
  48328. * Clears the texture
  48329. */
  48330. clear(): void;
  48331. /**
  48332. * Updates the texture
  48333. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  48334. * @param premulAlpha defines if alpha is stored as premultiplied (default is false)
  48335. */
  48336. update(invertY?: boolean, premulAlpha?: boolean): void;
  48337. /**
  48338. * Draws text onto the texture
  48339. * @param text defines the text to be drawn
  48340. * @param x defines the placement of the text from the left
  48341. * @param y defines the placement of the text from the top when invertY is true and from the bottom when false
  48342. * @param font defines the font to be used with font-style, font-size, font-name
  48343. * @param color defines the color used for the text
  48344. * @param clearColor defines the color for the canvas, use null to not overwrite canvas
  48345. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  48346. * @param update defines whether texture is immediately update (default is true)
  48347. */
  48348. drawText(text: string, x: number | null | undefined, y: number | null | undefined, font: string, color: string | null, clearColor: string, invertY?: boolean, update?: boolean): void;
  48349. /**
  48350. * Clones the texture
  48351. * @returns the clone of the texture.
  48352. */
  48353. clone(): DynamicTexture;
  48354. /**
  48355. * Serializes the dynamic texture. The scene should be ready before the dynamic texture is serialized
  48356. * @returns a serialized dynamic texture object
  48357. */
  48358. serialize(): any;
  48359. private _IsCanvasElement;
  48360. /** @hidden */
  48361. _rebuild(): void;
  48362. }
  48363. }
  48364. declare module "babylonjs/Meshes/Builders/groundBuilder" {
  48365. import { Scene } from "babylonjs/scene";
  48366. import { Color3 } from "babylonjs/Maths/math.color";
  48367. import { Mesh } from "babylonjs/Meshes/mesh";
  48368. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  48369. import { Nullable } from "babylonjs/types";
  48370. /**
  48371. * Class containing static functions to help procedurally build meshes
  48372. */
  48373. export class GroundBuilder {
  48374. /**
  48375. * Creates a ground mesh
  48376. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  48377. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  48378. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  48379. * @param name defines the name of the mesh
  48380. * @param options defines the options used to create the mesh
  48381. * @param scene defines the hosting scene
  48382. * @returns the ground mesh
  48383. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  48384. */
  48385. static CreateGround(name: string, options: {
  48386. width?: number;
  48387. height?: number;
  48388. subdivisions?: number;
  48389. subdivisionsX?: number;
  48390. subdivisionsY?: number;
  48391. updatable?: boolean;
  48392. }, scene: any): Mesh;
  48393. /**
  48394. * Creates a tiled ground mesh
  48395. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  48396. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  48397. * * 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
  48398. * * 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
  48399. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  48400. * @param name defines the name of the mesh
  48401. * @param options defines the options used to create the mesh
  48402. * @param scene defines the hosting scene
  48403. * @returns the tiled ground mesh
  48404. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  48405. */
  48406. static CreateTiledGround(name: string, options: {
  48407. xmin: number;
  48408. zmin: number;
  48409. xmax: number;
  48410. zmax: number;
  48411. subdivisions?: {
  48412. w: number;
  48413. h: number;
  48414. };
  48415. precision?: {
  48416. w: number;
  48417. h: number;
  48418. };
  48419. updatable?: boolean;
  48420. }, scene?: Nullable<Scene>): Mesh;
  48421. /**
  48422. * Creates a ground mesh from a height map
  48423. * * The parameter `url` sets the URL of the height map image resource.
  48424. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  48425. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  48426. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  48427. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  48428. * * 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.
  48429. * * 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).
  48430. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  48431. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  48432. * @param name defines the name of the mesh
  48433. * @param url defines the url to the height map
  48434. * @param options defines the options used to create the mesh
  48435. * @param scene defines the hosting scene
  48436. * @returns the ground mesh
  48437. * @see https://doc.babylonjs.com/babylon101/height_map
  48438. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  48439. */
  48440. static CreateGroundFromHeightMap(name: string, url: string, options: {
  48441. width?: number;
  48442. height?: number;
  48443. subdivisions?: number;
  48444. minHeight?: number;
  48445. maxHeight?: number;
  48446. colorFilter?: Color3;
  48447. alphaFilter?: number;
  48448. updatable?: boolean;
  48449. onReady?: (mesh: GroundMesh) => void;
  48450. }, scene?: Nullable<Scene>): GroundMesh;
  48451. }
  48452. }
  48453. declare module "babylonjs/Meshes/Builders/torusBuilder" {
  48454. import { Vector4 } from "babylonjs/Maths/math.vector";
  48455. import { Mesh } from "babylonjs/Meshes/mesh";
  48456. /**
  48457. * Class containing static functions to help procedurally build meshes
  48458. */
  48459. export class TorusBuilder {
  48460. /**
  48461. * Creates a torus mesh
  48462. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  48463. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  48464. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  48465. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  48466. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  48467. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  48468. * @param name defines the name of the mesh
  48469. * @param options defines the options used to create the mesh
  48470. * @param scene defines the hosting scene
  48471. * @returns the torus mesh
  48472. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  48473. */
  48474. static CreateTorus(name: string, options: {
  48475. diameter?: number;
  48476. thickness?: number;
  48477. tessellation?: number;
  48478. updatable?: boolean;
  48479. sideOrientation?: number;
  48480. frontUVs?: Vector4;
  48481. backUVs?: Vector4;
  48482. }, scene: any): Mesh;
  48483. }
  48484. }
  48485. declare module "babylonjs/Meshes/Builders/cylinderBuilder" {
  48486. import { Vector4 } from "babylonjs/Maths/math.vector";
  48487. import { Color4 } from "babylonjs/Maths/math.color";
  48488. import { Mesh } from "babylonjs/Meshes/mesh";
  48489. /**
  48490. * Class containing static functions to help procedurally build meshes
  48491. */
  48492. export class CylinderBuilder {
  48493. /**
  48494. * Creates a cylinder or a cone mesh
  48495. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  48496. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  48497. * * 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.
  48498. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  48499. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  48500. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  48501. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  48502. * * 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).
  48503. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  48504. * * 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).
  48505. * * 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
  48506. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  48507. * * 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
  48508. * * 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.
  48509. * * If `enclose` is false, a ring surface is one element.
  48510. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  48511. * * 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
  48512. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  48513. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  48514. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  48515. * @param name defines the name of the mesh
  48516. * @param options defines the options used to create the mesh
  48517. * @param scene defines the hosting scene
  48518. * @returns the cylinder mesh
  48519. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  48520. */
  48521. static CreateCylinder(name: string, options: {
  48522. height?: number;
  48523. diameterTop?: number;
  48524. diameterBottom?: number;
  48525. diameter?: number;
  48526. tessellation?: number;
  48527. subdivisions?: number;
  48528. arc?: number;
  48529. faceColors?: Color4[];
  48530. faceUV?: Vector4[];
  48531. updatable?: boolean;
  48532. hasRings?: boolean;
  48533. enclose?: boolean;
  48534. cap?: number;
  48535. sideOrientation?: number;
  48536. frontUVs?: Vector4;
  48537. backUVs?: Vector4;
  48538. }, scene: any): Mesh;
  48539. }
  48540. }
  48541. declare module "babylonjs/XR/webXRTypes" {
  48542. import { Nullable } from "babylonjs/types";
  48543. import { IDisposable } from "babylonjs/scene";
  48544. /**
  48545. * States of the webXR experience
  48546. */
  48547. export enum WebXRState {
  48548. /**
  48549. * Transitioning to being in XR mode
  48550. */
  48551. ENTERING_XR = 0,
  48552. /**
  48553. * Transitioning to non XR mode
  48554. */
  48555. EXITING_XR = 1,
  48556. /**
  48557. * In XR mode and presenting
  48558. */
  48559. IN_XR = 2,
  48560. /**
  48561. * Not entered XR mode
  48562. */
  48563. NOT_IN_XR = 3
  48564. }
  48565. /**
  48566. * Abstraction of the XR render target
  48567. */
  48568. export interface WebXRRenderTarget extends IDisposable {
  48569. /**
  48570. * xrpresent context of the canvas which can be used to display/mirror xr content
  48571. */
  48572. canvasContext: WebGLRenderingContext;
  48573. /**
  48574. * xr layer for the canvas
  48575. */
  48576. xrLayer: Nullable<XRWebGLLayer>;
  48577. /**
  48578. * Initializes the xr layer for the session
  48579. * @param xrSession xr session
  48580. * @returns a promise that will resolve once the XR Layer has been created
  48581. */
  48582. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  48583. }
  48584. }
  48585. declare module "babylonjs/XR/webXRManagedOutputCanvas" {
  48586. import { Nullable } from "babylonjs/types";
  48587. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  48588. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  48589. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  48590. import { Observable } from "babylonjs/Misc/observable";
  48591. /**
  48592. * COnfiguration object for WebXR output canvas
  48593. */
  48594. export class WebXRManagedOutputCanvasOptions {
  48595. /**
  48596. * An optional canvas in case you wish to create it yourself and provide it here.
  48597. * If not provided, a new canvas will be created
  48598. */
  48599. canvasElement?: HTMLCanvasElement;
  48600. /**
  48601. * Options for this XR Layer output
  48602. */
  48603. canvasOptions?: XRWebGLLayerOptions;
  48604. /**
  48605. * CSS styling for a newly created canvas (if not provided)
  48606. */
  48607. newCanvasCssStyle?: string;
  48608. /**
  48609. * Get the default values of the configuration object
  48610. * @param engine defines the engine to use (can be null)
  48611. * @returns default values of this configuration object
  48612. */
  48613. static GetDefaults(engine?: ThinEngine): WebXRManagedOutputCanvasOptions;
  48614. }
  48615. /**
  48616. * Creates a canvas that is added/removed from the webpage when entering/exiting XR
  48617. */
  48618. export class WebXRManagedOutputCanvas implements WebXRRenderTarget {
  48619. private _options;
  48620. private _canvas;
  48621. private _engine;
  48622. private _originalCanvasSize;
  48623. /**
  48624. * Rendering context of the canvas which can be used to display/mirror xr content
  48625. */
  48626. canvasContext: WebGLRenderingContext;
  48627. /**
  48628. * xr layer for the canvas
  48629. */
  48630. xrLayer: Nullable<XRWebGLLayer>;
  48631. /**
  48632. * Obseervers registered here will be triggered when the xr layer was initialized
  48633. */
  48634. onXRLayerInitObservable: Observable<XRWebGLLayer>;
  48635. /**
  48636. * Initializes the canvas to be added/removed upon entering/exiting xr
  48637. * @param _xrSessionManager The XR Session manager
  48638. * @param _options optional configuration for this canvas output. defaults will be used if not provided
  48639. */
  48640. constructor(_xrSessionManager: WebXRSessionManager, _options?: WebXRManagedOutputCanvasOptions);
  48641. /**
  48642. * Disposes of the object
  48643. */
  48644. dispose(): void;
  48645. /**
  48646. * Initializes the xr layer for the session
  48647. * @param xrSession xr session
  48648. * @returns a promise that will resolve once the XR Layer has been created
  48649. */
  48650. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  48651. private _addCanvas;
  48652. private _removeCanvas;
  48653. private _setCanvasSize;
  48654. private _setManagedOutputCanvas;
  48655. }
  48656. }
  48657. declare module "babylonjs/XR/webXRSessionManager" {
  48658. import { Observable } from "babylonjs/Misc/observable";
  48659. import { Nullable } from "babylonjs/types";
  48660. import { IDisposable, Scene } from "babylonjs/scene";
  48661. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  48662. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  48663. import { WebXRManagedOutputCanvasOptions } from "babylonjs/XR/webXRManagedOutputCanvas";
  48664. /**
  48665. * Manages an XRSession to work with Babylon's engine
  48666. * @see https://doc.babylonjs.com/how_to/webxr_session_manager
  48667. */
  48668. export class WebXRSessionManager implements IDisposable {
  48669. /** The scene which the session should be created for */
  48670. scene: Scene;
  48671. private _referenceSpace;
  48672. private _rttProvider;
  48673. private _sessionEnded;
  48674. private _xrNavigator;
  48675. private baseLayer;
  48676. /**
  48677. * The base reference space from which the session started. good if you want to reset your
  48678. * reference space
  48679. */
  48680. baseReferenceSpace: XRReferenceSpace;
  48681. /**
  48682. * Current XR frame
  48683. */
  48684. currentFrame: Nullable<XRFrame>;
  48685. /** WebXR timestamp updated every frame */
  48686. currentTimestamp: number;
  48687. /**
  48688. * Used just in case of a failure to initialize an immersive session.
  48689. * The viewer reference space is compensated using this height, creating a kind of "viewer-floor" reference space
  48690. */
  48691. defaultHeightCompensation: number;
  48692. /**
  48693. * Fires every time a new xrFrame arrives which can be used to update the camera
  48694. */
  48695. onXRFrameObservable: Observable<XRFrame>;
  48696. /**
  48697. * Fires when the reference space changed
  48698. */
  48699. onXRReferenceSpaceChanged: Observable<XRReferenceSpace>;
  48700. /**
  48701. * Fires when the xr session is ended either by the device or manually done
  48702. */
  48703. onXRSessionEnded: Observable<any>;
  48704. /**
  48705. * Fires when the xr session is ended either by the device or manually done
  48706. */
  48707. onXRSessionInit: Observable<XRSession>;
  48708. /**
  48709. * Underlying xr session
  48710. */
  48711. session: XRSession;
  48712. /**
  48713. * The viewer (head position) reference space. This can be used to get the XR world coordinates
  48714. * or get the offset the player is currently at.
  48715. */
  48716. viewerReferenceSpace: XRReferenceSpace;
  48717. /**
  48718. * Constructs a WebXRSessionManager, this must be initialized within a user action before usage
  48719. * @param scene The scene which the session should be created for
  48720. */
  48721. constructor(
  48722. /** The scene which the session should be created for */
  48723. scene: Scene);
  48724. /**
  48725. * The current reference space used in this session. This reference space can constantly change!
  48726. * It is mainly used to offset the camera's position.
  48727. */
  48728. get referenceSpace(): XRReferenceSpace;
  48729. /**
  48730. * Set a new reference space and triggers the observable
  48731. */
  48732. set referenceSpace(newReferenceSpace: XRReferenceSpace);
  48733. /**
  48734. * Disposes of the session manager
  48735. */
  48736. dispose(): void;
  48737. /**
  48738. * Stops the xrSession and restores the render loop
  48739. * @returns Promise which resolves after it exits XR
  48740. */
  48741. exitXRAsync(): Promise<void>;
  48742. /**
  48743. * Gets the correct render target texture to be rendered this frame for this eye
  48744. * @param eye the eye for which to get the render target
  48745. * @returns the render target for the specified eye
  48746. */
  48747. getRenderTargetTextureForEye(eye: XREye): RenderTargetTexture;
  48748. /**
  48749. * Creates a WebXRRenderTarget object for the XR session
  48750. * @param onStateChangedObservable optional, mechanism for enabling/disabling XR rendering canvas, used only on Web
  48751. * @param options optional options to provide when creating a new render target
  48752. * @returns a WebXR render target to which the session can render
  48753. */
  48754. getWebXRRenderTarget(options?: WebXRManagedOutputCanvasOptions): WebXRRenderTarget;
  48755. /**
  48756. * Initializes the manager
  48757. * After initialization enterXR can be called to start an XR session
  48758. * @returns Promise which resolves after it is initialized
  48759. */
  48760. initializeAsync(): Promise<void>;
  48761. /**
  48762. * Initializes an xr session
  48763. * @param xrSessionMode mode to initialize
  48764. * @param xrSessionInit defines optional and required values to pass to the session builder
  48765. * @returns a promise which will resolve once the session has been initialized
  48766. */
  48767. initializeSessionAsync(xrSessionMode?: XRSessionMode, xrSessionInit?: XRSessionInit): Promise<XRSession>;
  48768. /**
  48769. * Checks if a session would be supported for the creation options specified
  48770. * @param sessionMode session mode to check if supported eg. immersive-vr
  48771. * @returns A Promise that resolves to true if supported and false if not
  48772. */
  48773. isSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  48774. /**
  48775. * Resets the reference space to the one started the session
  48776. */
  48777. resetReferenceSpace(): void;
  48778. /**
  48779. * Starts rendering to the xr layer
  48780. */
  48781. runXRRenderLoop(): void;
  48782. /**
  48783. * Sets the reference space on the xr session
  48784. * @param referenceSpaceType space to set
  48785. * @returns a promise that will resolve once the reference space has been set
  48786. */
  48787. setReferenceSpaceTypeAsync(referenceSpaceType?: XRReferenceSpaceType): Promise<XRReferenceSpace>;
  48788. /**
  48789. * Updates the render state of the session
  48790. * @param state state to set
  48791. * @returns a promise that resolves once the render state has been updated
  48792. */
  48793. updateRenderStateAsync(state: XRRenderState): Promise<void>;
  48794. /**
  48795. * Returns a promise that resolves with a boolean indicating if the provided session mode is supported by this browser
  48796. * @param sessionMode defines the session to test
  48797. * @returns a promise with boolean as final value
  48798. */
  48799. static IsSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  48800. private _createRenderTargetTexture;
  48801. }
  48802. }
  48803. declare module "babylonjs/XR/webXRCamera" {
  48804. import { Vector3 } from "babylonjs/Maths/math.vector";
  48805. import { Scene } from "babylonjs/scene";
  48806. import { Camera } from "babylonjs/Cameras/camera";
  48807. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  48808. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  48809. import { Observable } from "babylonjs/Misc/observable";
  48810. /**
  48811. * WebXR Camera which holds the views for the xrSession
  48812. * @see https://doc.babylonjs.com/how_to/webxr_camera
  48813. */
  48814. export class WebXRCamera extends FreeCamera {
  48815. private _xrSessionManager;
  48816. private _firstFrame;
  48817. private _referenceQuaternion;
  48818. private _referencedPosition;
  48819. private _xrInvPositionCache;
  48820. private _xrInvQuaternionCache;
  48821. /**
  48822. * Observable raised before camera teleportation
  48823. */
  48824. onBeforeCameraTeleport: Observable<Vector3>;
  48825. /**
  48826. * Observable raised after camera teleportation
  48827. */
  48828. onAfterCameraTeleport: Observable<Vector3>;
  48829. /**
  48830. * Should position compensation execute on first frame.
  48831. * This is used when copying the position from a native (non XR) camera
  48832. */
  48833. compensateOnFirstFrame: boolean;
  48834. /**
  48835. * Creates a new webXRCamera, this should only be set at the camera after it has been updated by the xrSessionManager
  48836. * @param name the name of the camera
  48837. * @param scene the scene to add the camera to
  48838. * @param _xrSessionManager a constructed xr session manager
  48839. */
  48840. constructor(name: string, scene: Scene, _xrSessionManager: WebXRSessionManager);
  48841. /**
  48842. * Return the user's height, unrelated to the current ground.
  48843. * This will be the y position of this camera, when ground level is 0.
  48844. */
  48845. get realWorldHeight(): number;
  48846. /** @hidden */
  48847. _updateForDualEyeDebugging(): void;
  48848. /**
  48849. * Sets this camera's transformation based on a non-vr camera
  48850. * @param otherCamera the non-vr camera to copy the transformation from
  48851. * @param resetToBaseReferenceSpace should XR reset to the base reference space
  48852. */
  48853. setTransformationFromNonVRCamera(otherCamera?: Camera, resetToBaseReferenceSpace?: boolean): void;
  48854. /**
  48855. * Gets the current instance class name ("WebXRCamera").
  48856. * @returns the class name
  48857. */
  48858. getClassName(): string;
  48859. private _rotate180;
  48860. private _updateFromXRSession;
  48861. private _updateNumberOfRigCameras;
  48862. private _updateReferenceSpace;
  48863. private _updateReferenceSpaceOffset;
  48864. }
  48865. }
  48866. declare module "babylonjs/XR/webXRFeaturesManager" {
  48867. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  48868. import { IDisposable } from "babylonjs/scene";
  48869. /**
  48870. * Defining the interface required for a (webxr) feature
  48871. */
  48872. export interface IWebXRFeature extends IDisposable {
  48873. /**
  48874. * Is this feature attached
  48875. */
  48876. attached: boolean;
  48877. /**
  48878. * Should auto-attach be disabled?
  48879. */
  48880. disableAutoAttach: boolean;
  48881. /**
  48882. * Attach the feature to the session
  48883. * Will usually be called by the features manager
  48884. *
  48885. * @param force should attachment be forced (even when already attached)
  48886. * @returns true if successful.
  48887. */
  48888. attach(force?: boolean): boolean;
  48889. /**
  48890. * Detach the feature from the session
  48891. * Will usually be called by the features manager
  48892. *
  48893. * @returns true if successful.
  48894. */
  48895. detach(): boolean;
  48896. /**
  48897. * This function will be executed during before enabling the feature and can be used to not-allow enabling it.
  48898. * Note that at this point the session has NOT started, so this is purely checking if the browser supports it
  48899. *
  48900. * @returns whether or not the feature is compatible in this environment
  48901. */
  48902. isCompatible(): boolean;
  48903. /**
  48904. * The name of the native xr feature name, if applicable (like anchor, hit-test, or hand-tracking)
  48905. */
  48906. xrNativeFeatureName?: string;
  48907. /**
  48908. * A list of (Babylon WebXR) features this feature depends on
  48909. */
  48910. dependsOn?: string[];
  48911. }
  48912. /**
  48913. * A list of the currently available features without referencing them
  48914. */
  48915. export class WebXRFeatureName {
  48916. /**
  48917. * The name of the anchor system feature
  48918. */
  48919. static readonly ANCHOR_SYSTEM: string;
  48920. /**
  48921. * The name of the background remover feature
  48922. */
  48923. static readonly BACKGROUND_REMOVER: string;
  48924. /**
  48925. * The name of the hit test feature
  48926. */
  48927. static readonly HIT_TEST: string;
  48928. /**
  48929. * physics impostors for xr controllers feature
  48930. */
  48931. static readonly PHYSICS_CONTROLLERS: string;
  48932. /**
  48933. * The name of the plane detection feature
  48934. */
  48935. static readonly PLANE_DETECTION: string;
  48936. /**
  48937. * The name of the pointer selection feature
  48938. */
  48939. static readonly POINTER_SELECTION: string;
  48940. /**
  48941. * The name of the teleportation feature
  48942. */
  48943. static readonly TELEPORTATION: string;
  48944. /**
  48945. * The name of the feature points feature.
  48946. */
  48947. static readonly FEATURE_POINTS: string;
  48948. /**
  48949. * The name of the hand tracking feature.
  48950. */
  48951. static readonly HAND_TRACKING: string;
  48952. }
  48953. /**
  48954. * Defining the constructor of a feature. Used to register the modules.
  48955. */
  48956. export type WebXRFeatureConstructor = (xrSessionManager: WebXRSessionManager, options?: any) => () => IWebXRFeature;
  48957. /**
  48958. * The WebXR features manager is responsible of enabling or disabling features required for the current XR session.
  48959. * It is mainly used in AR sessions.
  48960. *
  48961. * A feature can have a version that is defined by Babylon (and does not correspond with the webxr version).
  48962. */
  48963. export class WebXRFeaturesManager implements IDisposable {
  48964. private _xrSessionManager;
  48965. private static readonly _AvailableFeatures;
  48966. private _features;
  48967. /**
  48968. * constructs a new features manages.
  48969. *
  48970. * @param _xrSessionManager an instance of WebXRSessionManager
  48971. */
  48972. constructor(_xrSessionManager: WebXRSessionManager);
  48973. /**
  48974. * Used to register a module. After calling this function a developer can use this feature in the scene.
  48975. * Mainly used internally.
  48976. *
  48977. * @param featureName the name of the feature to register
  48978. * @param constructorFunction the function used to construct the module
  48979. * @param version the (babylon) version of the module
  48980. * @param stable is that a stable version of this module
  48981. */
  48982. static AddWebXRFeature(featureName: string, constructorFunction: WebXRFeatureConstructor, version?: number, stable?: boolean): void;
  48983. /**
  48984. * Returns a constructor of a specific feature.
  48985. *
  48986. * @param featureName the name of the feature to construct
  48987. * @param version the version of the feature to load
  48988. * @param xrSessionManager the xrSessionManager. Used to construct the module
  48989. * @param options optional options provided to the module.
  48990. * @returns a function that, when called, will return a new instance of this feature
  48991. */
  48992. static ConstructFeature(featureName: string, version: number | undefined, xrSessionManager: WebXRSessionManager, options?: any): () => IWebXRFeature;
  48993. /**
  48994. * Can be used to return the list of features currently registered
  48995. *
  48996. * @returns an Array of available features
  48997. */
  48998. static GetAvailableFeatures(): string[];
  48999. /**
  49000. * Gets the versions available for a specific feature
  49001. * @param featureName the name of the feature
  49002. * @returns an array with the available versions
  49003. */
  49004. static GetAvailableVersions(featureName: string): string[];
  49005. /**
  49006. * Return the latest unstable version of this feature
  49007. * @param featureName the name of the feature to search
  49008. * @returns the version number. if not found will return -1
  49009. */
  49010. static GetLatestVersionOfFeature(featureName: string): number;
  49011. /**
  49012. * Return the latest stable version of this feature
  49013. * @param featureName the name of the feature to search
  49014. * @returns the version number. if not found will return -1
  49015. */
  49016. static GetStableVersionOfFeature(featureName: string): number;
  49017. /**
  49018. * Attach a feature to the current session. Mainly used when session started to start the feature effect.
  49019. * Can be used during a session to start a feature
  49020. * @param featureName the name of feature to attach
  49021. */
  49022. attachFeature(featureName: string): void;
  49023. /**
  49024. * Can be used inside a session or when the session ends to detach a specific feature
  49025. * @param featureName the name of the feature to detach
  49026. */
  49027. detachFeature(featureName: string): void;
  49028. /**
  49029. * Used to disable an already-enabled feature
  49030. * The feature will be disposed and will be recreated once enabled.
  49031. * @param featureName the feature to disable
  49032. * @returns true if disable was successful
  49033. */
  49034. disableFeature(featureName: string | {
  49035. Name: string;
  49036. }): boolean;
  49037. /**
  49038. * dispose this features manager
  49039. */
  49040. dispose(): void;
  49041. /**
  49042. * 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.
  49043. * 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.
  49044. *
  49045. * @param featureName the name of the feature to load or the class of the feature
  49046. * @param version optional version to load. if not provided the latest version will be enabled
  49047. * @param moduleOptions options provided to the module. Ses the module documentation / constructor
  49048. * @param attachIfPossible if set to true (default) the feature will be automatically attached, if it is currently possible
  49049. * @param required is this feature required to the app. If set to true the session init will fail if the feature is not available.
  49050. * @returns a new constructed feature or throws an error if feature not found.
  49051. */
  49052. enableFeature(featureName: string | {
  49053. Name: string;
  49054. }, version?: number | string, moduleOptions?: any, attachIfPossible?: boolean, required?: boolean): IWebXRFeature;
  49055. /**
  49056. * get the implementation of an enabled feature.
  49057. * @param featureName the name of the feature to load
  49058. * @returns the feature class, if found
  49059. */
  49060. getEnabledFeature(featureName: string): IWebXRFeature;
  49061. /**
  49062. * Get the list of enabled features
  49063. * @returns an array of enabled features
  49064. */
  49065. getEnabledFeatures(): string[];
  49066. /**
  49067. * This function will exten the session creation configuration object with enabled features.
  49068. * If, for example, the anchors feature is enabled, it will be automatically added to the optional or required features list,
  49069. * according to the defined "required" variable, provided during enableFeature call
  49070. * @param xrSessionInit the xr Session init object to extend
  49071. *
  49072. * @returns an extended XRSessionInit object
  49073. */
  49074. extendXRSessionInitObject(xrSessionInit: XRSessionInit): XRSessionInit;
  49075. }
  49076. }
  49077. declare module "babylonjs/XR/webXRExperienceHelper" {
  49078. import { Observable } from "babylonjs/Misc/observable";
  49079. import { IDisposable, Scene } from "babylonjs/scene";
  49080. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  49081. import { WebXRCamera } from "babylonjs/XR/webXRCamera";
  49082. import { WebXRState, WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  49083. import { WebXRFeaturesManager } from "babylonjs/XR/webXRFeaturesManager";
  49084. /**
  49085. * Base set of functionality needed to create an XR experience (WebXRSessionManager, Camera, StateManagement, etc.)
  49086. * @see https://doc.babylonjs.com/how_to/webxr_experience_helpers
  49087. */
  49088. export class WebXRExperienceHelper implements IDisposable {
  49089. private scene;
  49090. private _nonVRCamera;
  49091. private _originalSceneAutoClear;
  49092. private _supported;
  49093. /**
  49094. * Camera used to render xr content
  49095. */
  49096. camera: WebXRCamera;
  49097. /** A features manager for this xr session */
  49098. featuresManager: WebXRFeaturesManager;
  49099. /**
  49100. * Observers registered here will be triggered after the camera's initial transformation is set
  49101. * This can be used to set a different ground level or an extra rotation.
  49102. *
  49103. * Note that ground level is considered to be at 0. The height defined by the XR camera will be added
  49104. * to the position set after this observable is done executing.
  49105. */
  49106. onInitialXRPoseSetObservable: Observable<WebXRCamera>;
  49107. /**
  49108. * Fires when the state of the experience helper has changed
  49109. */
  49110. onStateChangedObservable: Observable<WebXRState>;
  49111. /** Session manager used to keep track of xr session */
  49112. sessionManager: WebXRSessionManager;
  49113. /**
  49114. * The current state of the XR experience (eg. transitioning, in XR or not in XR)
  49115. */
  49116. state: WebXRState;
  49117. /**
  49118. * Creates a WebXRExperienceHelper
  49119. * @param scene The scene the helper should be created in
  49120. */
  49121. private constructor();
  49122. /**
  49123. * Creates the experience helper
  49124. * @param scene the scene to attach the experience helper to
  49125. * @returns a promise for the experience helper
  49126. */
  49127. static CreateAsync(scene: Scene): Promise<WebXRExperienceHelper>;
  49128. /**
  49129. * Disposes of the experience helper
  49130. */
  49131. dispose(): void;
  49132. /**
  49133. * Enters XR mode (This must be done within a user interaction in most browsers eg. button click)
  49134. * @param sessionMode options for the XR session
  49135. * @param referenceSpaceType frame of reference of the XR session
  49136. * @param renderTarget the output canvas that will be used to enter XR mode
  49137. * @param sessionCreationOptions optional XRSessionInit object to init the session with
  49138. * @returns promise that resolves after xr mode has entered
  49139. */
  49140. enterXRAsync(sessionMode: XRSessionMode, referenceSpaceType: XRReferenceSpaceType, renderTarget?: WebXRRenderTarget, sessionCreationOptions?: XRSessionInit): Promise<WebXRSessionManager>;
  49141. /**
  49142. * Exits XR mode and returns the scene to its original state
  49143. * @returns promise that resolves after xr mode has exited
  49144. */
  49145. exitXRAsync(): Promise<void>;
  49146. private _nonXRToXRCamera;
  49147. private _setState;
  49148. }
  49149. }
  49150. declare module "babylonjs/XR/motionController/webXRControllerComponent" {
  49151. import { IMinimalMotionControllerObject, MotionControllerComponentType } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  49152. import { Observable } from "babylonjs/Misc/observable";
  49153. import { IDisposable } from "babylonjs/scene";
  49154. /**
  49155. * X-Y values for axes in WebXR
  49156. */
  49157. export interface IWebXRMotionControllerAxesValue {
  49158. /**
  49159. * The value of the x axis
  49160. */
  49161. x: number;
  49162. /**
  49163. * The value of the y-axis
  49164. */
  49165. y: number;
  49166. }
  49167. /**
  49168. * changed / previous values for the values of this component
  49169. */
  49170. export interface IWebXRMotionControllerComponentChangesValues<T> {
  49171. /**
  49172. * current (this frame) value
  49173. */
  49174. current: T;
  49175. /**
  49176. * previous (last change) value
  49177. */
  49178. previous: T;
  49179. }
  49180. /**
  49181. * Represents changes in the component between current frame and last values recorded
  49182. */
  49183. export interface IWebXRMotionControllerComponentChanges {
  49184. /**
  49185. * will be populated with previous and current values if axes changed
  49186. */
  49187. axes?: IWebXRMotionControllerComponentChangesValues<IWebXRMotionControllerAxesValue>;
  49188. /**
  49189. * will be populated with previous and current values if pressed changed
  49190. */
  49191. pressed?: IWebXRMotionControllerComponentChangesValues<boolean>;
  49192. /**
  49193. * will be populated with previous and current values if touched changed
  49194. */
  49195. touched?: IWebXRMotionControllerComponentChangesValues<boolean>;
  49196. /**
  49197. * will be populated with previous and current values if value changed
  49198. */
  49199. value?: IWebXRMotionControllerComponentChangesValues<number>;
  49200. }
  49201. /**
  49202. * This class represents a single component (for example button or thumbstick) of a motion controller
  49203. */
  49204. export class WebXRControllerComponent implements IDisposable {
  49205. /**
  49206. * the id of this component
  49207. */
  49208. id: string;
  49209. /**
  49210. * the type of the component
  49211. */
  49212. type: MotionControllerComponentType;
  49213. private _buttonIndex;
  49214. private _axesIndices;
  49215. private _axes;
  49216. private _changes;
  49217. private _currentValue;
  49218. private _hasChanges;
  49219. private _pressed;
  49220. private _touched;
  49221. /**
  49222. * button component type
  49223. */
  49224. static BUTTON_TYPE: MotionControllerComponentType;
  49225. /**
  49226. * squeeze component type
  49227. */
  49228. static SQUEEZE_TYPE: MotionControllerComponentType;
  49229. /**
  49230. * Thumbstick component type
  49231. */
  49232. static THUMBSTICK_TYPE: MotionControllerComponentType;
  49233. /**
  49234. * Touchpad component type
  49235. */
  49236. static TOUCHPAD_TYPE: MotionControllerComponentType;
  49237. /**
  49238. * trigger component type
  49239. */
  49240. static TRIGGER_TYPE: MotionControllerComponentType;
  49241. /**
  49242. * If axes are available for this component (like a touchpad or thumbstick) the observers will be notified when
  49243. * the axes data changes
  49244. */
  49245. onAxisValueChangedObservable: Observable<{
  49246. x: number;
  49247. y: number;
  49248. }>;
  49249. /**
  49250. * Observers registered here will be triggered when the state of a button changes
  49251. * State change is either pressed / touched / value
  49252. */
  49253. onButtonStateChangedObservable: Observable<WebXRControllerComponent>;
  49254. /**
  49255. * Creates a new component for a motion controller.
  49256. * It is created by the motion controller itself
  49257. *
  49258. * @param id the id of this component
  49259. * @param type the type of the component
  49260. * @param _buttonIndex index in the buttons array of the gamepad
  49261. * @param _axesIndices indices of the values in the axes array of the gamepad
  49262. */
  49263. constructor(
  49264. /**
  49265. * the id of this component
  49266. */
  49267. id: string,
  49268. /**
  49269. * the type of the component
  49270. */
  49271. type: MotionControllerComponentType, _buttonIndex?: number, _axesIndices?: number[]);
  49272. /**
  49273. * The current axes data. If this component has no axes it will still return an object { x: 0, y: 0 }
  49274. */
  49275. get axes(): IWebXRMotionControllerAxesValue;
  49276. /**
  49277. * Get the changes. Elements will be populated only if they changed with their previous and current value
  49278. */
  49279. get changes(): IWebXRMotionControllerComponentChanges;
  49280. /**
  49281. * Return whether or not the component changed the last frame
  49282. */
  49283. get hasChanges(): boolean;
  49284. /**
  49285. * is the button currently pressed
  49286. */
  49287. get pressed(): boolean;
  49288. /**
  49289. * is the button currently touched
  49290. */
  49291. get touched(): boolean;
  49292. /**
  49293. * Get the current value of this component
  49294. */
  49295. get value(): number;
  49296. /**
  49297. * Dispose this component
  49298. */
  49299. dispose(): void;
  49300. /**
  49301. * Are there axes correlating to this component
  49302. * @return true is axes data is available
  49303. */
  49304. isAxes(): boolean;
  49305. /**
  49306. * Is this component a button (hence - pressable)
  49307. * @returns true if can be pressed
  49308. */
  49309. isButton(): boolean;
  49310. /**
  49311. * update this component using the gamepad object it is in. Called on every frame
  49312. * @param nativeController the native gamepad controller object
  49313. */
  49314. update(nativeController: IMinimalMotionControllerObject): void;
  49315. }
  49316. }
  49317. declare module "babylonjs/Loading/sceneLoader" {
  49318. import { Observable } from "babylonjs/Misc/observable";
  49319. import { Nullable } from "babylonjs/types";
  49320. import { Scene } from "babylonjs/scene";
  49321. import { Engine } from "babylonjs/Engines/engine";
  49322. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  49323. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  49324. import { AssetContainer } from "babylonjs/assetContainer";
  49325. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  49326. import { Skeleton } from "babylonjs/Bones/skeleton";
  49327. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  49328. import { WebRequest } from "babylonjs/Misc/webRequest";
  49329. /**
  49330. * Interface used to represent data loading progression
  49331. */
  49332. export interface ISceneLoaderProgressEvent {
  49333. /**
  49334. * Defines if data length to load can be evaluated
  49335. */
  49336. readonly lengthComputable: boolean;
  49337. /**
  49338. * Defines the loaded data length
  49339. */
  49340. readonly loaded: number;
  49341. /**
  49342. * Defines the data length to load
  49343. */
  49344. readonly total: number;
  49345. }
  49346. /**
  49347. * Interface used by SceneLoader plugins to define supported file extensions
  49348. */
  49349. export interface ISceneLoaderPluginExtensions {
  49350. /**
  49351. * Defines the list of supported extensions
  49352. */
  49353. [extension: string]: {
  49354. isBinary: boolean;
  49355. };
  49356. }
  49357. /**
  49358. * Interface used by SceneLoader plugin factory
  49359. */
  49360. export interface ISceneLoaderPluginFactory {
  49361. /**
  49362. * Defines the name of the factory
  49363. */
  49364. name: string;
  49365. /**
  49366. * Function called to create a new plugin
  49367. * @return the new plugin
  49368. */
  49369. createPlugin(): ISceneLoaderPlugin | ISceneLoaderPluginAsync;
  49370. /**
  49371. * The callback that returns true if the data can be directly loaded.
  49372. * @param data string containing the file data
  49373. * @returns if the data can be loaded directly
  49374. */
  49375. canDirectLoad?(data: string): boolean;
  49376. }
  49377. /**
  49378. * Interface used to define the base of ISceneLoaderPlugin and ISceneLoaderPluginAsync
  49379. */
  49380. export interface ISceneLoaderPluginBase {
  49381. /**
  49382. * The friendly name of this plugin.
  49383. */
  49384. name: string;
  49385. /**
  49386. * The file extensions supported by this plugin.
  49387. */
  49388. extensions: string | ISceneLoaderPluginExtensions;
  49389. /**
  49390. * The callback called when loading from a url.
  49391. * @param scene scene loading this url
  49392. * @param url url to load
  49393. * @param onSuccess callback called when the file successfully loads
  49394. * @param onProgress callback called while file is loading (if the server supports this mode)
  49395. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  49396. * @param onError callback called when the file fails to load
  49397. * @returns a file request object
  49398. */
  49399. requestFile?(scene: Scene, url: string, onSuccess: (data: any, request?: WebRequest) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => void, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  49400. /**
  49401. * The callback called when loading from a file object.
  49402. * @param scene scene loading this file
  49403. * @param file defines the file to load
  49404. * @param onSuccess defines the callback to call when data is loaded
  49405. * @param onProgress defines the callback to call during loading process
  49406. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  49407. * @param onError defines the callback to call when an error occurs
  49408. * @returns a file request object
  49409. */
  49410. readFile?(scene: Scene, file: File, onSuccess: (data: any) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  49411. /**
  49412. * The callback that returns true if the data can be directly loaded.
  49413. * @param data string containing the file data
  49414. * @returns if the data can be loaded directly
  49415. */
  49416. canDirectLoad?(data: string): boolean;
  49417. /**
  49418. * The callback that returns the data to pass to the plugin if the data can be directly loaded.
  49419. * @param scene scene loading this data
  49420. * @param data string containing the data
  49421. * @returns data to pass to the plugin
  49422. */
  49423. directLoad?(scene: Scene, data: string): any;
  49424. /**
  49425. * The callback that allows custom handling of the root url based on the response url.
  49426. * @param rootUrl the original root url
  49427. * @param responseURL the response url if available
  49428. * @returns the new root url
  49429. */
  49430. rewriteRootURL?(rootUrl: string, responseURL?: string): string;
  49431. }
  49432. /**
  49433. * Interface used to define a SceneLoader plugin
  49434. */
  49435. export interface ISceneLoaderPlugin extends ISceneLoaderPluginBase {
  49436. /**
  49437. * Import meshes into a scene.
  49438. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  49439. * @param scene The scene to import into
  49440. * @param data The data to import
  49441. * @param rootUrl The root url for scene and resources
  49442. * @param meshes The meshes array to import into
  49443. * @param particleSystems The particle systems array to import into
  49444. * @param skeletons The skeletons array to import into
  49445. * @param onError The callback when import fails
  49446. * @returns True if successful or false otherwise
  49447. */
  49448. importMesh(meshesNames: any, scene: Scene, data: any, rootUrl: string, meshes: AbstractMesh[], particleSystems: IParticleSystem[], skeletons: Skeleton[], onError?: (message: string, exception?: any) => void): boolean;
  49449. /**
  49450. * Load into a scene.
  49451. * @param scene The scene to load into
  49452. * @param data The data to import
  49453. * @param rootUrl The root url for scene and resources
  49454. * @param onError The callback when import fails
  49455. * @returns True if successful or false otherwise
  49456. */
  49457. load(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): boolean;
  49458. /**
  49459. * Load into an asset container.
  49460. * @param scene The scene to load into
  49461. * @param data The data to import
  49462. * @param rootUrl The root url for scene and resources
  49463. * @param onError The callback when import fails
  49464. * @returns The loaded asset container
  49465. */
  49466. loadAssetContainer(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): AssetContainer;
  49467. }
  49468. /**
  49469. * Interface used to define an async SceneLoader plugin
  49470. */
  49471. export interface ISceneLoaderPluginAsync extends ISceneLoaderPluginBase {
  49472. /**
  49473. * Import meshes into a scene.
  49474. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  49475. * @param scene The scene to import into
  49476. * @param data The data to import
  49477. * @param rootUrl The root url for scene and resources
  49478. * @param onProgress The callback when the load progresses
  49479. * @param fileName Defines the name of the file to load
  49480. * @returns The loaded meshes, particle systems, skeletons, and animation groups
  49481. */
  49482. importMeshAsync(meshesNames: any, scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<{
  49483. meshes: AbstractMesh[];
  49484. particleSystems: IParticleSystem[];
  49485. skeletons: Skeleton[];
  49486. animationGroups: AnimationGroup[];
  49487. }>;
  49488. /**
  49489. * Load into a scene.
  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 Nothing
  49496. */
  49497. loadAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<void>;
  49498. /**
  49499. * Load into an asset container.
  49500. * @param scene The scene to load into
  49501. * @param data The data to import
  49502. * @param rootUrl The root url for scene and resources
  49503. * @param onProgress The callback when the load progresses
  49504. * @param fileName Defines the name of the file to load
  49505. * @returns The loaded asset container
  49506. */
  49507. loadAssetContainerAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<AssetContainer>;
  49508. }
  49509. /**
  49510. * Mode that determines how to handle old animation groups before loading new ones.
  49511. */
  49512. export enum SceneLoaderAnimationGroupLoadingMode {
  49513. /**
  49514. * Reset all old animations to initial state then dispose them.
  49515. */
  49516. Clean = 0,
  49517. /**
  49518. * Stop all old animations.
  49519. */
  49520. Stop = 1,
  49521. /**
  49522. * Restart old animations from first frame.
  49523. */
  49524. Sync = 2,
  49525. /**
  49526. * Old animations remains untouched.
  49527. */
  49528. NoSync = 3
  49529. }
  49530. /**
  49531. * Defines a plugin registered by the SceneLoader
  49532. */
  49533. interface IRegisteredPlugin {
  49534. /**
  49535. * Defines the plugin to use
  49536. */
  49537. plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  49538. /**
  49539. * Defines if the plugin supports binary data
  49540. */
  49541. isBinary: boolean;
  49542. }
  49543. /**
  49544. * Class used to load scene from various file formats using registered plugins
  49545. * @see https://doc.babylonjs.com/how_to/load_from_any_file_type
  49546. */
  49547. export class SceneLoader {
  49548. /**
  49549. * No logging while loading
  49550. */
  49551. static readonly NO_LOGGING: number;
  49552. /**
  49553. * Minimal logging while loading
  49554. */
  49555. static readonly MINIMAL_LOGGING: number;
  49556. /**
  49557. * Summary logging while loading
  49558. */
  49559. static readonly SUMMARY_LOGGING: number;
  49560. /**
  49561. * Detailled logging while loading
  49562. */
  49563. static readonly DETAILED_LOGGING: number;
  49564. /**
  49565. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  49566. */
  49567. static get ForceFullSceneLoadingForIncremental(): boolean;
  49568. static set ForceFullSceneLoadingForIncremental(value: boolean);
  49569. /**
  49570. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  49571. */
  49572. static get ShowLoadingScreen(): boolean;
  49573. static set ShowLoadingScreen(value: boolean);
  49574. /**
  49575. * Defines the current logging level (while loading the scene)
  49576. * @ignorenaming
  49577. */
  49578. static get loggingLevel(): number;
  49579. static set loggingLevel(value: number);
  49580. /**
  49581. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  49582. */
  49583. static get CleanBoneMatrixWeights(): boolean;
  49584. static set CleanBoneMatrixWeights(value: boolean);
  49585. /**
  49586. * Event raised when a plugin is used to load a scene
  49587. */
  49588. static OnPluginActivatedObservable: Observable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  49589. private static _registeredPlugins;
  49590. private static _showingLoadingScreen;
  49591. /**
  49592. * Gets the default plugin (used to load Babylon files)
  49593. * @returns the .babylon plugin
  49594. */
  49595. static GetDefaultPlugin(): IRegisteredPlugin;
  49596. private static _GetPluginForExtension;
  49597. private static _GetPluginForDirectLoad;
  49598. private static _GetPluginForFilename;
  49599. private static _GetDirectLoad;
  49600. private static _LoadData;
  49601. private static _GetFileInfo;
  49602. /**
  49603. * Gets a plugin that can load the given extension
  49604. * @param extension defines the extension to load
  49605. * @returns a plugin or null if none works
  49606. */
  49607. static GetPluginForExtension(extension: string): ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  49608. /**
  49609. * Gets a boolean indicating that the given extension can be loaded
  49610. * @param extension defines the extension to load
  49611. * @returns true if the extension is supported
  49612. */
  49613. static IsPluginForExtensionAvailable(extension: string): boolean;
  49614. /**
  49615. * Adds a new plugin to the list of registered plugins
  49616. * @param plugin defines the plugin to add
  49617. */
  49618. static RegisterPlugin(plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync): void;
  49619. /**
  49620. * Import meshes into a scene
  49621. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  49622. * @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)
  49623. * @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)
  49624. * @param scene the instance of BABYLON.Scene to append to
  49625. * @param onSuccess a callback with a list of imported meshes, particleSystems, and skeletons when import succeeds
  49626. * @param onProgress a callback with a progress event for each file being loaded
  49627. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49628. * @param pluginExtension the extension used to determine the plugin
  49629. * @returns The loaded plugin
  49630. */
  49631. 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>;
  49632. /**
  49633. * Import meshes into a scene
  49634. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  49635. * @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)
  49636. * @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)
  49637. * @param scene the instance of BABYLON.Scene to append to
  49638. * @param onProgress a callback with a progress event for each file being loaded
  49639. * @param pluginExtension the extension used to determine the plugin
  49640. * @returns The loaded list of imported meshes, particle systems, skeletons, and animation groups
  49641. */
  49642. static ImportMeshAsync(meshNames: any, rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<{
  49643. meshes: AbstractMesh[];
  49644. particleSystems: IParticleSystem[];
  49645. skeletons: Skeleton[];
  49646. animationGroups: AnimationGroup[];
  49647. }>;
  49648. /**
  49649. * Load a scene
  49650. * @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)
  49651. * @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)
  49652. * @param engine is the instance of BABYLON.Engine to use to create the scene
  49653. * @param onSuccess a callback with the scene when import succeeds
  49654. * @param onProgress a callback with a progress event for each file being loaded
  49655. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49656. * @param pluginExtension the extension used to determine the plugin
  49657. * @returns The loaded plugin
  49658. */
  49659. 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>;
  49660. /**
  49661. * Load 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 engine is the instance of BABYLON.Engine to use to create the scene
  49665. * @param onProgress a callback with a progress event for each file being loaded
  49666. * @param pluginExtension the extension used to determine the plugin
  49667. * @returns The loaded scene
  49668. */
  49669. static LoadAsync(rootUrl: string, sceneFilename?: string | File, engine?: Nullable<Engine>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  49670. /**
  49671. * Append a scene
  49672. * @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)
  49673. * @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)
  49674. * @param scene is the instance of BABYLON.Scene to append to
  49675. * @param onSuccess a callback with the scene when import succeeds
  49676. * @param onProgress a callback with a progress event for each file being loaded
  49677. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49678. * @param pluginExtension the extension used to determine the plugin
  49679. * @returns The loaded plugin
  49680. */
  49681. 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>;
  49682. /**
  49683. * Append a scene
  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
  49687. * @param onProgress a callback with a progress event for each file being loaded
  49688. * @param pluginExtension the extension used to determine the plugin
  49689. * @returns The given scene
  49690. */
  49691. static AppendAsync(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  49692. /**
  49693. * Load a scene into an asset container
  49694. * @param rootUrl a string that defines the root url for the scene and resources or the concatenation of rootURL and filename (e.g. http://example.com/test.glb)
  49695. * @param sceneFilename a string that defines the name of the scene file or starts with "data:" following by the stringified version of the scene or a File object (default: empty string)
  49696. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  49697. * @param onSuccess a callback with the scene when import succeeds
  49698. * @param onProgress a callback with a progress event for each file being loaded
  49699. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49700. * @param pluginExtension the extension used to determine the plugin
  49701. * @returns The loaded plugin
  49702. */
  49703. 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>;
  49704. /**
  49705. * Load a scene into an asset container
  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 (default: empty string)
  49708. * @param scene is the instance of Scene to append to
  49709. * @param onProgress a callback with a progress event for each file being loaded
  49710. * @param pluginExtension the extension used to determine the plugin
  49711. * @returns The loaded asset container
  49712. */
  49713. static LoadAssetContainerAsync(rootUrl: string, sceneFilename?: string, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<AssetContainer>;
  49714. /**
  49715. * Import animations from a file into a scene
  49716. * @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)
  49717. * @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)
  49718. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  49719. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  49720. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  49721. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  49722. * @param onSuccess a callback with the scene when import succeeds
  49723. * @param onProgress a callback with a progress event for each file being loaded
  49724. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49725. * @param pluginExtension the extension used to determine the plugin
  49726. */
  49727. 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;
  49728. /**
  49729. * Import animations from a file into a scene
  49730. * @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)
  49731. * @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)
  49732. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  49733. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  49734. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  49735. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  49736. * @param onSuccess a callback with the scene when import succeeds
  49737. * @param onProgress a callback with a progress event for each file being loaded
  49738. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49739. * @param pluginExtension the extension used to determine the plugin
  49740. * @returns the updated scene with imported animations
  49741. */
  49742. 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>;
  49743. }
  49744. }
  49745. declare module "babylonjs/XR/motionController/webXRAbstractMotionController" {
  49746. import { IDisposable, Scene } from "babylonjs/scene";
  49747. import { WebXRControllerComponent } from "babylonjs/XR/motionController/webXRControllerComponent";
  49748. import { Observable } from "babylonjs/Misc/observable";
  49749. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  49750. import { Nullable } from "babylonjs/types";
  49751. /**
  49752. * Handedness type in xrInput profiles. These can be used to define layouts in the Layout Map.
  49753. */
  49754. export type MotionControllerHandedness = "none" | "left" | "right";
  49755. /**
  49756. * The type of components available in motion controllers.
  49757. * This is not the name of the component.
  49758. */
  49759. export type MotionControllerComponentType = "trigger" | "squeeze" | "touchpad" | "thumbstick" | "button";
  49760. /**
  49761. * The state of a controller component
  49762. */
  49763. export type MotionControllerComponentStateType = "default" | "touched" | "pressed";
  49764. /**
  49765. * The schema of motion controller layout.
  49766. * No object will be initialized using this interface
  49767. * This is used just to define the profile.
  49768. */
  49769. export interface IMotionControllerLayout {
  49770. /**
  49771. * Path to load the assets. Usually relative to the base path
  49772. */
  49773. assetPath: string;
  49774. /**
  49775. * Available components (unsorted)
  49776. */
  49777. components: {
  49778. /**
  49779. * A map of component Ids
  49780. */
  49781. [componentId: string]: {
  49782. /**
  49783. * The type of input the component outputs
  49784. */
  49785. type: MotionControllerComponentType;
  49786. /**
  49787. * The indices of this component in the gamepad object
  49788. */
  49789. gamepadIndices: {
  49790. /**
  49791. * Index of button
  49792. */
  49793. button?: number;
  49794. /**
  49795. * If available, index of x-axis
  49796. */
  49797. xAxis?: number;
  49798. /**
  49799. * If available, index of y-axis
  49800. */
  49801. yAxis?: number;
  49802. };
  49803. /**
  49804. * The mesh's root node name
  49805. */
  49806. rootNodeName: string;
  49807. /**
  49808. * Animation definitions for this model
  49809. */
  49810. visualResponses: {
  49811. [stateKey: string]: {
  49812. /**
  49813. * What property will be animated
  49814. */
  49815. componentProperty: "xAxis" | "yAxis" | "button" | "state";
  49816. /**
  49817. * What states influence this visual response
  49818. */
  49819. states: MotionControllerComponentStateType[];
  49820. /**
  49821. * Type of animation - movement or visibility
  49822. */
  49823. valueNodeProperty: "transform" | "visibility";
  49824. /**
  49825. * Base node name to move. Its position will be calculated according to the min and max nodes
  49826. */
  49827. valueNodeName?: string;
  49828. /**
  49829. * Minimum movement node
  49830. */
  49831. minNodeName?: string;
  49832. /**
  49833. * Max movement node
  49834. */
  49835. maxNodeName?: string;
  49836. };
  49837. };
  49838. /**
  49839. * If touch enabled, what is the name of node to display user feedback
  49840. */
  49841. touchPointNodeName?: string;
  49842. };
  49843. };
  49844. /**
  49845. * Is it xr standard mapping or not
  49846. */
  49847. gamepadMapping: "" | "xr-standard";
  49848. /**
  49849. * Base root node of this entire model
  49850. */
  49851. rootNodeName: string;
  49852. /**
  49853. * Defines the main button component id
  49854. */
  49855. selectComponentId: string;
  49856. }
  49857. /**
  49858. * A definition for the layout map in the input profile
  49859. */
  49860. export interface IMotionControllerLayoutMap {
  49861. /**
  49862. * Layouts with handedness type as a key
  49863. */
  49864. [handedness: string]: IMotionControllerLayout;
  49865. }
  49866. /**
  49867. * The XR Input profile schema
  49868. * Profiles can be found here:
  49869. * https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/registry/profiles
  49870. */
  49871. export interface IMotionControllerProfile {
  49872. /**
  49873. * fallback profiles for this profileId
  49874. */
  49875. fallbackProfileIds: string[];
  49876. /**
  49877. * The layout map, with handedness as key
  49878. */
  49879. layouts: IMotionControllerLayoutMap;
  49880. /**
  49881. * The id of this profile
  49882. * correlates to the profile(s) in the xrInput.profiles array
  49883. */
  49884. profileId: string;
  49885. }
  49886. /**
  49887. * A helper-interface for the 3 meshes needed for controller button animation
  49888. * The meshes are provided to the _lerpButtonTransform function to calculate the current position of the value mesh
  49889. */
  49890. export interface IMotionControllerButtonMeshMap {
  49891. /**
  49892. * the mesh that defines the pressed value mesh position.
  49893. * This is used to find the max-position of this button
  49894. */
  49895. pressedMesh: AbstractMesh;
  49896. /**
  49897. * the mesh that defines the unpressed value mesh position.
  49898. * This is used to find the min (or initial) position of this button
  49899. */
  49900. unpressedMesh: AbstractMesh;
  49901. /**
  49902. * The mesh that will be changed when value changes
  49903. */
  49904. valueMesh: AbstractMesh;
  49905. }
  49906. /**
  49907. * A helper-interface for the 3 meshes needed for controller axis animation.
  49908. * This will be expanded when touchpad animations are fully supported
  49909. * The meshes are provided to the _lerpAxisTransform function to calculate the current position of the value mesh
  49910. */
  49911. export interface IMotionControllerMeshMap {
  49912. /**
  49913. * the mesh that defines the maximum value mesh position.
  49914. */
  49915. maxMesh?: AbstractMesh;
  49916. /**
  49917. * the mesh that defines the minimum value mesh position.
  49918. */
  49919. minMesh?: AbstractMesh;
  49920. /**
  49921. * The mesh that will be changed when axis value changes
  49922. */
  49923. valueMesh?: AbstractMesh;
  49924. }
  49925. /**
  49926. * The elements needed for change-detection of the gamepad objects in motion controllers
  49927. */
  49928. export interface IMinimalMotionControllerObject {
  49929. /**
  49930. * Available axes of this controller
  49931. */
  49932. axes: number[];
  49933. /**
  49934. * An array of available buttons
  49935. */
  49936. buttons: Array<{
  49937. /**
  49938. * Value of the button/trigger
  49939. */
  49940. value: number;
  49941. /**
  49942. * If the button/trigger is currently touched
  49943. */
  49944. touched: boolean;
  49945. /**
  49946. * If the button/trigger is currently pressed
  49947. */
  49948. pressed: boolean;
  49949. }>;
  49950. /**
  49951. * EXPERIMENTAL haptic support.
  49952. */
  49953. hapticActuators?: Array<{
  49954. pulse: (value: number, duration: number) => Promise<boolean>;
  49955. }>;
  49956. }
  49957. /**
  49958. * An Abstract Motion controller
  49959. * This class receives an xrInput and a profile layout and uses those to initialize the components
  49960. * Each component has an observable to check for changes in value and state
  49961. */
  49962. export abstract class WebXRAbstractMotionController implements IDisposable {
  49963. protected scene: Scene;
  49964. protected layout: IMotionControllerLayout;
  49965. /**
  49966. * The gamepad object correlating to this controller
  49967. */
  49968. gamepadObject: IMinimalMotionControllerObject;
  49969. /**
  49970. * handedness (left/right/none) of this controller
  49971. */
  49972. handedness: MotionControllerHandedness;
  49973. private _initComponent;
  49974. private _modelReady;
  49975. /**
  49976. * A map of components (WebXRControllerComponent) in this motion controller
  49977. * Components have a ComponentType and can also have both button and axis definitions
  49978. */
  49979. readonly components: {
  49980. [id: string]: WebXRControllerComponent;
  49981. };
  49982. /**
  49983. * Disable the model's animation. Can be set at any time.
  49984. */
  49985. disableAnimation: boolean;
  49986. /**
  49987. * Observers registered here will be triggered when the model of this controller is done loading
  49988. */
  49989. onModelLoadedObservable: Observable<WebXRAbstractMotionController>;
  49990. /**
  49991. * The profile id of this motion controller
  49992. */
  49993. abstract profileId: string;
  49994. /**
  49995. * The root mesh of the model. It is null if the model was not yet initialized
  49996. */
  49997. rootMesh: Nullable<AbstractMesh>;
  49998. /**
  49999. * constructs a new abstract motion controller
  50000. * @param scene the scene to which the model of the controller will be added
  50001. * @param layout The profile layout to load
  50002. * @param gamepadObject The gamepad object correlating to this controller
  50003. * @param handedness handedness (left/right/none) of this controller
  50004. * @param _doNotLoadControllerMesh set this flag to ignore the mesh loading
  50005. */
  50006. constructor(scene: Scene, layout: IMotionControllerLayout,
  50007. /**
  50008. * The gamepad object correlating to this controller
  50009. */
  50010. gamepadObject: IMinimalMotionControllerObject,
  50011. /**
  50012. * handedness (left/right/none) of this controller
  50013. */
  50014. handedness: MotionControllerHandedness, _doNotLoadControllerMesh?: boolean);
  50015. /**
  50016. * Dispose this controller, the model mesh and all its components
  50017. */
  50018. dispose(): void;
  50019. /**
  50020. * Returns all components of specific type
  50021. * @param type the type to search for
  50022. * @return an array of components with this type
  50023. */
  50024. getAllComponentsOfType(type: MotionControllerComponentType): WebXRControllerComponent[];
  50025. /**
  50026. * get a component based an its component id as defined in layout.components
  50027. * @param id the id of the component
  50028. * @returns the component correlates to the id or undefined if not found
  50029. */
  50030. getComponent(id: string): WebXRControllerComponent;
  50031. /**
  50032. * Get the list of components available in this motion controller
  50033. * @returns an array of strings correlating to available components
  50034. */
  50035. getComponentIds(): string[];
  50036. /**
  50037. * Get the first component of specific type
  50038. * @param type type of component to find
  50039. * @return a controller component or null if not found
  50040. */
  50041. getComponentOfType(type: MotionControllerComponentType): Nullable<WebXRControllerComponent>;
  50042. /**
  50043. * Get the main (Select) component of this controller as defined in the layout
  50044. * @returns the main component of this controller
  50045. */
  50046. getMainComponent(): WebXRControllerComponent;
  50047. /**
  50048. * Loads the model correlating to this controller
  50049. * When the mesh is loaded, the onModelLoadedObservable will be triggered
  50050. * @returns A promise fulfilled with the result of the model loading
  50051. */
  50052. loadModel(): Promise<boolean>;
  50053. /**
  50054. * Update this model using the current XRFrame
  50055. * @param xrFrame the current xr frame to use and update the model
  50056. */
  50057. updateFromXRFrame(xrFrame: XRFrame): void;
  50058. /**
  50059. * Backwards compatibility due to a deeply-integrated typo
  50060. */
  50061. get handness(): XREye;
  50062. /**
  50063. * Pulse (vibrate) this controller
  50064. * If the controller does not support pulses, this function will fail silently and return Promise<false> directly after called
  50065. * Consecutive calls to this function will cancel the last pulse call
  50066. *
  50067. * @param value the strength of the pulse in 0.0...1.0 range
  50068. * @param duration Duration of the pulse in milliseconds
  50069. * @param hapticActuatorIndex optional index of actuator (will usually be 0)
  50070. * @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
  50071. */
  50072. pulse(value: number, duration: number, hapticActuatorIndex?: number): Promise<boolean>;
  50073. protected _getChildByName(node: AbstractMesh, name: string): AbstractMesh | undefined;
  50074. protected _getImmediateChildByName(node: AbstractMesh, name: string): AbstractMesh | undefined;
  50075. /**
  50076. * Moves the axis on the controller mesh based on its current state
  50077. * @param axis the index of the axis
  50078. * @param axisValue the value of the axis which determines the meshes new position
  50079. * @hidden
  50080. */
  50081. protected _lerpTransform(axisMap: IMotionControllerMeshMap, axisValue: number, fixValueCoordinates?: boolean): void;
  50082. /**
  50083. * Update the model itself with the current frame data
  50084. * @param xrFrame the frame to use for updating the model mesh
  50085. */
  50086. protected updateModel(xrFrame: XRFrame): void;
  50087. /**
  50088. * Get the filename and path for this controller's model
  50089. * @returns a map of filename and path
  50090. */
  50091. protected abstract _getFilenameAndPath(): {
  50092. filename: string;
  50093. path: string;
  50094. };
  50095. /**
  50096. * This function is called before the mesh is loaded. It checks for loading constraints.
  50097. * For example, this function can check if the GLB loader is available
  50098. * If this function returns false, the generic controller will be loaded instead
  50099. * @returns Is the client ready to load the mesh
  50100. */
  50101. protected abstract _getModelLoadingConstraints(): boolean;
  50102. /**
  50103. * This function will be called after the model was successfully loaded and can be used
  50104. * for mesh transformations before it is available for the user
  50105. * @param meshes the loaded meshes
  50106. */
  50107. protected abstract _processLoadedModel(meshes: AbstractMesh[]): void;
  50108. /**
  50109. * Set the root mesh for this controller. Important for the WebXR controller class
  50110. * @param meshes the loaded meshes
  50111. */
  50112. protected abstract _setRootMesh(meshes: AbstractMesh[]): void;
  50113. /**
  50114. * A function executed each frame that updates the mesh (if needed)
  50115. * @param xrFrame the current xrFrame
  50116. */
  50117. protected abstract _updateModel(xrFrame: XRFrame): void;
  50118. private _getGenericFilenameAndPath;
  50119. private _getGenericParentMesh;
  50120. }
  50121. }
  50122. declare module "babylonjs/XR/motionController/webXRGenericMotionController" {
  50123. import { WebXRAbstractMotionController, IMinimalMotionControllerObject, MotionControllerHandedness } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  50124. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50125. import { Scene } from "babylonjs/scene";
  50126. /**
  50127. * A generic trigger-only motion controller for WebXR
  50128. */
  50129. export class WebXRGenericTriggerMotionController extends WebXRAbstractMotionController {
  50130. /**
  50131. * Static version of the profile id of this controller
  50132. */
  50133. static ProfileId: string;
  50134. profileId: string;
  50135. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  50136. protected _getFilenameAndPath(): {
  50137. filename: string;
  50138. path: string;
  50139. };
  50140. protected _getModelLoadingConstraints(): boolean;
  50141. protected _processLoadedModel(meshes: AbstractMesh[]): void;
  50142. protected _setRootMesh(meshes: AbstractMesh[]): void;
  50143. protected _updateModel(): void;
  50144. }
  50145. }
  50146. declare module "babylonjs/Meshes/Builders/sphereBuilder" {
  50147. import { Vector4 } from "babylonjs/Maths/math.vector";
  50148. import { Mesh } from "babylonjs/Meshes/mesh";
  50149. import { Scene } from "babylonjs/scene";
  50150. import { Nullable } from "babylonjs/types";
  50151. /**
  50152. * Class containing static functions to help procedurally build meshes
  50153. */
  50154. export class SphereBuilder {
  50155. /**
  50156. * Creates a sphere mesh
  50157. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  50158. * * 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`)
  50159. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  50160. * * 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
  50161. * * 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)
  50162. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  50163. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  50164. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  50165. * @param name defines the name of the mesh
  50166. * @param options defines the options used to create the mesh
  50167. * @param scene defines the hosting scene
  50168. * @returns the sphere mesh
  50169. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  50170. */
  50171. static CreateSphere(name: string, options: {
  50172. segments?: number;
  50173. diameter?: number;
  50174. diameterX?: number;
  50175. diameterY?: number;
  50176. diameterZ?: number;
  50177. arc?: number;
  50178. slice?: number;
  50179. sideOrientation?: number;
  50180. frontUVs?: Vector4;
  50181. backUVs?: Vector4;
  50182. updatable?: boolean;
  50183. }, scene?: Nullable<Scene>): Mesh;
  50184. }
  50185. }
  50186. declare module "babylonjs/XR/motionController/webXRProfiledMotionController" {
  50187. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50188. import { WebXRAbstractMotionController, IMotionControllerProfile } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  50189. import { Scene } from "babylonjs/scene";
  50190. /**
  50191. * A profiled motion controller has its profile loaded from an online repository.
  50192. * The class is responsible of loading the model, mapping the keys and enabling model-animations
  50193. */
  50194. export class WebXRProfiledMotionController extends WebXRAbstractMotionController {
  50195. private _repositoryUrl;
  50196. private _buttonMeshMapping;
  50197. private _touchDots;
  50198. /**
  50199. * The profile ID of this controller. Will be populated when the controller initializes.
  50200. */
  50201. profileId: string;
  50202. constructor(scene: Scene, xrInput: XRInputSource, _profile: IMotionControllerProfile, _repositoryUrl: string);
  50203. dispose(): void;
  50204. protected _getFilenameAndPath(): {
  50205. filename: string;
  50206. path: string;
  50207. };
  50208. protected _getModelLoadingConstraints(): boolean;
  50209. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  50210. protected _setRootMesh(meshes: AbstractMesh[]): void;
  50211. protected _updateModel(_xrFrame: XRFrame): void;
  50212. }
  50213. }
  50214. declare module "babylonjs/XR/motionController/webXRMotionControllerManager" {
  50215. import { WebXRAbstractMotionController } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  50216. import { Scene } from "babylonjs/scene";
  50217. /**
  50218. * A construction function type to create a new controller based on an xrInput object
  50219. */
  50220. export type MotionControllerConstructor = (xrInput: XRInputSource, scene: Scene) => WebXRAbstractMotionController;
  50221. /**
  50222. * The MotionController Manager manages all registered motion controllers and loads the right one when needed.
  50223. *
  50224. * When this repository is complete: https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/assets
  50225. * it should be replaced with auto-loaded controllers.
  50226. *
  50227. * When using a model try to stay as generic as possible. Eventually there will be no need in any of the controller classes
  50228. */
  50229. export class WebXRMotionControllerManager {
  50230. private static _AvailableControllers;
  50231. private static _Fallbacks;
  50232. private static _ProfileLoadingPromises;
  50233. private static _ProfilesList;
  50234. /**
  50235. * The base URL of the online controller repository. Can be changed at any time.
  50236. */
  50237. static BaseRepositoryUrl: string;
  50238. /**
  50239. * Which repository gets priority - local or online
  50240. */
  50241. static PrioritizeOnlineRepository: boolean;
  50242. /**
  50243. * Use the online repository, or use only locally-defined controllers
  50244. */
  50245. static UseOnlineRepository: boolean;
  50246. /**
  50247. * Clear the cache used for profile loading and reload when requested again
  50248. */
  50249. static ClearProfilesCache(): void;
  50250. /**
  50251. * Register the default fallbacks.
  50252. * This function is called automatically when this file is imported.
  50253. */
  50254. static DefaultFallbacks(): void;
  50255. /**
  50256. * Find a fallback profile if the profile was not found. There are a few predefined generic profiles.
  50257. * @param profileId the profile to which a fallback needs to be found
  50258. * @return an array with corresponding fallback profiles
  50259. */
  50260. static FindFallbackWithProfileId(profileId: string): string[];
  50261. /**
  50262. * When acquiring a new xrInput object (usually by the WebXRInput class), match it with the correct profile.
  50263. * The order of search:
  50264. *
  50265. * 1) Iterate the profiles array of the xr input and try finding a corresponding motion controller
  50266. * 2) (If not found) search in the gamepad id and try using it (legacy versions only)
  50267. * 3) search for registered fallbacks (should be redundant, nonetheless it makes sense to check)
  50268. * 4) return the generic trigger controller if none were found
  50269. *
  50270. * @param xrInput the xrInput to which a new controller is initialized
  50271. * @param scene the scene to which the model will be added
  50272. * @param forceProfile force a certain profile for this controller
  50273. * @return A promise that fulfils with the motion controller class for this profile id or the generic standard class if none was found
  50274. */
  50275. static GetMotionControllerWithXRInput(xrInput: XRInputSource, scene: Scene, forceProfile?: string): Promise<WebXRAbstractMotionController>;
  50276. /**
  50277. * Register a new controller based on its profile. This function will be called by the controller classes themselves.
  50278. *
  50279. * If you are missing a profile, make sure it is imported in your source, otherwise it will not register.
  50280. *
  50281. * @param type the profile type to register
  50282. * @param constructFunction the function to be called when loading this profile
  50283. */
  50284. static RegisterController(type: string, constructFunction: MotionControllerConstructor): void;
  50285. /**
  50286. * Register a fallback to a specific profile.
  50287. * @param profileId the profileId that will receive the fallbacks
  50288. * @param fallbacks A list of fallback profiles
  50289. */
  50290. static RegisterFallbacksForProfileId(profileId: string, fallbacks: string[]): void;
  50291. /**
  50292. * Will update the list of profiles available in the repository
  50293. * @return a promise that resolves to a map of profiles available online
  50294. */
  50295. static UpdateProfilesList(): Promise<{
  50296. [profile: string]: string;
  50297. }>;
  50298. private static _LoadProfileFromRepository;
  50299. private static _LoadProfilesFromAvailableControllers;
  50300. }
  50301. }
  50302. declare module "babylonjs/XR/webXRInputSource" {
  50303. import { Observable } from "babylonjs/Misc/observable";
  50304. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50305. import { Ray } from "babylonjs/Culling/ray";
  50306. import { Scene } from "babylonjs/scene";
  50307. import { WebXRAbstractMotionController } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  50308. /**
  50309. * Configuration options for the WebXR controller creation
  50310. */
  50311. export interface IWebXRControllerOptions {
  50312. /**
  50313. * Should the controller mesh be animated when a user interacts with it
  50314. * The pressed buttons / thumbstick and touchpad animations will be disabled
  50315. */
  50316. disableMotionControllerAnimation?: boolean;
  50317. /**
  50318. * Do not load the controller mesh, in case a different mesh needs to be loaded.
  50319. */
  50320. doNotLoadControllerMesh?: boolean;
  50321. /**
  50322. * Force a specific controller type for this controller.
  50323. * This can be used when creating your own profile or when testing different controllers
  50324. */
  50325. forceControllerProfile?: string;
  50326. /**
  50327. * Defines a rendering group ID for meshes that will be loaded.
  50328. * This is for the default controllers only.
  50329. */
  50330. renderingGroupId?: number;
  50331. }
  50332. /**
  50333. * Represents an XR controller
  50334. */
  50335. export class WebXRInputSource {
  50336. private _scene;
  50337. /** The underlying input source for the controller */
  50338. inputSource: XRInputSource;
  50339. private _options;
  50340. private _tmpVector;
  50341. private _uniqueId;
  50342. private _disposed;
  50343. /**
  50344. * 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
  50345. */
  50346. grip?: AbstractMesh;
  50347. /**
  50348. * If available, this is the gamepad object related to this controller.
  50349. * Using this object it is possible to get click events and trackpad changes of the
  50350. * webxr controller that is currently being used.
  50351. */
  50352. motionController?: WebXRAbstractMotionController;
  50353. /**
  50354. * Event that fires when the controller is removed/disposed.
  50355. * The object provided as event data is this controller, after associated assets were disposed.
  50356. * uniqueId is still available.
  50357. */
  50358. onDisposeObservable: Observable<WebXRInputSource>;
  50359. /**
  50360. * Will be triggered when the mesh associated with the motion controller is done loading.
  50361. * It is also possible that this will never trigger (!) if no mesh was loaded, or if the developer decides to load a different mesh
  50362. * A shortened version of controller -> motion controller -> on mesh loaded.
  50363. */
  50364. onMeshLoadedObservable: Observable<AbstractMesh>;
  50365. /**
  50366. * Observers registered here will trigger when a motion controller profile was assigned to this xr controller
  50367. */
  50368. onMotionControllerInitObservable: Observable<WebXRAbstractMotionController>;
  50369. /**
  50370. * Pointer which can be used to select objects or attach a visible laser to
  50371. */
  50372. pointer: AbstractMesh;
  50373. /**
  50374. * Creates the input source object
  50375. * @see https://doc.babylonjs.com/how_to/webxr_controllers_support
  50376. * @param _scene the scene which the controller should be associated to
  50377. * @param inputSource the underlying input source for the controller
  50378. * @param _options options for this controller creation
  50379. */
  50380. constructor(_scene: Scene,
  50381. /** The underlying input source for the controller */
  50382. inputSource: XRInputSource, _options?: IWebXRControllerOptions);
  50383. /**
  50384. * Get this controllers unique id
  50385. */
  50386. get uniqueId(): string;
  50387. /**
  50388. * Disposes of the object
  50389. */
  50390. dispose(): void;
  50391. /**
  50392. * Gets a world space ray coming from the pointer or grip
  50393. * @param result the resulting ray
  50394. * @param gripIfAvailable use the grip mesh instead of the pointer, if available
  50395. */
  50396. getWorldPointerRayToRef(result: Ray, gripIfAvailable?: boolean): void;
  50397. /**
  50398. * Updates the controller pose based on the given XRFrame
  50399. * @param xrFrame xr frame to update the pose with
  50400. * @param referenceSpace reference space to use
  50401. */
  50402. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace): void;
  50403. }
  50404. }
  50405. declare module "babylonjs/XR/webXRInput" {
  50406. import { Observable } from "babylonjs/Misc/observable";
  50407. import { IDisposable } from "babylonjs/scene";
  50408. import { WebXRInputSource, IWebXRControllerOptions } from "babylonjs/XR/webXRInputSource";
  50409. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  50410. import { WebXRCamera } from "babylonjs/XR/webXRCamera";
  50411. /**
  50412. * The schema for initialization options of the XR Input class
  50413. */
  50414. export interface IWebXRInputOptions {
  50415. /**
  50416. * If set to true no model will be automatically loaded
  50417. */
  50418. doNotLoadControllerMeshes?: boolean;
  50419. /**
  50420. * If set, this profile will be used for all controllers loaded (for example "microsoft-mixed-reality")
  50421. * If not found, the xr input profile data will be used.
  50422. * Profiles are defined here - https://github.com/immersive-web/webxr-input-profiles/
  50423. */
  50424. forceInputProfile?: string;
  50425. /**
  50426. * Do not send a request to the controller repository to load the profile.
  50427. *
  50428. * Instead, use the controllers available in babylon itself.
  50429. */
  50430. disableOnlineControllerRepository?: boolean;
  50431. /**
  50432. * A custom URL for the controllers repository
  50433. */
  50434. customControllersRepositoryURL?: string;
  50435. /**
  50436. * Should the controller model's components not move according to the user input
  50437. */
  50438. disableControllerAnimation?: boolean;
  50439. /**
  50440. * Optional options to pass to the controller. Will be overridden by the Input options where applicable
  50441. */
  50442. controllerOptions?: IWebXRControllerOptions;
  50443. }
  50444. /**
  50445. * XR input used to track XR inputs such as controllers/rays
  50446. */
  50447. export class WebXRInput implements IDisposable {
  50448. /**
  50449. * the xr session manager for this session
  50450. */
  50451. xrSessionManager: WebXRSessionManager;
  50452. /**
  50453. * the WebXR camera for this session. Mainly used for teleportation
  50454. */
  50455. xrCamera: WebXRCamera;
  50456. private readonly options;
  50457. /**
  50458. * XR controllers being tracked
  50459. */
  50460. controllers: Array<WebXRInputSource>;
  50461. private _frameObserver;
  50462. private _sessionEndedObserver;
  50463. private _sessionInitObserver;
  50464. /**
  50465. * Event when a controller has been connected/added
  50466. */
  50467. onControllerAddedObservable: Observable<WebXRInputSource>;
  50468. /**
  50469. * Event when a controller has been removed/disconnected
  50470. */
  50471. onControllerRemovedObservable: Observable<WebXRInputSource>;
  50472. /**
  50473. * Initializes the WebXRInput
  50474. * @param xrSessionManager the xr session manager for this session
  50475. * @param xrCamera the WebXR camera for this session. Mainly used for teleportation
  50476. * @param options = initialization options for this xr input
  50477. */
  50478. constructor(
  50479. /**
  50480. * the xr session manager for this session
  50481. */
  50482. xrSessionManager: WebXRSessionManager,
  50483. /**
  50484. * the WebXR camera for this session. Mainly used for teleportation
  50485. */
  50486. xrCamera: WebXRCamera, options?: IWebXRInputOptions);
  50487. private _onInputSourcesChange;
  50488. private _addAndRemoveControllers;
  50489. /**
  50490. * Disposes of the object
  50491. */
  50492. dispose(): void;
  50493. }
  50494. }
  50495. declare module "babylonjs/XR/features/WebXRAbstractFeature" {
  50496. import { IWebXRFeature } from "babylonjs/XR/webXRFeaturesManager";
  50497. import { Observable, EventState } from "babylonjs/Misc/observable";
  50498. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  50499. /**
  50500. * This is the base class for all WebXR features.
  50501. * Since most features require almost the same resources and callbacks, this class can be used to simplify the development
  50502. * Note that since the features manager is using the `IWebXRFeature` you are in no way obligated to use this class
  50503. */
  50504. export abstract class WebXRAbstractFeature implements IWebXRFeature {
  50505. protected _xrSessionManager: WebXRSessionManager;
  50506. private _attached;
  50507. private _removeOnDetach;
  50508. /**
  50509. * Should auto-attach be disabled?
  50510. */
  50511. disableAutoAttach: boolean;
  50512. /**
  50513. * The name of the native xr feature name (like anchor, hit-test, or hand-tracking)
  50514. */
  50515. xrNativeFeatureName: string;
  50516. /**
  50517. * Construct a new (abstract) WebXR feature
  50518. * @param _xrSessionManager the xr session manager for this feature
  50519. */
  50520. constructor(_xrSessionManager: WebXRSessionManager);
  50521. /**
  50522. * Is this feature attached
  50523. */
  50524. get attached(): boolean;
  50525. /**
  50526. * attach this feature
  50527. *
  50528. * @param force should attachment be forced (even when already attached)
  50529. * @returns true if successful, false is failed or already attached
  50530. */
  50531. attach(force?: boolean): boolean;
  50532. /**
  50533. * detach this feature.
  50534. *
  50535. * @returns true if successful, false if failed or already detached
  50536. */
  50537. detach(): boolean;
  50538. /**
  50539. * Dispose this feature and all of the resources attached
  50540. */
  50541. dispose(): void;
  50542. /**
  50543. * This function will be executed during before enabling the feature and can be used to not-allow enabling it.
  50544. * Note that at this point the session has NOT started, so this is purely checking if the browser supports it
  50545. *
  50546. * @returns whether or not the feature is compatible in this environment
  50547. */
  50548. isCompatible(): boolean;
  50549. /**
  50550. * This is used to register callbacks that will automatically be removed when detach is called.
  50551. * @param observable the observable to which the observer will be attached
  50552. * @param callback the callback to register
  50553. */
  50554. protected _addNewAttachObserver<T>(observable: Observable<T>, callback: (eventData: T, eventState: EventState) => void): void;
  50555. /**
  50556. * Code in this function will be executed on each xrFrame received from the browser.
  50557. * This function will not execute after the feature is detached.
  50558. * @param _xrFrame the current frame
  50559. */
  50560. protected abstract _onXRFrame(_xrFrame: XRFrame): void;
  50561. }
  50562. }
  50563. declare module "babylonjs/Rendering/utilityLayerRenderer" {
  50564. import { IDisposable, Scene } from "babylonjs/scene";
  50565. import { Nullable } from "babylonjs/types";
  50566. import { Observable } from "babylonjs/Misc/observable";
  50567. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50568. import { HemisphericLight } from "babylonjs/Lights/hemisphericLight";
  50569. import { Camera } from "babylonjs/Cameras/camera";
  50570. /**
  50571. * Renders a layer on top of an existing scene
  50572. */
  50573. export class UtilityLayerRenderer implements IDisposable {
  50574. /** the original scene that will be rendered on top of */
  50575. originalScene: Scene;
  50576. private _pointerCaptures;
  50577. private _lastPointerEvents;
  50578. private static _DefaultUtilityLayer;
  50579. private static _DefaultKeepDepthUtilityLayer;
  50580. private _sharedGizmoLight;
  50581. private _renderCamera;
  50582. /**
  50583. * Gets the camera that is used to render the utility layer (when not set, this will be the last active camera)
  50584. * @param getRigParentIfPossible if the current active camera is a rig camera, should its parent camera be returned
  50585. * @returns the camera that is used when rendering the utility layer
  50586. */
  50587. getRenderCamera(getRigParentIfPossible?: boolean): Camera;
  50588. /**
  50589. * Sets the camera that should be used when rendering the utility layer (If set to null the last active camera will be used)
  50590. * @param cam the camera that should be used when rendering the utility layer
  50591. */
  50592. setRenderCamera(cam: Nullable<Camera>): void;
  50593. /**
  50594. * @hidden
  50595. * Light which used by gizmos to get light shading
  50596. */
  50597. _getSharedGizmoLight(): HemisphericLight;
  50598. /**
  50599. * If the picking should be done on the utility layer prior to the actual scene (Default: true)
  50600. */
  50601. pickUtilitySceneFirst: boolean;
  50602. /**
  50603. * 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)
  50604. */
  50605. static get DefaultUtilityLayer(): UtilityLayerRenderer;
  50606. /**
  50607. * 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)
  50608. */
  50609. static get DefaultKeepDepthUtilityLayer(): UtilityLayerRenderer;
  50610. /**
  50611. * The scene that is rendered on top of the original scene
  50612. */
  50613. utilityLayerScene: Scene;
  50614. /**
  50615. * If the utility layer should automatically be rendered on top of existing scene
  50616. */
  50617. shouldRender: boolean;
  50618. /**
  50619. * If set to true, only pointer down onPointerObservable events will be blocked when picking is occluded by original scene
  50620. */
  50621. onlyCheckPointerDownEvents: boolean;
  50622. /**
  50623. * If set to false, only pointerUp, pointerDown and pointerMove will be sent to the utilityLayerScene (false by default)
  50624. */
  50625. processAllEvents: boolean;
  50626. /**
  50627. * Observable raised when the pointer move from the utility layer scene to the main scene
  50628. */
  50629. onPointerOutObservable: Observable<number>;
  50630. /** Gets or sets a predicate that will be used to indicate utility meshes present in the main scene */
  50631. mainSceneTrackerPredicate: (mesh: Nullable<AbstractMesh>) => boolean;
  50632. private _afterRenderObserver;
  50633. private _sceneDisposeObserver;
  50634. private _originalPointerObserver;
  50635. /**
  50636. * Instantiates a UtilityLayerRenderer
  50637. * @param originalScene the original scene that will be rendered on top of
  50638. * @param handleEvents boolean indicating if the utility layer should handle events
  50639. */
  50640. constructor(
  50641. /** the original scene that will be rendered on top of */
  50642. originalScene: Scene, handleEvents?: boolean);
  50643. private _notifyObservers;
  50644. /**
  50645. * Renders the utility layers scene on top of the original scene
  50646. */
  50647. render(): void;
  50648. /**
  50649. * Disposes of the renderer
  50650. */
  50651. dispose(): void;
  50652. private _updateCamera;
  50653. }
  50654. }
  50655. declare module "babylonjs/XR/features/WebXRControllerPointerSelection" {
  50656. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  50657. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50658. import { WebXRInput } from "babylonjs/XR/webXRInput";
  50659. import { WebXRInputSource } from "babylonjs/XR/webXRInputSource";
  50660. import { Scene } from "babylonjs/scene";
  50661. import { Nullable } from "babylonjs/types";
  50662. import { Color3 } from "babylonjs/Maths/math.color";
  50663. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  50664. import { WebXRCamera } from "babylonjs/XR/webXRCamera";
  50665. /**
  50666. * Options interface for the pointer selection module
  50667. */
  50668. export interface IWebXRControllerPointerSelectionOptions {
  50669. /**
  50670. * if provided, this scene will be used to render meshes.
  50671. */
  50672. customUtilityLayerScene?: Scene;
  50673. /**
  50674. * 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)
  50675. * If not disabled, the last picked point will be used to execute a pointer up event
  50676. * If disabled, pointer up event will be triggered right after the pointer down event.
  50677. * Used in screen and gaze target ray mode only
  50678. */
  50679. disablePointerUpOnTouchOut: boolean;
  50680. /**
  50681. * For gaze mode for tracked-pointer / controllers (time to select instead of button press)
  50682. */
  50683. forceGazeMode: boolean;
  50684. /**
  50685. * 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
  50686. * to start a new countdown to the pointer down event.
  50687. * Defaults to 1.
  50688. */
  50689. gazeModePointerMovedFactor?: number;
  50690. /**
  50691. * Different button type to use instead of the main component
  50692. */
  50693. overrideButtonId?: string;
  50694. /**
  50695. * use this rendering group id for the meshes (optional)
  50696. */
  50697. renderingGroupId?: number;
  50698. /**
  50699. * The amount of time in milliseconds it takes between pick found something to a pointer down event.
  50700. * Used in gaze modes. Tracked pointer uses the trigger, screen uses touch events
  50701. * 3000 means 3 seconds between pointing at something and selecting it
  50702. */
  50703. timeToSelect?: number;
  50704. /**
  50705. * Should meshes created here be added to a utility layer or the main scene
  50706. */
  50707. useUtilityLayer?: boolean;
  50708. /**
  50709. * Optional WebXR camera to be used for gaze selection
  50710. */
  50711. gazeCamera?: WebXRCamera;
  50712. /**
  50713. * the xr input to use with this pointer selection
  50714. */
  50715. xrInput: WebXRInput;
  50716. }
  50717. /**
  50718. * A module that will enable pointer selection for motion controllers of XR Input Sources
  50719. */
  50720. export class WebXRControllerPointerSelection extends WebXRAbstractFeature {
  50721. private readonly _options;
  50722. private static _idCounter;
  50723. private _attachController;
  50724. private _controllers;
  50725. private _scene;
  50726. private _tmpVectorForPickCompare;
  50727. /**
  50728. * The module's name
  50729. */
  50730. static readonly Name: string;
  50731. /**
  50732. * The (Babylon) version of this module.
  50733. * This is an integer representing the implementation version.
  50734. * This number does not correspond to the WebXR specs version
  50735. */
  50736. static readonly Version: number;
  50737. /**
  50738. * Disable lighting on the laser pointer (so it will always be visible)
  50739. */
  50740. disablePointerLighting: boolean;
  50741. /**
  50742. * Disable lighting on the selection mesh (so it will always be visible)
  50743. */
  50744. disableSelectionMeshLighting: boolean;
  50745. /**
  50746. * Should the laser pointer be displayed
  50747. */
  50748. displayLaserPointer: boolean;
  50749. /**
  50750. * Should the selection mesh be displayed (The ring at the end of the laser pointer)
  50751. */
  50752. displaySelectionMesh: boolean;
  50753. /**
  50754. * This color will be set to the laser pointer when selection is triggered
  50755. */
  50756. laserPointerPickedColor: Color3;
  50757. /**
  50758. * Default color of the laser pointer
  50759. */
  50760. laserPointerDefaultColor: Color3;
  50761. /**
  50762. * default color of the selection ring
  50763. */
  50764. selectionMeshDefaultColor: Color3;
  50765. /**
  50766. * This color will be applied to the selection ring when selection is triggered
  50767. */
  50768. selectionMeshPickedColor: Color3;
  50769. /**
  50770. * Optional filter to be used for ray selection. This predicate shares behavior with
  50771. * scene.pointerMovePredicate which takes priority if it is also assigned.
  50772. */
  50773. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  50774. /**
  50775. * constructs a new background remover module
  50776. * @param _xrSessionManager the session manager for this module
  50777. * @param _options read-only options to be used in this module
  50778. */
  50779. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPointerSelectionOptions);
  50780. /**
  50781. * attach this feature
  50782. * Will usually be called by the features manager
  50783. *
  50784. * @returns true if successful.
  50785. */
  50786. attach(): boolean;
  50787. /**
  50788. * detach this feature.
  50789. * Will usually be called by the features manager
  50790. *
  50791. * @returns true if successful.
  50792. */
  50793. detach(): boolean;
  50794. /**
  50795. * Will get the mesh under a specific pointer.
  50796. * `scene.meshUnderPointer` will only return one mesh - either left or right.
  50797. * @param controllerId the controllerId to check
  50798. * @returns The mesh under pointer or null if no mesh is under the pointer
  50799. */
  50800. getMeshUnderPointer(controllerId: string): Nullable<AbstractMesh>;
  50801. /**
  50802. * Get the xr controller that correlates to the pointer id in the pointer event
  50803. *
  50804. * @param id the pointer id to search for
  50805. * @returns the controller that correlates to this id or null if not found
  50806. */
  50807. getXRControllerByPointerId(id: number): Nullable<WebXRInputSource>;
  50808. protected _onXRFrame(_xrFrame: XRFrame): void;
  50809. private _attachGazeMode;
  50810. private _attachScreenRayMode;
  50811. private _attachTrackedPointerRayMode;
  50812. private _convertNormalToDirectionOfRay;
  50813. private _detachController;
  50814. private _generateNewMeshPair;
  50815. private _pickingMoved;
  50816. private _updatePointerDistance;
  50817. /** @hidden */
  50818. get lasterPointerDefaultColor(): Color3;
  50819. }
  50820. }
  50821. declare module "babylonjs/XR/webXREnterExitUI" {
  50822. import { Nullable } from "babylonjs/types";
  50823. import { Observable } from "babylonjs/Misc/observable";
  50824. import { IDisposable, Scene } from "babylonjs/scene";
  50825. import { WebXRExperienceHelper } from "babylonjs/XR/webXRExperienceHelper";
  50826. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  50827. /**
  50828. * Button which can be used to enter a different mode of XR
  50829. */
  50830. export class WebXREnterExitUIButton {
  50831. /** button element */
  50832. element: HTMLElement;
  50833. /** XR initialization options for the button */
  50834. sessionMode: XRSessionMode;
  50835. /** Reference space type */
  50836. referenceSpaceType: XRReferenceSpaceType;
  50837. /**
  50838. * Creates a WebXREnterExitUIButton
  50839. * @param element button element
  50840. * @param sessionMode XR initialization session mode
  50841. * @param referenceSpaceType the type of reference space to be used
  50842. */
  50843. constructor(
  50844. /** button element */
  50845. element: HTMLElement,
  50846. /** XR initialization options for the button */
  50847. sessionMode: XRSessionMode,
  50848. /** Reference space type */
  50849. referenceSpaceType: XRReferenceSpaceType);
  50850. /**
  50851. * Extendable function which can be used to update the button's visuals when the state changes
  50852. * @param activeButton the current active button in the UI
  50853. */
  50854. update(activeButton: Nullable<WebXREnterExitUIButton>): void;
  50855. }
  50856. /**
  50857. * Options to create the webXR UI
  50858. */
  50859. export class WebXREnterExitUIOptions {
  50860. /**
  50861. * User provided buttons to enable/disable WebXR. The system will provide default if not set
  50862. */
  50863. customButtons?: Array<WebXREnterExitUIButton>;
  50864. /**
  50865. * A reference space type to use when creating the default button.
  50866. * Default is local-floor
  50867. */
  50868. referenceSpaceType?: XRReferenceSpaceType;
  50869. /**
  50870. * Context to enter xr with
  50871. */
  50872. renderTarget?: Nullable<WebXRRenderTarget>;
  50873. /**
  50874. * A session mode to use when creating the default button.
  50875. * Default is immersive-vr
  50876. */
  50877. sessionMode?: XRSessionMode;
  50878. /**
  50879. * A list of optional features to init the session with
  50880. */
  50881. optionalFeatures?: string[];
  50882. /**
  50883. * A list of optional features to init the session with
  50884. */
  50885. requiredFeatures?: string[];
  50886. }
  50887. /**
  50888. * UI to allow the user to enter/exit XR mode
  50889. */
  50890. export class WebXREnterExitUI implements IDisposable {
  50891. private scene;
  50892. /** version of the options passed to this UI */
  50893. options: WebXREnterExitUIOptions;
  50894. private _activeButton;
  50895. private _buttons;
  50896. /**
  50897. * The HTML Div Element to which buttons are added.
  50898. */
  50899. readonly overlay: HTMLDivElement;
  50900. /**
  50901. * Fired every time the active button is changed.
  50902. *
  50903. * When xr is entered via a button that launches xr that button will be the callback parameter
  50904. *
  50905. * When exiting xr the callback parameter will be null)
  50906. */
  50907. activeButtonChangedObservable: Observable<Nullable<WebXREnterExitUIButton>>;
  50908. /**
  50909. *
  50910. * @param scene babylon scene object to use
  50911. * @param options (read-only) version of the options passed to this UI
  50912. */
  50913. private constructor();
  50914. /**
  50915. * Creates UI to allow the user to enter/exit XR mode
  50916. * @param scene the scene to add the ui to
  50917. * @param helper the xr experience helper to enter/exit xr with
  50918. * @param options options to configure the UI
  50919. * @returns the created ui
  50920. */
  50921. static CreateAsync(scene: Scene, helper: WebXRExperienceHelper, options: WebXREnterExitUIOptions): Promise<WebXREnterExitUI>;
  50922. /**
  50923. * Disposes of the XR UI component
  50924. */
  50925. dispose(): void;
  50926. private _updateButtons;
  50927. }
  50928. }
  50929. declare module "babylonjs/Meshes/Builders/linesBuilder" {
  50930. import { Vector3 } from "babylonjs/Maths/math.vector";
  50931. import { Color4 } from "babylonjs/Maths/math.color";
  50932. import { Nullable } from "babylonjs/types";
  50933. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  50934. import { Scene } from "babylonjs/scene";
  50935. /**
  50936. * Class containing static functions to help procedurally build meshes
  50937. */
  50938. export class LinesBuilder {
  50939. /**
  50940. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  50941. * * 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
  50942. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  50943. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  50944. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  50945. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  50946. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  50947. * * 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
  50948. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  50949. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  50950. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  50951. * @param name defines the name of the new line system
  50952. * @param options defines the options used to create the line system
  50953. * @param scene defines the hosting scene
  50954. * @returns a new line system mesh
  50955. */
  50956. static CreateLineSystem(name: string, options: {
  50957. lines: Vector3[][];
  50958. updatable?: boolean;
  50959. instance?: Nullable<LinesMesh>;
  50960. colors?: Nullable<Color4[][]>;
  50961. useVertexAlpha?: boolean;
  50962. }, scene: Nullable<Scene>): LinesMesh;
  50963. /**
  50964. * Creates a line mesh
  50965. * 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
  50966. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  50967. * * The parameter `points` is an array successive Vector3
  50968. * * 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
  50969. * * The optional parameter `colors` is an array of successive Color4, one per line point
  50970. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  50971. * * When updating an instance, remember that only point positions can change, not the number of points
  50972. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  50973. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  50974. * @param name defines the name of the new line system
  50975. * @param options defines the options used to create the line system
  50976. * @param scene defines the hosting scene
  50977. * @returns a new line mesh
  50978. */
  50979. static CreateLines(name: string, options: {
  50980. points: Vector3[];
  50981. updatable?: boolean;
  50982. instance?: Nullable<LinesMesh>;
  50983. colors?: Color4[];
  50984. useVertexAlpha?: boolean;
  50985. }, scene?: Nullable<Scene>): LinesMesh;
  50986. /**
  50987. * Creates a dashed line mesh
  50988. * * 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
  50989. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  50990. * * The parameter `points` is an array successive Vector3
  50991. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  50992. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  50993. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  50994. * * 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
  50995. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  50996. * * When updating an instance, remember that only point positions can change, not the number of points
  50997. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  50998. * @param name defines the name of the mesh
  50999. * @param options defines the options used to create the mesh
  51000. * @param scene defines the hosting scene
  51001. * @returns the dashed line mesh
  51002. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  51003. */
  51004. static CreateDashedLines(name: string, options: {
  51005. points: Vector3[];
  51006. dashSize?: number;
  51007. gapSize?: number;
  51008. dashNb?: number;
  51009. updatable?: boolean;
  51010. instance?: LinesMesh;
  51011. useVertexAlpha?: boolean;
  51012. }, scene?: Nullable<Scene>): LinesMesh;
  51013. }
  51014. }
  51015. declare module "babylonjs/Misc/timer" {
  51016. import { Observable, Observer } from "babylonjs/Misc/observable";
  51017. import { Nullable } from "babylonjs/types";
  51018. import { IDisposable } from "babylonjs/scene";
  51019. /**
  51020. * Construction options for a timer
  51021. */
  51022. export interface ITimerOptions<T> {
  51023. /**
  51024. * Time-to-end
  51025. */
  51026. timeout: number;
  51027. /**
  51028. * The context observable is used to calculate time deltas and provides the context of the timer's callbacks. Will usually be OnBeforeRenderObservable.
  51029. * Countdown calculation is done ONLY when the observable is notifying its observers, meaning that if
  51030. * you choose an observable that doesn't trigger too often, the wait time might extend further than the requested max time
  51031. */
  51032. contextObservable: Observable<T>;
  51033. /**
  51034. * Optional parameters when adding an observer to the observable
  51035. */
  51036. observableParameters?: {
  51037. mask?: number;
  51038. insertFirst?: boolean;
  51039. scope?: any;
  51040. };
  51041. /**
  51042. * An optional break condition that will stop the times prematurely. In this case onEnded will not be triggered!
  51043. */
  51044. breakCondition?: (data?: ITimerData<T>) => boolean;
  51045. /**
  51046. * Will be triggered when the time condition has met
  51047. */
  51048. onEnded?: (data: ITimerData<any>) => void;
  51049. /**
  51050. * Will be triggered when the break condition has met (prematurely ended)
  51051. */
  51052. onAborted?: (data: ITimerData<any>) => void;
  51053. /**
  51054. * Optional function to execute on each tick (or count)
  51055. */
  51056. onTick?: (data: ITimerData<any>) => void;
  51057. }
  51058. /**
  51059. * An interface defining the data sent by the timer
  51060. */
  51061. export interface ITimerData<T> {
  51062. /**
  51063. * When did it start
  51064. */
  51065. startTime: number;
  51066. /**
  51067. * Time now
  51068. */
  51069. currentTime: number;
  51070. /**
  51071. * Time passed since started
  51072. */
  51073. deltaTime: number;
  51074. /**
  51075. * How much is completed, in [0.0...1.0].
  51076. * Note that this CAN be higher than 1 due to the fact that we don't actually measure time but delta between observable calls
  51077. */
  51078. completeRate: number;
  51079. /**
  51080. * What the registered observable sent in the last count
  51081. */
  51082. payload: T;
  51083. }
  51084. /**
  51085. * The current state of the timer
  51086. */
  51087. export enum TimerState {
  51088. /**
  51089. * Timer initialized, not yet started
  51090. */
  51091. INIT = 0,
  51092. /**
  51093. * Timer started and counting
  51094. */
  51095. STARTED = 1,
  51096. /**
  51097. * Timer ended (whether aborted or time reached)
  51098. */
  51099. ENDED = 2
  51100. }
  51101. /**
  51102. * A simple version of the timer. Will take options and start the timer immediately after calling it
  51103. *
  51104. * @param options options with which to initialize this timer
  51105. */
  51106. export function setAndStartTimer(options: ITimerOptions<any>): Nullable<Observer<any>>;
  51107. /**
  51108. * An advanced implementation of a timer class
  51109. */
  51110. export class AdvancedTimer<T = any> implements IDisposable {
  51111. /**
  51112. * Will notify each time the timer calculates the remaining time
  51113. */
  51114. onEachCountObservable: Observable<ITimerData<T>>;
  51115. /**
  51116. * Will trigger when the timer was aborted due to the break condition
  51117. */
  51118. onTimerAbortedObservable: Observable<ITimerData<T>>;
  51119. /**
  51120. * Will trigger when the timer ended successfully
  51121. */
  51122. onTimerEndedObservable: Observable<ITimerData<T>>;
  51123. /**
  51124. * Will trigger when the timer state has changed
  51125. */
  51126. onStateChangedObservable: Observable<TimerState>;
  51127. private _observer;
  51128. private _contextObservable;
  51129. private _observableParameters;
  51130. private _startTime;
  51131. private _timer;
  51132. private _state;
  51133. private _breakCondition;
  51134. private _timeToEnd;
  51135. private _breakOnNextTick;
  51136. /**
  51137. * Will construct a new advanced timer based on the options provided. Timer will not start until start() is called.
  51138. * @param options construction options for this advanced timer
  51139. */
  51140. constructor(options: ITimerOptions<T>);
  51141. /**
  51142. * set a breaking condition for this timer. Default is to never break during count
  51143. * @param predicate the new break condition. Returns true to break, false otherwise
  51144. */
  51145. set breakCondition(predicate: (data: ITimerData<T>) => boolean);
  51146. /**
  51147. * Reset ALL associated observables in this advanced timer
  51148. */
  51149. clearObservables(): void;
  51150. /**
  51151. * Will start a new iteration of this timer. Only one instance of this timer can run at a time.
  51152. *
  51153. * @param timeToEnd how much time to measure until timer ended
  51154. */
  51155. start(timeToEnd?: number): void;
  51156. /**
  51157. * Will force a stop on the next tick.
  51158. */
  51159. stop(): void;
  51160. /**
  51161. * Dispose this timer, clearing all resources
  51162. */
  51163. dispose(): void;
  51164. private _setState;
  51165. private _tick;
  51166. private _stop;
  51167. }
  51168. }
  51169. declare module "babylonjs/XR/features/WebXRControllerTeleportation" {
  51170. import { IWebXRFeature } from "babylonjs/XR/webXRFeaturesManager";
  51171. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  51172. import { WebXRInput } from "babylonjs/XR/webXRInput";
  51173. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51174. import { Vector3 } from "babylonjs/Maths/math.vector";
  51175. import { Material } from "babylonjs/Materials/material";
  51176. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  51177. import { Scene } from "babylonjs/scene";
  51178. /**
  51179. * The options container for the teleportation module
  51180. */
  51181. export interface IWebXRTeleportationOptions {
  51182. /**
  51183. * if provided, this scene will be used to render meshes.
  51184. */
  51185. customUtilityLayerScene?: Scene;
  51186. /**
  51187. * Values to configure the default target mesh
  51188. */
  51189. defaultTargetMeshOptions?: {
  51190. /**
  51191. * Fill color of the teleportation area
  51192. */
  51193. teleportationFillColor?: string;
  51194. /**
  51195. * Border color for the teleportation area
  51196. */
  51197. teleportationBorderColor?: string;
  51198. /**
  51199. * Disable the mesh's animation sequence
  51200. */
  51201. disableAnimation?: boolean;
  51202. /**
  51203. * Disable lighting on the material or the ring and arrow
  51204. */
  51205. disableLighting?: boolean;
  51206. /**
  51207. * Override the default material of the torus and arrow
  51208. */
  51209. torusArrowMaterial?: Material;
  51210. };
  51211. /**
  51212. * A list of meshes to use as floor meshes.
  51213. * Meshes can be added and removed after initializing the feature using the
  51214. * addFloorMesh and removeFloorMesh functions
  51215. * If empty, rotation will still work
  51216. */
  51217. floorMeshes?: AbstractMesh[];
  51218. /**
  51219. * use this rendering group id for the meshes (optional)
  51220. */
  51221. renderingGroupId?: number;
  51222. /**
  51223. * Should teleportation move only to snap points
  51224. */
  51225. snapPointsOnly?: boolean;
  51226. /**
  51227. * An array of points to which the teleportation will snap to.
  51228. * If the teleportation ray is in the proximity of one of those points, it will be corrected to this point.
  51229. */
  51230. snapPositions?: Vector3[];
  51231. /**
  51232. * How close should the teleportation ray be in order to snap to position.
  51233. * Default to 0.8 units (meters)
  51234. */
  51235. snapToPositionRadius?: number;
  51236. /**
  51237. * Provide your own teleportation mesh instead of babylon's wonderful doughnut.
  51238. * If you want to support rotation, make sure your mesh has a direction indicator.
  51239. *
  51240. * When left untouched, the default mesh will be initialized.
  51241. */
  51242. teleportationTargetMesh?: AbstractMesh;
  51243. /**
  51244. * If main component is used (no thumbstick), how long should the "long press" take before teleport
  51245. */
  51246. timeToTeleport?: number;
  51247. /**
  51248. * Disable using the thumbstick and use the main component (usually trigger) on long press.
  51249. * This will be automatically true if the controller doesn't have a thumbstick or touchpad.
  51250. */
  51251. useMainComponentOnly?: boolean;
  51252. /**
  51253. * Should meshes created here be added to a utility layer or the main scene
  51254. */
  51255. useUtilityLayer?: boolean;
  51256. /**
  51257. * Babylon XR Input class for controller
  51258. */
  51259. xrInput: WebXRInput;
  51260. /**
  51261. * Meshes that the teleportation ray cannot go through
  51262. */
  51263. pickBlockerMeshes?: AbstractMesh[];
  51264. }
  51265. /**
  51266. * This is a teleportation feature to be used with WebXR-enabled motion controllers.
  51267. * When enabled and attached, the feature will allow a user to move around and rotate in the scene using
  51268. * the input of the attached controllers.
  51269. */
  51270. export class WebXRMotionControllerTeleportation extends WebXRAbstractFeature {
  51271. private _options;
  51272. private _controllers;
  51273. private _currentTeleportationControllerId;
  51274. private _floorMeshes;
  51275. private _quadraticBezierCurve;
  51276. private _selectionFeature;
  51277. private _snapToPositions;
  51278. private _snappedToPoint;
  51279. private _teleportationRingMaterial?;
  51280. private _tmpRay;
  51281. private _tmpVector;
  51282. private _tmpQuaternion;
  51283. /**
  51284. * The module's name
  51285. */
  51286. static readonly Name: string;
  51287. /**
  51288. * The (Babylon) version of this module.
  51289. * This is an integer representing the implementation version.
  51290. * This number does not correspond to the webxr specs version
  51291. */
  51292. static readonly Version: number;
  51293. /**
  51294. * Is movement backwards enabled
  51295. */
  51296. backwardsMovementEnabled: boolean;
  51297. /**
  51298. * Distance to travel when moving backwards
  51299. */
  51300. backwardsTeleportationDistance: number;
  51301. /**
  51302. * The distance from the user to the inspection point in the direction of the controller
  51303. * A higher number will allow the user to move further
  51304. * defaults to 5 (meters, in xr units)
  51305. */
  51306. parabolicCheckRadius: number;
  51307. /**
  51308. * Should the module support parabolic ray on top of direct ray
  51309. * If enabled, the user will be able to point "at the sky" and move according to predefined radius distance
  51310. * Very helpful when moving between floors / different heights
  51311. */
  51312. parabolicRayEnabled: boolean;
  51313. /**
  51314. * How much rotation should be applied when rotating right and left
  51315. */
  51316. rotationAngle: number;
  51317. /**
  51318. * Is rotation enabled when moving forward?
  51319. * Disabling this feature will prevent the user from deciding the direction when teleporting
  51320. */
  51321. rotationEnabled: boolean;
  51322. /**
  51323. * constructs a new anchor system
  51324. * @param _xrSessionManager an instance of WebXRSessionManager
  51325. * @param _options configuration object for this feature
  51326. */
  51327. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRTeleportationOptions);
  51328. /**
  51329. * Get the snapPointsOnly flag
  51330. */
  51331. get snapPointsOnly(): boolean;
  51332. /**
  51333. * Sets the snapPointsOnly flag
  51334. * @param snapToPoints should teleportation be exclusively to snap points
  51335. */
  51336. set snapPointsOnly(snapToPoints: boolean);
  51337. /**
  51338. * Add a new mesh to the floor meshes array
  51339. * @param mesh the mesh to use as floor mesh
  51340. */
  51341. addFloorMesh(mesh: AbstractMesh): void;
  51342. /**
  51343. * Add a new snap-to point to fix teleportation to this position
  51344. * @param newSnapPoint The new Snap-To point
  51345. */
  51346. addSnapPoint(newSnapPoint: Vector3): void;
  51347. attach(): boolean;
  51348. detach(): boolean;
  51349. dispose(): void;
  51350. /**
  51351. * Remove a mesh from the floor meshes array
  51352. * @param mesh the mesh to remove
  51353. */
  51354. removeFloorMesh(mesh: AbstractMesh): void;
  51355. /**
  51356. * Remove a mesh from the floor meshes array using its name
  51357. * @param name the mesh name to remove
  51358. */
  51359. removeFloorMeshByName(name: string): void;
  51360. /**
  51361. * 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
  51362. * @param snapPointToRemove the point (or a clone of it) to be removed from the array
  51363. * @returns was the point found and removed or not
  51364. */
  51365. removeSnapPoint(snapPointToRemove: Vector3): boolean;
  51366. /**
  51367. * This function sets a selection feature that will be disabled when
  51368. * the forward ray is shown and will be reattached when hidden.
  51369. * This is used to remove the selection rays when moving.
  51370. * @param selectionFeature the feature to disable when forward movement is enabled
  51371. */
  51372. setSelectionFeature(selectionFeature: IWebXRFeature): void;
  51373. protected _onXRFrame(_xrFrame: XRFrame): void;
  51374. private _attachController;
  51375. private _createDefaultTargetMesh;
  51376. private _detachController;
  51377. private _findClosestSnapPointWithRadius;
  51378. private _setTargetMeshPosition;
  51379. private _setTargetMeshVisibility;
  51380. private _showParabolicPath;
  51381. private _teleportForward;
  51382. }
  51383. }
  51384. declare module "babylonjs/XR/webXRDefaultExperience" {
  51385. import { WebXRExperienceHelper } from "babylonjs/XR/webXRExperienceHelper";
  51386. import { Scene } from "babylonjs/scene";
  51387. import { WebXRInput, IWebXRInputOptions } from "babylonjs/XR/webXRInput";
  51388. import { WebXRControllerPointerSelection } from "babylonjs/XR/features/WebXRControllerPointerSelection";
  51389. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  51390. import { WebXREnterExitUI, WebXREnterExitUIOptions } from "babylonjs/XR/webXREnterExitUI";
  51391. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51392. import { WebXRManagedOutputCanvasOptions } from "babylonjs/XR/webXRManagedOutputCanvas";
  51393. import { WebXRMotionControllerTeleportation } from "babylonjs/XR/features/WebXRControllerTeleportation";
  51394. /**
  51395. * Options for the default xr helper
  51396. */
  51397. export class WebXRDefaultExperienceOptions {
  51398. /**
  51399. * Enable or disable default UI to enter XR
  51400. */
  51401. disableDefaultUI?: boolean;
  51402. /**
  51403. * Should teleportation not initialize. defaults to false.
  51404. */
  51405. disableTeleportation?: boolean;
  51406. /**
  51407. * Floor meshes that will be used for teleport
  51408. */
  51409. floorMeshes?: Array<AbstractMesh>;
  51410. /**
  51411. * If set to true, the first frame will not be used to reset position
  51412. * The first frame is mainly used when copying transformation from the old camera
  51413. * Mainly used in AR
  51414. */
  51415. ignoreNativeCameraTransformation?: boolean;
  51416. /**
  51417. * Disable the controller mesh-loading. Can be used if you want to load your own meshes
  51418. */
  51419. inputOptions?: IWebXRInputOptions;
  51420. /**
  51421. * optional configuration for the output canvas
  51422. */
  51423. outputCanvasOptions?: WebXRManagedOutputCanvasOptions;
  51424. /**
  51425. * optional UI options. This can be used among other to change session mode and reference space type
  51426. */
  51427. uiOptions?: WebXREnterExitUIOptions;
  51428. /**
  51429. * When loading teleportation and pointer select, use stable versions instead of latest.
  51430. */
  51431. useStablePlugins?: boolean;
  51432. /**
  51433. * An optional rendering group id that will be set globally for teleportation, pointer selection and default controller meshes
  51434. */
  51435. renderingGroupId?: number;
  51436. /**
  51437. * A list of optional features to init the session with
  51438. * If set to true, all features we support will be added
  51439. */
  51440. optionalFeatures?: boolean | string[];
  51441. }
  51442. /**
  51443. * Default experience which provides a similar setup to the previous webVRExperience
  51444. */
  51445. export class WebXRDefaultExperience {
  51446. /**
  51447. * Base experience
  51448. */
  51449. baseExperience: WebXRExperienceHelper;
  51450. /**
  51451. * Enables ui for entering/exiting xr
  51452. */
  51453. enterExitUI: WebXREnterExitUI;
  51454. /**
  51455. * Input experience extension
  51456. */
  51457. input: WebXRInput;
  51458. /**
  51459. * Enables laser pointer and selection
  51460. */
  51461. pointerSelection: WebXRControllerPointerSelection;
  51462. /**
  51463. * Default target xr should render to
  51464. */
  51465. renderTarget: WebXRRenderTarget;
  51466. /**
  51467. * Enables teleportation
  51468. */
  51469. teleportation: WebXRMotionControllerTeleportation;
  51470. private constructor();
  51471. /**
  51472. * Creates the default xr experience
  51473. * @param scene scene
  51474. * @param options options for basic configuration
  51475. * @returns resulting WebXRDefaultExperience
  51476. */
  51477. static CreateAsync(scene: Scene, options?: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  51478. /**
  51479. * DIsposes of the experience helper
  51480. */
  51481. dispose(): void;
  51482. }
  51483. }
  51484. declare module "babylonjs/Cameras/VR/vrExperienceHelper" {
  51485. import { Observable } from "babylonjs/Misc/observable";
  51486. import { Nullable } from "babylonjs/types";
  51487. import { Camera } from "babylonjs/Cameras/camera";
  51488. import { DeviceOrientationCamera } from "babylonjs/Cameras/deviceOrientationCamera";
  51489. import { VRDeviceOrientationFreeCamera } from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  51490. import { WebVROptions, WebVRFreeCamera } from "babylonjs/Cameras/VR/webVRCamera";
  51491. import { Scene } from "babylonjs/scene";
  51492. import { Vector3 } from "babylonjs/Maths/math.vector";
  51493. import { Color3 } from "babylonjs/Maths/math.color";
  51494. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  51495. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51496. import { Mesh } from "babylonjs/Meshes/mesh";
  51497. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  51498. import { EasingFunction } from "babylonjs/Animations/easing";
  51499. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  51500. import "babylonjs/Meshes/Builders/groundBuilder";
  51501. import "babylonjs/Meshes/Builders/torusBuilder";
  51502. import "babylonjs/Meshes/Builders/cylinderBuilder";
  51503. import "babylonjs/Gamepads/gamepadSceneComponent";
  51504. import "babylonjs/Animations/animatable";
  51505. import { WebXRDefaultExperience } from "babylonjs/XR/webXRDefaultExperience";
  51506. /**
  51507. * Options to modify the vr teleportation behavior.
  51508. */
  51509. export interface VRTeleportationOptions {
  51510. /**
  51511. * The name of the mesh which should be used as the teleportation floor. (default: null)
  51512. */
  51513. floorMeshName?: string;
  51514. /**
  51515. * A list of meshes to be used as the teleportation floor. (default: empty)
  51516. */
  51517. floorMeshes?: Mesh[];
  51518. /**
  51519. * The teleportation mode. (default: TELEPORTATIONMODE_CONSTANTTIME)
  51520. */
  51521. teleportationMode?: number;
  51522. /**
  51523. * The duration of the animation in ms, apply when animationMode is TELEPORTATIONMODE_CONSTANTTIME. (default 122ms)
  51524. */
  51525. teleportationTime?: number;
  51526. /**
  51527. * The speed of the animation in distance/sec, apply when animationMode is TELEPORTATIONMODE_CONSTANTSPEED. (default 20 units / sec)
  51528. */
  51529. teleportationSpeed?: number;
  51530. /**
  51531. * The easing function used in the animation or null for Linear. (default CircleEase)
  51532. */
  51533. easingFunction?: EasingFunction;
  51534. }
  51535. /**
  51536. * Options to modify the vr experience helper's behavior.
  51537. */
  51538. export interface VRExperienceHelperOptions extends WebVROptions {
  51539. /**
  51540. * Create a DeviceOrientationCamera to be used as your out of vr camera. (default: true)
  51541. */
  51542. createDeviceOrientationCamera?: boolean;
  51543. /**
  51544. * Create a VRDeviceOrientationFreeCamera to be used for VR when no external HMD is found. (default: true)
  51545. */
  51546. createFallbackVRDeviceOrientationFreeCamera?: boolean;
  51547. /**
  51548. * Uses the main button on the controller to toggle the laser casted. (default: true)
  51549. */
  51550. laserToggle?: boolean;
  51551. /**
  51552. * A list of meshes to be used as the teleportation floor. If specified, teleportation will be enabled (default: undefined)
  51553. */
  51554. floorMeshes?: Mesh[];
  51555. /**
  51556. * Distortion metrics for the fallback vrDeviceOrientationCamera (default: VRCameraMetrics.Default)
  51557. */
  51558. vrDeviceOrientationCameraMetrics?: VRCameraMetrics;
  51559. /**
  51560. * Defines if WebXR should be used instead of WebVR (if available)
  51561. */
  51562. useXR?: boolean;
  51563. }
  51564. /**
  51565. * Event containing information after VR has been entered
  51566. */
  51567. export class OnAfterEnteringVRObservableEvent {
  51568. /**
  51569. * If entering vr was successful
  51570. */
  51571. success: boolean;
  51572. }
  51573. /**
  51574. * Helps to quickly add VR support to an existing scene.
  51575. * See https://doc.babylonjs.com/how_to/webvr_helper
  51576. */
  51577. export class VRExperienceHelper {
  51578. /** Options to modify the vr experience helper's behavior. */
  51579. webVROptions: VRExperienceHelperOptions;
  51580. private _scene;
  51581. private _position;
  51582. private _btnVR;
  51583. private _btnVRDisplayed;
  51584. private _webVRsupported;
  51585. private _webVRready;
  51586. private _webVRrequesting;
  51587. private _webVRpresenting;
  51588. private _hasEnteredVR;
  51589. private _fullscreenVRpresenting;
  51590. private _inputElement;
  51591. private _webVRCamera;
  51592. private _vrDeviceOrientationCamera;
  51593. private _deviceOrientationCamera;
  51594. private _existingCamera;
  51595. private _onKeyDown;
  51596. private _onVrDisplayPresentChange;
  51597. private _onVRDisplayChanged;
  51598. private _onVRRequestPresentStart;
  51599. private _onVRRequestPresentComplete;
  51600. /**
  51601. * 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)
  51602. */
  51603. enableGazeEvenWhenNoPointerLock: boolean;
  51604. /**
  51605. * Gets or sets a boolean indicating that the VREXperienceHelper will exit VR if double tap is detected
  51606. */
  51607. exitVROnDoubleTap: boolean;
  51608. /**
  51609. * Observable raised right before entering VR.
  51610. */
  51611. onEnteringVRObservable: Observable<VRExperienceHelper>;
  51612. /**
  51613. * Observable raised when entering VR has completed.
  51614. */
  51615. onAfterEnteringVRObservable: Observable<OnAfterEnteringVRObservableEvent>;
  51616. /**
  51617. * Observable raised when exiting VR.
  51618. */
  51619. onExitingVRObservable: Observable<VRExperienceHelper>;
  51620. /**
  51621. * Observable raised when controller mesh is loaded.
  51622. */
  51623. onControllerMeshLoadedObservable: Observable<WebVRController>;
  51624. /** Return this.onEnteringVRObservable
  51625. * Note: This one is for backward compatibility. Please use onEnteringVRObservable directly
  51626. */
  51627. get onEnteringVR(): Observable<VRExperienceHelper>;
  51628. /** Return this.onExitingVRObservable
  51629. * Note: This one is for backward compatibility. Please use onExitingVRObservable directly
  51630. */
  51631. get onExitingVR(): Observable<VRExperienceHelper>;
  51632. /** Return this.onControllerMeshLoadedObservable
  51633. * Note: This one is for backward compatibility. Please use onControllerMeshLoadedObservable directly
  51634. */
  51635. get onControllerMeshLoaded(): Observable<WebVRController>;
  51636. private _rayLength;
  51637. private _useCustomVRButton;
  51638. private _teleportationRequested;
  51639. private _teleportActive;
  51640. private _floorMeshName;
  51641. private _floorMeshesCollection;
  51642. private _teleportationMode;
  51643. private _teleportationTime;
  51644. private _teleportationSpeed;
  51645. private _teleportationEasing;
  51646. private _rotationAllowed;
  51647. private _teleportBackwardsVector;
  51648. private _teleportationTarget;
  51649. private _isDefaultTeleportationTarget;
  51650. private _postProcessMove;
  51651. private _teleportationFillColor;
  51652. private _teleportationBorderColor;
  51653. private _rotationAngle;
  51654. private _haloCenter;
  51655. private _cameraGazer;
  51656. private _padSensibilityUp;
  51657. private _padSensibilityDown;
  51658. private _leftController;
  51659. private _rightController;
  51660. private _gazeColor;
  51661. private _laserColor;
  51662. private _pickedLaserColor;
  51663. private _pickedGazeColor;
  51664. /**
  51665. * Observable raised when a new mesh is selected based on meshSelectionPredicate
  51666. */
  51667. onNewMeshSelected: Observable<AbstractMesh>;
  51668. /**
  51669. * Observable raised when a new mesh is selected based on meshSelectionPredicate.
  51670. * This observable will provide the mesh and the controller used to select the mesh
  51671. */
  51672. onMeshSelectedWithController: Observable<{
  51673. mesh: AbstractMesh;
  51674. controller: WebVRController;
  51675. }>;
  51676. /**
  51677. * Observable raised when a new mesh is picked based on meshSelectionPredicate
  51678. */
  51679. onNewMeshPicked: Observable<PickingInfo>;
  51680. private _circleEase;
  51681. /**
  51682. * Observable raised before camera teleportation
  51683. */
  51684. onBeforeCameraTeleport: Observable<Vector3>;
  51685. /**
  51686. * Observable raised after camera teleportation
  51687. */
  51688. onAfterCameraTeleport: Observable<Vector3>;
  51689. /**
  51690. * Observable raised when current selected mesh gets unselected
  51691. */
  51692. onSelectedMeshUnselected: Observable<AbstractMesh>;
  51693. private _raySelectionPredicate;
  51694. /**
  51695. * To be optionaly changed by user to define custom ray selection
  51696. */
  51697. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  51698. /**
  51699. * To be optionaly changed by user to define custom selection logic (after ray selection)
  51700. */
  51701. meshSelectionPredicate: (mesh: AbstractMesh) => boolean;
  51702. /**
  51703. * Set teleportation enabled. If set to false camera teleportation will be disabled but camera rotation will be kept.
  51704. */
  51705. teleportationEnabled: boolean;
  51706. private _defaultHeight;
  51707. private _teleportationInitialized;
  51708. private _interactionsEnabled;
  51709. private _interactionsRequested;
  51710. private _displayGaze;
  51711. private _displayLaserPointer;
  51712. /**
  51713. * The mesh used to display where the user is going to teleport.
  51714. */
  51715. get teleportationTarget(): Mesh;
  51716. /**
  51717. * Sets the mesh to be used to display where the user is going to teleport.
  51718. */
  51719. set teleportationTarget(value: Mesh);
  51720. /**
  51721. * 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
  51722. * when set bakeCurrentTransformIntoVertices will be called on the mesh.
  51723. * See https://doc.babylonjs.com/resources/baking_transformations
  51724. */
  51725. get gazeTrackerMesh(): Mesh;
  51726. set gazeTrackerMesh(value: Mesh);
  51727. /**
  51728. * If the gaze trackers scale should be updated to be constant size when pointing at near/far meshes
  51729. */
  51730. updateGazeTrackerScale: boolean;
  51731. /**
  51732. * If the gaze trackers color should be updated when selecting meshes
  51733. */
  51734. updateGazeTrackerColor: boolean;
  51735. /**
  51736. * If the controller laser color should be updated when selecting meshes
  51737. */
  51738. updateControllerLaserColor: boolean;
  51739. /**
  51740. * The gaze tracking mesh corresponding to the left controller
  51741. */
  51742. get leftControllerGazeTrackerMesh(): Nullable<Mesh>;
  51743. /**
  51744. * The gaze tracking mesh corresponding to the right controller
  51745. */
  51746. get rightControllerGazeTrackerMesh(): Nullable<Mesh>;
  51747. /**
  51748. * If the ray of the gaze should be displayed.
  51749. */
  51750. get displayGaze(): boolean;
  51751. /**
  51752. * Sets if the ray of the gaze should be displayed.
  51753. */
  51754. set displayGaze(value: boolean);
  51755. /**
  51756. * If the ray of the LaserPointer should be displayed.
  51757. */
  51758. get displayLaserPointer(): boolean;
  51759. /**
  51760. * Sets if the ray of the LaserPointer should be displayed.
  51761. */
  51762. set displayLaserPointer(value: boolean);
  51763. /**
  51764. * The deviceOrientationCamera used as the camera when not in VR.
  51765. */
  51766. get deviceOrientationCamera(): Nullable<DeviceOrientationCamera>;
  51767. /**
  51768. * Based on the current WebVR support, returns the current VR camera used.
  51769. */
  51770. get currentVRCamera(): Nullable<Camera>;
  51771. /**
  51772. * The webVRCamera which is used when in VR.
  51773. */
  51774. get webVRCamera(): WebVRFreeCamera;
  51775. /**
  51776. * The deviceOrientationCamera that is used as a fallback when vr device is not connected.
  51777. */
  51778. get vrDeviceOrientationCamera(): Nullable<VRDeviceOrientationFreeCamera>;
  51779. /**
  51780. * The html button that is used to trigger entering into VR.
  51781. */
  51782. get vrButton(): Nullable<HTMLButtonElement>;
  51783. private get _teleportationRequestInitiated();
  51784. /**
  51785. * Defines whether or not Pointer lock should be requested when switching to
  51786. * full screen.
  51787. */
  51788. requestPointerLockOnFullScreen: boolean;
  51789. /**
  51790. * If asking to force XR, this will be populated with the default xr experience
  51791. */
  51792. xr: WebXRDefaultExperience;
  51793. /**
  51794. * Was the XR test done already. If this is true AND this.xr exists, xr is initialized.
  51795. * If this is true and no this.xr, xr exists but is not supported, using WebVR.
  51796. */
  51797. xrTestDone: boolean;
  51798. /**
  51799. * Instantiates a VRExperienceHelper.
  51800. * Helps to quickly add VR support to an existing scene.
  51801. * @param scene The scene the VRExperienceHelper belongs to.
  51802. * @param webVROptions Options to modify the vr experience helper's behavior.
  51803. */
  51804. constructor(scene: Scene,
  51805. /** Options to modify the vr experience helper's behavior. */
  51806. webVROptions?: VRExperienceHelperOptions);
  51807. private completeVRInit;
  51808. private _onDefaultMeshLoaded;
  51809. private _onResize;
  51810. private _onFullscreenChange;
  51811. /**
  51812. * Gets a value indicating if we are currently in VR mode.
  51813. */
  51814. get isInVRMode(): boolean;
  51815. private onVrDisplayPresentChange;
  51816. private onVRDisplayChanged;
  51817. private moveButtonToBottomRight;
  51818. private displayVRButton;
  51819. private updateButtonVisibility;
  51820. private _cachedAngularSensibility;
  51821. /**
  51822. * Attempt to enter VR. If a headset is connected and ready, will request present on that.
  51823. * Otherwise, will use the fullscreen API.
  51824. */
  51825. enterVR(): void;
  51826. /**
  51827. * Attempt to exit VR, or fullscreen.
  51828. */
  51829. exitVR(): void;
  51830. /**
  51831. * The position of the vr experience helper.
  51832. */
  51833. get position(): Vector3;
  51834. /**
  51835. * Sets the position of the vr experience helper.
  51836. */
  51837. set position(value: Vector3);
  51838. /**
  51839. * Enables controllers and user interactions such as selecting and object or clicking on an object.
  51840. */
  51841. enableInteractions(): void;
  51842. private get _noControllerIsActive();
  51843. private beforeRender;
  51844. private _isTeleportationFloor;
  51845. /**
  51846. * Adds a floor mesh to be used for teleportation.
  51847. * @param floorMesh the mesh to be used for teleportation.
  51848. */
  51849. addFloorMesh(floorMesh: Mesh): void;
  51850. /**
  51851. * Removes a floor mesh from being used for teleportation.
  51852. * @param floorMesh the mesh to be removed.
  51853. */
  51854. removeFloorMesh(floorMesh: Mesh): void;
  51855. /**
  51856. * Enables interactions and teleportation using the VR controllers and gaze.
  51857. * @param vrTeleportationOptions options to modify teleportation behavior.
  51858. */
  51859. enableTeleportation(vrTeleportationOptions?: VRTeleportationOptions): void;
  51860. private _onNewGamepadConnected;
  51861. private _tryEnableInteractionOnController;
  51862. private _onNewGamepadDisconnected;
  51863. private _enableInteractionOnController;
  51864. private _checkTeleportWithRay;
  51865. private _checkRotate;
  51866. private _checkTeleportBackwards;
  51867. private _enableTeleportationOnController;
  51868. private _createTeleportationCircles;
  51869. private _displayTeleportationTarget;
  51870. private _hideTeleportationTarget;
  51871. private _rotateCamera;
  51872. private _moveTeleportationSelectorTo;
  51873. private _workingVector;
  51874. private _workingQuaternion;
  51875. private _workingMatrix;
  51876. /**
  51877. * Time Constant Teleportation Mode
  51878. */
  51879. static readonly TELEPORTATIONMODE_CONSTANTTIME: number;
  51880. /**
  51881. * Speed Constant Teleportation Mode
  51882. */
  51883. static readonly TELEPORTATIONMODE_CONSTANTSPEED: number;
  51884. /**
  51885. * Teleports the users feet to the desired location
  51886. * @param location The location where the user's feet should be placed
  51887. */
  51888. teleportCamera(location: Vector3): void;
  51889. private _convertNormalToDirectionOfRay;
  51890. private _castRayAndSelectObject;
  51891. private _notifySelectedMeshUnselected;
  51892. /**
  51893. * Permanently set new colors for the laser pointer
  51894. * @param color the new laser color
  51895. * @param pickedColor the new laser color when picked mesh detected
  51896. */
  51897. setLaserColor(color: Color3, pickedColor?: Color3): void;
  51898. /**
  51899. * Set lighting enabled / disabled on the laser pointer of both controllers
  51900. * @param enabled should the lighting be enabled on the laser pointer
  51901. */
  51902. setLaserLightingState(enabled?: boolean): void;
  51903. /**
  51904. * Permanently set new colors for the gaze pointer
  51905. * @param color the new gaze color
  51906. * @param pickedColor the new gaze color when picked mesh detected
  51907. */
  51908. setGazeColor(color: Color3, pickedColor?: Color3): void;
  51909. /**
  51910. * Sets the color of the laser ray from the vr controllers.
  51911. * @param color new color for the ray.
  51912. */
  51913. changeLaserColor(color: Color3): void;
  51914. /**
  51915. * Sets the color of the ray from the vr headsets gaze.
  51916. * @param color new color for the ray.
  51917. */
  51918. changeGazeColor(color: Color3): void;
  51919. /**
  51920. * Exits VR and disposes of the vr experience helper
  51921. */
  51922. dispose(): void;
  51923. /**
  51924. * Gets the name of the VRExperienceHelper class
  51925. * @returns "VRExperienceHelper"
  51926. */
  51927. getClassName(): string;
  51928. }
  51929. }
  51930. declare module "babylonjs/Cameras/VR/index" {
  51931. export * from "babylonjs/Cameras/VR/vrCameraMetrics";
  51932. export * from "babylonjs/Cameras/VR/vrDeviceOrientationArcRotateCamera";
  51933. export * from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  51934. export * from "babylonjs/Cameras/VR/vrDeviceOrientationGamepadCamera";
  51935. export * from "babylonjs/Cameras/VR/vrExperienceHelper";
  51936. export * from "babylonjs/Cameras/VR/webVRCamera";
  51937. }
  51938. declare module "babylonjs/Cameras/RigModes/index" {
  51939. export * from "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  51940. export * from "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  51941. export * from "babylonjs/Cameras/RigModes/vrRigMode";
  51942. export * from "babylonjs/Cameras/RigModes/webVRRigMode";
  51943. }
  51944. declare module "babylonjs/Cameras/index" {
  51945. export * from "babylonjs/Cameras/Inputs/index";
  51946. export * from "babylonjs/Cameras/cameraInputsManager";
  51947. export * from "babylonjs/Cameras/camera";
  51948. export * from "babylonjs/Cameras/targetCamera";
  51949. export * from "babylonjs/Cameras/freeCamera";
  51950. export * from "babylonjs/Cameras/freeCameraInputsManager";
  51951. export * from "babylonjs/Cameras/touchCamera";
  51952. export * from "babylonjs/Cameras/arcRotateCamera";
  51953. export * from "babylonjs/Cameras/arcRotateCameraInputsManager";
  51954. export * from "babylonjs/Cameras/deviceOrientationCamera";
  51955. export * from "babylonjs/Cameras/flyCamera";
  51956. export * from "babylonjs/Cameras/flyCameraInputsManager";
  51957. export * from "babylonjs/Cameras/followCamera";
  51958. export * from "babylonjs/Cameras/followCameraInputsManager";
  51959. export * from "babylonjs/Cameras/gamepadCamera";
  51960. export * from "babylonjs/Cameras/Stereoscopic/index";
  51961. export * from "babylonjs/Cameras/universalCamera";
  51962. export * from "babylonjs/Cameras/virtualJoysticksCamera";
  51963. export * from "babylonjs/Cameras/VR/index";
  51964. export * from "babylonjs/Cameras/RigModes/index";
  51965. }
  51966. declare module "babylonjs/Collisions/index" {
  51967. export * from "babylonjs/Collisions/collider";
  51968. export * from "babylonjs/Collisions/collisionCoordinator";
  51969. export * from "babylonjs/Collisions/pickingInfo";
  51970. export * from "babylonjs/Collisions/intersectionInfo";
  51971. export * from "babylonjs/Collisions/meshCollisionData";
  51972. }
  51973. declare module "babylonjs/Culling/Octrees/octreeBlock" {
  51974. import { SmartArrayNoDuplicate } from "babylonjs/Misc/smartArray";
  51975. import { Vector3 } from "babylonjs/Maths/math.vector";
  51976. import { Ray } from "babylonjs/Culling/ray";
  51977. import { Plane } from "babylonjs/Maths/math.plane";
  51978. /**
  51979. * Contains an array of blocks representing the octree
  51980. */
  51981. export interface IOctreeContainer<T> {
  51982. /**
  51983. * Blocks within the octree
  51984. */
  51985. blocks: Array<OctreeBlock<T>>;
  51986. }
  51987. /**
  51988. * Class used to store a cell in an octree
  51989. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  51990. */
  51991. export class OctreeBlock<T> {
  51992. /**
  51993. * Gets the content of the current block
  51994. */
  51995. entries: T[];
  51996. /**
  51997. * Gets the list of block children
  51998. */
  51999. blocks: Array<OctreeBlock<T>>;
  52000. private _depth;
  52001. private _maxDepth;
  52002. private _capacity;
  52003. private _minPoint;
  52004. private _maxPoint;
  52005. private _boundingVectors;
  52006. private _creationFunc;
  52007. /**
  52008. * Creates a new block
  52009. * @param minPoint defines the minimum vector (in world space) of the block's bounding box
  52010. * @param maxPoint defines the maximum vector (in world space) of the block's bounding box
  52011. * @param capacity defines the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  52012. * @param depth defines the current depth of this block in the octree
  52013. * @param maxDepth defines the maximal depth allowed (beyond this value, the capacity is ignored)
  52014. * @param creationFunc defines a callback to call when an element is added to the block
  52015. */
  52016. constructor(minPoint: Vector3, maxPoint: Vector3, capacity: number, depth: number, maxDepth: number, creationFunc: (entry: T, block: OctreeBlock<T>) => void);
  52017. /**
  52018. * Gets the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  52019. */
  52020. get capacity(): number;
  52021. /**
  52022. * Gets the minimum vector (in world space) of the block's bounding box
  52023. */
  52024. get minPoint(): Vector3;
  52025. /**
  52026. * Gets the maximum vector (in world space) of the block's bounding box
  52027. */
  52028. get maxPoint(): Vector3;
  52029. /**
  52030. * Add a new element to this block
  52031. * @param entry defines the element to add
  52032. */
  52033. addEntry(entry: T): void;
  52034. /**
  52035. * Remove an element from this block
  52036. * @param entry defines the element to remove
  52037. */
  52038. removeEntry(entry: T): void;
  52039. /**
  52040. * Add an array of elements to this block
  52041. * @param entries defines the array of elements to add
  52042. */
  52043. addEntries(entries: T[]): void;
  52044. /**
  52045. * Test if the current block intersects the furstum planes and if yes, then add its content to the selection array
  52046. * @param frustumPlanes defines the frustum planes to test
  52047. * @param selection defines the array to store current content if selection is positive
  52048. * @param allowDuplicate defines if the selection array can contains duplicated entries
  52049. */
  52050. select(frustumPlanes: Plane[], selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  52051. /**
  52052. * Test if the current block intersect with the given bounding sphere and if yes, then add its content to the selection array
  52053. * @param sphereCenter defines the bounding sphere center
  52054. * @param sphereRadius defines the bounding sphere radius
  52055. * @param selection defines the array to store current content if selection is positive
  52056. * @param allowDuplicate defines if the selection array can contains duplicated entries
  52057. */
  52058. intersects(sphereCenter: Vector3, sphereRadius: number, selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  52059. /**
  52060. * Test if the current block intersect with the given ray and if yes, then add its content to the selection array
  52061. * @param ray defines the ray to test with
  52062. * @param selection defines the array to store current content if selection is positive
  52063. */
  52064. intersectsRay(ray: Ray, selection: SmartArrayNoDuplicate<T>): void;
  52065. /**
  52066. * Subdivide the content into child blocks (this block will then be empty)
  52067. */
  52068. createInnerBlocks(): void;
  52069. /**
  52070. * @hidden
  52071. */
  52072. 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;
  52073. }
  52074. }
  52075. declare module "babylonjs/Culling/Octrees/octree" {
  52076. import { SmartArray } from "babylonjs/Misc/smartArray";
  52077. import { Vector3 } from "babylonjs/Maths/math.vector";
  52078. import { SubMesh } from "babylonjs/Meshes/subMesh";
  52079. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52080. import { Ray } from "babylonjs/Culling/ray";
  52081. import { OctreeBlock } from "babylonjs/Culling/Octrees/octreeBlock";
  52082. import { Plane } from "babylonjs/Maths/math.plane";
  52083. /**
  52084. * Octrees are a really powerful data structure that can quickly select entities based on space coordinates.
  52085. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  52086. */
  52087. export class Octree<T> {
  52088. /** 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.) */
  52089. maxDepth: number;
  52090. /**
  52091. * Blocks within the octree containing objects
  52092. */
  52093. blocks: Array<OctreeBlock<T>>;
  52094. /**
  52095. * Content stored in the octree
  52096. */
  52097. dynamicContent: T[];
  52098. private _maxBlockCapacity;
  52099. private _selectionContent;
  52100. private _creationFunc;
  52101. /**
  52102. * Creates a octree
  52103. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  52104. * @param creationFunc function to be used to instatiate the octree
  52105. * @param maxBlockCapacity defines the maximum number of meshes you want on your octree's leaves (default: 64)
  52106. * @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.)
  52107. */
  52108. constructor(creationFunc: (entry: T, block: OctreeBlock<T>) => void, maxBlockCapacity?: number,
  52109. /** 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.) */
  52110. maxDepth?: number);
  52111. /**
  52112. * Updates the octree by adding blocks for the passed in meshes within the min and max world parameters
  52113. * @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);
  52114. * @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);
  52115. * @param entries meshes to be added to the octree blocks
  52116. */
  52117. update(worldMin: Vector3, worldMax: Vector3, entries: T[]): void;
  52118. /**
  52119. * Adds a mesh to the octree
  52120. * @param entry Mesh to add to the octree
  52121. */
  52122. addMesh(entry: T): void;
  52123. /**
  52124. * Remove an element from the octree
  52125. * @param entry defines the element to remove
  52126. */
  52127. removeMesh(entry: T): void;
  52128. /**
  52129. * Selects an array of meshes within the frustum
  52130. * @param frustumPlanes The frustum planes to use which will select all meshes within it
  52131. * @param allowDuplicate If duplicate objects are allowed in the resulting object array
  52132. * @returns array of meshes within the frustum
  52133. */
  52134. select(frustumPlanes: Plane[], allowDuplicate?: boolean): SmartArray<T>;
  52135. /**
  52136. * Test if the octree intersect with the given bounding sphere and if yes, then add its content to the selection array
  52137. * @param sphereCenter defines the bounding sphere center
  52138. * @param sphereRadius defines the bounding sphere radius
  52139. * @param allowDuplicate defines if the selection array can contains duplicated entries
  52140. * @returns an array of objects that intersect the sphere
  52141. */
  52142. intersects(sphereCenter: Vector3, sphereRadius: number, allowDuplicate?: boolean): SmartArray<T>;
  52143. /**
  52144. * Test if the octree intersect with the given ray and if yes, then add its content to resulting array
  52145. * @param ray defines the ray to test with
  52146. * @returns array of intersected objects
  52147. */
  52148. intersectsRay(ray: Ray): SmartArray<T>;
  52149. /**
  52150. * Adds a mesh into the octree block if it intersects the block
  52151. */
  52152. static CreationFuncForMeshes: (entry: AbstractMesh, block: OctreeBlock<AbstractMesh>) => void;
  52153. /**
  52154. * Adds a submesh into the octree block if it intersects the block
  52155. */
  52156. static CreationFuncForSubMeshes: (entry: SubMesh, block: OctreeBlock<SubMesh>) => void;
  52157. }
  52158. }
  52159. declare module "babylonjs/Culling/Octrees/octreeSceneComponent" {
  52160. import { ISmartArrayLike } from "babylonjs/Misc/smartArray";
  52161. import { Scene } from "babylonjs/scene";
  52162. import { SubMesh } from "babylonjs/Meshes/subMesh";
  52163. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52164. import { Ray } from "babylonjs/Culling/ray";
  52165. import { Octree } from "babylonjs/Culling/Octrees/octree";
  52166. import { Collider } from "babylonjs/Collisions/collider";
  52167. module "babylonjs/scene" {
  52168. interface Scene {
  52169. /**
  52170. * @hidden
  52171. * Backing Filed
  52172. */
  52173. _selectionOctree: Octree<AbstractMesh>;
  52174. /**
  52175. * Gets the octree used to boost mesh selection (picking)
  52176. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  52177. */
  52178. selectionOctree: Octree<AbstractMesh>;
  52179. /**
  52180. * Creates or updates the octree used to boost selection (picking)
  52181. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  52182. * @param maxCapacity defines the maximum capacity per leaf
  52183. * @param maxDepth defines the maximum depth of the octree
  52184. * @returns an octree of AbstractMesh
  52185. */
  52186. createOrUpdateSelectionOctree(maxCapacity?: number, maxDepth?: number): Octree<AbstractMesh>;
  52187. }
  52188. }
  52189. module "babylonjs/Meshes/abstractMesh" {
  52190. interface AbstractMesh {
  52191. /**
  52192. * @hidden
  52193. * Backing Field
  52194. */
  52195. _submeshesOctree: Octree<SubMesh>;
  52196. /**
  52197. * This function will create an octree to help to select the right submeshes for rendering, picking and collision computations.
  52198. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  52199. * @param maxCapacity defines the maximum size of each block (64 by default)
  52200. * @param maxDepth defines the maximum depth to use (no more than 2 levels by default)
  52201. * @returns the new octree
  52202. * @see https://www.babylonjs-playground.com/#NA4OQ#12
  52203. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  52204. */
  52205. createOrUpdateSubmeshesOctree(maxCapacity?: number, maxDepth?: number): Octree<SubMesh>;
  52206. }
  52207. }
  52208. /**
  52209. * Defines the octree scene component responsible to manage any octrees
  52210. * in a given scene.
  52211. */
  52212. export class OctreeSceneComponent {
  52213. /**
  52214. * The component name help to identify the component in the list of scene components.
  52215. */
  52216. readonly name: string;
  52217. /**
  52218. * The scene the component belongs to.
  52219. */
  52220. scene: Scene;
  52221. /**
  52222. * Indicates if the meshes have been checked to make sure they are isEnabled()
  52223. */
  52224. readonly checksIsEnabled: boolean;
  52225. /**
  52226. * Creates a new instance of the component for the given scene
  52227. * @param scene Defines the scene to register the component in
  52228. */
  52229. constructor(scene: Scene);
  52230. /**
  52231. * Registers the component in a given scene
  52232. */
  52233. register(): void;
  52234. /**
  52235. * Return the list of active meshes
  52236. * @returns the list of active meshes
  52237. */
  52238. getActiveMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  52239. /**
  52240. * Return the list of active sub meshes
  52241. * @param mesh The mesh to get the candidates sub meshes from
  52242. * @returns the list of active sub meshes
  52243. */
  52244. getActiveSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  52245. private _tempRay;
  52246. /**
  52247. * Return the list of sub meshes intersecting with a given local ray
  52248. * @param mesh defines the mesh to find the submesh for
  52249. * @param localRay defines the ray in local space
  52250. * @returns the list of intersecting sub meshes
  52251. */
  52252. getIntersectingSubMeshCandidates(mesh: AbstractMesh, localRay: Ray): ISmartArrayLike<SubMesh>;
  52253. /**
  52254. * Return the list of sub meshes colliding with a collider
  52255. * @param mesh defines the mesh to find the submesh for
  52256. * @param collider defines the collider to evaluate the collision against
  52257. * @returns the list of colliding sub meshes
  52258. */
  52259. getCollidingSubMeshCandidates(mesh: AbstractMesh, collider: Collider): ISmartArrayLike<SubMesh>;
  52260. /**
  52261. * Rebuilds the elements related to this component in case of
  52262. * context lost for instance.
  52263. */
  52264. rebuild(): void;
  52265. /**
  52266. * Disposes the component and the associated ressources.
  52267. */
  52268. dispose(): void;
  52269. }
  52270. }
  52271. declare module "babylonjs/Culling/Octrees/index" {
  52272. export * from "babylonjs/Culling/Octrees/octree";
  52273. export * from "babylonjs/Culling/Octrees/octreeBlock";
  52274. export * from "babylonjs/Culling/Octrees/octreeSceneComponent";
  52275. }
  52276. declare module "babylonjs/Culling/index" {
  52277. export * from "babylonjs/Culling/boundingBox";
  52278. export * from "babylonjs/Culling/boundingInfo";
  52279. export * from "babylonjs/Culling/boundingSphere";
  52280. export * from "babylonjs/Culling/Octrees/index";
  52281. export * from "babylonjs/Culling/ray";
  52282. }
  52283. declare module "babylonjs/Gizmos/gizmo" {
  52284. import { Nullable } from "babylonjs/types";
  52285. import { IDisposable } from "babylonjs/scene";
  52286. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52287. import { Mesh } from "babylonjs/Meshes/mesh";
  52288. import { Node } from "babylonjs/node";
  52289. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  52290. /**
  52291. * Renders gizmos on top of an existing scene which provide controls for position, rotation, etc.
  52292. */
  52293. export class Gizmo implements IDisposable {
  52294. /** The utility layer the gizmo will be added to */
  52295. gizmoLayer: UtilityLayerRenderer;
  52296. /**
  52297. * The root mesh of the gizmo
  52298. */
  52299. _rootMesh: Mesh;
  52300. private _attachedMesh;
  52301. private _attachedNode;
  52302. /**
  52303. * Ratio for the scale of the gizmo (Default: 1)
  52304. */
  52305. protected _scaleRatio: number;
  52306. /**
  52307. * Ratio for the scale of the gizmo (Default: 1)
  52308. */
  52309. set scaleRatio(value: number);
  52310. get scaleRatio(): number;
  52311. /**
  52312. * If a custom mesh has been set (Default: false)
  52313. */
  52314. protected _customMeshSet: boolean;
  52315. /**
  52316. * Mesh that the gizmo will be attached to. (eg. on a drag gizmo the mesh that will be dragged)
  52317. * * When set, interactions will be enabled
  52318. */
  52319. get attachedMesh(): Nullable<AbstractMesh>;
  52320. set attachedMesh(value: Nullable<AbstractMesh>);
  52321. /**
  52322. * Node that the gizmo will be attached to. (eg. on a drag gizmo the mesh, bone or NodeTransform that will be dragged)
  52323. * * When set, interactions will be enabled
  52324. */
  52325. get attachedNode(): Nullable<Node>;
  52326. set attachedNode(value: Nullable<Node>);
  52327. /**
  52328. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  52329. * @param mesh The mesh to replace the default mesh of the gizmo
  52330. */
  52331. setCustomMesh(mesh: Mesh): void;
  52332. protected _updateGizmoRotationToMatchAttachedMesh: boolean;
  52333. /**
  52334. * If set the gizmo's rotation will be updated to match the attached mesh each frame (Default: true)
  52335. */
  52336. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  52337. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  52338. /**
  52339. * If set the gizmo's position will be updated to match the attached mesh each frame (Default: true)
  52340. */
  52341. updateGizmoPositionToMatchAttachedMesh: boolean;
  52342. /**
  52343. * When set, the gizmo will always appear the same size no matter where the camera is (default: true)
  52344. */
  52345. updateScale: boolean;
  52346. protected _interactionsEnabled: boolean;
  52347. protected _attachedNodeChanged(value: Nullable<Node>): void;
  52348. private _beforeRenderObserver;
  52349. private _tempQuaternion;
  52350. private _tempVector;
  52351. private _tempVector2;
  52352. private _tempMatrix1;
  52353. private _tempMatrix2;
  52354. private _rightHandtoLeftHandMatrix;
  52355. /**
  52356. * Creates a gizmo
  52357. * @param gizmoLayer The utility layer the gizmo will be added to
  52358. */
  52359. constructor(
  52360. /** The utility layer the gizmo will be added to */
  52361. gizmoLayer?: UtilityLayerRenderer);
  52362. /**
  52363. * Updates the gizmo to match the attached mesh's position/rotation
  52364. */
  52365. protected _update(): void;
  52366. /**
  52367. * computes the rotation/scaling/position of the transform once the Node world matrix has changed.
  52368. * @param value Node, TransformNode or mesh
  52369. */
  52370. protected _matrixChanged(): void;
  52371. /**
  52372. * Disposes of the gizmo
  52373. */
  52374. dispose(): void;
  52375. }
  52376. }
  52377. declare module "babylonjs/Gizmos/planeDragGizmo" {
  52378. import { Observable } from "babylonjs/Misc/observable";
  52379. import { Nullable } from "babylonjs/types";
  52380. import { Vector3 } from "babylonjs/Maths/math.vector";
  52381. import { Color3 } from "babylonjs/Maths/math.color";
  52382. import { TransformNode } from "babylonjs/Meshes/transformNode";
  52383. import { Node } from "babylonjs/node";
  52384. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  52385. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  52386. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  52387. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  52388. import { Scene } from "babylonjs/scene";
  52389. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  52390. /**
  52391. * Single plane drag gizmo
  52392. */
  52393. export class PlaneDragGizmo extends Gizmo {
  52394. /**
  52395. * Drag behavior responsible for the gizmos dragging interactions
  52396. */
  52397. dragBehavior: PointerDragBehavior;
  52398. private _pointerObserver;
  52399. /**
  52400. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  52401. */
  52402. snapDistance: number;
  52403. /**
  52404. * Event that fires each time the gizmo snaps to a new location.
  52405. * * snapDistance is the the change in distance
  52406. */
  52407. onSnapObservable: Observable<{
  52408. snapDistance: number;
  52409. }>;
  52410. private _plane;
  52411. private _coloredMaterial;
  52412. private _hoverMaterial;
  52413. private _isEnabled;
  52414. private _parent;
  52415. /** @hidden */
  52416. static _CreatePlane(scene: Scene, material: StandardMaterial): TransformNode;
  52417. /** @hidden */
  52418. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  52419. /**
  52420. * Creates a PlaneDragGizmo
  52421. * @param gizmoLayer The utility layer the gizmo will be added to
  52422. * @param dragPlaneNormal The axis normal to which the gizmo will be able to drag on
  52423. * @param color The color of the gizmo
  52424. */
  52425. constructor(dragPlaneNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  52426. protected _attachedNodeChanged(value: Nullable<Node>): void;
  52427. /**
  52428. * If the gizmo is enabled
  52429. */
  52430. set isEnabled(value: boolean);
  52431. get isEnabled(): boolean;
  52432. /**
  52433. * Disposes of the gizmo
  52434. */
  52435. dispose(): void;
  52436. }
  52437. }
  52438. declare module "babylonjs/Gizmos/positionGizmo" {
  52439. import { Observable } from "babylonjs/Misc/observable";
  52440. import { Nullable } from "babylonjs/types";
  52441. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52442. import { Node } from "babylonjs/node";
  52443. import { Mesh } from "babylonjs/Meshes/mesh";
  52444. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  52445. import { AxisDragGizmo } from "babylonjs/Gizmos/axisDragGizmo";
  52446. import { PlaneDragGizmo } from "babylonjs/Gizmos/planeDragGizmo";
  52447. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  52448. /**
  52449. * Gizmo that enables dragging a mesh along 3 axis
  52450. */
  52451. export class PositionGizmo extends Gizmo {
  52452. /**
  52453. * Internal gizmo used for interactions on the x axis
  52454. */
  52455. xGizmo: AxisDragGizmo;
  52456. /**
  52457. * Internal gizmo used for interactions on the y axis
  52458. */
  52459. yGizmo: AxisDragGizmo;
  52460. /**
  52461. * Internal gizmo used for interactions on the z axis
  52462. */
  52463. zGizmo: AxisDragGizmo;
  52464. /**
  52465. * Internal gizmo used for interactions on the yz plane
  52466. */
  52467. xPlaneGizmo: PlaneDragGizmo;
  52468. /**
  52469. * Internal gizmo used for interactions on the xz plane
  52470. */
  52471. yPlaneGizmo: PlaneDragGizmo;
  52472. /**
  52473. * Internal gizmo used for interactions on the xy plane
  52474. */
  52475. zPlaneGizmo: PlaneDragGizmo;
  52476. /**
  52477. * private variables
  52478. */
  52479. private _meshAttached;
  52480. private _nodeAttached;
  52481. private _snapDistance;
  52482. /** Fires an event when any of it's sub gizmos are dragged */
  52483. onDragStartObservable: Observable<unknown>;
  52484. /** Fires an event when any of it's sub gizmos are released from dragging */
  52485. onDragEndObservable: Observable<unknown>;
  52486. /**
  52487. * If set to true, planar drag is enabled
  52488. */
  52489. private _planarGizmoEnabled;
  52490. get attachedMesh(): Nullable<AbstractMesh>;
  52491. set attachedMesh(mesh: Nullable<AbstractMesh>);
  52492. get attachedNode(): Nullable<Node>;
  52493. set attachedNode(node: Nullable<Node>);
  52494. /**
  52495. * Creates a PositionGizmo
  52496. * @param gizmoLayer The utility layer the gizmo will be added to
  52497. @param thickness display gizmo axis thickness
  52498. */
  52499. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number);
  52500. /**
  52501. * If the planar drag gizmo is enabled
  52502. * setting this will enable/disable XY, XZ and YZ planes regardless of individual gizmo settings.
  52503. */
  52504. set planarGizmoEnabled(value: boolean);
  52505. get planarGizmoEnabled(): boolean;
  52506. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  52507. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  52508. /**
  52509. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  52510. */
  52511. set snapDistance(value: number);
  52512. get snapDistance(): number;
  52513. /**
  52514. * Ratio for the scale of the gizmo (Default: 1)
  52515. */
  52516. set scaleRatio(value: number);
  52517. get scaleRatio(): number;
  52518. /**
  52519. * Disposes of the gizmo
  52520. */
  52521. dispose(): void;
  52522. /**
  52523. * CustomMeshes are not supported by this gizmo
  52524. * @param mesh The mesh to replace the default mesh of the gizmo
  52525. */
  52526. setCustomMesh(mesh: Mesh): void;
  52527. }
  52528. }
  52529. declare module "babylonjs/Gizmos/axisDragGizmo" {
  52530. import { Observable } from "babylonjs/Misc/observable";
  52531. import { Nullable } from "babylonjs/types";
  52532. import { Vector3 } from "babylonjs/Maths/math.vector";
  52533. import { TransformNode } from "babylonjs/Meshes/transformNode";
  52534. import { Node } from "babylonjs/node";
  52535. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  52536. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  52537. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  52538. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  52539. import { Scene } from "babylonjs/scene";
  52540. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  52541. import { Color3 } from "babylonjs/Maths/math.color";
  52542. /**
  52543. * Single axis drag gizmo
  52544. */
  52545. export class AxisDragGizmo extends Gizmo {
  52546. /**
  52547. * Drag behavior responsible for the gizmos dragging interactions
  52548. */
  52549. dragBehavior: PointerDragBehavior;
  52550. private _pointerObserver;
  52551. /**
  52552. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  52553. */
  52554. snapDistance: number;
  52555. /**
  52556. * Event that fires each time the gizmo snaps to a new location.
  52557. * * snapDistance is the the change in distance
  52558. */
  52559. onSnapObservable: Observable<{
  52560. snapDistance: number;
  52561. }>;
  52562. private _isEnabled;
  52563. private _parent;
  52564. private _arrow;
  52565. private _coloredMaterial;
  52566. private _hoverMaterial;
  52567. /** @hidden */
  52568. static _CreateArrow(scene: Scene, material: StandardMaterial, thickness?: number): TransformNode;
  52569. /** @hidden */
  52570. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  52571. /**
  52572. * Creates an AxisDragGizmo
  52573. * @param gizmoLayer The utility layer the gizmo will be added to
  52574. * @param dragAxis The axis which the gizmo will be able to drag on
  52575. * @param color The color of the gizmo
  52576. * @param thickness display gizmo axis thickness
  52577. */
  52578. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>, thickness?: number);
  52579. protected _attachedNodeChanged(value: Nullable<Node>): void;
  52580. /**
  52581. * If the gizmo is enabled
  52582. */
  52583. set isEnabled(value: boolean);
  52584. get isEnabled(): boolean;
  52585. /**
  52586. * Disposes of the gizmo
  52587. */
  52588. dispose(): void;
  52589. }
  52590. }
  52591. declare module "babylonjs/Debug/axesViewer" {
  52592. import { Vector3 } from "babylonjs/Maths/math.vector";
  52593. import { Nullable } from "babylonjs/types";
  52594. import { Scene } from "babylonjs/scene";
  52595. import { TransformNode } from "babylonjs/Meshes/transformNode";
  52596. /**
  52597. * The Axes viewer will show 3 axes in a specific point in space
  52598. */
  52599. export class AxesViewer {
  52600. private _xAxis;
  52601. private _yAxis;
  52602. private _zAxis;
  52603. private _scaleLinesFactor;
  52604. private _instanced;
  52605. /**
  52606. * Gets the hosting scene
  52607. */
  52608. scene: Nullable<Scene>;
  52609. /**
  52610. * Gets or sets a number used to scale line length
  52611. */
  52612. scaleLines: number;
  52613. /** Gets the node hierarchy used to render x-axis */
  52614. get xAxis(): TransformNode;
  52615. /** Gets the node hierarchy used to render y-axis */
  52616. get yAxis(): TransformNode;
  52617. /** Gets the node hierarchy used to render z-axis */
  52618. get zAxis(): TransformNode;
  52619. /**
  52620. * Creates a new AxesViewer
  52621. * @param scene defines the hosting scene
  52622. * @param scaleLines defines a number used to scale line length (1 by default)
  52623. * @param renderingGroupId defines a number used to set the renderingGroupId of the meshes (2 by default)
  52624. * @param xAxis defines the node hierarchy used to render the x-axis
  52625. * @param yAxis defines the node hierarchy used to render the y-axis
  52626. * @param zAxis defines the node hierarchy used to render the z-axis
  52627. */
  52628. constructor(scene: Scene, scaleLines?: number, renderingGroupId?: Nullable<number>, xAxis?: TransformNode, yAxis?: TransformNode, zAxis?: TransformNode);
  52629. /**
  52630. * Force the viewer to update
  52631. * @param position defines the position of the viewer
  52632. * @param xaxis defines the x axis of the viewer
  52633. * @param yaxis defines the y axis of the viewer
  52634. * @param zaxis defines the z axis of the viewer
  52635. */
  52636. update(position: Vector3, xaxis: Vector3, yaxis: Vector3, zaxis: Vector3): void;
  52637. /**
  52638. * Creates an instance of this axes viewer.
  52639. * @returns a new axes viewer with instanced meshes
  52640. */
  52641. createInstance(): AxesViewer;
  52642. /** Releases resources */
  52643. dispose(): void;
  52644. private static _SetRenderingGroupId;
  52645. }
  52646. }
  52647. declare module "babylonjs/Debug/boneAxesViewer" {
  52648. import { Nullable } from "babylonjs/types";
  52649. import { AxesViewer } from "babylonjs/Debug/axesViewer";
  52650. import { Vector3 } from "babylonjs/Maths/math.vector";
  52651. import { Mesh } from "babylonjs/Meshes/mesh";
  52652. import { Bone } from "babylonjs/Bones/bone";
  52653. import { Scene } from "babylonjs/scene";
  52654. /**
  52655. * The BoneAxesViewer will attach 3 axes to a specific bone of a specific mesh
  52656. * @see demo here: https://www.babylonjs-playground.com/#0DE8F4#8
  52657. */
  52658. export class BoneAxesViewer extends AxesViewer {
  52659. /**
  52660. * Gets or sets the target mesh where to display the axes viewer
  52661. */
  52662. mesh: Nullable<Mesh>;
  52663. /**
  52664. * Gets or sets the target bone where to display the axes viewer
  52665. */
  52666. bone: Nullable<Bone>;
  52667. /** Gets current position */
  52668. pos: Vector3;
  52669. /** Gets direction of X axis */
  52670. xaxis: Vector3;
  52671. /** Gets direction of Y axis */
  52672. yaxis: Vector3;
  52673. /** Gets direction of Z axis */
  52674. zaxis: Vector3;
  52675. /**
  52676. * Creates a new BoneAxesViewer
  52677. * @param scene defines the hosting scene
  52678. * @param bone defines the target bone
  52679. * @param mesh defines the target mesh
  52680. * @param scaleLines defines a scaling factor for line length (1 by default)
  52681. */
  52682. constructor(scene: Scene, bone: Bone, mesh: Mesh, scaleLines?: number);
  52683. /**
  52684. * Force the viewer to update
  52685. */
  52686. update(): void;
  52687. /** Releases resources */
  52688. dispose(): void;
  52689. }
  52690. }
  52691. declare module "babylonjs/Debug/debugLayer" {
  52692. import { Scene } from "babylonjs/scene";
  52693. /**
  52694. * Interface used to define scene explorer extensibility option
  52695. */
  52696. export interface IExplorerExtensibilityOption {
  52697. /**
  52698. * Define the option label
  52699. */
  52700. label: string;
  52701. /**
  52702. * Defines the action to execute on click
  52703. */
  52704. action: (entity: any) => void;
  52705. }
  52706. /**
  52707. * Defines a group of actions associated with a predicate to use when extending the Inspector scene explorer
  52708. */
  52709. export interface IExplorerExtensibilityGroup {
  52710. /**
  52711. * Defines a predicate to test if a given type mut be extended
  52712. */
  52713. predicate: (entity: any) => boolean;
  52714. /**
  52715. * Gets the list of options added to a type
  52716. */
  52717. entries: IExplorerExtensibilityOption[];
  52718. }
  52719. /**
  52720. * Interface used to define the options to use to create the Inspector
  52721. */
  52722. export interface IInspectorOptions {
  52723. /**
  52724. * Display in overlay mode (default: false)
  52725. */
  52726. overlay?: boolean;
  52727. /**
  52728. * HTML element to use as root (the parent of the rendering canvas will be used as default value)
  52729. */
  52730. globalRoot?: HTMLElement;
  52731. /**
  52732. * Display the Scene explorer
  52733. */
  52734. showExplorer?: boolean;
  52735. /**
  52736. * Display the property inspector
  52737. */
  52738. showInspector?: boolean;
  52739. /**
  52740. * Display in embed mode (both panes on the right)
  52741. */
  52742. embedMode?: boolean;
  52743. /**
  52744. * let the Inspector handles resize of the canvas when panes are resized (default to true)
  52745. */
  52746. handleResize?: boolean;
  52747. /**
  52748. * Allow the panes to popup (default: true)
  52749. */
  52750. enablePopup?: boolean;
  52751. /**
  52752. * Allow the panes to be closed by users (default: true)
  52753. */
  52754. enableClose?: boolean;
  52755. /**
  52756. * Optional list of extensibility entries
  52757. */
  52758. explorerExtensibility?: IExplorerExtensibilityGroup[];
  52759. /**
  52760. * Optional URL to get the inspector script from (by default it uses the babylonjs CDN).
  52761. */
  52762. inspectorURL?: string;
  52763. /**
  52764. * Optional initial tab (default to DebugLayerTab.Properties)
  52765. */
  52766. initialTab?: DebugLayerTab;
  52767. }
  52768. module "babylonjs/scene" {
  52769. interface Scene {
  52770. /**
  52771. * @hidden
  52772. * Backing field
  52773. */
  52774. _debugLayer: DebugLayer;
  52775. /**
  52776. * Gets the debug layer (aka Inspector) associated with the scene
  52777. * @see https://doc.babylonjs.com/features/playground_debuglayer
  52778. */
  52779. debugLayer: DebugLayer;
  52780. }
  52781. }
  52782. /**
  52783. * Enum of inspector action tab
  52784. */
  52785. export enum DebugLayerTab {
  52786. /**
  52787. * Properties tag (default)
  52788. */
  52789. Properties = 0,
  52790. /**
  52791. * Debug tab
  52792. */
  52793. Debug = 1,
  52794. /**
  52795. * Statistics tab
  52796. */
  52797. Statistics = 2,
  52798. /**
  52799. * Tools tab
  52800. */
  52801. Tools = 3,
  52802. /**
  52803. * Settings tab
  52804. */
  52805. Settings = 4
  52806. }
  52807. /**
  52808. * The debug layer (aka Inspector) is the go to tool in order to better understand
  52809. * what is happening in your scene
  52810. * @see https://doc.babylonjs.com/features/playground_debuglayer
  52811. */
  52812. export class DebugLayer {
  52813. /**
  52814. * Define the url to get the inspector script from.
  52815. * By default it uses the babylonjs CDN.
  52816. * @ignoreNaming
  52817. */
  52818. static InspectorURL: string;
  52819. private _scene;
  52820. private BJSINSPECTOR;
  52821. private _onPropertyChangedObservable?;
  52822. /**
  52823. * Observable triggered when a property is changed through the inspector.
  52824. */
  52825. get onPropertyChangedObservable(): any;
  52826. /**
  52827. * Instantiates a new debug layer.
  52828. * The debug layer (aka Inspector) is the go to tool in order to better understand
  52829. * what is happening in your scene
  52830. * @see https://doc.babylonjs.com/features/playground_debuglayer
  52831. * @param scene Defines the scene to inspect
  52832. */
  52833. constructor(scene: Scene);
  52834. /** Creates the inspector window. */
  52835. private _createInspector;
  52836. /**
  52837. * Select a specific entity in the scene explorer and highlight a specific block in that entity property grid
  52838. * @param entity defines the entity to select
  52839. * @param lineContainerTitles defines the specific blocks to highlight (could be a string or an array of strings)
  52840. */
  52841. select(entity: any, lineContainerTitles?: string | string[]): void;
  52842. /** Get the inspector from bundle or global */
  52843. private _getGlobalInspector;
  52844. /**
  52845. * Get if the inspector is visible or not.
  52846. * @returns true if visible otherwise, false
  52847. */
  52848. isVisible(): boolean;
  52849. /**
  52850. * Hide the inspector and close its window.
  52851. */
  52852. hide(): void;
  52853. /**
  52854. * Update the scene in the inspector
  52855. */
  52856. setAsActiveScene(): void;
  52857. /**
  52858. * Launch the debugLayer.
  52859. * @param config Define the configuration of the inspector
  52860. * @return a promise fulfilled when the debug layer is visible
  52861. */
  52862. show(config?: IInspectorOptions): Promise<DebugLayer>;
  52863. }
  52864. }
  52865. declare module "babylonjs/Meshes/Builders/boxBuilder" {
  52866. import { Nullable } from "babylonjs/types";
  52867. import { Scene } from "babylonjs/scene";
  52868. import { Vector4 } from "babylonjs/Maths/math.vector";
  52869. import { Color4 } from "babylonjs/Maths/math.color";
  52870. import { Mesh } from "babylonjs/Meshes/mesh";
  52871. /**
  52872. * Class containing static functions to help procedurally build meshes
  52873. */
  52874. export class BoxBuilder {
  52875. /**
  52876. * Creates a box mesh
  52877. * * The parameter `size` sets the size (float) of each box side (default 1)
  52878. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  52879. * * 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)
  52880. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  52881. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  52882. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  52883. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  52884. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  52885. * @param name defines the name of the mesh
  52886. * @param options defines the options used to create the mesh
  52887. * @param scene defines the hosting scene
  52888. * @returns the box mesh
  52889. */
  52890. static CreateBox(name: string, options: {
  52891. size?: number;
  52892. width?: number;
  52893. height?: number;
  52894. depth?: number;
  52895. faceUV?: Vector4[];
  52896. faceColors?: Color4[];
  52897. sideOrientation?: number;
  52898. frontUVs?: Vector4;
  52899. backUVs?: Vector4;
  52900. wrap?: boolean;
  52901. topBaseAt?: number;
  52902. bottomBaseAt?: number;
  52903. updatable?: boolean;
  52904. }, scene?: Nullable<Scene>): Mesh;
  52905. }
  52906. }
  52907. declare module "babylonjs/Debug/physicsViewer" {
  52908. import { Nullable } from "babylonjs/types";
  52909. import { Scene } from "babylonjs/scene";
  52910. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52911. import { Mesh } from "babylonjs/Meshes/mesh";
  52912. import { IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  52913. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  52914. /**
  52915. * Used to show the physics impostor around the specific mesh
  52916. */
  52917. export class PhysicsViewer {
  52918. /** @hidden */
  52919. protected _impostors: Array<Nullable<PhysicsImpostor>>;
  52920. /** @hidden */
  52921. protected _meshes: Array<Nullable<AbstractMesh>>;
  52922. /** @hidden */
  52923. protected _scene: Nullable<Scene>;
  52924. /** @hidden */
  52925. protected _numMeshes: number;
  52926. /** @hidden */
  52927. protected _physicsEnginePlugin: Nullable<IPhysicsEnginePlugin>;
  52928. private _renderFunction;
  52929. private _utilityLayer;
  52930. private _debugBoxMesh;
  52931. private _debugSphereMesh;
  52932. private _debugCylinderMesh;
  52933. private _debugMaterial;
  52934. private _debugMeshMeshes;
  52935. /**
  52936. * Creates a new PhysicsViewer
  52937. * @param scene defines the hosting scene
  52938. */
  52939. constructor(scene: Scene);
  52940. /** @hidden */
  52941. protected _updateDebugMeshes(): void;
  52942. /**
  52943. * Renders a specified physic impostor
  52944. * @param impostor defines the impostor to render
  52945. * @param targetMesh defines the mesh represented by the impostor
  52946. * @returns the new debug mesh used to render the impostor
  52947. */
  52948. showImpostor(impostor: PhysicsImpostor, targetMesh?: Mesh): Nullable<AbstractMesh>;
  52949. /**
  52950. * Hides a specified physic impostor
  52951. * @param impostor defines the impostor to hide
  52952. */
  52953. hideImpostor(impostor: Nullable<PhysicsImpostor>): void;
  52954. private _getDebugMaterial;
  52955. private _getDebugBoxMesh;
  52956. private _getDebugSphereMesh;
  52957. private _getDebugCylinderMesh;
  52958. private _getDebugMeshMesh;
  52959. private _getDebugMesh;
  52960. /** Releases all resources */
  52961. dispose(): void;
  52962. }
  52963. }
  52964. declare module "babylonjs/Debug/rayHelper" {
  52965. import { Nullable } from "babylonjs/types";
  52966. import { Ray } from "babylonjs/Culling/ray";
  52967. import { Vector3 } from "babylonjs/Maths/math.vector";
  52968. import { Color3 } from "babylonjs/Maths/math.color";
  52969. import { Scene } from "babylonjs/scene";
  52970. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52971. import "babylonjs/Meshes/Builders/linesBuilder";
  52972. /**
  52973. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  52974. * in order to better appreciate the issue one might have.
  52975. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  52976. */
  52977. export class RayHelper {
  52978. /**
  52979. * Defines the ray we are currently tryin to visualize.
  52980. */
  52981. ray: Nullable<Ray>;
  52982. private _renderPoints;
  52983. private _renderLine;
  52984. private _renderFunction;
  52985. private _scene;
  52986. private _onAfterRenderObserver;
  52987. private _onAfterStepObserver;
  52988. private _attachedToMesh;
  52989. private _meshSpaceDirection;
  52990. private _meshSpaceOrigin;
  52991. /**
  52992. * Helper function to create a colored helper in a scene in one line.
  52993. * @param ray Defines the ray we are currently tryin to visualize
  52994. * @param scene Defines the scene the ray is used in
  52995. * @param color Defines the color we want to see the ray in
  52996. * @returns The newly created ray helper.
  52997. */
  52998. static CreateAndShow(ray: Ray, scene: Scene, color: Color3): RayHelper;
  52999. /**
  53000. * Instantiate a new ray helper.
  53001. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  53002. * in order to better appreciate the issue one might have.
  53003. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  53004. * @param ray Defines the ray we are currently tryin to visualize
  53005. */
  53006. constructor(ray: Ray);
  53007. /**
  53008. * Shows the ray we are willing to debug.
  53009. * @param scene Defines the scene the ray needs to be rendered in
  53010. * @param color Defines the color the ray needs to be rendered in
  53011. */
  53012. show(scene: Scene, color?: Color3): void;
  53013. /**
  53014. * Hides the ray we are debugging.
  53015. */
  53016. hide(): void;
  53017. private _render;
  53018. /**
  53019. * Attach a ray helper to a mesh so that we can easily see its orientation for instance or information like its normals.
  53020. * @param mesh Defines the mesh we want the helper attached to
  53021. * @param meshSpaceDirection Defines the direction of the Ray in mesh space (local space of the mesh node)
  53022. * @param meshSpaceOrigin Defines the origin of the Ray in mesh space (local space of the mesh node)
  53023. * @param length Defines the length of the ray
  53024. */
  53025. attachToMesh(mesh: AbstractMesh, meshSpaceDirection?: Vector3, meshSpaceOrigin?: Vector3, length?: number): void;
  53026. /**
  53027. * Detach the ray helper from the mesh it has previously been attached to.
  53028. */
  53029. detachFromMesh(): void;
  53030. private _updateToMesh;
  53031. /**
  53032. * Dispose the helper and release its associated resources.
  53033. */
  53034. dispose(): void;
  53035. }
  53036. }
  53037. declare module "babylonjs/Debug/ISkeletonViewer" {
  53038. import { Skeleton } from "babylonjs/Bones/skeleton";
  53039. import { Color3 } from "babylonjs/Maths/math.color";
  53040. /**
  53041. * Defines the options associated with the creation of a SkeletonViewer.
  53042. */
  53043. export interface ISkeletonViewerOptions {
  53044. /** Should the system pause animations before building the Viewer? */
  53045. pauseAnimations: boolean;
  53046. /** Should the system return the skeleton to rest before building? */
  53047. returnToRest: boolean;
  53048. /** public Display Mode of the Viewer */
  53049. displayMode: number;
  53050. /** Flag to toggle if the Viewer should use the CPU for animations or not? */
  53051. displayOptions: ISkeletonViewerDisplayOptions;
  53052. /** Flag to toggle if the Viewer should use the CPU for animations or not? */
  53053. computeBonesUsingShaders: boolean;
  53054. /** Flag ignore non weighted bones */
  53055. useAllBones: boolean;
  53056. }
  53057. /**
  53058. * Defines how to display the various bone meshes for the viewer.
  53059. */
  53060. export interface ISkeletonViewerDisplayOptions {
  53061. /** How far down to start tapering the bone spurs */
  53062. midStep?: number;
  53063. /** How big is the midStep? */
  53064. midStepFactor?: number;
  53065. /** Base for the Sphere Size */
  53066. sphereBaseSize?: number;
  53067. /** The ratio of the sphere to the longest bone in units */
  53068. sphereScaleUnit?: number;
  53069. /** Ratio for the Sphere Size */
  53070. sphereFactor?: number;
  53071. }
  53072. /**
  53073. * Defines the constructor options for the BoneWeight Shader.
  53074. */
  53075. export interface IBoneWeightShaderOptions {
  53076. /** Skeleton to Map */
  53077. skeleton: Skeleton;
  53078. /** Colors for Uninfluenced bones */
  53079. colorBase?: Color3;
  53080. /** Colors for 0.0-0.25 Weight bones */
  53081. colorZero?: Color3;
  53082. /** Color for 0.25-0.5 Weight Influence */
  53083. colorQuarter?: Color3;
  53084. /** Color for 0.5-0.75 Weight Influence */
  53085. colorHalf?: Color3;
  53086. /** Color for 0.75-1 Weight Influence */
  53087. colorFull?: Color3;
  53088. /** Color for Zero Weight Influence */
  53089. targetBoneIndex?: number;
  53090. }
  53091. /**
  53092. * Simple structure of the gradient steps for the Color Map.
  53093. */
  53094. export interface ISkeletonMapShaderColorMapKnot {
  53095. /** Color of the Knot */
  53096. color: Color3;
  53097. /** Location of the Knot */
  53098. location: number;
  53099. }
  53100. /**
  53101. * Defines the constructor options for the SkeletonMap Shader.
  53102. */
  53103. export interface ISkeletonMapShaderOptions {
  53104. /** Skeleton to Map */
  53105. skeleton: Skeleton;
  53106. /** Array of ColorMapKnots that make the gradient must be ordered with knot[i].location < knot[i+1].location*/
  53107. colorMap?: ISkeletonMapShaderColorMapKnot[];
  53108. }
  53109. }
  53110. declare module "babylonjs/Meshes/Builders/ribbonBuilder" {
  53111. import { Nullable } from "babylonjs/types";
  53112. import { Scene } from "babylonjs/scene";
  53113. import { Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  53114. import { Color4 } from "babylonjs/Maths/math.color";
  53115. import { Mesh } from "babylonjs/Meshes/mesh";
  53116. /**
  53117. * Class containing static functions to help procedurally build meshes
  53118. */
  53119. export class RibbonBuilder {
  53120. /**
  53121. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  53122. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  53123. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  53124. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  53125. * * 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
  53126. * * 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
  53127. * * 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
  53128. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  53129. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  53130. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  53131. * * 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
  53132. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  53133. * * 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
  53134. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  53135. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  53136. * @param name defines the name of the mesh
  53137. * @param options defines the options used to create the mesh
  53138. * @param scene defines the hosting scene
  53139. * @returns the ribbon mesh
  53140. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  53141. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  53142. */
  53143. static CreateRibbon(name: string, options: {
  53144. pathArray: Vector3[][];
  53145. closeArray?: boolean;
  53146. closePath?: boolean;
  53147. offset?: number;
  53148. updatable?: boolean;
  53149. sideOrientation?: number;
  53150. frontUVs?: Vector4;
  53151. backUVs?: Vector4;
  53152. instance?: Mesh;
  53153. invertUV?: boolean;
  53154. uvs?: Vector2[];
  53155. colors?: Color4[];
  53156. }, scene?: Nullable<Scene>): Mesh;
  53157. }
  53158. }
  53159. declare module "babylonjs/Meshes/Builders/shapeBuilder" {
  53160. import { Nullable } from "babylonjs/types";
  53161. import { Scene } from "babylonjs/scene";
  53162. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  53163. import { Mesh } from "babylonjs/Meshes/mesh";
  53164. /**
  53165. * Class containing static functions to help procedurally build meshes
  53166. */
  53167. export class ShapeBuilder {
  53168. /**
  53169. * 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.
  53170. * * 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.
  53171. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  53172. * * 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.
  53173. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  53174. * * 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
  53175. * * 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
  53176. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  53177. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  53178. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  53179. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  53180. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  53181. * @param name defines the name of the mesh
  53182. * @param options defines the options used to create the mesh
  53183. * @param scene defines the hosting scene
  53184. * @returns the extruded shape mesh
  53185. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  53186. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  53187. */
  53188. static ExtrudeShape(name: string, options: {
  53189. shape: Vector3[];
  53190. path: Vector3[];
  53191. scale?: number;
  53192. rotation?: number;
  53193. cap?: number;
  53194. updatable?: boolean;
  53195. sideOrientation?: number;
  53196. frontUVs?: Vector4;
  53197. backUVs?: Vector4;
  53198. instance?: Mesh;
  53199. invertUV?: boolean;
  53200. }, scene?: Nullable<Scene>): Mesh;
  53201. /**
  53202. * Creates an custom extruded shape mesh.
  53203. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  53204. * * 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.
  53205. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  53206. * * 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
  53207. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  53208. * * 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
  53209. * * It must returns a float value that will be the scale value applied to the shape on each path point
  53210. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  53211. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  53212. * * 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
  53213. * * 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
  53214. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  53215. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  53216. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  53217. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  53218. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  53219. * @param name defines the name of the mesh
  53220. * @param options defines the options used to create the mesh
  53221. * @param scene defines the hosting scene
  53222. * @returns the custom extruded shape mesh
  53223. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  53224. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  53225. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  53226. */
  53227. static ExtrudeShapeCustom(name: string, options: {
  53228. shape: Vector3[];
  53229. path: Vector3[];
  53230. scaleFunction?: any;
  53231. rotationFunction?: any;
  53232. ribbonCloseArray?: boolean;
  53233. ribbonClosePath?: boolean;
  53234. cap?: number;
  53235. updatable?: boolean;
  53236. sideOrientation?: number;
  53237. frontUVs?: Vector4;
  53238. backUVs?: Vector4;
  53239. instance?: Mesh;
  53240. invertUV?: boolean;
  53241. }, scene?: Nullable<Scene>): Mesh;
  53242. private static _ExtrudeShapeGeneric;
  53243. }
  53244. }
  53245. declare module "babylonjs/Debug/skeletonViewer" {
  53246. import { Color3 } from "babylonjs/Maths/math.color";
  53247. import { Scene } from "babylonjs/scene";
  53248. import { Nullable } from "babylonjs/types";
  53249. import { Skeleton } from "babylonjs/Bones/skeleton";
  53250. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  53251. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  53252. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  53253. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  53254. import { ShaderMaterial } from "babylonjs/Materials/shaderMaterial";
  53255. import { ISkeletonViewerOptions, IBoneWeightShaderOptions, ISkeletonMapShaderOptions } from "babylonjs/Debug/ISkeletonViewer";
  53256. /**
  53257. * Class used to render a debug view of a given skeleton
  53258. * @see http://www.babylonjs-playground.com/#1BZJVJ#8
  53259. */
  53260. export class SkeletonViewer {
  53261. /** defines the skeleton to render */
  53262. skeleton: Skeleton;
  53263. /** defines the mesh attached to the skeleton */
  53264. mesh: AbstractMesh;
  53265. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  53266. autoUpdateBonesMatrices: boolean;
  53267. /** defines the rendering group id to use with the viewer */
  53268. renderingGroupId: number;
  53269. /** is the options for the viewer */
  53270. options: Partial<ISkeletonViewerOptions>;
  53271. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_LINES */
  53272. static readonly DISPLAY_LINES: number;
  53273. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_SPHERES */
  53274. static readonly DISPLAY_SPHERES: number;
  53275. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_SPHERE_AND_SPURS */
  53276. static readonly DISPLAY_SPHERE_AND_SPURS: number;
  53277. /** public static method to create a BoneWeight Shader
  53278. * @param options The constructor options
  53279. * @param scene The scene that the shader is scoped to
  53280. * @returns The created ShaderMaterial
  53281. * @see http://www.babylonjs-playground.com/#1BZJVJ#395
  53282. */
  53283. static CreateBoneWeightShader(options: IBoneWeightShaderOptions, scene: Scene): ShaderMaterial;
  53284. /** public static method to create a BoneWeight Shader
  53285. * @param options The constructor options
  53286. * @param scene The scene that the shader is scoped to
  53287. * @returns The created ShaderMaterial
  53288. */
  53289. static CreateSkeletonMapShader(options: ISkeletonMapShaderOptions, scene: Scene): ShaderMaterial;
  53290. /** private static method to create a BoneWeight Shader
  53291. * @param size The size of the buffer to create (usually the bone count)
  53292. * @param colorMap The gradient data to generate
  53293. * @param scene The scene that the shader is scoped to
  53294. * @returns an Array of floats from the color gradient values
  53295. */
  53296. private static _CreateBoneMapColorBuffer;
  53297. /** If SkeletonViewer scene scope. */
  53298. private _scene;
  53299. /** Gets or sets the color used to render the skeleton */
  53300. color: Color3;
  53301. /** Array of the points of the skeleton fo the line view. */
  53302. private _debugLines;
  53303. /** The SkeletonViewers Mesh. */
  53304. private _debugMesh;
  53305. /** If SkeletonViewer is enabled. */
  53306. private _isEnabled;
  53307. /** If SkeletonViewer is ready. */
  53308. private _ready;
  53309. /** SkeletonViewer render observable. */
  53310. private _obs;
  53311. /** The Utility Layer to render the gizmos in. */
  53312. private _utilityLayer;
  53313. private _boneIndices;
  53314. /** Gets the Scene. */
  53315. get scene(): Scene;
  53316. /** Gets the utilityLayer. */
  53317. get utilityLayer(): Nullable<UtilityLayerRenderer>;
  53318. /** Checks Ready Status. */
  53319. get isReady(): Boolean;
  53320. /** Sets Ready Status. */
  53321. set ready(value: boolean);
  53322. /** Gets the debugMesh */
  53323. get debugMesh(): Nullable<AbstractMesh> | Nullable<LinesMesh>;
  53324. /** Sets the debugMesh */
  53325. set debugMesh(value: Nullable<AbstractMesh> | Nullable<LinesMesh>);
  53326. /** Gets the material */
  53327. get material(): StandardMaterial;
  53328. /** Sets the material */
  53329. set material(value: StandardMaterial);
  53330. /** Gets the material */
  53331. get displayMode(): number;
  53332. /** Sets the material */
  53333. set displayMode(value: number);
  53334. /**
  53335. * Creates a new SkeletonViewer
  53336. * @param skeleton defines the skeleton to render
  53337. * @param mesh defines the mesh attached to the skeleton
  53338. * @param scene defines the hosting scene
  53339. * @param autoUpdateBonesMatrices defines a boolean indicating if bones matrices must be forced to update before rendering (true by default)
  53340. * @param renderingGroupId defines the rendering group id to use with the viewer
  53341. * @param options All of the extra constructor options for the SkeletonViewer
  53342. */
  53343. constructor(
  53344. /** defines the skeleton to render */
  53345. skeleton: Skeleton,
  53346. /** defines the mesh attached to the skeleton */
  53347. mesh: AbstractMesh,
  53348. /** The Scene scope*/
  53349. scene: Scene,
  53350. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  53351. autoUpdateBonesMatrices?: boolean,
  53352. /** defines the rendering group id to use with the viewer */
  53353. renderingGroupId?: number,
  53354. /** is the options for the viewer */
  53355. options?: Partial<ISkeletonViewerOptions>);
  53356. /** The Dynamic bindings for the update functions */
  53357. private _bindObs;
  53358. /** Update the viewer to sync with current skeleton state, only used to manually update. */
  53359. update(): void;
  53360. /** Gets or sets a boolean indicating if the viewer is enabled */
  53361. set isEnabled(value: boolean);
  53362. get isEnabled(): boolean;
  53363. private _getBonePosition;
  53364. private _getLinesForBonesWithLength;
  53365. private _getLinesForBonesNoLength;
  53366. /** function to revert the mesh and scene back to the initial state. */
  53367. private _revert;
  53368. /** function to build and bind sphere joint points and spur bone representations. */
  53369. private _buildSpheresAndSpurs;
  53370. /** Update the viewer to sync with current skeleton state, only used for the line display. */
  53371. private _displayLinesUpdate;
  53372. /** Changes the displayMode of the skeleton viewer
  53373. * @param mode The displayMode numerical value
  53374. */
  53375. changeDisplayMode(mode: number): void;
  53376. /** Changes the displayMode of the skeleton viewer
  53377. * @param option String of the option name
  53378. * @param value The numerical option value
  53379. */
  53380. changeDisplayOptions(option: string, value: number): void;
  53381. /** Release associated resources */
  53382. dispose(): void;
  53383. }
  53384. }
  53385. declare module "babylonjs/Debug/index" {
  53386. export * from "babylonjs/Debug/axesViewer";
  53387. export * from "babylonjs/Debug/boneAxesViewer";
  53388. export * from "babylonjs/Debug/debugLayer";
  53389. export * from "babylonjs/Debug/physicsViewer";
  53390. export * from "babylonjs/Debug/rayHelper";
  53391. export * from "babylonjs/Debug/skeletonViewer";
  53392. export * from "babylonjs/Debug/ISkeletonViewer";
  53393. }
  53394. declare module "babylonjs/DeviceInput/InputDevices/deviceEnums" {
  53395. /**
  53396. * Enum for Device Types
  53397. */
  53398. export enum DeviceType {
  53399. /** Generic */
  53400. Generic = 0,
  53401. /** Keyboard */
  53402. Keyboard = 1,
  53403. /** Mouse */
  53404. Mouse = 2,
  53405. /** Touch Pointers */
  53406. Touch = 3,
  53407. /** PS4 Dual Shock */
  53408. DualShock = 4,
  53409. /** Xbox */
  53410. Xbox = 5,
  53411. /** Switch Controller */
  53412. Switch = 6
  53413. }
  53414. /**
  53415. * Enum for All Pointers (Touch/Mouse)
  53416. */
  53417. export enum PointerInput {
  53418. /** Horizontal Axis */
  53419. Horizontal = 0,
  53420. /** Vertical Axis */
  53421. Vertical = 1,
  53422. /** Left Click or Touch */
  53423. LeftClick = 2,
  53424. /** Middle Click */
  53425. MiddleClick = 3,
  53426. /** Right Click */
  53427. RightClick = 4,
  53428. /** Browser Back */
  53429. BrowserBack = 5,
  53430. /** Browser Forward */
  53431. BrowserForward = 6
  53432. }
  53433. /**
  53434. * Enum for Dual Shock Gamepad
  53435. */
  53436. export enum DualShockInput {
  53437. /** Cross */
  53438. Cross = 0,
  53439. /** Circle */
  53440. Circle = 1,
  53441. /** Square */
  53442. Square = 2,
  53443. /** Triangle */
  53444. Triangle = 3,
  53445. /** L1 */
  53446. L1 = 4,
  53447. /** R1 */
  53448. R1 = 5,
  53449. /** L2 */
  53450. L2 = 6,
  53451. /** R2 */
  53452. R2 = 7,
  53453. /** Share */
  53454. Share = 8,
  53455. /** Options */
  53456. Options = 9,
  53457. /** L3 */
  53458. L3 = 10,
  53459. /** R3 */
  53460. R3 = 11,
  53461. /** DPadUp */
  53462. DPadUp = 12,
  53463. /** DPadDown */
  53464. DPadDown = 13,
  53465. /** DPadLeft */
  53466. DPadLeft = 14,
  53467. /** DRight */
  53468. DPadRight = 15,
  53469. /** Home */
  53470. Home = 16,
  53471. /** TouchPad */
  53472. TouchPad = 17,
  53473. /** LStickXAxis */
  53474. LStickXAxis = 18,
  53475. /** LStickYAxis */
  53476. LStickYAxis = 19,
  53477. /** RStickXAxis */
  53478. RStickXAxis = 20,
  53479. /** RStickYAxis */
  53480. RStickYAxis = 21
  53481. }
  53482. /**
  53483. * Enum for Xbox Gamepad
  53484. */
  53485. export enum XboxInput {
  53486. /** A */
  53487. A = 0,
  53488. /** B */
  53489. B = 1,
  53490. /** X */
  53491. X = 2,
  53492. /** Y */
  53493. Y = 3,
  53494. /** LB */
  53495. LB = 4,
  53496. /** RB */
  53497. RB = 5,
  53498. /** LT */
  53499. LT = 6,
  53500. /** RT */
  53501. RT = 7,
  53502. /** Back */
  53503. Back = 8,
  53504. /** Start */
  53505. Start = 9,
  53506. /** LS */
  53507. LS = 10,
  53508. /** RS */
  53509. RS = 11,
  53510. /** DPadUp */
  53511. DPadUp = 12,
  53512. /** DPadDown */
  53513. DPadDown = 13,
  53514. /** DPadLeft */
  53515. DPadLeft = 14,
  53516. /** DRight */
  53517. DPadRight = 15,
  53518. /** Home */
  53519. Home = 16,
  53520. /** LStickXAxis */
  53521. LStickXAxis = 17,
  53522. /** LStickYAxis */
  53523. LStickYAxis = 18,
  53524. /** RStickXAxis */
  53525. RStickXAxis = 19,
  53526. /** RStickYAxis */
  53527. RStickYAxis = 20
  53528. }
  53529. /**
  53530. * Enum for Switch (Pro/JoyCon L+R) Gamepad
  53531. */
  53532. export enum SwitchInput {
  53533. /** B */
  53534. B = 0,
  53535. /** A */
  53536. A = 1,
  53537. /** Y */
  53538. Y = 2,
  53539. /** X */
  53540. X = 3,
  53541. /** L */
  53542. L = 4,
  53543. /** R */
  53544. R = 5,
  53545. /** ZL */
  53546. ZL = 6,
  53547. /** ZR */
  53548. ZR = 7,
  53549. /** Minus */
  53550. Minus = 8,
  53551. /** Plus */
  53552. Plus = 9,
  53553. /** LS */
  53554. LS = 10,
  53555. /** RS */
  53556. RS = 11,
  53557. /** DPadUp */
  53558. DPadUp = 12,
  53559. /** DPadDown */
  53560. DPadDown = 13,
  53561. /** DPadLeft */
  53562. DPadLeft = 14,
  53563. /** DRight */
  53564. DPadRight = 15,
  53565. /** Home */
  53566. Home = 16,
  53567. /** Capture */
  53568. Capture = 17,
  53569. /** LStickXAxis */
  53570. LStickXAxis = 18,
  53571. /** LStickYAxis */
  53572. LStickYAxis = 19,
  53573. /** RStickXAxis */
  53574. RStickXAxis = 20,
  53575. /** RStickYAxis */
  53576. RStickYAxis = 21
  53577. }
  53578. }
  53579. declare module "babylonjs/DeviceInput/deviceInputSystem" {
  53580. import { Engine } from "babylonjs/Engines/engine";
  53581. import { IDisposable } from "babylonjs/scene";
  53582. import { Nullable } from "babylonjs/types";
  53583. import { DeviceType } from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  53584. /**
  53585. * This class will take all inputs from Keyboard, Pointer, and
  53586. * any Gamepads and provide a polling system that all devices
  53587. * will use. This class assumes that there will only be one
  53588. * pointer device and one keyboard.
  53589. */
  53590. export class DeviceInputSystem implements IDisposable {
  53591. /**
  53592. * Callback to be triggered when a device is connected
  53593. */
  53594. onDeviceConnected: (deviceType: DeviceType, deviceSlot: number) => void;
  53595. /**
  53596. * Callback to be triggered when a device is disconnected
  53597. */
  53598. onDeviceDisconnected: (deviceType: DeviceType, deviceSlot: number) => void;
  53599. /**
  53600. * Callback to be triggered when event driven input is updated
  53601. */
  53602. onInputChanged: (deviceType: DeviceType, deviceSlot: number, inputIndex: number, previousState: Nullable<number>, currentState: Nullable<number>) => void;
  53603. private _inputs;
  53604. private _gamepads;
  53605. private _keyboardActive;
  53606. private _pointerActive;
  53607. private _elementToAttachTo;
  53608. private _keyboardDownEvent;
  53609. private _keyboardUpEvent;
  53610. private _pointerMoveEvent;
  53611. private _pointerDownEvent;
  53612. private _pointerUpEvent;
  53613. private _gamepadConnectedEvent;
  53614. private _gamepadDisconnectedEvent;
  53615. private static _MAX_KEYCODES;
  53616. private static _MAX_POINTER_INPUTS;
  53617. private constructor();
  53618. /**
  53619. * Creates a new DeviceInputSystem instance
  53620. * @param engine Engine to pull input element from
  53621. * @returns The new instance
  53622. */
  53623. static Create(engine: Engine): DeviceInputSystem;
  53624. /**
  53625. * Checks for current device input value, given an id and input index
  53626. * @param deviceName Id of connected device
  53627. * @param inputIndex Index of device input
  53628. * @returns Current value of input
  53629. */
  53630. /**
  53631. * Checks for current device input value, given an id and input index. Throws exception if requested device not initialized.
  53632. * @param deviceType Enum specifiying device type
  53633. * @param deviceSlot "Slot" or index that device is referenced in
  53634. * @param inputIndex Id of input to be checked
  53635. * @returns Current value of input
  53636. */
  53637. pollInput(deviceType: DeviceType, deviceSlot: number, inputIndex: number): number;
  53638. /**
  53639. * Dispose of all the eventlisteners
  53640. */
  53641. dispose(): void;
  53642. /**
  53643. * Add device and inputs to device array
  53644. * @param deviceType Enum specifiying device type
  53645. * @param deviceSlot "Slot" or index that device is referenced in
  53646. * @param numberOfInputs Number of input entries to create for given device
  53647. */
  53648. private _registerDevice;
  53649. /**
  53650. * Given a specific device name, remove that device from the device map
  53651. * @param deviceType Enum specifiying device type
  53652. * @param deviceSlot "Slot" or index that device is referenced in
  53653. */
  53654. private _unregisterDevice;
  53655. /**
  53656. * Handle all actions that come from keyboard interaction
  53657. */
  53658. private _handleKeyActions;
  53659. /**
  53660. * Handle all actions that come from pointer interaction
  53661. */
  53662. private _handlePointerActions;
  53663. /**
  53664. * Handle all actions that come from gamepad interaction
  53665. */
  53666. private _handleGamepadActions;
  53667. /**
  53668. * Update all non-event based devices with each frame
  53669. * @param deviceType Enum specifiying device type
  53670. * @param deviceSlot "Slot" or index that device is referenced in
  53671. * @param inputIndex Id of input to be checked
  53672. */
  53673. private _updateDevice;
  53674. /**
  53675. * Gets DeviceType from the device name
  53676. * @param deviceName Name of Device from DeviceInputSystem
  53677. * @returns DeviceType enum value
  53678. */
  53679. private _getGamepadDeviceType;
  53680. }
  53681. }
  53682. declare module "babylonjs/DeviceInput/InputDevices/deviceTypes" {
  53683. import { DeviceType, PointerInput, DualShockInput, XboxInput, SwitchInput } from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  53684. /**
  53685. * Type to handle enforcement of inputs
  53686. */
  53687. 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;
  53688. }
  53689. declare module "babylonjs/DeviceInput/InputDevices/deviceSourceManager" {
  53690. import { DeviceInputSystem } from "babylonjs/DeviceInput/deviceInputSystem";
  53691. import { Engine } from "babylonjs/Engines/engine";
  53692. import { IDisposable } from "babylonjs/scene";
  53693. import { DeviceType } from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  53694. import { Nullable } from "babylonjs/types";
  53695. import { Observable } from "babylonjs/Misc/observable";
  53696. import { DeviceInput } from "babylonjs/DeviceInput/InputDevices/deviceTypes";
  53697. /**
  53698. * Class that handles all input for a specific device
  53699. */
  53700. export class DeviceSource<T extends DeviceType> {
  53701. /** Type of device */
  53702. readonly deviceType: DeviceType;
  53703. /** "Slot" or index that device is referenced in */
  53704. readonly deviceSlot: number;
  53705. /**
  53706. * Observable to handle device input changes per device
  53707. */
  53708. readonly onInputChangedObservable: Observable<{
  53709. inputIndex: DeviceInput<T>;
  53710. previousState: Nullable<number>;
  53711. currentState: Nullable<number>;
  53712. }>;
  53713. private readonly _deviceInputSystem;
  53714. /**
  53715. * Default Constructor
  53716. * @param deviceInputSystem Reference to DeviceInputSystem
  53717. * @param deviceType Type of device
  53718. * @param deviceSlot "Slot" or index that device is referenced in
  53719. */
  53720. constructor(deviceInputSystem: DeviceInputSystem,
  53721. /** Type of device */
  53722. deviceType: DeviceType,
  53723. /** "Slot" or index that device is referenced in */
  53724. deviceSlot?: number);
  53725. /**
  53726. * Get input for specific input
  53727. * @param inputIndex index of specific input on device
  53728. * @returns Input value from DeviceInputSystem
  53729. */
  53730. getInput(inputIndex: DeviceInput<T>): number;
  53731. }
  53732. /**
  53733. * Class to keep track of devices
  53734. */
  53735. export class DeviceSourceManager implements IDisposable {
  53736. /**
  53737. * Observable to be triggered when before a device is connected
  53738. */
  53739. readonly onBeforeDeviceConnectedObservable: Observable<{
  53740. deviceType: DeviceType;
  53741. deviceSlot: number;
  53742. }>;
  53743. /**
  53744. * Observable to be triggered when before a device is disconnected
  53745. */
  53746. readonly onBeforeDeviceDisconnectedObservable: Observable<{
  53747. deviceType: DeviceType;
  53748. deviceSlot: number;
  53749. }>;
  53750. /**
  53751. * Observable to be triggered when after a device is connected
  53752. */
  53753. readonly onAfterDeviceConnectedObservable: Observable<{
  53754. deviceType: DeviceType;
  53755. deviceSlot: number;
  53756. }>;
  53757. /**
  53758. * Observable to be triggered when after a device is disconnected
  53759. */
  53760. readonly onAfterDeviceDisconnectedObservable: Observable<{
  53761. deviceType: DeviceType;
  53762. deviceSlot: number;
  53763. }>;
  53764. private readonly _devices;
  53765. private readonly _firstDevice;
  53766. private readonly _deviceInputSystem;
  53767. /**
  53768. * Default Constructor
  53769. * @param engine engine to pull input element from
  53770. */
  53771. constructor(engine: Engine);
  53772. /**
  53773. * Gets a DeviceSource, given a type and slot
  53774. * @param deviceType Enum specifying device type
  53775. * @param deviceSlot "Slot" or index that device is referenced in
  53776. * @returns DeviceSource object
  53777. */
  53778. getDeviceSource<T extends DeviceType>(deviceType: T, deviceSlot?: number): Nullable<DeviceSource<T>>;
  53779. /**
  53780. * Gets an array of DeviceSource objects for a given device type
  53781. * @param deviceType Enum specifying device type
  53782. * @returns Array of DeviceSource objects
  53783. */
  53784. getDeviceSources<T extends DeviceType>(deviceType: T): ReadonlyArray<DeviceSource<T>>;
  53785. /**
  53786. * Dispose of DeviceInputSystem and other parts
  53787. */
  53788. dispose(): void;
  53789. /**
  53790. * Function to add device name to device list
  53791. * @param deviceType Enum specifying device type
  53792. * @param deviceSlot "Slot" or index that device is referenced in
  53793. */
  53794. private _addDevice;
  53795. /**
  53796. * Function to remove device name to device list
  53797. * @param deviceType Enum specifying device type
  53798. * @param deviceSlot "Slot" or index that device is referenced in
  53799. */
  53800. private _removeDevice;
  53801. /**
  53802. * Updates array storing first connected device of each type
  53803. * @param type Type of Device
  53804. */
  53805. private _updateFirstDevices;
  53806. }
  53807. }
  53808. declare module "babylonjs/DeviceInput/index" {
  53809. export * from "babylonjs/DeviceInput/deviceInputSystem";
  53810. export * from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  53811. export * from "babylonjs/DeviceInput/InputDevices/deviceTypes";
  53812. import "babylonjs/DeviceInput/InputDevices/deviceSourceManager";
  53813. export * from "babylonjs/DeviceInput/InputDevices/deviceSourceManager";
  53814. }
  53815. declare module "babylonjs/Engines/nullEngine" {
  53816. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  53817. import { Engine } from "babylonjs/Engines/engine";
  53818. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  53819. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  53820. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  53821. import { Effect } from "babylonjs/Materials/effect";
  53822. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  53823. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  53824. import { IColor4Like, IViewportLike } from "babylonjs/Maths/math.like";
  53825. import { ISceneLike } from "babylonjs/Engines/thinEngine";
  53826. /**
  53827. * Options to create the null engine
  53828. */
  53829. export class NullEngineOptions {
  53830. /**
  53831. * Render width (Default: 512)
  53832. */
  53833. renderWidth: number;
  53834. /**
  53835. * Render height (Default: 256)
  53836. */
  53837. renderHeight: number;
  53838. /**
  53839. * Texture size (Default: 512)
  53840. */
  53841. textureSize: number;
  53842. /**
  53843. * If delta time between frames should be constant
  53844. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  53845. */
  53846. deterministicLockstep: boolean;
  53847. /**
  53848. * Maximum about of steps between frames (Default: 4)
  53849. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  53850. */
  53851. lockstepMaxSteps: number;
  53852. /**
  53853. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  53854. */
  53855. useHighPrecisionMatrix?: boolean;
  53856. }
  53857. /**
  53858. * The null engine class provides support for headless version of babylon.js.
  53859. * This can be used in server side scenario or for testing purposes
  53860. */
  53861. export class NullEngine extends Engine {
  53862. private _options;
  53863. /**
  53864. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  53865. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  53866. * @returns true if engine is in deterministic lock step mode
  53867. */
  53868. isDeterministicLockStep(): boolean;
  53869. /**
  53870. * Gets the max steps when engine is running in deterministic lock step
  53871. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  53872. * @returns the max steps
  53873. */
  53874. getLockstepMaxSteps(): number;
  53875. /**
  53876. * Gets the current hardware scaling level.
  53877. * By default the hardware scaling level is computed from the window device ratio.
  53878. * 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.
  53879. * @returns a number indicating the current hardware scaling level
  53880. */
  53881. getHardwareScalingLevel(): number;
  53882. constructor(options?: NullEngineOptions);
  53883. /**
  53884. * Creates a vertex buffer
  53885. * @param vertices the data for the vertex buffer
  53886. * @returns the new WebGL static buffer
  53887. */
  53888. createVertexBuffer(vertices: FloatArray): DataBuffer;
  53889. /**
  53890. * Creates a new index buffer
  53891. * @param indices defines the content of the index buffer
  53892. * @param updatable defines if the index buffer must be updatable
  53893. * @returns a new webGL buffer
  53894. */
  53895. createIndexBuffer(indices: IndicesArray): DataBuffer;
  53896. /**
  53897. * Clear the current render buffer or the current render target (if any is set up)
  53898. * @param color defines the color to use
  53899. * @param backBuffer defines if the back buffer must be cleared
  53900. * @param depth defines if the depth buffer must be cleared
  53901. * @param stencil defines if the stencil buffer must be cleared
  53902. */
  53903. clear(color: IColor4Like, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  53904. /**
  53905. * Gets the current render width
  53906. * @param useScreen defines if screen size must be used (or the current render target if any)
  53907. * @returns a number defining the current render width
  53908. */
  53909. getRenderWidth(useScreen?: boolean): number;
  53910. /**
  53911. * Gets the current render height
  53912. * @param useScreen defines if screen size must be used (or the current render target if any)
  53913. * @returns a number defining the current render height
  53914. */
  53915. getRenderHeight(useScreen?: boolean): number;
  53916. /**
  53917. * Set the WebGL's viewport
  53918. * @param viewport defines the viewport element to be used
  53919. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  53920. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  53921. */
  53922. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  53923. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: string, context?: WebGLRenderingContext): WebGLProgram;
  53924. /**
  53925. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  53926. * @param pipelineContext defines the pipeline context to use
  53927. * @param uniformsNames defines the list of uniform names
  53928. * @returns an array of webGL uniform locations
  53929. */
  53930. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  53931. /**
  53932. * Gets the lsit of active attributes for a given webGL program
  53933. * @param pipelineContext defines the pipeline context to use
  53934. * @param attributesNames defines the list of attribute names to get
  53935. * @returns an array of indices indicating the offset of each attribute
  53936. */
  53937. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  53938. /**
  53939. * Binds an effect to the webGL context
  53940. * @param effect defines the effect to bind
  53941. */
  53942. bindSamplers(effect: Effect): void;
  53943. /**
  53944. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  53945. * @param effect defines the effect to activate
  53946. */
  53947. enableEffect(effect: Effect): void;
  53948. /**
  53949. * Set various states to the webGL context
  53950. * @param culling defines backface culling state
  53951. * @param zOffset defines the value to apply to zOffset (0 by default)
  53952. * @param force defines if states must be applied even if cache is up to date
  53953. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  53954. */
  53955. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  53956. /**
  53957. * Set the value of an uniform to an array of int32
  53958. * @param uniform defines the webGL uniform location where to store the value
  53959. * @param array defines the array of int32 to store
  53960. */
  53961. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  53962. /**
  53963. * Set the value of an uniform to an array of int32 (stored as vec2)
  53964. * @param uniform defines the webGL uniform location where to store the value
  53965. * @param array defines the array of int32 to store
  53966. */
  53967. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  53968. /**
  53969. * Set the value of an uniform to an array of int32 (stored as vec3)
  53970. * @param uniform defines the webGL uniform location where to store the value
  53971. * @param array defines the array of int32 to store
  53972. */
  53973. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  53974. /**
  53975. * Set the value of an uniform to an array of int32 (stored as vec4)
  53976. * @param uniform defines the webGL uniform location where to store the value
  53977. * @param array defines the array of int32 to store
  53978. */
  53979. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  53980. /**
  53981. * Set the value of an uniform to an array of float32
  53982. * @param uniform defines the webGL uniform location where to store the value
  53983. * @param array defines the array of float32 to store
  53984. */
  53985. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  53986. /**
  53987. * Set the value of an uniform to an array of float32 (stored as vec2)
  53988. * @param uniform defines the webGL uniform location where to store the value
  53989. * @param array defines the array of float32 to store
  53990. */
  53991. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  53992. /**
  53993. * Set the value of an uniform to an array of float32 (stored as vec3)
  53994. * @param uniform defines the webGL uniform location where to store the value
  53995. * @param array defines the array of float32 to store
  53996. */
  53997. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  53998. /**
  53999. * Set the value of an uniform to an array of float32 (stored as vec4)
  54000. * @param uniform defines the webGL uniform location where to store the value
  54001. * @param array defines the array of float32 to store
  54002. */
  54003. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  54004. /**
  54005. * Set the value of an uniform to an array of number
  54006. * @param uniform defines the webGL uniform location where to store the value
  54007. * @param array defines the array of number to store
  54008. */
  54009. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  54010. /**
  54011. * Set the value of an uniform to an array of number (stored as vec2)
  54012. * @param uniform defines the webGL uniform location where to store the value
  54013. * @param array defines the array of number to store
  54014. */
  54015. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  54016. /**
  54017. * Set the value of an uniform to an array of number (stored as vec3)
  54018. * @param uniform defines the webGL uniform location where to store the value
  54019. * @param array defines the array of number to store
  54020. */
  54021. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  54022. /**
  54023. * Set the value of an uniform to an array of number (stored as vec4)
  54024. * @param uniform defines the webGL uniform location where to store the value
  54025. * @param array defines the array of number to store
  54026. */
  54027. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  54028. /**
  54029. * Set the value of an uniform to an array of float32 (stored as matrices)
  54030. * @param uniform defines the webGL uniform location where to store the value
  54031. * @param matrices defines the array of float32 to store
  54032. */
  54033. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  54034. /**
  54035. * Set the value of an uniform to a matrix (3x3)
  54036. * @param uniform defines the webGL uniform location where to store the value
  54037. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  54038. */
  54039. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  54040. /**
  54041. * Set the value of an uniform to a matrix (2x2)
  54042. * @param uniform defines the webGL uniform location where to store the value
  54043. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  54044. */
  54045. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  54046. /**
  54047. * Set the value of an uniform to a number (float)
  54048. * @param uniform defines the webGL uniform location where to store the value
  54049. * @param value defines the float number to store
  54050. */
  54051. setFloat(uniform: WebGLUniformLocation, value: number): void;
  54052. /**
  54053. * Set the value of an uniform to a vec2
  54054. * @param uniform defines the webGL uniform location where to store the value
  54055. * @param x defines the 1st component of the value
  54056. * @param y defines the 2nd component of the value
  54057. */
  54058. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  54059. /**
  54060. * Set the value of an uniform to a vec3
  54061. * @param uniform defines the webGL uniform location where to store the value
  54062. * @param x defines the 1st component of the value
  54063. * @param y defines the 2nd component of the value
  54064. * @param z defines the 3rd component of the value
  54065. */
  54066. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  54067. /**
  54068. * Set the value of an uniform to a boolean
  54069. * @param uniform defines the webGL uniform location where to store the value
  54070. * @param bool defines the boolean to store
  54071. */
  54072. setBool(uniform: WebGLUniformLocation, bool: number): void;
  54073. /**
  54074. * Set the value of an uniform to a vec4
  54075. * @param uniform defines the webGL uniform location where to store the value
  54076. * @param x defines the 1st component of the value
  54077. * @param y defines the 2nd component of the value
  54078. * @param z defines the 3rd component of the value
  54079. * @param w defines the 4th component of the value
  54080. */
  54081. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  54082. /**
  54083. * Sets the current alpha mode
  54084. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  54085. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  54086. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  54087. */
  54088. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  54089. /**
  54090. * Bind webGl buffers directly to the webGL context
  54091. * @param vertexBuffers defines the vertex buffer to bind
  54092. * @param indexBuffer defines the index buffer to bind
  54093. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  54094. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  54095. * @param effect defines the effect associated with the vertex buffer
  54096. */
  54097. bindBuffers(vertexBuffers: {
  54098. [key: string]: VertexBuffer;
  54099. }, indexBuffer: DataBuffer, effect: Effect): void;
  54100. /**
  54101. * Force the entire cache to be cleared
  54102. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  54103. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  54104. */
  54105. wipeCaches(bruteForce?: boolean): void;
  54106. /**
  54107. * Send a draw order
  54108. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  54109. * @param indexStart defines the starting index
  54110. * @param indexCount defines the number of index to draw
  54111. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  54112. */
  54113. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  54114. /**
  54115. * Draw a list of indexed primitives
  54116. * @param fillMode defines the primitive to use
  54117. * @param indexStart defines the starting index
  54118. * @param indexCount defines the number of index to draw
  54119. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  54120. */
  54121. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  54122. /**
  54123. * Draw a list of unindexed primitives
  54124. * @param fillMode defines the primitive to use
  54125. * @param verticesStart defines the index of first vertex to draw
  54126. * @param verticesCount defines the count of vertices to draw
  54127. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  54128. */
  54129. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  54130. /** @hidden */
  54131. _createTexture(): WebGLTexture;
  54132. /** @hidden */
  54133. _releaseTexture(texture: InternalTexture): void;
  54134. /**
  54135. * Usually called from Texture.ts.
  54136. * Passed information to create a WebGLTexture
  54137. * @param urlArg defines a value which contains one of the following:
  54138. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  54139. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  54140. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  54141. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  54142. * @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)
  54143. * @param scene needed for loading to the correct scene
  54144. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  54145. * @param onLoad optional callback to be called upon successful completion
  54146. * @param onError optional callback to be called upon failure
  54147. * @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
  54148. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  54149. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  54150. * @param forcedExtension defines the extension to use to pick the right loader
  54151. * @param mimeType defines an optional mime type
  54152. * @returns a InternalTexture for assignment back into BABYLON.Texture
  54153. */
  54154. 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;
  54155. /**
  54156. * Creates a new render target texture
  54157. * @param size defines the size of the texture
  54158. * @param options defines the options used to create the texture
  54159. * @returns a new render target texture stored in an InternalTexture
  54160. */
  54161. createRenderTargetTexture(size: any, options: boolean | RenderTargetCreationOptions): InternalTexture;
  54162. /**
  54163. * Update the sampling mode of a given texture
  54164. * @param samplingMode defines the required sampling mode
  54165. * @param texture defines the texture to update
  54166. */
  54167. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  54168. /**
  54169. * Binds the frame buffer to the specified texture.
  54170. * @param texture The texture to render to or null for the default canvas
  54171. * @param faceIndex The face of the texture to render to in case of cube texture
  54172. * @param requiredWidth The width of the target to render to
  54173. * @param requiredHeight The height of the target to render to
  54174. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  54175. * @param lodLevel defines le lod level to bind to the frame buffer
  54176. */
  54177. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  54178. /**
  54179. * Unbind the current render target texture from the webGL context
  54180. * @param texture defines the render target texture to unbind
  54181. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  54182. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  54183. */
  54184. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  54185. /**
  54186. * Creates a dynamic vertex buffer
  54187. * @param vertices the data for the dynamic vertex buffer
  54188. * @returns the new WebGL dynamic buffer
  54189. */
  54190. createDynamicVertexBuffer(vertices: FloatArray): DataBuffer;
  54191. /**
  54192. * Update the content of a dynamic texture
  54193. * @param texture defines the texture to update
  54194. * @param canvas defines the canvas containing the source
  54195. * @param invertY defines if data must be stored with Y axis inverted
  54196. * @param premulAlpha defines if alpha is stored as premultiplied
  54197. * @param format defines the format of the data
  54198. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  54199. */
  54200. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement, invertY: boolean, premulAlpha?: boolean, format?: number): void;
  54201. /**
  54202. * Gets a boolean indicating if all created effects are ready
  54203. * @returns true if all effects are ready
  54204. */
  54205. areAllEffectsReady(): boolean;
  54206. /**
  54207. * @hidden
  54208. * Get the current error code of the webGL context
  54209. * @returns the error code
  54210. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  54211. */
  54212. getError(): number;
  54213. /** @hidden */
  54214. _getUnpackAlignement(): number;
  54215. /** @hidden */
  54216. _unpackFlipY(value: boolean): void;
  54217. /**
  54218. * Update a dynamic index buffer
  54219. * @param indexBuffer defines the target index buffer
  54220. * @param indices defines the data to update
  54221. * @param offset defines the offset in the target index buffer where update should start
  54222. */
  54223. updateDynamicIndexBuffer(indexBuffer: WebGLBuffer, indices: IndicesArray, offset?: number): void;
  54224. /**
  54225. * Updates a dynamic vertex buffer.
  54226. * @param vertexBuffer the vertex buffer to update
  54227. * @param vertices the data used to update the vertex buffer
  54228. * @param byteOffset the byte offset of the data (optional)
  54229. * @param byteLength the byte length of the data (optional)
  54230. */
  54231. updateDynamicVertexBuffer(vertexBuffer: WebGLBuffer, vertices: FloatArray, byteOffset?: number, byteLength?: number): void;
  54232. /** @hidden */
  54233. _bindTextureDirectly(target: number, texture: InternalTexture): boolean;
  54234. /** @hidden */
  54235. _bindTexture(channel: number, texture: InternalTexture): void;
  54236. protected _deleteBuffer(buffer: WebGLBuffer): void;
  54237. /**
  54238. * 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
  54239. */
  54240. releaseEffects(): void;
  54241. displayLoadingUI(): void;
  54242. hideLoadingUI(): void;
  54243. /** @hidden */
  54244. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  54245. /** @hidden */
  54246. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  54247. /** @hidden */
  54248. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  54249. /** @hidden */
  54250. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  54251. }
  54252. }
  54253. declare module "babylonjs/Instrumentation/timeToken" {
  54254. import { Nullable } from "babylonjs/types";
  54255. /**
  54256. * @hidden
  54257. **/
  54258. export class _TimeToken {
  54259. _startTimeQuery: Nullable<WebGLQuery>;
  54260. _endTimeQuery: Nullable<WebGLQuery>;
  54261. _timeElapsedQuery: Nullable<WebGLQuery>;
  54262. _timeElapsedQueryEnded: boolean;
  54263. }
  54264. }
  54265. declare module "babylonjs/Engines/Extensions/engine.occlusionQuery" {
  54266. import { Nullable, int } from "babylonjs/types";
  54267. import { _TimeToken } from "babylonjs/Instrumentation/timeToken";
  54268. /** @hidden */
  54269. export class _OcclusionDataStorage {
  54270. /** @hidden */
  54271. occlusionInternalRetryCounter: number;
  54272. /** @hidden */
  54273. isOcclusionQueryInProgress: boolean;
  54274. /** @hidden */
  54275. isOccluded: boolean;
  54276. /** @hidden */
  54277. occlusionRetryCount: number;
  54278. /** @hidden */
  54279. occlusionType: number;
  54280. /** @hidden */
  54281. occlusionQueryAlgorithmType: number;
  54282. }
  54283. module "babylonjs/Engines/engine" {
  54284. interface Engine {
  54285. /**
  54286. * Create a new webGL query (you must be sure that queries are supported by checking getCaps() function)
  54287. * @return the new query
  54288. */
  54289. createQuery(): WebGLQuery;
  54290. /**
  54291. * Delete and release a webGL query
  54292. * @param query defines the query to delete
  54293. * @return the current engine
  54294. */
  54295. deleteQuery(query: WebGLQuery): Engine;
  54296. /**
  54297. * Check if a given query has resolved and got its value
  54298. * @param query defines the query to check
  54299. * @returns true if the query got its value
  54300. */
  54301. isQueryResultAvailable(query: WebGLQuery): boolean;
  54302. /**
  54303. * Gets the value of a given query
  54304. * @param query defines the query to check
  54305. * @returns the value of the query
  54306. */
  54307. getQueryResult(query: WebGLQuery): number;
  54308. /**
  54309. * Initiates an occlusion query
  54310. * @param algorithmType defines the algorithm to use
  54311. * @param query defines the query to use
  54312. * @returns the current engine
  54313. * @see https://doc.babylonjs.com/features/occlusionquery
  54314. */
  54315. beginOcclusionQuery(algorithmType: number, query: WebGLQuery): Engine;
  54316. /**
  54317. * Ends an occlusion query
  54318. * @see https://doc.babylonjs.com/features/occlusionquery
  54319. * @param algorithmType defines the algorithm to use
  54320. * @returns the current engine
  54321. */
  54322. endOcclusionQuery(algorithmType: number): Engine;
  54323. /**
  54324. * Starts a time query (used to measure time spent by the GPU on a specific frame)
  54325. * Please note that only one query can be issued at a time
  54326. * @returns a time token used to track the time span
  54327. */
  54328. startTimeQuery(): Nullable<_TimeToken>;
  54329. /**
  54330. * Ends a time query
  54331. * @param token defines the token used to measure the time span
  54332. * @returns the time spent (in ns)
  54333. */
  54334. endTimeQuery(token: _TimeToken): int;
  54335. /** @hidden */
  54336. _currentNonTimestampToken: Nullable<_TimeToken>;
  54337. /** @hidden */
  54338. _createTimeQuery(): WebGLQuery;
  54339. /** @hidden */
  54340. _deleteTimeQuery(query: WebGLQuery): void;
  54341. /** @hidden */
  54342. _getGlAlgorithmType(algorithmType: number): number;
  54343. /** @hidden */
  54344. _getTimeQueryResult(query: WebGLQuery): any;
  54345. /** @hidden */
  54346. _getTimeQueryAvailability(query: WebGLQuery): any;
  54347. }
  54348. }
  54349. module "babylonjs/Meshes/abstractMesh" {
  54350. interface AbstractMesh {
  54351. /**
  54352. * Backing filed
  54353. * @hidden
  54354. */
  54355. __occlusionDataStorage: _OcclusionDataStorage;
  54356. /**
  54357. * Access property
  54358. * @hidden
  54359. */
  54360. _occlusionDataStorage: _OcclusionDataStorage;
  54361. /**
  54362. * 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.
  54363. * The default value is -1 which means don't break the query and wait till the result
  54364. * @see https://doc.babylonjs.com/features/occlusionquery
  54365. */
  54366. occlusionRetryCount: number;
  54367. /**
  54368. * 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:
  54369. * * OCCLUSION_TYPE_NONE (Default Value): this option means no occlusion query whith the Mesh.
  54370. * * OCCLUSION_TYPE_OPTIMISTIC: this option is means use occlusion query and if occlusionRetryCount is reached and the query is broken show the mesh.
  54371. * * 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.
  54372. * @see https://doc.babylonjs.com/features/occlusionquery
  54373. */
  54374. occlusionType: number;
  54375. /**
  54376. * This property determines the type of occlusion query algorithm to run in WebGl, you can use:
  54377. * * AbstractMesh.OCCLUSION_ALGORITHM_TYPE_ACCURATE which is mapped to GL_ANY_SAMPLES_PASSED.
  54378. * * 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.
  54379. * @see https://doc.babylonjs.com/features/occlusionquery
  54380. */
  54381. occlusionQueryAlgorithmType: number;
  54382. /**
  54383. * 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
  54384. * @see https://doc.babylonjs.com/features/occlusionquery
  54385. */
  54386. isOccluded: boolean;
  54387. /**
  54388. * Flag to check the progress status of the query
  54389. * @see https://doc.babylonjs.com/features/occlusionquery
  54390. */
  54391. isOcclusionQueryInProgress: boolean;
  54392. }
  54393. }
  54394. }
  54395. declare module "babylonjs/Engines/Extensions/engine.transformFeedback" {
  54396. import { Nullable } from "babylonjs/types";
  54397. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  54398. /** @hidden */
  54399. export var _forceTransformFeedbackToBundle: boolean;
  54400. module "babylonjs/Engines/engine" {
  54401. interface Engine {
  54402. /**
  54403. * Creates a webGL transform feedback object
  54404. * Please makes sure to check webGLVersion property to check if you are running webGL 2+
  54405. * @returns the webGL transform feedback object
  54406. */
  54407. createTransformFeedback(): WebGLTransformFeedback;
  54408. /**
  54409. * Delete a webGL transform feedback object
  54410. * @param value defines the webGL transform feedback object to delete
  54411. */
  54412. deleteTransformFeedback(value: WebGLTransformFeedback): void;
  54413. /**
  54414. * Bind a webGL transform feedback object to the webgl context
  54415. * @param value defines the webGL transform feedback object to bind
  54416. */
  54417. bindTransformFeedback(value: Nullable<WebGLTransformFeedback>): void;
  54418. /**
  54419. * Begins a transform feedback operation
  54420. * @param usePoints defines if points or triangles must be used
  54421. */
  54422. beginTransformFeedback(usePoints: boolean): void;
  54423. /**
  54424. * Ends a transform feedback operation
  54425. */
  54426. endTransformFeedback(): void;
  54427. /**
  54428. * Specify the varyings to use with transform feedback
  54429. * @param program defines the associated webGL program
  54430. * @param value defines the list of strings representing the varying names
  54431. */
  54432. setTranformFeedbackVaryings(program: WebGLProgram, value: string[]): void;
  54433. /**
  54434. * Bind a webGL buffer for a transform feedback operation
  54435. * @param value defines the webGL buffer to bind
  54436. */
  54437. bindTransformFeedbackBuffer(value: Nullable<DataBuffer>): void;
  54438. }
  54439. }
  54440. }
  54441. declare module "babylonjs/Engines/Extensions/engine.views" {
  54442. import { Camera } from "babylonjs/Cameras/camera";
  54443. import { Nullable } from "babylonjs/types";
  54444. /**
  54445. * Class used to define an additional view for the engine
  54446. * @see https://doc.babylonjs.com/how_to/multi_canvases
  54447. */
  54448. export class EngineView {
  54449. /** Defines the canvas where to render the view */
  54450. target: HTMLCanvasElement;
  54451. /** Defines an optional camera used to render the view (will use active camera else) */
  54452. camera?: Camera;
  54453. }
  54454. module "babylonjs/Engines/engine" {
  54455. interface Engine {
  54456. /**
  54457. * Gets or sets the HTML element to use for attaching events
  54458. */
  54459. inputElement: Nullable<HTMLElement>;
  54460. /**
  54461. * Gets the current engine view
  54462. * @see https://doc.babylonjs.com/how_to/multi_canvases
  54463. */
  54464. activeView: Nullable<EngineView>;
  54465. /** Gets or sets the list of views */
  54466. views: EngineView[];
  54467. /**
  54468. * Register a new child canvas
  54469. * @param canvas defines the canvas to register
  54470. * @param camera defines an optional camera to use with this canvas (it will overwrite the scene.camera for this view)
  54471. * @returns the associated view
  54472. */
  54473. registerView(canvas: HTMLCanvasElement, camera?: Camera): EngineView;
  54474. /**
  54475. * Remove a registered child canvas
  54476. * @param canvas defines the canvas to remove
  54477. * @returns the current engine
  54478. */
  54479. unRegisterView(canvas: HTMLCanvasElement): Engine;
  54480. }
  54481. }
  54482. }
  54483. declare module "babylonjs/Engines/Extensions/engine.textureSelector" {
  54484. import { Nullable } from "babylonjs/types";
  54485. module "babylonjs/Engines/engine" {
  54486. interface Engine {
  54487. /** @hidden */
  54488. _excludedCompressedTextures: string[];
  54489. /** @hidden */
  54490. _textureFormatInUse: string;
  54491. /**
  54492. * Gets the list of texture formats supported
  54493. */
  54494. readonly texturesSupported: Array<string>;
  54495. /**
  54496. * Gets the texture format in use
  54497. */
  54498. readonly textureFormatInUse: Nullable<string>;
  54499. /**
  54500. * Set the compressed texture extensions or file names to skip.
  54501. *
  54502. * @param skippedFiles defines the list of those texture files you want to skip
  54503. * Example: [".dds", ".env", "myfile.png"]
  54504. */
  54505. setCompressedTextureExclusions(skippedFiles: Array<string>): void;
  54506. /**
  54507. * Set the compressed texture format to use, based on the formats you have, and the formats
  54508. * supported by the hardware / browser.
  54509. *
  54510. * Khronos Texture Container (.ktx) files are used to support this. This format has the
  54511. * advantage of being specifically designed for OpenGL. Header elements directly correspond
  54512. * to API arguments needed to compressed textures. This puts the burden on the container
  54513. * generator to house the arcane code for determining these for current & future formats.
  54514. *
  54515. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  54516. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  54517. *
  54518. * Note: The result of this call is not taken into account when a texture is base64.
  54519. *
  54520. * @param formatsAvailable defines the list of those format families you have created
  54521. * on your server. Syntax: '-' + format family + '.ktx'. (Case and order do not matter.)
  54522. *
  54523. * Current families are astc, dxt, pvrtc, etc2, & etc1.
  54524. * @returns The extension selected.
  54525. */
  54526. setTextureFormatToUse(formatsAvailable: Array<string>): Nullable<string>;
  54527. }
  54528. }
  54529. }
  54530. declare module "babylonjs/Engines/Extensions/index" {
  54531. export * from "babylonjs/Engines/Extensions/engine.alpha";
  54532. export * from "babylonjs/Engines/Extensions/engine.occlusionQuery";
  54533. export * from "babylonjs/Engines/Extensions/engine.transformFeedback";
  54534. export * from "babylonjs/Engines/Extensions/engine.multiview";
  54535. export * from "babylonjs/Engines/Extensions/engine.rawTexture";
  54536. export * from "babylonjs/Engines/Extensions/engine.dynamicTexture";
  54537. export * from "babylonjs/Engines/Extensions/engine.videoTexture";
  54538. export * from "babylonjs/Engines/Extensions/engine.multiRender";
  54539. export * from "babylonjs/Engines/Extensions/engine.cubeTexture";
  54540. export * from "babylonjs/Engines/Extensions/engine.renderTarget";
  54541. export * from "babylonjs/Engines/Extensions/engine.renderTargetCube";
  54542. export * from "babylonjs/Engines/Extensions/engine.webVR";
  54543. export * from "babylonjs/Engines/Extensions/engine.uniformBuffer";
  54544. export * from "babylonjs/Engines/Extensions/engine.dynamicBuffer";
  54545. export * from "babylonjs/Engines/Extensions/engine.views";
  54546. export * from "babylonjs/Engines/Extensions/engine.readTexture";
  54547. import "babylonjs/Engines/Extensions/engine.textureSelector";
  54548. export * from "babylonjs/Engines/Extensions/engine.textureSelector";
  54549. }
  54550. declare module "babylonjs/Misc/HighDynamicRange/panoramaToCubemap" {
  54551. import { Nullable } from "babylonjs/types";
  54552. /**
  54553. * CubeMap information grouping all the data for each faces as well as the cubemap size.
  54554. */
  54555. export interface CubeMapInfo {
  54556. /**
  54557. * The pixel array for the front face.
  54558. * This is stored in format, left to right, up to down format.
  54559. */
  54560. front: Nullable<ArrayBufferView>;
  54561. /**
  54562. * The pixel array for the back face.
  54563. * This is stored in format, left to right, up to down format.
  54564. */
  54565. back: Nullable<ArrayBufferView>;
  54566. /**
  54567. * The pixel array for the left face.
  54568. * This is stored in format, left to right, up to down format.
  54569. */
  54570. left: Nullable<ArrayBufferView>;
  54571. /**
  54572. * The pixel array for the right face.
  54573. * This is stored in format, left to right, up to down format.
  54574. */
  54575. right: Nullable<ArrayBufferView>;
  54576. /**
  54577. * The pixel array for the up face.
  54578. * This is stored in format, left to right, up to down format.
  54579. */
  54580. up: Nullable<ArrayBufferView>;
  54581. /**
  54582. * The pixel array for the down face.
  54583. * This is stored in format, left to right, up to down format.
  54584. */
  54585. down: Nullable<ArrayBufferView>;
  54586. /**
  54587. * The size of the cubemap stored.
  54588. *
  54589. * Each faces will be size * size pixels.
  54590. */
  54591. size: number;
  54592. /**
  54593. * The format of the texture.
  54594. *
  54595. * RGBA, RGB.
  54596. */
  54597. format: number;
  54598. /**
  54599. * The type of the texture data.
  54600. *
  54601. * UNSIGNED_INT, FLOAT.
  54602. */
  54603. type: number;
  54604. /**
  54605. * Specifies whether the texture is in gamma space.
  54606. */
  54607. gammaSpace: boolean;
  54608. }
  54609. /**
  54610. * Helper class useful to convert panorama picture to their cubemap representation in 6 faces.
  54611. */
  54612. export class PanoramaToCubeMapTools {
  54613. private static FACE_LEFT;
  54614. private static FACE_RIGHT;
  54615. private static FACE_FRONT;
  54616. private static FACE_BACK;
  54617. private static FACE_DOWN;
  54618. private static FACE_UP;
  54619. /**
  54620. * Converts a panorma stored in RGB right to left up to down format into a cubemap (6 faces).
  54621. *
  54622. * @param float32Array The source data.
  54623. * @param inputWidth The width of the input panorama.
  54624. * @param inputHeight The height of the input panorama.
  54625. * @param size The willing size of the generated cubemap (each faces will be size * size pixels)
  54626. * @return The cubemap data
  54627. */
  54628. static ConvertPanoramaToCubemap(float32Array: Float32Array, inputWidth: number, inputHeight: number, size: number): CubeMapInfo;
  54629. private static CreateCubemapTexture;
  54630. private static CalcProjectionSpherical;
  54631. }
  54632. }
  54633. declare module "babylonjs/Misc/HighDynamicRange/cubemapToSphericalPolynomial" {
  54634. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  54635. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54636. import { Nullable } from "babylonjs/types";
  54637. import { CubeMapInfo } from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  54638. /**
  54639. * Helper class dealing with the extraction of spherical polynomial dataArray
  54640. * from a cube map.
  54641. */
  54642. export class CubeMapToSphericalPolynomialTools {
  54643. private static FileFaces;
  54644. /**
  54645. * Converts a texture to the according Spherical Polynomial data.
  54646. * This extracts the first 3 orders only as they are the only one used in the lighting.
  54647. *
  54648. * @param texture The texture to extract the information from.
  54649. * @return The Spherical Polynomial data.
  54650. */
  54651. static ConvertCubeMapTextureToSphericalPolynomial(texture: BaseTexture): Nullable<SphericalPolynomial>;
  54652. /**
  54653. * Converts a cubemap to the according Spherical Polynomial data.
  54654. * This extracts the first 3 orders only as they are the only one used in the lighting.
  54655. *
  54656. * @param cubeInfo The Cube map to extract the information from.
  54657. * @return The Spherical Polynomial data.
  54658. */
  54659. static ConvertCubeMapToSphericalPolynomial(cubeInfo: CubeMapInfo): SphericalPolynomial;
  54660. }
  54661. }
  54662. declare module "babylonjs/Materials/Textures/baseTexture.polynomial" {
  54663. import { Nullable } from "babylonjs/types";
  54664. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  54665. module "babylonjs/Materials/Textures/baseTexture" {
  54666. interface BaseTexture {
  54667. /**
  54668. * Get the polynomial representation of the texture data.
  54669. * This is mainly use as a fast way to recover IBL Diffuse irradiance data.
  54670. * @see https://learnopengl.com/PBR/IBL/Diffuse-irradiance
  54671. */
  54672. sphericalPolynomial: Nullable<SphericalPolynomial>;
  54673. }
  54674. }
  54675. }
  54676. declare module "babylonjs/Shaders/rgbdEncode.fragment" {
  54677. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  54678. /** @hidden */
  54679. export var rgbdEncodePixelShader: {
  54680. name: string;
  54681. shader: string;
  54682. };
  54683. }
  54684. declare module "babylonjs/Shaders/rgbdDecode.fragment" {
  54685. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  54686. /** @hidden */
  54687. export var rgbdDecodePixelShader: {
  54688. name: string;
  54689. shader: string;
  54690. };
  54691. }
  54692. declare module "babylonjs/Misc/environmentTextureTools" {
  54693. import { Nullable } from "babylonjs/types";
  54694. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  54695. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  54696. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54697. import "babylonjs/Engines/Extensions/engine.renderTargetCube";
  54698. import "babylonjs/Engines/Extensions/engine.readTexture";
  54699. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  54700. import "babylonjs/Shaders/rgbdEncode.fragment";
  54701. import "babylonjs/Shaders/rgbdDecode.fragment";
  54702. /**
  54703. * Raw texture data and descriptor sufficient for WebGL texture upload
  54704. */
  54705. export interface EnvironmentTextureInfo {
  54706. /**
  54707. * Version of the environment map
  54708. */
  54709. version: number;
  54710. /**
  54711. * Width of image
  54712. */
  54713. width: number;
  54714. /**
  54715. * Irradiance information stored in the file.
  54716. */
  54717. irradiance: any;
  54718. /**
  54719. * Specular information stored in the file.
  54720. */
  54721. specular: any;
  54722. }
  54723. /**
  54724. * Defines One Image in the file. It requires only the position in the file
  54725. * as well as the length.
  54726. */
  54727. interface BufferImageData {
  54728. /**
  54729. * Length of the image data.
  54730. */
  54731. length: number;
  54732. /**
  54733. * Position of the data from the null terminator delimiting the end of the JSON.
  54734. */
  54735. position: number;
  54736. }
  54737. /**
  54738. * Defines the specular data enclosed in the file.
  54739. * This corresponds to the version 1 of the data.
  54740. */
  54741. export interface EnvironmentTextureSpecularInfoV1 {
  54742. /**
  54743. * Defines where the specular Payload is located. It is a runtime value only not stored in the file.
  54744. */
  54745. specularDataPosition?: number;
  54746. /**
  54747. * This contains all the images data needed to reconstruct the cubemap.
  54748. */
  54749. mipmaps: Array<BufferImageData>;
  54750. /**
  54751. * Defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness.
  54752. */
  54753. lodGenerationScale: number;
  54754. }
  54755. /**
  54756. * Sets of helpers addressing the serialization and deserialization of environment texture
  54757. * stored in a BabylonJS env file.
  54758. * Those files are usually stored as .env files.
  54759. */
  54760. export class EnvironmentTextureTools {
  54761. /**
  54762. * Magic number identifying the env file.
  54763. */
  54764. private static _MagicBytes;
  54765. /**
  54766. * Gets the environment info from an env file.
  54767. * @param data The array buffer containing the .env bytes.
  54768. * @returns the environment file info (the json header) if successfully parsed.
  54769. */
  54770. static GetEnvInfo(data: ArrayBufferView): Nullable<EnvironmentTextureInfo>;
  54771. /**
  54772. * Creates an environment texture from a loaded cube texture.
  54773. * @param texture defines the cube texture to convert in env file
  54774. * @return a promise containing the environment data if succesfull.
  54775. */
  54776. static CreateEnvTextureAsync(texture: BaseTexture): Promise<ArrayBuffer>;
  54777. /**
  54778. * Creates a JSON representation of the spherical data.
  54779. * @param texture defines the texture containing the polynomials
  54780. * @return the JSON representation of the spherical info
  54781. */
  54782. private static _CreateEnvTextureIrradiance;
  54783. /**
  54784. * Creates the ArrayBufferViews used for initializing environment texture image data.
  54785. * @param data the image data
  54786. * @param info parameters that determine what views will be created for accessing the underlying buffer
  54787. * @return the views described by info providing access to the underlying buffer
  54788. */
  54789. static CreateImageDataArrayBufferViews(data: ArrayBufferView, info: EnvironmentTextureInfo): Array<Array<ArrayBufferView>>;
  54790. /**
  54791. * Uploads the texture info contained in the env file to the GPU.
  54792. * @param texture defines the internal texture to upload to
  54793. * @param data defines the data to load
  54794. * @param info defines the texture info retrieved through the GetEnvInfo method
  54795. * @returns a promise
  54796. */
  54797. static UploadEnvLevelsAsync(texture: InternalTexture, data: ArrayBufferView, info: EnvironmentTextureInfo): Promise<void>;
  54798. private static _OnImageReadyAsync;
  54799. /**
  54800. * Uploads the levels of image data to the GPU.
  54801. * @param texture defines the internal texture to upload to
  54802. * @param imageData defines the array buffer views of image data [mipmap][face]
  54803. * @returns a promise
  54804. */
  54805. static UploadLevelsAsync(texture: InternalTexture, imageData: ArrayBufferView[][]): Promise<void>;
  54806. /**
  54807. * Uploads spherical polynomials information to the texture.
  54808. * @param texture defines the texture we are trying to upload the information to
  54809. * @param info defines the environment texture info retrieved through the GetEnvInfo method
  54810. */
  54811. static UploadEnvSpherical(texture: InternalTexture, info: EnvironmentTextureInfo): void;
  54812. /** @hidden */
  54813. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  54814. }
  54815. }
  54816. declare module "babylonjs/Engines/Processors/shaderCodeInliner" {
  54817. /**
  54818. * Class used to inline functions in shader code
  54819. */
  54820. export class ShaderCodeInliner {
  54821. private static readonly _RegexpFindFunctionNameAndType;
  54822. private _sourceCode;
  54823. private _functionDescr;
  54824. private _numMaxIterations;
  54825. /** Gets or sets the token used to mark the functions to inline */
  54826. inlineToken: string;
  54827. /** Gets or sets the debug mode */
  54828. debug: boolean;
  54829. /** Gets the code after the inlining process */
  54830. get code(): string;
  54831. /**
  54832. * Initializes the inliner
  54833. * @param sourceCode shader code source to inline
  54834. * @param numMaxIterations maximum number of iterations (used to detect recursive calls)
  54835. */
  54836. constructor(sourceCode: string, numMaxIterations?: number);
  54837. /**
  54838. * Start the processing of the shader code
  54839. */
  54840. processCode(): void;
  54841. private _collectFunctions;
  54842. private _processInlining;
  54843. private _extractBetweenMarkers;
  54844. private _skipWhitespaces;
  54845. private _removeComments;
  54846. private _replaceFunctionCallsByCode;
  54847. private _findBackward;
  54848. private _escapeRegExp;
  54849. private _replaceNames;
  54850. }
  54851. }
  54852. declare module "babylonjs/Engines/nativeEngine" {
  54853. import { Nullable, IndicesArray, DataArray } from "babylonjs/types";
  54854. import { Engine } from "babylonjs/Engines/engine";
  54855. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  54856. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  54857. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54858. import { Effect } from "babylonjs/Materials/effect";
  54859. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  54860. import { Matrix, Viewport, Color3 } from "babylonjs/Maths/math";
  54861. import { IColor4Like } from "babylonjs/Maths/math.like";
  54862. import { Scene } from "babylonjs/scene";
  54863. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  54864. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  54865. import { ISceneLike } from "babylonjs/Engines/thinEngine";
  54866. /**
  54867. * Container for accessors for natively-stored mesh data buffers.
  54868. */
  54869. class NativeDataBuffer extends DataBuffer {
  54870. /**
  54871. * Accessor value used to identify/retrieve a natively-stored index buffer.
  54872. */
  54873. nativeIndexBuffer?: any;
  54874. /**
  54875. * Accessor value used to identify/retrieve a natively-stored vertex buffer.
  54876. */
  54877. nativeVertexBuffer?: any;
  54878. }
  54879. /** @hidden */
  54880. class NativeTexture extends InternalTexture {
  54881. getInternalTexture(): InternalTexture;
  54882. getViewCount(): number;
  54883. }
  54884. /** @hidden */
  54885. export class NativeEngine extends Engine {
  54886. private readonly _native;
  54887. /** Defines the invalid handle returned by bgfx when resource creation goes wrong */
  54888. private readonly INVALID_HANDLE;
  54889. private _boundBuffersVertexArray;
  54890. getHardwareScalingLevel(): number;
  54891. constructor();
  54892. dispose(): void;
  54893. /**
  54894. * Can be used to override the current requestAnimationFrame requester.
  54895. * @hidden
  54896. */
  54897. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  54898. /**
  54899. * Override default engine behavior.
  54900. * @param color
  54901. * @param backBuffer
  54902. * @param depth
  54903. * @param stencil
  54904. */
  54905. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  54906. /**
  54907. * Gets host document
  54908. * @returns the host document object
  54909. */
  54910. getHostDocument(): Nullable<Document>;
  54911. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  54912. createIndexBuffer(indices: IndicesArray, updateable?: boolean): NativeDataBuffer;
  54913. createVertexBuffer(data: DataArray, updateable?: boolean): NativeDataBuffer;
  54914. protected _recordVertexArrayObject(vertexArray: any, vertexBuffers: {
  54915. [key: string]: VertexBuffer;
  54916. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): void;
  54917. bindBuffers(vertexBuffers: {
  54918. [key: string]: VertexBuffer;
  54919. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): void;
  54920. recordVertexArrayObject(vertexBuffers: {
  54921. [key: string]: VertexBuffer;
  54922. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): WebGLVertexArrayObject;
  54923. bindVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  54924. releaseVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  54925. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  54926. /**
  54927. * Draw a list of indexed primitives
  54928. * @param fillMode defines the primitive to use
  54929. * @param indexStart defines the starting index
  54930. * @param indexCount defines the number of index to draw
  54931. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  54932. */
  54933. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  54934. /**
  54935. * Draw a list of unindexed primitives
  54936. * @param fillMode defines the primitive to use
  54937. * @param verticesStart defines the index of first vertex to draw
  54938. * @param verticesCount defines the count of vertices to draw
  54939. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  54940. */
  54941. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  54942. createPipelineContext(): IPipelineContext;
  54943. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  54944. /** @hidden */
  54945. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  54946. /** @hidden */
  54947. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  54948. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  54949. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  54950. protected _setProgram(program: WebGLProgram): void;
  54951. _releaseEffect(effect: Effect): void;
  54952. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  54953. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): WebGLUniformLocation[];
  54954. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  54955. bindSamplers(effect: Effect): void;
  54956. setMatrix(uniform: WebGLUniformLocation, matrix: Matrix): void;
  54957. getRenderWidth(useScreen?: boolean): number;
  54958. getRenderHeight(useScreen?: boolean): number;
  54959. setViewport(viewport: Viewport, requiredWidth?: number, requiredHeight?: number): void;
  54960. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  54961. /**
  54962. * Set the z offset to apply to current rendering
  54963. * @param value defines the offset to apply
  54964. */
  54965. setZOffset(value: number): void;
  54966. /**
  54967. * Gets the current value of the zOffset
  54968. * @returns the current zOffset state
  54969. */
  54970. getZOffset(): number;
  54971. /**
  54972. * Enable or disable depth buffering
  54973. * @param enable defines the state to set
  54974. */
  54975. setDepthBuffer(enable: boolean): void;
  54976. /**
  54977. * Gets a boolean indicating if depth writing is enabled
  54978. * @returns the current depth writing state
  54979. */
  54980. getDepthWrite(): boolean;
  54981. /**
  54982. * Enable or disable depth writing
  54983. * @param enable defines the state to set
  54984. */
  54985. setDepthWrite(enable: boolean): void;
  54986. /**
  54987. * Enable or disable color writing
  54988. * @param enable defines the state to set
  54989. */
  54990. setColorWrite(enable: boolean): void;
  54991. /**
  54992. * Gets a boolean indicating if color writing is enabled
  54993. * @returns the current color writing state
  54994. */
  54995. getColorWrite(): boolean;
  54996. /**
  54997. * Sets alpha constants used by some alpha blending modes
  54998. * @param r defines the red component
  54999. * @param g defines the green component
  55000. * @param b defines the blue component
  55001. * @param a defines the alpha component
  55002. */
  55003. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  55004. /**
  55005. * Sets the current alpha mode
  55006. * @param mode defines the mode to use (one of the BABYLON.Constants.ALPHA_XXX)
  55007. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  55008. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  55009. */
  55010. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  55011. /**
  55012. * Gets the current alpha mode
  55013. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  55014. * @returns the current alpha mode
  55015. */
  55016. getAlphaMode(): number;
  55017. setInt(uniform: WebGLUniformLocation, int: number): void;
  55018. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  55019. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  55020. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  55021. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  55022. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  55023. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  55024. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  55025. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  55026. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  55027. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  55028. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  55029. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  55030. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  55031. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  55032. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  55033. setFloat(uniform: WebGLUniformLocation, value: number): void;
  55034. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  55035. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  55036. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  55037. setColor3(uniform: WebGLUniformLocation, color3: Color3): void;
  55038. setColor4(uniform: WebGLUniformLocation, color3: Color3, alpha: number): void;
  55039. wipeCaches(bruteForce?: boolean): void;
  55040. _createTexture(): WebGLTexture;
  55041. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  55042. /**
  55043. * Usually called from Texture.ts.
  55044. * Passed information to create a WebGLTexture
  55045. * @param url defines a value which contains one of the following:
  55046. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  55047. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  55048. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  55049. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  55050. * @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)
  55051. * @param scene needed for loading to the correct scene
  55052. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  55053. * @param onLoad optional callback to be called upon successful completion
  55054. * @param onError optional callback to be called upon failure
  55055. * @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
  55056. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  55057. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  55058. * @param forcedExtension defines the extension to use to pick the right loader
  55059. * @param mimeType defines an optional mime type
  55060. * @returns a InternalTexture for assignment back into BABYLON.Texture
  55061. */
  55062. 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;
  55063. /**
  55064. * Creates a cube texture
  55065. * @param rootUrl defines the url where the files to load is located
  55066. * @param scene defines the current scene
  55067. * @param files defines the list of files to load (1 per face)
  55068. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  55069. * @param onLoad defines an optional callback raised when the texture is loaded
  55070. * @param onError defines an optional callback raised if there is an issue to load the texture
  55071. * @param format defines the format of the data
  55072. * @param forcedExtension defines the extension to use to pick the right loader
  55073. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  55074. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  55075. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  55076. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  55077. * @returns the cube texture as an InternalTexture
  55078. */
  55079. 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;
  55080. private _getSamplingFilter;
  55081. private static _GetNativeTextureFormat;
  55082. createRenderTargetTexture(size: number | {
  55083. width: number;
  55084. height: number;
  55085. }, options: boolean | RenderTargetCreationOptions): NativeTexture;
  55086. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  55087. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  55088. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  55089. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  55090. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  55091. /**
  55092. * Updates a dynamic vertex buffer.
  55093. * @param vertexBuffer the vertex buffer to update
  55094. * @param data the data used to update the vertex buffer
  55095. * @param byteOffset the byte offset of the data (optional)
  55096. * @param byteLength the byte length of the data (optional)
  55097. */
  55098. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  55099. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  55100. private _updateAnisotropicLevel;
  55101. private _getAddressMode;
  55102. /** @hidden */
  55103. _bindTexture(channel: number, texture: InternalTexture): void;
  55104. protected _deleteBuffer(buffer: NativeDataBuffer): void;
  55105. releaseEffects(): void;
  55106. /** @hidden */
  55107. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  55108. /** @hidden */
  55109. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  55110. /** @hidden */
  55111. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  55112. /** @hidden */
  55113. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  55114. }
  55115. }
  55116. declare module "babylonjs/Engines/index" {
  55117. export * from "babylonjs/Engines/constants";
  55118. export * from "babylonjs/Engines/engineCapabilities";
  55119. export * from "babylonjs/Engines/instancingAttributeInfo";
  55120. export * from "babylonjs/Engines/thinEngine";
  55121. export * from "babylonjs/Engines/engine";
  55122. export * from "babylonjs/Engines/engineStore";
  55123. export * from "babylonjs/Engines/nullEngine";
  55124. export * from "babylonjs/Engines/Extensions/index";
  55125. export * from "babylonjs/Engines/IPipelineContext";
  55126. export * from "babylonjs/Engines/WebGL/webGLPipelineContext";
  55127. export * from "babylonjs/Engines/WebGL/webGL2ShaderProcessors";
  55128. export * from "babylonjs/Engines/nativeEngine";
  55129. export * from "babylonjs/Engines/Processors/shaderCodeInliner";
  55130. export * from "babylonjs/Engines/performanceConfigurator";
  55131. }
  55132. declare module "babylonjs/Events/clipboardEvents" {
  55133. /**
  55134. * Gather the list of clipboard event types as constants.
  55135. */
  55136. export class ClipboardEventTypes {
  55137. /**
  55138. * The clipboard event is fired when a copy command is active (pressed).
  55139. */
  55140. static readonly COPY: number;
  55141. /**
  55142. * The clipboard event is fired when a cut command is active (pressed).
  55143. */
  55144. static readonly CUT: number;
  55145. /**
  55146. * The clipboard event is fired when a paste command is active (pressed).
  55147. */
  55148. static readonly PASTE: number;
  55149. }
  55150. /**
  55151. * This class is used to store clipboard related info for the onClipboardObservable event.
  55152. */
  55153. export class ClipboardInfo {
  55154. /**
  55155. * Defines the type of event (BABYLON.ClipboardEventTypes)
  55156. */
  55157. type: number;
  55158. /**
  55159. * Defines the related dom event
  55160. */
  55161. event: ClipboardEvent;
  55162. /**
  55163. *Creates an instance of ClipboardInfo.
  55164. * @param type Defines the type of event (BABYLON.ClipboardEventTypes)
  55165. * @param event Defines the related dom event
  55166. */
  55167. constructor(
  55168. /**
  55169. * Defines the type of event (BABYLON.ClipboardEventTypes)
  55170. */
  55171. type: number,
  55172. /**
  55173. * Defines the related dom event
  55174. */
  55175. event: ClipboardEvent);
  55176. /**
  55177. * Get the clipboard event's type from the keycode.
  55178. * @param keyCode Defines the keyCode for the current keyboard event.
  55179. * @return {number}
  55180. */
  55181. static GetTypeFromCharacter(keyCode: number): number;
  55182. }
  55183. }
  55184. declare module "babylonjs/Events/index" {
  55185. export * from "babylonjs/Events/keyboardEvents";
  55186. export * from "babylonjs/Events/pointerEvents";
  55187. export * from "babylonjs/Events/clipboardEvents";
  55188. }
  55189. declare module "babylonjs/Gamepads/Controllers/daydreamController" {
  55190. import { Scene } from "babylonjs/scene";
  55191. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55192. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55193. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55194. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55195. /**
  55196. * Google Daydream controller
  55197. */
  55198. export class DaydreamController extends WebVRController {
  55199. /**
  55200. * Base Url for the controller model.
  55201. */
  55202. static MODEL_BASE_URL: string;
  55203. /**
  55204. * File name for the controller model.
  55205. */
  55206. static MODEL_FILENAME: string;
  55207. /**
  55208. * Gamepad Id prefix used to identify Daydream Controller.
  55209. */
  55210. static readonly GAMEPAD_ID_PREFIX: string;
  55211. /**
  55212. * Creates a new DaydreamController from a gamepad
  55213. * @param vrGamepad the gamepad that the controller should be created from
  55214. */
  55215. constructor(vrGamepad: any);
  55216. /**
  55217. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55218. * @param scene scene in which to add meshes
  55219. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55220. */
  55221. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  55222. /**
  55223. * Called once for each button that changed state since the last frame
  55224. * @param buttonIdx Which button index changed
  55225. * @param state New state of the button
  55226. * @param changes Which properties on the state changed since last frame
  55227. */
  55228. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55229. }
  55230. }
  55231. declare module "babylonjs/Gamepads/Controllers/gearVRController" {
  55232. import { Scene } from "babylonjs/scene";
  55233. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55234. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55235. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55236. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55237. /**
  55238. * Gear VR Controller
  55239. */
  55240. export class GearVRController extends WebVRController {
  55241. /**
  55242. * Base Url for the controller model.
  55243. */
  55244. static MODEL_BASE_URL: string;
  55245. /**
  55246. * File name for the controller model.
  55247. */
  55248. static MODEL_FILENAME: string;
  55249. /**
  55250. * Gamepad Id prefix used to identify this controller.
  55251. */
  55252. static readonly GAMEPAD_ID_PREFIX: string;
  55253. private readonly _buttonIndexToObservableNameMap;
  55254. /**
  55255. * Creates a new GearVRController from a gamepad
  55256. * @param vrGamepad the gamepad that the controller should be created from
  55257. */
  55258. constructor(vrGamepad: any);
  55259. /**
  55260. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55261. * @param scene scene in which to add meshes
  55262. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55263. */
  55264. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  55265. /**
  55266. * Called once for each button that changed state since the last frame
  55267. * @param buttonIdx Which button index changed
  55268. * @param state New state of the button
  55269. * @param changes Which properties on the state changed since last frame
  55270. */
  55271. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55272. }
  55273. }
  55274. declare module "babylonjs/Gamepads/Controllers/genericController" {
  55275. import { Scene } from "babylonjs/scene";
  55276. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55277. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55278. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55279. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55280. /**
  55281. * Generic Controller
  55282. */
  55283. export class GenericController extends WebVRController {
  55284. /**
  55285. * Base Url for the controller model.
  55286. */
  55287. static readonly MODEL_BASE_URL: string;
  55288. /**
  55289. * File name for the controller model.
  55290. */
  55291. static readonly MODEL_FILENAME: string;
  55292. /**
  55293. * Creates a new GenericController from a gamepad
  55294. * @param vrGamepad the gamepad that the controller should be created from
  55295. */
  55296. constructor(vrGamepad: any);
  55297. /**
  55298. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55299. * @param scene scene in which to add meshes
  55300. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55301. */
  55302. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  55303. /**
  55304. * Called once for each button that changed state since the last frame
  55305. * @param buttonIdx Which button index changed
  55306. * @param state New state of the button
  55307. * @param changes Which properties on the state changed since last frame
  55308. */
  55309. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55310. }
  55311. }
  55312. declare module "babylonjs/Gamepads/Controllers/oculusTouchController" {
  55313. import { Observable } from "babylonjs/Misc/observable";
  55314. import { Scene } from "babylonjs/scene";
  55315. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55316. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55317. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55318. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55319. /**
  55320. * Oculus Touch Controller
  55321. */
  55322. export class OculusTouchController extends WebVRController {
  55323. /**
  55324. * Base Url for the controller model.
  55325. */
  55326. static MODEL_BASE_URL: string;
  55327. /**
  55328. * File name for the left controller model.
  55329. */
  55330. static MODEL_LEFT_FILENAME: string;
  55331. /**
  55332. * File name for the right controller model.
  55333. */
  55334. static MODEL_RIGHT_FILENAME: string;
  55335. /**
  55336. * Base Url for the Quest controller model.
  55337. */
  55338. static QUEST_MODEL_BASE_URL: string;
  55339. /**
  55340. * @hidden
  55341. * If the controllers are running on a device that needs the updated Quest controller models
  55342. */
  55343. static _IsQuest: boolean;
  55344. /**
  55345. * Fired when the secondary trigger on this controller is modified
  55346. */
  55347. onSecondaryTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  55348. /**
  55349. * Fired when the thumb rest on this controller is modified
  55350. */
  55351. onThumbRestChangedObservable: Observable<ExtendedGamepadButton>;
  55352. /**
  55353. * Creates a new OculusTouchController from a gamepad
  55354. * @param vrGamepad the gamepad that the controller should be created from
  55355. */
  55356. constructor(vrGamepad: any);
  55357. /**
  55358. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55359. * @param scene scene in which to add meshes
  55360. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55361. */
  55362. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  55363. /**
  55364. * Fired when the A button on this controller is modified
  55365. */
  55366. get onAButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55367. /**
  55368. * Fired when the B button on this controller is modified
  55369. */
  55370. get onBButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55371. /**
  55372. * Fired when the X button on this controller is modified
  55373. */
  55374. get onXButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55375. /**
  55376. * Fired when the Y button on this controller is modified
  55377. */
  55378. get onYButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55379. /**
  55380. * Called once for each button that changed state since the last frame
  55381. * 0) thumb stick (touch, press, value = pressed (0,1)). value is in this.leftStick
  55382. * 1) index trigger (touch (?), press (only when value > 0.1), value 0 to 1)
  55383. * 2) secondary trigger (same)
  55384. * 3) A (right) X (left), touch, pressed = value
  55385. * 4) B / Y
  55386. * 5) thumb rest
  55387. * @param buttonIdx Which button index changed
  55388. * @param state New state of the button
  55389. * @param changes Which properties on the state changed since last frame
  55390. */
  55391. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55392. }
  55393. }
  55394. declare module "babylonjs/Gamepads/Controllers/viveController" {
  55395. import { Scene } from "babylonjs/scene";
  55396. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55397. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55398. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55399. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55400. import { Observable } from "babylonjs/Misc/observable";
  55401. /**
  55402. * Vive Controller
  55403. */
  55404. export class ViveController extends WebVRController {
  55405. /**
  55406. * Base Url for the controller model.
  55407. */
  55408. static MODEL_BASE_URL: string;
  55409. /**
  55410. * File name for the controller model.
  55411. */
  55412. static MODEL_FILENAME: string;
  55413. /**
  55414. * Creates a new ViveController from a gamepad
  55415. * @param vrGamepad the gamepad that the controller should be created from
  55416. */
  55417. constructor(vrGamepad: any);
  55418. /**
  55419. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55420. * @param scene scene in which to add meshes
  55421. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55422. */
  55423. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  55424. /**
  55425. * Fired when the left button on this controller is modified
  55426. */
  55427. get onLeftButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55428. /**
  55429. * Fired when the right button on this controller is modified
  55430. */
  55431. get onRightButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55432. /**
  55433. * Fired when the menu button on this controller is modified
  55434. */
  55435. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55436. /**
  55437. * Called once for each button that changed state since the last frame
  55438. * Vive mapping:
  55439. * 0: touchpad
  55440. * 1: trigger
  55441. * 2: left AND right buttons
  55442. * 3: menu button
  55443. * @param buttonIdx Which button index changed
  55444. * @param state New state of the button
  55445. * @param changes Which properties on the state changed since last frame
  55446. */
  55447. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55448. }
  55449. }
  55450. declare module "babylonjs/Gamepads/Controllers/windowsMotionController" {
  55451. import { Observable } from "babylonjs/Misc/observable";
  55452. import { Scene } from "babylonjs/scene";
  55453. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55454. import { Ray } from "babylonjs/Culling/ray";
  55455. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55456. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55457. import { StickValues, GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55458. /**
  55459. * Defines the WindowsMotionController object that the state of the windows motion controller
  55460. */
  55461. export class WindowsMotionController extends WebVRController {
  55462. /**
  55463. * The base url used to load the left and right controller models
  55464. */
  55465. static MODEL_BASE_URL: string;
  55466. /**
  55467. * The name of the left controller model file
  55468. */
  55469. static MODEL_LEFT_FILENAME: string;
  55470. /**
  55471. * The name of the right controller model file
  55472. */
  55473. static MODEL_RIGHT_FILENAME: string;
  55474. /**
  55475. * The controller name prefix for this controller type
  55476. */
  55477. static readonly GAMEPAD_ID_PREFIX: string;
  55478. /**
  55479. * The controller id pattern for this controller type
  55480. */
  55481. private static readonly GAMEPAD_ID_PATTERN;
  55482. private _loadedMeshInfo;
  55483. protected readonly _mapping: {
  55484. buttons: string[];
  55485. buttonMeshNames: {
  55486. trigger: string;
  55487. menu: string;
  55488. grip: string;
  55489. thumbstick: string;
  55490. trackpad: string;
  55491. };
  55492. buttonObservableNames: {
  55493. trigger: string;
  55494. menu: string;
  55495. grip: string;
  55496. thumbstick: string;
  55497. trackpad: string;
  55498. };
  55499. axisMeshNames: string[];
  55500. pointingPoseMeshName: string;
  55501. };
  55502. /**
  55503. * Fired when the trackpad on this controller is clicked
  55504. */
  55505. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  55506. /**
  55507. * Fired when the trackpad on this controller is modified
  55508. */
  55509. onTrackpadValuesChangedObservable: Observable<StickValues>;
  55510. /**
  55511. * The current x and y values of this controller's trackpad
  55512. */
  55513. trackpad: StickValues;
  55514. /**
  55515. * Creates a new WindowsMotionController from a gamepad
  55516. * @param vrGamepad the gamepad that the controller should be created from
  55517. */
  55518. constructor(vrGamepad: any);
  55519. /**
  55520. * Fired when the trigger on this controller is modified
  55521. */
  55522. get onTriggerButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55523. /**
  55524. * Fired when the menu button on this controller is modified
  55525. */
  55526. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55527. /**
  55528. * Fired when the grip button on this controller is modified
  55529. */
  55530. get onGripButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55531. /**
  55532. * Fired when the thumbstick button on this controller is modified
  55533. */
  55534. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55535. /**
  55536. * Fired when the touchpad button on this controller is modified
  55537. */
  55538. get onTouchpadButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55539. /**
  55540. * Fired when the touchpad values on this controller are modified
  55541. */
  55542. get onTouchpadValuesChangedObservable(): Observable<StickValues>;
  55543. protected _updateTrackpad(): void;
  55544. /**
  55545. * Called once per frame by the engine.
  55546. */
  55547. update(): void;
  55548. /**
  55549. * Called once for each button that changed state since the last frame
  55550. * @param buttonIdx Which button index changed
  55551. * @param state New state of the button
  55552. * @param changes Which properties on the state changed since last frame
  55553. */
  55554. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55555. /**
  55556. * Moves the buttons on the controller mesh based on their current state
  55557. * @param buttonName the name of the button to move
  55558. * @param buttonValue the value of the button which determines the buttons new position
  55559. */
  55560. protected _lerpButtonTransform(buttonName: string, buttonValue: number): void;
  55561. /**
  55562. * Moves the axis on the controller mesh based on its current state
  55563. * @param axis the index of the axis
  55564. * @param axisValue the value of the axis which determines the meshes new position
  55565. * @hidden
  55566. */
  55567. protected _lerpAxisTransform(axis: number, axisValue: number): void;
  55568. /**
  55569. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55570. * @param scene scene in which to add meshes
  55571. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55572. */
  55573. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void, forceDefault?: boolean): void;
  55574. /**
  55575. * Takes a list of meshes (as loaded from the glTF file) and finds the root node, as well as nodes that
  55576. * can be transformed by button presses and axes values, based on this._mapping.
  55577. *
  55578. * @param scene scene in which the meshes exist
  55579. * @param meshes list of meshes that make up the controller model to process
  55580. * @return structured view of the given meshes, with mapping of buttons and axes to meshes that can be transformed.
  55581. */
  55582. private processModel;
  55583. private createMeshInfo;
  55584. /**
  55585. * Gets the ray of the controller in the direction the controller is pointing
  55586. * @param length the length the resulting ray should be
  55587. * @returns a ray in the direction the controller is pointing
  55588. */
  55589. getForwardRay(length?: number): Ray;
  55590. /**
  55591. * Disposes of the controller
  55592. */
  55593. dispose(): void;
  55594. }
  55595. /**
  55596. * This class represents a new windows motion controller in XR.
  55597. */
  55598. export class XRWindowsMotionController extends WindowsMotionController {
  55599. /**
  55600. * Changing the original WIndowsMotionController mapping to fir the new mapping
  55601. */
  55602. protected readonly _mapping: {
  55603. buttons: string[];
  55604. buttonMeshNames: {
  55605. trigger: string;
  55606. menu: string;
  55607. grip: string;
  55608. thumbstick: string;
  55609. trackpad: string;
  55610. };
  55611. buttonObservableNames: {
  55612. trigger: string;
  55613. menu: string;
  55614. grip: string;
  55615. thumbstick: string;
  55616. trackpad: string;
  55617. };
  55618. axisMeshNames: string[];
  55619. pointingPoseMeshName: string;
  55620. };
  55621. /**
  55622. * Construct a new XR-Based windows motion controller
  55623. *
  55624. * @param gamepadInfo the gamepad object from the browser
  55625. */
  55626. constructor(gamepadInfo: any);
  55627. /**
  55628. * holds the thumbstick values (X,Y)
  55629. */
  55630. thumbstickValues: StickValues;
  55631. /**
  55632. * Fired when the thumbstick on this controller is clicked
  55633. */
  55634. onThumbstickStateChangedObservable: Observable<ExtendedGamepadButton>;
  55635. /**
  55636. * Fired when the thumbstick on this controller is modified
  55637. */
  55638. onThumbstickValuesChangedObservable: Observable<StickValues>;
  55639. /**
  55640. * Fired when the touchpad button on this controller is modified
  55641. */
  55642. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  55643. /**
  55644. * Fired when the touchpad values on this controller are modified
  55645. */
  55646. onTrackpadValuesChangedObservable: Observable<StickValues>;
  55647. /**
  55648. * Fired when the thumbstick button on this controller is modified
  55649. * here to prevent breaking changes
  55650. */
  55651. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55652. /**
  55653. * updating the thumbstick(!) and not the trackpad.
  55654. * This is named this way due to the difference between WebVR and XR and to avoid
  55655. * changing the parent class.
  55656. */
  55657. protected _updateTrackpad(): void;
  55658. /**
  55659. * Disposes the class with joy
  55660. */
  55661. dispose(): void;
  55662. }
  55663. }
  55664. declare module "babylonjs/Gamepads/Controllers/index" {
  55665. export * from "babylonjs/Gamepads/Controllers/daydreamController";
  55666. export * from "babylonjs/Gamepads/Controllers/gearVRController";
  55667. export * from "babylonjs/Gamepads/Controllers/genericController";
  55668. export * from "babylonjs/Gamepads/Controllers/oculusTouchController";
  55669. export * from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55670. export * from "babylonjs/Gamepads/Controllers/viveController";
  55671. export * from "babylonjs/Gamepads/Controllers/webVRController";
  55672. export * from "babylonjs/Gamepads/Controllers/windowsMotionController";
  55673. }
  55674. declare module "babylonjs/Gamepads/index" {
  55675. export * from "babylonjs/Gamepads/Controllers/index";
  55676. export * from "babylonjs/Gamepads/gamepad";
  55677. export * from "babylonjs/Gamepads/gamepadManager";
  55678. export * from "babylonjs/Gamepads/gamepadSceneComponent";
  55679. export * from "babylonjs/Gamepads/xboxGamepad";
  55680. export * from "babylonjs/Gamepads/dualShockGamepad";
  55681. }
  55682. declare module "babylonjs/Meshes/Builders/polyhedronBuilder" {
  55683. import { Scene } from "babylonjs/scene";
  55684. import { Vector4 } from "babylonjs/Maths/math.vector";
  55685. import { Color4 } from "babylonjs/Maths/math.color";
  55686. import { Mesh } from "babylonjs/Meshes/mesh";
  55687. import { Nullable } from "babylonjs/types";
  55688. /**
  55689. * Class containing static functions to help procedurally build meshes
  55690. */
  55691. export class PolyhedronBuilder {
  55692. /**
  55693. * Creates a polyhedron mesh
  55694. * * 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
  55695. * * The parameter `size` (positive float, default 1) sets the polygon size
  55696. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  55697. * * 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`
  55698. * * 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
  55699. * * 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)`)
  55700. * * 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
  55701. * * 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
  55702. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  55703. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  55704. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  55705. * @param name defines the name of the mesh
  55706. * @param options defines the options used to create the mesh
  55707. * @param scene defines the hosting scene
  55708. * @returns the polyhedron mesh
  55709. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  55710. */
  55711. static CreatePolyhedron(name: string, options: {
  55712. type?: number;
  55713. size?: number;
  55714. sizeX?: number;
  55715. sizeY?: number;
  55716. sizeZ?: number;
  55717. custom?: any;
  55718. faceUV?: Vector4[];
  55719. faceColors?: Color4[];
  55720. flat?: boolean;
  55721. updatable?: boolean;
  55722. sideOrientation?: number;
  55723. frontUVs?: Vector4;
  55724. backUVs?: Vector4;
  55725. }, scene?: Nullable<Scene>): Mesh;
  55726. }
  55727. }
  55728. declare module "babylonjs/Gizmos/scaleGizmo" {
  55729. import { Observable } from "babylonjs/Misc/observable";
  55730. import { Nullable } from "babylonjs/types";
  55731. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55732. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55733. import { AxisScaleGizmo } from "babylonjs/Gizmos/axisScaleGizmo";
  55734. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55735. import { Node } from "babylonjs/node";
  55736. /**
  55737. * Gizmo that enables scaling a mesh along 3 axis
  55738. */
  55739. export class ScaleGizmo extends Gizmo {
  55740. /**
  55741. * Internal gizmo used for interactions on the x axis
  55742. */
  55743. xGizmo: AxisScaleGizmo;
  55744. /**
  55745. * Internal gizmo used for interactions on the y axis
  55746. */
  55747. yGizmo: AxisScaleGizmo;
  55748. /**
  55749. * Internal gizmo used for interactions on the z axis
  55750. */
  55751. zGizmo: AxisScaleGizmo;
  55752. /**
  55753. * Internal gizmo used to scale all axis equally
  55754. */
  55755. uniformScaleGizmo: AxisScaleGizmo;
  55756. private _meshAttached;
  55757. private _nodeAttached;
  55758. private _snapDistance;
  55759. private _uniformScalingMesh;
  55760. private _octahedron;
  55761. private _sensitivity;
  55762. /** Fires an event when any of it's sub gizmos are dragged */
  55763. onDragStartObservable: Observable<unknown>;
  55764. /** Fires an event when any of it's sub gizmos are released from dragging */
  55765. onDragEndObservable: Observable<unknown>;
  55766. get attachedMesh(): Nullable<AbstractMesh>;
  55767. set attachedMesh(mesh: Nullable<AbstractMesh>);
  55768. get attachedNode(): Nullable<Node>;
  55769. set attachedNode(node: Nullable<Node>);
  55770. /**
  55771. * Creates a ScaleGizmo
  55772. * @param gizmoLayer The utility layer the gizmo will be added to
  55773. * @param thickness display gizmo axis thickness
  55774. */
  55775. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number);
  55776. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  55777. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  55778. /**
  55779. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  55780. */
  55781. set snapDistance(value: number);
  55782. get snapDistance(): number;
  55783. /**
  55784. * Ratio for the scale of the gizmo (Default: 1)
  55785. */
  55786. set scaleRatio(value: number);
  55787. get scaleRatio(): number;
  55788. /**
  55789. * Sensitivity factor for dragging (Default: 1)
  55790. */
  55791. set sensitivity(value: number);
  55792. get sensitivity(): number;
  55793. /**
  55794. * Disposes of the gizmo
  55795. */
  55796. dispose(): void;
  55797. }
  55798. }
  55799. declare module "babylonjs/Gizmos/axisScaleGizmo" {
  55800. import { Observable } from "babylonjs/Misc/observable";
  55801. import { Nullable } from "babylonjs/types";
  55802. import { Vector3 } from "babylonjs/Maths/math.vector";
  55803. import { Node } from "babylonjs/node";
  55804. import { Mesh } from "babylonjs/Meshes/mesh";
  55805. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  55806. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55807. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55808. import { ScaleGizmo } from "babylonjs/Gizmos/scaleGizmo";
  55809. import { Color3 } from "babylonjs/Maths/math.color";
  55810. /**
  55811. * Single axis scale gizmo
  55812. */
  55813. export class AxisScaleGizmo extends Gizmo {
  55814. /**
  55815. * Drag behavior responsible for the gizmos dragging interactions
  55816. */
  55817. dragBehavior: PointerDragBehavior;
  55818. private _pointerObserver;
  55819. /**
  55820. * Scale distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  55821. */
  55822. snapDistance: number;
  55823. /**
  55824. * Event that fires each time the gizmo snaps to a new location.
  55825. * * snapDistance is the the change in distance
  55826. */
  55827. onSnapObservable: Observable<{
  55828. snapDistance: number;
  55829. }>;
  55830. /**
  55831. * If the scaling operation should be done on all axis (default: false)
  55832. */
  55833. uniformScaling: boolean;
  55834. /**
  55835. * Custom sensitivity value for the drag strength
  55836. */
  55837. sensitivity: number;
  55838. private _isEnabled;
  55839. private _parent;
  55840. private _arrow;
  55841. private _coloredMaterial;
  55842. private _hoverMaterial;
  55843. /**
  55844. * Creates an AxisScaleGizmo
  55845. * @param gizmoLayer The utility layer the gizmo will be added to
  55846. * @param dragAxis The axis which the gizmo will be able to scale on
  55847. * @param color The color of the gizmo
  55848. * @param thickness display gizmo axis thickness
  55849. */
  55850. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<ScaleGizmo>, thickness?: number);
  55851. protected _attachedNodeChanged(value: Nullable<Node>): void;
  55852. /**
  55853. * If the gizmo is enabled
  55854. */
  55855. set isEnabled(value: boolean);
  55856. get isEnabled(): boolean;
  55857. /**
  55858. * Disposes of the gizmo
  55859. */
  55860. dispose(): void;
  55861. /**
  55862. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  55863. * @param mesh The mesh to replace the default mesh of the gizmo
  55864. * @param useGizmoMaterial If the gizmo's default material should be used (default: false)
  55865. */
  55866. setCustomMesh(mesh: Mesh, useGizmoMaterial?: boolean): void;
  55867. }
  55868. }
  55869. declare module "babylonjs/Gizmos/boundingBoxGizmo" {
  55870. import { Observable } from "babylonjs/Misc/observable";
  55871. import { Nullable } from "babylonjs/types";
  55872. import { Vector3 } from "babylonjs/Maths/math.vector";
  55873. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55874. import { Mesh } from "babylonjs/Meshes/mesh";
  55875. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55876. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55877. import { Color3 } from "babylonjs/Maths/math.color";
  55878. import "babylonjs/Meshes/Builders/boxBuilder";
  55879. /**
  55880. * Bounding box gizmo
  55881. */
  55882. export class BoundingBoxGizmo extends Gizmo {
  55883. private _lineBoundingBox;
  55884. private _rotateSpheresParent;
  55885. private _scaleBoxesParent;
  55886. private _boundingDimensions;
  55887. private _renderObserver;
  55888. private _pointerObserver;
  55889. private _scaleDragSpeed;
  55890. private _tmpQuaternion;
  55891. private _tmpVector;
  55892. private _tmpRotationMatrix;
  55893. /**
  55894. * 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)
  55895. */
  55896. ignoreChildren: boolean;
  55897. /**
  55898. * 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)
  55899. */
  55900. includeChildPredicate: Nullable<(abstractMesh: AbstractMesh) => boolean>;
  55901. /**
  55902. * The size of the rotation spheres attached to the bounding box (Default: 0.1)
  55903. */
  55904. rotationSphereSize: number;
  55905. /**
  55906. * The size of the scale boxes attached to the bounding box (Default: 0.1)
  55907. */
  55908. scaleBoxSize: number;
  55909. /**
  55910. * 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)
  55911. */
  55912. fixedDragMeshScreenSize: boolean;
  55913. /**
  55914. * The distance away from the object which the draggable meshes should appear world sized when fixedDragMeshScreenSize is set to true (default: 10)
  55915. */
  55916. fixedDragMeshScreenSizeDistanceFactor: number;
  55917. /**
  55918. * Fired when a rotation sphere or scale box is dragged
  55919. */
  55920. onDragStartObservable: Observable<{}>;
  55921. /**
  55922. * Fired when a scale box is dragged
  55923. */
  55924. onScaleBoxDragObservable: Observable<{}>;
  55925. /**
  55926. * Fired when a scale box drag is ended
  55927. */
  55928. onScaleBoxDragEndObservable: Observable<{}>;
  55929. /**
  55930. * Fired when a rotation sphere is dragged
  55931. */
  55932. onRotationSphereDragObservable: Observable<{}>;
  55933. /**
  55934. * Fired when a rotation sphere drag is ended
  55935. */
  55936. onRotationSphereDragEndObservable: Observable<{}>;
  55937. /**
  55938. * 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)
  55939. */
  55940. scalePivot: Nullable<Vector3>;
  55941. /**
  55942. * Mesh used as a pivot to rotate the attached node
  55943. */
  55944. private _anchorMesh;
  55945. private _existingMeshScale;
  55946. private _dragMesh;
  55947. private pointerDragBehavior;
  55948. private coloredMaterial;
  55949. private hoverColoredMaterial;
  55950. /**
  55951. * Sets the color of the bounding box gizmo
  55952. * @param color the color to set
  55953. */
  55954. setColor(color: Color3): void;
  55955. /**
  55956. * Creates an BoundingBoxGizmo
  55957. * @param gizmoLayer The utility layer the gizmo will be added to
  55958. * @param color The color of the gizmo
  55959. */
  55960. constructor(color?: Color3, gizmoLayer?: UtilityLayerRenderer);
  55961. protected _attachedNodeChanged(value: Nullable<AbstractMesh>): void;
  55962. private _selectNode;
  55963. /**
  55964. * Updates the bounding box information for the Gizmo
  55965. */
  55966. updateBoundingBox(): void;
  55967. private _updateRotationSpheres;
  55968. private _updateScaleBoxes;
  55969. /**
  55970. * Enables rotation on the specified axis and disables rotation on the others
  55971. * @param axis The list of axis that should be enabled (eg. "xy" or "xyz")
  55972. */
  55973. setEnabledRotationAxis(axis: string): void;
  55974. /**
  55975. * Enables/disables scaling
  55976. * @param enable if scaling should be enabled
  55977. * @param homogeneousScaling defines if scaling should only be homogeneous
  55978. */
  55979. setEnabledScaling(enable: boolean, homogeneousScaling?: boolean): void;
  55980. private _updateDummy;
  55981. /**
  55982. * Enables a pointer drag behavior on the bounding box of the gizmo
  55983. */
  55984. enableDragBehavior(): void;
  55985. /**
  55986. * Disposes of the gizmo
  55987. */
  55988. dispose(): void;
  55989. /**
  55990. * 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)
  55991. * @param mesh the mesh to wrap in the bounding box mesh and make not pickable
  55992. * @returns the bounding box mesh with the passed in mesh as a child
  55993. */
  55994. static MakeNotPickableAndWrapInBoundingBox(mesh: Mesh): Mesh;
  55995. /**
  55996. * CustomMeshes are not supported by this gizmo
  55997. * @param mesh The mesh to replace the default mesh of the gizmo
  55998. */
  55999. setCustomMesh(mesh: Mesh): void;
  56000. }
  56001. }
  56002. declare module "babylonjs/Gizmos/planeRotationGizmo" {
  56003. import { Observable } from "babylonjs/Misc/observable";
  56004. import { Nullable } from "babylonjs/types";
  56005. import { Vector3 } from "babylonjs/Maths/math.vector";
  56006. import { Color3 } from "babylonjs/Maths/math.color";
  56007. import { Node } from "babylonjs/node";
  56008. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  56009. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  56010. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  56011. import "babylonjs/Meshes/Builders/linesBuilder";
  56012. import { RotationGizmo } from "babylonjs/Gizmos/rotationGizmo";
  56013. /**
  56014. * Single plane rotation gizmo
  56015. */
  56016. export class PlaneRotationGizmo extends Gizmo {
  56017. /**
  56018. * Drag behavior responsible for the gizmos dragging interactions
  56019. */
  56020. dragBehavior: PointerDragBehavior;
  56021. private _pointerObserver;
  56022. /**
  56023. * Rotation distance in radians that the gizmo will snap to (Default: 0)
  56024. */
  56025. snapDistance: number;
  56026. /**
  56027. * Event that fires each time the gizmo snaps to a new location.
  56028. * * snapDistance is the the change in distance
  56029. */
  56030. onSnapObservable: Observable<{
  56031. snapDistance: number;
  56032. }>;
  56033. private _isEnabled;
  56034. private _parent;
  56035. /**
  56036. * Creates a PlaneRotationGizmo
  56037. * @param gizmoLayer The utility layer the gizmo will be added to
  56038. * @param planeNormal The normal of the plane which the gizmo will be able to rotate on
  56039. * @param color The color of the gizmo
  56040. * @param tessellation Amount of tessellation to be used when creating rotation circles
  56041. * @param useEulerRotation Use and update Euler angle instead of quaternion
  56042. * @param thickness display gizmo axis thickness
  56043. */
  56044. constructor(planeNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, tessellation?: number, parent?: Nullable<RotationGizmo>, useEulerRotation?: boolean, thickness?: number);
  56045. protected _attachedNodeChanged(value: Nullable<Node>): void;
  56046. /**
  56047. * If the gizmo is enabled
  56048. */
  56049. set isEnabled(value: boolean);
  56050. get isEnabled(): boolean;
  56051. /**
  56052. * Disposes of the gizmo
  56053. */
  56054. dispose(): void;
  56055. }
  56056. }
  56057. declare module "babylonjs/Gizmos/rotationGizmo" {
  56058. import { Observable } from "babylonjs/Misc/observable";
  56059. import { Nullable } from "babylonjs/types";
  56060. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56061. import { Mesh } from "babylonjs/Meshes/mesh";
  56062. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  56063. import { PlaneRotationGizmo } from "babylonjs/Gizmos/planeRotationGizmo";
  56064. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  56065. import { Node } from "babylonjs/node";
  56066. /**
  56067. * Gizmo that enables rotating a mesh along 3 axis
  56068. */
  56069. export class RotationGizmo extends Gizmo {
  56070. /**
  56071. * Internal gizmo used for interactions on the x axis
  56072. */
  56073. xGizmo: PlaneRotationGizmo;
  56074. /**
  56075. * Internal gizmo used for interactions on the y axis
  56076. */
  56077. yGizmo: PlaneRotationGizmo;
  56078. /**
  56079. * Internal gizmo used for interactions on the z axis
  56080. */
  56081. zGizmo: PlaneRotationGizmo;
  56082. /** Fires an event when any of it's sub gizmos are dragged */
  56083. onDragStartObservable: Observable<unknown>;
  56084. /** Fires an event when any of it's sub gizmos are released from dragging */
  56085. onDragEndObservable: Observable<unknown>;
  56086. private _meshAttached;
  56087. private _nodeAttached;
  56088. get attachedMesh(): Nullable<AbstractMesh>;
  56089. set attachedMesh(mesh: Nullable<AbstractMesh>);
  56090. get attachedNode(): Nullable<Node>;
  56091. set attachedNode(node: Nullable<Node>);
  56092. /**
  56093. * Creates a RotationGizmo
  56094. * @param gizmoLayer The utility layer the gizmo will be added to
  56095. * @param tessellation Amount of tessellation to be used when creating rotation circles
  56096. * @param useEulerRotation Use and update Euler angle instead of quaternion
  56097. * @param thickness display gizmo axis thickness
  56098. */
  56099. constructor(gizmoLayer?: UtilityLayerRenderer, tessellation?: number, useEulerRotation?: boolean, thickness?: number);
  56100. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  56101. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  56102. /**
  56103. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  56104. */
  56105. set snapDistance(value: number);
  56106. get snapDistance(): number;
  56107. /**
  56108. * Ratio for the scale of the gizmo (Default: 1)
  56109. */
  56110. set scaleRatio(value: number);
  56111. get scaleRatio(): number;
  56112. /**
  56113. * Disposes of the gizmo
  56114. */
  56115. dispose(): void;
  56116. /**
  56117. * CustomMeshes are not supported by this gizmo
  56118. * @param mesh The mesh to replace the default mesh of the gizmo
  56119. */
  56120. setCustomMesh(mesh: Mesh): void;
  56121. }
  56122. }
  56123. declare module "babylonjs/Gizmos/gizmoManager" {
  56124. import { Observable } from "babylonjs/Misc/observable";
  56125. import { Nullable } from "babylonjs/types";
  56126. import { Scene, IDisposable } from "babylonjs/scene";
  56127. import { Node } from "babylonjs/node";
  56128. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56129. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  56130. import { SixDofDragBehavior } from "babylonjs/Behaviors/Meshes/sixDofDragBehavior";
  56131. import { RotationGizmo } from "babylonjs/Gizmos/rotationGizmo";
  56132. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  56133. import { ScaleGizmo } from "babylonjs/Gizmos/scaleGizmo";
  56134. import { BoundingBoxGizmo } from "babylonjs/Gizmos/boundingBoxGizmo";
  56135. /**
  56136. * Helps setup gizmo's in the scene to rotate/scale/position nodes
  56137. */
  56138. export class GizmoManager implements IDisposable {
  56139. private scene;
  56140. /**
  56141. * Gizmo's created by the gizmo manager, gizmo will be null until gizmo has been enabled for the first time
  56142. */
  56143. gizmos: {
  56144. positionGizmo: Nullable<PositionGizmo>;
  56145. rotationGizmo: Nullable<RotationGizmo>;
  56146. scaleGizmo: Nullable<ScaleGizmo>;
  56147. boundingBoxGizmo: Nullable<BoundingBoxGizmo>;
  56148. };
  56149. /** When true, the gizmo will be detached from the current object when a pointer down occurs with an empty picked mesh */
  56150. clearGizmoOnEmptyPointerEvent: boolean;
  56151. /** Fires an event when the manager is attached to a mesh */
  56152. onAttachedToMeshObservable: Observable<Nullable<AbstractMesh>>;
  56153. /** Fires an event when the manager is attached to a node */
  56154. onAttachedToNodeObservable: Observable<Nullable<Node>>;
  56155. private _gizmosEnabled;
  56156. private _pointerObserver;
  56157. private _attachedMesh;
  56158. private _attachedNode;
  56159. private _boundingBoxColor;
  56160. private _defaultUtilityLayer;
  56161. private _defaultKeepDepthUtilityLayer;
  56162. private _thickness;
  56163. /**
  56164. * When bounding box gizmo is enabled, this can be used to track drag/end events
  56165. */
  56166. boundingBoxDragBehavior: SixDofDragBehavior;
  56167. /**
  56168. * Array of meshes which will have the gizmo attached when a pointer selected them. If null, all meshes are attachable. (Default: null)
  56169. */
  56170. attachableMeshes: Nullable<Array<AbstractMesh>>;
  56171. /**
  56172. * Array of nodes which will have the gizmo attached when a pointer selected them. If null, all nodes are attachable. (Default: null)
  56173. */
  56174. attachableNodes: Nullable<Array<Node>>;
  56175. /**
  56176. * If pointer events should perform attaching/detaching a gizmo, if false this can be done manually via attachToMesh/attachToNode. (Default: true)
  56177. */
  56178. usePointerToAttachGizmos: boolean;
  56179. /**
  56180. * Utility layer that the bounding box gizmo belongs to
  56181. */
  56182. get keepDepthUtilityLayer(): UtilityLayerRenderer;
  56183. /**
  56184. * Utility layer that all gizmos besides bounding box belong to
  56185. */
  56186. get utilityLayer(): UtilityLayerRenderer;
  56187. /**
  56188. * Instatiates a gizmo manager
  56189. * @param scene the scene to overlay the gizmos on top of
  56190. * @param thickness display gizmo axis thickness
  56191. */
  56192. constructor(scene: Scene, thickness?: number);
  56193. /**
  56194. * Attaches a set of gizmos to the specified mesh
  56195. * @param mesh The mesh the gizmo's should be attached to
  56196. */
  56197. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  56198. /**
  56199. * Attaches a set of gizmos to the specified node
  56200. * @param node The node the gizmo's should be attached to
  56201. */
  56202. attachToNode(node: Nullable<Node>): void;
  56203. /**
  56204. * If the position gizmo is enabled
  56205. */
  56206. set positionGizmoEnabled(value: boolean);
  56207. get positionGizmoEnabled(): boolean;
  56208. /**
  56209. * If the rotation gizmo is enabled
  56210. */
  56211. set rotationGizmoEnabled(value: boolean);
  56212. get rotationGizmoEnabled(): boolean;
  56213. /**
  56214. * If the scale gizmo is enabled
  56215. */
  56216. set scaleGizmoEnabled(value: boolean);
  56217. get scaleGizmoEnabled(): boolean;
  56218. /**
  56219. * If the boundingBox gizmo is enabled
  56220. */
  56221. set boundingBoxGizmoEnabled(value: boolean);
  56222. get boundingBoxGizmoEnabled(): boolean;
  56223. /**
  56224. * Disposes of the gizmo manager
  56225. */
  56226. dispose(): void;
  56227. }
  56228. }
  56229. declare module "babylonjs/Lights/directionalLight" {
  56230. import { Camera } from "babylonjs/Cameras/camera";
  56231. import { Scene } from "babylonjs/scene";
  56232. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  56233. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56234. import { Light } from "babylonjs/Lights/light";
  56235. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  56236. import { Effect } from "babylonjs/Materials/effect";
  56237. /**
  56238. * A directional light is defined by a direction (what a surprise!).
  56239. * The light is emitted from everywhere in the specified direction, and has an infinite range.
  56240. * 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.
  56241. * Documentation: https://doc.babylonjs.com/babylon101/lights
  56242. */
  56243. export class DirectionalLight extends ShadowLight {
  56244. private _shadowFrustumSize;
  56245. /**
  56246. * Fix frustum size for the shadow generation. This is disabled if the value is 0.
  56247. */
  56248. get shadowFrustumSize(): number;
  56249. /**
  56250. * Specifies a fix frustum size for the shadow generation.
  56251. */
  56252. set shadowFrustumSize(value: number);
  56253. private _shadowOrthoScale;
  56254. /**
  56255. * Gets the shadow projection scale against the optimal computed one.
  56256. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  56257. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  56258. */
  56259. get shadowOrthoScale(): number;
  56260. /**
  56261. * Sets the shadow projection scale against the optimal computed one.
  56262. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  56263. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  56264. */
  56265. set shadowOrthoScale(value: number);
  56266. /**
  56267. * Automatically compute the projection matrix to best fit (including all the casters)
  56268. * on each frame.
  56269. */
  56270. autoUpdateExtends: boolean;
  56271. /**
  56272. * Automatically compute the shadowMinZ and shadowMaxZ for the projection matrix to best fit (including all the casters)
  56273. * on each frame. autoUpdateExtends must be set to true for this to work
  56274. */
  56275. autoCalcShadowZBounds: boolean;
  56276. private _orthoLeft;
  56277. private _orthoRight;
  56278. private _orthoTop;
  56279. private _orthoBottom;
  56280. /**
  56281. * Creates a DirectionalLight object in the scene, oriented towards the passed direction (Vector3).
  56282. * The directional light is emitted from everywhere in the given direction.
  56283. * It can cast shadows.
  56284. * Documentation : https://doc.babylonjs.com/babylon101/lights
  56285. * @param name The friendly name of the light
  56286. * @param direction The direction of the light
  56287. * @param scene The scene the light belongs to
  56288. */
  56289. constructor(name: string, direction: Vector3, scene: Scene);
  56290. /**
  56291. * Returns the string "DirectionalLight".
  56292. * @return The class name
  56293. */
  56294. getClassName(): string;
  56295. /**
  56296. * Returns the integer 1.
  56297. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  56298. */
  56299. getTypeID(): number;
  56300. /**
  56301. * Sets the passed matrix "matrix" as projection matrix for the shadows cast by the light according to the passed view matrix.
  56302. * Returns the DirectionalLight Shadow projection matrix.
  56303. */
  56304. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  56305. /**
  56306. * Sets the passed matrix "matrix" as fixed frustum projection matrix for the shadows cast by the light according to the passed view matrix.
  56307. * Returns the DirectionalLight Shadow projection matrix.
  56308. */
  56309. protected _setDefaultFixedFrustumShadowProjectionMatrix(matrix: Matrix): void;
  56310. /**
  56311. * Sets the passed matrix "matrix" as auto extend projection matrix for the shadows cast by the light according to the passed view matrix.
  56312. * Returns the DirectionalLight Shadow projection matrix.
  56313. */
  56314. protected _setDefaultAutoExtendShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  56315. protected _buildUniformLayout(): void;
  56316. /**
  56317. * Sets the passed Effect object with the DirectionalLight transformed position (or position if not parented) and the passed name.
  56318. * @param effect The effect to update
  56319. * @param lightIndex The index of the light in the effect to update
  56320. * @returns The directional light
  56321. */
  56322. transferToEffect(effect: Effect, lightIndex: string): DirectionalLight;
  56323. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  56324. /**
  56325. * Gets the minZ used for shadow according to both the scene and the light.
  56326. *
  56327. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  56328. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  56329. * @param activeCamera The camera we are returning the min for
  56330. * @returns the depth min z
  56331. */
  56332. getDepthMinZ(activeCamera: Camera): number;
  56333. /**
  56334. * Gets the maxZ used for shadow according to both the scene and the light.
  56335. *
  56336. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  56337. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  56338. * @param activeCamera The camera we are returning the max for
  56339. * @returns the depth max z
  56340. */
  56341. getDepthMaxZ(activeCamera: Camera): number;
  56342. /**
  56343. * Prepares the list of defines specific to the light type.
  56344. * @param defines the list of defines
  56345. * @param lightIndex defines the index of the light for the effect
  56346. */
  56347. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  56348. }
  56349. }
  56350. declare module "babylonjs/Meshes/Builders/hemisphereBuilder" {
  56351. import { Mesh } from "babylonjs/Meshes/mesh";
  56352. /**
  56353. * Class containing static functions to help procedurally build meshes
  56354. */
  56355. export class HemisphereBuilder {
  56356. /**
  56357. * Creates a hemisphere mesh
  56358. * @param name defines the name of the mesh
  56359. * @param options defines the options used to create the mesh
  56360. * @param scene defines the hosting scene
  56361. * @returns the hemisphere mesh
  56362. */
  56363. static CreateHemisphere(name: string, options: {
  56364. segments?: number;
  56365. diameter?: number;
  56366. sideOrientation?: number;
  56367. }, scene: any): Mesh;
  56368. }
  56369. }
  56370. declare module "babylonjs/Lights/spotLight" {
  56371. import { Nullable } from "babylonjs/types";
  56372. import { Scene } from "babylonjs/scene";
  56373. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  56374. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56375. import { Effect } from "babylonjs/Materials/effect";
  56376. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  56377. import { Light } from "babylonjs/Lights/light";
  56378. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  56379. /**
  56380. * A spot light is defined by a position, a direction, an angle, and an exponent.
  56381. * These values define a cone of light starting from the position, emitting toward the direction.
  56382. * The angle, in radians, defines the size (field of illumination) of the spotlight's conical beam,
  56383. * and the exponent defines the speed of the decay of the light with distance (reach).
  56384. * Documentation: https://doc.babylonjs.com/babylon101/lights
  56385. */
  56386. export class SpotLight extends ShadowLight {
  56387. private _angle;
  56388. private _innerAngle;
  56389. private _cosHalfAngle;
  56390. private _lightAngleScale;
  56391. private _lightAngleOffset;
  56392. /**
  56393. * Gets the cone angle of the spot light in Radians.
  56394. */
  56395. get angle(): number;
  56396. /**
  56397. * Sets the cone angle of the spot light in Radians.
  56398. */
  56399. set angle(value: number);
  56400. /**
  56401. * Only used in gltf falloff mode, this defines the angle where
  56402. * the directional falloff will start before cutting at angle which could be seen
  56403. * as outer angle.
  56404. */
  56405. get innerAngle(): number;
  56406. /**
  56407. * Only used in gltf falloff mode, this defines the angle where
  56408. * the directional falloff will start before cutting at angle which could be seen
  56409. * as outer angle.
  56410. */
  56411. set innerAngle(value: number);
  56412. private _shadowAngleScale;
  56413. /**
  56414. * Allows scaling the angle of the light for shadow generation only.
  56415. */
  56416. get shadowAngleScale(): number;
  56417. /**
  56418. * Allows scaling the angle of the light for shadow generation only.
  56419. */
  56420. set shadowAngleScale(value: number);
  56421. /**
  56422. * The light decay speed with the distance from the emission spot.
  56423. */
  56424. exponent: number;
  56425. private _projectionTextureMatrix;
  56426. /**
  56427. * Allows reading the projecton texture
  56428. */
  56429. get projectionTextureMatrix(): Matrix;
  56430. protected _projectionTextureLightNear: number;
  56431. /**
  56432. * Gets the near clip of the Spotlight for texture projection.
  56433. */
  56434. get projectionTextureLightNear(): number;
  56435. /**
  56436. * Sets the near clip of the Spotlight for texture projection.
  56437. */
  56438. set projectionTextureLightNear(value: number);
  56439. protected _projectionTextureLightFar: number;
  56440. /**
  56441. * Gets the far clip of the Spotlight for texture projection.
  56442. */
  56443. get projectionTextureLightFar(): number;
  56444. /**
  56445. * Sets the far clip of the Spotlight for texture projection.
  56446. */
  56447. set projectionTextureLightFar(value: number);
  56448. protected _projectionTextureUpDirection: Vector3;
  56449. /**
  56450. * Gets the Up vector of the Spotlight for texture projection.
  56451. */
  56452. get projectionTextureUpDirection(): Vector3;
  56453. /**
  56454. * Sets the Up vector of the Spotlight for texture projection.
  56455. */
  56456. set projectionTextureUpDirection(value: Vector3);
  56457. private _projectionTexture;
  56458. /**
  56459. * Gets the projection texture of the light.
  56460. */
  56461. get projectionTexture(): Nullable<BaseTexture>;
  56462. /**
  56463. * Sets the projection texture of the light.
  56464. */
  56465. set projectionTexture(value: Nullable<BaseTexture>);
  56466. private _projectionTextureViewLightDirty;
  56467. private _projectionTextureProjectionLightDirty;
  56468. private _projectionTextureDirty;
  56469. private _projectionTextureViewTargetVector;
  56470. private _projectionTextureViewLightMatrix;
  56471. private _projectionTextureProjectionLightMatrix;
  56472. private _projectionTextureScalingMatrix;
  56473. /**
  56474. * Creates a SpotLight object in the scene. A spot light is a simply light oriented cone.
  56475. * It can cast shadows.
  56476. * Documentation : https://doc.babylonjs.com/babylon101/lights
  56477. * @param name The light friendly name
  56478. * @param position The position of the spot light in the scene
  56479. * @param direction The direction of the light in the scene
  56480. * @param angle The cone angle of the light in Radians
  56481. * @param exponent The light decay speed with the distance from the emission spot
  56482. * @param scene The scene the lights belongs to
  56483. */
  56484. constructor(name: string, position: Vector3, direction: Vector3, angle: number, exponent: number, scene: Scene);
  56485. /**
  56486. * Returns the string "SpotLight".
  56487. * @returns the class name
  56488. */
  56489. getClassName(): string;
  56490. /**
  56491. * Returns the integer 2.
  56492. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  56493. */
  56494. getTypeID(): number;
  56495. /**
  56496. * Overrides the direction setter to recompute the projection texture view light Matrix.
  56497. */
  56498. protected _setDirection(value: Vector3): void;
  56499. /**
  56500. * Overrides the position setter to recompute the projection texture view light Matrix.
  56501. */
  56502. protected _setPosition(value: Vector3): void;
  56503. /**
  56504. * 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.
  56505. * Returns the SpotLight.
  56506. */
  56507. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  56508. protected _computeProjectionTextureViewLightMatrix(): void;
  56509. protected _computeProjectionTextureProjectionLightMatrix(): void;
  56510. /**
  56511. * Main function for light texture projection matrix computing.
  56512. */
  56513. protected _computeProjectionTextureMatrix(): void;
  56514. protected _buildUniformLayout(): void;
  56515. private _computeAngleValues;
  56516. /**
  56517. * Sets the passed Effect "effect" with the Light textures.
  56518. * @param effect The effect to update
  56519. * @param lightIndex The index of the light in the effect to update
  56520. * @returns The light
  56521. */
  56522. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  56523. /**
  56524. * Sets the passed Effect object with the SpotLight transfomed position (or position if not parented) and normalized direction.
  56525. * @param effect The effect to update
  56526. * @param lightIndex The index of the light in the effect to update
  56527. * @returns The spot light
  56528. */
  56529. transferToEffect(effect: Effect, lightIndex: string): SpotLight;
  56530. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  56531. /**
  56532. * Disposes the light and the associated resources.
  56533. */
  56534. dispose(): void;
  56535. /**
  56536. * Prepares the list of defines specific to the light type.
  56537. * @param defines the list of defines
  56538. * @param lightIndex defines the index of the light for the effect
  56539. */
  56540. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  56541. }
  56542. }
  56543. declare module "babylonjs/Gizmos/lightGizmo" {
  56544. import { Nullable } from "babylonjs/types";
  56545. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  56546. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  56547. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  56548. import { Light } from "babylonjs/Lights/light";
  56549. import { Observable } from "babylonjs/Misc/observable";
  56550. /**
  56551. * Gizmo that enables viewing a light
  56552. */
  56553. export class LightGizmo extends Gizmo {
  56554. private _lightMesh;
  56555. private _material;
  56556. private _cachedPosition;
  56557. private _cachedForward;
  56558. private _attachedMeshParent;
  56559. private _pointerObserver;
  56560. /**
  56561. * Event that fires each time the gizmo is clicked
  56562. */
  56563. onClickedObservable: Observable<Light>;
  56564. /**
  56565. * Creates a LightGizmo
  56566. * @param gizmoLayer The utility layer the gizmo will be added to
  56567. */
  56568. constructor(gizmoLayer?: UtilityLayerRenderer);
  56569. private _light;
  56570. /**
  56571. * The light that the gizmo is attached to
  56572. */
  56573. set light(light: Nullable<Light>);
  56574. get light(): Nullable<Light>;
  56575. /**
  56576. * Gets the material used to render the light gizmo
  56577. */
  56578. get material(): StandardMaterial;
  56579. /**
  56580. * @hidden
  56581. * Updates the gizmo to match the attached mesh's position/rotation
  56582. */
  56583. protected _update(): void;
  56584. private static _Scale;
  56585. /**
  56586. * Creates the lines for a light mesh
  56587. */
  56588. private static _CreateLightLines;
  56589. /**
  56590. * Disposes of the light gizmo
  56591. */
  56592. dispose(): void;
  56593. private static _CreateHemisphericLightMesh;
  56594. private static _CreatePointLightMesh;
  56595. private static _CreateSpotLightMesh;
  56596. private static _CreateDirectionalLightMesh;
  56597. }
  56598. }
  56599. declare module "babylonjs/Gizmos/cameraGizmo" {
  56600. import { Nullable } from "babylonjs/types";
  56601. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  56602. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  56603. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  56604. import { Camera } from "babylonjs/Cameras/camera";
  56605. import { Observable } from "babylonjs/Misc/observable";
  56606. /**
  56607. * Gizmo that enables viewing a camera
  56608. */
  56609. export class CameraGizmo extends Gizmo {
  56610. private _cameraMesh;
  56611. private _cameraLinesMesh;
  56612. private _material;
  56613. private _pointerObserver;
  56614. /**
  56615. * Event that fires each time the gizmo is clicked
  56616. */
  56617. onClickedObservable: Observable<Camera>;
  56618. /**
  56619. * Creates a CameraGizmo
  56620. * @param gizmoLayer The utility layer the gizmo will be added to
  56621. */
  56622. constructor(gizmoLayer?: UtilityLayerRenderer);
  56623. private _camera;
  56624. /** Gets or sets a boolean indicating if frustum lines must be rendered (true by default)) */
  56625. get displayFrustum(): boolean;
  56626. set displayFrustum(value: boolean);
  56627. /**
  56628. * The camera that the gizmo is attached to
  56629. */
  56630. set camera(camera: Nullable<Camera>);
  56631. get camera(): Nullable<Camera>;
  56632. /**
  56633. * Gets the material used to render the camera gizmo
  56634. */
  56635. get material(): StandardMaterial;
  56636. /**
  56637. * @hidden
  56638. * Updates the gizmo to match the attached mesh's position/rotation
  56639. */
  56640. protected _update(): void;
  56641. private static _Scale;
  56642. private _invProjection;
  56643. /**
  56644. * Disposes of the camera gizmo
  56645. */
  56646. dispose(): void;
  56647. private static _CreateCameraMesh;
  56648. private static _CreateCameraFrustum;
  56649. }
  56650. }
  56651. declare module "babylonjs/Gizmos/index" {
  56652. export * from "babylonjs/Gizmos/axisDragGizmo";
  56653. export * from "babylonjs/Gizmos/axisScaleGizmo";
  56654. export * from "babylonjs/Gizmos/boundingBoxGizmo";
  56655. export * from "babylonjs/Gizmos/gizmo";
  56656. export * from "babylonjs/Gizmos/gizmoManager";
  56657. export * from "babylonjs/Gizmos/planeRotationGizmo";
  56658. export * from "babylonjs/Gizmos/positionGizmo";
  56659. export * from "babylonjs/Gizmos/rotationGizmo";
  56660. export * from "babylonjs/Gizmos/scaleGizmo";
  56661. export * from "babylonjs/Gizmos/lightGizmo";
  56662. export * from "babylonjs/Gizmos/cameraGizmo";
  56663. export * from "babylonjs/Gizmos/planeDragGizmo";
  56664. }
  56665. declare module "babylonjs/Shaders/ShadersInclude/backgroundFragmentDeclaration" {
  56666. /** @hidden */
  56667. export var backgroundFragmentDeclaration: {
  56668. name: string;
  56669. shader: string;
  56670. };
  56671. }
  56672. declare module "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration" {
  56673. /** @hidden */
  56674. export var backgroundUboDeclaration: {
  56675. name: string;
  56676. shader: string;
  56677. };
  56678. }
  56679. declare module "babylonjs/Shaders/background.fragment" {
  56680. import "babylonjs/Shaders/ShadersInclude/backgroundFragmentDeclaration";
  56681. import "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration";
  56682. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  56683. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  56684. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  56685. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  56686. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  56687. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  56688. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  56689. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  56690. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  56691. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  56692. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  56693. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  56694. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  56695. /** @hidden */
  56696. export var backgroundPixelShader: {
  56697. name: string;
  56698. shader: string;
  56699. };
  56700. }
  56701. declare module "babylonjs/Shaders/ShadersInclude/backgroundVertexDeclaration" {
  56702. /** @hidden */
  56703. export var backgroundVertexDeclaration: {
  56704. name: string;
  56705. shader: string;
  56706. };
  56707. }
  56708. declare module "babylonjs/Shaders/background.vertex" {
  56709. import "babylonjs/Shaders/ShadersInclude/backgroundVertexDeclaration";
  56710. import "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration";
  56711. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  56712. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  56713. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  56714. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  56715. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  56716. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  56717. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  56718. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  56719. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  56720. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  56721. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  56722. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  56723. /** @hidden */
  56724. export var backgroundVertexShader: {
  56725. name: string;
  56726. shader: string;
  56727. };
  56728. }
  56729. declare module "babylonjs/Materials/Background/backgroundMaterial" {
  56730. import { Nullable, int, float } from "babylonjs/types";
  56731. import { Scene } from "babylonjs/scene";
  56732. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  56733. import { SubMesh } from "babylonjs/Meshes/subMesh";
  56734. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56735. import { Mesh } from "babylonjs/Meshes/mesh";
  56736. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  56737. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  56738. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  56739. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  56740. import { IShadowLight } from "babylonjs/Lights/shadowLight";
  56741. import { Color3 } from "babylonjs/Maths/math.color";
  56742. import "babylonjs/Shaders/background.fragment";
  56743. import "babylonjs/Shaders/background.vertex";
  56744. /**
  56745. * Background material used to create an efficient environement around your scene.
  56746. */
  56747. export class BackgroundMaterial extends PushMaterial {
  56748. /**
  56749. * Standard reflectance value at parallel view angle.
  56750. */
  56751. static StandardReflectance0: number;
  56752. /**
  56753. * Standard reflectance value at grazing angle.
  56754. */
  56755. static StandardReflectance90: number;
  56756. protected _primaryColor: Color3;
  56757. /**
  56758. * Key light Color (multiply against the environement texture)
  56759. */
  56760. primaryColor: Color3;
  56761. protected __perceptualColor: Nullable<Color3>;
  56762. /**
  56763. * Experimental Internal Use Only.
  56764. *
  56765. * Key light Color in "perceptual value" meaning the color you would like to see on screen.
  56766. * This acts as a helper to set the primary color to a more "human friendly" value.
  56767. * Conversion to linear space as well as exposure and tone mapping correction will be applied to keep the
  56768. * output color as close as possible from the chosen value.
  56769. * (This does not account for contrast color grading and color curves as they are considered post effect and not directly
  56770. * part of lighting setup.)
  56771. */
  56772. get _perceptualColor(): Nullable<Color3>;
  56773. set _perceptualColor(value: Nullable<Color3>);
  56774. protected _primaryColorShadowLevel: float;
  56775. /**
  56776. * Defines the level of the shadows (dark area of the reflection map) in order to help scaling the colors.
  56777. * The color opposite to the primary color is used at the level chosen to define what the black area would look.
  56778. */
  56779. get primaryColorShadowLevel(): float;
  56780. set primaryColorShadowLevel(value: float);
  56781. protected _primaryColorHighlightLevel: float;
  56782. /**
  56783. * Defines the level of the highliights (highlight area of the reflection map) in order to help scaling the colors.
  56784. * The primary color is used at the level chosen to define what the white area would look.
  56785. */
  56786. get primaryColorHighlightLevel(): float;
  56787. set primaryColorHighlightLevel(value: float);
  56788. protected _reflectionTexture: Nullable<BaseTexture>;
  56789. /**
  56790. * Reflection Texture used in the material.
  56791. * Should be author in a specific way for the best result (refer to the documentation).
  56792. */
  56793. reflectionTexture: Nullable<BaseTexture>;
  56794. protected _reflectionBlur: float;
  56795. /**
  56796. * Reflection Texture level of blur.
  56797. *
  56798. * Can be use to reuse an existing HDR Texture and target a specific LOD to prevent authoring the
  56799. * texture twice.
  56800. */
  56801. reflectionBlur: float;
  56802. protected _diffuseTexture: Nullable<BaseTexture>;
  56803. /**
  56804. * Diffuse Texture used in the material.
  56805. * Should be author in a specific way for the best result (refer to the documentation).
  56806. */
  56807. diffuseTexture: Nullable<BaseTexture>;
  56808. protected _shadowLights: Nullable<IShadowLight[]>;
  56809. /**
  56810. * Specify the list of lights casting shadow on the material.
  56811. * All scene shadow lights will be included if null.
  56812. */
  56813. shadowLights: Nullable<IShadowLight[]>;
  56814. protected _shadowLevel: float;
  56815. /**
  56816. * Helps adjusting the shadow to a softer level if required.
  56817. * 0 means black shadows and 1 means no shadows.
  56818. */
  56819. shadowLevel: float;
  56820. protected _sceneCenter: Vector3;
  56821. /**
  56822. * In case of opacity Fresnel or reflection falloff, this is use as a scene center.
  56823. * It is usually zero but might be interesting to modify according to your setup.
  56824. */
  56825. sceneCenter: Vector3;
  56826. protected _opacityFresnel: boolean;
  56827. /**
  56828. * This helps specifying that the material is falling off to the sky box at grazing angle.
  56829. * This helps ensuring a nice transition when the camera goes under the ground.
  56830. */
  56831. opacityFresnel: boolean;
  56832. protected _reflectionFresnel: boolean;
  56833. /**
  56834. * This helps specifying that the material is falling off from diffuse to the reflection texture at grazing angle.
  56835. * This helps adding a mirror texture on the ground.
  56836. */
  56837. reflectionFresnel: boolean;
  56838. protected _reflectionFalloffDistance: number;
  56839. /**
  56840. * This helps specifying the falloff radius off the reflection texture from the sceneCenter.
  56841. * This helps adding a nice falloff effect to the reflection if used as a mirror for instance.
  56842. */
  56843. reflectionFalloffDistance: number;
  56844. protected _reflectionAmount: number;
  56845. /**
  56846. * This specifies the weight of the reflection against the background in case of reflection Fresnel.
  56847. */
  56848. reflectionAmount: number;
  56849. protected _reflectionReflectance0: number;
  56850. /**
  56851. * This specifies the weight of the reflection at grazing angle.
  56852. */
  56853. reflectionReflectance0: number;
  56854. protected _reflectionReflectance90: number;
  56855. /**
  56856. * This specifies the weight of the reflection at a perpendicular point of view.
  56857. */
  56858. reflectionReflectance90: number;
  56859. /**
  56860. * Sets the reflection reflectance fresnel values according to the default standard
  56861. * empirically know to work well :-)
  56862. */
  56863. set reflectionStandardFresnelWeight(value: number);
  56864. protected _useRGBColor: boolean;
  56865. /**
  56866. * Helps to directly use the maps channels instead of their level.
  56867. */
  56868. useRGBColor: boolean;
  56869. protected _enableNoise: boolean;
  56870. /**
  56871. * This helps reducing the banding effect that could occur on the background.
  56872. */
  56873. enableNoise: boolean;
  56874. /**
  56875. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  56876. * Best used when trying to implement visual zoom effects like fish-eye or binoculars while not adjusting camera fov.
  56877. * Recommended to be keep at 1.0 except for special cases.
  56878. */
  56879. get fovMultiplier(): number;
  56880. set fovMultiplier(value: number);
  56881. private _fovMultiplier;
  56882. /**
  56883. * Enable the FOV adjustment feature controlled by fovMultiplier.
  56884. */
  56885. useEquirectangularFOV: boolean;
  56886. private _maxSimultaneousLights;
  56887. /**
  56888. * Number of Simultaneous lights allowed on the material.
  56889. */
  56890. maxSimultaneousLights: int;
  56891. private _shadowOnly;
  56892. /**
  56893. * Make the material only render shadows
  56894. */
  56895. shadowOnly: boolean;
  56896. /**
  56897. * Default configuration related to image processing available in the Background Material.
  56898. */
  56899. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  56900. /**
  56901. * Keep track of the image processing observer to allow dispose and replace.
  56902. */
  56903. private _imageProcessingObserver;
  56904. /**
  56905. * Attaches a new image processing configuration to the PBR Material.
  56906. * @param configuration (if null the scene configuration will be use)
  56907. */
  56908. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  56909. /**
  56910. * Gets the image processing configuration used either in this material.
  56911. */
  56912. get imageProcessingConfiguration(): Nullable<ImageProcessingConfiguration>;
  56913. /**
  56914. * Sets the Default image processing configuration used either in the this material.
  56915. *
  56916. * If sets to null, the scene one is in use.
  56917. */
  56918. set imageProcessingConfiguration(value: Nullable<ImageProcessingConfiguration>);
  56919. /**
  56920. * Gets wether the color curves effect is enabled.
  56921. */
  56922. get cameraColorCurvesEnabled(): boolean;
  56923. /**
  56924. * Sets wether the color curves effect is enabled.
  56925. */
  56926. set cameraColorCurvesEnabled(value: boolean);
  56927. /**
  56928. * Gets wether the color grading effect is enabled.
  56929. */
  56930. get cameraColorGradingEnabled(): boolean;
  56931. /**
  56932. * Gets wether the color grading effect is enabled.
  56933. */
  56934. set cameraColorGradingEnabled(value: boolean);
  56935. /**
  56936. * Gets wether tonemapping is enabled or not.
  56937. */
  56938. get cameraToneMappingEnabled(): boolean;
  56939. /**
  56940. * Sets wether tonemapping is enabled or not
  56941. */
  56942. set cameraToneMappingEnabled(value: boolean);
  56943. /**
  56944. * The camera exposure used on this material.
  56945. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  56946. * This corresponds to a photographic exposure.
  56947. */
  56948. get cameraExposure(): float;
  56949. /**
  56950. * The camera exposure used on this material.
  56951. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  56952. * This corresponds to a photographic exposure.
  56953. */
  56954. set cameraExposure(value: float);
  56955. /**
  56956. * Gets The camera contrast used on this material.
  56957. */
  56958. get cameraContrast(): float;
  56959. /**
  56960. * Sets The camera contrast used on this material.
  56961. */
  56962. set cameraContrast(value: float);
  56963. /**
  56964. * Gets the Color Grading 2D Lookup Texture.
  56965. */
  56966. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  56967. /**
  56968. * Sets the Color Grading 2D Lookup Texture.
  56969. */
  56970. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  56971. /**
  56972. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  56973. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  56974. * 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;
  56975. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  56976. */
  56977. get cameraColorCurves(): Nullable<ColorCurves>;
  56978. /**
  56979. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  56980. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  56981. * 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;
  56982. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  56983. */
  56984. set cameraColorCurves(value: Nullable<ColorCurves>);
  56985. /**
  56986. * Due to a bug in iOS10, video tags (which are using the background material) are in BGR and not RGB.
  56987. * Setting this flag to true (not done automatically!) will convert it back to RGB.
  56988. */
  56989. switchToBGR: boolean;
  56990. private _renderTargets;
  56991. private _reflectionControls;
  56992. private _white;
  56993. private _primaryShadowColor;
  56994. private _primaryHighlightColor;
  56995. /**
  56996. * Instantiates a Background Material in the given scene
  56997. * @param name The friendly name of the material
  56998. * @param scene The scene to add the material to
  56999. */
  57000. constructor(name: string, scene: Scene);
  57001. /**
  57002. * Gets a boolean indicating that current material needs to register RTT
  57003. */
  57004. get hasRenderTargetTextures(): boolean;
  57005. /**
  57006. * The entire material has been created in order to prevent overdraw.
  57007. * @returns false
  57008. */
  57009. needAlphaTesting(): boolean;
  57010. /**
  57011. * The entire material has been created in order to prevent overdraw.
  57012. * @returns true if blending is enable
  57013. */
  57014. needAlphaBlending(): boolean;
  57015. /**
  57016. * Checks wether the material is ready to be rendered for a given mesh.
  57017. * @param mesh The mesh to render
  57018. * @param subMesh The submesh to check against
  57019. * @param useInstances Specify wether or not the material is used with instances
  57020. * @returns true if all the dependencies are ready (Textures, Effects...)
  57021. */
  57022. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  57023. /**
  57024. * Compute the primary color according to the chosen perceptual color.
  57025. */
  57026. private _computePrimaryColorFromPerceptualColor;
  57027. /**
  57028. * Compute the highlights and shadow colors according to their chosen levels.
  57029. */
  57030. private _computePrimaryColors;
  57031. /**
  57032. * Build the uniform buffer used in the material.
  57033. */
  57034. buildUniformLayout(): void;
  57035. /**
  57036. * Unbind the material.
  57037. */
  57038. unbind(): void;
  57039. /**
  57040. * Bind only the world matrix to the material.
  57041. * @param world The world matrix to bind.
  57042. */
  57043. bindOnlyWorldMatrix(world: Matrix): void;
  57044. /**
  57045. * Bind the material for a dedicated submeh (every used meshes will be considered opaque).
  57046. * @param world The world matrix to bind.
  57047. * @param subMesh The submesh to bind for.
  57048. */
  57049. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  57050. /**
  57051. * Checks to see if a texture is used in the material.
  57052. * @param texture - Base texture to use.
  57053. * @returns - Boolean specifying if a texture is used in the material.
  57054. */
  57055. hasTexture(texture: BaseTexture): boolean;
  57056. /**
  57057. * Dispose the material.
  57058. * @param forceDisposeEffect Force disposal of the associated effect.
  57059. * @param forceDisposeTextures Force disposal of the associated textures.
  57060. */
  57061. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  57062. /**
  57063. * Clones the material.
  57064. * @param name The cloned name.
  57065. * @returns The cloned material.
  57066. */
  57067. clone(name: string): BackgroundMaterial;
  57068. /**
  57069. * Serializes the current material to its JSON representation.
  57070. * @returns The JSON representation.
  57071. */
  57072. serialize(): any;
  57073. /**
  57074. * Gets the class name of the material
  57075. * @returns "BackgroundMaterial"
  57076. */
  57077. getClassName(): string;
  57078. /**
  57079. * Parse a JSON input to create back a background material.
  57080. * @param source The JSON data to parse
  57081. * @param scene The scene to create the parsed material in
  57082. * @param rootUrl The root url of the assets the material depends upon
  57083. * @returns the instantiated BackgroundMaterial.
  57084. */
  57085. static Parse(source: any, scene: Scene, rootUrl: string): BackgroundMaterial;
  57086. }
  57087. }
  57088. declare module "babylonjs/Helpers/environmentHelper" {
  57089. import { Observable } from "babylonjs/Misc/observable";
  57090. import { Nullable } from "babylonjs/types";
  57091. import { Scene } from "babylonjs/scene";
  57092. import { Vector3 } from "babylonjs/Maths/math.vector";
  57093. import { Color3 } from "babylonjs/Maths/math.color";
  57094. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  57095. import { Mesh } from "babylonjs/Meshes/mesh";
  57096. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  57097. import { MirrorTexture } from "babylonjs/Materials/Textures/mirrorTexture";
  57098. import { BackgroundMaterial } from "babylonjs/Materials/Background/backgroundMaterial";
  57099. import "babylonjs/Meshes/Builders/planeBuilder";
  57100. import "babylonjs/Meshes/Builders/boxBuilder";
  57101. /**
  57102. * Represents the different options available during the creation of
  57103. * a Environment helper.
  57104. *
  57105. * This can control the default ground, skybox and image processing setup of your scene.
  57106. */
  57107. export interface IEnvironmentHelperOptions {
  57108. /**
  57109. * Specifies whether or not to create a ground.
  57110. * True by default.
  57111. */
  57112. createGround: boolean;
  57113. /**
  57114. * Specifies the ground size.
  57115. * 15 by default.
  57116. */
  57117. groundSize: number;
  57118. /**
  57119. * The texture used on the ground for the main color.
  57120. * Comes from the BabylonJS CDN by default.
  57121. *
  57122. * Remarks: Can be either a texture or a url.
  57123. */
  57124. groundTexture: string | BaseTexture;
  57125. /**
  57126. * The color mixed in the ground texture by default.
  57127. * BabylonJS clearColor by default.
  57128. */
  57129. groundColor: Color3;
  57130. /**
  57131. * Specifies the ground opacity.
  57132. * 1 by default.
  57133. */
  57134. groundOpacity: number;
  57135. /**
  57136. * Enables the ground to receive shadows.
  57137. * True by default.
  57138. */
  57139. enableGroundShadow: boolean;
  57140. /**
  57141. * Helps preventing the shadow to be fully black on the ground.
  57142. * 0.5 by default.
  57143. */
  57144. groundShadowLevel: number;
  57145. /**
  57146. * Creates a mirror texture attach to the ground.
  57147. * false by default.
  57148. */
  57149. enableGroundMirror: boolean;
  57150. /**
  57151. * Specifies the ground mirror size ratio.
  57152. * 0.3 by default as the default kernel is 64.
  57153. */
  57154. groundMirrorSizeRatio: number;
  57155. /**
  57156. * Specifies the ground mirror blur kernel size.
  57157. * 64 by default.
  57158. */
  57159. groundMirrorBlurKernel: number;
  57160. /**
  57161. * Specifies the ground mirror visibility amount.
  57162. * 1 by default
  57163. */
  57164. groundMirrorAmount: number;
  57165. /**
  57166. * Specifies the ground mirror reflectance weight.
  57167. * This uses the standard weight of the background material to setup the fresnel effect
  57168. * of the mirror.
  57169. * 1 by default.
  57170. */
  57171. groundMirrorFresnelWeight: number;
  57172. /**
  57173. * Specifies the ground mirror Falloff distance.
  57174. * This can helps reducing the size of the reflection.
  57175. * 0 by Default.
  57176. */
  57177. groundMirrorFallOffDistance: number;
  57178. /**
  57179. * Specifies the ground mirror texture type.
  57180. * Unsigned Int by Default.
  57181. */
  57182. groundMirrorTextureType: number;
  57183. /**
  57184. * Specifies a bias applied to the ground vertical position to prevent z-fighting with
  57185. * the shown objects.
  57186. */
  57187. groundYBias: number;
  57188. /**
  57189. * Specifies whether or not to create a skybox.
  57190. * True by default.
  57191. */
  57192. createSkybox: boolean;
  57193. /**
  57194. * Specifies the skybox size.
  57195. * 20 by default.
  57196. */
  57197. skyboxSize: number;
  57198. /**
  57199. * The texture used on the skybox for the main color.
  57200. * Comes from the BabylonJS CDN by default.
  57201. *
  57202. * Remarks: Can be either a texture or a url.
  57203. */
  57204. skyboxTexture: string | BaseTexture;
  57205. /**
  57206. * The color mixed in the skybox texture by default.
  57207. * BabylonJS clearColor by default.
  57208. */
  57209. skyboxColor: Color3;
  57210. /**
  57211. * The background rotation around the Y axis of the scene.
  57212. * This helps aligning the key lights of your scene with the background.
  57213. * 0 by default.
  57214. */
  57215. backgroundYRotation: number;
  57216. /**
  57217. * Compute automatically the size of the elements to best fit with the scene.
  57218. */
  57219. sizeAuto: boolean;
  57220. /**
  57221. * Default position of the rootMesh if autoSize is not true.
  57222. */
  57223. rootPosition: Vector3;
  57224. /**
  57225. * Sets up the image processing in the scene.
  57226. * true by default.
  57227. */
  57228. setupImageProcessing: boolean;
  57229. /**
  57230. * The texture used as your environment texture in the scene.
  57231. * Comes from the BabylonJS CDN by default and in use if setupImageProcessing is true.
  57232. *
  57233. * Remarks: Can be either a texture or a url.
  57234. */
  57235. environmentTexture: string | BaseTexture;
  57236. /**
  57237. * The value of the exposure to apply to the scene.
  57238. * 0.6 by default if setupImageProcessing is true.
  57239. */
  57240. cameraExposure: number;
  57241. /**
  57242. * The value of the contrast to apply to the scene.
  57243. * 1.6 by default if setupImageProcessing is true.
  57244. */
  57245. cameraContrast: number;
  57246. /**
  57247. * Specifies whether or not tonemapping should be enabled in the scene.
  57248. * true by default if setupImageProcessing is true.
  57249. */
  57250. toneMappingEnabled: boolean;
  57251. }
  57252. /**
  57253. * The Environment helper class can be used to add a fully featuread none expensive background to your scene.
  57254. * It includes by default a skybox and a ground relying on the BackgroundMaterial.
  57255. * It also helps with the default setup of your imageProcessing configuration.
  57256. */
  57257. export class EnvironmentHelper {
  57258. /**
  57259. * Default ground texture URL.
  57260. */
  57261. private static _groundTextureCDNUrl;
  57262. /**
  57263. * Default skybox texture URL.
  57264. */
  57265. private static _skyboxTextureCDNUrl;
  57266. /**
  57267. * Default environment texture URL.
  57268. */
  57269. private static _environmentTextureCDNUrl;
  57270. /**
  57271. * Creates the default options for the helper.
  57272. */
  57273. private static _getDefaultOptions;
  57274. private _rootMesh;
  57275. /**
  57276. * Gets the root mesh created by the helper.
  57277. */
  57278. get rootMesh(): Mesh;
  57279. private _skybox;
  57280. /**
  57281. * Gets the skybox created by the helper.
  57282. */
  57283. get skybox(): Nullable<Mesh>;
  57284. private _skyboxTexture;
  57285. /**
  57286. * Gets the skybox texture created by the helper.
  57287. */
  57288. get skyboxTexture(): Nullable<BaseTexture>;
  57289. private _skyboxMaterial;
  57290. /**
  57291. * Gets the skybox material created by the helper.
  57292. */
  57293. get skyboxMaterial(): Nullable<BackgroundMaterial>;
  57294. private _ground;
  57295. /**
  57296. * Gets the ground mesh created by the helper.
  57297. */
  57298. get ground(): Nullable<Mesh>;
  57299. private _groundTexture;
  57300. /**
  57301. * Gets the ground texture created by the helper.
  57302. */
  57303. get groundTexture(): Nullable<BaseTexture>;
  57304. private _groundMirror;
  57305. /**
  57306. * Gets the ground mirror created by the helper.
  57307. */
  57308. get groundMirror(): Nullable<MirrorTexture>;
  57309. /**
  57310. * Gets the ground mirror render list to helps pushing the meshes
  57311. * you wish in the ground reflection.
  57312. */
  57313. get groundMirrorRenderList(): Nullable<AbstractMesh[]>;
  57314. private _groundMaterial;
  57315. /**
  57316. * Gets the ground material created by the helper.
  57317. */
  57318. get groundMaterial(): Nullable<BackgroundMaterial>;
  57319. /**
  57320. * Stores the creation options.
  57321. */
  57322. private readonly _scene;
  57323. private _options;
  57324. /**
  57325. * This observable will be notified with any error during the creation of the environment,
  57326. * mainly texture creation errors.
  57327. */
  57328. onErrorObservable: Observable<{
  57329. message?: string;
  57330. exception?: any;
  57331. }>;
  57332. /**
  57333. * constructor
  57334. * @param options Defines the options we want to customize the helper
  57335. * @param scene The scene to add the material to
  57336. */
  57337. constructor(options: Partial<IEnvironmentHelperOptions>, scene: Scene);
  57338. /**
  57339. * Updates the background according to the new options
  57340. * @param options
  57341. */
  57342. updateOptions(options: Partial<IEnvironmentHelperOptions>): void;
  57343. /**
  57344. * Sets the primary color of all the available elements.
  57345. * @param color the main color to affect to the ground and the background
  57346. */
  57347. setMainColor(color: Color3): void;
  57348. /**
  57349. * Setup the image processing according to the specified options.
  57350. */
  57351. private _setupImageProcessing;
  57352. /**
  57353. * Setup the environment texture according to the specified options.
  57354. */
  57355. private _setupEnvironmentTexture;
  57356. /**
  57357. * Setup the background according to the specified options.
  57358. */
  57359. private _setupBackground;
  57360. /**
  57361. * Get the scene sizes according to the setup.
  57362. */
  57363. private _getSceneSize;
  57364. /**
  57365. * Setup the ground according to the specified options.
  57366. */
  57367. private _setupGround;
  57368. /**
  57369. * Setup the ground material according to the specified options.
  57370. */
  57371. private _setupGroundMaterial;
  57372. /**
  57373. * Setup the ground diffuse texture according to the specified options.
  57374. */
  57375. private _setupGroundDiffuseTexture;
  57376. /**
  57377. * Setup the ground mirror texture according to the specified options.
  57378. */
  57379. private _setupGroundMirrorTexture;
  57380. /**
  57381. * Setup the ground to receive the mirror texture.
  57382. */
  57383. private _setupMirrorInGroundMaterial;
  57384. /**
  57385. * Setup the skybox according to the specified options.
  57386. */
  57387. private _setupSkybox;
  57388. /**
  57389. * Setup the skybox material according to the specified options.
  57390. */
  57391. private _setupSkyboxMaterial;
  57392. /**
  57393. * Setup the skybox reflection texture according to the specified options.
  57394. */
  57395. private _setupSkyboxReflectionTexture;
  57396. private _errorHandler;
  57397. /**
  57398. * Dispose all the elements created by the Helper.
  57399. */
  57400. dispose(): void;
  57401. }
  57402. }
  57403. declare module "babylonjs/Helpers/textureDome" {
  57404. import { Scene } from "babylonjs/scene";
  57405. import { TransformNode } from "babylonjs/Meshes/transformNode";
  57406. import { Mesh } from "babylonjs/Meshes/mesh";
  57407. import { Texture } from "babylonjs/Materials/Textures/texture";
  57408. import { BackgroundMaterial } from "babylonjs/Materials/Background/backgroundMaterial";
  57409. import "babylonjs/Meshes/Builders/sphereBuilder";
  57410. import { Nullable } from "babylonjs/types";
  57411. import { Observable } from "babylonjs/Misc/observable";
  57412. /**
  57413. * Display a 360/180 degree texture on an approximately spherical surface, useful for VR applications or skyboxes.
  57414. * As a subclass of TransformNode, this allow parenting to the camera or multiple textures with different locations in the scene.
  57415. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  57416. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  57417. */
  57418. export abstract class TextureDome<T extends Texture> extends TransformNode {
  57419. protected onError: Nullable<(message?: string, exception?: any) => void>;
  57420. /**
  57421. * Define the source as a Monoscopic panoramic 360/180.
  57422. */
  57423. static readonly MODE_MONOSCOPIC: number;
  57424. /**
  57425. * Define the source as a Stereoscopic TopBottom/OverUnder panoramic 360/180.
  57426. */
  57427. static readonly MODE_TOPBOTTOM: number;
  57428. /**
  57429. * Define the source as a Stereoscopic Side by Side panoramic 360/180.
  57430. */
  57431. static readonly MODE_SIDEBYSIDE: number;
  57432. private _halfDome;
  57433. protected _useDirectMapping: boolean;
  57434. /**
  57435. * The texture being displayed on the sphere
  57436. */
  57437. protected _texture: T;
  57438. /**
  57439. * Gets the texture being displayed on the sphere
  57440. */
  57441. get texture(): T;
  57442. /**
  57443. * Sets the texture being displayed on the sphere
  57444. */
  57445. set texture(newTexture: T);
  57446. /**
  57447. * The skybox material
  57448. */
  57449. protected _material: BackgroundMaterial;
  57450. /**
  57451. * The surface used for the dome
  57452. */
  57453. protected _mesh: Mesh;
  57454. /**
  57455. * Gets the mesh used for the dome.
  57456. */
  57457. get mesh(): Mesh;
  57458. /**
  57459. * A mesh that will be used to mask the back of the dome in case it is a 180 degree movie.
  57460. */
  57461. private _halfDomeMask;
  57462. /**
  57463. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  57464. * Also see the options.resolution property.
  57465. */
  57466. get fovMultiplier(): number;
  57467. set fovMultiplier(value: number);
  57468. protected _textureMode: number;
  57469. /**
  57470. * Gets or set the current texture mode for the texture. It can be:
  57471. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  57472. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  57473. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  57474. */
  57475. get textureMode(): number;
  57476. /**
  57477. * Sets the current texture mode for the texture. It can be:
  57478. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  57479. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  57480. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  57481. */
  57482. set textureMode(value: number);
  57483. /**
  57484. * Is it a 180 degrees dome (half dome) or 360 texture (full dome)
  57485. */
  57486. get halfDome(): boolean;
  57487. /**
  57488. * Set the halfDome mode. If set, only the front (180 degrees) will be displayed and the back will be blacked out.
  57489. */
  57490. set halfDome(enabled: boolean);
  57491. /**
  57492. * Oberserver used in Stereoscopic VR Mode.
  57493. */
  57494. private _onBeforeCameraRenderObserver;
  57495. /**
  57496. * Observable raised when an error occured while loading the 360 image
  57497. */
  57498. onLoadErrorObservable: Observable<string>;
  57499. /**
  57500. * Create an instance of this class and pass through the parameters to the relevant classes- Texture, StandardMaterial, and Mesh.
  57501. * @param name Element's name, child elements will append suffixes for their own names.
  57502. * @param textureUrlOrElement defines the url(s) or the (video) HTML element to use
  57503. * @param options An object containing optional or exposed sub element properties
  57504. */
  57505. constructor(name: string, textureUrlOrElement: string | string[] | HTMLVideoElement, options: {
  57506. resolution?: number;
  57507. clickToPlay?: boolean;
  57508. autoPlay?: boolean;
  57509. loop?: boolean;
  57510. size?: number;
  57511. poster?: string;
  57512. faceForward?: boolean;
  57513. useDirectMapping?: boolean;
  57514. halfDomeMode?: boolean;
  57515. }, scene: Scene, onError?: Nullable<(message?: string, exception?: any) => void>);
  57516. protected abstract _initTexture(urlsOrElement: string | string[] | HTMLElement, scene: Scene, options: any): T;
  57517. protected _changeTextureMode(value: number): void;
  57518. /**
  57519. * Releases resources associated with this node.
  57520. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  57521. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  57522. */
  57523. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  57524. }
  57525. }
  57526. declare module "babylonjs/Helpers/photoDome" {
  57527. import { Scene } from "babylonjs/scene";
  57528. import { Texture } from "babylonjs/Materials/Textures/texture";
  57529. import { TextureDome } from "babylonjs/Helpers/textureDome";
  57530. /**
  57531. * Display a 360 degree photo on an approximately spherical surface, useful for VR applications or skyboxes.
  57532. * As a subclass of TransformNode, this allow parenting to the camera with different locations in the scene.
  57533. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  57534. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  57535. */
  57536. export class PhotoDome extends TextureDome<Texture> {
  57537. /**
  57538. * Define the image as a Monoscopic panoramic 360 image.
  57539. */
  57540. static readonly MODE_MONOSCOPIC: number;
  57541. /**
  57542. * Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  57543. */
  57544. static readonly MODE_TOPBOTTOM: number;
  57545. /**
  57546. * Define the image as a Stereoscopic Side by Side panoramic 360 image.
  57547. */
  57548. static readonly MODE_SIDEBYSIDE: number;
  57549. /**
  57550. * Gets or sets the texture being displayed on the sphere
  57551. */
  57552. get photoTexture(): Texture;
  57553. /**
  57554. * sets the texture being displayed on the sphere
  57555. */
  57556. set photoTexture(value: Texture);
  57557. /**
  57558. * Gets the current video mode for the video. It can be:
  57559. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  57560. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  57561. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  57562. */
  57563. get imageMode(): number;
  57564. /**
  57565. * Sets the current video mode for the video. It can be:
  57566. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  57567. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  57568. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  57569. */
  57570. set imageMode(value: number);
  57571. protected _initTexture(urlsOrElement: string, scene: Scene, options: any): Texture;
  57572. }
  57573. }
  57574. declare module "babylonjs/Misc/rgbdTextureTools" {
  57575. import "babylonjs/Shaders/rgbdDecode.fragment";
  57576. import "babylonjs/Engines/Extensions/engine.renderTarget";
  57577. import { Texture } from "babylonjs/Materials/Textures/texture";
  57578. /**
  57579. * Class used to host RGBD texture specific utilities
  57580. */
  57581. export class RGBDTextureTools {
  57582. /**
  57583. * Expand the RGBD Texture from RGBD to Half Float if possible.
  57584. * @param texture the texture to expand.
  57585. */
  57586. static ExpandRGBDTexture(texture: Texture): void;
  57587. }
  57588. }
  57589. declare module "babylonjs/Misc/brdfTextureTools" {
  57590. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  57591. import { Scene } from "babylonjs/scene";
  57592. /**
  57593. * Class used to host texture specific utilities
  57594. */
  57595. export class BRDFTextureTools {
  57596. /**
  57597. * Prevents texture cache collision
  57598. */
  57599. private static _instanceNumber;
  57600. /**
  57601. * Gets a default environment BRDF for MS-BRDF Height Correlated BRDF
  57602. * @param scene defines the hosting scene
  57603. * @returns the environment BRDF texture
  57604. */
  57605. static GetEnvironmentBRDFTexture(scene: Scene): BaseTexture;
  57606. private static _environmentBRDFBase64Texture;
  57607. }
  57608. }
  57609. declare module "babylonjs/Materials/PBR/pbrClearCoatConfiguration" {
  57610. import { Nullable } from "babylonjs/types";
  57611. import { Color3 } from "babylonjs/Maths/math.color";
  57612. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  57613. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  57614. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  57615. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  57616. import { Engine } from "babylonjs/Engines/engine";
  57617. import { Scene } from "babylonjs/scene";
  57618. /**
  57619. * @hidden
  57620. */
  57621. export interface IMaterialClearCoatDefines {
  57622. CLEARCOAT: boolean;
  57623. CLEARCOAT_DEFAULTIOR: boolean;
  57624. CLEARCOAT_TEXTURE: boolean;
  57625. CLEARCOAT_TEXTUREDIRECTUV: number;
  57626. CLEARCOAT_BUMP: boolean;
  57627. CLEARCOAT_BUMPDIRECTUV: number;
  57628. CLEARCOAT_TINT: boolean;
  57629. CLEARCOAT_TINT_TEXTURE: boolean;
  57630. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  57631. /** @hidden */
  57632. _areTexturesDirty: boolean;
  57633. }
  57634. /**
  57635. * Define the code related to the clear coat parameters of the pbr material.
  57636. */
  57637. export class PBRClearCoatConfiguration {
  57638. /**
  57639. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  57640. * The default fits with a polyurethane material.
  57641. */
  57642. private static readonly _DefaultIndexOfRefraction;
  57643. private _isEnabled;
  57644. /**
  57645. * Defines if the clear coat is enabled in the material.
  57646. */
  57647. isEnabled: boolean;
  57648. /**
  57649. * Defines the clear coat layer strength (between 0 and 1) it defaults to 1.
  57650. */
  57651. intensity: number;
  57652. /**
  57653. * Defines the clear coat layer roughness.
  57654. */
  57655. roughness: number;
  57656. private _indexOfRefraction;
  57657. /**
  57658. * Defines the index of refraction of the clear coat.
  57659. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  57660. * The default fits with a polyurethane material.
  57661. * Changing the default value is more performance intensive.
  57662. */
  57663. indexOfRefraction: number;
  57664. private _texture;
  57665. /**
  57666. * Stores the clear coat values in a texture.
  57667. */
  57668. texture: Nullable<BaseTexture>;
  57669. private _bumpTexture;
  57670. /**
  57671. * Define the clear coat specific bump texture.
  57672. */
  57673. bumpTexture: Nullable<BaseTexture>;
  57674. private _isTintEnabled;
  57675. /**
  57676. * Defines if the clear coat tint is enabled in the material.
  57677. */
  57678. isTintEnabled: boolean;
  57679. /**
  57680. * Defines the clear coat tint of the material.
  57681. * This is only use if tint is enabled
  57682. */
  57683. tintColor: Color3;
  57684. /**
  57685. * Defines the distance at which the tint color should be found in the
  57686. * clear coat media.
  57687. * This is only use if tint is enabled
  57688. */
  57689. tintColorAtDistance: number;
  57690. /**
  57691. * Defines the clear coat layer thickness.
  57692. * This is only use if tint is enabled
  57693. */
  57694. tintThickness: number;
  57695. private _tintTexture;
  57696. /**
  57697. * Stores the clear tint values in a texture.
  57698. * rgb is tint
  57699. * a is a thickness factor
  57700. */
  57701. tintTexture: Nullable<BaseTexture>;
  57702. /** @hidden */
  57703. private _internalMarkAllSubMeshesAsTexturesDirty;
  57704. /** @hidden */
  57705. _markAllSubMeshesAsTexturesDirty(): void;
  57706. /**
  57707. * Instantiate a new istance of clear coat configuration.
  57708. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  57709. */
  57710. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  57711. /**
  57712. * Gets wehter the submesh is ready to be used or not.
  57713. * @param defines the list of "defines" to update.
  57714. * @param scene defines the scene the material belongs to.
  57715. * @param engine defines the engine the material belongs to.
  57716. * @param disableBumpMap defines wether the material disables bump or not.
  57717. * @returns - boolean indicating that the submesh is ready or not.
  57718. */
  57719. isReadyForSubMesh(defines: IMaterialClearCoatDefines, scene: Scene, engine: Engine, disableBumpMap: boolean): boolean;
  57720. /**
  57721. * Checks to see if a texture is used in the material.
  57722. * @param defines the list of "defines" to update.
  57723. * @param scene defines the scene to the material belongs to.
  57724. */
  57725. prepareDefines(defines: IMaterialClearCoatDefines, scene: Scene): void;
  57726. /**
  57727. * Binds the material data.
  57728. * @param uniformBuffer defines the Uniform buffer to fill in.
  57729. * @param scene defines the scene the material belongs to.
  57730. * @param engine defines the engine the material belongs to.
  57731. * @param disableBumpMap defines wether the material disables bump or not.
  57732. * @param isFrozen defines wether the material is frozen or not.
  57733. * @param invertNormalMapX If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  57734. * @param invertNormalMapY If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  57735. */
  57736. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, disableBumpMap: boolean, isFrozen: boolean, invertNormalMapX: boolean, invertNormalMapY: boolean): void;
  57737. /**
  57738. * Checks to see if a texture is used in the material.
  57739. * @param texture - Base texture to use.
  57740. * @returns - Boolean specifying if a texture is used in the material.
  57741. */
  57742. hasTexture(texture: BaseTexture): boolean;
  57743. /**
  57744. * Returns an array of the actively used textures.
  57745. * @param activeTextures Array of BaseTextures
  57746. */
  57747. getActiveTextures(activeTextures: BaseTexture[]): void;
  57748. /**
  57749. * Returns the animatable textures.
  57750. * @param animatables Array of animatable textures.
  57751. */
  57752. getAnimatables(animatables: IAnimatable[]): void;
  57753. /**
  57754. * Disposes the resources of the material.
  57755. * @param forceDisposeTextures - Forces the disposal of all textures.
  57756. */
  57757. dispose(forceDisposeTextures?: boolean): void;
  57758. /**
  57759. * Get the current class name of the texture useful for serialization or dynamic coding.
  57760. * @returns "PBRClearCoatConfiguration"
  57761. */
  57762. getClassName(): string;
  57763. /**
  57764. * Add fallbacks to the effect fallbacks list.
  57765. * @param defines defines the Base texture to use.
  57766. * @param fallbacks defines the current fallback list.
  57767. * @param currentRank defines the current fallback rank.
  57768. * @returns the new fallback rank.
  57769. */
  57770. static AddFallbacks(defines: IMaterialClearCoatDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  57771. /**
  57772. * Add the required uniforms to the current list.
  57773. * @param uniforms defines the current uniform list.
  57774. */
  57775. static AddUniforms(uniforms: string[]): void;
  57776. /**
  57777. * Add the required samplers to the current list.
  57778. * @param samplers defines the current sampler list.
  57779. */
  57780. static AddSamplers(samplers: string[]): void;
  57781. /**
  57782. * Add the required uniforms to the current buffer.
  57783. * @param uniformBuffer defines the current uniform buffer.
  57784. */
  57785. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  57786. /**
  57787. * Makes a duplicate of the current configuration into another one.
  57788. * @param clearCoatConfiguration define the config where to copy the info
  57789. */
  57790. copyTo(clearCoatConfiguration: PBRClearCoatConfiguration): void;
  57791. /**
  57792. * Serializes this clear coat configuration.
  57793. * @returns - An object with the serialized config.
  57794. */
  57795. serialize(): any;
  57796. /**
  57797. * Parses a anisotropy Configuration from a serialized object.
  57798. * @param source - Serialized object.
  57799. * @param scene Defines the scene we are parsing for
  57800. * @param rootUrl Defines the rootUrl to load from
  57801. */
  57802. parse(source: any, scene: Scene, rootUrl: string): void;
  57803. }
  57804. }
  57805. declare module "babylonjs/Materials/PBR/pbrAnisotropicConfiguration" {
  57806. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  57807. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  57808. import { Vector2 } from "babylonjs/Maths/math.vector";
  57809. import { Scene } from "babylonjs/scene";
  57810. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  57811. import { Nullable } from "babylonjs/types";
  57812. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  57813. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  57814. /**
  57815. * @hidden
  57816. */
  57817. export interface IMaterialAnisotropicDefines {
  57818. ANISOTROPIC: boolean;
  57819. ANISOTROPIC_TEXTURE: boolean;
  57820. ANISOTROPIC_TEXTUREDIRECTUV: number;
  57821. MAINUV1: boolean;
  57822. _areTexturesDirty: boolean;
  57823. _needUVs: boolean;
  57824. }
  57825. /**
  57826. * Define the code related to the anisotropic parameters of the pbr material.
  57827. */
  57828. export class PBRAnisotropicConfiguration {
  57829. private _isEnabled;
  57830. /**
  57831. * Defines if the anisotropy is enabled in the material.
  57832. */
  57833. isEnabled: boolean;
  57834. /**
  57835. * Defines the anisotropy strength (between 0 and 1) it defaults to 1.
  57836. */
  57837. intensity: number;
  57838. /**
  57839. * Defines if the effect is along the tangents, bitangents or in between.
  57840. * By default, the effect is "strectching" the highlights along the tangents.
  57841. */
  57842. direction: Vector2;
  57843. private _texture;
  57844. /**
  57845. * Stores the anisotropy values in a texture.
  57846. * rg is direction (like normal from -1 to 1)
  57847. * b is a intensity
  57848. */
  57849. texture: Nullable<BaseTexture>;
  57850. /** @hidden */
  57851. private _internalMarkAllSubMeshesAsTexturesDirty;
  57852. /** @hidden */
  57853. _markAllSubMeshesAsTexturesDirty(): void;
  57854. /**
  57855. * Instantiate a new istance of anisotropy configuration.
  57856. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  57857. */
  57858. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  57859. /**
  57860. * Specifies that the submesh is ready to be used.
  57861. * @param defines the list of "defines" to update.
  57862. * @param scene defines the scene the material belongs to.
  57863. * @returns - boolean indicating that the submesh is ready or not.
  57864. */
  57865. isReadyForSubMesh(defines: IMaterialAnisotropicDefines, scene: Scene): boolean;
  57866. /**
  57867. * Checks to see if a texture is used in the material.
  57868. * @param defines the list of "defines" to update.
  57869. * @param mesh the mesh we are preparing the defines for.
  57870. * @param scene defines the scene the material belongs to.
  57871. */
  57872. prepareDefines(defines: IMaterialAnisotropicDefines, mesh: AbstractMesh, scene: Scene): void;
  57873. /**
  57874. * Binds the material data.
  57875. * @param uniformBuffer defines the Uniform buffer to fill in.
  57876. * @param scene defines the scene the material belongs to.
  57877. * @param isFrozen defines wether the material is frozen or not.
  57878. */
  57879. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  57880. /**
  57881. * Checks to see if a texture is used in the material.
  57882. * @param texture - Base texture to use.
  57883. * @returns - Boolean specifying if a texture is used in the material.
  57884. */
  57885. hasTexture(texture: BaseTexture): boolean;
  57886. /**
  57887. * Returns an array of the actively used textures.
  57888. * @param activeTextures Array of BaseTextures
  57889. */
  57890. getActiveTextures(activeTextures: BaseTexture[]): void;
  57891. /**
  57892. * Returns the animatable textures.
  57893. * @param animatables Array of animatable textures.
  57894. */
  57895. getAnimatables(animatables: IAnimatable[]): void;
  57896. /**
  57897. * Disposes the resources of the material.
  57898. * @param forceDisposeTextures - Forces the disposal of all textures.
  57899. */
  57900. dispose(forceDisposeTextures?: boolean): void;
  57901. /**
  57902. * Get the current class name of the texture useful for serialization or dynamic coding.
  57903. * @returns "PBRAnisotropicConfiguration"
  57904. */
  57905. getClassName(): string;
  57906. /**
  57907. * Add fallbacks to the effect fallbacks list.
  57908. * @param defines defines the Base texture to use.
  57909. * @param fallbacks defines the current fallback list.
  57910. * @param currentRank defines the current fallback rank.
  57911. * @returns the new fallback rank.
  57912. */
  57913. static AddFallbacks(defines: IMaterialAnisotropicDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  57914. /**
  57915. * Add the required uniforms to the current list.
  57916. * @param uniforms defines the current uniform list.
  57917. */
  57918. static AddUniforms(uniforms: string[]): void;
  57919. /**
  57920. * Add the required uniforms to the current buffer.
  57921. * @param uniformBuffer defines the current uniform buffer.
  57922. */
  57923. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  57924. /**
  57925. * Add the required samplers to the current list.
  57926. * @param samplers defines the current sampler list.
  57927. */
  57928. static AddSamplers(samplers: string[]): void;
  57929. /**
  57930. * Makes a duplicate of the current configuration into another one.
  57931. * @param anisotropicConfiguration define the config where to copy the info
  57932. */
  57933. copyTo(anisotropicConfiguration: PBRAnisotropicConfiguration): void;
  57934. /**
  57935. * Serializes this anisotropy configuration.
  57936. * @returns - An object with the serialized config.
  57937. */
  57938. serialize(): any;
  57939. /**
  57940. * Parses a anisotropy Configuration from a serialized object.
  57941. * @param source - Serialized object.
  57942. * @param scene Defines the scene we are parsing for
  57943. * @param rootUrl Defines the rootUrl to load from
  57944. */
  57945. parse(source: any, scene: Scene, rootUrl: string): void;
  57946. }
  57947. }
  57948. declare module "babylonjs/Materials/PBR/pbrBRDFConfiguration" {
  57949. import { Scene } from "babylonjs/scene";
  57950. /**
  57951. * @hidden
  57952. */
  57953. export interface IMaterialBRDFDefines {
  57954. BRDF_V_HEIGHT_CORRELATED: boolean;
  57955. MS_BRDF_ENERGY_CONSERVATION: boolean;
  57956. SPHERICAL_HARMONICS: boolean;
  57957. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  57958. /** @hidden */
  57959. _areMiscDirty: boolean;
  57960. }
  57961. /**
  57962. * Define the code related to the BRDF parameters of the pbr material.
  57963. */
  57964. export class PBRBRDFConfiguration {
  57965. /**
  57966. * Default value used for the energy conservation.
  57967. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  57968. */
  57969. static DEFAULT_USE_ENERGY_CONSERVATION: boolean;
  57970. /**
  57971. * Default value used for the Smith Visibility Height Correlated mode.
  57972. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  57973. */
  57974. static DEFAULT_USE_SMITH_VISIBILITY_HEIGHT_CORRELATED: boolean;
  57975. /**
  57976. * Default value used for the IBL diffuse part.
  57977. * This can help switching back to the polynomials mode globally which is a tiny bit
  57978. * less GPU intensive at the drawback of a lower quality.
  57979. */
  57980. static DEFAULT_USE_SPHERICAL_HARMONICS: boolean;
  57981. /**
  57982. * Default value used for activating energy conservation for the specular workflow.
  57983. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  57984. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  57985. */
  57986. static DEFAULT_USE_SPECULAR_GLOSSINESS_INPUT_ENERGY_CONSERVATION: boolean;
  57987. private _useEnergyConservation;
  57988. /**
  57989. * Defines if the material uses energy conservation.
  57990. */
  57991. useEnergyConservation: boolean;
  57992. private _useSmithVisibilityHeightCorrelated;
  57993. /**
  57994. * LEGACY Mode set to false
  57995. * Defines if the material uses height smith correlated visibility term.
  57996. * If you intent to not use our default BRDF, you need to load a separate BRDF Texture for the PBR
  57997. * You can either load https://assets.babylonjs.com/environments/uncorrelatedBRDF.png
  57998. * or https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds to have more precision
  57999. * Not relying on height correlated will also disable energy conservation.
  58000. */
  58001. useSmithVisibilityHeightCorrelated: boolean;
  58002. private _useSphericalHarmonics;
  58003. /**
  58004. * LEGACY Mode set to false
  58005. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  58006. * diffuse part of the IBL.
  58007. * The harmonics despite a tiny bigger cost has been proven to provide closer results
  58008. * to the ground truth.
  58009. */
  58010. useSphericalHarmonics: boolean;
  58011. private _useSpecularGlossinessInputEnergyConservation;
  58012. /**
  58013. * Defines if the material uses energy conservation, when the specular workflow is active.
  58014. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  58015. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  58016. * In the deactivated case, the material author has to ensure energy conservation, for a physically plausible rendering.
  58017. */
  58018. useSpecularGlossinessInputEnergyConservation: boolean;
  58019. /** @hidden */
  58020. private _internalMarkAllSubMeshesAsMiscDirty;
  58021. /** @hidden */
  58022. _markAllSubMeshesAsMiscDirty(): void;
  58023. /**
  58024. * Instantiate a new istance of clear coat configuration.
  58025. * @param markAllSubMeshesAsMiscDirty Callback to flag the material to dirty
  58026. */
  58027. constructor(markAllSubMeshesAsMiscDirty: () => void);
  58028. /**
  58029. * Checks to see if a texture is used in the material.
  58030. * @param defines the list of "defines" to update.
  58031. */
  58032. prepareDefines(defines: IMaterialBRDFDefines): void;
  58033. /**
  58034. * Get the current class name of the texture useful for serialization or dynamic coding.
  58035. * @returns "PBRClearCoatConfiguration"
  58036. */
  58037. getClassName(): string;
  58038. /**
  58039. * Makes a duplicate of the current configuration into another one.
  58040. * @param brdfConfiguration define the config where to copy the info
  58041. */
  58042. copyTo(brdfConfiguration: PBRBRDFConfiguration): void;
  58043. /**
  58044. * Serializes this BRDF configuration.
  58045. * @returns - An object with the serialized config.
  58046. */
  58047. serialize(): any;
  58048. /**
  58049. * Parses a anisotropy Configuration from a serialized object.
  58050. * @param source - Serialized object.
  58051. * @param scene Defines the scene we are parsing for
  58052. * @param rootUrl Defines the rootUrl to load from
  58053. */
  58054. parse(source: any, scene: Scene, rootUrl: string): void;
  58055. }
  58056. }
  58057. declare module "babylonjs/Materials/PBR/pbrSheenConfiguration" {
  58058. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  58059. import { Color3 } from "babylonjs/Maths/math.color";
  58060. import { Scene } from "babylonjs/scene";
  58061. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  58062. import { Nullable } from "babylonjs/types";
  58063. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  58064. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  58065. /**
  58066. * @hidden
  58067. */
  58068. export interface IMaterialSheenDefines {
  58069. SHEEN: boolean;
  58070. SHEEN_TEXTURE: boolean;
  58071. SHEEN_TEXTUREDIRECTUV: number;
  58072. SHEEN_LINKWITHALBEDO: boolean;
  58073. SHEEN_ROUGHNESS: boolean;
  58074. SHEEN_ALBEDOSCALING: boolean;
  58075. /** @hidden */
  58076. _areTexturesDirty: boolean;
  58077. }
  58078. /**
  58079. * Define the code related to the Sheen parameters of the pbr material.
  58080. */
  58081. export class PBRSheenConfiguration {
  58082. private _isEnabled;
  58083. /**
  58084. * Defines if the material uses sheen.
  58085. */
  58086. isEnabled: boolean;
  58087. private _linkSheenWithAlbedo;
  58088. /**
  58089. * Defines if the sheen is linked to the sheen color.
  58090. */
  58091. linkSheenWithAlbedo: boolean;
  58092. /**
  58093. * Defines the sheen intensity.
  58094. */
  58095. intensity: number;
  58096. /**
  58097. * Defines the sheen color.
  58098. */
  58099. color: Color3;
  58100. private _texture;
  58101. /**
  58102. * Stores the sheen tint values in a texture.
  58103. * rgb is tint
  58104. * a is a intensity or roughness if roughness has been defined
  58105. */
  58106. texture: Nullable<BaseTexture>;
  58107. private _roughness;
  58108. /**
  58109. * Defines the sheen roughness.
  58110. * It is not taken into account if linkSheenWithAlbedo is true.
  58111. * To stay backward compatible, material roughness is used instead if sheen roughness = null
  58112. */
  58113. roughness: Nullable<number>;
  58114. private _albedoScaling;
  58115. /**
  58116. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  58117. * It allows the strength of the sheen effect to not depend on the base color of the material,
  58118. * making it easier to setup and tweak the effect
  58119. */
  58120. albedoScaling: boolean;
  58121. /** @hidden */
  58122. private _internalMarkAllSubMeshesAsTexturesDirty;
  58123. /** @hidden */
  58124. _markAllSubMeshesAsTexturesDirty(): void;
  58125. /**
  58126. * Instantiate a new istance of clear coat configuration.
  58127. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  58128. */
  58129. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  58130. /**
  58131. * Specifies that the submesh is ready to be used.
  58132. * @param defines the list of "defines" to update.
  58133. * @param scene defines the scene the material belongs to.
  58134. * @returns - boolean indicating that the submesh is ready or not.
  58135. */
  58136. isReadyForSubMesh(defines: IMaterialSheenDefines, scene: Scene): boolean;
  58137. /**
  58138. * Checks to see if a texture is used in the material.
  58139. * @param defines the list of "defines" to update.
  58140. * @param scene defines the scene the material belongs to.
  58141. */
  58142. prepareDefines(defines: IMaterialSheenDefines, scene: Scene): void;
  58143. /**
  58144. * Binds the material data.
  58145. * @param uniformBuffer defines the Uniform buffer to fill in.
  58146. * @param scene defines the scene the material belongs to.
  58147. * @param isFrozen defines wether the material is frozen or not.
  58148. */
  58149. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  58150. /**
  58151. * Checks to see if a texture is used in the material.
  58152. * @param texture - Base texture to use.
  58153. * @returns - Boolean specifying if a texture is used in the material.
  58154. */
  58155. hasTexture(texture: BaseTexture): boolean;
  58156. /**
  58157. * Returns an array of the actively used textures.
  58158. * @param activeTextures Array of BaseTextures
  58159. */
  58160. getActiveTextures(activeTextures: BaseTexture[]): void;
  58161. /**
  58162. * Returns the animatable textures.
  58163. * @param animatables Array of animatable textures.
  58164. */
  58165. getAnimatables(animatables: IAnimatable[]): void;
  58166. /**
  58167. * Disposes the resources of the material.
  58168. * @param forceDisposeTextures - Forces the disposal of all textures.
  58169. */
  58170. dispose(forceDisposeTextures?: boolean): void;
  58171. /**
  58172. * Get the current class name of the texture useful for serialization or dynamic coding.
  58173. * @returns "PBRSheenConfiguration"
  58174. */
  58175. getClassName(): string;
  58176. /**
  58177. * Add fallbacks to the effect fallbacks list.
  58178. * @param defines defines the Base texture to use.
  58179. * @param fallbacks defines the current fallback list.
  58180. * @param currentRank defines the current fallback rank.
  58181. * @returns the new fallback rank.
  58182. */
  58183. static AddFallbacks(defines: IMaterialSheenDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  58184. /**
  58185. * Add the required uniforms to the current list.
  58186. * @param uniforms defines the current uniform list.
  58187. */
  58188. static AddUniforms(uniforms: string[]): void;
  58189. /**
  58190. * Add the required uniforms to the current buffer.
  58191. * @param uniformBuffer defines the current uniform buffer.
  58192. */
  58193. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  58194. /**
  58195. * Add the required samplers to the current list.
  58196. * @param samplers defines the current sampler list.
  58197. */
  58198. static AddSamplers(samplers: string[]): void;
  58199. /**
  58200. * Makes a duplicate of the current configuration into another one.
  58201. * @param sheenConfiguration define the config where to copy the info
  58202. */
  58203. copyTo(sheenConfiguration: PBRSheenConfiguration): void;
  58204. /**
  58205. * Serializes this BRDF configuration.
  58206. * @returns - An object with the serialized config.
  58207. */
  58208. serialize(): any;
  58209. /**
  58210. * Parses a anisotropy Configuration from a serialized object.
  58211. * @param source - Serialized object.
  58212. * @param scene Defines the scene we are parsing for
  58213. * @param rootUrl Defines the rootUrl to load from
  58214. */
  58215. parse(source: any, scene: Scene, rootUrl: string): void;
  58216. }
  58217. }
  58218. declare module "babylonjs/Materials/PBR/pbrSubSurfaceConfiguration" {
  58219. import { Nullable } from "babylonjs/types";
  58220. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  58221. import { Color3 } from "babylonjs/Maths/math.color";
  58222. import { SmartArray } from "babylonjs/Misc/smartArray";
  58223. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  58224. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  58225. import { Effect } from "babylonjs/Materials/effect";
  58226. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  58227. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  58228. import { Engine } from "babylonjs/Engines/engine";
  58229. import { Scene } from "babylonjs/scene";
  58230. /**
  58231. * @hidden
  58232. */
  58233. export interface IMaterialSubSurfaceDefines {
  58234. SUBSURFACE: boolean;
  58235. SS_REFRACTION: boolean;
  58236. SS_TRANSLUCENCY: boolean;
  58237. SS_SCATTERING: boolean;
  58238. SS_THICKNESSANDMASK_TEXTURE: boolean;
  58239. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  58240. SS_REFRACTIONMAP_3D: boolean;
  58241. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  58242. SS_LODINREFRACTIONALPHA: boolean;
  58243. SS_GAMMAREFRACTION: boolean;
  58244. SS_RGBDREFRACTION: boolean;
  58245. SS_LINEARSPECULARREFRACTION: boolean;
  58246. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  58247. SS_ALBEDOFORREFRACTIONTINT: boolean;
  58248. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  58249. /** @hidden */
  58250. _areTexturesDirty: boolean;
  58251. }
  58252. /**
  58253. * Define the code related to the sub surface parameters of the pbr material.
  58254. */
  58255. export class PBRSubSurfaceConfiguration {
  58256. private _isRefractionEnabled;
  58257. /**
  58258. * Defines if the refraction is enabled in the material.
  58259. */
  58260. isRefractionEnabled: boolean;
  58261. private _isTranslucencyEnabled;
  58262. /**
  58263. * Defines if the translucency is enabled in the material.
  58264. */
  58265. isTranslucencyEnabled: boolean;
  58266. private _isScatteringEnabled;
  58267. /**
  58268. * Defines if the sub surface scattering is enabled in the material.
  58269. */
  58270. isScatteringEnabled: boolean;
  58271. private _scatteringDiffusionProfileIndex;
  58272. /**
  58273. * Diffusion profile for subsurface scattering.
  58274. * Useful for better scattering in the skins or foliages.
  58275. */
  58276. get scatteringDiffusionProfile(): Nullable<Color3>;
  58277. set scatteringDiffusionProfile(c: Nullable<Color3>);
  58278. /**
  58279. * Defines the refraction intensity of the material.
  58280. * The refraction when enabled replaces the Diffuse part of the material.
  58281. * The intensity helps transitionning between diffuse and refraction.
  58282. */
  58283. refractionIntensity: number;
  58284. /**
  58285. * Defines the translucency intensity of the material.
  58286. * When translucency has been enabled, this defines how much of the "translucency"
  58287. * is addded to the diffuse part of the material.
  58288. */
  58289. translucencyIntensity: number;
  58290. /**
  58291. * When enabled, transparent surfaces will be tinted with the albedo colour (independent of thickness)
  58292. */
  58293. useAlbedoToTintRefraction: boolean;
  58294. private _thicknessTexture;
  58295. /**
  58296. * Stores the average thickness of a mesh in a texture (The texture is holding the values linearly).
  58297. * The red channel of the texture should contain the thickness remapped between 0 and 1.
  58298. * 0 would mean minimumThickness
  58299. * 1 would mean maximumThickness
  58300. * The other channels might be use as a mask to vary the different effects intensity.
  58301. */
  58302. thicknessTexture: Nullable<BaseTexture>;
  58303. private _refractionTexture;
  58304. /**
  58305. * Defines the texture to use for refraction.
  58306. */
  58307. refractionTexture: Nullable<BaseTexture>;
  58308. private _indexOfRefraction;
  58309. /**
  58310. * Index of refraction of the material base layer.
  58311. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  58312. *
  58313. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  58314. *
  58315. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  58316. */
  58317. indexOfRefraction: number;
  58318. private _volumeIndexOfRefraction;
  58319. /**
  58320. * Index of refraction of the material's volume.
  58321. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  58322. *
  58323. * This ONLY impacts refraction. If not provided or given a non-valid value,
  58324. * the volume will use the same IOR as the surface.
  58325. */
  58326. get volumeIndexOfRefraction(): number;
  58327. set volumeIndexOfRefraction(value: number);
  58328. private _invertRefractionY;
  58329. /**
  58330. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  58331. */
  58332. invertRefractionY: boolean;
  58333. private _linkRefractionWithTransparency;
  58334. /**
  58335. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  58336. * Materials half opaque for instance using refraction could benefit from this control.
  58337. */
  58338. linkRefractionWithTransparency: boolean;
  58339. /**
  58340. * Defines the minimum thickness stored in the thickness map.
  58341. * If no thickness map is defined, this value will be used to simulate thickness.
  58342. */
  58343. minimumThickness: number;
  58344. /**
  58345. * Defines the maximum thickness stored in the thickness map.
  58346. */
  58347. maximumThickness: number;
  58348. /**
  58349. * Defines the volume tint of the material.
  58350. * This is used for both translucency and scattering.
  58351. */
  58352. tintColor: Color3;
  58353. /**
  58354. * Defines the distance at which the tint color should be found in the media.
  58355. * This is used for refraction only.
  58356. */
  58357. tintColorAtDistance: number;
  58358. /**
  58359. * Defines how far each channel transmit through the media.
  58360. * It is defined as a color to simplify it selection.
  58361. */
  58362. diffusionDistance: Color3;
  58363. private _useMaskFromThicknessTexture;
  58364. /**
  58365. * Stores the intensity of the different subsurface effects in the thickness texture.
  58366. * * the green channel is the translucency intensity.
  58367. * * the blue channel is the scattering intensity.
  58368. * * the alpha channel is the refraction intensity.
  58369. */
  58370. useMaskFromThicknessTexture: boolean;
  58371. private _scene;
  58372. /** @hidden */
  58373. private _internalMarkAllSubMeshesAsTexturesDirty;
  58374. private _internalMarkScenePrePassDirty;
  58375. /** @hidden */
  58376. _markAllSubMeshesAsTexturesDirty(): void;
  58377. /** @hidden */
  58378. _markScenePrePassDirty(): void;
  58379. /**
  58380. * Instantiate a new istance of sub surface configuration.
  58381. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  58382. * @param markScenePrePassDirty Callback to flag the scene as prepass dirty
  58383. * @param scene The scene
  58384. */
  58385. constructor(markAllSubMeshesAsTexturesDirty: () => void, markScenePrePassDirty: () => void, scene: Scene);
  58386. /**
  58387. * Gets wehter the submesh is ready to be used or not.
  58388. * @param defines the list of "defines" to update.
  58389. * @param scene defines the scene the material belongs to.
  58390. * @returns - boolean indicating that the submesh is ready or not.
  58391. */
  58392. isReadyForSubMesh(defines: IMaterialSubSurfaceDefines, scene: Scene): boolean;
  58393. /**
  58394. * Checks to see if a texture is used in the material.
  58395. * @param defines the list of "defines" to update.
  58396. * @param scene defines the scene to the material belongs to.
  58397. */
  58398. prepareDefines(defines: IMaterialSubSurfaceDefines, scene: Scene): void;
  58399. /**
  58400. * Binds the material data.
  58401. * @param uniformBuffer defines the Uniform buffer to fill in.
  58402. * @param scene defines the scene the material belongs to.
  58403. * @param engine defines the engine the material belongs to.
  58404. * @param isFrozen defines whether the material is frozen or not.
  58405. * @param lodBasedMicrosurface defines whether the material relies on lod based microsurface or not.
  58406. * @param realTimeFiltering defines whether the textures should be filtered on the fly.
  58407. */
  58408. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, isFrozen: boolean, lodBasedMicrosurface: boolean, realTimeFiltering: boolean): void;
  58409. /**
  58410. * Unbinds the material from the mesh.
  58411. * @param activeEffect defines the effect that should be unbound from.
  58412. * @returns true if unbound, otherwise false
  58413. */
  58414. unbind(activeEffect: Effect): boolean;
  58415. /**
  58416. * Returns the texture used for refraction or null if none is used.
  58417. * @param scene defines the scene the material belongs to.
  58418. * @returns - Refraction texture if present. If no refraction texture and refraction
  58419. * is linked with transparency, returns environment texture. Otherwise, returns null.
  58420. */
  58421. private _getRefractionTexture;
  58422. /**
  58423. * Returns true if alpha blending should be disabled.
  58424. */
  58425. get disableAlphaBlending(): boolean;
  58426. /**
  58427. * Fills the list of render target textures.
  58428. * @param renderTargets the list of render targets to update
  58429. */
  58430. fillRenderTargetTextures(renderTargets: SmartArray<RenderTargetTexture>): void;
  58431. /**
  58432. * Checks to see if a texture is used in the material.
  58433. * @param texture - Base texture to use.
  58434. * @returns - Boolean specifying if a texture is used in the material.
  58435. */
  58436. hasTexture(texture: BaseTexture): boolean;
  58437. /**
  58438. * Gets a boolean indicating that current material needs to register RTT
  58439. * @returns true if this uses a render target otherwise false.
  58440. */
  58441. hasRenderTargetTextures(): boolean;
  58442. /**
  58443. * Returns an array of the actively used textures.
  58444. * @param activeTextures Array of BaseTextures
  58445. */
  58446. getActiveTextures(activeTextures: BaseTexture[]): void;
  58447. /**
  58448. * Returns the animatable textures.
  58449. * @param animatables Array of animatable textures.
  58450. */
  58451. getAnimatables(animatables: IAnimatable[]): void;
  58452. /**
  58453. * Disposes the resources of the material.
  58454. * @param forceDisposeTextures - Forces the disposal of all textures.
  58455. */
  58456. dispose(forceDisposeTextures?: boolean): void;
  58457. /**
  58458. * Get the current class name of the texture useful for serialization or dynamic coding.
  58459. * @returns "PBRSubSurfaceConfiguration"
  58460. */
  58461. getClassName(): string;
  58462. /**
  58463. * Add fallbacks to the effect fallbacks list.
  58464. * @param defines defines the Base texture to use.
  58465. * @param fallbacks defines the current fallback list.
  58466. * @param currentRank defines the current fallback rank.
  58467. * @returns the new fallback rank.
  58468. */
  58469. static AddFallbacks(defines: IMaterialSubSurfaceDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  58470. /**
  58471. * Add the required uniforms to the current list.
  58472. * @param uniforms defines the current uniform list.
  58473. */
  58474. static AddUniforms(uniforms: string[]): void;
  58475. /**
  58476. * Add the required samplers to the current list.
  58477. * @param samplers defines the current sampler list.
  58478. */
  58479. static AddSamplers(samplers: string[]): void;
  58480. /**
  58481. * Add the required uniforms to the current buffer.
  58482. * @param uniformBuffer defines the current uniform buffer.
  58483. */
  58484. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  58485. /**
  58486. * Makes a duplicate of the current configuration into another one.
  58487. * @param configuration define the config where to copy the info
  58488. */
  58489. copyTo(configuration: PBRSubSurfaceConfiguration): void;
  58490. /**
  58491. * Serializes this Sub Surface configuration.
  58492. * @returns - An object with the serialized config.
  58493. */
  58494. serialize(): any;
  58495. /**
  58496. * Parses a anisotropy Configuration from a serialized object.
  58497. * @param source - Serialized object.
  58498. * @param scene Defines the scene we are parsing for
  58499. * @param rootUrl Defines the rootUrl to load from
  58500. */
  58501. parse(source: any, scene: Scene, rootUrl: string): void;
  58502. }
  58503. }
  58504. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentDeclaration" {
  58505. /** @hidden */
  58506. export var pbrFragmentDeclaration: {
  58507. name: string;
  58508. shader: string;
  58509. };
  58510. }
  58511. declare module "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration" {
  58512. /** @hidden */
  58513. export var pbrUboDeclaration: {
  58514. name: string;
  58515. shader: string;
  58516. };
  58517. }
  58518. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentExtraDeclaration" {
  58519. /** @hidden */
  58520. export var pbrFragmentExtraDeclaration: {
  58521. name: string;
  58522. shader: string;
  58523. };
  58524. }
  58525. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentSamplersDeclaration" {
  58526. /** @hidden */
  58527. export var pbrFragmentSamplersDeclaration: {
  58528. name: string;
  58529. shader: string;
  58530. };
  58531. }
  58532. declare module "babylonjs/Shaders/ShadersInclude/importanceSampling" {
  58533. /** @hidden */
  58534. export var importanceSampling: {
  58535. name: string;
  58536. shader: string;
  58537. };
  58538. }
  58539. declare module "babylonjs/Shaders/ShadersInclude/pbrHelperFunctions" {
  58540. /** @hidden */
  58541. export var pbrHelperFunctions: {
  58542. name: string;
  58543. shader: string;
  58544. };
  58545. }
  58546. declare module "babylonjs/Shaders/ShadersInclude/harmonicsFunctions" {
  58547. /** @hidden */
  58548. export var harmonicsFunctions: {
  58549. name: string;
  58550. shader: string;
  58551. };
  58552. }
  58553. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingSetupFunctions" {
  58554. /** @hidden */
  58555. export var pbrDirectLightingSetupFunctions: {
  58556. name: string;
  58557. shader: string;
  58558. };
  58559. }
  58560. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFalloffFunctions" {
  58561. /** @hidden */
  58562. export var pbrDirectLightingFalloffFunctions: {
  58563. name: string;
  58564. shader: string;
  58565. };
  58566. }
  58567. declare module "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions" {
  58568. /** @hidden */
  58569. export var pbrBRDFFunctions: {
  58570. name: string;
  58571. shader: string;
  58572. };
  58573. }
  58574. declare module "babylonjs/Shaders/ShadersInclude/hdrFilteringFunctions" {
  58575. /** @hidden */
  58576. export var hdrFilteringFunctions: {
  58577. name: string;
  58578. shader: string;
  58579. };
  58580. }
  58581. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFunctions" {
  58582. /** @hidden */
  58583. export var pbrDirectLightingFunctions: {
  58584. name: string;
  58585. shader: string;
  58586. };
  58587. }
  58588. declare module "babylonjs/Shaders/ShadersInclude/pbrIBLFunctions" {
  58589. /** @hidden */
  58590. export var pbrIBLFunctions: {
  58591. name: string;
  58592. shader: string;
  58593. };
  58594. }
  58595. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAlbedoOpacity" {
  58596. /** @hidden */
  58597. export var pbrBlockAlbedoOpacity: {
  58598. name: string;
  58599. shader: string;
  58600. };
  58601. }
  58602. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflectivity" {
  58603. /** @hidden */
  58604. export var pbrBlockReflectivity: {
  58605. name: string;
  58606. shader: string;
  58607. };
  58608. }
  58609. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAmbientOcclusion" {
  58610. /** @hidden */
  58611. export var pbrBlockAmbientOcclusion: {
  58612. name: string;
  58613. shader: string;
  58614. };
  58615. }
  58616. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAlphaFresnel" {
  58617. /** @hidden */
  58618. export var pbrBlockAlphaFresnel: {
  58619. name: string;
  58620. shader: string;
  58621. };
  58622. }
  58623. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAnisotropic" {
  58624. /** @hidden */
  58625. export var pbrBlockAnisotropic: {
  58626. name: string;
  58627. shader: string;
  58628. };
  58629. }
  58630. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflection" {
  58631. /** @hidden */
  58632. export var pbrBlockReflection: {
  58633. name: string;
  58634. shader: string;
  58635. };
  58636. }
  58637. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockSheen" {
  58638. /** @hidden */
  58639. export var pbrBlockSheen: {
  58640. name: string;
  58641. shader: string;
  58642. };
  58643. }
  58644. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockClearcoat" {
  58645. /** @hidden */
  58646. export var pbrBlockClearcoat: {
  58647. name: string;
  58648. shader: string;
  58649. };
  58650. }
  58651. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockSubSurface" {
  58652. /** @hidden */
  58653. export var pbrBlockSubSurface: {
  58654. name: string;
  58655. shader: string;
  58656. };
  58657. }
  58658. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockNormalGeometric" {
  58659. /** @hidden */
  58660. export var pbrBlockNormalGeometric: {
  58661. name: string;
  58662. shader: string;
  58663. };
  58664. }
  58665. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockNormalFinal" {
  58666. /** @hidden */
  58667. export var pbrBlockNormalFinal: {
  58668. name: string;
  58669. shader: string;
  58670. };
  58671. }
  58672. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockLightmapInit" {
  58673. /** @hidden */
  58674. export var pbrBlockLightmapInit: {
  58675. name: string;
  58676. shader: string;
  58677. };
  58678. }
  58679. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockGeometryInfo" {
  58680. /** @hidden */
  58681. export var pbrBlockGeometryInfo: {
  58682. name: string;
  58683. shader: string;
  58684. };
  58685. }
  58686. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance0" {
  58687. /** @hidden */
  58688. export var pbrBlockReflectance0: {
  58689. name: string;
  58690. shader: string;
  58691. };
  58692. }
  58693. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance" {
  58694. /** @hidden */
  58695. export var pbrBlockReflectance: {
  58696. name: string;
  58697. shader: string;
  58698. };
  58699. }
  58700. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockDirectLighting" {
  58701. /** @hidden */
  58702. export var pbrBlockDirectLighting: {
  58703. name: string;
  58704. shader: string;
  58705. };
  58706. }
  58707. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockFinalLitComponents" {
  58708. /** @hidden */
  58709. export var pbrBlockFinalLitComponents: {
  58710. name: string;
  58711. shader: string;
  58712. };
  58713. }
  58714. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockFinalUnlitComponents" {
  58715. /** @hidden */
  58716. export var pbrBlockFinalUnlitComponents: {
  58717. name: string;
  58718. shader: string;
  58719. };
  58720. }
  58721. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockFinalColorComposition" {
  58722. /** @hidden */
  58723. export var pbrBlockFinalColorComposition: {
  58724. name: string;
  58725. shader: string;
  58726. };
  58727. }
  58728. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockImageProcessing" {
  58729. /** @hidden */
  58730. export var pbrBlockImageProcessing: {
  58731. name: string;
  58732. shader: string;
  58733. };
  58734. }
  58735. declare module "babylonjs/Shaders/ShadersInclude/pbrDebug" {
  58736. /** @hidden */
  58737. export var pbrDebug: {
  58738. name: string;
  58739. shader: string;
  58740. };
  58741. }
  58742. declare module "babylonjs/Shaders/pbr.fragment" {
  58743. import "babylonjs/Shaders/ShadersInclude/prePassDeclaration";
  58744. import "babylonjs/Shaders/ShadersInclude/pbrFragmentDeclaration";
  58745. import "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration";
  58746. import "babylonjs/Shaders/ShadersInclude/pbrFragmentExtraDeclaration";
  58747. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  58748. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  58749. import "babylonjs/Shaders/ShadersInclude/pbrFragmentSamplersDeclaration";
  58750. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  58751. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  58752. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  58753. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  58754. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  58755. import "babylonjs/Shaders/ShadersInclude/subSurfaceScatteringFunctions";
  58756. import "babylonjs/Shaders/ShadersInclude/importanceSampling";
  58757. import "babylonjs/Shaders/ShadersInclude/pbrHelperFunctions";
  58758. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  58759. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  58760. import "babylonjs/Shaders/ShadersInclude/harmonicsFunctions";
  58761. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingSetupFunctions";
  58762. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFalloffFunctions";
  58763. import "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions";
  58764. import "babylonjs/Shaders/ShadersInclude/hdrFilteringFunctions";
  58765. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFunctions";
  58766. import "babylonjs/Shaders/ShadersInclude/pbrIBLFunctions";
  58767. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  58768. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  58769. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  58770. import "babylonjs/Shaders/ShadersInclude/pbrBlockAlbedoOpacity";
  58771. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflectivity";
  58772. import "babylonjs/Shaders/ShadersInclude/pbrBlockAmbientOcclusion";
  58773. import "babylonjs/Shaders/ShadersInclude/pbrBlockAlphaFresnel";
  58774. import "babylonjs/Shaders/ShadersInclude/pbrBlockAnisotropic";
  58775. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflection";
  58776. import "babylonjs/Shaders/ShadersInclude/pbrBlockSheen";
  58777. import "babylonjs/Shaders/ShadersInclude/pbrBlockClearcoat";
  58778. import "babylonjs/Shaders/ShadersInclude/pbrBlockSubSurface";
  58779. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  58780. import "babylonjs/Shaders/ShadersInclude/pbrBlockNormalGeometric";
  58781. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  58782. import "babylonjs/Shaders/ShadersInclude/pbrBlockNormalFinal";
  58783. import "babylonjs/Shaders/ShadersInclude/depthPrePass";
  58784. import "babylonjs/Shaders/ShadersInclude/pbrBlockLightmapInit";
  58785. import "babylonjs/Shaders/ShadersInclude/pbrBlockGeometryInfo";
  58786. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance0";
  58787. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance";
  58788. import "babylonjs/Shaders/ShadersInclude/pbrBlockDirectLighting";
  58789. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  58790. import "babylonjs/Shaders/ShadersInclude/pbrBlockFinalLitComponents";
  58791. import "babylonjs/Shaders/ShadersInclude/pbrBlockFinalUnlitComponents";
  58792. import "babylonjs/Shaders/ShadersInclude/pbrBlockFinalColorComposition";
  58793. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  58794. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  58795. import "babylonjs/Shaders/ShadersInclude/pbrBlockImageProcessing";
  58796. import "babylonjs/Shaders/ShadersInclude/pbrDebug";
  58797. /** @hidden */
  58798. export var pbrPixelShader: {
  58799. name: string;
  58800. shader: string;
  58801. };
  58802. }
  58803. declare module "babylonjs/Shaders/ShadersInclude/pbrVertexDeclaration" {
  58804. /** @hidden */
  58805. export var pbrVertexDeclaration: {
  58806. name: string;
  58807. shader: string;
  58808. };
  58809. }
  58810. declare module "babylonjs/Shaders/pbr.vertex" {
  58811. import "babylonjs/Shaders/ShadersInclude/pbrVertexDeclaration";
  58812. import "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration";
  58813. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  58814. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  58815. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  58816. import "babylonjs/Shaders/ShadersInclude/harmonicsFunctions";
  58817. import "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration";
  58818. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  58819. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  58820. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  58821. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  58822. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  58823. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  58824. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  58825. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  58826. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  58827. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  58828. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  58829. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  58830. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  58831. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  58832. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  58833. /** @hidden */
  58834. export var pbrVertexShader: {
  58835. name: string;
  58836. shader: string;
  58837. };
  58838. }
  58839. declare module "babylonjs/Materials/PBR/pbrBaseMaterial" {
  58840. import { Nullable } from "babylonjs/types";
  58841. import { Scene } from "babylonjs/scene";
  58842. import { Matrix } from "babylonjs/Maths/math.vector";
  58843. import { SubMesh } from "babylonjs/Meshes/subMesh";
  58844. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  58845. import { Mesh } from "babylonjs/Meshes/mesh";
  58846. import { IMaterialClearCoatDefines, PBRClearCoatConfiguration } from "babylonjs/Materials/PBR/pbrClearCoatConfiguration";
  58847. import { IMaterialAnisotropicDefines, PBRAnisotropicConfiguration } from "babylonjs/Materials/PBR/pbrAnisotropicConfiguration";
  58848. import { IMaterialBRDFDefines, PBRBRDFConfiguration } from "babylonjs/Materials/PBR/pbrBRDFConfiguration";
  58849. import { IMaterialSheenDefines, PBRSheenConfiguration } from "babylonjs/Materials/PBR/pbrSheenConfiguration";
  58850. import { IMaterialSubSurfaceDefines, PBRSubSurfaceConfiguration } from "babylonjs/Materials/PBR/pbrSubSurfaceConfiguration";
  58851. import { Color3 } from "babylonjs/Maths/math.color";
  58852. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  58853. import { Material, IMaterialCompilationOptions } from "babylonjs/Materials/material";
  58854. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  58855. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  58856. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  58857. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  58858. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  58859. import "babylonjs/Shaders/pbr.fragment";
  58860. import "babylonjs/Shaders/pbr.vertex";
  58861. import { IMaterialDetailMapDefines, DetailMapConfiguration } from "babylonjs/Materials/material.detailMapConfiguration";
  58862. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  58863. /**
  58864. * Manages the defines for the PBR Material.
  58865. * @hidden
  58866. */
  58867. export class PBRMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialClearCoatDefines, IMaterialAnisotropicDefines, IMaterialBRDFDefines, IMaterialSheenDefines, IMaterialSubSurfaceDefines, IMaterialDetailMapDefines {
  58868. PBR: boolean;
  58869. NUM_SAMPLES: string;
  58870. REALTIME_FILTERING: boolean;
  58871. MAINUV1: boolean;
  58872. MAINUV2: boolean;
  58873. UV1: boolean;
  58874. UV2: boolean;
  58875. ALBEDO: boolean;
  58876. GAMMAALBEDO: boolean;
  58877. ALBEDODIRECTUV: number;
  58878. VERTEXCOLOR: boolean;
  58879. DETAIL: boolean;
  58880. DETAILDIRECTUV: number;
  58881. DETAIL_NORMALBLENDMETHOD: number;
  58882. AMBIENT: boolean;
  58883. AMBIENTDIRECTUV: number;
  58884. AMBIENTINGRAYSCALE: boolean;
  58885. OPACITY: boolean;
  58886. VERTEXALPHA: boolean;
  58887. OPACITYDIRECTUV: number;
  58888. OPACITYRGB: boolean;
  58889. ALPHATEST: boolean;
  58890. DEPTHPREPASS: boolean;
  58891. ALPHABLEND: boolean;
  58892. ALPHAFROMALBEDO: boolean;
  58893. ALPHATESTVALUE: string;
  58894. SPECULAROVERALPHA: boolean;
  58895. RADIANCEOVERALPHA: boolean;
  58896. ALPHAFRESNEL: boolean;
  58897. LINEARALPHAFRESNEL: boolean;
  58898. PREMULTIPLYALPHA: boolean;
  58899. EMISSIVE: boolean;
  58900. EMISSIVEDIRECTUV: number;
  58901. REFLECTIVITY: boolean;
  58902. REFLECTIVITYDIRECTUV: number;
  58903. SPECULARTERM: boolean;
  58904. MICROSURFACEFROMREFLECTIVITYMAP: boolean;
  58905. MICROSURFACEAUTOMATIC: boolean;
  58906. LODBASEDMICROSFURACE: boolean;
  58907. MICROSURFACEMAP: boolean;
  58908. MICROSURFACEMAPDIRECTUV: number;
  58909. METALLICWORKFLOW: boolean;
  58910. ROUGHNESSSTOREINMETALMAPALPHA: boolean;
  58911. ROUGHNESSSTOREINMETALMAPGREEN: boolean;
  58912. METALLNESSSTOREINMETALMAPBLUE: boolean;
  58913. AOSTOREINMETALMAPRED: boolean;
  58914. METALLIC_REFLECTANCE: boolean;
  58915. METALLIC_REFLECTANCEDIRECTUV: number;
  58916. ENVIRONMENTBRDF: boolean;
  58917. ENVIRONMENTBRDF_RGBD: boolean;
  58918. NORMAL: boolean;
  58919. TANGENT: boolean;
  58920. BUMP: boolean;
  58921. BUMPDIRECTUV: number;
  58922. OBJECTSPACE_NORMALMAP: boolean;
  58923. PARALLAX: boolean;
  58924. PARALLAXOCCLUSION: boolean;
  58925. NORMALXYSCALE: boolean;
  58926. LIGHTMAP: boolean;
  58927. LIGHTMAPDIRECTUV: number;
  58928. USELIGHTMAPASSHADOWMAP: boolean;
  58929. GAMMALIGHTMAP: boolean;
  58930. RGBDLIGHTMAP: boolean;
  58931. REFLECTION: boolean;
  58932. REFLECTIONMAP_3D: boolean;
  58933. REFLECTIONMAP_SPHERICAL: boolean;
  58934. REFLECTIONMAP_PLANAR: boolean;
  58935. REFLECTIONMAP_CUBIC: boolean;
  58936. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  58937. REFLECTIONMAP_PROJECTION: boolean;
  58938. REFLECTIONMAP_SKYBOX: boolean;
  58939. REFLECTIONMAP_EXPLICIT: boolean;
  58940. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  58941. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  58942. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  58943. INVERTCUBICMAP: boolean;
  58944. USESPHERICALFROMREFLECTIONMAP: boolean;
  58945. USEIRRADIANCEMAP: boolean;
  58946. SPHERICAL_HARMONICS: boolean;
  58947. USESPHERICALINVERTEX: boolean;
  58948. REFLECTIONMAP_OPPOSITEZ: boolean;
  58949. LODINREFLECTIONALPHA: boolean;
  58950. GAMMAREFLECTION: boolean;
  58951. RGBDREFLECTION: boolean;
  58952. LINEARSPECULARREFLECTION: boolean;
  58953. RADIANCEOCCLUSION: boolean;
  58954. HORIZONOCCLUSION: boolean;
  58955. INSTANCES: boolean;
  58956. THIN_INSTANCES: boolean;
  58957. PREPASS: boolean;
  58958. SCENE_MRT_COUNT: number;
  58959. NUM_BONE_INFLUENCERS: number;
  58960. BonesPerMesh: number;
  58961. BONETEXTURE: boolean;
  58962. NONUNIFORMSCALING: boolean;
  58963. MORPHTARGETS: boolean;
  58964. MORPHTARGETS_NORMAL: boolean;
  58965. MORPHTARGETS_TANGENT: boolean;
  58966. MORPHTARGETS_UV: boolean;
  58967. NUM_MORPH_INFLUENCERS: number;
  58968. IMAGEPROCESSING: boolean;
  58969. VIGNETTE: boolean;
  58970. VIGNETTEBLENDMODEMULTIPLY: boolean;
  58971. VIGNETTEBLENDMODEOPAQUE: boolean;
  58972. TONEMAPPING: boolean;
  58973. TONEMAPPING_ACES: boolean;
  58974. CONTRAST: boolean;
  58975. COLORCURVES: boolean;
  58976. COLORGRADING: boolean;
  58977. COLORGRADING3D: boolean;
  58978. SAMPLER3DGREENDEPTH: boolean;
  58979. SAMPLER3DBGRMAP: boolean;
  58980. IMAGEPROCESSINGPOSTPROCESS: boolean;
  58981. EXPOSURE: boolean;
  58982. MULTIVIEW: boolean;
  58983. USEPHYSICALLIGHTFALLOFF: boolean;
  58984. USEGLTFLIGHTFALLOFF: boolean;
  58985. TWOSIDEDLIGHTING: boolean;
  58986. SHADOWFLOAT: boolean;
  58987. CLIPPLANE: boolean;
  58988. CLIPPLANE2: boolean;
  58989. CLIPPLANE3: boolean;
  58990. CLIPPLANE4: boolean;
  58991. CLIPPLANE5: boolean;
  58992. CLIPPLANE6: boolean;
  58993. POINTSIZE: boolean;
  58994. FOG: boolean;
  58995. LOGARITHMICDEPTH: boolean;
  58996. FORCENORMALFORWARD: boolean;
  58997. SPECULARAA: boolean;
  58998. CLEARCOAT: boolean;
  58999. CLEARCOAT_DEFAULTIOR: boolean;
  59000. CLEARCOAT_TEXTURE: boolean;
  59001. CLEARCOAT_TEXTUREDIRECTUV: number;
  59002. CLEARCOAT_BUMP: boolean;
  59003. CLEARCOAT_BUMPDIRECTUV: number;
  59004. CLEARCOAT_TINT: boolean;
  59005. CLEARCOAT_TINT_TEXTURE: boolean;
  59006. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  59007. ANISOTROPIC: boolean;
  59008. ANISOTROPIC_TEXTURE: boolean;
  59009. ANISOTROPIC_TEXTUREDIRECTUV: number;
  59010. BRDF_V_HEIGHT_CORRELATED: boolean;
  59011. MS_BRDF_ENERGY_CONSERVATION: boolean;
  59012. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  59013. SHEEN: boolean;
  59014. SHEEN_TEXTURE: boolean;
  59015. SHEEN_TEXTUREDIRECTUV: number;
  59016. SHEEN_LINKWITHALBEDO: boolean;
  59017. SHEEN_ROUGHNESS: boolean;
  59018. SHEEN_ALBEDOSCALING: boolean;
  59019. SUBSURFACE: boolean;
  59020. SS_REFRACTION: boolean;
  59021. SS_TRANSLUCENCY: boolean;
  59022. SS_SCATTERING: boolean;
  59023. SS_THICKNESSANDMASK_TEXTURE: boolean;
  59024. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  59025. SS_REFRACTIONMAP_3D: boolean;
  59026. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  59027. SS_LODINREFRACTIONALPHA: boolean;
  59028. SS_GAMMAREFRACTION: boolean;
  59029. SS_RGBDREFRACTION: boolean;
  59030. SS_LINEARSPECULARREFRACTION: boolean;
  59031. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  59032. SS_ALBEDOFORREFRACTIONTINT: boolean;
  59033. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  59034. UNLIT: boolean;
  59035. DEBUGMODE: number;
  59036. /**
  59037. * Initializes the PBR Material defines.
  59038. */
  59039. constructor();
  59040. /**
  59041. * Resets the PBR Material defines.
  59042. */
  59043. reset(): void;
  59044. }
  59045. /**
  59046. * The Physically based material base class of BJS.
  59047. *
  59048. * This offers the main features of a standard PBR material.
  59049. * For more information, please refer to the documentation :
  59050. * https://doc.babylonjs.com/how_to/physically_based_rendering
  59051. */
  59052. export abstract class PBRBaseMaterial extends PushMaterial {
  59053. /**
  59054. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  59055. */
  59056. static readonly PBRMATERIAL_OPAQUE: number;
  59057. /**
  59058. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  59059. */
  59060. static readonly PBRMATERIAL_ALPHATEST: number;
  59061. /**
  59062. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  59063. */
  59064. static readonly PBRMATERIAL_ALPHABLEND: number;
  59065. /**
  59066. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  59067. * They are also discarded below the alpha cutoff threshold to improve performances.
  59068. */
  59069. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  59070. /**
  59071. * Defines the default value of how much AO map is occluding the analytical lights
  59072. * (point spot...).
  59073. */
  59074. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  59075. /**
  59076. * PBRMaterialLightFalloff Physical: light is falling off following the inverse squared distance law.
  59077. */
  59078. static readonly LIGHTFALLOFF_PHYSICAL: number;
  59079. /**
  59080. * PBRMaterialLightFalloff gltf: light is falling off as described in the gltf moving to PBR document
  59081. * to enhance interoperability with other engines.
  59082. */
  59083. static readonly LIGHTFALLOFF_GLTF: number;
  59084. /**
  59085. * PBRMaterialLightFalloff Standard: light is falling off like in the standard material
  59086. * to enhance interoperability with other materials.
  59087. */
  59088. static readonly LIGHTFALLOFF_STANDARD: number;
  59089. /**
  59090. * Intensity of the direct lights e.g. the four lights available in your scene.
  59091. * This impacts both the direct diffuse and specular highlights.
  59092. */
  59093. protected _directIntensity: number;
  59094. /**
  59095. * Intensity of the emissive part of the material.
  59096. * This helps controlling the emissive effect without modifying the emissive color.
  59097. */
  59098. protected _emissiveIntensity: number;
  59099. /**
  59100. * Intensity of the environment e.g. how much the environment will light the object
  59101. * either through harmonics for rough material or through the refelction for shiny ones.
  59102. */
  59103. protected _environmentIntensity: number;
  59104. /**
  59105. * This is a special control allowing the reduction of the specular highlights coming from the
  59106. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  59107. */
  59108. protected _specularIntensity: number;
  59109. /**
  59110. * This stores the direct, emissive, environment, and specular light intensities into a Vector4.
  59111. */
  59112. private _lightingInfos;
  59113. /**
  59114. * Debug Control allowing disabling the bump map on this material.
  59115. */
  59116. protected _disableBumpMap: boolean;
  59117. /**
  59118. * AKA Diffuse Texture in standard nomenclature.
  59119. */
  59120. protected _albedoTexture: Nullable<BaseTexture>;
  59121. /**
  59122. * AKA Occlusion Texture in other nomenclature.
  59123. */
  59124. protected _ambientTexture: Nullable<BaseTexture>;
  59125. /**
  59126. * AKA Occlusion Texture Intensity in other nomenclature.
  59127. */
  59128. protected _ambientTextureStrength: number;
  59129. /**
  59130. * Defines how much the AO map is occluding the analytical lights (point spot...).
  59131. * 1 means it completely occludes it
  59132. * 0 mean it has no impact
  59133. */
  59134. protected _ambientTextureImpactOnAnalyticalLights: number;
  59135. /**
  59136. * Stores the alpha values in a texture.
  59137. */
  59138. protected _opacityTexture: Nullable<BaseTexture>;
  59139. /**
  59140. * Stores the reflection values in a texture.
  59141. */
  59142. protected _reflectionTexture: Nullable<BaseTexture>;
  59143. /**
  59144. * Stores the emissive values in a texture.
  59145. */
  59146. protected _emissiveTexture: Nullable<BaseTexture>;
  59147. /**
  59148. * AKA Specular texture in other nomenclature.
  59149. */
  59150. protected _reflectivityTexture: Nullable<BaseTexture>;
  59151. /**
  59152. * Used to switch from specular/glossiness to metallic/roughness workflow.
  59153. */
  59154. protected _metallicTexture: Nullable<BaseTexture>;
  59155. /**
  59156. * Specifies the metallic scalar of the metallic/roughness workflow.
  59157. * Can also be used to scale the metalness values of the metallic texture.
  59158. */
  59159. protected _metallic: Nullable<number>;
  59160. /**
  59161. * Specifies the roughness scalar of the metallic/roughness workflow.
  59162. * Can also be used to scale the roughness values of the metallic texture.
  59163. */
  59164. protected _roughness: Nullable<number>;
  59165. /**
  59166. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  59167. * By default the indexOfrefraction is used to compute F0;
  59168. *
  59169. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  59170. *
  59171. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  59172. * F90 = metallicReflectanceColor;
  59173. */
  59174. protected _metallicF0Factor: number;
  59175. /**
  59176. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  59177. * By default the F90 is always 1;
  59178. *
  59179. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  59180. *
  59181. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  59182. * F90 = metallicReflectanceColor;
  59183. */
  59184. protected _metallicReflectanceColor: Color3;
  59185. /**
  59186. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  59187. * This is multiply against the scalar values defined in the material.
  59188. */
  59189. protected _metallicReflectanceTexture: Nullable<BaseTexture>;
  59190. /**
  59191. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  59192. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  59193. */
  59194. protected _microSurfaceTexture: Nullable<BaseTexture>;
  59195. /**
  59196. * Stores surface normal data used to displace a mesh in a texture.
  59197. */
  59198. protected _bumpTexture: Nullable<BaseTexture>;
  59199. /**
  59200. * Stores the pre-calculated light information of a mesh in a texture.
  59201. */
  59202. protected _lightmapTexture: Nullable<BaseTexture>;
  59203. /**
  59204. * The color of a material in ambient lighting.
  59205. */
  59206. protected _ambientColor: Color3;
  59207. /**
  59208. * AKA Diffuse Color in other nomenclature.
  59209. */
  59210. protected _albedoColor: Color3;
  59211. /**
  59212. * AKA Specular Color in other nomenclature.
  59213. */
  59214. protected _reflectivityColor: Color3;
  59215. /**
  59216. * The color applied when light is reflected from a material.
  59217. */
  59218. protected _reflectionColor: Color3;
  59219. /**
  59220. * The color applied when light is emitted from a material.
  59221. */
  59222. protected _emissiveColor: Color3;
  59223. /**
  59224. * AKA Glossiness in other nomenclature.
  59225. */
  59226. protected _microSurface: number;
  59227. /**
  59228. * Specifies that the material will use the light map as a show map.
  59229. */
  59230. protected _useLightmapAsShadowmap: boolean;
  59231. /**
  59232. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  59233. * makes the reflect vector face the model (under horizon).
  59234. */
  59235. protected _useHorizonOcclusion: boolean;
  59236. /**
  59237. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  59238. * too much the area relying on ambient texture to define their ambient occlusion.
  59239. */
  59240. protected _useRadianceOcclusion: boolean;
  59241. /**
  59242. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  59243. */
  59244. protected _useAlphaFromAlbedoTexture: boolean;
  59245. /**
  59246. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most limunous ones).
  59247. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  59248. */
  59249. protected _useSpecularOverAlpha: boolean;
  59250. /**
  59251. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  59252. */
  59253. protected _useMicroSurfaceFromReflectivityMapAlpha: boolean;
  59254. /**
  59255. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  59256. */
  59257. protected _useRoughnessFromMetallicTextureAlpha: boolean;
  59258. /**
  59259. * Specifies if the metallic texture contains the roughness information in its green channel.
  59260. */
  59261. protected _useRoughnessFromMetallicTextureGreen: boolean;
  59262. /**
  59263. * Specifies if the metallic texture contains the metallness information in its blue channel.
  59264. */
  59265. protected _useMetallnessFromMetallicTextureBlue: boolean;
  59266. /**
  59267. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  59268. */
  59269. protected _useAmbientOcclusionFromMetallicTextureRed: boolean;
  59270. /**
  59271. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  59272. */
  59273. protected _useAmbientInGrayScale: boolean;
  59274. /**
  59275. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  59276. * The material will try to infer what glossiness each pixel should be.
  59277. */
  59278. protected _useAutoMicroSurfaceFromReflectivityMap: boolean;
  59279. /**
  59280. * Defines the falloff type used in this material.
  59281. * It by default is Physical.
  59282. */
  59283. protected _lightFalloff: number;
  59284. /**
  59285. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  59286. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  59287. */
  59288. protected _useRadianceOverAlpha: boolean;
  59289. /**
  59290. * Allows using an object space normal map (instead of tangent space).
  59291. */
  59292. protected _useObjectSpaceNormalMap: boolean;
  59293. /**
  59294. * Allows using the bump map in parallax mode.
  59295. */
  59296. protected _useParallax: boolean;
  59297. /**
  59298. * Allows using the bump map in parallax occlusion mode.
  59299. */
  59300. protected _useParallaxOcclusion: boolean;
  59301. /**
  59302. * Controls the scale bias of the parallax mode.
  59303. */
  59304. protected _parallaxScaleBias: number;
  59305. /**
  59306. * If sets to true, disables all the lights affecting the material.
  59307. */
  59308. protected _disableLighting: boolean;
  59309. /**
  59310. * Number of Simultaneous lights allowed on the material.
  59311. */
  59312. protected _maxSimultaneousLights: number;
  59313. /**
  59314. * If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  59315. */
  59316. protected _invertNormalMapX: boolean;
  59317. /**
  59318. * If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  59319. */
  59320. protected _invertNormalMapY: boolean;
  59321. /**
  59322. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  59323. */
  59324. protected _twoSidedLighting: boolean;
  59325. /**
  59326. * Defines the alpha limits in alpha test mode.
  59327. */
  59328. protected _alphaCutOff: number;
  59329. /**
  59330. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  59331. */
  59332. protected _forceAlphaTest: boolean;
  59333. /**
  59334. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  59335. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  59336. */
  59337. protected _useAlphaFresnel: boolean;
  59338. /**
  59339. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  59340. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  59341. */
  59342. protected _useLinearAlphaFresnel: boolean;
  59343. /**
  59344. * Specifies the environment BRDF texture used to comput the scale and offset roughness values
  59345. * from cos thetav and roughness:
  59346. * http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf
  59347. */
  59348. protected _environmentBRDFTexture: Nullable<BaseTexture>;
  59349. /**
  59350. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  59351. */
  59352. protected _forceIrradianceInFragment: boolean;
  59353. private _realTimeFiltering;
  59354. /**
  59355. * Enables realtime filtering on the texture.
  59356. */
  59357. get realTimeFiltering(): boolean;
  59358. set realTimeFiltering(b: boolean);
  59359. private _realTimeFilteringQuality;
  59360. /**
  59361. * Quality switch for realtime filtering
  59362. */
  59363. get realTimeFilteringQuality(): number;
  59364. set realTimeFilteringQuality(n: number);
  59365. /**
  59366. * Can this material render to several textures at once
  59367. */
  59368. get canRenderToMRT(): boolean;
  59369. /**
  59370. * Force normal to face away from face.
  59371. */
  59372. protected _forceNormalForward: boolean;
  59373. /**
  59374. * Enables specular anti aliasing in the PBR shader.
  59375. * It will both interacts on the Geometry for analytical and IBL lighting.
  59376. * It also prefilter the roughness map based on the bump values.
  59377. */
  59378. protected _enableSpecularAntiAliasing: boolean;
  59379. /**
  59380. * Default configuration related to image processing available in the PBR Material.
  59381. */
  59382. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  59383. /**
  59384. * Keep track of the image processing observer to allow dispose and replace.
  59385. */
  59386. private _imageProcessingObserver;
  59387. /**
  59388. * Attaches a new image processing configuration to the PBR Material.
  59389. * @param configuration
  59390. */
  59391. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  59392. /**
  59393. * Stores the available render targets.
  59394. */
  59395. private _renderTargets;
  59396. /**
  59397. * Sets the global ambient color for the material used in lighting calculations.
  59398. */
  59399. private _globalAmbientColor;
  59400. /**
  59401. * Enables the use of logarithmic depth buffers, which is good for wide depth buffers.
  59402. */
  59403. private _useLogarithmicDepth;
  59404. /**
  59405. * If set to true, no lighting calculations will be applied.
  59406. */
  59407. private _unlit;
  59408. private _debugMode;
  59409. /**
  59410. * @hidden
  59411. * This is reserved for the inspector.
  59412. * Defines the material debug mode.
  59413. * It helps seeing only some components of the material while troubleshooting.
  59414. */
  59415. debugMode: number;
  59416. /**
  59417. * @hidden
  59418. * This is reserved for the inspector.
  59419. * Specify from where on screen the debug mode should start.
  59420. * The value goes from -1 (full screen) to 1 (not visible)
  59421. * It helps with side by side comparison against the final render
  59422. * This defaults to -1
  59423. */
  59424. private debugLimit;
  59425. /**
  59426. * @hidden
  59427. * This is reserved for the inspector.
  59428. * As the default viewing range might not be enough (if the ambient is really small for instance)
  59429. * You can use the factor to better multiply the final value.
  59430. */
  59431. private debugFactor;
  59432. /**
  59433. * Defines the clear coat layer parameters for the material.
  59434. */
  59435. readonly clearCoat: PBRClearCoatConfiguration;
  59436. /**
  59437. * Defines the anisotropic parameters for the material.
  59438. */
  59439. readonly anisotropy: PBRAnisotropicConfiguration;
  59440. /**
  59441. * Defines the BRDF parameters for the material.
  59442. */
  59443. readonly brdf: PBRBRDFConfiguration;
  59444. /**
  59445. * Defines the Sheen parameters for the material.
  59446. */
  59447. readonly sheen: PBRSheenConfiguration;
  59448. /**
  59449. * Defines the SubSurface parameters for the material.
  59450. */
  59451. readonly subSurface: PBRSubSurfaceConfiguration;
  59452. /**
  59453. * Defines the detail map parameters for the material.
  59454. */
  59455. readonly detailMap: DetailMapConfiguration;
  59456. protected _rebuildInParallel: boolean;
  59457. /**
  59458. * Instantiates a new PBRMaterial instance.
  59459. *
  59460. * @param name The material name
  59461. * @param scene The scene the material will be use in.
  59462. */
  59463. constructor(name: string, scene: Scene);
  59464. /**
  59465. * Gets a boolean indicating that current material needs to register RTT
  59466. */
  59467. get hasRenderTargetTextures(): boolean;
  59468. /**
  59469. * Gets the name of the material class.
  59470. */
  59471. getClassName(): string;
  59472. /**
  59473. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  59474. */
  59475. get useLogarithmicDepth(): boolean;
  59476. /**
  59477. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  59478. */
  59479. set useLogarithmicDepth(value: boolean);
  59480. /**
  59481. * Returns true if alpha blending should be disabled.
  59482. */
  59483. protected get _disableAlphaBlending(): boolean;
  59484. /**
  59485. * Specifies whether or not this material should be rendered in alpha blend mode.
  59486. */
  59487. needAlphaBlending(): boolean;
  59488. /**
  59489. * Specifies whether or not this material should be rendered in alpha test mode.
  59490. */
  59491. needAlphaTesting(): boolean;
  59492. /**
  59493. * Specifies whether or not the alpha value of the albedo texture should be used for alpha blending.
  59494. */
  59495. protected _shouldUseAlphaFromAlbedoTexture(): boolean;
  59496. /**
  59497. * Gets the texture used for the alpha test.
  59498. */
  59499. getAlphaTestTexture(): Nullable<BaseTexture>;
  59500. /**
  59501. * Specifies that the submesh is ready to be used.
  59502. * @param mesh - BJS mesh.
  59503. * @param subMesh - A submesh of the BJS mesh. Used to check if it is ready.
  59504. * @param useInstances - Specifies that instances should be used.
  59505. * @returns - boolean indicating that the submesh is ready or not.
  59506. */
  59507. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  59508. /**
  59509. * Specifies if the material uses metallic roughness workflow.
  59510. * @returns boolean specifiying if the material uses metallic roughness workflow.
  59511. */
  59512. isMetallicWorkflow(): boolean;
  59513. private _prepareEffect;
  59514. private _prepareDefines;
  59515. /**
  59516. * Force shader compilation
  59517. */
  59518. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>): void;
  59519. /**
  59520. * Initializes the uniform buffer layout for the shader.
  59521. */
  59522. buildUniformLayout(): void;
  59523. /**
  59524. * Unbinds the material from the mesh
  59525. */
  59526. unbind(): void;
  59527. /**
  59528. * Binds the submesh data.
  59529. * @param world - The world matrix.
  59530. * @param mesh - The BJS mesh.
  59531. * @param subMesh - A submesh of the BJS mesh.
  59532. */
  59533. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  59534. /**
  59535. * Returns the animatable textures.
  59536. * @returns - Array of animatable textures.
  59537. */
  59538. getAnimatables(): IAnimatable[];
  59539. /**
  59540. * Returns the texture used for reflections.
  59541. * @returns - Reflection texture if present. Otherwise, returns the environment texture.
  59542. */
  59543. private _getReflectionTexture;
  59544. /**
  59545. * Returns an array of the actively used textures.
  59546. * @returns - Array of BaseTextures
  59547. */
  59548. getActiveTextures(): BaseTexture[];
  59549. /**
  59550. * Checks to see if a texture is used in the material.
  59551. * @param texture - Base texture to use.
  59552. * @returns - Boolean specifying if a texture is used in the material.
  59553. */
  59554. hasTexture(texture: BaseTexture): boolean;
  59555. /**
  59556. * Sets the required values to the prepass renderer.
  59557. * @param prePassRenderer defines the prepass renderer to setup
  59558. */
  59559. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  59560. /**
  59561. * Disposes the resources of the material.
  59562. * @param forceDisposeEffect - Forces the disposal of effects.
  59563. * @param forceDisposeTextures - Forces the disposal of all textures.
  59564. */
  59565. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  59566. }
  59567. }
  59568. declare module "babylonjs/Materials/PBR/pbrMaterial" {
  59569. import { Nullable } from "babylonjs/types";
  59570. import { Scene } from "babylonjs/scene";
  59571. import { Color3 } from "babylonjs/Maths/math.color";
  59572. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  59573. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  59574. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  59575. import { PBRBaseMaterial } from "babylonjs/Materials/PBR/pbrBaseMaterial";
  59576. /**
  59577. * The Physically based material of BJS.
  59578. *
  59579. * This offers the main features of a standard PBR material.
  59580. * For more information, please refer to the documentation :
  59581. * https://doc.babylonjs.com/how_to/physically_based_rendering
  59582. */
  59583. export class PBRMaterial extends PBRBaseMaterial {
  59584. /**
  59585. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  59586. */
  59587. static readonly PBRMATERIAL_OPAQUE: number;
  59588. /**
  59589. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  59590. */
  59591. static readonly PBRMATERIAL_ALPHATEST: number;
  59592. /**
  59593. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  59594. */
  59595. static readonly PBRMATERIAL_ALPHABLEND: number;
  59596. /**
  59597. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  59598. * They are also discarded below the alpha cutoff threshold to improve performances.
  59599. */
  59600. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  59601. /**
  59602. * Defines the default value of how much AO map is occluding the analytical lights
  59603. * (point spot...).
  59604. */
  59605. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  59606. /**
  59607. * Intensity of the direct lights e.g. the four lights available in your scene.
  59608. * This impacts both the direct diffuse and specular highlights.
  59609. */
  59610. directIntensity: number;
  59611. /**
  59612. * Intensity of the emissive part of the material.
  59613. * This helps controlling the emissive effect without modifying the emissive color.
  59614. */
  59615. emissiveIntensity: number;
  59616. /**
  59617. * Intensity of the environment e.g. how much the environment will light the object
  59618. * either through harmonics for rough material or through the refelction for shiny ones.
  59619. */
  59620. environmentIntensity: number;
  59621. /**
  59622. * This is a special control allowing the reduction of the specular highlights coming from the
  59623. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  59624. */
  59625. specularIntensity: number;
  59626. /**
  59627. * Debug Control allowing disabling the bump map on this material.
  59628. */
  59629. disableBumpMap: boolean;
  59630. /**
  59631. * AKA Diffuse Texture in standard nomenclature.
  59632. */
  59633. albedoTexture: BaseTexture;
  59634. /**
  59635. * AKA Occlusion Texture in other nomenclature.
  59636. */
  59637. ambientTexture: BaseTexture;
  59638. /**
  59639. * AKA Occlusion Texture Intensity in other nomenclature.
  59640. */
  59641. ambientTextureStrength: number;
  59642. /**
  59643. * Defines how much the AO map is occluding the analytical lights (point spot...).
  59644. * 1 means it completely occludes it
  59645. * 0 mean it has no impact
  59646. */
  59647. ambientTextureImpactOnAnalyticalLights: number;
  59648. /**
  59649. * Stores the alpha values in a texture. Use luminance if texture.getAlphaFromRGB is true.
  59650. */
  59651. opacityTexture: BaseTexture;
  59652. /**
  59653. * Stores the reflection values in a texture.
  59654. */
  59655. reflectionTexture: Nullable<BaseTexture>;
  59656. /**
  59657. * Stores the emissive values in a texture.
  59658. */
  59659. emissiveTexture: BaseTexture;
  59660. /**
  59661. * AKA Specular texture in other nomenclature.
  59662. */
  59663. reflectivityTexture: BaseTexture;
  59664. /**
  59665. * Used to switch from specular/glossiness to metallic/roughness workflow.
  59666. */
  59667. metallicTexture: BaseTexture;
  59668. /**
  59669. * Specifies the metallic scalar of the metallic/roughness workflow.
  59670. * Can also be used to scale the metalness values of the metallic texture.
  59671. */
  59672. metallic: Nullable<number>;
  59673. /**
  59674. * Specifies the roughness scalar of the metallic/roughness workflow.
  59675. * Can also be used to scale the roughness values of the metallic texture.
  59676. */
  59677. roughness: Nullable<number>;
  59678. /**
  59679. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  59680. * By default the indexOfrefraction is used to compute F0;
  59681. *
  59682. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  59683. *
  59684. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  59685. * F90 = metallicReflectanceColor;
  59686. */
  59687. metallicF0Factor: number;
  59688. /**
  59689. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  59690. * By default the F90 is always 1;
  59691. *
  59692. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  59693. *
  59694. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  59695. * F90 = metallicReflectanceColor;
  59696. */
  59697. metallicReflectanceColor: Color3;
  59698. /**
  59699. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  59700. * This is multiply against the scalar values defined in the material.
  59701. */
  59702. metallicReflectanceTexture: Nullable<BaseTexture>;
  59703. /**
  59704. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  59705. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  59706. */
  59707. microSurfaceTexture: BaseTexture;
  59708. /**
  59709. * Stores surface normal data used to displace a mesh in a texture.
  59710. */
  59711. bumpTexture: BaseTexture;
  59712. /**
  59713. * Stores the pre-calculated light information of a mesh in a texture.
  59714. */
  59715. lightmapTexture: BaseTexture;
  59716. /**
  59717. * Stores the refracted light information in a texture.
  59718. */
  59719. get refractionTexture(): Nullable<BaseTexture>;
  59720. set refractionTexture(value: Nullable<BaseTexture>);
  59721. /**
  59722. * The color of a material in ambient lighting.
  59723. */
  59724. ambientColor: Color3;
  59725. /**
  59726. * AKA Diffuse Color in other nomenclature.
  59727. */
  59728. albedoColor: Color3;
  59729. /**
  59730. * AKA Specular Color in other nomenclature.
  59731. */
  59732. reflectivityColor: Color3;
  59733. /**
  59734. * The color reflected from the material.
  59735. */
  59736. reflectionColor: Color3;
  59737. /**
  59738. * The color emitted from the material.
  59739. */
  59740. emissiveColor: Color3;
  59741. /**
  59742. * AKA Glossiness in other nomenclature.
  59743. */
  59744. microSurface: number;
  59745. /**
  59746. * Index of refraction of the material base layer.
  59747. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  59748. *
  59749. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  59750. *
  59751. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  59752. */
  59753. get indexOfRefraction(): number;
  59754. set indexOfRefraction(value: number);
  59755. /**
  59756. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  59757. */
  59758. get invertRefractionY(): boolean;
  59759. set invertRefractionY(value: boolean);
  59760. /**
  59761. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  59762. * Materials half opaque for instance using refraction could benefit from this control.
  59763. */
  59764. get linkRefractionWithTransparency(): boolean;
  59765. set linkRefractionWithTransparency(value: boolean);
  59766. /**
  59767. * If true, the light map contains occlusion information instead of lighting info.
  59768. */
  59769. useLightmapAsShadowmap: boolean;
  59770. /**
  59771. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  59772. */
  59773. useAlphaFromAlbedoTexture: boolean;
  59774. /**
  59775. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  59776. */
  59777. forceAlphaTest: boolean;
  59778. /**
  59779. * Defines the alpha limits in alpha test mode.
  59780. */
  59781. alphaCutOff: number;
  59782. /**
  59783. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  59784. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  59785. */
  59786. useSpecularOverAlpha: boolean;
  59787. /**
  59788. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  59789. */
  59790. useMicroSurfaceFromReflectivityMapAlpha: boolean;
  59791. /**
  59792. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  59793. */
  59794. useRoughnessFromMetallicTextureAlpha: boolean;
  59795. /**
  59796. * Specifies if the metallic texture contains the roughness information in its green channel.
  59797. */
  59798. useRoughnessFromMetallicTextureGreen: boolean;
  59799. /**
  59800. * Specifies if the metallic texture contains the metallness information in its blue channel.
  59801. */
  59802. useMetallnessFromMetallicTextureBlue: boolean;
  59803. /**
  59804. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  59805. */
  59806. useAmbientOcclusionFromMetallicTextureRed: boolean;
  59807. /**
  59808. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  59809. */
  59810. useAmbientInGrayScale: boolean;
  59811. /**
  59812. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  59813. * The material will try to infer what glossiness each pixel should be.
  59814. */
  59815. useAutoMicroSurfaceFromReflectivityMap: boolean;
  59816. /**
  59817. * BJS is using an harcoded light falloff based on a manually sets up range.
  59818. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  59819. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  59820. */
  59821. get usePhysicalLightFalloff(): boolean;
  59822. /**
  59823. * BJS is using an harcoded light falloff based on a manually sets up range.
  59824. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  59825. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  59826. */
  59827. set usePhysicalLightFalloff(value: boolean);
  59828. /**
  59829. * In order to support the falloff compatibility with gltf, a special mode has been added
  59830. * to reproduce the gltf light falloff.
  59831. */
  59832. get useGLTFLightFalloff(): boolean;
  59833. /**
  59834. * In order to support the falloff compatibility with gltf, a special mode has been added
  59835. * to reproduce the gltf light falloff.
  59836. */
  59837. set useGLTFLightFalloff(value: boolean);
  59838. /**
  59839. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  59840. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  59841. */
  59842. useRadianceOverAlpha: boolean;
  59843. /**
  59844. * Allows using an object space normal map (instead of tangent space).
  59845. */
  59846. useObjectSpaceNormalMap: boolean;
  59847. /**
  59848. * Allows using the bump map in parallax mode.
  59849. */
  59850. useParallax: boolean;
  59851. /**
  59852. * Allows using the bump map in parallax occlusion mode.
  59853. */
  59854. useParallaxOcclusion: boolean;
  59855. /**
  59856. * Controls the scale bias of the parallax mode.
  59857. */
  59858. parallaxScaleBias: number;
  59859. /**
  59860. * If sets to true, disables all the lights affecting the material.
  59861. */
  59862. disableLighting: boolean;
  59863. /**
  59864. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  59865. */
  59866. forceIrradianceInFragment: boolean;
  59867. /**
  59868. * Number of Simultaneous lights allowed on the material.
  59869. */
  59870. maxSimultaneousLights: number;
  59871. /**
  59872. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  59873. */
  59874. invertNormalMapX: boolean;
  59875. /**
  59876. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  59877. */
  59878. invertNormalMapY: boolean;
  59879. /**
  59880. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  59881. */
  59882. twoSidedLighting: boolean;
  59883. /**
  59884. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  59885. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  59886. */
  59887. useAlphaFresnel: boolean;
  59888. /**
  59889. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  59890. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  59891. */
  59892. useLinearAlphaFresnel: boolean;
  59893. /**
  59894. * Let user defines the brdf lookup texture used for IBL.
  59895. * A default 8bit version is embedded but you could point at :
  59896. * * Default texture: https://assets.babylonjs.com/environments/correlatedMSBRDF_RGBD.png
  59897. * * Default 16bit pixel depth texture: https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  59898. * * LEGACY Default None correlated https://assets.babylonjs.com/environments/uncorrelatedBRDF_RGBD.png
  59899. * * LEGACY Default None correlated 16bit pixel depth https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  59900. */
  59901. environmentBRDFTexture: Nullable<BaseTexture>;
  59902. /**
  59903. * Force normal to face away from face.
  59904. */
  59905. forceNormalForward: boolean;
  59906. /**
  59907. * Enables specular anti aliasing in the PBR shader.
  59908. * It will both interacts on the Geometry for analytical and IBL lighting.
  59909. * It also prefilter the roughness map based on the bump values.
  59910. */
  59911. enableSpecularAntiAliasing: boolean;
  59912. /**
  59913. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  59914. * makes the reflect vector face the model (under horizon).
  59915. */
  59916. useHorizonOcclusion: boolean;
  59917. /**
  59918. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  59919. * too much the area relying on ambient texture to define their ambient occlusion.
  59920. */
  59921. useRadianceOcclusion: boolean;
  59922. /**
  59923. * If set to true, no lighting calculations will be applied.
  59924. */
  59925. unlit: boolean;
  59926. /**
  59927. * Gets the image processing configuration used either in this material.
  59928. */
  59929. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  59930. /**
  59931. * Sets the Default image processing configuration used either in the this material.
  59932. *
  59933. * If sets to null, the scene one is in use.
  59934. */
  59935. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  59936. /**
  59937. * Gets wether the color curves effect is enabled.
  59938. */
  59939. get cameraColorCurvesEnabled(): boolean;
  59940. /**
  59941. * Sets wether the color curves effect is enabled.
  59942. */
  59943. set cameraColorCurvesEnabled(value: boolean);
  59944. /**
  59945. * Gets wether the color grading effect is enabled.
  59946. */
  59947. get cameraColorGradingEnabled(): boolean;
  59948. /**
  59949. * Gets wether the color grading effect is enabled.
  59950. */
  59951. set cameraColorGradingEnabled(value: boolean);
  59952. /**
  59953. * Gets wether tonemapping is enabled or not.
  59954. */
  59955. get cameraToneMappingEnabled(): boolean;
  59956. /**
  59957. * Sets wether tonemapping is enabled or not
  59958. */
  59959. set cameraToneMappingEnabled(value: boolean);
  59960. /**
  59961. * The camera exposure used on this material.
  59962. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  59963. * This corresponds to a photographic exposure.
  59964. */
  59965. get cameraExposure(): number;
  59966. /**
  59967. * The camera exposure used on this material.
  59968. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  59969. * This corresponds to a photographic exposure.
  59970. */
  59971. set cameraExposure(value: number);
  59972. /**
  59973. * Gets The camera contrast used on this material.
  59974. */
  59975. get cameraContrast(): number;
  59976. /**
  59977. * Sets The camera contrast used on this material.
  59978. */
  59979. set cameraContrast(value: number);
  59980. /**
  59981. * Gets the Color Grading 2D Lookup Texture.
  59982. */
  59983. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  59984. /**
  59985. * Sets the Color Grading 2D Lookup Texture.
  59986. */
  59987. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  59988. /**
  59989. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  59990. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  59991. * 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;
  59992. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  59993. */
  59994. get cameraColorCurves(): Nullable<ColorCurves>;
  59995. /**
  59996. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  59997. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  59998. * 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;
  59999. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  60000. */
  60001. set cameraColorCurves(value: Nullable<ColorCurves>);
  60002. /**
  60003. * Instantiates a new PBRMaterial instance.
  60004. *
  60005. * @param name The material name
  60006. * @param scene The scene the material will be use in.
  60007. */
  60008. constructor(name: string, scene: Scene);
  60009. /**
  60010. * Returns the name of this material class.
  60011. */
  60012. getClassName(): string;
  60013. /**
  60014. * Makes a duplicate of the current material.
  60015. * @param name - name to use for the new material.
  60016. */
  60017. clone(name: string): PBRMaterial;
  60018. /**
  60019. * Serializes this PBR Material.
  60020. * @returns - An object with the serialized material.
  60021. */
  60022. serialize(): any;
  60023. /**
  60024. * Parses a PBR Material from a serialized object.
  60025. * @param source - Serialized object.
  60026. * @param scene - BJS scene instance.
  60027. * @param rootUrl - url for the scene object
  60028. * @returns - PBRMaterial
  60029. */
  60030. static Parse(source: any, scene: Scene, rootUrl: string): PBRMaterial;
  60031. }
  60032. }
  60033. declare module "babylonjs/Misc/dds" {
  60034. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  60035. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  60036. import { Nullable } from "babylonjs/types";
  60037. import { Scene } from "babylonjs/scene";
  60038. import "babylonjs/Engines/Extensions/engine.cubeTexture";
  60039. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  60040. /**
  60041. * Direct draw surface info
  60042. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dx-graphics-dds-pguide
  60043. */
  60044. export interface DDSInfo {
  60045. /**
  60046. * Width of the texture
  60047. */
  60048. width: number;
  60049. /**
  60050. * Width of the texture
  60051. */
  60052. height: number;
  60053. /**
  60054. * Number of Mipmaps for the texture
  60055. * @see https://en.wikipedia.org/wiki/Mipmap
  60056. */
  60057. mipmapCount: number;
  60058. /**
  60059. * If the textures format is a known fourCC format
  60060. * @see https://www.fourcc.org/
  60061. */
  60062. isFourCC: boolean;
  60063. /**
  60064. * If the texture is an RGB format eg. DXGI_FORMAT_B8G8R8X8_UNORM format
  60065. */
  60066. isRGB: boolean;
  60067. /**
  60068. * If the texture is a lumincance format
  60069. */
  60070. isLuminance: boolean;
  60071. /**
  60072. * If this is a cube texture
  60073. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dds-file-layout-for-cubic-environment-maps
  60074. */
  60075. isCube: boolean;
  60076. /**
  60077. * If the texture is a compressed format eg. FOURCC_DXT1
  60078. */
  60079. isCompressed: boolean;
  60080. /**
  60081. * The dxgiFormat of the texture
  60082. * @see https://docs.microsoft.com/en-us/windows/desktop/api/dxgiformat/ne-dxgiformat-dxgi_format
  60083. */
  60084. dxgiFormat: number;
  60085. /**
  60086. * Texture type eg. Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT
  60087. */
  60088. textureType: number;
  60089. /**
  60090. * Sphericle polynomial created for the dds texture
  60091. */
  60092. sphericalPolynomial?: SphericalPolynomial;
  60093. }
  60094. /**
  60095. * Class used to provide DDS decompression tools
  60096. */
  60097. export class DDSTools {
  60098. /**
  60099. * Gets or sets a boolean indicating that LOD info is stored in alpha channel (false by default)
  60100. */
  60101. static StoreLODInAlphaChannel: boolean;
  60102. /**
  60103. * Gets DDS information from an array buffer
  60104. * @param data defines the array buffer view to read data from
  60105. * @returns the DDS information
  60106. */
  60107. static GetDDSInfo(data: ArrayBufferView): DDSInfo;
  60108. private static _FloatView;
  60109. private static _Int32View;
  60110. private static _ToHalfFloat;
  60111. private static _FromHalfFloat;
  60112. private static _GetHalfFloatAsFloatRGBAArrayBuffer;
  60113. private static _GetHalfFloatRGBAArrayBuffer;
  60114. private static _GetFloatRGBAArrayBuffer;
  60115. private static _GetFloatAsUIntRGBAArrayBuffer;
  60116. private static _GetHalfFloatAsUIntRGBAArrayBuffer;
  60117. private static _GetRGBAArrayBuffer;
  60118. private static _ExtractLongWordOrder;
  60119. private static _GetRGBArrayBuffer;
  60120. private static _GetLuminanceArrayBuffer;
  60121. /**
  60122. * Uploads DDS Levels to a Babylon Texture
  60123. * @hidden
  60124. */
  60125. static UploadDDSLevels(engine: ThinEngine, texture: InternalTexture, data: ArrayBufferView, info: DDSInfo, loadMipmaps: boolean, faces: number, lodIndex?: number, currentFace?: number): void;
  60126. }
  60127. module "babylonjs/Engines/thinEngine" {
  60128. interface ThinEngine {
  60129. /**
  60130. * Create a cube texture from prefiltered data (ie. the mipmaps contain ready to use data for PBR reflection)
  60131. * @param rootUrl defines the url where the file to load is located
  60132. * @param scene defines the current scene
  60133. * @param lodScale defines scale to apply to the mip map selection
  60134. * @param lodOffset defines offset to apply to the mip map selection
  60135. * @param onLoad defines an optional callback raised when the texture is loaded
  60136. * @param onError defines an optional callback raised if there is an issue to load the texture
  60137. * @param format defines the format of the data
  60138. * @param forcedExtension defines the extension to use to pick the right loader
  60139. * @param createPolynomials defines wheter or not to create polynomails harmonics for the texture
  60140. * @returns the cube texture as an InternalTexture
  60141. */
  60142. 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;
  60143. }
  60144. }
  60145. }
  60146. declare module "babylonjs/Materials/Textures/Loaders/ddsTextureLoader" {
  60147. import { Nullable } from "babylonjs/types";
  60148. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  60149. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  60150. /**
  60151. * Implementation of the DDS Texture Loader.
  60152. * @hidden
  60153. */
  60154. export class _DDSTextureLoader implements IInternalTextureLoader {
  60155. /**
  60156. * Defines wether the loader supports cascade loading the different faces.
  60157. */
  60158. readonly supportCascades: boolean;
  60159. /**
  60160. * This returns if the loader support the current file information.
  60161. * @param extension defines the file extension of the file being loaded
  60162. * @returns true if the loader can load the specified file
  60163. */
  60164. canLoad(extension: string): boolean;
  60165. /**
  60166. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  60167. * @param data contains the texture data
  60168. * @param texture defines the BabylonJS internal texture
  60169. * @param createPolynomials will be true if polynomials have been requested
  60170. * @param onLoad defines the callback to trigger once the texture is ready
  60171. * @param onError defines the callback to trigger in case of error
  60172. */
  60173. loadCubeData(imgs: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  60174. /**
  60175. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  60176. * @param data contains the texture data
  60177. * @param texture defines the BabylonJS internal texture
  60178. * @param callback defines the method to call once ready to upload
  60179. */
  60180. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  60181. }
  60182. }
  60183. declare module "babylonjs/Materials/Textures/Loaders/envTextureLoader" {
  60184. import { Nullable } from "babylonjs/types";
  60185. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  60186. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  60187. /**
  60188. * Implementation of the ENV Texture Loader.
  60189. * @hidden
  60190. */
  60191. export class _ENVTextureLoader implements IInternalTextureLoader {
  60192. /**
  60193. * Defines wether the loader supports cascade loading the different faces.
  60194. */
  60195. readonly supportCascades: boolean;
  60196. /**
  60197. * This returns if the loader support the current file information.
  60198. * @param extension defines the file extension of the file being loaded
  60199. * @returns true if the loader can load the specified file
  60200. */
  60201. canLoad(extension: string): boolean;
  60202. /**
  60203. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  60204. * @param data contains the texture data
  60205. * @param texture defines the BabylonJS internal texture
  60206. * @param createPolynomials will be true if polynomials have been requested
  60207. * @param onLoad defines the callback to trigger once the texture is ready
  60208. * @param onError defines the callback to trigger in case of error
  60209. */
  60210. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  60211. /**
  60212. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  60213. * @param data contains the texture data
  60214. * @param texture defines the BabylonJS internal texture
  60215. * @param callback defines the method to call once ready to upload
  60216. */
  60217. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  60218. }
  60219. }
  60220. declare module "babylonjs/Misc/khronosTextureContainer" {
  60221. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  60222. /**
  60223. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  60224. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  60225. */
  60226. export class KhronosTextureContainer {
  60227. /** contents of the KTX container file */
  60228. data: ArrayBufferView;
  60229. private static HEADER_LEN;
  60230. private static COMPRESSED_2D;
  60231. private static COMPRESSED_3D;
  60232. private static TEX_2D;
  60233. private static TEX_3D;
  60234. /**
  60235. * Gets the openGL type
  60236. */
  60237. glType: number;
  60238. /**
  60239. * Gets the openGL type size
  60240. */
  60241. glTypeSize: number;
  60242. /**
  60243. * Gets the openGL format
  60244. */
  60245. glFormat: number;
  60246. /**
  60247. * Gets the openGL internal format
  60248. */
  60249. glInternalFormat: number;
  60250. /**
  60251. * Gets the base internal format
  60252. */
  60253. glBaseInternalFormat: number;
  60254. /**
  60255. * Gets image width in pixel
  60256. */
  60257. pixelWidth: number;
  60258. /**
  60259. * Gets image height in pixel
  60260. */
  60261. pixelHeight: number;
  60262. /**
  60263. * Gets image depth in pixels
  60264. */
  60265. pixelDepth: number;
  60266. /**
  60267. * Gets the number of array elements
  60268. */
  60269. numberOfArrayElements: number;
  60270. /**
  60271. * Gets the number of faces
  60272. */
  60273. numberOfFaces: number;
  60274. /**
  60275. * Gets the number of mipmap levels
  60276. */
  60277. numberOfMipmapLevels: number;
  60278. /**
  60279. * Gets the bytes of key value data
  60280. */
  60281. bytesOfKeyValueData: number;
  60282. /**
  60283. * Gets the load type
  60284. */
  60285. loadType: number;
  60286. /**
  60287. * If the container has been made invalid (eg. constructor failed to correctly load array buffer)
  60288. */
  60289. isInvalid: boolean;
  60290. /**
  60291. * Creates a new KhronosTextureContainer
  60292. * @param data contents of the KTX container file
  60293. * @param facesExpected should be either 1 or 6, based whether a cube texture or or
  60294. * @param threeDExpected provision for indicating that data should be a 3D texture, not implemented
  60295. * @param textureArrayExpected provision for indicating that data should be a texture array, not implemented
  60296. */
  60297. constructor(
  60298. /** contents of the KTX container file */
  60299. data: ArrayBufferView, facesExpected: number, threeDExpected?: boolean, textureArrayExpected?: boolean);
  60300. /**
  60301. * Uploads KTX content to a Babylon Texture.
  60302. * It is assumed that the texture has already been created & is currently bound
  60303. * @hidden
  60304. */
  60305. uploadLevels(texture: InternalTexture, loadMipmaps: boolean): void;
  60306. private _upload2DCompressedLevels;
  60307. /**
  60308. * Checks if the given data starts with a KTX file identifier.
  60309. * @param data the data to check
  60310. * @returns true if the data is a KTX file or false otherwise
  60311. */
  60312. static IsValid(data: ArrayBufferView): boolean;
  60313. }
  60314. }
  60315. declare module "babylonjs/Misc/workerPool" {
  60316. import { IDisposable } from "babylonjs/scene";
  60317. /**
  60318. * Helper class to push actions to a pool of workers.
  60319. */
  60320. export class WorkerPool implements IDisposable {
  60321. private _workerInfos;
  60322. private _pendingActions;
  60323. /**
  60324. * Constructor
  60325. * @param workers Array of workers to use for actions
  60326. */
  60327. constructor(workers: Array<Worker>);
  60328. /**
  60329. * Terminates all workers and clears any pending actions.
  60330. */
  60331. dispose(): void;
  60332. /**
  60333. * Pushes an action to the worker pool. If all the workers are active, the action will be
  60334. * pended until a worker has completed its action.
  60335. * @param action The action to perform. Call onComplete when the action is complete.
  60336. */
  60337. push(action: (worker: Worker, onComplete: () => void) => void): void;
  60338. private _execute;
  60339. }
  60340. }
  60341. declare module "babylonjs/Misc/khronosTextureContainer2" {
  60342. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  60343. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  60344. /**
  60345. * Class for loading KTX2 files
  60346. * @hidden
  60347. */
  60348. export class KhronosTextureContainer2 {
  60349. private static _WorkerPoolPromise?;
  60350. private static _Initialized;
  60351. private static _Ktx2Decoder;
  60352. /**
  60353. * URL to use when loading the KTX2 decoder module
  60354. */
  60355. static JSModuleURL: string;
  60356. /**
  60357. * Default number of workers used to handle data decoding
  60358. */
  60359. static DefaultNumWorkers: number;
  60360. private static GetDefaultNumWorkers;
  60361. private _engine;
  60362. private static _CreateWorkerPool;
  60363. /**
  60364. * Constructor
  60365. * @param numWorkers The number of workers for async operations. Specify `0` to disable web workers and run synchronously in the current context.
  60366. */
  60367. constructor(engine: ThinEngine, numWorkers?: number);
  60368. uploadAsync(data: ArrayBufferView, internalTexture: InternalTexture): Promise<void>;
  60369. /**
  60370. * Stop all async operations and release resources.
  60371. */
  60372. dispose(): void;
  60373. protected _createTexture(data: any, internalTexture: InternalTexture): void;
  60374. /**
  60375. * Checks if the given data starts with a KTX2 file identifier.
  60376. * @param data the data to check
  60377. * @returns true if the data is a KTX2 file or false otherwise
  60378. */
  60379. static IsValid(data: ArrayBufferView): boolean;
  60380. }
  60381. export function workerFunc(): void;
  60382. }
  60383. declare module "babylonjs/Materials/Textures/Loaders/ktxTextureLoader" {
  60384. import { Nullable } from "babylonjs/types";
  60385. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  60386. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  60387. /**
  60388. * Implementation of the KTX Texture Loader.
  60389. * @hidden
  60390. */
  60391. export class _KTXTextureLoader implements IInternalTextureLoader {
  60392. /**
  60393. * Defines wether the loader supports cascade loading the different faces.
  60394. */
  60395. readonly supportCascades: boolean;
  60396. /**
  60397. * This returns if the loader support the current file information.
  60398. * @param extension defines the file extension of the file being loaded
  60399. * @param mimeType defines the optional mime type of the file being loaded
  60400. * @returns true if the loader can load the specified file
  60401. */
  60402. canLoad(extension: string, mimeType?: string): boolean;
  60403. /**
  60404. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  60405. * @param data contains the texture data
  60406. * @param texture defines the BabylonJS internal texture
  60407. * @param createPolynomials will be true if polynomials have been requested
  60408. * @param onLoad defines the callback to trigger once the texture is ready
  60409. * @param onError defines the callback to trigger in case of error
  60410. */
  60411. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  60412. /**
  60413. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  60414. * @param data contains the texture data
  60415. * @param texture defines the BabylonJS internal texture
  60416. * @param callback defines the method to call once ready to upload
  60417. */
  60418. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed: boolean) => void): void;
  60419. }
  60420. }
  60421. declare module "babylonjs/Helpers/sceneHelpers" {
  60422. import { Nullable } from "babylonjs/types";
  60423. import { Mesh } from "babylonjs/Meshes/mesh";
  60424. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  60425. import { IEnvironmentHelperOptions, EnvironmentHelper } from "babylonjs/Helpers/environmentHelper";
  60426. import { VRExperienceHelperOptions, VRExperienceHelper } from "babylonjs/Cameras/VR/vrExperienceHelper";
  60427. import "babylonjs/Materials/Textures/Loaders/ddsTextureLoader";
  60428. import "babylonjs/Materials/Textures/Loaders/envTextureLoader";
  60429. import "babylonjs/Materials/Textures/Loaders/ktxTextureLoader";
  60430. import "babylonjs/Meshes/Builders/boxBuilder";
  60431. import { WebXRDefaultExperience, WebXRDefaultExperienceOptions } from "babylonjs/XR/webXRDefaultExperience";
  60432. /** @hidden */
  60433. export var _forceSceneHelpersToBundle: boolean;
  60434. module "babylonjs/scene" {
  60435. interface Scene {
  60436. /**
  60437. * Creates a default light for the scene.
  60438. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-light
  60439. * @param replace has the default false, when true replaces the existing lights in the scene with a hemispheric light
  60440. */
  60441. createDefaultLight(replace?: boolean): void;
  60442. /**
  60443. * Creates a default camera for the scene.
  60444. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-camera
  60445. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  60446. * @param replace has default false, when true replaces the active camera in the scene
  60447. * @param attachCameraControls has default false, when true attaches camera controls to the canvas.
  60448. */
  60449. createDefaultCamera(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  60450. /**
  60451. * Creates a default camera and a default light.
  60452. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-camera-or-light
  60453. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  60454. * @param replace has the default false, when true replaces the active camera/light in the scene
  60455. * @param attachCameraControls has the default false, when true attaches camera controls to the canvas.
  60456. */
  60457. createDefaultCameraOrLight(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  60458. /**
  60459. * Creates a new sky box
  60460. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-skybox
  60461. * @param environmentTexture defines the texture to use as environment texture
  60462. * @param pbr has default false which requires the StandardMaterial to be used, when true PBRMaterial must be used
  60463. * @param scale defines the overall scale of the skybox
  60464. * @param blur is only available when pbr is true, default is 0, no blur, maximum value is 1
  60465. * @param setGlobalEnvTexture has default true indicating that scene.environmentTexture must match the current skybox texture
  60466. * @returns a new mesh holding the sky box
  60467. */
  60468. createDefaultSkybox(environmentTexture?: BaseTexture, pbr?: boolean, scale?: number, blur?: number, setGlobalEnvTexture?: boolean): Nullable<Mesh>;
  60469. /**
  60470. * Creates a new environment
  60471. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-environment
  60472. * @param options defines the options you can use to configure the environment
  60473. * @returns the new EnvironmentHelper
  60474. */
  60475. createDefaultEnvironment(options?: Partial<IEnvironmentHelperOptions>): Nullable<EnvironmentHelper>;
  60476. /**
  60477. * Creates a new VREXperienceHelper
  60478. * @see https://doc.babylonjs.com/how_to/webvr_helper
  60479. * @param webVROptions defines the options used to create the new VREXperienceHelper
  60480. * @returns a new VREXperienceHelper
  60481. */
  60482. createDefaultVRExperience(webVROptions?: VRExperienceHelperOptions): VRExperienceHelper;
  60483. /**
  60484. * Creates a new WebXRDefaultExperience
  60485. * @see https://doc.babylonjs.com/how_to/introduction_to_webxr
  60486. * @param options experience options
  60487. * @returns a promise for a new WebXRDefaultExperience
  60488. */
  60489. createDefaultXRExperienceAsync(options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  60490. }
  60491. }
  60492. }
  60493. declare module "babylonjs/Helpers/videoDome" {
  60494. import { Scene } from "babylonjs/scene";
  60495. import { VideoTexture } from "babylonjs/Materials/Textures/videoTexture";
  60496. import { TextureDome } from "babylonjs/Helpers/textureDome";
  60497. /**
  60498. * Display a 360/180 degree video on an approximately spherical surface, useful for VR applications or skyboxes.
  60499. * As a subclass of TransformNode, this allow parenting to the camera or multiple videos with different locations in the scene.
  60500. * This class achieves its effect with a VideoTexture and a correctly configured BackgroundMaterial on an inverted sphere.
  60501. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  60502. */
  60503. export class VideoDome extends TextureDome<VideoTexture> {
  60504. /**
  60505. * Define the video source as a Monoscopic panoramic 360 video.
  60506. */
  60507. static readonly MODE_MONOSCOPIC: number;
  60508. /**
  60509. * Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  60510. */
  60511. static readonly MODE_TOPBOTTOM: number;
  60512. /**
  60513. * Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  60514. */
  60515. static readonly MODE_SIDEBYSIDE: number;
  60516. /**
  60517. * Get the video texture associated with this video dome
  60518. */
  60519. get videoTexture(): VideoTexture;
  60520. /**
  60521. * Get the video mode of this dome
  60522. */
  60523. get videoMode(): number;
  60524. /**
  60525. * Set the video mode of this dome.
  60526. * @see textureMode
  60527. */
  60528. set videoMode(value: number);
  60529. protected _initTexture(urlsOrElement: string | string[] | HTMLVideoElement, scene: Scene, options: any): VideoTexture;
  60530. }
  60531. }
  60532. declare module "babylonjs/Helpers/index" {
  60533. export * from "babylonjs/Helpers/environmentHelper";
  60534. export * from "babylonjs/Helpers/photoDome";
  60535. export * from "babylonjs/Helpers/sceneHelpers";
  60536. export * from "babylonjs/Helpers/videoDome";
  60537. }
  60538. declare module "babylonjs/Instrumentation/engineInstrumentation" {
  60539. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  60540. import { IDisposable } from "babylonjs/scene";
  60541. import { Engine } from "babylonjs/Engines/engine";
  60542. /**
  60543. * This class can be used to get instrumentation data from a Babylon engine
  60544. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  60545. */
  60546. export class EngineInstrumentation implements IDisposable {
  60547. /**
  60548. * Define the instrumented engine.
  60549. */
  60550. engine: Engine;
  60551. private _captureGPUFrameTime;
  60552. private _gpuFrameTimeToken;
  60553. private _gpuFrameTime;
  60554. private _captureShaderCompilationTime;
  60555. private _shaderCompilationTime;
  60556. private _onBeginFrameObserver;
  60557. private _onEndFrameObserver;
  60558. private _onBeforeShaderCompilationObserver;
  60559. private _onAfterShaderCompilationObserver;
  60560. /**
  60561. * Gets the perf counter used for GPU frame time
  60562. */
  60563. get gpuFrameTimeCounter(): PerfCounter;
  60564. /**
  60565. * Gets the GPU frame time capture status
  60566. */
  60567. get captureGPUFrameTime(): boolean;
  60568. /**
  60569. * Enable or disable the GPU frame time capture
  60570. */
  60571. set captureGPUFrameTime(value: boolean);
  60572. /**
  60573. * Gets the perf counter used for shader compilation time
  60574. */
  60575. get shaderCompilationTimeCounter(): PerfCounter;
  60576. /**
  60577. * Gets the shader compilation time capture status
  60578. */
  60579. get captureShaderCompilationTime(): boolean;
  60580. /**
  60581. * Enable or disable the shader compilation time capture
  60582. */
  60583. set captureShaderCompilationTime(value: boolean);
  60584. /**
  60585. * Instantiates a new engine instrumentation.
  60586. * This class can be used to get instrumentation data from a Babylon engine
  60587. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  60588. * @param engine Defines the engine to instrument
  60589. */
  60590. constructor(
  60591. /**
  60592. * Define the instrumented engine.
  60593. */
  60594. engine: Engine);
  60595. /**
  60596. * Dispose and release associated resources.
  60597. */
  60598. dispose(): void;
  60599. }
  60600. }
  60601. declare module "babylonjs/Instrumentation/sceneInstrumentation" {
  60602. import { Scene, IDisposable } from "babylonjs/scene";
  60603. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  60604. /**
  60605. * This class can be used to get instrumentation data from a Babylon engine
  60606. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  60607. */
  60608. export class SceneInstrumentation implements IDisposable {
  60609. /**
  60610. * Defines the scene to instrument
  60611. */
  60612. scene: Scene;
  60613. private _captureActiveMeshesEvaluationTime;
  60614. private _activeMeshesEvaluationTime;
  60615. private _captureRenderTargetsRenderTime;
  60616. private _renderTargetsRenderTime;
  60617. private _captureFrameTime;
  60618. private _frameTime;
  60619. private _captureRenderTime;
  60620. private _renderTime;
  60621. private _captureInterFrameTime;
  60622. private _interFrameTime;
  60623. private _captureParticlesRenderTime;
  60624. private _particlesRenderTime;
  60625. private _captureSpritesRenderTime;
  60626. private _spritesRenderTime;
  60627. private _capturePhysicsTime;
  60628. private _physicsTime;
  60629. private _captureAnimationsTime;
  60630. private _animationsTime;
  60631. private _captureCameraRenderTime;
  60632. private _cameraRenderTime;
  60633. private _onBeforeActiveMeshesEvaluationObserver;
  60634. private _onAfterActiveMeshesEvaluationObserver;
  60635. private _onBeforeRenderTargetsRenderObserver;
  60636. private _onAfterRenderTargetsRenderObserver;
  60637. private _onAfterRenderObserver;
  60638. private _onBeforeDrawPhaseObserver;
  60639. private _onAfterDrawPhaseObserver;
  60640. private _onBeforeAnimationsObserver;
  60641. private _onBeforeParticlesRenderingObserver;
  60642. private _onAfterParticlesRenderingObserver;
  60643. private _onBeforeSpritesRenderingObserver;
  60644. private _onAfterSpritesRenderingObserver;
  60645. private _onBeforePhysicsObserver;
  60646. private _onAfterPhysicsObserver;
  60647. private _onAfterAnimationsObserver;
  60648. private _onBeforeCameraRenderObserver;
  60649. private _onAfterCameraRenderObserver;
  60650. /**
  60651. * Gets the perf counter used for active meshes evaluation time
  60652. */
  60653. get activeMeshesEvaluationTimeCounter(): PerfCounter;
  60654. /**
  60655. * Gets the active meshes evaluation time capture status
  60656. */
  60657. get captureActiveMeshesEvaluationTime(): boolean;
  60658. /**
  60659. * Enable or disable the active meshes evaluation time capture
  60660. */
  60661. set captureActiveMeshesEvaluationTime(value: boolean);
  60662. /**
  60663. * Gets the perf counter used for render targets render time
  60664. */
  60665. get renderTargetsRenderTimeCounter(): PerfCounter;
  60666. /**
  60667. * Gets the render targets render time capture status
  60668. */
  60669. get captureRenderTargetsRenderTime(): boolean;
  60670. /**
  60671. * Enable or disable the render targets render time capture
  60672. */
  60673. set captureRenderTargetsRenderTime(value: boolean);
  60674. /**
  60675. * Gets the perf counter used for particles render time
  60676. */
  60677. get particlesRenderTimeCounter(): PerfCounter;
  60678. /**
  60679. * Gets the particles render time capture status
  60680. */
  60681. get captureParticlesRenderTime(): boolean;
  60682. /**
  60683. * Enable or disable the particles render time capture
  60684. */
  60685. set captureParticlesRenderTime(value: boolean);
  60686. /**
  60687. * Gets the perf counter used for sprites render time
  60688. */
  60689. get spritesRenderTimeCounter(): PerfCounter;
  60690. /**
  60691. * Gets the sprites render time capture status
  60692. */
  60693. get captureSpritesRenderTime(): boolean;
  60694. /**
  60695. * Enable or disable the sprites render time capture
  60696. */
  60697. set captureSpritesRenderTime(value: boolean);
  60698. /**
  60699. * Gets the perf counter used for physics time
  60700. */
  60701. get physicsTimeCounter(): PerfCounter;
  60702. /**
  60703. * Gets the physics time capture status
  60704. */
  60705. get capturePhysicsTime(): boolean;
  60706. /**
  60707. * Enable or disable the physics time capture
  60708. */
  60709. set capturePhysicsTime(value: boolean);
  60710. /**
  60711. * Gets the perf counter used for animations time
  60712. */
  60713. get animationsTimeCounter(): PerfCounter;
  60714. /**
  60715. * Gets the animations time capture status
  60716. */
  60717. get captureAnimationsTime(): boolean;
  60718. /**
  60719. * Enable or disable the animations time capture
  60720. */
  60721. set captureAnimationsTime(value: boolean);
  60722. /**
  60723. * Gets the perf counter used for frame time capture
  60724. */
  60725. get frameTimeCounter(): PerfCounter;
  60726. /**
  60727. * Gets the frame time capture status
  60728. */
  60729. get captureFrameTime(): boolean;
  60730. /**
  60731. * Enable or disable the frame time capture
  60732. */
  60733. set captureFrameTime(value: boolean);
  60734. /**
  60735. * Gets the perf counter used for inter-frames time capture
  60736. */
  60737. get interFrameTimeCounter(): PerfCounter;
  60738. /**
  60739. * Gets the inter-frames time capture status
  60740. */
  60741. get captureInterFrameTime(): boolean;
  60742. /**
  60743. * Enable or disable the inter-frames time capture
  60744. */
  60745. set captureInterFrameTime(value: boolean);
  60746. /**
  60747. * Gets the perf counter used for render time capture
  60748. */
  60749. get renderTimeCounter(): PerfCounter;
  60750. /**
  60751. * Gets the render time capture status
  60752. */
  60753. get captureRenderTime(): boolean;
  60754. /**
  60755. * Enable or disable the render time capture
  60756. */
  60757. set captureRenderTime(value: boolean);
  60758. /**
  60759. * Gets the perf counter used for camera render time capture
  60760. */
  60761. get cameraRenderTimeCounter(): PerfCounter;
  60762. /**
  60763. * Gets the camera render time capture status
  60764. */
  60765. get captureCameraRenderTime(): boolean;
  60766. /**
  60767. * Enable or disable the camera render time capture
  60768. */
  60769. set captureCameraRenderTime(value: boolean);
  60770. /**
  60771. * Gets the perf counter used for draw calls
  60772. */
  60773. get drawCallsCounter(): PerfCounter;
  60774. /**
  60775. * Instantiates a new scene instrumentation.
  60776. * This class can be used to get instrumentation data from a Babylon engine
  60777. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  60778. * @param scene Defines the scene to instrument
  60779. */
  60780. constructor(
  60781. /**
  60782. * Defines the scene to instrument
  60783. */
  60784. scene: Scene);
  60785. /**
  60786. * Dispose and release associated resources.
  60787. */
  60788. dispose(): void;
  60789. }
  60790. }
  60791. declare module "babylonjs/Instrumentation/index" {
  60792. export * from "babylonjs/Instrumentation/engineInstrumentation";
  60793. export * from "babylonjs/Instrumentation/sceneInstrumentation";
  60794. export * from "babylonjs/Instrumentation/timeToken";
  60795. }
  60796. declare module "babylonjs/Shaders/glowMapGeneration.fragment" {
  60797. /** @hidden */
  60798. export var glowMapGenerationPixelShader: {
  60799. name: string;
  60800. shader: string;
  60801. };
  60802. }
  60803. declare module "babylonjs/Shaders/glowMapGeneration.vertex" {
  60804. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  60805. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  60806. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  60807. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  60808. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  60809. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  60810. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  60811. /** @hidden */
  60812. export var glowMapGenerationVertexShader: {
  60813. name: string;
  60814. shader: string;
  60815. };
  60816. }
  60817. declare module "babylonjs/Layers/effectLayer" {
  60818. import { Observable } from "babylonjs/Misc/observable";
  60819. import { Nullable } from "babylonjs/types";
  60820. import { Camera } from "babylonjs/Cameras/camera";
  60821. import { Scene } from "babylonjs/scene";
  60822. import { ISize } from "babylonjs/Maths/math.size";
  60823. import { Color4 } from "babylonjs/Maths/math.color";
  60824. import { Engine } from "babylonjs/Engines/engine";
  60825. import { SubMesh } from "babylonjs/Meshes/subMesh";
  60826. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  60827. import { Mesh } from "babylonjs/Meshes/mesh";
  60828. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  60829. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  60830. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  60831. import { Effect } from "babylonjs/Materials/effect";
  60832. import { Material } from "babylonjs/Materials/material";
  60833. import "babylonjs/Shaders/glowMapGeneration.fragment";
  60834. import "babylonjs/Shaders/glowMapGeneration.vertex";
  60835. /**
  60836. * Effect layer options. This helps customizing the behaviour
  60837. * of the effect layer.
  60838. */
  60839. export interface IEffectLayerOptions {
  60840. /**
  60841. * Multiplication factor apply to the canvas size to compute the render target size
  60842. * used to generated the objects (the smaller the faster).
  60843. */
  60844. mainTextureRatio: number;
  60845. /**
  60846. * Enforces a fixed size texture to ensure effect stability across devices.
  60847. */
  60848. mainTextureFixedSize?: number;
  60849. /**
  60850. * Alpha blending mode used to apply the blur. Default depends of the implementation.
  60851. */
  60852. alphaBlendingMode: number;
  60853. /**
  60854. * The camera attached to the layer.
  60855. */
  60856. camera: Nullable<Camera>;
  60857. /**
  60858. * The rendering group to draw the layer in.
  60859. */
  60860. renderingGroupId: number;
  60861. }
  60862. /**
  60863. * The effect layer Helps adding post process effect blended with the main pass.
  60864. *
  60865. * This can be for instance use to generate glow or higlight effects on the scene.
  60866. *
  60867. * The effect layer class can not be used directly and is intented to inherited from to be
  60868. * customized per effects.
  60869. */
  60870. export abstract class EffectLayer {
  60871. private _vertexBuffers;
  60872. private _indexBuffer;
  60873. private _cachedDefines;
  60874. private _effectLayerMapGenerationEffect;
  60875. private _effectLayerOptions;
  60876. private _mergeEffect;
  60877. protected _scene: Scene;
  60878. protected _engine: Engine;
  60879. protected _maxSize: number;
  60880. protected _mainTextureDesiredSize: ISize;
  60881. protected _mainTexture: RenderTargetTexture;
  60882. protected _shouldRender: boolean;
  60883. protected _postProcesses: PostProcess[];
  60884. protected _textures: BaseTexture[];
  60885. protected _emissiveTextureAndColor: {
  60886. texture: Nullable<BaseTexture>;
  60887. color: Color4;
  60888. };
  60889. /**
  60890. * The name of the layer
  60891. */
  60892. name: string;
  60893. /**
  60894. * The clear color of the texture used to generate the glow map.
  60895. */
  60896. neutralColor: Color4;
  60897. /**
  60898. * Specifies whether the highlight layer is enabled or not.
  60899. */
  60900. isEnabled: boolean;
  60901. /**
  60902. * Gets the camera attached to the layer.
  60903. */
  60904. get camera(): Nullable<Camera>;
  60905. /**
  60906. * Gets the rendering group id the layer should render in.
  60907. */
  60908. get renderingGroupId(): number;
  60909. set renderingGroupId(renderingGroupId: number);
  60910. /**
  60911. * An event triggered when the effect layer has been disposed.
  60912. */
  60913. onDisposeObservable: Observable<EffectLayer>;
  60914. /**
  60915. * An event triggered when the effect layer is about rendering the main texture with the glowy parts.
  60916. */
  60917. onBeforeRenderMainTextureObservable: Observable<EffectLayer>;
  60918. /**
  60919. * An event triggered when the generated texture is being merged in the scene.
  60920. */
  60921. onBeforeComposeObservable: Observable<EffectLayer>;
  60922. /**
  60923. * An event triggered when the mesh is rendered into the effect render target.
  60924. */
  60925. onBeforeRenderMeshToEffect: Observable<AbstractMesh>;
  60926. /**
  60927. * An event triggered after the mesh has been rendered into the effect render target.
  60928. */
  60929. onAfterRenderMeshToEffect: Observable<AbstractMesh>;
  60930. /**
  60931. * An event triggered when the generated texture has been merged in the scene.
  60932. */
  60933. onAfterComposeObservable: Observable<EffectLayer>;
  60934. /**
  60935. * An event triggered when the efffect layer changes its size.
  60936. */
  60937. onSizeChangedObservable: Observable<EffectLayer>;
  60938. /** @hidden */
  60939. static _SceneComponentInitialization: (scene: Scene) => void;
  60940. /**
  60941. * Instantiates a new effect Layer and references it in the scene.
  60942. * @param name The name of the layer
  60943. * @param scene The scene to use the layer in
  60944. */
  60945. constructor(
  60946. /** The Friendly of the effect in the scene */
  60947. name: string, scene: Scene);
  60948. /**
  60949. * Get the effect name of the layer.
  60950. * @return The effect name
  60951. */
  60952. abstract getEffectName(): string;
  60953. /**
  60954. * Checks for the readiness of the element composing the layer.
  60955. * @param subMesh the mesh to check for
  60956. * @param useInstances specify whether or not to use instances to render the mesh
  60957. * @return true if ready otherwise, false
  60958. */
  60959. abstract isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  60960. /**
  60961. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  60962. * @returns true if the effect requires stencil during the main canvas render pass.
  60963. */
  60964. abstract needStencil(): boolean;
  60965. /**
  60966. * Create the merge effect. This is the shader use to blit the information back
  60967. * to the main canvas at the end of the scene rendering.
  60968. * @returns The effect containing the shader used to merge the effect on the main canvas
  60969. */
  60970. protected abstract _createMergeEffect(): Effect;
  60971. /**
  60972. * Creates the render target textures and post processes used in the effect layer.
  60973. */
  60974. protected abstract _createTextureAndPostProcesses(): void;
  60975. /**
  60976. * Implementation specific of rendering the generating effect on the main canvas.
  60977. * @param effect The effect used to render through
  60978. */
  60979. protected abstract _internalRender(effect: Effect): void;
  60980. /**
  60981. * Sets the required values for both the emissive texture and and the main color.
  60982. */
  60983. protected abstract _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  60984. /**
  60985. * Free any resources and references associated to a mesh.
  60986. * Internal use
  60987. * @param mesh The mesh to free.
  60988. */
  60989. abstract _disposeMesh(mesh: Mesh): void;
  60990. /**
  60991. * Serializes this layer (Glow or Highlight for example)
  60992. * @returns a serialized layer object
  60993. */
  60994. abstract serialize?(): any;
  60995. /**
  60996. * Initializes the effect layer with the required options.
  60997. * @param options Sets of none mandatory options to use with the layer (see IEffectLayerOptions for more information)
  60998. */
  60999. protected _init(options: Partial<IEffectLayerOptions>): void;
  61000. /**
  61001. * Generates the index buffer of the full screen quad blending to the main canvas.
  61002. */
  61003. private _generateIndexBuffer;
  61004. /**
  61005. * Generates the vertex buffer of the full screen quad blending to the main canvas.
  61006. */
  61007. private _generateVertexBuffer;
  61008. /**
  61009. * Sets the main texture desired size which is the closest power of two
  61010. * of the engine canvas size.
  61011. */
  61012. private _setMainTextureSize;
  61013. /**
  61014. * Creates the main texture for the effect layer.
  61015. */
  61016. protected _createMainTexture(): void;
  61017. /**
  61018. * Adds specific effects defines.
  61019. * @param defines The defines to add specifics to.
  61020. */
  61021. protected _addCustomEffectDefines(defines: string[]): void;
  61022. /**
  61023. * Checks for the readiness of the element composing the layer.
  61024. * @param subMesh the mesh to check for
  61025. * @param useInstances specify whether or not to use instances to render the mesh
  61026. * @param emissiveTexture the associated emissive texture used to generate the glow
  61027. * @return true if ready otherwise, false
  61028. */
  61029. protected _isReady(subMesh: SubMesh, useInstances: boolean, emissiveTexture: Nullable<BaseTexture>): boolean;
  61030. /**
  61031. * Renders the glowing part of the scene by blending the blurred glowing meshes on top of the rendered scene.
  61032. */
  61033. render(): void;
  61034. /**
  61035. * Determine if a given mesh will be used in the current effect.
  61036. * @param mesh mesh to test
  61037. * @returns true if the mesh will be used
  61038. */
  61039. hasMesh(mesh: AbstractMesh): boolean;
  61040. /**
  61041. * Returns true if the layer contains information to display, otherwise false.
  61042. * @returns true if the glow layer should be rendered
  61043. */
  61044. shouldRender(): boolean;
  61045. /**
  61046. * Returns true if the mesh should render, otherwise false.
  61047. * @param mesh The mesh to render
  61048. * @returns true if it should render otherwise false
  61049. */
  61050. protected _shouldRenderMesh(mesh: AbstractMesh): boolean;
  61051. /**
  61052. * Returns true if the mesh can be rendered, otherwise false.
  61053. * @param mesh The mesh to render
  61054. * @param material The material used on the mesh
  61055. * @returns true if it can be rendered otherwise false
  61056. */
  61057. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  61058. /**
  61059. * Returns true if the mesh should render, otherwise false.
  61060. * @param mesh The mesh to render
  61061. * @returns true if it should render otherwise false
  61062. */
  61063. protected _shouldRenderEmissiveTextureForMesh(): boolean;
  61064. /**
  61065. * Renders the submesh passed in parameter to the generation map.
  61066. */
  61067. protected _renderSubMesh(subMesh: SubMesh, enableAlphaMode?: boolean): void;
  61068. /**
  61069. * Defines whether the current material of the mesh should be use to render the effect.
  61070. * @param mesh defines the current mesh to render
  61071. */
  61072. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  61073. /**
  61074. * Rebuild the required buffers.
  61075. * @hidden Internal use only.
  61076. */
  61077. _rebuild(): void;
  61078. /**
  61079. * Dispose only the render target textures and post process.
  61080. */
  61081. private _disposeTextureAndPostProcesses;
  61082. /**
  61083. * Dispose the highlight layer and free resources.
  61084. */
  61085. dispose(): void;
  61086. /**
  61087. * Gets the class name of the effect layer
  61088. * @returns the string with the class name of the effect layer
  61089. */
  61090. getClassName(): string;
  61091. /**
  61092. * Creates an effect layer from parsed effect layer data
  61093. * @param parsedEffectLayer defines effect layer data
  61094. * @param scene defines the current scene
  61095. * @param rootUrl defines the root URL containing the effect layer information
  61096. * @returns a parsed effect Layer
  61097. */
  61098. static Parse(parsedEffectLayer: any, scene: Scene, rootUrl: string): EffectLayer;
  61099. }
  61100. }
  61101. declare module "babylonjs/Layers/effectLayerSceneComponent" {
  61102. import { Scene } from "babylonjs/scene";
  61103. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  61104. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  61105. import { AbstractScene } from "babylonjs/abstractScene";
  61106. module "babylonjs/abstractScene" {
  61107. interface AbstractScene {
  61108. /**
  61109. * The list of effect layers (highlights/glow) added to the scene
  61110. * @see https://doc.babylonjs.com/how_to/highlight_layer
  61111. * @see https://doc.babylonjs.com/how_to/glow_layer
  61112. */
  61113. effectLayers: Array<EffectLayer>;
  61114. /**
  61115. * Removes the given effect layer from this scene.
  61116. * @param toRemove defines the effect layer to remove
  61117. * @returns the index of the removed effect layer
  61118. */
  61119. removeEffectLayer(toRemove: EffectLayer): number;
  61120. /**
  61121. * Adds the given effect layer to this scene
  61122. * @param newEffectLayer defines the effect layer to add
  61123. */
  61124. addEffectLayer(newEffectLayer: EffectLayer): void;
  61125. }
  61126. }
  61127. /**
  61128. * Defines the layer scene component responsible to manage any effect layers
  61129. * in a given scene.
  61130. */
  61131. export class EffectLayerSceneComponent implements ISceneSerializableComponent {
  61132. /**
  61133. * The component name helpfull to identify the component in the list of scene components.
  61134. */
  61135. readonly name: string;
  61136. /**
  61137. * The scene the component belongs to.
  61138. */
  61139. scene: Scene;
  61140. private _engine;
  61141. private _renderEffects;
  61142. private _needStencil;
  61143. private _previousStencilState;
  61144. /**
  61145. * Creates a new instance of the component for the given scene
  61146. * @param scene Defines the scene to register the component in
  61147. */
  61148. constructor(scene: Scene);
  61149. /**
  61150. * Registers the component in a given scene
  61151. */
  61152. register(): void;
  61153. /**
  61154. * Rebuilds the elements related to this component in case of
  61155. * context lost for instance.
  61156. */
  61157. rebuild(): void;
  61158. /**
  61159. * Serializes the component data to the specified json object
  61160. * @param serializationObject The object to serialize to
  61161. */
  61162. serialize(serializationObject: any): void;
  61163. /**
  61164. * Adds all the elements from the container to the scene
  61165. * @param container the container holding the elements
  61166. */
  61167. addFromContainer(container: AbstractScene): void;
  61168. /**
  61169. * Removes all the elements in the container from the scene
  61170. * @param container contains the elements to remove
  61171. * @param dispose if the removed element should be disposed (default: false)
  61172. */
  61173. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  61174. /**
  61175. * Disposes the component and the associated ressources.
  61176. */
  61177. dispose(): void;
  61178. private _isReadyForMesh;
  61179. private _renderMainTexture;
  61180. private _setStencil;
  61181. private _setStencilBack;
  61182. private _draw;
  61183. private _drawCamera;
  61184. private _drawRenderingGroup;
  61185. }
  61186. }
  61187. declare module "babylonjs/Shaders/glowMapMerge.fragment" {
  61188. /** @hidden */
  61189. export var glowMapMergePixelShader: {
  61190. name: string;
  61191. shader: string;
  61192. };
  61193. }
  61194. declare module "babylonjs/Shaders/glowMapMerge.vertex" {
  61195. /** @hidden */
  61196. export var glowMapMergeVertexShader: {
  61197. name: string;
  61198. shader: string;
  61199. };
  61200. }
  61201. declare module "babylonjs/Layers/glowLayer" {
  61202. import { Nullable } from "babylonjs/types";
  61203. import { Camera } from "babylonjs/Cameras/camera";
  61204. import { Scene } from "babylonjs/scene";
  61205. import { SubMesh } from "babylonjs/Meshes/subMesh";
  61206. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  61207. import { Mesh } from "babylonjs/Meshes/mesh";
  61208. import { Texture } from "babylonjs/Materials/Textures/texture";
  61209. import { Effect } from "babylonjs/Materials/effect";
  61210. import { Material } from "babylonjs/Materials/material";
  61211. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  61212. import { Color4 } from "babylonjs/Maths/math.color";
  61213. import "babylonjs/Shaders/glowMapMerge.fragment";
  61214. import "babylonjs/Shaders/glowMapMerge.vertex";
  61215. import "babylonjs/Layers/effectLayerSceneComponent";
  61216. module "babylonjs/abstractScene" {
  61217. interface AbstractScene {
  61218. /**
  61219. * Return a the first highlight layer of the scene with a given name.
  61220. * @param name The name of the highlight layer to look for.
  61221. * @return The highlight layer if found otherwise null.
  61222. */
  61223. getGlowLayerByName(name: string): Nullable<GlowLayer>;
  61224. }
  61225. }
  61226. /**
  61227. * Glow layer options. This helps customizing the behaviour
  61228. * of the glow layer.
  61229. */
  61230. export interface IGlowLayerOptions {
  61231. /**
  61232. * Multiplication factor apply to the canvas size to compute the render target size
  61233. * used to generated the glowing objects (the smaller the faster).
  61234. */
  61235. mainTextureRatio: number;
  61236. /**
  61237. * Enforces a fixed size texture to ensure resize independant blur.
  61238. */
  61239. mainTextureFixedSize?: number;
  61240. /**
  61241. * How big is the kernel of the blur texture.
  61242. */
  61243. blurKernelSize: number;
  61244. /**
  61245. * The camera attached to the layer.
  61246. */
  61247. camera: Nullable<Camera>;
  61248. /**
  61249. * Enable MSAA by chosing the number of samples.
  61250. */
  61251. mainTextureSamples?: number;
  61252. /**
  61253. * The rendering group to draw the layer in.
  61254. */
  61255. renderingGroupId: number;
  61256. }
  61257. /**
  61258. * The glow layer Helps adding a glow effect around the emissive parts of a mesh.
  61259. *
  61260. * Once instantiated in a scene, by default, all the emissive meshes will glow.
  61261. *
  61262. * Documentation: https://doc.babylonjs.com/how_to/glow_layer
  61263. */
  61264. export class GlowLayer extends EffectLayer {
  61265. /**
  61266. * Effect Name of the layer.
  61267. */
  61268. static readonly EffectName: string;
  61269. /**
  61270. * The default blur kernel size used for the glow.
  61271. */
  61272. static DefaultBlurKernelSize: number;
  61273. /**
  61274. * The default texture size ratio used for the glow.
  61275. */
  61276. static DefaultTextureRatio: number;
  61277. /**
  61278. * Sets the kernel size of the blur.
  61279. */
  61280. set blurKernelSize(value: number);
  61281. /**
  61282. * Gets the kernel size of the blur.
  61283. */
  61284. get blurKernelSize(): number;
  61285. /**
  61286. * Sets the glow intensity.
  61287. */
  61288. set intensity(value: number);
  61289. /**
  61290. * Gets the glow intensity.
  61291. */
  61292. get intensity(): number;
  61293. private _options;
  61294. private _intensity;
  61295. private _horizontalBlurPostprocess1;
  61296. private _verticalBlurPostprocess1;
  61297. private _horizontalBlurPostprocess2;
  61298. private _verticalBlurPostprocess2;
  61299. private _blurTexture1;
  61300. private _blurTexture2;
  61301. private _postProcesses1;
  61302. private _postProcesses2;
  61303. private _includedOnlyMeshes;
  61304. private _excludedMeshes;
  61305. private _meshesUsingTheirOwnMaterials;
  61306. /**
  61307. * Callback used to let the user override the color selection on a per mesh basis
  61308. */
  61309. customEmissiveColorSelector: (mesh: Mesh, subMesh: SubMesh, material: Material, result: Color4) => void;
  61310. /**
  61311. * Callback used to let the user override the texture selection on a per mesh basis
  61312. */
  61313. customEmissiveTextureSelector: (mesh: Mesh, subMesh: SubMesh, material: Material) => Texture;
  61314. /**
  61315. * Instantiates a new glow Layer and references it to the scene.
  61316. * @param name The name of the layer
  61317. * @param scene The scene to use the layer in
  61318. * @param options Sets of none mandatory options to use with the layer (see IGlowLayerOptions for more information)
  61319. */
  61320. constructor(name: string, scene: Scene, options?: Partial<IGlowLayerOptions>);
  61321. /**
  61322. * Get the effect name of the layer.
  61323. * @return The effect name
  61324. */
  61325. getEffectName(): string;
  61326. /**
  61327. * Create the merge effect. This is the shader use to blit the information back
  61328. * to the main canvas at the end of the scene rendering.
  61329. */
  61330. protected _createMergeEffect(): Effect;
  61331. /**
  61332. * Creates the render target textures and post processes used in the glow layer.
  61333. */
  61334. protected _createTextureAndPostProcesses(): void;
  61335. /**
  61336. * Checks for the readiness of the element composing the layer.
  61337. * @param subMesh the mesh to check for
  61338. * @param useInstances specify wether or not to use instances to render the mesh
  61339. * @param emissiveTexture the associated emissive texture used to generate the glow
  61340. * @return true if ready otherwise, false
  61341. */
  61342. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  61343. /**
  61344. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  61345. */
  61346. needStencil(): boolean;
  61347. /**
  61348. * Returns true if the mesh can be rendered, otherwise false.
  61349. * @param mesh The mesh to render
  61350. * @param material The material used on the mesh
  61351. * @returns true if it can be rendered otherwise false
  61352. */
  61353. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  61354. /**
  61355. * Implementation specific of rendering the generating effect on the main canvas.
  61356. * @param effect The effect used to render through
  61357. */
  61358. protected _internalRender(effect: Effect): void;
  61359. /**
  61360. * Sets the required values for both the emissive texture and and the main color.
  61361. */
  61362. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  61363. /**
  61364. * Returns true if the mesh should render, otherwise false.
  61365. * @param mesh The mesh to render
  61366. * @returns true if it should render otherwise false
  61367. */
  61368. protected _shouldRenderMesh(mesh: Mesh): boolean;
  61369. /**
  61370. * Adds specific effects defines.
  61371. * @param defines The defines to add specifics to.
  61372. */
  61373. protected _addCustomEffectDefines(defines: string[]): void;
  61374. /**
  61375. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the glow layer.
  61376. * @param mesh The mesh to exclude from the glow layer
  61377. */
  61378. addExcludedMesh(mesh: Mesh): void;
  61379. /**
  61380. * Remove a mesh from the exclusion list to let it impact or being impacted by the glow layer.
  61381. * @param mesh The mesh to remove
  61382. */
  61383. removeExcludedMesh(mesh: Mesh): void;
  61384. /**
  61385. * Add a mesh in the inclusion list to impact or being impacted by the glow layer.
  61386. * @param mesh The mesh to include in the glow layer
  61387. */
  61388. addIncludedOnlyMesh(mesh: Mesh): void;
  61389. /**
  61390. * Remove a mesh from the Inclusion list to prevent it to impact or being impacted by the glow layer.
  61391. * @param mesh The mesh to remove
  61392. */
  61393. removeIncludedOnlyMesh(mesh: Mesh): void;
  61394. /**
  61395. * Determine if a given mesh will be used in the glow layer
  61396. * @param mesh The mesh to test
  61397. * @returns true if the mesh will be highlighted by the current glow layer
  61398. */
  61399. hasMesh(mesh: AbstractMesh): boolean;
  61400. /**
  61401. * Defines whether the current material of the mesh should be use to render the effect.
  61402. * @param mesh defines the current mesh to render
  61403. */
  61404. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  61405. /**
  61406. * Add a mesh to be rendered through its own material and not with emissive only.
  61407. * @param mesh The mesh for which we need to use its material
  61408. */
  61409. referenceMeshToUseItsOwnMaterial(mesh: AbstractMesh): void;
  61410. /**
  61411. * Remove a mesh from being rendered through its own material and not with emissive only.
  61412. * @param mesh The mesh for which we need to not use its material
  61413. */
  61414. unReferenceMeshFromUsingItsOwnMaterial(mesh: AbstractMesh): void;
  61415. /**
  61416. * Free any resources and references associated to a mesh.
  61417. * Internal use
  61418. * @param mesh The mesh to free.
  61419. * @hidden
  61420. */
  61421. _disposeMesh(mesh: Mesh): void;
  61422. /**
  61423. * Gets the class name of the effect layer
  61424. * @returns the string with the class name of the effect layer
  61425. */
  61426. getClassName(): string;
  61427. /**
  61428. * Serializes this glow layer
  61429. * @returns a serialized glow layer object
  61430. */
  61431. serialize(): any;
  61432. /**
  61433. * Creates a Glow Layer from parsed glow layer data
  61434. * @param parsedGlowLayer defines glow layer data
  61435. * @param scene defines the current scene
  61436. * @param rootUrl defines the root URL containing the glow layer information
  61437. * @returns a parsed Glow Layer
  61438. */
  61439. static Parse(parsedGlowLayer: any, scene: Scene, rootUrl: string): GlowLayer;
  61440. }
  61441. }
  61442. declare module "babylonjs/Shaders/glowBlurPostProcess.fragment" {
  61443. /** @hidden */
  61444. export var glowBlurPostProcessPixelShader: {
  61445. name: string;
  61446. shader: string;
  61447. };
  61448. }
  61449. declare module "babylonjs/Layers/highlightLayer" {
  61450. import { Observable } from "babylonjs/Misc/observable";
  61451. import { Nullable } from "babylonjs/types";
  61452. import { Camera } from "babylonjs/Cameras/camera";
  61453. import { Scene } from "babylonjs/scene";
  61454. import { SubMesh } from "babylonjs/Meshes/subMesh";
  61455. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  61456. import { Mesh } from "babylonjs/Meshes/mesh";
  61457. import { Effect } from "babylonjs/Materials/effect";
  61458. import { Material } from "babylonjs/Materials/material";
  61459. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  61460. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  61461. import "babylonjs/Shaders/glowMapMerge.fragment";
  61462. import "babylonjs/Shaders/glowMapMerge.vertex";
  61463. import "babylonjs/Shaders/glowBlurPostProcess.fragment";
  61464. module "babylonjs/abstractScene" {
  61465. interface AbstractScene {
  61466. /**
  61467. * Return a the first highlight layer of the scene with a given name.
  61468. * @param name The name of the highlight layer to look for.
  61469. * @return The highlight layer if found otherwise null.
  61470. */
  61471. getHighlightLayerByName(name: string): Nullable<HighlightLayer>;
  61472. }
  61473. }
  61474. /**
  61475. * Highlight layer options. This helps customizing the behaviour
  61476. * of the highlight layer.
  61477. */
  61478. export interface IHighlightLayerOptions {
  61479. /**
  61480. * Multiplication factor apply to the canvas size to compute the render target size
  61481. * used to generated the glowing objects (the smaller the faster).
  61482. */
  61483. mainTextureRatio: number;
  61484. /**
  61485. * Enforces a fixed size texture to ensure resize independant blur.
  61486. */
  61487. mainTextureFixedSize?: number;
  61488. /**
  61489. * Multiplication factor apply to the main texture size in the first step of the blur to reduce the size
  61490. * of the picture to blur (the smaller the faster).
  61491. */
  61492. blurTextureSizeRatio: number;
  61493. /**
  61494. * How big in texel of the blur texture is the vertical blur.
  61495. */
  61496. blurVerticalSize: number;
  61497. /**
  61498. * How big in texel of the blur texture is the horizontal blur.
  61499. */
  61500. blurHorizontalSize: number;
  61501. /**
  61502. * Alpha blending mode used to apply the blur. Default is combine.
  61503. */
  61504. alphaBlendingMode: number;
  61505. /**
  61506. * The camera attached to the layer.
  61507. */
  61508. camera: Nullable<Camera>;
  61509. /**
  61510. * Should we display highlight as a solid stroke?
  61511. */
  61512. isStroke?: boolean;
  61513. /**
  61514. * The rendering group to draw the layer in.
  61515. */
  61516. renderingGroupId: number;
  61517. }
  61518. /**
  61519. * The highlight layer Helps adding a glow effect around a mesh.
  61520. *
  61521. * Once instantiated in a scene, simply use the addMesh or removeMesh method to add or remove
  61522. * glowy meshes to your scene.
  61523. *
  61524. * !!! THIS REQUIRES AN ACTIVE STENCIL BUFFER ON THE CANVAS !!!
  61525. */
  61526. export class HighlightLayer extends EffectLayer {
  61527. name: string;
  61528. /**
  61529. * Effect Name of the highlight layer.
  61530. */
  61531. static readonly EffectName: string;
  61532. /**
  61533. * The neutral color used during the preparation of the glow effect.
  61534. * This is black by default as the blend operation is a blend operation.
  61535. */
  61536. static NeutralColor: Color4;
  61537. /**
  61538. * Stencil value used for glowing meshes.
  61539. */
  61540. static GlowingMeshStencilReference: number;
  61541. /**
  61542. * Stencil value used for the other meshes in the scene.
  61543. */
  61544. static NormalMeshStencilReference: number;
  61545. /**
  61546. * Specifies whether or not the inner glow is ACTIVE in the layer.
  61547. */
  61548. innerGlow: boolean;
  61549. /**
  61550. * Specifies whether or not the outer glow is ACTIVE in the layer.
  61551. */
  61552. outerGlow: boolean;
  61553. /**
  61554. * Specifies the horizontal size of the blur.
  61555. */
  61556. set blurHorizontalSize(value: number);
  61557. /**
  61558. * Specifies the vertical size of the blur.
  61559. */
  61560. set blurVerticalSize(value: number);
  61561. /**
  61562. * Gets the horizontal size of the blur.
  61563. */
  61564. get blurHorizontalSize(): number;
  61565. /**
  61566. * Gets the vertical size of the blur.
  61567. */
  61568. get blurVerticalSize(): number;
  61569. /**
  61570. * An event triggered when the highlight layer is being blurred.
  61571. */
  61572. onBeforeBlurObservable: Observable<HighlightLayer>;
  61573. /**
  61574. * An event triggered when the highlight layer has been blurred.
  61575. */
  61576. onAfterBlurObservable: Observable<HighlightLayer>;
  61577. private _instanceGlowingMeshStencilReference;
  61578. private _options;
  61579. private _downSamplePostprocess;
  61580. private _horizontalBlurPostprocess;
  61581. private _verticalBlurPostprocess;
  61582. private _blurTexture;
  61583. private _meshes;
  61584. private _excludedMeshes;
  61585. /**
  61586. * Instantiates a new highlight Layer and references it to the scene..
  61587. * @param name The name of the layer
  61588. * @param scene The scene to use the layer in
  61589. * @param options Sets of none mandatory options to use with the layer (see IHighlightLayerOptions for more information)
  61590. */
  61591. constructor(name: string, scene: Scene, options?: Partial<IHighlightLayerOptions>);
  61592. /**
  61593. * Get the effect name of the layer.
  61594. * @return The effect name
  61595. */
  61596. getEffectName(): string;
  61597. /**
  61598. * Create the merge effect. This is the shader use to blit the information back
  61599. * to the main canvas at the end of the scene rendering.
  61600. */
  61601. protected _createMergeEffect(): Effect;
  61602. /**
  61603. * Creates the render target textures and post processes used in the highlight layer.
  61604. */
  61605. protected _createTextureAndPostProcesses(): void;
  61606. /**
  61607. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  61608. */
  61609. needStencil(): boolean;
  61610. /**
  61611. * Checks for the readiness of the element composing the layer.
  61612. * @param subMesh the mesh to check for
  61613. * @param useInstances specify wether or not to use instances to render the mesh
  61614. * @param emissiveTexture the associated emissive texture used to generate the glow
  61615. * @return true if ready otherwise, false
  61616. */
  61617. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  61618. /**
  61619. * Implementation specific of rendering the generating effect on the main canvas.
  61620. * @param effect The effect used to render through
  61621. */
  61622. protected _internalRender(effect: Effect): void;
  61623. /**
  61624. * Returns true if the layer contains information to display, otherwise false.
  61625. */
  61626. shouldRender(): boolean;
  61627. /**
  61628. * Returns true if the mesh should render, otherwise false.
  61629. * @param mesh The mesh to render
  61630. * @returns true if it should render otherwise false
  61631. */
  61632. protected _shouldRenderMesh(mesh: Mesh): boolean;
  61633. /**
  61634. * Returns true if the mesh can be rendered, otherwise false.
  61635. * @param mesh The mesh to render
  61636. * @param material The material used on the mesh
  61637. * @returns true if it can be rendered otherwise false
  61638. */
  61639. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  61640. /**
  61641. * Adds specific effects defines.
  61642. * @param defines The defines to add specifics to.
  61643. */
  61644. protected _addCustomEffectDefines(defines: string[]): void;
  61645. /**
  61646. * Sets the required values for both the emissive texture and and the main color.
  61647. */
  61648. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  61649. /**
  61650. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the highlight layer.
  61651. * @param mesh The mesh to exclude from the highlight layer
  61652. */
  61653. addExcludedMesh(mesh: Mesh): void;
  61654. /**
  61655. * Remove a mesh from the exclusion list to let it impact or being impacted by the highlight layer.
  61656. * @param mesh The mesh to highlight
  61657. */
  61658. removeExcludedMesh(mesh: Mesh): void;
  61659. /**
  61660. * Determine if a given mesh will be highlighted by the current HighlightLayer
  61661. * @param mesh mesh to test
  61662. * @returns true if the mesh will be highlighted by the current HighlightLayer
  61663. */
  61664. hasMesh(mesh: AbstractMesh): boolean;
  61665. /**
  61666. * Add a mesh in the highlight layer in order to make it glow with the chosen color.
  61667. * @param mesh The mesh to highlight
  61668. * @param color The color of the highlight
  61669. * @param glowEmissiveOnly Extract the glow from the emissive texture
  61670. */
  61671. addMesh(mesh: Mesh, color: Color3, glowEmissiveOnly?: boolean): void;
  61672. /**
  61673. * Remove a mesh from the highlight layer in order to make it stop glowing.
  61674. * @param mesh The mesh to highlight
  61675. */
  61676. removeMesh(mesh: Mesh): void;
  61677. /**
  61678. * Remove all the meshes currently referenced in the highlight layer
  61679. */
  61680. removeAllMeshes(): void;
  61681. /**
  61682. * Force the stencil to the normal expected value for none glowing parts
  61683. */
  61684. private _defaultStencilReference;
  61685. /**
  61686. * Free any resources and references associated to a mesh.
  61687. * Internal use
  61688. * @param mesh The mesh to free.
  61689. * @hidden
  61690. */
  61691. _disposeMesh(mesh: Mesh): void;
  61692. /**
  61693. * Dispose the highlight layer and free resources.
  61694. */
  61695. dispose(): void;
  61696. /**
  61697. * Gets the class name of the effect layer
  61698. * @returns the string with the class name of the effect layer
  61699. */
  61700. getClassName(): string;
  61701. /**
  61702. * Serializes this Highlight layer
  61703. * @returns a serialized Highlight layer object
  61704. */
  61705. serialize(): any;
  61706. /**
  61707. * Creates a Highlight layer from parsed Highlight layer data
  61708. * @param parsedHightlightLayer defines the Highlight layer data
  61709. * @param scene defines the current scene
  61710. * @param rootUrl defines the root URL containing the Highlight layer information
  61711. * @returns a parsed Highlight layer
  61712. */
  61713. static Parse(parsedHightlightLayer: any, scene: Scene, rootUrl: string): HighlightLayer;
  61714. }
  61715. }
  61716. declare module "babylonjs/Layers/layerSceneComponent" {
  61717. import { Scene } from "babylonjs/scene";
  61718. import { ISceneComponent } from "babylonjs/sceneComponent";
  61719. import { Layer } from "babylonjs/Layers/layer";
  61720. import { AbstractScene } from "babylonjs/abstractScene";
  61721. module "babylonjs/abstractScene" {
  61722. interface AbstractScene {
  61723. /**
  61724. * The list of layers (background and foreground) of the scene
  61725. */
  61726. layers: Array<Layer>;
  61727. }
  61728. }
  61729. /**
  61730. * Defines the layer scene component responsible to manage any layers
  61731. * in a given scene.
  61732. */
  61733. export class LayerSceneComponent implements ISceneComponent {
  61734. /**
  61735. * The component name helpfull to identify the component in the list of scene components.
  61736. */
  61737. readonly name: string;
  61738. /**
  61739. * The scene the component belongs to.
  61740. */
  61741. scene: Scene;
  61742. private _engine;
  61743. /**
  61744. * Creates a new instance of the component for the given scene
  61745. * @param scene Defines the scene to register the component in
  61746. */
  61747. constructor(scene: Scene);
  61748. /**
  61749. * Registers the component in a given scene
  61750. */
  61751. register(): void;
  61752. /**
  61753. * Rebuilds the elements related to this component in case of
  61754. * context lost for instance.
  61755. */
  61756. rebuild(): void;
  61757. /**
  61758. * Disposes the component and the associated ressources.
  61759. */
  61760. dispose(): void;
  61761. private _draw;
  61762. private _drawCameraPredicate;
  61763. private _drawCameraBackground;
  61764. private _drawCameraForeground;
  61765. private _drawRenderTargetPredicate;
  61766. private _drawRenderTargetBackground;
  61767. private _drawRenderTargetForeground;
  61768. /**
  61769. * Adds all the elements from the container to the scene
  61770. * @param container the container holding the elements
  61771. */
  61772. addFromContainer(container: AbstractScene): void;
  61773. /**
  61774. * Removes all the elements in the container from the scene
  61775. * @param container contains the elements to remove
  61776. * @param dispose if the removed element should be disposed (default: false)
  61777. */
  61778. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  61779. }
  61780. }
  61781. declare module "babylonjs/Shaders/layer.fragment" {
  61782. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  61783. /** @hidden */
  61784. export var layerPixelShader: {
  61785. name: string;
  61786. shader: string;
  61787. };
  61788. }
  61789. declare module "babylonjs/Shaders/layer.vertex" {
  61790. /** @hidden */
  61791. export var layerVertexShader: {
  61792. name: string;
  61793. shader: string;
  61794. };
  61795. }
  61796. declare module "babylonjs/Layers/layer" {
  61797. import { Observable } from "babylonjs/Misc/observable";
  61798. import { Nullable } from "babylonjs/types";
  61799. import { Scene } from "babylonjs/scene";
  61800. import { Vector2 } from "babylonjs/Maths/math.vector";
  61801. import { Color4 } from "babylonjs/Maths/math.color";
  61802. import { Texture } from "babylonjs/Materials/Textures/texture";
  61803. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  61804. import "babylonjs/Shaders/layer.fragment";
  61805. import "babylonjs/Shaders/layer.vertex";
  61806. /**
  61807. * This represents a full screen 2d layer.
  61808. * This can be useful to display a picture in the background of your scene for instance.
  61809. * @see https://www.babylonjs-playground.com/#08A2BS#1
  61810. */
  61811. export class Layer {
  61812. /**
  61813. * Define the name of the layer.
  61814. */
  61815. name: string;
  61816. /**
  61817. * Define the texture the layer should display.
  61818. */
  61819. texture: Nullable<Texture>;
  61820. /**
  61821. * Is the layer in background or foreground.
  61822. */
  61823. isBackground: boolean;
  61824. /**
  61825. * Define the color of the layer (instead of texture).
  61826. */
  61827. color: Color4;
  61828. /**
  61829. * Define the scale of the layer in order to zoom in out of the texture.
  61830. */
  61831. scale: Vector2;
  61832. /**
  61833. * Define an offset for the layer in order to shift the texture.
  61834. */
  61835. offset: Vector2;
  61836. /**
  61837. * Define the alpha blending mode used in the layer in case the texture or color has an alpha.
  61838. */
  61839. alphaBlendingMode: number;
  61840. /**
  61841. * Define if the layer should alpha test or alpha blend with the rest of the scene.
  61842. * Alpha test will not mix with the background color in case of transparency.
  61843. * It will either use the texture color or the background depending on the alpha value of the current pixel.
  61844. */
  61845. alphaTest: boolean;
  61846. /**
  61847. * Define a mask to restrict the layer to only some of the scene cameras.
  61848. */
  61849. layerMask: number;
  61850. /**
  61851. * Define the list of render target the layer is visible into.
  61852. */
  61853. renderTargetTextures: RenderTargetTexture[];
  61854. /**
  61855. * Define if the layer is only used in renderTarget or if it also
  61856. * renders in the main frame buffer of the canvas.
  61857. */
  61858. renderOnlyInRenderTargetTextures: boolean;
  61859. private _scene;
  61860. private _vertexBuffers;
  61861. private _indexBuffer;
  61862. private _effect;
  61863. private _previousDefines;
  61864. /**
  61865. * An event triggered when the layer is disposed.
  61866. */
  61867. onDisposeObservable: Observable<Layer>;
  61868. private _onDisposeObserver;
  61869. /**
  61870. * Back compatibility with callback before the onDisposeObservable existed.
  61871. * The set callback will be triggered when the layer has been disposed.
  61872. */
  61873. set onDispose(callback: () => void);
  61874. /**
  61875. * An event triggered before rendering the scene
  61876. */
  61877. onBeforeRenderObservable: Observable<Layer>;
  61878. private _onBeforeRenderObserver;
  61879. /**
  61880. * Back compatibility with callback before the onBeforeRenderObservable existed.
  61881. * The set callback will be triggered just before rendering the layer.
  61882. */
  61883. set onBeforeRender(callback: () => void);
  61884. /**
  61885. * An event triggered after rendering the scene
  61886. */
  61887. onAfterRenderObservable: Observable<Layer>;
  61888. private _onAfterRenderObserver;
  61889. /**
  61890. * Back compatibility with callback before the onAfterRenderObservable existed.
  61891. * The set callback will be triggered just after rendering the layer.
  61892. */
  61893. set onAfterRender(callback: () => void);
  61894. /**
  61895. * Instantiates a new layer.
  61896. * This represents a full screen 2d layer.
  61897. * This can be useful to display a picture in the background of your scene for instance.
  61898. * @see https://www.babylonjs-playground.com/#08A2BS#1
  61899. * @param name Define the name of the layer in the scene
  61900. * @param imgUrl Define the url of the texture to display in the layer
  61901. * @param scene Define the scene the layer belongs to
  61902. * @param isBackground Defines whether the layer is displayed in front or behind the scene
  61903. * @param color Defines a color for the layer
  61904. */
  61905. constructor(
  61906. /**
  61907. * Define the name of the layer.
  61908. */
  61909. name: string, imgUrl: Nullable<string>, scene: Nullable<Scene>, isBackground?: boolean, color?: Color4);
  61910. private _createIndexBuffer;
  61911. /** @hidden */
  61912. _rebuild(): void;
  61913. /**
  61914. * Renders the layer in the scene.
  61915. */
  61916. render(): void;
  61917. /**
  61918. * Disposes and releases the associated ressources.
  61919. */
  61920. dispose(): void;
  61921. }
  61922. }
  61923. declare module "babylonjs/Layers/index" {
  61924. export * from "babylonjs/Layers/effectLayer";
  61925. export * from "babylonjs/Layers/effectLayerSceneComponent";
  61926. export * from "babylonjs/Layers/glowLayer";
  61927. export * from "babylonjs/Layers/highlightLayer";
  61928. export * from "babylonjs/Layers/layer";
  61929. export * from "babylonjs/Layers/layerSceneComponent";
  61930. }
  61931. declare module "babylonjs/Shaders/lensFlare.fragment" {
  61932. /** @hidden */
  61933. export var lensFlarePixelShader: {
  61934. name: string;
  61935. shader: string;
  61936. };
  61937. }
  61938. declare module "babylonjs/Shaders/lensFlare.vertex" {
  61939. /** @hidden */
  61940. export var lensFlareVertexShader: {
  61941. name: string;
  61942. shader: string;
  61943. };
  61944. }
  61945. declare module "babylonjs/LensFlares/lensFlareSystem" {
  61946. import { Scene } from "babylonjs/scene";
  61947. import { Vector3 } from "babylonjs/Maths/math.vector";
  61948. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  61949. import { LensFlare } from "babylonjs/LensFlares/lensFlare";
  61950. import "babylonjs/Shaders/lensFlare.fragment";
  61951. import "babylonjs/Shaders/lensFlare.vertex";
  61952. import { Viewport } from "babylonjs/Maths/math.viewport";
  61953. /**
  61954. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  61955. * It is usually composed of several `lensFlare`.
  61956. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  61957. */
  61958. export class LensFlareSystem {
  61959. /**
  61960. * Define the name of the lens flare system
  61961. */
  61962. name: string;
  61963. /**
  61964. * List of lens flares used in this system.
  61965. */
  61966. lensFlares: LensFlare[];
  61967. /**
  61968. * Define a limit from the border the lens flare can be visible.
  61969. */
  61970. borderLimit: number;
  61971. /**
  61972. * Define a viewport border we do not want to see the lens flare in.
  61973. */
  61974. viewportBorder: number;
  61975. /**
  61976. * Define a predicate which could limit the list of meshes able to occlude the effect.
  61977. */
  61978. meshesSelectionPredicate: (mesh: AbstractMesh) => boolean;
  61979. /**
  61980. * Restricts the rendering of the effect to only the camera rendering this layer mask.
  61981. */
  61982. layerMask: number;
  61983. /**
  61984. * Define the id of the lens flare system in the scene.
  61985. * (equal to name by default)
  61986. */
  61987. id: string;
  61988. private _scene;
  61989. private _emitter;
  61990. private _vertexBuffers;
  61991. private _indexBuffer;
  61992. private _effect;
  61993. private _positionX;
  61994. private _positionY;
  61995. private _isEnabled;
  61996. /** @hidden */
  61997. static _SceneComponentInitialization: (scene: Scene) => void;
  61998. /**
  61999. * Instantiates a lens flare system.
  62000. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  62001. * It is usually composed of several `lensFlare`.
  62002. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  62003. * @param name Define the name of the lens flare system in the scene
  62004. * @param emitter Define the source (the emitter) of the lens flares (it can be a camera, a light or a mesh).
  62005. * @param scene Define the scene the lens flare system belongs to
  62006. */
  62007. constructor(
  62008. /**
  62009. * Define the name of the lens flare system
  62010. */
  62011. name: string, emitter: any, scene: Scene);
  62012. /**
  62013. * Define if the lens flare system is enabled.
  62014. */
  62015. get isEnabled(): boolean;
  62016. set isEnabled(value: boolean);
  62017. /**
  62018. * Get the scene the effects belongs to.
  62019. * @returns the scene holding the lens flare system
  62020. */
  62021. getScene(): Scene;
  62022. /**
  62023. * Get the emitter of the lens flare system.
  62024. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  62025. * @returns the emitter of the lens flare system
  62026. */
  62027. getEmitter(): any;
  62028. /**
  62029. * Set the emitter of the lens flare system.
  62030. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  62031. * @param newEmitter Define the new emitter of the system
  62032. */
  62033. setEmitter(newEmitter: any): void;
  62034. /**
  62035. * Get the lens flare system emitter position.
  62036. * The emitter defines the source of the lens flares (it can be a camera, a light or a mesh).
  62037. * @returns the position
  62038. */
  62039. getEmitterPosition(): Vector3;
  62040. /**
  62041. * @hidden
  62042. */
  62043. computeEffectivePosition(globalViewport: Viewport): boolean;
  62044. /** @hidden */
  62045. _isVisible(): boolean;
  62046. /**
  62047. * @hidden
  62048. */
  62049. render(): boolean;
  62050. /**
  62051. * Dispose and release the lens flare with its associated resources.
  62052. */
  62053. dispose(): void;
  62054. /**
  62055. * Parse a lens flare system from a JSON repressentation
  62056. * @param parsedLensFlareSystem Define the JSON to parse
  62057. * @param scene Define the scene the parsed system should be instantiated in
  62058. * @param rootUrl Define the rootUrl of the load sequence to easily find a load relative dependencies such as textures
  62059. * @returns the parsed system
  62060. */
  62061. static Parse(parsedLensFlareSystem: any, scene: Scene, rootUrl: string): LensFlareSystem;
  62062. /**
  62063. * Serialize the current Lens Flare System into a JSON representation.
  62064. * @returns the serialized JSON
  62065. */
  62066. serialize(): any;
  62067. }
  62068. }
  62069. declare module "babylonjs/LensFlares/lensFlare" {
  62070. import { Nullable } from "babylonjs/types";
  62071. import { Color3 } from "babylonjs/Maths/math.color";
  62072. import { Texture } from "babylonjs/Materials/Textures/texture";
  62073. import { LensFlareSystem } from "babylonjs/LensFlares/lensFlareSystem";
  62074. /**
  62075. * This represents one of the lens effect in a `lensFlareSystem`.
  62076. * It controls one of the indiviual texture used in the effect.
  62077. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  62078. */
  62079. export class LensFlare {
  62080. /**
  62081. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  62082. */
  62083. size: number;
  62084. /**
  62085. * 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.
  62086. */
  62087. position: number;
  62088. /**
  62089. * Define the lens color.
  62090. */
  62091. color: Color3;
  62092. /**
  62093. * Define the lens texture.
  62094. */
  62095. texture: Nullable<Texture>;
  62096. /**
  62097. * Define the alpha mode to render this particular lens.
  62098. */
  62099. alphaMode: number;
  62100. private _system;
  62101. /**
  62102. * Creates a new Lens Flare.
  62103. * This represents one of the lens effect in a `lensFlareSystem`.
  62104. * It controls one of the indiviual texture used in the effect.
  62105. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  62106. * @param size Define the size of the lens flare (a floating value between 0 and 1)
  62107. * @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.
  62108. * @param color Define the lens color
  62109. * @param imgUrl Define the lens texture url
  62110. * @param system Define the `lensFlareSystem` this flare is part of
  62111. * @returns The newly created Lens Flare
  62112. */
  62113. static AddFlare(size: number, position: number, color: Color3, imgUrl: string, system: LensFlareSystem): LensFlare;
  62114. /**
  62115. * Instantiates a new Lens Flare.
  62116. * This represents one of the lens effect in a `lensFlareSystem`.
  62117. * It controls one of the indiviual texture used in the effect.
  62118. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  62119. * @param size Define the size of the lens flare in the system (a floating value between 0 and 1)
  62120. * @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.
  62121. * @param color Define the lens color
  62122. * @param imgUrl Define the lens texture url
  62123. * @param system Define the `lensFlareSystem` this flare is part of
  62124. */
  62125. constructor(
  62126. /**
  62127. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  62128. */
  62129. size: number,
  62130. /**
  62131. * 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.
  62132. */
  62133. position: number, color: Color3, imgUrl: string, system: LensFlareSystem);
  62134. /**
  62135. * Dispose and release the lens flare with its associated resources.
  62136. */
  62137. dispose(): void;
  62138. }
  62139. }
  62140. declare module "babylonjs/LensFlares/lensFlareSystemSceneComponent" {
  62141. import { Nullable } from "babylonjs/types";
  62142. import { Scene } from "babylonjs/scene";
  62143. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  62144. import { AbstractScene } from "babylonjs/abstractScene";
  62145. import { LensFlareSystem } from "babylonjs/LensFlares/lensFlareSystem";
  62146. module "babylonjs/abstractScene" {
  62147. interface AbstractScene {
  62148. /**
  62149. * The list of lens flare system added to the scene
  62150. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  62151. */
  62152. lensFlareSystems: Array<LensFlareSystem>;
  62153. /**
  62154. * Removes the given lens flare system from this scene.
  62155. * @param toRemove The lens flare system to remove
  62156. * @returns The index of the removed lens flare system
  62157. */
  62158. removeLensFlareSystem(toRemove: LensFlareSystem): number;
  62159. /**
  62160. * Adds the given lens flare system to this scene
  62161. * @param newLensFlareSystem The lens flare system to add
  62162. */
  62163. addLensFlareSystem(newLensFlareSystem: LensFlareSystem): void;
  62164. /**
  62165. * Gets a lens flare system using its name
  62166. * @param name defines the name to look for
  62167. * @returns the lens flare system or null if not found
  62168. */
  62169. getLensFlareSystemByName(name: string): Nullable<LensFlareSystem>;
  62170. /**
  62171. * Gets a lens flare system using its id
  62172. * @param id defines the id to look for
  62173. * @returns the lens flare system or null if not found
  62174. */
  62175. getLensFlareSystemByID(id: string): Nullable<LensFlareSystem>;
  62176. }
  62177. }
  62178. /**
  62179. * Defines the lens flare scene component responsible to manage any lens flares
  62180. * in a given scene.
  62181. */
  62182. export class LensFlareSystemSceneComponent implements ISceneSerializableComponent {
  62183. /**
  62184. * The component name helpfull to identify the component in the list of scene components.
  62185. */
  62186. readonly name: string;
  62187. /**
  62188. * The scene the component belongs to.
  62189. */
  62190. scene: Scene;
  62191. /**
  62192. * Creates a new instance of the component for the given scene
  62193. * @param scene Defines the scene to register the component in
  62194. */
  62195. constructor(scene: Scene);
  62196. /**
  62197. * Registers the component in a given scene
  62198. */
  62199. register(): void;
  62200. /**
  62201. * Rebuilds the elements related to this component in case of
  62202. * context lost for instance.
  62203. */
  62204. rebuild(): void;
  62205. /**
  62206. * Adds all the elements from the container to the scene
  62207. * @param container the container holding the elements
  62208. */
  62209. addFromContainer(container: AbstractScene): void;
  62210. /**
  62211. * Removes all the elements in the container from the scene
  62212. * @param container contains the elements to remove
  62213. * @param dispose if the removed element should be disposed (default: false)
  62214. */
  62215. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  62216. /**
  62217. * Serializes the component data to the specified json object
  62218. * @param serializationObject The object to serialize to
  62219. */
  62220. serialize(serializationObject: any): void;
  62221. /**
  62222. * Disposes the component and the associated ressources.
  62223. */
  62224. dispose(): void;
  62225. private _draw;
  62226. }
  62227. }
  62228. declare module "babylonjs/LensFlares/index" {
  62229. export * from "babylonjs/LensFlares/lensFlare";
  62230. export * from "babylonjs/LensFlares/lensFlareSystem";
  62231. export * from "babylonjs/LensFlares/lensFlareSystemSceneComponent";
  62232. }
  62233. declare module "babylonjs/Shaders/depth.fragment" {
  62234. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  62235. /** @hidden */
  62236. export var depthPixelShader: {
  62237. name: string;
  62238. shader: string;
  62239. };
  62240. }
  62241. declare module "babylonjs/Shaders/depth.vertex" {
  62242. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  62243. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  62244. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  62245. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  62246. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  62247. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  62248. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  62249. /** @hidden */
  62250. export var depthVertexShader: {
  62251. name: string;
  62252. shader: string;
  62253. };
  62254. }
  62255. declare module "babylonjs/Rendering/depthRenderer" {
  62256. import { Nullable } from "babylonjs/types";
  62257. import { SubMesh } from "babylonjs/Meshes/subMesh";
  62258. import { Scene } from "babylonjs/scene";
  62259. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  62260. import { Camera } from "babylonjs/Cameras/camera";
  62261. import "babylonjs/Shaders/depth.fragment";
  62262. import "babylonjs/Shaders/depth.vertex";
  62263. /**
  62264. * This represents a depth renderer in Babylon.
  62265. * A depth renderer will render to it's depth map every frame which can be displayed or used in post processing
  62266. */
  62267. export class DepthRenderer {
  62268. private _scene;
  62269. private _depthMap;
  62270. private _effect;
  62271. private readonly _storeNonLinearDepth;
  62272. private readonly _clearColor;
  62273. /** Get if the depth renderer is using packed depth or not */
  62274. readonly isPacked: boolean;
  62275. private _cachedDefines;
  62276. private _camera;
  62277. /** Enable or disable the depth renderer. When disabled, the depth texture is not updated */
  62278. enabled: boolean;
  62279. /**
  62280. * Specifiess that the depth renderer will only be used within
  62281. * the camera it is created for.
  62282. * This can help forcing its rendering during the camera processing.
  62283. */
  62284. useOnlyInActiveCamera: boolean;
  62285. /** @hidden */
  62286. static _SceneComponentInitialization: (scene: Scene) => void;
  62287. /**
  62288. * Instantiates a depth renderer
  62289. * @param scene The scene the renderer belongs to
  62290. * @param type The texture type of the depth map (default: Engine.TEXTURETYPE_FLOAT)
  62291. * @param camera The camera to be used to render the depth map (default: scene's active camera)
  62292. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  62293. */
  62294. constructor(scene: Scene, type?: number, camera?: Nullable<Camera>, storeNonLinearDepth?: boolean);
  62295. /**
  62296. * Creates the depth rendering effect and checks if the effect is ready.
  62297. * @param subMesh The submesh to be used to render the depth map of
  62298. * @param useInstances If multiple world instances should be used
  62299. * @returns if the depth renderer is ready to render the depth map
  62300. */
  62301. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  62302. /**
  62303. * Gets the texture which the depth map will be written to.
  62304. * @returns The depth map texture
  62305. */
  62306. getDepthMap(): RenderTargetTexture;
  62307. /**
  62308. * Disposes of the depth renderer.
  62309. */
  62310. dispose(): void;
  62311. }
  62312. }
  62313. declare module "babylonjs/Shaders/minmaxRedux.fragment" {
  62314. /** @hidden */
  62315. export var minmaxReduxPixelShader: {
  62316. name: string;
  62317. shader: string;
  62318. };
  62319. }
  62320. declare module "babylonjs/Misc/minMaxReducer" {
  62321. import { Nullable } from "babylonjs/types";
  62322. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  62323. import { Camera } from "babylonjs/Cameras/camera";
  62324. import { Observer } from "babylonjs/Misc/observable";
  62325. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  62326. import { PostProcessManager } from "babylonjs/PostProcesses/postProcessManager";
  62327. import { Observable } from "babylonjs/Misc/observable";
  62328. import "babylonjs/Shaders/minmaxRedux.fragment";
  62329. /**
  62330. * This class computes a min/max reduction from a texture: it means it computes the minimum
  62331. * and maximum values from all values of the texture.
  62332. * It is performed on the GPU for better performances, thanks to a succession of post processes.
  62333. * The source values are read from the red channel of the texture.
  62334. */
  62335. export class MinMaxReducer {
  62336. /**
  62337. * Observable triggered when the computation has been performed
  62338. */
  62339. onAfterReductionPerformed: Observable<{
  62340. min: number;
  62341. max: number;
  62342. }>;
  62343. protected _camera: Camera;
  62344. protected _sourceTexture: Nullable<RenderTargetTexture>;
  62345. protected _reductionSteps: Nullable<Array<PostProcess>>;
  62346. protected _postProcessManager: PostProcessManager;
  62347. protected _onAfterUnbindObserver: Nullable<Observer<RenderTargetTexture>>;
  62348. protected _forceFullscreenViewport: boolean;
  62349. /**
  62350. * Creates a min/max reducer
  62351. * @param camera The camera to use for the post processes
  62352. */
  62353. constructor(camera: Camera);
  62354. /**
  62355. * Gets the texture used to read the values from.
  62356. */
  62357. get sourceTexture(): Nullable<RenderTargetTexture>;
  62358. /**
  62359. * Sets the source texture to read the values from.
  62360. * One must indicate if the texture is a depth texture or not through the depthRedux parameter
  62361. * because in such textures '1' value must not be taken into account to compute the maximum
  62362. * as this value is used to clear the texture.
  62363. * Note that the computation is not activated by calling this function, you must call activate() for that!
  62364. * @param sourceTexture The texture to read the values from. The values should be in the red channel.
  62365. * @param depthRedux Indicates if the texture is a depth texture or not
  62366. * @param type The type of the textures created for the reduction (defaults to TEXTURETYPE_HALF_FLOAT)
  62367. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  62368. */
  62369. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  62370. /**
  62371. * Defines the refresh rate of the computation.
  62372. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  62373. */
  62374. get refreshRate(): number;
  62375. set refreshRate(value: number);
  62376. protected _activated: boolean;
  62377. /**
  62378. * Gets the activation status of the reducer
  62379. */
  62380. get activated(): boolean;
  62381. /**
  62382. * Activates the reduction computation.
  62383. * When activated, the observers registered in onAfterReductionPerformed are
  62384. * called after the compuation is performed
  62385. */
  62386. activate(): void;
  62387. /**
  62388. * Deactivates the reduction computation.
  62389. */
  62390. deactivate(): void;
  62391. /**
  62392. * Disposes the min/max reducer
  62393. * @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.
  62394. */
  62395. dispose(disposeAll?: boolean): void;
  62396. }
  62397. }
  62398. declare module "babylonjs/Misc/depthReducer" {
  62399. import { Nullable } from "babylonjs/types";
  62400. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  62401. import { Camera } from "babylonjs/Cameras/camera";
  62402. import { DepthRenderer } from "babylonjs/Rendering/depthRenderer";
  62403. import { MinMaxReducer } from "babylonjs/Misc/minMaxReducer";
  62404. /**
  62405. * This class is a small wrapper around the MinMaxReducer class to compute the min/max values of a depth texture
  62406. */
  62407. export class DepthReducer extends MinMaxReducer {
  62408. private _depthRenderer;
  62409. private _depthRendererId;
  62410. /**
  62411. * Gets the depth renderer used for the computation.
  62412. * Note that the result is null if you provide your own renderer when calling setDepthRenderer.
  62413. */
  62414. get depthRenderer(): Nullable<DepthRenderer>;
  62415. /**
  62416. * Creates a depth reducer
  62417. * @param camera The camera used to render the depth texture
  62418. */
  62419. constructor(camera: Camera);
  62420. /**
  62421. * Sets the depth renderer to use to generate the depth map
  62422. * @param depthRenderer The depth renderer to use. If not provided, a new one will be created automatically
  62423. * @param type The texture type of the depth map (default: TEXTURETYPE_HALF_FLOAT)
  62424. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  62425. */
  62426. setDepthRenderer(depthRenderer?: Nullable<DepthRenderer>, type?: number, forceFullscreenViewport?: boolean): void;
  62427. /** @hidden */
  62428. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  62429. /**
  62430. * Activates the reduction computation.
  62431. * When activated, the observers registered in onAfterReductionPerformed are
  62432. * called after the compuation is performed
  62433. */
  62434. activate(): void;
  62435. /**
  62436. * Deactivates the reduction computation.
  62437. */
  62438. deactivate(): void;
  62439. /**
  62440. * Disposes the depth reducer
  62441. * @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.
  62442. */
  62443. dispose(disposeAll?: boolean): void;
  62444. }
  62445. }
  62446. declare module "babylonjs/Lights/Shadows/cascadedShadowGenerator" {
  62447. import { Nullable } from "babylonjs/types";
  62448. import { Scene } from "babylonjs/scene";
  62449. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  62450. import { SubMesh } from "babylonjs/Meshes/subMesh";
  62451. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  62452. import { Effect } from "babylonjs/Materials/effect";
  62453. import "babylonjs/Shaders/shadowMap.fragment";
  62454. import "babylonjs/Shaders/shadowMap.vertex";
  62455. import "babylonjs/Shaders/depthBoxBlur.fragment";
  62456. import { ShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  62457. import { DirectionalLight } from "babylonjs/Lights/directionalLight";
  62458. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  62459. import { DepthRenderer } from "babylonjs/Rendering/depthRenderer";
  62460. /**
  62461. * A CSM implementation allowing casting shadows on large scenes.
  62462. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  62463. * Based on: https://github.com/TheRealMJP/Shadows and https://johanmedestrom.wordpress.com/2016/03/18/opengl-cascaded-shadow-maps/
  62464. */
  62465. export class CascadedShadowGenerator extends ShadowGenerator {
  62466. private static readonly frustumCornersNDCSpace;
  62467. /**
  62468. * Name of the CSM class
  62469. */
  62470. static CLASSNAME: string;
  62471. /**
  62472. * Defines the default number of cascades used by the CSM.
  62473. */
  62474. static readonly DEFAULT_CASCADES_COUNT: number;
  62475. /**
  62476. * Defines the minimum number of cascades used by the CSM.
  62477. */
  62478. static readonly MIN_CASCADES_COUNT: number;
  62479. /**
  62480. * Defines the maximum number of cascades used by the CSM.
  62481. */
  62482. static readonly MAX_CASCADES_COUNT: number;
  62483. protected _validateFilter(filter: number): number;
  62484. /**
  62485. * Gets or sets the actual darkness of the soft shadows while using PCSS filtering (value between 0. and 1.)
  62486. */
  62487. penumbraDarkness: number;
  62488. private _numCascades;
  62489. /**
  62490. * Gets or set the number of cascades used by the CSM.
  62491. */
  62492. get numCascades(): number;
  62493. set numCascades(value: number);
  62494. /**
  62495. * Sets this to true if you want that the edges of the shadows don't "swimm" / "shimmer" when rotating the camera.
  62496. * The trade off is that you lose some precision in the shadow rendering when enabling this setting.
  62497. */
  62498. stabilizeCascades: boolean;
  62499. private _freezeShadowCastersBoundingInfo;
  62500. private _freezeShadowCastersBoundingInfoObservable;
  62501. /**
  62502. * Enables or disables the shadow casters bounding info computation.
  62503. * If your shadow casters don't move, you can disable this feature.
  62504. * If it is enabled, the bounding box computation is done every frame.
  62505. */
  62506. get freezeShadowCastersBoundingInfo(): boolean;
  62507. set freezeShadowCastersBoundingInfo(freeze: boolean);
  62508. private _scbiMin;
  62509. private _scbiMax;
  62510. protected _computeShadowCastersBoundingInfo(): void;
  62511. protected _shadowCastersBoundingInfo: BoundingInfo;
  62512. /**
  62513. * Gets or sets the shadow casters bounding info.
  62514. * If you provide your own shadow casters bounding info, first enable freezeShadowCastersBoundingInfo
  62515. * so that the system won't overwrite the bounds you provide
  62516. */
  62517. get shadowCastersBoundingInfo(): BoundingInfo;
  62518. set shadowCastersBoundingInfo(boundingInfo: BoundingInfo);
  62519. protected _breaksAreDirty: boolean;
  62520. protected _minDistance: number;
  62521. protected _maxDistance: number;
  62522. /**
  62523. * Sets the minimal and maximal distances to use when computing the cascade breaks.
  62524. *
  62525. * The values of min / max are typically the depth zmin and zmax values of your scene, for a given frame.
  62526. * If you don't know these values, simply leave them to their defaults and don't call this function.
  62527. * @param min minimal distance for the breaks (default to 0.)
  62528. * @param max maximal distance for the breaks (default to 1.)
  62529. */
  62530. setMinMaxDistance(min: number, max: number): void;
  62531. /** Gets the minimal distance used in the cascade break computation */
  62532. get minDistance(): number;
  62533. /** Gets the maximal distance used in the cascade break computation */
  62534. get maxDistance(): number;
  62535. /**
  62536. * Gets the class name of that object
  62537. * @returns "CascadedShadowGenerator"
  62538. */
  62539. getClassName(): string;
  62540. private _cascadeMinExtents;
  62541. private _cascadeMaxExtents;
  62542. /**
  62543. * Gets a cascade minimum extents
  62544. * @param cascadeIndex index of the cascade
  62545. * @returns the minimum cascade extents
  62546. */
  62547. getCascadeMinExtents(cascadeIndex: number): Nullable<Vector3>;
  62548. /**
  62549. * Gets a cascade maximum extents
  62550. * @param cascadeIndex index of the cascade
  62551. * @returns the maximum cascade extents
  62552. */
  62553. getCascadeMaxExtents(cascadeIndex: number): Nullable<Vector3>;
  62554. private _cascades;
  62555. private _currentLayer;
  62556. private _viewSpaceFrustumsZ;
  62557. private _viewMatrices;
  62558. private _projectionMatrices;
  62559. private _transformMatrices;
  62560. private _transformMatricesAsArray;
  62561. private _frustumLengths;
  62562. private _lightSizeUVCorrection;
  62563. private _depthCorrection;
  62564. private _frustumCornersWorldSpace;
  62565. private _frustumCenter;
  62566. private _shadowCameraPos;
  62567. private _shadowMaxZ;
  62568. /**
  62569. * Gets the shadow max z distance. It's the limit beyond which shadows are not displayed.
  62570. * It defaults to camera.maxZ
  62571. */
  62572. get shadowMaxZ(): number;
  62573. /**
  62574. * Sets the shadow max z distance.
  62575. */
  62576. set shadowMaxZ(value: number);
  62577. protected _debug: boolean;
  62578. /**
  62579. * Gets or sets the debug flag.
  62580. * When enabled, the cascades are materialized by different colors on the screen.
  62581. */
  62582. get debug(): boolean;
  62583. set debug(dbg: boolean);
  62584. private _depthClamp;
  62585. /**
  62586. * Gets or sets the depth clamping value.
  62587. *
  62588. * When enabled, it improves the shadow quality because the near z plane of the light frustum don't need to be adjusted
  62589. * to account for the shadow casters far away.
  62590. *
  62591. * Note that this property is incompatible with PCSS filtering, so it won't be used in that case.
  62592. */
  62593. get depthClamp(): boolean;
  62594. set depthClamp(value: boolean);
  62595. private _cascadeBlendPercentage;
  62596. /**
  62597. * Gets or sets the percentage of blending between two cascades (value between 0. and 1.).
  62598. * It defaults to 0.1 (10% blending).
  62599. */
  62600. get cascadeBlendPercentage(): number;
  62601. set cascadeBlendPercentage(value: number);
  62602. private _lambda;
  62603. /**
  62604. * Gets or set the lambda parameter.
  62605. * This parameter is used to split the camera frustum and create the cascades.
  62606. * 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.
  62607. * For all values in-between, it's a linear combination of the uniform and logarithm split algorithm.
  62608. */
  62609. get lambda(): number;
  62610. set lambda(value: number);
  62611. /**
  62612. * Gets the view matrix corresponding to a given cascade
  62613. * @param cascadeNum cascade to retrieve the view matrix from
  62614. * @returns the cascade view matrix
  62615. */
  62616. getCascadeViewMatrix(cascadeNum: number): Nullable<Matrix>;
  62617. /**
  62618. * Gets the projection matrix corresponding to a given cascade
  62619. * @param cascadeNum cascade to retrieve the projection matrix from
  62620. * @returns the cascade projection matrix
  62621. */
  62622. getCascadeProjectionMatrix(cascadeNum: number): Nullable<Matrix>;
  62623. /**
  62624. * Gets the transformation matrix corresponding to a given cascade
  62625. * @param cascadeNum cascade to retrieve the transformation matrix from
  62626. * @returns the cascade transformation matrix
  62627. */
  62628. getCascadeTransformMatrix(cascadeNum: number): Nullable<Matrix>;
  62629. private _depthRenderer;
  62630. /**
  62631. * Sets the depth renderer to use when autoCalcDepthBounds is enabled.
  62632. *
  62633. * Note that if no depth renderer is set, a new one will be automatically created internally when necessary.
  62634. *
  62635. * You should call this function if you already have a depth renderer enabled in your scene, to avoid
  62636. * doing multiple depth rendering each frame. If you provide your own depth renderer, make sure it stores linear depth!
  62637. * @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
  62638. */
  62639. setDepthRenderer(depthRenderer: Nullable<DepthRenderer>): void;
  62640. private _depthReducer;
  62641. private _autoCalcDepthBounds;
  62642. /**
  62643. * Gets or sets the autoCalcDepthBounds property.
  62644. *
  62645. * When enabled, a depth rendering pass is first performed (with an internally created depth renderer or with the one
  62646. * you provide by calling setDepthRenderer). Then, a min/max reducing is applied on the depth map to compute the
  62647. * minimal and maximal depth of the map and those values are used as inputs for the setMinMaxDistance() function.
  62648. * It can greatly enhance the shadow quality, at the expense of more GPU works.
  62649. * When using this option, you should increase the value of the lambda parameter, and even set it to 1 for best results.
  62650. */
  62651. get autoCalcDepthBounds(): boolean;
  62652. set autoCalcDepthBounds(value: boolean);
  62653. /**
  62654. * Defines the refresh rate of the min/max computation used when autoCalcDepthBounds is set to true
  62655. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  62656. * Note that if you provided your own depth renderer through a call to setDepthRenderer, you are responsible
  62657. * for setting the refresh rate on the renderer yourself!
  62658. */
  62659. get autoCalcDepthBoundsRefreshRate(): number;
  62660. set autoCalcDepthBoundsRefreshRate(value: number);
  62661. /**
  62662. * Create the cascade breaks according to the lambda, shadowMaxZ and min/max distance properties, as well as the camera near and far planes.
  62663. * This function is automatically called when updating lambda, shadowMaxZ and min/max distances, however you should call it yourself if
  62664. * you change the camera near/far planes!
  62665. */
  62666. splitFrustum(): void;
  62667. private _splitFrustum;
  62668. private _computeMatrices;
  62669. private _computeFrustumInWorldSpace;
  62670. private _computeCascadeFrustum;
  62671. /**
  62672. * Support test.
  62673. */
  62674. static get IsSupported(): boolean;
  62675. /** @hidden */
  62676. static _SceneComponentInitialization: (scene: Scene) => void;
  62677. /**
  62678. * Creates a Cascaded Shadow Generator object.
  62679. * A ShadowGenerator is the required tool to use the shadows.
  62680. * Each directional light casting shadows needs to use its own ShadowGenerator.
  62681. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  62682. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  62683. * @param light The directional light object generating the shadows.
  62684. * @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.
  62685. */
  62686. constructor(mapSize: number, light: DirectionalLight, usefulFloatFirst?: boolean);
  62687. protected _initializeGenerator(): void;
  62688. protected _createTargetRenderTexture(): void;
  62689. protected _initializeShadowMap(): void;
  62690. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  62691. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  62692. /**
  62693. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  62694. * @param defines Defines of the material we want to update
  62695. * @param lightIndex Index of the light in the enabled light list of the material
  62696. */
  62697. prepareDefines(defines: any, lightIndex: number): void;
  62698. /**
  62699. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  62700. * defined in the generator but impacting the effect).
  62701. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  62702. * @param effect The effect we are binfing the information for
  62703. */
  62704. bindShadowLight(lightIndex: string, effect: Effect): void;
  62705. /**
  62706. * Gets the transformation matrix of the first cascade used to project the meshes into the map from the light point of view.
  62707. * (eq to view projection * shadow projection matrices)
  62708. * @returns The transform matrix used to create the shadow map
  62709. */
  62710. getTransformMatrix(): Matrix;
  62711. /**
  62712. * Disposes the ShadowGenerator.
  62713. * Returns nothing.
  62714. */
  62715. dispose(): void;
  62716. /**
  62717. * Serializes the shadow generator setup to a json object.
  62718. * @returns The serialized JSON object
  62719. */
  62720. serialize(): any;
  62721. /**
  62722. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  62723. * @param parsedShadowGenerator The JSON object to parse
  62724. * @param scene The scene to create the shadow map for
  62725. * @returns The parsed shadow generator
  62726. */
  62727. static Parse(parsedShadowGenerator: any, scene: Scene): ShadowGenerator;
  62728. }
  62729. }
  62730. declare module "babylonjs/Lights/Shadows/shadowGeneratorSceneComponent" {
  62731. import { Scene } from "babylonjs/scene";
  62732. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  62733. import { AbstractScene } from "babylonjs/abstractScene";
  62734. /**
  62735. * Defines the shadow generator component responsible to manage any shadow generators
  62736. * in a given scene.
  62737. */
  62738. export class ShadowGeneratorSceneComponent implements ISceneSerializableComponent {
  62739. /**
  62740. * The component name helpfull to identify the component in the list of scene components.
  62741. */
  62742. readonly name: string;
  62743. /**
  62744. * The scene the component belongs to.
  62745. */
  62746. scene: Scene;
  62747. /**
  62748. * Creates a new instance of the component for the given scene
  62749. * @param scene Defines the scene to register the component in
  62750. */
  62751. constructor(scene: Scene);
  62752. /**
  62753. * Registers the component in a given scene
  62754. */
  62755. register(): void;
  62756. /**
  62757. * Rebuilds the elements related to this component in case of
  62758. * context lost for instance.
  62759. */
  62760. rebuild(): void;
  62761. /**
  62762. * Serializes the component data to the specified json object
  62763. * @param serializationObject The object to serialize to
  62764. */
  62765. serialize(serializationObject: any): void;
  62766. /**
  62767. * Adds all the elements from the container to the scene
  62768. * @param container the container holding the elements
  62769. */
  62770. addFromContainer(container: AbstractScene): void;
  62771. /**
  62772. * Removes all the elements in the container from the scene
  62773. * @param container contains the elements to remove
  62774. * @param dispose if the removed element should be disposed (default: false)
  62775. */
  62776. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  62777. /**
  62778. * Rebuilds the elements related to this component in case of
  62779. * context lost for instance.
  62780. */
  62781. dispose(): void;
  62782. private _gatherRenderTargets;
  62783. }
  62784. }
  62785. declare module "babylonjs/Lights/Shadows/index" {
  62786. export * from "babylonjs/Lights/Shadows/shadowGenerator";
  62787. export * from "babylonjs/Lights/Shadows/cascadedShadowGenerator";
  62788. export * from "babylonjs/Lights/Shadows/shadowGeneratorSceneComponent";
  62789. }
  62790. declare module "babylonjs/Lights/pointLight" {
  62791. import { Scene } from "babylonjs/scene";
  62792. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  62793. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  62794. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  62795. import { Effect } from "babylonjs/Materials/effect";
  62796. /**
  62797. * A point light is a light defined by an unique point in world space.
  62798. * The light is emitted in every direction from this point.
  62799. * A good example of a point light is a standard light bulb.
  62800. * Documentation: https://doc.babylonjs.com/babylon101/lights
  62801. */
  62802. export class PointLight extends ShadowLight {
  62803. private _shadowAngle;
  62804. /**
  62805. * Getter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  62806. * This specifies what angle the shadow will use to be created.
  62807. *
  62808. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  62809. */
  62810. get shadowAngle(): number;
  62811. /**
  62812. * Setter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  62813. * This specifies what angle the shadow will use to be created.
  62814. *
  62815. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  62816. */
  62817. set shadowAngle(value: number);
  62818. /**
  62819. * Gets the direction if it has been set.
  62820. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  62821. */
  62822. get direction(): Vector3;
  62823. /**
  62824. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  62825. */
  62826. set direction(value: Vector3);
  62827. /**
  62828. * Creates a PointLight object from the passed name and position (Vector3) and adds it in the scene.
  62829. * A PointLight emits the light in every direction.
  62830. * It can cast shadows.
  62831. * If the scene camera is already defined and you want to set your PointLight at the camera position, just set it :
  62832. * ```javascript
  62833. * var pointLight = new PointLight("pl", camera.position, scene);
  62834. * ```
  62835. * Documentation : https://doc.babylonjs.com/babylon101/lights
  62836. * @param name The light friendly name
  62837. * @param position The position of the point light in the scene
  62838. * @param scene The scene the lights belongs to
  62839. */
  62840. constructor(name: string, position: Vector3, scene: Scene);
  62841. /**
  62842. * Returns the string "PointLight"
  62843. * @returns the class name
  62844. */
  62845. getClassName(): string;
  62846. /**
  62847. * Returns the integer 0.
  62848. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  62849. */
  62850. getTypeID(): number;
  62851. /**
  62852. * Specifies wether or not the shadowmap should be a cube texture.
  62853. * @returns true if the shadowmap needs to be a cube texture.
  62854. */
  62855. needCube(): boolean;
  62856. /**
  62857. * Returns a new Vector3 aligned with the PointLight cube system according to the passed cube face index (integer).
  62858. * @param faceIndex The index of the face we are computed the direction to generate shadow
  62859. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  62860. */
  62861. getShadowDirection(faceIndex?: number): Vector3;
  62862. /**
  62863. * Sets the passed matrix "matrix" as a left-handed perspective projection matrix with the following settings :
  62864. * - fov = PI / 2
  62865. * - aspect ratio : 1.0
  62866. * - z-near and far equal to the active camera minZ and maxZ.
  62867. * Returns the PointLight.
  62868. */
  62869. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  62870. protected _buildUniformLayout(): void;
  62871. /**
  62872. * Sets the passed Effect "effect" with the PointLight transformed position (or position, if none) and passed name (string).
  62873. * @param effect The effect to update
  62874. * @param lightIndex The index of the light in the effect to update
  62875. * @returns The point light
  62876. */
  62877. transferToEffect(effect: Effect, lightIndex: string): PointLight;
  62878. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  62879. /**
  62880. * Prepares the list of defines specific to the light type.
  62881. * @param defines the list of defines
  62882. * @param lightIndex defines the index of the light for the effect
  62883. */
  62884. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  62885. }
  62886. }
  62887. declare module "babylonjs/Lights/index" {
  62888. export * from "babylonjs/Lights/light";
  62889. export * from "babylonjs/Lights/shadowLight";
  62890. export * from "babylonjs/Lights/Shadows/index";
  62891. export * from "babylonjs/Lights/directionalLight";
  62892. export * from "babylonjs/Lights/hemisphericLight";
  62893. export * from "babylonjs/Lights/pointLight";
  62894. export * from "babylonjs/Lights/spotLight";
  62895. }
  62896. declare module "babylonjs/Misc/HighDynamicRange/hdr" {
  62897. import { CubeMapInfo } from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  62898. /**
  62899. * Header information of HDR texture files.
  62900. */
  62901. export interface HDRInfo {
  62902. /**
  62903. * The height of the texture in pixels.
  62904. */
  62905. height: number;
  62906. /**
  62907. * The width of the texture in pixels.
  62908. */
  62909. width: number;
  62910. /**
  62911. * The index of the beginning of the data in the binary file.
  62912. */
  62913. dataPosition: number;
  62914. }
  62915. /**
  62916. * This groups tools to convert HDR texture to native colors array.
  62917. */
  62918. export class HDRTools {
  62919. private static Ldexp;
  62920. private static Rgbe2float;
  62921. private static readStringLine;
  62922. /**
  62923. * Reads header information from an RGBE texture stored in a native array.
  62924. * More information on this format are available here:
  62925. * https://en.wikipedia.org/wiki/RGBE_image_format
  62926. *
  62927. * @param uint8array The binary file stored in native array.
  62928. * @return The header information.
  62929. */
  62930. static RGBE_ReadHeader(uint8array: Uint8Array): HDRInfo;
  62931. /**
  62932. * Returns the cubemap information (each faces texture data) extracted from an RGBE texture.
  62933. * This RGBE texture needs to store the information as a panorama.
  62934. *
  62935. * More information on this format are available here:
  62936. * https://en.wikipedia.org/wiki/RGBE_image_format
  62937. *
  62938. * @param buffer The binary file stored in an array buffer.
  62939. * @param size The expected size of the extracted cubemap.
  62940. * @return The Cube Map information.
  62941. */
  62942. static GetCubeMapTextureData(buffer: ArrayBuffer, size: number): CubeMapInfo;
  62943. /**
  62944. * Returns the pixels data extracted from an RGBE texture.
  62945. * This pixels will be stored left to right up to down in the R G B order in one array.
  62946. *
  62947. * More information on this format are available here:
  62948. * https://en.wikipedia.org/wiki/RGBE_image_format
  62949. *
  62950. * @param uint8array The binary file stored in an array buffer.
  62951. * @param hdrInfo The header information of the file.
  62952. * @return The pixels data in RGB right to left up to down order.
  62953. */
  62954. static RGBE_ReadPixels(uint8array: Uint8Array, hdrInfo: HDRInfo): Float32Array;
  62955. private static RGBE_ReadPixels_RLE;
  62956. private static RGBE_ReadPixels_NOT_RLE;
  62957. }
  62958. }
  62959. declare module "babylonjs/Materials/effectRenderer" {
  62960. import { Nullable } from "babylonjs/types";
  62961. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  62962. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  62963. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  62964. import { Viewport } from "babylonjs/Maths/math.viewport";
  62965. import { Observable } from "babylonjs/Misc/observable";
  62966. import { Effect } from "babylonjs/Materials/effect";
  62967. import "babylonjs/Shaders/postprocess.vertex";
  62968. /**
  62969. * Effect Render Options
  62970. */
  62971. export interface IEffectRendererOptions {
  62972. /**
  62973. * Defines the vertices positions.
  62974. */
  62975. positions?: number[];
  62976. /**
  62977. * Defines the indices.
  62978. */
  62979. indices?: number[];
  62980. }
  62981. /**
  62982. * Helper class to render one or more effects.
  62983. * You can access the previous rendering in your shader by declaring a sampler named textureSampler
  62984. */
  62985. export class EffectRenderer {
  62986. private engine;
  62987. private static _DefaultOptions;
  62988. private _vertexBuffers;
  62989. private _indexBuffer;
  62990. private _fullscreenViewport;
  62991. /**
  62992. * Creates an effect renderer
  62993. * @param engine the engine to use for rendering
  62994. * @param options defines the options of the effect renderer
  62995. */
  62996. constructor(engine: ThinEngine, options?: IEffectRendererOptions);
  62997. /**
  62998. * Sets the current viewport in normalized coordinates 0-1
  62999. * @param viewport Defines the viewport to set (defaults to 0 0 1 1)
  63000. */
  63001. setViewport(viewport?: Viewport): void;
  63002. /**
  63003. * Binds the embedded attributes buffer to the effect.
  63004. * @param effect Defines the effect to bind the attributes for
  63005. */
  63006. bindBuffers(effect: Effect): void;
  63007. /**
  63008. * Sets the current effect wrapper to use during draw.
  63009. * The effect needs to be ready before calling this api.
  63010. * This also sets the default full screen position attribute.
  63011. * @param effectWrapper Defines the effect to draw with
  63012. */
  63013. applyEffectWrapper(effectWrapper: EffectWrapper): void;
  63014. /**
  63015. * Restores engine states
  63016. */
  63017. restoreStates(): void;
  63018. /**
  63019. * Draws a full screen quad.
  63020. */
  63021. draw(): void;
  63022. private isRenderTargetTexture;
  63023. /**
  63024. * renders one or more effects to a specified texture
  63025. * @param effectWrapper the effect to renderer
  63026. * @param outputTexture texture to draw to, if null it will render to the screen.
  63027. */
  63028. render(effectWrapper: EffectWrapper, outputTexture?: Nullable<InternalTexture | RenderTargetTexture>): void;
  63029. /**
  63030. * Disposes of the effect renderer
  63031. */
  63032. dispose(): void;
  63033. }
  63034. /**
  63035. * Options to create an EffectWrapper
  63036. */
  63037. interface EffectWrapperCreationOptions {
  63038. /**
  63039. * Engine to use to create the effect
  63040. */
  63041. engine: ThinEngine;
  63042. /**
  63043. * Fragment shader for the effect
  63044. */
  63045. fragmentShader: string;
  63046. /**
  63047. * Use the shader store instead of direct source code
  63048. */
  63049. useShaderStore?: boolean;
  63050. /**
  63051. * Vertex shader for the effect
  63052. */
  63053. vertexShader?: string;
  63054. /**
  63055. * Attributes to use in the shader
  63056. */
  63057. attributeNames?: Array<string>;
  63058. /**
  63059. * Uniforms to use in the shader
  63060. */
  63061. uniformNames?: Array<string>;
  63062. /**
  63063. * Texture sampler names to use in the shader
  63064. */
  63065. samplerNames?: Array<string>;
  63066. /**
  63067. * Defines to use in the shader
  63068. */
  63069. defines?: Array<string>;
  63070. /**
  63071. * Callback when effect is compiled
  63072. */
  63073. onCompiled?: Nullable<(effect: Effect) => void>;
  63074. /**
  63075. * The friendly name of the effect displayed in Spector.
  63076. */
  63077. name?: string;
  63078. }
  63079. /**
  63080. * Wraps an effect to be used for rendering
  63081. */
  63082. export class EffectWrapper {
  63083. /**
  63084. * Event that is fired right before the effect is drawn (should be used to update uniforms)
  63085. */
  63086. onApplyObservable: Observable<{}>;
  63087. /**
  63088. * The underlying effect
  63089. */
  63090. effect: Effect;
  63091. /**
  63092. * Creates an effect to be renderer
  63093. * @param creationOptions options to create the effect
  63094. */
  63095. constructor(creationOptions: EffectWrapperCreationOptions);
  63096. /**
  63097. * Disposes of the effect wrapper
  63098. */
  63099. dispose(): void;
  63100. }
  63101. }
  63102. declare module "babylonjs/Shaders/hdrFiltering.vertex" {
  63103. /** @hidden */
  63104. export var hdrFilteringVertexShader: {
  63105. name: string;
  63106. shader: string;
  63107. };
  63108. }
  63109. declare module "babylonjs/Shaders/hdrFiltering.fragment" {
  63110. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  63111. import "babylonjs/Shaders/ShadersInclude/importanceSampling";
  63112. import "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions";
  63113. import "babylonjs/Shaders/ShadersInclude/hdrFilteringFunctions";
  63114. /** @hidden */
  63115. export var hdrFilteringPixelShader: {
  63116. name: string;
  63117. shader: string;
  63118. };
  63119. }
  63120. declare module "babylonjs/Materials/Textures/Filtering/hdrFiltering" {
  63121. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  63122. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  63123. import { Nullable } from "babylonjs/types";
  63124. import "babylonjs/Shaders/hdrFiltering.vertex";
  63125. import "babylonjs/Shaders/hdrFiltering.fragment";
  63126. /**
  63127. * Options for texture filtering
  63128. */
  63129. interface IHDRFilteringOptions {
  63130. /**
  63131. * Scales pixel intensity for the input HDR map.
  63132. */
  63133. hdrScale?: number;
  63134. /**
  63135. * Quality of the filter. Should be `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` for prefiltering
  63136. */
  63137. quality?: number;
  63138. }
  63139. /**
  63140. * Filters HDR maps to get correct renderings of PBR reflections
  63141. */
  63142. export class HDRFiltering {
  63143. private _engine;
  63144. private _effectRenderer;
  63145. private _effectWrapper;
  63146. private _lodGenerationOffset;
  63147. private _lodGenerationScale;
  63148. /**
  63149. * Quality switch for prefiltering. Should be set to `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` unless
  63150. * you care about baking speed.
  63151. */
  63152. quality: number;
  63153. /**
  63154. * Scales pixel intensity for the input HDR map.
  63155. */
  63156. hdrScale: number;
  63157. /**
  63158. * Instantiates HDR filter for reflection maps
  63159. *
  63160. * @param engine Thin engine
  63161. * @param options Options
  63162. */
  63163. constructor(engine: ThinEngine, options?: IHDRFilteringOptions);
  63164. private _createRenderTarget;
  63165. private _prefilterInternal;
  63166. private _createEffect;
  63167. /**
  63168. * Get a value indicating if the filter is ready to be used
  63169. * @param texture Texture to filter
  63170. * @returns true if the filter is ready
  63171. */
  63172. isReady(texture: BaseTexture): boolean;
  63173. /**
  63174. * Prefilters a cube texture to have mipmap levels representing roughness values.
  63175. * Prefiltering will be invoked at the end of next rendering pass.
  63176. * This has to be done once the map is loaded, and has not been prefiltered by a third party software.
  63177. * See http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf for more information
  63178. * @param texture Texture to filter
  63179. * @param onFinished Callback when filtering is done
  63180. * @return Promise called when prefiltering is done
  63181. */
  63182. prefilter(texture: BaseTexture, onFinished?: Nullable<() => void>): Promise<unknown> | undefined;
  63183. }
  63184. }
  63185. declare module "babylonjs/Materials/Textures/hdrCubeTexture" {
  63186. import { Nullable } from "babylonjs/types";
  63187. import { Scene } from "babylonjs/scene";
  63188. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  63189. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  63190. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  63191. import "babylonjs/Engines/Extensions/engine.rawTexture";
  63192. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  63193. /**
  63194. * This represents a texture coming from an HDR input.
  63195. *
  63196. * The only supported format is currently panorama picture stored in RGBE format.
  63197. * Example of such files can be found on HDRLib: http://hdrlib.com/
  63198. */
  63199. export class HDRCubeTexture extends BaseTexture {
  63200. private static _facesMapping;
  63201. private _generateHarmonics;
  63202. private _noMipmap;
  63203. private _prefilterOnLoad;
  63204. private _textureMatrix;
  63205. private _size;
  63206. private _onLoad;
  63207. private _onError;
  63208. /**
  63209. * The texture URL.
  63210. */
  63211. url: string;
  63212. protected _isBlocking: boolean;
  63213. /**
  63214. * Sets wether or not the texture is blocking during loading.
  63215. */
  63216. set isBlocking(value: boolean);
  63217. /**
  63218. * Gets wether or not the texture is blocking during loading.
  63219. */
  63220. get isBlocking(): boolean;
  63221. protected _rotationY: number;
  63222. /**
  63223. * Sets texture matrix rotation angle around Y axis in radians.
  63224. */
  63225. set rotationY(value: number);
  63226. /**
  63227. * Gets texture matrix rotation angle around Y axis radians.
  63228. */
  63229. get rotationY(): number;
  63230. /**
  63231. * Gets or sets the center of the bounding box associated with the cube texture
  63232. * It must define where the camera used to render the texture was set
  63233. */
  63234. boundingBoxPosition: Vector3;
  63235. private _boundingBoxSize;
  63236. /**
  63237. * Gets or sets the size of the bounding box associated with the cube texture
  63238. * When defined, the cubemap will switch to local mode
  63239. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  63240. * @example https://www.babylonjs-playground.com/#RNASML
  63241. */
  63242. set boundingBoxSize(value: Vector3);
  63243. get boundingBoxSize(): Vector3;
  63244. /**
  63245. * Instantiates an HDRTexture from the following parameters.
  63246. *
  63247. * @param url The location of the HDR raw data (Panorama stored in RGBE format)
  63248. * @param sceneOrEngine The scene or engine the texture will be used in
  63249. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  63250. * @param noMipmap Forces to not generate the mipmap if true
  63251. * @param generateHarmonics Specifies whether you want to extract the polynomial harmonics during the generation process
  63252. * @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)
  63253. * @param prefilterOnLoad Prefilters HDR texture to allow use of this texture as a PBR reflection texture.
  63254. */
  63255. 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>);
  63256. /**
  63257. * Get the current class name of the texture useful for serialization or dynamic coding.
  63258. * @returns "HDRCubeTexture"
  63259. */
  63260. getClassName(): string;
  63261. /**
  63262. * Occurs when the file is raw .hdr file.
  63263. */
  63264. private loadTexture;
  63265. clone(): HDRCubeTexture;
  63266. delayLoad(): void;
  63267. /**
  63268. * Get the texture reflection matrix used to rotate/transform the reflection.
  63269. * @returns the reflection matrix
  63270. */
  63271. getReflectionTextureMatrix(): Matrix;
  63272. /**
  63273. * Set the texture reflection matrix used to rotate/transform the reflection.
  63274. * @param value Define the reflection matrix to set
  63275. */
  63276. setReflectionTextureMatrix(value: Matrix): void;
  63277. /**
  63278. * Parses a JSON representation of an HDR Texture in order to create the texture
  63279. * @param parsedTexture Define the JSON representation
  63280. * @param scene Define the scene the texture should be created in
  63281. * @param rootUrl Define the root url in case we need to load relative dependencies
  63282. * @returns the newly created texture after parsing
  63283. */
  63284. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<HDRCubeTexture>;
  63285. serialize(): any;
  63286. }
  63287. }
  63288. declare module "babylonjs/Physics/physicsEngine" {
  63289. import { Nullable } from "babylonjs/types";
  63290. import { Vector3 } from "babylonjs/Maths/math.vector";
  63291. import { IPhysicsEngine, IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  63292. import { PhysicsImpostor, IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  63293. import { PhysicsJoint } from "babylonjs/Physics/physicsJoint";
  63294. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  63295. /**
  63296. * Class used to control physics engine
  63297. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  63298. */
  63299. export class PhysicsEngine implements IPhysicsEngine {
  63300. private _physicsPlugin;
  63301. /**
  63302. * Global value used to control the smallest number supported by the simulation
  63303. */
  63304. static Epsilon: number;
  63305. private _impostors;
  63306. private _joints;
  63307. private _subTimeStep;
  63308. /**
  63309. * Gets the gravity vector used by the simulation
  63310. */
  63311. gravity: Vector3;
  63312. /**
  63313. * Factory used to create the default physics plugin.
  63314. * @returns The default physics plugin
  63315. */
  63316. static DefaultPluginFactory(): IPhysicsEnginePlugin;
  63317. /**
  63318. * Creates a new Physics Engine
  63319. * @param gravity defines the gravity vector used by the simulation
  63320. * @param _physicsPlugin defines the plugin to use (CannonJS by default)
  63321. */
  63322. constructor(gravity: Nullable<Vector3>, _physicsPlugin?: IPhysicsEnginePlugin);
  63323. /**
  63324. * Sets the gravity vector used by the simulation
  63325. * @param gravity defines the gravity vector to use
  63326. */
  63327. setGravity(gravity: Vector3): void;
  63328. /**
  63329. * Set the time step of the physics engine.
  63330. * Default is 1/60.
  63331. * To slow it down, enter 1/600 for example.
  63332. * To speed it up, 1/30
  63333. * @param newTimeStep defines the new timestep to apply to this world.
  63334. */
  63335. setTimeStep(newTimeStep?: number): void;
  63336. /**
  63337. * Get the time step of the physics engine.
  63338. * @returns the current time step
  63339. */
  63340. getTimeStep(): number;
  63341. /**
  63342. * Set the sub time step of the physics engine.
  63343. * Default is 0 meaning there is no sub steps
  63344. * To increase physics resolution precision, set a small value (like 1 ms)
  63345. * @param subTimeStep defines the new sub timestep used for physics resolution.
  63346. */
  63347. setSubTimeStep(subTimeStep?: number): void;
  63348. /**
  63349. * Get the sub time step of the physics engine.
  63350. * @returns the current sub time step
  63351. */
  63352. getSubTimeStep(): number;
  63353. /**
  63354. * Release all resources
  63355. */
  63356. dispose(): void;
  63357. /**
  63358. * Gets the name of the current physics plugin
  63359. * @returns the name of the plugin
  63360. */
  63361. getPhysicsPluginName(): string;
  63362. /**
  63363. * Adding a new impostor for the impostor tracking.
  63364. * This will be done by the impostor itself.
  63365. * @param impostor the impostor to add
  63366. */
  63367. addImpostor(impostor: PhysicsImpostor): void;
  63368. /**
  63369. * Remove an impostor from the engine.
  63370. * This impostor and its mesh will not longer be updated by the physics engine.
  63371. * @param impostor the impostor to remove
  63372. */
  63373. removeImpostor(impostor: PhysicsImpostor): void;
  63374. /**
  63375. * Add a joint to the physics engine
  63376. * @param mainImpostor defines the main impostor to which the joint is added.
  63377. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  63378. * @param joint defines the joint that will connect both impostors.
  63379. */
  63380. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  63381. /**
  63382. * Removes a joint from the simulation
  63383. * @param mainImpostor defines the impostor used with the joint
  63384. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  63385. * @param joint defines the joint to remove
  63386. */
  63387. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  63388. /**
  63389. * Called by the scene. No need to call it.
  63390. * @param delta defines the timespam between frames
  63391. */
  63392. _step(delta: number): void;
  63393. /**
  63394. * Gets the current plugin used to run the simulation
  63395. * @returns current plugin
  63396. */
  63397. getPhysicsPlugin(): IPhysicsEnginePlugin;
  63398. /**
  63399. * Gets the list of physic impostors
  63400. * @returns an array of PhysicsImpostor
  63401. */
  63402. getImpostors(): Array<PhysicsImpostor>;
  63403. /**
  63404. * Gets the impostor for a physics enabled object
  63405. * @param object defines the object impersonated by the impostor
  63406. * @returns the PhysicsImpostor or null if not found
  63407. */
  63408. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  63409. /**
  63410. * Gets the impostor for a physics body object
  63411. * @param body defines physics body used by the impostor
  63412. * @returns the PhysicsImpostor or null if not found
  63413. */
  63414. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  63415. /**
  63416. * Does a raycast in the physics world
  63417. * @param from when should the ray start?
  63418. * @param to when should the ray end?
  63419. * @returns PhysicsRaycastResult
  63420. */
  63421. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  63422. }
  63423. }
  63424. declare module "babylonjs/Physics/Plugins/cannonJSPlugin" {
  63425. import { Nullable } from "babylonjs/types";
  63426. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  63427. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  63428. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  63429. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  63430. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  63431. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  63432. /** @hidden */
  63433. export class CannonJSPlugin implements IPhysicsEnginePlugin {
  63434. private _useDeltaForWorldStep;
  63435. world: any;
  63436. name: string;
  63437. private _physicsMaterials;
  63438. private _fixedTimeStep;
  63439. private _cannonRaycastResult;
  63440. private _raycastResult;
  63441. private _physicsBodysToRemoveAfterStep;
  63442. private _firstFrame;
  63443. BJSCANNON: any;
  63444. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, cannonInjection?: any);
  63445. setGravity(gravity: Vector3): void;
  63446. setTimeStep(timeStep: number): void;
  63447. getTimeStep(): number;
  63448. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  63449. private _removeMarkedPhysicsBodiesFromWorld;
  63450. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63451. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63452. generatePhysicsBody(impostor: PhysicsImpostor): void;
  63453. private _processChildMeshes;
  63454. removePhysicsBody(impostor: PhysicsImpostor): void;
  63455. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  63456. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  63457. private _addMaterial;
  63458. private _checkWithEpsilon;
  63459. private _createShape;
  63460. private _createHeightmap;
  63461. private _minus90X;
  63462. private _plus90X;
  63463. private _tmpPosition;
  63464. private _tmpDeltaPosition;
  63465. private _tmpUnityRotation;
  63466. private _updatePhysicsBodyTransformation;
  63467. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  63468. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  63469. isSupported(): boolean;
  63470. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63471. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63472. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63473. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63474. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  63475. getBodyMass(impostor: PhysicsImpostor): number;
  63476. getBodyFriction(impostor: PhysicsImpostor): number;
  63477. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  63478. getBodyRestitution(impostor: PhysicsImpostor): number;
  63479. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  63480. sleepBody(impostor: PhysicsImpostor): void;
  63481. wakeUpBody(impostor: PhysicsImpostor): void;
  63482. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number): void;
  63483. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  63484. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  63485. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  63486. getRadius(impostor: PhysicsImpostor): number;
  63487. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  63488. dispose(): void;
  63489. private _extendNamespace;
  63490. /**
  63491. * Does a raycast in the physics world
  63492. * @param from when should the ray start?
  63493. * @param to when should the ray end?
  63494. * @returns PhysicsRaycastResult
  63495. */
  63496. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  63497. }
  63498. }
  63499. declare module "babylonjs/Physics/Plugins/oimoJSPlugin" {
  63500. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  63501. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  63502. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  63503. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  63504. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  63505. import { Nullable } from "babylonjs/types";
  63506. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  63507. /** @hidden */
  63508. export class OimoJSPlugin implements IPhysicsEnginePlugin {
  63509. private _useDeltaForWorldStep;
  63510. world: any;
  63511. name: string;
  63512. BJSOIMO: any;
  63513. private _raycastResult;
  63514. private _fixedTimeStep;
  63515. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, oimoInjection?: any);
  63516. setGravity(gravity: Vector3): void;
  63517. setTimeStep(timeStep: number): void;
  63518. getTimeStep(): number;
  63519. private _tmpImpostorsArray;
  63520. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  63521. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63522. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63523. generatePhysicsBody(impostor: PhysicsImpostor): void;
  63524. private _tmpPositionVector;
  63525. removePhysicsBody(impostor: PhysicsImpostor): void;
  63526. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  63527. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  63528. isSupported(): boolean;
  63529. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  63530. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  63531. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63532. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63533. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63534. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63535. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  63536. getBodyMass(impostor: PhysicsImpostor): number;
  63537. getBodyFriction(impostor: PhysicsImpostor): number;
  63538. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  63539. getBodyRestitution(impostor: PhysicsImpostor): number;
  63540. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  63541. sleepBody(impostor: PhysicsImpostor): void;
  63542. wakeUpBody(impostor: PhysicsImpostor): void;
  63543. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  63544. setMotor(joint: IMotorEnabledJoint, speed: number, force?: number, motorIndex?: number): void;
  63545. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  63546. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  63547. getRadius(impostor: PhysicsImpostor): number;
  63548. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  63549. dispose(): void;
  63550. /**
  63551. * Does a raycast in the physics world
  63552. * @param from when should the ray start?
  63553. * @param to when should the ray end?
  63554. * @returns PhysicsRaycastResult
  63555. */
  63556. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  63557. }
  63558. }
  63559. declare module "babylonjs/Physics/Plugins/ammoJSPlugin" {
  63560. import { Quaternion, Vector3 } from "babylonjs/Maths/math.vector";
  63561. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  63562. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  63563. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  63564. import { Nullable } from "babylonjs/types";
  63565. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  63566. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  63567. /**
  63568. * AmmoJS Physics plugin
  63569. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  63570. * @see https://github.com/kripken/ammo.js/
  63571. */
  63572. export class AmmoJSPlugin implements IPhysicsEnginePlugin {
  63573. private _useDeltaForWorldStep;
  63574. /**
  63575. * Reference to the Ammo library
  63576. */
  63577. bjsAMMO: any;
  63578. /**
  63579. * Created ammoJS world which physics bodies are added to
  63580. */
  63581. world: any;
  63582. /**
  63583. * Name of the plugin
  63584. */
  63585. name: string;
  63586. private _timeStep;
  63587. private _fixedTimeStep;
  63588. private _maxSteps;
  63589. private _tmpQuaternion;
  63590. private _tmpAmmoTransform;
  63591. private _tmpAmmoQuaternion;
  63592. private _tmpAmmoConcreteContactResultCallback;
  63593. private _collisionConfiguration;
  63594. private _dispatcher;
  63595. private _overlappingPairCache;
  63596. private _solver;
  63597. private _softBodySolver;
  63598. private _tmpAmmoVectorA;
  63599. private _tmpAmmoVectorB;
  63600. private _tmpAmmoVectorC;
  63601. private _tmpAmmoVectorD;
  63602. private _tmpContactCallbackResult;
  63603. private _tmpAmmoVectorRCA;
  63604. private _tmpAmmoVectorRCB;
  63605. private _raycastResult;
  63606. private static readonly DISABLE_COLLISION_FLAG;
  63607. private static readonly KINEMATIC_FLAG;
  63608. private static readonly DISABLE_DEACTIVATION_FLAG;
  63609. /**
  63610. * Initializes the ammoJS plugin
  63611. * @param _useDeltaForWorldStep if the time between frames should be used when calculating physics steps (Default: true)
  63612. * @param ammoInjection can be used to inject your own ammo reference
  63613. * @param overlappingPairCache can be used to specify your own overlapping pair cache
  63614. */
  63615. constructor(_useDeltaForWorldStep?: boolean, ammoInjection?: any, overlappingPairCache?: any);
  63616. /**
  63617. * Sets the gravity of the physics world (m/(s^2))
  63618. * @param gravity Gravity to set
  63619. */
  63620. setGravity(gravity: Vector3): void;
  63621. /**
  63622. * Amount of time to step forward on each frame (only used if useDeltaForWorldStep is false in the constructor)
  63623. * @param timeStep timestep to use in seconds
  63624. */
  63625. setTimeStep(timeStep: number): void;
  63626. /**
  63627. * 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)
  63628. * @param fixedTimeStep fixedTimeStep to use in seconds
  63629. */
  63630. setFixedTimeStep(fixedTimeStep: number): void;
  63631. /**
  63632. * Sets the maximum number of steps by the physics engine per frame (Default: 5)
  63633. * @param maxSteps the maximum number of steps by the physics engine per frame
  63634. */
  63635. setMaxSteps(maxSteps: number): void;
  63636. /**
  63637. * Gets the current timestep (only used if useDeltaForWorldStep is false in the constructor)
  63638. * @returns the current timestep in seconds
  63639. */
  63640. getTimeStep(): number;
  63641. /**
  63642. * The create custom shape handler function to be called when using BABYLON.PhysicsImposter.CustomImpostor
  63643. */
  63644. onCreateCustomShape: (impostor: PhysicsImpostor) => any;
  63645. private _isImpostorInContact;
  63646. private _isImpostorPairInContact;
  63647. private _stepSimulation;
  63648. /**
  63649. * Moves the physics simulation forward delta seconds and updates the given physics imposters
  63650. * Prior to the step the imposters physics location is set to the position of the babylon meshes
  63651. * After the step the babylon meshes are set to the position of the physics imposters
  63652. * @param delta amount of time to step forward
  63653. * @param impostors array of imposters to update before/after the step
  63654. */
  63655. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  63656. /**
  63657. * Update babylon mesh to match physics world object
  63658. * @param impostor imposter to match
  63659. */
  63660. private _afterSoftStep;
  63661. /**
  63662. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  63663. * @param impostor imposter to match
  63664. */
  63665. private _ropeStep;
  63666. /**
  63667. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  63668. * @param impostor imposter to match
  63669. */
  63670. private _softbodyOrClothStep;
  63671. private _tmpMatrix;
  63672. /**
  63673. * Applies an impulse on the imposter
  63674. * @param impostor imposter to apply impulse to
  63675. * @param force amount of force to be applied to the imposter
  63676. * @param contactPoint the location to apply the impulse on the imposter
  63677. */
  63678. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63679. /**
  63680. * Applies a force on the imposter
  63681. * @param impostor imposter to apply force
  63682. * @param force amount of force to be applied to the imposter
  63683. * @param contactPoint the location to apply the force on the imposter
  63684. */
  63685. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63686. /**
  63687. * Creates a physics body using the plugin
  63688. * @param impostor the imposter to create the physics body on
  63689. */
  63690. generatePhysicsBody(impostor: PhysicsImpostor): void;
  63691. /**
  63692. * Removes the physics body from the imposter and disposes of the body's memory
  63693. * @param impostor imposter to remove the physics body from
  63694. */
  63695. removePhysicsBody(impostor: PhysicsImpostor): void;
  63696. /**
  63697. * Generates a joint
  63698. * @param impostorJoint the imposter joint to create the joint with
  63699. */
  63700. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  63701. /**
  63702. * Removes a joint
  63703. * @param impostorJoint the imposter joint to remove the joint from
  63704. */
  63705. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  63706. private _addMeshVerts;
  63707. /**
  63708. * Initialise the soft body vertices to match its object's (mesh) vertices
  63709. * Softbody vertices (nodes) are in world space and to match this
  63710. * The object's position and rotation is set to zero and so its vertices are also then set in world space
  63711. * @param impostor to create the softbody for
  63712. */
  63713. private _softVertexData;
  63714. /**
  63715. * Create an impostor's soft body
  63716. * @param impostor to create the softbody for
  63717. */
  63718. private _createSoftbody;
  63719. /**
  63720. * Create cloth for an impostor
  63721. * @param impostor to create the softbody for
  63722. */
  63723. private _createCloth;
  63724. /**
  63725. * Create rope for an impostor
  63726. * @param impostor to create the softbody for
  63727. */
  63728. private _createRope;
  63729. /**
  63730. * Create a custom physics impostor shape using the plugin's onCreateCustomShape handler
  63731. * @param impostor to create the custom physics shape for
  63732. */
  63733. private _createCustom;
  63734. private _addHullVerts;
  63735. private _createShape;
  63736. /**
  63737. * Sets the physics body position/rotation from the babylon mesh's position/rotation
  63738. * @param impostor imposter containing the physics body and babylon object
  63739. */
  63740. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  63741. /**
  63742. * Sets the babylon object's position/rotation from the physics body's position/rotation
  63743. * @param impostor imposter containing the physics body and babylon object
  63744. * @param newPosition new position
  63745. * @param newRotation new rotation
  63746. */
  63747. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  63748. /**
  63749. * If this plugin is supported
  63750. * @returns true if its supported
  63751. */
  63752. isSupported(): boolean;
  63753. /**
  63754. * Sets the linear velocity of the physics body
  63755. * @param impostor imposter to set the velocity on
  63756. * @param velocity velocity to set
  63757. */
  63758. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63759. /**
  63760. * Sets the angular velocity of the physics body
  63761. * @param impostor imposter to set the velocity on
  63762. * @param velocity velocity to set
  63763. */
  63764. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63765. /**
  63766. * gets the linear velocity
  63767. * @param impostor imposter to get linear velocity from
  63768. * @returns linear velocity
  63769. */
  63770. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63771. /**
  63772. * gets the angular velocity
  63773. * @param impostor imposter to get angular velocity from
  63774. * @returns angular velocity
  63775. */
  63776. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63777. /**
  63778. * Sets the mass of physics body
  63779. * @param impostor imposter to set the mass on
  63780. * @param mass mass to set
  63781. */
  63782. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  63783. /**
  63784. * Gets the mass of the physics body
  63785. * @param impostor imposter to get the mass from
  63786. * @returns mass
  63787. */
  63788. getBodyMass(impostor: PhysicsImpostor): number;
  63789. /**
  63790. * Gets friction of the impostor
  63791. * @param impostor impostor to get friction from
  63792. * @returns friction value
  63793. */
  63794. getBodyFriction(impostor: PhysicsImpostor): number;
  63795. /**
  63796. * Sets friction of the impostor
  63797. * @param impostor impostor to set friction on
  63798. * @param friction friction value
  63799. */
  63800. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  63801. /**
  63802. * Gets restitution of the impostor
  63803. * @param impostor impostor to get restitution from
  63804. * @returns restitution value
  63805. */
  63806. getBodyRestitution(impostor: PhysicsImpostor): number;
  63807. /**
  63808. * Sets resitution of the impostor
  63809. * @param impostor impostor to set resitution on
  63810. * @param restitution resitution value
  63811. */
  63812. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  63813. /**
  63814. * Gets pressure inside the impostor
  63815. * @param impostor impostor to get pressure from
  63816. * @returns pressure value
  63817. */
  63818. getBodyPressure(impostor: PhysicsImpostor): number;
  63819. /**
  63820. * Sets pressure inside a soft body impostor
  63821. * Cloth and rope must remain 0 pressure
  63822. * @param impostor impostor to set pressure on
  63823. * @param pressure pressure value
  63824. */
  63825. setBodyPressure(impostor: PhysicsImpostor, pressure: number): void;
  63826. /**
  63827. * Gets stiffness of the impostor
  63828. * @param impostor impostor to get stiffness from
  63829. * @returns pressure value
  63830. */
  63831. getBodyStiffness(impostor: PhysicsImpostor): number;
  63832. /**
  63833. * Sets stiffness of the impostor
  63834. * @param impostor impostor to set stiffness on
  63835. * @param stiffness stiffness value from 0 to 1
  63836. */
  63837. setBodyStiffness(impostor: PhysicsImpostor, stiffness: number): void;
  63838. /**
  63839. * Gets velocityIterations of the impostor
  63840. * @param impostor impostor to get velocity iterations from
  63841. * @returns velocityIterations value
  63842. */
  63843. getBodyVelocityIterations(impostor: PhysicsImpostor): number;
  63844. /**
  63845. * Sets velocityIterations of the impostor
  63846. * @param impostor impostor to set velocity iterations on
  63847. * @param velocityIterations velocityIterations value
  63848. */
  63849. setBodyVelocityIterations(impostor: PhysicsImpostor, velocityIterations: number): void;
  63850. /**
  63851. * Gets positionIterations of the impostor
  63852. * @param impostor impostor to get position iterations from
  63853. * @returns positionIterations value
  63854. */
  63855. getBodyPositionIterations(impostor: PhysicsImpostor): number;
  63856. /**
  63857. * Sets positionIterations of the impostor
  63858. * @param impostor impostor to set position on
  63859. * @param positionIterations positionIterations value
  63860. */
  63861. setBodyPositionIterations(impostor: PhysicsImpostor, positionIterations: number): void;
  63862. /**
  63863. * Append an anchor to a cloth object
  63864. * @param impostor is the cloth impostor to add anchor to
  63865. * @param otherImpostor is the rigid impostor to anchor to
  63866. * @param width ratio across width from 0 to 1
  63867. * @param height ratio up height from 0 to 1
  63868. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  63869. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  63870. */
  63871. appendAnchor(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  63872. /**
  63873. * Append an hook to a rope object
  63874. * @param impostor is the rope impostor to add hook to
  63875. * @param otherImpostor is the rigid impostor to hook to
  63876. * @param length ratio along the rope from 0 to 1
  63877. * @param influence the elasticity between soft impostor and anchor from 0, very stretchy to 1, little strech
  63878. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  63879. */
  63880. appendHook(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  63881. /**
  63882. * Sleeps the physics body and stops it from being active
  63883. * @param impostor impostor to sleep
  63884. */
  63885. sleepBody(impostor: PhysicsImpostor): void;
  63886. /**
  63887. * Activates the physics body
  63888. * @param impostor impostor to activate
  63889. */
  63890. wakeUpBody(impostor: PhysicsImpostor): void;
  63891. /**
  63892. * Updates the distance parameters of the joint
  63893. * @param joint joint to update
  63894. * @param maxDistance maximum distance of the joint
  63895. * @param minDistance minimum distance of the joint
  63896. */
  63897. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  63898. /**
  63899. * Sets a motor on the joint
  63900. * @param joint joint to set motor on
  63901. * @param speed speed of the motor
  63902. * @param maxForce maximum force of the motor
  63903. * @param motorIndex index of the motor
  63904. */
  63905. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  63906. /**
  63907. * Sets the motors limit
  63908. * @param joint joint to set limit on
  63909. * @param upperLimit upper limit
  63910. * @param lowerLimit lower limit
  63911. */
  63912. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  63913. /**
  63914. * Syncs the position and rotation of a mesh with the impostor
  63915. * @param mesh mesh to sync
  63916. * @param impostor impostor to update the mesh with
  63917. */
  63918. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  63919. /**
  63920. * Gets the radius of the impostor
  63921. * @param impostor impostor to get radius from
  63922. * @returns the radius
  63923. */
  63924. getRadius(impostor: PhysicsImpostor): number;
  63925. /**
  63926. * Gets the box size of the impostor
  63927. * @param impostor impostor to get box size from
  63928. * @param result the resulting box size
  63929. */
  63930. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  63931. /**
  63932. * Disposes of the impostor
  63933. */
  63934. dispose(): void;
  63935. /**
  63936. * Does a raycast in the physics world
  63937. * @param from when should the ray start?
  63938. * @param to when should the ray end?
  63939. * @returns PhysicsRaycastResult
  63940. */
  63941. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  63942. }
  63943. }
  63944. declare module "babylonjs/Probes/reflectionProbe" {
  63945. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  63946. import { Vector3 } from "babylonjs/Maths/math.vector";
  63947. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  63948. import { Nullable } from "babylonjs/types";
  63949. import { Scene } from "babylonjs/scene";
  63950. module "babylonjs/abstractScene" {
  63951. interface AbstractScene {
  63952. /**
  63953. * The list of reflection probes added to the scene
  63954. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  63955. */
  63956. reflectionProbes: Array<ReflectionProbe>;
  63957. /**
  63958. * Removes the given reflection probe from this scene.
  63959. * @param toRemove The reflection probe to remove
  63960. * @returns The index of the removed reflection probe
  63961. */
  63962. removeReflectionProbe(toRemove: ReflectionProbe): number;
  63963. /**
  63964. * Adds the given reflection probe to this scene.
  63965. * @param newReflectionProbe The reflection probe to add
  63966. */
  63967. addReflectionProbe(newReflectionProbe: ReflectionProbe): void;
  63968. }
  63969. }
  63970. /**
  63971. * Class used to generate realtime reflection / refraction cube textures
  63972. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  63973. */
  63974. export class ReflectionProbe {
  63975. /** defines the name of the probe */
  63976. name: string;
  63977. private _scene;
  63978. private _renderTargetTexture;
  63979. private _projectionMatrix;
  63980. private _viewMatrix;
  63981. private _target;
  63982. private _add;
  63983. private _attachedMesh;
  63984. private _invertYAxis;
  63985. /** Gets or sets probe position (center of the cube map) */
  63986. position: Vector3;
  63987. /**
  63988. * Creates a new reflection probe
  63989. * @param name defines the name of the probe
  63990. * @param size defines the texture resolution (for each face)
  63991. * @param scene defines the hosting scene
  63992. * @param generateMipMaps defines if mip maps should be generated automatically (true by default)
  63993. * @param useFloat defines if HDR data (flaot data) should be used to store colors (false by default)
  63994. */
  63995. constructor(
  63996. /** defines the name of the probe */
  63997. name: string, size: number, scene: Scene, generateMipMaps?: boolean, useFloat?: boolean);
  63998. /** Gets or sets the number of samples to use for multi-sampling (0 by default). Required WebGL2 */
  63999. get samples(): number;
  64000. set samples(value: number);
  64001. /** Gets or sets the refresh rate to use (on every frame by default) */
  64002. get refreshRate(): number;
  64003. set refreshRate(value: number);
  64004. /**
  64005. * Gets the hosting scene
  64006. * @returns a Scene
  64007. */
  64008. getScene(): Scene;
  64009. /** Gets the internal CubeTexture used to render to */
  64010. get cubeTexture(): RenderTargetTexture;
  64011. /** Gets the list of meshes to render */
  64012. get renderList(): Nullable<AbstractMesh[]>;
  64013. /**
  64014. * Attach the probe to a specific mesh (Rendering will be done from attached mesh's position)
  64015. * @param mesh defines the mesh to attach to
  64016. */
  64017. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  64018. /**
  64019. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups
  64020. * @param renderingGroupId The rendering group id corresponding to its index
  64021. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  64022. */
  64023. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  64024. /**
  64025. * Clean all associated resources
  64026. */
  64027. dispose(): void;
  64028. /**
  64029. * Converts the reflection probe information to a readable string for debug purpose.
  64030. * @param fullDetails Supports for multiple levels of logging within scene loading
  64031. * @returns the human readable reflection probe info
  64032. */
  64033. toString(fullDetails?: boolean): string;
  64034. /**
  64035. * Get the class name of the relfection probe.
  64036. * @returns "ReflectionProbe"
  64037. */
  64038. getClassName(): string;
  64039. /**
  64040. * Serialize the reflection probe to a JSON representation we can easily use in the resepective Parse function.
  64041. * @returns The JSON representation of the texture
  64042. */
  64043. serialize(): any;
  64044. /**
  64045. * Parse the JSON representation of a reflection probe in order to recreate the reflection probe in the given scene.
  64046. * @param parsedReflectionProbe Define the JSON representation of the reflection probe
  64047. * @param scene Define the scene the parsed reflection probe should be instantiated in
  64048. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  64049. * @returns The parsed reflection probe if successful
  64050. */
  64051. static Parse(parsedReflectionProbe: any, scene: Scene, rootUrl: string): Nullable<ReflectionProbe>;
  64052. }
  64053. }
  64054. declare module "babylonjs/Loading/Plugins/babylonFileLoader" {
  64055. /** @hidden */
  64056. export var _BabylonLoaderRegistered: boolean;
  64057. /**
  64058. * Helps setting up some configuration for the babylon file loader.
  64059. */
  64060. export class BabylonFileLoaderConfiguration {
  64061. /**
  64062. * The loader does not allow injecting custom physix engine into the plugins.
  64063. * Unfortunately in ES6, we need to manually inject them into the plugin.
  64064. * So you could set this variable to your engine import to make it work.
  64065. */
  64066. static LoaderInjectedPhysicsEngine: any;
  64067. }
  64068. }
  64069. declare module "babylonjs/Loading/Plugins/index" {
  64070. export * from "babylonjs/Loading/Plugins/babylonFileLoader";
  64071. }
  64072. declare module "babylonjs/Loading/index" {
  64073. export * from "babylonjs/Loading/loadingScreen";
  64074. export * from "babylonjs/Loading/Plugins/index";
  64075. export * from "babylonjs/Loading/sceneLoader";
  64076. export * from "babylonjs/Loading/sceneLoaderFlags";
  64077. }
  64078. declare module "babylonjs/Materials/Background/index" {
  64079. export * from "babylonjs/Materials/Background/backgroundMaterial";
  64080. }
  64081. declare module "babylonjs/Materials/PBR/pbrBaseSimpleMaterial" {
  64082. import { Scene } from "babylonjs/scene";
  64083. import { Color3 } from "babylonjs/Maths/math.color";
  64084. import { PBRBaseMaterial } from "babylonjs/Materials/PBR/pbrBaseMaterial";
  64085. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64086. /**
  64087. * The Physically based simple base material of BJS.
  64088. *
  64089. * This enables better naming and convention enforcements on top of the pbrMaterial.
  64090. * It is used as the base class for both the specGloss and metalRough conventions.
  64091. */
  64092. export abstract class PBRBaseSimpleMaterial extends PBRBaseMaterial {
  64093. /**
  64094. * Number of Simultaneous lights allowed on the material.
  64095. */
  64096. maxSimultaneousLights: number;
  64097. /**
  64098. * If sets to true, disables all the lights affecting the material.
  64099. */
  64100. disableLighting: boolean;
  64101. /**
  64102. * Environment Texture used in the material (this is use for both reflection and environment lighting).
  64103. */
  64104. environmentTexture: BaseTexture;
  64105. /**
  64106. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  64107. */
  64108. invertNormalMapX: boolean;
  64109. /**
  64110. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  64111. */
  64112. invertNormalMapY: boolean;
  64113. /**
  64114. * Normal map used in the model.
  64115. */
  64116. normalTexture: BaseTexture;
  64117. /**
  64118. * Emissivie color used to self-illuminate the model.
  64119. */
  64120. emissiveColor: Color3;
  64121. /**
  64122. * Emissivie texture used to self-illuminate the model.
  64123. */
  64124. emissiveTexture: BaseTexture;
  64125. /**
  64126. * Occlusion Channel Strenght.
  64127. */
  64128. occlusionStrength: number;
  64129. /**
  64130. * Occlusion Texture of the material (adding extra occlusion effects).
  64131. */
  64132. occlusionTexture: BaseTexture;
  64133. /**
  64134. * Defines the alpha limits in alpha test mode.
  64135. */
  64136. alphaCutOff: number;
  64137. /**
  64138. * Gets the current double sided mode.
  64139. */
  64140. get doubleSided(): boolean;
  64141. /**
  64142. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  64143. */
  64144. set doubleSided(value: boolean);
  64145. /**
  64146. * Stores the pre-calculated light information of a mesh in a texture.
  64147. */
  64148. lightmapTexture: BaseTexture;
  64149. /**
  64150. * If true, the light map contains occlusion information instead of lighting info.
  64151. */
  64152. useLightmapAsShadowmap: boolean;
  64153. /**
  64154. * Instantiates a new PBRMaterial instance.
  64155. *
  64156. * @param name The material name
  64157. * @param scene The scene the material will be use in.
  64158. */
  64159. constructor(name: string, scene: Scene);
  64160. getClassName(): string;
  64161. }
  64162. }
  64163. declare module "babylonjs/Materials/PBR/pbrMetallicRoughnessMaterial" {
  64164. import { Scene } from "babylonjs/scene";
  64165. import { Color3 } from "babylonjs/Maths/math.color";
  64166. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64167. import { PBRBaseSimpleMaterial } from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  64168. /**
  64169. * The PBR material of BJS following the metal roughness convention.
  64170. *
  64171. * This fits to the PBR convention in the GLTF definition:
  64172. * https://github.com/KhronosGroup/glTF/tree/2.0/specification/2.0
  64173. */
  64174. export class PBRMetallicRoughnessMaterial extends PBRBaseSimpleMaterial {
  64175. /**
  64176. * The base color has two different interpretations depending on the value of metalness.
  64177. * When the material is a metal, the base color is the specific measured reflectance value
  64178. * at normal incidence (F0). For a non-metal the base color represents the reflected diffuse color
  64179. * of the material.
  64180. */
  64181. baseColor: Color3;
  64182. /**
  64183. * Base texture of the metallic workflow. It contains both the baseColor information in RGB as
  64184. * well as opacity information in the alpha channel.
  64185. */
  64186. baseTexture: BaseTexture;
  64187. /**
  64188. * Specifies the metallic scalar value of the material.
  64189. * Can also be used to scale the metalness values of the metallic texture.
  64190. */
  64191. metallic: number;
  64192. /**
  64193. * Specifies the roughness scalar value of the material.
  64194. * Can also be used to scale the roughness values of the metallic texture.
  64195. */
  64196. roughness: number;
  64197. /**
  64198. * Texture containing both the metallic value in the B channel and the
  64199. * roughness value in the G channel to keep better precision.
  64200. */
  64201. metallicRoughnessTexture: BaseTexture;
  64202. /**
  64203. * Instantiates a new PBRMetalRoughnessMaterial instance.
  64204. *
  64205. * @param name The material name
  64206. * @param scene The scene the material will be use in.
  64207. */
  64208. constructor(name: string, scene: Scene);
  64209. /**
  64210. * Return the currrent class name of the material.
  64211. */
  64212. getClassName(): string;
  64213. /**
  64214. * Makes a duplicate of the current material.
  64215. * @param name - name to use for the new material.
  64216. */
  64217. clone(name: string): PBRMetallicRoughnessMaterial;
  64218. /**
  64219. * Serialize the material to a parsable JSON object.
  64220. */
  64221. serialize(): any;
  64222. /**
  64223. * Parses a JSON object correponding to the serialize function.
  64224. */
  64225. static Parse(source: any, scene: Scene, rootUrl: string): PBRMetallicRoughnessMaterial;
  64226. }
  64227. }
  64228. declare module "babylonjs/Materials/PBR/pbrSpecularGlossinessMaterial" {
  64229. import { Scene } from "babylonjs/scene";
  64230. import { Color3 } from "babylonjs/Maths/math.color";
  64231. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64232. import { PBRBaseSimpleMaterial } from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  64233. /**
  64234. * The PBR material of BJS following the specular glossiness convention.
  64235. *
  64236. * This fits to the PBR convention in the GLTF definition:
  64237. * https://github.com/KhronosGroup/glTF/tree/2.0/extensions/Khronos/KHR_materials_pbrSpecularGlossiness
  64238. */
  64239. export class PBRSpecularGlossinessMaterial extends PBRBaseSimpleMaterial {
  64240. /**
  64241. * Specifies the diffuse color of the material.
  64242. */
  64243. diffuseColor: Color3;
  64244. /**
  64245. * Specifies the diffuse texture of the material. This can also contains the opcity value in its alpha
  64246. * channel.
  64247. */
  64248. diffuseTexture: BaseTexture;
  64249. /**
  64250. * Specifies the specular color of the material. This indicates how reflective is the material (none to mirror).
  64251. */
  64252. specularColor: Color3;
  64253. /**
  64254. * Specifies the glossiness of the material. This indicates "how sharp is the reflection".
  64255. */
  64256. glossiness: number;
  64257. /**
  64258. * Specifies both the specular color RGB and the glossiness A of the material per pixels.
  64259. */
  64260. specularGlossinessTexture: BaseTexture;
  64261. /**
  64262. * Instantiates a new PBRSpecularGlossinessMaterial instance.
  64263. *
  64264. * @param name The material name
  64265. * @param scene The scene the material will be use in.
  64266. */
  64267. constructor(name: string, scene: Scene);
  64268. /**
  64269. * Return the currrent class name of the material.
  64270. */
  64271. getClassName(): string;
  64272. /**
  64273. * Makes a duplicate of the current material.
  64274. * @param name - name to use for the new material.
  64275. */
  64276. clone(name: string): PBRSpecularGlossinessMaterial;
  64277. /**
  64278. * Serialize the material to a parsable JSON object.
  64279. */
  64280. serialize(): any;
  64281. /**
  64282. * Parses a JSON object correponding to the serialize function.
  64283. */
  64284. static Parse(source: any, scene: Scene, rootUrl: string): PBRSpecularGlossinessMaterial;
  64285. }
  64286. }
  64287. declare module "babylonjs/Materials/PBR/index" {
  64288. export * from "babylonjs/Materials/PBR/pbrBaseMaterial";
  64289. export * from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  64290. export * from "babylonjs/Materials/PBR/pbrMaterial";
  64291. export * from "babylonjs/Materials/PBR/pbrMetallicRoughnessMaterial";
  64292. export * from "babylonjs/Materials/PBR/pbrSpecularGlossinessMaterial";
  64293. }
  64294. declare module "babylonjs/Materials/Textures/colorGradingTexture" {
  64295. import { Nullable } from "babylonjs/types";
  64296. import { Scene } from "babylonjs/scene";
  64297. import { Matrix } from "babylonjs/Maths/math.vector";
  64298. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64299. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  64300. import "babylonjs/Engines/Extensions/engine.rawTexture";
  64301. /**
  64302. * This represents a color grading texture. This acts as a lookup table LUT, useful during post process
  64303. * It can help converting any input color in a desired output one. This can then be used to create effects
  64304. * from sepia, black and white to sixties or futuristic rendering...
  64305. *
  64306. * The only supported format is currently 3dl.
  64307. * More information on LUT: https://en.wikipedia.org/wiki/3D_lookup_table
  64308. */
  64309. export class ColorGradingTexture extends BaseTexture {
  64310. /**
  64311. * The texture URL.
  64312. */
  64313. url: string;
  64314. /**
  64315. * Empty line regex stored for GC.
  64316. */
  64317. private static _noneEmptyLineRegex;
  64318. private _textureMatrix;
  64319. private _onLoad;
  64320. /**
  64321. * Instantiates a ColorGradingTexture from the following parameters.
  64322. *
  64323. * @param url The location of the color gradind data (currently only supporting 3dl)
  64324. * @param sceneOrEngine The scene or engine the texture will be used in
  64325. * @param onLoad defines a callback triggered when the texture has been loaded
  64326. */
  64327. constructor(url: string, sceneOrEngine: Scene | ThinEngine, onLoad?: Nullable<() => void>);
  64328. /**
  64329. * Fires the onload event from the constructor if requested.
  64330. */
  64331. private _triggerOnLoad;
  64332. /**
  64333. * Returns the texture matrix used in most of the material.
  64334. * This is not used in color grading but keep for troubleshooting purpose (easily swap diffuse by colorgrading to look in).
  64335. */
  64336. getTextureMatrix(): Matrix;
  64337. /**
  64338. * Occurs when the file being loaded is a .3dl LUT file.
  64339. */
  64340. private load3dlTexture;
  64341. /**
  64342. * Starts the loading process of the texture.
  64343. */
  64344. private loadTexture;
  64345. /**
  64346. * Clones the color gradind texture.
  64347. */
  64348. clone(): ColorGradingTexture;
  64349. /**
  64350. * Called during delayed load for textures.
  64351. */
  64352. delayLoad(): void;
  64353. /**
  64354. * Parses a color grading texture serialized by Babylon.
  64355. * @param parsedTexture The texture information being parsedTexture
  64356. * @param scene The scene to load the texture in
  64357. * @param rootUrl The root url of the data assets to load
  64358. * @return A color gradind texture
  64359. */
  64360. static Parse(parsedTexture: any, scene: Scene): Nullable<ColorGradingTexture>;
  64361. /**
  64362. * Serializes the LUT texture to json format.
  64363. */
  64364. serialize(): any;
  64365. }
  64366. }
  64367. declare module "babylonjs/Materials/Textures/equiRectangularCubeTexture" {
  64368. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64369. import { Scene } from "babylonjs/scene";
  64370. import { Nullable } from "babylonjs/types";
  64371. import "babylonjs/Engines/Extensions/engine.rawTexture";
  64372. /**
  64373. * This represents a texture coming from an equirectangular image supported by the web browser canvas.
  64374. */
  64375. export class EquiRectangularCubeTexture extends BaseTexture {
  64376. /** The six faces of the cube. */
  64377. private static _FacesMapping;
  64378. private _noMipmap;
  64379. private _onLoad;
  64380. private _onError;
  64381. /** The size of the cubemap. */
  64382. private _size;
  64383. /** The buffer of the image. */
  64384. private _buffer;
  64385. /** The width of the input image. */
  64386. private _width;
  64387. /** The height of the input image. */
  64388. private _height;
  64389. /** The URL to the image. */
  64390. url: string;
  64391. /**
  64392. * Instantiates an EquiRectangularCubeTexture from the following parameters.
  64393. * @param url The location of the image
  64394. * @param scene The scene the texture will be used in
  64395. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  64396. * @param noMipmap Forces to not generate the mipmap if true
  64397. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  64398. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  64399. * @param onLoad — defines a callback called when texture is loaded
  64400. * @param onError — defines a callback called if there is an error
  64401. */
  64402. constructor(url: string, scene: Scene, size: number, noMipmap?: boolean, gammaSpace?: boolean, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>);
  64403. /**
  64404. * Load the image data, by putting the image on a canvas and extracting its buffer.
  64405. */
  64406. private loadImage;
  64407. /**
  64408. * Convert the image buffer into a cubemap and create a CubeTexture.
  64409. */
  64410. private loadTexture;
  64411. /**
  64412. * Convert the ArrayBuffer into a Float32Array and drop the transparency channel.
  64413. * @param buffer The ArrayBuffer that should be converted.
  64414. * @returns The buffer as Float32Array.
  64415. */
  64416. private getFloat32ArrayFromArrayBuffer;
  64417. /**
  64418. * Get the current class name of the texture useful for serialization or dynamic coding.
  64419. * @returns "EquiRectangularCubeTexture"
  64420. */
  64421. getClassName(): string;
  64422. /**
  64423. * Create a clone of the current EquiRectangularCubeTexture and return it.
  64424. * @returns A clone of the current EquiRectangularCubeTexture.
  64425. */
  64426. clone(): EquiRectangularCubeTexture;
  64427. }
  64428. }
  64429. declare module "babylonjs/Materials/Textures/htmlElementTexture" {
  64430. import { Nullable } from "babylonjs/types";
  64431. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64432. import { Matrix } from "babylonjs/Maths/math.vector";
  64433. import "babylonjs/Engines/Extensions/engine.dynamicTexture";
  64434. import "babylonjs/Engines/Extensions/engine.videoTexture";
  64435. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  64436. import { Scene } from "babylonjs/scene";
  64437. /**
  64438. * Defines the options related to the creation of an HtmlElementTexture
  64439. */
  64440. export interface IHtmlElementTextureOptions {
  64441. /**
  64442. * Defines wether mip maps should be created or not.
  64443. */
  64444. generateMipMaps?: boolean;
  64445. /**
  64446. * Defines the sampling mode of the texture.
  64447. */
  64448. samplingMode?: number;
  64449. /**
  64450. * Defines the engine instance to use the texture with. It is not mandatory if you define a scene.
  64451. */
  64452. engine: Nullable<ThinEngine>;
  64453. /**
  64454. * Defines the scene the texture belongs to. It is not mandatory if you define an engine.
  64455. */
  64456. scene: Nullable<Scene>;
  64457. }
  64458. /**
  64459. * This represents the smallest workload to use an already existing element (Canvas or Video) as a texture.
  64460. * To be as efficient as possible depending on your constraints nothing aside the first upload
  64461. * is automatically managed.
  64462. * It is a cheap VideoTexture or DynamicTexture if you prefer to keep full control of the elements
  64463. * in your application.
  64464. *
  64465. * As the update is not automatic, you need to call them manually.
  64466. */
  64467. export class HtmlElementTexture extends BaseTexture {
  64468. /**
  64469. * The texture URL.
  64470. */
  64471. element: HTMLVideoElement | HTMLCanvasElement;
  64472. private static readonly DefaultOptions;
  64473. private _textureMatrix;
  64474. private _isVideo;
  64475. private _generateMipMaps;
  64476. private _samplingMode;
  64477. /**
  64478. * Instantiates a HtmlElementTexture from the following parameters.
  64479. *
  64480. * @param name Defines the name of the texture
  64481. * @param element Defines the video or canvas the texture is filled with
  64482. * @param options Defines the other none mandatory texture creation options
  64483. */
  64484. constructor(name: string, element: HTMLVideoElement | HTMLCanvasElement, options: IHtmlElementTextureOptions);
  64485. private _createInternalTexture;
  64486. /**
  64487. * Returns the texture matrix used in most of the material.
  64488. */
  64489. getTextureMatrix(): Matrix;
  64490. /**
  64491. * Updates the content of the texture.
  64492. * @param invertY Defines wether the texture should be inverted on Y (false by default on video and true on canvas)
  64493. */
  64494. update(invertY?: Nullable<boolean>): void;
  64495. }
  64496. }
  64497. declare module "babylonjs/Misc/tga" {
  64498. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  64499. /**
  64500. * Based on jsTGALoader - Javascript loader for TGA file
  64501. * By Vincent Thibault
  64502. * @see http://blog.robrowser.com/javascript-tga-loader.html
  64503. */
  64504. export class TGATools {
  64505. private static _TYPE_INDEXED;
  64506. private static _TYPE_RGB;
  64507. private static _TYPE_GREY;
  64508. private static _TYPE_RLE_INDEXED;
  64509. private static _TYPE_RLE_RGB;
  64510. private static _TYPE_RLE_GREY;
  64511. private static _ORIGIN_MASK;
  64512. private static _ORIGIN_SHIFT;
  64513. private static _ORIGIN_BL;
  64514. private static _ORIGIN_BR;
  64515. private static _ORIGIN_UL;
  64516. private static _ORIGIN_UR;
  64517. /**
  64518. * Gets the header of a TGA file
  64519. * @param data defines the TGA data
  64520. * @returns the header
  64521. */
  64522. static GetTGAHeader(data: Uint8Array): any;
  64523. /**
  64524. * Uploads TGA content to a Babylon Texture
  64525. * @hidden
  64526. */
  64527. static UploadContent(texture: InternalTexture, data: Uint8Array): void;
  64528. /** @hidden */
  64529. 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;
  64530. /** @hidden */
  64531. 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;
  64532. /** @hidden */
  64533. 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;
  64534. /** @hidden */
  64535. 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;
  64536. /** @hidden */
  64537. 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;
  64538. /** @hidden */
  64539. 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;
  64540. }
  64541. }
  64542. declare module "babylonjs/Materials/Textures/Loaders/tgaTextureLoader" {
  64543. import { Nullable } from "babylonjs/types";
  64544. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  64545. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  64546. /**
  64547. * Implementation of the TGA Texture Loader.
  64548. * @hidden
  64549. */
  64550. export class _TGATextureLoader implements IInternalTextureLoader {
  64551. /**
  64552. * Defines wether the loader supports cascade loading the different faces.
  64553. */
  64554. readonly supportCascades: boolean;
  64555. /**
  64556. * This returns if the loader support the current file information.
  64557. * @param extension defines the file extension of the file being loaded
  64558. * @returns true if the loader can load the specified file
  64559. */
  64560. canLoad(extension: string): boolean;
  64561. /**
  64562. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  64563. * @param data contains the texture data
  64564. * @param texture defines the BabylonJS internal texture
  64565. * @param createPolynomials will be true if polynomials have been requested
  64566. * @param onLoad defines the callback to trigger once the texture is ready
  64567. * @param onError defines the callback to trigger in case of error
  64568. */
  64569. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  64570. /**
  64571. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  64572. * @param data contains the texture data
  64573. * @param texture defines the BabylonJS internal texture
  64574. * @param callback defines the method to call once ready to upload
  64575. */
  64576. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  64577. }
  64578. }
  64579. declare module "babylonjs/Misc/basis" {
  64580. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  64581. /**
  64582. * Info about the .basis files
  64583. */
  64584. class BasisFileInfo {
  64585. /**
  64586. * If the file has alpha
  64587. */
  64588. hasAlpha: boolean;
  64589. /**
  64590. * Info about each image of the basis file
  64591. */
  64592. images: Array<{
  64593. levels: Array<{
  64594. width: number;
  64595. height: number;
  64596. transcodedPixels: ArrayBufferView;
  64597. }>;
  64598. }>;
  64599. }
  64600. /**
  64601. * Result of transcoding a basis file
  64602. */
  64603. class TranscodeResult {
  64604. /**
  64605. * Info about the .basis file
  64606. */
  64607. fileInfo: BasisFileInfo;
  64608. /**
  64609. * Format to use when loading the file
  64610. */
  64611. format: number;
  64612. }
  64613. /**
  64614. * Configuration options for the Basis transcoder
  64615. */
  64616. export class BasisTranscodeConfiguration {
  64617. /**
  64618. * Supported compression formats used to determine the supported output format of the transcoder
  64619. */
  64620. supportedCompressionFormats?: {
  64621. /**
  64622. * etc1 compression format
  64623. */
  64624. etc1?: boolean;
  64625. /**
  64626. * s3tc compression format
  64627. */
  64628. s3tc?: boolean;
  64629. /**
  64630. * pvrtc compression format
  64631. */
  64632. pvrtc?: boolean;
  64633. /**
  64634. * etc2 compression format
  64635. */
  64636. etc2?: boolean;
  64637. };
  64638. /**
  64639. * If mipmap levels should be loaded for transcoded images (Default: true)
  64640. */
  64641. loadMipmapLevels?: boolean;
  64642. /**
  64643. * Index of a single image to load (Default: all images)
  64644. */
  64645. loadSingleImage?: number;
  64646. }
  64647. /**
  64648. * Used to load .Basis files
  64649. * See https://github.com/BinomialLLC/basis_universal/tree/master/webgl
  64650. */
  64651. export class BasisTools {
  64652. private static _IgnoreSupportedFormats;
  64653. /**
  64654. * URL to use when loading the basis transcoder
  64655. */
  64656. static JSModuleURL: string;
  64657. /**
  64658. * URL to use when loading the wasm module for the transcoder
  64659. */
  64660. static WasmModuleURL: string;
  64661. /**
  64662. * Get the internal format to be passed to texImage2D corresponding to the .basis format value
  64663. * @param basisFormat format chosen from GetSupportedTranscodeFormat
  64664. * @returns internal format corresponding to the Basis format
  64665. */
  64666. static GetInternalFormatFromBasisFormat(basisFormat: number): number;
  64667. private static _WorkerPromise;
  64668. private static _Worker;
  64669. private static _actionId;
  64670. private static _CreateWorkerAsync;
  64671. /**
  64672. * Transcodes a loaded image file to compressed pixel data
  64673. * @param data image data to transcode
  64674. * @param config configuration options for the transcoding
  64675. * @returns a promise resulting in the transcoded image
  64676. */
  64677. static TranscodeAsync(data: ArrayBuffer | ArrayBufferView, config: BasisTranscodeConfiguration): Promise<TranscodeResult>;
  64678. /**
  64679. * Loads a texture from the transcode result
  64680. * @param texture texture load to
  64681. * @param transcodeResult the result of transcoding the basis file to load from
  64682. */
  64683. static LoadTextureFromTranscodeResult(texture: InternalTexture, transcodeResult: TranscodeResult): void;
  64684. }
  64685. }
  64686. declare module "babylonjs/Materials/Textures/Loaders/basisTextureLoader" {
  64687. import { Nullable } from "babylonjs/types";
  64688. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  64689. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  64690. /**
  64691. * Loader for .basis file format
  64692. */
  64693. export class _BasisTextureLoader implements IInternalTextureLoader {
  64694. /**
  64695. * Defines whether the loader supports cascade loading the different faces.
  64696. */
  64697. readonly supportCascades: boolean;
  64698. /**
  64699. * This returns if the loader support the current file information.
  64700. * @param extension defines the file extension of the file being loaded
  64701. * @returns true if the loader can load the specified file
  64702. */
  64703. canLoad(extension: string): boolean;
  64704. /**
  64705. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  64706. * @param data contains the texture data
  64707. * @param texture defines the BabylonJS internal texture
  64708. * @param createPolynomials will be true if polynomials have been requested
  64709. * @param onLoad defines the callback to trigger once the texture is ready
  64710. * @param onError defines the callback to trigger in case of error
  64711. */
  64712. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  64713. /**
  64714. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  64715. * @param data contains the texture data
  64716. * @param texture defines the BabylonJS internal texture
  64717. * @param callback defines the method to call once ready to upload
  64718. */
  64719. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  64720. }
  64721. }
  64722. declare module "babylonjs/Materials/Textures/Loaders/index" {
  64723. export * from "babylonjs/Materials/Textures/Loaders/ddsTextureLoader";
  64724. export * from "babylonjs/Materials/Textures/Loaders/envTextureLoader";
  64725. export * from "babylonjs/Materials/Textures/Loaders/ktxTextureLoader";
  64726. export * from "babylonjs/Materials/Textures/Loaders/tgaTextureLoader";
  64727. export * from "babylonjs/Materials/Textures/Loaders/basisTextureLoader";
  64728. }
  64729. declare module "babylonjs/Materials/Textures/Packer/frame" {
  64730. import { Vector2 } from "babylonjs/Maths/math.vector";
  64731. /**
  64732. * Defines the basic options interface of a TexturePacker Frame
  64733. */
  64734. export interface ITexturePackerFrame {
  64735. /**
  64736. * The frame ID
  64737. */
  64738. id: number;
  64739. /**
  64740. * The frames Scale
  64741. */
  64742. scale: Vector2;
  64743. /**
  64744. * The Frames offset
  64745. */
  64746. offset: Vector2;
  64747. }
  64748. /**
  64749. * This is a support class for frame Data on texture packer sets.
  64750. */
  64751. export class TexturePackerFrame implements ITexturePackerFrame {
  64752. /**
  64753. * The frame ID
  64754. */
  64755. id: number;
  64756. /**
  64757. * The frames Scale
  64758. */
  64759. scale: Vector2;
  64760. /**
  64761. * The Frames offset
  64762. */
  64763. offset: Vector2;
  64764. /**
  64765. * Initializes a texture package frame.
  64766. * @param id The numerical frame identifier
  64767. * @param scale Scalar Vector2 for UV frame
  64768. * @param offset Vector2 for the frame position in UV units.
  64769. * @returns TexturePackerFrame
  64770. */
  64771. constructor(id: number, scale: Vector2, offset: Vector2);
  64772. }
  64773. }
  64774. declare module "babylonjs/Materials/Textures/Packer/packer" {
  64775. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  64776. import { Scene } from "babylonjs/scene";
  64777. import { Nullable } from "babylonjs/types";
  64778. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  64779. import { TexturePackerFrame } from "babylonjs/Materials/Textures/Packer/frame";
  64780. /**
  64781. * Defines the basic options interface of a TexturePacker
  64782. */
  64783. export interface ITexturePackerOptions {
  64784. /**
  64785. * Custom targets for the channels of a texture packer. Default is all the channels of the Standard Material
  64786. */
  64787. map?: string[];
  64788. /**
  64789. * the UV input targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  64790. */
  64791. uvsIn?: string;
  64792. /**
  64793. * the UV output targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  64794. */
  64795. uvsOut?: string;
  64796. /**
  64797. * number representing the layout style. Defaults to LAYOUT_STRIP
  64798. */
  64799. layout?: number;
  64800. /**
  64801. * number of columns if using custom column count layout(2). This defaults to 4.
  64802. */
  64803. colnum?: number;
  64804. /**
  64805. * flag to update the input meshes to the new packed texture after compilation. Defaults to true.
  64806. */
  64807. updateInputMeshes?: boolean;
  64808. /**
  64809. * boolean flag to dispose all the source textures. Defaults to true.
  64810. */
  64811. disposeSources?: boolean;
  64812. /**
  64813. * Fills the blank cells in a set to the customFillColor. Defaults to true.
  64814. */
  64815. fillBlanks?: boolean;
  64816. /**
  64817. * string value representing the context fill style color. Defaults to 'black'.
  64818. */
  64819. customFillColor?: string;
  64820. /**
  64821. * Width and Height Value of each Frame in the TexturePacker Sets
  64822. */
  64823. frameSize?: number;
  64824. /**
  64825. * Ratio of the value to add padding wise to each cell. Defaults to 0.0115
  64826. */
  64827. paddingRatio?: number;
  64828. /**
  64829. * Number that declares the fill method for the padding gutter.
  64830. */
  64831. paddingMode?: number;
  64832. /**
  64833. * If in SUBUV_COLOR padding mode what color to use.
  64834. */
  64835. paddingColor?: Color3 | Color4;
  64836. }
  64837. /**
  64838. * Defines the basic interface of a TexturePacker JSON File
  64839. */
  64840. export interface ITexturePackerJSON {
  64841. /**
  64842. * The frame ID
  64843. */
  64844. name: string;
  64845. /**
  64846. * The base64 channel data
  64847. */
  64848. sets: any;
  64849. /**
  64850. * The options of the Packer
  64851. */
  64852. options: ITexturePackerOptions;
  64853. /**
  64854. * The frame data of the Packer
  64855. */
  64856. frames: Array<number>;
  64857. }
  64858. /**
  64859. * This is a support class that generates a series of packed texture sets.
  64860. * @see https://doc.babylonjs.com/babylon101/materials
  64861. */
  64862. export class TexturePacker {
  64863. /** Packer Layout Constant 0 */
  64864. static readonly LAYOUT_STRIP: number;
  64865. /** Packer Layout Constant 1 */
  64866. static readonly LAYOUT_POWER2: number;
  64867. /** Packer Layout Constant 2 */
  64868. static readonly LAYOUT_COLNUM: number;
  64869. /** Packer Layout Constant 0 */
  64870. static readonly SUBUV_WRAP: number;
  64871. /** Packer Layout Constant 1 */
  64872. static readonly SUBUV_EXTEND: number;
  64873. /** Packer Layout Constant 2 */
  64874. static readonly SUBUV_COLOR: number;
  64875. /** The Name of the Texture Package */
  64876. name: string;
  64877. /** The scene scope of the TexturePacker */
  64878. scene: Scene;
  64879. /** The Meshes to target */
  64880. meshes: AbstractMesh[];
  64881. /** Arguments passed with the Constructor */
  64882. options: ITexturePackerOptions;
  64883. /** The promise that is started upon initialization */
  64884. promise: Nullable<Promise<TexturePacker | string>>;
  64885. /** The Container object for the channel sets that are generated */
  64886. sets: object;
  64887. /** The Container array for the frames that are generated */
  64888. frames: TexturePackerFrame[];
  64889. /** The expected number of textures the system is parsing. */
  64890. private _expecting;
  64891. /** The padding value from Math.ceil(frameSize * paddingRatio) */
  64892. private _paddingValue;
  64893. /**
  64894. * Initializes a texture package series from an array of meshes or a single mesh.
  64895. * @param name The name of the package
  64896. * @param meshes The target meshes to compose the package from
  64897. * @param options The arguments that texture packer should follow while building.
  64898. * @param scene The scene which the textures are scoped to.
  64899. * @returns TexturePacker
  64900. */
  64901. constructor(name: string, meshes: AbstractMesh[], options: ITexturePackerOptions, scene: Scene);
  64902. /**
  64903. * Starts the package process
  64904. * @param resolve The promises resolution function
  64905. * @returns TexturePacker
  64906. */
  64907. private _createFrames;
  64908. /**
  64909. * Calculates the Size of the Channel Sets
  64910. * @returns Vector2
  64911. */
  64912. private _calculateSize;
  64913. /**
  64914. * Calculates the UV data for the frames.
  64915. * @param baseSize the base frameSize
  64916. * @param padding the base frame padding
  64917. * @param dtSize size of the Dynamic Texture for that channel
  64918. * @param dtUnits is 1/dtSize
  64919. * @param update flag to update the input meshes
  64920. */
  64921. private _calculateMeshUVFrames;
  64922. /**
  64923. * Calculates the frames Offset.
  64924. * @param index of the frame
  64925. * @returns Vector2
  64926. */
  64927. private _getFrameOffset;
  64928. /**
  64929. * Updates a Mesh to the frame data
  64930. * @param mesh that is the target
  64931. * @param frameID or the frame index
  64932. */
  64933. private _updateMeshUV;
  64934. /**
  64935. * Updates a Meshes materials to use the texture packer channels
  64936. * @param m is the mesh to target
  64937. * @param force all channels on the packer to be set.
  64938. */
  64939. private _updateTextureReferences;
  64940. /**
  64941. * Public method to set a Mesh to a frame
  64942. * @param m that is the target
  64943. * @param frameID or the frame index
  64944. * @param updateMaterial trigger for if the Meshes attached Material be updated?
  64945. */
  64946. setMeshToFrame(m: AbstractMesh, frameID: number, updateMaterial?: boolean): void;
  64947. /**
  64948. * Starts the async promise to compile the texture packer.
  64949. * @returns Promise<void>
  64950. */
  64951. processAsync(): Promise<void>;
  64952. /**
  64953. * Disposes all textures associated with this packer
  64954. */
  64955. dispose(): void;
  64956. /**
  64957. * Starts the download process for all the channels converting them to base64 data and embedding it all in a JSON file.
  64958. * @param imageType is the image type to use.
  64959. * @param quality of the image if downloading as jpeg, Ranges from >0 to 1.
  64960. */
  64961. download(imageType?: string, quality?: number): void;
  64962. /**
  64963. * Public method to load a texturePacker JSON file.
  64964. * @param data of the JSON file in string format.
  64965. */
  64966. updateFromJSON(data: string): void;
  64967. }
  64968. }
  64969. declare module "babylonjs/Materials/Textures/Packer/index" {
  64970. export * from "babylonjs/Materials/Textures/Packer/packer";
  64971. export * from "babylonjs/Materials/Textures/Packer/frame";
  64972. }
  64973. declare module "babylonjs/Materials/Textures/Procedurals/customProceduralTexture" {
  64974. import { Scene } from "babylonjs/scene";
  64975. import { Texture } from "babylonjs/Materials/Textures/texture";
  64976. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  64977. /**
  64978. * 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.
  64979. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  64980. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  64981. */
  64982. export class CustomProceduralTexture extends ProceduralTexture {
  64983. private _animate;
  64984. private _time;
  64985. private _config;
  64986. private _texturePath;
  64987. /**
  64988. * Instantiates a new Custom Procedural Texture.
  64989. * 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.
  64990. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  64991. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  64992. * @param name Define the name of the texture
  64993. * @param texturePath Define the folder path containing all the cutom texture related files (config, shaders...)
  64994. * @param size Define the size of the texture to create
  64995. * @param scene Define the scene the texture belongs to
  64996. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  64997. * @param generateMipMaps Define if the texture should creates mip maps or not
  64998. */
  64999. constructor(name: string, texturePath: string, size: number, scene: Scene, fallbackTexture?: Texture, generateMipMaps?: boolean);
  65000. private _loadJson;
  65001. /**
  65002. * Is the texture ready to be used ? (rendered at least once)
  65003. * @returns true if ready, otherwise, false.
  65004. */
  65005. isReady(): boolean;
  65006. /**
  65007. * Render the texture to its associated render target.
  65008. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  65009. */
  65010. render(useCameraPostProcess?: boolean): void;
  65011. /**
  65012. * Update the list of dependant textures samplers in the shader.
  65013. */
  65014. updateTextures(): void;
  65015. /**
  65016. * Update the uniform values of the procedural texture in the shader.
  65017. */
  65018. updateShaderUniforms(): void;
  65019. /**
  65020. * Define if the texture animates or not.
  65021. */
  65022. get animate(): boolean;
  65023. set animate(value: boolean);
  65024. }
  65025. }
  65026. declare module "babylonjs/Shaders/noise.fragment" {
  65027. /** @hidden */
  65028. export var noisePixelShader: {
  65029. name: string;
  65030. shader: string;
  65031. };
  65032. }
  65033. declare module "babylonjs/Materials/Textures/Procedurals/noiseProceduralTexture" {
  65034. import { Nullable } from "babylonjs/types";
  65035. import { Scene } from "babylonjs/scene";
  65036. import { Texture } from "babylonjs/Materials/Textures/texture";
  65037. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  65038. import "babylonjs/Shaders/noise.fragment";
  65039. /**
  65040. * Class used to generate noise procedural textures
  65041. */
  65042. export class NoiseProceduralTexture extends ProceduralTexture {
  65043. /** Gets or sets the start time (default is 0) */
  65044. time: number;
  65045. /** Gets or sets a value between 0 and 1 indicating the overall brightness of the texture (default is 0.2) */
  65046. brightness: number;
  65047. /** Defines the number of octaves to process */
  65048. octaves: number;
  65049. /** Defines the level of persistence (0.8 by default) */
  65050. persistence: number;
  65051. /** Gets or sets animation speed factor (default is 1) */
  65052. animationSpeedFactor: number;
  65053. /**
  65054. * Creates a new NoiseProceduralTexture
  65055. * @param name defines the name fo the texture
  65056. * @param size defines the size of the texture (default is 256)
  65057. * @param scene defines the hosting scene
  65058. * @param fallbackTexture defines the texture to use if the NoiseProceduralTexture can't be created
  65059. * @param generateMipMaps defines if mipmaps must be generated (true by default)
  65060. */
  65061. constructor(name: string, size?: number, scene?: Nullable<Scene>, fallbackTexture?: Texture, generateMipMaps?: boolean);
  65062. private _updateShaderUniforms;
  65063. protected _getDefines(): string;
  65064. /** Generate the current state of the procedural texture */
  65065. render(useCameraPostProcess?: boolean): void;
  65066. /**
  65067. * Serializes this noise procedural texture
  65068. * @returns a serialized noise procedural texture object
  65069. */
  65070. serialize(): any;
  65071. /**
  65072. * Clone the texture.
  65073. * @returns the cloned texture
  65074. */
  65075. clone(): NoiseProceduralTexture;
  65076. /**
  65077. * Creates a NoiseProceduralTexture from parsed noise procedural texture data
  65078. * @param parsedTexture defines parsed texture data
  65079. * @param scene defines the current scene
  65080. * @param rootUrl defines the root URL containing noise procedural texture information
  65081. * @returns a parsed NoiseProceduralTexture
  65082. */
  65083. static Parse(parsedTexture: any, scene: Scene): NoiseProceduralTexture;
  65084. }
  65085. }
  65086. declare module "babylonjs/Materials/Textures/Procedurals/index" {
  65087. export * from "babylonjs/Materials/Textures/Procedurals/customProceduralTexture";
  65088. export * from "babylonjs/Materials/Textures/Procedurals/noiseProceduralTexture";
  65089. export * from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  65090. export * from "babylonjs/Materials/Textures/Procedurals/proceduralTextureSceneComponent";
  65091. }
  65092. declare module "babylonjs/Materials/Textures/rawCubeTexture" {
  65093. import { Nullable } from "babylonjs/types";
  65094. import { Scene } from "babylonjs/scene";
  65095. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  65096. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  65097. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  65098. import "babylonjs/Engines/Extensions/engine.rawTexture";
  65099. /**
  65100. * Raw cube texture where the raw buffers are passed in
  65101. */
  65102. export class RawCubeTexture extends CubeTexture {
  65103. /**
  65104. * Creates a cube texture where the raw buffers are passed in.
  65105. * @param scene defines the scene the texture is attached to
  65106. * @param data defines the array of data to use to create each face
  65107. * @param size defines the size of the textures
  65108. * @param format defines the format of the data
  65109. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  65110. * @param generateMipMaps defines if the engine should generate the mip levels
  65111. * @param invertY defines if data must be stored with Y axis inverted
  65112. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  65113. * @param compression defines the compression used (null by default)
  65114. */
  65115. constructor(scene: Scene, data: Nullable<ArrayBufferView[]>, size: number, format?: number, type?: number, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, compression?: Nullable<string>);
  65116. /**
  65117. * Updates the raw cube texture.
  65118. * @param data defines the data to store
  65119. * @param format defines the data format
  65120. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  65121. * @param invertY defines if data must be stored with Y axis inverted
  65122. * @param compression defines the compression used (null by default)
  65123. * @param level defines which level of the texture to update
  65124. */
  65125. update(data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression?: Nullable<string>): void;
  65126. /**
  65127. * Updates a raw cube texture with RGBD encoded data.
  65128. * @param data defines the array of data [mipmap][face] to use to create each face
  65129. * @param sphericalPolynomial defines the spherical polynomial for irradiance
  65130. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  65131. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  65132. * @returns a promsie that resolves when the operation is complete
  65133. */
  65134. updateRGBDAsync(data: ArrayBufferView[][], sphericalPolynomial?: Nullable<SphericalPolynomial>, lodScale?: number, lodOffset?: number): Promise<void>;
  65135. /**
  65136. * Clones the raw cube texture.
  65137. * @return a new cube texture
  65138. */
  65139. clone(): CubeTexture;
  65140. /** @hidden */
  65141. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  65142. }
  65143. }
  65144. declare module "babylonjs/Materials/Textures/rawTexture2DArray" {
  65145. import { Scene } from "babylonjs/scene";
  65146. import { Texture } from "babylonjs/Materials/Textures/texture";
  65147. import "babylonjs/Engines/Extensions/engine.rawTexture";
  65148. /**
  65149. * Class used to store 2D array textures containing user data
  65150. */
  65151. export class RawTexture2DArray extends Texture {
  65152. /** Gets or sets the texture format to use */
  65153. format: number;
  65154. /**
  65155. * Create a new RawTexture2DArray
  65156. * @param data defines the data of the texture
  65157. * @param width defines the width of the texture
  65158. * @param height defines the height of the texture
  65159. * @param depth defines the number of layers of the texture
  65160. * @param format defines the texture format to use
  65161. * @param scene defines the hosting scene
  65162. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  65163. * @param invertY defines if texture must be stored with Y axis inverted
  65164. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  65165. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  65166. */
  65167. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  65168. /** Gets or sets the texture format to use */
  65169. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  65170. /**
  65171. * Update the texture with new data
  65172. * @param data defines the data to store in the texture
  65173. */
  65174. update(data: ArrayBufferView): void;
  65175. }
  65176. }
  65177. declare module "babylonjs/Materials/Textures/rawTexture3D" {
  65178. import { Scene } from "babylonjs/scene";
  65179. import { Texture } from "babylonjs/Materials/Textures/texture";
  65180. import "babylonjs/Engines/Extensions/engine.rawTexture";
  65181. /**
  65182. * Class used to store 3D textures containing user data
  65183. */
  65184. export class RawTexture3D extends Texture {
  65185. /** Gets or sets the texture format to use */
  65186. format: number;
  65187. /**
  65188. * Create a new RawTexture3D
  65189. * @param data defines the data of the texture
  65190. * @param width defines the width of the texture
  65191. * @param height defines the height of the texture
  65192. * @param depth defines the depth of the texture
  65193. * @param format defines the texture format to use
  65194. * @param scene defines the hosting scene
  65195. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  65196. * @param invertY defines if texture must be stored with Y axis inverted
  65197. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  65198. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  65199. */
  65200. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  65201. /** Gets or sets the texture format to use */
  65202. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  65203. /**
  65204. * Update the texture with new data
  65205. * @param data defines the data to store in the texture
  65206. */
  65207. update(data: ArrayBufferView): void;
  65208. }
  65209. }
  65210. declare module "babylonjs/Materials/Textures/refractionTexture" {
  65211. import { Scene } from "babylonjs/scene";
  65212. import { Plane } from "babylonjs/Maths/math.plane";
  65213. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  65214. /**
  65215. * Creates a refraction texture used by refraction channel of the standard material.
  65216. * It is like a mirror but to see through a material.
  65217. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  65218. */
  65219. export class RefractionTexture extends RenderTargetTexture {
  65220. /**
  65221. * Define the reflection plane we want to use. The refractionPlane is usually set to the constructed refractor.
  65222. * 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.
  65223. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  65224. */
  65225. refractionPlane: Plane;
  65226. /**
  65227. * Define how deep under the surface we should see.
  65228. */
  65229. depth: number;
  65230. /**
  65231. * Creates a refraction texture used by refraction channel of the standard material.
  65232. * It is like a mirror but to see through a material.
  65233. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  65234. * @param name Define the texture name
  65235. * @param size Define the size of the underlying texture
  65236. * @param scene Define the scene the refraction belongs to
  65237. * @param generateMipMaps Define if we need to generate mips level for the refraction
  65238. */
  65239. constructor(name: string, size: number, scene: Scene, generateMipMaps?: boolean);
  65240. /**
  65241. * Clone the refraction texture.
  65242. * @returns the cloned texture
  65243. */
  65244. clone(): RefractionTexture;
  65245. /**
  65246. * Serialize the texture to a JSON representation you could use in Parse later on
  65247. * @returns the serialized JSON representation
  65248. */
  65249. serialize(): any;
  65250. }
  65251. }
  65252. declare module "babylonjs/Materials/Textures/index" {
  65253. export * from "babylonjs/Materials/Textures/baseTexture";
  65254. export * from "babylonjs/Materials/Textures/baseTexture.polynomial";
  65255. export * from "babylonjs/Materials/Textures/colorGradingTexture";
  65256. export * from "babylonjs/Materials/Textures/cubeTexture";
  65257. export * from "babylonjs/Materials/Textures/dynamicTexture";
  65258. export * from "babylonjs/Materials/Textures/equiRectangularCubeTexture";
  65259. export * from "babylonjs/Materials/Textures/Filtering/hdrFiltering";
  65260. export * from "babylonjs/Materials/Textures/hdrCubeTexture";
  65261. export * from "babylonjs/Materials/Textures/htmlElementTexture";
  65262. export * from "babylonjs/Materials/Textures/internalTexture";
  65263. export * from "babylonjs/Materials/Textures/internalTextureLoader";
  65264. export * from "babylonjs/Materials/Textures/Loaders/index";
  65265. export * from "babylonjs/Materials/Textures/mirrorTexture";
  65266. export * from "babylonjs/Materials/Textures/multiRenderTarget";
  65267. export * from "babylonjs/Materials/Textures/Packer/index";
  65268. export * from "babylonjs/Materials/Textures/Procedurals/index";
  65269. export * from "babylonjs/Materials/Textures/rawCubeTexture";
  65270. export * from "babylonjs/Materials/Textures/rawTexture";
  65271. export * from "babylonjs/Materials/Textures/rawTexture2DArray";
  65272. export * from "babylonjs/Materials/Textures/rawTexture3D";
  65273. export * from "babylonjs/Materials/Textures/refractionTexture";
  65274. export * from "babylonjs/Materials/Textures/renderTargetTexture";
  65275. export * from "babylonjs/Materials/Textures/texture";
  65276. export * from "babylonjs/Materials/Textures/videoTexture";
  65277. }
  65278. declare module "babylonjs/Materials/Node/Enums/index" {
  65279. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  65280. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  65281. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointMode";
  65282. export * from "babylonjs/Materials/Node/Enums/nodeMaterialSystemValues";
  65283. export * from "babylonjs/Materials/Node/Enums/nodeMaterialModes";
  65284. }
  65285. declare module "babylonjs/Materials/Node/Blocks/Vertex/bonesBlock" {
  65286. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65287. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65288. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65289. import { Mesh } from "babylonjs/Meshes/mesh";
  65290. import { Effect } from "babylonjs/Materials/effect";
  65291. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65292. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65293. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  65294. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  65295. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  65296. /**
  65297. * Block used to add support for vertex skinning (bones)
  65298. */
  65299. export class BonesBlock extends NodeMaterialBlock {
  65300. /**
  65301. * Creates a new BonesBlock
  65302. * @param name defines the block name
  65303. */
  65304. constructor(name: string);
  65305. /**
  65306. * Initialize the block and prepare the context for build
  65307. * @param state defines the state that will be used for the build
  65308. */
  65309. initialize(state: NodeMaterialBuildState): void;
  65310. /**
  65311. * Gets the current class name
  65312. * @returns the class name
  65313. */
  65314. getClassName(): string;
  65315. /**
  65316. * Gets the matrix indices input component
  65317. */
  65318. get matricesIndices(): NodeMaterialConnectionPoint;
  65319. /**
  65320. * Gets the matrix weights input component
  65321. */
  65322. get matricesWeights(): NodeMaterialConnectionPoint;
  65323. /**
  65324. * Gets the extra matrix indices input component
  65325. */
  65326. get matricesIndicesExtra(): NodeMaterialConnectionPoint;
  65327. /**
  65328. * Gets the extra matrix weights input component
  65329. */
  65330. get matricesWeightsExtra(): NodeMaterialConnectionPoint;
  65331. /**
  65332. * Gets the world input component
  65333. */
  65334. get world(): NodeMaterialConnectionPoint;
  65335. /**
  65336. * Gets the output component
  65337. */
  65338. get output(): NodeMaterialConnectionPoint;
  65339. autoConfigure(material: NodeMaterial): void;
  65340. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  65341. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65342. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65343. protected _buildBlock(state: NodeMaterialBuildState): this;
  65344. }
  65345. }
  65346. declare module "babylonjs/Materials/Node/Blocks/Vertex/instancesBlock" {
  65347. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65348. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65349. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65350. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65351. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65352. import { SubMesh } from "babylonjs/Meshes/subMesh";
  65353. /**
  65354. * Block used to add support for instances
  65355. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  65356. */
  65357. export class InstancesBlock extends NodeMaterialBlock {
  65358. /**
  65359. * Creates a new InstancesBlock
  65360. * @param name defines the block name
  65361. */
  65362. constructor(name: string);
  65363. /**
  65364. * Gets the current class name
  65365. * @returns the class name
  65366. */
  65367. getClassName(): string;
  65368. /**
  65369. * Gets the first world row input component
  65370. */
  65371. get world0(): NodeMaterialConnectionPoint;
  65372. /**
  65373. * Gets the second world row input component
  65374. */
  65375. get world1(): NodeMaterialConnectionPoint;
  65376. /**
  65377. * Gets the third world row input component
  65378. */
  65379. get world2(): NodeMaterialConnectionPoint;
  65380. /**
  65381. * Gets the forth world row input component
  65382. */
  65383. get world3(): NodeMaterialConnectionPoint;
  65384. /**
  65385. * Gets the world input component
  65386. */
  65387. get world(): NodeMaterialConnectionPoint;
  65388. /**
  65389. * Gets the output component
  65390. */
  65391. get output(): NodeMaterialConnectionPoint;
  65392. /**
  65393. * Gets the isntanceID component
  65394. */
  65395. get instanceID(): NodeMaterialConnectionPoint;
  65396. autoConfigure(material: NodeMaterial): void;
  65397. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  65398. protected _buildBlock(state: NodeMaterialBuildState): this;
  65399. }
  65400. }
  65401. declare module "babylonjs/Materials/Node/Blocks/Vertex/morphTargetsBlock" {
  65402. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65403. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65404. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65405. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65406. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65407. import { Effect } from "babylonjs/Materials/effect";
  65408. import { Mesh } from "babylonjs/Meshes/mesh";
  65409. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  65410. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  65411. /**
  65412. * Block used to add morph targets support to vertex shader
  65413. */
  65414. export class MorphTargetsBlock extends NodeMaterialBlock {
  65415. private _repeatableContentAnchor;
  65416. /**
  65417. * Create a new MorphTargetsBlock
  65418. * @param name defines the block name
  65419. */
  65420. constructor(name: string);
  65421. /**
  65422. * Gets the current class name
  65423. * @returns the class name
  65424. */
  65425. getClassName(): string;
  65426. /**
  65427. * Gets the position input component
  65428. */
  65429. get position(): NodeMaterialConnectionPoint;
  65430. /**
  65431. * Gets the normal input component
  65432. */
  65433. get normal(): NodeMaterialConnectionPoint;
  65434. /**
  65435. * Gets the tangent input component
  65436. */
  65437. get tangent(): NodeMaterialConnectionPoint;
  65438. /**
  65439. * Gets the tangent input component
  65440. */
  65441. get uv(): NodeMaterialConnectionPoint;
  65442. /**
  65443. * Gets the position output component
  65444. */
  65445. get positionOutput(): NodeMaterialConnectionPoint;
  65446. /**
  65447. * Gets the normal output component
  65448. */
  65449. get normalOutput(): NodeMaterialConnectionPoint;
  65450. /**
  65451. * Gets the tangent output component
  65452. */
  65453. get tangentOutput(): NodeMaterialConnectionPoint;
  65454. /**
  65455. * Gets the tangent output component
  65456. */
  65457. get uvOutput(): NodeMaterialConnectionPoint;
  65458. initialize(state: NodeMaterialBuildState): void;
  65459. autoConfigure(material: NodeMaterial): void;
  65460. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65461. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65462. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  65463. protected _buildBlock(state: NodeMaterialBuildState): this;
  65464. }
  65465. }
  65466. declare module "babylonjs/Materials/Node/Blocks/Vertex/lightInformationBlock" {
  65467. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65468. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65469. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65470. import { Nullable } from "babylonjs/types";
  65471. import { Scene } from "babylonjs/scene";
  65472. import { Effect } from "babylonjs/Materials/effect";
  65473. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65474. import { Mesh } from "babylonjs/Meshes/mesh";
  65475. import { Light } from "babylonjs/Lights/light";
  65476. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65477. /**
  65478. * Block used to get data information from a light
  65479. */
  65480. export class LightInformationBlock extends NodeMaterialBlock {
  65481. private _lightDataUniformName;
  65482. private _lightColorUniformName;
  65483. private _lightTypeDefineName;
  65484. /**
  65485. * Gets or sets the light associated with this block
  65486. */
  65487. light: Nullable<Light>;
  65488. /**
  65489. * Creates a new LightInformationBlock
  65490. * @param name defines the block name
  65491. */
  65492. constructor(name: string);
  65493. /**
  65494. * Gets the current class name
  65495. * @returns the class name
  65496. */
  65497. getClassName(): string;
  65498. /**
  65499. * Gets the world position input component
  65500. */
  65501. get worldPosition(): NodeMaterialConnectionPoint;
  65502. /**
  65503. * Gets the direction output component
  65504. */
  65505. get direction(): NodeMaterialConnectionPoint;
  65506. /**
  65507. * Gets the direction output component
  65508. */
  65509. get color(): NodeMaterialConnectionPoint;
  65510. /**
  65511. * Gets the direction output component
  65512. */
  65513. get intensity(): NodeMaterialConnectionPoint;
  65514. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65515. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65516. protected _buildBlock(state: NodeMaterialBuildState): this;
  65517. serialize(): any;
  65518. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  65519. }
  65520. }
  65521. declare module "babylonjs/Materials/Node/Blocks/Vertex/index" {
  65522. export * from "babylonjs/Materials/Node/Blocks/Vertex/vertexOutputBlock";
  65523. export * from "babylonjs/Materials/Node/Blocks/Vertex/bonesBlock";
  65524. export * from "babylonjs/Materials/Node/Blocks/Vertex/instancesBlock";
  65525. export * from "babylonjs/Materials/Node/Blocks/Vertex/morphTargetsBlock";
  65526. export * from "babylonjs/Materials/Node/Blocks/Vertex/lightInformationBlock";
  65527. }
  65528. declare module "babylonjs/Materials/Node/Blocks/Fragment/imageProcessingBlock" {
  65529. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65530. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65531. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65532. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65533. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65534. import { Effect } from "babylonjs/Materials/effect";
  65535. import { Mesh } from "babylonjs/Meshes/mesh";
  65536. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  65537. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  65538. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  65539. /**
  65540. * Block used to add image processing support to fragment shader
  65541. */
  65542. export class ImageProcessingBlock extends NodeMaterialBlock {
  65543. /**
  65544. * Create a new ImageProcessingBlock
  65545. * @param name defines the block name
  65546. */
  65547. constructor(name: string);
  65548. /**
  65549. * Gets the current class name
  65550. * @returns the class name
  65551. */
  65552. getClassName(): string;
  65553. /**
  65554. * Gets the color input component
  65555. */
  65556. get color(): NodeMaterialConnectionPoint;
  65557. /**
  65558. * Gets the output component
  65559. */
  65560. get output(): NodeMaterialConnectionPoint;
  65561. /**
  65562. * Initialize the block and prepare the context for build
  65563. * @param state defines the state that will be used for the build
  65564. */
  65565. initialize(state: NodeMaterialBuildState): void;
  65566. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): boolean;
  65567. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65568. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65569. protected _buildBlock(state: NodeMaterialBuildState): this;
  65570. }
  65571. }
  65572. declare module "babylonjs/Materials/Node/Blocks/Fragment/perturbNormalBlock" {
  65573. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65574. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65575. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65576. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65577. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65578. import { Effect } from "babylonjs/Materials/effect";
  65579. import { Mesh } from "babylonjs/Meshes/mesh";
  65580. import { Scene } from "babylonjs/scene";
  65581. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  65582. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  65583. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  65584. /**
  65585. * Block used to pertub normals based on a normal map
  65586. */
  65587. export class PerturbNormalBlock extends NodeMaterialBlock {
  65588. private _tangentSpaceParameterName;
  65589. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  65590. invertX: boolean;
  65591. /** Gets or sets a boolean indicating that normal should be inverted on Y axis */
  65592. invertY: boolean;
  65593. /**
  65594. * Create a new PerturbNormalBlock
  65595. * @param name defines the block name
  65596. */
  65597. constructor(name: string);
  65598. /**
  65599. * Gets the current class name
  65600. * @returns the class name
  65601. */
  65602. getClassName(): string;
  65603. /**
  65604. * Gets the world position input component
  65605. */
  65606. get worldPosition(): NodeMaterialConnectionPoint;
  65607. /**
  65608. * Gets the world normal input component
  65609. */
  65610. get worldNormal(): NodeMaterialConnectionPoint;
  65611. /**
  65612. * Gets the world tangent input component
  65613. */
  65614. get worldTangent(): NodeMaterialConnectionPoint;
  65615. /**
  65616. * Gets the uv input component
  65617. */
  65618. get uv(): NodeMaterialConnectionPoint;
  65619. /**
  65620. * Gets the normal map color input component
  65621. */
  65622. get normalMapColor(): NodeMaterialConnectionPoint;
  65623. /**
  65624. * Gets the strength input component
  65625. */
  65626. get strength(): NodeMaterialConnectionPoint;
  65627. /**
  65628. * Gets the output component
  65629. */
  65630. get output(): NodeMaterialConnectionPoint;
  65631. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65632. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65633. autoConfigure(material: NodeMaterial): void;
  65634. protected _buildBlock(state: NodeMaterialBuildState): this;
  65635. protected _dumpPropertiesCode(): string;
  65636. serialize(): any;
  65637. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  65638. }
  65639. }
  65640. declare module "babylonjs/Materials/Node/Blocks/Fragment/discardBlock" {
  65641. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65642. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65643. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65644. /**
  65645. * Block used to discard a pixel if a value is smaller than a cutoff
  65646. */
  65647. export class DiscardBlock extends NodeMaterialBlock {
  65648. /**
  65649. * Create a new DiscardBlock
  65650. * @param name defines the block name
  65651. */
  65652. constructor(name: string);
  65653. /**
  65654. * Gets the current class name
  65655. * @returns the class name
  65656. */
  65657. getClassName(): string;
  65658. /**
  65659. * Gets the color input component
  65660. */
  65661. get value(): NodeMaterialConnectionPoint;
  65662. /**
  65663. * Gets the cutoff input component
  65664. */
  65665. get cutoff(): NodeMaterialConnectionPoint;
  65666. protected _buildBlock(state: NodeMaterialBuildState): this;
  65667. }
  65668. }
  65669. declare module "babylonjs/Materials/Node/Blocks/Fragment/frontFacingBlock" {
  65670. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65671. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65672. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65673. /**
  65674. * Block used to test if the fragment shader is front facing
  65675. */
  65676. export class FrontFacingBlock extends NodeMaterialBlock {
  65677. /**
  65678. * Creates a new FrontFacingBlock
  65679. * @param name defines the block name
  65680. */
  65681. constructor(name: string);
  65682. /**
  65683. * Gets the current class name
  65684. * @returns the class name
  65685. */
  65686. getClassName(): string;
  65687. /**
  65688. * Gets the output component
  65689. */
  65690. get output(): NodeMaterialConnectionPoint;
  65691. protected _buildBlock(state: NodeMaterialBuildState): this;
  65692. }
  65693. }
  65694. declare module "babylonjs/Materials/Node/Blocks/Fragment/derivativeBlock" {
  65695. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65696. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65697. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65698. /**
  65699. * Block used to get the derivative value on x and y of a given input
  65700. */
  65701. export class DerivativeBlock extends NodeMaterialBlock {
  65702. /**
  65703. * Create a new DerivativeBlock
  65704. * @param name defines the block name
  65705. */
  65706. constructor(name: string);
  65707. /**
  65708. * Gets the current class name
  65709. * @returns the class name
  65710. */
  65711. getClassName(): string;
  65712. /**
  65713. * Gets the input component
  65714. */
  65715. get input(): NodeMaterialConnectionPoint;
  65716. /**
  65717. * Gets the derivative output on x
  65718. */
  65719. get dx(): NodeMaterialConnectionPoint;
  65720. /**
  65721. * Gets the derivative output on y
  65722. */
  65723. get dy(): NodeMaterialConnectionPoint;
  65724. protected _buildBlock(state: NodeMaterialBuildState): this;
  65725. }
  65726. }
  65727. declare module "babylonjs/Materials/Node/Blocks/Fragment/fragCoordBlock" {
  65728. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65729. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65730. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65731. /**
  65732. * Block used to make gl_FragCoord available
  65733. */
  65734. export class FragCoordBlock extends NodeMaterialBlock {
  65735. /**
  65736. * Creates a new FragCoordBlock
  65737. * @param name defines the block name
  65738. */
  65739. constructor(name: string);
  65740. /**
  65741. * Gets the current class name
  65742. * @returns the class name
  65743. */
  65744. getClassName(): string;
  65745. /**
  65746. * Gets the xy component
  65747. */
  65748. get xy(): NodeMaterialConnectionPoint;
  65749. /**
  65750. * Gets the xyz component
  65751. */
  65752. get xyz(): NodeMaterialConnectionPoint;
  65753. /**
  65754. * Gets the xyzw component
  65755. */
  65756. get xyzw(): NodeMaterialConnectionPoint;
  65757. /**
  65758. * Gets the x component
  65759. */
  65760. get x(): NodeMaterialConnectionPoint;
  65761. /**
  65762. * Gets the y component
  65763. */
  65764. get y(): NodeMaterialConnectionPoint;
  65765. /**
  65766. * Gets the z component
  65767. */
  65768. get z(): NodeMaterialConnectionPoint;
  65769. /**
  65770. * Gets the w component
  65771. */
  65772. get output(): NodeMaterialConnectionPoint;
  65773. protected writeOutputs(state: NodeMaterialBuildState): string;
  65774. protected _buildBlock(state: NodeMaterialBuildState): this;
  65775. }
  65776. }
  65777. declare module "babylonjs/Materials/Node/Blocks/Fragment/screenSizeBlock" {
  65778. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65779. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65780. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65781. import { Effect } from "babylonjs/Materials/effect";
  65782. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  65783. import { Mesh } from "babylonjs/Meshes/mesh";
  65784. /**
  65785. * Block used to get the screen sizes
  65786. */
  65787. export class ScreenSizeBlock extends NodeMaterialBlock {
  65788. private _varName;
  65789. private _scene;
  65790. /**
  65791. * Creates a new ScreenSizeBlock
  65792. * @param name defines the block name
  65793. */
  65794. constructor(name: string);
  65795. /**
  65796. * Gets the current class name
  65797. * @returns the class name
  65798. */
  65799. getClassName(): string;
  65800. /**
  65801. * Gets the xy component
  65802. */
  65803. get xy(): NodeMaterialConnectionPoint;
  65804. /**
  65805. * Gets the x component
  65806. */
  65807. get x(): NodeMaterialConnectionPoint;
  65808. /**
  65809. * Gets the y component
  65810. */
  65811. get y(): NodeMaterialConnectionPoint;
  65812. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65813. protected writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  65814. protected _buildBlock(state: NodeMaterialBuildState): this;
  65815. }
  65816. }
  65817. declare module "babylonjs/Materials/Node/Blocks/Fragment/index" {
  65818. export * from "babylonjs/Materials/Node/Blocks/Fragment/fragmentOutputBlock";
  65819. export * from "babylonjs/Materials/Node/Blocks/Fragment/imageProcessingBlock";
  65820. export * from "babylonjs/Materials/Node/Blocks/Fragment/perturbNormalBlock";
  65821. export * from "babylonjs/Materials/Node/Blocks/Fragment/discardBlock";
  65822. export * from "babylonjs/Materials/Node/Blocks/Fragment/frontFacingBlock";
  65823. export * from "babylonjs/Materials/Node/Blocks/Fragment/derivativeBlock";
  65824. export * from "babylonjs/Materials/Node/Blocks/Fragment/fragCoordBlock";
  65825. export * from "babylonjs/Materials/Node/Blocks/Fragment/screenSizeBlock";
  65826. }
  65827. declare module "babylonjs/Materials/Node/Blocks/Dual/fogBlock" {
  65828. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65829. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65830. import { Mesh } from "babylonjs/Meshes/mesh";
  65831. import { Effect } from "babylonjs/Materials/effect";
  65832. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65833. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65834. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65835. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  65836. /**
  65837. * Block used to add support for scene fog
  65838. */
  65839. export class FogBlock extends NodeMaterialBlock {
  65840. private _fogDistanceName;
  65841. private _fogParameters;
  65842. /**
  65843. * Create a new FogBlock
  65844. * @param name defines the block name
  65845. */
  65846. constructor(name: string);
  65847. /**
  65848. * Gets the current class name
  65849. * @returns the class name
  65850. */
  65851. getClassName(): string;
  65852. /**
  65853. * Gets the world position input component
  65854. */
  65855. get worldPosition(): NodeMaterialConnectionPoint;
  65856. /**
  65857. * Gets the view input component
  65858. */
  65859. get view(): NodeMaterialConnectionPoint;
  65860. /**
  65861. * Gets the color input component
  65862. */
  65863. get input(): NodeMaterialConnectionPoint;
  65864. /**
  65865. * Gets the fog color input component
  65866. */
  65867. get fogColor(): NodeMaterialConnectionPoint;
  65868. /**
  65869. * Gets the output component
  65870. */
  65871. get output(): NodeMaterialConnectionPoint;
  65872. autoConfigure(material: NodeMaterial): void;
  65873. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65874. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65875. protected _buildBlock(state: NodeMaterialBuildState): this;
  65876. }
  65877. }
  65878. declare module "babylonjs/Materials/Node/Blocks/Dual/lightBlock" {
  65879. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65880. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65881. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65882. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65883. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65884. import { Effect } from "babylonjs/Materials/effect";
  65885. import { Mesh } from "babylonjs/Meshes/mesh";
  65886. import { Light } from "babylonjs/Lights/light";
  65887. import { Nullable } from "babylonjs/types";
  65888. import { Scene } from "babylonjs/scene";
  65889. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  65890. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  65891. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  65892. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  65893. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  65894. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  65895. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  65896. /**
  65897. * Block used to add light in the fragment shader
  65898. */
  65899. export class LightBlock extends NodeMaterialBlock {
  65900. private _lightId;
  65901. /**
  65902. * Gets or sets the light associated with this block
  65903. */
  65904. light: Nullable<Light>;
  65905. /**
  65906. * Create a new LightBlock
  65907. * @param name defines the block name
  65908. */
  65909. constructor(name: string);
  65910. /**
  65911. * Gets the current class name
  65912. * @returns the class name
  65913. */
  65914. getClassName(): string;
  65915. /**
  65916. * Gets the world position input component
  65917. */
  65918. get worldPosition(): NodeMaterialConnectionPoint;
  65919. /**
  65920. * Gets the world normal input component
  65921. */
  65922. get worldNormal(): NodeMaterialConnectionPoint;
  65923. /**
  65924. * Gets the camera (or eye) position component
  65925. */
  65926. get cameraPosition(): NodeMaterialConnectionPoint;
  65927. /**
  65928. * Gets the glossiness component
  65929. */
  65930. get glossiness(): NodeMaterialConnectionPoint;
  65931. /**
  65932. * Gets the glossinness power component
  65933. */
  65934. get glossPower(): NodeMaterialConnectionPoint;
  65935. /**
  65936. * Gets the diffuse color component
  65937. */
  65938. get diffuseColor(): NodeMaterialConnectionPoint;
  65939. /**
  65940. * Gets the specular color component
  65941. */
  65942. get specularColor(): NodeMaterialConnectionPoint;
  65943. /**
  65944. * Gets the diffuse output component
  65945. */
  65946. get diffuseOutput(): NodeMaterialConnectionPoint;
  65947. /**
  65948. * Gets the specular output component
  65949. */
  65950. get specularOutput(): NodeMaterialConnectionPoint;
  65951. /**
  65952. * Gets the shadow output component
  65953. */
  65954. get shadow(): NodeMaterialConnectionPoint;
  65955. autoConfigure(material: NodeMaterial): void;
  65956. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65957. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  65958. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65959. private _injectVertexCode;
  65960. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  65961. serialize(): any;
  65962. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  65963. }
  65964. }
  65965. declare module "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBlock" {
  65966. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65967. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65968. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  65969. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  65970. /**
  65971. * Block used to read a reflection texture from a sampler
  65972. */
  65973. export class ReflectionTextureBlock extends ReflectionTextureBaseBlock {
  65974. /**
  65975. * Create a new ReflectionTextureBlock
  65976. * @param name defines the block name
  65977. */
  65978. constructor(name: string);
  65979. /**
  65980. * Gets the current class name
  65981. * @returns the class name
  65982. */
  65983. getClassName(): string;
  65984. /**
  65985. * Gets the world position input component
  65986. */
  65987. get position(): NodeMaterialConnectionPoint;
  65988. /**
  65989. * Gets the world position input component
  65990. */
  65991. get worldPosition(): NodeMaterialConnectionPoint;
  65992. /**
  65993. * Gets the world normal input component
  65994. */
  65995. get worldNormal(): NodeMaterialConnectionPoint;
  65996. /**
  65997. * Gets the world input component
  65998. */
  65999. get world(): NodeMaterialConnectionPoint;
  66000. /**
  66001. * Gets the camera (or eye) position component
  66002. */
  66003. get cameraPosition(): NodeMaterialConnectionPoint;
  66004. /**
  66005. * Gets the view input component
  66006. */
  66007. get view(): NodeMaterialConnectionPoint;
  66008. /**
  66009. * Gets the rgb output component
  66010. */
  66011. get rgb(): NodeMaterialConnectionPoint;
  66012. /**
  66013. * Gets the rgba output component
  66014. */
  66015. get rgba(): NodeMaterialConnectionPoint;
  66016. /**
  66017. * Gets the r output component
  66018. */
  66019. get r(): NodeMaterialConnectionPoint;
  66020. /**
  66021. * Gets the g output component
  66022. */
  66023. get g(): NodeMaterialConnectionPoint;
  66024. /**
  66025. * Gets the b output component
  66026. */
  66027. get b(): NodeMaterialConnectionPoint;
  66028. /**
  66029. * Gets the a output component
  66030. */
  66031. get a(): NodeMaterialConnectionPoint;
  66032. autoConfigure(material: NodeMaterial): void;
  66033. protected _buildBlock(state: NodeMaterialBuildState): this;
  66034. }
  66035. }
  66036. declare module "babylonjs/Materials/Node/Blocks/Dual/index" {
  66037. export * from "babylonjs/Materials/Node/Blocks/Dual/fogBlock";
  66038. export * from "babylonjs/Materials/Node/Blocks/Dual/lightBlock";
  66039. export * from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  66040. export * from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBlock";
  66041. export * from "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock";
  66042. }
  66043. declare module "babylonjs/Materials/Node/Blocks/Input/index" {
  66044. export * from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  66045. export * from "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes";
  66046. }
  66047. declare module "babylonjs/Materials/Node/Blocks/addBlock" {
  66048. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66049. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66050. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66051. /**
  66052. * Block used to add 2 vectors
  66053. */
  66054. export class AddBlock extends NodeMaterialBlock {
  66055. /**
  66056. * Creates a new AddBlock
  66057. * @param name defines the block name
  66058. */
  66059. constructor(name: string);
  66060. /**
  66061. * Gets the current class name
  66062. * @returns the class name
  66063. */
  66064. getClassName(): string;
  66065. /**
  66066. * Gets the left operand input component
  66067. */
  66068. get left(): NodeMaterialConnectionPoint;
  66069. /**
  66070. * Gets the right operand input component
  66071. */
  66072. get right(): NodeMaterialConnectionPoint;
  66073. /**
  66074. * Gets the output component
  66075. */
  66076. get output(): NodeMaterialConnectionPoint;
  66077. protected _buildBlock(state: NodeMaterialBuildState): this;
  66078. }
  66079. }
  66080. declare module "babylonjs/Materials/Node/Blocks/scaleBlock" {
  66081. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66082. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66083. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66084. /**
  66085. * Block used to scale a vector by a float
  66086. */
  66087. export class ScaleBlock extends NodeMaterialBlock {
  66088. /**
  66089. * Creates a new ScaleBlock
  66090. * @param name defines the block name
  66091. */
  66092. constructor(name: string);
  66093. /**
  66094. * Gets the current class name
  66095. * @returns the class name
  66096. */
  66097. getClassName(): string;
  66098. /**
  66099. * Gets the input component
  66100. */
  66101. get input(): NodeMaterialConnectionPoint;
  66102. /**
  66103. * Gets the factor input component
  66104. */
  66105. get factor(): NodeMaterialConnectionPoint;
  66106. /**
  66107. * Gets the output component
  66108. */
  66109. get output(): NodeMaterialConnectionPoint;
  66110. protected _buildBlock(state: NodeMaterialBuildState): this;
  66111. }
  66112. }
  66113. declare module "babylonjs/Materials/Node/Blocks/clampBlock" {
  66114. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66115. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66116. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66117. import { Scene } from "babylonjs/scene";
  66118. /**
  66119. * Block used to clamp a float
  66120. */
  66121. export class ClampBlock extends NodeMaterialBlock {
  66122. /** Gets or sets the minimum range */
  66123. minimum: number;
  66124. /** Gets or sets the maximum range */
  66125. maximum: number;
  66126. /**
  66127. * Creates a new ClampBlock
  66128. * @param name defines the block name
  66129. */
  66130. constructor(name: string);
  66131. /**
  66132. * Gets the current class name
  66133. * @returns the class name
  66134. */
  66135. getClassName(): string;
  66136. /**
  66137. * Gets the value input component
  66138. */
  66139. get value(): NodeMaterialConnectionPoint;
  66140. /**
  66141. * Gets the output component
  66142. */
  66143. get output(): NodeMaterialConnectionPoint;
  66144. protected _buildBlock(state: NodeMaterialBuildState): this;
  66145. protected _dumpPropertiesCode(): string;
  66146. serialize(): any;
  66147. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  66148. }
  66149. }
  66150. declare module "babylonjs/Materials/Node/Blocks/crossBlock" {
  66151. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66152. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66153. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66154. /**
  66155. * Block used to apply a cross product between 2 vectors
  66156. */
  66157. export class CrossBlock extends NodeMaterialBlock {
  66158. /**
  66159. * Creates a new CrossBlock
  66160. * @param name defines the block name
  66161. */
  66162. constructor(name: string);
  66163. /**
  66164. * Gets the current class name
  66165. * @returns the class name
  66166. */
  66167. getClassName(): string;
  66168. /**
  66169. * Gets the left operand input component
  66170. */
  66171. get left(): NodeMaterialConnectionPoint;
  66172. /**
  66173. * Gets the right operand input component
  66174. */
  66175. get right(): NodeMaterialConnectionPoint;
  66176. /**
  66177. * Gets the output component
  66178. */
  66179. get output(): NodeMaterialConnectionPoint;
  66180. protected _buildBlock(state: NodeMaterialBuildState): this;
  66181. }
  66182. }
  66183. declare module "babylonjs/Materials/Node/Blocks/dotBlock" {
  66184. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66185. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66186. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66187. /**
  66188. * Block used to apply a dot product between 2 vectors
  66189. */
  66190. export class DotBlock extends NodeMaterialBlock {
  66191. /**
  66192. * Creates a new DotBlock
  66193. * @param name defines the block name
  66194. */
  66195. constructor(name: string);
  66196. /**
  66197. * Gets the current class name
  66198. * @returns the class name
  66199. */
  66200. getClassName(): string;
  66201. /**
  66202. * Gets the left operand input component
  66203. */
  66204. get left(): NodeMaterialConnectionPoint;
  66205. /**
  66206. * Gets the right operand input component
  66207. */
  66208. get right(): NodeMaterialConnectionPoint;
  66209. /**
  66210. * Gets the output component
  66211. */
  66212. get output(): NodeMaterialConnectionPoint;
  66213. protected _buildBlock(state: NodeMaterialBuildState): this;
  66214. }
  66215. }
  66216. declare module "babylonjs/Materials/Node/Blocks/normalizeBlock" {
  66217. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66218. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66219. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66220. /**
  66221. * Block used to normalize a vector
  66222. */
  66223. export class NormalizeBlock extends NodeMaterialBlock {
  66224. /**
  66225. * Creates a new NormalizeBlock
  66226. * @param name defines the block name
  66227. */
  66228. constructor(name: string);
  66229. /**
  66230. * Gets the current class name
  66231. * @returns the class name
  66232. */
  66233. getClassName(): string;
  66234. /**
  66235. * Gets the input component
  66236. */
  66237. get input(): NodeMaterialConnectionPoint;
  66238. /**
  66239. * Gets the output component
  66240. */
  66241. get output(): NodeMaterialConnectionPoint;
  66242. protected _buildBlock(state: NodeMaterialBuildState): this;
  66243. }
  66244. }
  66245. declare module "babylonjs/Materials/Node/Blocks/trigonometryBlock" {
  66246. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66247. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66248. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66249. import { Scene } from "babylonjs/scene";
  66250. /**
  66251. * Operations supported by the Trigonometry block
  66252. */
  66253. export enum TrigonometryBlockOperations {
  66254. /** Cos */
  66255. Cos = 0,
  66256. /** Sin */
  66257. Sin = 1,
  66258. /** Abs */
  66259. Abs = 2,
  66260. /** Exp */
  66261. Exp = 3,
  66262. /** Exp2 */
  66263. Exp2 = 4,
  66264. /** Round */
  66265. Round = 5,
  66266. /** Floor */
  66267. Floor = 6,
  66268. /** Ceiling */
  66269. Ceiling = 7,
  66270. /** Square root */
  66271. Sqrt = 8,
  66272. /** Log */
  66273. Log = 9,
  66274. /** Tangent */
  66275. Tan = 10,
  66276. /** Arc tangent */
  66277. ArcTan = 11,
  66278. /** Arc cosinus */
  66279. ArcCos = 12,
  66280. /** Arc sinus */
  66281. ArcSin = 13,
  66282. /** Fraction */
  66283. Fract = 14,
  66284. /** Sign */
  66285. Sign = 15,
  66286. /** To radians (from degrees) */
  66287. Radians = 16,
  66288. /** To degrees (from radians) */
  66289. Degrees = 17
  66290. }
  66291. /**
  66292. * Block used to apply trigonometry operation to floats
  66293. */
  66294. export class TrigonometryBlock extends NodeMaterialBlock {
  66295. /**
  66296. * Gets or sets the operation applied by the block
  66297. */
  66298. operation: TrigonometryBlockOperations;
  66299. /**
  66300. * Creates a new TrigonometryBlock
  66301. * @param name defines the block name
  66302. */
  66303. constructor(name: string);
  66304. /**
  66305. * Gets the current class name
  66306. * @returns the class name
  66307. */
  66308. getClassName(): string;
  66309. /**
  66310. * Gets the input component
  66311. */
  66312. get input(): NodeMaterialConnectionPoint;
  66313. /**
  66314. * Gets the output component
  66315. */
  66316. get output(): NodeMaterialConnectionPoint;
  66317. protected _buildBlock(state: NodeMaterialBuildState): this;
  66318. serialize(): any;
  66319. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  66320. protected _dumpPropertiesCode(): string;
  66321. }
  66322. }
  66323. declare module "babylonjs/Materials/Node/Blocks/colorMergerBlock" {
  66324. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66325. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66326. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66327. /**
  66328. * Block used to create a Color3/4 out of individual inputs (one for each component)
  66329. */
  66330. export class ColorMergerBlock extends NodeMaterialBlock {
  66331. /**
  66332. * Create a new ColorMergerBlock
  66333. * @param name defines the block name
  66334. */
  66335. constructor(name: string);
  66336. /**
  66337. * Gets the current class name
  66338. * @returns the class name
  66339. */
  66340. getClassName(): string;
  66341. /**
  66342. * Gets the rgb component (input)
  66343. */
  66344. get rgbIn(): NodeMaterialConnectionPoint;
  66345. /**
  66346. * Gets the r component (input)
  66347. */
  66348. get r(): NodeMaterialConnectionPoint;
  66349. /**
  66350. * Gets the g component (input)
  66351. */
  66352. get g(): NodeMaterialConnectionPoint;
  66353. /**
  66354. * Gets the b component (input)
  66355. */
  66356. get b(): NodeMaterialConnectionPoint;
  66357. /**
  66358. * Gets the a component (input)
  66359. */
  66360. get a(): NodeMaterialConnectionPoint;
  66361. /**
  66362. * Gets the rgba component (output)
  66363. */
  66364. get rgba(): NodeMaterialConnectionPoint;
  66365. /**
  66366. * Gets the rgb component (output)
  66367. */
  66368. get rgbOut(): NodeMaterialConnectionPoint;
  66369. /**
  66370. * Gets the rgb component (output)
  66371. * @deprecated Please use rgbOut instead.
  66372. */
  66373. get rgb(): NodeMaterialConnectionPoint;
  66374. protected _buildBlock(state: NodeMaterialBuildState): this;
  66375. }
  66376. }
  66377. declare module "babylonjs/Materials/Node/Blocks/vectorSplitterBlock" {
  66378. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66379. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66380. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66381. /**
  66382. * Block used to expand a Vector3/4 into 4 outputs (one for each component)
  66383. */
  66384. export class VectorSplitterBlock extends NodeMaterialBlock {
  66385. /**
  66386. * Create a new VectorSplitterBlock
  66387. * @param name defines the block name
  66388. */
  66389. constructor(name: string);
  66390. /**
  66391. * Gets the current class name
  66392. * @returns the class name
  66393. */
  66394. getClassName(): string;
  66395. /**
  66396. * Gets the xyzw component (input)
  66397. */
  66398. get xyzw(): NodeMaterialConnectionPoint;
  66399. /**
  66400. * Gets the xyz component (input)
  66401. */
  66402. get xyzIn(): NodeMaterialConnectionPoint;
  66403. /**
  66404. * Gets the xy component (input)
  66405. */
  66406. get xyIn(): NodeMaterialConnectionPoint;
  66407. /**
  66408. * Gets the xyz component (output)
  66409. */
  66410. get xyzOut(): NodeMaterialConnectionPoint;
  66411. /**
  66412. * Gets the xy component (output)
  66413. */
  66414. get xyOut(): NodeMaterialConnectionPoint;
  66415. /**
  66416. * Gets the x component (output)
  66417. */
  66418. get x(): NodeMaterialConnectionPoint;
  66419. /**
  66420. * Gets the y component (output)
  66421. */
  66422. get y(): NodeMaterialConnectionPoint;
  66423. /**
  66424. * Gets the z component (output)
  66425. */
  66426. get z(): NodeMaterialConnectionPoint;
  66427. /**
  66428. * Gets the w component (output)
  66429. */
  66430. get w(): NodeMaterialConnectionPoint;
  66431. protected _inputRename(name: string): string;
  66432. protected _outputRename(name: string): string;
  66433. protected _buildBlock(state: NodeMaterialBuildState): this;
  66434. }
  66435. }
  66436. declare module "babylonjs/Materials/Node/Blocks/lerpBlock" {
  66437. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66438. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66439. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66440. /**
  66441. * Block used to lerp between 2 values
  66442. */
  66443. export class LerpBlock extends NodeMaterialBlock {
  66444. /**
  66445. * Creates a new LerpBlock
  66446. * @param name defines the block name
  66447. */
  66448. constructor(name: string);
  66449. /**
  66450. * Gets the current class name
  66451. * @returns the class name
  66452. */
  66453. getClassName(): string;
  66454. /**
  66455. * Gets the left operand input component
  66456. */
  66457. get left(): NodeMaterialConnectionPoint;
  66458. /**
  66459. * Gets the right operand input component
  66460. */
  66461. get right(): NodeMaterialConnectionPoint;
  66462. /**
  66463. * Gets the gradient operand input component
  66464. */
  66465. get gradient(): NodeMaterialConnectionPoint;
  66466. /**
  66467. * Gets the output component
  66468. */
  66469. get output(): NodeMaterialConnectionPoint;
  66470. protected _buildBlock(state: NodeMaterialBuildState): this;
  66471. }
  66472. }
  66473. declare module "babylonjs/Materials/Node/Blocks/divideBlock" {
  66474. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66475. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66476. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66477. /**
  66478. * Block used to divide 2 vectors
  66479. */
  66480. export class DivideBlock extends NodeMaterialBlock {
  66481. /**
  66482. * Creates a new DivideBlock
  66483. * @param name defines the block name
  66484. */
  66485. constructor(name: string);
  66486. /**
  66487. * Gets the current class name
  66488. * @returns the class name
  66489. */
  66490. getClassName(): string;
  66491. /**
  66492. * Gets the left operand input component
  66493. */
  66494. get left(): NodeMaterialConnectionPoint;
  66495. /**
  66496. * Gets the right operand input component
  66497. */
  66498. get right(): NodeMaterialConnectionPoint;
  66499. /**
  66500. * Gets the output component
  66501. */
  66502. get output(): NodeMaterialConnectionPoint;
  66503. protected _buildBlock(state: NodeMaterialBuildState): this;
  66504. }
  66505. }
  66506. declare module "babylonjs/Materials/Node/Blocks/subtractBlock" {
  66507. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66508. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66509. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66510. /**
  66511. * Block used to subtract 2 vectors
  66512. */
  66513. export class SubtractBlock extends NodeMaterialBlock {
  66514. /**
  66515. * Creates a new SubtractBlock
  66516. * @param name defines the block name
  66517. */
  66518. constructor(name: string);
  66519. /**
  66520. * Gets the current class name
  66521. * @returns the class name
  66522. */
  66523. getClassName(): string;
  66524. /**
  66525. * Gets the left operand input component
  66526. */
  66527. get left(): NodeMaterialConnectionPoint;
  66528. /**
  66529. * Gets the right operand input component
  66530. */
  66531. get right(): NodeMaterialConnectionPoint;
  66532. /**
  66533. * Gets the output component
  66534. */
  66535. get output(): NodeMaterialConnectionPoint;
  66536. protected _buildBlock(state: NodeMaterialBuildState): this;
  66537. }
  66538. }
  66539. declare module "babylonjs/Materials/Node/Blocks/stepBlock" {
  66540. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66541. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66542. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66543. /**
  66544. * Block used to step a value
  66545. */
  66546. export class StepBlock extends NodeMaterialBlock {
  66547. /**
  66548. * Creates a new StepBlock
  66549. * @param name defines the block name
  66550. */
  66551. constructor(name: string);
  66552. /**
  66553. * Gets the current class name
  66554. * @returns the class name
  66555. */
  66556. getClassName(): string;
  66557. /**
  66558. * Gets the value operand input component
  66559. */
  66560. get value(): NodeMaterialConnectionPoint;
  66561. /**
  66562. * Gets the edge operand input component
  66563. */
  66564. get edge(): NodeMaterialConnectionPoint;
  66565. /**
  66566. * Gets the output component
  66567. */
  66568. get output(): NodeMaterialConnectionPoint;
  66569. protected _buildBlock(state: NodeMaterialBuildState): this;
  66570. }
  66571. }
  66572. declare module "babylonjs/Materials/Node/Blocks/oneMinusBlock" {
  66573. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66574. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66575. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66576. /**
  66577. * Block used to get the opposite (1 - x) of a value
  66578. */
  66579. export class OneMinusBlock extends NodeMaterialBlock {
  66580. /**
  66581. * Creates a new OneMinusBlock
  66582. * @param name defines the block name
  66583. */
  66584. constructor(name: string);
  66585. /**
  66586. * Gets the current class name
  66587. * @returns the class name
  66588. */
  66589. getClassName(): string;
  66590. /**
  66591. * Gets the input component
  66592. */
  66593. get input(): NodeMaterialConnectionPoint;
  66594. /**
  66595. * Gets the output component
  66596. */
  66597. get output(): NodeMaterialConnectionPoint;
  66598. protected _buildBlock(state: NodeMaterialBuildState): this;
  66599. }
  66600. }
  66601. declare module "babylonjs/Materials/Node/Blocks/viewDirectionBlock" {
  66602. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66603. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66604. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66605. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  66606. /**
  66607. * Block used to get the view direction
  66608. */
  66609. export class ViewDirectionBlock extends NodeMaterialBlock {
  66610. /**
  66611. * Creates a new ViewDirectionBlock
  66612. * @param name defines the block name
  66613. */
  66614. constructor(name: string);
  66615. /**
  66616. * Gets the current class name
  66617. * @returns the class name
  66618. */
  66619. getClassName(): string;
  66620. /**
  66621. * Gets the world position component
  66622. */
  66623. get worldPosition(): NodeMaterialConnectionPoint;
  66624. /**
  66625. * Gets the camera position component
  66626. */
  66627. get cameraPosition(): NodeMaterialConnectionPoint;
  66628. /**
  66629. * Gets the output component
  66630. */
  66631. get output(): NodeMaterialConnectionPoint;
  66632. autoConfigure(material: NodeMaterial): void;
  66633. protected _buildBlock(state: NodeMaterialBuildState): this;
  66634. }
  66635. }
  66636. declare module "babylonjs/Materials/Node/Blocks/fresnelBlock" {
  66637. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66638. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66639. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66640. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  66641. import "babylonjs/Shaders/ShadersInclude/fresnelFunction";
  66642. /**
  66643. * Block used to compute fresnel value
  66644. */
  66645. export class FresnelBlock extends NodeMaterialBlock {
  66646. /**
  66647. * Create a new FresnelBlock
  66648. * @param name defines the block name
  66649. */
  66650. constructor(name: string);
  66651. /**
  66652. * Gets the current class name
  66653. * @returns the class name
  66654. */
  66655. getClassName(): string;
  66656. /**
  66657. * Gets the world normal input component
  66658. */
  66659. get worldNormal(): NodeMaterialConnectionPoint;
  66660. /**
  66661. * Gets the view direction input component
  66662. */
  66663. get viewDirection(): NodeMaterialConnectionPoint;
  66664. /**
  66665. * Gets the bias input component
  66666. */
  66667. get bias(): NodeMaterialConnectionPoint;
  66668. /**
  66669. * Gets the camera (or eye) position component
  66670. */
  66671. get power(): NodeMaterialConnectionPoint;
  66672. /**
  66673. * Gets the fresnel output component
  66674. */
  66675. get fresnel(): NodeMaterialConnectionPoint;
  66676. autoConfigure(material: NodeMaterial): void;
  66677. protected _buildBlock(state: NodeMaterialBuildState): this;
  66678. }
  66679. }
  66680. declare module "babylonjs/Materials/Node/Blocks/maxBlock" {
  66681. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66682. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66683. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66684. /**
  66685. * Block used to get the max of 2 values
  66686. */
  66687. export class MaxBlock extends NodeMaterialBlock {
  66688. /**
  66689. * Creates a new MaxBlock
  66690. * @param name defines the block name
  66691. */
  66692. constructor(name: string);
  66693. /**
  66694. * Gets the current class name
  66695. * @returns the class name
  66696. */
  66697. getClassName(): string;
  66698. /**
  66699. * Gets the left operand input component
  66700. */
  66701. get left(): NodeMaterialConnectionPoint;
  66702. /**
  66703. * Gets the right operand input component
  66704. */
  66705. get right(): NodeMaterialConnectionPoint;
  66706. /**
  66707. * Gets the output component
  66708. */
  66709. get output(): NodeMaterialConnectionPoint;
  66710. protected _buildBlock(state: NodeMaterialBuildState): this;
  66711. }
  66712. }
  66713. declare module "babylonjs/Materials/Node/Blocks/minBlock" {
  66714. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66715. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66716. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66717. /**
  66718. * Block used to get the min of 2 values
  66719. */
  66720. export class MinBlock extends NodeMaterialBlock {
  66721. /**
  66722. * Creates a new MinBlock
  66723. * @param name defines the block name
  66724. */
  66725. constructor(name: string);
  66726. /**
  66727. * Gets the current class name
  66728. * @returns the class name
  66729. */
  66730. getClassName(): string;
  66731. /**
  66732. * Gets the left operand input component
  66733. */
  66734. get left(): NodeMaterialConnectionPoint;
  66735. /**
  66736. * Gets the right operand input component
  66737. */
  66738. get right(): NodeMaterialConnectionPoint;
  66739. /**
  66740. * Gets the output component
  66741. */
  66742. get output(): NodeMaterialConnectionPoint;
  66743. protected _buildBlock(state: NodeMaterialBuildState): this;
  66744. }
  66745. }
  66746. declare module "babylonjs/Materials/Node/Blocks/distanceBlock" {
  66747. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66748. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66749. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66750. /**
  66751. * Block used to get the distance between 2 values
  66752. */
  66753. export class DistanceBlock extends NodeMaterialBlock {
  66754. /**
  66755. * Creates a new DistanceBlock
  66756. * @param name defines the block name
  66757. */
  66758. constructor(name: string);
  66759. /**
  66760. * Gets the current class name
  66761. * @returns the class name
  66762. */
  66763. getClassName(): string;
  66764. /**
  66765. * Gets the left operand input component
  66766. */
  66767. get left(): NodeMaterialConnectionPoint;
  66768. /**
  66769. * Gets the right operand input component
  66770. */
  66771. get right(): NodeMaterialConnectionPoint;
  66772. /**
  66773. * Gets the output component
  66774. */
  66775. get output(): NodeMaterialConnectionPoint;
  66776. protected _buildBlock(state: NodeMaterialBuildState): this;
  66777. }
  66778. }
  66779. declare module "babylonjs/Materials/Node/Blocks/lengthBlock" {
  66780. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66781. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66782. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66783. /**
  66784. * Block used to get the length of a vector
  66785. */
  66786. export class LengthBlock extends NodeMaterialBlock {
  66787. /**
  66788. * Creates a new LengthBlock
  66789. * @param name defines the block name
  66790. */
  66791. constructor(name: string);
  66792. /**
  66793. * Gets the current class name
  66794. * @returns the class name
  66795. */
  66796. getClassName(): string;
  66797. /**
  66798. * Gets the value input component
  66799. */
  66800. get value(): NodeMaterialConnectionPoint;
  66801. /**
  66802. * Gets the output component
  66803. */
  66804. get output(): NodeMaterialConnectionPoint;
  66805. protected _buildBlock(state: NodeMaterialBuildState): this;
  66806. }
  66807. }
  66808. declare module "babylonjs/Materials/Node/Blocks/negateBlock" {
  66809. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66810. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66811. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66812. /**
  66813. * Block used to get negative version of a value (i.e. x * -1)
  66814. */
  66815. export class NegateBlock extends NodeMaterialBlock {
  66816. /**
  66817. * Creates a new NegateBlock
  66818. * @param name defines the block name
  66819. */
  66820. constructor(name: string);
  66821. /**
  66822. * Gets the current class name
  66823. * @returns the class name
  66824. */
  66825. getClassName(): string;
  66826. /**
  66827. * Gets the value input component
  66828. */
  66829. get value(): NodeMaterialConnectionPoint;
  66830. /**
  66831. * Gets the output component
  66832. */
  66833. get output(): NodeMaterialConnectionPoint;
  66834. protected _buildBlock(state: NodeMaterialBuildState): this;
  66835. }
  66836. }
  66837. declare module "babylonjs/Materials/Node/Blocks/powBlock" {
  66838. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66839. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66840. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66841. /**
  66842. * Block used to get the value of the first parameter raised to the power of the second
  66843. */
  66844. export class PowBlock extends NodeMaterialBlock {
  66845. /**
  66846. * Creates a new PowBlock
  66847. * @param name defines the block name
  66848. */
  66849. constructor(name: string);
  66850. /**
  66851. * Gets the current class name
  66852. * @returns the class name
  66853. */
  66854. getClassName(): string;
  66855. /**
  66856. * Gets the value operand input component
  66857. */
  66858. get value(): NodeMaterialConnectionPoint;
  66859. /**
  66860. * Gets the power operand input component
  66861. */
  66862. get power(): NodeMaterialConnectionPoint;
  66863. /**
  66864. * Gets the output component
  66865. */
  66866. get output(): NodeMaterialConnectionPoint;
  66867. protected _buildBlock(state: NodeMaterialBuildState): this;
  66868. }
  66869. }
  66870. declare module "babylonjs/Materials/Node/Blocks/randomNumberBlock" {
  66871. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66872. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66873. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66874. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  66875. /**
  66876. * Block used to get a random number
  66877. */
  66878. export class RandomNumberBlock extends NodeMaterialBlock {
  66879. /**
  66880. * Creates a new RandomNumberBlock
  66881. * @param name defines the block name
  66882. */
  66883. constructor(name: string);
  66884. /**
  66885. * Gets the current class name
  66886. * @returns the class name
  66887. */
  66888. getClassName(): string;
  66889. /**
  66890. * Gets the seed input component
  66891. */
  66892. get seed(): NodeMaterialConnectionPoint;
  66893. /**
  66894. * Gets the output component
  66895. */
  66896. get output(): NodeMaterialConnectionPoint;
  66897. protected _buildBlock(state: NodeMaterialBuildState): this;
  66898. }
  66899. }
  66900. declare module "babylonjs/Materials/Node/Blocks/arcTan2Block" {
  66901. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66902. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66903. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66904. /**
  66905. * Block used to compute arc tangent of 2 values
  66906. */
  66907. export class ArcTan2Block extends NodeMaterialBlock {
  66908. /**
  66909. * Creates a new ArcTan2Block
  66910. * @param name defines the block name
  66911. */
  66912. constructor(name: string);
  66913. /**
  66914. * Gets the current class name
  66915. * @returns the class name
  66916. */
  66917. getClassName(): string;
  66918. /**
  66919. * Gets the x operand input component
  66920. */
  66921. get x(): NodeMaterialConnectionPoint;
  66922. /**
  66923. * Gets the y operand input component
  66924. */
  66925. get y(): NodeMaterialConnectionPoint;
  66926. /**
  66927. * Gets the output component
  66928. */
  66929. get output(): NodeMaterialConnectionPoint;
  66930. protected _buildBlock(state: NodeMaterialBuildState): this;
  66931. }
  66932. }
  66933. declare module "babylonjs/Materials/Node/Blocks/smoothStepBlock" {
  66934. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66935. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66936. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66937. /**
  66938. * Block used to smooth step a value
  66939. */
  66940. export class SmoothStepBlock extends NodeMaterialBlock {
  66941. /**
  66942. * Creates a new SmoothStepBlock
  66943. * @param name defines the block name
  66944. */
  66945. constructor(name: string);
  66946. /**
  66947. * Gets the current class name
  66948. * @returns the class name
  66949. */
  66950. getClassName(): string;
  66951. /**
  66952. * Gets the value operand input component
  66953. */
  66954. get value(): NodeMaterialConnectionPoint;
  66955. /**
  66956. * Gets the first edge operand input component
  66957. */
  66958. get edge0(): NodeMaterialConnectionPoint;
  66959. /**
  66960. * Gets the second edge operand input component
  66961. */
  66962. get edge1(): NodeMaterialConnectionPoint;
  66963. /**
  66964. * Gets the output component
  66965. */
  66966. get output(): NodeMaterialConnectionPoint;
  66967. protected _buildBlock(state: NodeMaterialBuildState): this;
  66968. }
  66969. }
  66970. declare module "babylonjs/Materials/Node/Blocks/reciprocalBlock" {
  66971. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66972. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66973. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66974. /**
  66975. * Block used to get the reciprocal (1 / x) of a value
  66976. */
  66977. export class ReciprocalBlock extends NodeMaterialBlock {
  66978. /**
  66979. * Creates a new ReciprocalBlock
  66980. * @param name defines the block name
  66981. */
  66982. constructor(name: string);
  66983. /**
  66984. * Gets the current class name
  66985. * @returns the class name
  66986. */
  66987. getClassName(): string;
  66988. /**
  66989. * Gets the input component
  66990. */
  66991. get input(): NodeMaterialConnectionPoint;
  66992. /**
  66993. * Gets the output component
  66994. */
  66995. get output(): NodeMaterialConnectionPoint;
  66996. protected _buildBlock(state: NodeMaterialBuildState): this;
  66997. }
  66998. }
  66999. declare module "babylonjs/Materials/Node/Blocks/replaceColorBlock" {
  67000. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67001. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67002. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67003. /**
  67004. * Block used to replace a color by another one
  67005. */
  67006. export class ReplaceColorBlock extends NodeMaterialBlock {
  67007. /**
  67008. * Creates a new ReplaceColorBlock
  67009. * @param name defines the block name
  67010. */
  67011. constructor(name: string);
  67012. /**
  67013. * Gets the current class name
  67014. * @returns the class name
  67015. */
  67016. getClassName(): string;
  67017. /**
  67018. * Gets the value input component
  67019. */
  67020. get value(): NodeMaterialConnectionPoint;
  67021. /**
  67022. * Gets the reference input component
  67023. */
  67024. get reference(): NodeMaterialConnectionPoint;
  67025. /**
  67026. * Gets the distance input component
  67027. */
  67028. get distance(): NodeMaterialConnectionPoint;
  67029. /**
  67030. * Gets the replacement input component
  67031. */
  67032. get replacement(): NodeMaterialConnectionPoint;
  67033. /**
  67034. * Gets the output component
  67035. */
  67036. get output(): NodeMaterialConnectionPoint;
  67037. protected _buildBlock(state: NodeMaterialBuildState): this;
  67038. }
  67039. }
  67040. declare module "babylonjs/Materials/Node/Blocks/posterizeBlock" {
  67041. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67042. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67043. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67044. /**
  67045. * Block used to posterize a value
  67046. * @see https://en.wikipedia.org/wiki/Posterization
  67047. */
  67048. export class PosterizeBlock extends NodeMaterialBlock {
  67049. /**
  67050. * Creates a new PosterizeBlock
  67051. * @param name defines the block name
  67052. */
  67053. constructor(name: string);
  67054. /**
  67055. * Gets the current class name
  67056. * @returns the class name
  67057. */
  67058. getClassName(): string;
  67059. /**
  67060. * Gets the value input component
  67061. */
  67062. get value(): NodeMaterialConnectionPoint;
  67063. /**
  67064. * Gets the steps input component
  67065. */
  67066. get steps(): NodeMaterialConnectionPoint;
  67067. /**
  67068. * Gets the output component
  67069. */
  67070. get output(): NodeMaterialConnectionPoint;
  67071. protected _buildBlock(state: NodeMaterialBuildState): this;
  67072. }
  67073. }
  67074. declare module "babylonjs/Materials/Node/Blocks/waveBlock" {
  67075. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67076. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67077. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67078. import { Scene } from "babylonjs/scene";
  67079. /**
  67080. * Operations supported by the Wave block
  67081. */
  67082. export enum WaveBlockKind {
  67083. /** SawTooth */
  67084. SawTooth = 0,
  67085. /** Square */
  67086. Square = 1,
  67087. /** Triangle */
  67088. Triangle = 2
  67089. }
  67090. /**
  67091. * Block used to apply wave operation to floats
  67092. */
  67093. export class WaveBlock extends NodeMaterialBlock {
  67094. /**
  67095. * Gets or sets the kibnd of wave to be applied by the block
  67096. */
  67097. kind: WaveBlockKind;
  67098. /**
  67099. * Creates a new WaveBlock
  67100. * @param name defines the block name
  67101. */
  67102. constructor(name: string);
  67103. /**
  67104. * Gets the current class name
  67105. * @returns the class name
  67106. */
  67107. getClassName(): string;
  67108. /**
  67109. * Gets the input component
  67110. */
  67111. get input(): NodeMaterialConnectionPoint;
  67112. /**
  67113. * Gets the output component
  67114. */
  67115. get output(): NodeMaterialConnectionPoint;
  67116. protected _buildBlock(state: NodeMaterialBuildState): this;
  67117. serialize(): any;
  67118. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67119. }
  67120. }
  67121. declare module "babylonjs/Materials/Node/Blocks/gradientBlock" {
  67122. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67123. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67124. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67125. import { Color3 } from "babylonjs/Maths/math.color";
  67126. import { Scene } from "babylonjs/scene";
  67127. /**
  67128. * Class used to store a color step for the GradientBlock
  67129. */
  67130. export class GradientBlockColorStep {
  67131. /**
  67132. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  67133. */
  67134. step: number;
  67135. /**
  67136. * Gets or sets the color associated with this step
  67137. */
  67138. color: Color3;
  67139. /**
  67140. * Creates a new GradientBlockColorStep
  67141. * @param step defines a value indicating which step this color is associated with (between 0 and 1)
  67142. * @param color defines the color associated with this step
  67143. */
  67144. constructor(
  67145. /**
  67146. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  67147. */
  67148. step: number,
  67149. /**
  67150. * Gets or sets the color associated with this step
  67151. */
  67152. color: Color3);
  67153. }
  67154. /**
  67155. * Block used to return a color from a gradient based on an input value between 0 and 1
  67156. */
  67157. export class GradientBlock extends NodeMaterialBlock {
  67158. /**
  67159. * Gets or sets the list of color steps
  67160. */
  67161. colorSteps: GradientBlockColorStep[];
  67162. /**
  67163. * Creates a new GradientBlock
  67164. * @param name defines the block name
  67165. */
  67166. constructor(name: string);
  67167. /**
  67168. * Gets the current class name
  67169. * @returns the class name
  67170. */
  67171. getClassName(): string;
  67172. /**
  67173. * Gets the gradient input component
  67174. */
  67175. get gradient(): NodeMaterialConnectionPoint;
  67176. /**
  67177. * Gets the output component
  67178. */
  67179. get output(): NodeMaterialConnectionPoint;
  67180. private _writeColorConstant;
  67181. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  67182. serialize(): any;
  67183. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67184. protected _dumpPropertiesCode(): string;
  67185. }
  67186. }
  67187. declare module "babylonjs/Materials/Node/Blocks/nLerpBlock" {
  67188. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67189. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67190. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67191. /**
  67192. * Block used to normalize lerp between 2 values
  67193. */
  67194. export class NLerpBlock extends NodeMaterialBlock {
  67195. /**
  67196. * Creates a new NLerpBlock
  67197. * @param name defines the block name
  67198. */
  67199. constructor(name: string);
  67200. /**
  67201. * Gets the current class name
  67202. * @returns the class name
  67203. */
  67204. getClassName(): string;
  67205. /**
  67206. * Gets the left operand input component
  67207. */
  67208. get left(): NodeMaterialConnectionPoint;
  67209. /**
  67210. * Gets the right operand input component
  67211. */
  67212. get right(): NodeMaterialConnectionPoint;
  67213. /**
  67214. * Gets the gradient operand input component
  67215. */
  67216. get gradient(): NodeMaterialConnectionPoint;
  67217. /**
  67218. * Gets the output component
  67219. */
  67220. get output(): NodeMaterialConnectionPoint;
  67221. protected _buildBlock(state: NodeMaterialBuildState): this;
  67222. }
  67223. }
  67224. declare module "babylonjs/Materials/Node/Blocks/worleyNoise3DBlock" {
  67225. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67226. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67227. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67228. import { Scene } from "babylonjs/scene";
  67229. /**
  67230. * block used to Generate a Worley Noise 3D Noise Pattern
  67231. */
  67232. export class WorleyNoise3DBlock extends NodeMaterialBlock {
  67233. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  67234. manhattanDistance: boolean;
  67235. /**
  67236. * Creates a new WorleyNoise3DBlock
  67237. * @param name defines the block name
  67238. */
  67239. constructor(name: string);
  67240. /**
  67241. * Gets the current class name
  67242. * @returns the class name
  67243. */
  67244. getClassName(): string;
  67245. /**
  67246. * Gets the seed input component
  67247. */
  67248. get seed(): NodeMaterialConnectionPoint;
  67249. /**
  67250. * Gets the jitter input component
  67251. */
  67252. get jitter(): NodeMaterialConnectionPoint;
  67253. /**
  67254. * Gets the output component
  67255. */
  67256. get output(): NodeMaterialConnectionPoint;
  67257. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  67258. /**
  67259. * Exposes the properties to the UI?
  67260. */
  67261. protected _dumpPropertiesCode(): string;
  67262. /**
  67263. * Exposes the properties to the Seralize?
  67264. */
  67265. serialize(): any;
  67266. /**
  67267. * Exposes the properties to the deseralize?
  67268. */
  67269. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67270. }
  67271. }
  67272. declare module "babylonjs/Materials/Node/Blocks/simplexPerlin3DBlock" {
  67273. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67274. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67275. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67276. /**
  67277. * block used to Generate a Simplex Perlin 3d Noise Pattern
  67278. */
  67279. export class SimplexPerlin3DBlock extends NodeMaterialBlock {
  67280. /**
  67281. * Creates a new SimplexPerlin3DBlock
  67282. * @param name defines the block name
  67283. */
  67284. constructor(name: string);
  67285. /**
  67286. * Gets the current class name
  67287. * @returns the class name
  67288. */
  67289. getClassName(): string;
  67290. /**
  67291. * Gets the seed operand input component
  67292. */
  67293. get seed(): NodeMaterialConnectionPoint;
  67294. /**
  67295. * Gets the output component
  67296. */
  67297. get output(): NodeMaterialConnectionPoint;
  67298. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  67299. }
  67300. }
  67301. declare module "babylonjs/Materials/Node/Blocks/normalBlendBlock" {
  67302. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67303. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67304. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67305. /**
  67306. * Block used to blend normals
  67307. */
  67308. export class NormalBlendBlock extends NodeMaterialBlock {
  67309. /**
  67310. * Creates a new NormalBlendBlock
  67311. * @param name defines the block name
  67312. */
  67313. constructor(name: string);
  67314. /**
  67315. * Gets the current class name
  67316. * @returns the class name
  67317. */
  67318. getClassName(): string;
  67319. /**
  67320. * Gets the first input component
  67321. */
  67322. get normalMap0(): NodeMaterialConnectionPoint;
  67323. /**
  67324. * Gets the second input component
  67325. */
  67326. get normalMap1(): NodeMaterialConnectionPoint;
  67327. /**
  67328. * Gets the output component
  67329. */
  67330. get output(): NodeMaterialConnectionPoint;
  67331. protected _buildBlock(state: NodeMaterialBuildState): this;
  67332. }
  67333. }
  67334. declare module "babylonjs/Materials/Node/Blocks/rotate2dBlock" {
  67335. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67336. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67337. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67338. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  67339. /**
  67340. * Block used to rotate a 2d vector by a given angle
  67341. */
  67342. export class Rotate2dBlock extends NodeMaterialBlock {
  67343. /**
  67344. * Creates a new Rotate2dBlock
  67345. * @param name defines the block name
  67346. */
  67347. constructor(name: string);
  67348. /**
  67349. * Gets the current class name
  67350. * @returns the class name
  67351. */
  67352. getClassName(): string;
  67353. /**
  67354. * Gets the input vector
  67355. */
  67356. get input(): NodeMaterialConnectionPoint;
  67357. /**
  67358. * Gets the input angle
  67359. */
  67360. get angle(): NodeMaterialConnectionPoint;
  67361. /**
  67362. * Gets the output component
  67363. */
  67364. get output(): NodeMaterialConnectionPoint;
  67365. autoConfigure(material: NodeMaterial): void;
  67366. protected _buildBlock(state: NodeMaterialBuildState): this;
  67367. }
  67368. }
  67369. declare module "babylonjs/Materials/Node/Blocks/reflectBlock" {
  67370. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67371. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67372. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67373. /**
  67374. * Block used to get the reflected vector from a direction and a normal
  67375. */
  67376. export class ReflectBlock extends NodeMaterialBlock {
  67377. /**
  67378. * Creates a new ReflectBlock
  67379. * @param name defines the block name
  67380. */
  67381. constructor(name: string);
  67382. /**
  67383. * Gets the current class name
  67384. * @returns the class name
  67385. */
  67386. getClassName(): string;
  67387. /**
  67388. * Gets the incident component
  67389. */
  67390. get incident(): NodeMaterialConnectionPoint;
  67391. /**
  67392. * Gets the normal component
  67393. */
  67394. get normal(): NodeMaterialConnectionPoint;
  67395. /**
  67396. * Gets the output component
  67397. */
  67398. get output(): NodeMaterialConnectionPoint;
  67399. protected _buildBlock(state: NodeMaterialBuildState): this;
  67400. }
  67401. }
  67402. declare module "babylonjs/Materials/Node/Blocks/refractBlock" {
  67403. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67404. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67405. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67406. /**
  67407. * Block used to get the refracted vector from a direction and a normal
  67408. */
  67409. export class RefractBlock extends NodeMaterialBlock {
  67410. /**
  67411. * Creates a new RefractBlock
  67412. * @param name defines the block name
  67413. */
  67414. constructor(name: string);
  67415. /**
  67416. * Gets the current class name
  67417. * @returns the class name
  67418. */
  67419. getClassName(): string;
  67420. /**
  67421. * Gets the incident component
  67422. */
  67423. get incident(): NodeMaterialConnectionPoint;
  67424. /**
  67425. * Gets the normal component
  67426. */
  67427. get normal(): NodeMaterialConnectionPoint;
  67428. /**
  67429. * Gets the index of refraction component
  67430. */
  67431. get ior(): NodeMaterialConnectionPoint;
  67432. /**
  67433. * Gets the output component
  67434. */
  67435. get output(): NodeMaterialConnectionPoint;
  67436. protected _buildBlock(state: NodeMaterialBuildState): this;
  67437. }
  67438. }
  67439. declare module "babylonjs/Materials/Node/Blocks/desaturateBlock" {
  67440. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67441. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67442. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67443. /**
  67444. * Block used to desaturate a color
  67445. */
  67446. export class DesaturateBlock extends NodeMaterialBlock {
  67447. /**
  67448. * Creates a new DesaturateBlock
  67449. * @param name defines the block name
  67450. */
  67451. constructor(name: string);
  67452. /**
  67453. * Gets the current class name
  67454. * @returns the class name
  67455. */
  67456. getClassName(): string;
  67457. /**
  67458. * Gets the color operand input component
  67459. */
  67460. get color(): NodeMaterialConnectionPoint;
  67461. /**
  67462. * Gets the level operand input component
  67463. */
  67464. get level(): NodeMaterialConnectionPoint;
  67465. /**
  67466. * Gets the output component
  67467. */
  67468. get output(): NodeMaterialConnectionPoint;
  67469. protected _buildBlock(state: NodeMaterialBuildState): this;
  67470. }
  67471. }
  67472. declare module "babylonjs/Materials/Node/Blocks/PBR/ambientOcclusionBlock" {
  67473. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67474. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67475. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67476. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67477. import { Nullable } from "babylonjs/types";
  67478. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67479. import { Scene } from "babylonjs/scene";
  67480. /**
  67481. * Block used to implement the ambient occlusion module of the PBR material
  67482. */
  67483. export class AmbientOcclusionBlock extends NodeMaterialBlock {
  67484. /**
  67485. * Create a new AmbientOcclusionBlock
  67486. * @param name defines the block name
  67487. */
  67488. constructor(name: string);
  67489. /**
  67490. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  67491. */
  67492. useAmbientInGrayScale: boolean;
  67493. /**
  67494. * Initialize the block and prepare the context for build
  67495. * @param state defines the state that will be used for the build
  67496. */
  67497. initialize(state: NodeMaterialBuildState): void;
  67498. /**
  67499. * Gets the current class name
  67500. * @returns the class name
  67501. */
  67502. getClassName(): string;
  67503. /**
  67504. * Gets the texture input component
  67505. */
  67506. get texture(): NodeMaterialConnectionPoint;
  67507. /**
  67508. * Gets the texture intensity component
  67509. */
  67510. get intensity(): NodeMaterialConnectionPoint;
  67511. /**
  67512. * Gets the direct light intensity input component
  67513. */
  67514. get directLightIntensity(): NodeMaterialConnectionPoint;
  67515. /**
  67516. * Gets the ambient occlusion object output component
  67517. */
  67518. get ambientOcclusion(): NodeMaterialConnectionPoint;
  67519. /**
  67520. * Gets the main code of the block (fragment side)
  67521. * @param block instance of an AmbientOcclusionBlock or null if the code must be generated without an active ambient occlusion module
  67522. * @returns the shader code
  67523. */
  67524. static GetCode(block: Nullable<AmbientOcclusionBlock>): string;
  67525. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67526. protected _buildBlock(state: NodeMaterialBuildState): this;
  67527. protected _dumpPropertiesCode(): string;
  67528. serialize(): any;
  67529. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67530. }
  67531. }
  67532. declare module "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock" {
  67533. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67534. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67535. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67536. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  67537. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67538. import { Nullable } from "babylonjs/types";
  67539. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  67540. import { Mesh } from "babylonjs/Meshes/mesh";
  67541. import { SubMesh } from "babylonjs/Meshes/subMesh";
  67542. import { Effect } from "babylonjs/Materials/effect";
  67543. import { Scene } from "babylonjs/scene";
  67544. /**
  67545. * Block used to implement the reflection module of the PBR material
  67546. */
  67547. export class ReflectionBlock extends ReflectionTextureBaseBlock {
  67548. /** @hidden */
  67549. _defineLODReflectionAlpha: string;
  67550. /** @hidden */
  67551. _defineLinearSpecularReflection: string;
  67552. private _vEnvironmentIrradianceName;
  67553. /** @hidden */
  67554. _vReflectionMicrosurfaceInfosName: string;
  67555. /** @hidden */
  67556. _vReflectionInfosName: string;
  67557. /** @hidden */
  67558. _vReflectionFilteringInfoName: string;
  67559. private _scene;
  67560. /**
  67561. * The three properties below are set by the main PBR block prior to calling methods of this class.
  67562. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  67563. * It's less burden on the user side in the editor part.
  67564. */
  67565. /** @hidden */
  67566. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  67567. /** @hidden */
  67568. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  67569. /** @hidden */
  67570. cameraPositionConnectionPoint: NodeMaterialConnectionPoint;
  67571. /**
  67572. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  67573. * diffuse part of the IBL.
  67574. */
  67575. useSphericalHarmonics: boolean;
  67576. /**
  67577. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  67578. */
  67579. forceIrradianceInFragment: boolean;
  67580. /**
  67581. * Create a new ReflectionBlock
  67582. * @param name defines the block name
  67583. */
  67584. constructor(name: string);
  67585. /**
  67586. * Gets the current class name
  67587. * @returns the class name
  67588. */
  67589. getClassName(): string;
  67590. /**
  67591. * Gets the position input component
  67592. */
  67593. get position(): NodeMaterialConnectionPoint;
  67594. /**
  67595. * Gets the world position input component
  67596. */
  67597. get worldPosition(): NodeMaterialConnectionPoint;
  67598. /**
  67599. * Gets the world normal input component
  67600. */
  67601. get worldNormal(): NodeMaterialConnectionPoint;
  67602. /**
  67603. * Gets the world input component
  67604. */
  67605. get world(): NodeMaterialConnectionPoint;
  67606. /**
  67607. * Gets the camera (or eye) position component
  67608. */
  67609. get cameraPosition(): NodeMaterialConnectionPoint;
  67610. /**
  67611. * Gets the view input component
  67612. */
  67613. get view(): NodeMaterialConnectionPoint;
  67614. /**
  67615. * Gets the color input component
  67616. */
  67617. get color(): NodeMaterialConnectionPoint;
  67618. /**
  67619. * Gets the reflection object output component
  67620. */
  67621. get reflection(): NodeMaterialConnectionPoint;
  67622. /**
  67623. * Returns true if the block has a texture (either its own texture or the environment texture from the scene, if set)
  67624. */
  67625. get hasTexture(): boolean;
  67626. /**
  67627. * Gets the reflection color (either the name of the variable if the color input is connected, else a default value)
  67628. */
  67629. get reflectionColor(): string;
  67630. protected _getTexture(): Nullable<BaseTexture>;
  67631. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67632. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  67633. /**
  67634. * Gets the code to inject in the vertex shader
  67635. * @param state current state of the node material building
  67636. * @returns the shader code
  67637. */
  67638. handleVertexSide(state: NodeMaterialBuildState): string;
  67639. /**
  67640. * Gets the main code of the block (fragment side)
  67641. * @param state current state of the node material building
  67642. * @param normalVarName name of the existing variable corresponding to the normal
  67643. * @returns the shader code
  67644. */
  67645. getCode(state: NodeMaterialBuildState, normalVarName: string): string;
  67646. protected _buildBlock(state: NodeMaterialBuildState): this;
  67647. protected _dumpPropertiesCode(): string;
  67648. serialize(): any;
  67649. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67650. }
  67651. }
  67652. declare module "babylonjs/Materials/Node/Blocks/PBR/sheenBlock" {
  67653. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67654. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67655. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67656. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67657. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67658. import { ReflectionBlock } from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  67659. import { Scene } from "babylonjs/scene";
  67660. import { Nullable } from "babylonjs/types";
  67661. /**
  67662. * Block used to implement the sheen module of the PBR material
  67663. */
  67664. export class SheenBlock extends NodeMaterialBlock {
  67665. /**
  67666. * Create a new SheenBlock
  67667. * @param name defines the block name
  67668. */
  67669. constructor(name: string);
  67670. /**
  67671. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  67672. * It allows the strength of the sheen effect to not depend on the base color of the material,
  67673. * making it easier to setup and tweak the effect
  67674. */
  67675. albedoScaling: boolean;
  67676. /**
  67677. * Defines if the sheen is linked to the sheen color.
  67678. */
  67679. linkSheenWithAlbedo: boolean;
  67680. /**
  67681. * Initialize the block and prepare the context for build
  67682. * @param state defines the state that will be used for the build
  67683. */
  67684. initialize(state: NodeMaterialBuildState): void;
  67685. /**
  67686. * Gets the current class name
  67687. * @returns the class name
  67688. */
  67689. getClassName(): string;
  67690. /**
  67691. * Gets the intensity input component
  67692. */
  67693. get intensity(): NodeMaterialConnectionPoint;
  67694. /**
  67695. * Gets the color input component
  67696. */
  67697. get color(): NodeMaterialConnectionPoint;
  67698. /**
  67699. * Gets the roughness input component
  67700. */
  67701. get roughness(): NodeMaterialConnectionPoint;
  67702. /**
  67703. * Gets the sheen object output component
  67704. */
  67705. get sheen(): NodeMaterialConnectionPoint;
  67706. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67707. /**
  67708. * Gets the main code of the block (fragment side)
  67709. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  67710. * @returns the shader code
  67711. */
  67712. getCode(reflectionBlock: Nullable<ReflectionBlock>): string;
  67713. protected _buildBlock(state: NodeMaterialBuildState): this;
  67714. protected _dumpPropertiesCode(): string;
  67715. serialize(): any;
  67716. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67717. }
  67718. }
  67719. declare module "babylonjs/Materials/Node/Blocks/PBR/reflectivityBlock" {
  67720. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67721. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67722. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67723. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67724. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67725. import { Scene } from "babylonjs/scene";
  67726. import { Nullable } from "babylonjs/types";
  67727. import { Mesh } from "babylonjs/Meshes/mesh";
  67728. import { SubMesh } from "babylonjs/Meshes/subMesh";
  67729. import { Effect } from "babylonjs/Materials/effect";
  67730. /**
  67731. * Block used to implement the reflectivity module of the PBR material
  67732. */
  67733. export class ReflectivityBlock extends NodeMaterialBlock {
  67734. private _metallicReflectanceColor;
  67735. private _metallicF0Factor;
  67736. /** @hidden */
  67737. _vMetallicReflectanceFactorsName: string;
  67738. /**
  67739. * The property below is set by the main PBR block prior to calling methods of this class.
  67740. */
  67741. /** @hidden */
  67742. indexOfRefractionConnectionPoint: Nullable<NodeMaterialConnectionPoint>;
  67743. /**
  67744. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  67745. */
  67746. useAmbientOcclusionFromMetallicTextureRed: boolean;
  67747. /**
  67748. * Specifies if the metallic texture contains the metallness information in its blue channel.
  67749. */
  67750. useMetallnessFromMetallicTextureBlue: boolean;
  67751. /**
  67752. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  67753. */
  67754. useRoughnessFromMetallicTextureAlpha: boolean;
  67755. /**
  67756. * Specifies if the metallic texture contains the roughness information in its green channel.
  67757. */
  67758. useRoughnessFromMetallicTextureGreen: boolean;
  67759. /**
  67760. * Create a new ReflectivityBlock
  67761. * @param name defines the block name
  67762. */
  67763. constructor(name: string);
  67764. /**
  67765. * Initialize the block and prepare the context for build
  67766. * @param state defines the state that will be used for the build
  67767. */
  67768. initialize(state: NodeMaterialBuildState): void;
  67769. /**
  67770. * Gets the current class name
  67771. * @returns the class name
  67772. */
  67773. getClassName(): string;
  67774. /**
  67775. * Gets the metallic input component
  67776. */
  67777. get metallic(): NodeMaterialConnectionPoint;
  67778. /**
  67779. * Gets the roughness input component
  67780. */
  67781. get roughness(): NodeMaterialConnectionPoint;
  67782. /**
  67783. * Gets the texture input component
  67784. */
  67785. get texture(): NodeMaterialConnectionPoint;
  67786. /**
  67787. * Gets the reflectivity object output component
  67788. */
  67789. get reflectivity(): NodeMaterialConnectionPoint;
  67790. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  67791. /**
  67792. * Gets the main code of the block (fragment side)
  67793. * @param state current state of the node material building
  67794. * @param aoIntensityVarName name of the variable with the ambient occlusion intensity
  67795. * @returns the shader code
  67796. */
  67797. getCode(state: NodeMaterialBuildState, aoIntensityVarName: string): string;
  67798. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67799. protected _buildBlock(state: NodeMaterialBuildState): this;
  67800. protected _dumpPropertiesCode(): string;
  67801. serialize(): any;
  67802. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67803. }
  67804. }
  67805. declare module "babylonjs/Materials/Node/Blocks/PBR/anisotropyBlock" {
  67806. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67807. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67808. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67809. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67810. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67811. /**
  67812. * Block used to implement the anisotropy module of the PBR material
  67813. */
  67814. export class AnisotropyBlock extends NodeMaterialBlock {
  67815. /**
  67816. * The two properties below are set by the main PBR block prior to calling methods of this class.
  67817. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  67818. * It's less burden on the user side in the editor part.
  67819. */
  67820. /** @hidden */
  67821. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  67822. /** @hidden */
  67823. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  67824. /**
  67825. * Create a new AnisotropyBlock
  67826. * @param name defines the block name
  67827. */
  67828. constructor(name: string);
  67829. /**
  67830. * Initialize the block and prepare the context for build
  67831. * @param state defines the state that will be used for the build
  67832. */
  67833. initialize(state: NodeMaterialBuildState): void;
  67834. /**
  67835. * Gets the current class name
  67836. * @returns the class name
  67837. */
  67838. getClassName(): string;
  67839. /**
  67840. * Gets the intensity input component
  67841. */
  67842. get intensity(): NodeMaterialConnectionPoint;
  67843. /**
  67844. * Gets the direction input component
  67845. */
  67846. get direction(): NodeMaterialConnectionPoint;
  67847. /**
  67848. * Gets the texture input component
  67849. */
  67850. get texture(): NodeMaterialConnectionPoint;
  67851. /**
  67852. * Gets the uv input component
  67853. */
  67854. get uv(): NodeMaterialConnectionPoint;
  67855. /**
  67856. * Gets the worldTangent input component
  67857. */
  67858. get worldTangent(): NodeMaterialConnectionPoint;
  67859. /**
  67860. * Gets the anisotropy object output component
  67861. */
  67862. get anisotropy(): NodeMaterialConnectionPoint;
  67863. private _generateTBNSpace;
  67864. /**
  67865. * Gets the main code of the block (fragment side)
  67866. * @param state current state of the node material building
  67867. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  67868. * @returns the shader code
  67869. */
  67870. getCode(state: NodeMaterialBuildState, generateTBNSpace?: boolean): string;
  67871. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67872. protected _buildBlock(state: NodeMaterialBuildState): this;
  67873. }
  67874. }
  67875. declare module "babylonjs/Materials/Node/Blocks/PBR/clearCoatBlock" {
  67876. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67877. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67878. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67879. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67880. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67881. import { ReflectionBlock } from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  67882. import { Nullable } from "babylonjs/types";
  67883. import { Mesh } from "babylonjs/Meshes/mesh";
  67884. import { SubMesh } from "babylonjs/Meshes/subMesh";
  67885. import { Effect } from "babylonjs/Materials/effect";
  67886. /**
  67887. * Block used to implement the clear coat module of the PBR material
  67888. */
  67889. export class ClearCoatBlock extends NodeMaterialBlock {
  67890. private _scene;
  67891. /**
  67892. * Create a new ClearCoatBlock
  67893. * @param name defines the block name
  67894. */
  67895. constructor(name: string);
  67896. /**
  67897. * Initialize the block and prepare the context for build
  67898. * @param state defines the state that will be used for the build
  67899. */
  67900. initialize(state: NodeMaterialBuildState): void;
  67901. /**
  67902. * Gets the current class name
  67903. * @returns the class name
  67904. */
  67905. getClassName(): string;
  67906. /**
  67907. * Gets the intensity input component
  67908. */
  67909. get intensity(): NodeMaterialConnectionPoint;
  67910. /**
  67911. * Gets the roughness input component
  67912. */
  67913. get roughness(): NodeMaterialConnectionPoint;
  67914. /**
  67915. * Gets the ior input component
  67916. */
  67917. get ior(): NodeMaterialConnectionPoint;
  67918. /**
  67919. * Gets the texture input component
  67920. */
  67921. get texture(): NodeMaterialConnectionPoint;
  67922. /**
  67923. * Gets the bump texture input component
  67924. */
  67925. get bumpTexture(): NodeMaterialConnectionPoint;
  67926. /**
  67927. * Gets the uv input component
  67928. */
  67929. get uv(): NodeMaterialConnectionPoint;
  67930. /**
  67931. * Gets the tint color input component
  67932. */
  67933. get tintColor(): NodeMaterialConnectionPoint;
  67934. /**
  67935. * Gets the tint "at distance" input component
  67936. */
  67937. get tintAtDistance(): NodeMaterialConnectionPoint;
  67938. /**
  67939. * Gets the tint thickness input component
  67940. */
  67941. get tintThickness(): NodeMaterialConnectionPoint;
  67942. /**
  67943. * Gets the world tangent input component
  67944. */
  67945. get worldTangent(): NodeMaterialConnectionPoint;
  67946. /**
  67947. * Gets the clear coat object output component
  67948. */
  67949. get clearcoat(): NodeMaterialConnectionPoint;
  67950. autoConfigure(material: NodeMaterial): void;
  67951. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67952. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  67953. private _generateTBNSpace;
  67954. /**
  67955. * Gets the main code of the block (fragment side)
  67956. * @param state current state of the node material building
  67957. * @param ccBlock instance of a ClearCoatBlock or null if the code must be generated without an active clear coat module
  67958. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  67959. * @param worldPosVarName name of the variable holding the world position
  67960. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  67961. * @param vTBNAvailable indicate that the vTBN variable is already existing because it has already been generated by another block (PerturbNormal or Anisotropy)
  67962. * @param worldNormalVarName name of the variable holding the world normal
  67963. * @returns the shader code
  67964. */
  67965. static GetCode(state: NodeMaterialBuildState, ccBlock: Nullable<ClearCoatBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string, generateTBNSpace: boolean, vTBNAvailable: boolean, worldNormalVarName: string): string;
  67966. protected _buildBlock(state: NodeMaterialBuildState): this;
  67967. }
  67968. }
  67969. declare module "babylonjs/Materials/Node/Blocks/PBR/subSurfaceBlock" {
  67970. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67971. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67972. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67973. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67974. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67975. import { ReflectionBlock } from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  67976. import { Nullable } from "babylonjs/types";
  67977. /**
  67978. * Block used to implement the sub surface module of the PBR material
  67979. */
  67980. export class SubSurfaceBlock extends NodeMaterialBlock {
  67981. /**
  67982. * Create a new SubSurfaceBlock
  67983. * @param name defines the block name
  67984. */
  67985. constructor(name: string);
  67986. /**
  67987. * Stores the intensity of the different subsurface effects in the thickness texture.
  67988. * * the green channel is the translucency intensity.
  67989. * * the blue channel is the scattering intensity.
  67990. * * the alpha channel is the refraction intensity.
  67991. */
  67992. useMaskFromThicknessTexture: boolean;
  67993. /**
  67994. * Initialize the block and prepare the context for build
  67995. * @param state defines the state that will be used for the build
  67996. */
  67997. initialize(state: NodeMaterialBuildState): void;
  67998. /**
  67999. * Gets the current class name
  68000. * @returns the class name
  68001. */
  68002. getClassName(): string;
  68003. /**
  68004. * Gets the min thickness input component
  68005. */
  68006. get minThickness(): NodeMaterialConnectionPoint;
  68007. /**
  68008. * Gets the max thickness input component
  68009. */
  68010. get maxThickness(): NodeMaterialConnectionPoint;
  68011. /**
  68012. * Gets the thickness texture component
  68013. */
  68014. get thicknessTexture(): NodeMaterialConnectionPoint;
  68015. /**
  68016. * Gets the tint color input component
  68017. */
  68018. get tintColor(): NodeMaterialConnectionPoint;
  68019. /**
  68020. * Gets the translucency intensity input component
  68021. */
  68022. get translucencyIntensity(): NodeMaterialConnectionPoint;
  68023. /**
  68024. * Gets the translucency diffusion distance input component
  68025. */
  68026. get translucencyDiffusionDistance(): NodeMaterialConnectionPoint;
  68027. /**
  68028. * Gets the refraction object parameters
  68029. */
  68030. get refraction(): NodeMaterialConnectionPoint;
  68031. /**
  68032. * Gets the sub surface object output component
  68033. */
  68034. get subsurface(): NodeMaterialConnectionPoint;
  68035. autoConfigure(material: NodeMaterial): void;
  68036. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  68037. /**
  68038. * Gets the main code of the block (fragment side)
  68039. * @param state current state of the node material building
  68040. * @param ssBlock instance of a SubSurfaceBlock or null if the code must be generated without an active sub surface module
  68041. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  68042. * @param worldPosVarName name of the variable holding the world position
  68043. * @returns the shader code
  68044. */
  68045. static GetCode(state: NodeMaterialBuildState, ssBlock: Nullable<SubSurfaceBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string): string;
  68046. protected _buildBlock(state: NodeMaterialBuildState): this;
  68047. }
  68048. }
  68049. declare module "babylonjs/Materials/Node/Blocks/PBR/pbrMetallicRoughnessBlock" {
  68050. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  68051. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  68052. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  68053. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  68054. import { Light } from "babylonjs/Lights/light";
  68055. import { Nullable } from "babylonjs/types";
  68056. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  68057. import { Effect } from "babylonjs/Materials/effect";
  68058. import { Mesh } from "babylonjs/Meshes/mesh";
  68059. import { Scene } from "babylonjs/scene";
  68060. /**
  68061. * Block used to implement the PBR metallic/roughness model
  68062. */
  68063. export class PBRMetallicRoughnessBlock extends NodeMaterialBlock {
  68064. /**
  68065. * Gets or sets the light associated with this block
  68066. */
  68067. light: Nullable<Light>;
  68068. private _lightId;
  68069. private _scene;
  68070. private _environmentBRDFTexture;
  68071. private _environmentBrdfSamplerName;
  68072. private _vNormalWName;
  68073. private _invertNormalName;
  68074. /**
  68075. * Create a new ReflectionBlock
  68076. * @param name defines the block name
  68077. */
  68078. constructor(name: string);
  68079. /**
  68080. * Intensity of the direct lights e.g. the four lights available in your scene.
  68081. * This impacts both the direct diffuse and specular highlights.
  68082. */
  68083. directIntensity: number;
  68084. /**
  68085. * Intensity of the environment e.g. how much the environment will light the object
  68086. * either through harmonics for rough material or through the refelction for shiny ones.
  68087. */
  68088. environmentIntensity: number;
  68089. /**
  68090. * This is a special control allowing the reduction of the specular highlights coming from the
  68091. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  68092. */
  68093. specularIntensity: number;
  68094. /**
  68095. * Defines the falloff type used in this material.
  68096. * It by default is Physical.
  68097. */
  68098. lightFalloff: number;
  68099. /**
  68100. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  68101. */
  68102. useAlphaFromAlbedoTexture: boolean;
  68103. /**
  68104. * Specifies that alpha test should be used
  68105. */
  68106. useAlphaTest: boolean;
  68107. /**
  68108. * Defines the alpha limits in alpha test mode.
  68109. */
  68110. alphaTestCutoff: number;
  68111. /**
  68112. * Specifies that alpha blending should be used
  68113. */
  68114. useAlphaBlending: boolean;
  68115. /**
  68116. * Defines if the alpha value should be determined via the rgb values.
  68117. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  68118. */
  68119. opacityRGB: boolean;
  68120. /**
  68121. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most luminous ones).
  68122. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  68123. */
  68124. useRadianceOverAlpha: boolean;
  68125. /**
  68126. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most luminous ones).
  68127. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  68128. */
  68129. useSpecularOverAlpha: boolean;
  68130. /**
  68131. * Enables specular anti aliasing in the PBR shader.
  68132. * It will both interacts on the Geometry for analytical and IBL lighting.
  68133. * It also prefilter the roughness map based on the bump values.
  68134. */
  68135. enableSpecularAntiAliasing: boolean;
  68136. /**
  68137. * Enables realtime filtering on the texture.
  68138. */
  68139. realTimeFiltering: boolean;
  68140. /**
  68141. * Quality switch for realtime filtering
  68142. */
  68143. realTimeFilteringQuality: number;
  68144. /**
  68145. * Defines if the material uses energy conservation.
  68146. */
  68147. useEnergyConservation: boolean;
  68148. /**
  68149. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  68150. * too much the area relying on ambient texture to define their ambient occlusion.
  68151. */
  68152. useRadianceOcclusion: boolean;
  68153. /**
  68154. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  68155. * makes the reflect vector face the model (under horizon).
  68156. */
  68157. useHorizonOcclusion: boolean;
  68158. /**
  68159. * If set to true, no lighting calculations will be applied.
  68160. */
  68161. unlit: boolean;
  68162. /**
  68163. * Force normal to face away from face.
  68164. */
  68165. forceNormalForward: boolean;
  68166. /**
  68167. * Defines the material debug mode.
  68168. * It helps seeing only some components of the material while troubleshooting.
  68169. */
  68170. debugMode: number;
  68171. /**
  68172. * Specify from where on screen the debug mode should start.
  68173. * The value goes from -1 (full screen) to 1 (not visible)
  68174. * It helps with side by side comparison against the final render
  68175. * This defaults to 0
  68176. */
  68177. debugLimit: number;
  68178. /**
  68179. * As the default viewing range might not be enough (if the ambient is really small for instance)
  68180. * You can use the factor to better multiply the final value.
  68181. */
  68182. debugFactor: number;
  68183. /**
  68184. * Initialize the block and prepare the context for build
  68185. * @param state defines the state that will be used for the build
  68186. */
  68187. initialize(state: NodeMaterialBuildState): void;
  68188. /**
  68189. * Gets the current class name
  68190. * @returns the class name
  68191. */
  68192. getClassName(): string;
  68193. /**
  68194. * Gets the world position input component
  68195. */
  68196. get worldPosition(): NodeMaterialConnectionPoint;
  68197. /**
  68198. * Gets the world normal input component
  68199. */
  68200. get worldNormal(): NodeMaterialConnectionPoint;
  68201. /**
  68202. * Gets the perturbed normal input component
  68203. */
  68204. get perturbedNormal(): NodeMaterialConnectionPoint;
  68205. /**
  68206. * Gets the camera position input component
  68207. */
  68208. get cameraPosition(): NodeMaterialConnectionPoint;
  68209. /**
  68210. * Gets the base color input component
  68211. */
  68212. get baseColor(): NodeMaterialConnectionPoint;
  68213. /**
  68214. * Gets the opacity texture input component
  68215. */
  68216. get opacityTexture(): NodeMaterialConnectionPoint;
  68217. /**
  68218. * Gets the ambient color input component
  68219. */
  68220. get ambientColor(): NodeMaterialConnectionPoint;
  68221. /**
  68222. * Gets the reflectivity object parameters
  68223. */
  68224. get reflectivity(): NodeMaterialConnectionPoint;
  68225. /**
  68226. * Gets the ambient occlusion object parameters
  68227. */
  68228. get ambientOcclusion(): NodeMaterialConnectionPoint;
  68229. /**
  68230. * Gets the reflection object parameters
  68231. */
  68232. get reflection(): NodeMaterialConnectionPoint;
  68233. /**
  68234. * Gets the sheen object parameters
  68235. */
  68236. get sheen(): NodeMaterialConnectionPoint;
  68237. /**
  68238. * Gets the clear coat object parameters
  68239. */
  68240. get clearcoat(): NodeMaterialConnectionPoint;
  68241. /**
  68242. * Gets the sub surface object parameters
  68243. */
  68244. get subsurface(): NodeMaterialConnectionPoint;
  68245. /**
  68246. * Gets the anisotropy object parameters
  68247. */
  68248. get anisotropy(): NodeMaterialConnectionPoint;
  68249. /**
  68250. * Gets the ambient output component
  68251. */
  68252. get ambient(): NodeMaterialConnectionPoint;
  68253. /**
  68254. * Gets the diffuse output component
  68255. */
  68256. get diffuse(): NodeMaterialConnectionPoint;
  68257. /**
  68258. * Gets the specular output component
  68259. */
  68260. get specular(): NodeMaterialConnectionPoint;
  68261. /**
  68262. * Gets the sheen output component
  68263. */
  68264. get sheenDir(): NodeMaterialConnectionPoint;
  68265. /**
  68266. * Gets the clear coat output component
  68267. */
  68268. get clearcoatDir(): NodeMaterialConnectionPoint;
  68269. /**
  68270. * Gets the indirect diffuse output component
  68271. */
  68272. get diffuseIndirect(): NodeMaterialConnectionPoint;
  68273. /**
  68274. * Gets the indirect specular output component
  68275. */
  68276. get specularIndirect(): NodeMaterialConnectionPoint;
  68277. /**
  68278. * Gets the indirect sheen output component
  68279. */
  68280. get sheenIndirect(): NodeMaterialConnectionPoint;
  68281. /**
  68282. * Gets the indirect clear coat output component
  68283. */
  68284. get clearcoatIndirect(): NodeMaterialConnectionPoint;
  68285. /**
  68286. * Gets the refraction output component
  68287. */
  68288. get refraction(): NodeMaterialConnectionPoint;
  68289. /**
  68290. * Gets the global lighting output component
  68291. */
  68292. get lighting(): NodeMaterialConnectionPoint;
  68293. /**
  68294. * Gets the shadow output component
  68295. */
  68296. get shadow(): NodeMaterialConnectionPoint;
  68297. /**
  68298. * Gets the alpha output component
  68299. */
  68300. get alpha(): NodeMaterialConnectionPoint;
  68301. autoConfigure(material: NodeMaterial): void;
  68302. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  68303. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  68304. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  68305. private _injectVertexCode;
  68306. /**
  68307. * Gets the code corresponding to the albedo/opacity module
  68308. * @returns the shader code
  68309. */
  68310. getAlbedoOpacityCode(): string;
  68311. protected _buildBlock(state: NodeMaterialBuildState): this;
  68312. protected _dumpPropertiesCode(): string;
  68313. serialize(): any;
  68314. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  68315. }
  68316. }
  68317. declare module "babylonjs/Materials/Node/Blocks/PBR/index" {
  68318. export * from "babylonjs/Materials/Node/Blocks/PBR/pbrMetallicRoughnessBlock";
  68319. export * from "babylonjs/Materials/Node/Blocks/PBR/sheenBlock";
  68320. export * from "babylonjs/Materials/Node/Blocks/PBR/ambientOcclusionBlock";
  68321. export * from "babylonjs/Materials/Node/Blocks/PBR/reflectivityBlock";
  68322. export * from "babylonjs/Materials/Node/Blocks/PBR/anisotropyBlock";
  68323. export * from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  68324. export * from "babylonjs/Materials/Node/Blocks/PBR/clearCoatBlock";
  68325. export * from "babylonjs/Materials/Node/Blocks/PBR/refractionBlock";
  68326. export * from "babylonjs/Materials/Node/Blocks/PBR/subSurfaceBlock";
  68327. }
  68328. declare module "babylonjs/Materials/Node/Blocks/Particle/index" {
  68329. export * from "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock";
  68330. export * from "babylonjs/Materials/Node/Blocks/Particle/particleRampGradientBlock";
  68331. export * from "babylonjs/Materials/Node/Blocks/Particle/particleBlendMultiplyBlock";
  68332. }
  68333. declare module "babylonjs/Materials/Node/Blocks/modBlock" {
  68334. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  68335. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  68336. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  68337. /**
  68338. * Block used to compute value of one parameter modulo another
  68339. */
  68340. export class ModBlock extends NodeMaterialBlock {
  68341. /**
  68342. * Creates a new ModBlock
  68343. * @param name defines the block name
  68344. */
  68345. constructor(name: string);
  68346. /**
  68347. * Gets the current class name
  68348. * @returns the class name
  68349. */
  68350. getClassName(): string;
  68351. /**
  68352. * Gets the left operand input component
  68353. */
  68354. get left(): NodeMaterialConnectionPoint;
  68355. /**
  68356. * Gets the right operand input component
  68357. */
  68358. get right(): NodeMaterialConnectionPoint;
  68359. /**
  68360. * Gets the output component
  68361. */
  68362. get output(): NodeMaterialConnectionPoint;
  68363. protected _buildBlock(state: NodeMaterialBuildState): this;
  68364. }
  68365. }
  68366. declare module "babylonjs/Materials/Node/Blocks/index" {
  68367. export * from "babylonjs/Materials/Node/Blocks/Vertex/index";
  68368. export * from "babylonjs/Materials/Node/Blocks/Fragment/index";
  68369. export * from "babylonjs/Materials/Node/Blocks/Dual/index";
  68370. export * from "babylonjs/Materials/Node/Blocks/Input/index";
  68371. export * from "babylonjs/Materials/Node/Blocks/multiplyBlock";
  68372. export * from "babylonjs/Materials/Node/Blocks/addBlock";
  68373. export * from "babylonjs/Materials/Node/Blocks/scaleBlock";
  68374. export * from "babylonjs/Materials/Node/Blocks/clampBlock";
  68375. export * from "babylonjs/Materials/Node/Blocks/crossBlock";
  68376. export * from "babylonjs/Materials/Node/Blocks/dotBlock";
  68377. export * from "babylonjs/Materials/Node/Blocks/transformBlock";
  68378. export * from "babylonjs/Materials/Node/Blocks/remapBlock";
  68379. export * from "babylonjs/Materials/Node/Blocks/normalizeBlock";
  68380. export * from "babylonjs/Materials/Node/Blocks/trigonometryBlock";
  68381. export * from "babylonjs/Materials/Node/Blocks/colorMergerBlock";
  68382. export * from "babylonjs/Materials/Node/Blocks/vectorMergerBlock";
  68383. export * from "babylonjs/Materials/Node/Blocks/colorSplitterBlock";
  68384. export * from "babylonjs/Materials/Node/Blocks/vectorSplitterBlock";
  68385. export * from "babylonjs/Materials/Node/Blocks/lerpBlock";
  68386. export * from "babylonjs/Materials/Node/Blocks/divideBlock";
  68387. export * from "babylonjs/Materials/Node/Blocks/subtractBlock";
  68388. export * from "babylonjs/Materials/Node/Blocks/stepBlock";
  68389. export * from "babylonjs/Materials/Node/Blocks/oneMinusBlock";
  68390. export * from "babylonjs/Materials/Node/Blocks/viewDirectionBlock";
  68391. export * from "babylonjs/Materials/Node/Blocks/fresnelBlock";
  68392. export * from "babylonjs/Materials/Node/Blocks/maxBlock";
  68393. export * from "babylonjs/Materials/Node/Blocks/minBlock";
  68394. export * from "babylonjs/Materials/Node/Blocks/distanceBlock";
  68395. export * from "babylonjs/Materials/Node/Blocks/lengthBlock";
  68396. export * from "babylonjs/Materials/Node/Blocks/negateBlock";
  68397. export * from "babylonjs/Materials/Node/Blocks/powBlock";
  68398. export * from "babylonjs/Materials/Node/Blocks/randomNumberBlock";
  68399. export * from "babylonjs/Materials/Node/Blocks/arcTan2Block";
  68400. export * from "babylonjs/Materials/Node/Blocks/smoothStepBlock";
  68401. export * from "babylonjs/Materials/Node/Blocks/reciprocalBlock";
  68402. export * from "babylonjs/Materials/Node/Blocks/replaceColorBlock";
  68403. export * from "babylonjs/Materials/Node/Blocks/posterizeBlock";
  68404. export * from "babylonjs/Materials/Node/Blocks/waveBlock";
  68405. export * from "babylonjs/Materials/Node/Blocks/gradientBlock";
  68406. export * from "babylonjs/Materials/Node/Blocks/nLerpBlock";
  68407. export * from "babylonjs/Materials/Node/Blocks/worleyNoise3DBlock";
  68408. export * from "babylonjs/Materials/Node/Blocks/simplexPerlin3DBlock";
  68409. export * from "babylonjs/Materials/Node/Blocks/normalBlendBlock";
  68410. export * from "babylonjs/Materials/Node/Blocks/rotate2dBlock";
  68411. export * from "babylonjs/Materials/Node/Blocks/reflectBlock";
  68412. export * from "babylonjs/Materials/Node/Blocks/refractBlock";
  68413. export * from "babylonjs/Materials/Node/Blocks/desaturateBlock";
  68414. export * from "babylonjs/Materials/Node/Blocks/PBR/index";
  68415. export * from "babylonjs/Materials/Node/Blocks/Particle/index";
  68416. export * from "babylonjs/Materials/Node/Blocks/modBlock";
  68417. }
  68418. declare module "babylonjs/Materials/Node/Optimizers/index" {
  68419. export * from "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer";
  68420. }
  68421. declare module "babylonjs/Materials/Node/index" {
  68422. export * from "babylonjs/Materials/Node/Enums/index";
  68423. export * from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  68424. export * from "babylonjs/Materials/Node/nodeMaterialBlock";
  68425. export * from "babylonjs/Materials/Node/nodeMaterial";
  68426. export * from "babylonjs/Materials/Node/Blocks/index";
  68427. export * from "babylonjs/Materials/Node/Optimizers/index";
  68428. export * from "babylonjs/Materials/Node/nodeMaterialDecorator";
  68429. }
  68430. declare module "babylonjs/Materials/index" {
  68431. export * from "babylonjs/Materials/Background/index";
  68432. export * from "babylonjs/Materials/colorCurves";
  68433. export * from "babylonjs/Materials/iEffectFallbacks";
  68434. export * from "babylonjs/Materials/effectFallbacks";
  68435. export * from "babylonjs/Materials/effect";
  68436. export * from "babylonjs/Materials/fresnelParameters";
  68437. export * from "babylonjs/Materials/imageProcessingConfiguration";
  68438. export * from "babylonjs/Materials/material";
  68439. export * from "babylonjs/Materials/materialDefines";
  68440. export * from "babylonjs/Materials/thinMaterialHelper";
  68441. export * from "babylonjs/Materials/materialHelper";
  68442. export * from "babylonjs/Materials/multiMaterial";
  68443. export * from "babylonjs/Materials/PBR/index";
  68444. export * from "babylonjs/Materials/pushMaterial";
  68445. export * from "babylonjs/Materials/shaderMaterial";
  68446. export * from "babylonjs/Materials/standardMaterial";
  68447. export * from "babylonjs/Materials/Textures/index";
  68448. export * from "babylonjs/Materials/uniformBuffer";
  68449. export * from "babylonjs/Materials/materialFlags";
  68450. export * from "babylonjs/Materials/Node/index";
  68451. export * from "babylonjs/Materials/effectRenderer";
  68452. export * from "babylonjs/Materials/shadowDepthWrapper";
  68453. }
  68454. declare module "babylonjs/Maths/index" {
  68455. export * from "babylonjs/Maths/math.scalar";
  68456. export * from "babylonjs/Maths/math";
  68457. export * from "babylonjs/Maths/sphericalPolynomial";
  68458. }
  68459. declare module "babylonjs/Meshes/Compression/dracoCompression" {
  68460. import { IDisposable } from "babylonjs/scene";
  68461. import { VertexData } from "babylonjs/Meshes/mesh.vertexData";
  68462. /**
  68463. * Configuration for Draco compression
  68464. */
  68465. export interface IDracoCompressionConfiguration {
  68466. /**
  68467. * Configuration for the decoder.
  68468. */
  68469. decoder: {
  68470. /**
  68471. * The url to the WebAssembly module.
  68472. */
  68473. wasmUrl?: string;
  68474. /**
  68475. * The url to the WebAssembly binary.
  68476. */
  68477. wasmBinaryUrl?: string;
  68478. /**
  68479. * The url to the fallback JavaScript module.
  68480. */
  68481. fallbackUrl?: string;
  68482. };
  68483. }
  68484. /**
  68485. * Draco compression (https://google.github.io/draco/)
  68486. *
  68487. * This class wraps the Draco module.
  68488. *
  68489. * **Encoder**
  68490. *
  68491. * The encoder is not currently implemented.
  68492. *
  68493. * **Decoder**
  68494. *
  68495. * 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.
  68496. *
  68497. * To update the configuration, use the following code:
  68498. * ```javascript
  68499. * DracoCompression.Configuration = {
  68500. * decoder: {
  68501. * wasmUrl: "<url to the WebAssembly library>",
  68502. * wasmBinaryUrl: "<url to the WebAssembly binary>",
  68503. * fallbackUrl: "<url to the fallback JavaScript library>",
  68504. * }
  68505. * };
  68506. * ```
  68507. *
  68508. * 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.
  68509. * Decoding will automatically fallback to the JavaScript version if WebAssembly version is not configured or if WebAssembly is not supported by the browser.
  68510. * Use `DracoCompression.DecoderAvailable` to determine if the decoder configuration is available for the current context.
  68511. *
  68512. * To decode Draco compressed data, get the default DracoCompression object and call decodeMeshAsync:
  68513. * ```javascript
  68514. * var vertexData = await DracoCompression.Default.decodeMeshAsync(data);
  68515. * ```
  68516. *
  68517. * @see https://www.babylonjs-playground.com/#N3EK4B#0
  68518. */
  68519. export class DracoCompression implements IDisposable {
  68520. private _workerPoolPromise?;
  68521. private _decoderModulePromise?;
  68522. /**
  68523. * The configuration. Defaults to the following urls:
  68524. * - wasmUrl: "https://preview.babylonjs.com/draco_wasm_wrapper_gltf.js"
  68525. * - wasmBinaryUrl: "https://preview.babylonjs.com/draco_decoder_gltf.wasm"
  68526. * - fallbackUrl: "https://preview.babylonjs.com/draco_decoder_gltf.js"
  68527. */
  68528. static Configuration: IDracoCompressionConfiguration;
  68529. /**
  68530. * Returns true if the decoder configuration is available.
  68531. */
  68532. static get DecoderAvailable(): boolean;
  68533. /**
  68534. * Default number of workers to create when creating the draco compression object.
  68535. */
  68536. static DefaultNumWorkers: number;
  68537. private static GetDefaultNumWorkers;
  68538. private static _Default;
  68539. /**
  68540. * Default instance for the draco compression object.
  68541. */
  68542. static get Default(): DracoCompression;
  68543. /**
  68544. * Constructor
  68545. * @param numWorkers The number of workers for async operations. Specify `0` to disable web workers and run synchronously in the current context.
  68546. */
  68547. constructor(numWorkers?: number);
  68548. /**
  68549. * Stop all async operations and release resources.
  68550. */
  68551. dispose(): void;
  68552. /**
  68553. * Returns a promise that resolves when ready. Call this manually to ensure draco compression is ready before use.
  68554. * @returns a promise that resolves when ready
  68555. */
  68556. whenReadyAsync(): Promise<void>;
  68557. /**
  68558. * Decode Draco compressed mesh data to vertex data.
  68559. * @param data The ArrayBuffer or ArrayBufferView for the Draco compression data
  68560. * @param attributes A map of attributes from vertex buffer kinds to Draco unique ids
  68561. * @returns A promise that resolves with the decoded vertex data
  68562. */
  68563. decodeMeshAsync(data: ArrayBuffer | ArrayBufferView, attributes?: {
  68564. [kind: string]: number;
  68565. }): Promise<VertexData>;
  68566. }
  68567. }
  68568. declare module "babylonjs/Meshes/Compression/index" {
  68569. export * from "babylonjs/Meshes/Compression/dracoCompression";
  68570. }
  68571. declare module "babylonjs/Meshes/csg" {
  68572. import { Nullable } from "babylonjs/types";
  68573. import { Scene } from "babylonjs/scene";
  68574. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  68575. import { Mesh } from "babylonjs/Meshes/mesh";
  68576. import { Material } from "babylonjs/Materials/material";
  68577. /**
  68578. * Class for building Constructive Solid Geometry
  68579. */
  68580. export class CSG {
  68581. private polygons;
  68582. /**
  68583. * The world matrix
  68584. */
  68585. matrix: Matrix;
  68586. /**
  68587. * Stores the position
  68588. */
  68589. position: Vector3;
  68590. /**
  68591. * Stores the rotation
  68592. */
  68593. rotation: Vector3;
  68594. /**
  68595. * Stores the rotation quaternion
  68596. */
  68597. rotationQuaternion: Nullable<Quaternion>;
  68598. /**
  68599. * Stores the scaling vector
  68600. */
  68601. scaling: Vector3;
  68602. /**
  68603. * Convert the Mesh to CSG
  68604. * @param mesh The Mesh to convert to CSG
  68605. * @returns A new CSG from the Mesh
  68606. */
  68607. static FromMesh(mesh: Mesh): CSG;
  68608. /**
  68609. * Construct a CSG solid from a list of `CSG.Polygon` instances.
  68610. * @param polygons Polygons used to construct a CSG solid
  68611. */
  68612. private static FromPolygons;
  68613. /**
  68614. * Clones, or makes a deep copy, of the CSG
  68615. * @returns A new CSG
  68616. */
  68617. clone(): CSG;
  68618. /**
  68619. * Unions this CSG with another CSG
  68620. * @param csg The CSG to union against this CSG
  68621. * @returns The unioned CSG
  68622. */
  68623. union(csg: CSG): CSG;
  68624. /**
  68625. * Unions this CSG with another CSG in place
  68626. * @param csg The CSG to union against this CSG
  68627. */
  68628. unionInPlace(csg: CSG): void;
  68629. /**
  68630. * Subtracts this CSG with another CSG
  68631. * @param csg The CSG to subtract against this CSG
  68632. * @returns A new CSG
  68633. */
  68634. subtract(csg: CSG): CSG;
  68635. /**
  68636. * Subtracts this CSG with another CSG in place
  68637. * @param csg The CSG to subtact against this CSG
  68638. */
  68639. subtractInPlace(csg: CSG): void;
  68640. /**
  68641. * Intersect this CSG with another CSG
  68642. * @param csg The CSG to intersect against this CSG
  68643. * @returns A new CSG
  68644. */
  68645. intersect(csg: CSG): CSG;
  68646. /**
  68647. * Intersects this CSG with another CSG in place
  68648. * @param csg The CSG to intersect against this CSG
  68649. */
  68650. intersectInPlace(csg: CSG): void;
  68651. /**
  68652. * Return a new CSG solid with solid and empty space switched. This solid is
  68653. * not modified.
  68654. * @returns A new CSG solid with solid and empty space switched
  68655. */
  68656. inverse(): CSG;
  68657. /**
  68658. * Inverses the CSG in place
  68659. */
  68660. inverseInPlace(): void;
  68661. /**
  68662. * This is used to keep meshes transformations so they can be restored
  68663. * when we build back a Babylon Mesh
  68664. * NB : All CSG operations are performed in world coordinates
  68665. * @param csg The CSG to copy the transform attributes from
  68666. * @returns This CSG
  68667. */
  68668. copyTransformAttributes(csg: CSG): CSG;
  68669. /**
  68670. * Build Raw mesh from CSG
  68671. * Coordinates here are in world space
  68672. * @param name The name of the mesh geometry
  68673. * @param scene The Scene
  68674. * @param keepSubMeshes Specifies if the submeshes should be kept
  68675. * @returns A new Mesh
  68676. */
  68677. buildMeshGeometry(name: string, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  68678. /**
  68679. * Build Mesh from CSG taking material and transforms into account
  68680. * @param name The name of the Mesh
  68681. * @param material The material of the Mesh
  68682. * @param scene The Scene
  68683. * @param keepSubMeshes Specifies if submeshes should be kept
  68684. * @returns The new Mesh
  68685. */
  68686. toMesh(name: string, material?: Nullable<Material>, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  68687. }
  68688. }
  68689. declare module "babylonjs/Meshes/trailMesh" {
  68690. import { Mesh } from "babylonjs/Meshes/mesh";
  68691. import { Scene } from "babylonjs/scene";
  68692. import { TransformNode } from "babylonjs/Meshes/transformNode";
  68693. /**
  68694. * Class used to create a trail following a mesh
  68695. */
  68696. export class TrailMesh extends Mesh {
  68697. private _generator;
  68698. private _autoStart;
  68699. private _running;
  68700. private _diameter;
  68701. private _length;
  68702. private _sectionPolygonPointsCount;
  68703. private _sectionVectors;
  68704. private _sectionNormalVectors;
  68705. private _beforeRenderObserver;
  68706. /**
  68707. * @constructor
  68708. * @param name The value used by scene.getMeshByName() to do a lookup.
  68709. * @param generator The mesh or transform node to generate a trail.
  68710. * @param scene The scene to add this mesh to.
  68711. * @param diameter Diameter of trailing mesh. Default is 1.
  68712. * @param length Length of trailing mesh. Default is 60.
  68713. * @param autoStart Automatically start trailing mesh. Default true.
  68714. */
  68715. constructor(name: string, generator: TransformNode, scene: Scene, diameter?: number, length?: number, autoStart?: boolean);
  68716. /**
  68717. * "TrailMesh"
  68718. * @returns "TrailMesh"
  68719. */
  68720. getClassName(): string;
  68721. private _createMesh;
  68722. /**
  68723. * Start trailing mesh.
  68724. */
  68725. start(): void;
  68726. /**
  68727. * Stop trailing mesh.
  68728. */
  68729. stop(): void;
  68730. /**
  68731. * Update trailing mesh geometry.
  68732. */
  68733. update(): void;
  68734. /**
  68735. * Returns a new TrailMesh object.
  68736. * @param name is a string, the name given to the new mesh
  68737. * @param newGenerator use new generator object for cloned trail mesh
  68738. * @returns a new mesh
  68739. */
  68740. clone(name: string | undefined, newGenerator: TransformNode): TrailMesh;
  68741. /**
  68742. * Serializes this trail mesh
  68743. * @param serializationObject object to write serialization to
  68744. */
  68745. serialize(serializationObject: any): void;
  68746. /**
  68747. * Parses a serialized trail mesh
  68748. * @param parsedMesh the serialized mesh
  68749. * @param scene the scene to create the trail mesh in
  68750. * @returns the created trail mesh
  68751. */
  68752. static Parse(parsedMesh: any, scene: Scene): TrailMesh;
  68753. }
  68754. }
  68755. declare module "babylonjs/Meshes/Builders/tiledBoxBuilder" {
  68756. import { Nullable } from "babylonjs/types";
  68757. import { Scene } from "babylonjs/scene";
  68758. import { Vector4 } from "babylonjs/Maths/math.vector";
  68759. import { Color4 } from "babylonjs/Maths/math.color";
  68760. import { Mesh } from "babylonjs/Meshes/mesh";
  68761. /**
  68762. * Class containing static functions to help procedurally build meshes
  68763. */
  68764. export class TiledBoxBuilder {
  68765. /**
  68766. * Creates a box mesh
  68767. * 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)
  68768. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  68769. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68770. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68771. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68772. * @param name defines the name of the mesh
  68773. * @param options defines the options used to create the mesh
  68774. * @param scene defines the hosting scene
  68775. * @returns the box mesh
  68776. */
  68777. static CreateTiledBox(name: string, options: {
  68778. pattern?: number;
  68779. width?: number;
  68780. height?: number;
  68781. depth?: number;
  68782. tileSize?: number;
  68783. tileWidth?: number;
  68784. tileHeight?: number;
  68785. alignHorizontal?: number;
  68786. alignVertical?: number;
  68787. faceUV?: Vector4[];
  68788. faceColors?: Color4[];
  68789. sideOrientation?: number;
  68790. updatable?: boolean;
  68791. }, scene?: Nullable<Scene>): Mesh;
  68792. }
  68793. }
  68794. declare module "babylonjs/Meshes/Builders/torusKnotBuilder" {
  68795. import { Vector4 } from "babylonjs/Maths/math.vector";
  68796. import { Mesh } from "babylonjs/Meshes/mesh";
  68797. /**
  68798. * Class containing static functions to help procedurally build meshes
  68799. */
  68800. export class TorusKnotBuilder {
  68801. /**
  68802. * Creates a torus knot mesh
  68803. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  68804. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  68805. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  68806. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  68807. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68808. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68809. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  68810. * @param name defines the name of the mesh
  68811. * @param options defines the options used to create the mesh
  68812. * @param scene defines the hosting scene
  68813. * @returns the torus knot mesh
  68814. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  68815. */
  68816. static CreateTorusKnot(name: string, options: {
  68817. radius?: number;
  68818. tube?: number;
  68819. radialSegments?: number;
  68820. tubularSegments?: number;
  68821. p?: number;
  68822. q?: number;
  68823. updatable?: boolean;
  68824. sideOrientation?: number;
  68825. frontUVs?: Vector4;
  68826. backUVs?: Vector4;
  68827. }, scene: any): Mesh;
  68828. }
  68829. }
  68830. declare module "babylonjs/Meshes/polygonMesh" {
  68831. import { Scene } from "babylonjs/scene";
  68832. import { Vector2 } from "babylonjs/Maths/math.vector";
  68833. import { Mesh } from "babylonjs/Meshes/mesh";
  68834. import { VertexData } from "babylonjs/Meshes/mesh.vertexData";
  68835. import { Path2 } from "babylonjs/Maths/math.path";
  68836. /**
  68837. * Polygon
  68838. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  68839. */
  68840. export class Polygon {
  68841. /**
  68842. * Creates a rectangle
  68843. * @param xmin bottom X coord
  68844. * @param ymin bottom Y coord
  68845. * @param xmax top X coord
  68846. * @param ymax top Y coord
  68847. * @returns points that make the resulting rectation
  68848. */
  68849. static Rectangle(xmin: number, ymin: number, xmax: number, ymax: number): Vector2[];
  68850. /**
  68851. * Creates a circle
  68852. * @param radius radius of circle
  68853. * @param cx scale in x
  68854. * @param cy scale in y
  68855. * @param numberOfSides number of sides that make up the circle
  68856. * @returns points that make the resulting circle
  68857. */
  68858. static Circle(radius: number, cx?: number, cy?: number, numberOfSides?: number): Vector2[];
  68859. /**
  68860. * Creates a polygon from input string
  68861. * @param input Input polygon data
  68862. * @returns the parsed points
  68863. */
  68864. static Parse(input: string): Vector2[];
  68865. /**
  68866. * Starts building a polygon from x and y coordinates
  68867. * @param x x coordinate
  68868. * @param y y coordinate
  68869. * @returns the started path2
  68870. */
  68871. static StartingAt(x: number, y: number): Path2;
  68872. }
  68873. /**
  68874. * Builds a polygon
  68875. * @see https://doc.babylonjs.com/how_to/polygonmeshbuilder
  68876. */
  68877. export class PolygonMeshBuilder {
  68878. private _points;
  68879. private _outlinepoints;
  68880. private _holes;
  68881. private _name;
  68882. private _scene;
  68883. private _epoints;
  68884. private _eholes;
  68885. private _addToepoint;
  68886. /**
  68887. * Babylon reference to the earcut plugin.
  68888. */
  68889. bjsEarcut: any;
  68890. /**
  68891. * Creates a PolygonMeshBuilder
  68892. * @param name name of the builder
  68893. * @param contours Path of the polygon
  68894. * @param scene scene to add to when creating the mesh
  68895. * @param earcutInjection can be used to inject your own earcut reference
  68896. */
  68897. constructor(name: string, contours: Path2 | Vector2[] | any, scene?: Scene, earcutInjection?: any);
  68898. /**
  68899. * Adds a whole within the polygon
  68900. * @param hole Array of points defining the hole
  68901. * @returns this
  68902. */
  68903. addHole(hole: Vector2[]): PolygonMeshBuilder;
  68904. /**
  68905. * Creates the polygon
  68906. * @param updatable If the mesh should be updatable
  68907. * @param depth The depth of the mesh created
  68908. * @returns the created mesh
  68909. */
  68910. build(updatable?: boolean, depth?: number): Mesh;
  68911. /**
  68912. * Creates the polygon
  68913. * @param depth The depth of the mesh created
  68914. * @returns the created VertexData
  68915. */
  68916. buildVertexData(depth?: number): VertexData;
  68917. /**
  68918. * Adds a side to the polygon
  68919. * @param positions points that make the polygon
  68920. * @param normals normals of the polygon
  68921. * @param uvs uvs of the polygon
  68922. * @param indices indices of the polygon
  68923. * @param bounds bounds of the polygon
  68924. * @param points points of the polygon
  68925. * @param depth depth of the polygon
  68926. * @param flip flip of the polygon
  68927. */
  68928. private addSide;
  68929. }
  68930. }
  68931. declare module "babylonjs/Meshes/Builders/polygonBuilder" {
  68932. import { Scene } from "babylonjs/scene";
  68933. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  68934. import { Color4 } from "babylonjs/Maths/math.color";
  68935. import { Mesh } from "babylonjs/Meshes/mesh";
  68936. import { Nullable } from "babylonjs/types";
  68937. /**
  68938. * Class containing static functions to help procedurally build meshes
  68939. */
  68940. export class PolygonBuilder {
  68941. /**
  68942. * Creates a polygon mesh
  68943. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  68944. * * 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
  68945. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  68946. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68947. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  68948. * * Remember you can only change the shape positions, not their number when updating a polygon
  68949. * @param name defines the name of the mesh
  68950. * @param options defines the options used to create the mesh
  68951. * @param scene defines the hosting scene
  68952. * @param earcutInjection can be used to inject your own earcut reference
  68953. * @returns the polygon mesh
  68954. */
  68955. static CreatePolygon(name: string, options: {
  68956. shape: Vector3[];
  68957. holes?: Vector3[][];
  68958. depth?: number;
  68959. faceUV?: Vector4[];
  68960. faceColors?: Color4[];
  68961. updatable?: boolean;
  68962. sideOrientation?: number;
  68963. frontUVs?: Vector4;
  68964. backUVs?: Vector4;
  68965. wrap?: boolean;
  68966. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  68967. /**
  68968. * Creates an extruded polygon mesh, with depth in the Y direction.
  68969. * * 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)
  68970. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  68971. * @param name defines the name of the mesh
  68972. * @param options defines the options used to create the mesh
  68973. * @param scene defines the hosting scene
  68974. * @param earcutInjection can be used to inject your own earcut reference
  68975. * @returns the polygon mesh
  68976. */
  68977. static ExtrudePolygon(name: string, options: {
  68978. shape: Vector3[];
  68979. holes?: Vector3[][];
  68980. depth?: number;
  68981. faceUV?: Vector4[];
  68982. faceColors?: Color4[];
  68983. updatable?: boolean;
  68984. sideOrientation?: number;
  68985. frontUVs?: Vector4;
  68986. backUVs?: Vector4;
  68987. wrap?: boolean;
  68988. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  68989. }
  68990. }
  68991. declare module "babylonjs/Meshes/Builders/latheBuilder" {
  68992. import { Scene } from "babylonjs/scene";
  68993. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  68994. import { Mesh } from "babylonjs/Meshes/mesh";
  68995. import { Nullable } from "babylonjs/types";
  68996. /**
  68997. * Class containing static functions to help procedurally build meshes
  68998. */
  68999. export class LatheBuilder {
  69000. /**
  69001. * Creates lathe mesh.
  69002. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  69003. * * 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
  69004. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  69005. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  69006. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  69007. * * 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
  69008. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  69009. * * 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
  69010. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69011. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69012. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69013. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69014. * @param name defines the name of the mesh
  69015. * @param options defines the options used to create the mesh
  69016. * @param scene defines the hosting scene
  69017. * @returns the lathe mesh
  69018. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  69019. */
  69020. static CreateLathe(name: string, options: {
  69021. shape: Vector3[];
  69022. radius?: number;
  69023. tessellation?: number;
  69024. clip?: number;
  69025. arc?: number;
  69026. closed?: boolean;
  69027. updatable?: boolean;
  69028. sideOrientation?: number;
  69029. frontUVs?: Vector4;
  69030. backUVs?: Vector4;
  69031. cap?: number;
  69032. invertUV?: boolean;
  69033. }, scene?: Nullable<Scene>): Mesh;
  69034. }
  69035. }
  69036. declare module "babylonjs/Meshes/Builders/tiledPlaneBuilder" {
  69037. import { Nullable } from "babylonjs/types";
  69038. import { Scene } from "babylonjs/scene";
  69039. import { Vector4 } from "babylonjs/Maths/math.vector";
  69040. import { Mesh } from "babylonjs/Meshes/mesh";
  69041. /**
  69042. * Class containing static functions to help procedurally build meshes
  69043. */
  69044. export class TiledPlaneBuilder {
  69045. /**
  69046. * Creates a tiled plane mesh
  69047. * * The parameter `pattern` will, depending on value, do nothing or
  69048. * * * flip (reflect about central vertical) alternate tiles across and up
  69049. * * * flip every tile on alternate rows
  69050. * * * rotate (180 degs) alternate tiles across and up
  69051. * * * rotate every tile on alternate rows
  69052. * * * flip and rotate alternate tiles across and up
  69053. * * * flip and rotate every tile on alternate rows
  69054. * * The parameter `tileSize` sets the size (float) of each tile side (default 1)
  69055. * * You can set some different tile dimensions by using the parameters `tileWidth` and `tileHeight` (both by default have the same value of `tileSize`)
  69056. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69057. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  69058. * * 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)
  69059. * * 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)
  69060. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  69061. * @param name defines the name of the mesh
  69062. * @param options defines the options used to create the mesh
  69063. * @param scene defines the hosting scene
  69064. * @returns the box mesh
  69065. */
  69066. static CreateTiledPlane(name: string, options: {
  69067. pattern?: number;
  69068. tileSize?: number;
  69069. tileWidth?: number;
  69070. tileHeight?: number;
  69071. size?: number;
  69072. width?: number;
  69073. height?: number;
  69074. alignHorizontal?: number;
  69075. alignVertical?: number;
  69076. sideOrientation?: number;
  69077. frontUVs?: Vector4;
  69078. backUVs?: Vector4;
  69079. updatable?: boolean;
  69080. }, scene?: Nullable<Scene>): Mesh;
  69081. }
  69082. }
  69083. declare module "babylonjs/Meshes/Builders/tubeBuilder" {
  69084. import { Nullable } from "babylonjs/types";
  69085. import { Scene } from "babylonjs/scene";
  69086. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  69087. import { Mesh } from "babylonjs/Meshes/mesh";
  69088. /**
  69089. * Class containing static functions to help procedurally build meshes
  69090. */
  69091. export class TubeBuilder {
  69092. /**
  69093. * Creates a tube mesh.
  69094. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  69095. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  69096. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  69097. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  69098. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  69099. * * 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)
  69100. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  69101. * * 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
  69102. * * 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
  69103. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69104. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69105. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69106. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69107. * @param name defines the name of the mesh
  69108. * @param options defines the options used to create the mesh
  69109. * @param scene defines the hosting scene
  69110. * @returns the tube mesh
  69111. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69112. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  69113. */
  69114. static CreateTube(name: string, options: {
  69115. path: Vector3[];
  69116. radius?: number;
  69117. tessellation?: number;
  69118. radiusFunction?: {
  69119. (i: number, distance: number): number;
  69120. };
  69121. cap?: number;
  69122. arc?: number;
  69123. updatable?: boolean;
  69124. sideOrientation?: number;
  69125. frontUVs?: Vector4;
  69126. backUVs?: Vector4;
  69127. instance?: Mesh;
  69128. invertUV?: boolean;
  69129. }, scene?: Nullable<Scene>): Mesh;
  69130. }
  69131. }
  69132. declare module "babylonjs/Meshes/Builders/icoSphereBuilder" {
  69133. import { Scene } from "babylonjs/scene";
  69134. import { Vector4 } from "babylonjs/Maths/math.vector";
  69135. import { Mesh } from "babylonjs/Meshes/mesh";
  69136. import { Nullable } from "babylonjs/types";
  69137. /**
  69138. * Class containing static functions to help procedurally build meshes
  69139. */
  69140. export class IcoSphereBuilder {
  69141. /**
  69142. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  69143. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  69144. * * 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`)
  69145. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  69146. * * 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
  69147. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69148. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69149. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69150. * @param name defines the name of the mesh
  69151. * @param options defines the options used to create the mesh
  69152. * @param scene defines the hosting scene
  69153. * @returns the icosahedron mesh
  69154. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  69155. */
  69156. static CreateIcoSphere(name: string, options: {
  69157. radius?: number;
  69158. radiusX?: number;
  69159. radiusY?: number;
  69160. radiusZ?: number;
  69161. flat?: boolean;
  69162. subdivisions?: number;
  69163. sideOrientation?: number;
  69164. frontUVs?: Vector4;
  69165. backUVs?: Vector4;
  69166. updatable?: boolean;
  69167. }, scene?: Nullable<Scene>): Mesh;
  69168. }
  69169. }
  69170. declare module "babylonjs/Meshes/Builders/decalBuilder" {
  69171. import { Vector3 } from "babylonjs/Maths/math.vector";
  69172. import { Mesh } from "babylonjs/Meshes/mesh";
  69173. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  69174. /**
  69175. * Class containing static functions to help procedurally build meshes
  69176. */
  69177. export class DecalBuilder {
  69178. /**
  69179. * Creates a decal mesh.
  69180. * 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
  69181. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  69182. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  69183. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  69184. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  69185. * @param name defines the name of the mesh
  69186. * @param sourceMesh defines the mesh where the decal must be applied
  69187. * @param options defines the options used to create the mesh
  69188. * @param scene defines the hosting scene
  69189. * @returns the decal mesh
  69190. * @see https://doc.babylonjs.com/how_to/decals
  69191. */
  69192. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  69193. position?: Vector3;
  69194. normal?: Vector3;
  69195. size?: Vector3;
  69196. angle?: number;
  69197. }): Mesh;
  69198. }
  69199. }
  69200. declare module "babylonjs/Meshes/meshBuilder" {
  69201. import { Vector4, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  69202. import { Nullable } from "babylonjs/types";
  69203. import { Scene } from "babylonjs/scene";
  69204. import { Mesh } from "babylonjs/Meshes/mesh";
  69205. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  69206. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  69207. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  69208. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  69209. import { Plane } from "babylonjs/Maths/math.plane";
  69210. /**
  69211. * Class containing static functions to help procedurally build meshes
  69212. */
  69213. export class MeshBuilder {
  69214. /**
  69215. * Creates a box mesh
  69216. * * The parameter `size` sets the size (float) of each box side (default 1)
  69217. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  69218. * * 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)
  69219. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  69220. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69221. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69222. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69223. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  69224. * @param name defines the name of the mesh
  69225. * @param options defines the options used to create the mesh
  69226. * @param scene defines the hosting scene
  69227. * @returns the box mesh
  69228. */
  69229. static CreateBox(name: string, options: {
  69230. size?: number;
  69231. width?: number;
  69232. height?: number;
  69233. depth?: number;
  69234. faceUV?: Vector4[];
  69235. faceColors?: Color4[];
  69236. sideOrientation?: number;
  69237. frontUVs?: Vector4;
  69238. backUVs?: Vector4;
  69239. wrap?: boolean;
  69240. topBaseAt?: number;
  69241. bottomBaseAt?: number;
  69242. updatable?: boolean;
  69243. }, scene?: Nullable<Scene>): Mesh;
  69244. /**
  69245. * Creates a tiled box mesh
  69246. * * faceTiles sets the pattern, tile size and number of tiles for a face
  69247. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69248. * @param name defines the name of the mesh
  69249. * @param options defines the options used to create the mesh
  69250. * @param scene defines the hosting scene
  69251. * @returns the tiled box mesh
  69252. */
  69253. static CreateTiledBox(name: string, options: {
  69254. pattern?: number;
  69255. size?: number;
  69256. width?: number;
  69257. height?: number;
  69258. depth: number;
  69259. tileSize?: number;
  69260. tileWidth?: number;
  69261. tileHeight?: number;
  69262. faceUV?: Vector4[];
  69263. faceColors?: Color4[];
  69264. alignHorizontal?: number;
  69265. alignVertical?: number;
  69266. sideOrientation?: number;
  69267. updatable?: boolean;
  69268. }, scene?: Nullable<Scene>): Mesh;
  69269. /**
  69270. * Creates a sphere mesh
  69271. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  69272. * * 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`)
  69273. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  69274. * * 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
  69275. * * 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)
  69276. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69277. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69278. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69279. * @param name defines the name of the mesh
  69280. * @param options defines the options used to create the mesh
  69281. * @param scene defines the hosting scene
  69282. * @returns the sphere mesh
  69283. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  69284. */
  69285. static CreateSphere(name: string, options: {
  69286. segments?: number;
  69287. diameter?: number;
  69288. diameterX?: number;
  69289. diameterY?: number;
  69290. diameterZ?: number;
  69291. arc?: number;
  69292. slice?: number;
  69293. sideOrientation?: number;
  69294. frontUVs?: Vector4;
  69295. backUVs?: Vector4;
  69296. updatable?: boolean;
  69297. }, scene?: Nullable<Scene>): Mesh;
  69298. /**
  69299. * Creates a plane polygonal mesh. By default, this is a disc
  69300. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  69301. * * 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
  69302. * * 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
  69303. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69304. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69305. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69306. * @param name defines the name of the mesh
  69307. * @param options defines the options used to create the mesh
  69308. * @param scene defines the hosting scene
  69309. * @returns the plane polygonal mesh
  69310. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  69311. */
  69312. static CreateDisc(name: string, options: {
  69313. radius?: number;
  69314. tessellation?: number;
  69315. arc?: number;
  69316. updatable?: boolean;
  69317. sideOrientation?: number;
  69318. frontUVs?: Vector4;
  69319. backUVs?: Vector4;
  69320. }, scene?: Nullable<Scene>): Mesh;
  69321. /**
  69322. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  69323. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  69324. * * 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`)
  69325. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  69326. * * 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
  69327. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69328. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69329. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69330. * @param name defines the name of the mesh
  69331. * @param options defines the options used to create the mesh
  69332. * @param scene defines the hosting scene
  69333. * @returns the icosahedron mesh
  69334. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  69335. */
  69336. static CreateIcoSphere(name: string, options: {
  69337. radius?: number;
  69338. radiusX?: number;
  69339. radiusY?: number;
  69340. radiusZ?: number;
  69341. flat?: boolean;
  69342. subdivisions?: number;
  69343. sideOrientation?: number;
  69344. frontUVs?: Vector4;
  69345. backUVs?: Vector4;
  69346. updatable?: boolean;
  69347. }, scene?: Nullable<Scene>): Mesh;
  69348. /**
  69349. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  69350. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  69351. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  69352. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  69353. * * 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
  69354. * * 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
  69355. * * 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
  69356. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69357. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69358. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69359. * * 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
  69360. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  69361. * * 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
  69362. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  69363. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69364. * @param name defines the name of the mesh
  69365. * @param options defines the options used to create the mesh
  69366. * @param scene defines the hosting scene
  69367. * @returns the ribbon mesh
  69368. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  69369. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69370. */
  69371. static CreateRibbon(name: string, options: {
  69372. pathArray: Vector3[][];
  69373. closeArray?: boolean;
  69374. closePath?: boolean;
  69375. offset?: number;
  69376. updatable?: boolean;
  69377. sideOrientation?: number;
  69378. frontUVs?: Vector4;
  69379. backUVs?: Vector4;
  69380. instance?: Mesh;
  69381. invertUV?: boolean;
  69382. uvs?: Vector2[];
  69383. colors?: Color4[];
  69384. }, scene?: Nullable<Scene>): Mesh;
  69385. /**
  69386. * Creates a cylinder or a cone mesh
  69387. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  69388. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  69389. * * 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.
  69390. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  69391. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  69392. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  69393. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  69394. * * 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).
  69395. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  69396. * * 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).
  69397. * * 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
  69398. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  69399. * * 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
  69400. * * 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.
  69401. * * If `enclose` is false, a ring surface is one element.
  69402. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  69403. * * 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
  69404. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69405. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69406. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69407. * @param name defines the name of the mesh
  69408. * @param options defines the options used to create the mesh
  69409. * @param scene defines the hosting scene
  69410. * @returns the cylinder mesh
  69411. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  69412. */
  69413. static CreateCylinder(name: string, options: {
  69414. height?: number;
  69415. diameterTop?: number;
  69416. diameterBottom?: number;
  69417. diameter?: number;
  69418. tessellation?: number;
  69419. subdivisions?: number;
  69420. arc?: number;
  69421. faceColors?: Color4[];
  69422. faceUV?: Vector4[];
  69423. updatable?: boolean;
  69424. hasRings?: boolean;
  69425. enclose?: boolean;
  69426. cap?: number;
  69427. sideOrientation?: number;
  69428. frontUVs?: Vector4;
  69429. backUVs?: Vector4;
  69430. }, scene?: Nullable<Scene>): Mesh;
  69431. /**
  69432. * Creates a torus mesh
  69433. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  69434. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  69435. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  69436. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69437. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69438. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69439. * @param name defines the name of the mesh
  69440. * @param options defines the options used to create the mesh
  69441. * @param scene defines the hosting scene
  69442. * @returns the torus mesh
  69443. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  69444. */
  69445. static CreateTorus(name: string, options: {
  69446. diameter?: number;
  69447. thickness?: number;
  69448. tessellation?: number;
  69449. updatable?: boolean;
  69450. sideOrientation?: number;
  69451. frontUVs?: Vector4;
  69452. backUVs?: Vector4;
  69453. }, scene?: Nullable<Scene>): Mesh;
  69454. /**
  69455. * Creates a torus knot mesh
  69456. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  69457. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  69458. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  69459. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  69460. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69461. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69462. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69463. * @param name defines the name of the mesh
  69464. * @param options defines the options used to create the mesh
  69465. * @param scene defines the hosting scene
  69466. * @returns the torus knot mesh
  69467. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  69468. */
  69469. static CreateTorusKnot(name: string, options: {
  69470. radius?: number;
  69471. tube?: number;
  69472. radialSegments?: number;
  69473. tubularSegments?: number;
  69474. p?: number;
  69475. q?: number;
  69476. updatable?: boolean;
  69477. sideOrientation?: number;
  69478. frontUVs?: Vector4;
  69479. backUVs?: Vector4;
  69480. }, scene?: Nullable<Scene>): Mesh;
  69481. /**
  69482. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  69483. * * 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
  69484. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  69485. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  69486. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  69487. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  69488. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  69489. * * 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
  69490. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  69491. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69492. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  69493. * @param name defines the name of the new line system
  69494. * @param options defines the options used to create the line system
  69495. * @param scene defines the hosting scene
  69496. * @returns a new line system mesh
  69497. */
  69498. static CreateLineSystem(name: string, options: {
  69499. lines: Vector3[][];
  69500. updatable?: boolean;
  69501. instance?: Nullable<LinesMesh>;
  69502. colors?: Nullable<Color4[][]>;
  69503. useVertexAlpha?: boolean;
  69504. }, scene: Nullable<Scene>): LinesMesh;
  69505. /**
  69506. * Creates a line mesh
  69507. * 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
  69508. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  69509. * * The parameter `points` is an array successive Vector3
  69510. * * The optional parameter `instance` is an instance of an existing LineMesh object to be updated with the passed `points` parameter : https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#lines-and-dashedlines
  69511. * * The optional parameter `colors` is an array of successive Color4, one per line point
  69512. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  69513. * * When updating an instance, remember that only point positions can change, not the number of points
  69514. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69515. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  69516. * @param name defines the name of the new line system
  69517. * @param options defines the options used to create the line system
  69518. * @param scene defines the hosting scene
  69519. * @returns a new line mesh
  69520. */
  69521. static CreateLines(name: string, options: {
  69522. points: Vector3[];
  69523. updatable?: boolean;
  69524. instance?: Nullable<LinesMesh>;
  69525. colors?: Color4[];
  69526. useVertexAlpha?: boolean;
  69527. }, scene?: Nullable<Scene>): LinesMesh;
  69528. /**
  69529. * Creates a dashed line mesh
  69530. * * 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
  69531. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  69532. * * The parameter `points` is an array successive Vector3
  69533. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  69534. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  69535. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  69536. * * 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
  69537. * * When updating an instance, remember that only point positions can change, not the number of points
  69538. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69539. * @param name defines the name of the mesh
  69540. * @param options defines the options used to create the mesh
  69541. * @param scene defines the hosting scene
  69542. * @returns the dashed line mesh
  69543. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  69544. */
  69545. static CreateDashedLines(name: string, options: {
  69546. points: Vector3[];
  69547. dashSize?: number;
  69548. gapSize?: number;
  69549. dashNb?: number;
  69550. updatable?: boolean;
  69551. instance?: LinesMesh;
  69552. }, scene?: Nullable<Scene>): LinesMesh;
  69553. /**
  69554. * 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.
  69555. * * 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.
  69556. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  69557. * * 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.
  69558. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  69559. * * 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
  69560. * * 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
  69561. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  69562. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69563. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69564. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  69565. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69566. * @param name defines the name of the mesh
  69567. * @param options defines the options used to create the mesh
  69568. * @param scene defines the hosting scene
  69569. * @returns the extruded shape mesh
  69570. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69571. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  69572. */
  69573. static ExtrudeShape(name: string, options: {
  69574. shape: Vector3[];
  69575. path: Vector3[];
  69576. scale?: number;
  69577. rotation?: number;
  69578. cap?: number;
  69579. updatable?: boolean;
  69580. sideOrientation?: number;
  69581. frontUVs?: Vector4;
  69582. backUVs?: Vector4;
  69583. instance?: Mesh;
  69584. invertUV?: boolean;
  69585. }, scene?: Nullable<Scene>): Mesh;
  69586. /**
  69587. * Creates an custom extruded shape mesh.
  69588. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  69589. * * 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.
  69590. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  69591. * * 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
  69592. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  69593. * * 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
  69594. * * It must returns a float value that will be the scale value applied to the shape on each path point
  69595. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  69596. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  69597. * * 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
  69598. * * 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
  69599. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  69600. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69601. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69602. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  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 custom extruded shape mesh
  69608. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  69609. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69610. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  69611. */
  69612. static ExtrudeShapeCustom(name: string, options: {
  69613. shape: Vector3[];
  69614. path: Vector3[];
  69615. scaleFunction?: any;
  69616. rotationFunction?: any;
  69617. ribbonCloseArray?: boolean;
  69618. ribbonClosePath?: boolean;
  69619. cap?: number;
  69620. updatable?: boolean;
  69621. sideOrientation?: number;
  69622. frontUVs?: Vector4;
  69623. backUVs?: Vector4;
  69624. instance?: Mesh;
  69625. invertUV?: boolean;
  69626. }, scene?: Nullable<Scene>): Mesh;
  69627. /**
  69628. * Creates lathe mesh.
  69629. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  69630. * * 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
  69631. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  69632. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  69633. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  69634. * * 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
  69635. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  69636. * * 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
  69637. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69638. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69639. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69640. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69641. * @param name defines the name of the mesh
  69642. * @param options defines the options used to create the mesh
  69643. * @param scene defines the hosting scene
  69644. * @returns the lathe mesh
  69645. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  69646. */
  69647. static CreateLathe(name: string, options: {
  69648. shape: Vector3[];
  69649. radius?: number;
  69650. tessellation?: number;
  69651. clip?: number;
  69652. arc?: number;
  69653. closed?: boolean;
  69654. updatable?: boolean;
  69655. sideOrientation?: number;
  69656. frontUVs?: Vector4;
  69657. backUVs?: Vector4;
  69658. cap?: number;
  69659. invertUV?: boolean;
  69660. }, scene?: Nullable<Scene>): Mesh;
  69661. /**
  69662. * Creates a tiled plane mesh
  69663. * * You can set a limited pattern arrangement with the tiles
  69664. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69665. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69666. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69667. * @param name defines the name of the mesh
  69668. * @param options defines the options used to create the mesh
  69669. * @param scene defines the hosting scene
  69670. * @returns the plane mesh
  69671. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  69672. */
  69673. static CreateTiledPlane(name: string, options: {
  69674. pattern?: number;
  69675. tileSize?: number;
  69676. tileWidth?: number;
  69677. tileHeight?: number;
  69678. size?: number;
  69679. width?: number;
  69680. height?: number;
  69681. alignHorizontal?: number;
  69682. alignVertical?: number;
  69683. sideOrientation?: number;
  69684. frontUVs?: Vector4;
  69685. backUVs?: Vector4;
  69686. updatable?: boolean;
  69687. }, scene?: Nullable<Scene>): Mesh;
  69688. /**
  69689. * Creates a plane mesh
  69690. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  69691. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  69692. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  69693. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69694. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69695. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69696. * @param name defines the name of the mesh
  69697. * @param options defines the options used to create the mesh
  69698. * @param scene defines the hosting scene
  69699. * @returns the plane mesh
  69700. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  69701. */
  69702. static CreatePlane(name: string, options: {
  69703. size?: number;
  69704. width?: number;
  69705. height?: number;
  69706. sideOrientation?: number;
  69707. frontUVs?: Vector4;
  69708. backUVs?: Vector4;
  69709. updatable?: boolean;
  69710. sourcePlane?: Plane;
  69711. }, scene?: Nullable<Scene>): Mesh;
  69712. /**
  69713. * Creates a ground mesh
  69714. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  69715. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  69716. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69717. * @param name defines the name of the mesh
  69718. * @param options defines the options used to create the mesh
  69719. * @param scene defines the hosting scene
  69720. * @returns the ground mesh
  69721. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  69722. */
  69723. static CreateGround(name: string, options: {
  69724. width?: number;
  69725. height?: number;
  69726. subdivisions?: number;
  69727. subdivisionsX?: number;
  69728. subdivisionsY?: number;
  69729. updatable?: boolean;
  69730. }, scene?: Nullable<Scene>): Mesh;
  69731. /**
  69732. * Creates a tiled ground mesh
  69733. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  69734. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  69735. * * 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
  69736. * * 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
  69737. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69738. * @param name defines the name of the mesh
  69739. * @param options defines the options used to create the mesh
  69740. * @param scene defines the hosting scene
  69741. * @returns the tiled ground mesh
  69742. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  69743. */
  69744. static CreateTiledGround(name: string, options: {
  69745. xmin: number;
  69746. zmin: number;
  69747. xmax: number;
  69748. zmax: number;
  69749. subdivisions?: {
  69750. w: number;
  69751. h: number;
  69752. };
  69753. precision?: {
  69754. w: number;
  69755. h: number;
  69756. };
  69757. updatable?: boolean;
  69758. }, scene?: Nullable<Scene>): Mesh;
  69759. /**
  69760. * Creates a ground mesh from a height map
  69761. * * The parameter `url` sets the URL of the height map image resource.
  69762. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  69763. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  69764. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  69765. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  69766. * * 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.
  69767. * * 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).
  69768. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  69769. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69770. * @param name defines the name of the mesh
  69771. * @param url defines the url to the height map
  69772. * @param options defines the options used to create the mesh
  69773. * @param scene defines the hosting scene
  69774. * @returns the ground mesh
  69775. * @see https://doc.babylonjs.com/babylon101/height_map
  69776. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  69777. */
  69778. static CreateGroundFromHeightMap(name: string, url: string, options: {
  69779. width?: number;
  69780. height?: number;
  69781. subdivisions?: number;
  69782. minHeight?: number;
  69783. maxHeight?: number;
  69784. colorFilter?: Color3;
  69785. alphaFilter?: number;
  69786. updatable?: boolean;
  69787. onReady?: (mesh: GroundMesh) => void;
  69788. }, scene?: Nullable<Scene>): GroundMesh;
  69789. /**
  69790. * Creates a polygon mesh
  69791. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  69792. * * 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
  69793. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  69794. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69795. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  69796. * * Remember you can only change the shape positions, not their number when updating a polygon
  69797. * @param name defines the name of the mesh
  69798. * @param options defines the options used to create the mesh
  69799. * @param scene defines the hosting scene
  69800. * @param earcutInjection can be used to inject your own earcut reference
  69801. * @returns the polygon mesh
  69802. */
  69803. static CreatePolygon(name: string, options: {
  69804. shape: Vector3[];
  69805. holes?: Vector3[][];
  69806. depth?: number;
  69807. faceUV?: Vector4[];
  69808. faceColors?: Color4[];
  69809. updatable?: boolean;
  69810. sideOrientation?: number;
  69811. frontUVs?: Vector4;
  69812. backUVs?: Vector4;
  69813. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  69814. /**
  69815. * Creates an extruded polygon mesh, with depth in the Y direction.
  69816. * * 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)
  69817. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  69818. * @param name defines the name of the mesh
  69819. * @param options defines the options used to create the mesh
  69820. * @param scene defines the hosting scene
  69821. * @param earcutInjection can be used to inject your own earcut reference
  69822. * @returns the polygon mesh
  69823. */
  69824. static ExtrudePolygon(name: string, options: {
  69825. shape: Vector3[];
  69826. holes?: Vector3[][];
  69827. depth?: number;
  69828. faceUV?: Vector4[];
  69829. faceColors?: Color4[];
  69830. updatable?: boolean;
  69831. sideOrientation?: number;
  69832. frontUVs?: Vector4;
  69833. backUVs?: Vector4;
  69834. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  69835. /**
  69836. * Creates a tube mesh.
  69837. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  69838. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  69839. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  69840. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  69841. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  69842. * * 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)
  69843. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  69844. * * 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
  69845. * * 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
  69846. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69847. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69848. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69849. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69850. * @param name defines the name of the mesh
  69851. * @param options defines the options used to create the mesh
  69852. * @param scene defines the hosting scene
  69853. * @returns the tube mesh
  69854. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69855. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  69856. */
  69857. static CreateTube(name: string, options: {
  69858. path: Vector3[];
  69859. radius?: number;
  69860. tessellation?: number;
  69861. radiusFunction?: {
  69862. (i: number, distance: number): number;
  69863. };
  69864. cap?: number;
  69865. arc?: number;
  69866. updatable?: boolean;
  69867. sideOrientation?: number;
  69868. frontUVs?: Vector4;
  69869. backUVs?: Vector4;
  69870. instance?: Mesh;
  69871. invertUV?: boolean;
  69872. }, scene?: Nullable<Scene>): Mesh;
  69873. /**
  69874. * Creates a polyhedron mesh
  69875. * * 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
  69876. * * The parameter `size` (positive float, default 1) sets the polygon size
  69877. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  69878. * * 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`
  69879. * * 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
  69880. * * 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)`)
  69881. * * 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
  69882. * * 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
  69883. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69884. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69885. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69886. * @param name defines the name of the mesh
  69887. * @param options defines the options used to create the mesh
  69888. * @param scene defines the hosting scene
  69889. * @returns the polyhedron mesh
  69890. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  69891. */
  69892. static CreatePolyhedron(name: string, options: {
  69893. type?: number;
  69894. size?: number;
  69895. sizeX?: number;
  69896. sizeY?: number;
  69897. sizeZ?: number;
  69898. custom?: any;
  69899. faceUV?: Vector4[];
  69900. faceColors?: Color4[];
  69901. flat?: boolean;
  69902. updatable?: boolean;
  69903. sideOrientation?: number;
  69904. frontUVs?: Vector4;
  69905. backUVs?: Vector4;
  69906. }, scene?: Nullable<Scene>): Mesh;
  69907. /**
  69908. * Creates a decal mesh.
  69909. * 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
  69910. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  69911. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  69912. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  69913. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  69914. * @param name defines the name of the mesh
  69915. * @param sourceMesh defines the mesh where the decal must be applied
  69916. * @param options defines the options used to create the mesh
  69917. * @param scene defines the hosting scene
  69918. * @returns the decal mesh
  69919. * @see https://doc.babylonjs.com/how_to/decals
  69920. */
  69921. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  69922. position?: Vector3;
  69923. normal?: Vector3;
  69924. size?: Vector3;
  69925. angle?: number;
  69926. }): Mesh;
  69927. }
  69928. }
  69929. declare module "babylonjs/Meshes/meshSimplification" {
  69930. import { Mesh } from "babylonjs/Meshes/mesh";
  69931. /**
  69932. * A simplifier interface for future simplification implementations
  69933. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69934. */
  69935. export interface ISimplifier {
  69936. /**
  69937. * Simplification of a given mesh according to the given settings.
  69938. * Since this requires computation, it is assumed that the function runs async.
  69939. * @param settings The settings of the simplification, including quality and distance
  69940. * @param successCallback A callback that will be called after the mesh was simplified.
  69941. * @param errorCallback in case of an error, this callback will be called. optional.
  69942. */
  69943. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMeshes: Mesh) => void, errorCallback?: () => void): void;
  69944. }
  69945. /**
  69946. * Expected simplification settings.
  69947. * Quality should be between 0 and 1 (1 being 100%, 0 being 0%)
  69948. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69949. */
  69950. export interface ISimplificationSettings {
  69951. /**
  69952. * Gets or sets the expected quality
  69953. */
  69954. quality: number;
  69955. /**
  69956. * Gets or sets the distance when this optimized version should be used
  69957. */
  69958. distance: number;
  69959. /**
  69960. * Gets an already optimized mesh
  69961. */
  69962. optimizeMesh?: boolean;
  69963. }
  69964. /**
  69965. * Class used to specify simplification options
  69966. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69967. */
  69968. export class SimplificationSettings implements ISimplificationSettings {
  69969. /** expected quality */
  69970. quality: number;
  69971. /** distance when this optimized version should be used */
  69972. distance: number;
  69973. /** already optimized mesh */
  69974. optimizeMesh?: boolean | undefined;
  69975. /**
  69976. * Creates a SimplificationSettings
  69977. * @param quality expected quality
  69978. * @param distance distance when this optimized version should be used
  69979. * @param optimizeMesh already optimized mesh
  69980. */
  69981. constructor(
  69982. /** expected quality */
  69983. quality: number,
  69984. /** distance when this optimized version should be used */
  69985. distance: number,
  69986. /** already optimized mesh */
  69987. optimizeMesh?: boolean | undefined);
  69988. }
  69989. /**
  69990. * Interface used to define a simplification task
  69991. */
  69992. export interface ISimplificationTask {
  69993. /**
  69994. * Array of settings
  69995. */
  69996. settings: Array<ISimplificationSettings>;
  69997. /**
  69998. * Simplification type
  69999. */
  70000. simplificationType: SimplificationType;
  70001. /**
  70002. * Mesh to simplify
  70003. */
  70004. mesh: Mesh;
  70005. /**
  70006. * Callback called on success
  70007. */
  70008. successCallback?: () => void;
  70009. /**
  70010. * Defines if parallel processing can be used
  70011. */
  70012. parallelProcessing: boolean;
  70013. }
  70014. /**
  70015. * Queue used to order the simplification tasks
  70016. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  70017. */
  70018. export class SimplificationQueue {
  70019. private _simplificationArray;
  70020. /**
  70021. * Gets a boolean indicating that the process is still running
  70022. */
  70023. running: boolean;
  70024. /**
  70025. * Creates a new queue
  70026. */
  70027. constructor();
  70028. /**
  70029. * Adds a new simplification task
  70030. * @param task defines a task to add
  70031. */
  70032. addTask(task: ISimplificationTask): void;
  70033. /**
  70034. * Execute next task
  70035. */
  70036. executeNext(): void;
  70037. /**
  70038. * Execute a simplification task
  70039. * @param task defines the task to run
  70040. */
  70041. runSimplification(task: ISimplificationTask): void;
  70042. private getSimplifier;
  70043. }
  70044. /**
  70045. * The implemented types of simplification
  70046. * At the moment only Quadratic Error Decimation is implemented
  70047. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  70048. */
  70049. export enum SimplificationType {
  70050. /** Quadratic error decimation */
  70051. QUADRATIC = 0
  70052. }
  70053. /**
  70054. * An implementation of the Quadratic Error simplification algorithm.
  70055. * Original paper : http://www1.cs.columbia.edu/~cs4162/html05s/garland97.pdf
  70056. * Ported mostly from QSlim and http://voxels.blogspot.de/2014/05/quadric-mesh-simplification-with-source.html to babylon JS
  70057. * @author RaananW
  70058. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  70059. */
  70060. export class QuadraticErrorSimplification implements ISimplifier {
  70061. private _mesh;
  70062. private triangles;
  70063. private vertices;
  70064. private references;
  70065. private _reconstructedMesh;
  70066. /** Gets or sets the number pf sync interations */
  70067. syncIterations: number;
  70068. /** Gets or sets the aggressiveness of the simplifier */
  70069. aggressiveness: number;
  70070. /** Gets or sets the number of allowed iterations for decimation */
  70071. decimationIterations: number;
  70072. /** Gets or sets the espilon to use for bounding box computation */
  70073. boundingBoxEpsilon: number;
  70074. /**
  70075. * Creates a new QuadraticErrorSimplification
  70076. * @param _mesh defines the target mesh
  70077. */
  70078. constructor(_mesh: Mesh);
  70079. /**
  70080. * Simplification of a given mesh according to the given settings.
  70081. * Since this requires computation, it is assumed that the function runs async.
  70082. * @param settings The settings of the simplification, including quality and distance
  70083. * @param successCallback A callback that will be called after the mesh was simplified.
  70084. */
  70085. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMesh: Mesh) => void): void;
  70086. private runDecimation;
  70087. private initWithMesh;
  70088. private init;
  70089. private reconstructMesh;
  70090. private initDecimatedMesh;
  70091. private isFlipped;
  70092. private updateTriangles;
  70093. private identifyBorder;
  70094. private updateMesh;
  70095. private vertexError;
  70096. private calculateError;
  70097. }
  70098. }
  70099. declare module "babylonjs/Meshes/meshSimplificationSceneComponent" {
  70100. import { Scene } from "babylonjs/scene";
  70101. import { SimplificationQueue, ISimplificationSettings, SimplificationType } from "babylonjs/Meshes/meshSimplification";
  70102. import { ISceneComponent } from "babylonjs/sceneComponent";
  70103. module "babylonjs/scene" {
  70104. interface Scene {
  70105. /** @hidden (Backing field) */
  70106. _simplificationQueue: SimplificationQueue;
  70107. /**
  70108. * Gets or sets the simplification queue attached to the scene
  70109. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  70110. */
  70111. simplificationQueue: SimplificationQueue;
  70112. }
  70113. }
  70114. module "babylonjs/Meshes/mesh" {
  70115. interface Mesh {
  70116. /**
  70117. * Simplify the mesh according to the given array of settings.
  70118. * Function will return immediately and will simplify async
  70119. * @param settings a collection of simplification settings
  70120. * @param parallelProcessing should all levels calculate parallel or one after the other
  70121. * @param simplificationType the type of simplification to run
  70122. * @param successCallback optional success callback to be called after the simplification finished processing all settings
  70123. * @returns the current mesh
  70124. */
  70125. simplify(settings: Array<ISimplificationSettings>, parallelProcessing?: boolean, simplificationType?: SimplificationType, successCallback?: (mesh?: Mesh, submeshIndex?: number) => void): Mesh;
  70126. }
  70127. }
  70128. /**
  70129. * Defines the simplification queue scene component responsible to help scheduling the various simplification task
  70130. * created in a scene
  70131. */
  70132. export class SimplicationQueueSceneComponent implements ISceneComponent {
  70133. /**
  70134. * The component name helpfull to identify the component in the list of scene components.
  70135. */
  70136. readonly name: string;
  70137. /**
  70138. * The scene the component belongs to.
  70139. */
  70140. scene: Scene;
  70141. /**
  70142. * Creates a new instance of the component for the given scene
  70143. * @param scene Defines the scene to register the component in
  70144. */
  70145. constructor(scene: Scene);
  70146. /**
  70147. * Registers the component in a given scene
  70148. */
  70149. register(): void;
  70150. /**
  70151. * Rebuilds the elements related to this component in case of
  70152. * context lost for instance.
  70153. */
  70154. rebuild(): void;
  70155. /**
  70156. * Disposes the component and the associated ressources
  70157. */
  70158. dispose(): void;
  70159. private _beforeCameraUpdate;
  70160. }
  70161. }
  70162. declare module "babylonjs/Meshes/Builders/index" {
  70163. export * from "babylonjs/Meshes/Builders/boxBuilder";
  70164. export * from "babylonjs/Meshes/Builders/tiledBoxBuilder";
  70165. export * from "babylonjs/Meshes/Builders/discBuilder";
  70166. export * from "babylonjs/Meshes/Builders/ribbonBuilder";
  70167. export * from "babylonjs/Meshes/Builders/sphereBuilder";
  70168. export * from "babylonjs/Meshes/Builders/hemisphereBuilder";
  70169. export * from "babylonjs/Meshes/Builders/cylinderBuilder";
  70170. export * from "babylonjs/Meshes/Builders/torusBuilder";
  70171. export * from "babylonjs/Meshes/Builders/torusKnotBuilder";
  70172. export * from "babylonjs/Meshes/Builders/linesBuilder";
  70173. export * from "babylonjs/Meshes/Builders/polygonBuilder";
  70174. export * from "babylonjs/Meshes/Builders/shapeBuilder";
  70175. export * from "babylonjs/Meshes/Builders/latheBuilder";
  70176. export * from "babylonjs/Meshes/Builders/planeBuilder";
  70177. export * from "babylonjs/Meshes/Builders/tiledPlaneBuilder";
  70178. export * from "babylonjs/Meshes/Builders/groundBuilder";
  70179. export * from "babylonjs/Meshes/Builders/tubeBuilder";
  70180. export * from "babylonjs/Meshes/Builders/polyhedronBuilder";
  70181. export * from "babylonjs/Meshes/Builders/icoSphereBuilder";
  70182. export * from "babylonjs/Meshes/Builders/decalBuilder";
  70183. }
  70184. declare module "babylonjs/Meshes/thinInstanceMesh" {
  70185. import { Nullable, DeepImmutableObject } from "babylonjs/types";
  70186. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  70187. import { Matrix } from "babylonjs/Maths/math.vector";
  70188. module "babylonjs/Meshes/mesh" {
  70189. interface Mesh {
  70190. /**
  70191. * Gets or sets a boolean defining if we want picking to pick thin instances as well
  70192. */
  70193. thinInstanceEnablePicking: boolean;
  70194. /**
  70195. * Creates a new thin instance
  70196. * @param matrix the matrix or array of matrices (position, rotation, scale) of the thin instance(s) to create
  70197. * @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
  70198. * @returns the thin instance index number. If you pass an array of matrices, other instance indexes are index+1, index+2, etc
  70199. */
  70200. thinInstanceAdd(matrix: DeepImmutableObject<Matrix> | Array<DeepImmutableObject<Matrix>>, refresh: boolean): number;
  70201. /**
  70202. * Adds the transformation (matrix) of the current mesh as a thin instance
  70203. * @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
  70204. * @returns the thin instance index number
  70205. */
  70206. thinInstanceAddSelf(refresh: boolean): number;
  70207. /**
  70208. * Registers a custom attribute to be used with thin instances
  70209. * @param kind name of the attribute
  70210. * @param stride size in floats of the attribute
  70211. */
  70212. thinInstanceRegisterAttribute(kind: string, stride: number): void;
  70213. /**
  70214. * Sets the matrix of a thin instance
  70215. * @param index index of the thin instance
  70216. * @param matrix matrix to set
  70217. * @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
  70218. */
  70219. thinInstanceSetMatrixAt(index: number, matrix: DeepImmutableObject<Matrix>, refresh: boolean): void;
  70220. /**
  70221. * Sets the value of a custom attribute for a thin instance
  70222. * @param kind name of the attribute
  70223. * @param index index of the thin instance
  70224. * @param value value to set
  70225. * @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
  70226. */
  70227. thinInstanceSetAttributeAt(kind: string, index: number, value: Array<number>, refresh: boolean): void;
  70228. /**
  70229. * 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.
  70230. */
  70231. thinInstanceCount: number;
  70232. /**
  70233. * Sets a buffer to be used with thin instances. This method is a faster way to setup multiple instances than calling thinInstanceAdd repeatedly
  70234. * @param kind name of the attribute. Use "matrix" to setup the buffer of matrices
  70235. * @param buffer buffer to set
  70236. * @param stride size in floats of each value of the buffer
  70237. * @param staticBuffer indicates that the buffer is static, so that you won't change it after it is set (better performances - false by default)
  70238. */
  70239. thinInstanceSetBuffer(kind: string, buffer: Nullable<Float32Array>, stride: number, staticBuffer: boolean): void;
  70240. /**
  70241. * Gets the list of world matrices
  70242. * @return an array containing all the world matrices from the thin instances
  70243. */
  70244. thinInstanceGetWorldMatrices(): Matrix[];
  70245. /**
  70246. * Synchronize the gpu buffers with a thin instance buffer. Call this method if you update later on the buffers passed to thinInstanceSetBuffer
  70247. * @param kind name of the attribute to update. Use "matrix" to update the buffer of matrices
  70248. */
  70249. thinInstanceBufferUpdated(kind: string): void;
  70250. /**
  70251. * Applies a partial update to a buffer directly on the GPU
  70252. * Note that the buffer located on the CPU is NOT updated! It's up to you to update it (or not) with the same data you pass to this method
  70253. * @param kind name of the attribute to update. Use "matrix" to update the buffer of matrices
  70254. * @param data the data to set in the GPU buffer
  70255. * @param offset the offset in the GPU buffer where to update the data
  70256. */
  70257. thinInstancePartialBufferUpdate(kind: string, data: Float32Array, offset: number): void;
  70258. /**
  70259. * Refreshes the bounding info, taking into account all the thin instances defined
  70260. * @param forceRefreshParentInfo true to force recomputing the mesh bounding info and use it to compute the aggregated bounding info
  70261. */
  70262. thinInstanceRefreshBoundingInfo(forceRefreshParentInfo: boolean): void;
  70263. /** @hidden */
  70264. _thinInstanceInitializeUserStorage(): void;
  70265. /** @hidden */
  70266. _thinInstanceUpdateBufferSize(kind: string, numInstances: number): void;
  70267. /** @hidden */
  70268. _userThinInstanceBuffersStorage: {
  70269. data: {
  70270. [key: string]: Float32Array;
  70271. };
  70272. sizes: {
  70273. [key: string]: number;
  70274. };
  70275. vertexBuffers: {
  70276. [key: string]: Nullable<VertexBuffer>;
  70277. };
  70278. strides: {
  70279. [key: string]: number;
  70280. };
  70281. };
  70282. }
  70283. }
  70284. }
  70285. declare module "babylonjs/Meshes/index" {
  70286. export * from "babylonjs/Meshes/abstractMesh";
  70287. export * from "babylonjs/Meshes/buffer";
  70288. export * from "babylonjs/Meshes/Compression/index";
  70289. export * from "babylonjs/Meshes/csg";
  70290. export * from "babylonjs/Meshes/geometry";
  70291. export * from "babylonjs/Meshes/groundMesh";
  70292. export * from "babylonjs/Meshes/trailMesh";
  70293. export * from "babylonjs/Meshes/instancedMesh";
  70294. export * from "babylonjs/Meshes/linesMesh";
  70295. export * from "babylonjs/Meshes/mesh";
  70296. export * from "babylonjs/Meshes/mesh.vertexData";
  70297. export * from "babylonjs/Meshes/meshBuilder";
  70298. export * from "babylonjs/Meshes/meshSimplification";
  70299. export * from "babylonjs/Meshes/meshSimplificationSceneComponent";
  70300. export * from "babylonjs/Meshes/polygonMesh";
  70301. export * from "babylonjs/Meshes/subMesh";
  70302. export * from "babylonjs/Meshes/meshLODLevel";
  70303. export * from "babylonjs/Meshes/transformNode";
  70304. export * from "babylonjs/Meshes/Builders/index";
  70305. export * from "babylonjs/Meshes/dataBuffer";
  70306. export * from "babylonjs/Meshes/WebGL/webGLDataBuffer";
  70307. import "babylonjs/Meshes/thinInstanceMesh";
  70308. export * from "babylonjs/Meshes/thinInstanceMesh";
  70309. }
  70310. declare module "babylonjs/Morph/index" {
  70311. export * from "babylonjs/Morph/morphTarget";
  70312. export * from "babylonjs/Morph/morphTargetManager";
  70313. }
  70314. declare module "babylonjs/Navigation/INavigationEngine" {
  70315. import { TransformNode } from "babylonjs/Meshes/transformNode";
  70316. import { Vector3 } from "babylonjs/Maths/math";
  70317. import { Mesh } from "babylonjs/Meshes/mesh";
  70318. import { Scene } from "babylonjs/scene";
  70319. /**
  70320. * Navigation plugin interface to add navigation constrained by a navigation mesh
  70321. */
  70322. export interface INavigationEnginePlugin {
  70323. /**
  70324. * plugin name
  70325. */
  70326. name: string;
  70327. /**
  70328. * Creates a navigation mesh
  70329. * @param meshes array of all the geometry used to compute the navigatio mesh
  70330. * @param parameters bunch of parameters used to filter geometry
  70331. */
  70332. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  70333. /**
  70334. * Create a navigation mesh debug mesh
  70335. * @param scene is where the mesh will be added
  70336. * @returns debug display mesh
  70337. */
  70338. createDebugNavMesh(scene: Scene): Mesh;
  70339. /**
  70340. * Get a navigation mesh constrained position, closest to the parameter position
  70341. * @param position world position
  70342. * @returns the closest point to position constrained by the navigation mesh
  70343. */
  70344. getClosestPoint(position: Vector3): Vector3;
  70345. /**
  70346. * Get a navigation mesh constrained position, closest to the parameter position
  70347. * @param position world position
  70348. * @param result output the closest point to position constrained by the navigation mesh
  70349. */
  70350. getClosestPointToRef(position: Vector3, result: Vector3): void;
  70351. /**
  70352. * Get a navigation mesh constrained position, within a particular radius
  70353. * @param position world position
  70354. * @param maxRadius the maximum distance to the constrained world position
  70355. * @returns the closest point to position constrained by the navigation mesh
  70356. */
  70357. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  70358. /**
  70359. * Get a navigation mesh constrained position, within a particular radius
  70360. * @param position world position
  70361. * @param maxRadius the maximum distance to the constrained world position
  70362. * @param result output the closest point to position constrained by the navigation mesh
  70363. */
  70364. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  70365. /**
  70366. * Compute the final position from a segment made of destination-position
  70367. * @param position world position
  70368. * @param destination world position
  70369. * @returns the resulting point along the navmesh
  70370. */
  70371. moveAlong(position: Vector3, destination: Vector3): Vector3;
  70372. /**
  70373. * Compute the final position from a segment made of destination-position
  70374. * @param position world position
  70375. * @param destination world position
  70376. * @param result output the resulting point along the navmesh
  70377. */
  70378. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  70379. /**
  70380. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  70381. * @param start world position
  70382. * @param end world position
  70383. * @returns array containing world position composing the path
  70384. */
  70385. computePath(start: Vector3, end: Vector3): Vector3[];
  70386. /**
  70387. * If this plugin is supported
  70388. * @returns true if plugin is supported
  70389. */
  70390. isSupported(): boolean;
  70391. /**
  70392. * Create a new Crowd so you can add agents
  70393. * @param maxAgents the maximum agent count in the crowd
  70394. * @param maxAgentRadius the maximum radius an agent can have
  70395. * @param scene to attach the crowd to
  70396. * @returns the crowd you can add agents to
  70397. */
  70398. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  70399. /**
  70400. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  70401. * The queries will try to find a solution within those bounds
  70402. * default is (1,1,1)
  70403. * @param extent x,y,z value that define the extent around the queries point of reference
  70404. */
  70405. setDefaultQueryExtent(extent: Vector3): void;
  70406. /**
  70407. * Get the Bounding box extent specified by setDefaultQueryExtent
  70408. * @returns the box extent values
  70409. */
  70410. getDefaultQueryExtent(): Vector3;
  70411. /**
  70412. * build the navmesh from a previously saved state using getNavmeshData
  70413. * @param data the Uint8Array returned by getNavmeshData
  70414. */
  70415. buildFromNavmeshData(data: Uint8Array): void;
  70416. /**
  70417. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  70418. * @returns data the Uint8Array that can be saved and reused
  70419. */
  70420. getNavmeshData(): Uint8Array;
  70421. /**
  70422. * Get the Bounding box extent result specified by setDefaultQueryExtent
  70423. * @param result output the box extent values
  70424. */
  70425. getDefaultQueryExtentToRef(result: Vector3): void;
  70426. /**
  70427. * Release all resources
  70428. */
  70429. dispose(): void;
  70430. }
  70431. /**
  70432. * Crowd Interface. A Crowd is a collection of moving agents constrained by a navigation mesh
  70433. */
  70434. export interface ICrowd {
  70435. /**
  70436. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  70437. * You can attach anything to that node. The node position is updated in the scene update tick.
  70438. * @param pos world position that will be constrained by the navigation mesh
  70439. * @param parameters agent parameters
  70440. * @param transform hooked to the agent that will be update by the scene
  70441. * @returns agent index
  70442. */
  70443. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  70444. /**
  70445. * Returns the agent position in world space
  70446. * @param index agent index returned by addAgent
  70447. * @returns world space position
  70448. */
  70449. getAgentPosition(index: number): Vector3;
  70450. /**
  70451. * Gets the agent position result in world space
  70452. * @param index agent index returned by addAgent
  70453. * @param result output world space position
  70454. */
  70455. getAgentPositionToRef(index: number, result: Vector3): void;
  70456. /**
  70457. * Gets the agent velocity in world space
  70458. * @param index agent index returned by addAgent
  70459. * @returns world space velocity
  70460. */
  70461. getAgentVelocity(index: number): Vector3;
  70462. /**
  70463. * Gets the agent velocity result in world space
  70464. * @param index agent index returned by addAgent
  70465. * @param result output world space velocity
  70466. */
  70467. getAgentVelocityToRef(index: number, result: Vector3): void;
  70468. /**
  70469. * remove a particular agent previously created
  70470. * @param index agent index returned by addAgent
  70471. */
  70472. removeAgent(index: number): void;
  70473. /**
  70474. * get the list of all agents attached to this crowd
  70475. * @returns list of agent indices
  70476. */
  70477. getAgents(): number[];
  70478. /**
  70479. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  70480. * @param deltaTime in seconds
  70481. */
  70482. update(deltaTime: number): void;
  70483. /**
  70484. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  70485. * @param index agent index returned by addAgent
  70486. * @param destination targeted world position
  70487. */
  70488. agentGoto(index: number, destination: Vector3): void;
  70489. /**
  70490. * Teleport the agent to a new position
  70491. * @param index agent index returned by addAgent
  70492. * @param destination targeted world position
  70493. */
  70494. agentTeleport(index: number, destination: Vector3): void;
  70495. /**
  70496. * Update agent parameters
  70497. * @param index agent index returned by addAgent
  70498. * @param parameters agent parameters
  70499. */
  70500. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  70501. /**
  70502. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  70503. * The queries will try to find a solution within those bounds
  70504. * default is (1,1,1)
  70505. * @param extent x,y,z value that define the extent around the queries point of reference
  70506. */
  70507. setDefaultQueryExtent(extent: Vector3): void;
  70508. /**
  70509. * Get the Bounding box extent specified by setDefaultQueryExtent
  70510. * @returns the box extent values
  70511. */
  70512. getDefaultQueryExtent(): Vector3;
  70513. /**
  70514. * Get the Bounding box extent result specified by setDefaultQueryExtent
  70515. * @param result output the box extent values
  70516. */
  70517. getDefaultQueryExtentToRef(result: Vector3): void;
  70518. /**
  70519. * Release all resources
  70520. */
  70521. dispose(): void;
  70522. }
  70523. /**
  70524. * Configures an agent
  70525. */
  70526. export interface IAgentParameters {
  70527. /**
  70528. * Agent radius. [Limit: >= 0]
  70529. */
  70530. radius: number;
  70531. /**
  70532. * Agent height. [Limit: > 0]
  70533. */
  70534. height: number;
  70535. /**
  70536. * Maximum allowed acceleration. [Limit: >= 0]
  70537. */
  70538. maxAcceleration: number;
  70539. /**
  70540. * Maximum allowed speed. [Limit: >= 0]
  70541. */
  70542. maxSpeed: number;
  70543. /**
  70544. * Defines how close a collision element must be before it is considered for steering behaviors. [Limits: > 0]
  70545. */
  70546. collisionQueryRange: number;
  70547. /**
  70548. * The path visibility optimization range. [Limit: > 0]
  70549. */
  70550. pathOptimizationRange: number;
  70551. /**
  70552. * How aggresive the agent manager should be at avoiding collisions with this agent. [Limit: >= 0]
  70553. */
  70554. separationWeight: number;
  70555. }
  70556. /**
  70557. * Configures the navigation mesh creation
  70558. */
  70559. export interface INavMeshParameters {
  70560. /**
  70561. * The xz-plane cell size to use for fields. [Limit: > 0] [Units: wu]
  70562. */
  70563. cs: number;
  70564. /**
  70565. * The y-axis cell size to use for fields. [Limit: > 0] [Units: wu]
  70566. */
  70567. ch: number;
  70568. /**
  70569. * The maximum slope that is considered walkable. [Limits: 0 <= value < 90] [Units: Degrees]
  70570. */
  70571. walkableSlopeAngle: number;
  70572. /**
  70573. * Minimum floor to 'ceiling' height that will still allow the floor area to
  70574. * be considered walkable. [Limit: >= 3] [Units: vx]
  70575. */
  70576. walkableHeight: number;
  70577. /**
  70578. * Maximum ledge height that is considered to still be traversable. [Limit: >=0] [Units: vx]
  70579. */
  70580. walkableClimb: number;
  70581. /**
  70582. * The distance to erode/shrink the walkable area of the heightfield away from
  70583. * obstructions. [Limit: >=0] [Units: vx]
  70584. */
  70585. walkableRadius: number;
  70586. /**
  70587. * The maximum allowed length for contour edges along the border of the mesh. [Limit: >=0] [Units: vx]
  70588. */
  70589. maxEdgeLen: number;
  70590. /**
  70591. * The maximum distance a simplfied contour's border edges should deviate
  70592. * the original raw contour. [Limit: >=0] [Units: vx]
  70593. */
  70594. maxSimplificationError: number;
  70595. /**
  70596. * The minimum number of cells allowed to form isolated island areas. [Limit: >=0] [Units: vx]
  70597. */
  70598. minRegionArea: number;
  70599. /**
  70600. * Any regions with a span count smaller than this value will, if possible,
  70601. * be merged with larger regions. [Limit: >=0] [Units: vx]
  70602. */
  70603. mergeRegionArea: number;
  70604. /**
  70605. * The maximum number of vertices allowed for polygons generated during the
  70606. * contour to polygon conversion process. [Limit: >= 3]
  70607. */
  70608. maxVertsPerPoly: number;
  70609. /**
  70610. * Sets the sampling distance to use when generating the detail mesh.
  70611. * (For height detail only.) [Limits: 0 or >= 0.9] [Units: wu]
  70612. */
  70613. detailSampleDist: number;
  70614. /**
  70615. * The maximum distance the detail mesh surface should deviate from heightfield
  70616. * data. (For height detail only.) [Limit: >=0] [Units: wu]
  70617. */
  70618. detailSampleMaxError: number;
  70619. }
  70620. }
  70621. declare module "babylonjs/Navigation/Plugins/recastJSPlugin" {
  70622. import { INavigationEnginePlugin, ICrowd, IAgentParameters, INavMeshParameters } from "babylonjs/Navigation/INavigationEngine";
  70623. import { Mesh } from "babylonjs/Meshes/mesh";
  70624. import { Scene } from "babylonjs/scene";
  70625. import { Vector3 } from "babylonjs/Maths/math";
  70626. import { TransformNode } from "babylonjs/Meshes/transformNode";
  70627. /**
  70628. * RecastJS navigation plugin
  70629. */
  70630. export class RecastJSPlugin implements INavigationEnginePlugin {
  70631. /**
  70632. * Reference to the Recast library
  70633. */
  70634. bjsRECAST: any;
  70635. /**
  70636. * plugin name
  70637. */
  70638. name: string;
  70639. /**
  70640. * the first navmesh created. We might extend this to support multiple navmeshes
  70641. */
  70642. navMesh: any;
  70643. /**
  70644. * Initializes the recastJS plugin
  70645. * @param recastInjection can be used to inject your own recast reference
  70646. */
  70647. constructor(recastInjection?: any);
  70648. /**
  70649. * Creates a navigation mesh
  70650. * @param meshes array of all the geometry used to compute the navigatio mesh
  70651. * @param parameters bunch of parameters used to filter geometry
  70652. */
  70653. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  70654. /**
  70655. * Create a navigation mesh debug mesh
  70656. * @param scene is where the mesh will be added
  70657. * @returns debug display mesh
  70658. */
  70659. createDebugNavMesh(scene: Scene): Mesh;
  70660. /**
  70661. * Get a navigation mesh constrained position, closest to the parameter position
  70662. * @param position world position
  70663. * @returns the closest point to position constrained by the navigation mesh
  70664. */
  70665. getClosestPoint(position: Vector3): Vector3;
  70666. /**
  70667. * Get a navigation mesh constrained position, closest to the parameter position
  70668. * @param position world position
  70669. * @param result output the closest point to position constrained by the navigation mesh
  70670. */
  70671. getClosestPointToRef(position: Vector3, result: Vector3): void;
  70672. /**
  70673. * Get a navigation mesh constrained position, within a particular radius
  70674. * @param position world position
  70675. * @param maxRadius the maximum distance to the constrained world position
  70676. * @returns the closest point to position constrained by the navigation mesh
  70677. */
  70678. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  70679. /**
  70680. * Get a navigation mesh constrained position, within a particular radius
  70681. * @param position world position
  70682. * @param maxRadius the maximum distance to the constrained world position
  70683. * @param result output the closest point to position constrained by the navigation mesh
  70684. */
  70685. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  70686. /**
  70687. * Compute the final position from a segment made of destination-position
  70688. * @param position world position
  70689. * @param destination world position
  70690. * @returns the resulting point along the navmesh
  70691. */
  70692. moveAlong(position: Vector3, destination: Vector3): Vector3;
  70693. /**
  70694. * Compute the final position from a segment made of destination-position
  70695. * @param position world position
  70696. * @param destination world position
  70697. * @param result output the resulting point along the navmesh
  70698. */
  70699. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  70700. /**
  70701. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  70702. * @param start world position
  70703. * @param end world position
  70704. * @returns array containing world position composing the path
  70705. */
  70706. computePath(start: Vector3, end: Vector3): Vector3[];
  70707. /**
  70708. * Create a new Crowd so you can add agents
  70709. * @param maxAgents the maximum agent count in the crowd
  70710. * @param maxAgentRadius the maximum radius an agent can have
  70711. * @param scene to attach the crowd to
  70712. * @returns the crowd you can add agents to
  70713. */
  70714. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  70715. /**
  70716. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  70717. * The queries will try to find a solution within those bounds
  70718. * default is (1,1,1)
  70719. * @param extent x,y,z value that define the extent around the queries point of reference
  70720. */
  70721. setDefaultQueryExtent(extent: Vector3): void;
  70722. /**
  70723. * Get the Bounding box extent specified by setDefaultQueryExtent
  70724. * @returns the box extent values
  70725. */
  70726. getDefaultQueryExtent(): Vector3;
  70727. /**
  70728. * build the navmesh from a previously saved state using getNavmeshData
  70729. * @param data the Uint8Array returned by getNavmeshData
  70730. */
  70731. buildFromNavmeshData(data: Uint8Array): void;
  70732. /**
  70733. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  70734. * @returns data the Uint8Array that can be saved and reused
  70735. */
  70736. getNavmeshData(): Uint8Array;
  70737. /**
  70738. * Get the Bounding box extent result specified by setDefaultQueryExtent
  70739. * @param result output the box extent values
  70740. */
  70741. getDefaultQueryExtentToRef(result: Vector3): void;
  70742. /**
  70743. * Disposes
  70744. */
  70745. dispose(): void;
  70746. /**
  70747. * If this plugin is supported
  70748. * @returns true if plugin is supported
  70749. */
  70750. isSupported(): boolean;
  70751. }
  70752. /**
  70753. * Recast detour crowd implementation
  70754. */
  70755. export class RecastJSCrowd implements ICrowd {
  70756. /**
  70757. * Recast/detour plugin
  70758. */
  70759. bjsRECASTPlugin: RecastJSPlugin;
  70760. /**
  70761. * Link to the detour crowd
  70762. */
  70763. recastCrowd: any;
  70764. /**
  70765. * One transform per agent
  70766. */
  70767. transforms: TransformNode[];
  70768. /**
  70769. * All agents created
  70770. */
  70771. agents: number[];
  70772. /**
  70773. * Link to the scene is kept to unregister the crowd from the scene
  70774. */
  70775. private _scene;
  70776. /**
  70777. * Observer for crowd updates
  70778. */
  70779. private _onBeforeAnimationsObserver;
  70780. /**
  70781. * Constructor
  70782. * @param plugin recastJS plugin
  70783. * @param maxAgents the maximum agent count in the crowd
  70784. * @param maxAgentRadius the maximum radius an agent can have
  70785. * @param scene to attach the crowd to
  70786. * @returns the crowd you can add agents to
  70787. */
  70788. constructor(plugin: RecastJSPlugin, maxAgents: number, maxAgentRadius: number, scene: Scene);
  70789. /**
  70790. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  70791. * You can attach anything to that node. The node position is updated in the scene update tick.
  70792. * @param pos world position that will be constrained by the navigation mesh
  70793. * @param parameters agent parameters
  70794. * @param transform hooked to the agent that will be update by the scene
  70795. * @returns agent index
  70796. */
  70797. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  70798. /**
  70799. * Returns the agent position in world space
  70800. * @param index agent index returned by addAgent
  70801. * @returns world space position
  70802. */
  70803. getAgentPosition(index: number): Vector3;
  70804. /**
  70805. * Returns the agent position result in world space
  70806. * @param index agent index returned by addAgent
  70807. * @param result output world space position
  70808. */
  70809. getAgentPositionToRef(index: number, result: Vector3): void;
  70810. /**
  70811. * Returns the agent velocity in world space
  70812. * @param index agent index returned by addAgent
  70813. * @returns world space velocity
  70814. */
  70815. getAgentVelocity(index: number): Vector3;
  70816. /**
  70817. * Returns the agent velocity result in world space
  70818. * @param index agent index returned by addAgent
  70819. * @param result output world space velocity
  70820. */
  70821. getAgentVelocityToRef(index: number, result: Vector3): void;
  70822. /**
  70823. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  70824. * @param index agent index returned by addAgent
  70825. * @param destination targeted world position
  70826. */
  70827. agentGoto(index: number, destination: Vector3): void;
  70828. /**
  70829. * Teleport the agent to a new position
  70830. * @param index agent index returned by addAgent
  70831. * @param destination targeted world position
  70832. */
  70833. agentTeleport(index: number, destination: Vector3): void;
  70834. /**
  70835. * Update agent parameters
  70836. * @param index agent index returned by addAgent
  70837. * @param parameters agent parameters
  70838. */
  70839. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  70840. /**
  70841. * remove a particular agent previously created
  70842. * @param index agent index returned by addAgent
  70843. */
  70844. removeAgent(index: number): void;
  70845. /**
  70846. * get the list of all agents attached to this crowd
  70847. * @returns list of agent indices
  70848. */
  70849. getAgents(): number[];
  70850. /**
  70851. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  70852. * @param deltaTime in seconds
  70853. */
  70854. update(deltaTime: number): void;
  70855. /**
  70856. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  70857. * The queries will try to find a solution within those bounds
  70858. * default is (1,1,1)
  70859. * @param extent x,y,z value that define the extent around the queries point of reference
  70860. */
  70861. setDefaultQueryExtent(extent: Vector3): void;
  70862. /**
  70863. * Get the Bounding box extent specified by setDefaultQueryExtent
  70864. * @returns the box extent values
  70865. */
  70866. getDefaultQueryExtent(): Vector3;
  70867. /**
  70868. * Get the Bounding box extent result specified by setDefaultQueryExtent
  70869. * @param result output the box extent values
  70870. */
  70871. getDefaultQueryExtentToRef(result: Vector3): void;
  70872. /**
  70873. * Release all resources
  70874. */
  70875. dispose(): void;
  70876. }
  70877. }
  70878. declare module "babylonjs/Navigation/Plugins/index" {
  70879. export * from "babylonjs/Navigation/Plugins/recastJSPlugin";
  70880. }
  70881. declare module "babylonjs/Navigation/index" {
  70882. export * from "babylonjs/Navigation/INavigationEngine";
  70883. export * from "babylonjs/Navigation/Plugins/index";
  70884. }
  70885. declare module "babylonjs/Offline/database" {
  70886. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  70887. /**
  70888. * Class used to enable access to IndexedDB
  70889. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  70890. */
  70891. export class Database implements IOfflineProvider {
  70892. private _callbackManifestChecked;
  70893. private _currentSceneUrl;
  70894. private _db;
  70895. private _enableSceneOffline;
  70896. private _enableTexturesOffline;
  70897. private _manifestVersionFound;
  70898. private _mustUpdateRessources;
  70899. private _hasReachedQuota;
  70900. private _isSupported;
  70901. private _idbFactory;
  70902. /** Gets a boolean indicating if the user agent supports blob storage (this value will be updated after creating the first Database object) */
  70903. private static IsUASupportingBlobStorage;
  70904. /**
  70905. * Gets a boolean indicating if Database storate is enabled (off by default)
  70906. */
  70907. static IDBStorageEnabled: boolean;
  70908. /**
  70909. * Gets a boolean indicating if scene must be saved in the database
  70910. */
  70911. get enableSceneOffline(): boolean;
  70912. /**
  70913. * Gets a boolean indicating if textures must be saved in the database
  70914. */
  70915. get enableTexturesOffline(): boolean;
  70916. /**
  70917. * Creates a new Database
  70918. * @param urlToScene defines the url to load the scene
  70919. * @param callbackManifestChecked defines the callback to use when manifest is checked
  70920. * @param disableManifestCheck defines a boolean indicating that we want to skip the manifest validation (it will be considered validated and up to date)
  70921. */
  70922. constructor(urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck?: boolean);
  70923. private static _ParseURL;
  70924. private static _ReturnFullUrlLocation;
  70925. private _checkManifestFile;
  70926. /**
  70927. * Open the database and make it available
  70928. * @param successCallback defines the callback to call on success
  70929. * @param errorCallback defines the callback to call on error
  70930. */
  70931. open(successCallback: () => void, errorCallback: () => void): void;
  70932. /**
  70933. * Loads an image from the database
  70934. * @param url defines the url to load from
  70935. * @param image defines the target DOM image
  70936. */
  70937. loadImage(url: string, image: HTMLImageElement): void;
  70938. private _loadImageFromDBAsync;
  70939. private _saveImageIntoDBAsync;
  70940. private _checkVersionFromDB;
  70941. private _loadVersionFromDBAsync;
  70942. private _saveVersionIntoDBAsync;
  70943. /**
  70944. * Loads a file from database
  70945. * @param url defines the URL to load from
  70946. * @param sceneLoaded defines a callback to call on success
  70947. * @param progressCallBack defines a callback to call when progress changed
  70948. * @param errorCallback defines a callback to call on error
  70949. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  70950. */
  70951. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  70952. private _loadFileAsync;
  70953. private _saveFileAsync;
  70954. /**
  70955. * Validates if xhr data is correct
  70956. * @param xhr defines the request to validate
  70957. * @param dataType defines the expected data type
  70958. * @returns true if data is correct
  70959. */
  70960. private static _ValidateXHRData;
  70961. }
  70962. }
  70963. declare module "babylonjs/Offline/index" {
  70964. export * from "babylonjs/Offline/database";
  70965. export * from "babylonjs/Offline/IOfflineProvider";
  70966. }
  70967. declare module "babylonjs/Shaders/gpuUpdateParticles.fragment" {
  70968. /** @hidden */
  70969. export var gpuUpdateParticlesPixelShader: {
  70970. name: string;
  70971. shader: string;
  70972. };
  70973. }
  70974. declare module "babylonjs/Shaders/gpuUpdateParticles.vertex" {
  70975. /** @hidden */
  70976. export var gpuUpdateParticlesVertexShader: {
  70977. name: string;
  70978. shader: string;
  70979. };
  70980. }
  70981. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration2" {
  70982. /** @hidden */
  70983. export var clipPlaneFragmentDeclaration2: {
  70984. name: string;
  70985. shader: string;
  70986. };
  70987. }
  70988. declare module "babylonjs/Shaders/gpuRenderParticles.fragment" {
  70989. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration2";
  70990. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  70991. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  70992. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  70993. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  70994. /** @hidden */
  70995. export var gpuRenderParticlesPixelShader: {
  70996. name: string;
  70997. shader: string;
  70998. };
  70999. }
  71000. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration2" {
  71001. /** @hidden */
  71002. export var clipPlaneVertexDeclaration2: {
  71003. name: string;
  71004. shader: string;
  71005. };
  71006. }
  71007. declare module "babylonjs/Shaders/gpuRenderParticles.vertex" {
  71008. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration2";
  71009. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  71010. /** @hidden */
  71011. export var gpuRenderParticlesVertexShader: {
  71012. name: string;
  71013. shader: string;
  71014. };
  71015. }
  71016. declare module "babylonjs/Particles/gpuParticleSystem" {
  71017. import { Nullable } from "babylonjs/types";
  71018. import { Color3Gradient, IValueGradient } from "babylonjs/Misc/gradients";
  71019. import { Observable } from "babylonjs/Misc/observable";
  71020. import { Matrix } from "babylonjs/Maths/math.vector";
  71021. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  71022. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  71023. import { BaseParticleSystem } from "babylonjs/Particles/baseParticleSystem";
  71024. import { IDisposable } from "babylonjs/scene";
  71025. import { Effect } from "babylonjs/Materials/effect";
  71026. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  71027. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  71028. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  71029. import { Scene } from "babylonjs/scene";
  71030. import "babylonjs/Shaders/gpuUpdateParticles.fragment";
  71031. import "babylonjs/Shaders/gpuUpdateParticles.vertex";
  71032. import "babylonjs/Shaders/gpuRenderParticles.fragment";
  71033. import "babylonjs/Shaders/gpuRenderParticles.vertex";
  71034. /**
  71035. * This represents a GPU particle system in Babylon
  71036. * This is the fastest particle system in Babylon as it uses the GPU to update the individual particle data
  71037. * @see https://www.babylonjs-playground.com/#PU4WYI#4
  71038. */
  71039. export class GPUParticleSystem extends BaseParticleSystem implements IDisposable, IParticleSystem, IAnimatable {
  71040. /**
  71041. * The layer mask we are rendering the particles through.
  71042. */
  71043. layerMask: number;
  71044. private _capacity;
  71045. private _activeCount;
  71046. private _currentActiveCount;
  71047. private _accumulatedCount;
  71048. private _renderEffect;
  71049. private _updateEffect;
  71050. private _buffer0;
  71051. private _buffer1;
  71052. private _spriteBuffer;
  71053. private _updateVAO;
  71054. private _renderVAO;
  71055. private _targetIndex;
  71056. private _sourceBuffer;
  71057. private _targetBuffer;
  71058. private _currentRenderId;
  71059. private _started;
  71060. private _stopped;
  71061. private _timeDelta;
  71062. private _randomTexture;
  71063. private _randomTexture2;
  71064. private _attributesStrideSize;
  71065. private _updateEffectOptions;
  71066. private _randomTextureSize;
  71067. private _actualFrame;
  71068. private _customEffect;
  71069. private readonly _rawTextureWidth;
  71070. /**
  71071. * Gets a boolean indicating if the GPU particles can be rendered on current browser
  71072. */
  71073. static get IsSupported(): boolean;
  71074. /**
  71075. * An event triggered when the system is disposed.
  71076. */
  71077. onDisposeObservable: Observable<IParticleSystem>;
  71078. /**
  71079. * Gets the maximum number of particles active at the same time.
  71080. * @returns The max number of active particles.
  71081. */
  71082. getCapacity(): number;
  71083. /**
  71084. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  71085. * to override the particles.
  71086. */
  71087. forceDepthWrite: boolean;
  71088. /**
  71089. * Gets or set the number of active particles
  71090. */
  71091. get activeParticleCount(): number;
  71092. set activeParticleCount(value: number);
  71093. private _preWarmDone;
  71094. /**
  71095. * Specifies if the particles are updated in emitter local space or world space.
  71096. */
  71097. isLocal: boolean;
  71098. /** Gets or sets a matrix to use to compute projection */
  71099. defaultProjectionMatrix: Matrix;
  71100. /**
  71101. * Is this system ready to be used/rendered
  71102. * @return true if the system is ready
  71103. */
  71104. isReady(): boolean;
  71105. /**
  71106. * Gets if the system has been started. (Note: this will still be true after stop is called)
  71107. * @returns True if it has been started, otherwise false.
  71108. */
  71109. isStarted(): boolean;
  71110. /**
  71111. * Gets if the system has been stopped. (Note: rendering is still happening but the system is frozen)
  71112. * @returns True if it has been stopped, otherwise false.
  71113. */
  71114. isStopped(): boolean;
  71115. /**
  71116. * Gets a boolean indicating that the system is stopping
  71117. * @returns true if the system is currently stopping
  71118. */
  71119. isStopping(): boolean;
  71120. /**
  71121. * Gets the number of particles active at the same time.
  71122. * @returns The number of active particles.
  71123. */
  71124. getActiveCount(): number;
  71125. /**
  71126. * Starts the particle system and begins to emit
  71127. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  71128. */
  71129. start(delay?: number): void;
  71130. /**
  71131. * Stops the particle system.
  71132. */
  71133. stop(): void;
  71134. /**
  71135. * Remove all active particles
  71136. */
  71137. reset(): void;
  71138. /**
  71139. * Returns the string "GPUParticleSystem"
  71140. * @returns a string containing the class name
  71141. */
  71142. getClassName(): string;
  71143. /**
  71144. * Gets the custom effect used to render the particles
  71145. * @param blendMode Blend mode for which the effect should be retrieved
  71146. * @returns The effect
  71147. */
  71148. getCustomEffect(blendMode?: number): Nullable<Effect>;
  71149. /**
  71150. * Sets the custom effect used to render the particles
  71151. * @param effect The effect to set
  71152. * @param blendMode Blend mode for which the effect should be set
  71153. */
  71154. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  71155. /** @hidden */
  71156. protected _onBeforeDrawParticlesObservable: Nullable<Observable<Nullable<Effect>>>;
  71157. /**
  71158. * Observable that will be called just before the particles are drawn
  71159. */
  71160. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  71161. /**
  71162. * Gets the name of the particle vertex shader
  71163. */
  71164. get vertexShaderName(): string;
  71165. private _colorGradientsTexture;
  71166. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: RawTexture): BaseParticleSystem;
  71167. /**
  71168. * Adds a new color gradient
  71169. * @param gradient defines the gradient to use (between 0 and 1)
  71170. * @param color1 defines the color to affect to the specified gradient
  71171. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  71172. * @returns the current particle system
  71173. */
  71174. addColorGradient(gradient: number, color1: Color4, color2?: Color4): GPUParticleSystem;
  71175. private _refreshColorGradient;
  71176. /** Force the system to rebuild all gradients that need to be resync */
  71177. forceRefreshGradients(): void;
  71178. /**
  71179. * Remove a specific color gradient
  71180. * @param gradient defines the gradient to remove
  71181. * @returns the current particle system
  71182. */
  71183. removeColorGradient(gradient: number): GPUParticleSystem;
  71184. private _angularSpeedGradientsTexture;
  71185. private _sizeGradientsTexture;
  71186. private _velocityGradientsTexture;
  71187. private _limitVelocityGradientsTexture;
  71188. private _dragGradientsTexture;
  71189. private _addFactorGradient;
  71190. /**
  71191. * Adds a new size gradient
  71192. * @param gradient defines the gradient to use (between 0 and 1)
  71193. * @param factor defines the size factor to affect to the specified gradient
  71194. * @returns the current particle system
  71195. */
  71196. addSizeGradient(gradient: number, factor: number): GPUParticleSystem;
  71197. /**
  71198. * Remove a specific size gradient
  71199. * @param gradient defines the gradient to remove
  71200. * @returns the current particle system
  71201. */
  71202. removeSizeGradient(gradient: number): GPUParticleSystem;
  71203. private _refreshFactorGradient;
  71204. /**
  71205. * Adds a new angular speed gradient
  71206. * @param gradient defines the gradient to use (between 0 and 1)
  71207. * @param factor defines the angular speed to affect to the specified gradient
  71208. * @returns the current particle system
  71209. */
  71210. addAngularSpeedGradient(gradient: number, factor: number): GPUParticleSystem;
  71211. /**
  71212. * Remove a specific angular speed gradient
  71213. * @param gradient defines the gradient to remove
  71214. * @returns the current particle system
  71215. */
  71216. removeAngularSpeedGradient(gradient: number): GPUParticleSystem;
  71217. /**
  71218. * Adds a new velocity gradient
  71219. * @param gradient defines the gradient to use (between 0 and 1)
  71220. * @param factor defines the velocity to affect to the specified gradient
  71221. * @returns the current particle system
  71222. */
  71223. addVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  71224. /**
  71225. * Remove a specific velocity gradient
  71226. * @param gradient defines the gradient to remove
  71227. * @returns the current particle system
  71228. */
  71229. removeVelocityGradient(gradient: number): GPUParticleSystem;
  71230. /**
  71231. * Adds a new limit velocity gradient
  71232. * @param gradient defines the gradient to use (between 0 and 1)
  71233. * @param factor defines the limit velocity value to affect to the specified gradient
  71234. * @returns the current particle system
  71235. */
  71236. addLimitVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  71237. /**
  71238. * Remove a specific limit velocity gradient
  71239. * @param gradient defines the gradient to remove
  71240. * @returns the current particle system
  71241. */
  71242. removeLimitVelocityGradient(gradient: number): GPUParticleSystem;
  71243. /**
  71244. * Adds a new drag gradient
  71245. * @param gradient defines the gradient to use (between 0 and 1)
  71246. * @param factor defines the drag value to affect to the specified gradient
  71247. * @returns the current particle system
  71248. */
  71249. addDragGradient(gradient: number, factor: number): GPUParticleSystem;
  71250. /**
  71251. * Remove a specific drag gradient
  71252. * @param gradient defines the gradient to remove
  71253. * @returns the current particle system
  71254. */
  71255. removeDragGradient(gradient: number): GPUParticleSystem;
  71256. /**
  71257. * Not supported by GPUParticleSystem
  71258. * @param gradient defines the gradient to use (between 0 and 1)
  71259. * @param factor defines the emit rate value to affect to the specified gradient
  71260. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  71261. * @returns the current particle system
  71262. */
  71263. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  71264. /**
  71265. * Not supported by GPUParticleSystem
  71266. * @param gradient defines the gradient to remove
  71267. * @returns the current particle system
  71268. */
  71269. removeEmitRateGradient(gradient: number): IParticleSystem;
  71270. /**
  71271. * Not supported by GPUParticleSystem
  71272. * @param gradient defines the gradient to use (between 0 and 1)
  71273. * @param factor defines the start size value to affect to the specified gradient
  71274. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  71275. * @returns the current particle system
  71276. */
  71277. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  71278. /**
  71279. * Not supported by GPUParticleSystem
  71280. * @param gradient defines the gradient to remove
  71281. * @returns the current particle system
  71282. */
  71283. removeStartSizeGradient(gradient: number): IParticleSystem;
  71284. /**
  71285. * Not supported by GPUParticleSystem
  71286. * @param gradient defines the gradient to use (between 0 and 1)
  71287. * @param min defines the color remap minimal range
  71288. * @param max defines the color remap maximal range
  71289. * @returns the current particle system
  71290. */
  71291. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  71292. /**
  71293. * Not supported by GPUParticleSystem
  71294. * @param gradient defines the gradient to remove
  71295. * @returns the current particle system
  71296. */
  71297. removeColorRemapGradient(): IParticleSystem;
  71298. /**
  71299. * Not supported by GPUParticleSystem
  71300. * @param gradient defines the gradient to use (between 0 and 1)
  71301. * @param min defines the alpha remap minimal range
  71302. * @param max defines the alpha remap maximal range
  71303. * @returns the current particle system
  71304. */
  71305. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  71306. /**
  71307. * Not supported by GPUParticleSystem
  71308. * @param gradient defines the gradient to remove
  71309. * @returns the current particle system
  71310. */
  71311. removeAlphaRemapGradient(): IParticleSystem;
  71312. /**
  71313. * Not supported by GPUParticleSystem
  71314. * @param gradient defines the gradient to use (between 0 and 1)
  71315. * @param color defines the color to affect to the specified gradient
  71316. * @returns the current particle system
  71317. */
  71318. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  71319. /**
  71320. * Not supported by GPUParticleSystem
  71321. * @param gradient defines the gradient to remove
  71322. * @returns the current particle system
  71323. */
  71324. removeRampGradient(): IParticleSystem;
  71325. /**
  71326. * Not supported by GPUParticleSystem
  71327. * @returns the list of ramp gradients
  71328. */
  71329. getRampGradients(): Nullable<Array<Color3Gradient>>;
  71330. /**
  71331. * Not supported by GPUParticleSystem
  71332. * Gets or sets a boolean indicating that ramp gradients must be used
  71333. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  71334. */
  71335. get useRampGradients(): boolean;
  71336. set useRampGradients(value: boolean);
  71337. /**
  71338. * Not supported by GPUParticleSystem
  71339. * @param gradient defines the gradient to use (between 0 and 1)
  71340. * @param factor defines the life time factor to affect to the specified gradient
  71341. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  71342. * @returns the current particle system
  71343. */
  71344. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  71345. /**
  71346. * Not supported by GPUParticleSystem
  71347. * @param gradient defines the gradient to remove
  71348. * @returns the current particle system
  71349. */
  71350. removeLifeTimeGradient(gradient: number): IParticleSystem;
  71351. /**
  71352. * Instantiates a GPU particle system.
  71353. * 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.
  71354. * @param name The name of the particle system
  71355. * @param options The options used to create the system
  71356. * @param sceneOrEngine The scene the particle system belongs to or the engine to use if no scene
  71357. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  71358. * @param customEffect a custom effect used to change the way particles are rendered by default
  71359. */
  71360. constructor(name: string, options: Partial<{
  71361. capacity: number;
  71362. randomTextureSize: number;
  71363. }>, sceneOrEngine: Scene | ThinEngine, isAnimationSheetEnabled?: boolean, customEffect?: Nullable<Effect>);
  71364. protected _reset(): void;
  71365. private _createUpdateVAO;
  71366. private _createRenderVAO;
  71367. private _initialize;
  71368. /** @hidden */
  71369. _recreateUpdateEffect(): void;
  71370. private _getEffect;
  71371. /**
  71372. * Fill the defines array according to the current settings of the particle system
  71373. * @param defines Array to be updated
  71374. * @param blendMode blend mode to take into account when updating the array
  71375. */
  71376. fillDefines(defines: Array<string>, blendMode?: number): void;
  71377. /**
  71378. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  71379. * @param uniforms Uniforms array to fill
  71380. * @param attributes Attributes array to fill
  71381. * @param samplers Samplers array to fill
  71382. */
  71383. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  71384. /** @hidden */
  71385. _recreateRenderEffect(): Effect;
  71386. /**
  71387. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  71388. * @param preWarm defines if we are in the pre-warmimg phase
  71389. */
  71390. animate(preWarm?: boolean): void;
  71391. private _createFactorGradientTexture;
  71392. private _createSizeGradientTexture;
  71393. private _createAngularSpeedGradientTexture;
  71394. private _createVelocityGradientTexture;
  71395. private _createLimitVelocityGradientTexture;
  71396. private _createDragGradientTexture;
  71397. private _createColorGradientTexture;
  71398. /**
  71399. * Renders the particle system in its current state
  71400. * @param preWarm defines if the system should only update the particles but not render them
  71401. * @returns the current number of particles
  71402. */
  71403. render(preWarm?: boolean): number;
  71404. /**
  71405. * Rebuilds the particle system
  71406. */
  71407. rebuild(): void;
  71408. private _releaseBuffers;
  71409. private _releaseVAOs;
  71410. /**
  71411. * Disposes the particle system and free the associated resources
  71412. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  71413. */
  71414. dispose(disposeTexture?: boolean): void;
  71415. /**
  71416. * Clones the particle system.
  71417. * @param name The name of the cloned object
  71418. * @param newEmitter The new emitter to use
  71419. * @returns the cloned particle system
  71420. */
  71421. clone(name: string, newEmitter: any): GPUParticleSystem;
  71422. /**
  71423. * Serializes the particle system to a JSON object
  71424. * @param serializeTexture defines if the texture must be serialized as well
  71425. * @returns the JSON object
  71426. */
  71427. serialize(serializeTexture?: boolean): any;
  71428. /**
  71429. * Parses a JSON object to create a GPU particle system.
  71430. * @param parsedParticleSystem The JSON object to parse
  71431. * @param sceneOrEngine The scene or the engine to create the particle system in
  71432. * @param rootUrl The root url to use to load external dependencies like texture
  71433. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  71434. * @returns the parsed GPU particle system
  71435. */
  71436. static Parse(parsedParticleSystem: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string, doNotStart?: boolean): GPUParticleSystem;
  71437. }
  71438. }
  71439. declare module "babylonjs/Particles/particleSystemSet" {
  71440. import { Nullable } from "babylonjs/types";
  71441. import { Color3 } from "babylonjs/Maths/math.color";
  71442. import { TransformNode } from "babylonjs/Meshes/transformNode";
  71443. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  71444. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  71445. import { Scene, IDisposable } from "babylonjs/scene";
  71446. /**
  71447. * Represents a set of particle systems working together to create a specific effect
  71448. */
  71449. export class ParticleSystemSet implements IDisposable {
  71450. /**
  71451. * Gets or sets base Assets URL
  71452. */
  71453. static BaseAssetsUrl: string;
  71454. private _emitterCreationOptions;
  71455. private _emitterNode;
  71456. /**
  71457. * Gets the particle system list
  71458. */
  71459. systems: IParticleSystem[];
  71460. /**
  71461. * Gets the emitter node used with this set
  71462. */
  71463. get emitterNode(): Nullable<TransformNode>;
  71464. /**
  71465. * Creates a new emitter mesh as a sphere
  71466. * @param options defines the options used to create the sphere
  71467. * @param renderingGroupId defines the renderingGroupId to use for the sphere
  71468. * @param scene defines the hosting scene
  71469. */
  71470. setEmitterAsSphere(options: {
  71471. diameter: number;
  71472. segments: number;
  71473. color: Color3;
  71474. }, renderingGroupId: number, scene: Scene): void;
  71475. /**
  71476. * Starts all particle systems of the set
  71477. * @param emitter defines an optional mesh to use as emitter for the particle systems
  71478. */
  71479. start(emitter?: AbstractMesh): void;
  71480. /**
  71481. * Release all associated resources
  71482. */
  71483. dispose(): void;
  71484. /**
  71485. * Serialize the set into a JSON compatible object
  71486. * @param serializeTexture defines if the texture must be serialized as well
  71487. * @returns a JSON compatible representation of the set
  71488. */
  71489. serialize(serializeTexture?: boolean): any;
  71490. /**
  71491. * Parse a new ParticleSystemSet from a serialized source
  71492. * @param data defines a JSON compatible representation of the set
  71493. * @param scene defines the hosting scene
  71494. * @param gpu defines if we want GPU particles or CPU particles
  71495. * @returns a new ParticleSystemSet
  71496. */
  71497. static Parse(data: any, scene: Scene, gpu?: boolean): ParticleSystemSet;
  71498. }
  71499. }
  71500. declare module "babylonjs/Particles/particleHelper" {
  71501. import { Nullable } from "babylonjs/types";
  71502. import { Scene } from "babylonjs/scene";
  71503. import { Vector3 } from "babylonjs/Maths/math.vector";
  71504. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  71505. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  71506. import { ParticleSystemSet } from "babylonjs/Particles/particleSystemSet";
  71507. /**
  71508. * This class is made for on one-liner static method to help creating particle system set.
  71509. */
  71510. export class ParticleHelper {
  71511. /**
  71512. * Gets or sets base Assets URL
  71513. */
  71514. static BaseAssetsUrl: string;
  71515. /** Define the Url to load snippets */
  71516. static SnippetUrl: string;
  71517. /**
  71518. * Create a default particle system that you can tweak
  71519. * @param emitter defines the emitter to use
  71520. * @param capacity defines the system capacity (default is 500 particles)
  71521. * @param scene defines the hosting scene
  71522. * @param useGPU defines if a GPUParticleSystem must be created (default is false)
  71523. * @returns the new Particle system
  71524. */
  71525. static CreateDefault(emitter: Nullable<AbstractMesh | Vector3>, capacity?: number, scene?: Scene, useGPU?: boolean): IParticleSystem;
  71526. /**
  71527. * This is the main static method (one-liner) of this helper to create different particle systems
  71528. * @param type This string represents the type to the particle system to create
  71529. * @param scene The scene where the particle system should live
  71530. * @param gpu If the system will use gpu
  71531. * @returns the ParticleSystemSet created
  71532. */
  71533. static CreateAsync(type: string, scene: Nullable<Scene>, gpu?: boolean): Promise<ParticleSystemSet>;
  71534. /**
  71535. * Static function used to export a particle system to a ParticleSystemSet variable.
  71536. * Please note that the emitter shape is not exported
  71537. * @param systems defines the particle systems to export
  71538. * @returns the created particle system set
  71539. */
  71540. static ExportSet(systems: IParticleSystem[]): ParticleSystemSet;
  71541. /**
  71542. * Creates a particle system from a snippet saved in a remote file
  71543. * @param name defines the name of the particle system to create (can be null or empty to use the one from the json data)
  71544. * @param url defines the url to load from
  71545. * @param scene defines the hosting scene
  71546. * @param gpu If the system will use gpu
  71547. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  71548. * @returns a promise that will resolve to the new particle system
  71549. */
  71550. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  71551. /**
  71552. * Creates a particle system from a snippet saved by the particle system editor
  71553. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  71554. * @param scene defines the hosting scene
  71555. * @param gpu If the system will use gpu
  71556. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  71557. * @returns a promise that will resolve to the new particle system
  71558. */
  71559. static CreateFromSnippetAsync(snippetId: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  71560. }
  71561. }
  71562. declare module "babylonjs/Particles/particleSystemComponent" {
  71563. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  71564. import { Effect } from "babylonjs/Materials/effect";
  71565. import "babylonjs/Shaders/particles.vertex";
  71566. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  71567. module "babylonjs/Engines/engine" {
  71568. interface Engine {
  71569. /**
  71570. * Create an effect to use with particle systems.
  71571. * Please note that some parameters like animation sheets or not being billboard are not supported in this configuration, except if you pass
  71572. * the particle system for which you want to create a custom effect in the last parameter
  71573. * @param fragmentName defines the base name of the effect (The name of file without .fragment.fx)
  71574. * @param uniformsNames defines a list of attribute names
  71575. * @param samplers defines an array of string used to represent textures
  71576. * @param defines defines the string containing the defines to use to compile the shaders
  71577. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  71578. * @param onCompiled defines a function to call when the effect creation is successful
  71579. * @param onError defines a function to call when the effect creation has failed
  71580. * @param particleSystem the particle system you want to create the effect for
  71581. * @returns the new Effect
  71582. */
  71583. createEffectForParticles(fragmentName: string, uniformsNames: string[], samplers: string[], defines: string, fallbacks?: EffectFallbacks, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void, particleSystem?: IParticleSystem): Effect;
  71584. }
  71585. }
  71586. module "babylonjs/Meshes/mesh" {
  71587. interface Mesh {
  71588. /**
  71589. * Returns an array populated with IParticleSystem objects whose the mesh is the emitter
  71590. * @returns an array of IParticleSystem
  71591. */
  71592. getEmittedParticleSystems(): IParticleSystem[];
  71593. /**
  71594. * Returns an array populated with IParticleSystem objects whose the mesh or its children are the emitter
  71595. * @returns an array of IParticleSystem
  71596. */
  71597. getHierarchyEmittedParticleSystems(): IParticleSystem[];
  71598. }
  71599. }
  71600. }
  71601. declare module "babylonjs/Particles/pointsCloudSystem" {
  71602. import { Color4 } from "babylonjs/Maths/math";
  71603. import { Mesh } from "babylonjs/Meshes/mesh";
  71604. import { Scene, IDisposable } from "babylonjs/scene";
  71605. import { CloudPoint } from "babylonjs/Particles/cloudPoint";
  71606. /** Defines the 4 color options */
  71607. export enum PointColor {
  71608. /** color value */
  71609. Color = 2,
  71610. /** uv value */
  71611. UV = 1,
  71612. /** random value */
  71613. Random = 0,
  71614. /** stated value */
  71615. Stated = 3
  71616. }
  71617. /**
  71618. * The PointCloudSystem (PCS) is a single updatable mesh. The points corresponding to the vertices of this big mesh.
  71619. * 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.
  71620. * The PointCloudSytem is also a particle system, with each point being a particle. It provides some methods to manage the particles.
  71621. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  71622. *
  71623. * Full documentation here : TO BE ENTERED
  71624. */
  71625. export class PointsCloudSystem implements IDisposable {
  71626. /**
  71627. * The PCS array of cloud point objects. Just access each particle as with any classic array.
  71628. * Example : var p = SPS.particles[i];
  71629. */
  71630. particles: CloudPoint[];
  71631. /**
  71632. * The PCS total number of particles. Read only. Use PCS.counter instead if you need to set your own value.
  71633. */
  71634. nbParticles: number;
  71635. /**
  71636. * This a counter for your own usage. It's not set by any SPS functions.
  71637. */
  71638. counter: number;
  71639. /**
  71640. * The PCS name. This name is also given to the underlying mesh.
  71641. */
  71642. name: string;
  71643. /**
  71644. * The PCS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  71645. */
  71646. mesh: Mesh;
  71647. /**
  71648. * This empty object is intended to store some PCS specific or temporary values in order to lower the Garbage Collector activity.
  71649. * Please read :
  71650. */
  71651. vars: any;
  71652. /**
  71653. * @hidden
  71654. */
  71655. _size: number;
  71656. private _scene;
  71657. private _promises;
  71658. private _positions;
  71659. private _indices;
  71660. private _normals;
  71661. private _colors;
  71662. private _uvs;
  71663. private _indices32;
  71664. private _positions32;
  71665. private _colors32;
  71666. private _uvs32;
  71667. private _updatable;
  71668. private _isVisibilityBoxLocked;
  71669. private _alwaysVisible;
  71670. private _groups;
  71671. private _groupCounter;
  71672. private _computeParticleColor;
  71673. private _computeParticleTexture;
  71674. private _computeParticleRotation;
  71675. private _computeBoundingBox;
  71676. private _isReady;
  71677. /**
  71678. * Creates a PCS (Points Cloud System) object
  71679. * @param name (String) is the PCS name, this will be the underlying mesh name
  71680. * @param pointSize (number) is the size for each point
  71681. * @param scene (Scene) is the scene in which the PCS is added
  71682. * @param options defines the options of the PCS e.g.
  71683. * * updatable (optional boolean, default true) : if the PCS must be updatable or immutable
  71684. */
  71685. constructor(name: string, pointSize: number, scene: Scene, options?: {
  71686. updatable?: boolean;
  71687. });
  71688. /**
  71689. * Builds the PCS underlying mesh. Returns a standard Mesh.
  71690. * If no points were added to the PCS, the returned mesh is just a single point.
  71691. * @returns a promise for the created mesh
  71692. */
  71693. buildMeshAsync(): Promise<Mesh>;
  71694. /**
  71695. * @hidden
  71696. */
  71697. private _buildMesh;
  71698. private _addParticle;
  71699. private _randomUnitVector;
  71700. private _getColorIndicesForCoord;
  71701. private _setPointsColorOrUV;
  71702. private _colorFromTexture;
  71703. private _calculateDensity;
  71704. /**
  71705. * Adds points to the PCS in random positions within a unit sphere
  71706. * @param nb (positive integer) the number of particles to be created from this model
  71707. * @param pointFunction is an optional javascript function to be called for each particle on PCS creation
  71708. * @returns the number of groups in the system
  71709. */
  71710. addPoints(nb: number, pointFunction?: any): number;
  71711. /**
  71712. * Adds points to the PCS from the surface of the model shape
  71713. * @param mesh is any Mesh object that will be used as a surface model for the points
  71714. * @param nb (positive integer) the number of particles to be created from this model
  71715. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  71716. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  71717. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  71718. * @returns the number of groups in the system
  71719. */
  71720. addSurfacePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  71721. /**
  71722. * Adds points to the PCS inside the model shape
  71723. * @param mesh is any Mesh object that will be used as a surface model for the points
  71724. * @param nb (positive integer) the number of particles to be created from this model
  71725. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  71726. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  71727. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  71728. * @returns the number of groups in the system
  71729. */
  71730. addVolumePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  71731. /**
  71732. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  71733. * This method calls `updateParticle()` for each particle of the SPS.
  71734. * For an animated SPS, it is usually called within the render loop.
  71735. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  71736. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  71737. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  71738. * @returns the PCS.
  71739. */
  71740. setParticles(start?: number, end?: number, update?: boolean): PointsCloudSystem;
  71741. /**
  71742. * Disposes the PCS.
  71743. */
  71744. dispose(): void;
  71745. /**
  71746. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  71747. * doc :
  71748. * @returns the PCS.
  71749. */
  71750. refreshVisibleSize(): PointsCloudSystem;
  71751. /**
  71752. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  71753. * @param size the size (float) of the visibility box
  71754. * note : this doesn't lock the PCS mesh bounding box.
  71755. * doc :
  71756. */
  71757. setVisibilityBox(size: number): void;
  71758. /**
  71759. * Gets whether the PCS is always visible or not
  71760. * doc :
  71761. */
  71762. get isAlwaysVisible(): boolean;
  71763. /**
  71764. * Sets the PCS as always visible or not
  71765. * doc :
  71766. */
  71767. set isAlwaysVisible(val: boolean);
  71768. /**
  71769. * Tells to `setParticles()` to compute the particle rotations or not
  71770. * Default value : false. The PCS is faster when it's set to false
  71771. * Note : particle rotations are only applied to parent particles
  71772. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate
  71773. */
  71774. set computeParticleRotation(val: boolean);
  71775. /**
  71776. * Tells to `setParticles()` to compute the particle colors or not.
  71777. * Default value : true. The PCS is faster when it's set to false.
  71778. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  71779. */
  71780. set computeParticleColor(val: boolean);
  71781. set computeParticleTexture(val: boolean);
  71782. /**
  71783. * Gets if `setParticles()` computes the particle colors or not.
  71784. * Default value : false. The PCS is faster when it's set to false.
  71785. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  71786. */
  71787. get computeParticleColor(): boolean;
  71788. /**
  71789. * Gets if `setParticles()` computes the particle textures or not.
  71790. * Default value : false. The PCS is faster when it's set to false.
  71791. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  71792. */
  71793. get computeParticleTexture(): boolean;
  71794. /**
  71795. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  71796. */
  71797. set computeBoundingBox(val: boolean);
  71798. /**
  71799. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  71800. */
  71801. get computeBoundingBox(): boolean;
  71802. /**
  71803. * This function does nothing. It may be overwritten to set all the particle first values.
  71804. * The PCS doesn't call this function, you may have to call it by your own.
  71805. * doc :
  71806. */
  71807. initParticles(): void;
  71808. /**
  71809. * This function does nothing. It may be overwritten to recycle a particle
  71810. * The PCS doesn't call this function, you can to call it
  71811. * doc :
  71812. * @param particle The particle to recycle
  71813. * @returns the recycled particle
  71814. */
  71815. recycleParticle(particle: CloudPoint): CloudPoint;
  71816. /**
  71817. * Updates a particle : this function should be overwritten by the user.
  71818. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  71819. * doc :
  71820. * @example : just set a particle position or velocity and recycle conditions
  71821. * @param particle The particle to update
  71822. * @returns the updated particle
  71823. */
  71824. updateParticle(particle: CloudPoint): CloudPoint;
  71825. /**
  71826. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  71827. * This does nothing and may be overwritten by the user.
  71828. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  71829. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  71830. * @param update the boolean update value actually passed to setParticles()
  71831. */
  71832. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  71833. /**
  71834. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  71835. * This will be passed three parameters.
  71836. * This does nothing and may be overwritten by the user.
  71837. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  71838. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  71839. * @param update the boolean update value actually passed to setParticles()
  71840. */
  71841. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  71842. }
  71843. }
  71844. declare module "babylonjs/Particles/cloudPoint" {
  71845. import { Nullable } from "babylonjs/types";
  71846. import { Color4, Vector2, Vector3, Matrix, Quaternion } from "babylonjs/Maths/math";
  71847. import { Mesh } from "babylonjs/Meshes/mesh";
  71848. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  71849. import { PointsCloudSystem } from "babylonjs/Particles/pointsCloudSystem";
  71850. /**
  71851. * Represents one particle of a points cloud system.
  71852. */
  71853. export class CloudPoint {
  71854. /**
  71855. * particle global index
  71856. */
  71857. idx: number;
  71858. /**
  71859. * The color of the particle
  71860. */
  71861. color: Nullable<Color4>;
  71862. /**
  71863. * The world space position of the particle.
  71864. */
  71865. position: Vector3;
  71866. /**
  71867. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  71868. */
  71869. rotation: Vector3;
  71870. /**
  71871. * The world space rotation quaternion of the particle.
  71872. */
  71873. rotationQuaternion: Nullable<Quaternion>;
  71874. /**
  71875. * The uv of the particle.
  71876. */
  71877. uv: Nullable<Vector2>;
  71878. /**
  71879. * The current speed of the particle.
  71880. */
  71881. velocity: Vector3;
  71882. /**
  71883. * The pivot point in the particle local space.
  71884. */
  71885. pivot: Vector3;
  71886. /**
  71887. * Must the particle be translated from its pivot point in its local space ?
  71888. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  71889. * Default : false
  71890. */
  71891. translateFromPivot: boolean;
  71892. /**
  71893. * Index of this particle in the global "positions" array (Internal use)
  71894. * @hidden
  71895. */
  71896. _pos: number;
  71897. /**
  71898. * @hidden Index of this particle in the global "indices" array (Internal use)
  71899. */
  71900. _ind: number;
  71901. /**
  71902. * Group this particle belongs to
  71903. */
  71904. _group: PointsGroup;
  71905. /**
  71906. * Group id of this particle
  71907. */
  71908. groupId: number;
  71909. /**
  71910. * Index of the particle in its group id (Internal use)
  71911. */
  71912. idxInGroup: number;
  71913. /**
  71914. * @hidden Particle BoundingInfo object (Internal use)
  71915. */
  71916. _boundingInfo: BoundingInfo;
  71917. /**
  71918. * @hidden Reference to the PCS that the particle belongs to (Internal use)
  71919. */
  71920. _pcs: PointsCloudSystem;
  71921. /**
  71922. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  71923. */
  71924. _stillInvisible: boolean;
  71925. /**
  71926. * @hidden Last computed particle rotation matrix
  71927. */
  71928. _rotationMatrix: number[];
  71929. /**
  71930. * Parent particle Id, if any.
  71931. * Default null.
  71932. */
  71933. parentId: Nullable<number>;
  71934. /**
  71935. * @hidden Internal global position in the PCS.
  71936. */
  71937. _globalPosition: Vector3;
  71938. /**
  71939. * Creates a Point Cloud object.
  71940. * Don't create particles manually, use instead the PCS internal tools like _addParticle()
  71941. * @param particleIndex (integer) is the particle index in the PCS pool. It's also the particle identifier.
  71942. * @param group (PointsGroup) is the group the particle belongs to
  71943. * @param groupId (integer) is the group identifier in the PCS.
  71944. * @param idxInGroup (integer) is the index of the particle in the current point group (ex: the 10th point of addPoints(30))
  71945. * @param pcs defines the PCS it is associated to
  71946. */
  71947. constructor(particleIndex: number, group: PointsGroup, groupId: number, idxInGroup: number, pcs: PointsCloudSystem);
  71948. /**
  71949. * get point size
  71950. */
  71951. get size(): Vector3;
  71952. /**
  71953. * Set point size
  71954. */
  71955. set size(scale: Vector3);
  71956. /**
  71957. * Legacy support, changed quaternion to rotationQuaternion
  71958. */
  71959. get quaternion(): Nullable<Quaternion>;
  71960. /**
  71961. * Legacy support, changed quaternion to rotationQuaternion
  71962. */
  71963. set quaternion(q: Nullable<Quaternion>);
  71964. /**
  71965. * Returns a boolean. True if the particle intersects a mesh, else false
  71966. * The intersection is computed on the particle position and Axis Aligned Bounding Box (AABB) or Sphere
  71967. * @param target is the object (point or mesh) what the intersection is computed against
  71968. * @param isSphere is boolean flag when false (default) bounding box of mesh is used, when true the bouding sphere is used
  71969. * @returns true if it intersects
  71970. */
  71971. intersectsMesh(target: Mesh, isSphere: boolean): boolean;
  71972. /**
  71973. * get the rotation matrix of the particle
  71974. * @hidden
  71975. */
  71976. getRotationMatrix(m: Matrix): void;
  71977. }
  71978. /**
  71979. * Represents a group of points in a points cloud system
  71980. * * PCS internal tool, don't use it manually.
  71981. */
  71982. export class PointsGroup {
  71983. /**
  71984. * The group id
  71985. * @hidden
  71986. */
  71987. groupID: number;
  71988. /**
  71989. * image data for group (internal use)
  71990. * @hidden
  71991. */
  71992. _groupImageData: Nullable<ArrayBufferView>;
  71993. /**
  71994. * Image Width (internal use)
  71995. * @hidden
  71996. */
  71997. _groupImgWidth: number;
  71998. /**
  71999. * Image Height (internal use)
  72000. * @hidden
  72001. */
  72002. _groupImgHeight: number;
  72003. /**
  72004. * Custom position function (internal use)
  72005. * @hidden
  72006. */
  72007. _positionFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>;
  72008. /**
  72009. * density per facet for surface points
  72010. * @hidden
  72011. */
  72012. _groupDensity: number[];
  72013. /**
  72014. * Only when points are colored by texture carries pointer to texture list array
  72015. * @hidden
  72016. */
  72017. _textureNb: number;
  72018. /**
  72019. * Creates a points group object. This is an internal reference to produce particles for the PCS.
  72020. * PCS internal tool, don't use it manually.
  72021. * @hidden
  72022. */
  72023. constructor(id: number, posFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>);
  72024. }
  72025. }
  72026. declare module "babylonjs/Particles/index" {
  72027. export * from "babylonjs/Particles/baseParticleSystem";
  72028. export * from "babylonjs/Particles/EmitterTypes/index";
  72029. export * from "babylonjs/Particles/gpuParticleSystem";
  72030. export * from "babylonjs/Particles/IParticleSystem";
  72031. export * from "babylonjs/Particles/particle";
  72032. export * from "babylonjs/Particles/particleHelper";
  72033. export * from "babylonjs/Particles/particleSystem";
  72034. import "babylonjs/Particles/particleSystemComponent";
  72035. export * from "babylonjs/Particles/particleSystemComponent";
  72036. export * from "babylonjs/Particles/particleSystemSet";
  72037. export * from "babylonjs/Particles/solidParticle";
  72038. export * from "babylonjs/Particles/solidParticleSystem";
  72039. export * from "babylonjs/Particles/cloudPoint";
  72040. export * from "babylonjs/Particles/pointsCloudSystem";
  72041. export * from "babylonjs/Particles/subEmitter";
  72042. }
  72043. declare module "babylonjs/Physics/physicsEngineComponent" {
  72044. import { Nullable } from "babylonjs/types";
  72045. import { Observable, Observer } from "babylonjs/Misc/observable";
  72046. import { Vector3 } from "babylonjs/Maths/math.vector";
  72047. import { Mesh } from "babylonjs/Meshes/mesh";
  72048. import { ISceneComponent } from "babylonjs/sceneComponent";
  72049. import { Scene } from "babylonjs/scene";
  72050. import { Node } from "babylonjs/node";
  72051. import { IPhysicsEngine, IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  72052. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  72053. module "babylonjs/scene" {
  72054. interface Scene {
  72055. /** @hidden (Backing field) */
  72056. _physicsEngine: Nullable<IPhysicsEngine>;
  72057. /** @hidden */
  72058. _physicsTimeAccumulator: number;
  72059. /**
  72060. * Gets the current physics engine
  72061. * @returns a IPhysicsEngine or null if none attached
  72062. */
  72063. getPhysicsEngine(): Nullable<IPhysicsEngine>;
  72064. /**
  72065. * Enables physics to the current scene
  72066. * @param gravity defines the scene's gravity for the physics engine
  72067. * @param plugin defines the physics engine to be used. defaults to OimoJS.
  72068. * @return a boolean indicating if the physics engine was initialized
  72069. */
  72070. enablePhysics(gravity: Nullable<Vector3>, plugin?: IPhysicsEnginePlugin): boolean;
  72071. /**
  72072. * Disables and disposes the physics engine associated with the scene
  72073. */
  72074. disablePhysicsEngine(): void;
  72075. /**
  72076. * Gets a boolean indicating if there is an active physics engine
  72077. * @returns a boolean indicating if there is an active physics engine
  72078. */
  72079. isPhysicsEnabled(): boolean;
  72080. /**
  72081. * Deletes a physics compound impostor
  72082. * @param compound defines the compound to delete
  72083. */
  72084. deleteCompoundImpostor(compound: any): void;
  72085. /**
  72086. * An event triggered when physic simulation is about to be run
  72087. */
  72088. onBeforePhysicsObservable: Observable<Scene>;
  72089. /**
  72090. * An event triggered when physic simulation has been done
  72091. */
  72092. onAfterPhysicsObservable: Observable<Scene>;
  72093. }
  72094. }
  72095. module "babylonjs/Meshes/abstractMesh" {
  72096. interface AbstractMesh {
  72097. /** @hidden */
  72098. _physicsImpostor: Nullable<PhysicsImpostor>;
  72099. /**
  72100. * Gets or sets impostor used for physic simulation
  72101. * @see https://doc.babylonjs.com/features/physics_engine
  72102. */
  72103. physicsImpostor: Nullable<PhysicsImpostor>;
  72104. /**
  72105. * Gets the current physics impostor
  72106. * @see https://doc.babylonjs.com/features/physics_engine
  72107. * @returns a physics impostor or null
  72108. */
  72109. getPhysicsImpostor(): Nullable<PhysicsImpostor>;
  72110. /** Apply a physic impulse to the mesh
  72111. * @param force defines the force to apply
  72112. * @param contactPoint defines where to apply the force
  72113. * @returns the current mesh
  72114. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  72115. */
  72116. applyImpulse(force: Vector3, contactPoint: Vector3): AbstractMesh;
  72117. /**
  72118. * Creates a physic joint between two meshes
  72119. * @param otherMesh defines the other mesh to use
  72120. * @param pivot1 defines the pivot to use on this mesh
  72121. * @param pivot2 defines the pivot to use on the other mesh
  72122. * @param options defines additional options (can be plugin dependent)
  72123. * @returns the current mesh
  72124. * @see https://www.babylonjs-playground.com/#0BS5U0#0
  72125. */
  72126. setPhysicsLinkWith(otherMesh: Mesh, pivot1: Vector3, pivot2: Vector3, options?: any): AbstractMesh;
  72127. /** @hidden */
  72128. _disposePhysicsObserver: Nullable<Observer<Node>>;
  72129. }
  72130. }
  72131. /**
  72132. * Defines the physics engine scene component responsible to manage a physics engine
  72133. */
  72134. export class PhysicsEngineSceneComponent implements ISceneComponent {
  72135. /**
  72136. * The component name helpful to identify the component in the list of scene components.
  72137. */
  72138. readonly name: string;
  72139. /**
  72140. * The scene the component belongs to.
  72141. */
  72142. scene: Scene;
  72143. /**
  72144. * Creates a new instance of the component for the given scene
  72145. * @param scene Defines the scene to register the component in
  72146. */
  72147. constructor(scene: Scene);
  72148. /**
  72149. * Registers the component in a given scene
  72150. */
  72151. register(): void;
  72152. /**
  72153. * Rebuilds the elements related to this component in case of
  72154. * context lost for instance.
  72155. */
  72156. rebuild(): void;
  72157. /**
  72158. * Disposes the component and the associated ressources
  72159. */
  72160. dispose(): void;
  72161. }
  72162. }
  72163. declare module "babylonjs/Physics/physicsHelper" {
  72164. import { Nullable } from "babylonjs/types";
  72165. import { Vector3 } from "babylonjs/Maths/math.vector";
  72166. import { Mesh } from "babylonjs/Meshes/mesh";
  72167. import { Scene } from "babylonjs/scene";
  72168. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  72169. /**
  72170. * A helper for physics simulations
  72171. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72172. */
  72173. export class PhysicsHelper {
  72174. private _scene;
  72175. private _physicsEngine;
  72176. /**
  72177. * Initializes the Physics helper
  72178. * @param scene Babylon.js scene
  72179. */
  72180. constructor(scene: Scene);
  72181. /**
  72182. * Applies a radial explosion impulse
  72183. * @param origin the origin of the explosion
  72184. * @param radiusOrEventOptions the radius or the options of radial explosion
  72185. * @param strength the explosion strength
  72186. * @param falloff possible options: Constant & Linear. Defaults to Constant
  72187. * @returns A physics radial explosion event, or null
  72188. */
  72189. applyRadialExplosionImpulse(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  72190. /**
  72191. * Applies a radial explosion force
  72192. * @param origin the origin of the explosion
  72193. * @param radiusOrEventOptions the radius or the options of radial explosion
  72194. * @param strength the explosion strength
  72195. * @param falloff possible options: Constant & Linear. Defaults to Constant
  72196. * @returns A physics radial explosion event, or null
  72197. */
  72198. applyRadialExplosionForce(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  72199. /**
  72200. * Creates a gravitational field
  72201. * @param origin the origin of the explosion
  72202. * @param radiusOrEventOptions the radius or the options of radial explosion
  72203. * @param strength the explosion strength
  72204. * @param falloff possible options: Constant & Linear. Defaults to Constant
  72205. * @returns A physics gravitational field event, or null
  72206. */
  72207. gravitationalField(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsGravitationalFieldEvent>;
  72208. /**
  72209. * Creates a physics updraft event
  72210. * @param origin the origin of the updraft
  72211. * @param radiusOrEventOptions the radius or the options of the updraft
  72212. * @param strength the strength of the updraft
  72213. * @param height the height of the updraft
  72214. * @param updraftMode possible options: Center & Perpendicular. Defaults to Center
  72215. * @returns A physics updraft event, or null
  72216. */
  72217. updraft(origin: Vector3, radiusOrEventOptions: number | PhysicsUpdraftEventOptions, strength?: number, height?: number, updraftMode?: PhysicsUpdraftMode): Nullable<PhysicsUpdraftEvent>;
  72218. /**
  72219. * Creates a physics vortex event
  72220. * @param origin the of the vortex
  72221. * @param radiusOrEventOptions the radius or the options of the vortex
  72222. * @param strength the strength of the vortex
  72223. * @param height the height of the vortex
  72224. * @returns a Physics vortex event, or null
  72225. * A physics vortex event or null
  72226. */
  72227. vortex(origin: Vector3, radiusOrEventOptions: number | PhysicsVortexEventOptions, strength?: number, height?: number): Nullable<PhysicsVortexEvent>;
  72228. }
  72229. /**
  72230. * Represents a physics radial explosion event
  72231. */
  72232. class PhysicsRadialExplosionEvent {
  72233. private _scene;
  72234. private _options;
  72235. private _sphere;
  72236. private _dataFetched;
  72237. /**
  72238. * Initializes a radial explosioin event
  72239. * @param _scene BabylonJS scene
  72240. * @param _options The options for the vortex event
  72241. */
  72242. constructor(_scene: Scene, _options: PhysicsRadialExplosionEventOptions);
  72243. /**
  72244. * Returns the data related to the radial explosion event (sphere).
  72245. * @returns The radial explosion event data
  72246. */
  72247. getData(): PhysicsRadialExplosionEventData;
  72248. /**
  72249. * Returns the force and contact point of the impostor or false, if the impostor is not affected by the force/impulse.
  72250. * @param impostor A physics imposter
  72251. * @param origin the origin of the explosion
  72252. * @returns {Nullable<PhysicsHitData>} A physics force and contact point, or null
  72253. */
  72254. getImpostorHitData(impostor: PhysicsImpostor, origin: Vector3): Nullable<PhysicsHitData>;
  72255. /**
  72256. * Triggers affecterd impostors callbacks
  72257. * @param affectedImpostorsWithData defines the list of affected impostors (including associated data)
  72258. */
  72259. triggerAffectedImpostorsCallback(affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>): void;
  72260. /**
  72261. * Disposes the sphere.
  72262. * @param force Specifies if the sphere should be disposed by force
  72263. */
  72264. dispose(force?: boolean): void;
  72265. /*** Helpers ***/
  72266. private _prepareSphere;
  72267. private _intersectsWithSphere;
  72268. }
  72269. /**
  72270. * Represents a gravitational field event
  72271. */
  72272. class PhysicsGravitationalFieldEvent {
  72273. private _physicsHelper;
  72274. private _scene;
  72275. private _origin;
  72276. private _options;
  72277. private _tickCallback;
  72278. private _sphere;
  72279. private _dataFetched;
  72280. /**
  72281. * Initializes the physics gravitational field event
  72282. * @param _physicsHelper A physics helper
  72283. * @param _scene BabylonJS scene
  72284. * @param _origin The origin position of the gravitational field event
  72285. * @param _options The options for the vortex event
  72286. */
  72287. constructor(_physicsHelper: PhysicsHelper, _scene: Scene, _origin: Vector3, _options: PhysicsRadialExplosionEventOptions);
  72288. /**
  72289. * Returns the data related to the gravitational field event (sphere).
  72290. * @returns A gravitational field event
  72291. */
  72292. getData(): PhysicsGravitationalFieldEventData;
  72293. /**
  72294. * Enables the gravitational field.
  72295. */
  72296. enable(): void;
  72297. /**
  72298. * Disables the gravitational field.
  72299. */
  72300. disable(): void;
  72301. /**
  72302. * Disposes the sphere.
  72303. * @param force The force to dispose from the gravitational field event
  72304. */
  72305. dispose(force?: boolean): void;
  72306. private _tick;
  72307. }
  72308. /**
  72309. * Represents a physics updraft event
  72310. */
  72311. class PhysicsUpdraftEvent {
  72312. private _scene;
  72313. private _origin;
  72314. private _options;
  72315. private _physicsEngine;
  72316. private _originTop;
  72317. private _originDirection;
  72318. private _tickCallback;
  72319. private _cylinder;
  72320. private _cylinderPosition;
  72321. private _dataFetched;
  72322. /**
  72323. * Initializes the physics updraft event
  72324. * @param _scene BabylonJS scene
  72325. * @param _origin The origin position of the updraft
  72326. * @param _options The options for the updraft event
  72327. */
  72328. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsUpdraftEventOptions);
  72329. /**
  72330. * Returns the data related to the updraft event (cylinder).
  72331. * @returns A physics updraft event
  72332. */
  72333. getData(): PhysicsUpdraftEventData;
  72334. /**
  72335. * Enables the updraft.
  72336. */
  72337. enable(): void;
  72338. /**
  72339. * Disables the updraft.
  72340. */
  72341. disable(): void;
  72342. /**
  72343. * Disposes the cylinder.
  72344. * @param force Specifies if the updraft should be disposed by force
  72345. */
  72346. dispose(force?: boolean): void;
  72347. private getImpostorHitData;
  72348. private _tick;
  72349. /*** Helpers ***/
  72350. private _prepareCylinder;
  72351. private _intersectsWithCylinder;
  72352. }
  72353. /**
  72354. * Represents a physics vortex event
  72355. */
  72356. class PhysicsVortexEvent {
  72357. private _scene;
  72358. private _origin;
  72359. private _options;
  72360. private _physicsEngine;
  72361. private _originTop;
  72362. private _tickCallback;
  72363. private _cylinder;
  72364. private _cylinderPosition;
  72365. private _dataFetched;
  72366. /**
  72367. * Initializes the physics vortex event
  72368. * @param _scene The BabylonJS scene
  72369. * @param _origin The origin position of the vortex
  72370. * @param _options The options for the vortex event
  72371. */
  72372. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsVortexEventOptions);
  72373. /**
  72374. * Returns the data related to the vortex event (cylinder).
  72375. * @returns The physics vortex event data
  72376. */
  72377. getData(): PhysicsVortexEventData;
  72378. /**
  72379. * Enables the vortex.
  72380. */
  72381. enable(): void;
  72382. /**
  72383. * Disables the cortex.
  72384. */
  72385. disable(): void;
  72386. /**
  72387. * Disposes the sphere.
  72388. * @param force
  72389. */
  72390. dispose(force?: boolean): void;
  72391. private getImpostorHitData;
  72392. private _tick;
  72393. /*** Helpers ***/
  72394. private _prepareCylinder;
  72395. private _intersectsWithCylinder;
  72396. }
  72397. /**
  72398. * Options fot the radial explosion event
  72399. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72400. */
  72401. export class PhysicsRadialExplosionEventOptions {
  72402. /**
  72403. * The radius of the sphere for the radial explosion.
  72404. */
  72405. radius: number;
  72406. /**
  72407. * The strenth of the explosion.
  72408. */
  72409. strength: number;
  72410. /**
  72411. * The strenght of the force in correspondence to the distance of the affected object
  72412. */
  72413. falloff: PhysicsRadialImpulseFalloff;
  72414. /**
  72415. * Sphere options for the radial explosion.
  72416. */
  72417. sphere: {
  72418. segments: number;
  72419. diameter: number;
  72420. };
  72421. /**
  72422. * Sphere options for the radial explosion.
  72423. */
  72424. affectedImpostorsCallback: (affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>) => void;
  72425. }
  72426. /**
  72427. * Options fot the updraft event
  72428. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72429. */
  72430. export class PhysicsUpdraftEventOptions {
  72431. /**
  72432. * The radius of the cylinder for the vortex
  72433. */
  72434. radius: number;
  72435. /**
  72436. * The strenth of the updraft.
  72437. */
  72438. strength: number;
  72439. /**
  72440. * The height of the cylinder for the updraft.
  72441. */
  72442. height: number;
  72443. /**
  72444. * The mode for the the updraft.
  72445. */
  72446. updraftMode: PhysicsUpdraftMode;
  72447. }
  72448. /**
  72449. * Options fot the vortex event
  72450. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72451. */
  72452. export class PhysicsVortexEventOptions {
  72453. /**
  72454. * The radius of the cylinder for the vortex
  72455. */
  72456. radius: number;
  72457. /**
  72458. * The strenth of the vortex.
  72459. */
  72460. strength: number;
  72461. /**
  72462. * The height of the cylinder for the vortex.
  72463. */
  72464. height: number;
  72465. /**
  72466. * At which distance, relative to the radius the centripetal forces should kick in? Range: 0-1
  72467. */
  72468. centripetalForceThreshold: number;
  72469. /**
  72470. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when below the treshold.
  72471. */
  72472. centripetalForceMultiplier: number;
  72473. /**
  72474. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when above the treshold.
  72475. */
  72476. centrifugalForceMultiplier: number;
  72477. /**
  72478. * This multiplier determines with how much force the objects will be pushed upwards, when in the vortex.
  72479. */
  72480. updraftForceMultiplier: number;
  72481. }
  72482. /**
  72483. * The strenght of the force in correspondence to the distance of the affected object
  72484. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72485. */
  72486. export enum PhysicsRadialImpulseFalloff {
  72487. /** Defines that impulse is constant in strength across it's whole radius */
  72488. Constant = 0,
  72489. /** Defines that impulse gets weaker if it's further from the origin */
  72490. Linear = 1
  72491. }
  72492. /**
  72493. * The strength of the force in correspondence to the distance of the affected object
  72494. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72495. */
  72496. export enum PhysicsUpdraftMode {
  72497. /** Defines that the upstream forces will pull towards the top center of the cylinder */
  72498. Center = 0,
  72499. /** Defines that once a impostor is inside the cylinder, it will shoot out perpendicular from the ground of the cylinder */
  72500. Perpendicular = 1
  72501. }
  72502. /**
  72503. * Interface for a physics hit data
  72504. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72505. */
  72506. export interface PhysicsHitData {
  72507. /**
  72508. * The force applied at the contact point
  72509. */
  72510. force: Vector3;
  72511. /**
  72512. * The contact point
  72513. */
  72514. contactPoint: Vector3;
  72515. /**
  72516. * The distance from the origin to the contact point
  72517. */
  72518. distanceFromOrigin: number;
  72519. }
  72520. /**
  72521. * Interface for radial explosion event data
  72522. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72523. */
  72524. export interface PhysicsRadialExplosionEventData {
  72525. /**
  72526. * A sphere used for the radial explosion event
  72527. */
  72528. sphere: Mesh;
  72529. }
  72530. /**
  72531. * Interface for gravitational field event data
  72532. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72533. */
  72534. export interface PhysicsGravitationalFieldEventData {
  72535. /**
  72536. * A sphere mesh used for the gravitational field event
  72537. */
  72538. sphere: Mesh;
  72539. }
  72540. /**
  72541. * Interface for updraft event data
  72542. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72543. */
  72544. export interface PhysicsUpdraftEventData {
  72545. /**
  72546. * A cylinder used for the updraft event
  72547. */
  72548. cylinder: Mesh;
  72549. }
  72550. /**
  72551. * Interface for vortex event data
  72552. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72553. */
  72554. export interface PhysicsVortexEventData {
  72555. /**
  72556. * A cylinder used for the vortex event
  72557. */
  72558. cylinder: Mesh;
  72559. }
  72560. /**
  72561. * Interface for an affected physics impostor
  72562. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72563. */
  72564. export interface PhysicsAffectedImpostorWithData {
  72565. /**
  72566. * The impostor affected by the effect
  72567. */
  72568. impostor: PhysicsImpostor;
  72569. /**
  72570. * The data about the hit/horce from the explosion
  72571. */
  72572. hitData: PhysicsHitData;
  72573. }
  72574. }
  72575. declare module "babylonjs/Physics/Plugins/index" {
  72576. export * from "babylonjs/Physics/Plugins/cannonJSPlugin";
  72577. export * from "babylonjs/Physics/Plugins/ammoJSPlugin";
  72578. export * from "babylonjs/Physics/Plugins/oimoJSPlugin";
  72579. }
  72580. declare module "babylonjs/Physics/index" {
  72581. export * from "babylonjs/Physics/IPhysicsEngine";
  72582. export * from "babylonjs/Physics/physicsEngine";
  72583. export * from "babylonjs/Physics/physicsEngineComponent";
  72584. export * from "babylonjs/Physics/physicsHelper";
  72585. export * from "babylonjs/Physics/physicsImpostor";
  72586. export * from "babylonjs/Physics/physicsJoint";
  72587. export * from "babylonjs/Physics/Plugins/index";
  72588. }
  72589. declare module "babylonjs/Shaders/blackAndWhite.fragment" {
  72590. /** @hidden */
  72591. export var blackAndWhitePixelShader: {
  72592. name: string;
  72593. shader: string;
  72594. };
  72595. }
  72596. declare module "babylonjs/PostProcesses/blackAndWhitePostProcess" {
  72597. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72598. import { Camera } from "babylonjs/Cameras/camera";
  72599. import { Engine } from "babylonjs/Engines/engine";
  72600. import "babylonjs/Shaders/blackAndWhite.fragment";
  72601. import { Nullable } from "babylonjs/types";
  72602. import { Scene } from "babylonjs/scene";
  72603. /**
  72604. * Post process used to render in black and white
  72605. */
  72606. export class BlackAndWhitePostProcess extends PostProcess {
  72607. /**
  72608. * Linear about to convert he result to black and white (default: 1)
  72609. */
  72610. degree: number;
  72611. /**
  72612. * Gets a string identifying the name of the class
  72613. * @returns "BlackAndWhitePostProcess" string
  72614. */
  72615. getClassName(): string;
  72616. /**
  72617. * Creates a black and white post process
  72618. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#black-and-white
  72619. * @param name The name of the effect.
  72620. * @param options The required width/height ratio to downsize to before computing the render pass.
  72621. * @param camera The camera to apply the render pass to.
  72622. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72623. * @param engine The engine which the post process will be applied. (default: current engine)
  72624. * @param reusable If the post process can be reused on the same frame. (default: false)
  72625. */
  72626. constructor(name: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  72627. /** @hidden */
  72628. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<BlackAndWhitePostProcess>;
  72629. }
  72630. }
  72631. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect" {
  72632. import { Nullable } from "babylonjs/types";
  72633. import { Camera } from "babylonjs/Cameras/camera";
  72634. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  72635. import { Engine } from "babylonjs/Engines/engine";
  72636. /**
  72637. * This represents a set of one or more post processes in Babylon.
  72638. * A post process can be used to apply a shader to a texture after it is rendered.
  72639. * @example https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  72640. */
  72641. export class PostProcessRenderEffect {
  72642. private _postProcesses;
  72643. private _getPostProcesses;
  72644. private _singleInstance;
  72645. private _cameras;
  72646. private _indicesForCamera;
  72647. /**
  72648. * Name of the effect
  72649. * @hidden
  72650. */
  72651. _name: string;
  72652. /**
  72653. * Instantiates a post process render effect.
  72654. * A post process can be used to apply a shader to a texture after it is rendered.
  72655. * @param engine The engine the effect is tied to
  72656. * @param name The name of the effect
  72657. * @param getPostProcesses A function that returns a set of post processes which the effect will run in order to be run.
  72658. * @param singleInstance False if this post process can be run on multiple cameras. (default: true)
  72659. */
  72660. constructor(engine: Engine, name: string, getPostProcesses: () => Nullable<PostProcess | Array<PostProcess>>, singleInstance?: boolean);
  72661. /**
  72662. * Checks if all the post processes in the effect are supported.
  72663. */
  72664. get isSupported(): boolean;
  72665. /**
  72666. * Updates the current state of the effect
  72667. * @hidden
  72668. */
  72669. _update(): void;
  72670. /**
  72671. * Attaches the effect on cameras
  72672. * @param cameras The camera to attach to.
  72673. * @hidden
  72674. */
  72675. _attachCameras(cameras: Camera): void;
  72676. /**
  72677. * Attaches the effect on cameras
  72678. * @param cameras The camera to attach to.
  72679. * @hidden
  72680. */
  72681. _attachCameras(cameras: Camera[]): void;
  72682. /**
  72683. * Detaches the effect on cameras
  72684. * @param cameras The camera to detatch from.
  72685. * @hidden
  72686. */
  72687. _detachCameras(cameras: Camera): void;
  72688. /**
  72689. * Detatches the effect on cameras
  72690. * @param cameras The camera to detatch from.
  72691. * @hidden
  72692. */
  72693. _detachCameras(cameras: Camera[]): void;
  72694. /**
  72695. * Enables the effect on given cameras
  72696. * @param cameras The camera to enable.
  72697. * @hidden
  72698. */
  72699. _enable(cameras: Camera): void;
  72700. /**
  72701. * Enables the effect on given cameras
  72702. * @param cameras The camera to enable.
  72703. * @hidden
  72704. */
  72705. _enable(cameras: Nullable<Camera[]>): void;
  72706. /**
  72707. * Disables the effect on the given cameras
  72708. * @param cameras The camera to disable.
  72709. * @hidden
  72710. */
  72711. _disable(cameras: Camera): void;
  72712. /**
  72713. * Disables the effect on the given cameras
  72714. * @param cameras The camera to disable.
  72715. * @hidden
  72716. */
  72717. _disable(cameras: Nullable<Camera[]>): void;
  72718. /**
  72719. * Gets a list of the post processes contained in the effect.
  72720. * @param camera The camera to get the post processes on.
  72721. * @returns The list of the post processes in the effect.
  72722. */
  72723. getPostProcesses(camera?: Camera): Nullable<Array<PostProcess>>;
  72724. }
  72725. }
  72726. declare module "babylonjs/Shaders/extractHighlights.fragment" {
  72727. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  72728. /** @hidden */
  72729. export var extractHighlightsPixelShader: {
  72730. name: string;
  72731. shader: string;
  72732. };
  72733. }
  72734. declare module "babylonjs/PostProcesses/extractHighlightsPostProcess" {
  72735. import { Nullable } from "babylonjs/types";
  72736. import { Camera } from "babylonjs/Cameras/camera";
  72737. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72738. import { Engine } from "babylonjs/Engines/engine";
  72739. import "babylonjs/Shaders/extractHighlights.fragment";
  72740. /**
  72741. * 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.
  72742. */
  72743. export class ExtractHighlightsPostProcess extends PostProcess {
  72744. /**
  72745. * The luminance threshold, pixels below this value will be set to black.
  72746. */
  72747. threshold: number;
  72748. /** @hidden */
  72749. _exposure: number;
  72750. /**
  72751. * Post process which has the input texture to be used when performing highlight extraction
  72752. * @hidden
  72753. */
  72754. _inputPostProcess: Nullable<PostProcess>;
  72755. /**
  72756. * Gets a string identifying the name of the class
  72757. * @returns "ExtractHighlightsPostProcess" string
  72758. */
  72759. getClassName(): string;
  72760. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  72761. }
  72762. }
  72763. declare module "babylonjs/Shaders/bloomMerge.fragment" {
  72764. /** @hidden */
  72765. export var bloomMergePixelShader: {
  72766. name: string;
  72767. shader: string;
  72768. };
  72769. }
  72770. declare module "babylonjs/PostProcesses/bloomMergePostProcess" {
  72771. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72772. import { Nullable } from "babylonjs/types";
  72773. import { Engine } from "babylonjs/Engines/engine";
  72774. import { Camera } from "babylonjs/Cameras/camera";
  72775. import "babylonjs/Shaders/bloomMerge.fragment";
  72776. /**
  72777. * The BloomMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  72778. */
  72779. export class BloomMergePostProcess extends PostProcess {
  72780. /** Weight of the bloom to be added to the original input. */
  72781. weight: number;
  72782. /**
  72783. * Gets a string identifying the name of the class
  72784. * @returns "BloomMergePostProcess" string
  72785. */
  72786. getClassName(): string;
  72787. /**
  72788. * Creates a new instance of @see BloomMergePostProcess
  72789. * @param name The name of the effect.
  72790. * @param originalFromInput Post process which's input will be used for the merge.
  72791. * @param blurred Blurred highlights post process which's output will be used.
  72792. * @param weight Weight of the bloom to be added to the original input.
  72793. * @param options The required width/height ratio to downsize to before computing the render pass.
  72794. * @param camera The camera to apply the render pass to.
  72795. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72796. * @param engine The engine which the post process will be applied. (default: current engine)
  72797. * @param reusable If the post process can be reused on the same frame. (default: false)
  72798. * @param textureType Type of textures used when performing the post process. (default: 0)
  72799. * @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)
  72800. */
  72801. constructor(name: string, originalFromInput: PostProcess, blurred: PostProcess,
  72802. /** Weight of the bloom to be added to the original input. */
  72803. weight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  72804. }
  72805. }
  72806. declare module "babylonjs/PostProcesses/bloomEffect" {
  72807. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  72808. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  72809. import { ExtractHighlightsPostProcess } from "babylonjs/PostProcesses/extractHighlightsPostProcess";
  72810. import { Camera } from "babylonjs/Cameras/camera";
  72811. import { Scene } from "babylonjs/scene";
  72812. /**
  72813. * The bloom effect spreads bright areas of an image to simulate artifacts seen in cameras
  72814. */
  72815. export class BloomEffect extends PostProcessRenderEffect {
  72816. private bloomScale;
  72817. /**
  72818. * @hidden Internal
  72819. */
  72820. _effects: Array<PostProcess>;
  72821. /**
  72822. * @hidden Internal
  72823. */
  72824. _downscale: ExtractHighlightsPostProcess;
  72825. private _blurX;
  72826. private _blurY;
  72827. private _merge;
  72828. /**
  72829. * The luminance threshold to find bright areas of the image to bloom.
  72830. */
  72831. get threshold(): number;
  72832. set threshold(value: number);
  72833. /**
  72834. * The strength of the bloom.
  72835. */
  72836. get weight(): number;
  72837. set weight(value: number);
  72838. /**
  72839. * Specifies the size of the bloom blur kernel, relative to the final output size
  72840. */
  72841. get kernel(): number;
  72842. set kernel(value: number);
  72843. /**
  72844. * Creates a new instance of @see BloomEffect
  72845. * @param scene The scene the effect belongs to.
  72846. * @param bloomScale The ratio of the blur texture to the input texture that should be used to compute the bloom.
  72847. * @param bloomKernel The size of the kernel to be used when applying the blur.
  72848. * @param bloomWeight The the strength of bloom.
  72849. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  72850. * @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)
  72851. */
  72852. constructor(scene: Scene, bloomScale: number, bloomWeight: number, bloomKernel: number, pipelineTextureType?: number, blockCompilation?: boolean);
  72853. /**
  72854. * Disposes each of the internal effects for a given camera.
  72855. * @param camera The camera to dispose the effect on.
  72856. */
  72857. disposeEffects(camera: Camera): void;
  72858. /**
  72859. * @hidden Internal
  72860. */
  72861. _updateEffects(): void;
  72862. /**
  72863. * Internal
  72864. * @returns if all the contained post processes are ready.
  72865. * @hidden
  72866. */
  72867. _isReady(): boolean;
  72868. }
  72869. }
  72870. declare module "babylonjs/Shaders/chromaticAberration.fragment" {
  72871. /** @hidden */
  72872. export var chromaticAberrationPixelShader: {
  72873. name: string;
  72874. shader: string;
  72875. };
  72876. }
  72877. declare module "babylonjs/PostProcesses/chromaticAberrationPostProcess" {
  72878. import { Vector2 } from "babylonjs/Maths/math.vector";
  72879. import { Nullable } from "babylonjs/types";
  72880. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72881. import { Camera } from "babylonjs/Cameras/camera";
  72882. import { Engine } from "babylonjs/Engines/engine";
  72883. import "babylonjs/Shaders/chromaticAberration.fragment";
  72884. import { Scene } from "babylonjs/scene";
  72885. /**
  72886. * The ChromaticAberrationPostProcess separates the rgb channels in an image to produce chromatic distortion around the edges of the screen
  72887. */
  72888. export class ChromaticAberrationPostProcess extends PostProcess {
  72889. /**
  72890. * The amount of seperation of rgb channels (default: 30)
  72891. */
  72892. aberrationAmount: number;
  72893. /**
  72894. * The amount the effect will increase for pixels closer to the edge of the screen. (default: 0)
  72895. */
  72896. radialIntensity: number;
  72897. /**
  72898. * 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))
  72899. */
  72900. direction: Vector2;
  72901. /**
  72902. * 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))
  72903. */
  72904. centerPosition: Vector2;
  72905. /** The width of the screen to apply the effect on */
  72906. screenWidth: number;
  72907. /** The height of the screen to apply the effect on */
  72908. screenHeight: number;
  72909. /**
  72910. * Gets a string identifying the name of the class
  72911. * @returns "ChromaticAberrationPostProcess" string
  72912. */
  72913. getClassName(): string;
  72914. /**
  72915. * Creates a new instance ChromaticAberrationPostProcess
  72916. * @param name The name of the effect.
  72917. * @param screenWidth The width of the screen to apply the effect on.
  72918. * @param screenHeight The height of the screen to apply the effect on.
  72919. * @param options The required width/height ratio to downsize to before computing the render pass.
  72920. * @param camera The camera to apply the render pass to.
  72921. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72922. * @param engine The engine which the post process will be applied. (default: current engine)
  72923. * @param reusable If the post process can be reused on the same frame. (default: false)
  72924. * @param textureType Type of textures used when performing the post process. (default: 0)
  72925. * @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)
  72926. */
  72927. constructor(name: string, screenWidth: number, screenHeight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  72928. /** @hidden */
  72929. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ChromaticAberrationPostProcess>;
  72930. }
  72931. }
  72932. declare module "babylonjs/Shaders/circleOfConfusion.fragment" {
  72933. /** @hidden */
  72934. export var circleOfConfusionPixelShader: {
  72935. name: string;
  72936. shader: string;
  72937. };
  72938. }
  72939. declare module "babylonjs/PostProcesses/circleOfConfusionPostProcess" {
  72940. import { Nullable } from "babylonjs/types";
  72941. import { Engine } from "babylonjs/Engines/engine";
  72942. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72943. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  72944. import { Camera } from "babylonjs/Cameras/camera";
  72945. import "babylonjs/Shaders/circleOfConfusion.fragment";
  72946. /**
  72947. * The CircleOfConfusionPostProcess computes the circle of confusion value for each pixel given required lens parameters. See https://en.wikipedia.org/wiki/Circle_of_confusion
  72948. */
  72949. export class CircleOfConfusionPostProcess extends PostProcess {
  72950. /**
  72951. * 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.
  72952. */
  72953. lensSize: number;
  72954. /**
  72955. * F-Stop of the effect's camera. The diamater of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  72956. */
  72957. fStop: number;
  72958. /**
  72959. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  72960. */
  72961. focusDistance: number;
  72962. /**
  72963. * Focal length of the effect's camera in scene units/1000 (eg. millimeter). (default: 50)
  72964. */
  72965. focalLength: number;
  72966. /**
  72967. * Gets a string identifying the name of the class
  72968. * @returns "CircleOfConfusionPostProcess" string
  72969. */
  72970. getClassName(): string;
  72971. private _depthTexture;
  72972. /**
  72973. * Creates a new instance CircleOfConfusionPostProcess
  72974. * @param name The name of the effect.
  72975. * @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.
  72976. * @param options The required width/height ratio to downsize to before computing the render pass.
  72977. * @param camera The camera to apply the render pass to.
  72978. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72979. * @param engine The engine which the post process will be applied. (default: current engine)
  72980. * @param reusable If the post process can be reused on the same frame. (default: false)
  72981. * @param textureType Type of textures used when performing the post process. (default: 0)
  72982. * @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)
  72983. */
  72984. constructor(name: string, depthTexture: Nullable<RenderTargetTexture>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  72985. /**
  72986. * 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.
  72987. */
  72988. set depthTexture(value: RenderTargetTexture);
  72989. }
  72990. }
  72991. declare module "babylonjs/Shaders/colorCorrection.fragment" {
  72992. /** @hidden */
  72993. export var colorCorrectionPixelShader: {
  72994. name: string;
  72995. shader: string;
  72996. };
  72997. }
  72998. declare module "babylonjs/PostProcesses/colorCorrectionPostProcess" {
  72999. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73000. import { Engine } from "babylonjs/Engines/engine";
  73001. import { Camera } from "babylonjs/Cameras/camera";
  73002. import "babylonjs/Shaders/colorCorrection.fragment";
  73003. import { Nullable } from "babylonjs/types";
  73004. import { Scene } from "babylonjs/scene";
  73005. /**
  73006. *
  73007. * This post-process allows the modification of rendered colors by using
  73008. * a 'look-up table' (LUT). This effect is also called Color Grading.
  73009. *
  73010. * The object needs to be provided an url to a texture containing the color
  73011. * look-up table: the texture must be 256 pixels wide and 16 pixels high.
  73012. * Use an image editing software to tweak the LUT to match your needs.
  73013. *
  73014. * For an example of a color LUT, see here:
  73015. * @see http://udn.epicgames.com/Three/rsrc/Three/ColorGrading/RGBTable16x1.png
  73016. * For explanations on color grading, see here:
  73017. * @see http://udn.epicgames.com/Three/ColorGrading.html
  73018. *
  73019. */
  73020. export class ColorCorrectionPostProcess extends PostProcess {
  73021. private _colorTableTexture;
  73022. /**
  73023. * Gets the color table url used to create the LUT texture
  73024. */
  73025. colorTableUrl: string;
  73026. /**
  73027. * Gets a string identifying the name of the class
  73028. * @returns "ColorCorrectionPostProcess" string
  73029. */
  73030. getClassName(): string;
  73031. constructor(name: string, colorTableUrl: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  73032. /** @hidden */
  73033. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ColorCorrectionPostProcess>;
  73034. }
  73035. }
  73036. declare module "babylonjs/Shaders/convolution.fragment" {
  73037. /** @hidden */
  73038. export var convolutionPixelShader: {
  73039. name: string;
  73040. shader: string;
  73041. };
  73042. }
  73043. declare module "babylonjs/PostProcesses/convolutionPostProcess" {
  73044. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73045. import { Nullable } from "babylonjs/types";
  73046. import { Camera } from "babylonjs/Cameras/camera";
  73047. import { Engine } from "babylonjs/Engines/engine";
  73048. import "babylonjs/Shaders/convolution.fragment";
  73049. import { Scene } from "babylonjs/scene";
  73050. /**
  73051. * The ConvolutionPostProcess applies a 3x3 kernel to every pixel of the
  73052. * input texture to perform effects such as edge detection or sharpening
  73053. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  73054. */
  73055. export class ConvolutionPostProcess extends PostProcess {
  73056. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  73057. kernel: number[];
  73058. /**
  73059. * Gets a string identifying the name of the class
  73060. * @returns "ConvolutionPostProcess" string
  73061. */
  73062. getClassName(): string;
  73063. /**
  73064. * Creates a new instance ConvolutionPostProcess
  73065. * @param name The name of the effect.
  73066. * @param kernel Array of 9 values corresponding to the 3x3 kernel to be applied
  73067. * @param options The required width/height ratio to downsize to before computing the render pass.
  73068. * @param camera The camera to apply the render pass to.
  73069. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73070. * @param engine The engine which the post process will be applied. (default: current engine)
  73071. * @param reusable If the post process can be reused on the same frame. (default: false)
  73072. * @param textureType Type of textures used when performing the post process. (default: 0)
  73073. */
  73074. constructor(name: string, kernel: number[], options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  73075. /** @hidden */
  73076. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ConvolutionPostProcess>;
  73077. /**
  73078. * Edge detection 0 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  73079. */
  73080. static EdgeDetect0Kernel: number[];
  73081. /**
  73082. * Edge detection 1 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  73083. */
  73084. static EdgeDetect1Kernel: number[];
  73085. /**
  73086. * Edge detection 2 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  73087. */
  73088. static EdgeDetect2Kernel: number[];
  73089. /**
  73090. * Kernel to sharpen an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  73091. */
  73092. static SharpenKernel: number[];
  73093. /**
  73094. * Kernel to emboss an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  73095. */
  73096. static EmbossKernel: number[];
  73097. /**
  73098. * Kernel to blur an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  73099. */
  73100. static GaussianKernel: number[];
  73101. }
  73102. }
  73103. declare module "babylonjs/PostProcesses/depthOfFieldBlurPostProcess" {
  73104. import { Nullable } from "babylonjs/types";
  73105. import { Vector2 } from "babylonjs/Maths/math.vector";
  73106. import { Camera } from "babylonjs/Cameras/camera";
  73107. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73108. import { BlurPostProcess } from "babylonjs/PostProcesses/blurPostProcess";
  73109. import { Engine } from "babylonjs/Engines/engine";
  73110. import { Scene } from "babylonjs/scene";
  73111. /**
  73112. * The DepthOfFieldBlurPostProcess applied a blur in a give direction.
  73113. * This blur differs from the standard BlurPostProcess as it attempts to avoid blurring pixels
  73114. * based on samples that have a large difference in distance than the center pixel.
  73115. * See section 2.6.2 http://fileadmin.cs.lth.se/cs/education/edan35/lectures/12dof.pdf
  73116. */
  73117. export class DepthOfFieldBlurPostProcess extends BlurPostProcess {
  73118. /**
  73119. * The direction the blur should be applied
  73120. */
  73121. direction: Vector2;
  73122. /**
  73123. * Gets a string identifying the name of the class
  73124. * @returns "DepthOfFieldBlurPostProcess" string
  73125. */
  73126. getClassName(): string;
  73127. /**
  73128. * Creates a new instance CircleOfConfusionPostProcess
  73129. * @param name The name of the effect.
  73130. * @param scene The scene the effect belongs to.
  73131. * @param direction The direction the blur should be applied.
  73132. * @param kernel The size of the kernel used to blur.
  73133. * @param options The required width/height ratio to downsize to before computing the render pass.
  73134. * @param camera The camera to apply the render pass to.
  73135. * @param circleOfConfusion The circle of confusion + depth map to be used to avoid blurring accross edges
  73136. * @param imageToBlur The image to apply the blur to (default: Current rendered frame)
  73137. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73138. * @param engine The engine which the post process will be applied. (default: current engine)
  73139. * @param reusable If the post process can be reused on the same frame. (default: false)
  73140. * @param textureType Type of textures used when performing the post process. (default: 0)
  73141. * @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)
  73142. */
  73143. 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);
  73144. }
  73145. }
  73146. declare module "babylonjs/Shaders/depthOfFieldMerge.fragment" {
  73147. /** @hidden */
  73148. export var depthOfFieldMergePixelShader: {
  73149. name: string;
  73150. shader: string;
  73151. };
  73152. }
  73153. declare module "babylonjs/PostProcesses/depthOfFieldMergePostProcess" {
  73154. import { Nullable } from "babylonjs/types";
  73155. import { Camera } from "babylonjs/Cameras/camera";
  73156. import { Effect } from "babylonjs/Materials/effect";
  73157. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73158. import { Engine } from "babylonjs/Engines/engine";
  73159. import "babylonjs/Shaders/depthOfFieldMerge.fragment";
  73160. /**
  73161. * Options to be set when merging outputs from the default pipeline.
  73162. */
  73163. export class DepthOfFieldMergePostProcessOptions {
  73164. /**
  73165. * The original image to merge on top of
  73166. */
  73167. originalFromInput: PostProcess;
  73168. /**
  73169. * Parameters to perform the merge of the depth of field effect
  73170. */
  73171. depthOfField?: {
  73172. circleOfConfusion: PostProcess;
  73173. blurSteps: Array<PostProcess>;
  73174. };
  73175. /**
  73176. * Parameters to perform the merge of bloom effect
  73177. */
  73178. bloom?: {
  73179. blurred: PostProcess;
  73180. weight: number;
  73181. };
  73182. }
  73183. /**
  73184. * The DepthOfFieldMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  73185. */
  73186. export class DepthOfFieldMergePostProcess extends PostProcess {
  73187. private blurSteps;
  73188. /**
  73189. * Gets a string identifying the name of the class
  73190. * @returns "DepthOfFieldMergePostProcess" string
  73191. */
  73192. getClassName(): string;
  73193. /**
  73194. * Creates a new instance of DepthOfFieldMergePostProcess
  73195. * @param name The name of the effect.
  73196. * @param originalFromInput Post process which's input will be used for the merge.
  73197. * @param circleOfConfusion Circle of confusion post process which's output will be used to blur each pixel.
  73198. * @param blurSteps Blur post processes from low to high which will be mixed with the original image.
  73199. * @param options The required width/height ratio to downsize to before computing the render pass.
  73200. * @param camera The camera to apply the render pass to.
  73201. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73202. * @param engine The engine which the post process will be applied. (default: current engine)
  73203. * @param reusable If the post process can be reused on the same frame. (default: false)
  73204. * @param textureType Type of textures used when performing the post process. (default: 0)
  73205. * @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)
  73206. */
  73207. 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);
  73208. /**
  73209. * Updates the effect with the current post process compile time values and recompiles the shader.
  73210. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  73211. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  73212. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  73213. * @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
  73214. * @param onCompiled Called when the shader has been compiled.
  73215. * @param onError Called if there is an error when compiling a shader.
  73216. */
  73217. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  73218. }
  73219. }
  73220. declare module "babylonjs/PostProcesses/depthOfFieldEffect" {
  73221. import { Nullable } from "babylonjs/types";
  73222. import { Camera } from "babylonjs/Cameras/camera";
  73223. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  73224. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  73225. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  73226. import { DepthOfFieldBlurPostProcess } from "babylonjs/PostProcesses/depthOfFieldBlurPostProcess";
  73227. import { Scene } from "babylonjs/scene";
  73228. /**
  73229. * Specifies the level of max blur that should be applied when using the depth of field effect
  73230. */
  73231. export enum DepthOfFieldEffectBlurLevel {
  73232. /**
  73233. * Subtle blur
  73234. */
  73235. Low = 0,
  73236. /**
  73237. * Medium blur
  73238. */
  73239. Medium = 1,
  73240. /**
  73241. * Large blur
  73242. */
  73243. High = 2
  73244. }
  73245. /**
  73246. * The depth of field effect applies a blur to objects that are closer or further from where the camera is focusing.
  73247. */
  73248. export class DepthOfFieldEffect extends PostProcessRenderEffect {
  73249. private _circleOfConfusion;
  73250. /**
  73251. * @hidden Internal, blurs from high to low
  73252. */
  73253. _depthOfFieldBlurX: Array<DepthOfFieldBlurPostProcess>;
  73254. private _depthOfFieldBlurY;
  73255. private _dofMerge;
  73256. /**
  73257. * @hidden Internal post processes in depth of field effect
  73258. */
  73259. _effects: Array<PostProcess>;
  73260. /**
  73261. * The focal the length of the camera used in the effect in scene units/1000 (eg. millimeter)
  73262. */
  73263. set focalLength(value: number);
  73264. get focalLength(): number;
  73265. /**
  73266. * F-Stop of the effect's camera. The diameter of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  73267. */
  73268. set fStop(value: number);
  73269. get fStop(): number;
  73270. /**
  73271. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  73272. */
  73273. set focusDistance(value: number);
  73274. get focusDistance(): number;
  73275. /**
  73276. * 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.
  73277. */
  73278. set lensSize(value: number);
  73279. get lensSize(): number;
  73280. /**
  73281. * Creates a new instance DepthOfFieldEffect
  73282. * @param scene The scene the effect belongs to.
  73283. * @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.
  73284. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  73285. * @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)
  73286. */
  73287. constructor(scene: Scene, depthTexture: Nullable<RenderTargetTexture>, blurLevel?: DepthOfFieldEffectBlurLevel, pipelineTextureType?: number, blockCompilation?: boolean);
  73288. /**
  73289. * Get the current class name of the current effet
  73290. * @returns "DepthOfFieldEffect"
  73291. */
  73292. getClassName(): string;
  73293. /**
  73294. * 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.
  73295. */
  73296. set depthTexture(value: RenderTargetTexture);
  73297. /**
  73298. * Disposes each of the internal effects for a given camera.
  73299. * @param camera The camera to dispose the effect on.
  73300. */
  73301. disposeEffects(camera: Camera): void;
  73302. /**
  73303. * @hidden Internal
  73304. */
  73305. _updateEffects(): void;
  73306. /**
  73307. * Internal
  73308. * @returns if all the contained post processes are ready.
  73309. * @hidden
  73310. */
  73311. _isReady(): boolean;
  73312. }
  73313. }
  73314. declare module "babylonjs/Shaders/displayPass.fragment" {
  73315. /** @hidden */
  73316. export var displayPassPixelShader: {
  73317. name: string;
  73318. shader: string;
  73319. };
  73320. }
  73321. declare module "babylonjs/PostProcesses/displayPassPostProcess" {
  73322. import { Nullable } from "babylonjs/types";
  73323. import { Camera } from "babylonjs/Cameras/camera";
  73324. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73325. import { Engine } from "babylonjs/Engines/engine";
  73326. import "babylonjs/Shaders/displayPass.fragment";
  73327. import { Scene } from "babylonjs/scene";
  73328. /**
  73329. * DisplayPassPostProcess which produces an output the same as it's input
  73330. */
  73331. export class DisplayPassPostProcess extends PostProcess {
  73332. /**
  73333. * Gets a string identifying the name of the class
  73334. * @returns "DisplayPassPostProcess" string
  73335. */
  73336. getClassName(): string;
  73337. /**
  73338. * Creates the DisplayPassPostProcess
  73339. * @param name The name of the effect.
  73340. * @param options The required width/height ratio to downsize to before computing the render pass.
  73341. * @param camera The camera to apply the render pass to.
  73342. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73343. * @param engine The engine which the post process will be applied. (default: current engine)
  73344. * @param reusable If the post process can be reused on the same frame. (default: false)
  73345. */
  73346. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  73347. /** @hidden */
  73348. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<DisplayPassPostProcess>;
  73349. }
  73350. }
  73351. declare module "babylonjs/Shaders/filter.fragment" {
  73352. /** @hidden */
  73353. export var filterPixelShader: {
  73354. name: string;
  73355. shader: string;
  73356. };
  73357. }
  73358. declare module "babylonjs/PostProcesses/filterPostProcess" {
  73359. import { Nullable } from "babylonjs/types";
  73360. import { Matrix } from "babylonjs/Maths/math.vector";
  73361. import { Camera } from "babylonjs/Cameras/camera";
  73362. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73363. import { Engine } from "babylonjs/Engines/engine";
  73364. import "babylonjs/Shaders/filter.fragment";
  73365. import { Scene } from "babylonjs/scene";
  73366. /**
  73367. * Applies a kernel filter to the image
  73368. */
  73369. export class FilterPostProcess extends PostProcess {
  73370. /** The matrix to be applied to the image */
  73371. kernelMatrix: Matrix;
  73372. /**
  73373. * Gets a string identifying the name of the class
  73374. * @returns "FilterPostProcess" string
  73375. */
  73376. getClassName(): string;
  73377. /**
  73378. *
  73379. * @param name The name of the effect.
  73380. * @param kernelMatrix The matrix to be applied to the image
  73381. * @param options The required width/height ratio to downsize to before computing the render pass.
  73382. * @param camera The camera to apply the render pass to.
  73383. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73384. * @param engine The engine which the post process will be applied. (default: current engine)
  73385. * @param reusable If the post process can be reused on the same frame. (default: false)
  73386. */
  73387. constructor(name: string, kernelMatrix: Matrix, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  73388. /** @hidden */
  73389. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<FilterPostProcess>;
  73390. }
  73391. }
  73392. declare module "babylonjs/Shaders/fxaa.fragment" {
  73393. /** @hidden */
  73394. export var fxaaPixelShader: {
  73395. name: string;
  73396. shader: string;
  73397. };
  73398. }
  73399. declare module "babylonjs/Shaders/fxaa.vertex" {
  73400. /** @hidden */
  73401. export var fxaaVertexShader: {
  73402. name: string;
  73403. shader: string;
  73404. };
  73405. }
  73406. declare module "babylonjs/PostProcesses/fxaaPostProcess" {
  73407. import { Nullable } from "babylonjs/types";
  73408. import { Camera } from "babylonjs/Cameras/camera";
  73409. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73410. import { Engine } from "babylonjs/Engines/engine";
  73411. import "babylonjs/Shaders/fxaa.fragment";
  73412. import "babylonjs/Shaders/fxaa.vertex";
  73413. import { Scene } from "babylonjs/scene";
  73414. /**
  73415. * Fxaa post process
  73416. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#fxaa
  73417. */
  73418. export class FxaaPostProcess extends PostProcess {
  73419. /**
  73420. * Gets a string identifying the name of the class
  73421. * @returns "FxaaPostProcess" string
  73422. */
  73423. getClassName(): string;
  73424. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  73425. private _getDefines;
  73426. /** @hidden */
  73427. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): FxaaPostProcess;
  73428. }
  73429. }
  73430. declare module "babylonjs/Shaders/grain.fragment" {
  73431. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  73432. /** @hidden */
  73433. export var grainPixelShader: {
  73434. name: string;
  73435. shader: string;
  73436. };
  73437. }
  73438. declare module "babylonjs/PostProcesses/grainPostProcess" {
  73439. import { Nullable } from "babylonjs/types";
  73440. import { Camera } from "babylonjs/Cameras/camera";
  73441. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73442. import { Engine } from "babylonjs/Engines/engine";
  73443. import "babylonjs/Shaders/grain.fragment";
  73444. import { Scene } from "babylonjs/scene";
  73445. /**
  73446. * The GrainPostProcess adds noise to the image at mid luminance levels
  73447. */
  73448. export class GrainPostProcess extends PostProcess {
  73449. /**
  73450. * The intensity of the grain added (default: 30)
  73451. */
  73452. intensity: number;
  73453. /**
  73454. * If the grain should be randomized on every frame
  73455. */
  73456. animated: boolean;
  73457. /**
  73458. * Gets a string identifying the name of the class
  73459. * @returns "GrainPostProcess" string
  73460. */
  73461. getClassName(): string;
  73462. /**
  73463. * Creates a new instance of @see GrainPostProcess
  73464. * @param name The name of the effect.
  73465. * @param options The required width/height ratio to downsize to before computing the render pass.
  73466. * @param camera The camera to apply the render pass to.
  73467. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73468. * @param engine The engine which the post process will be applied. (default: current engine)
  73469. * @param reusable If the post process can be reused on the same frame. (default: false)
  73470. * @param textureType Type of textures used when performing the post process. (default: 0)
  73471. * @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)
  73472. */
  73473. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  73474. /** @hidden */
  73475. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): GrainPostProcess;
  73476. }
  73477. }
  73478. declare module "babylonjs/Shaders/highlights.fragment" {
  73479. /** @hidden */
  73480. export var highlightsPixelShader: {
  73481. name: string;
  73482. shader: string;
  73483. };
  73484. }
  73485. declare module "babylonjs/PostProcesses/highlightsPostProcess" {
  73486. import { Nullable } from "babylonjs/types";
  73487. import { Camera } from "babylonjs/Cameras/camera";
  73488. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73489. import { Engine } from "babylonjs/Engines/engine";
  73490. import "babylonjs/Shaders/highlights.fragment";
  73491. /**
  73492. * Extracts highlights from the image
  73493. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  73494. */
  73495. export class HighlightsPostProcess extends PostProcess {
  73496. /**
  73497. * Gets a string identifying the name of the class
  73498. * @returns "HighlightsPostProcess" string
  73499. */
  73500. getClassName(): string;
  73501. /**
  73502. * Extracts highlights from the image
  73503. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  73504. * @param name The name of the effect.
  73505. * @param options The required width/height ratio to downsize to before computing the render pass.
  73506. * @param camera The camera to apply the render pass to.
  73507. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73508. * @param engine The engine which the post process will be applied. (default: current engine)
  73509. * @param reusable If the post process can be reused on the same frame. (default: false)
  73510. * @param textureType Type of texture for the post process (default: Engine.TEXTURETYPE_UNSIGNED_INT)
  73511. */
  73512. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  73513. }
  73514. }
  73515. declare module "babylonjs/Shaders/ShadersInclude/mrtFragmentDeclaration" {
  73516. /** @hidden */
  73517. export var mrtFragmentDeclaration: {
  73518. name: string;
  73519. shader: string;
  73520. };
  73521. }
  73522. declare module "babylonjs/Shaders/geometry.fragment" {
  73523. import "babylonjs/Shaders/ShadersInclude/mrtFragmentDeclaration";
  73524. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  73525. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  73526. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  73527. /** @hidden */
  73528. export var geometryPixelShader: {
  73529. name: string;
  73530. shader: string;
  73531. };
  73532. }
  73533. declare module "babylonjs/Shaders/geometry.vertex" {
  73534. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  73535. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  73536. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  73537. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  73538. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  73539. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  73540. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  73541. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  73542. /** @hidden */
  73543. export var geometryVertexShader: {
  73544. name: string;
  73545. shader: string;
  73546. };
  73547. }
  73548. declare module "babylonjs/Rendering/geometryBufferRenderer" {
  73549. import { Matrix } from "babylonjs/Maths/math.vector";
  73550. import { SubMesh } from "babylonjs/Meshes/subMesh";
  73551. import { Mesh } from "babylonjs/Meshes/mesh";
  73552. import { MultiRenderTarget } from "babylonjs/Materials/Textures/multiRenderTarget";
  73553. import { Effect } from "babylonjs/Materials/effect";
  73554. import { Scene } from "babylonjs/scene";
  73555. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  73556. import "babylonjs/Shaders/geometry.fragment";
  73557. import "babylonjs/Shaders/geometry.vertex";
  73558. /** @hidden */
  73559. interface ISavedTransformationMatrix {
  73560. world: Matrix;
  73561. viewProjection: Matrix;
  73562. }
  73563. /**
  73564. * This renderer is helpfull to fill one of the render target with a geometry buffer.
  73565. */
  73566. export class GeometryBufferRenderer {
  73567. /**
  73568. * Constant used to retrieve the position texture index in the G-Buffer textures array
  73569. * using getIndex(GeometryBufferRenderer.POSITION_TEXTURE_INDEX)
  73570. */
  73571. static readonly POSITION_TEXTURE_TYPE: number;
  73572. /**
  73573. * Constant used to retrieve the velocity texture index in the G-Buffer textures array
  73574. * using getIndex(GeometryBufferRenderer.VELOCITY_TEXTURE_INDEX)
  73575. */
  73576. static readonly VELOCITY_TEXTURE_TYPE: number;
  73577. /**
  73578. * Constant used to retrieve the reflectivity texture index in the G-Buffer textures array
  73579. * using the getIndex(GeometryBufferRenderer.REFLECTIVITY_TEXTURE_TYPE)
  73580. */
  73581. static readonly REFLECTIVITY_TEXTURE_TYPE: number;
  73582. /**
  73583. * Dictionary used to store the previous transformation matrices of each rendered mesh
  73584. * in order to compute objects velocities when enableVelocity is set to "true"
  73585. * @hidden
  73586. */
  73587. _previousTransformationMatrices: {
  73588. [index: number]: ISavedTransformationMatrix;
  73589. };
  73590. /**
  73591. * Dictionary used to store the previous bones transformation matrices of each rendered mesh
  73592. * in order to compute objects velocities when enableVelocity is set to "true"
  73593. * @hidden
  73594. */
  73595. _previousBonesTransformationMatrices: {
  73596. [index: number]: Float32Array;
  73597. };
  73598. /**
  73599. * Array used to store the ignored skinned meshes while computing velocity map (typically used by the motion blur post-process).
  73600. * Avoids computing bones velocities and computes only mesh's velocity itself (position, rotation, scaling).
  73601. */
  73602. excludedSkinnedMeshesFromVelocity: AbstractMesh[];
  73603. /** Gets or sets a boolean indicating if transparent meshes should be rendered */
  73604. renderTransparentMeshes: boolean;
  73605. private _scene;
  73606. private _resizeObserver;
  73607. private _multiRenderTarget;
  73608. private _ratio;
  73609. private _enablePosition;
  73610. private _enableVelocity;
  73611. private _enableReflectivity;
  73612. private _positionIndex;
  73613. private _velocityIndex;
  73614. private _reflectivityIndex;
  73615. protected _effect: Effect;
  73616. protected _cachedDefines: string;
  73617. /**
  73618. * Set the render list (meshes to be rendered) used in the G buffer.
  73619. */
  73620. set renderList(meshes: Mesh[]);
  73621. /**
  73622. * Gets wether or not G buffer are supported by the running hardware.
  73623. * This requires draw buffer supports
  73624. */
  73625. get isSupported(): boolean;
  73626. /**
  73627. * Returns the index of the given texture type in the G-Buffer textures array
  73628. * @param textureType The texture type constant. For example GeometryBufferRenderer.POSITION_TEXTURE_INDEX
  73629. * @returns the index of the given texture type in the G-Buffer textures array
  73630. */
  73631. getTextureIndex(textureType: number): number;
  73632. /**
  73633. * Gets a boolean indicating if objects positions are enabled for the G buffer.
  73634. */
  73635. get enablePosition(): boolean;
  73636. /**
  73637. * Sets whether or not objects positions are enabled for the G buffer.
  73638. */
  73639. set enablePosition(enable: boolean);
  73640. /**
  73641. * Gets a boolean indicating if objects velocities are enabled for the G buffer.
  73642. */
  73643. get enableVelocity(): boolean;
  73644. /**
  73645. * Sets wether or not objects velocities are enabled for the G buffer.
  73646. */
  73647. set enableVelocity(enable: boolean);
  73648. /**
  73649. * Gets a boolean indicating if objects roughness are enabled in the G buffer.
  73650. */
  73651. get enableReflectivity(): boolean;
  73652. /**
  73653. * Sets wether or not objects roughness are enabled for the G buffer.
  73654. */
  73655. set enableReflectivity(enable: boolean);
  73656. /**
  73657. * Gets the scene associated with the buffer.
  73658. */
  73659. get scene(): Scene;
  73660. /**
  73661. * Gets the ratio used by the buffer during its creation.
  73662. * How big is the buffer related to the main canvas.
  73663. */
  73664. get ratio(): number;
  73665. /** @hidden */
  73666. static _SceneComponentInitialization: (scene: Scene) => void;
  73667. /**
  73668. * Creates a new G Buffer for the scene
  73669. * @param scene The scene the buffer belongs to
  73670. * @param ratio How big is the buffer related to the main canvas.
  73671. */
  73672. constructor(scene: Scene, ratio?: number);
  73673. /**
  73674. * Checks wether everything is ready to render a submesh to the G buffer.
  73675. * @param subMesh the submesh to check readiness for
  73676. * @param useInstances is the mesh drawn using instance or not
  73677. * @returns true if ready otherwise false
  73678. */
  73679. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  73680. /**
  73681. * Gets the current underlying G Buffer.
  73682. * @returns the buffer
  73683. */
  73684. getGBuffer(): MultiRenderTarget;
  73685. /**
  73686. * Gets the number of samples used to render the buffer (anti aliasing).
  73687. */
  73688. get samples(): number;
  73689. /**
  73690. * Sets the number of samples used to render the buffer (anti aliasing).
  73691. */
  73692. set samples(value: number);
  73693. /**
  73694. * Disposes the renderer and frees up associated resources.
  73695. */
  73696. dispose(): void;
  73697. protected _createRenderTargets(): void;
  73698. private _copyBonesTransformationMatrices;
  73699. }
  73700. }
  73701. declare module "babylonjs/Rendering/geometryBufferRendererSceneComponent" {
  73702. import { Nullable } from "babylonjs/types";
  73703. import { Scene } from "babylonjs/scene";
  73704. import { ISceneComponent } from "babylonjs/sceneComponent";
  73705. import { GeometryBufferRenderer } from "babylonjs/Rendering/geometryBufferRenderer";
  73706. module "babylonjs/scene" {
  73707. interface Scene {
  73708. /** @hidden (Backing field) */
  73709. _geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  73710. /**
  73711. * Gets or Sets the current geometry buffer associated to the scene.
  73712. */
  73713. geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  73714. /**
  73715. * Enables a GeometryBufferRender and associates it with the scene
  73716. * @param ratio defines the scaling ratio to apply to the renderer (1 by default which means same resolution)
  73717. * @returns the GeometryBufferRenderer
  73718. */
  73719. enableGeometryBufferRenderer(ratio?: number): Nullable<GeometryBufferRenderer>;
  73720. /**
  73721. * Disables the GeometryBufferRender associated with the scene
  73722. */
  73723. disableGeometryBufferRenderer(): void;
  73724. }
  73725. }
  73726. /**
  73727. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  73728. * in several rendering techniques.
  73729. */
  73730. export class GeometryBufferRendererSceneComponent implements ISceneComponent {
  73731. /**
  73732. * The component name helpful to identify the component in the list of scene components.
  73733. */
  73734. readonly name: string;
  73735. /**
  73736. * The scene the component belongs to.
  73737. */
  73738. scene: Scene;
  73739. /**
  73740. * Creates a new instance of the component for the given scene
  73741. * @param scene Defines the scene to register the component in
  73742. */
  73743. constructor(scene: Scene);
  73744. /**
  73745. * Registers the component in a given scene
  73746. */
  73747. register(): void;
  73748. /**
  73749. * Rebuilds the elements related to this component in case of
  73750. * context lost for instance.
  73751. */
  73752. rebuild(): void;
  73753. /**
  73754. * Disposes the component and the associated ressources
  73755. */
  73756. dispose(): void;
  73757. private _gatherRenderTargets;
  73758. }
  73759. }
  73760. declare module "babylonjs/Shaders/motionBlur.fragment" {
  73761. /** @hidden */
  73762. export var motionBlurPixelShader: {
  73763. name: string;
  73764. shader: string;
  73765. };
  73766. }
  73767. declare module "babylonjs/PostProcesses/motionBlurPostProcess" {
  73768. import { Nullable } from "babylonjs/types";
  73769. import { Camera } from "babylonjs/Cameras/camera";
  73770. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73771. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  73772. import "babylonjs/Animations/animatable";
  73773. import "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  73774. import "babylonjs/Shaders/motionBlur.fragment";
  73775. import { Engine } from "babylonjs/Engines/engine";
  73776. import { Scene } from "babylonjs/scene";
  73777. /**
  73778. * The Motion Blur Post Process which blurs an image based on the objects velocity in scene.
  73779. * Velocity can be affected by each object's rotation, position and scale depending on the transformation speed.
  73780. * As an example, all you have to do is to create the post-process:
  73781. * var mb = new BABYLON.MotionBlurPostProcess(
  73782. * 'mb', // The name of the effect.
  73783. * scene, // The scene containing the objects to blur according to their velocity.
  73784. * 1.0, // The required width/height ratio to downsize to before computing the render pass.
  73785. * camera // The camera to apply the render pass to.
  73786. * );
  73787. * Then, all objects moving, rotating and/or scaling will be blurred depending on the transformation speed.
  73788. */
  73789. export class MotionBlurPostProcess extends PostProcess {
  73790. /**
  73791. * Defines how much the image is blurred by the movement. Default value is equal to 1
  73792. */
  73793. motionStrength: number;
  73794. /**
  73795. * Gets the number of iterations are used for motion blur quality. Default value is equal to 32
  73796. */
  73797. get motionBlurSamples(): number;
  73798. /**
  73799. * Sets the number of iterations to be used for motion blur quality
  73800. */
  73801. set motionBlurSamples(samples: number);
  73802. private _motionBlurSamples;
  73803. private _geometryBufferRenderer;
  73804. /**
  73805. * Gets a string identifying the name of the class
  73806. * @returns "MotionBlurPostProcess" string
  73807. */
  73808. getClassName(): string;
  73809. /**
  73810. * Creates a new instance MotionBlurPostProcess
  73811. * @param name The name of the effect.
  73812. * @param scene The scene containing the objects to blur according to their velocity.
  73813. * @param options The required width/height ratio to downsize to before computing the render pass.
  73814. * @param camera The camera to apply the render pass to.
  73815. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73816. * @param engine The engine which the post process will be applied. (default: current engine)
  73817. * @param reusable If the post process can be reused on the same frame. (default: false)
  73818. * @param textureType Type of textures used when performing the post process. (default: 0)
  73819. * @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)
  73820. */
  73821. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  73822. /**
  73823. * Excludes the given skinned mesh from computing bones velocities.
  73824. * 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.
  73825. * @param skinnedMesh The mesh containing the skeleton to ignore when computing the velocity map.
  73826. */
  73827. excludeSkinnedMesh(skinnedMesh: AbstractMesh): void;
  73828. /**
  73829. * Removes the given skinned mesh from the excluded meshes to integrate bones velocities while rendering the velocity map.
  73830. * @param skinnedMesh The mesh containing the skeleton that has been ignored previously.
  73831. * @see excludeSkinnedMesh to exclude a skinned mesh from bones velocity computation.
  73832. */
  73833. removeExcludedSkinnedMesh(skinnedMesh: AbstractMesh): void;
  73834. /**
  73835. * Disposes the post process.
  73836. * @param camera The camera to dispose the post process on.
  73837. */
  73838. dispose(camera?: Camera): void;
  73839. /** @hidden */
  73840. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<MotionBlurPostProcess>;
  73841. }
  73842. }
  73843. declare module "babylonjs/Shaders/refraction.fragment" {
  73844. /** @hidden */
  73845. export var refractionPixelShader: {
  73846. name: string;
  73847. shader: string;
  73848. };
  73849. }
  73850. declare module "babylonjs/PostProcesses/refractionPostProcess" {
  73851. import { Color3 } from "babylonjs/Maths/math.color";
  73852. import { Camera } from "babylonjs/Cameras/camera";
  73853. import { Texture } from "babylonjs/Materials/Textures/texture";
  73854. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73855. import { Engine } from "babylonjs/Engines/engine";
  73856. import "babylonjs/Shaders/refraction.fragment";
  73857. import { Scene } from "babylonjs/scene";
  73858. /**
  73859. * Post process which applies a refractin texture
  73860. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  73861. */
  73862. export class RefractionPostProcess extends PostProcess {
  73863. private _refTexture;
  73864. private _ownRefractionTexture;
  73865. /** the base color of the refraction (used to taint the rendering) */
  73866. color: Color3;
  73867. /** simulated refraction depth */
  73868. depth: number;
  73869. /** the coefficient of the base color (0 to remove base color tainting) */
  73870. colorLevel: number;
  73871. /** Gets the url used to load the refraction texture */
  73872. refractionTextureUrl: string;
  73873. /**
  73874. * Gets or sets the refraction texture
  73875. * Please note that you are responsible for disposing the texture if you set it manually
  73876. */
  73877. get refractionTexture(): Texture;
  73878. set refractionTexture(value: Texture);
  73879. /**
  73880. * Gets a string identifying the name of the class
  73881. * @returns "RefractionPostProcess" string
  73882. */
  73883. getClassName(): string;
  73884. /**
  73885. * Initializes the RefractionPostProcess
  73886. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  73887. * @param name The name of the effect.
  73888. * @param refractionTextureUrl Url of the refraction texture to use
  73889. * @param color the base color of the refraction (used to taint the rendering)
  73890. * @param depth simulated refraction depth
  73891. * @param colorLevel the coefficient of the base color (0 to remove base color tainting)
  73892. * @param camera The camera to apply the render pass to.
  73893. * @param options The required width/height ratio to downsize to before computing the render pass.
  73894. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73895. * @param engine The engine which the post process will be applied. (default: current engine)
  73896. * @param reusable If the post process can be reused on the same frame. (default: false)
  73897. */
  73898. constructor(name: string, refractionTextureUrl: string, color: Color3, depth: number, colorLevel: number, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  73899. /**
  73900. * Disposes of the post process
  73901. * @param camera Camera to dispose post process on
  73902. */
  73903. dispose(camera: Camera): void;
  73904. /** @hidden */
  73905. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): RefractionPostProcess;
  73906. }
  73907. }
  73908. declare module "babylonjs/Shaders/sharpen.fragment" {
  73909. /** @hidden */
  73910. export var sharpenPixelShader: {
  73911. name: string;
  73912. shader: string;
  73913. };
  73914. }
  73915. declare module "babylonjs/PostProcesses/sharpenPostProcess" {
  73916. import { Nullable } from "babylonjs/types";
  73917. import { Camera } from "babylonjs/Cameras/camera";
  73918. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73919. import "babylonjs/Shaders/sharpen.fragment";
  73920. import { Engine } from "babylonjs/Engines/engine";
  73921. import { Scene } from "babylonjs/scene";
  73922. /**
  73923. * The SharpenPostProcess applies a sharpen kernel to every pixel
  73924. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  73925. */
  73926. export class SharpenPostProcess extends PostProcess {
  73927. /**
  73928. * How much of the original color should be applied. Setting this to 0 will display edge detection. (default: 1)
  73929. */
  73930. colorAmount: number;
  73931. /**
  73932. * How much sharpness should be applied (default: 0.3)
  73933. */
  73934. edgeAmount: number;
  73935. /**
  73936. * Gets a string identifying the name of the class
  73937. * @returns "SharpenPostProcess" string
  73938. */
  73939. getClassName(): string;
  73940. /**
  73941. * Creates a new instance ConvolutionPostProcess
  73942. * @param name The name of the effect.
  73943. * @param options The required width/height ratio to downsize to before computing the render pass.
  73944. * @param camera The camera to apply the render pass to.
  73945. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73946. * @param engine The engine which the post process will be applied. (default: current engine)
  73947. * @param reusable If the post process can be reused on the same frame. (default: false)
  73948. * @param textureType Type of textures used when performing the post process. (default: 0)
  73949. * @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)
  73950. */
  73951. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  73952. /** @hidden */
  73953. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): SharpenPostProcess;
  73954. }
  73955. }
  73956. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline" {
  73957. import { Nullable } from "babylonjs/types";
  73958. import { Camera } from "babylonjs/Cameras/camera";
  73959. import { Engine } from "babylonjs/Engines/engine";
  73960. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  73961. import { IInspectable } from "babylonjs/Misc/iInspectable";
  73962. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  73963. /**
  73964. * PostProcessRenderPipeline
  73965. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  73966. */
  73967. export class PostProcessRenderPipeline {
  73968. private engine;
  73969. private _renderEffects;
  73970. private _renderEffectsForIsolatedPass;
  73971. /**
  73972. * List of inspectable custom properties (used by the Inspector)
  73973. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  73974. */
  73975. inspectableCustomProperties: IInspectable[];
  73976. /**
  73977. * @hidden
  73978. */
  73979. protected _cameras: Camera[];
  73980. /** @hidden */
  73981. _name: string;
  73982. /**
  73983. * Gets pipeline name
  73984. */
  73985. get name(): string;
  73986. /** Gets the list of attached cameras */
  73987. get cameras(): Camera[];
  73988. /**
  73989. * Initializes a PostProcessRenderPipeline
  73990. * @param engine engine to add the pipeline to
  73991. * @param name name of the pipeline
  73992. */
  73993. constructor(engine: Engine, name: string);
  73994. /**
  73995. * Gets the class name
  73996. * @returns "PostProcessRenderPipeline"
  73997. */
  73998. getClassName(): string;
  73999. /**
  74000. * If all the render effects in the pipeline are supported
  74001. */
  74002. get isSupported(): boolean;
  74003. /**
  74004. * Adds an effect to the pipeline
  74005. * @param renderEffect the effect to add
  74006. */
  74007. addEffect(renderEffect: PostProcessRenderEffect): void;
  74008. /** @hidden */
  74009. _rebuild(): void;
  74010. /** @hidden */
  74011. _enableEffect(renderEffectName: string, cameras: Camera): void;
  74012. /** @hidden */
  74013. _enableEffect(renderEffectName: string, cameras: Camera[]): void;
  74014. /** @hidden */
  74015. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  74016. /** @hidden */
  74017. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  74018. /** @hidden */
  74019. _attachCameras(cameras: Camera, unique: boolean): void;
  74020. /** @hidden */
  74021. _attachCameras(cameras: Camera[], unique: boolean): void;
  74022. /** @hidden */
  74023. _detachCameras(cameras: Camera): void;
  74024. /** @hidden */
  74025. _detachCameras(cameras: Nullable<Camera[]>): void;
  74026. /** @hidden */
  74027. _update(): void;
  74028. /** @hidden */
  74029. _reset(): void;
  74030. protected _enableMSAAOnFirstPostProcess(sampleCount: number): boolean;
  74031. /**
  74032. * Sets the required values to the prepass renderer.
  74033. * @param prePassRenderer defines the prepass renderer to setup.
  74034. * @returns true if the pre pass is needed.
  74035. */
  74036. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  74037. /**
  74038. * Disposes of the pipeline
  74039. */
  74040. dispose(): void;
  74041. }
  74042. }
  74043. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager" {
  74044. import { Camera } from "babylonjs/Cameras/camera";
  74045. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74046. /**
  74047. * PostProcessRenderPipelineManager class
  74048. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  74049. */
  74050. export class PostProcessRenderPipelineManager {
  74051. private _renderPipelines;
  74052. /**
  74053. * Initializes a PostProcessRenderPipelineManager
  74054. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  74055. */
  74056. constructor();
  74057. /**
  74058. * Gets the list of supported render pipelines
  74059. */
  74060. get supportedPipelines(): PostProcessRenderPipeline[];
  74061. /**
  74062. * Adds a pipeline to the manager
  74063. * @param renderPipeline The pipeline to add
  74064. */
  74065. addPipeline(renderPipeline: PostProcessRenderPipeline): void;
  74066. /**
  74067. * Attaches a camera to the pipeline
  74068. * @param renderPipelineName The name of the pipeline to attach to
  74069. * @param cameras the camera to attach
  74070. * @param unique if the camera can be attached multiple times to the pipeline
  74071. */
  74072. attachCamerasToRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera, unique?: boolean): void;
  74073. /**
  74074. * Detaches a camera from the pipeline
  74075. * @param renderPipelineName The name of the pipeline to detach from
  74076. * @param cameras the camera to detach
  74077. */
  74078. detachCamerasFromRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera): void;
  74079. /**
  74080. * Enables an effect by name on a pipeline
  74081. * @param renderPipelineName the name of the pipeline to enable the effect in
  74082. * @param renderEffectName the name of the effect to enable
  74083. * @param cameras the cameras that the effect should be enabled on
  74084. */
  74085. enableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  74086. /**
  74087. * Disables an effect by name on a pipeline
  74088. * @param renderPipelineName the name of the pipeline to disable the effect in
  74089. * @param renderEffectName the name of the effect to disable
  74090. * @param cameras the cameras that the effect should be disabled on
  74091. */
  74092. disableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  74093. /**
  74094. * Updates the state of all contained render pipelines and disposes of any non supported pipelines
  74095. */
  74096. update(): void;
  74097. /** @hidden */
  74098. _rebuild(): void;
  74099. /**
  74100. * Disposes of the manager and pipelines
  74101. */
  74102. dispose(): void;
  74103. }
  74104. }
  74105. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent" {
  74106. import { ISceneComponent } from "babylonjs/sceneComponent";
  74107. import { PostProcessRenderPipelineManager } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager";
  74108. import { Scene } from "babylonjs/scene";
  74109. module "babylonjs/scene" {
  74110. interface Scene {
  74111. /** @hidden (Backing field) */
  74112. _postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  74113. /**
  74114. * Gets the postprocess render pipeline manager
  74115. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  74116. * @see https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  74117. */
  74118. readonly postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  74119. }
  74120. }
  74121. /**
  74122. * Defines the Render Pipeline scene component responsible to rendering pipelines
  74123. */
  74124. export class PostProcessRenderPipelineManagerSceneComponent implements ISceneComponent {
  74125. /**
  74126. * The component name helpfull to identify the component in the list of scene components.
  74127. */
  74128. readonly name: string;
  74129. /**
  74130. * The scene the component belongs to.
  74131. */
  74132. scene: Scene;
  74133. /**
  74134. * Creates a new instance of the component for the given scene
  74135. * @param scene Defines the scene to register the component in
  74136. */
  74137. constructor(scene: Scene);
  74138. /**
  74139. * Registers the component in a given scene
  74140. */
  74141. register(): void;
  74142. /**
  74143. * Rebuilds the elements related to this component in case of
  74144. * context lost for instance.
  74145. */
  74146. rebuild(): void;
  74147. /**
  74148. * Disposes the component and the associated ressources
  74149. */
  74150. dispose(): void;
  74151. private _gatherRenderTargets;
  74152. }
  74153. }
  74154. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/defaultRenderingPipeline" {
  74155. import { Nullable } from "babylonjs/types";
  74156. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  74157. import { Camera } from "babylonjs/Cameras/camera";
  74158. import { IDisposable } from "babylonjs/scene";
  74159. import { GlowLayer } from "babylonjs/Layers/glowLayer";
  74160. import { Scene } from "babylonjs/scene";
  74161. import { SharpenPostProcess } from "babylonjs/PostProcesses/sharpenPostProcess";
  74162. import { ImageProcessingPostProcess } from "babylonjs/PostProcesses/imageProcessingPostProcess";
  74163. import { ChromaticAberrationPostProcess } from "babylonjs/PostProcesses/chromaticAberrationPostProcess";
  74164. import { GrainPostProcess } from "babylonjs/PostProcesses/grainPostProcess";
  74165. import { FxaaPostProcess } from "babylonjs/PostProcesses/fxaaPostProcess";
  74166. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74167. import { DepthOfFieldEffect, DepthOfFieldEffectBlurLevel } from "babylonjs/PostProcesses/depthOfFieldEffect";
  74168. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74169. import { Animation } from "babylonjs/Animations/animation";
  74170. /**
  74171. * The default rendering pipeline can be added to a scene to apply common post processing effects such as anti-aliasing or depth of field.
  74172. * See https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  74173. */
  74174. export class DefaultRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  74175. private _scene;
  74176. private _camerasToBeAttached;
  74177. /**
  74178. * ID of the sharpen post process,
  74179. */
  74180. private readonly SharpenPostProcessId;
  74181. /**
  74182. * @ignore
  74183. * ID of the image processing post process;
  74184. */
  74185. readonly ImageProcessingPostProcessId: string;
  74186. /**
  74187. * @ignore
  74188. * ID of the Fast Approximate Anti-Aliasing post process;
  74189. */
  74190. readonly FxaaPostProcessId: string;
  74191. /**
  74192. * ID of the chromatic aberration post process,
  74193. */
  74194. private readonly ChromaticAberrationPostProcessId;
  74195. /**
  74196. * ID of the grain post process
  74197. */
  74198. private readonly GrainPostProcessId;
  74199. /**
  74200. * Sharpen post process which will apply a sharpen convolution to enhance edges
  74201. */
  74202. sharpen: SharpenPostProcess;
  74203. private _sharpenEffect;
  74204. private bloom;
  74205. /**
  74206. * Depth of field effect, applies a blur based on how far away objects are from the focus distance.
  74207. */
  74208. depthOfField: DepthOfFieldEffect;
  74209. /**
  74210. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  74211. */
  74212. fxaa: FxaaPostProcess;
  74213. /**
  74214. * Image post processing pass used to perform operations such as tone mapping or color grading.
  74215. */
  74216. imageProcessing: ImageProcessingPostProcess;
  74217. /**
  74218. * Chromatic aberration post process which will shift rgb colors in the image
  74219. */
  74220. chromaticAberration: ChromaticAberrationPostProcess;
  74221. private _chromaticAberrationEffect;
  74222. /**
  74223. * Grain post process which add noise to the image
  74224. */
  74225. grain: GrainPostProcess;
  74226. private _grainEffect;
  74227. /**
  74228. * Glow post process which adds a glow to emissive areas of the image
  74229. */
  74230. private _glowLayer;
  74231. /**
  74232. * Animations which can be used to tweak settings over a period of time
  74233. */
  74234. animations: Animation[];
  74235. private _imageProcessingConfigurationObserver;
  74236. private _sharpenEnabled;
  74237. private _bloomEnabled;
  74238. private _depthOfFieldEnabled;
  74239. private _depthOfFieldBlurLevel;
  74240. private _fxaaEnabled;
  74241. private _imageProcessingEnabled;
  74242. private _defaultPipelineTextureType;
  74243. private _bloomScale;
  74244. private _chromaticAberrationEnabled;
  74245. private _grainEnabled;
  74246. private _buildAllowed;
  74247. /**
  74248. * Gets active scene
  74249. */
  74250. get scene(): Scene;
  74251. /**
  74252. * Enable or disable the sharpen process from the pipeline
  74253. */
  74254. set sharpenEnabled(enabled: boolean);
  74255. get sharpenEnabled(): boolean;
  74256. private _resizeObserver;
  74257. private _hardwareScaleLevel;
  74258. private _bloomKernel;
  74259. /**
  74260. * Specifies the size of the bloom blur kernel, relative to the final output size
  74261. */
  74262. get bloomKernel(): number;
  74263. set bloomKernel(value: number);
  74264. /**
  74265. * Specifies the weight of the bloom in the final rendering
  74266. */
  74267. private _bloomWeight;
  74268. /**
  74269. * Specifies the luma threshold for the area that will be blurred by the bloom
  74270. */
  74271. private _bloomThreshold;
  74272. private _hdr;
  74273. /**
  74274. * The strength of the bloom.
  74275. */
  74276. set bloomWeight(value: number);
  74277. get bloomWeight(): number;
  74278. /**
  74279. * The strength of the bloom.
  74280. */
  74281. set bloomThreshold(value: number);
  74282. get bloomThreshold(): number;
  74283. /**
  74284. * The scale of the bloom, lower value will provide better performance.
  74285. */
  74286. set bloomScale(value: number);
  74287. get bloomScale(): number;
  74288. /**
  74289. * Enable or disable the bloom from the pipeline
  74290. */
  74291. set bloomEnabled(enabled: boolean);
  74292. get bloomEnabled(): boolean;
  74293. private _rebuildBloom;
  74294. /**
  74295. * If the depth of field is enabled.
  74296. */
  74297. get depthOfFieldEnabled(): boolean;
  74298. set depthOfFieldEnabled(enabled: boolean);
  74299. /**
  74300. * Blur level of the depth of field effect. (Higher blur will effect performance)
  74301. */
  74302. get depthOfFieldBlurLevel(): DepthOfFieldEffectBlurLevel;
  74303. set depthOfFieldBlurLevel(value: DepthOfFieldEffectBlurLevel);
  74304. /**
  74305. * If the anti aliasing is enabled.
  74306. */
  74307. set fxaaEnabled(enabled: boolean);
  74308. get fxaaEnabled(): boolean;
  74309. private _samples;
  74310. /**
  74311. * MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  74312. */
  74313. set samples(sampleCount: number);
  74314. get samples(): number;
  74315. /**
  74316. * If image processing is enabled.
  74317. */
  74318. set imageProcessingEnabled(enabled: boolean);
  74319. get imageProcessingEnabled(): boolean;
  74320. /**
  74321. * If glow layer is enabled. (Adds a glow effect to emmissive materials)
  74322. */
  74323. set glowLayerEnabled(enabled: boolean);
  74324. get glowLayerEnabled(): boolean;
  74325. /**
  74326. * Gets the glow layer (or null if not defined)
  74327. */
  74328. get glowLayer(): Nullable<GlowLayer>;
  74329. /**
  74330. * Enable or disable the chromaticAberration process from the pipeline
  74331. */
  74332. set chromaticAberrationEnabled(enabled: boolean);
  74333. get chromaticAberrationEnabled(): boolean;
  74334. /**
  74335. * Enable or disable the grain process from the pipeline
  74336. */
  74337. set grainEnabled(enabled: boolean);
  74338. get grainEnabled(): boolean;
  74339. /**
  74340. * @constructor
  74341. * @param name - The rendering pipeline name (default: "")
  74342. * @param hdr - If high dynamic range textures should be used (default: true)
  74343. * @param scene - The scene linked to this pipeline (default: the last created scene)
  74344. * @param cameras - The array of cameras that the rendering pipeline will be attached to (default: scene.cameras)
  74345. * @param automaticBuild - if false, you will have to manually call prepare() to update the pipeline (default: true)
  74346. */
  74347. constructor(name?: string, hdr?: boolean, scene?: Scene, cameras?: Camera[], automaticBuild?: boolean);
  74348. /**
  74349. * Get the class name
  74350. * @returns "DefaultRenderingPipeline"
  74351. */
  74352. getClassName(): string;
  74353. /**
  74354. * Force the compilation of the entire pipeline.
  74355. */
  74356. prepare(): void;
  74357. private _hasCleared;
  74358. private _prevPostProcess;
  74359. private _prevPrevPostProcess;
  74360. private _setAutoClearAndTextureSharing;
  74361. private _depthOfFieldSceneObserver;
  74362. private _buildPipeline;
  74363. private _disposePostProcesses;
  74364. /**
  74365. * Adds a camera to the pipeline
  74366. * @param camera the camera to be added
  74367. */
  74368. addCamera(camera: Camera): void;
  74369. /**
  74370. * Removes a camera from the pipeline
  74371. * @param camera the camera to remove
  74372. */
  74373. removeCamera(camera: Camera): void;
  74374. /**
  74375. * Dispose of the pipeline and stop all post processes
  74376. */
  74377. dispose(): void;
  74378. /**
  74379. * Serialize the rendering pipeline (Used when exporting)
  74380. * @returns the serialized object
  74381. */
  74382. serialize(): any;
  74383. /**
  74384. * Parse the serialized pipeline
  74385. * @param source Source pipeline.
  74386. * @param scene The scene to load the pipeline to.
  74387. * @param rootUrl The URL of the serialized pipeline.
  74388. * @returns An instantiated pipeline from the serialized object.
  74389. */
  74390. static Parse(source: any, scene: Scene, rootUrl: string): DefaultRenderingPipeline;
  74391. }
  74392. }
  74393. declare module "babylonjs/Shaders/lensHighlights.fragment" {
  74394. /** @hidden */
  74395. export var lensHighlightsPixelShader: {
  74396. name: string;
  74397. shader: string;
  74398. };
  74399. }
  74400. declare module "babylonjs/Shaders/depthOfField.fragment" {
  74401. /** @hidden */
  74402. export var depthOfFieldPixelShader: {
  74403. name: string;
  74404. shader: string;
  74405. };
  74406. }
  74407. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline" {
  74408. import { Camera } from "babylonjs/Cameras/camera";
  74409. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74410. import { Scene } from "babylonjs/scene";
  74411. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74412. import "babylonjs/Shaders/chromaticAberration.fragment";
  74413. import "babylonjs/Shaders/lensHighlights.fragment";
  74414. import "babylonjs/Shaders/depthOfField.fragment";
  74415. /**
  74416. * BABYLON.JS Chromatic Aberration GLSL Shader
  74417. * Author: Olivier Guyot
  74418. * Separates very slightly R, G and B colors on the edges of the screen
  74419. * Inspired by Francois Tarlier & Martins Upitis
  74420. */
  74421. export class LensRenderingPipeline extends PostProcessRenderPipeline {
  74422. /**
  74423. * @ignore
  74424. * The chromatic aberration PostProcess id in the pipeline
  74425. */
  74426. LensChromaticAberrationEffect: string;
  74427. /**
  74428. * @ignore
  74429. * The highlights enhancing PostProcess id in the pipeline
  74430. */
  74431. HighlightsEnhancingEffect: string;
  74432. /**
  74433. * @ignore
  74434. * The depth-of-field PostProcess id in the pipeline
  74435. */
  74436. LensDepthOfFieldEffect: string;
  74437. private _scene;
  74438. private _depthTexture;
  74439. private _grainTexture;
  74440. private _chromaticAberrationPostProcess;
  74441. private _highlightsPostProcess;
  74442. private _depthOfFieldPostProcess;
  74443. private _edgeBlur;
  74444. private _grainAmount;
  74445. private _chromaticAberration;
  74446. private _distortion;
  74447. private _highlightsGain;
  74448. private _highlightsThreshold;
  74449. private _dofDistance;
  74450. private _dofAperture;
  74451. private _dofDarken;
  74452. private _dofPentagon;
  74453. private _blurNoise;
  74454. /**
  74455. * @constructor
  74456. *
  74457. * Effect parameters are as follow:
  74458. * {
  74459. * chromatic_aberration: number; // from 0 to x (1 for realism)
  74460. * edge_blur: number; // from 0 to x (1 for realism)
  74461. * distortion: number; // from 0 to x (1 for realism)
  74462. * grain_amount: number; // from 0 to 1
  74463. * grain_texture: BABYLON.Texture; // texture to use for grain effect; if unset, use random B&W noise
  74464. * dof_focus_distance: number; // depth-of-field: focus distance; unset to disable (disabled by default)
  74465. * dof_aperture: number; // depth-of-field: focus blur bias (default: 1)
  74466. * dof_darken: number; // depth-of-field: darken that which is out of focus (from 0 to 1, disabled by default)
  74467. * dof_pentagon: boolean; // depth-of-field: makes a pentagon-like "bokeh" effect
  74468. * dof_gain: number; // depth-of-field: highlights gain; unset to disable (disabled by default)
  74469. * dof_threshold: number; // depth-of-field: highlights threshold (default: 1)
  74470. * blur_noise: boolean; // add a little bit of noise to the blur (default: true)
  74471. * }
  74472. * Note: if an effect parameter is unset, effect is disabled
  74473. *
  74474. * @param name The rendering pipeline name
  74475. * @param parameters - An object containing all parameters (see above)
  74476. * @param scene The scene linked to this pipeline
  74477. * @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)
  74478. * @param cameras The array of cameras that the rendering pipeline will be attached to
  74479. */
  74480. constructor(name: string, parameters: any, scene: Scene, ratio?: number, cameras?: Camera[]);
  74481. /**
  74482. * Get the class name
  74483. * @returns "LensRenderingPipeline"
  74484. */
  74485. getClassName(): string;
  74486. /**
  74487. * Gets associated scene
  74488. */
  74489. get scene(): Scene;
  74490. /**
  74491. * Gets or sets the edge blur
  74492. */
  74493. get edgeBlur(): number;
  74494. set edgeBlur(value: number);
  74495. /**
  74496. * Gets or sets the grain amount
  74497. */
  74498. get grainAmount(): number;
  74499. set grainAmount(value: number);
  74500. /**
  74501. * Gets or sets the chromatic aberration amount
  74502. */
  74503. get chromaticAberration(): number;
  74504. set chromaticAberration(value: number);
  74505. /**
  74506. * Gets or sets the depth of field aperture
  74507. */
  74508. get dofAperture(): number;
  74509. set dofAperture(value: number);
  74510. /**
  74511. * Gets or sets the edge distortion
  74512. */
  74513. get edgeDistortion(): number;
  74514. set edgeDistortion(value: number);
  74515. /**
  74516. * Gets or sets the depth of field distortion
  74517. */
  74518. get dofDistortion(): number;
  74519. set dofDistortion(value: number);
  74520. /**
  74521. * Gets or sets the darken out of focus amount
  74522. */
  74523. get darkenOutOfFocus(): number;
  74524. set darkenOutOfFocus(value: number);
  74525. /**
  74526. * Gets or sets a boolean indicating if blur noise is enabled
  74527. */
  74528. get blurNoise(): boolean;
  74529. set blurNoise(value: boolean);
  74530. /**
  74531. * Gets or sets a boolean indicating if pentagon bokeh is enabled
  74532. */
  74533. get pentagonBokeh(): boolean;
  74534. set pentagonBokeh(value: boolean);
  74535. /**
  74536. * Gets or sets the highlight grain amount
  74537. */
  74538. get highlightsGain(): number;
  74539. set highlightsGain(value: number);
  74540. /**
  74541. * Gets or sets the highlight threshold
  74542. */
  74543. get highlightsThreshold(): number;
  74544. set highlightsThreshold(value: number);
  74545. /**
  74546. * Sets the amount of blur at the edges
  74547. * @param amount blur amount
  74548. */
  74549. setEdgeBlur(amount: number): void;
  74550. /**
  74551. * Sets edge blur to 0
  74552. */
  74553. disableEdgeBlur(): void;
  74554. /**
  74555. * Sets the amout of grain
  74556. * @param amount Amount of grain
  74557. */
  74558. setGrainAmount(amount: number): void;
  74559. /**
  74560. * Set grain amount to 0
  74561. */
  74562. disableGrain(): void;
  74563. /**
  74564. * Sets the chromatic aberration amount
  74565. * @param amount amount of chromatic aberration
  74566. */
  74567. setChromaticAberration(amount: number): void;
  74568. /**
  74569. * Sets chromatic aberration amount to 0
  74570. */
  74571. disableChromaticAberration(): void;
  74572. /**
  74573. * Sets the EdgeDistortion amount
  74574. * @param amount amount of EdgeDistortion
  74575. */
  74576. setEdgeDistortion(amount: number): void;
  74577. /**
  74578. * Sets edge distortion to 0
  74579. */
  74580. disableEdgeDistortion(): void;
  74581. /**
  74582. * Sets the FocusDistance amount
  74583. * @param amount amount of FocusDistance
  74584. */
  74585. setFocusDistance(amount: number): void;
  74586. /**
  74587. * Disables depth of field
  74588. */
  74589. disableDepthOfField(): void;
  74590. /**
  74591. * Sets the Aperture amount
  74592. * @param amount amount of Aperture
  74593. */
  74594. setAperture(amount: number): void;
  74595. /**
  74596. * Sets the DarkenOutOfFocus amount
  74597. * @param amount amount of DarkenOutOfFocus
  74598. */
  74599. setDarkenOutOfFocus(amount: number): void;
  74600. private _pentagonBokehIsEnabled;
  74601. /**
  74602. * Creates a pentagon bokeh effect
  74603. */
  74604. enablePentagonBokeh(): void;
  74605. /**
  74606. * Disables the pentagon bokeh effect
  74607. */
  74608. disablePentagonBokeh(): void;
  74609. /**
  74610. * Enables noise blur
  74611. */
  74612. enableNoiseBlur(): void;
  74613. /**
  74614. * Disables noise blur
  74615. */
  74616. disableNoiseBlur(): void;
  74617. /**
  74618. * Sets the HighlightsGain amount
  74619. * @param amount amount of HighlightsGain
  74620. */
  74621. setHighlightsGain(amount: number): void;
  74622. /**
  74623. * Sets the HighlightsThreshold amount
  74624. * @param amount amount of HighlightsThreshold
  74625. */
  74626. setHighlightsThreshold(amount: number): void;
  74627. /**
  74628. * Disables highlights
  74629. */
  74630. disableHighlights(): void;
  74631. /**
  74632. * Removes the internal pipeline assets and detaches the pipeline from the scene cameras
  74633. * @param disableDepthRender If the scens depth rendering should be disabled (default: false)
  74634. */
  74635. dispose(disableDepthRender?: boolean): void;
  74636. private _createChromaticAberrationPostProcess;
  74637. private _createHighlightsPostProcess;
  74638. private _createDepthOfFieldPostProcess;
  74639. private _createGrainTexture;
  74640. }
  74641. }
  74642. declare module "babylonjs/Shaders/ssao2.fragment" {
  74643. /** @hidden */
  74644. export var ssao2PixelShader: {
  74645. name: string;
  74646. shader: string;
  74647. };
  74648. }
  74649. declare module "babylonjs/Shaders/ssaoCombine.fragment" {
  74650. /** @hidden */
  74651. export var ssaoCombinePixelShader: {
  74652. name: string;
  74653. shader: string;
  74654. };
  74655. }
  74656. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssao2RenderingPipeline" {
  74657. import { Camera } from "babylonjs/Cameras/camera";
  74658. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74659. import { Scene } from "babylonjs/scene";
  74660. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74661. import "babylonjs/Shaders/ssao2.fragment";
  74662. import "babylonjs/Shaders/ssaoCombine.fragment";
  74663. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  74664. /**
  74665. * Render pipeline to produce ssao effect
  74666. */
  74667. export class SSAO2RenderingPipeline extends PostProcessRenderPipeline {
  74668. /**
  74669. * @ignore
  74670. * The PassPostProcess id in the pipeline that contains the original scene color
  74671. */
  74672. SSAOOriginalSceneColorEffect: string;
  74673. /**
  74674. * @ignore
  74675. * The SSAO PostProcess id in the pipeline
  74676. */
  74677. SSAORenderEffect: string;
  74678. /**
  74679. * @ignore
  74680. * The horizontal blur PostProcess id in the pipeline
  74681. */
  74682. SSAOBlurHRenderEffect: string;
  74683. /**
  74684. * @ignore
  74685. * The vertical blur PostProcess id in the pipeline
  74686. */
  74687. SSAOBlurVRenderEffect: string;
  74688. /**
  74689. * @ignore
  74690. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  74691. */
  74692. SSAOCombineRenderEffect: string;
  74693. /**
  74694. * The output strength of the SSAO post-process. Default value is 1.0.
  74695. */
  74696. totalStrength: number;
  74697. /**
  74698. * Maximum depth value to still render AO. A smooth falloff makes the dimming more natural, so there will be no abrupt shading change.
  74699. */
  74700. maxZ: number;
  74701. /**
  74702. * In order to save performances, SSAO radius is clamped on close geometry. This ratio changes by how much
  74703. */
  74704. minZAspect: number;
  74705. private _samples;
  74706. /**
  74707. * Number of samples used for the SSAO calculations. Default value is 8
  74708. */
  74709. set samples(n: number);
  74710. get samples(): number;
  74711. private _textureSamples;
  74712. /**
  74713. * Number of samples to use for antialiasing
  74714. */
  74715. set textureSamples(n: number);
  74716. get textureSamples(): number;
  74717. /**
  74718. * Force rendering the geometry through geometry buffer
  74719. */
  74720. private _forceGeometryBuffer;
  74721. /**
  74722. * Ratio object used for SSAO ratio and blur ratio
  74723. */
  74724. private _ratio;
  74725. /**
  74726. * Dynamically generated sphere sampler.
  74727. */
  74728. private _sampleSphere;
  74729. /**
  74730. * Blur filter offsets
  74731. */
  74732. private _samplerOffsets;
  74733. private _expensiveBlur;
  74734. /**
  74735. * If bilateral blur should be used
  74736. */
  74737. set expensiveBlur(b: boolean);
  74738. get expensiveBlur(): boolean;
  74739. /**
  74740. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 2.0
  74741. */
  74742. radius: number;
  74743. /**
  74744. * The base color of the SSAO post-process
  74745. * The final result is "base + ssao" between [0, 1]
  74746. */
  74747. base: number;
  74748. /**
  74749. * Support test.
  74750. */
  74751. static get IsSupported(): boolean;
  74752. private _scene;
  74753. private _randomTexture;
  74754. private _originalColorPostProcess;
  74755. private _ssaoPostProcess;
  74756. private _blurHPostProcess;
  74757. private _blurVPostProcess;
  74758. private _ssaoCombinePostProcess;
  74759. private _prePassRenderer;
  74760. /**
  74761. * Gets active scene
  74762. */
  74763. get scene(): Scene;
  74764. /**
  74765. * @constructor
  74766. * @param name The rendering pipeline name
  74767. * @param scene The scene linked to this pipeline
  74768. * @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 }
  74769. * @param cameras The array of cameras that the rendering pipeline will be attached to
  74770. * @param forceGeometryBuffer Set to true if you want to use the legacy geometry buffer renderer
  74771. */
  74772. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[], forceGeometryBuffer?: boolean);
  74773. /**
  74774. * Get the class name
  74775. * @returns "SSAO2RenderingPipeline"
  74776. */
  74777. getClassName(): string;
  74778. /**
  74779. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  74780. */
  74781. dispose(disableGeometryBufferRenderer?: boolean): void;
  74782. private _createBlurPostProcess;
  74783. /** @hidden */
  74784. _rebuild(): void;
  74785. private _bits;
  74786. private _radicalInverse_VdC;
  74787. private _hammersley;
  74788. private _hemisphereSample_uniform;
  74789. private _generateHemisphere;
  74790. private _getDefinesForSSAO;
  74791. private _createSSAOPostProcess;
  74792. private _createSSAOCombinePostProcess;
  74793. private _createRandomTexture;
  74794. /**
  74795. * Serialize the rendering pipeline (Used when exporting)
  74796. * @returns the serialized object
  74797. */
  74798. serialize(): any;
  74799. /**
  74800. * Parse the serialized pipeline
  74801. * @param source Source pipeline.
  74802. * @param scene The scene to load the pipeline to.
  74803. * @param rootUrl The URL of the serialized pipeline.
  74804. * @returns An instantiated pipeline from the serialized object.
  74805. */
  74806. static Parse(source: any, scene: Scene, rootUrl: string): SSAO2RenderingPipeline;
  74807. /**
  74808. * Sets the required values to the prepass renderer.
  74809. * @param prePassRenderer defines the prepass renderer to setup
  74810. * @returns true if the pre pass is needed.
  74811. */
  74812. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  74813. }
  74814. }
  74815. declare module "babylonjs/Shaders/ssao.fragment" {
  74816. /** @hidden */
  74817. export var ssaoPixelShader: {
  74818. name: string;
  74819. shader: string;
  74820. };
  74821. }
  74822. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssaoRenderingPipeline" {
  74823. import { Camera } from "babylonjs/Cameras/camera";
  74824. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74825. import { Scene } from "babylonjs/scene";
  74826. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74827. import "babylonjs/Shaders/ssao.fragment";
  74828. import "babylonjs/Shaders/ssaoCombine.fragment";
  74829. /**
  74830. * Render pipeline to produce ssao effect
  74831. */
  74832. export class SSAORenderingPipeline extends PostProcessRenderPipeline {
  74833. /**
  74834. * @ignore
  74835. * The PassPostProcess id in the pipeline that contains the original scene color
  74836. */
  74837. SSAOOriginalSceneColorEffect: string;
  74838. /**
  74839. * @ignore
  74840. * The SSAO PostProcess id in the pipeline
  74841. */
  74842. SSAORenderEffect: string;
  74843. /**
  74844. * @ignore
  74845. * The horizontal blur PostProcess id in the pipeline
  74846. */
  74847. SSAOBlurHRenderEffect: string;
  74848. /**
  74849. * @ignore
  74850. * The vertical blur PostProcess id in the pipeline
  74851. */
  74852. SSAOBlurVRenderEffect: string;
  74853. /**
  74854. * @ignore
  74855. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  74856. */
  74857. SSAOCombineRenderEffect: string;
  74858. /**
  74859. * The output strength of the SSAO post-process. Default value is 1.0.
  74860. */
  74861. totalStrength: number;
  74862. /**
  74863. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 0.0006
  74864. */
  74865. radius: number;
  74866. /**
  74867. * Related to fallOff, used to interpolate SSAO samples (first interpolate function input) based on the occlusion difference of each pixel
  74868. * Must not be equal to fallOff and superior to fallOff.
  74869. * Default value is 0.0075
  74870. */
  74871. area: number;
  74872. /**
  74873. * Related to area, used to interpolate SSAO samples (second interpolate function input) based on the occlusion difference of each pixel
  74874. * Must not be equal to area and inferior to area.
  74875. * Default value is 0.000001
  74876. */
  74877. fallOff: number;
  74878. /**
  74879. * The base color of the SSAO post-process
  74880. * The final result is "base + ssao" between [0, 1]
  74881. */
  74882. base: number;
  74883. private _scene;
  74884. private _depthTexture;
  74885. private _randomTexture;
  74886. private _originalColorPostProcess;
  74887. private _ssaoPostProcess;
  74888. private _blurHPostProcess;
  74889. private _blurVPostProcess;
  74890. private _ssaoCombinePostProcess;
  74891. private _firstUpdate;
  74892. /**
  74893. * Gets active scene
  74894. */
  74895. get scene(): Scene;
  74896. /**
  74897. * @constructor
  74898. * @param name - The rendering pipeline name
  74899. * @param scene - The scene linked to this pipeline
  74900. * @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 }
  74901. * @param cameras - The array of cameras that the rendering pipeline will be attached to
  74902. */
  74903. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  74904. /**
  74905. * Get the class name
  74906. * @returns "SSAORenderingPipeline"
  74907. */
  74908. getClassName(): string;
  74909. /**
  74910. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  74911. */
  74912. dispose(disableDepthRender?: boolean): void;
  74913. private _createBlurPostProcess;
  74914. /** @hidden */
  74915. _rebuild(): void;
  74916. private _createSSAOPostProcess;
  74917. private _createSSAOCombinePostProcess;
  74918. private _createRandomTexture;
  74919. }
  74920. }
  74921. declare module "babylonjs/Shaders/screenSpaceReflection.fragment" {
  74922. /** @hidden */
  74923. export var screenSpaceReflectionPixelShader: {
  74924. name: string;
  74925. shader: string;
  74926. };
  74927. }
  74928. declare module "babylonjs/PostProcesses/screenSpaceReflectionPostProcess" {
  74929. import { Nullable } from "babylonjs/types";
  74930. import { Camera } from "babylonjs/Cameras/camera";
  74931. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  74932. import "babylonjs/Shaders/screenSpaceReflection.fragment";
  74933. import { Engine } from "babylonjs/Engines/engine";
  74934. import { Scene } from "babylonjs/scene";
  74935. /**
  74936. * The ScreenSpaceReflectionPostProcess performs realtime reflections using only and only the available informations on the screen (positions and normals).
  74937. * Basically, the screen space reflection post-process will compute reflections according the material's reflectivity.
  74938. */
  74939. export class ScreenSpaceReflectionPostProcess extends PostProcess {
  74940. /**
  74941. * Gets or sets a reflection threshold mainly used to adjust the reflection's height.
  74942. */
  74943. threshold: number;
  74944. /**
  74945. * Gets or sets the current reflection strength. 1.0 is an ideal value but can be increased/decreased for particular results.
  74946. */
  74947. strength: number;
  74948. /**
  74949. * Gets or sets the falloff exponent used while computing fresnel. More the exponent is high, more the reflections will be discrete.
  74950. */
  74951. reflectionSpecularFalloffExponent: number;
  74952. /**
  74953. * 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]
  74954. */
  74955. step: number;
  74956. /**
  74957. * Gets or sets the factor applied when computing roughness. Default value is 0.2.
  74958. */
  74959. roughnessFactor: number;
  74960. private _geometryBufferRenderer;
  74961. private _enableSmoothReflections;
  74962. private _reflectionSamples;
  74963. private _smoothSteps;
  74964. /**
  74965. * Gets a string identifying the name of the class
  74966. * @returns "ScreenSpaceReflectionPostProcess" string
  74967. */
  74968. getClassName(): string;
  74969. /**
  74970. * Creates a new instance of ScreenSpaceReflectionPostProcess.
  74971. * @param name The name of the effect.
  74972. * @param scene The scene containing the objects to calculate reflections.
  74973. * @param options The required width/height ratio to downsize to before computing the render pass.
  74974. * @param camera The camera to apply the render pass to.
  74975. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  74976. * @param engine The engine which the post process will be applied. (default: current engine)
  74977. * @param reusable If the post process can be reused on the same frame. (default: false)
  74978. * @param textureType Type of textures used when performing the post process. (default: 0)
  74979. * @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)
  74980. */
  74981. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  74982. /**
  74983. * Gets wether or not smoothing reflections is enabled.
  74984. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  74985. */
  74986. get enableSmoothReflections(): boolean;
  74987. /**
  74988. * Sets wether or not smoothing reflections is enabled.
  74989. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  74990. */
  74991. set enableSmoothReflections(enabled: boolean);
  74992. /**
  74993. * Gets the number of samples taken while computing reflections. More samples count is high,
  74994. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  74995. */
  74996. get reflectionSamples(): number;
  74997. /**
  74998. * Sets the number of samples taken while computing reflections. More samples count is high,
  74999. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  75000. */
  75001. set reflectionSamples(samples: number);
  75002. /**
  75003. * Gets the number of samples taken while smoothing reflections. More samples count is high,
  75004. * more the post-process will require GPU power and can generate a drop in FPS.
  75005. * Default value (5.0) work pretty well in all cases but can be adjusted.
  75006. */
  75007. get smoothSteps(): number;
  75008. set smoothSteps(steps: number);
  75009. private _updateEffectDefines;
  75010. /** @hidden */
  75011. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): ScreenSpaceReflectionPostProcess;
  75012. }
  75013. }
  75014. declare module "babylonjs/Shaders/standard.fragment" {
  75015. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  75016. /** @hidden */
  75017. export var standardPixelShader: {
  75018. name: string;
  75019. shader: string;
  75020. };
  75021. }
  75022. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/standardRenderingPipeline" {
  75023. import { Nullable } from "babylonjs/types";
  75024. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  75025. import { Camera } from "babylonjs/Cameras/camera";
  75026. import { Texture } from "babylonjs/Materials/Textures/texture";
  75027. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  75028. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  75029. import { BlurPostProcess } from "babylonjs/PostProcesses/blurPostProcess";
  75030. import { FxaaPostProcess } from "babylonjs/PostProcesses/fxaaPostProcess";
  75031. import { IDisposable } from "babylonjs/scene";
  75032. import { SpotLight } from "babylonjs/Lights/spotLight";
  75033. import { DirectionalLight } from "babylonjs/Lights/directionalLight";
  75034. import { Scene } from "babylonjs/scene";
  75035. import { ScreenSpaceReflectionPostProcess } from "babylonjs/PostProcesses/screenSpaceReflectionPostProcess";
  75036. import { Animation } from "babylonjs/Animations/animation";
  75037. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  75038. import "babylonjs/Shaders/standard.fragment";
  75039. /**
  75040. * Standard rendering pipeline
  75041. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  75042. * @see https://doc.babylonjs.com/how_to/using_standard_rendering_pipeline
  75043. */
  75044. export class StandardRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  75045. /**
  75046. * Public members
  75047. */
  75048. /**
  75049. * Post-process which contains the original scene color before the pipeline applies all the effects
  75050. */
  75051. originalPostProcess: Nullable<PostProcess>;
  75052. /**
  75053. * Post-process used to down scale an image x4
  75054. */
  75055. downSampleX4PostProcess: Nullable<PostProcess>;
  75056. /**
  75057. * Post-process used to calculate the illuminated surfaces controlled by a threshold
  75058. */
  75059. brightPassPostProcess: Nullable<PostProcess>;
  75060. /**
  75061. * Post-process array storing all the horizontal blur post-processes used by the pipeline
  75062. */
  75063. blurHPostProcesses: PostProcess[];
  75064. /**
  75065. * Post-process array storing all the vertical blur post-processes used by the pipeline
  75066. */
  75067. blurVPostProcesses: PostProcess[];
  75068. /**
  75069. * Post-process used to add colors of 2 textures (typically brightness + real scene color)
  75070. */
  75071. textureAdderPostProcess: Nullable<PostProcess>;
  75072. /**
  75073. * Post-process used to create volumetric lighting effect
  75074. */
  75075. volumetricLightPostProcess: Nullable<PostProcess>;
  75076. /**
  75077. * Post-process used to smooth the previous volumetric light post-process on the X axis
  75078. */
  75079. volumetricLightSmoothXPostProcess: Nullable<BlurPostProcess>;
  75080. /**
  75081. * Post-process used to smooth the previous volumetric light post-process on the Y axis
  75082. */
  75083. volumetricLightSmoothYPostProcess: Nullable<BlurPostProcess>;
  75084. /**
  75085. * Post-process used to merge the volumetric light effect and the real scene color
  75086. */
  75087. volumetricLightMergePostProces: Nullable<PostProcess>;
  75088. /**
  75089. * Post-process used to store the final volumetric light post-process (attach/detach for debug purpose)
  75090. */
  75091. volumetricLightFinalPostProcess: Nullable<PostProcess>;
  75092. /**
  75093. * Base post-process used to calculate the average luminance of the final image for HDR
  75094. */
  75095. luminancePostProcess: Nullable<PostProcess>;
  75096. /**
  75097. * Post-processes used to create down sample post-processes in order to get
  75098. * the average luminance of the final image for HDR
  75099. * Array of length "StandardRenderingPipeline.LuminanceSteps"
  75100. */
  75101. luminanceDownSamplePostProcesses: PostProcess[];
  75102. /**
  75103. * Post-process used to create a HDR effect (light adaptation)
  75104. */
  75105. hdrPostProcess: Nullable<PostProcess>;
  75106. /**
  75107. * Post-process used to store the final texture adder post-process (attach/detach for debug purpose)
  75108. */
  75109. textureAdderFinalPostProcess: Nullable<PostProcess>;
  75110. /**
  75111. * Post-process used to store the final lens flare post-process (attach/detach for debug purpose)
  75112. */
  75113. lensFlareFinalPostProcess: Nullable<PostProcess>;
  75114. /**
  75115. * Post-process used to merge the final HDR post-process and the real scene color
  75116. */
  75117. hdrFinalPostProcess: Nullable<PostProcess>;
  75118. /**
  75119. * Post-process used to create a lens flare effect
  75120. */
  75121. lensFlarePostProcess: Nullable<PostProcess>;
  75122. /**
  75123. * Post-process that merges the result of the lens flare post-process and the real scene color
  75124. */
  75125. lensFlareComposePostProcess: Nullable<PostProcess>;
  75126. /**
  75127. * Post-process used to create a motion blur effect
  75128. */
  75129. motionBlurPostProcess: Nullable<PostProcess>;
  75130. /**
  75131. * Post-process used to create a depth of field effect
  75132. */
  75133. depthOfFieldPostProcess: Nullable<PostProcess>;
  75134. /**
  75135. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  75136. */
  75137. fxaaPostProcess: Nullable<FxaaPostProcess>;
  75138. /**
  75139. * Post-process used to simulate realtime reflections using the screen space and geometry renderer.
  75140. */
  75141. screenSpaceReflectionPostProcess: Nullable<ScreenSpaceReflectionPostProcess>;
  75142. /**
  75143. * Represents the brightness threshold in order to configure the illuminated surfaces
  75144. */
  75145. brightThreshold: number;
  75146. /**
  75147. * Configures the blur intensity used for surexposed surfaces are highlighted surfaces (light halo)
  75148. */
  75149. blurWidth: number;
  75150. /**
  75151. * Sets if the blur for highlighted surfaces must be only horizontal
  75152. */
  75153. horizontalBlur: boolean;
  75154. /**
  75155. * Gets the overall exposure used by the pipeline
  75156. */
  75157. get exposure(): number;
  75158. /**
  75159. * Sets the overall exposure used by the pipeline
  75160. */
  75161. set exposure(value: number);
  75162. /**
  75163. * Texture used typically to simulate "dirty" on camera lens
  75164. */
  75165. lensTexture: Nullable<Texture>;
  75166. /**
  75167. * Represents the offset coefficient based on Rayleigh principle. Typically in interval [-0.2, 0.2]
  75168. */
  75169. volumetricLightCoefficient: number;
  75170. /**
  75171. * The overall power of volumetric lights, typically in interval [0, 10] maximum
  75172. */
  75173. volumetricLightPower: number;
  75174. /**
  75175. * Used the set the blur intensity to smooth the volumetric lights
  75176. */
  75177. volumetricLightBlurScale: number;
  75178. /**
  75179. * Light (spot or directional) used to generate the volumetric lights rays
  75180. * The source light must have a shadow generate so the pipeline can get its
  75181. * depth map
  75182. */
  75183. sourceLight: Nullable<SpotLight | DirectionalLight>;
  75184. /**
  75185. * For eye adaptation, represents the minimum luminance the eye can see
  75186. */
  75187. hdrMinimumLuminance: number;
  75188. /**
  75189. * For eye adaptation, represents the decrease luminance speed
  75190. */
  75191. hdrDecreaseRate: number;
  75192. /**
  75193. * For eye adaptation, represents the increase luminance speed
  75194. */
  75195. hdrIncreaseRate: number;
  75196. /**
  75197. * Gets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  75198. */
  75199. get hdrAutoExposure(): boolean;
  75200. /**
  75201. * Sets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  75202. */
  75203. set hdrAutoExposure(value: boolean);
  75204. /**
  75205. * Lens color texture used by the lens flare effect. Mandatory if lens flare effect enabled
  75206. */
  75207. lensColorTexture: Nullable<Texture>;
  75208. /**
  75209. * The overall strengh for the lens flare effect
  75210. */
  75211. lensFlareStrength: number;
  75212. /**
  75213. * Dispersion coefficient for lens flare ghosts
  75214. */
  75215. lensFlareGhostDispersal: number;
  75216. /**
  75217. * Main lens flare halo width
  75218. */
  75219. lensFlareHaloWidth: number;
  75220. /**
  75221. * Based on the lens distortion effect, defines how much the lens flare result
  75222. * is distorted
  75223. */
  75224. lensFlareDistortionStrength: number;
  75225. /**
  75226. * Configures the blur intensity used for for lens flare (halo)
  75227. */
  75228. lensFlareBlurWidth: number;
  75229. /**
  75230. * Lens star texture must be used to simulate rays on the flares and is available
  75231. * in the documentation
  75232. */
  75233. lensStarTexture: Nullable<Texture>;
  75234. /**
  75235. * As the "lensTexture" (can be the same texture or different), it is used to apply the lens
  75236. * flare effect by taking account of the dirt texture
  75237. */
  75238. lensFlareDirtTexture: Nullable<Texture>;
  75239. /**
  75240. * Represents the focal length for the depth of field effect
  75241. */
  75242. depthOfFieldDistance: number;
  75243. /**
  75244. * Represents the blur intensity for the blurred part of the depth of field effect
  75245. */
  75246. depthOfFieldBlurWidth: number;
  75247. /**
  75248. * Gets how much the image is blurred by the movement while using the motion blur post-process
  75249. */
  75250. get motionStrength(): number;
  75251. /**
  75252. * Sets how much the image is blurred by the movement while using the motion blur post-process
  75253. */
  75254. set motionStrength(strength: number);
  75255. /**
  75256. * Gets wether or not the motion blur post-process is object based or screen based.
  75257. */
  75258. get objectBasedMotionBlur(): boolean;
  75259. /**
  75260. * Sets wether or not the motion blur post-process should be object based or screen based
  75261. */
  75262. set objectBasedMotionBlur(value: boolean);
  75263. /**
  75264. * List of animations for the pipeline (IAnimatable implementation)
  75265. */
  75266. animations: Animation[];
  75267. /**
  75268. * Private members
  75269. */
  75270. private _scene;
  75271. private _currentDepthOfFieldSource;
  75272. private _basePostProcess;
  75273. private _fixedExposure;
  75274. private _currentExposure;
  75275. private _hdrAutoExposure;
  75276. private _hdrCurrentLuminance;
  75277. private _motionStrength;
  75278. private _isObjectBasedMotionBlur;
  75279. private _floatTextureType;
  75280. private _camerasToBeAttached;
  75281. private _ratio;
  75282. private _bloomEnabled;
  75283. private _depthOfFieldEnabled;
  75284. private _vlsEnabled;
  75285. private _lensFlareEnabled;
  75286. private _hdrEnabled;
  75287. private _motionBlurEnabled;
  75288. private _fxaaEnabled;
  75289. private _screenSpaceReflectionsEnabled;
  75290. private _motionBlurSamples;
  75291. private _volumetricLightStepsCount;
  75292. private _samples;
  75293. /**
  75294. * @ignore
  75295. * Specifies if the bloom pipeline is enabled
  75296. */
  75297. get BloomEnabled(): boolean;
  75298. set BloomEnabled(enabled: boolean);
  75299. /**
  75300. * @ignore
  75301. * Specifies if the depth of field pipeline is enabed
  75302. */
  75303. get DepthOfFieldEnabled(): boolean;
  75304. set DepthOfFieldEnabled(enabled: boolean);
  75305. /**
  75306. * @ignore
  75307. * Specifies if the lens flare pipeline is enabed
  75308. */
  75309. get LensFlareEnabled(): boolean;
  75310. set LensFlareEnabled(enabled: boolean);
  75311. /**
  75312. * @ignore
  75313. * Specifies if the HDR pipeline is enabled
  75314. */
  75315. get HDREnabled(): boolean;
  75316. set HDREnabled(enabled: boolean);
  75317. /**
  75318. * @ignore
  75319. * Specifies if the volumetric lights scattering effect is enabled
  75320. */
  75321. get VLSEnabled(): boolean;
  75322. set VLSEnabled(enabled: boolean);
  75323. /**
  75324. * @ignore
  75325. * Specifies if the motion blur effect is enabled
  75326. */
  75327. get MotionBlurEnabled(): boolean;
  75328. set MotionBlurEnabled(enabled: boolean);
  75329. /**
  75330. * Specifies if anti-aliasing is enabled
  75331. */
  75332. get fxaaEnabled(): boolean;
  75333. set fxaaEnabled(enabled: boolean);
  75334. /**
  75335. * Specifies if screen space reflections are enabled.
  75336. */
  75337. get screenSpaceReflectionsEnabled(): boolean;
  75338. set screenSpaceReflectionsEnabled(enabled: boolean);
  75339. /**
  75340. * Specifies the number of steps used to calculate the volumetric lights
  75341. * Typically in interval [50, 200]
  75342. */
  75343. get volumetricLightStepsCount(): number;
  75344. set volumetricLightStepsCount(count: number);
  75345. /**
  75346. * Specifies the number of samples used for the motion blur effect
  75347. * Typically in interval [16, 64]
  75348. */
  75349. get motionBlurSamples(): number;
  75350. set motionBlurSamples(samples: number);
  75351. /**
  75352. * Specifies MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  75353. */
  75354. get samples(): number;
  75355. set samples(sampleCount: number);
  75356. /**
  75357. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  75358. * @constructor
  75359. * @param name The rendering pipeline name
  75360. * @param scene The scene linked to this pipeline
  75361. * @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)
  75362. * @param originalPostProcess the custom original color post-process. Must be "reusable". Can be null.
  75363. * @param cameras The array of cameras that the rendering pipeline will be attached to
  75364. */
  75365. constructor(name: string, scene: Scene, ratio: number, originalPostProcess?: Nullable<PostProcess>, cameras?: Camera[]);
  75366. private _buildPipeline;
  75367. private _createDownSampleX4PostProcess;
  75368. private _createBrightPassPostProcess;
  75369. private _createBlurPostProcesses;
  75370. private _createTextureAdderPostProcess;
  75371. private _createVolumetricLightPostProcess;
  75372. private _createLuminancePostProcesses;
  75373. private _createHdrPostProcess;
  75374. private _createLensFlarePostProcess;
  75375. private _createDepthOfFieldPostProcess;
  75376. private _createMotionBlurPostProcess;
  75377. private _getDepthTexture;
  75378. private _disposePostProcesses;
  75379. /**
  75380. * Dispose of the pipeline and stop all post processes
  75381. */
  75382. dispose(): void;
  75383. /**
  75384. * Serialize the rendering pipeline (Used when exporting)
  75385. * @returns the serialized object
  75386. */
  75387. serialize(): any;
  75388. /**
  75389. * Parse the serialized pipeline
  75390. * @param source Source pipeline.
  75391. * @param scene The scene to load the pipeline to.
  75392. * @param rootUrl The URL of the serialized pipeline.
  75393. * @returns An instantiated pipeline from the serialized object.
  75394. */
  75395. static Parse(source: any, scene: Scene, rootUrl: string): StandardRenderingPipeline;
  75396. /**
  75397. * Luminance steps
  75398. */
  75399. static LuminanceSteps: number;
  75400. }
  75401. }
  75402. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/index" {
  75403. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/defaultRenderingPipeline";
  75404. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline";
  75405. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssao2RenderingPipeline";
  75406. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssaoRenderingPipeline";
  75407. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/standardRenderingPipeline";
  75408. }
  75409. declare module "babylonjs/PostProcesses/RenderPipeline/index" {
  75410. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/index";
  75411. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  75412. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  75413. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager";
  75414. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  75415. }
  75416. declare module "babylonjs/Shaders/stereoscopicInterlace.fragment" {
  75417. /** @hidden */
  75418. export var stereoscopicInterlacePixelShader: {
  75419. name: string;
  75420. shader: string;
  75421. };
  75422. }
  75423. declare module "babylonjs/PostProcesses/stereoscopicInterlacePostProcess" {
  75424. import { Camera } from "babylonjs/Cameras/camera";
  75425. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  75426. import { Engine } from "babylonjs/Engines/engine";
  75427. import "babylonjs/Shaders/stereoscopicInterlace.fragment";
  75428. /**
  75429. * StereoscopicInterlacePostProcessI used to render stereo views from a rigged camera with support for alternate line interlacing
  75430. */
  75431. export class StereoscopicInterlacePostProcessI extends PostProcess {
  75432. private _stepSize;
  75433. private _passedProcess;
  75434. /**
  75435. * Gets a string identifying the name of the class
  75436. * @returns "StereoscopicInterlacePostProcessI" string
  75437. */
  75438. getClassName(): string;
  75439. /**
  75440. * Initializes a StereoscopicInterlacePostProcessI
  75441. * @param name The name of the effect.
  75442. * @param rigCameras The rig cameras to be appled to the post process
  75443. * @param isStereoscopicHoriz If the rendered results are horizontal or vertical
  75444. * @param isStereoscopicInterlaced If the rendered results are alternate line interlaced
  75445. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  75446. * @param engine The engine which the post process will be applied. (default: current engine)
  75447. * @param reusable If the post process can be reused on the same frame. (default: false)
  75448. */
  75449. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, isStereoscopicInterlaced: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  75450. }
  75451. /**
  75452. * StereoscopicInterlacePostProcess used to render stereo views from a rigged camera
  75453. */
  75454. export class StereoscopicInterlacePostProcess extends PostProcess {
  75455. private _stepSize;
  75456. private _passedProcess;
  75457. /**
  75458. * Gets a string identifying the name of the class
  75459. * @returns "StereoscopicInterlacePostProcess" string
  75460. */
  75461. getClassName(): string;
  75462. /**
  75463. * Initializes a StereoscopicInterlacePostProcess
  75464. * @param name The name of the effect.
  75465. * @param rigCameras The rig cameras to be appled to the post process
  75466. * @param isStereoscopicHoriz If the rendered results are horizontal or verticle
  75467. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  75468. * @param engine The engine which the post process will be applied. (default: current engine)
  75469. * @param reusable If the post process can be reused on the same frame. (default: false)
  75470. */
  75471. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  75472. }
  75473. }
  75474. declare module "babylonjs/Shaders/tonemap.fragment" {
  75475. /** @hidden */
  75476. export var tonemapPixelShader: {
  75477. name: string;
  75478. shader: string;
  75479. };
  75480. }
  75481. declare module "babylonjs/PostProcesses/tonemapPostProcess" {
  75482. import { Camera } from "babylonjs/Cameras/camera";
  75483. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  75484. import "babylonjs/Shaders/tonemap.fragment";
  75485. import { Engine } from "babylonjs/Engines/engine";
  75486. /** Defines operator used for tonemapping */
  75487. export enum TonemappingOperator {
  75488. /** Hable */
  75489. Hable = 0,
  75490. /** Reinhard */
  75491. Reinhard = 1,
  75492. /** HejiDawson */
  75493. HejiDawson = 2,
  75494. /** Photographic */
  75495. Photographic = 3
  75496. }
  75497. /**
  75498. * Defines a post process to apply tone mapping
  75499. */
  75500. export class TonemapPostProcess extends PostProcess {
  75501. private _operator;
  75502. /** Defines the required exposure adjustement */
  75503. exposureAdjustment: number;
  75504. /**
  75505. * Gets a string identifying the name of the class
  75506. * @returns "TonemapPostProcess" string
  75507. */
  75508. getClassName(): string;
  75509. /**
  75510. * Creates a new TonemapPostProcess
  75511. * @param name defines the name of the postprocess
  75512. * @param _operator defines the operator to use
  75513. * @param exposureAdjustment defines the required exposure adjustement
  75514. * @param camera defines the camera to use (can be null)
  75515. * @param samplingMode defines the required sampling mode (BABYLON.Texture.BILINEAR_SAMPLINGMODE by default)
  75516. * @param engine defines the hosting engine (can be ignore if camera is set)
  75517. * @param textureFormat defines the texture format to use (BABYLON.Engine.TEXTURETYPE_UNSIGNED_INT by default)
  75518. */
  75519. constructor(name: string, _operator: TonemappingOperator,
  75520. /** Defines the required exposure adjustement */
  75521. exposureAdjustment: number, camera: Camera, samplingMode?: number, engine?: Engine, textureFormat?: number);
  75522. }
  75523. }
  75524. declare module "babylonjs/Shaders/volumetricLightScattering.fragment" {
  75525. /** @hidden */
  75526. export var volumetricLightScatteringPixelShader: {
  75527. name: string;
  75528. shader: string;
  75529. };
  75530. }
  75531. declare module "babylonjs/Shaders/volumetricLightScatteringPass.vertex" {
  75532. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  75533. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  75534. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  75535. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  75536. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  75537. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  75538. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  75539. /** @hidden */
  75540. export var volumetricLightScatteringPassVertexShader: {
  75541. name: string;
  75542. shader: string;
  75543. };
  75544. }
  75545. declare module "babylonjs/Shaders/volumetricLightScatteringPass.fragment" {
  75546. /** @hidden */
  75547. export var volumetricLightScatteringPassPixelShader: {
  75548. name: string;
  75549. shader: string;
  75550. };
  75551. }
  75552. declare module "babylonjs/PostProcesses/volumetricLightScatteringPostProcess" {
  75553. import { Vector3 } from "babylonjs/Maths/math.vector";
  75554. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  75555. import { Mesh } from "babylonjs/Meshes/mesh";
  75556. import { Camera } from "babylonjs/Cameras/camera";
  75557. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  75558. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  75559. import { Scene } from "babylonjs/scene";
  75560. import "babylonjs/Meshes/Builders/planeBuilder";
  75561. import "babylonjs/Shaders/depth.vertex";
  75562. import "babylonjs/Shaders/volumetricLightScattering.fragment";
  75563. import "babylonjs/Shaders/volumetricLightScatteringPass.vertex";
  75564. import "babylonjs/Shaders/volumetricLightScatteringPass.fragment";
  75565. import { Engine } from "babylonjs/Engines/engine";
  75566. /**
  75567. * Inspired by http://http.developer.nvidia.com/GPUGems3/gpugems3_ch13.html
  75568. */
  75569. export class VolumetricLightScatteringPostProcess extends PostProcess {
  75570. private _volumetricLightScatteringPass;
  75571. private _volumetricLightScatteringRTT;
  75572. private _viewPort;
  75573. private _screenCoordinates;
  75574. private _cachedDefines;
  75575. /**
  75576. * If not undefined, the mesh position is computed from the attached node position
  75577. */
  75578. attachedNode: {
  75579. position: Vector3;
  75580. };
  75581. /**
  75582. * Custom position of the mesh. Used if "useCustomMeshPosition" is set to "true"
  75583. */
  75584. customMeshPosition: Vector3;
  75585. /**
  75586. * Set if the post-process should use a custom position for the light source (true) or the internal mesh position (false)
  75587. */
  75588. useCustomMeshPosition: boolean;
  75589. /**
  75590. * If the post-process should inverse the light scattering direction
  75591. */
  75592. invert: boolean;
  75593. /**
  75594. * The internal mesh used by the post-process
  75595. */
  75596. mesh: Mesh;
  75597. /**
  75598. * @hidden
  75599. * VolumetricLightScatteringPostProcess.useDiffuseColor is no longer used, use the mesh material directly instead
  75600. */
  75601. get useDiffuseColor(): boolean;
  75602. set useDiffuseColor(useDiffuseColor: boolean);
  75603. /**
  75604. * Array containing the excluded meshes not rendered in the internal pass
  75605. */
  75606. excludedMeshes: AbstractMesh[];
  75607. /**
  75608. * Controls the overall intensity of the post-process
  75609. */
  75610. exposure: number;
  75611. /**
  75612. * Dissipates each sample's contribution in range [0, 1]
  75613. */
  75614. decay: number;
  75615. /**
  75616. * Controls the overall intensity of each sample
  75617. */
  75618. weight: number;
  75619. /**
  75620. * Controls the density of each sample
  75621. */
  75622. density: number;
  75623. /**
  75624. * @constructor
  75625. * @param name The post-process name
  75626. * @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)
  75627. * @param camera The camera that the post-process will be attached to
  75628. * @param mesh The mesh used to create the light scattering
  75629. * @param samples The post-process quality, default 100
  75630. * @param samplingModeThe post-process filtering mode
  75631. * @param engine The babylon engine
  75632. * @param reusable If the post-process is reusable
  75633. * @param scene The constructor needs a scene reference to initialize internal components. If "camera" is null a "scene" must be provided
  75634. */
  75635. constructor(name: string, ratio: any, camera: Camera, mesh?: Mesh, samples?: number, samplingMode?: number, engine?: Engine, reusable?: boolean, scene?: Scene);
  75636. /**
  75637. * Returns the string "VolumetricLightScatteringPostProcess"
  75638. * @returns "VolumetricLightScatteringPostProcess"
  75639. */
  75640. getClassName(): string;
  75641. private _isReady;
  75642. /**
  75643. * Sets the new light position for light scattering effect
  75644. * @param position The new custom light position
  75645. */
  75646. setCustomMeshPosition(position: Vector3): void;
  75647. /**
  75648. * Returns the light position for light scattering effect
  75649. * @return Vector3 The custom light position
  75650. */
  75651. getCustomMeshPosition(): Vector3;
  75652. /**
  75653. * Disposes the internal assets and detaches the post-process from the camera
  75654. */
  75655. dispose(camera: Camera): void;
  75656. /**
  75657. * Returns the render target texture used by the post-process
  75658. * @return the render target texture used by the post-process
  75659. */
  75660. getPass(): RenderTargetTexture;
  75661. private _meshExcluded;
  75662. private _createPass;
  75663. private _updateMeshScreenCoordinates;
  75664. /**
  75665. * Creates a default mesh for the Volumeric Light Scattering post-process
  75666. * @param name The mesh name
  75667. * @param scene The scene where to create the mesh
  75668. * @return the default mesh
  75669. */
  75670. static CreateDefaultMesh(name: string, scene: Scene): Mesh;
  75671. }
  75672. }
  75673. declare module "babylonjs/Shaders/screenSpaceCurvature.fragment" {
  75674. /** @hidden */
  75675. export var screenSpaceCurvaturePixelShader: {
  75676. name: string;
  75677. shader: string;
  75678. };
  75679. }
  75680. declare module "babylonjs/PostProcesses/screenSpaceCurvaturePostProcess" {
  75681. import { Nullable } from "babylonjs/types";
  75682. import { Camera } from "babylonjs/Cameras/camera";
  75683. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  75684. import "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  75685. import "babylonjs/Shaders/screenSpaceCurvature.fragment";
  75686. import { Engine } from "babylonjs/Engines/engine";
  75687. import { Scene } from "babylonjs/scene";
  75688. /**
  75689. * The Screen Space curvature effect can help highlighting ridge and valley of a model.
  75690. */
  75691. export class ScreenSpaceCurvaturePostProcess extends PostProcess {
  75692. /**
  75693. * Defines how much ridge the curvature effect displays.
  75694. */
  75695. ridge: number;
  75696. /**
  75697. * Defines how much valley the curvature effect displays.
  75698. */
  75699. valley: number;
  75700. private _geometryBufferRenderer;
  75701. /**
  75702. * Gets a string identifying the name of the class
  75703. * @returns "ScreenSpaceCurvaturePostProcess" string
  75704. */
  75705. getClassName(): string;
  75706. /**
  75707. * Creates a new instance ScreenSpaceCurvaturePostProcess
  75708. * @param name The name of the effect.
  75709. * @param scene The scene containing the objects to blur according to their velocity.
  75710. * @param options The required width/height ratio to downsize to before computing the render pass.
  75711. * @param camera The camera to apply the render pass to.
  75712. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  75713. * @param engine The engine which the post process will be applied. (default: current engine)
  75714. * @param reusable If the post process can be reused on the same frame. (default: false)
  75715. * @param textureType Type of textures used when performing the post process. (default: 0)
  75716. * @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)
  75717. */
  75718. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  75719. /**
  75720. * Support test.
  75721. */
  75722. static get IsSupported(): boolean;
  75723. /** @hidden */
  75724. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): ScreenSpaceCurvaturePostProcess;
  75725. }
  75726. }
  75727. declare module "babylonjs/PostProcesses/index" {
  75728. export * from "babylonjs/PostProcesses/anaglyphPostProcess";
  75729. export * from "babylonjs/PostProcesses/blackAndWhitePostProcess";
  75730. export * from "babylonjs/PostProcesses/bloomEffect";
  75731. export * from "babylonjs/PostProcesses/bloomMergePostProcess";
  75732. export * from "babylonjs/PostProcesses/blurPostProcess";
  75733. export * from "babylonjs/PostProcesses/chromaticAberrationPostProcess";
  75734. export * from "babylonjs/PostProcesses/circleOfConfusionPostProcess";
  75735. export * from "babylonjs/PostProcesses/colorCorrectionPostProcess";
  75736. export * from "babylonjs/PostProcesses/convolutionPostProcess";
  75737. export * from "babylonjs/PostProcesses/depthOfFieldBlurPostProcess";
  75738. export * from "babylonjs/PostProcesses/depthOfFieldEffect";
  75739. export * from "babylonjs/PostProcesses/depthOfFieldMergePostProcess";
  75740. export * from "babylonjs/PostProcesses/displayPassPostProcess";
  75741. export * from "babylonjs/PostProcesses/extractHighlightsPostProcess";
  75742. export * from "babylonjs/PostProcesses/filterPostProcess";
  75743. export * from "babylonjs/PostProcesses/fxaaPostProcess";
  75744. export * from "babylonjs/PostProcesses/grainPostProcess";
  75745. export * from "babylonjs/PostProcesses/highlightsPostProcess";
  75746. export * from "babylonjs/PostProcesses/imageProcessingPostProcess";
  75747. export * from "babylonjs/PostProcesses/motionBlurPostProcess";
  75748. export * from "babylonjs/PostProcesses/passPostProcess";
  75749. export * from "babylonjs/PostProcesses/postProcess";
  75750. export * from "babylonjs/PostProcesses/postProcessManager";
  75751. export * from "babylonjs/PostProcesses/refractionPostProcess";
  75752. export * from "babylonjs/PostProcesses/RenderPipeline/index";
  75753. export * from "babylonjs/PostProcesses/sharpenPostProcess";
  75754. export * from "babylonjs/PostProcesses/stereoscopicInterlacePostProcess";
  75755. export * from "babylonjs/PostProcesses/tonemapPostProcess";
  75756. export * from "babylonjs/PostProcesses/volumetricLightScatteringPostProcess";
  75757. export * from "babylonjs/PostProcesses/vrDistortionCorrectionPostProcess";
  75758. export * from "babylonjs/PostProcesses/vrMultiviewToSingleviewPostProcess";
  75759. export * from "babylonjs/PostProcesses/screenSpaceReflectionPostProcess";
  75760. export * from "babylonjs/PostProcesses/screenSpaceCurvaturePostProcess";
  75761. }
  75762. declare module "babylonjs/Probes/index" {
  75763. export * from "babylonjs/Probes/reflectionProbe";
  75764. }
  75765. declare module "babylonjs/Rendering/boundingBoxRenderer" {
  75766. import { Scene } from "babylonjs/scene";
  75767. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  75768. import { SmartArray } from "babylonjs/Misc/smartArray";
  75769. import { ISceneComponent } from "babylonjs/sceneComponent";
  75770. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  75771. import "babylonjs/Meshes/Builders/boxBuilder";
  75772. import "babylonjs/Shaders/color.fragment";
  75773. import "babylonjs/Shaders/color.vertex";
  75774. import { Color3 } from "babylonjs/Maths/math.color";
  75775. import { Observable } from "babylonjs/Misc/observable";
  75776. module "babylonjs/scene" {
  75777. interface Scene {
  75778. /** @hidden (Backing field) */
  75779. _boundingBoxRenderer: BoundingBoxRenderer;
  75780. /** @hidden (Backing field) */
  75781. _forceShowBoundingBoxes: boolean;
  75782. /**
  75783. * Gets or sets a boolean indicating if all bounding boxes must be rendered
  75784. */
  75785. forceShowBoundingBoxes: boolean;
  75786. /**
  75787. * Gets the bounding box renderer associated with the scene
  75788. * @returns a BoundingBoxRenderer
  75789. */
  75790. getBoundingBoxRenderer(): BoundingBoxRenderer;
  75791. }
  75792. }
  75793. module "babylonjs/Meshes/abstractMesh" {
  75794. interface AbstractMesh {
  75795. /** @hidden (Backing field) */
  75796. _showBoundingBox: boolean;
  75797. /**
  75798. * Gets or sets a boolean indicating if the bounding box must be rendered as well (false by default)
  75799. */
  75800. showBoundingBox: boolean;
  75801. }
  75802. }
  75803. /**
  75804. * Component responsible of rendering the bounding box of the meshes in a scene.
  75805. * This is usually used through the mesh.showBoundingBox or the scene.forceShowBoundingBoxes properties
  75806. */
  75807. export class BoundingBoxRenderer implements ISceneComponent {
  75808. /**
  75809. * The component name helpfull to identify the component in the list of scene components.
  75810. */
  75811. readonly name: string;
  75812. /**
  75813. * The scene the component belongs to.
  75814. */
  75815. scene: Scene;
  75816. /**
  75817. * Color of the bounding box lines placed in front of an object
  75818. */
  75819. frontColor: Color3;
  75820. /**
  75821. * Color of the bounding box lines placed behind an object
  75822. */
  75823. backColor: Color3;
  75824. /**
  75825. * Defines if the renderer should show the back lines or not
  75826. */
  75827. showBackLines: boolean;
  75828. /**
  75829. * Observable raised before rendering a bounding box
  75830. */
  75831. onBeforeBoxRenderingObservable: Observable<BoundingBox>;
  75832. /**
  75833. * Observable raised after rendering a bounding box
  75834. */
  75835. onAfterBoxRenderingObservable: Observable<BoundingBox>;
  75836. /**
  75837. * @hidden
  75838. */
  75839. renderList: SmartArray<BoundingBox>;
  75840. private _colorShader;
  75841. private _vertexBuffers;
  75842. private _indexBuffer;
  75843. private _fillIndexBuffer;
  75844. private _fillIndexData;
  75845. /**
  75846. * Instantiates a new bounding box renderer in a scene.
  75847. * @param scene the scene the renderer renders in
  75848. */
  75849. constructor(scene: Scene);
  75850. /**
  75851. * Registers the component in a given scene
  75852. */
  75853. register(): void;
  75854. private _evaluateSubMesh;
  75855. private _activeMesh;
  75856. private _prepareRessources;
  75857. private _createIndexBuffer;
  75858. /**
  75859. * Rebuilds the elements related to this component in case of
  75860. * context lost for instance.
  75861. */
  75862. rebuild(): void;
  75863. /**
  75864. * @hidden
  75865. */
  75866. reset(): void;
  75867. /**
  75868. * Render the bounding boxes of a specific rendering group
  75869. * @param renderingGroupId defines the rendering group to render
  75870. */
  75871. render(renderingGroupId: number): void;
  75872. /**
  75873. * In case of occlusion queries, we can render the occlusion bounding box through this method
  75874. * @param mesh Define the mesh to render the occlusion bounding box for
  75875. */
  75876. renderOcclusionBoundingBox(mesh: AbstractMesh): void;
  75877. /**
  75878. * Dispose and release the resources attached to this renderer.
  75879. */
  75880. dispose(): void;
  75881. }
  75882. }
  75883. declare module "babylonjs/Rendering/depthRendererSceneComponent" {
  75884. import { Nullable } from "babylonjs/types";
  75885. import { Scene } from "babylonjs/scene";
  75886. import { DepthRenderer } from "babylonjs/Rendering/depthRenderer";
  75887. import { Camera } from "babylonjs/Cameras/camera";
  75888. import { ISceneComponent } from "babylonjs/sceneComponent";
  75889. module "babylonjs/scene" {
  75890. interface Scene {
  75891. /** @hidden (Backing field) */
  75892. _depthRenderer: {
  75893. [id: string]: DepthRenderer;
  75894. };
  75895. /**
  75896. * Creates a depth renderer a given camera which contains a depth map which can be used for post processing.
  75897. * @param camera The camera to create the depth renderer on (default: scene's active camera)
  75898. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  75899. * @returns the created depth renderer
  75900. */
  75901. enableDepthRenderer(camera?: Nullable<Camera>, storeNonLinearDepth?: boolean): DepthRenderer;
  75902. /**
  75903. * Disables a depth renderer for a given camera
  75904. * @param camera The camera to disable the depth renderer on (default: scene's active camera)
  75905. */
  75906. disableDepthRenderer(camera?: Nullable<Camera>): void;
  75907. }
  75908. }
  75909. /**
  75910. * Defines the Depth Renderer scene component responsible to manage a depth buffer useful
  75911. * in several rendering techniques.
  75912. */
  75913. export class DepthRendererSceneComponent implements ISceneComponent {
  75914. /**
  75915. * The component name helpfull to identify the component in the list of scene components.
  75916. */
  75917. readonly name: string;
  75918. /**
  75919. * The scene the component belongs to.
  75920. */
  75921. scene: Scene;
  75922. /**
  75923. * Creates a new instance of the component for the given scene
  75924. * @param scene Defines the scene to register the component in
  75925. */
  75926. constructor(scene: Scene);
  75927. /**
  75928. * Registers the component in a given scene
  75929. */
  75930. register(): void;
  75931. /**
  75932. * Rebuilds the elements related to this component in case of
  75933. * context lost for instance.
  75934. */
  75935. rebuild(): void;
  75936. /**
  75937. * Disposes the component and the associated ressources
  75938. */
  75939. dispose(): void;
  75940. private _gatherRenderTargets;
  75941. private _gatherActiveCameraRenderTargets;
  75942. }
  75943. }
  75944. declare module "babylonjs/Rendering/prePassRendererSceneComponent" {
  75945. import { Nullable } from "babylonjs/types";
  75946. import { Scene } from "babylonjs/scene";
  75947. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  75948. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  75949. import { AbstractScene } from "babylonjs/abstractScene";
  75950. module "babylonjs/abstractScene" {
  75951. interface AbstractScene {
  75952. /** @hidden (Backing field) */
  75953. _prePassRenderer: Nullable<PrePassRenderer>;
  75954. /**
  75955. * Gets or Sets the current prepass renderer associated to the scene.
  75956. */
  75957. prePassRenderer: Nullable<PrePassRenderer>;
  75958. /**
  75959. * Enables the prepass and associates it with the scene
  75960. * @returns the PrePassRenderer
  75961. */
  75962. enablePrePassRenderer(): Nullable<PrePassRenderer>;
  75963. /**
  75964. * Disables the prepass associated with the scene
  75965. */
  75966. disablePrePassRenderer(): void;
  75967. }
  75968. }
  75969. /**
  75970. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  75971. * in several rendering techniques.
  75972. */
  75973. export class PrePassRendererSceneComponent implements ISceneSerializableComponent {
  75974. /**
  75975. * The component name helpful to identify the component in the list of scene components.
  75976. */
  75977. readonly name: string;
  75978. /**
  75979. * The scene the component belongs to.
  75980. */
  75981. scene: Scene;
  75982. /**
  75983. * Creates a new instance of the component for the given scene
  75984. * @param scene Defines the scene to register the component in
  75985. */
  75986. constructor(scene: Scene);
  75987. /**
  75988. * Registers the component in a given scene
  75989. */
  75990. register(): void;
  75991. private _beforeCameraDraw;
  75992. private _afterCameraDraw;
  75993. private _beforeClearStage;
  75994. /**
  75995. * Serializes the component data to the specified json object
  75996. * @param serializationObject The object to serialize to
  75997. */
  75998. serialize(serializationObject: any): void;
  75999. /**
  76000. * Adds all the elements from the container to the scene
  76001. * @param container the container holding the elements
  76002. */
  76003. addFromContainer(container: AbstractScene): void;
  76004. /**
  76005. * Removes all the elements in the container from the scene
  76006. * @param container contains the elements to remove
  76007. * @param dispose if the removed element should be disposed (default: false)
  76008. */
  76009. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  76010. /**
  76011. * Rebuilds the elements related to this component in case of
  76012. * context lost for instance.
  76013. */
  76014. rebuild(): void;
  76015. /**
  76016. * Disposes the component and the associated ressources
  76017. */
  76018. dispose(): void;
  76019. }
  76020. }
  76021. declare module "babylonjs/Shaders/outline.fragment" {
  76022. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  76023. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  76024. /** @hidden */
  76025. export var outlinePixelShader: {
  76026. name: string;
  76027. shader: string;
  76028. };
  76029. }
  76030. declare module "babylonjs/Shaders/outline.vertex" {
  76031. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  76032. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  76033. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  76034. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  76035. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  76036. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  76037. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  76038. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  76039. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  76040. /** @hidden */
  76041. export var outlineVertexShader: {
  76042. name: string;
  76043. shader: string;
  76044. };
  76045. }
  76046. declare module "babylonjs/Rendering/outlineRenderer" {
  76047. import { SubMesh } from "babylonjs/Meshes/subMesh";
  76048. import { _InstancesBatch } from "babylonjs/Meshes/mesh";
  76049. import { Scene } from "babylonjs/scene";
  76050. import { ISceneComponent } from "babylonjs/sceneComponent";
  76051. import "babylonjs/Shaders/outline.fragment";
  76052. import "babylonjs/Shaders/outline.vertex";
  76053. module "babylonjs/scene" {
  76054. interface Scene {
  76055. /** @hidden */
  76056. _outlineRenderer: OutlineRenderer;
  76057. /**
  76058. * Gets the outline renderer associated with the scene
  76059. * @returns a OutlineRenderer
  76060. */
  76061. getOutlineRenderer(): OutlineRenderer;
  76062. }
  76063. }
  76064. module "babylonjs/Meshes/abstractMesh" {
  76065. interface AbstractMesh {
  76066. /** @hidden (Backing field) */
  76067. _renderOutline: boolean;
  76068. /**
  76069. * Gets or sets a boolean indicating if the outline must be rendered as well
  76070. * @see https://www.babylonjs-playground.com/#10WJ5S#3
  76071. */
  76072. renderOutline: boolean;
  76073. /** @hidden (Backing field) */
  76074. _renderOverlay: boolean;
  76075. /**
  76076. * Gets or sets a boolean indicating if the overlay must be rendered as well
  76077. * @see https://www.babylonjs-playground.com/#10WJ5S#2
  76078. */
  76079. renderOverlay: boolean;
  76080. }
  76081. }
  76082. /**
  76083. * This class is responsible to draw bothe outline/overlay of meshes.
  76084. * It should not be used directly but through the available method on mesh.
  76085. */
  76086. export class OutlineRenderer implements ISceneComponent {
  76087. /**
  76088. * Stencil value used to avoid outline being seen within the mesh when the mesh is transparent
  76089. */
  76090. private static _StencilReference;
  76091. /**
  76092. * The name of the component. Each component must have a unique name.
  76093. */
  76094. name: string;
  76095. /**
  76096. * The scene the component belongs to.
  76097. */
  76098. scene: Scene;
  76099. /**
  76100. * Defines a zOffset to prevent zFighting between the overlay and the mesh.
  76101. */
  76102. zOffset: number;
  76103. private _engine;
  76104. private _effect;
  76105. private _cachedDefines;
  76106. private _savedDepthWrite;
  76107. /**
  76108. * Instantiates a new outline renderer. (There could be only one per scene).
  76109. * @param scene Defines the scene it belongs to
  76110. */
  76111. constructor(scene: Scene);
  76112. /**
  76113. * Register the component to one instance of a scene.
  76114. */
  76115. register(): void;
  76116. /**
  76117. * Rebuilds the elements related to this component in case of
  76118. * context lost for instance.
  76119. */
  76120. rebuild(): void;
  76121. /**
  76122. * Disposes the component and the associated ressources.
  76123. */
  76124. dispose(): void;
  76125. /**
  76126. * Renders the outline in the canvas.
  76127. * @param subMesh Defines the sumesh to render
  76128. * @param batch Defines the batch of meshes in case of instances
  76129. * @param useOverlay Defines if the rendering is for the overlay or the outline
  76130. */
  76131. render(subMesh: SubMesh, batch: _InstancesBatch, useOverlay?: boolean): void;
  76132. /**
  76133. * Returns whether or not the outline renderer is ready for a given submesh.
  76134. * All the dependencies e.g. submeshes, texture, effect... mus be ready
  76135. * @param subMesh Defines the submesh to check readyness for
  76136. * @param useInstances Defines wheter wee are trying to render instances or not
  76137. * @returns true if ready otherwise false
  76138. */
  76139. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  76140. private _beforeRenderingMesh;
  76141. private _afterRenderingMesh;
  76142. }
  76143. }
  76144. declare module "babylonjs/Rendering/index" {
  76145. export * from "babylonjs/Rendering/boundingBoxRenderer";
  76146. export * from "babylonjs/Rendering/depthRenderer";
  76147. export * from "babylonjs/Rendering/depthRendererSceneComponent";
  76148. export * from "babylonjs/Rendering/edgesRenderer";
  76149. export * from "babylonjs/Rendering/geometryBufferRenderer";
  76150. export * from "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  76151. export * from "babylonjs/Rendering/prePassRenderer";
  76152. export * from "babylonjs/Rendering/prePassRendererSceneComponent";
  76153. export * from "babylonjs/Rendering/outlineRenderer";
  76154. export * from "babylonjs/Rendering/renderingGroup";
  76155. export * from "babylonjs/Rendering/renderingManager";
  76156. export * from "babylonjs/Rendering/utilityLayerRenderer";
  76157. }
  76158. declare module "babylonjs/Sprites/ISprites" {
  76159. /**
  76160. * Defines the basic options interface of a Sprite Frame Source Size.
  76161. */
  76162. export interface ISpriteJSONSpriteSourceSize {
  76163. /**
  76164. * number of the original width of the Frame
  76165. */
  76166. w: number;
  76167. /**
  76168. * number of the original height of the Frame
  76169. */
  76170. h: number;
  76171. }
  76172. /**
  76173. * Defines the basic options interface of a Sprite Frame Data.
  76174. */
  76175. export interface ISpriteJSONSpriteFrameData {
  76176. /**
  76177. * number of the x offset of the Frame
  76178. */
  76179. x: number;
  76180. /**
  76181. * number of the y offset of the Frame
  76182. */
  76183. y: number;
  76184. /**
  76185. * number of the width of the Frame
  76186. */
  76187. w: number;
  76188. /**
  76189. * number of the height of the Frame
  76190. */
  76191. h: number;
  76192. }
  76193. /**
  76194. * Defines the basic options interface of a JSON Sprite.
  76195. */
  76196. export interface ISpriteJSONSprite {
  76197. /**
  76198. * string name of the Frame
  76199. */
  76200. filename: string;
  76201. /**
  76202. * ISpriteJSONSpriteFrame basic object of the frame data
  76203. */
  76204. frame: ISpriteJSONSpriteFrameData;
  76205. /**
  76206. * boolean to flag is the frame was rotated.
  76207. */
  76208. rotated: boolean;
  76209. /**
  76210. * boolean to flag is the frame was trimmed.
  76211. */
  76212. trimmed: boolean;
  76213. /**
  76214. * ISpriteJSONSpriteFrame basic object of the source data
  76215. */
  76216. spriteSourceSize: ISpriteJSONSpriteFrameData;
  76217. /**
  76218. * ISpriteJSONSpriteFrame basic object of the source data
  76219. */
  76220. sourceSize: ISpriteJSONSpriteSourceSize;
  76221. }
  76222. /**
  76223. * Defines the basic options interface of a JSON atlas.
  76224. */
  76225. export interface ISpriteJSONAtlas {
  76226. /**
  76227. * Array of objects that contain the frame data.
  76228. */
  76229. frames: Array<ISpriteJSONSprite>;
  76230. /**
  76231. * object basic object containing the sprite meta data.
  76232. */
  76233. meta?: object;
  76234. }
  76235. }
  76236. declare module "babylonjs/Shaders/spriteMap.fragment" {
  76237. /** @hidden */
  76238. export var spriteMapPixelShader: {
  76239. name: string;
  76240. shader: string;
  76241. };
  76242. }
  76243. declare module "babylonjs/Shaders/spriteMap.vertex" {
  76244. /** @hidden */
  76245. export var spriteMapVertexShader: {
  76246. name: string;
  76247. shader: string;
  76248. };
  76249. }
  76250. declare module "babylonjs/Sprites/spriteMap" {
  76251. import { IDisposable, Scene } from "babylonjs/scene";
  76252. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  76253. import { Texture } from "babylonjs/Materials/Textures/texture";
  76254. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  76255. import { ISpriteJSONSprite, ISpriteJSONAtlas } from "babylonjs/Sprites/ISprites";
  76256. import "babylonjs/Meshes/Builders/planeBuilder";
  76257. import "babylonjs/Shaders/spriteMap.fragment";
  76258. import "babylonjs/Shaders/spriteMap.vertex";
  76259. /**
  76260. * Defines the basic options interface of a SpriteMap
  76261. */
  76262. export interface ISpriteMapOptions {
  76263. /**
  76264. * Vector2 of the number of cells in the grid.
  76265. */
  76266. stageSize?: Vector2;
  76267. /**
  76268. * Vector2 of the size of the output plane in World Units.
  76269. */
  76270. outputSize?: Vector2;
  76271. /**
  76272. * Vector3 of the position of the output plane in World Units.
  76273. */
  76274. outputPosition?: Vector3;
  76275. /**
  76276. * Vector3 of the rotation of the output plane.
  76277. */
  76278. outputRotation?: Vector3;
  76279. /**
  76280. * number of layers that the system will reserve in resources.
  76281. */
  76282. layerCount?: number;
  76283. /**
  76284. * number of max animation frames a single cell will reserve in resources.
  76285. */
  76286. maxAnimationFrames?: number;
  76287. /**
  76288. * number cell index of the base tile when the system compiles.
  76289. */
  76290. baseTile?: number;
  76291. /**
  76292. * boolean flip the sprite after its been repositioned by the framing data.
  76293. */
  76294. flipU?: boolean;
  76295. /**
  76296. * Vector3 scalar of the global RGB values of the SpriteMap.
  76297. */
  76298. colorMultiply?: Vector3;
  76299. }
  76300. /**
  76301. * Defines the IDisposable interface in order to be cleanable from resources.
  76302. */
  76303. export interface ISpriteMap extends IDisposable {
  76304. /**
  76305. * String name of the SpriteMap.
  76306. */
  76307. name: string;
  76308. /**
  76309. * The JSON Array file from a https://www.codeandweb.com/texturepacker export. Or similar structure.
  76310. */
  76311. atlasJSON: ISpriteJSONAtlas;
  76312. /**
  76313. * Texture of the SpriteMap.
  76314. */
  76315. spriteSheet: Texture;
  76316. /**
  76317. * The parameters to initialize the SpriteMap with.
  76318. */
  76319. options: ISpriteMapOptions;
  76320. }
  76321. /**
  76322. * Class used to manage a grid restricted sprite deployment on an Output plane.
  76323. */
  76324. export class SpriteMap implements ISpriteMap {
  76325. /** The Name of the spriteMap */
  76326. name: string;
  76327. /** The JSON file with the frame and meta data */
  76328. atlasJSON: ISpriteJSONAtlas;
  76329. /** The systems Sprite Sheet Texture */
  76330. spriteSheet: Texture;
  76331. /** Arguments passed with the Constructor */
  76332. options: ISpriteMapOptions;
  76333. /** Public Sprite Storage array, parsed from atlasJSON */
  76334. sprites: Array<ISpriteJSONSprite>;
  76335. /** Returns the Number of Sprites in the System */
  76336. get spriteCount(): number;
  76337. /** Returns the Position of Output Plane*/
  76338. get position(): Vector3;
  76339. /** Returns the Position of Output Plane*/
  76340. set position(v: Vector3);
  76341. /** Returns the Rotation of Output Plane*/
  76342. get rotation(): Vector3;
  76343. /** Returns the Rotation of Output Plane*/
  76344. set rotation(v: Vector3);
  76345. /** Sets the AnimationMap*/
  76346. get animationMap(): RawTexture;
  76347. /** Sets the AnimationMap*/
  76348. set animationMap(v: RawTexture);
  76349. /** Scene that the SpriteMap was created in */
  76350. private _scene;
  76351. /** Texture Buffer of Float32 that holds tile frame data*/
  76352. private _frameMap;
  76353. /** Texture Buffers of Float32 that holds tileMap data*/
  76354. private _tileMaps;
  76355. /** Texture Buffer of Float32 that holds Animation Data*/
  76356. private _animationMap;
  76357. /** Custom ShaderMaterial Central to the System*/
  76358. private _material;
  76359. /** Custom ShaderMaterial Central to the System*/
  76360. private _output;
  76361. /** Systems Time Ticker*/
  76362. private _time;
  76363. /**
  76364. * Creates a new SpriteMap
  76365. * @param name defines the SpriteMaps Name
  76366. * @param atlasJSON is the JSON file that controls the Sprites Frames and Meta
  76367. * @param spriteSheet is the Texture that the Sprites are on.
  76368. * @param options a basic deployment configuration
  76369. * @param scene The Scene that the map is deployed on
  76370. */
  76371. constructor(name: string, atlasJSON: ISpriteJSONAtlas, spriteSheet: Texture, options: ISpriteMapOptions, scene: Scene);
  76372. /**
  76373. * Returns tileID location
  76374. * @returns Vector2 the cell position ID
  76375. */
  76376. getTileID(): Vector2;
  76377. /**
  76378. * Gets the UV location of the mouse over the SpriteMap.
  76379. * @returns Vector2 the UV position of the mouse interaction
  76380. */
  76381. getMousePosition(): Vector2;
  76382. /**
  76383. * Creates the "frame" texture Buffer
  76384. * -------------------------------------
  76385. * Structure of frames
  76386. * "filename": "Falling-Water-2.png",
  76387. * "frame": {"x":69,"y":103,"w":24,"h":32},
  76388. * "rotated": true,
  76389. * "trimmed": true,
  76390. * "spriteSourceSize": {"x":4,"y":0,"w":24,"h":32},
  76391. * "sourceSize": {"w":32,"h":32}
  76392. * @returns RawTexture of the frameMap
  76393. */
  76394. private _createFrameBuffer;
  76395. /**
  76396. * Creates the tileMap texture Buffer
  76397. * @param buffer normally and array of numbers, or a false to generate from scratch
  76398. * @param _layer indicates what layer for a logic trigger dealing with the baseTile. The system uses this
  76399. * @returns RawTexture of the tileMap
  76400. */
  76401. private _createTileBuffer;
  76402. /**
  76403. * Modifies the data of the tileMaps
  76404. * @param _layer is the ID of the layer you want to edit on the SpriteMap
  76405. * @param pos is the iVector2 Coordinates of the Tile
  76406. * @param tile The SpriteIndex of the new Tile
  76407. */
  76408. changeTiles(_layer: number | undefined, pos: Vector2 | Vector2[], tile?: number): void;
  76409. /**
  76410. * Creates the animationMap texture Buffer
  76411. * @param buffer normally and array of numbers, or a false to generate from scratch
  76412. * @returns RawTexture of the animationMap
  76413. */
  76414. private _createTileAnimationBuffer;
  76415. /**
  76416. * Modifies the data of the animationMap
  76417. * @param cellID is the Index of the Sprite
  76418. * @param _frame is the target Animation frame
  76419. * @param toCell is the Target Index of the next frame of the animation
  76420. * @param time is a value between 0-1 that is the trigger for when the frame should change tiles
  76421. * @param speed is a global scalar of the time variable on the map.
  76422. */
  76423. addAnimationToTile(cellID?: number, _frame?: number, toCell?: number, time?: number, speed?: number): void;
  76424. /**
  76425. * Exports the .tilemaps file
  76426. */
  76427. saveTileMaps(): void;
  76428. /**
  76429. * Imports the .tilemaps file
  76430. * @param url of the .tilemaps file
  76431. */
  76432. loadTileMaps(url: string): void;
  76433. /**
  76434. * Release associated resources
  76435. */
  76436. dispose(): void;
  76437. }
  76438. }
  76439. declare module "babylonjs/Sprites/spritePackedManager" {
  76440. import { SpriteManager } from "babylonjs/Sprites/spriteManager";
  76441. import { Scene } from "babylonjs/scene";
  76442. /**
  76443. * Class used to manage multiple sprites of different sizes on the same spritesheet
  76444. * @see https://doc.babylonjs.com/babylon101/sprites
  76445. */
  76446. export class SpritePackedManager extends SpriteManager {
  76447. /** defines the packed manager's name */
  76448. name: string;
  76449. /**
  76450. * Creates a new sprite manager from a packed sprite sheet
  76451. * @param name defines the manager's name
  76452. * @param imgUrl defines the sprite sheet url
  76453. * @param capacity defines the maximum allowed number of sprites
  76454. * @param scene defines the hosting scene
  76455. * @param spriteJSON null otherwise a JSON object defining sprite sheet data
  76456. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  76457. * @param samplingMode defines the smapling mode to use with spritesheet
  76458. * @param fromPacked set to true; do not alter
  76459. */
  76460. constructor(
  76461. /** defines the packed manager's name */
  76462. name: string, imgUrl: string, capacity: number, scene: Scene, spriteJSON?: string | null, epsilon?: number, samplingMode?: number);
  76463. }
  76464. }
  76465. declare module "babylonjs/Sprites/index" {
  76466. export * from "babylonjs/Sprites/sprite";
  76467. export * from "babylonjs/Sprites/ISprites";
  76468. export * from "babylonjs/Sprites/spriteManager";
  76469. export * from "babylonjs/Sprites/spriteMap";
  76470. export * from "babylonjs/Sprites/spritePackedManager";
  76471. export * from "babylonjs/Sprites/spriteSceneComponent";
  76472. }
  76473. declare module "babylonjs/States/index" {
  76474. export * from "babylonjs/States/alphaCullingState";
  76475. export * from "babylonjs/States/depthCullingState";
  76476. export * from "babylonjs/States/stencilState";
  76477. }
  76478. declare module "babylonjs/Misc/assetsManager" {
  76479. import { Scene } from "babylonjs/scene";
  76480. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  76481. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  76482. import { Skeleton } from "babylonjs/Bones/skeleton";
  76483. import { Observable } from "babylonjs/Misc/observable";
  76484. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  76485. import { Texture } from "babylonjs/Materials/Textures/texture";
  76486. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  76487. import { HDRCubeTexture } from "babylonjs/Materials/Textures/hdrCubeTexture";
  76488. import { EquiRectangularCubeTexture } from "babylonjs/Materials/Textures/equiRectangularCubeTexture";
  76489. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  76490. import { AssetContainer } from "babylonjs/assetContainer";
  76491. /**
  76492. * Defines the list of states available for a task inside a AssetsManager
  76493. */
  76494. export enum AssetTaskState {
  76495. /**
  76496. * Initialization
  76497. */
  76498. INIT = 0,
  76499. /**
  76500. * Running
  76501. */
  76502. RUNNING = 1,
  76503. /**
  76504. * Done
  76505. */
  76506. DONE = 2,
  76507. /**
  76508. * Error
  76509. */
  76510. ERROR = 3
  76511. }
  76512. /**
  76513. * Define an abstract asset task used with a AssetsManager class to load assets into a scene
  76514. */
  76515. export abstract class AbstractAssetTask {
  76516. /**
  76517. * Task name
  76518. */ name: string;
  76519. /**
  76520. * Callback called when the task is successful
  76521. */
  76522. onSuccess: (task: any) => void;
  76523. /**
  76524. * Callback called when the task is not successful
  76525. */
  76526. onError: (task: any, message?: string, exception?: any) => void;
  76527. /**
  76528. * Creates a new AssetsManager
  76529. * @param name defines the name of the task
  76530. */
  76531. constructor(
  76532. /**
  76533. * Task name
  76534. */ name: string);
  76535. private _isCompleted;
  76536. private _taskState;
  76537. private _errorObject;
  76538. /**
  76539. * Get if the task is completed
  76540. */
  76541. get isCompleted(): boolean;
  76542. /**
  76543. * Gets the current state of the task
  76544. */
  76545. get taskState(): AssetTaskState;
  76546. /**
  76547. * Gets the current error object (if task is in error)
  76548. */
  76549. get errorObject(): {
  76550. message?: string;
  76551. exception?: any;
  76552. };
  76553. /**
  76554. * Internal only
  76555. * @hidden
  76556. */
  76557. _setErrorObject(message?: string, exception?: any): void;
  76558. /**
  76559. * Execute the current task
  76560. * @param scene defines the scene where you want your assets to be loaded
  76561. * @param onSuccess is a callback called when the task is successfully executed
  76562. * @param onError is a callback called if an error occurs
  76563. */
  76564. run(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76565. /**
  76566. * Execute the current task
  76567. * @param scene defines the scene where you want your assets to be loaded
  76568. * @param onSuccess is a callback called when the task is successfully executed
  76569. * @param onError is a callback called if an error occurs
  76570. */
  76571. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76572. /**
  76573. * Reset will set the task state back to INIT, so the next load call of the assets manager will execute this task again.
  76574. * This can be used with failed tasks that have the reason for failure fixed.
  76575. */
  76576. reset(): void;
  76577. private onErrorCallback;
  76578. private onDoneCallback;
  76579. }
  76580. /**
  76581. * Define the interface used by progress events raised during assets loading
  76582. */
  76583. export interface IAssetsProgressEvent {
  76584. /**
  76585. * Defines the number of remaining tasks to process
  76586. */
  76587. remainingCount: number;
  76588. /**
  76589. * Defines the total number of tasks
  76590. */
  76591. totalCount: number;
  76592. /**
  76593. * Defines the task that was just processed
  76594. */
  76595. task: AbstractAssetTask;
  76596. }
  76597. /**
  76598. * Class used to share progress information about assets loading
  76599. */
  76600. export class AssetsProgressEvent implements IAssetsProgressEvent {
  76601. /**
  76602. * Defines the number of remaining tasks to process
  76603. */
  76604. remainingCount: number;
  76605. /**
  76606. * Defines the total number of tasks
  76607. */
  76608. totalCount: number;
  76609. /**
  76610. * Defines the task that was just processed
  76611. */
  76612. task: AbstractAssetTask;
  76613. /**
  76614. * Creates a AssetsProgressEvent
  76615. * @param remainingCount defines the number of remaining tasks to process
  76616. * @param totalCount defines the total number of tasks
  76617. * @param task defines the task that was just processed
  76618. */
  76619. constructor(remainingCount: number, totalCount: number, task: AbstractAssetTask);
  76620. }
  76621. /**
  76622. * Define a task used by AssetsManager to load assets into a container
  76623. */
  76624. export class ContainerAssetTask extends AbstractAssetTask {
  76625. /**
  76626. * Defines the name of the task
  76627. */
  76628. name: string;
  76629. /**
  76630. * Defines the list of mesh's names you want to load
  76631. */
  76632. meshesNames: any;
  76633. /**
  76634. * Defines the root url to use as a base to load your meshes and associated resources
  76635. */
  76636. rootUrl: string;
  76637. /**
  76638. * Defines the filename or File of the scene to load from
  76639. */
  76640. sceneFilename: string | File;
  76641. /**
  76642. * Get the loaded asset container
  76643. */
  76644. loadedContainer: AssetContainer;
  76645. /**
  76646. * Gets the list of loaded meshes
  76647. */
  76648. loadedMeshes: Array<AbstractMesh>;
  76649. /**
  76650. * Gets the list of loaded particle systems
  76651. */
  76652. loadedParticleSystems: Array<IParticleSystem>;
  76653. /**
  76654. * Gets the list of loaded skeletons
  76655. */
  76656. loadedSkeletons: Array<Skeleton>;
  76657. /**
  76658. * Gets the list of loaded animation groups
  76659. */
  76660. loadedAnimationGroups: Array<AnimationGroup>;
  76661. /**
  76662. * Callback called when the task is successful
  76663. */
  76664. onSuccess: (task: ContainerAssetTask) => void;
  76665. /**
  76666. * Callback called when the task is successful
  76667. */
  76668. onError: (task: ContainerAssetTask, message?: string, exception?: any) => void;
  76669. /**
  76670. * Creates a new ContainerAssetTask
  76671. * @param name defines the name of the task
  76672. * @param meshesNames defines the list of mesh's names you want to load
  76673. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  76674. * @param sceneFilename defines the filename or File of the scene to load from
  76675. */
  76676. constructor(
  76677. /**
  76678. * Defines the name of the task
  76679. */
  76680. name: string,
  76681. /**
  76682. * Defines the list of mesh's names you want to load
  76683. */
  76684. meshesNames: any,
  76685. /**
  76686. * Defines the root url to use as a base to load your meshes and associated resources
  76687. */
  76688. rootUrl: string,
  76689. /**
  76690. * Defines the filename or File of the scene to load from
  76691. */
  76692. sceneFilename: string | File);
  76693. /**
  76694. * Execute the current task
  76695. * @param scene defines the scene where you want your assets to be loaded
  76696. * @param onSuccess is a callback called when the task is successfully executed
  76697. * @param onError is a callback called if an error occurs
  76698. */
  76699. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76700. }
  76701. /**
  76702. * Define a task used by AssetsManager to load meshes
  76703. */
  76704. export class MeshAssetTask extends AbstractAssetTask {
  76705. /**
  76706. * Defines the name of the task
  76707. */
  76708. name: string;
  76709. /**
  76710. * Defines the list of mesh's names you want to load
  76711. */
  76712. meshesNames: any;
  76713. /**
  76714. * Defines the root url to use as a base to load your meshes and associated resources
  76715. */
  76716. rootUrl: string;
  76717. /**
  76718. * Defines the filename or File of the scene to load from
  76719. */
  76720. sceneFilename: string | File;
  76721. /**
  76722. * Gets the list of loaded meshes
  76723. */
  76724. loadedMeshes: Array<AbstractMesh>;
  76725. /**
  76726. * Gets the list of loaded particle systems
  76727. */
  76728. loadedParticleSystems: Array<IParticleSystem>;
  76729. /**
  76730. * Gets the list of loaded skeletons
  76731. */
  76732. loadedSkeletons: Array<Skeleton>;
  76733. /**
  76734. * Gets the list of loaded animation groups
  76735. */
  76736. loadedAnimationGroups: Array<AnimationGroup>;
  76737. /**
  76738. * Callback called when the task is successful
  76739. */
  76740. onSuccess: (task: MeshAssetTask) => void;
  76741. /**
  76742. * Callback called when the task is successful
  76743. */
  76744. onError: (task: MeshAssetTask, message?: string, exception?: any) => void;
  76745. /**
  76746. * Creates a new MeshAssetTask
  76747. * @param name defines the name of the task
  76748. * @param meshesNames defines the list of mesh's names you want to load
  76749. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  76750. * @param sceneFilename defines the filename or File of the scene to load from
  76751. */
  76752. constructor(
  76753. /**
  76754. * Defines the name of the task
  76755. */
  76756. name: string,
  76757. /**
  76758. * Defines the list of mesh's names you want to load
  76759. */
  76760. meshesNames: any,
  76761. /**
  76762. * Defines the root url to use as a base to load your meshes and associated resources
  76763. */
  76764. rootUrl: string,
  76765. /**
  76766. * Defines the filename or File of the scene to load from
  76767. */
  76768. sceneFilename: string | File);
  76769. /**
  76770. * Execute the current task
  76771. * @param scene defines the scene where you want your assets to be loaded
  76772. * @param onSuccess is a callback called when the task is successfully executed
  76773. * @param onError is a callback called if an error occurs
  76774. */
  76775. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76776. }
  76777. /**
  76778. * Define a task used by AssetsManager to load text content
  76779. */
  76780. export class TextFileAssetTask extends AbstractAssetTask {
  76781. /**
  76782. * Defines the name of the task
  76783. */
  76784. name: string;
  76785. /**
  76786. * Defines the location of the file to load
  76787. */
  76788. url: string;
  76789. /**
  76790. * Gets the loaded text string
  76791. */
  76792. text: string;
  76793. /**
  76794. * Callback called when the task is successful
  76795. */
  76796. onSuccess: (task: TextFileAssetTask) => void;
  76797. /**
  76798. * Callback called when the task is successful
  76799. */
  76800. onError: (task: TextFileAssetTask, message?: string, exception?: any) => void;
  76801. /**
  76802. * Creates a new TextFileAssetTask object
  76803. * @param name defines the name of the task
  76804. * @param url defines the location of the file to load
  76805. */
  76806. constructor(
  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. * Execute the current task
  76817. * @param scene defines the scene where you want your assets to be loaded
  76818. * @param onSuccess is a callback called when the task is successfully executed
  76819. * @param onError is a callback called if an error occurs
  76820. */
  76821. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76822. }
  76823. /**
  76824. * Define a task used by AssetsManager to load binary data
  76825. */
  76826. export class BinaryFileAssetTask extends AbstractAssetTask {
  76827. /**
  76828. * Defines the name of the task
  76829. */
  76830. name: string;
  76831. /**
  76832. * Defines the location of the file to load
  76833. */
  76834. url: string;
  76835. /**
  76836. * Gets the lodaded data (as an array buffer)
  76837. */
  76838. data: ArrayBuffer;
  76839. /**
  76840. * Callback called when the task is successful
  76841. */
  76842. onSuccess: (task: BinaryFileAssetTask) => void;
  76843. /**
  76844. * Callback called when the task is successful
  76845. */
  76846. onError: (task: BinaryFileAssetTask, message?: string, exception?: any) => void;
  76847. /**
  76848. * Creates a new BinaryFileAssetTask object
  76849. * @param name defines the name of the new task
  76850. * @param url defines the location of the file to load
  76851. */
  76852. constructor(
  76853. /**
  76854. * Defines the name of the task
  76855. */
  76856. name: string,
  76857. /**
  76858. * Defines the location of the file to load
  76859. */
  76860. url: string);
  76861. /**
  76862. * Execute the current task
  76863. * @param scene defines the scene where you want your assets to be loaded
  76864. * @param onSuccess is a callback called when the task is successfully executed
  76865. * @param onError is a callback called if an error occurs
  76866. */
  76867. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76868. }
  76869. /**
  76870. * Define a task used by AssetsManager to load images
  76871. */
  76872. export class ImageAssetTask extends AbstractAssetTask {
  76873. /**
  76874. * Defines the name of the task
  76875. */
  76876. name: string;
  76877. /**
  76878. * Defines the location of the image to load
  76879. */
  76880. url: string;
  76881. /**
  76882. * Gets the loaded images
  76883. */
  76884. image: HTMLImageElement;
  76885. /**
  76886. * Callback called when the task is successful
  76887. */
  76888. onSuccess: (task: ImageAssetTask) => void;
  76889. /**
  76890. * Callback called when the task is successful
  76891. */
  76892. onError: (task: ImageAssetTask, message?: string, exception?: any) => void;
  76893. /**
  76894. * Creates a new ImageAssetTask
  76895. * @param name defines the name of the task
  76896. * @param url defines the location of the image to load
  76897. */
  76898. constructor(
  76899. /**
  76900. * Defines the name of the task
  76901. */
  76902. name: string,
  76903. /**
  76904. * Defines the location of the image to load
  76905. */
  76906. url: string);
  76907. /**
  76908. * Execute the current task
  76909. * @param scene defines the scene where you want your assets to be loaded
  76910. * @param onSuccess is a callback called when the task is successfully executed
  76911. * @param onError is a callback called if an error occurs
  76912. */
  76913. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76914. }
  76915. /**
  76916. * Defines the interface used by texture loading tasks
  76917. */
  76918. export interface ITextureAssetTask<TEX extends BaseTexture> {
  76919. /**
  76920. * Gets the loaded texture
  76921. */
  76922. texture: TEX;
  76923. }
  76924. /**
  76925. * Define a task used by AssetsManager to load 2D textures
  76926. */
  76927. export class TextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<Texture> {
  76928. /**
  76929. * Defines the name of the task
  76930. */
  76931. name: string;
  76932. /**
  76933. * Defines the location of the file to load
  76934. */
  76935. url: string;
  76936. /**
  76937. * Defines if mipmap should not be generated (default is false)
  76938. */
  76939. noMipmap?: boolean | undefined;
  76940. /**
  76941. * Defines if texture must be inverted on Y axis (default is true)
  76942. */
  76943. invertY: boolean;
  76944. /**
  76945. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  76946. */
  76947. samplingMode: number;
  76948. /**
  76949. * Gets the loaded texture
  76950. */
  76951. texture: Texture;
  76952. /**
  76953. * Callback called when the task is successful
  76954. */
  76955. onSuccess: (task: TextureAssetTask) => void;
  76956. /**
  76957. * Callback called when the task is successful
  76958. */
  76959. onError: (task: TextureAssetTask, message?: string, exception?: any) => void;
  76960. /**
  76961. * Creates a new TextureAssetTask object
  76962. * @param name defines the name of the task
  76963. * @param url defines the location of the file to load
  76964. * @param noMipmap defines if mipmap should not be generated (default is false)
  76965. * @param invertY defines if texture must be inverted on Y axis (default is true)
  76966. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  76967. */
  76968. constructor(
  76969. /**
  76970. * Defines the name of the task
  76971. */
  76972. name: string,
  76973. /**
  76974. * Defines the location of the file to load
  76975. */
  76976. url: string,
  76977. /**
  76978. * Defines if mipmap should not be generated (default is false)
  76979. */
  76980. noMipmap?: boolean | undefined,
  76981. /**
  76982. * Defines if texture must be inverted on Y axis (default is true)
  76983. */
  76984. invertY?: boolean,
  76985. /**
  76986. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  76987. */
  76988. samplingMode?: number);
  76989. /**
  76990. * Execute the current task
  76991. * @param scene defines the scene where you want your assets to be loaded
  76992. * @param onSuccess is a callback called when the task is successfully executed
  76993. * @param onError is a callback called if an error occurs
  76994. */
  76995. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76996. }
  76997. /**
  76998. * Define a task used by AssetsManager to load cube textures
  76999. */
  77000. export class CubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<CubeTexture> {
  77001. /**
  77002. * Defines the name of the task
  77003. */
  77004. name: string;
  77005. /**
  77006. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  77007. */
  77008. url: string;
  77009. /**
  77010. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  77011. */
  77012. extensions?: string[] | undefined;
  77013. /**
  77014. * Defines if mipmaps should not be generated (default is false)
  77015. */
  77016. noMipmap?: boolean | undefined;
  77017. /**
  77018. * Defines the explicit list of files (undefined by default)
  77019. */
  77020. files?: string[] | undefined;
  77021. /**
  77022. * Gets the loaded texture
  77023. */
  77024. texture: CubeTexture;
  77025. /**
  77026. * Callback called when the task is successful
  77027. */
  77028. onSuccess: (task: CubeTextureAssetTask) => void;
  77029. /**
  77030. * Callback called when the task is successful
  77031. */
  77032. onError: (task: CubeTextureAssetTask, message?: string, exception?: any) => void;
  77033. /**
  77034. * Creates a new CubeTextureAssetTask
  77035. * @param name defines the name of the task
  77036. * @param url defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  77037. * @param extensions defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  77038. * @param noMipmap defines if mipmaps should not be generated (default is false)
  77039. * @param files defines the explicit list of files (undefined by default)
  77040. */
  77041. constructor(
  77042. /**
  77043. * Defines the name of the task
  77044. */
  77045. name: string,
  77046. /**
  77047. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  77048. */
  77049. url: string,
  77050. /**
  77051. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  77052. */
  77053. extensions?: string[] | undefined,
  77054. /**
  77055. * Defines if mipmaps should not be generated (default is false)
  77056. */
  77057. noMipmap?: boolean | undefined,
  77058. /**
  77059. * Defines the explicit list of files (undefined by default)
  77060. */
  77061. files?: string[] | undefined);
  77062. /**
  77063. * Execute the current task
  77064. * @param scene defines the scene where you want your assets to be loaded
  77065. * @param onSuccess is a callback called when the task is successfully executed
  77066. * @param onError is a callback called if an error occurs
  77067. */
  77068. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  77069. }
  77070. /**
  77071. * Define a task used by AssetsManager to load HDR cube textures
  77072. */
  77073. export class HDRCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<HDRCubeTexture> {
  77074. /**
  77075. * Defines the name of the task
  77076. */
  77077. name: string;
  77078. /**
  77079. * Defines the location of the file to load
  77080. */
  77081. url: string;
  77082. /**
  77083. * Defines the desired size (the more it increases the longer the generation will be)
  77084. */
  77085. size: number;
  77086. /**
  77087. * Defines if mipmaps should not be generated (default is false)
  77088. */
  77089. noMipmap: boolean;
  77090. /**
  77091. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  77092. */
  77093. generateHarmonics: boolean;
  77094. /**
  77095. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space) (default is false)
  77096. */
  77097. gammaSpace: boolean;
  77098. /**
  77099. * Internal Use Only
  77100. */
  77101. reserved: boolean;
  77102. /**
  77103. * Gets the loaded texture
  77104. */
  77105. texture: HDRCubeTexture;
  77106. /**
  77107. * Callback called when the task is successful
  77108. */
  77109. onSuccess: (task: HDRCubeTextureAssetTask) => void;
  77110. /**
  77111. * Callback called when the task is successful
  77112. */
  77113. onError: (task: HDRCubeTextureAssetTask, message?: string, exception?: any) => void;
  77114. /**
  77115. * Creates a new HDRCubeTextureAssetTask object
  77116. * @param name defines the name of the task
  77117. * @param url defines the location of the file to load
  77118. * @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.
  77119. * @param noMipmap defines if mipmaps should not be generated (default is false)
  77120. * @param generateHarmonics specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  77121. * @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)
  77122. * @param reserved Internal use only
  77123. */
  77124. constructor(
  77125. /**
  77126. * Defines the name of the task
  77127. */
  77128. name: string,
  77129. /**
  77130. * Defines the location of the file to load
  77131. */
  77132. url: string,
  77133. /**
  77134. * Defines the desired size (the more it increases the longer the generation will be)
  77135. */
  77136. size: number,
  77137. /**
  77138. * Defines if mipmaps should not be generated (default is false)
  77139. */
  77140. noMipmap?: boolean,
  77141. /**
  77142. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  77143. */
  77144. generateHarmonics?: boolean,
  77145. /**
  77146. * 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)
  77147. */
  77148. gammaSpace?: boolean,
  77149. /**
  77150. * Internal Use Only
  77151. */
  77152. reserved?: boolean);
  77153. /**
  77154. * Execute the current task
  77155. * @param scene defines the scene where you want your assets to be loaded
  77156. * @param onSuccess is a callback called when the task is successfully executed
  77157. * @param onError is a callback called if an error occurs
  77158. */
  77159. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  77160. }
  77161. /**
  77162. * Define a task used by AssetsManager to load Equirectangular cube textures
  77163. */
  77164. export class EquiRectangularCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<EquiRectangularCubeTexture> {
  77165. /**
  77166. * Defines the name of the task
  77167. */
  77168. name: string;
  77169. /**
  77170. * Defines the location of the file to load
  77171. */
  77172. url: string;
  77173. /**
  77174. * Defines the desired size (the more it increases the longer the generation will be)
  77175. */
  77176. size: number;
  77177. /**
  77178. * Defines if mipmaps should not be generated (default is false)
  77179. */
  77180. noMipmap: boolean;
  77181. /**
  77182. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  77183. * but the standard material would require them in Gamma space) (default is true)
  77184. */
  77185. gammaSpace: boolean;
  77186. /**
  77187. * Gets the loaded texture
  77188. */
  77189. texture: EquiRectangularCubeTexture;
  77190. /**
  77191. * Callback called when the task is successful
  77192. */
  77193. onSuccess: (task: EquiRectangularCubeTextureAssetTask) => void;
  77194. /**
  77195. * Callback called when the task is successful
  77196. */
  77197. onError: (task: EquiRectangularCubeTextureAssetTask, message?: string, exception?: any) => void;
  77198. /**
  77199. * Creates a new EquiRectangularCubeTextureAssetTask object
  77200. * @param name defines the name of the task
  77201. * @param url defines the location of the file to load
  77202. * @param size defines the desired size (the more it increases the longer the generation will be)
  77203. * If the size is omitted this implies you are using a preprocessed cubemap.
  77204. * @param noMipmap defines if mipmaps should not be generated (default is false)
  77205. * @param gammaSpace specifies if the texture will be used in gamma or linear space
  77206. * (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space)
  77207. * (default is true)
  77208. */
  77209. constructor(
  77210. /**
  77211. * Defines the name of the task
  77212. */
  77213. name: string,
  77214. /**
  77215. * Defines the location of the file to load
  77216. */
  77217. url: string,
  77218. /**
  77219. * Defines the desired size (the more it increases the longer the generation will be)
  77220. */
  77221. size: number,
  77222. /**
  77223. * Defines if mipmaps should not be generated (default is false)
  77224. */
  77225. noMipmap?: boolean,
  77226. /**
  77227. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  77228. * but the standard material would require them in Gamma space) (default is true)
  77229. */
  77230. gammaSpace?: boolean);
  77231. /**
  77232. * Execute the current task
  77233. * @param scene defines the scene where you want your assets to be loaded
  77234. * @param onSuccess is a callback called when the task is successfully executed
  77235. * @param onError is a callback called if an error occurs
  77236. */
  77237. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  77238. }
  77239. /**
  77240. * This class can be used to easily import assets into a scene
  77241. * @see https://doc.babylonjs.com/how_to/how_to_use_assetsmanager
  77242. */
  77243. export class AssetsManager {
  77244. private _scene;
  77245. private _isLoading;
  77246. protected _tasks: AbstractAssetTask[];
  77247. protected _waitingTasksCount: number;
  77248. protected _totalTasksCount: number;
  77249. /**
  77250. * Callback called when all tasks are processed
  77251. */
  77252. onFinish: (tasks: AbstractAssetTask[]) => void;
  77253. /**
  77254. * Callback called when a task is successful
  77255. */
  77256. onTaskSuccess: (task: AbstractAssetTask) => void;
  77257. /**
  77258. * Callback called when a task had an error
  77259. */
  77260. onTaskError: (task: AbstractAssetTask) => void;
  77261. /**
  77262. * Callback called when a task is done (whatever the result is)
  77263. */
  77264. onProgress: (remainingCount: number, totalCount: number, task: AbstractAssetTask) => void;
  77265. /**
  77266. * Observable called when all tasks are processed
  77267. */
  77268. onTaskSuccessObservable: Observable<AbstractAssetTask>;
  77269. /**
  77270. * Observable called when a task had an error
  77271. */
  77272. onTaskErrorObservable: Observable<AbstractAssetTask>;
  77273. /**
  77274. * Observable called when all tasks were executed
  77275. */
  77276. onTasksDoneObservable: Observable<AbstractAssetTask[]>;
  77277. /**
  77278. * Observable called when a task is done (whatever the result is)
  77279. */
  77280. onProgressObservable: Observable<IAssetsProgressEvent>;
  77281. /**
  77282. * Gets or sets a boolean defining if the AssetsManager should use the default loading screen
  77283. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  77284. */
  77285. useDefaultLoadingScreen: boolean;
  77286. /**
  77287. * Gets or sets a boolean defining if the AssetsManager should automatically hide the loading screen
  77288. * when all assets have been downloaded.
  77289. * If set to false, you need to manually call in hideLoadingUI() once your scene is ready.
  77290. */
  77291. autoHideLoadingUI: boolean;
  77292. /**
  77293. * Creates a new AssetsManager
  77294. * @param scene defines the scene to work on
  77295. */
  77296. constructor(scene: Scene);
  77297. /**
  77298. * Add a ContainerAssetTask to the list of active tasks
  77299. * @param taskName defines the name of the new task
  77300. * @param meshesNames defines the name of meshes to load
  77301. * @param rootUrl defines the root url to use to locate files
  77302. * @param sceneFilename defines the filename of the scene file
  77303. * @returns a new ContainerAssetTask object
  77304. */
  77305. addContainerTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): ContainerAssetTask;
  77306. /**
  77307. * Add a MeshAssetTask to the list of active tasks
  77308. * @param taskName defines the name of the new task
  77309. * @param meshesNames defines the name of meshes to load
  77310. * @param rootUrl defines the root url to use to locate files
  77311. * @param sceneFilename defines the filename of the scene file
  77312. * @returns a new MeshAssetTask object
  77313. */
  77314. addMeshTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): MeshAssetTask;
  77315. /**
  77316. * Add a TextFileAssetTask to the list of active tasks
  77317. * @param taskName defines the name of the new task
  77318. * @param url defines the url of the file to load
  77319. * @returns a new TextFileAssetTask object
  77320. */
  77321. addTextFileTask(taskName: string, url: string): TextFileAssetTask;
  77322. /**
  77323. * Add a BinaryFileAssetTask to the list of active tasks
  77324. * @param taskName defines the name of the new task
  77325. * @param url defines the url of the file to load
  77326. * @returns a new BinaryFileAssetTask object
  77327. */
  77328. addBinaryFileTask(taskName: string, url: string): BinaryFileAssetTask;
  77329. /**
  77330. * Add a ImageAssetTask to the list of active tasks
  77331. * @param taskName defines the name of the new task
  77332. * @param url defines the url of the file to load
  77333. * @returns a new ImageAssetTask object
  77334. */
  77335. addImageTask(taskName: string, url: string): ImageAssetTask;
  77336. /**
  77337. * Add a TextureAssetTask to the list of active tasks
  77338. * @param taskName defines the name of the new task
  77339. * @param url defines the url of the file to load
  77340. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  77341. * @param invertY defines if you want to invert Y axis of the loaded texture (false by default)
  77342. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  77343. * @returns a new TextureAssetTask object
  77344. */
  77345. addTextureTask(taskName: string, url: string, noMipmap?: boolean, invertY?: boolean, samplingMode?: number): TextureAssetTask;
  77346. /**
  77347. * Add a CubeTextureAssetTask to the list of active tasks
  77348. * @param taskName defines the name of the new task
  77349. * @param url defines the url of the file to load
  77350. * @param extensions defines the extension to use to load the cube map (can be null)
  77351. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  77352. * @param files defines the list of files to load (can be null)
  77353. * @returns a new CubeTextureAssetTask object
  77354. */
  77355. addCubeTextureTask(taskName: string, url: string, extensions?: string[], noMipmap?: boolean, files?: string[]): CubeTextureAssetTask;
  77356. /**
  77357. *
  77358. * Add a HDRCubeTextureAssetTask to the list of active tasks
  77359. * @param taskName defines the name of the new task
  77360. * @param url defines the url of the file to load
  77361. * @param size defines the size you want for the cubemap (can be null)
  77362. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  77363. * @param generateHarmonics defines if you want to automatically generate (true by default)
  77364. * @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)
  77365. * @param reserved Internal use only
  77366. * @returns a new HDRCubeTextureAssetTask object
  77367. */
  77368. addHDRCubeTextureTask(taskName: string, url: string, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, reserved?: boolean): HDRCubeTextureAssetTask;
  77369. /**
  77370. *
  77371. * Add a EquiRectangularCubeTextureAssetTask to the list of active tasks
  77372. * @param taskName defines the name of the new task
  77373. * @param url defines the url of the file to load
  77374. * @param size defines the size you want for the cubemap (can be null)
  77375. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  77376. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  77377. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  77378. * @returns a new EquiRectangularCubeTextureAssetTask object
  77379. */
  77380. addEquiRectangularCubeTextureAssetTask(taskName: string, url: string, size: number, noMipmap?: boolean, gammaSpace?: boolean): EquiRectangularCubeTextureAssetTask;
  77381. /**
  77382. * Remove a task from the assets manager.
  77383. * @param task the task to remove
  77384. */
  77385. removeTask(task: AbstractAssetTask): void;
  77386. private _decreaseWaitingTasksCount;
  77387. private _runTask;
  77388. /**
  77389. * Reset the AssetsManager and remove all tasks
  77390. * @return the current instance of the AssetsManager
  77391. */
  77392. reset(): AssetsManager;
  77393. /**
  77394. * Start the loading process
  77395. * @return the current instance of the AssetsManager
  77396. */
  77397. load(): AssetsManager;
  77398. /**
  77399. * Start the loading process as an async operation
  77400. * @return a promise returning the list of failed tasks
  77401. */
  77402. loadAsync(): Promise<void>;
  77403. }
  77404. }
  77405. declare module "babylonjs/Misc/deferred" {
  77406. /**
  77407. * Wrapper class for promise with external resolve and reject.
  77408. */
  77409. export class Deferred<T> {
  77410. /**
  77411. * The promise associated with this deferred object.
  77412. */
  77413. readonly promise: Promise<T>;
  77414. private _resolve;
  77415. private _reject;
  77416. /**
  77417. * The resolve method of the promise associated with this deferred object.
  77418. */
  77419. get resolve(): (value?: T | PromiseLike<T> | undefined) => void;
  77420. /**
  77421. * The reject method of the promise associated with this deferred object.
  77422. */
  77423. get reject(): (reason?: any) => void;
  77424. /**
  77425. * Constructor for this deferred object.
  77426. */
  77427. constructor();
  77428. }
  77429. }
  77430. declare module "babylonjs/Misc/meshExploder" {
  77431. import { Mesh } from "babylonjs/Meshes/mesh";
  77432. /**
  77433. * Class used to explode meshes (ie. to have a center and move them away from that center to better see the overall organization)
  77434. */
  77435. export class MeshExploder {
  77436. private _centerMesh;
  77437. private _meshes;
  77438. private _meshesOrigins;
  77439. private _toCenterVectors;
  77440. private _scaledDirection;
  77441. private _newPosition;
  77442. private _centerPosition;
  77443. /**
  77444. * Explodes meshes from a center mesh.
  77445. * @param meshes The meshes to explode.
  77446. * @param centerMesh The mesh to be center of explosion.
  77447. */
  77448. constructor(meshes: Array<Mesh>, centerMesh?: Mesh);
  77449. private _setCenterMesh;
  77450. /**
  77451. * Get class name
  77452. * @returns "MeshExploder"
  77453. */
  77454. getClassName(): string;
  77455. /**
  77456. * "Exploded meshes"
  77457. * @returns Array of meshes with the centerMesh at index 0.
  77458. */
  77459. getMeshes(): Array<Mesh>;
  77460. /**
  77461. * Explodes meshes giving a specific direction
  77462. * @param direction Number to multiply distance of each mesh's origin from center. Use a negative number to implode, or zero to reset.
  77463. */
  77464. explode(direction?: number): void;
  77465. }
  77466. }
  77467. declare module "babylonjs/Misc/filesInput" {
  77468. import { Engine } from "babylonjs/Engines/engine";
  77469. import { Scene } from "babylonjs/scene";
  77470. import { ISceneLoaderProgressEvent } from "babylonjs/Loading/sceneLoader";
  77471. import { Nullable } from "babylonjs/types";
  77472. /**
  77473. * Class used to help managing file picking and drag'n'drop
  77474. */
  77475. export class FilesInput {
  77476. /**
  77477. * List of files ready to be loaded
  77478. */
  77479. static get FilesToLoad(): {
  77480. [key: string]: File;
  77481. };
  77482. /**
  77483. * Callback called when a file is processed
  77484. */
  77485. onProcessFileCallback: (file: File, name: string, extension: string) => boolean;
  77486. private _engine;
  77487. private _currentScene;
  77488. private _sceneLoadedCallback;
  77489. private _progressCallback;
  77490. private _additionalRenderLoopLogicCallback;
  77491. private _textureLoadingCallback;
  77492. private _startingProcessingFilesCallback;
  77493. private _onReloadCallback;
  77494. private _errorCallback;
  77495. private _elementToMonitor;
  77496. private _sceneFileToLoad;
  77497. private _filesToLoad;
  77498. /**
  77499. * Creates a new FilesInput
  77500. * @param engine defines the rendering engine
  77501. * @param scene defines the hosting scene
  77502. * @param sceneLoadedCallback callback called when scene is loaded
  77503. * @param progressCallback callback called to track progress
  77504. * @param additionalRenderLoopLogicCallback callback called to add user logic to the rendering loop
  77505. * @param textureLoadingCallback callback called when a texture is loading
  77506. * @param startingProcessingFilesCallback callback called when the system is about to process all files
  77507. * @param onReloadCallback callback called when a reload is requested
  77508. * @param errorCallback callback call if an error occurs
  77509. */
  77510. 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>);
  77511. private _dragEnterHandler;
  77512. private _dragOverHandler;
  77513. private _dropHandler;
  77514. /**
  77515. * Calls this function to listen to drag'n'drop events on a specific DOM element
  77516. * @param elementToMonitor defines the DOM element to track
  77517. */
  77518. monitorElementForDragNDrop(elementToMonitor: HTMLElement): void;
  77519. /** Gets the current list of files to load */
  77520. get filesToLoad(): File[];
  77521. /**
  77522. * Release all associated resources
  77523. */
  77524. dispose(): void;
  77525. private renderFunction;
  77526. private drag;
  77527. private drop;
  77528. private _traverseFolder;
  77529. private _processFiles;
  77530. /**
  77531. * Load files from a drop event
  77532. * @param event defines the drop event to use as source
  77533. */
  77534. loadFiles(event: any): void;
  77535. private _processReload;
  77536. /**
  77537. * Reload the current scene from the loaded files
  77538. */
  77539. reload(): void;
  77540. }
  77541. }
  77542. declare module "babylonjs/Misc/HighDynamicRange/index" {
  77543. export * from "babylonjs/Misc/HighDynamicRange/cubemapToSphericalPolynomial";
  77544. export * from "babylonjs/Misc/HighDynamicRange/hdr";
  77545. export * from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  77546. }
  77547. declare module "babylonjs/Misc/sceneOptimizer" {
  77548. import { Scene, IDisposable } from "babylonjs/scene";
  77549. import { Observable } from "babylonjs/Misc/observable";
  77550. /**
  77551. * Defines the root class used to create scene optimization to use with SceneOptimizer
  77552. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77553. */
  77554. export class SceneOptimization {
  77555. /**
  77556. * Defines the priority of this optimization (0 by default which means first in the list)
  77557. */
  77558. priority: number;
  77559. /**
  77560. * Gets a string describing the action executed by the current optimization
  77561. * @returns description string
  77562. */
  77563. getDescription(): string;
  77564. /**
  77565. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77566. * @param scene defines the current scene where to apply this optimization
  77567. * @param optimizer defines the current optimizer
  77568. * @returns true if everything that can be done was applied
  77569. */
  77570. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77571. /**
  77572. * Creates the SceneOptimization object
  77573. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  77574. * @param desc defines the description associated with the optimization
  77575. */
  77576. constructor(
  77577. /**
  77578. * Defines the priority of this optimization (0 by default which means first in the list)
  77579. */
  77580. priority?: number);
  77581. }
  77582. /**
  77583. * Defines an optimization used to reduce the size of render target textures
  77584. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77585. */
  77586. export class TextureOptimization extends SceneOptimization {
  77587. /**
  77588. * Defines the priority of this optimization (0 by default which means first in the list)
  77589. */
  77590. priority: number;
  77591. /**
  77592. * 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
  77593. */
  77594. maximumSize: number;
  77595. /**
  77596. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  77597. */
  77598. step: number;
  77599. /**
  77600. * Gets a string describing the action executed by the current optimization
  77601. * @returns description string
  77602. */
  77603. getDescription(): string;
  77604. /**
  77605. * Creates the TextureOptimization object
  77606. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  77607. * @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
  77608. * @param step defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  77609. */
  77610. constructor(
  77611. /**
  77612. * Defines the priority of this optimization (0 by default which means first in the list)
  77613. */
  77614. priority?: number,
  77615. /**
  77616. * 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
  77617. */
  77618. maximumSize?: number,
  77619. /**
  77620. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  77621. */
  77622. step?: number);
  77623. /**
  77624. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77625. * @param scene defines the current scene where to apply this optimization
  77626. * @param optimizer defines the current optimizer
  77627. * @returns true if everything that can be done was applied
  77628. */
  77629. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77630. }
  77631. /**
  77632. * Defines an optimization used to increase or decrease the rendering resolution
  77633. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77634. */
  77635. export class HardwareScalingOptimization extends SceneOptimization {
  77636. /**
  77637. * Defines the priority of this optimization (0 by default which means first in the list)
  77638. */
  77639. priority: number;
  77640. /**
  77641. * Defines the maximum scale to use (2 by default)
  77642. */
  77643. maximumScale: number;
  77644. /**
  77645. * Defines the step to use between two passes (0.5 by default)
  77646. */
  77647. step: number;
  77648. private _currentScale;
  77649. private _directionOffset;
  77650. /**
  77651. * Gets a string describing the action executed by the current optimization
  77652. * @return description string
  77653. */
  77654. getDescription(): string;
  77655. /**
  77656. * Creates the HardwareScalingOptimization object
  77657. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  77658. * @param maximumScale defines the maximum scale to use (2 by default)
  77659. * @param step defines the step to use between two passes (0.5 by default)
  77660. */
  77661. constructor(
  77662. /**
  77663. * Defines the priority of this optimization (0 by default which means first in the list)
  77664. */
  77665. priority?: number,
  77666. /**
  77667. * Defines the maximum scale to use (2 by default)
  77668. */
  77669. maximumScale?: number,
  77670. /**
  77671. * Defines the step to use between two passes (0.5 by default)
  77672. */
  77673. step?: number);
  77674. /**
  77675. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77676. * @param scene defines the current scene where to apply this optimization
  77677. * @param optimizer defines the current optimizer
  77678. * @returns true if everything that can be done was applied
  77679. */
  77680. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77681. }
  77682. /**
  77683. * Defines an optimization used to remove shadows
  77684. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77685. */
  77686. export class ShadowsOptimization extends SceneOptimization {
  77687. /**
  77688. * Gets a string describing the action executed by the current optimization
  77689. * @return description string
  77690. */
  77691. getDescription(): string;
  77692. /**
  77693. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77694. * @param scene defines the current scene where to apply this optimization
  77695. * @param optimizer defines the current optimizer
  77696. * @returns true if everything that can be done was applied
  77697. */
  77698. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77699. }
  77700. /**
  77701. * Defines an optimization used to turn post-processes off
  77702. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77703. */
  77704. export class PostProcessesOptimization extends SceneOptimization {
  77705. /**
  77706. * Gets a string describing the action executed by the current optimization
  77707. * @return description string
  77708. */
  77709. getDescription(): string;
  77710. /**
  77711. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77712. * @param scene defines the current scene where to apply this optimization
  77713. * @param optimizer defines the current optimizer
  77714. * @returns true if everything that can be done was applied
  77715. */
  77716. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77717. }
  77718. /**
  77719. * Defines an optimization used to turn lens flares off
  77720. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77721. */
  77722. export class LensFlaresOptimization extends SceneOptimization {
  77723. /**
  77724. * Gets a string describing the action executed by the current optimization
  77725. * @return description string
  77726. */
  77727. getDescription(): string;
  77728. /**
  77729. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77730. * @param scene defines the current scene where to apply this optimization
  77731. * @param optimizer defines the current optimizer
  77732. * @returns true if everything that can be done was applied
  77733. */
  77734. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77735. }
  77736. /**
  77737. * Defines an optimization based on user defined callback.
  77738. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77739. */
  77740. export class CustomOptimization extends SceneOptimization {
  77741. /**
  77742. * Callback called to apply the custom optimization.
  77743. */
  77744. onApply: (scene: Scene, optimizer: SceneOptimizer) => boolean;
  77745. /**
  77746. * Callback called to get custom description
  77747. */
  77748. onGetDescription: () => string;
  77749. /**
  77750. * Gets a string describing the action executed by the current optimization
  77751. * @returns description string
  77752. */
  77753. getDescription(): string;
  77754. /**
  77755. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77756. * @param scene defines the current scene where to apply this optimization
  77757. * @param optimizer defines the current optimizer
  77758. * @returns true if everything that can be done was applied
  77759. */
  77760. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77761. }
  77762. /**
  77763. * Defines an optimization used to turn particles off
  77764. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77765. */
  77766. export class ParticlesOptimization extends SceneOptimization {
  77767. /**
  77768. * Gets a string describing the action executed by the current optimization
  77769. * @return description string
  77770. */
  77771. getDescription(): string;
  77772. /**
  77773. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77774. * @param scene defines the current scene where to apply this optimization
  77775. * @param optimizer defines the current optimizer
  77776. * @returns true if everything that can be done was applied
  77777. */
  77778. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77779. }
  77780. /**
  77781. * Defines an optimization used to turn render targets off
  77782. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77783. */
  77784. export class RenderTargetsOptimization extends SceneOptimization {
  77785. /**
  77786. * Gets a string describing the action executed by the current optimization
  77787. * @return description string
  77788. */
  77789. getDescription(): string;
  77790. /**
  77791. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77792. * @param scene defines the current scene where to apply this optimization
  77793. * @param optimizer defines the current optimizer
  77794. * @returns true if everything that can be done was applied
  77795. */
  77796. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77797. }
  77798. /**
  77799. * Defines an optimization used to merge meshes with compatible materials
  77800. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77801. */
  77802. export class MergeMeshesOptimization extends SceneOptimization {
  77803. private static _UpdateSelectionTree;
  77804. /**
  77805. * Gets or sets a boolean which defines if optimization octree has to be updated
  77806. */
  77807. static get UpdateSelectionTree(): boolean;
  77808. /**
  77809. * Gets or sets a boolean which defines if optimization octree has to be updated
  77810. */
  77811. static set UpdateSelectionTree(value: boolean);
  77812. /**
  77813. * Gets a string describing the action executed by the current optimization
  77814. * @return description string
  77815. */
  77816. getDescription(): string;
  77817. private _canBeMerged;
  77818. /**
  77819. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77820. * @param scene defines the current scene where to apply this optimization
  77821. * @param optimizer defines the current optimizer
  77822. * @param updateSelectionTree defines that the selection octree has to be updated (false by default)
  77823. * @returns true if everything that can be done was applied
  77824. */
  77825. apply(scene: Scene, optimizer: SceneOptimizer, updateSelectionTree?: boolean): boolean;
  77826. }
  77827. /**
  77828. * Defines a list of options used by SceneOptimizer
  77829. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77830. */
  77831. export class SceneOptimizerOptions {
  77832. /**
  77833. * Defines the target frame rate to reach (60 by default)
  77834. */
  77835. targetFrameRate: number;
  77836. /**
  77837. * Defines the interval between two checkes (2000ms by default)
  77838. */
  77839. trackerDuration: number;
  77840. /**
  77841. * Gets the list of optimizations to apply
  77842. */
  77843. optimizations: SceneOptimization[];
  77844. /**
  77845. * Creates a new list of options used by SceneOptimizer
  77846. * @param targetFrameRate defines the target frame rate to reach (60 by default)
  77847. * @param trackerDuration defines the interval between two checkes (2000ms by default)
  77848. */
  77849. constructor(
  77850. /**
  77851. * Defines the target frame rate to reach (60 by default)
  77852. */
  77853. targetFrameRate?: number,
  77854. /**
  77855. * Defines the interval between two checkes (2000ms by default)
  77856. */
  77857. trackerDuration?: number);
  77858. /**
  77859. * Add a new optimization
  77860. * @param optimization defines the SceneOptimization to add to the list of active optimizations
  77861. * @returns the current SceneOptimizerOptions
  77862. */
  77863. addOptimization(optimization: SceneOptimization): SceneOptimizerOptions;
  77864. /**
  77865. * Add a new custom optimization
  77866. * @param onApply defines the callback called to apply the custom optimization (true if everything that can be done was applied)
  77867. * @param onGetDescription defines the callback called to get the description attached with the optimization.
  77868. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  77869. * @returns the current SceneOptimizerOptions
  77870. */
  77871. addCustomOptimization(onApply: (scene: Scene) => boolean, onGetDescription: () => string, priority?: number): SceneOptimizerOptions;
  77872. /**
  77873. * Creates a list of pre-defined optimizations aimed to reduce the visual impact on the scene
  77874. * @param targetFrameRate defines the target frame rate (60 by default)
  77875. * @returns a SceneOptimizerOptions object
  77876. */
  77877. static LowDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  77878. /**
  77879. * Creates a list of pre-defined optimizations aimed to have a moderate impact on the scene visual
  77880. * @param targetFrameRate defines the target frame rate (60 by default)
  77881. * @returns a SceneOptimizerOptions object
  77882. */
  77883. static ModerateDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  77884. /**
  77885. * Creates a list of pre-defined optimizations aimed to have a big impact on the scene visual
  77886. * @param targetFrameRate defines the target frame rate (60 by default)
  77887. * @returns a SceneOptimizerOptions object
  77888. */
  77889. static HighDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  77890. }
  77891. /**
  77892. * Class used to run optimizations in order to reach a target frame rate
  77893. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77894. */
  77895. export class SceneOptimizer implements IDisposable {
  77896. private _isRunning;
  77897. private _options;
  77898. private _scene;
  77899. private _currentPriorityLevel;
  77900. private _targetFrameRate;
  77901. private _trackerDuration;
  77902. private _currentFrameRate;
  77903. private _sceneDisposeObserver;
  77904. private _improvementMode;
  77905. /**
  77906. * Defines an observable called when the optimizer reaches the target frame rate
  77907. */
  77908. onSuccessObservable: Observable<SceneOptimizer>;
  77909. /**
  77910. * Defines an observable called when the optimizer enables an optimization
  77911. */
  77912. onNewOptimizationAppliedObservable: Observable<SceneOptimization>;
  77913. /**
  77914. * Defines an observable called when the optimizer is not able to reach the target frame rate
  77915. */
  77916. onFailureObservable: Observable<SceneOptimizer>;
  77917. /**
  77918. * Gets a boolean indicating if the optimizer is in improvement mode
  77919. */
  77920. get isInImprovementMode(): boolean;
  77921. /**
  77922. * Gets the current priority level (0 at start)
  77923. */
  77924. get currentPriorityLevel(): number;
  77925. /**
  77926. * Gets the current frame rate checked by the SceneOptimizer
  77927. */
  77928. get currentFrameRate(): number;
  77929. /**
  77930. * Gets or sets the current target frame rate (60 by default)
  77931. */
  77932. get targetFrameRate(): number;
  77933. /**
  77934. * Gets or sets the current target frame rate (60 by default)
  77935. */
  77936. set targetFrameRate(value: number);
  77937. /**
  77938. * Gets or sets the current interval between two checks (every 2000ms by default)
  77939. */
  77940. get trackerDuration(): number;
  77941. /**
  77942. * Gets or sets the current interval between two checks (every 2000ms by default)
  77943. */
  77944. set trackerDuration(value: number);
  77945. /**
  77946. * Gets the list of active optimizations
  77947. */
  77948. get optimizations(): SceneOptimization[];
  77949. /**
  77950. * Creates a new SceneOptimizer
  77951. * @param scene defines the scene to work on
  77952. * @param options defines the options to use with the SceneOptimizer
  77953. * @param autoGeneratePriorities defines if priorities must be generated and not read from SceneOptimization property (true by default)
  77954. * @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)
  77955. */
  77956. constructor(scene: Scene, options?: SceneOptimizerOptions, autoGeneratePriorities?: boolean, improvementMode?: boolean);
  77957. /**
  77958. * Stops the current optimizer
  77959. */
  77960. stop(): void;
  77961. /**
  77962. * Reset the optimizer to initial step (current priority level = 0)
  77963. */
  77964. reset(): void;
  77965. /**
  77966. * Start the optimizer. By default it will try to reach a specific framerate
  77967. * but if the optimizer is set with improvementMode === true then it will run all optimiatiation while frame rate is above the target frame rate
  77968. */
  77969. start(): void;
  77970. private _checkCurrentState;
  77971. /**
  77972. * Release all resources
  77973. */
  77974. dispose(): void;
  77975. /**
  77976. * Helper function to create a SceneOptimizer with one single line of code
  77977. * @param scene defines the scene to work on
  77978. * @param options defines the options to use with the SceneOptimizer
  77979. * @param onSuccess defines a callback to call on success
  77980. * @param onFailure defines a callback to call on failure
  77981. * @returns the new SceneOptimizer object
  77982. */
  77983. static OptimizeAsync(scene: Scene, options?: SceneOptimizerOptions, onSuccess?: () => void, onFailure?: () => void): SceneOptimizer;
  77984. }
  77985. }
  77986. declare module "babylonjs/Misc/sceneSerializer" {
  77987. import { Scene } from "babylonjs/scene";
  77988. /**
  77989. * Class used to serialize a scene into a string
  77990. */
  77991. export class SceneSerializer {
  77992. /**
  77993. * Clear cache used by a previous serialization
  77994. */
  77995. static ClearCache(): void;
  77996. /**
  77997. * Serialize a scene into a JSON compatible object
  77998. * @param scene defines the scene to serialize
  77999. * @returns a JSON compatible object
  78000. */
  78001. static Serialize(scene: Scene): any;
  78002. /**
  78003. * Serialize a mesh into a JSON compatible object
  78004. * @param toSerialize defines the mesh to serialize
  78005. * @param withParents defines if parents must be serialized as well
  78006. * @param withChildren defines if children must be serialized as well
  78007. * @returns a JSON compatible object
  78008. */
  78009. static SerializeMesh(toSerialize: any, withParents?: boolean, withChildren?: boolean): any;
  78010. }
  78011. }
  78012. declare module "babylonjs/Misc/textureTools" {
  78013. import { Texture } from "babylonjs/Materials/Textures/texture";
  78014. /**
  78015. * Class used to host texture specific utilities
  78016. */
  78017. export class TextureTools {
  78018. /**
  78019. * Uses the GPU to create a copy texture rescaled at a given size
  78020. * @param texture Texture to copy from
  78021. * @param width defines the desired width
  78022. * @param height defines the desired height
  78023. * @param useBilinearMode defines if bilinear mode has to be used
  78024. * @return the generated texture
  78025. */
  78026. static CreateResizedCopy(texture: Texture, width: number, height: number, useBilinearMode?: boolean): Texture;
  78027. }
  78028. }
  78029. declare module "babylonjs/Misc/videoRecorder" {
  78030. import { Nullable } from "babylonjs/types";
  78031. import { Engine } from "babylonjs/Engines/engine";
  78032. /**
  78033. * This represents the different options available for the video capture.
  78034. */
  78035. export interface VideoRecorderOptions {
  78036. /** Defines the mime type of the video. */
  78037. mimeType: string;
  78038. /** Defines the FPS the video should be recorded at. */
  78039. fps: number;
  78040. /** Defines the chunk size for the recording data. */
  78041. recordChunckSize: number;
  78042. /** The audio tracks to attach to the recording. */
  78043. audioTracks?: MediaStreamTrack[];
  78044. }
  78045. /**
  78046. * This can help with recording videos from BabylonJS.
  78047. * This is based on the available WebRTC functionalities of the browser.
  78048. *
  78049. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_video
  78050. */
  78051. export class VideoRecorder {
  78052. private static readonly _defaultOptions;
  78053. /**
  78054. * Returns whether or not the VideoRecorder is available in your browser.
  78055. * @param engine Defines the Babylon Engine.
  78056. * @returns true if supported otherwise false.
  78057. */
  78058. static IsSupported(engine: Engine): boolean;
  78059. private readonly _options;
  78060. private _canvas;
  78061. private _mediaRecorder;
  78062. private _recordedChunks;
  78063. private _fileName;
  78064. private _resolve;
  78065. private _reject;
  78066. /**
  78067. * True when a recording is already in progress.
  78068. */
  78069. get isRecording(): boolean;
  78070. /**
  78071. * Create a new VideoCapture object which can help converting what you see in Babylon to a video file.
  78072. * @param engine Defines the BabylonJS Engine you wish to record.
  78073. * @param options Defines options that can be used to customize the capture.
  78074. */
  78075. constructor(engine: Engine, options?: Nullable<VideoRecorderOptions>);
  78076. /**
  78077. * Stops the current recording before the default capture timeout passed in the startRecording function.
  78078. */
  78079. stopRecording(): void;
  78080. /**
  78081. * Starts recording the canvas for a max duration specified in parameters.
  78082. * @param fileName Defines the name of the file to be downloaded when the recording stop.
  78083. * If null no automatic download will start and you can rely on the promise to get the data back.
  78084. * @param maxDuration Defines the maximum recording time in seconds.
  78085. * It defaults to 7 seconds. A value of zero will not stop automatically, you would need to call stopRecording manually.
  78086. * @return A promise callback at the end of the recording with the video data in Blob.
  78087. */
  78088. startRecording(fileName?: Nullable<string>, maxDuration?: number): Promise<Blob>;
  78089. /**
  78090. * Releases internal resources used during the recording.
  78091. */
  78092. dispose(): void;
  78093. private _handleDataAvailable;
  78094. private _handleError;
  78095. private _handleStop;
  78096. }
  78097. }
  78098. declare module "babylonjs/Misc/screenshotTools" {
  78099. import { Camera } from "babylonjs/Cameras/camera";
  78100. import { IScreenshotSize } from "babylonjs/Misc/interfaces/screenshotSize";
  78101. import { Engine } from "babylonjs/Engines/engine";
  78102. /**
  78103. * Class containing a set of static utilities functions for screenshots
  78104. */
  78105. export class ScreenshotTools {
  78106. /**
  78107. * Captures a screenshot of the current rendering
  78108. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  78109. * @param engine defines the rendering engine
  78110. * @param camera defines the source camera
  78111. * @param size This parameter can be set to a single number or to an object with the
  78112. * following (optional) properties: precision, width, height. If a single number is passed,
  78113. * it will be used for both width and height. If an object is passed, the screenshot size
  78114. * will be derived from the parameters. The precision property is a multiplier allowing
  78115. * rendering at a higher or lower resolution
  78116. * @param successCallback defines the callback receives a single parameter which contains the
  78117. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  78118. * src parameter of an <img> to display it
  78119. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  78120. * Check your browser for supported MIME types
  78121. */
  78122. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  78123. /**
  78124. * Captures a screenshot of the current rendering
  78125. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  78126. * @param engine defines the rendering engine
  78127. * @param camera defines the source camera
  78128. * @param size This parameter can be set to a single number or to an object with the
  78129. * following (optional) properties: precision, width, height. If a single number is passed,
  78130. * it will be used for both width and height. If an object is passed, the screenshot size
  78131. * will be derived from the parameters. The precision property is a multiplier allowing
  78132. * rendering at a higher or lower resolution
  78133. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  78134. * Check your browser for supported MIME types
  78135. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  78136. * to the src parameter of an <img> to display it
  78137. */
  78138. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: any, mimeType?: string): Promise<string>;
  78139. /**
  78140. * Generates an image screenshot from the specified camera.
  78141. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  78142. * @param engine The engine to use for rendering
  78143. * @param camera The camera to use for rendering
  78144. * @param size This parameter can be set to a single number or to an object with the
  78145. * following (optional) properties: precision, width, height. If a single number is passed,
  78146. * it will be used for both width and height. If an object is passed, the screenshot size
  78147. * will be derived from the parameters. The precision property is a multiplier allowing
  78148. * rendering at a higher or lower resolution
  78149. * @param successCallback The callback receives a single parameter which contains the
  78150. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  78151. * src parameter of an <img> to display it
  78152. * @param mimeType The MIME type of the screenshot image (default: image/png).
  78153. * Check your browser for supported MIME types
  78154. * @param samples Texture samples (default: 1)
  78155. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  78156. * @param fileName A name for for the downloaded file.
  78157. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  78158. * @param enableStencilBuffer Whether the stencil buffer should be enabled or not (default: false)
  78159. */
  78160. 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;
  78161. /**
  78162. * Generates an image screenshot from the specified camera.
  78163. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  78164. * @param engine The engine to use for rendering
  78165. * @param camera The camera to use for rendering
  78166. * @param size This parameter can be set to a single number or to an object with the
  78167. * following (optional) properties: precision, width, height. If a single number is passed,
  78168. * it will be used for both width and height. If an object is passed, the screenshot size
  78169. * will be derived from the parameters. The precision property is a multiplier allowing
  78170. * rendering at a higher or lower resolution
  78171. * @param mimeType The MIME type of the screenshot image (default: image/png).
  78172. * Check your browser for supported MIME types
  78173. * @param samples Texture samples (default: 1)
  78174. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  78175. * @param fileName A name for for the downloaded file.
  78176. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  78177. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  78178. * to the src parameter of an <img> to display it
  78179. */
  78180. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: any, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string, renderSprites?: boolean): Promise<string>;
  78181. /**
  78182. * Gets height and width for screenshot size
  78183. * @private
  78184. */
  78185. private static _getScreenshotSize;
  78186. }
  78187. }
  78188. declare module "babylonjs/Misc/dataReader" {
  78189. /**
  78190. * Interface for a data buffer
  78191. */
  78192. export interface IDataBuffer {
  78193. /**
  78194. * Reads bytes from the data buffer.
  78195. * @param byteOffset The byte offset to read
  78196. * @param byteLength The byte length to read
  78197. * @returns A promise that resolves when the bytes are read
  78198. */
  78199. readAsync(byteOffset: number, byteLength: number): Promise<ArrayBufferView>;
  78200. /**
  78201. * The byte length of the buffer.
  78202. */
  78203. readonly byteLength: number;
  78204. }
  78205. /**
  78206. * Utility class for reading from a data buffer
  78207. */
  78208. export class DataReader {
  78209. /**
  78210. * The data buffer associated with this data reader.
  78211. */
  78212. readonly buffer: IDataBuffer;
  78213. /**
  78214. * The current byte offset from the beginning of the data buffer.
  78215. */
  78216. byteOffset: number;
  78217. private _dataView;
  78218. private _dataByteOffset;
  78219. /**
  78220. * Constructor
  78221. * @param buffer The buffer to read
  78222. */
  78223. constructor(buffer: IDataBuffer);
  78224. /**
  78225. * Loads the given byte length.
  78226. * @param byteLength The byte length to load
  78227. * @returns A promise that resolves when the load is complete
  78228. */
  78229. loadAsync(byteLength: number): Promise<void>;
  78230. /**
  78231. * Read a unsigned 32-bit integer from the currently loaded data range.
  78232. * @returns The 32-bit integer read
  78233. */
  78234. readUint32(): number;
  78235. /**
  78236. * Read a byte array from the currently loaded data range.
  78237. * @param byteLength The byte length to read
  78238. * @returns The byte array read
  78239. */
  78240. readUint8Array(byteLength: number): Uint8Array;
  78241. /**
  78242. * Read a string from the currently loaded data range.
  78243. * @param byteLength The byte length to read
  78244. * @returns The string read
  78245. */
  78246. readString(byteLength: number): string;
  78247. /**
  78248. * Skips the given byte length the currently loaded data range.
  78249. * @param byteLength The byte length to skip
  78250. */
  78251. skipBytes(byteLength: number): void;
  78252. }
  78253. }
  78254. declare module "babylonjs/Misc/dataStorage" {
  78255. /**
  78256. * Class for storing data to local storage if available or in-memory storage otherwise
  78257. */
  78258. export class DataStorage {
  78259. private static _Storage;
  78260. private static _GetStorage;
  78261. /**
  78262. * Reads a string from the data storage
  78263. * @param key The key to read
  78264. * @param defaultValue The value if the key doesn't exist
  78265. * @returns The string value
  78266. */
  78267. static ReadString(key: string, defaultValue: string): string;
  78268. /**
  78269. * Writes a string to the data storage
  78270. * @param key The key to write
  78271. * @param value The value to write
  78272. */
  78273. static WriteString(key: string, value: string): void;
  78274. /**
  78275. * Reads a boolean from the data storage
  78276. * @param key The key to read
  78277. * @param defaultValue The value if the key doesn't exist
  78278. * @returns The boolean value
  78279. */
  78280. static ReadBoolean(key: string, defaultValue: boolean): boolean;
  78281. /**
  78282. * Writes a boolean to the data storage
  78283. * @param key The key to write
  78284. * @param value The value to write
  78285. */
  78286. static WriteBoolean(key: string, value: boolean): void;
  78287. /**
  78288. * Reads a number from the data storage
  78289. * @param key The key to read
  78290. * @param defaultValue The value if the key doesn't exist
  78291. * @returns The number value
  78292. */
  78293. static ReadNumber(key: string, defaultValue: number): number;
  78294. /**
  78295. * Writes a number to the data storage
  78296. * @param key The key to write
  78297. * @param value The value to write
  78298. */
  78299. static WriteNumber(key: string, value: number): void;
  78300. }
  78301. }
  78302. declare module "babylonjs/Misc/sceneRecorder" {
  78303. import { Scene } from "babylonjs/scene";
  78304. /**
  78305. * Class used to record delta files between 2 scene states
  78306. */
  78307. export class SceneRecorder {
  78308. private _trackedScene;
  78309. private _savedJSON;
  78310. /**
  78311. * Track a given scene. This means the current scene state will be considered the original state
  78312. * @param scene defines the scene to track
  78313. */
  78314. track(scene: Scene): void;
  78315. /**
  78316. * Get the delta between current state and original state
  78317. * @returns a string containing the delta
  78318. */
  78319. getDelta(): any;
  78320. private _compareArray;
  78321. private _compareObjects;
  78322. private _compareCollections;
  78323. private static GetShadowGeneratorById;
  78324. /**
  78325. * Apply a given delta to a given scene
  78326. * @param deltaJSON defines the JSON containing the delta
  78327. * @param scene defines the scene to apply the delta to
  78328. */
  78329. static ApplyDelta(deltaJSON: any | string, scene: Scene): void;
  78330. private static _ApplyPropertiesToEntity;
  78331. private static _ApplyDeltaForEntity;
  78332. }
  78333. }
  78334. declare module "babylonjs/Misc/index" {
  78335. export * from "babylonjs/Misc/andOrNotEvaluator";
  78336. export * from "babylonjs/Misc/assetsManager";
  78337. export * from "babylonjs/Misc/basis";
  78338. export * from "babylonjs/Misc/dds";
  78339. export * from "babylonjs/Misc/decorators";
  78340. export * from "babylonjs/Misc/deferred";
  78341. export * from "babylonjs/Misc/environmentTextureTools";
  78342. export * from "babylonjs/Misc/meshExploder";
  78343. export * from "babylonjs/Misc/filesInput";
  78344. export * from "babylonjs/Misc/HighDynamicRange/index";
  78345. export * from "babylonjs/Misc/khronosTextureContainer";
  78346. export * from "babylonjs/Misc/observable";
  78347. export * from "babylonjs/Misc/performanceMonitor";
  78348. export * from "babylonjs/Misc/promise";
  78349. export * from "babylonjs/Misc/sceneOptimizer";
  78350. export * from "babylonjs/Misc/sceneSerializer";
  78351. export * from "babylonjs/Misc/smartArray";
  78352. export * from "babylonjs/Misc/stringDictionary";
  78353. export * from "babylonjs/Misc/tags";
  78354. export * from "babylonjs/Misc/textureTools";
  78355. export * from "babylonjs/Misc/tga";
  78356. export * from "babylonjs/Misc/tools";
  78357. export * from "babylonjs/Misc/videoRecorder";
  78358. export * from "babylonjs/Misc/virtualJoystick";
  78359. export * from "babylonjs/Misc/workerPool";
  78360. export * from "babylonjs/Misc/logger";
  78361. export * from "babylonjs/Misc/typeStore";
  78362. export * from "babylonjs/Misc/filesInputStore";
  78363. export * from "babylonjs/Misc/deepCopier";
  78364. export * from "babylonjs/Misc/pivotTools";
  78365. export * from "babylonjs/Misc/precisionDate";
  78366. export * from "babylonjs/Misc/screenshotTools";
  78367. export * from "babylonjs/Misc/typeStore";
  78368. export * from "babylonjs/Misc/webRequest";
  78369. export * from "babylonjs/Misc/iInspectable";
  78370. export * from "babylonjs/Misc/brdfTextureTools";
  78371. export * from "babylonjs/Misc/rgbdTextureTools";
  78372. export * from "babylonjs/Misc/gradients";
  78373. export * from "babylonjs/Misc/perfCounter";
  78374. export * from "babylonjs/Misc/fileRequest";
  78375. export * from "babylonjs/Misc/customAnimationFrameRequester";
  78376. export * from "babylonjs/Misc/retryStrategy";
  78377. export * from "babylonjs/Misc/interfaces/screenshotSize";
  78378. export * from "babylonjs/Misc/canvasGenerator";
  78379. export * from "babylonjs/Misc/fileTools";
  78380. export * from "babylonjs/Misc/stringTools";
  78381. export * from "babylonjs/Misc/dataReader";
  78382. export * from "babylonjs/Misc/minMaxReducer";
  78383. export * from "babylonjs/Misc/depthReducer";
  78384. export * from "babylonjs/Misc/dataStorage";
  78385. export * from "babylonjs/Misc/sceneRecorder";
  78386. export * from "babylonjs/Misc/khronosTextureContainer2";
  78387. }
  78388. declare module "babylonjs/XR/features/WebXRHitTestLegacy" {
  78389. import { IWebXRFeature } from "babylonjs/XR/webXRFeaturesManager";
  78390. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78391. import { Observable } from "babylonjs/Misc/observable";
  78392. import { Matrix } from "babylonjs/Maths/math.vector";
  78393. import { TransformNode } from "babylonjs/Meshes/transformNode";
  78394. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78395. /**
  78396. * An interface for all Hit test features
  78397. */
  78398. export interface IWebXRHitTestFeature<T extends IWebXRLegacyHitResult> extends IWebXRFeature {
  78399. /**
  78400. * Triggered when new babylon (transformed) hit test results are available
  78401. */
  78402. onHitTestResultObservable: Observable<T[]>;
  78403. }
  78404. /**
  78405. * Options used for hit testing
  78406. */
  78407. export interface IWebXRLegacyHitTestOptions {
  78408. /**
  78409. * Only test when user interacted with the scene. Default - hit test every frame
  78410. */
  78411. testOnPointerDownOnly?: boolean;
  78412. /**
  78413. * The node to use to transform the local results to world coordinates
  78414. */
  78415. worldParentNode?: TransformNode;
  78416. }
  78417. /**
  78418. * Interface defining the babylon result of raycasting/hit-test
  78419. */
  78420. export interface IWebXRLegacyHitResult {
  78421. /**
  78422. * Transformation matrix that can be applied to a node that will put it in the hit point location
  78423. */
  78424. transformationMatrix: Matrix;
  78425. /**
  78426. * The native hit test result
  78427. */
  78428. xrHitResult: XRHitResult | XRHitTestResult;
  78429. }
  78430. /**
  78431. * The currently-working hit-test module.
  78432. * Hit test (or Ray-casting) is used to interact with the real world.
  78433. * For further information read here - https://github.com/immersive-web/hit-test
  78434. */
  78435. export class WebXRHitTestLegacy extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRLegacyHitResult> {
  78436. /**
  78437. * options to use when constructing this feature
  78438. */
  78439. readonly options: IWebXRLegacyHitTestOptions;
  78440. private _direction;
  78441. private _mat;
  78442. private _onSelectEnabled;
  78443. private _origin;
  78444. /**
  78445. * The module's name
  78446. */
  78447. static readonly Name: string;
  78448. /**
  78449. * The (Babylon) version of this module.
  78450. * This is an integer representing the implementation version.
  78451. * This number does not correspond to the WebXR specs version
  78452. */
  78453. static readonly Version: number;
  78454. /**
  78455. * Populated with the last native XR Hit Results
  78456. */
  78457. lastNativeXRHitResults: XRHitResult[];
  78458. /**
  78459. * Triggered when new babylon (transformed) hit test results are available
  78460. */
  78461. onHitTestResultObservable: Observable<IWebXRLegacyHitResult[]>;
  78462. /**
  78463. * Creates a new instance of the (legacy version) hit test feature
  78464. * @param _xrSessionManager an instance of WebXRSessionManager
  78465. * @param options options to use when constructing this feature
  78466. */
  78467. constructor(_xrSessionManager: WebXRSessionManager,
  78468. /**
  78469. * options to use when constructing this feature
  78470. */
  78471. options?: IWebXRLegacyHitTestOptions);
  78472. /**
  78473. * execute a hit test with an XR Ray
  78474. *
  78475. * @param xrSession a native xrSession that will execute this hit test
  78476. * @param xrRay the ray (position and direction) to use for ray-casting
  78477. * @param referenceSpace native XR reference space to use for the hit-test
  78478. * @param filter filter function that will filter the results
  78479. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  78480. */
  78481. static XRHitTestWithRay(xrSession: XRSession, xrRay: XRRay, referenceSpace: XRReferenceSpace, filter?: (result: XRHitResult) => boolean): Promise<XRHitResult[]>;
  78482. /**
  78483. * Execute a hit test on the current running session using a select event returned from a transient input (such as touch)
  78484. * @param event the (select) event to use to select with
  78485. * @param referenceSpace the reference space to use for this hit test
  78486. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  78487. */
  78488. static XRHitTestWithSelectEvent(event: XRInputSourceEvent, referenceSpace: XRReferenceSpace): Promise<XRHitResult[]>;
  78489. /**
  78490. * attach this feature
  78491. * Will usually be called by the features manager
  78492. *
  78493. * @returns true if successful.
  78494. */
  78495. attach(): boolean;
  78496. /**
  78497. * detach this feature.
  78498. * Will usually be called by the features manager
  78499. *
  78500. * @returns true if successful.
  78501. */
  78502. detach(): boolean;
  78503. /**
  78504. * Dispose this feature and all of the resources attached
  78505. */
  78506. dispose(): void;
  78507. protected _onXRFrame(frame: XRFrame): void;
  78508. private _onHitTestResults;
  78509. private _onSelect;
  78510. }
  78511. }
  78512. declare module "babylonjs/XR/features/WebXRHitTest" {
  78513. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78514. import { Observable } from "babylonjs/Misc/observable";
  78515. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  78516. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78517. import { IWebXRLegacyHitTestOptions, IWebXRLegacyHitResult, IWebXRHitTestFeature } from "babylonjs/XR/features/WebXRHitTestLegacy";
  78518. /**
  78519. * Options used for hit testing (version 2)
  78520. */
  78521. export interface IWebXRHitTestOptions extends IWebXRLegacyHitTestOptions {
  78522. /**
  78523. * Do not create a permanent hit test. Will usually be used when only
  78524. * transient inputs are needed.
  78525. */
  78526. disablePermanentHitTest?: boolean;
  78527. /**
  78528. * Enable transient (for example touch-based) hit test inspections
  78529. */
  78530. enableTransientHitTest?: boolean;
  78531. /**
  78532. * Offset ray for the permanent hit test
  78533. */
  78534. offsetRay?: Vector3;
  78535. /**
  78536. * Offset ray for the transient hit test
  78537. */
  78538. transientOffsetRay?: Vector3;
  78539. /**
  78540. * Instead of using viewer space for hit tests, use the reference space defined in the session manager
  78541. */
  78542. useReferenceSpace?: boolean;
  78543. /**
  78544. * Override the default entity type(s) of the hit-test result
  78545. */
  78546. entityTypes?: XRHitTestTrackableType[];
  78547. }
  78548. /**
  78549. * Interface defining the babylon result of hit-test
  78550. */
  78551. export interface IWebXRHitResult extends IWebXRLegacyHitResult {
  78552. /**
  78553. * The input source that generated this hit test (if transient)
  78554. */
  78555. inputSource?: XRInputSource;
  78556. /**
  78557. * Is this a transient hit test
  78558. */
  78559. isTransient?: boolean;
  78560. /**
  78561. * Position of the hit test result
  78562. */
  78563. position: Vector3;
  78564. /**
  78565. * Rotation of the hit test result
  78566. */
  78567. rotationQuaternion: Quaternion;
  78568. /**
  78569. * The native hit test result
  78570. */
  78571. xrHitResult: XRHitTestResult;
  78572. }
  78573. /**
  78574. * The currently-working hit-test module.
  78575. * Hit test (or Ray-casting) is used to interact with the real world.
  78576. * For further information read here - https://github.com/immersive-web/hit-test
  78577. *
  78578. * Tested on chrome (mobile) 80.
  78579. */
  78580. export class WebXRHitTest extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRHitResult> {
  78581. /**
  78582. * options to use when constructing this feature
  78583. */
  78584. readonly options: IWebXRHitTestOptions;
  78585. private _tmpMat;
  78586. private _tmpPos;
  78587. private _tmpQuat;
  78588. private _transientXrHitTestSource;
  78589. private _xrHitTestSource;
  78590. private initHitTestSource;
  78591. /**
  78592. * The module's name
  78593. */
  78594. static readonly Name: string;
  78595. /**
  78596. * The (Babylon) version of this module.
  78597. * This is an integer representing the implementation version.
  78598. * This number does not correspond to the WebXR specs version
  78599. */
  78600. static readonly Version: number;
  78601. /**
  78602. * When set to true, each hit test will have its own position/rotation objects
  78603. * When set to false, position and rotation objects will be reused for each hit test. It is expected that
  78604. * the developers will clone them or copy them as they see fit.
  78605. */
  78606. autoCloneTransformation: boolean;
  78607. /**
  78608. * Triggered when new babylon (transformed) hit test results are available
  78609. */
  78610. onHitTestResultObservable: Observable<IWebXRHitResult[]>;
  78611. /**
  78612. * Use this to temporarily pause hit test checks.
  78613. */
  78614. paused: boolean;
  78615. /**
  78616. * Creates a new instance of the hit test feature
  78617. * @param _xrSessionManager an instance of WebXRSessionManager
  78618. * @param options options to use when constructing this feature
  78619. */
  78620. constructor(_xrSessionManager: WebXRSessionManager,
  78621. /**
  78622. * options to use when constructing this feature
  78623. */
  78624. options?: IWebXRHitTestOptions);
  78625. /**
  78626. * attach this feature
  78627. * Will usually be called by the features manager
  78628. *
  78629. * @returns true if successful.
  78630. */
  78631. attach(): boolean;
  78632. /**
  78633. * detach this feature.
  78634. * Will usually be called by the features manager
  78635. *
  78636. * @returns true if successful.
  78637. */
  78638. detach(): boolean;
  78639. /**
  78640. * Dispose this feature and all of the resources attached
  78641. */
  78642. dispose(): void;
  78643. protected _onXRFrame(frame: XRFrame): void;
  78644. private _processWebXRHitTestResult;
  78645. }
  78646. }
  78647. declare module "babylonjs/XR/features/WebXRAnchorSystem" {
  78648. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78649. import { Observable } from "babylonjs/Misc/observable";
  78650. import { Matrix, Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  78651. import { TransformNode } from "babylonjs/Meshes/transformNode";
  78652. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78653. import { IWebXRHitResult } from "babylonjs/XR/features/WebXRHitTest";
  78654. /**
  78655. * Configuration options of the anchor system
  78656. */
  78657. export interface IWebXRAnchorSystemOptions {
  78658. /**
  78659. * a node that will be used to convert local to world coordinates
  78660. */
  78661. worldParentNode?: TransformNode;
  78662. /**
  78663. * If set to true a reference of the created anchors will be kept until the next session starts
  78664. * If not defined, anchors will be removed from the array when the feature is detached or the session ended.
  78665. */
  78666. doNotRemoveAnchorsOnSessionEnded?: boolean;
  78667. }
  78668. /**
  78669. * A babylon container for an XR Anchor
  78670. */
  78671. export interface IWebXRAnchor {
  78672. /**
  78673. * A babylon-assigned ID for this anchor
  78674. */
  78675. id: number;
  78676. /**
  78677. * Transformation matrix to apply to an object attached to this anchor
  78678. */
  78679. transformationMatrix: Matrix;
  78680. /**
  78681. * The native anchor object
  78682. */
  78683. xrAnchor: XRAnchor;
  78684. /**
  78685. * if defined, this object will be constantly updated by the anchor's position and rotation
  78686. */
  78687. attachedNode?: TransformNode;
  78688. }
  78689. /**
  78690. * An implementation of the anchor system for WebXR.
  78691. * For further information see https://github.com/immersive-web/anchors/
  78692. */
  78693. export class WebXRAnchorSystem extends WebXRAbstractFeature {
  78694. private _options;
  78695. private _lastFrameDetected;
  78696. private _trackedAnchors;
  78697. private _referenceSpaceForFrameAnchors;
  78698. private _futureAnchors;
  78699. /**
  78700. * The module's name
  78701. */
  78702. static readonly Name: string;
  78703. /**
  78704. * The (Babylon) version of this module.
  78705. * This is an integer representing the implementation version.
  78706. * This number does not correspond to the WebXR specs version
  78707. */
  78708. static readonly Version: number;
  78709. /**
  78710. * Observers registered here will be executed when a new anchor was added to the session
  78711. */
  78712. onAnchorAddedObservable: Observable<IWebXRAnchor>;
  78713. /**
  78714. * Observers registered here will be executed when an anchor was removed from the session
  78715. */
  78716. onAnchorRemovedObservable: Observable<IWebXRAnchor>;
  78717. /**
  78718. * Observers registered here will be executed when an existing anchor updates
  78719. * This can execute N times every frame
  78720. */
  78721. onAnchorUpdatedObservable: Observable<IWebXRAnchor>;
  78722. /**
  78723. * Set the reference space to use for anchor creation, when not using a hit test.
  78724. * Will default to the session's reference space if not defined
  78725. */
  78726. set referenceSpaceForFrameAnchors(referenceSpace: XRReferenceSpace);
  78727. /**
  78728. * constructs a new anchor system
  78729. * @param _xrSessionManager an instance of WebXRSessionManager
  78730. * @param _options configuration object for this feature
  78731. */
  78732. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRAnchorSystemOptions);
  78733. private _tmpVector;
  78734. private _tmpQuaternion;
  78735. private _populateTmpTransformation;
  78736. /**
  78737. * Create a new anchor point using a hit test result at a specific point in the scene
  78738. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  78739. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  78740. *
  78741. * @param hitTestResult The hit test result to use for this anchor creation
  78742. * @param position an optional position offset for this anchor
  78743. * @param rotationQuaternion an optional rotation offset for this anchor
  78744. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  78745. */
  78746. addAnchorPointUsingHitTestResultAsync(hitTestResult: IWebXRHitResult, position?: Vector3, rotationQuaternion?: Quaternion): Promise<XRAnchor>;
  78747. /**
  78748. * Add a new anchor at a specific position and rotation
  78749. * This function will add a new anchor per default in the next available frame. Unless forced, the createAnchor function
  78750. * will be called in the next xrFrame loop to make sure that the anchor can be created correctly.
  78751. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  78752. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  78753. *
  78754. * @param position the position in which to add an anchor
  78755. * @param rotationQuaternion an optional rotation for the anchor transformation
  78756. * @param forceCreateInCurrentFrame force the creation of this anchor in the current frame. Must be called inside xrFrame loop!
  78757. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  78758. */
  78759. addAnchorAtPositionAndRotationAsync(position: Vector3, rotationQuaternion?: Quaternion, forceCreateInCurrentFrame?: boolean): Promise<XRAnchor>;
  78760. /**
  78761. * detach this feature.
  78762. * Will usually be called by the features manager
  78763. *
  78764. * @returns true if successful.
  78765. */
  78766. detach(): boolean;
  78767. /**
  78768. * Dispose this feature and all of the resources attached
  78769. */
  78770. dispose(): void;
  78771. protected _onXRFrame(frame: XRFrame): void;
  78772. /**
  78773. * avoiding using Array.find for global support.
  78774. * @param xrAnchor the plane to find in the array
  78775. */
  78776. private _findIndexInAnchorArray;
  78777. private _updateAnchorWithXRFrame;
  78778. private _createAnchorAtTransformation;
  78779. }
  78780. }
  78781. declare module "babylonjs/XR/features/WebXRPlaneDetector" {
  78782. import { TransformNode } from "babylonjs/Meshes/transformNode";
  78783. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78784. import { Observable } from "babylonjs/Misc/observable";
  78785. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  78786. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78787. /**
  78788. * Options used in the plane detector module
  78789. */
  78790. export interface IWebXRPlaneDetectorOptions {
  78791. /**
  78792. * The node to use to transform the local results to world coordinates
  78793. */
  78794. worldParentNode?: TransformNode;
  78795. /**
  78796. * If set to true a reference of the created planes will be kept until the next session starts
  78797. * If not defined, planes will be removed from the array when the feature is detached or the session ended.
  78798. */
  78799. doNotRemovePlanesOnSessionEnded?: boolean;
  78800. }
  78801. /**
  78802. * A babylon interface for a WebXR plane.
  78803. * A Plane is actually a polygon, built from N points in space
  78804. *
  78805. * Supported in chrome 79, not supported in canary 81 ATM
  78806. */
  78807. export interface IWebXRPlane {
  78808. /**
  78809. * a babylon-assigned ID for this polygon
  78810. */
  78811. id: number;
  78812. /**
  78813. * an array of vector3 points in babylon space. right/left hand system is taken into account.
  78814. */
  78815. polygonDefinition: Array<Vector3>;
  78816. /**
  78817. * A transformation matrix to apply on the mesh that will be built using the polygonDefinition
  78818. * Local vs. World are decided if worldParentNode was provided or not in the options when constructing the module
  78819. */
  78820. transformationMatrix: Matrix;
  78821. /**
  78822. * the native xr-plane object
  78823. */
  78824. xrPlane: XRPlane;
  78825. }
  78826. /**
  78827. * The plane detector is used to detect planes in the real world when in AR
  78828. * For more information see https://github.com/immersive-web/real-world-geometry/
  78829. */
  78830. export class WebXRPlaneDetector extends WebXRAbstractFeature {
  78831. private _options;
  78832. private _detectedPlanes;
  78833. private _enabled;
  78834. private _lastFrameDetected;
  78835. /**
  78836. * The module's name
  78837. */
  78838. static readonly Name: string;
  78839. /**
  78840. * The (Babylon) version of this module.
  78841. * This is an integer representing the implementation version.
  78842. * This number does not correspond to the WebXR specs version
  78843. */
  78844. static readonly Version: number;
  78845. /**
  78846. * Observers registered here will be executed when a new plane was added to the session
  78847. */
  78848. onPlaneAddedObservable: Observable<IWebXRPlane>;
  78849. /**
  78850. * Observers registered here will be executed when a plane is no longer detected in the session
  78851. */
  78852. onPlaneRemovedObservable: Observable<IWebXRPlane>;
  78853. /**
  78854. * Observers registered here will be executed when an existing plane updates (for example - expanded)
  78855. * This can execute N times every frame
  78856. */
  78857. onPlaneUpdatedObservable: Observable<IWebXRPlane>;
  78858. /**
  78859. * construct a new Plane Detector
  78860. * @param _xrSessionManager an instance of xr Session manager
  78861. * @param _options configuration to use when constructing this feature
  78862. */
  78863. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRPlaneDetectorOptions);
  78864. /**
  78865. * detach this feature.
  78866. * Will usually be called by the features manager
  78867. *
  78868. * @returns true if successful.
  78869. */
  78870. detach(): boolean;
  78871. /**
  78872. * Dispose this feature and all of the resources attached
  78873. */
  78874. dispose(): void;
  78875. protected _onXRFrame(frame: XRFrame): void;
  78876. private _init;
  78877. private _updatePlaneWithXRPlane;
  78878. /**
  78879. * avoiding using Array.find for global support.
  78880. * @param xrPlane the plane to find in the array
  78881. */
  78882. private findIndexInPlaneArray;
  78883. }
  78884. }
  78885. declare module "babylonjs/XR/features/WebXRBackgroundRemover" {
  78886. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78887. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  78888. import { Observable } from "babylonjs/Misc/observable";
  78889. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78890. /**
  78891. * Options interface for the background remover plugin
  78892. */
  78893. export interface IWebXRBackgroundRemoverOptions {
  78894. /**
  78895. * Further background meshes to disable when entering AR
  78896. */
  78897. backgroundMeshes?: AbstractMesh[];
  78898. /**
  78899. * flags to configure the removal of the environment helper.
  78900. * If not set, the entire background will be removed. If set, flags should be set as well.
  78901. */
  78902. environmentHelperRemovalFlags?: {
  78903. /**
  78904. * Should the skybox be removed (default false)
  78905. */
  78906. skyBox?: boolean;
  78907. /**
  78908. * Should the ground be removed (default false)
  78909. */
  78910. ground?: boolean;
  78911. };
  78912. /**
  78913. * don't disable the environment helper
  78914. */
  78915. ignoreEnvironmentHelper?: boolean;
  78916. }
  78917. /**
  78918. * A module that will automatically disable background meshes when entering AR and will enable them when leaving AR.
  78919. */
  78920. export class WebXRBackgroundRemover extends WebXRAbstractFeature {
  78921. /**
  78922. * read-only options to be used in this module
  78923. */
  78924. readonly options: IWebXRBackgroundRemoverOptions;
  78925. /**
  78926. * The module's name
  78927. */
  78928. static readonly Name: string;
  78929. /**
  78930. * The (Babylon) version of this module.
  78931. * This is an integer representing the implementation version.
  78932. * This number does not correspond to the WebXR specs version
  78933. */
  78934. static readonly Version: number;
  78935. /**
  78936. * registered observers will be triggered when the background state changes
  78937. */
  78938. onBackgroundStateChangedObservable: Observable<boolean>;
  78939. /**
  78940. * constructs a new background remover module
  78941. * @param _xrSessionManager the session manager for this module
  78942. * @param options read-only options to be used in this module
  78943. */
  78944. constructor(_xrSessionManager: WebXRSessionManager,
  78945. /**
  78946. * read-only options to be used in this module
  78947. */
  78948. options?: IWebXRBackgroundRemoverOptions);
  78949. /**
  78950. * attach this feature
  78951. * Will usually be called by the features manager
  78952. *
  78953. * @returns true if successful.
  78954. */
  78955. attach(): boolean;
  78956. /**
  78957. * detach this feature.
  78958. * Will usually be called by the features manager
  78959. *
  78960. * @returns true if successful.
  78961. */
  78962. detach(): boolean;
  78963. /**
  78964. * Dispose this feature and all of the resources attached
  78965. */
  78966. dispose(): void;
  78967. protected _onXRFrame(_xrFrame: XRFrame): void;
  78968. private _setBackgroundState;
  78969. }
  78970. }
  78971. declare module "babylonjs/XR/features/WebXRControllerPhysics" {
  78972. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78973. import { WebXRInputSource } from "babylonjs/XR/webXRInputSource";
  78974. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  78975. import { WebXRInput } from "babylonjs/XR/webXRInput";
  78976. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78977. import { Nullable } from "babylonjs/types";
  78978. /**
  78979. * Options for the controller physics feature
  78980. */
  78981. export class IWebXRControllerPhysicsOptions {
  78982. /**
  78983. * Should the headset get its own impostor
  78984. */
  78985. enableHeadsetImpostor?: boolean;
  78986. /**
  78987. * Optional parameters for the headset impostor
  78988. */
  78989. headsetImpostorParams?: {
  78990. /**
  78991. * The type of impostor to create. Default is sphere
  78992. */
  78993. impostorType: number;
  78994. /**
  78995. * the size of the impostor. Defaults to 10cm
  78996. */
  78997. impostorSize?: number | {
  78998. width: number;
  78999. height: number;
  79000. depth: number;
  79001. };
  79002. /**
  79003. * Friction definitions
  79004. */
  79005. friction?: number;
  79006. /**
  79007. * Restitution
  79008. */
  79009. restitution?: number;
  79010. };
  79011. /**
  79012. * The physics properties of the future impostors
  79013. */
  79014. physicsProperties?: {
  79015. /**
  79016. * If set to true, a mesh impostor will be created when the controller mesh was loaded
  79017. * Note that this requires a physics engine that supports mesh impostors!
  79018. */
  79019. useControllerMesh?: boolean;
  79020. /**
  79021. * The type of impostor to create. Default is sphere
  79022. */
  79023. impostorType?: number;
  79024. /**
  79025. * the size of the impostor. Defaults to 10cm
  79026. */
  79027. impostorSize?: number | {
  79028. width: number;
  79029. height: number;
  79030. depth: number;
  79031. };
  79032. /**
  79033. * Friction definitions
  79034. */
  79035. friction?: number;
  79036. /**
  79037. * Restitution
  79038. */
  79039. restitution?: number;
  79040. };
  79041. /**
  79042. * the xr input to use with this pointer selection
  79043. */
  79044. xrInput: WebXRInput;
  79045. }
  79046. /**
  79047. * Add physics impostor to your webxr controllers,
  79048. * including naive calculation of their linear and angular velocity
  79049. */
  79050. export class WebXRControllerPhysics extends WebXRAbstractFeature {
  79051. private readonly _options;
  79052. private _attachController;
  79053. private _controllers;
  79054. private _debugMode;
  79055. private _delta;
  79056. private _headsetImpostor?;
  79057. private _headsetMesh?;
  79058. private _lastTimestamp;
  79059. private _tmpQuaternion;
  79060. private _tmpVector;
  79061. /**
  79062. * The module's name
  79063. */
  79064. static readonly Name: string;
  79065. /**
  79066. * The (Babylon) version of this module.
  79067. * This is an integer representing the implementation version.
  79068. * This number does not correspond to the webxr specs version
  79069. */
  79070. static readonly Version: number;
  79071. /**
  79072. * Construct a new Controller Physics Feature
  79073. * @param _xrSessionManager the corresponding xr session manager
  79074. * @param _options options to create this feature with
  79075. */
  79076. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPhysicsOptions);
  79077. /**
  79078. * @hidden
  79079. * enable debugging - will show console outputs and the impostor mesh
  79080. */
  79081. _enablePhysicsDebug(): void;
  79082. /**
  79083. * Manually add a controller (if no xrInput was provided or physics engine was not enabled)
  79084. * @param xrController the controller to add
  79085. */
  79086. addController(xrController: WebXRInputSource): void;
  79087. /**
  79088. * attach this feature
  79089. * Will usually be called by the features manager
  79090. *
  79091. * @returns true if successful.
  79092. */
  79093. attach(): boolean;
  79094. /**
  79095. * detach this feature.
  79096. * Will usually be called by the features manager
  79097. *
  79098. * @returns true if successful.
  79099. */
  79100. detach(): boolean;
  79101. /**
  79102. * Get the headset impostor, if enabled
  79103. * @returns the impostor
  79104. */
  79105. getHeadsetImpostor(): PhysicsImpostor | undefined;
  79106. /**
  79107. * Get the physics impostor of a specific controller.
  79108. * The impostor is not attached to a mesh because a mesh for each controller is not obligatory
  79109. * @param controller the controller or the controller id of which to get the impostor
  79110. * @returns the impostor or null
  79111. */
  79112. getImpostorForController(controller: WebXRInputSource | string): Nullable<PhysicsImpostor>;
  79113. /**
  79114. * Update the physics properties provided in the constructor
  79115. * @param newProperties the new properties object
  79116. */
  79117. setPhysicsProperties(newProperties: {
  79118. impostorType?: number;
  79119. impostorSize?: number | {
  79120. width: number;
  79121. height: number;
  79122. depth: number;
  79123. };
  79124. friction?: number;
  79125. restitution?: number;
  79126. }): void;
  79127. protected _onXRFrame(_xrFrame: any): void;
  79128. private _detachController;
  79129. }
  79130. }
  79131. declare module "babylonjs/XR/features/WebXRFeaturePointSystem" {
  79132. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  79133. import { Observable } from "babylonjs/Misc/observable";
  79134. import { Vector3 } from "babylonjs/Maths/math.vector";
  79135. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  79136. /**
  79137. * A babylon interface for a "WebXR" feature point.
  79138. * Represents the position and confidence value of a given feature point.
  79139. */
  79140. export interface IWebXRFeaturePoint {
  79141. /**
  79142. * Represents the position of the feature point in world space.
  79143. */
  79144. position: Vector3;
  79145. /**
  79146. * Represents the confidence value of the feature point in world space. 0 being least confident, and 1 being most confident.
  79147. */
  79148. confidenceValue: number;
  79149. }
  79150. /**
  79151. * The feature point system is used to detect feature points from real world geometry.
  79152. * This feature is currently experimental and only supported on BabylonNative, and should not be used in the browser.
  79153. * The newly introduced API can be seen in webxr.nativeextensions.d.ts and described in FeaturePoints.md.
  79154. */
  79155. export class WebXRFeaturePointSystem extends WebXRAbstractFeature {
  79156. private _enabled;
  79157. private _featurePointCloud;
  79158. /**
  79159. * The module's name
  79160. */
  79161. static readonly Name: string;
  79162. /**
  79163. * The (Babylon) version of this module.
  79164. * This is an integer representing the implementation version.
  79165. * This number does not correspond to the WebXR specs version
  79166. */
  79167. static readonly Version: number;
  79168. /**
  79169. * Observers registered here will be executed whenever new feature points are added (on XRFrame while the session is tracking).
  79170. * Will notify the observers about which feature points have been added.
  79171. */
  79172. readonly onFeaturePointsAddedObservable: Observable<number[]>;
  79173. /**
  79174. * Observers registered here will be executed whenever a feature point has been updated (on XRFrame while the session is tracking).
  79175. * Will notify the observers about which feature points have been updated.
  79176. */
  79177. readonly onFeaturePointsUpdatedObservable: Observable<number[]>;
  79178. /**
  79179. * The current feature point cloud maintained across frames.
  79180. */
  79181. get featurePointCloud(): Array<IWebXRFeaturePoint>;
  79182. /**
  79183. * construct the feature point system
  79184. * @param _xrSessionManager an instance of xr Session manager
  79185. */
  79186. constructor(_xrSessionManager: WebXRSessionManager);
  79187. /**
  79188. * Detach this feature.
  79189. * Will usually be called by the features manager
  79190. *
  79191. * @returns true if successful.
  79192. */
  79193. detach(): boolean;
  79194. /**
  79195. * Dispose this feature and all of the resources attached
  79196. */
  79197. dispose(): void;
  79198. /**
  79199. * On receiving a new XR frame if this feature is attached notify observers new feature point data is available.
  79200. */
  79201. protected _onXRFrame(frame: XRFrame): void;
  79202. /**
  79203. * Initializes the feature. If the feature point feature is not available for this environment do not mark the feature as enabled.
  79204. */
  79205. private _init;
  79206. }
  79207. }
  79208. declare module "babylonjs/XR/features/WebXRHandTracking" {
  79209. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  79210. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  79211. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  79212. import { Mesh } from "babylonjs/Meshes/mesh";
  79213. import { WebXRInput } from "babylonjs/XR/webXRInput";
  79214. import { WebXRInputSource } from "babylonjs/XR/webXRInputSource";
  79215. import { Nullable } from "babylonjs/types";
  79216. import { IDisposable } from "babylonjs/scene";
  79217. import { Observable } from "babylonjs/Misc/observable";
  79218. /**
  79219. * Configuration interface for the hand tracking feature
  79220. */
  79221. export interface IWebXRHandTrackingOptions {
  79222. /**
  79223. * The xrInput that will be used as source for new hands
  79224. */
  79225. xrInput: WebXRInput;
  79226. /**
  79227. * Configuration object for the joint meshes
  79228. */
  79229. jointMeshes?: {
  79230. /**
  79231. * Should the meshes created be invisible (defaults to false)
  79232. */
  79233. invisible?: boolean;
  79234. /**
  79235. * A source mesh to be used to create instances. Defaults to a sphere.
  79236. * This mesh will be the source for all other (25) meshes.
  79237. * It should have the general size of a single unit, as the instances will be scaled according to the provided radius
  79238. */
  79239. sourceMesh?: Mesh;
  79240. /**
  79241. * Should the source mesh stay visible. Defaults to false
  79242. */
  79243. keepOriginalVisible?: boolean;
  79244. /**
  79245. * Scale factor for all instances (defaults to 2)
  79246. */
  79247. scaleFactor?: number;
  79248. /**
  79249. * Should each instance have its own physics impostor
  79250. */
  79251. enablePhysics?: boolean;
  79252. /**
  79253. * If enabled, override default physics properties
  79254. */
  79255. physicsProps?: {
  79256. friction?: number;
  79257. restitution?: number;
  79258. impostorType?: number;
  79259. };
  79260. /**
  79261. * For future use - a single hand-mesh that will be updated according to the XRHand data provided
  79262. */
  79263. handMesh?: AbstractMesh;
  79264. };
  79265. }
  79266. /**
  79267. * Parts of the hands divided to writs and finger names
  79268. */
  79269. export const enum HandPart {
  79270. /**
  79271. * HandPart - Wrist
  79272. */
  79273. WRIST = "wrist",
  79274. /**
  79275. * HandPart - The THumb
  79276. */
  79277. THUMB = "thumb",
  79278. /**
  79279. * HandPart - Index finger
  79280. */
  79281. INDEX = "index",
  79282. /**
  79283. * HandPart - Middle finger
  79284. */
  79285. MIDDLE = "middle",
  79286. /**
  79287. * HandPart - Ring finger
  79288. */
  79289. RING = "ring",
  79290. /**
  79291. * HandPart - Little finger
  79292. */
  79293. LITTLE = "little"
  79294. }
  79295. /**
  79296. * Representing a single hand (with its corresponding native XRHand object)
  79297. */
  79298. export class WebXRHand implements IDisposable {
  79299. /** the controller to which the hand correlates */
  79300. readonly xrController: WebXRInputSource;
  79301. /** the meshes to be used to track the hand joints */
  79302. readonly trackedMeshes: AbstractMesh[];
  79303. /**
  79304. * Hand-parts definition (key is HandPart)
  79305. */
  79306. handPartsDefinition: {
  79307. [key: string]: number[];
  79308. };
  79309. /**
  79310. * Populate the HandPartsDefinition object.
  79311. * This is called as a side effect since certain browsers don't have XRHand defined.
  79312. */
  79313. private generateHandPartsDefinition;
  79314. /**
  79315. * Construct a new hand object
  79316. * @param xrController the controller to which the hand correlates
  79317. * @param trackedMeshes the meshes to be used to track the hand joints
  79318. */
  79319. constructor(
  79320. /** the controller to which the hand correlates */
  79321. xrController: WebXRInputSource,
  79322. /** the meshes to be used to track the hand joints */
  79323. trackedMeshes: AbstractMesh[]);
  79324. /**
  79325. * Update this hand from the latest xr frame
  79326. * @param xrFrame xrFrame to update from
  79327. * @param referenceSpace The current viewer reference space
  79328. * @param scaleFactor optional scale factor for the meshes
  79329. */
  79330. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace, scaleFactor?: number): void;
  79331. /**
  79332. * Get meshes of part of the hand
  79333. * @param part the part of hand to get
  79334. * @returns An array of meshes that correlate to the hand part requested
  79335. */
  79336. getHandPartMeshes(part: HandPart): AbstractMesh[];
  79337. /**
  79338. * Dispose this Hand object
  79339. */
  79340. dispose(): void;
  79341. }
  79342. /**
  79343. * WebXR Hand Joint tracking feature, available for selected browsers and devices
  79344. */
  79345. export class WebXRHandTracking extends WebXRAbstractFeature {
  79346. /**
  79347. * options to use when constructing this feature
  79348. */
  79349. readonly options: IWebXRHandTrackingOptions;
  79350. private static _idCounter;
  79351. /**
  79352. * The module's name
  79353. */
  79354. static readonly Name: string;
  79355. /**
  79356. * The (Babylon) version of this module.
  79357. * This is an integer representing the implementation version.
  79358. * This number does not correspond to the WebXR specs version
  79359. */
  79360. static readonly Version: number;
  79361. /**
  79362. * This observable will notify registered observers when a new hand object was added and initialized
  79363. */
  79364. onHandAddedObservable: Observable<WebXRHand>;
  79365. /**
  79366. * This observable will notify its observers right before the hand object is disposed
  79367. */
  79368. onHandRemovedObservable: Observable<WebXRHand>;
  79369. private _hands;
  79370. /**
  79371. * Creates a new instance of the hit test feature
  79372. * @param _xrSessionManager an instance of WebXRSessionManager
  79373. * @param options options to use when constructing this feature
  79374. */
  79375. constructor(_xrSessionManager: WebXRSessionManager,
  79376. /**
  79377. * options to use when constructing this feature
  79378. */
  79379. options: IWebXRHandTrackingOptions);
  79380. /**
  79381. * Check if the needed objects are defined.
  79382. * This does not mean that the feature is enabled, but that the objects needed are well defined.
  79383. */
  79384. isCompatible(): boolean;
  79385. /**
  79386. * attach this feature
  79387. * Will usually be called by the features manager
  79388. *
  79389. * @returns true if successful.
  79390. */
  79391. attach(): boolean;
  79392. /**
  79393. * detach this feature.
  79394. * Will usually be called by the features manager
  79395. *
  79396. * @returns true if successful.
  79397. */
  79398. detach(): boolean;
  79399. /**
  79400. * Dispose this feature and all of the resources attached
  79401. */
  79402. dispose(): void;
  79403. /**
  79404. * Get the hand object according to the controller id
  79405. * @param controllerId the controller id to which we want to get the hand
  79406. * @returns null if not found or the WebXRHand object if found
  79407. */
  79408. getHandByControllerId(controllerId: string): Nullable<WebXRHand>;
  79409. /**
  79410. * Get a hand object according to the requested handedness
  79411. * @param handedness the handedness to request
  79412. * @returns null if not found or the WebXRHand object if found
  79413. */
  79414. getHandByHandedness(handedness: XRHandedness): Nullable<WebXRHand>;
  79415. protected _onXRFrame(_xrFrame: XRFrame): void;
  79416. private _attachHand;
  79417. private _detachHand;
  79418. }
  79419. }
  79420. declare module "babylonjs/XR/features/index" {
  79421. export * from "babylonjs/XR/features/WebXRHitTestLegacy";
  79422. export * from "babylonjs/XR/features/WebXRAnchorSystem";
  79423. export * from "babylonjs/XR/features/WebXRPlaneDetector";
  79424. export * from "babylonjs/XR/features/WebXRBackgroundRemover";
  79425. export * from "babylonjs/XR/features/WebXRControllerTeleportation";
  79426. export * from "babylonjs/XR/features/WebXRControllerPointerSelection";
  79427. export * from "babylonjs/XR/features/WebXRControllerPhysics";
  79428. export * from "babylonjs/XR/features/WebXRHitTest";
  79429. export * from "babylonjs/XR/features/WebXRFeaturePointSystem";
  79430. export * from "babylonjs/XR/features/WebXRHandTracking";
  79431. }
  79432. declare module "babylonjs/XR/motionController/webXRMicrosoftMixedRealityController" {
  79433. import { WebXRAbstractMotionController, IMinimalMotionControllerObject, MotionControllerHandedness } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  79434. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  79435. import { Scene } from "babylonjs/scene";
  79436. /**
  79437. * The motion controller class for all microsoft mixed reality controllers
  79438. */
  79439. export class WebXRMicrosoftMixedRealityController extends WebXRAbstractMotionController {
  79440. protected readonly _mapping: {
  79441. defaultButton: {
  79442. valueNodeName: string;
  79443. unpressedNodeName: string;
  79444. pressedNodeName: string;
  79445. };
  79446. defaultAxis: {
  79447. valueNodeName: string;
  79448. minNodeName: string;
  79449. maxNodeName: string;
  79450. };
  79451. buttons: {
  79452. "xr-standard-trigger": {
  79453. rootNodeName: string;
  79454. componentProperty: string;
  79455. states: string[];
  79456. };
  79457. "xr-standard-squeeze": {
  79458. rootNodeName: string;
  79459. componentProperty: string;
  79460. states: string[];
  79461. };
  79462. "xr-standard-touchpad": {
  79463. rootNodeName: string;
  79464. labelAnchorNodeName: string;
  79465. touchPointNodeName: string;
  79466. };
  79467. "xr-standard-thumbstick": {
  79468. rootNodeName: string;
  79469. componentProperty: string;
  79470. states: string[];
  79471. };
  79472. };
  79473. axes: {
  79474. "xr-standard-touchpad": {
  79475. "x-axis": {
  79476. rootNodeName: string;
  79477. };
  79478. "y-axis": {
  79479. rootNodeName: string;
  79480. };
  79481. };
  79482. "xr-standard-thumbstick": {
  79483. "x-axis": {
  79484. rootNodeName: string;
  79485. };
  79486. "y-axis": {
  79487. rootNodeName: string;
  79488. };
  79489. };
  79490. };
  79491. };
  79492. /**
  79493. * The base url used to load the left and right controller models
  79494. */
  79495. static MODEL_BASE_URL: string;
  79496. /**
  79497. * The name of the left controller model file
  79498. */
  79499. static MODEL_LEFT_FILENAME: string;
  79500. /**
  79501. * The name of the right controller model file
  79502. */
  79503. static MODEL_RIGHT_FILENAME: string;
  79504. profileId: string;
  79505. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  79506. protected _getFilenameAndPath(): {
  79507. filename: string;
  79508. path: string;
  79509. };
  79510. protected _getModelLoadingConstraints(): boolean;
  79511. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  79512. protected _setRootMesh(meshes: AbstractMesh[]): void;
  79513. protected _updateModel(): void;
  79514. }
  79515. }
  79516. declare module "babylonjs/XR/motionController/webXROculusTouchMotionController" {
  79517. import { WebXRAbstractMotionController, IMinimalMotionControllerObject, MotionControllerHandedness } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  79518. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  79519. import { Scene } from "babylonjs/scene";
  79520. /**
  79521. * The motion controller class for oculus touch (quest, rift).
  79522. * This class supports legacy mapping as well the standard xr mapping
  79523. */
  79524. export class WebXROculusTouchMotionController extends WebXRAbstractMotionController {
  79525. private _forceLegacyControllers;
  79526. private _modelRootNode;
  79527. /**
  79528. * The base url used to load the left and right controller models
  79529. */
  79530. static MODEL_BASE_URL: string;
  79531. /**
  79532. * The name of the left controller model file
  79533. */
  79534. static MODEL_LEFT_FILENAME: string;
  79535. /**
  79536. * The name of the right controller model file
  79537. */
  79538. static MODEL_RIGHT_FILENAME: string;
  79539. /**
  79540. * Base Url for the Quest controller model.
  79541. */
  79542. static QUEST_MODEL_BASE_URL: string;
  79543. profileId: string;
  79544. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness, legacyMapping?: boolean, _forceLegacyControllers?: boolean);
  79545. protected _getFilenameAndPath(): {
  79546. filename: string;
  79547. path: string;
  79548. };
  79549. protected _getModelLoadingConstraints(): boolean;
  79550. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  79551. protected _setRootMesh(meshes: AbstractMesh[]): void;
  79552. protected _updateModel(): void;
  79553. /**
  79554. * Is this the new type of oculus touch. At the moment both have the same profile and it is impossible to differentiate
  79555. * between the touch and touch 2.
  79556. */
  79557. private _isQuest;
  79558. }
  79559. }
  79560. declare module "babylonjs/XR/motionController/webXRHTCViveMotionController" {
  79561. import { IMinimalMotionControllerObject, MotionControllerHandedness, WebXRAbstractMotionController } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  79562. import { Scene } from "babylonjs/scene";
  79563. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  79564. /**
  79565. * The motion controller class for the standard HTC-Vive controllers
  79566. */
  79567. export class WebXRHTCViveMotionController extends WebXRAbstractMotionController {
  79568. private _modelRootNode;
  79569. /**
  79570. * The base url used to load the left and right controller models
  79571. */
  79572. static MODEL_BASE_URL: string;
  79573. /**
  79574. * File name for the controller model.
  79575. */
  79576. static MODEL_FILENAME: string;
  79577. profileId: string;
  79578. /**
  79579. * Create a new Vive motion controller object
  79580. * @param scene the scene to use to create this controller
  79581. * @param gamepadObject the corresponding gamepad object
  79582. * @param handedness the handedness of the controller
  79583. */
  79584. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  79585. protected _getFilenameAndPath(): {
  79586. filename: string;
  79587. path: string;
  79588. };
  79589. protected _getModelLoadingConstraints(): boolean;
  79590. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  79591. protected _setRootMesh(meshes: AbstractMesh[]): void;
  79592. protected _updateModel(): void;
  79593. }
  79594. }
  79595. declare module "babylonjs/XR/motionController/index" {
  79596. export * from "babylonjs/XR/motionController/webXRAbstractMotionController";
  79597. export * from "babylonjs/XR/motionController/webXRControllerComponent";
  79598. export * from "babylonjs/XR/motionController/webXRGenericMotionController";
  79599. export * from "babylonjs/XR/motionController/webXRMicrosoftMixedRealityController";
  79600. export * from "babylonjs/XR/motionController/webXRMotionControllerManager";
  79601. export * from "babylonjs/XR/motionController/webXROculusTouchMotionController";
  79602. export * from "babylonjs/XR/motionController/webXRHTCViveMotionController";
  79603. export * from "babylonjs/XR/motionController/webXRProfiledMotionController";
  79604. }
  79605. declare module "babylonjs/XR/index" {
  79606. export * from "babylonjs/XR/webXRCamera";
  79607. export * from "babylonjs/XR/webXREnterExitUI";
  79608. export * from "babylonjs/XR/webXRExperienceHelper";
  79609. export * from "babylonjs/XR/webXRInput";
  79610. export * from "babylonjs/XR/webXRInputSource";
  79611. export * from "babylonjs/XR/webXRManagedOutputCanvas";
  79612. export * from "babylonjs/XR/webXRTypes";
  79613. export * from "babylonjs/XR/webXRSessionManager";
  79614. export * from "babylonjs/XR/webXRDefaultExperience";
  79615. export * from "babylonjs/XR/webXRFeaturesManager";
  79616. export * from "babylonjs/XR/features/index";
  79617. export * from "babylonjs/XR/motionController/index";
  79618. }
  79619. declare module "babylonjs/index" {
  79620. export * from "babylonjs/abstractScene";
  79621. export * from "babylonjs/Actions/index";
  79622. export * from "babylonjs/Animations/index";
  79623. export * from "babylonjs/assetContainer";
  79624. export * from "babylonjs/Audio/index";
  79625. export * from "babylonjs/Behaviors/index";
  79626. export * from "babylonjs/Bones/index";
  79627. export * from "babylonjs/Cameras/index";
  79628. export * from "babylonjs/Collisions/index";
  79629. export * from "babylonjs/Culling/index";
  79630. export * from "babylonjs/Debug/index";
  79631. export * from "babylonjs/DeviceInput/index";
  79632. export * from "babylonjs/Engines/index";
  79633. export * from "babylonjs/Events/index";
  79634. export * from "babylonjs/Gamepads/index";
  79635. export * from "babylonjs/Gizmos/index";
  79636. export * from "babylonjs/Helpers/index";
  79637. export * from "babylonjs/Instrumentation/index";
  79638. export * from "babylonjs/Layers/index";
  79639. export * from "babylonjs/LensFlares/index";
  79640. export * from "babylonjs/Lights/index";
  79641. export * from "babylonjs/Loading/index";
  79642. export * from "babylonjs/Materials/index";
  79643. export * from "babylonjs/Maths/index";
  79644. export * from "babylonjs/Meshes/index";
  79645. export * from "babylonjs/Morph/index";
  79646. export * from "babylonjs/Navigation/index";
  79647. export * from "babylonjs/node";
  79648. export * from "babylonjs/Offline/index";
  79649. export * from "babylonjs/Particles/index";
  79650. export * from "babylonjs/Physics/index";
  79651. export * from "babylonjs/PostProcesses/index";
  79652. export * from "babylonjs/Probes/index";
  79653. export * from "babylonjs/Rendering/index";
  79654. export * from "babylonjs/scene";
  79655. export * from "babylonjs/sceneComponent";
  79656. export * from "babylonjs/Sprites/index";
  79657. export * from "babylonjs/States/index";
  79658. export * from "babylonjs/Misc/index";
  79659. export * from "babylonjs/XR/index";
  79660. export * from "babylonjs/types";
  79661. }
  79662. declare module "babylonjs/Animations/pathCursor" {
  79663. import { Vector3 } from "babylonjs/Maths/math.vector";
  79664. import { Path2 } from "babylonjs/Maths/math.path";
  79665. /**
  79666. * A cursor which tracks a point on a path
  79667. */
  79668. export class PathCursor {
  79669. private path;
  79670. /**
  79671. * Stores path cursor callbacks for when an onchange event is triggered
  79672. */
  79673. private _onchange;
  79674. /**
  79675. * The value of the path cursor
  79676. */
  79677. value: number;
  79678. /**
  79679. * The animation array of the path cursor
  79680. */
  79681. animations: Animation[];
  79682. /**
  79683. * Initializes the path cursor
  79684. * @param path The path to track
  79685. */
  79686. constructor(path: Path2);
  79687. /**
  79688. * Gets the cursor point on the path
  79689. * @returns A point on the path cursor at the cursor location
  79690. */
  79691. getPoint(): Vector3;
  79692. /**
  79693. * Moves the cursor ahead by the step amount
  79694. * @param step The amount to move the cursor forward
  79695. * @returns This path cursor
  79696. */
  79697. moveAhead(step?: number): PathCursor;
  79698. /**
  79699. * Moves the cursor behind by the step amount
  79700. * @param step The amount to move the cursor back
  79701. * @returns This path cursor
  79702. */
  79703. moveBack(step?: number): PathCursor;
  79704. /**
  79705. * Moves the cursor by the step amount
  79706. * If the step amount is greater than one, an exception is thrown
  79707. * @param step The amount to move the cursor
  79708. * @returns This path cursor
  79709. */
  79710. move(step: number): PathCursor;
  79711. /**
  79712. * Ensures that the value is limited between zero and one
  79713. * @returns This path cursor
  79714. */
  79715. private ensureLimits;
  79716. /**
  79717. * Runs onchange callbacks on change (used by the animation engine)
  79718. * @returns This path cursor
  79719. */
  79720. private raiseOnChange;
  79721. /**
  79722. * Executes a function on change
  79723. * @param f A path cursor onchange callback
  79724. * @returns This path cursor
  79725. */
  79726. onchange(f: (cursor: PathCursor) => void): PathCursor;
  79727. }
  79728. }
  79729. declare module "babylonjs/Engines/Processors/Expressions/Operators/index" {
  79730. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineAndOperator";
  79731. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineArithmeticOperator";
  79732. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineIsDefinedOperator";
  79733. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineOrOperator";
  79734. }
  79735. declare module "babylonjs/Engines/Processors/Expressions/index" {
  79736. export * from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  79737. export * from "babylonjs/Engines/Processors/Expressions/Operators/index";
  79738. }
  79739. declare module "babylonjs/Engines/Processors/index" {
  79740. export * from "babylonjs/Engines/Processors/iShaderProcessor";
  79741. export * from "babylonjs/Engines/Processors/Expressions/index";
  79742. export * from "babylonjs/Engines/Processors/shaderCodeConditionNode";
  79743. export * from "babylonjs/Engines/Processors/shaderCodeCursor";
  79744. export * from "babylonjs/Engines/Processors/shaderCodeNode";
  79745. export * from "babylonjs/Engines/Processors/shaderCodeTestNode";
  79746. export * from "babylonjs/Engines/Processors/shaderProcessingOptions";
  79747. export * from "babylonjs/Engines/Processors/shaderProcessor";
  79748. export * from "babylonjs/Engines/Processors/shaderCodeInliner";
  79749. }
  79750. declare module "babylonjs/Legacy/legacy" {
  79751. import * as Babylon from "babylonjs/index";
  79752. export * from "babylonjs/index";
  79753. }
  79754. declare module "babylonjs/Shaders/blur.fragment" {
  79755. /** @hidden */
  79756. export var blurPixelShader: {
  79757. name: string;
  79758. shader: string;
  79759. };
  79760. }
  79761. declare module "babylonjs/Shaders/ShadersInclude/pointCloudVertexDeclaration" {
  79762. /** @hidden */
  79763. export var pointCloudVertexDeclaration: {
  79764. name: string;
  79765. shader: string;
  79766. };
  79767. }
  79768. declare module "babylonjs" {
  79769. export * from "babylonjs/Legacy/legacy";
  79770. }
  79771. declare module BABYLON {
  79772. /** Alias type for value that can be null */
  79773. export type Nullable<T> = T | null;
  79774. /**
  79775. * Alias type for number that are floats
  79776. * @ignorenaming
  79777. */
  79778. export type float = number;
  79779. /**
  79780. * Alias type for number that are doubles.
  79781. * @ignorenaming
  79782. */
  79783. export type double = number;
  79784. /**
  79785. * Alias type for number that are integer
  79786. * @ignorenaming
  79787. */
  79788. export type int = number;
  79789. /** Alias type for number array or Float32Array */
  79790. export type FloatArray = number[] | Float32Array;
  79791. /** Alias type for number array or Float32Array or Int32Array or Uint32Array or Uint16Array */
  79792. export type IndicesArray = number[] | Int32Array | Uint32Array | Uint16Array;
  79793. /**
  79794. * Alias for types that can be used by a Buffer or VertexBuffer.
  79795. */
  79796. export type DataArray = number[] | ArrayBuffer | ArrayBufferView;
  79797. /**
  79798. * Alias type for primitive types
  79799. * @ignorenaming
  79800. */
  79801. type Primitive = undefined | null | boolean | string | number | Function;
  79802. /**
  79803. * Type modifier to make all the properties of an object Readonly
  79804. */
  79805. export type Immutable<T> = T extends Primitive ? T : T extends Array<infer U> ? ReadonlyArray<U> : DeepImmutable<T>;
  79806. /**
  79807. * Type modifier to make all the properties of an object Readonly recursively
  79808. */
  79809. export type DeepImmutable<T> = T extends Primitive ? T : T extends Array<infer U> ? DeepImmutableArray<U> : DeepImmutableObject<T>;
  79810. /**
  79811. * Type modifier to make object properties readonly.
  79812. */
  79813. export type DeepImmutableObject<T> = {
  79814. readonly [K in keyof T]: DeepImmutable<T[K]>;
  79815. };
  79816. /** @hidden */
  79817. interface DeepImmutableArray<T> extends ReadonlyArray<DeepImmutable<T>> {
  79818. }
  79819. }
  79820. declare module BABYLON {
  79821. /**
  79822. * A class serves as a medium between the observable and its observers
  79823. */
  79824. export class EventState {
  79825. /**
  79826. * Create a new EventState
  79827. * @param mask defines the mask associated with this state
  79828. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  79829. * @param target defines the original target of the state
  79830. * @param currentTarget defines the current target of the state
  79831. */
  79832. constructor(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any);
  79833. /**
  79834. * Initialize the current event state
  79835. * @param mask defines the mask associated with this state
  79836. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  79837. * @param target defines the original target of the state
  79838. * @param currentTarget defines the current target of the state
  79839. * @returns the current event state
  79840. */
  79841. initalize(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any): EventState;
  79842. /**
  79843. * An Observer can set this property to true to prevent subsequent observers of being notified
  79844. */
  79845. skipNextObservers: boolean;
  79846. /**
  79847. * Get the mask value that were used to trigger the event corresponding to this EventState object
  79848. */
  79849. mask: number;
  79850. /**
  79851. * The object that originally notified the event
  79852. */
  79853. target?: any;
  79854. /**
  79855. * The current object in the bubbling phase
  79856. */
  79857. currentTarget?: any;
  79858. /**
  79859. * This will be populated with the return value of the last function that was executed.
  79860. * If it is the first function in the callback chain it will be the event data.
  79861. */
  79862. lastReturnValue?: any;
  79863. }
  79864. /**
  79865. * Represent an Observer registered to a given Observable object.
  79866. */
  79867. export class Observer<T> {
  79868. /**
  79869. * Defines the callback to call when the observer is notified
  79870. */
  79871. callback: (eventData: T, eventState: EventState) => void;
  79872. /**
  79873. * Defines the mask of the observer (used to filter notifications)
  79874. */
  79875. mask: number;
  79876. /**
  79877. * Defines the current scope used to restore the JS context
  79878. */
  79879. scope: any;
  79880. /** @hidden */
  79881. _willBeUnregistered: boolean;
  79882. /**
  79883. * Gets or sets a property defining that the observer as to be unregistered after the next notification
  79884. */
  79885. unregisterOnNextCall: boolean;
  79886. /**
  79887. * Creates a new observer
  79888. * @param callback defines the callback to call when the observer is notified
  79889. * @param mask defines the mask of the observer (used to filter notifications)
  79890. * @param scope defines the current scope used to restore the JS context
  79891. */
  79892. constructor(
  79893. /**
  79894. * Defines the callback to call when the observer is notified
  79895. */
  79896. callback: (eventData: T, eventState: EventState) => void,
  79897. /**
  79898. * Defines the mask of the observer (used to filter notifications)
  79899. */
  79900. mask: number,
  79901. /**
  79902. * Defines the current scope used to restore the JS context
  79903. */
  79904. scope?: any);
  79905. }
  79906. /**
  79907. * Represent a list of observers registered to multiple Observables object.
  79908. */
  79909. export class MultiObserver<T> {
  79910. private _observers;
  79911. private _observables;
  79912. /**
  79913. * Release associated resources
  79914. */
  79915. dispose(): void;
  79916. /**
  79917. * Raise a callback when one of the observable will notify
  79918. * @param observables defines a list of observables to watch
  79919. * @param callback defines the callback to call on notification
  79920. * @param mask defines the mask used to filter notifications
  79921. * @param scope defines the current scope used to restore the JS context
  79922. * @returns the new MultiObserver
  79923. */
  79924. static Watch<T>(observables: Observable<T>[], callback: (eventData: T, eventState: EventState) => void, mask?: number, scope?: any): MultiObserver<T>;
  79925. }
  79926. /**
  79927. * The Observable class is a simple implementation of the Observable pattern.
  79928. *
  79929. * 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.
  79930. * This enable a more fine grained execution without having to rely on multiple different Observable objects.
  79931. * 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).
  79932. * 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.
  79933. */
  79934. export class Observable<T> {
  79935. private _observers;
  79936. private _eventState;
  79937. private _onObserverAdded;
  79938. /**
  79939. * Gets the list of observers
  79940. */
  79941. get observers(): Array<Observer<T>>;
  79942. /**
  79943. * Creates a new observable
  79944. * @param onObserverAdded defines a callback to call when a new observer is added
  79945. */
  79946. constructor(onObserverAdded?: (observer: Observer<T>) => void);
  79947. /**
  79948. * Create a new Observer with the specified callback
  79949. * @param callback the callback that will be executed for that Observer
  79950. * @param mask the mask used to filter observers
  79951. * @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.
  79952. * @param scope optional scope for the callback to be called from
  79953. * @param unregisterOnFirstCall defines if the observer as to be unregistered after the next notification
  79954. * @returns the new observer created for the callback
  79955. */
  79956. add(callback: (eventData: T, eventState: EventState) => void, mask?: number, insertFirst?: boolean, scope?: any, unregisterOnFirstCall?: boolean): Nullable<Observer<T>>;
  79957. /**
  79958. * Create a new Observer with the specified callback and unregisters after the next notification
  79959. * @param callback the callback that will be executed for that Observer
  79960. * @returns the new observer created for the callback
  79961. */
  79962. addOnce(callback: (eventData: T, eventState: EventState) => void): Nullable<Observer<T>>;
  79963. /**
  79964. * Remove an Observer from the Observable object
  79965. * @param observer the instance of the Observer to remove
  79966. * @returns false if it doesn't belong to this Observable
  79967. */
  79968. remove(observer: Nullable<Observer<T>>): boolean;
  79969. /**
  79970. * Remove a callback from the Observable object
  79971. * @param callback the callback to remove
  79972. * @param scope optional scope. If used only the callbacks with this scope will be removed
  79973. * @returns false if it doesn't belong to this Observable
  79974. */
  79975. removeCallback(callback: (eventData: T, eventState: EventState) => void, scope?: any): boolean;
  79976. private _deferUnregister;
  79977. private _remove;
  79978. /**
  79979. * Moves the observable to the top of the observer list making it get called first when notified
  79980. * @param observer the observer to move
  79981. */
  79982. makeObserverTopPriority(observer: Observer<T>): void;
  79983. /**
  79984. * Moves the observable to the bottom of the observer list making it get called last when notified
  79985. * @param observer the observer to move
  79986. */
  79987. makeObserverBottomPriority(observer: Observer<T>): void;
  79988. /**
  79989. * Notify all Observers by calling their respective callback with the given data
  79990. * Will return true if all observers were executed, false if an observer set skipNextObservers to true, then prevent the subsequent ones to execute
  79991. * @param eventData defines the data to send to all observers
  79992. * @param mask defines the mask of the current notification (observers with incompatible mask (ie mask & observer.mask === 0) will not be notified)
  79993. * @param target defines the original target of the state
  79994. * @param currentTarget defines the current target of the state
  79995. * @returns false if the complete observer chain was not processed (because one observer set the skipNextObservers to true)
  79996. */
  79997. notifyObservers(eventData: T, mask?: number, target?: any, currentTarget?: any): boolean;
  79998. /**
  79999. * Calling this will execute each callback, expecting it to be a promise or return a value.
  80000. * If at any point in the chain one function fails, the promise will fail and the execution will not continue.
  80001. * This is useful when a chain of events (sometimes async events) is needed to initialize a certain object
  80002. * and it is crucial that all callbacks will be executed.
  80003. * The order of the callbacks is kept, callbacks are not executed parallel.
  80004. *
  80005. * @param eventData The data to be sent to each callback
  80006. * @param mask is used to filter observers defaults to -1
  80007. * @param target defines the callback target (see EventState)
  80008. * @param currentTarget defines he current object in the bubbling phase
  80009. * @returns {Promise<T>} will return a Promise than resolves when all callbacks executed successfully.
  80010. */
  80011. notifyObserversWithPromise(eventData: T, mask?: number, target?: any, currentTarget?: any): Promise<T>;
  80012. /**
  80013. * Notify a specific observer
  80014. * @param observer defines the observer to notify
  80015. * @param eventData defines the data to be sent to each callback
  80016. * @param mask is used to filter observers defaults to -1
  80017. */
  80018. notifyObserver(observer: Observer<T>, eventData: T, mask?: number): void;
  80019. /**
  80020. * Gets a boolean indicating if the observable has at least one observer
  80021. * @returns true is the Observable has at least one Observer registered
  80022. */
  80023. hasObservers(): boolean;
  80024. /**
  80025. * Clear the list of observers
  80026. */
  80027. clear(): void;
  80028. /**
  80029. * Clone the current observable
  80030. * @returns a new observable
  80031. */
  80032. clone(): Observable<T>;
  80033. /**
  80034. * Does this observable handles observer registered with a given mask
  80035. * @param mask defines the mask to be tested
  80036. * @return whether or not one observer registered with the given mask is handeled
  80037. **/
  80038. hasSpecificMask(mask?: number): boolean;
  80039. }
  80040. }
  80041. declare module BABYLON {
  80042. /**
  80043. * Sets of helpers dealing with the DOM and some of the recurrent functions needed in
  80044. * Babylon.js
  80045. */
  80046. export class DomManagement {
  80047. /**
  80048. * Checks if the window object exists
  80049. * @returns true if the window object exists
  80050. */
  80051. static IsWindowObjectExist(): boolean;
  80052. /**
  80053. * Checks if the navigator object exists
  80054. * @returns true if the navigator object exists
  80055. */
  80056. static IsNavigatorAvailable(): boolean;
  80057. /**
  80058. * Check if the document object exists
  80059. * @returns true if the document object exists
  80060. */
  80061. static IsDocumentAvailable(): boolean;
  80062. /**
  80063. * Extracts text content from a DOM element hierarchy
  80064. * @param element defines the root element
  80065. * @returns a string
  80066. */
  80067. static GetDOMTextContent(element: HTMLElement): string;
  80068. }
  80069. }
  80070. declare module BABYLON {
  80071. /**
  80072. * Logger used througouht the application to allow configuration of
  80073. * the log level required for the messages.
  80074. */
  80075. export class Logger {
  80076. /**
  80077. * No log
  80078. */
  80079. static readonly NoneLogLevel: number;
  80080. /**
  80081. * Only message logs
  80082. */
  80083. static readonly MessageLogLevel: number;
  80084. /**
  80085. * Only warning logs
  80086. */
  80087. static readonly WarningLogLevel: number;
  80088. /**
  80089. * Only error logs
  80090. */
  80091. static readonly ErrorLogLevel: number;
  80092. /**
  80093. * All logs
  80094. */
  80095. static readonly AllLogLevel: number;
  80096. private static _LogCache;
  80097. /**
  80098. * Gets a value indicating the number of loading errors
  80099. * @ignorenaming
  80100. */
  80101. static errorsCount: number;
  80102. /**
  80103. * Callback called when a new log is added
  80104. */
  80105. static OnNewCacheEntry: (entry: string) => void;
  80106. private static _AddLogEntry;
  80107. private static _FormatMessage;
  80108. private static _LogDisabled;
  80109. private static _LogEnabled;
  80110. private static _WarnDisabled;
  80111. private static _WarnEnabled;
  80112. private static _ErrorDisabled;
  80113. private static _ErrorEnabled;
  80114. /**
  80115. * Log a message to the console
  80116. */
  80117. static Log: (message: string) => void;
  80118. /**
  80119. * Write a warning message to the console
  80120. */
  80121. static Warn: (message: string) => void;
  80122. /**
  80123. * Write an error message to the console
  80124. */
  80125. static Error: (message: string) => void;
  80126. /**
  80127. * Gets current log cache (list of logs)
  80128. */
  80129. static get LogCache(): string;
  80130. /**
  80131. * Clears the log cache
  80132. */
  80133. static ClearLogCache(): void;
  80134. /**
  80135. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  80136. */
  80137. static set LogLevels(level: number);
  80138. }
  80139. }
  80140. declare module BABYLON {
  80141. /** @hidden */
  80142. export class _TypeStore {
  80143. /** @hidden */
  80144. static RegisteredTypes: {
  80145. [key: string]: Object;
  80146. };
  80147. /** @hidden */
  80148. static GetClass(fqdn: string): any;
  80149. }
  80150. }
  80151. declare module BABYLON {
  80152. /**
  80153. * Helper to manipulate strings
  80154. */
  80155. export class StringTools {
  80156. /**
  80157. * Checks for a matching suffix at the end of a string (for ES5 and lower)
  80158. * @param str Source string
  80159. * @param suffix Suffix to search for in the source string
  80160. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  80161. */
  80162. static EndsWith(str: string, suffix: string): boolean;
  80163. /**
  80164. * Checks for a matching suffix at the beginning of a string (for ES5 and lower)
  80165. * @param str Source string
  80166. * @param suffix Suffix to search for in the source string
  80167. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  80168. */
  80169. static StartsWith(str: string, suffix: string): boolean;
  80170. /**
  80171. * Decodes a buffer into a string
  80172. * @param buffer The buffer to decode
  80173. * @returns The decoded string
  80174. */
  80175. static Decode(buffer: Uint8Array | Uint16Array): string;
  80176. /**
  80177. * Encode a buffer to a base64 string
  80178. * @param buffer defines the buffer to encode
  80179. * @returns the encoded string
  80180. */
  80181. static EncodeArrayBufferToBase64(buffer: ArrayBuffer | ArrayBufferView): string;
  80182. /**
  80183. * Converts a number to string and pads with preceeding zeroes until it is of specified length.
  80184. * @param num the number to convert and pad
  80185. * @param length the expected length of the string
  80186. * @returns the padded string
  80187. */
  80188. static PadNumber(num: number, length: number): string;
  80189. }
  80190. }
  80191. declare module BABYLON {
  80192. /**
  80193. * Class containing a set of static utilities functions for deep copy.
  80194. */
  80195. export class DeepCopier {
  80196. /**
  80197. * Tries to copy an object by duplicating every property
  80198. * @param source defines the source object
  80199. * @param destination defines the target object
  80200. * @param doNotCopyList defines a list of properties to avoid
  80201. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  80202. */
  80203. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  80204. }
  80205. }
  80206. declare module BABYLON {
  80207. /**
  80208. * Class containing a set of static utilities functions for precision date
  80209. */
  80210. export class PrecisionDate {
  80211. /**
  80212. * Gets either window.performance.now() if supported or Date.now() else
  80213. */
  80214. static get Now(): number;
  80215. }
  80216. }
  80217. declare module BABYLON {
  80218. /** @hidden */
  80219. export class _DevTools {
  80220. static WarnImport(name: string): string;
  80221. }
  80222. }
  80223. declare module BABYLON {
  80224. /**
  80225. * Interface used to define the mechanism to get data from the network
  80226. */
  80227. export interface IWebRequest {
  80228. /**
  80229. * Returns client's response url
  80230. */
  80231. responseURL: string;
  80232. /**
  80233. * Returns client's status
  80234. */
  80235. status: number;
  80236. /**
  80237. * Returns client's status as a text
  80238. */
  80239. statusText: string;
  80240. }
  80241. }
  80242. declare module BABYLON {
  80243. /**
  80244. * Extended version of XMLHttpRequest with support for customizations (headers, ...)
  80245. */
  80246. export class WebRequest implements IWebRequest {
  80247. private _xhr;
  80248. /**
  80249. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  80250. * i.e. when loading files, where the server/service expects an Authorization header
  80251. */
  80252. static CustomRequestHeaders: {
  80253. [key: string]: string;
  80254. };
  80255. /**
  80256. * Add callback functions in this array to update all the requests before they get sent to the network
  80257. */
  80258. static CustomRequestModifiers: ((request: XMLHttpRequest, url: string) => void)[];
  80259. private _injectCustomRequestHeaders;
  80260. /**
  80261. * Gets or sets a function to be called when loading progress changes
  80262. */
  80263. get onprogress(): ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null;
  80264. set onprogress(value: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null);
  80265. /**
  80266. * Returns client's state
  80267. */
  80268. get readyState(): number;
  80269. /**
  80270. * Returns client's status
  80271. */
  80272. get status(): number;
  80273. /**
  80274. * Returns client's status as a text
  80275. */
  80276. get statusText(): string;
  80277. /**
  80278. * Returns client's response
  80279. */
  80280. get response(): any;
  80281. /**
  80282. * Returns client's response url
  80283. */
  80284. get responseURL(): string;
  80285. /**
  80286. * Returns client's response as text
  80287. */
  80288. get responseText(): string;
  80289. /**
  80290. * Gets or sets the expected response type
  80291. */
  80292. get responseType(): XMLHttpRequestResponseType;
  80293. set responseType(value: XMLHttpRequestResponseType);
  80294. /** @hidden */
  80295. addEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
  80296. /** @hidden */
  80297. removeEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
  80298. /**
  80299. * Cancels any network activity
  80300. */
  80301. abort(): void;
  80302. /**
  80303. * Initiates the request. The optional argument provides the request body. The argument is ignored if request method is GET or HEAD
  80304. * @param body defines an optional request body
  80305. */
  80306. send(body?: Document | BodyInit | null): void;
  80307. /**
  80308. * Sets the request method, request URL
  80309. * @param method defines the method to use (GET, POST, etc..)
  80310. * @param url defines the url to connect with
  80311. */
  80312. open(method: string, url: string): void;
  80313. /**
  80314. * Sets the value of a request header.
  80315. * @param name The name of the header whose value is to be set
  80316. * @param value The value to set as the body of the header
  80317. */
  80318. setRequestHeader(name: string, value: string): void;
  80319. /**
  80320. * Get the string containing the text of a particular header's value.
  80321. * @param name The name of the header
  80322. * @returns The string containing the text of the given header name
  80323. */
  80324. getResponseHeader(name: string): Nullable<string>;
  80325. }
  80326. }
  80327. declare module BABYLON {
  80328. /**
  80329. * File request interface
  80330. */
  80331. export interface IFileRequest {
  80332. /**
  80333. * Raised when the request is complete (success or error).
  80334. */
  80335. onCompleteObservable: Observable<IFileRequest>;
  80336. /**
  80337. * Aborts the request for a file.
  80338. */
  80339. abort: () => void;
  80340. }
  80341. }
  80342. declare module BABYLON {
  80343. /**
  80344. * Define options used to create a render target texture
  80345. */
  80346. export class RenderTargetCreationOptions {
  80347. /**
  80348. * Specifies is mipmaps must be generated
  80349. */
  80350. generateMipMaps?: boolean;
  80351. /** Specifies whether or not a depth should be allocated in the texture (true by default) */
  80352. generateDepthBuffer?: boolean;
  80353. /** Specifies whether or not a stencil should be allocated in the texture (false by default)*/
  80354. generateStencilBuffer?: boolean;
  80355. /** Defines texture type (int by default) */
  80356. type?: number;
  80357. /** Defines sampling mode (trilinear by default) */
  80358. samplingMode?: number;
  80359. /** Defines format (RGBA by default) */
  80360. format?: number;
  80361. }
  80362. }
  80363. declare module BABYLON {
  80364. /** Defines the cross module used constants to avoid circular dependncies */
  80365. export class Constants {
  80366. /** Defines that alpha blending is disabled */
  80367. static readonly ALPHA_DISABLE: number;
  80368. /** Defines that alpha blending is SRC ALPHA * SRC + DEST */
  80369. static readonly ALPHA_ADD: number;
  80370. /** Defines that alpha blending is SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  80371. static readonly ALPHA_COMBINE: number;
  80372. /** Defines that alpha blending is DEST - SRC * DEST */
  80373. static readonly ALPHA_SUBTRACT: number;
  80374. /** Defines that alpha blending is SRC * DEST */
  80375. static readonly ALPHA_MULTIPLY: number;
  80376. /** Defines that alpha blending is SRC ALPHA * SRC + (1 - SRC) * DEST */
  80377. static readonly ALPHA_MAXIMIZED: number;
  80378. /** Defines that alpha blending is SRC + DEST */
  80379. static readonly ALPHA_ONEONE: number;
  80380. /** Defines that alpha blending is SRC + (1 - SRC ALPHA) * DEST */
  80381. static readonly ALPHA_PREMULTIPLIED: number;
  80382. /**
  80383. * Defines that alpha blending is SRC + (1 - SRC ALPHA) * DEST
  80384. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  80385. */
  80386. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  80387. /** Defines that alpha blending is CST * SRC + (1 - CST) * DEST */
  80388. static readonly ALPHA_INTERPOLATE: number;
  80389. /**
  80390. * Defines that alpha blending is SRC + (1 - SRC) * DEST
  80391. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  80392. */
  80393. static readonly ALPHA_SCREENMODE: number;
  80394. /**
  80395. * Defines that alpha blending is SRC + DST
  80396. * Alpha will be set to SRC ALPHA + DST ALPHA
  80397. */
  80398. static readonly ALPHA_ONEONE_ONEONE: number;
  80399. /**
  80400. * Defines that alpha blending is SRC * DST ALPHA + DST
  80401. * Alpha will be set to 0
  80402. */
  80403. static readonly ALPHA_ALPHATOCOLOR: number;
  80404. /**
  80405. * Defines that alpha blending is SRC * (1 - DST) + DST * (1 - SRC)
  80406. */
  80407. static readonly ALPHA_REVERSEONEMINUS: number;
  80408. /**
  80409. * Defines that alpha blending is SRC + DST * (1 - SRC ALPHA)
  80410. * Alpha will be set to SRC ALPHA + DST ALPHA * (1 - SRC ALPHA)
  80411. */
  80412. static readonly ALPHA_SRC_DSTONEMINUSSRCALPHA: number;
  80413. /**
  80414. * Defines that alpha blending is SRC + DST
  80415. * Alpha will be set to SRC ALPHA
  80416. */
  80417. static readonly ALPHA_ONEONE_ONEZERO: number;
  80418. /**
  80419. * Defines that alpha blending is SRC * (1 - DST) + DST * (1 - SRC)
  80420. * Alpha will be set to DST ALPHA
  80421. */
  80422. static readonly ALPHA_EXCLUSION: number;
  80423. /** Defines that alpha blending equation a SUM */
  80424. static readonly ALPHA_EQUATION_ADD: number;
  80425. /** Defines that alpha blending equation a SUBSTRACTION */
  80426. static readonly ALPHA_EQUATION_SUBSTRACT: number;
  80427. /** Defines that alpha blending equation a REVERSE SUBSTRACTION */
  80428. static readonly ALPHA_EQUATION_REVERSE_SUBTRACT: number;
  80429. /** Defines that alpha blending equation a MAX operation */
  80430. static readonly ALPHA_EQUATION_MAX: number;
  80431. /** Defines that alpha blending equation a MIN operation */
  80432. static readonly ALPHA_EQUATION_MIN: number;
  80433. /**
  80434. * Defines that alpha blending equation a DARKEN operation:
  80435. * It takes the min of the src and sums the alpha channels.
  80436. */
  80437. static readonly ALPHA_EQUATION_DARKEN: number;
  80438. /** Defines that the ressource is not delayed*/
  80439. static readonly DELAYLOADSTATE_NONE: number;
  80440. /** Defines that the ressource was successfully delay loaded */
  80441. static readonly DELAYLOADSTATE_LOADED: number;
  80442. /** Defines that the ressource is currently delay loading */
  80443. static readonly DELAYLOADSTATE_LOADING: number;
  80444. /** Defines that the ressource is delayed and has not started loading */
  80445. static readonly DELAYLOADSTATE_NOTLOADED: number;
  80446. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  80447. static readonly NEVER: number;
  80448. /** 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 */
  80449. static readonly ALWAYS: number;
  80450. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  80451. static readonly LESS: number;
  80452. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  80453. static readonly EQUAL: number;
  80454. /** 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 */
  80455. static readonly LEQUAL: number;
  80456. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  80457. static readonly GREATER: number;
  80458. /** 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 */
  80459. static readonly GEQUAL: number;
  80460. /** 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 */
  80461. static readonly NOTEQUAL: number;
  80462. /** Passed to stencilOperation to specify that stencil value must be kept */
  80463. static readonly KEEP: number;
  80464. /** Passed to stencilOperation to specify that stencil value must be replaced */
  80465. static readonly REPLACE: number;
  80466. /** Passed to stencilOperation to specify that stencil value must be incremented */
  80467. static readonly INCR: number;
  80468. /** Passed to stencilOperation to specify that stencil value must be decremented */
  80469. static readonly DECR: number;
  80470. /** Passed to stencilOperation to specify that stencil value must be inverted */
  80471. static readonly INVERT: number;
  80472. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  80473. static readonly INCR_WRAP: number;
  80474. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  80475. static readonly DECR_WRAP: number;
  80476. /** Texture is not repeating outside of 0..1 UVs */
  80477. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  80478. /** Texture is repeating outside of 0..1 UVs */
  80479. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  80480. /** Texture is repeating and mirrored */
  80481. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  80482. /** ALPHA */
  80483. static readonly TEXTUREFORMAT_ALPHA: number;
  80484. /** LUMINANCE */
  80485. static readonly TEXTUREFORMAT_LUMINANCE: number;
  80486. /** LUMINANCE_ALPHA */
  80487. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  80488. /** RGB */
  80489. static readonly TEXTUREFORMAT_RGB: number;
  80490. /** RGBA */
  80491. static readonly TEXTUREFORMAT_RGBA: number;
  80492. /** RED */
  80493. static readonly TEXTUREFORMAT_RED: number;
  80494. /** RED (2nd reference) */
  80495. static readonly TEXTUREFORMAT_R: number;
  80496. /** RG */
  80497. static readonly TEXTUREFORMAT_RG: number;
  80498. /** RED_INTEGER */
  80499. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  80500. /** RED_INTEGER (2nd reference) */
  80501. static readonly TEXTUREFORMAT_R_INTEGER: number;
  80502. /** RG_INTEGER */
  80503. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  80504. /** RGB_INTEGER */
  80505. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  80506. /** RGBA_INTEGER */
  80507. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  80508. /** UNSIGNED_BYTE */
  80509. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  80510. /** UNSIGNED_BYTE (2nd reference) */
  80511. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  80512. /** FLOAT */
  80513. static readonly TEXTURETYPE_FLOAT: number;
  80514. /** HALF_FLOAT */
  80515. static readonly TEXTURETYPE_HALF_FLOAT: number;
  80516. /** BYTE */
  80517. static readonly TEXTURETYPE_BYTE: number;
  80518. /** SHORT */
  80519. static readonly TEXTURETYPE_SHORT: number;
  80520. /** UNSIGNED_SHORT */
  80521. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  80522. /** INT */
  80523. static readonly TEXTURETYPE_INT: number;
  80524. /** UNSIGNED_INT */
  80525. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  80526. /** UNSIGNED_SHORT_4_4_4_4 */
  80527. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  80528. /** UNSIGNED_SHORT_5_5_5_1 */
  80529. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  80530. /** UNSIGNED_SHORT_5_6_5 */
  80531. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  80532. /** UNSIGNED_INT_2_10_10_10_REV */
  80533. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  80534. /** UNSIGNED_INT_24_8 */
  80535. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  80536. /** UNSIGNED_INT_10F_11F_11F_REV */
  80537. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  80538. /** UNSIGNED_INT_5_9_9_9_REV */
  80539. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  80540. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  80541. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  80542. /** nearest is mag = nearest and min = nearest and no mip */
  80543. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  80544. /** mag = nearest and min = nearest and mip = none */
  80545. static readonly TEXTURE_NEAREST_NEAREST: number;
  80546. /** Bilinear is mag = linear and min = linear and no mip */
  80547. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  80548. /** mag = linear and min = linear and mip = none */
  80549. static readonly TEXTURE_LINEAR_LINEAR: number;
  80550. /** Trilinear is mag = linear and min = linear and mip = linear */
  80551. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  80552. /** Trilinear is mag = linear and min = linear and mip = linear */
  80553. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  80554. /** mag = nearest and min = nearest and mip = nearest */
  80555. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  80556. /** mag = nearest and min = linear and mip = nearest */
  80557. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  80558. /** mag = nearest and min = linear and mip = linear */
  80559. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  80560. /** mag = nearest and min = linear and mip = none */
  80561. static readonly TEXTURE_NEAREST_LINEAR: number;
  80562. /** nearest is mag = nearest and min = nearest and mip = linear */
  80563. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  80564. /** mag = linear and min = nearest and mip = nearest */
  80565. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  80566. /** mag = linear and min = nearest and mip = linear */
  80567. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  80568. /** Bilinear is mag = linear and min = linear and mip = nearest */
  80569. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  80570. /** mag = linear and min = nearest and mip = none */
  80571. static readonly TEXTURE_LINEAR_NEAREST: number;
  80572. /** Explicit coordinates mode */
  80573. static readonly TEXTURE_EXPLICIT_MODE: number;
  80574. /** Spherical coordinates mode */
  80575. static readonly TEXTURE_SPHERICAL_MODE: number;
  80576. /** Planar coordinates mode */
  80577. static readonly TEXTURE_PLANAR_MODE: number;
  80578. /** Cubic coordinates mode */
  80579. static readonly TEXTURE_CUBIC_MODE: number;
  80580. /** Projection coordinates mode */
  80581. static readonly TEXTURE_PROJECTION_MODE: number;
  80582. /** Skybox coordinates mode */
  80583. static readonly TEXTURE_SKYBOX_MODE: number;
  80584. /** Inverse Cubic coordinates mode */
  80585. static readonly TEXTURE_INVCUBIC_MODE: number;
  80586. /** Equirectangular coordinates mode */
  80587. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  80588. /** Equirectangular Fixed coordinates mode */
  80589. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  80590. /** Equirectangular Fixed Mirrored coordinates mode */
  80591. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  80592. /** Offline (baking) quality for texture filtering */
  80593. static readonly TEXTURE_FILTERING_QUALITY_OFFLINE: number;
  80594. /** High quality for texture filtering */
  80595. static readonly TEXTURE_FILTERING_QUALITY_HIGH: number;
  80596. /** Medium quality for texture filtering */
  80597. static readonly TEXTURE_FILTERING_QUALITY_MEDIUM: number;
  80598. /** Low quality for texture filtering */
  80599. static readonly TEXTURE_FILTERING_QUALITY_LOW: number;
  80600. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  80601. static readonly SCALEMODE_FLOOR: number;
  80602. /** Defines that texture rescaling will look for the nearest power of 2 size */
  80603. static readonly SCALEMODE_NEAREST: number;
  80604. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  80605. static readonly SCALEMODE_CEILING: number;
  80606. /**
  80607. * The dirty texture flag value
  80608. */
  80609. static readonly MATERIAL_TextureDirtyFlag: number;
  80610. /**
  80611. * The dirty light flag value
  80612. */
  80613. static readonly MATERIAL_LightDirtyFlag: number;
  80614. /**
  80615. * The dirty fresnel flag value
  80616. */
  80617. static readonly MATERIAL_FresnelDirtyFlag: number;
  80618. /**
  80619. * The dirty attribute flag value
  80620. */
  80621. static readonly MATERIAL_AttributesDirtyFlag: number;
  80622. /**
  80623. * The dirty misc flag value
  80624. */
  80625. static readonly MATERIAL_MiscDirtyFlag: number;
  80626. /**
  80627. * The all dirty flag value
  80628. */
  80629. static readonly MATERIAL_AllDirtyFlag: number;
  80630. /**
  80631. * Returns the triangle fill mode
  80632. */
  80633. static readonly MATERIAL_TriangleFillMode: number;
  80634. /**
  80635. * Returns the wireframe mode
  80636. */
  80637. static readonly MATERIAL_WireFrameFillMode: number;
  80638. /**
  80639. * Returns the point fill mode
  80640. */
  80641. static readonly MATERIAL_PointFillMode: number;
  80642. /**
  80643. * Returns the point list draw mode
  80644. */
  80645. static readonly MATERIAL_PointListDrawMode: number;
  80646. /**
  80647. * Returns the line list draw mode
  80648. */
  80649. static readonly MATERIAL_LineListDrawMode: number;
  80650. /**
  80651. * Returns the line loop draw mode
  80652. */
  80653. static readonly MATERIAL_LineLoopDrawMode: number;
  80654. /**
  80655. * Returns the line strip draw mode
  80656. */
  80657. static readonly MATERIAL_LineStripDrawMode: number;
  80658. /**
  80659. * Returns the triangle strip draw mode
  80660. */
  80661. static readonly MATERIAL_TriangleStripDrawMode: number;
  80662. /**
  80663. * Returns the triangle fan draw mode
  80664. */
  80665. static readonly MATERIAL_TriangleFanDrawMode: number;
  80666. /**
  80667. * Stores the clock-wise side orientation
  80668. */
  80669. static readonly MATERIAL_ClockWiseSideOrientation: number;
  80670. /**
  80671. * Stores the counter clock-wise side orientation
  80672. */
  80673. static readonly MATERIAL_CounterClockWiseSideOrientation: number;
  80674. /**
  80675. * Nothing
  80676. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80677. */
  80678. static readonly ACTION_NothingTrigger: number;
  80679. /**
  80680. * On pick
  80681. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80682. */
  80683. static readonly ACTION_OnPickTrigger: number;
  80684. /**
  80685. * On left pick
  80686. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80687. */
  80688. static readonly ACTION_OnLeftPickTrigger: number;
  80689. /**
  80690. * On right pick
  80691. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80692. */
  80693. static readonly ACTION_OnRightPickTrigger: number;
  80694. /**
  80695. * On center pick
  80696. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80697. */
  80698. static readonly ACTION_OnCenterPickTrigger: number;
  80699. /**
  80700. * On pick down
  80701. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80702. */
  80703. static readonly ACTION_OnPickDownTrigger: number;
  80704. /**
  80705. * On double pick
  80706. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80707. */
  80708. static readonly ACTION_OnDoublePickTrigger: number;
  80709. /**
  80710. * On pick up
  80711. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80712. */
  80713. static readonly ACTION_OnPickUpTrigger: number;
  80714. /**
  80715. * On pick out.
  80716. * This trigger will only be raised if you also declared a OnPickDown
  80717. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80718. */
  80719. static readonly ACTION_OnPickOutTrigger: number;
  80720. /**
  80721. * On long press
  80722. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80723. */
  80724. static readonly ACTION_OnLongPressTrigger: number;
  80725. /**
  80726. * On pointer over
  80727. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80728. */
  80729. static readonly ACTION_OnPointerOverTrigger: number;
  80730. /**
  80731. * On pointer out
  80732. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80733. */
  80734. static readonly ACTION_OnPointerOutTrigger: number;
  80735. /**
  80736. * On every frame
  80737. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80738. */
  80739. static readonly ACTION_OnEveryFrameTrigger: number;
  80740. /**
  80741. * On intersection enter
  80742. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80743. */
  80744. static readonly ACTION_OnIntersectionEnterTrigger: number;
  80745. /**
  80746. * On intersection exit
  80747. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80748. */
  80749. static readonly ACTION_OnIntersectionExitTrigger: number;
  80750. /**
  80751. * On key down
  80752. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80753. */
  80754. static readonly ACTION_OnKeyDownTrigger: number;
  80755. /**
  80756. * On key up
  80757. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80758. */
  80759. static readonly ACTION_OnKeyUpTrigger: number;
  80760. /**
  80761. * Billboard mode will only apply to Y axis
  80762. */
  80763. static readonly PARTICLES_BILLBOARDMODE_Y: number;
  80764. /**
  80765. * Billboard mode will apply to all axes
  80766. */
  80767. static readonly PARTICLES_BILLBOARDMODE_ALL: number;
  80768. /**
  80769. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  80770. */
  80771. static readonly PARTICLES_BILLBOARDMODE_STRETCHED: number;
  80772. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  80773. * Test order :
  80774. * Is the bounding sphere outside the frustum ?
  80775. * If not, are the bounding box vertices outside the frustum ?
  80776. * It not, then the cullable object is in the frustum.
  80777. */
  80778. static readonly MESHES_CULLINGSTRATEGY_STANDARD: number;
  80779. /** Culling strategy : Bounding Sphere Only.
  80780. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  80781. * It's also less accurate than the standard because some not visible objects can still be selected.
  80782. * Test : is the bounding sphere outside the frustum ?
  80783. * If not, then the cullable object is in the frustum.
  80784. */
  80785. static readonly MESHES_CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  80786. /** Culling strategy : Optimistic Inclusion.
  80787. * This in an inclusion test first, then the standard exclusion test.
  80788. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  80789. * 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.
  80790. * Anyway, it's as accurate as the standard strategy.
  80791. * Test :
  80792. * Is the cullable object bounding sphere center in the frustum ?
  80793. * If not, apply the default culling strategy.
  80794. */
  80795. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  80796. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  80797. * This in an inclusion test first, then the bounding sphere only exclusion test.
  80798. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  80799. * 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.
  80800. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  80801. * Test :
  80802. * Is the cullable object bounding sphere center in the frustum ?
  80803. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  80804. */
  80805. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  80806. /**
  80807. * No logging while loading
  80808. */
  80809. static readonly SCENELOADER_NO_LOGGING: number;
  80810. /**
  80811. * Minimal logging while loading
  80812. */
  80813. static readonly SCENELOADER_MINIMAL_LOGGING: number;
  80814. /**
  80815. * Summary logging while loading
  80816. */
  80817. static readonly SCENELOADER_SUMMARY_LOGGING: number;
  80818. /**
  80819. * Detailled logging while loading
  80820. */
  80821. static readonly SCENELOADER_DETAILED_LOGGING: number;
  80822. /**
  80823. * Prepass texture index for color
  80824. */
  80825. static readonly PREPASS_COLOR_INDEX: number;
  80826. /**
  80827. * Prepass texture index for irradiance
  80828. */
  80829. static readonly PREPASS_IRRADIANCE_INDEX: number;
  80830. /**
  80831. * Prepass texture index for depth + normal
  80832. */
  80833. static readonly PREPASS_DEPTHNORMAL_INDEX: number;
  80834. /**
  80835. * Prepass texture index for albedo
  80836. */
  80837. static readonly PREPASS_ALBEDO_INDEX: number;
  80838. }
  80839. }
  80840. declare module BABYLON {
  80841. /**
  80842. * This represents the required contract to create a new type of texture loader.
  80843. */
  80844. export interface IInternalTextureLoader {
  80845. /**
  80846. * Defines wether the loader supports cascade loading the different faces.
  80847. */
  80848. supportCascades: boolean;
  80849. /**
  80850. * This returns if the loader support the current file information.
  80851. * @param extension defines the file extension of the file being loaded
  80852. * @param mimeType defines the optional mime type of the file being loaded
  80853. * @returns true if the loader can load the specified file
  80854. */
  80855. canLoad(extension: string, mimeType?: string): boolean;
  80856. /**
  80857. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  80858. * @param data contains the texture data
  80859. * @param texture defines the BabylonJS internal texture
  80860. * @param createPolynomials will be true if polynomials have been requested
  80861. * @param onLoad defines the callback to trigger once the texture is ready
  80862. * @param onError defines the callback to trigger in case of error
  80863. */
  80864. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  80865. /**
  80866. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  80867. * @param data contains the texture data
  80868. * @param texture defines the BabylonJS internal texture
  80869. * @param callback defines the method to call once ready to upload
  80870. */
  80871. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed?: boolean) => void): void;
  80872. }
  80873. }
  80874. declare module BABYLON {
  80875. /**
  80876. * Class used to store and describe the pipeline context associated with an effect
  80877. */
  80878. export interface IPipelineContext {
  80879. /**
  80880. * Gets a boolean indicating that this pipeline context is supporting asynchronous creating
  80881. */
  80882. isAsync: boolean;
  80883. /**
  80884. * Gets a boolean indicating that the context is ready to be used (like shaders / pipelines are compiled and ready for instance)
  80885. */
  80886. isReady: boolean;
  80887. /** @hidden */
  80888. _getVertexShaderCode(): string | null;
  80889. /** @hidden */
  80890. _getFragmentShaderCode(): string | null;
  80891. /** @hidden */
  80892. _handlesSpectorRebuildCallback(onCompiled: (compiledObject: any) => void): void;
  80893. }
  80894. }
  80895. declare module BABYLON {
  80896. /**
  80897. * Class used to store gfx data (like WebGLBuffer)
  80898. */
  80899. export class DataBuffer {
  80900. /**
  80901. * Gets or sets the number of objects referencing this buffer
  80902. */
  80903. references: number;
  80904. /** Gets or sets the size of the underlying buffer */
  80905. capacity: number;
  80906. /**
  80907. * Gets or sets a boolean indicating if the buffer contains 32bits indices
  80908. */
  80909. is32Bits: boolean;
  80910. /**
  80911. * Gets the underlying buffer
  80912. */
  80913. get underlyingResource(): any;
  80914. }
  80915. }
  80916. declare module BABYLON {
  80917. /** @hidden */
  80918. export interface IShaderProcessor {
  80919. attributeProcessor?: (attribute: string) => string;
  80920. varyingProcessor?: (varying: string, isFragment: boolean) => string;
  80921. uniformProcessor?: (uniform: string, isFragment: boolean) => string;
  80922. uniformBufferProcessor?: (uniformBuffer: string, isFragment: boolean) => string;
  80923. endOfUniformBufferProcessor?: (closingBracketLine: string, isFragment: boolean) => string;
  80924. lineProcessor?: (line: string, isFragment: boolean) => string;
  80925. preProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  80926. postProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  80927. }
  80928. }
  80929. declare module BABYLON {
  80930. /** @hidden */
  80931. export interface ProcessingOptions {
  80932. defines: string[];
  80933. indexParameters: any;
  80934. isFragment: boolean;
  80935. shouldUseHighPrecisionShader: boolean;
  80936. supportsUniformBuffers: boolean;
  80937. shadersRepository: string;
  80938. includesShadersStore: {
  80939. [key: string]: string;
  80940. };
  80941. processor?: IShaderProcessor;
  80942. version: string;
  80943. platformName: string;
  80944. lookForClosingBracketForUniformBuffer?: boolean;
  80945. }
  80946. }
  80947. declare module BABYLON {
  80948. /** @hidden */
  80949. export class ShaderCodeNode {
  80950. line: string;
  80951. children: ShaderCodeNode[];
  80952. additionalDefineKey?: string;
  80953. additionalDefineValue?: string;
  80954. isValid(preprocessors: {
  80955. [key: string]: string;
  80956. }): boolean;
  80957. process(preprocessors: {
  80958. [key: string]: string;
  80959. }, options: ProcessingOptions): string;
  80960. }
  80961. }
  80962. declare module BABYLON {
  80963. /** @hidden */
  80964. export class ShaderCodeCursor {
  80965. private _lines;
  80966. lineIndex: number;
  80967. get currentLine(): string;
  80968. get canRead(): boolean;
  80969. set lines(value: string[]);
  80970. }
  80971. }
  80972. declare module BABYLON {
  80973. /** @hidden */
  80974. export class ShaderCodeConditionNode extends ShaderCodeNode {
  80975. process(preprocessors: {
  80976. [key: string]: string;
  80977. }, options: ProcessingOptions): string;
  80978. }
  80979. }
  80980. declare module BABYLON {
  80981. /** @hidden */
  80982. export class ShaderDefineExpression {
  80983. isTrue(preprocessors: {
  80984. [key: string]: string;
  80985. }): boolean;
  80986. private static _OperatorPriority;
  80987. private static _Stack;
  80988. static postfixToInfix(postfix: string[]): string;
  80989. static infixToPostfix(infix: string): string[];
  80990. }
  80991. }
  80992. declare module BABYLON {
  80993. /** @hidden */
  80994. export class ShaderCodeTestNode extends ShaderCodeNode {
  80995. testExpression: ShaderDefineExpression;
  80996. isValid(preprocessors: {
  80997. [key: string]: string;
  80998. }): boolean;
  80999. }
  81000. }
  81001. declare module BABYLON {
  81002. /** @hidden */
  81003. export class ShaderDefineIsDefinedOperator extends ShaderDefineExpression {
  81004. define: string;
  81005. not: boolean;
  81006. constructor(define: string, not?: boolean);
  81007. isTrue(preprocessors: {
  81008. [key: string]: string;
  81009. }): boolean;
  81010. }
  81011. }
  81012. declare module BABYLON {
  81013. /** @hidden */
  81014. export class ShaderDefineOrOperator extends ShaderDefineExpression {
  81015. leftOperand: ShaderDefineExpression;
  81016. rightOperand: ShaderDefineExpression;
  81017. isTrue(preprocessors: {
  81018. [key: string]: string;
  81019. }): boolean;
  81020. }
  81021. }
  81022. declare module BABYLON {
  81023. /** @hidden */
  81024. export class ShaderDefineAndOperator extends ShaderDefineExpression {
  81025. leftOperand: ShaderDefineExpression;
  81026. rightOperand: ShaderDefineExpression;
  81027. isTrue(preprocessors: {
  81028. [key: string]: string;
  81029. }): boolean;
  81030. }
  81031. }
  81032. declare module BABYLON {
  81033. /** @hidden */
  81034. export class ShaderDefineArithmeticOperator extends ShaderDefineExpression {
  81035. define: string;
  81036. operand: string;
  81037. testValue: string;
  81038. constructor(define: string, operand: string, testValue: string);
  81039. isTrue(preprocessors: {
  81040. [key: string]: string;
  81041. }): boolean;
  81042. }
  81043. }
  81044. declare module BABYLON {
  81045. /**
  81046. * Class used to enable access to offline support
  81047. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  81048. */
  81049. export interface IOfflineProvider {
  81050. /**
  81051. * Gets a boolean indicating if scene must be saved in the database
  81052. */
  81053. enableSceneOffline: boolean;
  81054. /**
  81055. * Gets a boolean indicating if textures must be saved in the database
  81056. */
  81057. enableTexturesOffline: boolean;
  81058. /**
  81059. * Open the offline support and make it available
  81060. * @param successCallback defines the callback to call on success
  81061. * @param errorCallback defines the callback to call on error
  81062. */
  81063. open(successCallback: () => void, errorCallback: () => void): void;
  81064. /**
  81065. * Loads an image from the offline support
  81066. * @param url defines the url to load from
  81067. * @param image defines the target DOM image
  81068. */
  81069. loadImage(url: string, image: HTMLImageElement): void;
  81070. /**
  81071. * Loads a file from offline support
  81072. * @param url defines the URL to load from
  81073. * @param sceneLoaded defines a callback to call on success
  81074. * @param progressCallBack defines a callback to call when progress changed
  81075. * @param errorCallback defines a callback to call on error
  81076. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  81077. */
  81078. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  81079. }
  81080. }
  81081. declare module BABYLON {
  81082. /**
  81083. * Class used to help managing file picking and drag'n'drop
  81084. * File Storage
  81085. */
  81086. export class FilesInputStore {
  81087. /**
  81088. * List of files ready to be loaded
  81089. */
  81090. static FilesToLoad: {
  81091. [key: string]: File;
  81092. };
  81093. }
  81094. }
  81095. declare module BABYLON {
  81096. /**
  81097. * Class used to define a retry strategy when error happens while loading assets
  81098. */
  81099. export class RetryStrategy {
  81100. /**
  81101. * Function used to defines an exponential back off strategy
  81102. * @param maxRetries defines the maximum number of retries (3 by default)
  81103. * @param baseInterval defines the interval between retries
  81104. * @returns the strategy function to use
  81105. */
  81106. static ExponentialBackoff(maxRetries?: number, baseInterval?: number): (url: string, request: WebRequest, retryIndex: number) => number;
  81107. }
  81108. }
  81109. declare module BABYLON {
  81110. /**
  81111. * @ignore
  81112. * Application error to support additional information when loading a file
  81113. */
  81114. export abstract class BaseError extends Error {
  81115. protected static _setPrototypeOf: (o: any, proto: object | null) => any;
  81116. }
  81117. }
  81118. declare module BABYLON {
  81119. /** @ignore */
  81120. export class LoadFileError extends BaseError {
  81121. request?: WebRequest;
  81122. file?: File;
  81123. /**
  81124. * Creates a new LoadFileError
  81125. * @param message defines the message of the error
  81126. * @param request defines the optional web request
  81127. * @param file defines the optional file
  81128. */
  81129. constructor(message: string, object?: WebRequest | File);
  81130. }
  81131. /** @ignore */
  81132. export class RequestFileError extends BaseError {
  81133. request: WebRequest;
  81134. /**
  81135. * Creates a new LoadFileError
  81136. * @param message defines the message of the error
  81137. * @param request defines the optional web request
  81138. */
  81139. constructor(message: string, request: WebRequest);
  81140. }
  81141. /** @ignore */
  81142. export class ReadFileError extends BaseError {
  81143. file: File;
  81144. /**
  81145. * Creates a new ReadFileError
  81146. * @param message defines the message of the error
  81147. * @param file defines the optional file
  81148. */
  81149. constructor(message: string, file: File);
  81150. }
  81151. /**
  81152. * @hidden
  81153. */
  81154. export class FileTools {
  81155. /**
  81156. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  81157. */
  81158. static DefaultRetryStrategy: (url: string, request: WebRequest, retryIndex: number) => number;
  81159. /**
  81160. * Gets or sets the base URL to use to load assets
  81161. */
  81162. static BaseUrl: string;
  81163. /**
  81164. * Default behaviour for cors in the application.
  81165. * It can be a string if the expected behavior is identical in the entire app.
  81166. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  81167. */
  81168. static CorsBehavior: string | ((url: string | string[]) => string);
  81169. /**
  81170. * Gets or sets a function used to pre-process url before using them to load assets
  81171. */
  81172. static PreprocessUrl: (url: string) => string;
  81173. /**
  81174. * Removes unwanted characters from an url
  81175. * @param url defines the url to clean
  81176. * @returns the cleaned url
  81177. */
  81178. private static _CleanUrl;
  81179. /**
  81180. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  81181. * @param url define the url we are trying
  81182. * @param element define the dom element where to configure the cors policy
  81183. */
  81184. static SetCorsBehavior(url: string | string[], element: {
  81185. crossOrigin: string | null;
  81186. }): void;
  81187. /**
  81188. * Loads an image as an HTMLImageElement.
  81189. * @param input url string, ArrayBuffer, or Blob to load
  81190. * @param onLoad callback called when the image successfully loads
  81191. * @param onError callback called when the image fails to load
  81192. * @param offlineProvider offline provider for caching
  81193. * @param mimeType optional mime type
  81194. * @returns the HTMLImageElement of the loaded image
  81195. */
  81196. 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>;
  81197. /**
  81198. * Reads a file from a File object
  81199. * @param file defines the file to load
  81200. * @param onSuccess defines the callback to call when data is loaded
  81201. * @param onProgress defines the callback to call during loading process
  81202. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  81203. * @param onError defines the callback to call when an error occurs
  81204. * @returns a file request object
  81205. */
  81206. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  81207. /**
  81208. * Loads a file from a url
  81209. * @param url url to load
  81210. * @param onSuccess callback called when the file successfully loads
  81211. * @param onProgress callback called while file is loading (if the server supports this mode)
  81212. * @param offlineProvider defines the offline provider for caching
  81213. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  81214. * @param onError callback called when the file fails to load
  81215. * @returns a file request object
  81216. */
  81217. 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;
  81218. /**
  81219. * Loads a file
  81220. * @param url url to load
  81221. * @param onSuccess callback called when the file successfully loads
  81222. * @param onProgress callback called while file is loading (if the server supports this mode)
  81223. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  81224. * @param onError callback called when the file fails to load
  81225. * @param onOpened callback called when the web request is opened
  81226. * @returns a file request object
  81227. */
  81228. 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;
  81229. /**
  81230. * Checks if the loaded document was accessed via `file:`-Protocol.
  81231. * @returns boolean
  81232. */
  81233. static IsFileURL(): boolean;
  81234. }
  81235. }
  81236. declare module BABYLON {
  81237. /** @hidden */
  81238. export class ShaderProcessor {
  81239. static Process(sourceCode: string, options: ProcessingOptions, callback: (migratedCode: string) => void): void;
  81240. private static _ProcessPrecision;
  81241. private static _ExtractOperation;
  81242. private static _BuildSubExpression;
  81243. private static _BuildExpression;
  81244. private static _MoveCursorWithinIf;
  81245. private static _MoveCursor;
  81246. private static _EvaluatePreProcessors;
  81247. private static _PreparePreProcessors;
  81248. private static _ProcessShaderConversion;
  81249. private static _ProcessIncludes;
  81250. /**
  81251. * Loads a file from a url
  81252. * @param url url to load
  81253. * @param onSuccess callback called when the file successfully loads
  81254. * @param onProgress callback called while file is loading (if the server supports this mode)
  81255. * @param offlineProvider defines the offline provider for caching
  81256. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  81257. * @param onError callback called when the file fails to load
  81258. * @returns a file request object
  81259. * @hidden
  81260. */
  81261. 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;
  81262. }
  81263. }
  81264. declare module BABYLON {
  81265. /**
  81266. * @hidden
  81267. */
  81268. export interface IColor4Like {
  81269. r: float;
  81270. g: float;
  81271. b: float;
  81272. a: float;
  81273. }
  81274. /**
  81275. * @hidden
  81276. */
  81277. export interface IColor3Like {
  81278. r: float;
  81279. g: float;
  81280. b: float;
  81281. }
  81282. /**
  81283. * @hidden
  81284. */
  81285. export interface IVector4Like {
  81286. x: float;
  81287. y: float;
  81288. z: float;
  81289. w: float;
  81290. }
  81291. /**
  81292. * @hidden
  81293. */
  81294. export interface IVector3Like {
  81295. x: float;
  81296. y: float;
  81297. z: float;
  81298. }
  81299. /**
  81300. * @hidden
  81301. */
  81302. export interface IVector2Like {
  81303. x: float;
  81304. y: float;
  81305. }
  81306. /**
  81307. * @hidden
  81308. */
  81309. export interface IMatrixLike {
  81310. toArray(): DeepImmutable<Float32Array | Array<number>>;
  81311. updateFlag: int;
  81312. }
  81313. /**
  81314. * @hidden
  81315. */
  81316. export interface IViewportLike {
  81317. x: float;
  81318. y: float;
  81319. width: float;
  81320. height: float;
  81321. }
  81322. /**
  81323. * @hidden
  81324. */
  81325. export interface IPlaneLike {
  81326. normal: IVector3Like;
  81327. d: float;
  81328. normalize(): void;
  81329. }
  81330. }
  81331. declare module BABYLON {
  81332. /**
  81333. * Interface used to define common properties for effect fallbacks
  81334. */
  81335. export interface IEffectFallbacks {
  81336. /**
  81337. * Removes the defines that should be removed when falling back.
  81338. * @param currentDefines defines the current define statements for the shader.
  81339. * @param effect defines the current effect we try to compile
  81340. * @returns The resulting defines with defines of the current rank removed.
  81341. */
  81342. reduce(currentDefines: string, effect: Effect): string;
  81343. /**
  81344. * Removes the fallback from the bound mesh.
  81345. */
  81346. unBindMesh(): void;
  81347. /**
  81348. * Checks to see if more fallbacks are still availible.
  81349. */
  81350. hasMoreFallbacks: boolean;
  81351. }
  81352. }
  81353. declare module BABYLON {
  81354. /**
  81355. * Class used to evalaute queries containing `and` and `or` operators
  81356. */
  81357. export class AndOrNotEvaluator {
  81358. /**
  81359. * Evaluate a query
  81360. * @param query defines the query to evaluate
  81361. * @param evaluateCallback defines the callback used to filter result
  81362. * @returns true if the query matches
  81363. */
  81364. static Eval(query: string, evaluateCallback: (val: any) => boolean): boolean;
  81365. private static _HandleParenthesisContent;
  81366. private static _SimplifyNegation;
  81367. }
  81368. }
  81369. declare module BABYLON {
  81370. /**
  81371. * Class used to store custom tags
  81372. */
  81373. export class Tags {
  81374. /**
  81375. * Adds support for tags on the given object
  81376. * @param obj defines the object to use
  81377. */
  81378. static EnableFor(obj: any): void;
  81379. /**
  81380. * Removes tags support
  81381. * @param obj defines the object to use
  81382. */
  81383. static DisableFor(obj: any): void;
  81384. /**
  81385. * Gets a boolean indicating if the given object has tags
  81386. * @param obj defines the object to use
  81387. * @returns a boolean
  81388. */
  81389. static HasTags(obj: any): boolean;
  81390. /**
  81391. * Gets the tags available on a given object
  81392. * @param obj defines the object to use
  81393. * @param asString defines if the tags must be returned as a string instead of an array of strings
  81394. * @returns the tags
  81395. */
  81396. static GetTags(obj: any, asString?: boolean): any;
  81397. /**
  81398. * Adds tags to an object
  81399. * @param obj defines the object to use
  81400. * @param tagsString defines the tag string. The tags 'true' and 'false' are reserved and cannot be used as tags.
  81401. * A tag cannot start with '||', '&&', and '!'. It cannot contain whitespaces
  81402. */
  81403. static AddTagsTo(obj: any, tagsString: string): void;
  81404. /**
  81405. * @hidden
  81406. */
  81407. static _AddTagTo(obj: any, tag: string): void;
  81408. /**
  81409. * Removes specific tags from a specific object
  81410. * @param obj defines the object to use
  81411. * @param tagsString defines the tags to remove
  81412. */
  81413. static RemoveTagsFrom(obj: any, tagsString: string): void;
  81414. /**
  81415. * @hidden
  81416. */
  81417. static _RemoveTagFrom(obj: any, tag: string): void;
  81418. /**
  81419. * Defines if tags hosted on an object match a given query
  81420. * @param obj defines the object to use
  81421. * @param tagsQuery defines the tag query
  81422. * @returns a boolean
  81423. */
  81424. static MatchesQuery(obj: any, tagsQuery: string): boolean;
  81425. }
  81426. }
  81427. declare module BABYLON {
  81428. /**
  81429. * Scalar computation library
  81430. */
  81431. export class Scalar {
  81432. /**
  81433. * Two pi constants convenient for computation.
  81434. */
  81435. static TwoPi: number;
  81436. /**
  81437. * Boolean : true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  81438. * @param a number
  81439. * @param b number
  81440. * @param epsilon (default = 1.401298E-45)
  81441. * @returns true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  81442. */
  81443. static WithinEpsilon(a: number, b: number, epsilon?: number): boolean;
  81444. /**
  81445. * Returns a string : the upper case translation of the number i to hexadecimal.
  81446. * @param i number
  81447. * @returns the upper case translation of the number i to hexadecimal.
  81448. */
  81449. static ToHex(i: number): string;
  81450. /**
  81451. * Returns -1 if value is negative and +1 is value is positive.
  81452. * @param value the value
  81453. * @returns the value itself if it's equal to zero.
  81454. */
  81455. static Sign(value: number): number;
  81456. /**
  81457. * Returns the value itself if it's between min and max.
  81458. * Returns min if the value is lower than min.
  81459. * Returns max if the value is greater than max.
  81460. * @param value the value to clmap
  81461. * @param min the min value to clamp to (default: 0)
  81462. * @param max the max value to clamp to (default: 1)
  81463. * @returns the clamped value
  81464. */
  81465. static Clamp(value: number, min?: number, max?: number): number;
  81466. /**
  81467. * the log2 of value.
  81468. * @param value the value to compute log2 of
  81469. * @returns the log2 of value.
  81470. */
  81471. static Log2(value: number): number;
  81472. /**
  81473. * Loops the value, so that it is never larger than length and never smaller than 0.
  81474. *
  81475. * This is similar to the modulo operator but it works with floating point numbers.
  81476. * For example, using 3.0 for t and 2.5 for length, the result would be 0.5.
  81477. * With t = 5 and length = 2.5, the result would be 0.0.
  81478. * Note, however, that the behaviour is not defined for negative numbers as it is for the modulo operator
  81479. * @param value the value
  81480. * @param length the length
  81481. * @returns the looped value
  81482. */
  81483. static Repeat(value: number, length: number): number;
  81484. /**
  81485. * Normalize the value between 0.0 and 1.0 using min and max values
  81486. * @param value value to normalize
  81487. * @param min max to normalize between
  81488. * @param max min to normalize between
  81489. * @returns the normalized value
  81490. */
  81491. static Normalize(value: number, min: number, max: number): number;
  81492. /**
  81493. * Denormalize the value from 0.0 and 1.0 using min and max values
  81494. * @param normalized value to denormalize
  81495. * @param min max to denormalize between
  81496. * @param max min to denormalize between
  81497. * @returns the denormalized value
  81498. */
  81499. static Denormalize(normalized: number, min: number, max: number): number;
  81500. /**
  81501. * Calculates the shortest difference between two given angles given in degrees.
  81502. * @param current current angle in degrees
  81503. * @param target target angle in degrees
  81504. * @returns the delta
  81505. */
  81506. static DeltaAngle(current: number, target: number): number;
  81507. /**
  81508. * PingPongs the value t, so that it is never larger than length and never smaller than 0.
  81509. * @param tx value
  81510. * @param length length
  81511. * @returns The returned value will move back and forth between 0 and length
  81512. */
  81513. static PingPong(tx: number, length: number): number;
  81514. /**
  81515. * Interpolates between min and max with smoothing at the limits.
  81516. *
  81517. * This function interpolates between min and max in a similar way to Lerp. However, the interpolation will gradually speed up
  81518. * from the start and slow down toward the end. This is useful for creating natural-looking animation, fading and other transitions.
  81519. * @param from from
  81520. * @param to to
  81521. * @param tx value
  81522. * @returns the smooth stepped value
  81523. */
  81524. static SmoothStep(from: number, to: number, tx: number): number;
  81525. /**
  81526. * Moves a value current towards target.
  81527. *
  81528. * This is essentially the same as Mathf.Lerp but instead the function will ensure that the speed never exceeds maxDelta.
  81529. * Negative values of maxDelta pushes the value away from target.
  81530. * @param current current value
  81531. * @param target target value
  81532. * @param maxDelta max distance to move
  81533. * @returns resulting value
  81534. */
  81535. static MoveTowards(current: number, target: number, maxDelta: number): number;
  81536. /**
  81537. * Same as MoveTowards but makes sure the values interpolate correctly when they wrap around 360 degrees.
  81538. *
  81539. * Variables current and target are assumed to be in degrees. For optimization reasons, negative values of maxDelta
  81540. * are not supported and may cause oscillation. To push current away from a target angle, add 180 to that angle instead.
  81541. * @param current current value
  81542. * @param target target value
  81543. * @param maxDelta max distance to move
  81544. * @returns resulting angle
  81545. */
  81546. static MoveTowardsAngle(current: number, target: number, maxDelta: number): number;
  81547. /**
  81548. * Creates a new scalar with values linearly interpolated of "amount" between the start scalar and the end scalar.
  81549. * @param start start value
  81550. * @param end target value
  81551. * @param amount amount to lerp between
  81552. * @returns the lerped value
  81553. */
  81554. static Lerp(start: number, end: number, amount: number): number;
  81555. /**
  81556. * Same as Lerp but makes sure the values interpolate correctly when they wrap around 360 degrees.
  81557. * The parameter t is clamped to the range [0, 1]. Variables a and b are assumed to be in degrees.
  81558. * @param start start value
  81559. * @param end target value
  81560. * @param amount amount to lerp between
  81561. * @returns the lerped value
  81562. */
  81563. static LerpAngle(start: number, end: number, amount: number): number;
  81564. /**
  81565. * Calculates the linear parameter t that produces the interpolant value within the range [a, b].
  81566. * @param a start value
  81567. * @param b target value
  81568. * @param value value between a and b
  81569. * @returns the inverseLerp value
  81570. */
  81571. static InverseLerp(a: number, b: number, value: number): number;
  81572. /**
  81573. * Returns a new scalar located for "amount" (float) on the Hermite spline defined by the scalars "value1", "value3", "tangent1", "tangent2".
  81574. * @see http://mathworld.wolfram.com/HermitePolynomial.html
  81575. * @param value1 spline value
  81576. * @param tangent1 spline value
  81577. * @param value2 spline value
  81578. * @param tangent2 spline value
  81579. * @param amount input value
  81580. * @returns hermite result
  81581. */
  81582. static Hermite(value1: number, tangent1: number, value2: number, tangent2: number, amount: number): number;
  81583. /**
  81584. * Returns a random float number between and min and max values
  81585. * @param min min value of random
  81586. * @param max max value of random
  81587. * @returns random value
  81588. */
  81589. static RandomRange(min: number, max: number): number;
  81590. /**
  81591. * This function returns percentage of a number in a given range.
  81592. *
  81593. * RangeToPercent(40,20,60) will return 0.5 (50%)
  81594. * RangeToPercent(34,0,100) will return 0.34 (34%)
  81595. * @param number to convert to percentage
  81596. * @param min min range
  81597. * @param max max range
  81598. * @returns the percentage
  81599. */
  81600. static RangeToPercent(number: number, min: number, max: number): number;
  81601. /**
  81602. * This function returns number that corresponds to the percentage in a given range.
  81603. *
  81604. * PercentToRange(0.34,0,100) will return 34.
  81605. * @param percent to convert to number
  81606. * @param min min range
  81607. * @param max max range
  81608. * @returns the number
  81609. */
  81610. static PercentToRange(percent: number, min: number, max: number): number;
  81611. /**
  81612. * Returns the angle converted to equivalent value between -Math.PI and Math.PI radians.
  81613. * @param angle The angle to normalize in radian.
  81614. * @return The converted angle.
  81615. */
  81616. static NormalizeRadians(angle: number): number;
  81617. }
  81618. }
  81619. declare module BABYLON {
  81620. /**
  81621. * Constant used to convert a value to gamma space
  81622. * @ignorenaming
  81623. */
  81624. export const ToGammaSpace: number;
  81625. /**
  81626. * Constant used to convert a value to linear space
  81627. * @ignorenaming
  81628. */
  81629. export const ToLinearSpace = 2.2;
  81630. /**
  81631. * Constant used to define the minimal number value in Babylon.js
  81632. * @ignorenaming
  81633. */
  81634. let Epsilon: number;
  81635. }
  81636. declare module BABYLON {
  81637. /**
  81638. * Class used to represent a viewport on screen
  81639. */
  81640. export class Viewport {
  81641. /** viewport left coordinate */
  81642. x: number;
  81643. /** viewport top coordinate */
  81644. y: number;
  81645. /**viewport width */
  81646. width: number;
  81647. /** viewport height */
  81648. height: number;
  81649. /**
  81650. * Creates a Viewport object located at (x, y) and sized (width, height)
  81651. * @param x defines viewport left coordinate
  81652. * @param y defines viewport top coordinate
  81653. * @param width defines the viewport width
  81654. * @param height defines the viewport height
  81655. */
  81656. constructor(
  81657. /** viewport left coordinate */
  81658. x: number,
  81659. /** viewport top coordinate */
  81660. y: number,
  81661. /**viewport width */
  81662. width: number,
  81663. /** viewport height */
  81664. height: number);
  81665. /**
  81666. * Creates a new viewport using absolute sizing (from 0-> width, 0-> height instead of 0->1)
  81667. * @param renderWidth defines the rendering width
  81668. * @param renderHeight defines the rendering height
  81669. * @returns a new Viewport
  81670. */
  81671. toGlobal(renderWidth: number, renderHeight: number): Viewport;
  81672. /**
  81673. * Stores absolute viewport value into a target viewport (from 0-> width, 0-> height instead of 0->1)
  81674. * @param renderWidth defines the rendering width
  81675. * @param renderHeight defines the rendering height
  81676. * @param ref defines the target viewport
  81677. * @returns the current viewport
  81678. */
  81679. toGlobalToRef(renderWidth: number, renderHeight: number, ref: Viewport): Viewport;
  81680. /**
  81681. * Returns a new Viewport copied from the current one
  81682. * @returns a new Viewport
  81683. */
  81684. clone(): Viewport;
  81685. }
  81686. }
  81687. declare module BABYLON {
  81688. /**
  81689. * Class containing a set of static utilities functions for arrays.
  81690. */
  81691. export class ArrayTools {
  81692. /**
  81693. * Returns an array of the given size filled with element built from the given constructor and the paramters
  81694. * @param size the number of element to construct and put in the array
  81695. * @param itemBuilder a callback responsible for creating new instance of item. Called once per array entry.
  81696. * @returns a new array filled with new objects
  81697. */
  81698. static BuildArray<T>(size: number, itemBuilder: () => T): Array<T>;
  81699. }
  81700. }
  81701. declare module BABYLON {
  81702. /**
  81703. * Represents a plane by the equation ax + by + cz + d = 0
  81704. */
  81705. export class Plane {
  81706. private static _TmpMatrix;
  81707. /**
  81708. * Normal of the plane (a,b,c)
  81709. */
  81710. normal: Vector3;
  81711. /**
  81712. * d component of the plane
  81713. */
  81714. d: number;
  81715. /**
  81716. * Creates a Plane object according to the given floats a, b, c, d and the plane equation : ax + by + cz + d = 0
  81717. * @param a a component of the plane
  81718. * @param b b component of the plane
  81719. * @param c c component of the plane
  81720. * @param d d component of the plane
  81721. */
  81722. constructor(a: number, b: number, c: number, d: number);
  81723. /**
  81724. * @returns the plane coordinates as a new array of 4 elements [a, b, c, d].
  81725. */
  81726. asArray(): number[];
  81727. /**
  81728. * @returns a new plane copied from the current Plane.
  81729. */
  81730. clone(): Plane;
  81731. /**
  81732. * @returns the string "Plane".
  81733. */
  81734. getClassName(): string;
  81735. /**
  81736. * @returns the Plane hash code.
  81737. */
  81738. getHashCode(): number;
  81739. /**
  81740. * Normalize the current Plane in place.
  81741. * @returns the updated Plane.
  81742. */
  81743. normalize(): Plane;
  81744. /**
  81745. * Applies a transformation the plane and returns the result
  81746. * @param transformation the transformation matrix to be applied to the plane
  81747. * @returns a new Plane as the result of the transformation of the current Plane by the given matrix.
  81748. */
  81749. transform(transformation: DeepImmutable<Matrix>): Plane;
  81750. /**
  81751. * Compute the dot product between the point and the plane normal
  81752. * @param point point to calculate the dot product with
  81753. * @returns the dot product (float) of the point coordinates and the plane normal.
  81754. */
  81755. dotCoordinate(point: DeepImmutable<Vector3>): number;
  81756. /**
  81757. * Updates the current Plane from the plane defined by the three given points.
  81758. * @param point1 one of the points used to contruct the plane
  81759. * @param point2 one of the points used to contruct the plane
  81760. * @param point3 one of the points used to contruct the plane
  81761. * @returns the updated Plane.
  81762. */
  81763. copyFromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  81764. /**
  81765. * Checks if the plane is facing a given direction
  81766. * @param direction the direction to check if the plane is facing
  81767. * @param epsilon value the dot product is compared against (returns true if dot <= epsilon)
  81768. * @returns True is the vector "direction" is the same side than the plane normal.
  81769. */
  81770. isFrontFacingTo(direction: DeepImmutable<Vector3>, epsilon: number): boolean;
  81771. /**
  81772. * Calculates the distance to a point
  81773. * @param point point to calculate distance to
  81774. * @returns the signed distance (float) from the given point to the Plane.
  81775. */
  81776. signedDistanceTo(point: DeepImmutable<Vector3>): number;
  81777. /**
  81778. * Creates a plane from an array
  81779. * @param array the array to create a plane from
  81780. * @returns a new Plane from the given array.
  81781. */
  81782. static FromArray(array: DeepImmutable<ArrayLike<number>>): Plane;
  81783. /**
  81784. * Creates a plane from three points
  81785. * @param point1 point used to create the plane
  81786. * @param point2 point used to create the plane
  81787. * @param point3 point used to create the plane
  81788. * @returns a new Plane defined by the three given points.
  81789. */
  81790. static FromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  81791. /**
  81792. * Creates a plane from an origin point and a normal
  81793. * @param origin origin of the plane to be constructed
  81794. * @param normal normal of the plane to be constructed
  81795. * @returns a new Plane the normal vector to this plane at the given origin point.
  81796. * Note : the vector "normal" is updated because normalized.
  81797. */
  81798. static FromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: Vector3): Plane;
  81799. /**
  81800. * Calculates the distance from a plane and a point
  81801. * @param origin origin of the plane to be constructed
  81802. * @param normal normal of the plane to be constructed
  81803. * @param point point to calculate distance to
  81804. * @returns the signed distance between the plane defined by the normal vector at the "origin"" point and the given other point.
  81805. */
  81806. static SignedDistanceToPlaneFromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>, point: DeepImmutable<Vector3>): number;
  81807. }
  81808. }
  81809. declare module BABYLON {
  81810. /** @hidden */
  81811. export class PerformanceConfigurator {
  81812. /** @hidden */
  81813. static MatrixUse64Bits: boolean;
  81814. /** @hidden */
  81815. static MatrixTrackPrecisionChange: boolean;
  81816. /** @hidden */
  81817. static MatrixCurrentType: any;
  81818. /** @hidden */
  81819. static MatrixTrackedMatrices: Array<any> | null;
  81820. /** @hidden */
  81821. static SetMatrixPrecision(use64bits: boolean): void;
  81822. }
  81823. }
  81824. declare module BABYLON {
  81825. /**
  81826. * Class representing a vector containing 2 coordinates
  81827. */
  81828. export class Vector2 {
  81829. /** defines the first coordinate */
  81830. x: number;
  81831. /** defines the second coordinate */
  81832. y: number;
  81833. /**
  81834. * Creates a new Vector2 from the given x and y coordinates
  81835. * @param x defines the first coordinate
  81836. * @param y defines the second coordinate
  81837. */
  81838. constructor(
  81839. /** defines the first coordinate */
  81840. x?: number,
  81841. /** defines the second coordinate */
  81842. y?: number);
  81843. /**
  81844. * Gets a string with the Vector2 coordinates
  81845. * @returns a string with the Vector2 coordinates
  81846. */
  81847. toString(): string;
  81848. /**
  81849. * Gets class name
  81850. * @returns the string "Vector2"
  81851. */
  81852. getClassName(): string;
  81853. /**
  81854. * Gets current vector hash code
  81855. * @returns the Vector2 hash code as a number
  81856. */
  81857. getHashCode(): number;
  81858. /**
  81859. * Sets the Vector2 coordinates in the given array or Float32Array from the given index.
  81860. * @param array defines the source array
  81861. * @param index defines the offset in source array
  81862. * @returns the current Vector2
  81863. */
  81864. toArray(array: FloatArray, index?: number): Vector2;
  81865. /**
  81866. * Update the current vector from an array
  81867. * @param array defines the destination array
  81868. * @param index defines the offset in the destination array
  81869. * @returns the current Vector3
  81870. */
  81871. fromArray(array: FloatArray, index?: number): Vector2;
  81872. /**
  81873. * Copy the current vector to an array
  81874. * @returns a new array with 2 elements: the Vector2 coordinates.
  81875. */
  81876. asArray(): number[];
  81877. /**
  81878. * Sets the Vector2 coordinates with the given Vector2 coordinates
  81879. * @param source defines the source Vector2
  81880. * @returns the current updated Vector2
  81881. */
  81882. copyFrom(source: DeepImmutable<Vector2>): Vector2;
  81883. /**
  81884. * Sets the Vector2 coordinates with the given floats
  81885. * @param x defines the first coordinate
  81886. * @param y defines the second coordinate
  81887. * @returns the current updated Vector2
  81888. */
  81889. copyFromFloats(x: number, y: number): Vector2;
  81890. /**
  81891. * Sets the Vector2 coordinates with the given floats
  81892. * @param x defines the first coordinate
  81893. * @param y defines the second coordinate
  81894. * @returns the current updated Vector2
  81895. */
  81896. set(x: number, y: number): Vector2;
  81897. /**
  81898. * Add another vector with the current one
  81899. * @param otherVector defines the other vector
  81900. * @returns a new Vector2 set with the addition of the current Vector2 and the given one coordinates
  81901. */
  81902. add(otherVector: DeepImmutable<Vector2>): Vector2;
  81903. /**
  81904. * Sets the "result" coordinates with the addition of the current Vector2 and the given one coordinates
  81905. * @param otherVector defines the other vector
  81906. * @param result defines the target vector
  81907. * @returns the unmodified current Vector2
  81908. */
  81909. addToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  81910. /**
  81911. * Set the Vector2 coordinates by adding the given Vector2 coordinates
  81912. * @param otherVector defines the other vector
  81913. * @returns the current updated Vector2
  81914. */
  81915. addInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  81916. /**
  81917. * Gets a new Vector2 by adding the current Vector2 coordinates to the given Vector3 x, y coordinates
  81918. * @param otherVector defines the other vector
  81919. * @returns a new Vector2
  81920. */
  81921. addVector3(otherVector: Vector3): Vector2;
  81922. /**
  81923. * Gets a new Vector2 set with the subtracted coordinates of the given one from the current Vector2
  81924. * @param otherVector defines the other vector
  81925. * @returns a new Vector2
  81926. */
  81927. subtract(otherVector: Vector2): Vector2;
  81928. /**
  81929. * Sets the "result" coordinates with the subtraction of the given one from the current Vector2 coordinates.
  81930. * @param otherVector defines the other vector
  81931. * @param result defines the target vector
  81932. * @returns the unmodified current Vector2
  81933. */
  81934. subtractToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  81935. /**
  81936. * Sets the current Vector2 coordinates by subtracting from it the given one coordinates
  81937. * @param otherVector defines the other vector
  81938. * @returns the current updated Vector2
  81939. */
  81940. subtractInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  81941. /**
  81942. * Multiplies in place the current Vector2 coordinates by the given ones
  81943. * @param otherVector defines the other vector
  81944. * @returns the current updated Vector2
  81945. */
  81946. multiplyInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  81947. /**
  81948. * Returns a new Vector2 set with the multiplication of the current Vector2 and the given one coordinates
  81949. * @param otherVector defines the other vector
  81950. * @returns a new Vector2
  81951. */
  81952. multiply(otherVector: DeepImmutable<Vector2>): Vector2;
  81953. /**
  81954. * Sets "result" coordinates with the multiplication of the current Vector2 and the given one coordinates
  81955. * @param otherVector defines the other vector
  81956. * @param result defines the target vector
  81957. * @returns the unmodified current Vector2
  81958. */
  81959. multiplyToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  81960. /**
  81961. * Gets a new Vector2 set with the Vector2 coordinates multiplied by the given floats
  81962. * @param x defines the first coordinate
  81963. * @param y defines the second coordinate
  81964. * @returns a new Vector2
  81965. */
  81966. multiplyByFloats(x: number, y: number): Vector2;
  81967. /**
  81968. * Returns a new Vector2 set with the Vector2 coordinates divided by the given one coordinates
  81969. * @param otherVector defines the other vector
  81970. * @returns a new Vector2
  81971. */
  81972. divide(otherVector: Vector2): Vector2;
  81973. /**
  81974. * Sets the "result" coordinates with the Vector2 divided by the given one coordinates
  81975. * @param otherVector defines the other vector
  81976. * @param result defines the target vector
  81977. * @returns the unmodified current Vector2
  81978. */
  81979. divideToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  81980. /**
  81981. * Divides the current Vector2 coordinates by the given ones
  81982. * @param otherVector defines the other vector
  81983. * @returns the current updated Vector2
  81984. */
  81985. divideInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  81986. /**
  81987. * Gets a new Vector2 with current Vector2 negated coordinates
  81988. * @returns a new Vector2
  81989. */
  81990. negate(): Vector2;
  81991. /**
  81992. * Negate this vector in place
  81993. * @returns this
  81994. */
  81995. negateInPlace(): Vector2;
  81996. /**
  81997. * Negate the current Vector2 and stores the result in the given vector "result" coordinates
  81998. * @param result defines the Vector3 object where to store the result
  81999. * @returns the current Vector2
  82000. */
  82001. negateToRef(result: Vector2): Vector2;
  82002. /**
  82003. * Multiply the Vector2 coordinates by scale
  82004. * @param scale defines the scaling factor
  82005. * @returns the current updated Vector2
  82006. */
  82007. scaleInPlace(scale: number): Vector2;
  82008. /**
  82009. * Returns a new Vector2 scaled by "scale" from the current Vector2
  82010. * @param scale defines the scaling factor
  82011. * @returns a new Vector2
  82012. */
  82013. scale(scale: number): Vector2;
  82014. /**
  82015. * Scale the current Vector2 values by a factor to a given Vector2
  82016. * @param scale defines the scale factor
  82017. * @param result defines the Vector2 object where to store the result
  82018. * @returns the unmodified current Vector2
  82019. */
  82020. scaleToRef(scale: number, result: Vector2): Vector2;
  82021. /**
  82022. * Scale the current Vector2 values by a factor and add the result to a given Vector2
  82023. * @param scale defines the scale factor
  82024. * @param result defines the Vector2 object where to store the result
  82025. * @returns the unmodified current Vector2
  82026. */
  82027. scaleAndAddToRef(scale: number, result: Vector2): Vector2;
  82028. /**
  82029. * Gets a boolean if two vectors are equals
  82030. * @param otherVector defines the other vector
  82031. * @returns true if the given vector coordinates strictly equal the current Vector2 ones
  82032. */
  82033. equals(otherVector: DeepImmutable<Vector2>): boolean;
  82034. /**
  82035. * Gets a boolean if two vectors are equals (using an epsilon value)
  82036. * @param otherVector defines the other vector
  82037. * @param epsilon defines the minimal distance to consider equality
  82038. * @returns true if the given vector coordinates are close to the current ones by a distance of epsilon.
  82039. */
  82040. equalsWithEpsilon(otherVector: DeepImmutable<Vector2>, epsilon?: number): boolean;
  82041. /**
  82042. * Gets a new Vector2 from current Vector2 floored values
  82043. * @returns a new Vector2
  82044. */
  82045. floor(): Vector2;
  82046. /**
  82047. * Gets a new Vector2 from current Vector2 floored values
  82048. * @returns a new Vector2
  82049. */
  82050. fract(): Vector2;
  82051. /**
  82052. * Gets the length of the vector
  82053. * @returns the vector length (float)
  82054. */
  82055. length(): number;
  82056. /**
  82057. * Gets the vector squared length
  82058. * @returns the vector squared length (float)
  82059. */
  82060. lengthSquared(): number;
  82061. /**
  82062. * Normalize the vector
  82063. * @returns the current updated Vector2
  82064. */
  82065. normalize(): Vector2;
  82066. /**
  82067. * Gets a new Vector2 copied from the Vector2
  82068. * @returns a new Vector2
  82069. */
  82070. clone(): Vector2;
  82071. /**
  82072. * Gets a new Vector2(0, 0)
  82073. * @returns a new Vector2
  82074. */
  82075. static Zero(): Vector2;
  82076. /**
  82077. * Gets a new Vector2(1, 1)
  82078. * @returns a new Vector2
  82079. */
  82080. static One(): Vector2;
  82081. /**
  82082. * Gets a new Vector2 set from the given index element of the given array
  82083. * @param array defines the data source
  82084. * @param offset defines the offset in the data source
  82085. * @returns a new Vector2
  82086. */
  82087. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector2;
  82088. /**
  82089. * Sets "result" from the given index element of the given array
  82090. * @param array defines the data source
  82091. * @param offset defines the offset in the data source
  82092. * @param result defines the target vector
  82093. */
  82094. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector2): void;
  82095. /**
  82096. * Gets a new Vector2 located for "amount" (float) on the CatmullRom spline defined by the given four Vector2
  82097. * @param value1 defines 1st point of control
  82098. * @param value2 defines 2nd point of control
  82099. * @param value3 defines 3rd point of control
  82100. * @param value4 defines 4th point of control
  82101. * @param amount defines the interpolation factor
  82102. * @returns a new Vector2
  82103. */
  82104. static CatmullRom(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, value3: DeepImmutable<Vector2>, value4: DeepImmutable<Vector2>, amount: number): Vector2;
  82105. /**
  82106. * 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".
  82107. * If a coordinate of "value" is lower than "min" coordinates, the returned Vector2 is given this "min" coordinate.
  82108. * If a coordinate of "value" is greater than "max" coordinates, the returned Vector2 is given this "max" coordinate
  82109. * @param value defines the value to clamp
  82110. * @param min defines the lower limit
  82111. * @param max defines the upper limit
  82112. * @returns a new Vector2
  82113. */
  82114. static Clamp(value: DeepImmutable<Vector2>, min: DeepImmutable<Vector2>, max: DeepImmutable<Vector2>): Vector2;
  82115. /**
  82116. * Returns a new Vector2 located for "amount" (float) on the Hermite spline defined by the vectors "value1", "value3", "tangent1", "tangent2"
  82117. * @param value1 defines the 1st control point
  82118. * @param tangent1 defines the outgoing tangent
  82119. * @param value2 defines the 2nd control point
  82120. * @param tangent2 defines the incoming tangent
  82121. * @param amount defines the interpolation factor
  82122. * @returns a new Vector2
  82123. */
  82124. static Hermite(value1: DeepImmutable<Vector2>, tangent1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, tangent2: DeepImmutable<Vector2>, amount: number): Vector2;
  82125. /**
  82126. * Returns a new Vector2 located for "amount" (float) on the linear interpolation between the vector "start" adn the vector "end".
  82127. * @param start defines the start vector
  82128. * @param end defines the end vector
  82129. * @param amount defines the interpolation factor
  82130. * @returns a new Vector2
  82131. */
  82132. static Lerp(start: DeepImmutable<Vector2>, end: DeepImmutable<Vector2>, amount: number): Vector2;
  82133. /**
  82134. * Gets the dot product of the vector "left" and the vector "right"
  82135. * @param left defines first vector
  82136. * @param right defines second vector
  82137. * @returns the dot product (float)
  82138. */
  82139. static Dot(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): number;
  82140. /**
  82141. * Returns a new Vector2 equal to the normalized given vector
  82142. * @param vector defines the vector to normalize
  82143. * @returns a new Vector2
  82144. */
  82145. static Normalize(vector: DeepImmutable<Vector2>): Vector2;
  82146. /**
  82147. * Gets a new Vector2 set with the minimal coordinate values from the "left" and "right" vectors
  82148. * @param left defines 1st vector
  82149. * @param right defines 2nd vector
  82150. * @returns a new Vector2
  82151. */
  82152. static Minimize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  82153. /**
  82154. * Gets a new Vecto2 set with the maximal coordinate values from the "left" and "right" vectors
  82155. * @param left defines 1st vector
  82156. * @param right defines 2nd vector
  82157. * @returns a new Vector2
  82158. */
  82159. static Maximize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  82160. /**
  82161. * Gets a new Vector2 set with the transformed coordinates of the given vector by the given transformation matrix
  82162. * @param vector defines the vector to transform
  82163. * @param transformation defines the matrix to apply
  82164. * @returns a new Vector2
  82165. */
  82166. static Transform(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>): Vector2;
  82167. /**
  82168. * Transforms the given vector coordinates by the given transformation matrix and stores the result in the vector "result" coordinates
  82169. * @param vector defines the vector to transform
  82170. * @param transformation defines the matrix to apply
  82171. * @param result defines the target vector
  82172. */
  82173. static TransformToRef(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>, result: Vector2): void;
  82174. /**
  82175. * Determines if a given vector is included in a triangle
  82176. * @param p defines the vector to test
  82177. * @param p0 defines 1st triangle point
  82178. * @param p1 defines 2nd triangle point
  82179. * @param p2 defines 3rd triangle point
  82180. * @returns true if the point "p" is in the triangle defined by the vertors "p0", "p1", "p2"
  82181. */
  82182. static PointInTriangle(p: DeepImmutable<Vector2>, p0: DeepImmutable<Vector2>, p1: DeepImmutable<Vector2>, p2: DeepImmutable<Vector2>): boolean;
  82183. /**
  82184. * Gets the distance between the vectors "value1" and "value2"
  82185. * @param value1 defines first vector
  82186. * @param value2 defines second vector
  82187. * @returns the distance between vectors
  82188. */
  82189. static Distance(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  82190. /**
  82191. * Returns the squared distance between the vectors "value1" and "value2"
  82192. * @param value1 defines first vector
  82193. * @param value2 defines second vector
  82194. * @returns the squared distance between vectors
  82195. */
  82196. static DistanceSquared(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  82197. /**
  82198. * Gets a new Vector2 located at the center of the vectors "value1" and "value2"
  82199. * @param value1 defines first vector
  82200. * @param value2 defines second vector
  82201. * @returns a new Vector2
  82202. */
  82203. static Center(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): Vector2;
  82204. /**
  82205. * Gets the shortest distance (float) between the point "p" and the segment defined by the two points "segA" and "segB".
  82206. * @param p defines the middle point
  82207. * @param segA defines one point of the segment
  82208. * @param segB defines the other point of the segment
  82209. * @returns the shortest distance
  82210. */
  82211. static DistanceOfPointFromSegment(p: DeepImmutable<Vector2>, segA: DeepImmutable<Vector2>, segB: DeepImmutable<Vector2>): number;
  82212. }
  82213. /**
  82214. * Class used to store (x,y,z) vector representation
  82215. * A Vector3 is the main object used in 3D geometry
  82216. * It can represent etiher the coordinates of a point the space, either a direction
  82217. * Reminder: js uses a left handed forward facing system
  82218. */
  82219. export class Vector3 {
  82220. private static _UpReadOnly;
  82221. private static _ZeroReadOnly;
  82222. /** @hidden */
  82223. _x: number;
  82224. /** @hidden */
  82225. _y: number;
  82226. /** @hidden */
  82227. _z: number;
  82228. /** @hidden */
  82229. _isDirty: boolean;
  82230. /** Gets or sets the x coordinate */
  82231. get x(): number;
  82232. set x(value: number);
  82233. /** Gets or sets the y coordinate */
  82234. get y(): number;
  82235. set y(value: number);
  82236. /** Gets or sets the z coordinate */
  82237. get z(): number;
  82238. set z(value: number);
  82239. /**
  82240. * Creates a new Vector3 object from the given x, y, z (floats) coordinates.
  82241. * @param x defines the first coordinates (on X axis)
  82242. * @param y defines the second coordinates (on Y axis)
  82243. * @param z defines the third coordinates (on Z axis)
  82244. */
  82245. constructor(x?: number, y?: number, z?: number);
  82246. /**
  82247. * Creates a string representation of the Vector3
  82248. * @returns a string with the Vector3 coordinates.
  82249. */
  82250. toString(): string;
  82251. /**
  82252. * Gets the class name
  82253. * @returns the string "Vector3"
  82254. */
  82255. getClassName(): string;
  82256. /**
  82257. * Creates the Vector3 hash code
  82258. * @returns a number which tends to be unique between Vector3 instances
  82259. */
  82260. getHashCode(): number;
  82261. /**
  82262. * Creates an array containing three elements : the coordinates of the Vector3
  82263. * @returns a new array of numbers
  82264. */
  82265. asArray(): number[];
  82266. /**
  82267. * Populates the given array or Float32Array from the given index with the successive coordinates of the Vector3
  82268. * @param array defines the destination array
  82269. * @param index defines the offset in the destination array
  82270. * @returns the current Vector3
  82271. */
  82272. toArray(array: FloatArray, index?: number): Vector3;
  82273. /**
  82274. * Update the current vector from an array
  82275. * @param array defines the destination array
  82276. * @param index defines the offset in the destination array
  82277. * @returns the current Vector3
  82278. */
  82279. fromArray(array: FloatArray, index?: number): Vector3;
  82280. /**
  82281. * Converts the current Vector3 into a quaternion (considering that the Vector3 contains Euler angles representation of a rotation)
  82282. * @returns a new Quaternion object, computed from the Vector3 coordinates
  82283. */
  82284. toQuaternion(): Quaternion;
  82285. /**
  82286. * Adds the given vector to the current Vector3
  82287. * @param otherVector defines the second operand
  82288. * @returns the current updated Vector3
  82289. */
  82290. addInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  82291. /**
  82292. * Adds the given coordinates to the current Vector3
  82293. * @param x defines the x coordinate of the operand
  82294. * @param y defines the y coordinate of the operand
  82295. * @param z defines the z coordinate of the operand
  82296. * @returns the current updated Vector3
  82297. */
  82298. addInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  82299. /**
  82300. * Gets a new Vector3, result of the addition the current Vector3 and the given vector
  82301. * @param otherVector defines the second operand
  82302. * @returns the resulting Vector3
  82303. */
  82304. add(otherVector: DeepImmutable<Vector3>): Vector3;
  82305. /**
  82306. * Adds the current Vector3 to the given one and stores the result in the vector "result"
  82307. * @param otherVector defines the second operand
  82308. * @param result defines the Vector3 object where to store the result
  82309. * @returns the current Vector3
  82310. */
  82311. addToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  82312. /**
  82313. * Subtract the given vector from the current Vector3
  82314. * @param otherVector defines the second operand
  82315. * @returns the current updated Vector3
  82316. */
  82317. subtractInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  82318. /**
  82319. * Returns a new Vector3, result of the subtraction of the given vector from the current Vector3
  82320. * @param otherVector defines the second operand
  82321. * @returns the resulting Vector3
  82322. */
  82323. subtract(otherVector: DeepImmutable<Vector3>): Vector3;
  82324. /**
  82325. * Subtracts the given vector from the current Vector3 and stores the result in the vector "result".
  82326. * @param otherVector defines the second operand
  82327. * @param result defines the Vector3 object where to store the result
  82328. * @returns the current Vector3
  82329. */
  82330. subtractToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  82331. /**
  82332. * Returns a new Vector3 set with the subtraction of the given floats from the current Vector3 coordinates
  82333. * @param x defines the x coordinate of the operand
  82334. * @param y defines the y coordinate of the operand
  82335. * @param z defines the z coordinate of the operand
  82336. * @returns the resulting Vector3
  82337. */
  82338. subtractFromFloats(x: number, y: number, z: number): Vector3;
  82339. /**
  82340. * Subtracts the given floats from the current Vector3 coordinates and set the given vector "result" with this result
  82341. * @param x defines the x coordinate of the operand
  82342. * @param y defines the y coordinate of the operand
  82343. * @param z defines the z coordinate of the operand
  82344. * @param result defines the Vector3 object where to store the result
  82345. * @returns the current Vector3
  82346. */
  82347. subtractFromFloatsToRef(x: number, y: number, z: number, result: Vector3): Vector3;
  82348. /**
  82349. * Gets a new Vector3 set with the current Vector3 negated coordinates
  82350. * @returns a new Vector3
  82351. */
  82352. negate(): Vector3;
  82353. /**
  82354. * Negate this vector in place
  82355. * @returns this
  82356. */
  82357. negateInPlace(): Vector3;
  82358. /**
  82359. * Negate the current Vector3 and stores the result in the given vector "result" coordinates
  82360. * @param result defines the Vector3 object where to store the result
  82361. * @returns the current Vector3
  82362. */
  82363. negateToRef(result: Vector3): Vector3;
  82364. /**
  82365. * Multiplies the Vector3 coordinates by the float "scale"
  82366. * @param scale defines the multiplier factor
  82367. * @returns the current updated Vector3
  82368. */
  82369. scaleInPlace(scale: number): Vector3;
  82370. /**
  82371. * Returns a new Vector3 set with the current Vector3 coordinates multiplied by the float "scale"
  82372. * @param scale defines the multiplier factor
  82373. * @returns a new Vector3
  82374. */
  82375. scale(scale: number): Vector3;
  82376. /**
  82377. * Multiplies the current Vector3 coordinates by the float "scale" and stores the result in the given vector "result" coordinates
  82378. * @param scale defines the multiplier factor
  82379. * @param result defines the Vector3 object where to store the result
  82380. * @returns the current Vector3
  82381. */
  82382. scaleToRef(scale: number, result: Vector3): Vector3;
  82383. /**
  82384. * Scale the current Vector3 values by a factor and add the result to a given Vector3
  82385. * @param scale defines the scale factor
  82386. * @param result defines the Vector3 object where to store the result
  82387. * @returns the unmodified current Vector3
  82388. */
  82389. scaleAndAddToRef(scale: number, result: Vector3): Vector3;
  82390. /**
  82391. * Projects the current vector3 to a plane along a ray starting from a specified origin and directed towards the point.
  82392. * @param origin defines the origin of the projection ray
  82393. * @param plane defines the plane to project to
  82394. * @returns the projected vector3
  82395. */
  82396. projectOnPlane(plane: Plane, origin: Vector3): Vector3;
  82397. /**
  82398. * Projects the current vector3 to a plane along a ray starting from a specified origin and directed towards the point.
  82399. * @param origin defines the origin of the projection ray
  82400. * @param plane defines the plane to project to
  82401. * @param result defines the Vector3 where to store the result
  82402. */
  82403. projectOnPlaneToRef(plane: Plane, origin: Vector3, result: Vector3): void;
  82404. /**
  82405. * Returns true if the current Vector3 and the given vector coordinates are strictly equal
  82406. * @param otherVector defines the second operand
  82407. * @returns true if both vectors are equals
  82408. */
  82409. equals(otherVector: DeepImmutable<Vector3>): boolean;
  82410. /**
  82411. * Returns true if the current Vector3 and the given vector coordinates are distant less than epsilon
  82412. * @param otherVector defines the second operand
  82413. * @param epsilon defines the minimal distance to define values as equals
  82414. * @returns true if both vectors are distant less than epsilon
  82415. */
  82416. equalsWithEpsilon(otherVector: DeepImmutable<Vector3>, epsilon?: number): boolean;
  82417. /**
  82418. * Returns true if the current Vector3 coordinates equals the given floats
  82419. * @param x defines the x coordinate of the operand
  82420. * @param y defines the y coordinate of the operand
  82421. * @param z defines the z coordinate of the operand
  82422. * @returns true if both vectors are equals
  82423. */
  82424. equalsToFloats(x: number, y: number, z: number): boolean;
  82425. /**
  82426. * Multiplies the current Vector3 coordinates by the given ones
  82427. * @param otherVector defines the second operand
  82428. * @returns the current updated Vector3
  82429. */
  82430. multiplyInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  82431. /**
  82432. * Returns a new Vector3, result of the multiplication of the current Vector3 by the given vector
  82433. * @param otherVector defines the second operand
  82434. * @returns the new Vector3
  82435. */
  82436. multiply(otherVector: DeepImmutable<Vector3>): Vector3;
  82437. /**
  82438. * Multiplies the current Vector3 by the given one and stores the result in the given vector "result"
  82439. * @param otherVector defines the second operand
  82440. * @param result defines the Vector3 object where to store the result
  82441. * @returns the current Vector3
  82442. */
  82443. multiplyToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  82444. /**
  82445. * Returns a new Vector3 set with the result of the mulliplication of the current Vector3 coordinates by the given floats
  82446. * @param x defines the x coordinate of the operand
  82447. * @param y defines the y coordinate of the operand
  82448. * @param z defines the z coordinate of the operand
  82449. * @returns the new Vector3
  82450. */
  82451. multiplyByFloats(x: number, y: number, z: number): Vector3;
  82452. /**
  82453. * Returns a new Vector3 set with the result of the division of the current Vector3 coordinates by the given ones
  82454. * @param otherVector defines the second operand
  82455. * @returns the new Vector3
  82456. */
  82457. divide(otherVector: DeepImmutable<Vector3>): Vector3;
  82458. /**
  82459. * Divides the current Vector3 coordinates by the given ones and stores the result in the given vector "result"
  82460. * @param otherVector defines the second operand
  82461. * @param result defines the Vector3 object where to store the result
  82462. * @returns the current Vector3
  82463. */
  82464. divideToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  82465. /**
  82466. * Divides the current Vector3 coordinates by the given ones.
  82467. * @param otherVector defines the second operand
  82468. * @returns the current updated Vector3
  82469. */
  82470. divideInPlace(otherVector: Vector3): Vector3;
  82471. /**
  82472. * Updates the current Vector3 with the minimal coordinate values between its and the given vector ones
  82473. * @param other defines the second operand
  82474. * @returns the current updated Vector3
  82475. */
  82476. minimizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  82477. /**
  82478. * Updates the current Vector3 with the maximal coordinate values between its and the given vector ones.
  82479. * @param other defines the second operand
  82480. * @returns the current updated Vector3
  82481. */
  82482. maximizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  82483. /**
  82484. * Updates the current Vector3 with the minimal coordinate values between its and the given coordinates
  82485. * @param x defines the x coordinate of the operand
  82486. * @param y defines the y coordinate of the operand
  82487. * @param z defines the z coordinate of the operand
  82488. * @returns the current updated Vector3
  82489. */
  82490. minimizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  82491. /**
  82492. * Updates the current Vector3 with the maximal coordinate values between its and the given coordinates.
  82493. * @param x defines the x coordinate of the operand
  82494. * @param y defines the y coordinate of the operand
  82495. * @param z defines the z coordinate of the operand
  82496. * @returns the current updated Vector3
  82497. */
  82498. maximizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  82499. /**
  82500. * Due to float precision, scale of a mesh could be uniform but float values are off by a small fraction
  82501. * Check if is non uniform within a certain amount of decimal places to account for this
  82502. * @param epsilon the amount the values can differ
  82503. * @returns if the the vector is non uniform to a certain number of decimal places
  82504. */
  82505. isNonUniformWithinEpsilon(epsilon: number): boolean;
  82506. /**
  82507. * Gets a boolean indicating that the vector is non uniform meaning x, y or z are not all the same
  82508. */
  82509. get isNonUniform(): boolean;
  82510. /**
  82511. * Gets a new Vector3 from current Vector3 floored values
  82512. * @returns a new Vector3
  82513. */
  82514. floor(): Vector3;
  82515. /**
  82516. * Gets a new Vector3 from current Vector3 floored values
  82517. * @returns a new Vector3
  82518. */
  82519. fract(): Vector3;
  82520. /**
  82521. * Gets the length of the Vector3
  82522. * @returns the length of the Vector3
  82523. */
  82524. length(): number;
  82525. /**
  82526. * Gets the squared length of the Vector3
  82527. * @returns squared length of the Vector3
  82528. */
  82529. lengthSquared(): number;
  82530. /**
  82531. * Normalize the current Vector3.
  82532. * Please note that this is an in place operation.
  82533. * @returns the current updated Vector3
  82534. */
  82535. normalize(): Vector3;
  82536. /**
  82537. * Reorders the x y z properties of the vector in place
  82538. * @param order new ordering of the properties (eg. for vector 1,2,3 with "ZYX" will produce 3,2,1)
  82539. * @returns the current updated vector
  82540. */
  82541. reorderInPlace(order: string): this;
  82542. /**
  82543. * Rotates the vector around 0,0,0 by a quaternion
  82544. * @param quaternion the rotation quaternion
  82545. * @param result vector to store the result
  82546. * @returns the resulting vector
  82547. */
  82548. rotateByQuaternionToRef(quaternion: Quaternion, result: Vector3): Vector3;
  82549. /**
  82550. * Rotates a vector around a given point
  82551. * @param quaternion the rotation quaternion
  82552. * @param point the point to rotate around
  82553. * @param result vector to store the result
  82554. * @returns the resulting vector
  82555. */
  82556. rotateByQuaternionAroundPointToRef(quaternion: Quaternion, point: Vector3, result: Vector3): Vector3;
  82557. /**
  82558. * Returns a new Vector3 as the cross product of the current vector and the "other" one
  82559. * The cross product is then orthogonal to both current and "other"
  82560. * @param other defines the right operand
  82561. * @returns the cross product
  82562. */
  82563. cross(other: Vector3): Vector3;
  82564. /**
  82565. * Normalize the current Vector3 with the given input length.
  82566. * Please note that this is an in place operation.
  82567. * @param len the length of the vector
  82568. * @returns the current updated Vector3
  82569. */
  82570. normalizeFromLength(len: number): Vector3;
  82571. /**
  82572. * Normalize the current Vector3 to a new vector
  82573. * @returns the new Vector3
  82574. */
  82575. normalizeToNew(): Vector3;
  82576. /**
  82577. * Normalize the current Vector3 to the reference
  82578. * @param reference define the Vector3 to update
  82579. * @returns the updated Vector3
  82580. */
  82581. normalizeToRef(reference: Vector3): Vector3;
  82582. /**
  82583. * Creates a new Vector3 copied from the current Vector3
  82584. * @returns the new Vector3
  82585. */
  82586. clone(): Vector3;
  82587. /**
  82588. * Copies the given vector coordinates to the current Vector3 ones
  82589. * @param source defines the source Vector3
  82590. * @returns the current updated Vector3
  82591. */
  82592. copyFrom(source: DeepImmutable<Vector3>): Vector3;
  82593. /**
  82594. * Copies the given floats to the current Vector3 coordinates
  82595. * @param x defines the x coordinate of the operand
  82596. * @param y defines the y coordinate of the operand
  82597. * @param z defines the z coordinate of the operand
  82598. * @returns the current updated Vector3
  82599. */
  82600. copyFromFloats(x: number, y: number, z: number): Vector3;
  82601. /**
  82602. * Copies the given floats to the current Vector3 coordinates
  82603. * @param x defines the x coordinate of the operand
  82604. * @param y defines the y coordinate of the operand
  82605. * @param z defines the z coordinate of the operand
  82606. * @returns the current updated Vector3
  82607. */
  82608. set(x: number, y: number, z: number): Vector3;
  82609. /**
  82610. * Copies the given float to the current Vector3 coordinates
  82611. * @param v defines the x, y and z coordinates of the operand
  82612. * @returns the current updated Vector3
  82613. */
  82614. setAll(v: number): Vector3;
  82615. /**
  82616. * Get the clip factor between two vectors
  82617. * @param vector0 defines the first operand
  82618. * @param vector1 defines the second operand
  82619. * @param axis defines the axis to use
  82620. * @param size defines the size along the axis
  82621. * @returns the clip factor
  82622. */
  82623. static GetClipFactor(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, axis: DeepImmutable<Vector3>, size: number): number;
  82624. /**
  82625. * Get angle between two vectors
  82626. * @param vector0 angle between vector0 and vector1
  82627. * @param vector1 angle between vector0 and vector1
  82628. * @param normal direction of the normal
  82629. * @return the angle between vector0 and vector1
  82630. */
  82631. static GetAngleBetweenVectors(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>): number;
  82632. /**
  82633. * Returns a new Vector3 set from the index "offset" of the given array
  82634. * @param array defines the source array
  82635. * @param offset defines the offset in the source array
  82636. * @returns the new Vector3
  82637. */
  82638. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector3;
  82639. /**
  82640. * Returns a new Vector3 set from the index "offset" of the given Float32Array
  82641. * @param array defines the source array
  82642. * @param offset defines the offset in the source array
  82643. * @returns the new Vector3
  82644. * @deprecated Please use FromArray instead.
  82645. */
  82646. static FromFloatArray(array: DeepImmutable<Float32Array>, offset?: number): Vector3;
  82647. /**
  82648. * Sets the given vector "result" with the element values from the index "offset" of the given array
  82649. * @param array defines the source array
  82650. * @param offset defines the offset in the source array
  82651. * @param result defines the Vector3 where to store the result
  82652. */
  82653. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector3): void;
  82654. /**
  82655. * Sets the given vector "result" with the element values from the index "offset" of the given Float32Array
  82656. * @param array defines the source array
  82657. * @param offset defines the offset in the source array
  82658. * @param result defines the Vector3 where to store the result
  82659. * @deprecated Please use FromArrayToRef instead.
  82660. */
  82661. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector3): void;
  82662. /**
  82663. * Sets the given vector "result" with the given floats.
  82664. * @param x defines the x coordinate of the source
  82665. * @param y defines the y coordinate of the source
  82666. * @param z defines the z coordinate of the source
  82667. * @param result defines the Vector3 where to store the result
  82668. */
  82669. static FromFloatsToRef(x: number, y: number, z: number, result: Vector3): void;
  82670. /**
  82671. * Returns a new Vector3 set to (0.0, 0.0, 0.0)
  82672. * @returns a new empty Vector3
  82673. */
  82674. static Zero(): Vector3;
  82675. /**
  82676. * Returns a new Vector3 set to (1.0, 1.0, 1.0)
  82677. * @returns a new unit Vector3
  82678. */
  82679. static One(): Vector3;
  82680. /**
  82681. * Returns a new Vector3 set to (0.0, 1.0, 0.0)
  82682. * @returns a new up Vector3
  82683. */
  82684. static Up(): Vector3;
  82685. /**
  82686. * Gets a up Vector3 that must not be updated
  82687. */
  82688. static get UpReadOnly(): DeepImmutable<Vector3>;
  82689. /**
  82690. * Gets a zero Vector3 that must not be updated
  82691. */
  82692. static get ZeroReadOnly(): DeepImmutable<Vector3>;
  82693. /**
  82694. * Returns a new Vector3 set to (0.0, -1.0, 0.0)
  82695. * @returns a new down Vector3
  82696. */
  82697. static Down(): Vector3;
  82698. /**
  82699. * Returns a new Vector3 set to (0.0, 0.0, 1.0)
  82700. * @param rightHandedSystem is the scene right-handed (negative z)
  82701. * @returns a new forward Vector3
  82702. */
  82703. static Forward(rightHandedSystem?: boolean): Vector3;
  82704. /**
  82705. * Returns a new Vector3 set to (0.0, 0.0, -1.0)
  82706. * @param rightHandedSystem is the scene right-handed (negative-z)
  82707. * @returns a new forward Vector3
  82708. */
  82709. static Backward(rightHandedSystem?: boolean): Vector3;
  82710. /**
  82711. * Returns a new Vector3 set to (1.0, 0.0, 0.0)
  82712. * @returns a new right Vector3
  82713. */
  82714. static Right(): Vector3;
  82715. /**
  82716. * Returns a new Vector3 set to (-1.0, 0.0, 0.0)
  82717. * @returns a new left Vector3
  82718. */
  82719. static Left(): Vector3;
  82720. /**
  82721. * Returns a new Vector3 set with the result of the transformation by the given matrix of the given vector.
  82722. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  82723. * @param vector defines the Vector3 to transform
  82724. * @param transformation defines the transformation matrix
  82725. * @returns the transformed Vector3
  82726. */
  82727. static TransformCoordinates(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  82728. /**
  82729. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given vector
  82730. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  82731. * @param vector defines the Vector3 to transform
  82732. * @param transformation defines the transformation matrix
  82733. * @param result defines the Vector3 where to store the result
  82734. */
  82735. static TransformCoordinatesToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  82736. /**
  82737. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given floats (x, y, z)
  82738. * This method computes tranformed coordinates only, not transformed direction vectors
  82739. * @param x define the x coordinate of the source vector
  82740. * @param y define the y coordinate of the source vector
  82741. * @param z define the z coordinate of the source vector
  82742. * @param transformation defines the transformation matrix
  82743. * @param result defines the Vector3 where to store the result
  82744. */
  82745. static TransformCoordinatesFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  82746. /**
  82747. * Returns a new Vector3 set with the result of the normal transformation by the given matrix of the given vector
  82748. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  82749. * @param vector defines the Vector3 to transform
  82750. * @param transformation defines the transformation matrix
  82751. * @returns the new Vector3
  82752. */
  82753. static TransformNormal(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  82754. /**
  82755. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector
  82756. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  82757. * @param vector defines the Vector3 to transform
  82758. * @param transformation defines the transformation matrix
  82759. * @param result defines the Vector3 where to store the result
  82760. */
  82761. static TransformNormalToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  82762. /**
  82763. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z)
  82764. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  82765. * @param x define the x coordinate of the source vector
  82766. * @param y define the y coordinate of the source vector
  82767. * @param z define the z coordinate of the source vector
  82768. * @param transformation defines the transformation matrix
  82769. * @param result defines the Vector3 where to store the result
  82770. */
  82771. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  82772. /**
  82773. * Returns a new Vector3 located for "amount" on the CatmullRom interpolation spline defined by the vectors "value1", "value2", "value3", "value4"
  82774. * @param value1 defines the first control point
  82775. * @param value2 defines the second control point
  82776. * @param value3 defines the third control point
  82777. * @param value4 defines the fourth control point
  82778. * @param amount defines the amount on the spline to use
  82779. * @returns the new Vector3
  82780. */
  82781. static CatmullRom(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, value3: DeepImmutable<Vector3>, value4: DeepImmutable<Vector3>, amount: number): Vector3;
  82782. /**
  82783. * 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"
  82784. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  82785. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  82786. * @param value defines the current value
  82787. * @param min defines the lower range value
  82788. * @param max defines the upper range value
  82789. * @returns the new Vector3
  82790. */
  82791. static Clamp(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): Vector3;
  82792. /**
  82793. * 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"
  82794. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  82795. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  82796. * @param value defines the current value
  82797. * @param min defines the lower range value
  82798. * @param max defines the upper range value
  82799. * @param result defines the Vector3 where to store the result
  82800. */
  82801. static ClampToRef(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, result: Vector3): void;
  82802. /**
  82803. * Checks if a given vector is inside a specific range
  82804. * @param v defines the vector to test
  82805. * @param min defines the minimum range
  82806. * @param max defines the maximum range
  82807. */
  82808. static CheckExtends(v: Vector3, min: Vector3, max: Vector3): void;
  82809. /**
  82810. * Returns a new Vector3 located for "amount" (float) on the Hermite interpolation spline defined by the vectors "value1", "tangent1", "value2", "tangent2"
  82811. * @param value1 defines the first control point
  82812. * @param tangent1 defines the first tangent vector
  82813. * @param value2 defines the second control point
  82814. * @param tangent2 defines the second tangent vector
  82815. * @param amount defines the amount on the interpolation spline (between 0 and 1)
  82816. * @returns the new Vector3
  82817. */
  82818. static Hermite(value1: DeepImmutable<Vector3>, tangent1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, tangent2: DeepImmutable<Vector3>, amount: number): Vector3;
  82819. /**
  82820. * Returns a new Vector3 located for "amount" (float) on the linear interpolation between the vectors "start" and "end"
  82821. * @param start defines the start value
  82822. * @param end defines the end value
  82823. * @param amount max defines amount between both (between 0 and 1)
  82824. * @returns the new Vector3
  82825. */
  82826. static Lerp(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number): Vector3;
  82827. /**
  82828. * Sets the given vector "result" with the result of the linear interpolation from the vector "start" for "amount" to the vector "end"
  82829. * @param start defines the start value
  82830. * @param end defines the end value
  82831. * @param amount max defines amount between both (between 0 and 1)
  82832. * @param result defines the Vector3 where to store the result
  82833. */
  82834. static LerpToRef(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number, result: Vector3): void;
  82835. /**
  82836. * Returns the dot product (float) between the vectors "left" and "right"
  82837. * @param left defines the left operand
  82838. * @param right defines the right operand
  82839. * @returns the dot product
  82840. */
  82841. static Dot(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): number;
  82842. /**
  82843. * Returns a new Vector3 as the cross product of the vectors "left" and "right"
  82844. * The cross product is then orthogonal to both "left" and "right"
  82845. * @param left defines the left operand
  82846. * @param right defines the right operand
  82847. * @returns the cross product
  82848. */
  82849. static Cross(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  82850. /**
  82851. * Sets the given vector "result" with the cross product of "left" and "right"
  82852. * The cross product is then orthogonal to both "left" and "right"
  82853. * @param left defines the left operand
  82854. * @param right defines the right operand
  82855. * @param result defines the Vector3 where to store the result
  82856. */
  82857. static CrossToRef(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>, result: Vector3): void;
  82858. /**
  82859. * Returns a new Vector3 as the normalization of the given vector
  82860. * @param vector defines the Vector3 to normalize
  82861. * @returns the new Vector3
  82862. */
  82863. static Normalize(vector: DeepImmutable<Vector3>): Vector3;
  82864. /**
  82865. * Sets the given vector "result" with the normalization of the given first vector
  82866. * @param vector defines the Vector3 to normalize
  82867. * @param result defines the Vector3 where to store the result
  82868. */
  82869. static NormalizeToRef(vector: DeepImmutable<Vector3>, result: Vector3): void;
  82870. /**
  82871. * Project a Vector3 onto screen space
  82872. * @param vector defines the Vector3 to project
  82873. * @param world defines the world matrix to use
  82874. * @param transform defines the transform (view x projection) matrix to use
  82875. * @param viewport defines the screen viewport to use
  82876. * @returns the new Vector3
  82877. */
  82878. static Project(vector: DeepImmutable<Vector3>, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>, viewport: DeepImmutable<Viewport>): Vector3;
  82879. /** @hidden */
  82880. static _UnprojectFromInvertedMatrixToRef(source: DeepImmutable<Vector3>, matrix: DeepImmutable<Matrix>, result: Vector3): void;
  82881. /**
  82882. * Unproject from screen space to object space
  82883. * @param source defines the screen space Vector3 to use
  82884. * @param viewportWidth defines the current width of the viewport
  82885. * @param viewportHeight defines the current height of the viewport
  82886. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  82887. * @param transform defines the transform (view x projection) matrix to use
  82888. * @returns the new Vector3
  82889. */
  82890. static UnprojectFromTransform(source: Vector3, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>): Vector3;
  82891. /**
  82892. * Unproject from screen space to object space
  82893. * @param source defines the screen space Vector3 to use
  82894. * @param viewportWidth defines the current width of the viewport
  82895. * @param viewportHeight defines the current height of the viewport
  82896. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  82897. * @param view defines the view matrix to use
  82898. * @param projection defines the projection matrix to use
  82899. * @returns the new Vector3
  82900. */
  82901. static Unproject(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Vector3;
  82902. /**
  82903. * Unproject from screen space to object space
  82904. * @param source defines the screen space Vector3 to use
  82905. * @param viewportWidth defines the current width of the viewport
  82906. * @param viewportHeight defines the current height of the viewport
  82907. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  82908. * @param view defines the view matrix to use
  82909. * @param projection defines the projection matrix to use
  82910. * @param result defines the Vector3 where to store the result
  82911. */
  82912. static UnprojectToRef(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  82913. /**
  82914. * Unproject from screen space to object space
  82915. * @param sourceX defines the screen space x coordinate to use
  82916. * @param sourceY defines the screen space y coordinate to use
  82917. * @param sourceZ defines the screen space z coordinate to use
  82918. * @param viewportWidth defines the current width of the viewport
  82919. * @param viewportHeight defines the current height of the viewport
  82920. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  82921. * @param view defines the view matrix to use
  82922. * @param projection defines the projection matrix to use
  82923. * @param result defines the Vector3 where to store the result
  82924. */
  82925. static UnprojectFloatsToRef(sourceX: float, sourceY: float, sourceZ: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  82926. /**
  82927. * Gets the minimal coordinate values between two Vector3
  82928. * @param left defines the first operand
  82929. * @param right defines the second operand
  82930. * @returns the new Vector3
  82931. */
  82932. static Minimize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  82933. /**
  82934. * Gets the maximal coordinate values between two Vector3
  82935. * @param left defines the first operand
  82936. * @param right defines the second operand
  82937. * @returns the new Vector3
  82938. */
  82939. static Maximize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  82940. /**
  82941. * Returns the distance between the vectors "value1" and "value2"
  82942. * @param value1 defines the first operand
  82943. * @param value2 defines the second operand
  82944. * @returns the distance
  82945. */
  82946. static Distance(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  82947. /**
  82948. * Returns the squared distance between the vectors "value1" and "value2"
  82949. * @param value1 defines the first operand
  82950. * @param value2 defines the second operand
  82951. * @returns the squared distance
  82952. */
  82953. static DistanceSquared(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  82954. /**
  82955. * Returns a new Vector3 located at the center between "value1" and "value2"
  82956. * @param value1 defines the first operand
  82957. * @param value2 defines the second operand
  82958. * @returns the new Vector3
  82959. */
  82960. static Center(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): Vector3;
  82961. /**
  82962. * Given three orthogonal normalized left-handed oriented Vector3 axis in space (target system),
  82963. * RotationFromAxis() returns the rotation Euler angles (ex : rotation.x, rotation.y, rotation.z) to apply
  82964. * to something in order to rotate it from its local system to the given target system
  82965. * Note: axis1, axis2 and axis3 are normalized during this operation
  82966. * @param axis1 defines the first axis
  82967. * @param axis2 defines the second axis
  82968. * @param axis3 defines the third axis
  82969. * @returns a new Vector3
  82970. */
  82971. static RotationFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Vector3;
  82972. /**
  82973. * The same than RotationFromAxis but updates the given ref Vector3 parameter instead of returning a new Vector3
  82974. * @param axis1 defines the first axis
  82975. * @param axis2 defines the second axis
  82976. * @param axis3 defines the third axis
  82977. * @param ref defines the Vector3 where to store the result
  82978. */
  82979. static RotationFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Vector3): void;
  82980. }
  82981. /**
  82982. * Vector4 class created for EulerAngle class conversion to Quaternion
  82983. */
  82984. export class Vector4 {
  82985. /** x value of the vector */
  82986. x: number;
  82987. /** y value of the vector */
  82988. y: number;
  82989. /** z value of the vector */
  82990. z: number;
  82991. /** w value of the vector */
  82992. w: number;
  82993. /**
  82994. * Creates a Vector4 object from the given floats.
  82995. * @param x x value of the vector
  82996. * @param y y value of the vector
  82997. * @param z z value of the vector
  82998. * @param w w value of the vector
  82999. */
  83000. constructor(
  83001. /** x value of the vector */
  83002. x: number,
  83003. /** y value of the vector */
  83004. y: number,
  83005. /** z value of the vector */
  83006. z: number,
  83007. /** w value of the vector */
  83008. w: number);
  83009. /**
  83010. * Returns the string with the Vector4 coordinates.
  83011. * @returns a string containing all the vector values
  83012. */
  83013. toString(): string;
  83014. /**
  83015. * Returns the string "Vector4".
  83016. * @returns "Vector4"
  83017. */
  83018. getClassName(): string;
  83019. /**
  83020. * Returns the Vector4 hash code.
  83021. * @returns a unique hash code
  83022. */
  83023. getHashCode(): number;
  83024. /**
  83025. * Returns a new array populated with 4 elements : the Vector4 coordinates.
  83026. * @returns the resulting array
  83027. */
  83028. asArray(): number[];
  83029. /**
  83030. * Populates the given array from the given index with the Vector4 coordinates.
  83031. * @param array array to populate
  83032. * @param index index of the array to start at (default: 0)
  83033. * @returns the Vector4.
  83034. */
  83035. toArray(array: FloatArray, index?: number): Vector4;
  83036. /**
  83037. * Update the current vector from an array
  83038. * @param array defines the destination array
  83039. * @param index defines the offset in the destination array
  83040. * @returns the current Vector3
  83041. */
  83042. fromArray(array: FloatArray, index?: number): Vector4;
  83043. /**
  83044. * Adds the given vector to the current Vector4.
  83045. * @param otherVector the vector to add
  83046. * @returns the updated Vector4.
  83047. */
  83048. addInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  83049. /**
  83050. * Returns a new Vector4 as the result of the addition of the current Vector4 and the given one.
  83051. * @param otherVector the vector to add
  83052. * @returns the resulting vector
  83053. */
  83054. add(otherVector: DeepImmutable<Vector4>): Vector4;
  83055. /**
  83056. * Updates the given vector "result" with the result of the addition of the current Vector4 and the given one.
  83057. * @param otherVector the vector to add
  83058. * @param result the vector to store the result
  83059. * @returns the current Vector4.
  83060. */
  83061. addToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  83062. /**
  83063. * Subtract in place the given vector from the current Vector4.
  83064. * @param otherVector the vector to subtract
  83065. * @returns the updated Vector4.
  83066. */
  83067. subtractInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  83068. /**
  83069. * Returns a new Vector4 with the result of the subtraction of the given vector from the current Vector4.
  83070. * @param otherVector the vector to add
  83071. * @returns the new vector with the result
  83072. */
  83073. subtract(otherVector: DeepImmutable<Vector4>): Vector4;
  83074. /**
  83075. * Sets the given vector "result" with the result of the subtraction of the given vector from the current Vector4.
  83076. * @param otherVector the vector to subtract
  83077. * @param result the vector to store the result
  83078. * @returns the current Vector4.
  83079. */
  83080. subtractToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  83081. /**
  83082. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  83083. */
  83084. /**
  83085. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  83086. * @param x value to subtract
  83087. * @param y value to subtract
  83088. * @param z value to subtract
  83089. * @param w value to subtract
  83090. * @returns new vector containing the result
  83091. */
  83092. subtractFromFloats(x: number, y: number, z: number, w: number): Vector4;
  83093. /**
  83094. * Sets the given vector "result" set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  83095. * @param x value to subtract
  83096. * @param y value to subtract
  83097. * @param z value to subtract
  83098. * @param w value to subtract
  83099. * @param result the vector to store the result in
  83100. * @returns the current Vector4.
  83101. */
  83102. subtractFromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): Vector4;
  83103. /**
  83104. * Returns a new Vector4 set with the current Vector4 negated coordinates.
  83105. * @returns a new vector with the negated values
  83106. */
  83107. negate(): Vector4;
  83108. /**
  83109. * Negate this vector in place
  83110. * @returns this
  83111. */
  83112. negateInPlace(): Vector4;
  83113. /**
  83114. * Negate the current Vector4 and stores the result in the given vector "result" coordinates
  83115. * @param result defines the Vector3 object where to store the result
  83116. * @returns the current Vector4
  83117. */
  83118. negateToRef(result: Vector4): Vector4;
  83119. /**
  83120. * Multiplies the current Vector4 coordinates by scale (float).
  83121. * @param scale the number to scale with
  83122. * @returns the updated Vector4.
  83123. */
  83124. scaleInPlace(scale: number): Vector4;
  83125. /**
  83126. * Returns a new Vector4 set with the current Vector4 coordinates multiplied by scale (float).
  83127. * @param scale the number to scale with
  83128. * @returns a new vector with the result
  83129. */
  83130. scale(scale: number): Vector4;
  83131. /**
  83132. * Sets the given vector "result" with the current Vector4 coordinates multiplied by scale (float).
  83133. * @param scale the number to scale with
  83134. * @param result a vector to store the result in
  83135. * @returns the current Vector4.
  83136. */
  83137. scaleToRef(scale: number, result: Vector4): Vector4;
  83138. /**
  83139. * Scale the current Vector4 values by a factor and add the result to a given Vector4
  83140. * @param scale defines the scale factor
  83141. * @param result defines the Vector4 object where to store the result
  83142. * @returns the unmodified current Vector4
  83143. */
  83144. scaleAndAddToRef(scale: number, result: Vector4): Vector4;
  83145. /**
  83146. * Boolean : True if the current Vector4 coordinates are stricly equal to the given ones.
  83147. * @param otherVector the vector to compare against
  83148. * @returns true if they are equal
  83149. */
  83150. equals(otherVector: DeepImmutable<Vector4>): boolean;
  83151. /**
  83152. * Boolean : True if the current Vector4 coordinates are each beneath the distance "epsilon" from the given vector ones.
  83153. * @param otherVector vector to compare against
  83154. * @param epsilon (Default: very small number)
  83155. * @returns true if they are equal
  83156. */
  83157. equalsWithEpsilon(otherVector: DeepImmutable<Vector4>, epsilon?: number): boolean;
  83158. /**
  83159. * Boolean : True if the given floats are strictly equal to the current Vector4 coordinates.
  83160. * @param x x value to compare against
  83161. * @param y y value to compare against
  83162. * @param z z value to compare against
  83163. * @param w w value to compare against
  83164. * @returns true if equal
  83165. */
  83166. equalsToFloats(x: number, y: number, z: number, w: number): boolean;
  83167. /**
  83168. * Multiplies in place the current Vector4 by the given one.
  83169. * @param otherVector vector to multiple with
  83170. * @returns the updated Vector4.
  83171. */
  83172. multiplyInPlace(otherVector: Vector4): Vector4;
  83173. /**
  83174. * Returns a new Vector4 set with the multiplication result of the current Vector4 and the given one.
  83175. * @param otherVector vector to multiple with
  83176. * @returns resulting new vector
  83177. */
  83178. multiply(otherVector: DeepImmutable<Vector4>): Vector4;
  83179. /**
  83180. * Updates the given vector "result" with the multiplication result of the current Vector4 and the given one.
  83181. * @param otherVector vector to multiple with
  83182. * @param result vector to store the result
  83183. * @returns the current Vector4.
  83184. */
  83185. multiplyToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  83186. /**
  83187. * Returns a new Vector4 set with the multiplication result of the given floats and the current Vector4 coordinates.
  83188. * @param x x value multiply with
  83189. * @param y y value multiply with
  83190. * @param z z value multiply with
  83191. * @param w w value multiply with
  83192. * @returns resulting new vector
  83193. */
  83194. multiplyByFloats(x: number, y: number, z: number, w: number): Vector4;
  83195. /**
  83196. * Returns a new Vector4 set with the division result of the current Vector4 by the given one.
  83197. * @param otherVector vector to devide with
  83198. * @returns resulting new vector
  83199. */
  83200. divide(otherVector: DeepImmutable<Vector4>): Vector4;
  83201. /**
  83202. * Updates the given vector "result" with the division result of the current Vector4 by the given one.
  83203. * @param otherVector vector to devide with
  83204. * @param result vector to store the result
  83205. * @returns the current Vector4.
  83206. */
  83207. divideToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  83208. /**
  83209. * Divides the current Vector3 coordinates by the given ones.
  83210. * @param otherVector vector to devide with
  83211. * @returns the updated Vector3.
  83212. */
  83213. divideInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  83214. /**
  83215. * Updates the Vector4 coordinates with the minimum values between its own and the given vector ones
  83216. * @param other defines the second operand
  83217. * @returns the current updated Vector4
  83218. */
  83219. minimizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  83220. /**
  83221. * Updates the Vector4 coordinates with the maximum values between its own and the given vector ones
  83222. * @param other defines the second operand
  83223. * @returns the current updated Vector4
  83224. */
  83225. maximizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  83226. /**
  83227. * Gets a new Vector4 from current Vector4 floored values
  83228. * @returns a new Vector4
  83229. */
  83230. floor(): Vector4;
  83231. /**
  83232. * Gets a new Vector4 from current Vector3 floored values
  83233. * @returns a new Vector4
  83234. */
  83235. fract(): Vector4;
  83236. /**
  83237. * Returns the Vector4 length (float).
  83238. * @returns the length
  83239. */
  83240. length(): number;
  83241. /**
  83242. * Returns the Vector4 squared length (float).
  83243. * @returns the length squared
  83244. */
  83245. lengthSquared(): number;
  83246. /**
  83247. * Normalizes in place the Vector4.
  83248. * @returns the updated Vector4.
  83249. */
  83250. normalize(): Vector4;
  83251. /**
  83252. * Returns a new Vector3 from the Vector4 (x, y, z) coordinates.
  83253. * @returns this converted to a new vector3
  83254. */
  83255. toVector3(): Vector3;
  83256. /**
  83257. * Returns a new Vector4 copied from the current one.
  83258. * @returns the new cloned vector
  83259. */
  83260. clone(): Vector4;
  83261. /**
  83262. * Updates the current Vector4 with the given one coordinates.
  83263. * @param source the source vector to copy from
  83264. * @returns the updated Vector4.
  83265. */
  83266. copyFrom(source: DeepImmutable<Vector4>): Vector4;
  83267. /**
  83268. * Updates the current Vector4 coordinates with the given floats.
  83269. * @param x float to copy from
  83270. * @param y float to copy from
  83271. * @param z float to copy from
  83272. * @param w float to copy from
  83273. * @returns the updated Vector4.
  83274. */
  83275. copyFromFloats(x: number, y: number, z: number, w: number): Vector4;
  83276. /**
  83277. * Updates the current Vector4 coordinates with the given floats.
  83278. * @param x float to set from
  83279. * @param y float to set from
  83280. * @param z float to set from
  83281. * @param w float to set from
  83282. * @returns the updated Vector4.
  83283. */
  83284. set(x: number, y: number, z: number, w: number): Vector4;
  83285. /**
  83286. * Copies the given float to the current Vector3 coordinates
  83287. * @param v defines the x, y, z and w coordinates of the operand
  83288. * @returns the current updated Vector3
  83289. */
  83290. setAll(v: number): Vector4;
  83291. /**
  83292. * Returns a new Vector4 set from the starting index of the given array.
  83293. * @param array the array to pull values from
  83294. * @param offset the offset into the array to start at
  83295. * @returns the new vector
  83296. */
  83297. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector4;
  83298. /**
  83299. * Updates the given vector "result" from the starting index of the given array.
  83300. * @param array the array to pull values from
  83301. * @param offset the offset into the array to start at
  83302. * @param result the vector to store the result in
  83303. */
  83304. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector4): void;
  83305. /**
  83306. * Updates the given vector "result" from the starting index of the given Float32Array.
  83307. * @param array the array to pull values from
  83308. * @param offset the offset into the array to start at
  83309. * @param result the vector to store the result in
  83310. */
  83311. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector4): void;
  83312. /**
  83313. * Updates the given vector "result" coordinates from the given floats.
  83314. * @param x float to set from
  83315. * @param y float to set from
  83316. * @param z float to set from
  83317. * @param w float to set from
  83318. * @param result the vector to the floats in
  83319. */
  83320. static FromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): void;
  83321. /**
  83322. * Returns a new Vector4 set to (0.0, 0.0, 0.0, 0.0)
  83323. * @returns the new vector
  83324. */
  83325. static Zero(): Vector4;
  83326. /**
  83327. * Returns a new Vector4 set to (1.0, 1.0, 1.0, 1.0)
  83328. * @returns the new vector
  83329. */
  83330. static One(): Vector4;
  83331. /**
  83332. * Returns a new normalized Vector4 from the given one.
  83333. * @param vector the vector to normalize
  83334. * @returns the vector
  83335. */
  83336. static Normalize(vector: DeepImmutable<Vector4>): Vector4;
  83337. /**
  83338. * Updates the given vector "result" from the normalization of the given one.
  83339. * @param vector the vector to normalize
  83340. * @param result the vector to store the result in
  83341. */
  83342. static NormalizeToRef(vector: DeepImmutable<Vector4>, result: Vector4): void;
  83343. /**
  83344. * Returns a vector with the minimum values from the left and right vectors
  83345. * @param left left vector to minimize
  83346. * @param right right vector to minimize
  83347. * @returns a new vector with the minimum of the left and right vector values
  83348. */
  83349. static Minimize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  83350. /**
  83351. * Returns a vector with the maximum values from the left and right vectors
  83352. * @param left left vector to maximize
  83353. * @param right right vector to maximize
  83354. * @returns a new vector with the maximum of the left and right vector values
  83355. */
  83356. static Maximize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  83357. /**
  83358. * Returns the distance (float) between the vectors "value1" and "value2".
  83359. * @param value1 value to calulate the distance between
  83360. * @param value2 value to calulate the distance between
  83361. * @return the distance between the two vectors
  83362. */
  83363. static Distance(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  83364. /**
  83365. * Returns the squared distance (float) between the vectors "value1" and "value2".
  83366. * @param value1 value to calulate the distance between
  83367. * @param value2 value to calulate the distance between
  83368. * @return the distance between the two vectors squared
  83369. */
  83370. static DistanceSquared(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  83371. /**
  83372. * Returns a new Vector4 located at the center between the vectors "value1" and "value2".
  83373. * @param value1 value to calulate the center between
  83374. * @param value2 value to calulate the center between
  83375. * @return the center between the two vectors
  83376. */
  83377. static Center(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): Vector4;
  83378. /**
  83379. * Returns a new Vector4 set with the result of the normal transformation by the given matrix of the given vector.
  83380. * This methods computes transformed normalized direction vectors only.
  83381. * @param vector the vector to transform
  83382. * @param transformation the transformation matrix to apply
  83383. * @returns the new vector
  83384. */
  83385. static TransformNormal(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>): Vector4;
  83386. /**
  83387. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector.
  83388. * This methods computes transformed normalized direction vectors only.
  83389. * @param vector the vector to transform
  83390. * @param transformation the transformation matrix to apply
  83391. * @param result the vector to store the result in
  83392. */
  83393. static TransformNormalToRef(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  83394. /**
  83395. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z, w).
  83396. * This methods computes transformed normalized direction vectors only.
  83397. * @param x value to transform
  83398. * @param y value to transform
  83399. * @param z value to transform
  83400. * @param w value to transform
  83401. * @param transformation the transformation matrix to apply
  83402. * @param result the vector to store the results in
  83403. */
  83404. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, w: number, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  83405. /**
  83406. * Creates a new Vector4 from a Vector3
  83407. * @param source defines the source data
  83408. * @param w defines the 4th component (default is 0)
  83409. * @returns a new Vector4
  83410. */
  83411. static FromVector3(source: Vector3, w?: number): Vector4;
  83412. }
  83413. /**
  83414. * Class used to store quaternion data
  83415. * @see https://en.wikipedia.org/wiki/Quaternion
  83416. * @see https://doc.babylonjs.com/features/position,_rotation,_scaling
  83417. */
  83418. export class Quaternion {
  83419. /** @hidden */
  83420. _x: number;
  83421. /** @hidden */
  83422. _y: number;
  83423. /** @hidden */
  83424. _z: number;
  83425. /** @hidden */
  83426. _w: number;
  83427. /** @hidden */
  83428. _isDirty: boolean;
  83429. /** Gets or sets the x coordinate */
  83430. get x(): number;
  83431. set x(value: number);
  83432. /** Gets or sets the y coordinate */
  83433. get y(): number;
  83434. set y(value: number);
  83435. /** Gets or sets the z coordinate */
  83436. get z(): number;
  83437. set z(value: number);
  83438. /** Gets or sets the w coordinate */
  83439. get w(): number;
  83440. set w(value: number);
  83441. /**
  83442. * Creates a new Quaternion from the given floats
  83443. * @param x defines the first component (0 by default)
  83444. * @param y defines the second component (0 by default)
  83445. * @param z defines the third component (0 by default)
  83446. * @param w defines the fourth component (1.0 by default)
  83447. */
  83448. constructor(x?: number, y?: number, z?: number, w?: number);
  83449. /**
  83450. * Gets a string representation for the current quaternion
  83451. * @returns a string with the Quaternion coordinates
  83452. */
  83453. toString(): string;
  83454. /**
  83455. * Gets the class name of the quaternion
  83456. * @returns the string "Quaternion"
  83457. */
  83458. getClassName(): string;
  83459. /**
  83460. * Gets a hash code for this quaternion
  83461. * @returns the quaternion hash code
  83462. */
  83463. getHashCode(): number;
  83464. /**
  83465. * Copy the quaternion to an array
  83466. * @returns a new array populated with 4 elements from the quaternion coordinates
  83467. */
  83468. asArray(): number[];
  83469. /**
  83470. * Check if two quaternions are equals
  83471. * @param otherQuaternion defines the second operand
  83472. * @return true if the current quaternion and the given one coordinates are strictly equals
  83473. */
  83474. equals(otherQuaternion: DeepImmutable<Quaternion>): boolean;
  83475. /**
  83476. * Gets a boolean if two quaternions are equals (using an epsilon value)
  83477. * @param otherQuaternion defines the other quaternion
  83478. * @param epsilon defines the minimal distance to consider equality
  83479. * @returns true if the given quaternion coordinates are close to the current ones by a distance of epsilon.
  83480. */
  83481. equalsWithEpsilon(otherQuaternion: DeepImmutable<Quaternion>, epsilon?: number): boolean;
  83482. /**
  83483. * Clone the current quaternion
  83484. * @returns a new quaternion copied from the current one
  83485. */
  83486. clone(): Quaternion;
  83487. /**
  83488. * Copy a quaternion to the current one
  83489. * @param other defines the other quaternion
  83490. * @returns the updated current quaternion
  83491. */
  83492. copyFrom(other: DeepImmutable<Quaternion>): Quaternion;
  83493. /**
  83494. * Updates the current quaternion with the given float coordinates
  83495. * @param x defines the x coordinate
  83496. * @param y defines the y coordinate
  83497. * @param z defines the z coordinate
  83498. * @param w defines the w coordinate
  83499. * @returns the updated current quaternion
  83500. */
  83501. copyFromFloats(x: number, y: number, z: number, w: number): Quaternion;
  83502. /**
  83503. * Updates the current quaternion from the given float coordinates
  83504. * @param x defines the x coordinate
  83505. * @param y defines the y coordinate
  83506. * @param z defines the z coordinate
  83507. * @param w defines the w coordinate
  83508. * @returns the updated current quaternion
  83509. */
  83510. set(x: number, y: number, z: number, w: number): Quaternion;
  83511. /**
  83512. * Adds two quaternions
  83513. * @param other defines the second operand
  83514. * @returns a new quaternion as the addition result of the given one and the current quaternion
  83515. */
  83516. add(other: DeepImmutable<Quaternion>): Quaternion;
  83517. /**
  83518. * Add a quaternion to the current one
  83519. * @param other defines the quaternion to add
  83520. * @returns the current quaternion
  83521. */
  83522. addInPlace(other: DeepImmutable<Quaternion>): Quaternion;
  83523. /**
  83524. * Subtract two quaternions
  83525. * @param other defines the second operand
  83526. * @returns a new quaternion as the subtraction result of the given one from the current one
  83527. */
  83528. subtract(other: Quaternion): Quaternion;
  83529. /**
  83530. * Multiplies the current quaternion by a scale factor
  83531. * @param value defines the scale factor
  83532. * @returns a new quaternion set by multiplying the current quaternion coordinates by the float "scale"
  83533. */
  83534. scale(value: number): Quaternion;
  83535. /**
  83536. * Scale the current quaternion values by a factor and stores the result to a given quaternion
  83537. * @param scale defines the scale factor
  83538. * @param result defines the Quaternion object where to store the result
  83539. * @returns the unmodified current quaternion
  83540. */
  83541. scaleToRef(scale: number, result: Quaternion): Quaternion;
  83542. /**
  83543. * Multiplies in place the current quaternion by a scale factor
  83544. * @param value defines the scale factor
  83545. * @returns the current modified quaternion
  83546. */
  83547. scaleInPlace(value: number): Quaternion;
  83548. /**
  83549. * Scale the current quaternion values by a factor and add the result to a given quaternion
  83550. * @param scale defines the scale factor
  83551. * @param result defines the Quaternion object where to store the result
  83552. * @returns the unmodified current quaternion
  83553. */
  83554. scaleAndAddToRef(scale: number, result: Quaternion): Quaternion;
  83555. /**
  83556. * Multiplies two quaternions
  83557. * @param q1 defines the second operand
  83558. * @returns a new quaternion set as the multiplication result of the current one with the given one "q1"
  83559. */
  83560. multiply(q1: DeepImmutable<Quaternion>): Quaternion;
  83561. /**
  83562. * Sets the given "result" as the the multiplication result of the current one with the given one "q1"
  83563. * @param q1 defines the second operand
  83564. * @param result defines the target quaternion
  83565. * @returns the current quaternion
  83566. */
  83567. multiplyToRef(q1: DeepImmutable<Quaternion>, result: Quaternion): Quaternion;
  83568. /**
  83569. * Updates the current quaternion with the multiplication of itself with the given one "q1"
  83570. * @param q1 defines the second operand
  83571. * @returns the currentupdated quaternion
  83572. */
  83573. multiplyInPlace(q1: DeepImmutable<Quaternion>): Quaternion;
  83574. /**
  83575. * Conjugates (1-q) the current quaternion and stores the result in the given quaternion
  83576. * @param ref defines the target quaternion
  83577. * @returns the current quaternion
  83578. */
  83579. conjugateToRef(ref: Quaternion): Quaternion;
  83580. /**
  83581. * Conjugates in place (1-q) the current quaternion
  83582. * @returns the current updated quaternion
  83583. */
  83584. conjugateInPlace(): Quaternion;
  83585. /**
  83586. * Conjugates in place (1-q) the current quaternion
  83587. * @returns a new quaternion
  83588. */
  83589. conjugate(): Quaternion;
  83590. /**
  83591. * Gets length of current quaternion
  83592. * @returns the quaternion length (float)
  83593. */
  83594. length(): number;
  83595. /**
  83596. * Normalize in place the current quaternion
  83597. * @returns the current updated quaternion
  83598. */
  83599. normalize(): Quaternion;
  83600. /**
  83601. * Returns a new Vector3 set with the Euler angles translated from the current quaternion
  83602. * @param order is a reserved parameter and is ignore for now
  83603. * @returns a new Vector3 containing the Euler angles
  83604. */
  83605. toEulerAngles(order?: string): Vector3;
  83606. /**
  83607. * Sets the given vector3 "result" with the Euler angles translated from the current quaternion
  83608. * @param result defines the vector which will be filled with the Euler angles
  83609. * @param order is a reserved parameter and is ignore for now
  83610. * @returns the current unchanged quaternion
  83611. */
  83612. toEulerAnglesToRef(result: Vector3): Quaternion;
  83613. /**
  83614. * Updates the given rotation matrix with the current quaternion values
  83615. * @param result defines the target matrix
  83616. * @returns the current unchanged quaternion
  83617. */
  83618. toRotationMatrix(result: Matrix): Quaternion;
  83619. /**
  83620. * Updates the current quaternion from the given rotation matrix values
  83621. * @param matrix defines the source matrix
  83622. * @returns the current updated quaternion
  83623. */
  83624. fromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  83625. /**
  83626. * Creates a new quaternion from a rotation matrix
  83627. * @param matrix defines the source matrix
  83628. * @returns a new quaternion created from the given rotation matrix values
  83629. */
  83630. static FromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  83631. /**
  83632. * Updates the given quaternion with the given rotation matrix values
  83633. * @param matrix defines the source matrix
  83634. * @param result defines the target quaternion
  83635. */
  83636. static FromRotationMatrixToRef(matrix: DeepImmutable<Matrix>, result: Quaternion): void;
  83637. /**
  83638. * Returns the dot product (float) between the quaternions "left" and "right"
  83639. * @param left defines the left operand
  83640. * @param right defines the right operand
  83641. * @returns the dot product
  83642. */
  83643. static Dot(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>): number;
  83644. /**
  83645. * Checks if the two quaternions are close to each other
  83646. * @param quat0 defines the first quaternion to check
  83647. * @param quat1 defines the second quaternion to check
  83648. * @returns true if the two quaternions are close to each other
  83649. */
  83650. static AreClose(quat0: DeepImmutable<Quaternion>, quat1: DeepImmutable<Quaternion>): boolean;
  83651. /**
  83652. * Creates an empty quaternion
  83653. * @returns a new quaternion set to (0.0, 0.0, 0.0)
  83654. */
  83655. static Zero(): Quaternion;
  83656. /**
  83657. * Inverse a given quaternion
  83658. * @param q defines the source quaternion
  83659. * @returns a new quaternion as the inverted current quaternion
  83660. */
  83661. static Inverse(q: DeepImmutable<Quaternion>): Quaternion;
  83662. /**
  83663. * Inverse a given quaternion
  83664. * @param q defines the source quaternion
  83665. * @param result the quaternion the result will be stored in
  83666. * @returns the result quaternion
  83667. */
  83668. static InverseToRef(q: Quaternion, result: Quaternion): Quaternion;
  83669. /**
  83670. * Creates an identity quaternion
  83671. * @returns the identity quaternion
  83672. */
  83673. static Identity(): Quaternion;
  83674. /**
  83675. * Gets a boolean indicating if the given quaternion is identity
  83676. * @param quaternion defines the quaternion to check
  83677. * @returns true if the quaternion is identity
  83678. */
  83679. static IsIdentity(quaternion: DeepImmutable<Quaternion>): boolean;
  83680. /**
  83681. * Creates a quaternion from a rotation around an axis
  83682. * @param axis defines the axis to use
  83683. * @param angle defines the angle to use
  83684. * @returns a new quaternion created from the given axis (Vector3) and angle in radians (float)
  83685. */
  83686. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Quaternion;
  83687. /**
  83688. * Creates a rotation around an axis and stores it into the given quaternion
  83689. * @param axis defines the axis to use
  83690. * @param angle defines the angle to use
  83691. * @param result defines the target quaternion
  83692. * @returns the target quaternion
  83693. */
  83694. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Quaternion): Quaternion;
  83695. /**
  83696. * Creates a new quaternion from data stored into an array
  83697. * @param array defines the data source
  83698. * @param offset defines the offset in the source array where the data starts
  83699. * @returns a new quaternion
  83700. */
  83701. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Quaternion;
  83702. /**
  83703. * Updates the given quaternion "result" from the starting index of the given array.
  83704. * @param array the array to pull values from
  83705. * @param offset the offset into the array to start at
  83706. * @param result the quaternion to store the result in
  83707. */
  83708. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Quaternion): void;
  83709. /**
  83710. * Create a quaternion from Euler rotation angles
  83711. * @param x Pitch
  83712. * @param y Yaw
  83713. * @param z Roll
  83714. * @returns the new Quaternion
  83715. */
  83716. static FromEulerAngles(x: number, y: number, z: number): Quaternion;
  83717. /**
  83718. * Updates a quaternion from Euler rotation angles
  83719. * @param x Pitch
  83720. * @param y Yaw
  83721. * @param z Roll
  83722. * @param result the quaternion to store the result
  83723. * @returns the updated quaternion
  83724. */
  83725. static FromEulerAnglesToRef(x: number, y: number, z: number, result: Quaternion): Quaternion;
  83726. /**
  83727. * Create a quaternion from Euler rotation vector
  83728. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  83729. * @returns the new Quaternion
  83730. */
  83731. static FromEulerVector(vec: DeepImmutable<Vector3>): Quaternion;
  83732. /**
  83733. * Updates a quaternion from Euler rotation vector
  83734. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  83735. * @param result the quaternion to store the result
  83736. * @returns the updated quaternion
  83737. */
  83738. static FromEulerVectorToRef(vec: DeepImmutable<Vector3>, result: Quaternion): Quaternion;
  83739. /**
  83740. * Creates a new quaternion from the given Euler float angles (y, x, z)
  83741. * @param yaw defines the rotation around Y axis
  83742. * @param pitch defines the rotation around X axis
  83743. * @param roll defines the rotation around Z axis
  83744. * @returns the new quaternion
  83745. */
  83746. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Quaternion;
  83747. /**
  83748. * Creates a new rotation from the given Euler float angles (y, x, z) and stores it in the target quaternion
  83749. * @param yaw defines the rotation around Y axis
  83750. * @param pitch defines the rotation around X axis
  83751. * @param roll defines the rotation around Z axis
  83752. * @param result defines the target quaternion
  83753. */
  83754. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Quaternion): void;
  83755. /**
  83756. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation
  83757. * @param alpha defines the rotation around first axis
  83758. * @param beta defines the rotation around second axis
  83759. * @param gamma defines the rotation around third axis
  83760. * @returns the new quaternion
  83761. */
  83762. static RotationAlphaBetaGamma(alpha: number, beta: number, gamma: number): Quaternion;
  83763. /**
  83764. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation and stores it in the target quaternion
  83765. * @param alpha defines the rotation around first axis
  83766. * @param beta defines the rotation around second axis
  83767. * @param gamma defines the rotation around third axis
  83768. * @param result defines the target quaternion
  83769. */
  83770. static RotationAlphaBetaGammaToRef(alpha: number, beta: number, gamma: number, result: Quaternion): void;
  83771. /**
  83772. * 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)
  83773. * @param axis1 defines the first axis
  83774. * @param axis2 defines the second axis
  83775. * @param axis3 defines the third axis
  83776. * @returns the new quaternion
  83777. */
  83778. static RotationQuaternionFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Quaternion;
  83779. /**
  83780. * 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
  83781. * @param axis1 defines the first axis
  83782. * @param axis2 defines the second axis
  83783. * @param axis3 defines the third axis
  83784. * @param ref defines the target quaternion
  83785. */
  83786. static RotationQuaternionFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Quaternion): void;
  83787. /**
  83788. * Interpolates between two quaternions
  83789. * @param left defines first quaternion
  83790. * @param right defines second quaternion
  83791. * @param amount defines the gradient to use
  83792. * @returns the new interpolated quaternion
  83793. */
  83794. static Slerp(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number): Quaternion;
  83795. /**
  83796. * Interpolates between two quaternions and stores it into a target quaternion
  83797. * @param left defines first quaternion
  83798. * @param right defines second quaternion
  83799. * @param amount defines the gradient to use
  83800. * @param result defines the target quaternion
  83801. */
  83802. static SlerpToRef(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number, result: Quaternion): void;
  83803. /**
  83804. * Interpolate between two quaternions using Hermite interpolation
  83805. * @param value1 defines first quaternion
  83806. * @param tangent1 defines the incoming tangent
  83807. * @param value2 defines second quaternion
  83808. * @param tangent2 defines the outgoing tangent
  83809. * @param amount defines the target quaternion
  83810. * @returns the new interpolated quaternion
  83811. */
  83812. static Hermite(value1: DeepImmutable<Quaternion>, tangent1: DeepImmutable<Quaternion>, value2: DeepImmutable<Quaternion>, tangent2: DeepImmutable<Quaternion>, amount: number): Quaternion;
  83813. }
  83814. /**
  83815. * Class used to store matrix data (4x4)
  83816. */
  83817. export class Matrix {
  83818. /**
  83819. * Gets the precision of matrix computations
  83820. */
  83821. static get Use64Bits(): boolean;
  83822. private static _updateFlagSeed;
  83823. private static _identityReadOnly;
  83824. private _isIdentity;
  83825. private _isIdentityDirty;
  83826. private _isIdentity3x2;
  83827. private _isIdentity3x2Dirty;
  83828. /**
  83829. * Gets the update flag of the matrix which is an unique number for the matrix.
  83830. * It will be incremented every time the matrix data change.
  83831. * You can use it to speed the comparison between two versions of the same matrix.
  83832. */
  83833. updateFlag: number;
  83834. private readonly _m;
  83835. /**
  83836. * Gets the internal data of the matrix
  83837. */
  83838. get m(): DeepImmutable<Float32Array | Array<number>>;
  83839. /** @hidden */
  83840. _markAsUpdated(): void;
  83841. /** @hidden */
  83842. private _updateIdentityStatus;
  83843. /**
  83844. * Creates an empty matrix (filled with zeros)
  83845. */
  83846. constructor();
  83847. /**
  83848. * Check if the current matrix is identity
  83849. * @returns true is the matrix is the identity matrix
  83850. */
  83851. isIdentity(): boolean;
  83852. /**
  83853. * Check if the current matrix is identity as a texture matrix (3x2 store in 4x4)
  83854. * @returns true is the matrix is the identity matrix
  83855. */
  83856. isIdentityAs3x2(): boolean;
  83857. /**
  83858. * Gets the determinant of the matrix
  83859. * @returns the matrix determinant
  83860. */
  83861. determinant(): number;
  83862. /**
  83863. * Returns the matrix as a Float32Array or Array<number>
  83864. * @returns the matrix underlying array
  83865. */
  83866. toArray(): DeepImmutable<Float32Array | Array<number>>;
  83867. /**
  83868. * Returns the matrix as a Float32Array or Array<number>
  83869. * @returns the matrix underlying array.
  83870. */
  83871. asArray(): DeepImmutable<Float32Array | Array<number>>;
  83872. /**
  83873. * Inverts the current matrix in place
  83874. * @returns the current inverted matrix
  83875. */
  83876. invert(): Matrix;
  83877. /**
  83878. * Sets all the matrix elements to zero
  83879. * @returns the current matrix
  83880. */
  83881. reset(): Matrix;
  83882. /**
  83883. * Adds the current matrix with a second one
  83884. * @param other defines the matrix to add
  83885. * @returns a new matrix as the addition of the current matrix and the given one
  83886. */
  83887. add(other: DeepImmutable<Matrix>): Matrix;
  83888. /**
  83889. * Sets the given matrix "result" to the addition of the current matrix and the given one
  83890. * @param other defines the matrix to add
  83891. * @param result defines the target matrix
  83892. * @returns the current matrix
  83893. */
  83894. addToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  83895. /**
  83896. * Adds in place the given matrix to the current matrix
  83897. * @param other defines the second operand
  83898. * @returns the current updated matrix
  83899. */
  83900. addToSelf(other: DeepImmutable<Matrix>): Matrix;
  83901. /**
  83902. * Sets the given matrix to the current inverted Matrix
  83903. * @param other defines the target matrix
  83904. * @returns the unmodified current matrix
  83905. */
  83906. invertToRef(other: Matrix): Matrix;
  83907. /**
  83908. * add a value at the specified position in the current Matrix
  83909. * @param index the index of the value within the matrix. between 0 and 15.
  83910. * @param value the value to be added
  83911. * @returns the current updated matrix
  83912. */
  83913. addAtIndex(index: number, value: number): Matrix;
  83914. /**
  83915. * mutiply the specified position in the current Matrix by a value
  83916. * @param index the index of the value within the matrix. between 0 and 15.
  83917. * @param value the value to be added
  83918. * @returns the current updated matrix
  83919. */
  83920. multiplyAtIndex(index: number, value: number): Matrix;
  83921. /**
  83922. * Inserts the translation vector (using 3 floats) in the current matrix
  83923. * @param x defines the 1st component of the translation
  83924. * @param y defines the 2nd component of the translation
  83925. * @param z defines the 3rd component of the translation
  83926. * @returns the current updated matrix
  83927. */
  83928. setTranslationFromFloats(x: number, y: number, z: number): Matrix;
  83929. /**
  83930. * Adds the translation vector (using 3 floats) in the current matrix
  83931. * @param x defines the 1st component of the translation
  83932. * @param y defines the 2nd component of the translation
  83933. * @param z defines the 3rd component of the translation
  83934. * @returns the current updated matrix
  83935. */
  83936. addTranslationFromFloats(x: number, y: number, z: number): Matrix;
  83937. /**
  83938. * Inserts the translation vector in the current matrix
  83939. * @param vector3 defines the translation to insert
  83940. * @returns the current updated matrix
  83941. */
  83942. setTranslation(vector3: DeepImmutable<Vector3>): Matrix;
  83943. /**
  83944. * Gets the translation value of the current matrix
  83945. * @returns a new Vector3 as the extracted translation from the matrix
  83946. */
  83947. getTranslation(): Vector3;
  83948. /**
  83949. * Fill a Vector3 with the extracted translation from the matrix
  83950. * @param result defines the Vector3 where to store the translation
  83951. * @returns the current matrix
  83952. */
  83953. getTranslationToRef(result: Vector3): Matrix;
  83954. /**
  83955. * Remove rotation and scaling part from the matrix
  83956. * @returns the updated matrix
  83957. */
  83958. removeRotationAndScaling(): Matrix;
  83959. /**
  83960. * Multiply two matrices
  83961. * @param other defines the second operand
  83962. * @returns a new matrix set with the multiplication result of the current Matrix and the given one
  83963. */
  83964. multiply(other: DeepImmutable<Matrix>): Matrix;
  83965. /**
  83966. * Copy the current matrix from the given one
  83967. * @param other defines the source matrix
  83968. * @returns the current updated matrix
  83969. */
  83970. copyFrom(other: DeepImmutable<Matrix>): Matrix;
  83971. /**
  83972. * Populates the given array from the starting index with the current matrix values
  83973. * @param array defines the target array
  83974. * @param offset defines the offset in the target array where to start storing values
  83975. * @returns the current matrix
  83976. */
  83977. copyToArray(array: Float32Array | Array<number>, offset?: number): Matrix;
  83978. /**
  83979. * Sets the given matrix "result" with the multiplication result of the current Matrix and the given one
  83980. * @param other defines the second operand
  83981. * @param result defines the matrix where to store the multiplication
  83982. * @returns the current matrix
  83983. */
  83984. multiplyToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  83985. /**
  83986. * Sets the Float32Array "result" from the given index "offset" with the multiplication of the current matrix and the given one
  83987. * @param other defines the second operand
  83988. * @param result defines the array where to store the multiplication
  83989. * @param offset defines the offset in the target array where to start storing values
  83990. * @returns the current matrix
  83991. */
  83992. multiplyToArray(other: DeepImmutable<Matrix>, result: Float32Array | Array<number>, offset: number): Matrix;
  83993. /**
  83994. * Check equality between this matrix and a second one
  83995. * @param value defines the second matrix to compare
  83996. * @returns true is the current matrix and the given one values are strictly equal
  83997. */
  83998. equals(value: DeepImmutable<Matrix>): boolean;
  83999. /**
  84000. * Clone the current matrix
  84001. * @returns a new matrix from the current matrix
  84002. */
  84003. clone(): Matrix;
  84004. /**
  84005. * Returns the name of the current matrix class
  84006. * @returns the string "Matrix"
  84007. */
  84008. getClassName(): string;
  84009. /**
  84010. * Gets the hash code of the current matrix
  84011. * @returns the hash code
  84012. */
  84013. getHashCode(): number;
  84014. /**
  84015. * Decomposes the current Matrix into a translation, rotation and scaling components
  84016. * @param scale defines the scale vector3 given as a reference to update
  84017. * @param rotation defines the rotation quaternion given as a reference to update
  84018. * @param translation defines the translation vector3 given as a reference to update
  84019. * @returns true if operation was successful
  84020. */
  84021. decompose(scale?: Vector3, rotation?: Quaternion, translation?: Vector3): boolean;
  84022. /**
  84023. * Gets specific row of the matrix
  84024. * @param index defines the number of the row to get
  84025. * @returns the index-th row of the current matrix as a new Vector4
  84026. */
  84027. getRow(index: number): Nullable<Vector4>;
  84028. /**
  84029. * Sets the index-th row of the current matrix to the vector4 values
  84030. * @param index defines the number of the row to set
  84031. * @param row defines the target vector4
  84032. * @returns the updated current matrix
  84033. */
  84034. setRow(index: number, row: Vector4): Matrix;
  84035. /**
  84036. * Compute the transpose of the matrix
  84037. * @returns the new transposed matrix
  84038. */
  84039. transpose(): Matrix;
  84040. /**
  84041. * Compute the transpose of the matrix and store it in a given matrix
  84042. * @param result defines the target matrix
  84043. * @returns the current matrix
  84044. */
  84045. transposeToRef(result: Matrix): Matrix;
  84046. /**
  84047. * Sets the index-th row of the current matrix with the given 4 x float values
  84048. * @param index defines the row index
  84049. * @param x defines the x component to set
  84050. * @param y defines the y component to set
  84051. * @param z defines the z component to set
  84052. * @param w defines the w component to set
  84053. * @returns the updated current matrix
  84054. */
  84055. setRowFromFloats(index: number, x: number, y: number, z: number, w: number): Matrix;
  84056. /**
  84057. * Compute a new matrix set with the current matrix values multiplied by scale (float)
  84058. * @param scale defines the scale factor
  84059. * @returns a new matrix
  84060. */
  84061. scale(scale: number): Matrix;
  84062. /**
  84063. * Scale the current matrix values by a factor to a given result matrix
  84064. * @param scale defines the scale factor
  84065. * @param result defines the matrix to store the result
  84066. * @returns the current matrix
  84067. */
  84068. scaleToRef(scale: number, result: Matrix): Matrix;
  84069. /**
  84070. * Scale the current matrix values by a factor and add the result to a given matrix
  84071. * @param scale defines the scale factor
  84072. * @param result defines the Matrix to store the result
  84073. * @returns the current matrix
  84074. */
  84075. scaleAndAddToRef(scale: number, result: Matrix): Matrix;
  84076. /**
  84077. * Writes to the given matrix a normal matrix, computed from this one (using values from identity matrix for fourth row and column).
  84078. * @param ref matrix to store the result
  84079. */
  84080. toNormalMatrix(ref: Matrix): void;
  84081. /**
  84082. * Gets only rotation part of the current matrix
  84083. * @returns a new matrix sets to the extracted rotation matrix from the current one
  84084. */
  84085. getRotationMatrix(): Matrix;
  84086. /**
  84087. * Extracts the rotation matrix from the current one and sets it as the given "result"
  84088. * @param result defines the target matrix to store data to
  84089. * @returns the current matrix
  84090. */
  84091. getRotationMatrixToRef(result: Matrix): Matrix;
  84092. /**
  84093. * Toggles model matrix from being right handed to left handed in place and vice versa
  84094. */
  84095. toggleModelMatrixHandInPlace(): void;
  84096. /**
  84097. * Toggles projection matrix from being right handed to left handed in place and vice versa
  84098. */
  84099. toggleProjectionMatrixHandInPlace(): void;
  84100. /**
  84101. * Creates a matrix from an array
  84102. * @param array defines the source array
  84103. * @param offset defines an offset in the source array
  84104. * @returns a new Matrix set from the starting index of the given array
  84105. */
  84106. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Matrix;
  84107. /**
  84108. * Copy the content of an array into a given matrix
  84109. * @param array defines the source array
  84110. * @param offset defines an offset in the source array
  84111. * @param result defines the target matrix
  84112. */
  84113. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Matrix): void;
  84114. /**
  84115. * Stores an array into a matrix after having multiplied each component by a given factor
  84116. * @param array defines the source array
  84117. * @param offset defines the offset in the source array
  84118. * @param scale defines the scaling factor
  84119. * @param result defines the target matrix
  84120. */
  84121. static FromFloat32ArrayToRefScaled(array: DeepImmutable<Float32Array | Array<number>>, offset: number, scale: number, result: Matrix): void;
  84122. /**
  84123. * Gets an identity matrix that must not be updated
  84124. */
  84125. static get IdentityReadOnly(): DeepImmutable<Matrix>;
  84126. /**
  84127. * Stores a list of values (16) inside a given matrix
  84128. * @param initialM11 defines 1st value of 1st row
  84129. * @param initialM12 defines 2nd value of 1st row
  84130. * @param initialM13 defines 3rd value of 1st row
  84131. * @param initialM14 defines 4th value of 1st row
  84132. * @param initialM21 defines 1st value of 2nd row
  84133. * @param initialM22 defines 2nd value of 2nd row
  84134. * @param initialM23 defines 3rd value of 2nd row
  84135. * @param initialM24 defines 4th value of 2nd row
  84136. * @param initialM31 defines 1st value of 3rd row
  84137. * @param initialM32 defines 2nd value of 3rd row
  84138. * @param initialM33 defines 3rd value of 3rd row
  84139. * @param initialM34 defines 4th value of 3rd row
  84140. * @param initialM41 defines 1st value of 4th row
  84141. * @param initialM42 defines 2nd value of 4th row
  84142. * @param initialM43 defines 3rd value of 4th row
  84143. * @param initialM44 defines 4th value of 4th row
  84144. * @param result defines the target matrix
  84145. */
  84146. 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;
  84147. /**
  84148. * Creates new matrix from a list of values (16)
  84149. * @param initialM11 defines 1st value of 1st row
  84150. * @param initialM12 defines 2nd value of 1st row
  84151. * @param initialM13 defines 3rd value of 1st row
  84152. * @param initialM14 defines 4th value of 1st row
  84153. * @param initialM21 defines 1st value of 2nd row
  84154. * @param initialM22 defines 2nd value of 2nd row
  84155. * @param initialM23 defines 3rd value of 2nd row
  84156. * @param initialM24 defines 4th value of 2nd row
  84157. * @param initialM31 defines 1st value of 3rd row
  84158. * @param initialM32 defines 2nd value of 3rd row
  84159. * @param initialM33 defines 3rd value of 3rd row
  84160. * @param initialM34 defines 4th value of 3rd row
  84161. * @param initialM41 defines 1st value of 4th row
  84162. * @param initialM42 defines 2nd value of 4th row
  84163. * @param initialM43 defines 3rd value of 4th row
  84164. * @param initialM44 defines 4th value of 4th row
  84165. * @returns the new matrix
  84166. */
  84167. 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;
  84168. /**
  84169. * Creates a new matrix composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  84170. * @param scale defines the scale vector3
  84171. * @param rotation defines the rotation quaternion
  84172. * @param translation defines the translation vector3
  84173. * @returns a new matrix
  84174. */
  84175. static Compose(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>): Matrix;
  84176. /**
  84177. * Sets a matrix to a value composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  84178. * @param scale defines the scale vector3
  84179. * @param rotation defines the rotation quaternion
  84180. * @param translation defines the translation vector3
  84181. * @param result defines the target matrix
  84182. */
  84183. static ComposeToRef(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>, result: Matrix): void;
  84184. /**
  84185. * Creates a new identity matrix
  84186. * @returns a new identity matrix
  84187. */
  84188. static Identity(): Matrix;
  84189. /**
  84190. * Creates a new identity matrix and stores the result in a given matrix
  84191. * @param result defines the target matrix
  84192. */
  84193. static IdentityToRef(result: Matrix): void;
  84194. /**
  84195. * Creates a new zero matrix
  84196. * @returns a new zero matrix
  84197. */
  84198. static Zero(): Matrix;
  84199. /**
  84200. * Creates a new rotation matrix for "angle" radians around the X axis
  84201. * @param angle defines the angle (in radians) to use
  84202. * @return the new matrix
  84203. */
  84204. static RotationX(angle: number): Matrix;
  84205. /**
  84206. * Creates a new matrix as the invert of a given matrix
  84207. * @param source defines the source matrix
  84208. * @returns the new matrix
  84209. */
  84210. static Invert(source: DeepImmutable<Matrix>): Matrix;
  84211. /**
  84212. * Creates a new rotation matrix for "angle" radians around the X axis and stores it in a given matrix
  84213. * @param angle defines the angle (in radians) to use
  84214. * @param result defines the target matrix
  84215. */
  84216. static RotationXToRef(angle: number, result: Matrix): void;
  84217. /**
  84218. * Creates a new rotation matrix for "angle" radians around the Y axis
  84219. * @param angle defines the angle (in radians) to use
  84220. * @return the new matrix
  84221. */
  84222. static RotationY(angle: number): Matrix;
  84223. /**
  84224. * Creates a new rotation matrix for "angle" radians around the Y axis and stores it in a given matrix
  84225. * @param angle defines the angle (in radians) to use
  84226. * @param result defines the target matrix
  84227. */
  84228. static RotationYToRef(angle: number, result: Matrix): void;
  84229. /**
  84230. * Creates a new rotation matrix for "angle" radians around the Z axis
  84231. * @param angle defines the angle (in radians) to use
  84232. * @return the new matrix
  84233. */
  84234. static RotationZ(angle: number): Matrix;
  84235. /**
  84236. * Creates a new rotation matrix for "angle" radians around the Z axis and stores it in a given matrix
  84237. * @param angle defines the angle (in radians) to use
  84238. * @param result defines the target matrix
  84239. */
  84240. static RotationZToRef(angle: number, result: Matrix): void;
  84241. /**
  84242. * Creates a new rotation matrix for "angle" radians around the given axis
  84243. * @param axis defines the axis to use
  84244. * @param angle defines the angle (in radians) to use
  84245. * @return the new matrix
  84246. */
  84247. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Matrix;
  84248. /**
  84249. * Creates a new rotation matrix for "angle" radians around the given axis and stores it in a given matrix
  84250. * @param axis defines the axis to use
  84251. * @param angle defines the angle (in radians) to use
  84252. * @param result defines the target matrix
  84253. */
  84254. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Matrix): void;
  84255. /**
  84256. * Takes normalised vectors and returns a rotation matrix to align "from" with "to".
  84257. * Taken from http://www.iquilezles.org/www/articles/noacos/noacos.htm
  84258. * @param from defines the vector to align
  84259. * @param to defines the vector to align to
  84260. * @param result defines the target matrix
  84261. */
  84262. static RotationAlignToRef(from: DeepImmutable<Vector3>, to: DeepImmutable<Vector3>, result: Matrix): void;
  84263. /**
  84264. * Creates a rotation matrix
  84265. * @param yaw defines the yaw angle in radians (Y axis)
  84266. * @param pitch defines the pitch angle in radians (X axis)
  84267. * @param roll defines the roll angle in radians (Z axis)
  84268. * @returns the new rotation matrix
  84269. */
  84270. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Matrix;
  84271. /**
  84272. * Creates a rotation matrix and stores it in a given matrix
  84273. * @param yaw defines the yaw angle in radians (Y axis)
  84274. * @param pitch defines the pitch angle in radians (X axis)
  84275. * @param roll defines the roll angle in radians (Z axis)
  84276. * @param result defines the target matrix
  84277. */
  84278. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Matrix): void;
  84279. /**
  84280. * Creates a scaling matrix
  84281. * @param x defines the scale factor on X axis
  84282. * @param y defines the scale factor on Y axis
  84283. * @param z defines the scale factor on Z axis
  84284. * @returns the new matrix
  84285. */
  84286. static Scaling(x: number, y: number, z: number): Matrix;
  84287. /**
  84288. * Creates a scaling matrix and stores it in a given matrix
  84289. * @param x defines the scale factor on X axis
  84290. * @param y defines the scale factor on Y axis
  84291. * @param z defines the scale factor on Z axis
  84292. * @param result defines the target matrix
  84293. */
  84294. static ScalingToRef(x: number, y: number, z: number, result: Matrix): void;
  84295. /**
  84296. * Creates a translation matrix
  84297. * @param x defines the translation on X axis
  84298. * @param y defines the translation on Y axis
  84299. * @param z defines the translationon Z axis
  84300. * @returns the new matrix
  84301. */
  84302. static Translation(x: number, y: number, z: number): Matrix;
  84303. /**
  84304. * Creates a translation matrix and stores it in a given matrix
  84305. * @param x defines the translation on X axis
  84306. * @param y defines the translation on Y axis
  84307. * @param z defines the translationon Z axis
  84308. * @param result defines the target matrix
  84309. */
  84310. static TranslationToRef(x: number, y: number, z: number, result: Matrix): void;
  84311. /**
  84312. * Returns a new Matrix whose values are the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  84313. * @param startValue defines the start value
  84314. * @param endValue defines the end value
  84315. * @param gradient defines the gradient factor
  84316. * @returns the new matrix
  84317. */
  84318. static Lerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  84319. /**
  84320. * Set the given matrix "result" as the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  84321. * @param startValue defines the start value
  84322. * @param endValue defines the end value
  84323. * @param gradient defines the gradient factor
  84324. * @param result defines the Matrix object where to store data
  84325. */
  84326. static LerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  84327. /**
  84328. * Builds a new matrix whose values are computed by:
  84329. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  84330. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  84331. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  84332. * @param startValue defines the first matrix
  84333. * @param endValue defines the second matrix
  84334. * @param gradient defines the gradient between the two matrices
  84335. * @returns the new matrix
  84336. */
  84337. static DecomposeLerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  84338. /**
  84339. * Update a matrix to values which are computed by:
  84340. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  84341. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  84342. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  84343. * @param startValue defines the first matrix
  84344. * @param endValue defines the second matrix
  84345. * @param gradient defines the gradient between the two matrices
  84346. * @param result defines the target matrix
  84347. */
  84348. static DecomposeLerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  84349. /**
  84350. * 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"
  84351. * This function works in left handed mode
  84352. * @param eye defines the final position of the entity
  84353. * @param target defines where the entity should look at
  84354. * @param up defines the up vector for the entity
  84355. * @returns the new matrix
  84356. */
  84357. static LookAtLH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  84358. /**
  84359. * 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".
  84360. * This function works in left handed mode
  84361. * @param eye defines the final position of the entity
  84362. * @param target defines where the entity should look at
  84363. * @param up defines the up vector for the entity
  84364. * @param result defines the target matrix
  84365. */
  84366. static LookAtLHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  84367. /**
  84368. * 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"
  84369. * This function works in right handed mode
  84370. * @param eye defines the final position of the entity
  84371. * @param target defines where the entity should look at
  84372. * @param up defines the up vector for the entity
  84373. * @returns the new matrix
  84374. */
  84375. static LookAtRH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  84376. /**
  84377. * 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".
  84378. * This function works in right handed mode
  84379. * @param eye defines the final position of the entity
  84380. * @param target defines where the entity should look at
  84381. * @param up defines the up vector for the entity
  84382. * @param result defines the target matrix
  84383. */
  84384. static LookAtRHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  84385. /**
  84386. * Create a left-handed orthographic projection matrix
  84387. * @param width defines the viewport width
  84388. * @param height defines the viewport height
  84389. * @param znear defines the near clip plane
  84390. * @param zfar defines the far clip plane
  84391. * @returns a new matrix as a left-handed orthographic projection matrix
  84392. */
  84393. static OrthoLH(width: number, height: number, znear: number, zfar: number): Matrix;
  84394. /**
  84395. * Store a left-handed orthographic projection to a given matrix
  84396. * @param width defines the viewport width
  84397. * @param height defines the viewport height
  84398. * @param znear defines the near clip plane
  84399. * @param zfar defines the far clip plane
  84400. * @param result defines the target matrix
  84401. */
  84402. static OrthoLHToRef(width: number, height: number, znear: number, zfar: number, result: Matrix): void;
  84403. /**
  84404. * Create a left-handed orthographic projection matrix
  84405. * @param left defines the viewport left coordinate
  84406. * @param right defines the viewport right coordinate
  84407. * @param bottom defines the viewport bottom coordinate
  84408. * @param top defines the viewport top coordinate
  84409. * @param znear defines the near clip plane
  84410. * @param zfar defines the far clip plane
  84411. * @returns a new matrix as a left-handed orthographic projection matrix
  84412. */
  84413. static OrthoOffCenterLH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  84414. /**
  84415. * Stores a left-handed orthographic projection into a given matrix
  84416. * @param left defines the viewport left coordinate
  84417. * @param right defines the viewport right coordinate
  84418. * @param bottom defines the viewport bottom coordinate
  84419. * @param top defines the viewport top coordinate
  84420. * @param znear defines the near clip plane
  84421. * @param zfar defines the far clip plane
  84422. * @param result defines the target matrix
  84423. */
  84424. static OrthoOffCenterLHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  84425. /**
  84426. * Creates a right-handed orthographic projection matrix
  84427. * @param left defines the viewport left coordinate
  84428. * @param right defines the viewport right coordinate
  84429. * @param bottom defines the viewport bottom coordinate
  84430. * @param top defines the viewport top coordinate
  84431. * @param znear defines the near clip plane
  84432. * @param zfar defines the far clip plane
  84433. * @returns a new matrix as a right-handed orthographic projection matrix
  84434. */
  84435. static OrthoOffCenterRH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  84436. /**
  84437. * Stores a right-handed orthographic projection into a given matrix
  84438. * @param left defines the viewport left coordinate
  84439. * @param right defines the viewport right coordinate
  84440. * @param bottom defines the viewport bottom coordinate
  84441. * @param top defines the viewport top coordinate
  84442. * @param znear defines the near clip plane
  84443. * @param zfar defines the far clip plane
  84444. * @param result defines the target matrix
  84445. */
  84446. static OrthoOffCenterRHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  84447. /**
  84448. * Creates a left-handed perspective projection matrix
  84449. * @param width defines the viewport width
  84450. * @param height defines the viewport height
  84451. * @param znear defines the near clip plane
  84452. * @param zfar defines the far clip plane
  84453. * @returns a new matrix as a left-handed perspective projection matrix
  84454. */
  84455. static PerspectiveLH(width: number, height: number, znear: number, zfar: number): Matrix;
  84456. /**
  84457. * Creates a left-handed perspective projection matrix
  84458. * @param fov defines the horizontal field of view
  84459. * @param aspect defines the aspect ratio
  84460. * @param znear defines the near clip plane
  84461. * @param zfar defines the far clip plane
  84462. * @returns a new matrix as a left-handed perspective projection matrix
  84463. */
  84464. static PerspectiveFovLH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  84465. /**
  84466. * Stores a left-handed perspective projection into a given matrix
  84467. * @param fov defines the horizontal field of view
  84468. * @param aspect defines the aspect ratio
  84469. * @param znear defines the near clip plane
  84470. * @param zfar defines the far clip plane
  84471. * @param result defines the target matrix
  84472. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  84473. */
  84474. static PerspectiveFovLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  84475. /**
  84476. * Stores a left-handed perspective projection into a given matrix with depth reversed
  84477. * @param fov defines the horizontal field of view
  84478. * @param aspect defines the aspect ratio
  84479. * @param znear defines the near clip plane
  84480. * @param zfar not used as infinity is used as far clip
  84481. * @param result defines the target matrix
  84482. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  84483. */
  84484. static PerspectiveFovReverseLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  84485. /**
  84486. * Creates a right-handed perspective projection matrix
  84487. * @param fov defines the horizontal field of view
  84488. * @param aspect defines the aspect ratio
  84489. * @param znear defines the near clip plane
  84490. * @param zfar defines the far clip plane
  84491. * @returns a new matrix as a right-handed perspective projection matrix
  84492. */
  84493. static PerspectiveFovRH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  84494. /**
  84495. * Stores a right-handed perspective projection into a given matrix
  84496. * @param fov defines the horizontal field of view
  84497. * @param aspect defines the aspect ratio
  84498. * @param znear defines the near clip plane
  84499. * @param zfar defines the far clip plane
  84500. * @param result defines the target matrix
  84501. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  84502. */
  84503. static PerspectiveFovRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  84504. /**
  84505. * Stores a right-handed perspective projection into a given matrix
  84506. * @param fov defines the horizontal field of view
  84507. * @param aspect defines the aspect ratio
  84508. * @param znear defines the near clip plane
  84509. * @param zfar not used as infinity is used as far clip
  84510. * @param result defines the target matrix
  84511. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  84512. */
  84513. static PerspectiveFovReverseRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  84514. /**
  84515. * Stores a perspective projection for WebVR info a given matrix
  84516. * @param fov defines the field of view
  84517. * @param znear defines the near clip plane
  84518. * @param zfar defines the far clip plane
  84519. * @param result defines the target matrix
  84520. * @param rightHanded defines if the matrix must be in right-handed mode (false by default)
  84521. */
  84522. static PerspectiveFovWebVRToRef(fov: {
  84523. upDegrees: number;
  84524. downDegrees: number;
  84525. leftDegrees: number;
  84526. rightDegrees: number;
  84527. }, znear: number, zfar: number, result: Matrix, rightHanded?: boolean): void;
  84528. /**
  84529. * Computes a complete transformation matrix
  84530. * @param viewport defines the viewport to use
  84531. * @param world defines the world matrix
  84532. * @param view defines the view matrix
  84533. * @param projection defines the projection matrix
  84534. * @param zmin defines the near clip plane
  84535. * @param zmax defines the far clip plane
  84536. * @returns the transformation matrix
  84537. */
  84538. static GetFinalMatrix(viewport: DeepImmutable<Viewport>, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, zmin: number, zmax: number): Matrix;
  84539. /**
  84540. * Extracts a 2x2 matrix from a given matrix and store the result in a Float32Array
  84541. * @param matrix defines the matrix to use
  84542. * @returns a new Float32Array array with 4 elements : the 2x2 matrix extracted from the given matrix
  84543. */
  84544. static GetAsMatrix2x2(matrix: DeepImmutable<Matrix>): Float32Array | Array<number>;
  84545. /**
  84546. * Extracts a 3x3 matrix from a given matrix and store the result in a Float32Array
  84547. * @param matrix defines the matrix to use
  84548. * @returns a new Float32Array array with 9 elements : the 3x3 matrix extracted from the given matrix
  84549. */
  84550. static GetAsMatrix3x3(matrix: DeepImmutable<Matrix>): Float32Array | Array<number>;
  84551. /**
  84552. * Compute the transpose of a given matrix
  84553. * @param matrix defines the matrix to transpose
  84554. * @returns the new matrix
  84555. */
  84556. static Transpose(matrix: DeepImmutable<Matrix>): Matrix;
  84557. /**
  84558. * Compute the transpose of a matrix and store it in a target matrix
  84559. * @param matrix defines the matrix to transpose
  84560. * @param result defines the target matrix
  84561. */
  84562. static TransposeToRef(matrix: DeepImmutable<Matrix>, result: Matrix): void;
  84563. /**
  84564. * Computes a reflection matrix from a plane
  84565. * @param plane defines the reflection plane
  84566. * @returns a new matrix
  84567. */
  84568. static Reflection(plane: DeepImmutable<IPlaneLike>): Matrix;
  84569. /**
  84570. * Computes a reflection matrix from a plane
  84571. * @param plane defines the reflection plane
  84572. * @param result defines the target matrix
  84573. */
  84574. static ReflectionToRef(plane: DeepImmutable<IPlaneLike>, result: Matrix): void;
  84575. /**
  84576. * Sets the given matrix as a rotation matrix composed from the 3 left handed axes
  84577. * @param xaxis defines the value of the 1st axis
  84578. * @param yaxis defines the value of the 2nd axis
  84579. * @param zaxis defines the value of the 3rd axis
  84580. * @param result defines the target matrix
  84581. */
  84582. static FromXYZAxesToRef(xaxis: DeepImmutable<Vector3>, yaxis: DeepImmutable<Vector3>, zaxis: DeepImmutable<Vector3>, result: Matrix): void;
  84583. /**
  84584. * Creates a rotation matrix from a quaternion and stores it in a target matrix
  84585. * @param quat defines the quaternion to use
  84586. * @param result defines the target matrix
  84587. */
  84588. static FromQuaternionToRef(quat: DeepImmutable<Quaternion>, result: Matrix): void;
  84589. }
  84590. /**
  84591. * @hidden
  84592. */
  84593. export class TmpVectors {
  84594. static Vector2: Vector2[];
  84595. static Vector3: Vector3[];
  84596. static Vector4: Vector4[];
  84597. static Quaternion: Quaternion[];
  84598. static Matrix: Matrix[];
  84599. }
  84600. }
  84601. declare module BABYLON {
  84602. /**
  84603. * Defines potential orientation for back face culling
  84604. */
  84605. export enum Orientation {
  84606. /**
  84607. * Clockwise
  84608. */
  84609. CW = 0,
  84610. /** Counter clockwise */
  84611. CCW = 1
  84612. }
  84613. /** Class used to represent a Bezier curve */
  84614. export class BezierCurve {
  84615. /**
  84616. * Returns the cubic Bezier interpolated value (float) at "t" (float) from the given x1, y1, x2, y2 floats
  84617. * @param t defines the time
  84618. * @param x1 defines the left coordinate on X axis
  84619. * @param y1 defines the left coordinate on Y axis
  84620. * @param x2 defines the right coordinate on X axis
  84621. * @param y2 defines the right coordinate on Y axis
  84622. * @returns the interpolated value
  84623. */
  84624. static Interpolate(t: number, x1: number, y1: number, x2: number, y2: number): number;
  84625. }
  84626. /**
  84627. * Defines angle representation
  84628. */
  84629. export class Angle {
  84630. private _radians;
  84631. /**
  84632. * Creates an Angle object of "radians" radians (float).
  84633. * @param radians the angle in radians
  84634. */
  84635. constructor(radians: number);
  84636. /**
  84637. * Get value in degrees
  84638. * @returns the Angle value in degrees (float)
  84639. */
  84640. degrees(): number;
  84641. /**
  84642. * Get value in radians
  84643. * @returns the Angle value in radians (float)
  84644. */
  84645. radians(): number;
  84646. /**
  84647. * Gets a new Angle object valued with the gradient angle, in radians, of the line joining two points
  84648. * @param a defines first point as the origin
  84649. * @param b defines point
  84650. * @returns a new Angle
  84651. */
  84652. static BetweenTwoPoints(a: DeepImmutable<Vector2>, b: DeepImmutable<Vector2>): Angle;
  84653. /**
  84654. * Gets a new Angle object from the given float in radians
  84655. * @param radians defines the angle value in radians
  84656. * @returns a new Angle
  84657. */
  84658. static FromRadians(radians: number): Angle;
  84659. /**
  84660. * Gets a new Angle object from the given float in degrees
  84661. * @param degrees defines the angle value in degrees
  84662. * @returns a new Angle
  84663. */
  84664. static FromDegrees(degrees: number): Angle;
  84665. }
  84666. /**
  84667. * This represents an arc in a 2d space.
  84668. */
  84669. export class Arc2 {
  84670. /** Defines the start point of the arc */
  84671. startPoint: Vector2;
  84672. /** Defines the mid point of the arc */
  84673. midPoint: Vector2;
  84674. /** Defines the end point of the arc */
  84675. endPoint: Vector2;
  84676. /**
  84677. * Defines the center point of the arc.
  84678. */
  84679. centerPoint: Vector2;
  84680. /**
  84681. * Defines the radius of the arc.
  84682. */
  84683. radius: number;
  84684. /**
  84685. * Defines the angle of the arc (from mid point to end point).
  84686. */
  84687. angle: Angle;
  84688. /**
  84689. * Defines the start angle of the arc (from start point to middle point).
  84690. */
  84691. startAngle: Angle;
  84692. /**
  84693. * Defines the orientation of the arc (clock wise/counter clock wise).
  84694. */
  84695. orientation: Orientation;
  84696. /**
  84697. * Creates an Arc object from the three given points : start, middle and end.
  84698. * @param startPoint Defines the start point of the arc
  84699. * @param midPoint Defines the midlle point of the arc
  84700. * @param endPoint Defines the end point of the arc
  84701. */
  84702. constructor(
  84703. /** Defines the start point of the arc */
  84704. startPoint: Vector2,
  84705. /** Defines the mid point of the arc */
  84706. midPoint: Vector2,
  84707. /** Defines the end point of the arc */
  84708. endPoint: Vector2);
  84709. }
  84710. /**
  84711. * Represents a 2D path made up of multiple 2D points
  84712. */
  84713. export class Path2 {
  84714. private _points;
  84715. private _length;
  84716. /**
  84717. * If the path start and end point are the same
  84718. */
  84719. closed: boolean;
  84720. /**
  84721. * Creates a Path2 object from the starting 2D coordinates x and y.
  84722. * @param x the starting points x value
  84723. * @param y the starting points y value
  84724. */
  84725. constructor(x: number, y: number);
  84726. /**
  84727. * Adds a new segment until the given coordinates (x, y) to the current Path2.
  84728. * @param x the added points x value
  84729. * @param y the added points y value
  84730. * @returns the updated Path2.
  84731. */
  84732. addLineTo(x: number, y: number): Path2;
  84733. /**
  84734. * 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.
  84735. * @param midX middle point x value
  84736. * @param midY middle point y value
  84737. * @param endX end point x value
  84738. * @param endY end point y value
  84739. * @param numberOfSegments (default: 36)
  84740. * @returns the updated Path2.
  84741. */
  84742. addArcTo(midX: number, midY: number, endX: number, endY: number, numberOfSegments?: number): Path2;
  84743. /**
  84744. * Closes the Path2.
  84745. * @returns the Path2.
  84746. */
  84747. close(): Path2;
  84748. /**
  84749. * Gets the sum of the distance between each sequential point in the path
  84750. * @returns the Path2 total length (float).
  84751. */
  84752. length(): number;
  84753. /**
  84754. * Gets the points which construct the path
  84755. * @returns the Path2 internal array of points.
  84756. */
  84757. getPoints(): Vector2[];
  84758. /**
  84759. * Retreives the point at the distance aways from the starting point
  84760. * @param normalizedLengthPosition the length along the path to retreive the point from
  84761. * @returns a new Vector2 located at a percentage of the Path2 total length on this path.
  84762. */
  84763. getPointAtLengthPosition(normalizedLengthPosition: number): Vector2;
  84764. /**
  84765. * Creates a new path starting from an x and y position
  84766. * @param x starting x value
  84767. * @param y starting y value
  84768. * @returns a new Path2 starting at the coordinates (x, y).
  84769. */
  84770. static StartingAt(x: number, y: number): Path2;
  84771. }
  84772. /**
  84773. * Represents a 3D path made up of multiple 3D points
  84774. */
  84775. export class Path3D {
  84776. /**
  84777. * an array of Vector3, the curve axis of the Path3D
  84778. */
  84779. path: Vector3[];
  84780. private _curve;
  84781. private _distances;
  84782. private _tangents;
  84783. private _normals;
  84784. private _binormals;
  84785. private _raw;
  84786. private _alignTangentsWithPath;
  84787. private readonly _pointAtData;
  84788. /**
  84789. * new Path3D(path, normal, raw)
  84790. * Creates a Path3D. A Path3D is a logical math object, so not a mesh.
  84791. * please read the description in the tutorial : https://doc.babylonjs.com/how_to/how_to_use_path3d
  84792. * @param path an array of Vector3, the curve axis of the Path3D
  84793. * @param firstNormal (options) Vector3, the first wanted normal to the curve. Ex (0, 1, 0) for a vertical normal.
  84794. * @param raw (optional, default false) : boolean, if true the returned Path3D isn't normalized. Useful to depict path acceleration or speed.
  84795. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path.
  84796. */
  84797. constructor(
  84798. /**
  84799. * an array of Vector3, the curve axis of the Path3D
  84800. */
  84801. path: Vector3[], firstNormal?: Nullable<Vector3>, raw?: boolean, alignTangentsWithPath?: boolean);
  84802. /**
  84803. * Returns the Path3D array of successive Vector3 designing its curve.
  84804. * @returns the Path3D array of successive Vector3 designing its curve.
  84805. */
  84806. getCurve(): Vector3[];
  84807. /**
  84808. * Returns the Path3D array of successive Vector3 designing its curve.
  84809. * @returns the Path3D array of successive Vector3 designing its curve.
  84810. */
  84811. getPoints(): Vector3[];
  84812. /**
  84813. * @returns the computed length (float) of the path.
  84814. */
  84815. length(): number;
  84816. /**
  84817. * Returns an array populated with tangent vectors on each Path3D curve point.
  84818. * @returns an array populated with tangent vectors on each Path3D curve point.
  84819. */
  84820. getTangents(): Vector3[];
  84821. /**
  84822. * Returns an array populated with normal vectors on each Path3D curve point.
  84823. * @returns an array populated with normal vectors on each Path3D curve point.
  84824. */
  84825. getNormals(): Vector3[];
  84826. /**
  84827. * Returns an array populated with binormal vectors on each Path3D curve point.
  84828. * @returns an array populated with binormal vectors on each Path3D curve point.
  84829. */
  84830. getBinormals(): Vector3[];
  84831. /**
  84832. * Returns an array populated with distances (float) of the i-th point from the first curve point.
  84833. * @returns an array populated with distances (float) of the i-th point from the first curve point.
  84834. */
  84835. getDistances(): number[];
  84836. /**
  84837. * Returns an interpolated point along this path
  84838. * @param position the position of the point along this path, from 0.0 to 1.0
  84839. * @returns a new Vector3 as the point
  84840. */
  84841. getPointAt(position: number): Vector3;
  84842. /**
  84843. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  84844. * @param position the position of the point along this path, from 0.0 to 1.0
  84845. * @param interpolated (optional, default false) : boolean, if true returns an interpolated tangent instead of the tangent of the previous path point.
  84846. * @returns a tangent vector corresponding to the interpolated Path3D curve point, if not interpolated, the tangent is taken from the precomputed tangents array.
  84847. */
  84848. getTangentAt(position: number, interpolated?: boolean): Vector3;
  84849. /**
  84850. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  84851. * @param position the position of the point along this path, from 0.0 to 1.0
  84852. * @param interpolated (optional, default false) : boolean, if true returns an interpolated normal instead of the normal of the previous path point.
  84853. * @returns a normal vector corresponding to the interpolated Path3D curve point, if not interpolated, the normal is taken from the precomputed normals array.
  84854. */
  84855. getNormalAt(position: number, interpolated?: boolean): Vector3;
  84856. /**
  84857. * Returns the binormal vector of an interpolated Path3D curve point at the specified position along this path.
  84858. * @param position the position of the point along this path, from 0.0 to 1.0
  84859. * @param interpolated (optional, default false) : boolean, if true returns an interpolated binormal instead of the binormal of the previous path point.
  84860. * @returns a binormal vector corresponding to the interpolated Path3D curve point, if not interpolated, the binormal is taken from the precomputed binormals array.
  84861. */
  84862. getBinormalAt(position: number, interpolated?: boolean): Vector3;
  84863. /**
  84864. * Returns the distance (float) of an interpolated Path3D curve point at the specified position along this path.
  84865. * @param position the position of the point along this path, from 0.0 to 1.0
  84866. * @returns the distance of the interpolated Path3D curve point at the specified position along this path.
  84867. */
  84868. getDistanceAt(position: number): number;
  84869. /**
  84870. * Returns the array index of the previous point of an interpolated point along this path
  84871. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  84872. * @returns the array index
  84873. */
  84874. getPreviousPointIndexAt(position: number): number;
  84875. /**
  84876. * 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)
  84877. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  84878. * @returns the sub position
  84879. */
  84880. getSubPositionAt(position: number): number;
  84881. /**
  84882. * Returns the position of the closest virtual point on this path to an arbitrary Vector3, from 0.0 to 1.0
  84883. * @param target the vector of which to get the closest position to
  84884. * @returns the position of the closest virtual point on this path to the target vector
  84885. */
  84886. getClosestPositionTo(target: Vector3): number;
  84887. /**
  84888. * Returns a sub path (slice) of this path
  84889. * @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
  84890. * @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
  84891. * @returns a sub path (slice) of this path
  84892. */
  84893. slice(start?: number, end?: number): Path3D;
  84894. /**
  84895. * Forces the Path3D tangent, normal, binormal and distance recomputation.
  84896. * @param path path which all values are copied into the curves points
  84897. * @param firstNormal which should be projected onto the curve
  84898. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path
  84899. * @returns the same object updated.
  84900. */
  84901. update(path: Vector3[], firstNormal?: Nullable<Vector3>, alignTangentsWithPath?: boolean): Path3D;
  84902. private _compute;
  84903. private _getFirstNonNullVector;
  84904. private _getLastNonNullVector;
  84905. private _normalVector;
  84906. /**
  84907. * Updates the point at data for an interpolated point along this curve
  84908. * @param position the position of the point along this curve, from 0.0 to 1.0
  84909. * @interpolateTNB wether to compute the interpolated tangent, normal and binormal
  84910. * @returns the (updated) point at data
  84911. */
  84912. private _updatePointAtData;
  84913. /**
  84914. * Updates the point at data from the specified parameters
  84915. * @param position where along the path the interpolated point is, from 0.0 to 1.0
  84916. * @param point the interpolated point
  84917. * @param parentIndex the index of an existing curve point that is on, or else positionally the first behind, the interpolated point
  84918. */
  84919. private _setPointAtData;
  84920. /**
  84921. * Updates the point at interpolation matrix for the tangents, normals and binormals
  84922. */
  84923. private _updateInterpolationMatrix;
  84924. }
  84925. /**
  84926. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  84927. * A Curve3 is designed from a series of successive Vector3.
  84928. * @see https://doc.babylonjs.com/how_to/how_to_use_curve3
  84929. */
  84930. export class Curve3 {
  84931. private _points;
  84932. private _length;
  84933. /**
  84934. * Returns a Curve3 object along a Quadratic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#quadratic-bezier-curve
  84935. * @param v0 (Vector3) the origin point of the Quadratic Bezier
  84936. * @param v1 (Vector3) the control point
  84937. * @param v2 (Vector3) the end point of the Quadratic Bezier
  84938. * @param nbPoints (integer) the wanted number of points in the curve
  84939. * @returns the created Curve3
  84940. */
  84941. static CreateQuadraticBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  84942. /**
  84943. * Returns a Curve3 object along a Cubic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#cubic-bezier-curve
  84944. * @param v0 (Vector3) the origin point of the Cubic Bezier
  84945. * @param v1 (Vector3) the first control point
  84946. * @param v2 (Vector3) the second control point
  84947. * @param v3 (Vector3) the end point of the Cubic Bezier
  84948. * @param nbPoints (integer) the wanted number of points in the curve
  84949. * @returns the created Curve3
  84950. */
  84951. static CreateCubicBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, v3: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  84952. /**
  84953. * Returns a Curve3 object along a Hermite Spline curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#hermite-spline
  84954. * @param p1 (Vector3) the origin point of the Hermite Spline
  84955. * @param t1 (Vector3) the tangent vector at the origin point
  84956. * @param p2 (Vector3) the end point of the Hermite Spline
  84957. * @param t2 (Vector3) the tangent vector at the end point
  84958. * @param nbPoints (integer) the wanted number of points in the curve
  84959. * @returns the created Curve3
  84960. */
  84961. static CreateHermiteSpline(p1: DeepImmutable<Vector3>, t1: DeepImmutable<Vector3>, p2: DeepImmutable<Vector3>, t2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  84962. /**
  84963. * Returns a Curve3 object along a CatmullRom Spline curve :
  84964. * @param points (array of Vector3) the points the spline must pass through. At least, four points required
  84965. * @param nbPoints (integer) the wanted number of points between each curve control points
  84966. * @param closed (boolean) optional with default false, when true forms a closed loop from the points
  84967. * @returns the created Curve3
  84968. */
  84969. static CreateCatmullRomSpline(points: DeepImmutable<Vector3[]>, nbPoints: number, closed?: boolean): Curve3;
  84970. /**
  84971. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  84972. * A Curve3 is designed from a series of successive Vector3.
  84973. * Tuto : https://doc.babylonjs.com/how_to/how_to_use_curve3#curve3-object
  84974. * @param points points which make up the curve
  84975. */
  84976. constructor(points: Vector3[]);
  84977. /**
  84978. * @returns the Curve3 stored array of successive Vector3
  84979. */
  84980. getPoints(): Vector3[];
  84981. /**
  84982. * @returns the computed length (float) of the curve.
  84983. */
  84984. length(): number;
  84985. /**
  84986. * Returns a new instance of Curve3 object : var curve = curveA.continue(curveB);
  84987. * This new Curve3 is built by translating and sticking the curveB at the end of the curveA.
  84988. * curveA and curveB keep unchanged.
  84989. * @param curve the curve to continue from this curve
  84990. * @returns the newly constructed curve
  84991. */
  84992. continue(curve: DeepImmutable<Curve3>): Curve3;
  84993. private _computeLength;
  84994. }
  84995. }
  84996. declare module BABYLON {
  84997. /**
  84998. * This represents the main contract an easing function should follow.
  84999. * Easing functions are used throughout the animation system.
  85000. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85001. */
  85002. export interface IEasingFunction {
  85003. /**
  85004. * Given an input gradient between 0 and 1, this returns the corrseponding value
  85005. * of the easing function.
  85006. * The link below provides some of the most common examples of easing functions.
  85007. * @see https://easings.net/
  85008. * @param gradient Defines the value between 0 and 1 we want the easing value for
  85009. * @returns the corresponding value on the curve defined by the easing function
  85010. */
  85011. ease(gradient: number): number;
  85012. }
  85013. /**
  85014. * Base class used for every default easing function.
  85015. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85016. */
  85017. export class EasingFunction implements IEasingFunction {
  85018. /**
  85019. * Interpolation follows the mathematical formula associated with the easing function.
  85020. */
  85021. static readonly EASINGMODE_EASEIN: number;
  85022. /**
  85023. * Interpolation follows 100% interpolation minus the output of the formula associated with the easing function.
  85024. */
  85025. static readonly EASINGMODE_EASEOUT: number;
  85026. /**
  85027. * Interpolation uses EaseIn for the first half of the animation and EaseOut for the second half.
  85028. */
  85029. static readonly EASINGMODE_EASEINOUT: number;
  85030. private _easingMode;
  85031. /**
  85032. * Sets the easing mode of the current function.
  85033. * @param easingMode Defines the willing mode (EASINGMODE_EASEIN, EASINGMODE_EASEOUT or EASINGMODE_EASEINOUT)
  85034. */
  85035. setEasingMode(easingMode: number): void;
  85036. /**
  85037. * Gets the current easing mode.
  85038. * @returns the easing mode
  85039. */
  85040. getEasingMode(): number;
  85041. /**
  85042. * @hidden
  85043. */
  85044. easeInCore(gradient: number): number;
  85045. /**
  85046. * Given an input gradient between 0 and 1, this returns the corresponding value
  85047. * of the easing function.
  85048. * @param gradient Defines the value between 0 and 1 we want the easing value for
  85049. * @returns the corresponding value on the curve defined by the easing function
  85050. */
  85051. ease(gradient: number): number;
  85052. }
  85053. /**
  85054. * Easing function with a circle shape (see link below).
  85055. * @see https://easings.net/#easeInCirc
  85056. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85057. */
  85058. export class CircleEase extends EasingFunction implements IEasingFunction {
  85059. /** @hidden */
  85060. easeInCore(gradient: number): number;
  85061. }
  85062. /**
  85063. * Easing function with a ease back shape (see link below).
  85064. * @see https://easings.net/#easeInBack
  85065. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85066. */
  85067. export class BackEase extends EasingFunction implements IEasingFunction {
  85068. /** Defines the amplitude of the function */
  85069. amplitude: number;
  85070. /**
  85071. * Instantiates a back ease easing
  85072. * @see https://easings.net/#easeInBack
  85073. * @param amplitude Defines the amplitude of the function
  85074. */
  85075. constructor(
  85076. /** Defines the amplitude of the function */
  85077. amplitude?: number);
  85078. /** @hidden */
  85079. easeInCore(gradient: number): number;
  85080. }
  85081. /**
  85082. * Easing function with a bouncing shape (see link below).
  85083. * @see https://easings.net/#easeInBounce
  85084. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85085. */
  85086. export class BounceEase extends EasingFunction implements IEasingFunction {
  85087. /** Defines the number of bounces */
  85088. bounces: number;
  85089. /** Defines the amplitude of the bounce */
  85090. bounciness: number;
  85091. /**
  85092. * Instantiates a bounce easing
  85093. * @see https://easings.net/#easeInBounce
  85094. * @param bounces Defines the number of bounces
  85095. * @param bounciness Defines the amplitude of the bounce
  85096. */
  85097. constructor(
  85098. /** Defines the number of bounces */
  85099. bounces?: number,
  85100. /** Defines the amplitude of the bounce */
  85101. bounciness?: number);
  85102. /** @hidden */
  85103. easeInCore(gradient: number): number;
  85104. }
  85105. /**
  85106. * Easing function with a power of 3 shape (see link below).
  85107. * @see https://easings.net/#easeInCubic
  85108. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85109. */
  85110. export class CubicEase extends EasingFunction implements IEasingFunction {
  85111. /** @hidden */
  85112. easeInCore(gradient: number): number;
  85113. }
  85114. /**
  85115. * Easing function with an elastic shape (see link below).
  85116. * @see https://easings.net/#easeInElastic
  85117. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85118. */
  85119. export class ElasticEase extends EasingFunction implements IEasingFunction {
  85120. /** Defines the number of oscillations*/
  85121. oscillations: number;
  85122. /** Defines the amplitude of the oscillations*/
  85123. springiness: number;
  85124. /**
  85125. * Instantiates an elastic easing function
  85126. * @see https://easings.net/#easeInElastic
  85127. * @param oscillations Defines the number of oscillations
  85128. * @param springiness Defines the amplitude of the oscillations
  85129. */
  85130. constructor(
  85131. /** Defines the number of oscillations*/
  85132. oscillations?: number,
  85133. /** Defines the amplitude of the oscillations*/
  85134. springiness?: number);
  85135. /** @hidden */
  85136. easeInCore(gradient: number): number;
  85137. }
  85138. /**
  85139. * Easing function with an exponential shape (see link below).
  85140. * @see https://easings.net/#easeInExpo
  85141. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85142. */
  85143. export class ExponentialEase extends EasingFunction implements IEasingFunction {
  85144. /** Defines the exponent of the function */
  85145. exponent: number;
  85146. /**
  85147. * Instantiates an exponential easing function
  85148. * @see https://easings.net/#easeInExpo
  85149. * @param exponent Defines the exponent of the function
  85150. */
  85151. constructor(
  85152. /** Defines the exponent of the function */
  85153. exponent?: number);
  85154. /** @hidden */
  85155. easeInCore(gradient: number): number;
  85156. }
  85157. /**
  85158. * Easing function with a power shape (see link below).
  85159. * @see https://easings.net/#easeInQuad
  85160. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85161. */
  85162. export class PowerEase extends EasingFunction implements IEasingFunction {
  85163. /** Defines the power of the function */
  85164. power: number;
  85165. /**
  85166. * Instantiates an power base easing function
  85167. * @see https://easings.net/#easeInQuad
  85168. * @param power Defines the power of the function
  85169. */
  85170. constructor(
  85171. /** Defines the power of the function */
  85172. power?: number);
  85173. /** @hidden */
  85174. easeInCore(gradient: number): number;
  85175. }
  85176. /**
  85177. * Easing function with a power of 2 shape (see link below).
  85178. * @see https://easings.net/#easeInQuad
  85179. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85180. */
  85181. export class QuadraticEase extends EasingFunction implements IEasingFunction {
  85182. /** @hidden */
  85183. easeInCore(gradient: number): number;
  85184. }
  85185. /**
  85186. * Easing function with a power of 4 shape (see link below).
  85187. * @see https://easings.net/#easeInQuart
  85188. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85189. */
  85190. export class QuarticEase extends EasingFunction implements IEasingFunction {
  85191. /** @hidden */
  85192. easeInCore(gradient: number): number;
  85193. }
  85194. /**
  85195. * Easing function with a power of 5 shape (see link below).
  85196. * @see https://easings.net/#easeInQuint
  85197. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85198. */
  85199. export class QuinticEase extends EasingFunction implements IEasingFunction {
  85200. /** @hidden */
  85201. easeInCore(gradient: number): number;
  85202. }
  85203. /**
  85204. * Easing function with a sin shape (see link below).
  85205. * @see https://easings.net/#easeInSine
  85206. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85207. */
  85208. export class SineEase extends EasingFunction implements IEasingFunction {
  85209. /** @hidden */
  85210. easeInCore(gradient: number): number;
  85211. }
  85212. /**
  85213. * Easing function with a bezier shape (see link below).
  85214. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  85215. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85216. */
  85217. export class BezierCurveEase extends EasingFunction implements IEasingFunction {
  85218. /** Defines the x component of the start tangent in the bezier curve */
  85219. x1: number;
  85220. /** Defines the y component of the start tangent in the bezier curve */
  85221. y1: number;
  85222. /** Defines the x component of the end tangent in the bezier curve */
  85223. x2: number;
  85224. /** Defines the y component of the end tangent in the bezier curve */
  85225. y2: number;
  85226. /**
  85227. * Instantiates a bezier function
  85228. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  85229. * @param x1 Defines the x component of the start tangent in the bezier curve
  85230. * @param y1 Defines the y component of the start tangent in the bezier curve
  85231. * @param x2 Defines the x component of the end tangent in the bezier curve
  85232. * @param y2 Defines the y component of the end tangent in the bezier curve
  85233. */
  85234. constructor(
  85235. /** Defines the x component of the start tangent in the bezier curve */
  85236. x1?: number,
  85237. /** Defines the y component of the start tangent in the bezier curve */
  85238. y1?: number,
  85239. /** Defines the x component of the end tangent in the bezier curve */
  85240. x2?: number,
  85241. /** Defines the y component of the end tangent in the bezier curve */
  85242. y2?: number);
  85243. /** @hidden */
  85244. easeInCore(gradient: number): number;
  85245. }
  85246. }
  85247. declare module BABYLON {
  85248. /**
  85249. * Class used to hold a RBG color
  85250. */
  85251. export class Color3 {
  85252. /**
  85253. * Defines the red component (between 0 and 1, default is 0)
  85254. */
  85255. r: number;
  85256. /**
  85257. * Defines the green component (between 0 and 1, default is 0)
  85258. */
  85259. g: number;
  85260. /**
  85261. * Defines the blue component (between 0 and 1, default is 0)
  85262. */
  85263. b: number;
  85264. /**
  85265. * Creates a new Color3 object from red, green, blue values, all between 0 and 1
  85266. * @param r defines the red component (between 0 and 1, default is 0)
  85267. * @param g defines the green component (between 0 and 1, default is 0)
  85268. * @param b defines the blue component (between 0 and 1, default is 0)
  85269. */
  85270. constructor(
  85271. /**
  85272. * Defines the red component (between 0 and 1, default is 0)
  85273. */
  85274. r?: number,
  85275. /**
  85276. * Defines the green component (between 0 and 1, default is 0)
  85277. */
  85278. g?: number,
  85279. /**
  85280. * Defines the blue component (between 0 and 1, default is 0)
  85281. */
  85282. b?: number);
  85283. /**
  85284. * Creates a string with the Color3 current values
  85285. * @returns the string representation of the Color3 object
  85286. */
  85287. toString(): string;
  85288. /**
  85289. * Returns the string "Color3"
  85290. * @returns "Color3"
  85291. */
  85292. getClassName(): string;
  85293. /**
  85294. * Compute the Color3 hash code
  85295. * @returns an unique number that can be used to hash Color3 objects
  85296. */
  85297. getHashCode(): number;
  85298. /**
  85299. * Stores in the given array from the given starting index the red, green, blue values as successive elements
  85300. * @param array defines the array where to store the r,g,b components
  85301. * @param index defines an optional index in the target array to define where to start storing values
  85302. * @returns the current Color3 object
  85303. */
  85304. toArray(array: FloatArray, index?: number): Color3;
  85305. /**
  85306. * Update the current color with values stored in an array from the starting index of the given array
  85307. * @param array defines the source array
  85308. * @param offset defines an offset in the source array
  85309. * @returns the current Color3 object
  85310. */
  85311. fromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  85312. /**
  85313. * Returns a new Color4 object from the current Color3 and the given alpha
  85314. * @param alpha defines the alpha component on the new Color4 object (default is 1)
  85315. * @returns a new Color4 object
  85316. */
  85317. toColor4(alpha?: number): Color4;
  85318. /**
  85319. * Returns a new array populated with 3 numeric elements : red, green and blue values
  85320. * @returns the new array
  85321. */
  85322. asArray(): number[];
  85323. /**
  85324. * Returns the luminance value
  85325. * @returns a float value
  85326. */
  85327. toLuminance(): number;
  85328. /**
  85329. * Multiply each Color3 rgb values by the given Color3 rgb values in a new Color3 object
  85330. * @param otherColor defines the second operand
  85331. * @returns the new Color3 object
  85332. */
  85333. multiply(otherColor: DeepImmutable<Color3>): Color3;
  85334. /**
  85335. * Multiply the rgb values of the Color3 and the given Color3 and stores the result in the object "result"
  85336. * @param otherColor defines the second operand
  85337. * @param result defines the Color3 object where to store the result
  85338. * @returns the current Color3
  85339. */
  85340. multiplyToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  85341. /**
  85342. * Determines equality between Color3 objects
  85343. * @param otherColor defines the second operand
  85344. * @returns true if the rgb values are equal to the given ones
  85345. */
  85346. equals(otherColor: DeepImmutable<Color3>): boolean;
  85347. /**
  85348. * Determines equality between the current Color3 object and a set of r,b,g values
  85349. * @param r defines the red component to check
  85350. * @param g defines the green component to check
  85351. * @param b defines the blue component to check
  85352. * @returns true if the rgb values are equal to the given ones
  85353. */
  85354. equalsFloats(r: number, g: number, b: number): boolean;
  85355. /**
  85356. * Multiplies in place each rgb value by scale
  85357. * @param scale defines the scaling factor
  85358. * @returns the updated Color3
  85359. */
  85360. scale(scale: number): Color3;
  85361. /**
  85362. * Multiplies the rgb values by scale and stores the result into "result"
  85363. * @param scale defines the scaling factor
  85364. * @param result defines the Color3 object where to store the result
  85365. * @returns the unmodified current Color3
  85366. */
  85367. scaleToRef(scale: number, result: Color3): Color3;
  85368. /**
  85369. * Scale the current Color3 values by a factor and add the result to a given Color3
  85370. * @param scale defines the scale factor
  85371. * @param result defines color to store the result into
  85372. * @returns the unmodified current Color3
  85373. */
  85374. scaleAndAddToRef(scale: number, result: Color3): Color3;
  85375. /**
  85376. * Clamps the rgb values by the min and max values and stores the result into "result"
  85377. * @param min defines minimum clamping value (default is 0)
  85378. * @param max defines maximum clamping value (default is 1)
  85379. * @param result defines color to store the result into
  85380. * @returns the original Color3
  85381. */
  85382. clampToRef(min: number | undefined, max: number | undefined, result: Color3): Color3;
  85383. /**
  85384. * Creates a new Color3 set with the added values of the current Color3 and of the given one
  85385. * @param otherColor defines the second operand
  85386. * @returns the new Color3
  85387. */
  85388. add(otherColor: DeepImmutable<Color3>): Color3;
  85389. /**
  85390. * Stores the result of the addition of the current Color3 and given one rgb values into "result"
  85391. * @param otherColor defines the second operand
  85392. * @param result defines Color3 object to store the result into
  85393. * @returns the unmodified current Color3
  85394. */
  85395. addToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  85396. /**
  85397. * Returns a new Color3 set with the subtracted values of the given one from the current Color3
  85398. * @param otherColor defines the second operand
  85399. * @returns the new Color3
  85400. */
  85401. subtract(otherColor: DeepImmutable<Color3>): Color3;
  85402. /**
  85403. * Stores the result of the subtraction of given one from the current Color3 rgb values into "result"
  85404. * @param otherColor defines the second operand
  85405. * @param result defines Color3 object to store the result into
  85406. * @returns the unmodified current Color3
  85407. */
  85408. subtractToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  85409. /**
  85410. * Copy the current object
  85411. * @returns a new Color3 copied the current one
  85412. */
  85413. clone(): Color3;
  85414. /**
  85415. * Copies the rgb values from the source in the current Color3
  85416. * @param source defines the source Color3 object
  85417. * @returns the updated Color3 object
  85418. */
  85419. copyFrom(source: DeepImmutable<Color3>): Color3;
  85420. /**
  85421. * Updates the Color3 rgb values from the given floats
  85422. * @param r defines the red component to read from
  85423. * @param g defines the green component to read from
  85424. * @param b defines the blue component to read from
  85425. * @returns the current Color3 object
  85426. */
  85427. copyFromFloats(r: number, g: number, b: number): Color3;
  85428. /**
  85429. * Updates the Color3 rgb values from the given floats
  85430. * @param r defines the red component to read from
  85431. * @param g defines the green component to read from
  85432. * @param b defines the blue component to read from
  85433. * @returns the current Color3 object
  85434. */
  85435. set(r: number, g: number, b: number): Color3;
  85436. /**
  85437. * Compute the Color3 hexadecimal code as a string
  85438. * @returns a string containing the hexadecimal representation of the Color3 object
  85439. */
  85440. toHexString(): string;
  85441. /**
  85442. * Computes a new Color3 converted from the current one to linear space
  85443. * @returns a new Color3 object
  85444. */
  85445. toLinearSpace(): Color3;
  85446. /**
  85447. * Converts current color in rgb space to HSV values
  85448. * @returns a new color3 representing the HSV values
  85449. */
  85450. toHSV(): Color3;
  85451. /**
  85452. * Converts current color in rgb space to HSV values
  85453. * @param result defines the Color3 where to store the HSV values
  85454. */
  85455. toHSVToRef(result: Color3): void;
  85456. /**
  85457. * Converts the Color3 values to linear space and stores the result in "convertedColor"
  85458. * @param convertedColor defines the Color3 object where to store the linear space version
  85459. * @returns the unmodified Color3
  85460. */
  85461. toLinearSpaceToRef(convertedColor: Color3): Color3;
  85462. /**
  85463. * Computes a new Color3 converted from the current one to gamma space
  85464. * @returns a new Color3 object
  85465. */
  85466. toGammaSpace(): Color3;
  85467. /**
  85468. * Converts the Color3 values to gamma space and stores the result in "convertedColor"
  85469. * @param convertedColor defines the Color3 object where to store the gamma space version
  85470. * @returns the unmodified Color3
  85471. */
  85472. toGammaSpaceToRef(convertedColor: Color3): Color3;
  85473. private static _BlackReadOnly;
  85474. /**
  85475. * Convert Hue, saturation and value to a Color3 (RGB)
  85476. * @param hue defines the hue
  85477. * @param saturation defines the saturation
  85478. * @param value defines the value
  85479. * @param result defines the Color3 where to store the RGB values
  85480. */
  85481. static HSVtoRGBToRef(hue: number, saturation: number, value: number, result: Color3): void;
  85482. /**
  85483. * Creates a new Color3 from the string containing valid hexadecimal values
  85484. * @param hex defines a string containing valid hexadecimal values
  85485. * @returns a new Color3 object
  85486. */
  85487. static FromHexString(hex: string): Color3;
  85488. /**
  85489. * Creates a new Color3 from the starting index of the given array
  85490. * @param array defines the source array
  85491. * @param offset defines an offset in the source array
  85492. * @returns a new Color3 object
  85493. */
  85494. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  85495. /**
  85496. * Creates a new Color3 from the starting index element of the given array
  85497. * @param array defines the source array to read from
  85498. * @param offset defines the offset in the source array
  85499. * @param result defines the target Color3 object
  85500. */
  85501. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number | undefined, result: Color3): void;
  85502. /**
  85503. * Creates a new Color3 from integer values (< 256)
  85504. * @param r defines the red component to read from (value between 0 and 255)
  85505. * @param g defines the green component to read from (value between 0 and 255)
  85506. * @param b defines the blue component to read from (value between 0 and 255)
  85507. * @returns a new Color3 object
  85508. */
  85509. static FromInts(r: number, g: number, b: number): Color3;
  85510. /**
  85511. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  85512. * @param start defines the start Color3 value
  85513. * @param end defines the end Color3 value
  85514. * @param amount defines the gradient value between start and end
  85515. * @returns a new Color3 object
  85516. */
  85517. static Lerp(start: DeepImmutable<Color3>, end: DeepImmutable<Color3>, amount: number): Color3;
  85518. /**
  85519. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  85520. * @param left defines the start value
  85521. * @param right defines the end value
  85522. * @param amount defines the gradient factor
  85523. * @param result defines the Color3 object where to store the result
  85524. */
  85525. static LerpToRef(left: DeepImmutable<Color3>, right: DeepImmutable<Color3>, amount: number, result: Color3): void;
  85526. /**
  85527. * Returns a Color3 value containing a red color
  85528. * @returns a new Color3 object
  85529. */
  85530. static Red(): Color3;
  85531. /**
  85532. * Returns a Color3 value containing a green color
  85533. * @returns a new Color3 object
  85534. */
  85535. static Green(): Color3;
  85536. /**
  85537. * Returns a Color3 value containing a blue color
  85538. * @returns a new Color3 object
  85539. */
  85540. static Blue(): Color3;
  85541. /**
  85542. * Returns a Color3 value containing a black color
  85543. * @returns a new Color3 object
  85544. */
  85545. static Black(): Color3;
  85546. /**
  85547. * Gets a Color3 value containing a black color that must not be updated
  85548. */
  85549. static get BlackReadOnly(): DeepImmutable<Color3>;
  85550. /**
  85551. * Returns a Color3 value containing a white color
  85552. * @returns a new Color3 object
  85553. */
  85554. static White(): Color3;
  85555. /**
  85556. * Returns a Color3 value containing a purple color
  85557. * @returns a new Color3 object
  85558. */
  85559. static Purple(): Color3;
  85560. /**
  85561. * Returns a Color3 value containing a magenta color
  85562. * @returns a new Color3 object
  85563. */
  85564. static Magenta(): Color3;
  85565. /**
  85566. * Returns a Color3 value containing a yellow color
  85567. * @returns a new Color3 object
  85568. */
  85569. static Yellow(): Color3;
  85570. /**
  85571. * Returns a Color3 value containing a gray color
  85572. * @returns a new Color3 object
  85573. */
  85574. static Gray(): Color3;
  85575. /**
  85576. * Returns a Color3 value containing a teal color
  85577. * @returns a new Color3 object
  85578. */
  85579. static Teal(): Color3;
  85580. /**
  85581. * Returns a Color3 value containing a random color
  85582. * @returns a new Color3 object
  85583. */
  85584. static Random(): Color3;
  85585. }
  85586. /**
  85587. * Class used to hold a RBGA color
  85588. */
  85589. export class Color4 {
  85590. /**
  85591. * Defines the red component (between 0 and 1, default is 0)
  85592. */
  85593. r: number;
  85594. /**
  85595. * Defines the green component (between 0 and 1, default is 0)
  85596. */
  85597. g: number;
  85598. /**
  85599. * Defines the blue component (between 0 and 1, default is 0)
  85600. */
  85601. b: number;
  85602. /**
  85603. * Defines the alpha component (between 0 and 1, default is 1)
  85604. */
  85605. a: number;
  85606. /**
  85607. * Creates a new Color4 object from red, green, blue values, all between 0 and 1
  85608. * @param r defines the red component (between 0 and 1, default is 0)
  85609. * @param g defines the green component (between 0 and 1, default is 0)
  85610. * @param b defines the blue component (between 0 and 1, default is 0)
  85611. * @param a defines the alpha component (between 0 and 1, default is 1)
  85612. */
  85613. constructor(
  85614. /**
  85615. * Defines the red component (between 0 and 1, default is 0)
  85616. */
  85617. r?: number,
  85618. /**
  85619. * Defines the green component (between 0 and 1, default is 0)
  85620. */
  85621. g?: number,
  85622. /**
  85623. * Defines the blue component (between 0 and 1, default is 0)
  85624. */
  85625. b?: number,
  85626. /**
  85627. * Defines the alpha component (between 0 and 1, default is 1)
  85628. */
  85629. a?: number);
  85630. /**
  85631. * Adds in place the given Color4 values to the current Color4 object
  85632. * @param right defines the second operand
  85633. * @returns the current updated Color4 object
  85634. */
  85635. addInPlace(right: DeepImmutable<Color4>): Color4;
  85636. /**
  85637. * Creates a new array populated with 4 numeric elements : red, green, blue, alpha values
  85638. * @returns the new array
  85639. */
  85640. asArray(): number[];
  85641. /**
  85642. * Stores from the starting index in the given array the Color4 successive values
  85643. * @param array defines the array where to store the r,g,b components
  85644. * @param index defines an optional index in the target array to define where to start storing values
  85645. * @returns the current Color4 object
  85646. */
  85647. toArray(array: number[], index?: number): Color4;
  85648. /**
  85649. * Update the current color with values stored in an array from the starting index of the given array
  85650. * @param array defines the source array
  85651. * @param offset defines an offset in the source array
  85652. * @returns the current Color4 object
  85653. */
  85654. fromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  85655. /**
  85656. * Determines equality between Color4 objects
  85657. * @param otherColor defines the second operand
  85658. * @returns true if the rgba values are equal to the given ones
  85659. */
  85660. equals(otherColor: DeepImmutable<Color4>): boolean;
  85661. /**
  85662. * Creates a new Color4 set with the added values of the current Color4 and of the given one
  85663. * @param right defines the second operand
  85664. * @returns a new Color4 object
  85665. */
  85666. add(right: DeepImmutable<Color4>): Color4;
  85667. /**
  85668. * Creates a new Color4 set with the subtracted values of the given one from the current Color4
  85669. * @param right defines the second operand
  85670. * @returns a new Color4 object
  85671. */
  85672. subtract(right: DeepImmutable<Color4>): Color4;
  85673. /**
  85674. * Subtracts the given ones from the current Color4 values and stores the results in "result"
  85675. * @param right defines the second operand
  85676. * @param result defines the Color4 object where to store the result
  85677. * @returns the current Color4 object
  85678. */
  85679. subtractToRef(right: DeepImmutable<Color4>, result: Color4): Color4;
  85680. /**
  85681. * Creates a new Color4 with the current Color4 values multiplied by scale
  85682. * @param scale defines the scaling factor to apply
  85683. * @returns a new Color4 object
  85684. */
  85685. scale(scale: number): Color4;
  85686. /**
  85687. * Multiplies the current Color4 values by scale and stores the result in "result"
  85688. * @param scale defines the scaling factor to apply
  85689. * @param result defines the Color4 object where to store the result
  85690. * @returns the current unmodified Color4
  85691. */
  85692. scaleToRef(scale: number, result: Color4): Color4;
  85693. /**
  85694. * Scale the current Color4 values by a factor and add the result to a given Color4
  85695. * @param scale defines the scale factor
  85696. * @param result defines the Color4 object where to store the result
  85697. * @returns the unmodified current Color4
  85698. */
  85699. scaleAndAddToRef(scale: number, result: Color4): Color4;
  85700. /**
  85701. * Clamps the rgb values by the min and max values and stores the result into "result"
  85702. * @param min defines minimum clamping value (default is 0)
  85703. * @param max defines maximum clamping value (default is 1)
  85704. * @param result defines color to store the result into.
  85705. * @returns the cuurent Color4
  85706. */
  85707. clampToRef(min: number | undefined, max: number | undefined, result: Color4): Color4;
  85708. /**
  85709. * Multipy an Color4 value by another and return a new Color4 object
  85710. * @param color defines the Color4 value to multiply by
  85711. * @returns a new Color4 object
  85712. */
  85713. multiply(color: Color4): Color4;
  85714. /**
  85715. * Multipy a Color4 value by another and push the result in a reference value
  85716. * @param color defines the Color4 value to multiply by
  85717. * @param result defines the Color4 to fill the result in
  85718. * @returns the result Color4
  85719. */
  85720. multiplyToRef(color: Color4, result: Color4): Color4;
  85721. /**
  85722. * Creates a string with the Color4 current values
  85723. * @returns the string representation of the Color4 object
  85724. */
  85725. toString(): string;
  85726. /**
  85727. * Returns the string "Color4"
  85728. * @returns "Color4"
  85729. */
  85730. getClassName(): string;
  85731. /**
  85732. * Compute the Color4 hash code
  85733. * @returns an unique number that can be used to hash Color4 objects
  85734. */
  85735. getHashCode(): number;
  85736. /**
  85737. * Creates a new Color4 copied from the current one
  85738. * @returns a new Color4 object
  85739. */
  85740. clone(): Color4;
  85741. /**
  85742. * Copies the given Color4 values into the current one
  85743. * @param source defines the source Color4 object
  85744. * @returns the current updated Color4 object
  85745. */
  85746. copyFrom(source: Color4): Color4;
  85747. /**
  85748. * Copies the given float values into the current one
  85749. * @param r defines the red component to read from
  85750. * @param g defines the green component to read from
  85751. * @param b defines the blue component to read from
  85752. * @param a defines the alpha component to read from
  85753. * @returns the current updated Color4 object
  85754. */
  85755. copyFromFloats(r: number, g: number, b: number, a: number): Color4;
  85756. /**
  85757. * Copies the given float values into the current one
  85758. * @param r defines the red component to read from
  85759. * @param g defines the green component to read from
  85760. * @param b defines the blue component to read from
  85761. * @param a defines the alpha component to read from
  85762. * @returns the current updated Color4 object
  85763. */
  85764. set(r: number, g: number, b: number, a: number): Color4;
  85765. /**
  85766. * Compute the Color4 hexadecimal code as a string
  85767. * @param returnAsColor3 defines if the string should only contains RGB values (off by default)
  85768. * @returns a string containing the hexadecimal representation of the Color4 object
  85769. */
  85770. toHexString(returnAsColor3?: boolean): string;
  85771. /**
  85772. * Computes a new Color4 converted from the current one to linear space
  85773. * @returns a new Color4 object
  85774. */
  85775. toLinearSpace(): Color4;
  85776. /**
  85777. * Converts the Color4 values to linear space and stores the result in "convertedColor"
  85778. * @param convertedColor defines the Color4 object where to store the linear space version
  85779. * @returns the unmodified Color4
  85780. */
  85781. toLinearSpaceToRef(convertedColor: Color4): Color4;
  85782. /**
  85783. * Computes a new Color4 converted from the current one to gamma space
  85784. * @returns a new Color4 object
  85785. */
  85786. toGammaSpace(): Color4;
  85787. /**
  85788. * Converts the Color4 values to gamma space and stores the result in "convertedColor"
  85789. * @param convertedColor defines the Color4 object where to store the gamma space version
  85790. * @returns the unmodified Color4
  85791. */
  85792. toGammaSpaceToRef(convertedColor: Color4): Color4;
  85793. /**
  85794. * Creates a new Color4 from the string containing valid hexadecimal values
  85795. * @param hex defines a string containing valid hexadecimal values
  85796. * @returns a new Color4 object
  85797. */
  85798. static FromHexString(hex: string): Color4;
  85799. /**
  85800. * Creates a new Color4 object set with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  85801. * @param left defines the start value
  85802. * @param right defines the end value
  85803. * @param amount defines the gradient factor
  85804. * @returns a new Color4 object
  85805. */
  85806. static Lerp(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number): Color4;
  85807. /**
  85808. * Set the given "result" with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  85809. * @param left defines the start value
  85810. * @param right defines the end value
  85811. * @param amount defines the gradient factor
  85812. * @param result defines the Color4 object where to store data
  85813. */
  85814. static LerpToRef(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number, result: Color4): void;
  85815. /**
  85816. * Creates a new Color4 from a Color3 and an alpha value
  85817. * @param color3 defines the source Color3 to read from
  85818. * @param alpha defines the alpha component (1.0 by default)
  85819. * @returns a new Color4 object
  85820. */
  85821. static FromColor3(color3: DeepImmutable<Color3>, alpha?: number): Color4;
  85822. /**
  85823. * Creates a new Color4 from the starting index element of the given array
  85824. * @param array defines the source array to read from
  85825. * @param offset defines the offset in the source array
  85826. * @returns a new Color4 object
  85827. */
  85828. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  85829. /**
  85830. * Creates a new Color4 from the starting index element of the given array
  85831. * @param array defines the source array to read from
  85832. * @param offset defines the offset in the source array
  85833. * @param result defines the target Color4 object
  85834. */
  85835. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number | undefined, result: Color4): void;
  85836. /**
  85837. * Creates a new Color3 from integer values (< 256)
  85838. * @param r defines the red component to read from (value between 0 and 255)
  85839. * @param g defines the green component to read from (value between 0 and 255)
  85840. * @param b defines the blue component to read from (value between 0 and 255)
  85841. * @param a defines the alpha component to read from (value between 0 and 255)
  85842. * @returns a new Color3 object
  85843. */
  85844. static FromInts(r: number, g: number, b: number, a: number): Color4;
  85845. /**
  85846. * Check the content of a given array and convert it to an array containing RGBA data
  85847. * If the original array was already containing count * 4 values then it is returned directly
  85848. * @param colors defines the array to check
  85849. * @param count defines the number of RGBA data to expect
  85850. * @returns an array containing count * 4 values (RGBA)
  85851. */
  85852. static CheckColors4(colors: number[], count: number): number[];
  85853. }
  85854. /**
  85855. * @hidden
  85856. */
  85857. export class TmpColors {
  85858. static Color3: Color3[];
  85859. static Color4: Color4[];
  85860. }
  85861. }
  85862. declare module BABYLON {
  85863. /**
  85864. * Defines an interface which represents an animation key frame
  85865. */
  85866. export interface IAnimationKey {
  85867. /**
  85868. * Frame of the key frame
  85869. */
  85870. frame: number;
  85871. /**
  85872. * Value at the specifies key frame
  85873. */
  85874. value: any;
  85875. /**
  85876. * The input tangent for the cubic hermite spline
  85877. */
  85878. inTangent?: any;
  85879. /**
  85880. * The output tangent for the cubic hermite spline
  85881. */
  85882. outTangent?: any;
  85883. /**
  85884. * The animation interpolation type
  85885. */
  85886. interpolation?: AnimationKeyInterpolation;
  85887. }
  85888. /**
  85889. * Enum for the animation key frame interpolation type
  85890. */
  85891. export enum AnimationKeyInterpolation {
  85892. /**
  85893. * Do not interpolate between keys and use the start key value only. Tangents are ignored
  85894. */
  85895. STEP = 1
  85896. }
  85897. }
  85898. declare module BABYLON {
  85899. /**
  85900. * Represents the range of an animation
  85901. */
  85902. export class AnimationRange {
  85903. /**The name of the animation range**/
  85904. name: string;
  85905. /**The starting frame of the animation */
  85906. from: number;
  85907. /**The ending frame of the animation*/
  85908. to: number;
  85909. /**
  85910. * Initializes the range of an animation
  85911. * @param name The name of the animation range
  85912. * @param from The starting frame of the animation
  85913. * @param to The ending frame of the animation
  85914. */
  85915. constructor(
  85916. /**The name of the animation range**/
  85917. name: string,
  85918. /**The starting frame of the animation */
  85919. from: number,
  85920. /**The ending frame of the animation*/
  85921. to: number);
  85922. /**
  85923. * Makes a copy of the animation range
  85924. * @returns A copy of the animation range
  85925. */
  85926. clone(): AnimationRange;
  85927. }
  85928. }
  85929. declare module BABYLON {
  85930. /**
  85931. * Composed of a frame, and an action function
  85932. */
  85933. export class AnimationEvent {
  85934. /** The frame for which the event is triggered **/
  85935. frame: number;
  85936. /** The event to perform when triggered **/
  85937. action: (currentFrame: number) => void;
  85938. /** Specifies if the event should be triggered only once**/
  85939. onlyOnce?: boolean | undefined;
  85940. /**
  85941. * Specifies if the animation event is done
  85942. */
  85943. isDone: boolean;
  85944. /**
  85945. * Initializes the animation event
  85946. * @param frame The frame for which the event is triggered
  85947. * @param action The event to perform when triggered
  85948. * @param onlyOnce Specifies if the event should be triggered only once
  85949. */
  85950. constructor(
  85951. /** The frame for which the event is triggered **/
  85952. frame: number,
  85953. /** The event to perform when triggered **/
  85954. action: (currentFrame: number) => void,
  85955. /** Specifies if the event should be triggered only once**/
  85956. onlyOnce?: boolean | undefined);
  85957. /** @hidden */
  85958. _clone(): AnimationEvent;
  85959. }
  85960. }
  85961. declare module BABYLON {
  85962. /**
  85963. * Interface used to define a behavior
  85964. */
  85965. export interface Behavior<T> {
  85966. /** gets or sets behavior's name */
  85967. name: string;
  85968. /**
  85969. * Function called when the behavior needs to be initialized (after attaching it to a target)
  85970. */
  85971. init(): void;
  85972. /**
  85973. * Called when the behavior is attached to a target
  85974. * @param target defines the target where the behavior is attached to
  85975. */
  85976. attach(target: T): void;
  85977. /**
  85978. * Called when the behavior is detached from its target
  85979. */
  85980. detach(): void;
  85981. }
  85982. /**
  85983. * Interface implemented by classes supporting behaviors
  85984. */
  85985. export interface IBehaviorAware<T> {
  85986. /**
  85987. * Attach a behavior
  85988. * @param behavior defines the behavior to attach
  85989. * @returns the current host
  85990. */
  85991. addBehavior(behavior: Behavior<T>): T;
  85992. /**
  85993. * Remove a behavior from the current object
  85994. * @param behavior defines the behavior to detach
  85995. * @returns the current host
  85996. */
  85997. removeBehavior(behavior: Behavior<T>): T;
  85998. /**
  85999. * Gets a behavior using its name to search
  86000. * @param name defines the name to search
  86001. * @returns the behavior or null if not found
  86002. */
  86003. getBehaviorByName(name: string): Nullable<Behavior<T>>;
  86004. }
  86005. }
  86006. declare module BABYLON {
  86007. /**
  86008. * Defines an array and its length.
  86009. * It can be helpfull to group result from both Arrays and smart arrays in one structure.
  86010. */
  86011. export interface ISmartArrayLike<T> {
  86012. /**
  86013. * The data of the array.
  86014. */
  86015. data: Array<T>;
  86016. /**
  86017. * The active length of the array.
  86018. */
  86019. length: number;
  86020. }
  86021. /**
  86022. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  86023. */
  86024. export class SmartArray<T> implements ISmartArrayLike<T> {
  86025. /**
  86026. * The full set of data from the array.
  86027. */
  86028. data: Array<T>;
  86029. /**
  86030. * The active length of the array.
  86031. */
  86032. length: number;
  86033. protected _id: number;
  86034. /**
  86035. * Instantiates a Smart Array.
  86036. * @param capacity defines the default capacity of the array.
  86037. */
  86038. constructor(capacity: number);
  86039. /**
  86040. * Pushes a value at the end of the active data.
  86041. * @param value defines the object to push in the array.
  86042. */
  86043. push(value: T): void;
  86044. /**
  86045. * Iterates over the active data and apply the lambda to them.
  86046. * @param func defines the action to apply on each value.
  86047. */
  86048. forEach(func: (content: T) => void): void;
  86049. /**
  86050. * Sorts the full sets of data.
  86051. * @param compareFn defines the comparison function to apply.
  86052. */
  86053. sort(compareFn: (a: T, b: T) => number): void;
  86054. /**
  86055. * Resets the active data to an empty array.
  86056. */
  86057. reset(): void;
  86058. /**
  86059. * Releases all the data from the array as well as the array.
  86060. */
  86061. dispose(): void;
  86062. /**
  86063. * Concats the active data with a given array.
  86064. * @param array defines the data to concatenate with.
  86065. */
  86066. concat(array: any): void;
  86067. /**
  86068. * Returns the position of a value in the active data.
  86069. * @param value defines the value to find the index for
  86070. * @returns the index if found in the active data otherwise -1
  86071. */
  86072. indexOf(value: T): number;
  86073. /**
  86074. * Returns whether an element is part of the active data.
  86075. * @param value defines the value to look for
  86076. * @returns true if found in the active data otherwise false
  86077. */
  86078. contains(value: T): boolean;
  86079. private static _GlobalId;
  86080. }
  86081. /**
  86082. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  86083. * The data in this array can only be present once
  86084. */
  86085. export class SmartArrayNoDuplicate<T> extends SmartArray<T> {
  86086. private _duplicateId;
  86087. /**
  86088. * Pushes a value at the end of the active data.
  86089. * THIS DOES NOT PREVENT DUPPLICATE DATA
  86090. * @param value defines the object to push in the array.
  86091. */
  86092. push(value: T): void;
  86093. /**
  86094. * Pushes a value at the end of the active data.
  86095. * If the data is already present, it won t be added again
  86096. * @param value defines the object to push in the array.
  86097. * @returns true if added false if it was already present
  86098. */
  86099. pushNoDuplicate(value: T): boolean;
  86100. /**
  86101. * Resets the active data to an empty array.
  86102. */
  86103. reset(): void;
  86104. /**
  86105. * Concats the active data with a given array.
  86106. * This ensures no dupplicate will be present in the result.
  86107. * @param array defines the data to concatenate with.
  86108. */
  86109. concatWithNoDuplicate(array: any): void;
  86110. }
  86111. }
  86112. declare module BABYLON {
  86113. /**
  86114. * @ignore
  86115. * This is a list of all the different input types that are available in the application.
  86116. * Fo instance: ArcRotateCameraGamepadInput...
  86117. */
  86118. export var CameraInputTypes: {};
  86119. /**
  86120. * This is the contract to implement in order to create a new input class.
  86121. * Inputs are dealing with listening to user actions and moving the camera accordingly.
  86122. */
  86123. export interface ICameraInput<TCamera extends Camera> {
  86124. /**
  86125. * Defines the camera the input is attached to.
  86126. */
  86127. camera: Nullable<TCamera>;
  86128. /**
  86129. * Gets the class name of the current intput.
  86130. * @returns the class name
  86131. */
  86132. getClassName(): string;
  86133. /**
  86134. * Get the friendly name associated with the input class.
  86135. * @returns the input friendly name
  86136. */
  86137. getSimpleName(): string;
  86138. /**
  86139. * Attach the input controls to a specific dom element to get the input from.
  86140. * @param element Defines the element the controls should be listened from
  86141. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  86142. */
  86143. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  86144. /**
  86145. * Detach the current controls from the specified dom element.
  86146. * @param element Defines the element to stop listening the inputs from
  86147. */
  86148. detachControl(element: Nullable<HTMLElement>): void;
  86149. /**
  86150. * Update the current camera state depending on the inputs that have been used this frame.
  86151. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  86152. */
  86153. checkInputs?: () => void;
  86154. }
  86155. /**
  86156. * Represents a map of input types to input instance or input index to input instance.
  86157. */
  86158. export interface CameraInputsMap<TCamera extends Camera> {
  86159. /**
  86160. * Accessor to the input by input type.
  86161. */
  86162. [name: string]: ICameraInput<TCamera>;
  86163. /**
  86164. * Accessor to the input by input index.
  86165. */
  86166. [idx: number]: ICameraInput<TCamera>;
  86167. }
  86168. /**
  86169. * This represents the input manager used within a camera.
  86170. * It helps dealing with all the different kind of input attached to a camera.
  86171. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  86172. */
  86173. export class CameraInputsManager<TCamera extends Camera> {
  86174. /**
  86175. * Defines the list of inputs attahed to the camera.
  86176. */
  86177. attached: CameraInputsMap<TCamera>;
  86178. /**
  86179. * Defines the dom element the camera is collecting inputs from.
  86180. * This is null if the controls have not been attached.
  86181. */
  86182. attachedElement: Nullable<HTMLElement>;
  86183. /**
  86184. * Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  86185. */
  86186. noPreventDefault: boolean;
  86187. /**
  86188. * Defined the camera the input manager belongs to.
  86189. */
  86190. camera: TCamera;
  86191. /**
  86192. * Update the current camera state depending on the inputs that have been used this frame.
  86193. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  86194. */
  86195. checkInputs: () => void;
  86196. /**
  86197. * Instantiate a new Camera Input Manager.
  86198. * @param camera Defines the camera the input manager blongs to
  86199. */
  86200. constructor(camera: TCamera);
  86201. /**
  86202. * Add an input method to a camera
  86203. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  86204. * @param input camera input method
  86205. */
  86206. add(input: ICameraInput<TCamera>): void;
  86207. /**
  86208. * Remove a specific input method from a camera
  86209. * example: camera.inputs.remove(camera.inputs.attached.mouse);
  86210. * @param inputToRemove camera input method
  86211. */
  86212. remove(inputToRemove: ICameraInput<TCamera>): void;
  86213. /**
  86214. * Remove a specific input type from a camera
  86215. * example: camera.inputs.remove("ArcRotateCameraGamepadInput");
  86216. * @param inputType the type of the input to remove
  86217. */
  86218. removeByType(inputType: string): void;
  86219. private _addCheckInputs;
  86220. /**
  86221. * Attach the input controls to the currently attached dom element to listen the events from.
  86222. * @param input Defines the input to attach
  86223. */
  86224. attachInput(input: ICameraInput<TCamera>): void;
  86225. /**
  86226. * Attach the current manager inputs controls to a specific dom element to listen the events from.
  86227. * @param element Defines the dom element to collect the events from
  86228. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  86229. */
  86230. attachElement(element: HTMLElement, noPreventDefault?: boolean): void;
  86231. /**
  86232. * Detach the current manager inputs controls from a specific dom element.
  86233. * @param element Defines the dom element to collect the events from
  86234. * @param disconnect Defines whether the input should be removed from the current list of attached inputs
  86235. */
  86236. detachElement(element: HTMLElement, disconnect?: boolean): void;
  86237. /**
  86238. * Rebuild the dynamic inputCheck function from the current list of
  86239. * defined inputs in the manager.
  86240. */
  86241. rebuildInputCheck(): void;
  86242. /**
  86243. * Remove all attached input methods from a camera
  86244. */
  86245. clear(): void;
  86246. /**
  86247. * Serialize the current input manager attached to a camera.
  86248. * This ensures than once parsed,
  86249. * the input associated to the camera will be identical to the current ones
  86250. * @param serializedCamera Defines the camera serialization JSON the input serialization should write to
  86251. */
  86252. serialize(serializedCamera: any): void;
  86253. /**
  86254. * Parses an input manager serialized JSON to restore the previous list of inputs
  86255. * and states associated to a camera.
  86256. * @param parsedCamera Defines the JSON to parse
  86257. */
  86258. parse(parsedCamera: any): void;
  86259. }
  86260. }
  86261. declare module BABYLON {
  86262. /**
  86263. * Class used to store data that will be store in GPU memory
  86264. */
  86265. export class Buffer {
  86266. private _engine;
  86267. private _buffer;
  86268. /** @hidden */
  86269. _data: Nullable<DataArray>;
  86270. private _updatable;
  86271. private _instanced;
  86272. private _divisor;
  86273. /**
  86274. * Gets the byte stride.
  86275. */
  86276. readonly byteStride: number;
  86277. /**
  86278. * Constructor
  86279. * @param engine the engine
  86280. * @param data the data to use for this buffer
  86281. * @param updatable whether the data is updatable
  86282. * @param stride the stride (optional)
  86283. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  86284. * @param instanced whether the buffer is instanced (optional)
  86285. * @param useBytes set to true if the stride in in bytes (optional)
  86286. * @param divisor sets an optional divisor for instances (1 by default)
  86287. */
  86288. constructor(engine: any, data: DataArray, updatable: boolean, stride?: number, postponeInternalCreation?: boolean, instanced?: boolean, useBytes?: boolean, divisor?: number);
  86289. /**
  86290. * Create a new VertexBuffer based on the current buffer
  86291. * @param kind defines the vertex buffer kind (position, normal, etc.)
  86292. * @param offset defines offset in the buffer (0 by default)
  86293. * @param size defines the size in floats of attributes (position is 3 for instance)
  86294. * @param stride defines the stride size in floats in the buffer (the offset to apply to reach next value when data is interleaved)
  86295. * @param instanced defines if the vertex buffer contains indexed data
  86296. * @param useBytes defines if the offset and stride are in bytes *
  86297. * @param divisor sets an optional divisor for instances (1 by default)
  86298. * @returns the new vertex buffer
  86299. */
  86300. createVertexBuffer(kind: string, offset: number, size: number, stride?: number, instanced?: boolean, useBytes?: boolean, divisor?: number): VertexBuffer;
  86301. /**
  86302. * Gets a boolean indicating if the Buffer is updatable?
  86303. * @returns true if the buffer is updatable
  86304. */
  86305. isUpdatable(): boolean;
  86306. /**
  86307. * Gets current buffer's data
  86308. * @returns a DataArray or null
  86309. */
  86310. getData(): Nullable<DataArray>;
  86311. /**
  86312. * Gets underlying native buffer
  86313. * @returns underlying native buffer
  86314. */
  86315. getBuffer(): Nullable<DataBuffer>;
  86316. /**
  86317. * Gets the stride in float32 units (i.e. byte stride / 4).
  86318. * May not be an integer if the byte stride is not divisible by 4.
  86319. * @returns the stride in float32 units
  86320. * @deprecated Please use byteStride instead.
  86321. */
  86322. getStrideSize(): number;
  86323. /**
  86324. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  86325. * @param data defines the data to store
  86326. */
  86327. create(data?: Nullable<DataArray>): void;
  86328. /** @hidden */
  86329. _rebuild(): void;
  86330. /**
  86331. * Update current buffer data
  86332. * @param data defines the data to store
  86333. */
  86334. update(data: DataArray): void;
  86335. /**
  86336. * Updates the data directly.
  86337. * @param data the new data
  86338. * @param offset the new offset
  86339. * @param vertexCount the vertex count (optional)
  86340. * @param useBytes set to true if the offset is in bytes
  86341. */
  86342. updateDirectly(data: DataArray, offset: number, vertexCount?: number, useBytes?: boolean): void;
  86343. /**
  86344. * Release all resources
  86345. */
  86346. dispose(): void;
  86347. }
  86348. /**
  86349. * Specialized buffer used to store vertex data
  86350. */
  86351. export class VertexBuffer {
  86352. /** @hidden */
  86353. _buffer: Buffer;
  86354. private _kind;
  86355. private _size;
  86356. private _ownsBuffer;
  86357. private _instanced;
  86358. private _instanceDivisor;
  86359. /**
  86360. * The byte type.
  86361. */
  86362. static readonly BYTE: number;
  86363. /**
  86364. * The unsigned byte type.
  86365. */
  86366. static readonly UNSIGNED_BYTE: number;
  86367. /**
  86368. * The short type.
  86369. */
  86370. static readonly SHORT: number;
  86371. /**
  86372. * The unsigned short type.
  86373. */
  86374. static readonly UNSIGNED_SHORT: number;
  86375. /**
  86376. * The integer type.
  86377. */
  86378. static readonly INT: number;
  86379. /**
  86380. * The unsigned integer type.
  86381. */
  86382. static readonly UNSIGNED_INT: number;
  86383. /**
  86384. * The float type.
  86385. */
  86386. static readonly FLOAT: number;
  86387. /**
  86388. * Gets or sets the instance divisor when in instanced mode
  86389. */
  86390. get instanceDivisor(): number;
  86391. set instanceDivisor(value: number);
  86392. /**
  86393. * Gets the byte stride.
  86394. */
  86395. readonly byteStride: number;
  86396. /**
  86397. * Gets the byte offset.
  86398. */
  86399. readonly byteOffset: number;
  86400. /**
  86401. * Gets whether integer data values should be normalized into a certain range when being casted to a float.
  86402. */
  86403. readonly normalized: boolean;
  86404. /**
  86405. * Gets the data type of each component in the array.
  86406. */
  86407. readonly type: number;
  86408. /**
  86409. * Constructor
  86410. * @param engine the engine
  86411. * @param data the data to use for this vertex buffer
  86412. * @param kind the vertex buffer kind
  86413. * @param updatable whether the data is updatable
  86414. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  86415. * @param stride the stride (optional)
  86416. * @param instanced whether the buffer is instanced (optional)
  86417. * @param offset the offset of the data (optional)
  86418. * @param size the number of components (optional)
  86419. * @param type the type of the component (optional)
  86420. * @param normalized whether the data contains normalized data (optional)
  86421. * @param useBytes set to true if stride and offset are in bytes (optional)
  86422. * @param divisor defines the instance divisor to use (1 by default)
  86423. */
  86424. 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);
  86425. /** @hidden */
  86426. _rebuild(): void;
  86427. /**
  86428. * Returns the kind of the VertexBuffer (string)
  86429. * @returns a string
  86430. */
  86431. getKind(): string;
  86432. /**
  86433. * Gets a boolean indicating if the VertexBuffer is updatable?
  86434. * @returns true if the buffer is updatable
  86435. */
  86436. isUpdatable(): boolean;
  86437. /**
  86438. * Gets current buffer's data
  86439. * @returns a DataArray or null
  86440. */
  86441. getData(): Nullable<DataArray>;
  86442. /**
  86443. * Gets underlying native buffer
  86444. * @returns underlying native buffer
  86445. */
  86446. getBuffer(): Nullable<DataBuffer>;
  86447. /**
  86448. * Gets the stride in float32 units (i.e. byte stride / 4).
  86449. * May not be an integer if the byte stride is not divisible by 4.
  86450. * @returns the stride in float32 units
  86451. * @deprecated Please use byteStride instead.
  86452. */
  86453. getStrideSize(): number;
  86454. /**
  86455. * Returns the offset as a multiple of the type byte length.
  86456. * @returns the offset in bytes
  86457. * @deprecated Please use byteOffset instead.
  86458. */
  86459. getOffset(): number;
  86460. /**
  86461. * Returns the number of components per vertex attribute (integer)
  86462. * @returns the size in float
  86463. */
  86464. getSize(): number;
  86465. /**
  86466. * Gets a boolean indicating is the internal buffer of the VertexBuffer is instanced
  86467. * @returns true if this buffer is instanced
  86468. */
  86469. getIsInstanced(): boolean;
  86470. /**
  86471. * Returns the instancing divisor, zero for non-instanced (integer).
  86472. * @returns a number
  86473. */
  86474. getInstanceDivisor(): number;
  86475. /**
  86476. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  86477. * @param data defines the data to store
  86478. */
  86479. create(data?: DataArray): void;
  86480. /**
  86481. * Updates the underlying buffer according to the passed numeric array or Float32Array.
  86482. * This function will create a new buffer if the current one is not updatable
  86483. * @param data defines the data to store
  86484. */
  86485. update(data: DataArray): void;
  86486. /**
  86487. * Updates directly the underlying WebGLBuffer according to the passed numeric array or Float32Array.
  86488. * Returns the directly updated WebGLBuffer.
  86489. * @param data the new data
  86490. * @param offset the new offset
  86491. * @param useBytes set to true if the offset is in bytes
  86492. */
  86493. updateDirectly(data: DataArray, offset: number, useBytes?: boolean): void;
  86494. /**
  86495. * Disposes the VertexBuffer and the underlying WebGLBuffer.
  86496. */
  86497. dispose(): void;
  86498. /**
  86499. * Enumerates each value of this vertex buffer as numbers.
  86500. * @param count the number of values to enumerate
  86501. * @param callback the callback function called for each value
  86502. */
  86503. forEach(count: number, callback: (value: number, index: number) => void): void;
  86504. /**
  86505. * Positions
  86506. */
  86507. static readonly PositionKind: string;
  86508. /**
  86509. * Normals
  86510. */
  86511. static readonly NormalKind: string;
  86512. /**
  86513. * Tangents
  86514. */
  86515. static readonly TangentKind: string;
  86516. /**
  86517. * Texture coordinates
  86518. */
  86519. static readonly UVKind: string;
  86520. /**
  86521. * Texture coordinates 2
  86522. */
  86523. static readonly UV2Kind: string;
  86524. /**
  86525. * Texture coordinates 3
  86526. */
  86527. static readonly UV3Kind: string;
  86528. /**
  86529. * Texture coordinates 4
  86530. */
  86531. static readonly UV4Kind: string;
  86532. /**
  86533. * Texture coordinates 5
  86534. */
  86535. static readonly UV5Kind: string;
  86536. /**
  86537. * Texture coordinates 6
  86538. */
  86539. static readonly UV6Kind: string;
  86540. /**
  86541. * Colors
  86542. */
  86543. static readonly ColorKind: string;
  86544. /**
  86545. * Matrix indices (for bones)
  86546. */
  86547. static readonly MatricesIndicesKind: string;
  86548. /**
  86549. * Matrix weights (for bones)
  86550. */
  86551. static readonly MatricesWeightsKind: string;
  86552. /**
  86553. * Additional matrix indices (for bones)
  86554. */
  86555. static readonly MatricesIndicesExtraKind: string;
  86556. /**
  86557. * Additional matrix weights (for bones)
  86558. */
  86559. static readonly MatricesWeightsExtraKind: string;
  86560. /**
  86561. * Deduces the stride given a kind.
  86562. * @param kind The kind string to deduce
  86563. * @returns The deduced stride
  86564. */
  86565. static DeduceStride(kind: string): number;
  86566. /**
  86567. * Gets the byte length of the given type.
  86568. * @param type the type
  86569. * @returns the number of bytes
  86570. */
  86571. static GetTypeByteLength(type: number): number;
  86572. /**
  86573. * Enumerates each value of the given parameters as numbers.
  86574. * @param data the data to enumerate
  86575. * @param byteOffset the byte offset of the data
  86576. * @param byteStride the byte stride of the data
  86577. * @param componentCount the number of components per element
  86578. * @param componentType the type of the component
  86579. * @param count the number of values to enumerate
  86580. * @param normalized whether the data is normalized
  86581. * @param callback the callback function called for each value
  86582. */
  86583. static ForEach(data: DataArray, byteOffset: number, byteStride: number, componentCount: number, componentType: number, count: number, normalized: boolean, callback: (value: number, index: number) => void): void;
  86584. private static _GetFloatValue;
  86585. }
  86586. }
  86587. declare module BABYLON {
  86588. /**
  86589. * @hidden
  86590. */
  86591. export class IntersectionInfo {
  86592. bu: Nullable<number>;
  86593. bv: Nullable<number>;
  86594. distance: number;
  86595. faceId: number;
  86596. subMeshId: number;
  86597. constructor(bu: Nullable<number>, bv: Nullable<number>, distance: number);
  86598. }
  86599. }
  86600. declare module BABYLON {
  86601. /**
  86602. * Class used to store bounding sphere information
  86603. */
  86604. export class BoundingSphere {
  86605. /**
  86606. * Gets the center of the bounding sphere in local space
  86607. */
  86608. readonly center: Vector3;
  86609. /**
  86610. * Radius of the bounding sphere in local space
  86611. */
  86612. radius: number;
  86613. /**
  86614. * Gets the center of the bounding sphere in world space
  86615. */
  86616. readonly centerWorld: Vector3;
  86617. /**
  86618. * Radius of the bounding sphere in world space
  86619. */
  86620. radiusWorld: number;
  86621. /**
  86622. * Gets the minimum vector in local space
  86623. */
  86624. readonly minimum: Vector3;
  86625. /**
  86626. * Gets the maximum vector in local space
  86627. */
  86628. readonly maximum: Vector3;
  86629. private _worldMatrix;
  86630. private static readonly TmpVector3;
  86631. /**
  86632. * Creates a new bounding sphere
  86633. * @param min defines the minimum vector (in local space)
  86634. * @param max defines the maximum vector (in local space)
  86635. * @param worldMatrix defines the new world matrix
  86636. */
  86637. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  86638. /**
  86639. * Recreates the entire bounding sphere from scratch as if we call the constructor in place
  86640. * @param min defines the new minimum vector (in local space)
  86641. * @param max defines the new maximum vector (in local space)
  86642. * @param worldMatrix defines the new world matrix
  86643. */
  86644. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  86645. /**
  86646. * Scale the current bounding sphere by applying a scale factor
  86647. * @param factor defines the scale factor to apply
  86648. * @returns the current bounding box
  86649. */
  86650. scale(factor: number): BoundingSphere;
  86651. /**
  86652. * Gets the world matrix of the bounding box
  86653. * @returns a matrix
  86654. */
  86655. getWorldMatrix(): DeepImmutable<Matrix>;
  86656. /** @hidden */
  86657. _update(worldMatrix: DeepImmutable<Matrix>): void;
  86658. /**
  86659. * Tests if the bounding sphere is intersecting the frustum planes
  86660. * @param frustumPlanes defines the frustum planes to test
  86661. * @returns true if there is an intersection
  86662. */
  86663. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86664. /**
  86665. * Tests if the bounding sphere center is in between the frustum planes.
  86666. * Used for optimistic fast inclusion.
  86667. * @param frustumPlanes defines the frustum planes to test
  86668. * @returns true if the sphere center is in between the frustum planes
  86669. */
  86670. isCenterInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86671. /**
  86672. * Tests if a point is inside the bounding sphere
  86673. * @param point defines the point to test
  86674. * @returns true if the point is inside the bounding sphere
  86675. */
  86676. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  86677. /**
  86678. * Checks if two sphere intersct
  86679. * @param sphere0 sphere 0
  86680. * @param sphere1 sphere 1
  86681. * @returns true if the speres intersect
  86682. */
  86683. static Intersects(sphere0: DeepImmutable<BoundingSphere>, sphere1: DeepImmutable<BoundingSphere>): boolean;
  86684. }
  86685. }
  86686. declare module BABYLON {
  86687. /**
  86688. * Class used to store bounding box information
  86689. */
  86690. export class BoundingBox implements ICullable {
  86691. /**
  86692. * Gets the 8 vectors representing the bounding box in local space
  86693. */
  86694. readonly vectors: Vector3[];
  86695. /**
  86696. * Gets the center of the bounding box in local space
  86697. */
  86698. readonly center: Vector3;
  86699. /**
  86700. * Gets the center of the bounding box in world space
  86701. */
  86702. readonly centerWorld: Vector3;
  86703. /**
  86704. * Gets the extend size in local space
  86705. */
  86706. readonly extendSize: Vector3;
  86707. /**
  86708. * Gets the extend size in world space
  86709. */
  86710. readonly extendSizeWorld: Vector3;
  86711. /**
  86712. * Gets the OBB (object bounding box) directions
  86713. */
  86714. readonly directions: Vector3[];
  86715. /**
  86716. * Gets the 8 vectors representing the bounding box in world space
  86717. */
  86718. readonly vectorsWorld: Vector3[];
  86719. /**
  86720. * Gets the minimum vector in world space
  86721. */
  86722. readonly minimumWorld: Vector3;
  86723. /**
  86724. * Gets the maximum vector in world space
  86725. */
  86726. readonly maximumWorld: Vector3;
  86727. /**
  86728. * Gets the minimum vector in local space
  86729. */
  86730. readonly minimum: Vector3;
  86731. /**
  86732. * Gets the maximum vector in local space
  86733. */
  86734. readonly maximum: Vector3;
  86735. private _worldMatrix;
  86736. private static readonly TmpVector3;
  86737. /**
  86738. * @hidden
  86739. */
  86740. _tag: number;
  86741. /**
  86742. * Creates a new bounding box
  86743. * @param min defines the minimum vector (in local space)
  86744. * @param max defines the maximum vector (in local space)
  86745. * @param worldMatrix defines the new world matrix
  86746. */
  86747. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  86748. /**
  86749. * Recreates the entire bounding box from scratch as if we call the constructor in place
  86750. * @param min defines the new minimum vector (in local space)
  86751. * @param max defines the new maximum vector (in local space)
  86752. * @param worldMatrix defines the new world matrix
  86753. */
  86754. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  86755. /**
  86756. * Scale the current bounding box by applying a scale factor
  86757. * @param factor defines the scale factor to apply
  86758. * @returns the current bounding box
  86759. */
  86760. scale(factor: number): BoundingBox;
  86761. /**
  86762. * Gets the world matrix of the bounding box
  86763. * @returns a matrix
  86764. */
  86765. getWorldMatrix(): DeepImmutable<Matrix>;
  86766. /** @hidden */
  86767. _update(world: DeepImmutable<Matrix>): void;
  86768. /**
  86769. * Tests if the bounding box is intersecting the frustum planes
  86770. * @param frustumPlanes defines the frustum planes to test
  86771. * @returns true if there is an intersection
  86772. */
  86773. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86774. /**
  86775. * Tests if the bounding box is entirely inside the frustum planes
  86776. * @param frustumPlanes defines the frustum planes to test
  86777. * @returns true if there is an inclusion
  86778. */
  86779. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86780. /**
  86781. * Tests if a point is inside the bounding box
  86782. * @param point defines the point to test
  86783. * @returns true if the point is inside the bounding box
  86784. */
  86785. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  86786. /**
  86787. * Tests if the bounding box intersects with a bounding sphere
  86788. * @param sphere defines the sphere to test
  86789. * @returns true if there is an intersection
  86790. */
  86791. intersectsSphere(sphere: DeepImmutable<BoundingSphere>): boolean;
  86792. /**
  86793. * Tests if the bounding box intersects with a box defined by a min and max vectors
  86794. * @param min defines the min vector to use
  86795. * @param max defines the max vector to use
  86796. * @returns true if there is an intersection
  86797. */
  86798. intersectsMinMax(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): boolean;
  86799. /**
  86800. * Tests if two bounding boxes are intersections
  86801. * @param box0 defines the first box to test
  86802. * @param box1 defines the second box to test
  86803. * @returns true if there is an intersection
  86804. */
  86805. static Intersects(box0: DeepImmutable<BoundingBox>, box1: DeepImmutable<BoundingBox>): boolean;
  86806. /**
  86807. * Tests if a bounding box defines by a min/max vectors intersects a sphere
  86808. * @param minPoint defines the minimum vector of the bounding box
  86809. * @param maxPoint defines the maximum vector of the bounding box
  86810. * @param sphereCenter defines the sphere center
  86811. * @param sphereRadius defines the sphere radius
  86812. * @returns true if there is an intersection
  86813. */
  86814. static IntersectsSphere(minPoint: DeepImmutable<Vector3>, maxPoint: DeepImmutable<Vector3>, sphereCenter: DeepImmutable<Vector3>, sphereRadius: number): boolean;
  86815. /**
  86816. * Tests if a bounding box defined with 8 vectors is entirely inside frustum planes
  86817. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  86818. * @param frustumPlanes defines the frustum planes to test
  86819. * @return true if there is an inclusion
  86820. */
  86821. static IsCompletelyInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86822. /**
  86823. * Tests if a bounding box defined with 8 vectors intersects frustum planes
  86824. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  86825. * @param frustumPlanes defines the frustum planes to test
  86826. * @return true if there is an intersection
  86827. */
  86828. static IsInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86829. }
  86830. }
  86831. declare module BABYLON {
  86832. /** @hidden */
  86833. export class Collider {
  86834. /** Define if a collision was found */
  86835. collisionFound: boolean;
  86836. /**
  86837. * Define last intersection point in local space
  86838. */
  86839. intersectionPoint: Vector3;
  86840. /**
  86841. * Define last collided mesh
  86842. */
  86843. collidedMesh: Nullable<AbstractMesh>;
  86844. private _collisionPoint;
  86845. private _planeIntersectionPoint;
  86846. private _tempVector;
  86847. private _tempVector2;
  86848. private _tempVector3;
  86849. private _tempVector4;
  86850. private _edge;
  86851. private _baseToVertex;
  86852. private _destinationPoint;
  86853. private _slidePlaneNormal;
  86854. private _displacementVector;
  86855. /** @hidden */
  86856. _radius: Vector3;
  86857. /** @hidden */
  86858. _retry: number;
  86859. private _velocity;
  86860. private _basePoint;
  86861. private _epsilon;
  86862. /** @hidden */
  86863. _velocityWorldLength: number;
  86864. /** @hidden */
  86865. _basePointWorld: Vector3;
  86866. private _velocityWorld;
  86867. private _normalizedVelocity;
  86868. /** @hidden */
  86869. _initialVelocity: Vector3;
  86870. /** @hidden */
  86871. _initialPosition: Vector3;
  86872. private _nearestDistance;
  86873. private _collisionMask;
  86874. get collisionMask(): number;
  86875. set collisionMask(mask: number);
  86876. /**
  86877. * Gets the plane normal used to compute the sliding response (in local space)
  86878. */
  86879. get slidePlaneNormal(): Vector3;
  86880. /** @hidden */
  86881. _initialize(source: Vector3, dir: Vector3, e: number): void;
  86882. /** @hidden */
  86883. _checkPointInTriangle(point: Vector3, pa: Vector3, pb: Vector3, pc: Vector3, n: Vector3): boolean;
  86884. /** @hidden */
  86885. _canDoCollision(sphereCenter: Vector3, sphereRadius: number, vecMin: Vector3, vecMax: Vector3): boolean;
  86886. /** @hidden */
  86887. _testTriangle(faceIndex: number, trianglePlaneArray: Array<Plane>, p1: Vector3, p2: Vector3, p3: Vector3, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  86888. /** @hidden */
  86889. _collide(trianglePlaneArray: Array<Plane>, pts: Vector3[], indices: IndicesArray, indexStart: number, indexEnd: number, decal: number, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  86890. /** @hidden */
  86891. _getResponse(pos: Vector3, vel: Vector3): void;
  86892. }
  86893. }
  86894. declare module BABYLON {
  86895. /**
  86896. * Interface for cullable objects
  86897. * @see https://doc.babylonjs.com/babylon101/materials#back-face-culling
  86898. */
  86899. export interface ICullable {
  86900. /**
  86901. * Checks if the object or part of the object is in the frustum
  86902. * @param frustumPlanes Camera near/planes
  86903. * @returns true if the object is in frustum otherwise false
  86904. */
  86905. isInFrustum(frustumPlanes: Plane[]): boolean;
  86906. /**
  86907. * Checks if a cullable object (mesh...) is in the camera frustum
  86908. * Unlike isInFrustum this cheks the full bounding box
  86909. * @param frustumPlanes Camera near/planes
  86910. * @returns true if the object is in frustum otherwise false
  86911. */
  86912. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  86913. }
  86914. /**
  86915. * Info for a bounding data of a mesh
  86916. */
  86917. export class BoundingInfo implements ICullable {
  86918. /**
  86919. * Bounding box for the mesh
  86920. */
  86921. readonly boundingBox: BoundingBox;
  86922. /**
  86923. * Bounding sphere for the mesh
  86924. */
  86925. readonly boundingSphere: BoundingSphere;
  86926. private _isLocked;
  86927. private static readonly TmpVector3;
  86928. /**
  86929. * Constructs bounding info
  86930. * @param minimum min vector of the bounding box/sphere
  86931. * @param maximum max vector of the bounding box/sphere
  86932. * @param worldMatrix defines the new world matrix
  86933. */
  86934. constructor(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  86935. /**
  86936. * Recreates the entire bounding info from scratch as if we call the constructor in place
  86937. * @param min defines the new minimum vector (in local space)
  86938. * @param max defines the new maximum vector (in local space)
  86939. * @param worldMatrix defines the new world matrix
  86940. */
  86941. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  86942. /**
  86943. * min vector of the bounding box/sphere
  86944. */
  86945. get minimum(): Vector3;
  86946. /**
  86947. * max vector of the bounding box/sphere
  86948. */
  86949. get maximum(): Vector3;
  86950. /**
  86951. * If the info is locked and won't be updated to avoid perf overhead
  86952. */
  86953. get isLocked(): boolean;
  86954. set isLocked(value: boolean);
  86955. /**
  86956. * Updates the bounding sphere and box
  86957. * @param world world matrix to be used to update
  86958. */
  86959. update(world: DeepImmutable<Matrix>): void;
  86960. /**
  86961. * Recreate the bounding info to be centered around a specific point given a specific extend.
  86962. * @param center New center of the bounding info
  86963. * @param extend New extend of the bounding info
  86964. * @returns the current bounding info
  86965. */
  86966. centerOn(center: DeepImmutable<Vector3>, extend: DeepImmutable<Vector3>): BoundingInfo;
  86967. /**
  86968. * Scale the current bounding info by applying a scale factor
  86969. * @param factor defines the scale factor to apply
  86970. * @returns the current bounding info
  86971. */
  86972. scale(factor: number): BoundingInfo;
  86973. /**
  86974. * Returns `true` if the bounding info is within the frustum defined by the passed array of planes.
  86975. * @param frustumPlanes defines the frustum to test
  86976. * @param strategy defines the strategy to use for the culling (default is BABYLON.AbstractMesh.CULLINGSTRATEGY_STANDARD)
  86977. * @returns true if the bounding info is in the frustum planes
  86978. */
  86979. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>, strategy?: number): boolean;
  86980. /**
  86981. * Gets the world distance between the min and max points of the bounding box
  86982. */
  86983. get diagonalLength(): number;
  86984. /**
  86985. * Checks if a cullable object (mesh...) is in the camera frustum
  86986. * Unlike isInFrustum this cheks the full bounding box
  86987. * @param frustumPlanes Camera near/planes
  86988. * @returns true if the object is in frustum otherwise false
  86989. */
  86990. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86991. /** @hidden */
  86992. _checkCollision(collider: Collider): boolean;
  86993. /**
  86994. * Checks if a point is inside the bounding box and bounding sphere or the mesh
  86995. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  86996. * @param point the point to check intersection with
  86997. * @returns if the point intersects
  86998. */
  86999. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  87000. /**
  87001. * Checks if another bounding info intersects the bounding box and bounding sphere or the mesh
  87002. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  87003. * @param boundingInfo the bounding info to check intersection with
  87004. * @param precise if the intersection should be done using OBB
  87005. * @returns if the bounding info intersects
  87006. */
  87007. intersects(boundingInfo: DeepImmutable<BoundingInfo>, precise: boolean): boolean;
  87008. }
  87009. }
  87010. declare module BABYLON {
  87011. /**
  87012. * Extracts minimum and maximum values from a list of indexed positions
  87013. * @param positions defines the positions to use
  87014. * @param indices defines the indices to the positions
  87015. * @param indexStart defines the start index
  87016. * @param indexCount defines the end index
  87017. * @param bias defines bias value to add to the result
  87018. * @return minimum and maximum values
  87019. */
  87020. export function extractMinAndMaxIndexed(positions: FloatArray, indices: IndicesArray, indexStart: number, indexCount: number, bias?: Nullable<Vector2>): {
  87021. minimum: Vector3;
  87022. maximum: Vector3;
  87023. };
  87024. /**
  87025. * Extracts minimum and maximum values from a list of positions
  87026. * @param positions defines the positions to use
  87027. * @param start defines the start index in the positions array
  87028. * @param count defines the number of positions to handle
  87029. * @param bias defines bias value to add to the result
  87030. * @param stride defines the stride size to use (distance between two positions in the positions array)
  87031. * @return minimum and maximum values
  87032. */
  87033. export function extractMinAndMax(positions: FloatArray, start: number, count: number, bias?: Nullable<Vector2>, stride?: number): {
  87034. minimum: Vector3;
  87035. maximum: Vector3;
  87036. };
  87037. }
  87038. declare module BABYLON {
  87039. /** @hidden */
  87040. export class WebGLDataBuffer extends DataBuffer {
  87041. private _buffer;
  87042. constructor(resource: WebGLBuffer);
  87043. get underlyingResource(): any;
  87044. }
  87045. }
  87046. declare module BABYLON {
  87047. /** @hidden */
  87048. export class WebGLPipelineContext implements IPipelineContext {
  87049. engine: ThinEngine;
  87050. program: Nullable<WebGLProgram>;
  87051. context?: WebGLRenderingContext;
  87052. vertexShader?: WebGLShader;
  87053. fragmentShader?: WebGLShader;
  87054. isParallelCompiled: boolean;
  87055. onCompiled?: () => void;
  87056. transformFeedback?: WebGLTransformFeedback | null;
  87057. vertexCompilationError: Nullable<string>;
  87058. fragmentCompilationError: Nullable<string>;
  87059. programLinkError: Nullable<string>;
  87060. programValidationError: Nullable<string>;
  87061. get isAsync(): boolean;
  87062. get isReady(): boolean;
  87063. _handlesSpectorRebuildCallback(onCompiled: (program: WebGLProgram) => void): void;
  87064. _getVertexShaderCode(): string | null;
  87065. _getFragmentShaderCode(): string | null;
  87066. }
  87067. }
  87068. declare module BABYLON {
  87069. interface ThinEngine {
  87070. /**
  87071. * Create an uniform buffer
  87072. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  87073. * @param elements defines the content of the uniform buffer
  87074. * @returns the webGL uniform buffer
  87075. */
  87076. createUniformBuffer(elements: FloatArray): DataBuffer;
  87077. /**
  87078. * Create a dynamic uniform buffer
  87079. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  87080. * @param elements defines the content of the uniform buffer
  87081. * @returns the webGL uniform buffer
  87082. */
  87083. createDynamicUniformBuffer(elements: FloatArray): DataBuffer;
  87084. /**
  87085. * Update an existing uniform buffer
  87086. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  87087. * @param uniformBuffer defines the target uniform buffer
  87088. * @param elements defines the content to update
  87089. * @param offset defines the offset in the uniform buffer where update should start
  87090. * @param count defines the size of the data to update
  87091. */
  87092. updateUniformBuffer(uniformBuffer: DataBuffer, elements: FloatArray, offset?: number, count?: number): void;
  87093. /**
  87094. * Bind an uniform buffer to the current webGL context
  87095. * @param buffer defines the buffer to bind
  87096. */
  87097. bindUniformBuffer(buffer: Nullable<DataBuffer>): void;
  87098. /**
  87099. * Bind a buffer to the current webGL context at a given location
  87100. * @param buffer defines the buffer to bind
  87101. * @param location defines the index where to bind the buffer
  87102. */
  87103. bindUniformBufferBase(buffer: DataBuffer, location: number): void;
  87104. /**
  87105. * Bind a specific block at a given index in a specific shader program
  87106. * @param pipelineContext defines the pipeline context to use
  87107. * @param blockName defines the block name
  87108. * @param index defines the index where to bind the block
  87109. */
  87110. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  87111. }
  87112. }
  87113. declare module BABYLON {
  87114. /**
  87115. * Uniform buffer objects.
  87116. *
  87117. * Handles blocks of uniform on the GPU.
  87118. *
  87119. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  87120. *
  87121. * For more information, please refer to :
  87122. * https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  87123. */
  87124. export class UniformBuffer {
  87125. private _engine;
  87126. private _buffer;
  87127. private _data;
  87128. private _bufferData;
  87129. private _dynamic?;
  87130. private _uniformLocations;
  87131. private _uniformSizes;
  87132. private _uniformLocationPointer;
  87133. private _needSync;
  87134. private _noUBO;
  87135. private _currentEffect;
  87136. /** @hidden */
  87137. _alreadyBound: boolean;
  87138. private static _MAX_UNIFORM_SIZE;
  87139. private static _tempBuffer;
  87140. /**
  87141. * Lambda to Update a 3x3 Matrix in a uniform buffer.
  87142. * This is dynamic to allow compat with webgl 1 and 2.
  87143. * You will need to pass the name of the uniform as well as the value.
  87144. */
  87145. updateMatrix3x3: (name: string, matrix: Float32Array) => void;
  87146. /**
  87147. * Lambda to Update a 2x2 Matrix in a uniform buffer.
  87148. * This is dynamic to allow compat with webgl 1 and 2.
  87149. * You will need to pass the name of the uniform as well as the value.
  87150. */
  87151. updateMatrix2x2: (name: string, matrix: Float32Array) => void;
  87152. /**
  87153. * Lambda to Update a single float in a uniform buffer.
  87154. * This is dynamic to allow compat with webgl 1 and 2.
  87155. * You will need to pass the name of the uniform as well as the value.
  87156. */
  87157. updateFloat: (name: string, x: number) => void;
  87158. /**
  87159. * Lambda to Update a vec2 of float in a uniform buffer.
  87160. * This is dynamic to allow compat with webgl 1 and 2.
  87161. * You will need to pass the name of the uniform as well as the value.
  87162. */
  87163. updateFloat2: (name: string, x: number, y: number, suffix?: string) => void;
  87164. /**
  87165. * Lambda to Update a vec3 of float in a uniform buffer.
  87166. * This is dynamic to allow compat with webgl 1 and 2.
  87167. * You will need to pass the name of the uniform as well as the value.
  87168. */
  87169. updateFloat3: (name: string, x: number, y: number, z: number, suffix?: string) => void;
  87170. /**
  87171. * Lambda to Update a vec4 of float in a uniform buffer.
  87172. * This is dynamic to allow compat with webgl 1 and 2.
  87173. * You will need to pass the name of the uniform as well as the value.
  87174. */
  87175. updateFloat4: (name: string, x: number, y: number, z: number, w: number, suffix?: string) => void;
  87176. /**
  87177. * Lambda to Update a 4x4 Matrix in a uniform buffer.
  87178. * This is dynamic to allow compat with webgl 1 and 2.
  87179. * You will need to pass the name of the uniform as well as the value.
  87180. */
  87181. updateMatrix: (name: string, mat: Matrix) => void;
  87182. /**
  87183. * Lambda to Update vec3 of float from a Vector in a uniform buffer.
  87184. * This is dynamic to allow compat with webgl 1 and 2.
  87185. * You will need to pass the name of the uniform as well as the value.
  87186. */
  87187. updateVector3: (name: string, vector: Vector3) => void;
  87188. /**
  87189. * Lambda to Update vec4 of float from a Vector in a uniform buffer.
  87190. * This is dynamic to allow compat with webgl 1 and 2.
  87191. * You will need to pass the name of the uniform as well as the value.
  87192. */
  87193. updateVector4: (name: string, vector: Vector4) => void;
  87194. /**
  87195. * Lambda to Update vec3 of float from a Color in a uniform buffer.
  87196. * This is dynamic to allow compat with webgl 1 and 2.
  87197. * You will need to pass the name of the uniform as well as the value.
  87198. */
  87199. updateColor3: (name: string, color: Color3, suffix?: string) => void;
  87200. /**
  87201. * Lambda to Update vec4 of float from a Color in a uniform buffer.
  87202. * This is dynamic to allow compat with webgl 1 and 2.
  87203. * You will need to pass the name of the uniform as well as the value.
  87204. */
  87205. updateColor4: (name: string, color: Color3, alpha: number, suffix?: string) => void;
  87206. /**
  87207. * Instantiates a new Uniform buffer objects.
  87208. *
  87209. * Handles blocks of uniform on the GPU.
  87210. *
  87211. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  87212. *
  87213. * For more information, please refer to :
  87214. * @see https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  87215. * @param engine Define the engine the buffer is associated with
  87216. * @param data Define the data contained in the buffer
  87217. * @param dynamic Define if the buffer is updatable
  87218. */
  87219. constructor(engine: Engine, data?: number[], dynamic?: boolean);
  87220. /**
  87221. * Indicates if the buffer is using the WebGL2 UBO implementation,
  87222. * or just falling back on setUniformXXX calls.
  87223. */
  87224. get useUbo(): boolean;
  87225. /**
  87226. * Indicates if the WebGL underlying uniform buffer is in sync
  87227. * with the javascript cache data.
  87228. */
  87229. get isSync(): boolean;
  87230. /**
  87231. * Indicates if the WebGL underlying uniform buffer is dynamic.
  87232. * Also, a dynamic UniformBuffer will disable cache verification and always
  87233. * update the underlying WebGL uniform buffer to the GPU.
  87234. * @returns if Dynamic, otherwise false
  87235. */
  87236. isDynamic(): boolean;
  87237. /**
  87238. * The data cache on JS side.
  87239. * @returns the underlying data as a float array
  87240. */
  87241. getData(): Float32Array;
  87242. /**
  87243. * The underlying WebGL Uniform buffer.
  87244. * @returns the webgl buffer
  87245. */
  87246. getBuffer(): Nullable<DataBuffer>;
  87247. /**
  87248. * std140 layout specifies how to align data within an UBO structure.
  87249. * See https://khronos.org/registry/OpenGL/specs/gl/glspec45.core.pdf#page=159
  87250. * for specs.
  87251. */
  87252. private _fillAlignment;
  87253. /**
  87254. * Adds an uniform in the buffer.
  87255. * Warning : the subsequents calls of this function must be in the same order as declared in the shader
  87256. * for the layout to be correct !
  87257. * @param name Name of the uniform, as used in the uniform block in the shader.
  87258. * @param size Data size, or data directly.
  87259. */
  87260. addUniform(name: string, size: number | number[]): void;
  87261. /**
  87262. * Adds a Matrix 4x4 to the uniform buffer.
  87263. * @param name Name of the uniform, as used in the uniform block in the shader.
  87264. * @param mat A 4x4 matrix.
  87265. */
  87266. addMatrix(name: string, mat: Matrix): void;
  87267. /**
  87268. * Adds a vec2 to the uniform buffer.
  87269. * @param name Name of the uniform, as used in the uniform block in the shader.
  87270. * @param x Define the x component value of the vec2
  87271. * @param y Define the y component value of the vec2
  87272. */
  87273. addFloat2(name: string, x: number, y: number): void;
  87274. /**
  87275. * Adds a vec3 to the uniform buffer.
  87276. * @param name Name of the uniform, as used in the uniform block in the shader.
  87277. * @param x Define the x component value of the vec3
  87278. * @param y Define the y component value of the vec3
  87279. * @param z Define the z component value of the vec3
  87280. */
  87281. addFloat3(name: string, x: number, y: number, z: number): void;
  87282. /**
  87283. * Adds a vec3 to the uniform buffer.
  87284. * @param name Name of the uniform, as used in the uniform block in the shader.
  87285. * @param color Define the vec3 from a Color
  87286. */
  87287. addColor3(name: string, color: Color3): void;
  87288. /**
  87289. * Adds a vec4 to the uniform buffer.
  87290. * @param name Name of the uniform, as used in the uniform block in the shader.
  87291. * @param color Define the rgb components from a Color
  87292. * @param alpha Define the a component of the vec4
  87293. */
  87294. addColor4(name: string, color: Color3, alpha: number): void;
  87295. /**
  87296. * Adds a vec3 to the uniform buffer.
  87297. * @param name Name of the uniform, as used in the uniform block in the shader.
  87298. * @param vector Define the vec3 components from a Vector
  87299. */
  87300. addVector3(name: string, vector: Vector3): void;
  87301. /**
  87302. * Adds a Matrix 3x3 to the uniform buffer.
  87303. * @param name Name of the uniform, as used in the uniform block in the shader.
  87304. */
  87305. addMatrix3x3(name: string): void;
  87306. /**
  87307. * Adds a Matrix 2x2 to the uniform buffer.
  87308. * @param name Name of the uniform, as used in the uniform block in the shader.
  87309. */
  87310. addMatrix2x2(name: string): void;
  87311. /**
  87312. * Effectively creates the WebGL Uniform Buffer, once layout is completed with `addUniform`.
  87313. */
  87314. create(): void;
  87315. /** @hidden */
  87316. _rebuild(): void;
  87317. /**
  87318. * Updates the WebGL Uniform Buffer on the GPU.
  87319. * If the `dynamic` flag is set to true, no cache comparison is done.
  87320. * Otherwise, the buffer will be updated only if the cache differs.
  87321. */
  87322. update(): void;
  87323. /**
  87324. * Updates the value of an uniform. The `update` method must be called afterwards to make it effective in the GPU.
  87325. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  87326. * @param data Define the flattened data
  87327. * @param size Define the size of the data.
  87328. */
  87329. updateUniform(uniformName: string, data: FloatArray, size: number): void;
  87330. private _valueCache;
  87331. private _cacheMatrix;
  87332. private _updateMatrix3x3ForUniform;
  87333. private _updateMatrix3x3ForEffect;
  87334. private _updateMatrix2x2ForEffect;
  87335. private _updateMatrix2x2ForUniform;
  87336. private _updateFloatForEffect;
  87337. private _updateFloatForUniform;
  87338. private _updateFloat2ForEffect;
  87339. private _updateFloat2ForUniform;
  87340. private _updateFloat3ForEffect;
  87341. private _updateFloat3ForUniform;
  87342. private _updateFloat4ForEffect;
  87343. private _updateFloat4ForUniform;
  87344. private _updateMatrixForEffect;
  87345. private _updateMatrixForUniform;
  87346. private _updateVector3ForEffect;
  87347. private _updateVector3ForUniform;
  87348. private _updateVector4ForEffect;
  87349. private _updateVector4ForUniform;
  87350. private _updateColor3ForEffect;
  87351. private _updateColor3ForUniform;
  87352. private _updateColor4ForEffect;
  87353. private _updateColor4ForUniform;
  87354. /**
  87355. * Sets a sampler uniform on the effect.
  87356. * @param name Define the name of the sampler.
  87357. * @param texture Define the texture to set in the sampler
  87358. */
  87359. setTexture(name: string, texture: Nullable<BaseTexture>): void;
  87360. /**
  87361. * Directly updates the value of the uniform in the cache AND on the GPU.
  87362. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  87363. * @param data Define the flattened data
  87364. */
  87365. updateUniformDirectly(uniformName: string, data: FloatArray): void;
  87366. /**
  87367. * Binds this uniform buffer to an effect.
  87368. * @param effect Define the effect to bind the buffer to
  87369. * @param name Name of the uniform block in the shader.
  87370. */
  87371. bindToEffect(effect: Effect, name: string): void;
  87372. /**
  87373. * Disposes the uniform buffer.
  87374. */
  87375. dispose(): void;
  87376. }
  87377. }
  87378. declare module BABYLON {
  87379. /**
  87380. * Enum that determines the text-wrapping mode to use.
  87381. */
  87382. export enum InspectableType {
  87383. /**
  87384. * Checkbox for booleans
  87385. */
  87386. Checkbox = 0,
  87387. /**
  87388. * Sliders for numbers
  87389. */
  87390. Slider = 1,
  87391. /**
  87392. * Vector3
  87393. */
  87394. Vector3 = 2,
  87395. /**
  87396. * Quaternions
  87397. */
  87398. Quaternion = 3,
  87399. /**
  87400. * Color3
  87401. */
  87402. Color3 = 4,
  87403. /**
  87404. * String
  87405. */
  87406. String = 5
  87407. }
  87408. /**
  87409. * Interface used to define custom inspectable properties.
  87410. * This interface is used by the inspector to display custom property grids
  87411. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  87412. */
  87413. export interface IInspectable {
  87414. /**
  87415. * Gets the label to display
  87416. */
  87417. label: string;
  87418. /**
  87419. * Gets the name of the property to edit
  87420. */
  87421. propertyName: string;
  87422. /**
  87423. * Gets the type of the editor to use
  87424. */
  87425. type: InspectableType;
  87426. /**
  87427. * Gets the minimum value of the property when using in "slider" mode
  87428. */
  87429. min?: number;
  87430. /**
  87431. * Gets the maximum value of the property when using in "slider" mode
  87432. */
  87433. max?: number;
  87434. /**
  87435. * Gets the setp to use when using in "slider" mode
  87436. */
  87437. step?: number;
  87438. }
  87439. }
  87440. declare module BABYLON {
  87441. /**
  87442. * Class used to provide helper for timing
  87443. */
  87444. export class TimingTools {
  87445. /**
  87446. * Polyfill for setImmediate
  87447. * @param action defines the action to execute after the current execution block
  87448. */
  87449. static SetImmediate(action: () => void): void;
  87450. }
  87451. }
  87452. declare module BABYLON {
  87453. /**
  87454. * Class used to enable instatition of objects by class name
  87455. */
  87456. export class InstantiationTools {
  87457. /**
  87458. * Use this object to register external classes like custom textures or material
  87459. * to allow the laoders to instantiate them
  87460. */
  87461. static RegisteredExternalClasses: {
  87462. [key: string]: Object;
  87463. };
  87464. /**
  87465. * Tries to instantiate a new object from a given class name
  87466. * @param className defines the class name to instantiate
  87467. * @returns the new object or null if the system was not able to do the instantiation
  87468. */
  87469. static Instantiate(className: string): any;
  87470. }
  87471. }
  87472. declare module BABYLON {
  87473. /**
  87474. * Define options used to create a depth texture
  87475. */
  87476. export class DepthTextureCreationOptions {
  87477. /** Specifies whether or not a stencil should be allocated in the texture */
  87478. generateStencil?: boolean;
  87479. /** Specifies whether or not bilinear filtering is enable on the texture */
  87480. bilinearFiltering?: boolean;
  87481. /** Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode */
  87482. comparisonFunction?: number;
  87483. /** Specifies if the created texture is a cube texture */
  87484. isCube?: boolean;
  87485. }
  87486. }
  87487. declare module BABYLON {
  87488. interface ThinEngine {
  87489. /**
  87490. * Creates a depth stencil cube texture.
  87491. * This is only available in WebGL 2.
  87492. * @param size The size of face edge in the cube texture.
  87493. * @param options The options defining the cube texture.
  87494. * @returns The cube texture
  87495. */
  87496. _createDepthStencilCubeTexture(size: number, options: DepthTextureCreationOptions): InternalTexture;
  87497. /**
  87498. * Creates a cube texture
  87499. * @param rootUrl defines the url where the files to load is located
  87500. * @param scene defines the current scene
  87501. * @param files defines the list of files to load (1 per face)
  87502. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  87503. * @param onLoad defines an optional callback raised when the texture is loaded
  87504. * @param onError defines an optional callback raised if there is an issue to load the texture
  87505. * @param format defines the format of the data
  87506. * @param forcedExtension defines the extension to use to pick the right loader
  87507. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  87508. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  87509. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  87510. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  87511. * @returns the cube texture as an InternalTexture
  87512. */
  87513. 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;
  87514. /**
  87515. * Creates a cube texture
  87516. * @param rootUrl defines the url where the files to load is located
  87517. * @param scene defines the current scene
  87518. * @param files defines the list of files to load (1 per face)
  87519. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  87520. * @param onLoad defines an optional callback raised when the texture is loaded
  87521. * @param onError defines an optional callback raised if there is an issue to load the texture
  87522. * @param format defines the format of the data
  87523. * @param forcedExtension defines the extension to use to pick the right loader
  87524. * @returns the cube texture as an InternalTexture
  87525. */
  87526. 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;
  87527. /**
  87528. * Creates a cube texture
  87529. * @param rootUrl defines the url where the files to load is located
  87530. * @param scene defines the current scene
  87531. * @param files defines the list of files to load (1 per face)
  87532. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  87533. * @param onLoad defines an optional callback raised when the texture is loaded
  87534. * @param onError defines an optional callback raised if there is an issue to load the texture
  87535. * @param format defines the format of the data
  87536. * @param forcedExtension defines the extension to use to pick the right loader
  87537. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  87538. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  87539. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  87540. * @returns the cube texture as an InternalTexture
  87541. */
  87542. 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;
  87543. /** @hidden */
  87544. _partialLoadFile(url: string, index: number, loadedFiles: ArrayBuffer[], onfinish: (files: ArrayBuffer[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>): void;
  87545. /** @hidden */
  87546. _cascadeLoadFiles(scene: Nullable<Scene>, onfinish: (images: ArrayBuffer[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>): void;
  87547. /** @hidden */
  87548. _cascadeLoadImgs(scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  87549. /** @hidden */
  87550. _partialLoadImg(url: string, index: number, loadedImages: HTMLImageElement[], scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  87551. /**
  87552. * @hidden
  87553. */
  87554. _setCubeMapTextureParams(loadMipmap: boolean): void;
  87555. }
  87556. }
  87557. declare module BABYLON {
  87558. /**
  87559. * Class for creating a cube texture
  87560. */
  87561. export class CubeTexture extends BaseTexture {
  87562. private _delayedOnLoad;
  87563. /**
  87564. * Observable triggered once the texture has been loaded.
  87565. */
  87566. onLoadObservable: Observable<CubeTexture>;
  87567. /**
  87568. * The url of the texture
  87569. */
  87570. url: string;
  87571. /**
  87572. * Gets or sets the center of the bounding box associated with the cube texture.
  87573. * It must define where the camera used to render the texture was set
  87574. * @see https://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  87575. */
  87576. boundingBoxPosition: Vector3;
  87577. private _boundingBoxSize;
  87578. /**
  87579. * Gets or sets the size of the bounding box associated with the cube texture
  87580. * When defined, the cubemap will switch to local mode
  87581. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  87582. * @example https://www.babylonjs-playground.com/#RNASML
  87583. */
  87584. set boundingBoxSize(value: Vector3);
  87585. /**
  87586. * Returns the bounding box size
  87587. * @see https://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  87588. */
  87589. get boundingBoxSize(): Vector3;
  87590. protected _rotationY: number;
  87591. /**
  87592. * Sets texture matrix rotation angle around Y axis in radians.
  87593. */
  87594. set rotationY(value: number);
  87595. /**
  87596. * Gets texture matrix rotation angle around Y axis radians.
  87597. */
  87598. get rotationY(): number;
  87599. /**
  87600. * Are mip maps generated for this texture or not.
  87601. */
  87602. get noMipmap(): boolean;
  87603. private _noMipmap;
  87604. private _files;
  87605. protected _forcedExtension: Nullable<string>;
  87606. private _extensions;
  87607. private _textureMatrix;
  87608. private _format;
  87609. private _createPolynomials;
  87610. /**
  87611. * Creates a cube texture from an array of image urls
  87612. * @param files defines an array of image urls
  87613. * @param scene defines the hosting scene
  87614. * @param noMipmap specifies if mip maps are not used
  87615. * @returns a cube texture
  87616. */
  87617. static CreateFromImages(files: string[], scene: Scene, noMipmap?: boolean): CubeTexture;
  87618. /**
  87619. * Creates and return a texture created from prefilterd data by tools like IBL Baker or Lys.
  87620. * @param url defines the url of the prefiltered texture
  87621. * @param scene defines the scene the texture is attached to
  87622. * @param forcedExtension defines the extension of the file if different from the url
  87623. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  87624. * @return the prefiltered texture
  87625. */
  87626. static CreateFromPrefilteredData(url: string, scene: Scene, forcedExtension?: any, createPolynomials?: boolean): CubeTexture;
  87627. /**
  87628. * Creates a cube texture to use with reflection for instance. It can be based upon dds or six images as well
  87629. * as prefiltered data.
  87630. * @param rootUrl defines the url of the texture or the root name of the six images
  87631. * @param null defines the scene or engine the texture is attached to
  87632. * @param extensions defines the suffixes add to the picture name in case six images are in use like _px.jpg...
  87633. * @param noMipmap defines if mipmaps should be created or not
  87634. * @param files defines the six files to load for the different faces in that order: px, py, pz, nx, ny, nz
  87635. * @param onLoad defines a callback triggered at the end of the file load if no errors occured
  87636. * @param onError defines a callback triggered in case of error during load
  87637. * @param format defines the internal format to use for the texture once loaded
  87638. * @param prefiltered defines whether or not the texture is created from prefiltered data
  87639. * @param forcedExtension defines the extensions to use (force a special type of file to load) in case it is different from the file name
  87640. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  87641. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  87642. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  87643. * @return the cube texture
  87644. */
  87645. 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);
  87646. /**
  87647. * Get the current class name of the texture useful for serialization or dynamic coding.
  87648. * @returns "CubeTexture"
  87649. */
  87650. getClassName(): string;
  87651. /**
  87652. * Update the url (and optional buffer) of this texture if url was null during construction.
  87653. * @param url the url of the texture
  87654. * @param forcedExtension defines the extension to use
  87655. * @param onLoad callback called when the texture is loaded (defaults to null)
  87656. * @param prefiltered Defines whether the updated texture is prefiltered or not
  87657. */
  87658. updateURL(url: string, forcedExtension?: string, onLoad?: () => void, prefiltered?: boolean): void;
  87659. /**
  87660. * Delays loading of the cube texture
  87661. * @param forcedExtension defines the extension to use
  87662. */
  87663. delayLoad(forcedExtension?: string): void;
  87664. /**
  87665. * Returns the reflection texture matrix
  87666. * @returns the reflection texture matrix
  87667. */
  87668. getReflectionTextureMatrix(): Matrix;
  87669. /**
  87670. * Sets the reflection texture matrix
  87671. * @param value Reflection texture matrix
  87672. */
  87673. setReflectionTextureMatrix(value: Matrix): void;
  87674. /**
  87675. * Parses text to create a cube texture
  87676. * @param parsedTexture define the serialized text to read from
  87677. * @param scene defines the hosting scene
  87678. * @param rootUrl defines the root url of the cube texture
  87679. * @returns a cube texture
  87680. */
  87681. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): CubeTexture;
  87682. /**
  87683. * Makes a clone, or deep copy, of the cube texture
  87684. * @returns a new cube texture
  87685. */
  87686. clone(): CubeTexture;
  87687. }
  87688. }
  87689. declare module BABYLON {
  87690. /**
  87691. * Manages the defines for the Material
  87692. */
  87693. export class MaterialDefines {
  87694. /** @hidden */
  87695. protected _keys: string[];
  87696. private _isDirty;
  87697. /** @hidden */
  87698. _renderId: number;
  87699. /** @hidden */
  87700. _areLightsDirty: boolean;
  87701. /** @hidden */
  87702. _areLightsDisposed: boolean;
  87703. /** @hidden */
  87704. _areAttributesDirty: boolean;
  87705. /** @hidden */
  87706. _areTexturesDirty: boolean;
  87707. /** @hidden */
  87708. _areFresnelDirty: boolean;
  87709. /** @hidden */
  87710. _areMiscDirty: boolean;
  87711. /** @hidden */
  87712. _areImageProcessingDirty: boolean;
  87713. /** @hidden */
  87714. _normals: boolean;
  87715. /** @hidden */
  87716. _uvs: boolean;
  87717. /** @hidden */
  87718. _needNormals: boolean;
  87719. /** @hidden */
  87720. _needUVs: boolean;
  87721. [id: string]: any;
  87722. /**
  87723. * Specifies if the material needs to be re-calculated
  87724. */
  87725. get isDirty(): boolean;
  87726. /**
  87727. * Marks the material to indicate that it has been re-calculated
  87728. */
  87729. markAsProcessed(): void;
  87730. /**
  87731. * Marks the material to indicate that it needs to be re-calculated
  87732. */
  87733. markAsUnprocessed(): void;
  87734. /**
  87735. * Marks the material to indicate all of its defines need to be re-calculated
  87736. */
  87737. markAllAsDirty(): void;
  87738. /**
  87739. * Marks the material to indicate that image processing needs to be re-calculated
  87740. */
  87741. markAsImageProcessingDirty(): void;
  87742. /**
  87743. * Marks the material to indicate the lights need to be re-calculated
  87744. * @param disposed Defines whether the light is dirty due to dispose or not
  87745. */
  87746. markAsLightDirty(disposed?: boolean): void;
  87747. /**
  87748. * Marks the attribute state as changed
  87749. */
  87750. markAsAttributesDirty(): void;
  87751. /**
  87752. * Marks the texture state as changed
  87753. */
  87754. markAsTexturesDirty(): void;
  87755. /**
  87756. * Marks the fresnel state as changed
  87757. */
  87758. markAsFresnelDirty(): void;
  87759. /**
  87760. * Marks the misc state as changed
  87761. */
  87762. markAsMiscDirty(): void;
  87763. /**
  87764. * Rebuilds the material defines
  87765. */
  87766. rebuild(): void;
  87767. /**
  87768. * Specifies if two material defines are equal
  87769. * @param other - A material define instance to compare to
  87770. * @returns - Boolean indicating if the material defines are equal (true) or not (false)
  87771. */
  87772. isEqual(other: MaterialDefines): boolean;
  87773. /**
  87774. * Clones this instance's defines to another instance
  87775. * @param other - material defines to clone values to
  87776. */
  87777. cloneTo(other: MaterialDefines): void;
  87778. /**
  87779. * Resets the material define values
  87780. */
  87781. reset(): void;
  87782. /**
  87783. * Converts the material define values to a string
  87784. * @returns - String of material define information
  87785. */
  87786. toString(): string;
  87787. }
  87788. }
  87789. declare module BABYLON {
  87790. /**
  87791. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  87792. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  87793. * 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;
  87794. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  87795. */
  87796. export class ColorCurves {
  87797. private _dirty;
  87798. private _tempColor;
  87799. private _globalCurve;
  87800. private _highlightsCurve;
  87801. private _midtonesCurve;
  87802. private _shadowsCurve;
  87803. private _positiveCurve;
  87804. private _negativeCurve;
  87805. private _globalHue;
  87806. private _globalDensity;
  87807. private _globalSaturation;
  87808. private _globalExposure;
  87809. /**
  87810. * Gets the global Hue value.
  87811. * 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).
  87812. */
  87813. get globalHue(): number;
  87814. /**
  87815. * Sets the global Hue value.
  87816. * 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).
  87817. */
  87818. set globalHue(value: number);
  87819. /**
  87820. * Gets the global Density value.
  87821. * 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.
  87822. * Values less than zero provide a filter of opposite hue.
  87823. */
  87824. get globalDensity(): number;
  87825. /**
  87826. * Sets the global Density value.
  87827. * 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.
  87828. * Values less than zero provide a filter of opposite hue.
  87829. */
  87830. set globalDensity(value: number);
  87831. /**
  87832. * Gets the global Saturation value.
  87833. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  87834. */
  87835. get globalSaturation(): number;
  87836. /**
  87837. * Sets the global Saturation value.
  87838. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  87839. */
  87840. set globalSaturation(value: number);
  87841. /**
  87842. * Gets the global Exposure value.
  87843. * 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.
  87844. */
  87845. get globalExposure(): number;
  87846. /**
  87847. * Sets the global Exposure value.
  87848. * 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.
  87849. */
  87850. set globalExposure(value: number);
  87851. private _highlightsHue;
  87852. private _highlightsDensity;
  87853. private _highlightsSaturation;
  87854. private _highlightsExposure;
  87855. /**
  87856. * Gets the highlights Hue value.
  87857. * 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).
  87858. */
  87859. get highlightsHue(): number;
  87860. /**
  87861. * Sets the highlights Hue value.
  87862. * 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).
  87863. */
  87864. set highlightsHue(value: number);
  87865. /**
  87866. * Gets the highlights Density value.
  87867. * 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.
  87868. * Values less than zero provide a filter of opposite hue.
  87869. */
  87870. get highlightsDensity(): number;
  87871. /**
  87872. * Sets the highlights Density value.
  87873. * 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.
  87874. * Values less than zero provide a filter of opposite hue.
  87875. */
  87876. set highlightsDensity(value: number);
  87877. /**
  87878. * Gets the highlights Saturation value.
  87879. * 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.
  87880. */
  87881. get highlightsSaturation(): number;
  87882. /**
  87883. * Sets the highlights Saturation value.
  87884. * 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.
  87885. */
  87886. set highlightsSaturation(value: number);
  87887. /**
  87888. * Gets the highlights Exposure value.
  87889. * 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.
  87890. */
  87891. get highlightsExposure(): number;
  87892. /**
  87893. * Sets the highlights Exposure value.
  87894. * 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.
  87895. */
  87896. set highlightsExposure(value: number);
  87897. private _midtonesHue;
  87898. private _midtonesDensity;
  87899. private _midtonesSaturation;
  87900. private _midtonesExposure;
  87901. /**
  87902. * Gets the midtones Hue value.
  87903. * 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).
  87904. */
  87905. get midtonesHue(): number;
  87906. /**
  87907. * Sets the midtones Hue value.
  87908. * 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).
  87909. */
  87910. set midtonesHue(value: number);
  87911. /**
  87912. * Gets the midtones Density value.
  87913. * 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.
  87914. * Values less than zero provide a filter of opposite hue.
  87915. */
  87916. get midtonesDensity(): number;
  87917. /**
  87918. * Sets the midtones Density value.
  87919. * 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.
  87920. * Values less than zero provide a filter of opposite hue.
  87921. */
  87922. set midtonesDensity(value: number);
  87923. /**
  87924. * Gets the midtones Saturation value.
  87925. * 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.
  87926. */
  87927. get midtonesSaturation(): number;
  87928. /**
  87929. * Sets the midtones Saturation value.
  87930. * 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.
  87931. */
  87932. set midtonesSaturation(value: number);
  87933. /**
  87934. * Gets the midtones Exposure value.
  87935. * 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.
  87936. */
  87937. get midtonesExposure(): number;
  87938. /**
  87939. * Sets the midtones Exposure value.
  87940. * 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.
  87941. */
  87942. set midtonesExposure(value: number);
  87943. private _shadowsHue;
  87944. private _shadowsDensity;
  87945. private _shadowsSaturation;
  87946. private _shadowsExposure;
  87947. /**
  87948. * Gets the shadows Hue value.
  87949. * 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).
  87950. */
  87951. get shadowsHue(): number;
  87952. /**
  87953. * Sets the shadows Hue value.
  87954. * 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).
  87955. */
  87956. set shadowsHue(value: number);
  87957. /**
  87958. * Gets the shadows Density value.
  87959. * 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.
  87960. * Values less than zero provide a filter of opposite hue.
  87961. */
  87962. get shadowsDensity(): number;
  87963. /**
  87964. * Sets the shadows Density value.
  87965. * 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.
  87966. * Values less than zero provide a filter of opposite hue.
  87967. */
  87968. set shadowsDensity(value: number);
  87969. /**
  87970. * Gets the shadows Saturation value.
  87971. * 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.
  87972. */
  87973. get shadowsSaturation(): number;
  87974. /**
  87975. * Sets the shadows Saturation value.
  87976. * 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.
  87977. */
  87978. set shadowsSaturation(value: number);
  87979. /**
  87980. * Gets the shadows Exposure value.
  87981. * 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.
  87982. */
  87983. get shadowsExposure(): number;
  87984. /**
  87985. * Sets the shadows Exposure value.
  87986. * 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.
  87987. */
  87988. set shadowsExposure(value: number);
  87989. /**
  87990. * Returns the class name
  87991. * @returns The class name
  87992. */
  87993. getClassName(): string;
  87994. /**
  87995. * Binds the color curves to the shader.
  87996. * @param colorCurves The color curve to bind
  87997. * @param effect The effect to bind to
  87998. * @param positiveUniform The positive uniform shader parameter
  87999. * @param neutralUniform The neutral uniform shader parameter
  88000. * @param negativeUniform The negative uniform shader parameter
  88001. */
  88002. static Bind(colorCurves: ColorCurves, effect: Effect, positiveUniform?: string, neutralUniform?: string, negativeUniform?: string): void;
  88003. /**
  88004. * Prepare the list of uniforms associated with the ColorCurves effects.
  88005. * @param uniformsList The list of uniforms used in the effect
  88006. */
  88007. static PrepareUniforms(uniformsList: string[]): void;
  88008. /**
  88009. * Returns color grading data based on a hue, density, saturation and exposure value.
  88010. * @param filterHue The hue of the color filter.
  88011. * @param filterDensity The density of the color filter.
  88012. * @param saturation The saturation.
  88013. * @param exposure The exposure.
  88014. * @param result The result data container.
  88015. */
  88016. private getColorGradingDataToRef;
  88017. /**
  88018. * Takes an input slider value and returns an adjusted value that provides extra control near the centre.
  88019. * @param value The input slider value in range [-100,100].
  88020. * @returns Adjusted value.
  88021. */
  88022. private static applyColorGradingSliderNonlinear;
  88023. /**
  88024. * Returns an RGBA Color4 based on Hue, Saturation and Brightness (also referred to as value, HSV).
  88025. * @param hue The hue (H) input.
  88026. * @param saturation The saturation (S) input.
  88027. * @param brightness The brightness (B) input.
  88028. * @result An RGBA color represented as Vector4.
  88029. */
  88030. private static fromHSBToRef;
  88031. /**
  88032. * Returns a value clamped between min and max
  88033. * @param value The value to clamp
  88034. * @param min The minimum of value
  88035. * @param max The maximum of value
  88036. * @returns The clamped value.
  88037. */
  88038. private static clamp;
  88039. /**
  88040. * Clones the current color curve instance.
  88041. * @return The cloned curves
  88042. */
  88043. clone(): ColorCurves;
  88044. /**
  88045. * Serializes the current color curve instance to a json representation.
  88046. * @return a JSON representation
  88047. */
  88048. serialize(): any;
  88049. /**
  88050. * Parses the color curve from a json representation.
  88051. * @param source the JSON source to parse
  88052. * @return The parsed curves
  88053. */
  88054. static Parse(source: any): ColorCurves;
  88055. }
  88056. }
  88057. declare module BABYLON {
  88058. /**
  88059. * Interface to follow in your material defines to integrate easily the
  88060. * Image proccessing functions.
  88061. * @hidden
  88062. */
  88063. export interface IImageProcessingConfigurationDefines {
  88064. IMAGEPROCESSING: boolean;
  88065. VIGNETTE: boolean;
  88066. VIGNETTEBLENDMODEMULTIPLY: boolean;
  88067. VIGNETTEBLENDMODEOPAQUE: boolean;
  88068. TONEMAPPING: boolean;
  88069. TONEMAPPING_ACES: boolean;
  88070. CONTRAST: boolean;
  88071. EXPOSURE: boolean;
  88072. COLORCURVES: boolean;
  88073. COLORGRADING: boolean;
  88074. COLORGRADING3D: boolean;
  88075. SAMPLER3DGREENDEPTH: boolean;
  88076. SAMPLER3DBGRMAP: boolean;
  88077. IMAGEPROCESSINGPOSTPROCESS: boolean;
  88078. }
  88079. /**
  88080. * @hidden
  88081. */
  88082. export class ImageProcessingConfigurationDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  88083. IMAGEPROCESSING: boolean;
  88084. VIGNETTE: boolean;
  88085. VIGNETTEBLENDMODEMULTIPLY: boolean;
  88086. VIGNETTEBLENDMODEOPAQUE: boolean;
  88087. TONEMAPPING: boolean;
  88088. TONEMAPPING_ACES: boolean;
  88089. CONTRAST: boolean;
  88090. COLORCURVES: boolean;
  88091. COLORGRADING: boolean;
  88092. COLORGRADING3D: boolean;
  88093. SAMPLER3DGREENDEPTH: boolean;
  88094. SAMPLER3DBGRMAP: boolean;
  88095. IMAGEPROCESSINGPOSTPROCESS: boolean;
  88096. EXPOSURE: boolean;
  88097. constructor();
  88098. }
  88099. /**
  88100. * This groups together the common properties used for image processing either in direct forward pass
  88101. * or through post processing effect depending on the use of the image processing pipeline in your scene
  88102. * or not.
  88103. */
  88104. export class ImageProcessingConfiguration {
  88105. /**
  88106. * Default tone mapping applied in BabylonJS.
  88107. */
  88108. static readonly TONEMAPPING_STANDARD: number;
  88109. /**
  88110. * ACES Tone mapping (used by default in unreal and unity). This can help getting closer
  88111. * to other engines rendering to increase portability.
  88112. */
  88113. static readonly TONEMAPPING_ACES: number;
  88114. /**
  88115. * Color curves setup used in the effect if colorCurvesEnabled is set to true
  88116. */
  88117. colorCurves: Nullable<ColorCurves>;
  88118. private _colorCurvesEnabled;
  88119. /**
  88120. * Gets wether the color curves effect is enabled.
  88121. */
  88122. get colorCurvesEnabled(): boolean;
  88123. /**
  88124. * Sets wether the color curves effect is enabled.
  88125. */
  88126. set colorCurvesEnabled(value: boolean);
  88127. private _colorGradingTexture;
  88128. /**
  88129. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  88130. */
  88131. get colorGradingTexture(): Nullable<BaseTexture>;
  88132. /**
  88133. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  88134. */
  88135. set colorGradingTexture(value: Nullable<BaseTexture>);
  88136. private _colorGradingEnabled;
  88137. /**
  88138. * Gets wether the color grading effect is enabled.
  88139. */
  88140. get colorGradingEnabled(): boolean;
  88141. /**
  88142. * Sets wether the color grading effect is enabled.
  88143. */
  88144. set colorGradingEnabled(value: boolean);
  88145. private _colorGradingWithGreenDepth;
  88146. /**
  88147. * Gets wether the color grading effect is using a green depth for the 3d Texture.
  88148. */
  88149. get colorGradingWithGreenDepth(): boolean;
  88150. /**
  88151. * Sets wether the color grading effect is using a green depth for the 3d Texture.
  88152. */
  88153. set colorGradingWithGreenDepth(value: boolean);
  88154. private _colorGradingBGR;
  88155. /**
  88156. * Gets wether the color grading texture contains BGR values.
  88157. */
  88158. get colorGradingBGR(): boolean;
  88159. /**
  88160. * Sets wether the color grading texture contains BGR values.
  88161. */
  88162. set colorGradingBGR(value: boolean);
  88163. /** @hidden */
  88164. _exposure: number;
  88165. /**
  88166. * Gets the Exposure used in the effect.
  88167. */
  88168. get exposure(): number;
  88169. /**
  88170. * Sets the Exposure used in the effect.
  88171. */
  88172. set exposure(value: number);
  88173. private _toneMappingEnabled;
  88174. /**
  88175. * Gets wether the tone mapping effect is enabled.
  88176. */
  88177. get toneMappingEnabled(): boolean;
  88178. /**
  88179. * Sets wether the tone mapping effect is enabled.
  88180. */
  88181. set toneMappingEnabled(value: boolean);
  88182. private _toneMappingType;
  88183. /**
  88184. * Gets the type of tone mapping effect.
  88185. */
  88186. get toneMappingType(): number;
  88187. /**
  88188. * Sets the type of tone mapping effect used in BabylonJS.
  88189. */
  88190. set toneMappingType(value: number);
  88191. protected _contrast: number;
  88192. /**
  88193. * Gets the contrast used in the effect.
  88194. */
  88195. get contrast(): number;
  88196. /**
  88197. * Sets the contrast used in the effect.
  88198. */
  88199. set contrast(value: number);
  88200. /**
  88201. * Vignette stretch size.
  88202. */
  88203. vignetteStretch: number;
  88204. /**
  88205. * Vignette centre X Offset.
  88206. */
  88207. vignetteCentreX: number;
  88208. /**
  88209. * Vignette centre Y Offset.
  88210. */
  88211. vignetteCentreY: number;
  88212. /**
  88213. * Vignette weight or intensity of the vignette effect.
  88214. */
  88215. vignetteWeight: number;
  88216. /**
  88217. * Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  88218. * if vignetteEnabled is set to true.
  88219. */
  88220. vignetteColor: Color4;
  88221. /**
  88222. * Camera field of view used by the Vignette effect.
  88223. */
  88224. vignetteCameraFov: number;
  88225. private _vignetteBlendMode;
  88226. /**
  88227. * Gets the vignette blend mode allowing different kind of effect.
  88228. */
  88229. get vignetteBlendMode(): number;
  88230. /**
  88231. * Sets the vignette blend mode allowing different kind of effect.
  88232. */
  88233. set vignetteBlendMode(value: number);
  88234. private _vignetteEnabled;
  88235. /**
  88236. * Gets wether the vignette effect is enabled.
  88237. */
  88238. get vignetteEnabled(): boolean;
  88239. /**
  88240. * Sets wether the vignette effect is enabled.
  88241. */
  88242. set vignetteEnabled(value: boolean);
  88243. private _applyByPostProcess;
  88244. /**
  88245. * Gets wether the image processing is applied through a post process or not.
  88246. */
  88247. get applyByPostProcess(): boolean;
  88248. /**
  88249. * Sets wether the image processing is applied through a post process or not.
  88250. */
  88251. set applyByPostProcess(value: boolean);
  88252. private _isEnabled;
  88253. /**
  88254. * Gets wether the image processing is enabled or not.
  88255. */
  88256. get isEnabled(): boolean;
  88257. /**
  88258. * Sets wether the image processing is enabled or not.
  88259. */
  88260. set isEnabled(value: boolean);
  88261. /**
  88262. * An event triggered when the configuration changes and requires Shader to Update some parameters.
  88263. */
  88264. onUpdateParameters: Observable<ImageProcessingConfiguration>;
  88265. /**
  88266. * Method called each time the image processing information changes requires to recompile the effect.
  88267. */
  88268. protected _updateParameters(): void;
  88269. /**
  88270. * Gets the current class name.
  88271. * @return "ImageProcessingConfiguration"
  88272. */
  88273. getClassName(): string;
  88274. /**
  88275. * Prepare the list of uniforms associated with the Image Processing effects.
  88276. * @param uniforms The list of uniforms used in the effect
  88277. * @param defines the list of defines currently in use
  88278. */
  88279. static PrepareUniforms(uniforms: string[], defines: IImageProcessingConfigurationDefines): void;
  88280. /**
  88281. * Prepare the list of samplers associated with the Image Processing effects.
  88282. * @param samplersList The list of uniforms used in the effect
  88283. * @param defines the list of defines currently in use
  88284. */
  88285. static PrepareSamplers(samplersList: string[], defines: IImageProcessingConfigurationDefines): void;
  88286. /**
  88287. * Prepare the list of defines associated to the shader.
  88288. * @param defines the list of defines to complete
  88289. * @param forPostProcess Define if we are currently in post process mode or not
  88290. */
  88291. prepareDefines(defines: IImageProcessingConfigurationDefines, forPostProcess?: boolean): void;
  88292. /**
  88293. * Returns true if all the image processing information are ready.
  88294. * @returns True if ready, otherwise, false
  88295. */
  88296. isReady(): boolean;
  88297. /**
  88298. * Binds the image processing to the shader.
  88299. * @param effect The effect to bind to
  88300. * @param overrideAspectRatio Override the aspect ratio of the effect
  88301. */
  88302. bind(effect: Effect, overrideAspectRatio?: number): void;
  88303. /**
  88304. * Clones the current image processing instance.
  88305. * @return The cloned image processing
  88306. */
  88307. clone(): ImageProcessingConfiguration;
  88308. /**
  88309. * Serializes the current image processing instance to a json representation.
  88310. * @return a JSON representation
  88311. */
  88312. serialize(): any;
  88313. /**
  88314. * Parses the image processing from a json representation.
  88315. * @param source the JSON source to parse
  88316. * @return The parsed image processing
  88317. */
  88318. static Parse(source: any): ImageProcessingConfiguration;
  88319. private static _VIGNETTEMODE_MULTIPLY;
  88320. private static _VIGNETTEMODE_OPAQUE;
  88321. /**
  88322. * Used to apply the vignette as a mix with the pixel color.
  88323. */
  88324. static get VIGNETTEMODE_MULTIPLY(): number;
  88325. /**
  88326. * Used to apply the vignette as a replacement of the pixel color.
  88327. */
  88328. static get VIGNETTEMODE_OPAQUE(): number;
  88329. }
  88330. }
  88331. declare module BABYLON {
  88332. /** @hidden */
  88333. export var postprocessVertexShader: {
  88334. name: string;
  88335. shader: string;
  88336. };
  88337. }
  88338. declare module BABYLON {
  88339. interface ThinEngine {
  88340. /**
  88341. * Creates a new render target texture
  88342. * @param size defines the size of the texture
  88343. * @param options defines the options used to create the texture
  88344. * @returns a new render target texture stored in an InternalTexture
  88345. */
  88346. createRenderTargetTexture(size: number | {
  88347. width: number;
  88348. height: number;
  88349. layers?: number;
  88350. }, options: boolean | RenderTargetCreationOptions): InternalTexture;
  88351. /**
  88352. * Creates a depth stencil texture.
  88353. * This is only available in WebGL 2 or with the depth texture extension available.
  88354. * @param size The size of face edge in the texture.
  88355. * @param options The options defining the texture.
  88356. * @returns The texture
  88357. */
  88358. createDepthStencilTexture(size: number | {
  88359. width: number;
  88360. height: number;
  88361. layers?: number;
  88362. }, options: DepthTextureCreationOptions): InternalTexture;
  88363. /** @hidden */
  88364. _createDepthStencilTexture(size: number | {
  88365. width: number;
  88366. height: number;
  88367. layers?: number;
  88368. }, options: DepthTextureCreationOptions): InternalTexture;
  88369. }
  88370. }
  88371. declare module BABYLON {
  88372. /**
  88373. * Defines the kind of connection point for node based material
  88374. */
  88375. export enum NodeMaterialBlockConnectionPointTypes {
  88376. /** Float */
  88377. Float = 1,
  88378. /** Int */
  88379. Int = 2,
  88380. /** Vector2 */
  88381. Vector2 = 4,
  88382. /** Vector3 */
  88383. Vector3 = 8,
  88384. /** Vector4 */
  88385. Vector4 = 16,
  88386. /** Color3 */
  88387. Color3 = 32,
  88388. /** Color4 */
  88389. Color4 = 64,
  88390. /** Matrix */
  88391. Matrix = 128,
  88392. /** Custom object */
  88393. Object = 256,
  88394. /** Detect type based on connection */
  88395. AutoDetect = 1024,
  88396. /** Output type that will be defined by input type */
  88397. BasedOnInput = 2048
  88398. }
  88399. }
  88400. declare module BABYLON {
  88401. /**
  88402. * Enum used to define the target of a block
  88403. */
  88404. export enum NodeMaterialBlockTargets {
  88405. /** Vertex shader */
  88406. Vertex = 1,
  88407. /** Fragment shader */
  88408. Fragment = 2,
  88409. /** Neutral */
  88410. Neutral = 4,
  88411. /** Vertex and Fragment */
  88412. VertexAndFragment = 3
  88413. }
  88414. }
  88415. declare module BABYLON {
  88416. /**
  88417. * Enum defining the mode of a NodeMaterialBlockConnectionPoint
  88418. */
  88419. export enum NodeMaterialBlockConnectionPointMode {
  88420. /** Value is an uniform */
  88421. Uniform = 0,
  88422. /** Value is a mesh attribute */
  88423. Attribute = 1,
  88424. /** Value is a varying between vertex and fragment shaders */
  88425. Varying = 2,
  88426. /** Mode is undefined */
  88427. Undefined = 3
  88428. }
  88429. }
  88430. declare module BABYLON {
  88431. /**
  88432. * Enum used to define system values e.g. values automatically provided by the system
  88433. */
  88434. export enum NodeMaterialSystemValues {
  88435. /** World */
  88436. World = 1,
  88437. /** View */
  88438. View = 2,
  88439. /** Projection */
  88440. Projection = 3,
  88441. /** ViewProjection */
  88442. ViewProjection = 4,
  88443. /** WorldView */
  88444. WorldView = 5,
  88445. /** WorldViewProjection */
  88446. WorldViewProjection = 6,
  88447. /** CameraPosition */
  88448. CameraPosition = 7,
  88449. /** Fog Color */
  88450. FogColor = 8,
  88451. /** Delta time */
  88452. DeltaTime = 9
  88453. }
  88454. }
  88455. declare module BABYLON {
  88456. /** Defines supported spaces */
  88457. export enum Space {
  88458. /** Local (object) space */
  88459. LOCAL = 0,
  88460. /** World space */
  88461. WORLD = 1,
  88462. /** Bone space */
  88463. BONE = 2
  88464. }
  88465. /** Defines the 3 main axes */
  88466. export class Axis {
  88467. /** X axis */
  88468. static X: Vector3;
  88469. /** Y axis */
  88470. static Y: Vector3;
  88471. /** Z axis */
  88472. static Z: Vector3;
  88473. }
  88474. }
  88475. declare module BABYLON {
  88476. /**
  88477. * Represents a camera frustum
  88478. */
  88479. export class Frustum {
  88480. /**
  88481. * Gets the planes representing the frustum
  88482. * @param transform matrix to be applied to the returned planes
  88483. * @returns a new array of 6 Frustum planes computed by the given transformation matrix.
  88484. */
  88485. static GetPlanes(transform: DeepImmutable<Matrix>): Plane[];
  88486. /**
  88487. * Gets the near frustum plane transformed by the transform matrix
  88488. * @param transform transformation matrix to be applied to the resulting frustum plane
  88489. * @param frustumPlane the resuling frustum plane
  88490. */
  88491. static GetNearPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88492. /**
  88493. * Gets the far frustum plane transformed by the transform matrix
  88494. * @param transform transformation matrix to be applied to the resulting frustum plane
  88495. * @param frustumPlane the resuling frustum plane
  88496. */
  88497. static GetFarPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88498. /**
  88499. * Gets the left frustum plane transformed by the transform matrix
  88500. * @param transform transformation matrix to be applied to the resulting frustum plane
  88501. * @param frustumPlane the resuling frustum plane
  88502. */
  88503. static GetLeftPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88504. /**
  88505. * Gets the right frustum plane transformed by the transform matrix
  88506. * @param transform transformation matrix to be applied to the resulting frustum plane
  88507. * @param frustumPlane the resuling frustum plane
  88508. */
  88509. static GetRightPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88510. /**
  88511. * Gets the top frustum plane transformed by the transform matrix
  88512. * @param transform transformation matrix to be applied to the resulting frustum plane
  88513. * @param frustumPlane the resuling frustum plane
  88514. */
  88515. static GetTopPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88516. /**
  88517. * Gets the bottom frustum plane transformed by the transform matrix
  88518. * @param transform transformation matrix to be applied to the resulting frustum plane
  88519. * @param frustumPlane the resuling frustum plane
  88520. */
  88521. static GetBottomPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88522. /**
  88523. * Sets the given array "frustumPlanes" with the 6 Frustum planes computed by the given transformation matrix.
  88524. * @param transform transformation matrix to be applied to the resulting frustum planes
  88525. * @param frustumPlanes the resuling frustum planes
  88526. */
  88527. static GetPlanesToRef(transform: DeepImmutable<Matrix>, frustumPlanes: Plane[]): void;
  88528. }
  88529. }
  88530. declare module BABYLON {
  88531. /**
  88532. * Interface for the size containing width and height
  88533. */
  88534. export interface ISize {
  88535. /**
  88536. * Width
  88537. */
  88538. width: number;
  88539. /**
  88540. * Heighht
  88541. */
  88542. height: number;
  88543. }
  88544. /**
  88545. * Size containing widht and height
  88546. */
  88547. export class Size implements ISize {
  88548. /**
  88549. * Width
  88550. */
  88551. width: number;
  88552. /**
  88553. * Height
  88554. */
  88555. height: number;
  88556. /**
  88557. * Creates a Size object from the given width and height (floats).
  88558. * @param width width of the new size
  88559. * @param height height of the new size
  88560. */
  88561. constructor(width: number, height: number);
  88562. /**
  88563. * Returns a string with the Size width and height
  88564. * @returns a string with the Size width and height
  88565. */
  88566. toString(): string;
  88567. /**
  88568. * "Size"
  88569. * @returns the string "Size"
  88570. */
  88571. getClassName(): string;
  88572. /**
  88573. * Returns the Size hash code.
  88574. * @returns a hash code for a unique width and height
  88575. */
  88576. getHashCode(): number;
  88577. /**
  88578. * Updates the current size from the given one.
  88579. * @param src the given size
  88580. */
  88581. copyFrom(src: Size): void;
  88582. /**
  88583. * Updates in place the current Size from the given floats.
  88584. * @param width width of the new size
  88585. * @param height height of the new size
  88586. * @returns the updated Size.
  88587. */
  88588. copyFromFloats(width: number, height: number): Size;
  88589. /**
  88590. * Updates in place the current Size from the given floats.
  88591. * @param width width to set
  88592. * @param height height to set
  88593. * @returns the updated Size.
  88594. */
  88595. set(width: number, height: number): Size;
  88596. /**
  88597. * Multiplies the width and height by numbers
  88598. * @param w factor to multiple the width by
  88599. * @param h factor to multiple the height by
  88600. * @returns a new Size set with the multiplication result of the current Size and the given floats.
  88601. */
  88602. multiplyByFloats(w: number, h: number): Size;
  88603. /**
  88604. * Clones the size
  88605. * @returns a new Size copied from the given one.
  88606. */
  88607. clone(): Size;
  88608. /**
  88609. * True if the current Size and the given one width and height are strictly equal.
  88610. * @param other the other size to compare against
  88611. * @returns True if the current Size and the given one width and height are strictly equal.
  88612. */
  88613. equals(other: Size): boolean;
  88614. /**
  88615. * The surface of the Size : width * height (float).
  88616. */
  88617. get surface(): number;
  88618. /**
  88619. * Create a new size of zero
  88620. * @returns a new Size set to (0.0, 0.0)
  88621. */
  88622. static Zero(): Size;
  88623. /**
  88624. * Sums the width and height of two sizes
  88625. * @param otherSize size to add to this size
  88626. * @returns a new Size set as the addition result of the current Size and the given one.
  88627. */
  88628. add(otherSize: Size): Size;
  88629. /**
  88630. * Subtracts the width and height of two
  88631. * @param otherSize size to subtract to this size
  88632. * @returns a new Size set as the subtraction result of the given one from the current Size.
  88633. */
  88634. subtract(otherSize: Size): Size;
  88635. /**
  88636. * Creates a new Size set at the linear interpolation "amount" between "start" and "end"
  88637. * @param start starting size to lerp between
  88638. * @param end end size to lerp between
  88639. * @param amount amount to lerp between the start and end values
  88640. * @returns a new Size set at the linear interpolation "amount" between "start" and "end"
  88641. */
  88642. static Lerp(start: Size, end: Size, amount: number): Size;
  88643. }
  88644. }
  88645. declare module BABYLON {
  88646. /**
  88647. * Contains position and normal vectors for a vertex
  88648. */
  88649. export class PositionNormalVertex {
  88650. /** the position of the vertex (defaut: 0,0,0) */
  88651. position: Vector3;
  88652. /** the normal of the vertex (defaut: 0,1,0) */
  88653. normal: Vector3;
  88654. /**
  88655. * Creates a PositionNormalVertex
  88656. * @param position the position of the vertex (defaut: 0,0,0)
  88657. * @param normal the normal of the vertex (defaut: 0,1,0)
  88658. */
  88659. constructor(
  88660. /** the position of the vertex (defaut: 0,0,0) */
  88661. position?: Vector3,
  88662. /** the normal of the vertex (defaut: 0,1,0) */
  88663. normal?: Vector3);
  88664. /**
  88665. * Clones the PositionNormalVertex
  88666. * @returns the cloned PositionNormalVertex
  88667. */
  88668. clone(): PositionNormalVertex;
  88669. }
  88670. /**
  88671. * Contains position, normal and uv vectors for a vertex
  88672. */
  88673. export class PositionNormalTextureVertex {
  88674. /** the position of the vertex (defaut: 0,0,0) */
  88675. position: Vector3;
  88676. /** the normal of the vertex (defaut: 0,1,0) */
  88677. normal: Vector3;
  88678. /** the uv of the vertex (default: 0,0) */
  88679. uv: Vector2;
  88680. /**
  88681. * Creates a PositionNormalTextureVertex
  88682. * @param position the position of the vertex (defaut: 0,0,0)
  88683. * @param normal the normal of the vertex (defaut: 0,1,0)
  88684. * @param uv the uv of the vertex (default: 0,0)
  88685. */
  88686. constructor(
  88687. /** the position of the vertex (defaut: 0,0,0) */
  88688. position?: Vector3,
  88689. /** the normal of the vertex (defaut: 0,1,0) */
  88690. normal?: Vector3,
  88691. /** the uv of the vertex (default: 0,0) */
  88692. uv?: Vector2);
  88693. /**
  88694. * Clones the PositionNormalTextureVertex
  88695. * @returns the cloned PositionNormalTextureVertex
  88696. */
  88697. clone(): PositionNormalTextureVertex;
  88698. }
  88699. }
  88700. declare module BABYLON {
  88701. /**
  88702. * Enum defining the type of animations supported by InputBlock
  88703. */
  88704. export enum AnimatedInputBlockTypes {
  88705. /** No animation */
  88706. None = 0,
  88707. /** Time based animation. Will only work for floats */
  88708. Time = 1
  88709. }
  88710. }
  88711. declare module BABYLON {
  88712. /**
  88713. * Interface describing all the common properties and methods a shadow light needs to implement.
  88714. * This helps both the shadow generator and materials to genrate the corresponding shadow maps
  88715. * as well as binding the different shadow properties to the effects.
  88716. */
  88717. export interface IShadowLight extends Light {
  88718. /**
  88719. * The light id in the scene (used in scene.findLighById for instance)
  88720. */
  88721. id: string;
  88722. /**
  88723. * The position the shdow will be casted from.
  88724. */
  88725. position: Vector3;
  88726. /**
  88727. * In 2d mode (needCube being false), the direction used to cast the shadow.
  88728. */
  88729. direction: Vector3;
  88730. /**
  88731. * The transformed position. Position of the light in world space taking parenting in account.
  88732. */
  88733. transformedPosition: Vector3;
  88734. /**
  88735. * The transformed direction. Direction of the light in world space taking parenting in account.
  88736. */
  88737. transformedDirection: Vector3;
  88738. /**
  88739. * The friendly name of the light in the scene.
  88740. */
  88741. name: string;
  88742. /**
  88743. * Defines the shadow projection clipping minimum z value.
  88744. */
  88745. shadowMinZ: number;
  88746. /**
  88747. * Defines the shadow projection clipping maximum z value.
  88748. */
  88749. shadowMaxZ: number;
  88750. /**
  88751. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  88752. * @returns true if the information has been computed, false if it does not need to (no parenting)
  88753. */
  88754. computeTransformedInformation(): boolean;
  88755. /**
  88756. * Gets the scene the light belongs to.
  88757. * @returns The scene
  88758. */
  88759. getScene(): Scene;
  88760. /**
  88761. * Callback defining a custom Projection Matrix Builder.
  88762. * This can be used to override the default projection matrix computation.
  88763. */
  88764. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  88765. /**
  88766. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  88767. * @param matrix The materix to updated with the projection information
  88768. * @param viewMatrix The transform matrix of the light
  88769. * @param renderList The list of mesh to render in the map
  88770. * @returns The current light
  88771. */
  88772. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  88773. /**
  88774. * Gets the current depth scale used in ESM.
  88775. * @returns The scale
  88776. */
  88777. getDepthScale(): number;
  88778. /**
  88779. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  88780. * @returns true if a cube texture needs to be use
  88781. */
  88782. needCube(): boolean;
  88783. /**
  88784. * Detects if the projection matrix requires to be recomputed this frame.
  88785. * @returns true if it requires to be recomputed otherwise, false.
  88786. */
  88787. needProjectionMatrixCompute(): boolean;
  88788. /**
  88789. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  88790. */
  88791. forceProjectionMatrixCompute(): void;
  88792. /**
  88793. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  88794. * @param faceIndex The index of the face we are computed the direction to generate shadow
  88795. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  88796. */
  88797. getShadowDirection(faceIndex?: number): Vector3;
  88798. /**
  88799. * Gets the minZ used for shadow according to both the scene and the light.
  88800. * @param activeCamera The camera we are returning the min for
  88801. * @returns the depth min z
  88802. */
  88803. getDepthMinZ(activeCamera: Camera): number;
  88804. /**
  88805. * Gets the maxZ used for shadow according to both the scene and the light.
  88806. * @param activeCamera The camera we are returning the max for
  88807. * @returns the depth max z
  88808. */
  88809. getDepthMaxZ(activeCamera: Camera): number;
  88810. }
  88811. /**
  88812. * Base implementation IShadowLight
  88813. * It groups all the common behaviour in order to reduce dupplication and better follow the DRY pattern.
  88814. */
  88815. export abstract class ShadowLight extends Light implements IShadowLight {
  88816. protected abstract _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  88817. protected _position: Vector3;
  88818. protected _setPosition(value: Vector3): void;
  88819. /**
  88820. * Sets the position the shadow will be casted from. Also use as the light position for both
  88821. * point and spot lights.
  88822. */
  88823. get position(): Vector3;
  88824. /**
  88825. * Sets the position the shadow will be casted from. Also use as the light position for both
  88826. * point and spot lights.
  88827. */
  88828. set position(value: Vector3);
  88829. protected _direction: Vector3;
  88830. protected _setDirection(value: Vector3): void;
  88831. /**
  88832. * In 2d mode (needCube being false), gets the direction used to cast the shadow.
  88833. * Also use as the light direction on spot and directional lights.
  88834. */
  88835. get direction(): Vector3;
  88836. /**
  88837. * In 2d mode (needCube being false), sets the direction used to cast the shadow.
  88838. * Also use as the light direction on spot and directional lights.
  88839. */
  88840. set direction(value: Vector3);
  88841. protected _shadowMinZ: number;
  88842. /**
  88843. * Gets the shadow projection clipping minimum z value.
  88844. */
  88845. get shadowMinZ(): number;
  88846. /**
  88847. * Sets the shadow projection clipping minimum z value.
  88848. */
  88849. set shadowMinZ(value: number);
  88850. protected _shadowMaxZ: number;
  88851. /**
  88852. * Sets the shadow projection clipping maximum z value.
  88853. */
  88854. get shadowMaxZ(): number;
  88855. /**
  88856. * Gets the shadow projection clipping maximum z value.
  88857. */
  88858. set shadowMaxZ(value: number);
  88859. /**
  88860. * Callback defining a custom Projection Matrix Builder.
  88861. * This can be used to override the default projection matrix computation.
  88862. */
  88863. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  88864. /**
  88865. * The transformed position. Position of the light in world space taking parenting in account.
  88866. */
  88867. transformedPosition: Vector3;
  88868. /**
  88869. * The transformed direction. Direction of the light in world space taking parenting in account.
  88870. */
  88871. transformedDirection: Vector3;
  88872. private _needProjectionMatrixCompute;
  88873. /**
  88874. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  88875. * @returns true if the information has been computed, false if it does not need to (no parenting)
  88876. */
  88877. computeTransformedInformation(): boolean;
  88878. /**
  88879. * Return the depth scale used for the shadow map.
  88880. * @returns the depth scale.
  88881. */
  88882. getDepthScale(): number;
  88883. /**
  88884. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  88885. * @param faceIndex The index of the face we are computed the direction to generate shadow
  88886. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  88887. */
  88888. getShadowDirection(faceIndex?: number): Vector3;
  88889. /**
  88890. * Returns the ShadowLight absolute position in the World.
  88891. * @returns the position vector in world space
  88892. */
  88893. getAbsolutePosition(): Vector3;
  88894. /**
  88895. * Sets the ShadowLight direction toward the passed target.
  88896. * @param target The point to target in local space
  88897. * @returns the updated ShadowLight direction
  88898. */
  88899. setDirectionToTarget(target: Vector3): Vector3;
  88900. /**
  88901. * Returns the light rotation in euler definition.
  88902. * @returns the x y z rotation in local space.
  88903. */
  88904. getRotation(): Vector3;
  88905. /**
  88906. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  88907. * @returns true if a cube texture needs to be use
  88908. */
  88909. needCube(): boolean;
  88910. /**
  88911. * Detects if the projection matrix requires to be recomputed this frame.
  88912. * @returns true if it requires to be recomputed otherwise, false.
  88913. */
  88914. needProjectionMatrixCompute(): boolean;
  88915. /**
  88916. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  88917. */
  88918. forceProjectionMatrixCompute(): void;
  88919. /** @hidden */
  88920. _initCache(): void;
  88921. /** @hidden */
  88922. _isSynchronized(): boolean;
  88923. /**
  88924. * Computes the world matrix of the node
  88925. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  88926. * @returns the world matrix
  88927. */
  88928. computeWorldMatrix(force?: boolean): Matrix;
  88929. /**
  88930. * Gets the minZ used for shadow according to both the scene and the light.
  88931. * @param activeCamera The camera we are returning the min for
  88932. * @returns the depth min z
  88933. */
  88934. getDepthMinZ(activeCamera: Camera): number;
  88935. /**
  88936. * Gets the maxZ used for shadow according to both the scene and the light.
  88937. * @param activeCamera The camera we are returning the max for
  88938. * @returns the depth max z
  88939. */
  88940. getDepthMaxZ(activeCamera: Camera): number;
  88941. /**
  88942. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  88943. * @param matrix The materix to updated with the projection information
  88944. * @param viewMatrix The transform matrix of the light
  88945. * @param renderList The list of mesh to render in the map
  88946. * @returns The current light
  88947. */
  88948. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  88949. }
  88950. }
  88951. declare module BABYLON {
  88952. /** @hidden */
  88953. export var packingFunctions: {
  88954. name: string;
  88955. shader: string;
  88956. };
  88957. }
  88958. declare module BABYLON {
  88959. /** @hidden */
  88960. export var bayerDitherFunctions: {
  88961. name: string;
  88962. shader: string;
  88963. };
  88964. }
  88965. declare module BABYLON {
  88966. /** @hidden */
  88967. export var shadowMapFragmentDeclaration: {
  88968. name: string;
  88969. shader: string;
  88970. };
  88971. }
  88972. declare module BABYLON {
  88973. /** @hidden */
  88974. export var clipPlaneFragmentDeclaration: {
  88975. name: string;
  88976. shader: string;
  88977. };
  88978. }
  88979. declare module BABYLON {
  88980. /** @hidden */
  88981. export var clipPlaneFragment: {
  88982. name: string;
  88983. shader: string;
  88984. };
  88985. }
  88986. declare module BABYLON {
  88987. /** @hidden */
  88988. export var shadowMapFragment: {
  88989. name: string;
  88990. shader: string;
  88991. };
  88992. }
  88993. declare module BABYLON {
  88994. /** @hidden */
  88995. export var shadowMapPixelShader: {
  88996. name: string;
  88997. shader: string;
  88998. };
  88999. }
  89000. declare module BABYLON {
  89001. /** @hidden */
  89002. export var bonesDeclaration: {
  89003. name: string;
  89004. shader: string;
  89005. };
  89006. }
  89007. declare module BABYLON {
  89008. /** @hidden */
  89009. export var morphTargetsVertexGlobalDeclaration: {
  89010. name: string;
  89011. shader: string;
  89012. };
  89013. }
  89014. declare module BABYLON {
  89015. /** @hidden */
  89016. export var morphTargetsVertexDeclaration: {
  89017. name: string;
  89018. shader: string;
  89019. };
  89020. }
  89021. declare module BABYLON {
  89022. /** @hidden */
  89023. export var instancesDeclaration: {
  89024. name: string;
  89025. shader: string;
  89026. };
  89027. }
  89028. declare module BABYLON {
  89029. /** @hidden */
  89030. export var helperFunctions: {
  89031. name: string;
  89032. shader: string;
  89033. };
  89034. }
  89035. declare module BABYLON {
  89036. /** @hidden */
  89037. export var shadowMapVertexDeclaration: {
  89038. name: string;
  89039. shader: string;
  89040. };
  89041. }
  89042. declare module BABYLON {
  89043. /** @hidden */
  89044. export var clipPlaneVertexDeclaration: {
  89045. name: string;
  89046. shader: string;
  89047. };
  89048. }
  89049. declare module BABYLON {
  89050. /** @hidden */
  89051. export var morphTargetsVertex: {
  89052. name: string;
  89053. shader: string;
  89054. };
  89055. }
  89056. declare module BABYLON {
  89057. /** @hidden */
  89058. export var instancesVertex: {
  89059. name: string;
  89060. shader: string;
  89061. };
  89062. }
  89063. declare module BABYLON {
  89064. /** @hidden */
  89065. export var bonesVertex: {
  89066. name: string;
  89067. shader: string;
  89068. };
  89069. }
  89070. declare module BABYLON {
  89071. /** @hidden */
  89072. export var shadowMapVertexNormalBias: {
  89073. name: string;
  89074. shader: string;
  89075. };
  89076. }
  89077. declare module BABYLON {
  89078. /** @hidden */
  89079. export var shadowMapVertexMetric: {
  89080. name: string;
  89081. shader: string;
  89082. };
  89083. }
  89084. declare module BABYLON {
  89085. /** @hidden */
  89086. export var clipPlaneVertex: {
  89087. name: string;
  89088. shader: string;
  89089. };
  89090. }
  89091. declare module BABYLON {
  89092. /** @hidden */
  89093. export var shadowMapVertexShader: {
  89094. name: string;
  89095. shader: string;
  89096. };
  89097. }
  89098. declare module BABYLON {
  89099. /** @hidden */
  89100. export var depthBoxBlurPixelShader: {
  89101. name: string;
  89102. shader: string;
  89103. };
  89104. }
  89105. declare module BABYLON {
  89106. /** @hidden */
  89107. export var shadowMapFragmentSoftTransparentShadow: {
  89108. name: string;
  89109. shader: string;
  89110. };
  89111. }
  89112. declare module BABYLON {
  89113. /**
  89114. * EffectFallbacks can be used to add fallbacks (properties to disable) to certain properties when desired to improve performance.
  89115. * (Eg. Start at high quality with reflection and fog, if fps is low, remove reflection, if still low remove fog)
  89116. */
  89117. export class EffectFallbacks implements IEffectFallbacks {
  89118. private _defines;
  89119. private _currentRank;
  89120. private _maxRank;
  89121. private _mesh;
  89122. /**
  89123. * Removes the fallback from the bound mesh.
  89124. */
  89125. unBindMesh(): void;
  89126. /**
  89127. * Adds a fallback on the specified property.
  89128. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  89129. * @param define The name of the define in the shader
  89130. */
  89131. addFallback(rank: number, define: string): void;
  89132. /**
  89133. * Sets the mesh to use CPU skinning when needing to fallback.
  89134. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  89135. * @param mesh The mesh to use the fallbacks.
  89136. */
  89137. addCPUSkinningFallback(rank: number, mesh: AbstractMesh): void;
  89138. /**
  89139. * Checks to see if more fallbacks are still availible.
  89140. */
  89141. get hasMoreFallbacks(): boolean;
  89142. /**
  89143. * Removes the defines that should be removed when falling back.
  89144. * @param currentDefines defines the current define statements for the shader.
  89145. * @param effect defines the current effect we try to compile
  89146. * @returns The resulting defines with defines of the current rank removed.
  89147. */
  89148. reduce(currentDefines: string, effect: Effect): string;
  89149. }
  89150. }
  89151. declare module BABYLON {
  89152. /**
  89153. * Interface used to define Action
  89154. */
  89155. export interface IAction {
  89156. /**
  89157. * Trigger for the action
  89158. */
  89159. trigger: number;
  89160. /** Options of the trigger */
  89161. triggerOptions: any;
  89162. /**
  89163. * Gets the trigger parameters
  89164. * @returns the trigger parameters
  89165. */
  89166. getTriggerParameter(): any;
  89167. /**
  89168. * Internal only - executes current action event
  89169. * @hidden
  89170. */
  89171. _executeCurrent(evt?: ActionEvent): void;
  89172. /**
  89173. * Serialize placeholder for child classes
  89174. * @param parent of child
  89175. * @returns the serialized object
  89176. */
  89177. serialize(parent: any): any;
  89178. /**
  89179. * Internal only
  89180. * @hidden
  89181. */
  89182. _prepare(): void;
  89183. /**
  89184. * Internal only - manager for action
  89185. * @hidden
  89186. */
  89187. _actionManager: Nullable<AbstractActionManager>;
  89188. /**
  89189. * Adds action to chain of actions, may be a DoNothingAction
  89190. * @param action defines the next action to execute
  89191. * @returns The action passed in
  89192. * @see https://www.babylonjs-playground.com/#1T30HR#0
  89193. */
  89194. then(action: IAction): IAction;
  89195. }
  89196. /**
  89197. * The action to be carried out following a trigger
  89198. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#available-actions
  89199. */
  89200. export class Action implements IAction {
  89201. /** the trigger, with or without parameters, for the action */
  89202. triggerOptions: any;
  89203. /**
  89204. * Trigger for the action
  89205. */
  89206. trigger: number;
  89207. /**
  89208. * Internal only - manager for action
  89209. * @hidden
  89210. */
  89211. _actionManager: ActionManager;
  89212. private _nextActiveAction;
  89213. private _child;
  89214. private _condition?;
  89215. private _triggerParameter;
  89216. /**
  89217. * An event triggered prior to action being executed.
  89218. */
  89219. onBeforeExecuteObservable: Observable<Action>;
  89220. /**
  89221. * Creates a new Action
  89222. * @param triggerOptions the trigger, with or without parameters, for the action
  89223. * @param condition an optional determinant of action
  89224. */
  89225. constructor(
  89226. /** the trigger, with or without parameters, for the action */
  89227. triggerOptions: any, condition?: Condition);
  89228. /**
  89229. * Internal only
  89230. * @hidden
  89231. */
  89232. _prepare(): void;
  89233. /**
  89234. * Gets the trigger parameters
  89235. * @returns the trigger parameters
  89236. */
  89237. getTriggerParameter(): any;
  89238. /**
  89239. * Internal only - executes current action event
  89240. * @hidden
  89241. */
  89242. _executeCurrent(evt?: ActionEvent): void;
  89243. /**
  89244. * Execute placeholder for child classes
  89245. * @param evt optional action event
  89246. */
  89247. execute(evt?: ActionEvent): void;
  89248. /**
  89249. * Skips to next active action
  89250. */
  89251. skipToNextActiveAction(): void;
  89252. /**
  89253. * Adds action to chain of actions, may be a DoNothingAction
  89254. * @param action defines the next action to execute
  89255. * @returns The action passed in
  89256. * @see https://www.babylonjs-playground.com/#1T30HR#0
  89257. */
  89258. then(action: Action): Action;
  89259. /**
  89260. * Internal only
  89261. * @hidden
  89262. */
  89263. _getProperty(propertyPath: string): string;
  89264. /**
  89265. * Internal only
  89266. * @hidden
  89267. */
  89268. _getEffectiveTarget(target: any, propertyPath: string): any;
  89269. /**
  89270. * Serialize placeholder for child classes
  89271. * @param parent of child
  89272. * @returns the serialized object
  89273. */
  89274. serialize(parent: any): any;
  89275. /**
  89276. * Internal only called by serialize
  89277. * @hidden
  89278. */
  89279. protected _serialize(serializedAction: any, parent?: any): any;
  89280. /**
  89281. * Internal only
  89282. * @hidden
  89283. */
  89284. static _SerializeValueAsString: (value: any) => string;
  89285. /**
  89286. * Internal only
  89287. * @hidden
  89288. */
  89289. static _GetTargetProperty: (target: Scene | Node) => {
  89290. name: string;
  89291. targetType: string;
  89292. value: string;
  89293. };
  89294. }
  89295. }
  89296. declare module BABYLON {
  89297. /**
  89298. * A Condition applied to an Action
  89299. */
  89300. export class Condition {
  89301. /**
  89302. * Internal only - manager for action
  89303. * @hidden
  89304. */
  89305. _actionManager: ActionManager;
  89306. /**
  89307. * Internal only
  89308. * @hidden
  89309. */
  89310. _evaluationId: number;
  89311. /**
  89312. * Internal only
  89313. * @hidden
  89314. */
  89315. _currentResult: boolean;
  89316. /**
  89317. * Creates a new Condition
  89318. * @param actionManager the manager of the action the condition is applied to
  89319. */
  89320. constructor(actionManager: ActionManager);
  89321. /**
  89322. * Check if the current condition is valid
  89323. * @returns a boolean
  89324. */
  89325. isValid(): boolean;
  89326. /**
  89327. * Internal only
  89328. * @hidden
  89329. */
  89330. _getProperty(propertyPath: string): string;
  89331. /**
  89332. * Internal only
  89333. * @hidden
  89334. */
  89335. _getEffectiveTarget(target: any, propertyPath: string): any;
  89336. /**
  89337. * Serialize placeholder for child classes
  89338. * @returns the serialized object
  89339. */
  89340. serialize(): any;
  89341. /**
  89342. * Internal only
  89343. * @hidden
  89344. */
  89345. protected _serialize(serializedCondition: any): any;
  89346. }
  89347. /**
  89348. * Defines specific conditional operators as extensions of Condition
  89349. */
  89350. export class ValueCondition extends Condition {
  89351. /** path to specify the property of the target the conditional operator uses */
  89352. propertyPath: string;
  89353. /** the value compared by the conditional operator against the current value of the property */
  89354. value: any;
  89355. /** the conditional operator, default ValueCondition.IsEqual */
  89356. operator: number;
  89357. /**
  89358. * Internal only
  89359. * @hidden
  89360. */
  89361. private static _IsEqual;
  89362. /**
  89363. * Internal only
  89364. * @hidden
  89365. */
  89366. private static _IsDifferent;
  89367. /**
  89368. * Internal only
  89369. * @hidden
  89370. */
  89371. private static _IsGreater;
  89372. /**
  89373. * Internal only
  89374. * @hidden
  89375. */
  89376. private static _IsLesser;
  89377. /**
  89378. * returns the number for IsEqual
  89379. */
  89380. static get IsEqual(): number;
  89381. /**
  89382. * Returns the number for IsDifferent
  89383. */
  89384. static get IsDifferent(): number;
  89385. /**
  89386. * Returns the number for IsGreater
  89387. */
  89388. static get IsGreater(): number;
  89389. /**
  89390. * Returns the number for IsLesser
  89391. */
  89392. static get IsLesser(): number;
  89393. /**
  89394. * Internal only The action manager for the condition
  89395. * @hidden
  89396. */
  89397. _actionManager: ActionManager;
  89398. /**
  89399. * Internal only
  89400. * @hidden
  89401. */
  89402. private _target;
  89403. /**
  89404. * Internal only
  89405. * @hidden
  89406. */
  89407. private _effectiveTarget;
  89408. /**
  89409. * Internal only
  89410. * @hidden
  89411. */
  89412. private _property;
  89413. /**
  89414. * Creates a new ValueCondition
  89415. * @param actionManager manager for the action the condition applies to
  89416. * @param target for the action
  89417. * @param propertyPath path to specify the property of the target the conditional operator uses
  89418. * @param value the value compared by the conditional operator against the current value of the property
  89419. * @param operator the conditional operator, default ValueCondition.IsEqual
  89420. */
  89421. constructor(actionManager: ActionManager, target: any,
  89422. /** path to specify the property of the target the conditional operator uses */
  89423. propertyPath: string,
  89424. /** the value compared by the conditional operator against the current value of the property */
  89425. value: any,
  89426. /** the conditional operator, default ValueCondition.IsEqual */
  89427. operator?: number);
  89428. /**
  89429. * Compares the given value with the property value for the specified conditional operator
  89430. * @returns the result of the comparison
  89431. */
  89432. isValid(): boolean;
  89433. /**
  89434. * Serialize the ValueCondition into a JSON compatible object
  89435. * @returns serialization object
  89436. */
  89437. serialize(): any;
  89438. /**
  89439. * Gets the name of the conditional operator for the ValueCondition
  89440. * @param operator the conditional operator
  89441. * @returns the name
  89442. */
  89443. static GetOperatorName(operator: number): string;
  89444. }
  89445. /**
  89446. * Defines a predicate condition as an extension of Condition
  89447. */
  89448. export class PredicateCondition extends Condition {
  89449. /** defines the predicate function used to validate the condition */
  89450. predicate: () => boolean;
  89451. /**
  89452. * Internal only - manager for action
  89453. * @hidden
  89454. */
  89455. _actionManager: ActionManager;
  89456. /**
  89457. * Creates a new PredicateCondition
  89458. * @param actionManager manager for the action the condition applies to
  89459. * @param predicate defines the predicate function used to validate the condition
  89460. */
  89461. constructor(actionManager: ActionManager,
  89462. /** defines the predicate function used to validate the condition */
  89463. predicate: () => boolean);
  89464. /**
  89465. * @returns the validity of the predicate condition
  89466. */
  89467. isValid(): boolean;
  89468. }
  89469. /**
  89470. * Defines a state condition as an extension of Condition
  89471. */
  89472. export class StateCondition extends Condition {
  89473. /** Value to compare with target state */
  89474. value: string;
  89475. /**
  89476. * Internal only - manager for action
  89477. * @hidden
  89478. */
  89479. _actionManager: ActionManager;
  89480. /**
  89481. * Internal only
  89482. * @hidden
  89483. */
  89484. private _target;
  89485. /**
  89486. * Creates a new StateCondition
  89487. * @param actionManager manager for the action the condition applies to
  89488. * @param target of the condition
  89489. * @param value to compare with target state
  89490. */
  89491. constructor(actionManager: ActionManager, target: any,
  89492. /** Value to compare with target state */
  89493. value: string);
  89494. /**
  89495. * Gets a boolean indicating if the current condition is met
  89496. * @returns the validity of the state
  89497. */
  89498. isValid(): boolean;
  89499. /**
  89500. * Serialize the StateCondition into a JSON compatible object
  89501. * @returns serialization object
  89502. */
  89503. serialize(): any;
  89504. }
  89505. }
  89506. declare module BABYLON {
  89507. /**
  89508. * This defines an action responsible to toggle a boolean once triggered.
  89509. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89510. */
  89511. export class SwitchBooleanAction extends Action {
  89512. /**
  89513. * The path to the boolean property in the target object
  89514. */
  89515. propertyPath: string;
  89516. private _target;
  89517. private _effectiveTarget;
  89518. private _property;
  89519. /**
  89520. * Instantiate the action
  89521. * @param triggerOptions defines the trigger options
  89522. * @param target defines the object containing the boolean
  89523. * @param propertyPath defines the path to the boolean property in the target object
  89524. * @param condition defines the trigger related conditions
  89525. */
  89526. constructor(triggerOptions: any, target: any, propertyPath: string, condition?: Condition);
  89527. /** @hidden */
  89528. _prepare(): void;
  89529. /**
  89530. * Execute the action toggle the boolean value.
  89531. */
  89532. execute(): void;
  89533. /**
  89534. * Serializes the actions and its related information.
  89535. * @param parent defines the object to serialize in
  89536. * @returns the serialized object
  89537. */
  89538. serialize(parent: any): any;
  89539. }
  89540. /**
  89541. * This defines an action responsible to set a the state field of the target
  89542. * to a desired value once triggered.
  89543. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89544. */
  89545. export class SetStateAction extends Action {
  89546. /**
  89547. * The value to store in the state field.
  89548. */
  89549. value: string;
  89550. private _target;
  89551. /**
  89552. * Instantiate the action
  89553. * @param triggerOptions defines the trigger options
  89554. * @param target defines the object containing the state property
  89555. * @param value defines the value to store in the state field
  89556. * @param condition defines the trigger related conditions
  89557. */
  89558. constructor(triggerOptions: any, target: any, value: string, condition?: Condition);
  89559. /**
  89560. * Execute the action and store the value on the target state property.
  89561. */
  89562. execute(): void;
  89563. /**
  89564. * Serializes the actions and its related information.
  89565. * @param parent defines the object to serialize in
  89566. * @returns the serialized object
  89567. */
  89568. serialize(parent: any): any;
  89569. }
  89570. /**
  89571. * This defines an action responsible to set a property of the target
  89572. * to a desired value once triggered.
  89573. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89574. */
  89575. export class SetValueAction extends Action {
  89576. /**
  89577. * The path of the property to set in the target.
  89578. */
  89579. propertyPath: string;
  89580. /**
  89581. * The value to set in the property
  89582. */
  89583. value: any;
  89584. private _target;
  89585. private _effectiveTarget;
  89586. private _property;
  89587. /**
  89588. * Instantiate the action
  89589. * @param triggerOptions defines the trigger options
  89590. * @param target defines the object containing the property
  89591. * @param propertyPath defines the path of the property to set in the target
  89592. * @param value defines the value to set in the property
  89593. * @param condition defines the trigger related conditions
  89594. */
  89595. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  89596. /** @hidden */
  89597. _prepare(): void;
  89598. /**
  89599. * Execute the action and set the targetted property to the desired value.
  89600. */
  89601. execute(): void;
  89602. /**
  89603. * Serializes the actions and its related information.
  89604. * @param parent defines the object to serialize in
  89605. * @returns the serialized object
  89606. */
  89607. serialize(parent: any): any;
  89608. }
  89609. /**
  89610. * This defines an action responsible to increment the target value
  89611. * to a desired value once triggered.
  89612. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89613. */
  89614. export class IncrementValueAction extends Action {
  89615. /**
  89616. * The path of the property to increment in the target.
  89617. */
  89618. propertyPath: string;
  89619. /**
  89620. * The value we should increment the property by.
  89621. */
  89622. value: any;
  89623. private _target;
  89624. private _effectiveTarget;
  89625. private _property;
  89626. /**
  89627. * Instantiate the action
  89628. * @param triggerOptions defines the trigger options
  89629. * @param target defines the object containing the property
  89630. * @param propertyPath defines the path of the property to increment in the target
  89631. * @param value defines the value value we should increment the property by
  89632. * @param condition defines the trigger related conditions
  89633. */
  89634. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  89635. /** @hidden */
  89636. _prepare(): void;
  89637. /**
  89638. * Execute the action and increment the target of the value amount.
  89639. */
  89640. execute(): void;
  89641. /**
  89642. * Serializes the actions and its related information.
  89643. * @param parent defines the object to serialize in
  89644. * @returns the serialized object
  89645. */
  89646. serialize(parent: any): any;
  89647. }
  89648. /**
  89649. * This defines an action responsible to start an animation once triggered.
  89650. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89651. */
  89652. export class PlayAnimationAction extends Action {
  89653. /**
  89654. * Where the animation should start (animation frame)
  89655. */
  89656. from: number;
  89657. /**
  89658. * Where the animation should stop (animation frame)
  89659. */
  89660. to: number;
  89661. /**
  89662. * Define if the animation should loop or stop after the first play.
  89663. */
  89664. loop?: boolean;
  89665. private _target;
  89666. /**
  89667. * Instantiate the action
  89668. * @param triggerOptions defines the trigger options
  89669. * @param target defines the target animation or animation name
  89670. * @param from defines from where the animation should start (animation frame)
  89671. * @param end defines where the animation should stop (animation frame)
  89672. * @param loop defines if the animation should loop or stop after the first play
  89673. * @param condition defines the trigger related conditions
  89674. */
  89675. constructor(triggerOptions: any, target: any, from: number, to: number, loop?: boolean, condition?: Condition);
  89676. /** @hidden */
  89677. _prepare(): void;
  89678. /**
  89679. * Execute the action and play the animation.
  89680. */
  89681. execute(): void;
  89682. /**
  89683. * Serializes the actions and its related information.
  89684. * @param parent defines the object to serialize in
  89685. * @returns the serialized object
  89686. */
  89687. serialize(parent: any): any;
  89688. }
  89689. /**
  89690. * This defines an action responsible to stop an animation once triggered.
  89691. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89692. */
  89693. export class StopAnimationAction extends Action {
  89694. private _target;
  89695. /**
  89696. * Instantiate the action
  89697. * @param triggerOptions defines the trigger options
  89698. * @param target defines the target animation or animation name
  89699. * @param condition defines the trigger related conditions
  89700. */
  89701. constructor(triggerOptions: any, target: any, condition?: Condition);
  89702. /** @hidden */
  89703. _prepare(): void;
  89704. /**
  89705. * Execute the action and stop the animation.
  89706. */
  89707. execute(): void;
  89708. /**
  89709. * Serializes the actions and its related information.
  89710. * @param parent defines the object to serialize in
  89711. * @returns the serialized object
  89712. */
  89713. serialize(parent: any): any;
  89714. }
  89715. /**
  89716. * This defines an action responsible that does nothing once triggered.
  89717. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89718. */
  89719. export class DoNothingAction extends Action {
  89720. /**
  89721. * Instantiate the action
  89722. * @param triggerOptions defines the trigger options
  89723. * @param condition defines the trigger related conditions
  89724. */
  89725. constructor(triggerOptions?: any, condition?: Condition);
  89726. /**
  89727. * Execute the action and do nothing.
  89728. */
  89729. execute(): void;
  89730. /**
  89731. * Serializes the actions and its related information.
  89732. * @param parent defines the object to serialize in
  89733. * @returns the serialized object
  89734. */
  89735. serialize(parent: any): any;
  89736. }
  89737. /**
  89738. * This defines an action responsible to trigger several actions once triggered.
  89739. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89740. */
  89741. export class CombineAction extends Action {
  89742. /**
  89743. * The list of aggregated animations to run.
  89744. */
  89745. children: Action[];
  89746. /**
  89747. * Instantiate the action
  89748. * @param triggerOptions defines the trigger options
  89749. * @param children defines the list of aggregated animations to run
  89750. * @param condition defines the trigger related conditions
  89751. */
  89752. constructor(triggerOptions: any, children: Action[], condition?: Condition);
  89753. /** @hidden */
  89754. _prepare(): void;
  89755. /**
  89756. * Execute the action and executes all the aggregated actions.
  89757. */
  89758. execute(evt: ActionEvent): void;
  89759. /**
  89760. * Serializes the actions and its related information.
  89761. * @param parent defines the object to serialize in
  89762. * @returns the serialized object
  89763. */
  89764. serialize(parent: any): any;
  89765. }
  89766. /**
  89767. * This defines an action responsible to run code (external event) once triggered.
  89768. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89769. */
  89770. export class ExecuteCodeAction extends Action {
  89771. /**
  89772. * The callback function to run.
  89773. */
  89774. func: (evt: ActionEvent) => void;
  89775. /**
  89776. * Instantiate the action
  89777. * @param triggerOptions defines the trigger options
  89778. * @param func defines the callback function to run
  89779. * @param condition defines the trigger related conditions
  89780. */
  89781. constructor(triggerOptions: any, func: (evt: ActionEvent) => void, condition?: Condition);
  89782. /**
  89783. * Execute the action and run the attached code.
  89784. */
  89785. execute(evt: ActionEvent): void;
  89786. }
  89787. /**
  89788. * This defines an action responsible to set the parent property of the target once triggered.
  89789. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89790. */
  89791. export class SetParentAction extends Action {
  89792. private _parent;
  89793. private _target;
  89794. /**
  89795. * Instantiate the action
  89796. * @param triggerOptions defines the trigger options
  89797. * @param target defines the target containing the parent property
  89798. * @param parent defines from where the animation should start (animation frame)
  89799. * @param condition defines the trigger related conditions
  89800. */
  89801. constructor(triggerOptions: any, target: any, parent: any, condition?: Condition);
  89802. /** @hidden */
  89803. _prepare(): void;
  89804. /**
  89805. * Execute the action and set the parent property.
  89806. */
  89807. execute(): void;
  89808. /**
  89809. * Serializes the actions and its related information.
  89810. * @param parent defines the object to serialize in
  89811. * @returns the serialized object
  89812. */
  89813. serialize(parent: any): any;
  89814. }
  89815. }
  89816. declare module BABYLON {
  89817. /**
  89818. * Action Manager manages all events to be triggered on a given mesh or the global scene.
  89819. * A single scene can have many Action Managers to handle predefined actions on specific meshes.
  89820. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89821. */
  89822. export class ActionManager extends AbstractActionManager {
  89823. /**
  89824. * Nothing
  89825. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89826. */
  89827. static readonly NothingTrigger: number;
  89828. /**
  89829. * On pick
  89830. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89831. */
  89832. static readonly OnPickTrigger: number;
  89833. /**
  89834. * On left pick
  89835. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89836. */
  89837. static readonly OnLeftPickTrigger: number;
  89838. /**
  89839. * On right pick
  89840. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89841. */
  89842. static readonly OnRightPickTrigger: number;
  89843. /**
  89844. * On center pick
  89845. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89846. */
  89847. static readonly OnCenterPickTrigger: number;
  89848. /**
  89849. * On pick down
  89850. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89851. */
  89852. static readonly OnPickDownTrigger: number;
  89853. /**
  89854. * On double pick
  89855. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89856. */
  89857. static readonly OnDoublePickTrigger: number;
  89858. /**
  89859. * On pick up
  89860. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89861. */
  89862. static readonly OnPickUpTrigger: number;
  89863. /**
  89864. * On pick out.
  89865. * This trigger will only be raised if you also declared a OnPickDown
  89866. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89867. */
  89868. static readonly OnPickOutTrigger: number;
  89869. /**
  89870. * On long press
  89871. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89872. */
  89873. static readonly OnLongPressTrigger: number;
  89874. /**
  89875. * On pointer over
  89876. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89877. */
  89878. static readonly OnPointerOverTrigger: number;
  89879. /**
  89880. * On pointer out
  89881. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89882. */
  89883. static readonly OnPointerOutTrigger: number;
  89884. /**
  89885. * On every frame
  89886. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89887. */
  89888. static readonly OnEveryFrameTrigger: number;
  89889. /**
  89890. * On intersection enter
  89891. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89892. */
  89893. static readonly OnIntersectionEnterTrigger: number;
  89894. /**
  89895. * On intersection exit
  89896. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89897. */
  89898. static readonly OnIntersectionExitTrigger: number;
  89899. /**
  89900. * On key down
  89901. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89902. */
  89903. static readonly OnKeyDownTrigger: number;
  89904. /**
  89905. * On key up
  89906. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89907. */
  89908. static readonly OnKeyUpTrigger: number;
  89909. private _scene;
  89910. /**
  89911. * Creates a new action manager
  89912. * @param scene defines the hosting scene
  89913. */
  89914. constructor(scene: Scene);
  89915. /**
  89916. * Releases all associated resources
  89917. */
  89918. dispose(): void;
  89919. /**
  89920. * Gets hosting scene
  89921. * @returns the hosting scene
  89922. */
  89923. getScene(): Scene;
  89924. /**
  89925. * Does this action manager handles actions of any of the given triggers
  89926. * @param triggers defines the triggers to be tested
  89927. * @return a boolean indicating whether one (or more) of the triggers is handled
  89928. */
  89929. hasSpecificTriggers(triggers: number[]): boolean;
  89930. /**
  89931. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  89932. * speed.
  89933. * @param triggerA defines the trigger to be tested
  89934. * @param triggerB defines the trigger to be tested
  89935. * @return a boolean indicating whether one (or more) of the triggers is handled
  89936. */
  89937. hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  89938. /**
  89939. * Does this action manager handles actions of a given trigger
  89940. * @param trigger defines the trigger to be tested
  89941. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  89942. * @return whether the trigger is handled
  89943. */
  89944. hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  89945. /**
  89946. * Does this action manager has pointer triggers
  89947. */
  89948. get hasPointerTriggers(): boolean;
  89949. /**
  89950. * Does this action manager has pick triggers
  89951. */
  89952. get hasPickTriggers(): boolean;
  89953. /**
  89954. * Registers an action to this action manager
  89955. * @param action defines the action to be registered
  89956. * @return the action amended (prepared) after registration
  89957. */
  89958. registerAction(action: IAction): Nullable<IAction>;
  89959. /**
  89960. * Unregisters an action to this action manager
  89961. * @param action defines the action to be unregistered
  89962. * @return a boolean indicating whether the action has been unregistered
  89963. */
  89964. unregisterAction(action: IAction): Boolean;
  89965. /**
  89966. * Process a specific trigger
  89967. * @param trigger defines the trigger to process
  89968. * @param evt defines the event details to be processed
  89969. */
  89970. processTrigger(trigger: number, evt?: IActionEvent): void;
  89971. /** @hidden */
  89972. _getEffectiveTarget(target: any, propertyPath: string): any;
  89973. /** @hidden */
  89974. _getProperty(propertyPath: string): string;
  89975. /**
  89976. * Serialize this manager to a JSON object
  89977. * @param name defines the property name to store this manager
  89978. * @returns a JSON representation of this manager
  89979. */
  89980. serialize(name: string): any;
  89981. /**
  89982. * Creates a new ActionManager from a JSON data
  89983. * @param parsedActions defines the JSON data to read from
  89984. * @param object defines the hosting mesh
  89985. * @param scene defines the hosting scene
  89986. */
  89987. static Parse(parsedActions: any, object: Nullable<AbstractMesh>, scene: Scene): void;
  89988. /**
  89989. * Get a trigger name by index
  89990. * @param trigger defines the trigger index
  89991. * @returns a trigger name
  89992. */
  89993. static GetTriggerName(trigger: number): string;
  89994. }
  89995. }
  89996. declare module BABYLON {
  89997. /**
  89998. * Class used to represent a sprite
  89999. * @see https://doc.babylonjs.com/babylon101/sprites
  90000. */
  90001. export class Sprite implements IAnimatable {
  90002. /** defines the name */
  90003. name: string;
  90004. /** Gets or sets the current world position */
  90005. position: Vector3;
  90006. /** Gets or sets the main color */
  90007. color: Color4;
  90008. /** Gets or sets the width */
  90009. width: number;
  90010. /** Gets or sets the height */
  90011. height: number;
  90012. /** Gets or sets rotation angle */
  90013. angle: number;
  90014. /** Gets or sets the cell index in the sprite sheet */
  90015. cellIndex: number;
  90016. /** Gets or sets the cell reference in the sprite sheet, uses sprite's filename when added to sprite sheet */
  90017. cellRef: string;
  90018. /** Gets or sets a boolean indicating if UV coordinates should be inverted in U axis */
  90019. invertU: boolean;
  90020. /** Gets or sets a boolean indicating if UV coordinates should be inverted in B axis */
  90021. invertV: boolean;
  90022. /** Gets or sets a boolean indicating that this sprite should be disposed after animation ends */
  90023. disposeWhenFinishedAnimating: boolean;
  90024. /** Gets the list of attached animations */
  90025. animations: Nullable<Array<Animation>>;
  90026. /** Gets or sets a boolean indicating if the sprite can be picked */
  90027. isPickable: boolean;
  90028. /** Gets or sets a boolean indicating that sprite texture alpha will be used for precise picking (false by default) */
  90029. useAlphaForPicking: boolean;
  90030. /** @hidden */
  90031. _xOffset: number;
  90032. /** @hidden */
  90033. _yOffset: number;
  90034. /** @hidden */
  90035. _xSize: number;
  90036. /** @hidden */
  90037. _ySize: number;
  90038. /**
  90039. * Gets or sets the associated action manager
  90040. */
  90041. actionManager: Nullable<ActionManager>;
  90042. /**
  90043. * An event triggered when the control has been disposed
  90044. */
  90045. onDisposeObservable: Observable<Sprite>;
  90046. private _animationStarted;
  90047. private _loopAnimation;
  90048. private _fromIndex;
  90049. private _toIndex;
  90050. private _delay;
  90051. private _direction;
  90052. private _manager;
  90053. private _time;
  90054. private _onAnimationEnd;
  90055. /**
  90056. * Gets or sets a boolean indicating if the sprite is visible (renderable). Default is true
  90057. */
  90058. isVisible: boolean;
  90059. /**
  90060. * Gets or sets the sprite size
  90061. */
  90062. get size(): number;
  90063. set size(value: number);
  90064. /**
  90065. * Returns a boolean indicating if the animation is started
  90066. */
  90067. get animationStarted(): boolean;
  90068. /**
  90069. * Gets or sets the unique id of the sprite
  90070. */
  90071. uniqueId: number;
  90072. /**
  90073. * Gets the manager of this sprite
  90074. */
  90075. get manager(): ISpriteManager;
  90076. /**
  90077. * Creates a new Sprite
  90078. * @param name defines the name
  90079. * @param manager defines the manager
  90080. */
  90081. constructor(
  90082. /** defines the name */
  90083. name: string, manager: ISpriteManager);
  90084. /**
  90085. * Returns the string "Sprite"
  90086. * @returns "Sprite"
  90087. */
  90088. getClassName(): string;
  90089. /** Gets or sets the initial key for the animation (setting it will restart the animation) */
  90090. get fromIndex(): number;
  90091. set fromIndex(value: number);
  90092. /** Gets or sets the end key for the animation (setting it will restart the animation) */
  90093. get toIndex(): number;
  90094. set toIndex(value: number);
  90095. /** Gets or sets a boolean indicating if the animation is looping (setting it will restart the animation) */
  90096. get loopAnimation(): boolean;
  90097. set loopAnimation(value: boolean);
  90098. /** Gets or sets the delay between cell changes (setting it will restart the animation) */
  90099. get delay(): number;
  90100. set delay(value: number);
  90101. /**
  90102. * Starts an animation
  90103. * @param from defines the initial key
  90104. * @param to defines the end key
  90105. * @param loop defines if the animation must loop
  90106. * @param delay defines the start delay (in ms)
  90107. * @param onAnimationEnd defines a callback to call when animation ends
  90108. */
  90109. playAnimation(from: number, to: number, loop: boolean, delay: number, onAnimationEnd?: Nullable<() => void>): void;
  90110. /** Stops current animation (if any) */
  90111. stopAnimation(): void;
  90112. /** @hidden */
  90113. _animate(deltaTime: number): void;
  90114. /** Release associated resources */
  90115. dispose(): void;
  90116. /**
  90117. * Serializes the sprite to a JSON object
  90118. * @returns the JSON object
  90119. */
  90120. serialize(): any;
  90121. /**
  90122. * Parses a JSON object to create a new sprite
  90123. * @param parsedSprite The JSON object to parse
  90124. * @param manager defines the hosting manager
  90125. * @returns the new sprite
  90126. */
  90127. static Parse(parsedSprite: any, manager: SpriteManager): Sprite;
  90128. }
  90129. }
  90130. declare module BABYLON {
  90131. /**
  90132. * Information about the result of picking within a scene
  90133. * @see https://doc.babylonjs.com/babylon101/picking_collisions
  90134. */
  90135. export class PickingInfo {
  90136. /** @hidden */
  90137. _pickingUnavailable: boolean;
  90138. /**
  90139. * If the pick collided with an object
  90140. */
  90141. hit: boolean;
  90142. /**
  90143. * Distance away where the pick collided
  90144. */
  90145. distance: number;
  90146. /**
  90147. * The location of pick collision
  90148. */
  90149. pickedPoint: Nullable<Vector3>;
  90150. /**
  90151. * The mesh corresponding the the pick collision
  90152. */
  90153. pickedMesh: Nullable<AbstractMesh>;
  90154. /** (See getTextureCoordinates) The barycentric U coordinate that is used when calculating the texture coordinates of the collision.*/
  90155. bu: number;
  90156. /** (See getTextureCoordinates) The barycentric V coordinate that is used when calculating the texture coordinates of the collision.*/
  90157. bv: number;
  90158. /** The index of the face on the mesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  90159. faceId: number;
  90160. /** The index of the face on the subMesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  90161. subMeshFaceId: number;
  90162. /** Id of the the submesh that was picked */
  90163. subMeshId: number;
  90164. /** If a sprite was picked, this will be the sprite the pick collided with */
  90165. pickedSprite: Nullable<Sprite>;
  90166. /** If we are pikcing a mesh with thin instance, this will give you the picked thin instance */
  90167. thinInstanceIndex: number;
  90168. /**
  90169. * If a mesh was used to do the picking (eg. 6dof controller) this will be populated.
  90170. */
  90171. originMesh: Nullable<AbstractMesh>;
  90172. /**
  90173. * The ray that was used to perform the picking.
  90174. */
  90175. ray: Nullable<Ray>;
  90176. /**
  90177. * Gets the normal correspodning to the face the pick collided with
  90178. * @param useWorldCoordinates If the resulting normal should be relative to the world (default: false)
  90179. * @param useVerticesNormals If the vertices normals should be used to calculate the normal instead of the normal map
  90180. * @returns The normal correspodning to the face the pick collided with
  90181. */
  90182. getNormal(useWorldCoordinates?: boolean, useVerticesNormals?: boolean): Nullable<Vector3>;
  90183. /**
  90184. * Gets the texture coordinates of where the pick occured
  90185. * @returns the vector containing the coordnates of the texture
  90186. */
  90187. getTextureCoordinates(): Nullable<Vector2>;
  90188. }
  90189. }
  90190. declare module BABYLON {
  90191. /**
  90192. * Class representing a ray with position and direction
  90193. */
  90194. export class Ray {
  90195. /** origin point */
  90196. origin: Vector3;
  90197. /** direction */
  90198. direction: Vector3;
  90199. /** length of the ray */
  90200. length: number;
  90201. private static readonly _TmpVector3;
  90202. private _tmpRay;
  90203. /**
  90204. * Creates a new ray
  90205. * @param origin origin point
  90206. * @param direction direction
  90207. * @param length length of the ray
  90208. */
  90209. constructor(
  90210. /** origin point */
  90211. origin: Vector3,
  90212. /** direction */
  90213. direction: Vector3,
  90214. /** length of the ray */
  90215. length?: number);
  90216. /**
  90217. * Checks if the ray intersects a box
  90218. * This does not account for the ray lenght by design to improve perfs.
  90219. * @param minimum bound of the box
  90220. * @param maximum bound of the box
  90221. * @param intersectionTreshold extra extend to be added to the box in all direction
  90222. * @returns if the box was hit
  90223. */
  90224. intersectsBoxMinMax(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, intersectionTreshold?: number): boolean;
  90225. /**
  90226. * Checks if the ray intersects a box
  90227. * This does not account for the ray lenght by design to improve perfs.
  90228. * @param box the bounding box to check
  90229. * @param intersectionTreshold extra extend to be added to the BoundingBox in all direction
  90230. * @returns if the box was hit
  90231. */
  90232. intersectsBox(box: DeepImmutable<BoundingBox>, intersectionTreshold?: number): boolean;
  90233. /**
  90234. * If the ray hits a sphere
  90235. * @param sphere the bounding sphere to check
  90236. * @param intersectionTreshold extra extend to be added to the BoundingSphere in all direction
  90237. * @returns true if it hits the sphere
  90238. */
  90239. intersectsSphere(sphere: DeepImmutable<BoundingSphere>, intersectionTreshold?: number): boolean;
  90240. /**
  90241. * If the ray hits a triange
  90242. * @param vertex0 triangle vertex
  90243. * @param vertex1 triangle vertex
  90244. * @param vertex2 triangle vertex
  90245. * @returns intersection information if hit
  90246. */
  90247. intersectsTriangle(vertex0: DeepImmutable<Vector3>, vertex1: DeepImmutable<Vector3>, vertex2: DeepImmutable<Vector3>): Nullable<IntersectionInfo>;
  90248. /**
  90249. * Checks if ray intersects a plane
  90250. * @param plane the plane to check
  90251. * @returns the distance away it was hit
  90252. */
  90253. intersectsPlane(plane: DeepImmutable<Plane>): Nullable<number>;
  90254. /**
  90255. * Calculate the intercept of a ray on a given axis
  90256. * @param axis to check 'x' | 'y' | 'z'
  90257. * @param offset from axis interception (i.e. an offset of 1y is intercepted above ground)
  90258. * @returns a vector containing the coordinates where 'axis' is equal to zero (else offset), or null if there is no intercept.
  90259. */
  90260. intersectsAxis(axis: string, offset?: number): Nullable<Vector3>;
  90261. /**
  90262. * Checks if ray intersects a mesh
  90263. * @param mesh the mesh to check
  90264. * @param fastCheck defines if the first intersection will be used (and not the closest)
  90265. * @returns picking info of the intersecton
  90266. */
  90267. intersectsMesh(mesh: DeepImmutable<AbstractMesh>, fastCheck?: boolean): PickingInfo;
  90268. /**
  90269. * Checks if ray intersects a mesh
  90270. * @param meshes the meshes to check
  90271. * @param fastCheck defines if the first intersection will be used (and not the closest)
  90272. * @param results array to store result in
  90273. * @returns Array of picking infos
  90274. */
  90275. intersectsMeshes(meshes: Array<DeepImmutable<AbstractMesh>>, fastCheck?: boolean, results?: Array<PickingInfo>): Array<PickingInfo>;
  90276. private _comparePickingInfo;
  90277. private static smallnum;
  90278. private static rayl;
  90279. /**
  90280. * Intersection test between the ray and a given segment whithin a given tolerance (threshold)
  90281. * @param sega the first point of the segment to test the intersection against
  90282. * @param segb the second point of the segment to test the intersection against
  90283. * @param threshold the tolerance margin, if the ray doesn't intersect the segment but is close to the given threshold, the intersection is successful
  90284. * @return the distance from the ray origin to the intersection point if there's intersection, or -1 if there's no intersection
  90285. */
  90286. intersectionSegment(sega: DeepImmutable<Vector3>, segb: DeepImmutable<Vector3>, threshold: number): number;
  90287. /**
  90288. * Update the ray from viewport position
  90289. * @param x position
  90290. * @param y y position
  90291. * @param viewportWidth viewport width
  90292. * @param viewportHeight viewport height
  90293. * @param world world matrix
  90294. * @param view view matrix
  90295. * @param projection projection matrix
  90296. * @returns this ray updated
  90297. */
  90298. update(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  90299. /**
  90300. * Creates a ray with origin and direction of 0,0,0
  90301. * @returns the new ray
  90302. */
  90303. static Zero(): Ray;
  90304. /**
  90305. * Creates a new ray from screen space and viewport
  90306. * @param x position
  90307. * @param y y position
  90308. * @param viewportWidth viewport width
  90309. * @param viewportHeight viewport height
  90310. * @param world world matrix
  90311. * @param view view matrix
  90312. * @param projection projection matrix
  90313. * @returns new ray
  90314. */
  90315. static CreateNew(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  90316. /**
  90317. * 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
  90318. * transformed to the given world matrix.
  90319. * @param origin The origin point
  90320. * @param end The end point
  90321. * @param world a matrix to transform the ray to. Default is the identity matrix.
  90322. * @returns the new ray
  90323. */
  90324. static CreateNewFromTo(origin: Vector3, end: Vector3, world?: DeepImmutable<Matrix>): Ray;
  90325. /**
  90326. * Transforms a ray by a matrix
  90327. * @param ray ray to transform
  90328. * @param matrix matrix to apply
  90329. * @returns the resulting new ray
  90330. */
  90331. static Transform(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>): Ray;
  90332. /**
  90333. * Transforms a ray by a matrix
  90334. * @param ray ray to transform
  90335. * @param matrix matrix to apply
  90336. * @param result ray to store result in
  90337. */
  90338. static TransformToRef(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>, result: Ray): void;
  90339. /**
  90340. * Unproject a ray from screen space to object space
  90341. * @param sourceX defines the screen space x coordinate to use
  90342. * @param sourceY defines the screen space y coordinate to use
  90343. * @param viewportWidth defines the current width of the viewport
  90344. * @param viewportHeight defines the current height of the viewport
  90345. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  90346. * @param view defines the view matrix to use
  90347. * @param projection defines the projection matrix to use
  90348. */
  90349. unprojectRayToRef(sourceX: float, sourceY: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): void;
  90350. }
  90351. /**
  90352. * Type used to define predicate used to select faces when a mesh intersection is detected
  90353. */
  90354. export type TrianglePickingPredicate = (p0: Vector3, p1: Vector3, p2: Vector3, ray: Ray) => boolean;
  90355. interface Scene {
  90356. /** @hidden */
  90357. _tempPickingRay: Nullable<Ray>;
  90358. /** @hidden */
  90359. _cachedRayForTransform: Ray;
  90360. /** @hidden */
  90361. _pickWithRayInverseMatrix: Matrix;
  90362. /** @hidden */
  90363. _internalPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, onlyBoundingInfo?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  90364. /** @hidden */
  90365. _internalMultiPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  90366. /** @hidden */
  90367. _internalPickForMesh(pickingInfo: Nullable<PickingInfo>, rayFunction: (world: Matrix) => Ray, mesh: AbstractMesh, world: Matrix, fastCheck?: boolean, onlyBoundingInfo?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  90368. }
  90369. }
  90370. declare module BABYLON {
  90371. /**
  90372. * Groups all the scene component constants in one place to ease maintenance.
  90373. * @hidden
  90374. */
  90375. export class SceneComponentConstants {
  90376. static readonly NAME_EFFECTLAYER: string;
  90377. static readonly NAME_LAYER: string;
  90378. static readonly NAME_LENSFLARESYSTEM: string;
  90379. static readonly NAME_BOUNDINGBOXRENDERER: string;
  90380. static readonly NAME_PARTICLESYSTEM: string;
  90381. static readonly NAME_GAMEPAD: string;
  90382. static readonly NAME_SIMPLIFICATIONQUEUE: string;
  90383. static readonly NAME_GEOMETRYBUFFERRENDERER: string;
  90384. static readonly NAME_PREPASSRENDERER: string;
  90385. static readonly NAME_DEPTHRENDERER: string;
  90386. static readonly NAME_POSTPROCESSRENDERPIPELINEMANAGER: string;
  90387. static readonly NAME_SPRITE: string;
  90388. static readonly NAME_OUTLINERENDERER: string;
  90389. static readonly NAME_PROCEDURALTEXTURE: string;
  90390. static readonly NAME_SHADOWGENERATOR: string;
  90391. static readonly NAME_OCTREE: string;
  90392. static readonly NAME_PHYSICSENGINE: string;
  90393. static readonly NAME_AUDIO: string;
  90394. static readonly STEP_ISREADYFORMESH_EFFECTLAYER: number;
  90395. static readonly STEP_BEFOREEVALUATEACTIVEMESH_BOUNDINGBOXRENDERER: number;
  90396. static readonly STEP_EVALUATESUBMESH_BOUNDINGBOXRENDERER: number;
  90397. static readonly STEP_ACTIVEMESH_BOUNDINGBOXRENDERER: number;
  90398. static readonly STEP_CAMERADRAWRENDERTARGET_EFFECTLAYER: number;
  90399. static readonly STEP_BEFORECAMERADRAW_EFFECTLAYER: number;
  90400. static readonly STEP_BEFORECAMERADRAW_LAYER: number;
  90401. static readonly STEP_BEFORECAMERADRAW_PREPASS: number;
  90402. static readonly STEP_BEFORERENDERTARGETDRAW_LAYER: number;
  90403. static readonly STEP_BEFORERENDERINGMESH_OUTLINE: number;
  90404. static readonly STEP_AFTERRENDERINGMESH_OUTLINE: number;
  90405. static readonly STEP_AFTERRENDERINGGROUPDRAW_EFFECTLAYER_DRAW: number;
  90406. static readonly STEP_AFTERRENDERINGGROUPDRAW_BOUNDINGBOXRENDERER: number;
  90407. static readonly STEP_BEFORECAMERAUPDATE_SIMPLIFICATIONQUEUE: number;
  90408. static readonly STEP_BEFORECAMERAUPDATE_GAMEPAD: number;
  90409. static readonly STEP_BEFORECLEAR_PROCEDURALTEXTURE: number;
  90410. static readonly STEP_AFTERRENDERTARGETDRAW_LAYER: number;
  90411. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER: number;
  90412. static readonly STEP_AFTERCAMERADRAW_LENSFLARESYSTEM: number;
  90413. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER_DRAW: number;
  90414. static readonly STEP_AFTERCAMERADRAW_LAYER: number;
  90415. static readonly STEP_AFTERCAMERADRAW_PREPASS: number;
  90416. static readonly STEP_AFTERRENDER_AUDIO: number;
  90417. static readonly STEP_GATHERRENDERTARGETS_DEPTHRENDERER: number;
  90418. static readonly STEP_GATHERRENDERTARGETS_GEOMETRYBUFFERRENDERER: number;
  90419. static readonly STEP_GATHERRENDERTARGETS_SHADOWGENERATOR: number;
  90420. static readonly STEP_GATHERRENDERTARGETS_POSTPROCESSRENDERPIPELINEMANAGER: number;
  90421. static readonly STEP_GATHERACTIVECAMERARENDERTARGETS_DEPTHRENDERER: number;
  90422. static readonly STEP_BEFORECLEARSTAGE_PREPASS: number;
  90423. static readonly STEP_POINTERMOVE_SPRITE: number;
  90424. static readonly STEP_POINTERDOWN_SPRITE: number;
  90425. static readonly STEP_POINTERUP_SPRITE: number;
  90426. }
  90427. /**
  90428. * This represents a scene component.
  90429. *
  90430. * This is used to decouple the dependency the scene is having on the different workloads like
  90431. * layers, post processes...
  90432. */
  90433. export interface ISceneComponent {
  90434. /**
  90435. * The name of the component. Each component must have a unique name.
  90436. */
  90437. name: string;
  90438. /**
  90439. * The scene the component belongs to.
  90440. */
  90441. scene: Scene;
  90442. /**
  90443. * Register the component to one instance of a scene.
  90444. */
  90445. register(): void;
  90446. /**
  90447. * Rebuilds the elements related to this component in case of
  90448. * context lost for instance.
  90449. */
  90450. rebuild(): void;
  90451. /**
  90452. * Disposes the component and the associated ressources.
  90453. */
  90454. dispose(): void;
  90455. }
  90456. /**
  90457. * This represents a SERIALIZABLE scene component.
  90458. *
  90459. * This extends Scene Component to add Serialization methods on top.
  90460. */
  90461. export interface ISceneSerializableComponent extends ISceneComponent {
  90462. /**
  90463. * Adds all the elements from the container to the scene
  90464. * @param container the container holding the elements
  90465. */
  90466. addFromContainer(container: AbstractScene): void;
  90467. /**
  90468. * Removes all the elements in the container from the scene
  90469. * @param container contains the elements to remove
  90470. * @param dispose if the removed element should be disposed (default: false)
  90471. */
  90472. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  90473. /**
  90474. * Serializes the component data to the specified json object
  90475. * @param serializationObject The object to serialize to
  90476. */
  90477. serialize(serializationObject: any): void;
  90478. }
  90479. /**
  90480. * Strong typing of a Mesh related stage step action
  90481. */
  90482. export type MeshStageAction = (mesh: AbstractMesh, hardwareInstancedRendering: boolean) => boolean;
  90483. /**
  90484. * Strong typing of a Evaluate Sub Mesh related stage step action
  90485. */
  90486. export type EvaluateSubMeshStageAction = (mesh: AbstractMesh, subMesh: SubMesh) => void;
  90487. /**
  90488. * Strong typing of a Active Mesh related stage step action
  90489. */
  90490. export type ActiveMeshStageAction = (sourceMesh: AbstractMesh, mesh: AbstractMesh) => void;
  90491. /**
  90492. * Strong typing of a Camera related stage step action
  90493. */
  90494. export type CameraStageAction = (camera: Camera) => void;
  90495. /**
  90496. * Strong typing of a Camera Frame buffer related stage step action
  90497. */
  90498. export type CameraStageFrameBufferAction = (camera: Camera) => boolean;
  90499. /**
  90500. * Strong typing of a Render Target related stage step action
  90501. */
  90502. export type RenderTargetStageAction = (renderTarget: RenderTargetTexture) => void;
  90503. /**
  90504. * Strong typing of a RenderingGroup related stage step action
  90505. */
  90506. export type RenderingGroupStageAction = (renderingGroupId: number) => void;
  90507. /**
  90508. * Strong typing of a Mesh Render related stage step action
  90509. */
  90510. export type RenderingMeshStageAction = (mesh: Mesh, subMesh: SubMesh, batch: _InstancesBatch) => void;
  90511. /**
  90512. * Strong typing of a simple stage step action
  90513. */
  90514. export type SimpleStageAction = () => void;
  90515. /**
  90516. * Strong typing of a render target action.
  90517. */
  90518. export type RenderTargetsStageAction = (renderTargets: SmartArrayNoDuplicate<RenderTargetTexture>) => void;
  90519. /**
  90520. * Strong typing of a pointer move action.
  90521. */
  90522. export type PointerMoveStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, isMeshPicked: boolean, element: HTMLElement) => Nullable<PickingInfo>;
  90523. /**
  90524. * Strong typing of a pointer up/down action.
  90525. */
  90526. export type PointerUpDownStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, evt: PointerEvent) => Nullable<PickingInfo>;
  90527. /**
  90528. * Representation of a stage in the scene (Basically a list of ordered steps)
  90529. * @hidden
  90530. */
  90531. export class Stage<T extends Function> extends Array<{
  90532. index: number;
  90533. component: ISceneComponent;
  90534. action: T;
  90535. }> {
  90536. /**
  90537. * Hide ctor from the rest of the world.
  90538. * @param items The items to add.
  90539. */
  90540. private constructor();
  90541. /**
  90542. * Creates a new Stage.
  90543. * @returns A new instance of a Stage
  90544. */
  90545. static Create<T extends Function>(): Stage<T>;
  90546. /**
  90547. * Registers a step in an ordered way in the targeted stage.
  90548. * @param index Defines the position to register the step in
  90549. * @param component Defines the component attached to the step
  90550. * @param action Defines the action to launch during the step
  90551. */
  90552. registerStep(index: number, component: ISceneComponent, action: T): void;
  90553. /**
  90554. * Clears all the steps from the stage.
  90555. */
  90556. clear(): void;
  90557. }
  90558. }
  90559. declare module BABYLON {
  90560. interface Scene {
  90561. /** @hidden */
  90562. _pointerOverSprite: Nullable<Sprite>;
  90563. /** @hidden */
  90564. _pickedDownSprite: Nullable<Sprite>;
  90565. /** @hidden */
  90566. _tempSpritePickingRay: Nullable<Ray>;
  90567. /**
  90568. * All of the sprite managers added to this scene
  90569. * @see https://doc.babylonjs.com/babylon101/sprites
  90570. */
  90571. spriteManagers: Array<ISpriteManager>;
  90572. /**
  90573. * An event triggered when sprites rendering is about to start
  90574. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  90575. */
  90576. onBeforeSpritesRenderingObservable: Observable<Scene>;
  90577. /**
  90578. * An event triggered when sprites rendering is done
  90579. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  90580. */
  90581. onAfterSpritesRenderingObservable: Observable<Scene>;
  90582. /** @hidden */
  90583. _internalPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  90584. /** Launch a ray to try to pick a sprite in the scene
  90585. * @param x position on screen
  90586. * @param y position on screen
  90587. * @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
  90588. * @param fastCheck defines if the first intersection will be used (and not the closest)
  90589. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  90590. * @returns a PickingInfo
  90591. */
  90592. pickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  90593. /** Use the given ray to pick a sprite in the scene
  90594. * @param ray The ray (in world space) to use to pick meshes
  90595. * @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
  90596. * @param fastCheck defines if the first intersection will be used (and not the closest)
  90597. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  90598. * @returns a PickingInfo
  90599. */
  90600. pickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  90601. /** @hidden */
  90602. _internalMultiPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  90603. /** Launch a ray to try to pick sprites in the scene
  90604. * @param x position on screen
  90605. * @param y position on screen
  90606. * @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
  90607. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  90608. * @returns a PickingInfo array
  90609. */
  90610. multiPickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  90611. /** Use the given ray to pick sprites in the scene
  90612. * @param ray The ray (in world space) to use to pick meshes
  90613. * @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
  90614. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  90615. * @returns a PickingInfo array
  90616. */
  90617. multiPickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  90618. /**
  90619. * Force the sprite under the pointer
  90620. * @param sprite defines the sprite to use
  90621. */
  90622. setPointerOverSprite(sprite: Nullable<Sprite>): void;
  90623. /**
  90624. * Gets the sprite under the pointer
  90625. * @returns a Sprite or null if no sprite is under the pointer
  90626. */
  90627. getPointerOverSprite(): Nullable<Sprite>;
  90628. }
  90629. /**
  90630. * Defines the sprite scene component responsible to manage sprites
  90631. * in a given scene.
  90632. */
  90633. export class SpriteSceneComponent implements ISceneComponent {
  90634. /**
  90635. * The component name helpfull to identify the component in the list of scene components.
  90636. */
  90637. readonly name: string;
  90638. /**
  90639. * The scene the component belongs to.
  90640. */
  90641. scene: Scene;
  90642. /** @hidden */
  90643. private _spritePredicate;
  90644. /**
  90645. * Creates a new instance of the component for the given scene
  90646. * @param scene Defines the scene to register the component in
  90647. */
  90648. constructor(scene: Scene);
  90649. /**
  90650. * Registers the component in a given scene
  90651. */
  90652. register(): void;
  90653. /**
  90654. * Rebuilds the elements related to this component in case of
  90655. * context lost for instance.
  90656. */
  90657. rebuild(): void;
  90658. /**
  90659. * Disposes the component and the associated ressources.
  90660. */
  90661. dispose(): void;
  90662. private _pickSpriteButKeepRay;
  90663. private _pointerMove;
  90664. private _pointerDown;
  90665. private _pointerUp;
  90666. }
  90667. }
  90668. declare module BABYLON {
  90669. /** @hidden */
  90670. export var fogFragmentDeclaration: {
  90671. name: string;
  90672. shader: string;
  90673. };
  90674. }
  90675. declare module BABYLON {
  90676. /** @hidden */
  90677. export var fogFragment: {
  90678. name: string;
  90679. shader: string;
  90680. };
  90681. }
  90682. declare module BABYLON {
  90683. /** @hidden */
  90684. export var spritesPixelShader: {
  90685. name: string;
  90686. shader: string;
  90687. };
  90688. }
  90689. declare module BABYLON {
  90690. /** @hidden */
  90691. export var fogVertexDeclaration: {
  90692. name: string;
  90693. shader: string;
  90694. };
  90695. }
  90696. declare module BABYLON {
  90697. /** @hidden */
  90698. export var spritesVertexShader: {
  90699. name: string;
  90700. shader: string;
  90701. };
  90702. }
  90703. declare module BABYLON {
  90704. /**
  90705. * Defines the minimum interface to fullfil in order to be a sprite manager.
  90706. */
  90707. export interface ISpriteManager extends IDisposable {
  90708. /**
  90709. * Gets manager's name
  90710. */
  90711. name: string;
  90712. /**
  90713. * Restricts the camera to viewing objects with the same layerMask.
  90714. * A camera with a layerMask of 1 will render spriteManager.layerMask & camera.layerMask!== 0
  90715. */
  90716. layerMask: number;
  90717. /**
  90718. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  90719. */
  90720. isPickable: boolean;
  90721. /**
  90722. * Gets the hosting scene
  90723. */
  90724. scene: Scene;
  90725. /**
  90726. * Specifies the rendering group id for this mesh (0 by default)
  90727. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  90728. */
  90729. renderingGroupId: number;
  90730. /**
  90731. * Defines the list of sprites managed by the manager.
  90732. */
  90733. sprites: Array<Sprite>;
  90734. /**
  90735. * Gets or sets the spritesheet texture
  90736. */
  90737. texture: Texture;
  90738. /** Defines the default width of a cell in the spritesheet */
  90739. cellWidth: number;
  90740. /** Defines the default height of a cell in the spritesheet */
  90741. cellHeight: number;
  90742. /**
  90743. * Tests the intersection of a sprite with a specific ray.
  90744. * @param ray The ray we are sending to test the collision
  90745. * @param camera The camera space we are sending rays in
  90746. * @param predicate A predicate allowing excluding sprites from the list of object to test
  90747. * @param fastCheck defines if the first intersection will be used (and not the closest)
  90748. * @returns picking info or null.
  90749. */
  90750. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  90751. /**
  90752. * Intersects the sprites with a ray
  90753. * @param ray defines the ray to intersect with
  90754. * @param camera defines the current active camera
  90755. * @param predicate defines a predicate used to select candidate sprites
  90756. * @returns null if no hit or a PickingInfo array
  90757. */
  90758. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  90759. /**
  90760. * Renders the list of sprites on screen.
  90761. */
  90762. render(): void;
  90763. }
  90764. /**
  90765. * Class used to manage multiple sprites on the same spritesheet
  90766. * @see https://doc.babylonjs.com/babylon101/sprites
  90767. */
  90768. export class SpriteManager implements ISpriteManager {
  90769. /** defines the manager's name */
  90770. name: string;
  90771. /** Define the Url to load snippets */
  90772. static SnippetUrl: string;
  90773. /** Snippet ID if the manager was created from the snippet server */
  90774. snippetId: string;
  90775. /** Gets the list of sprites */
  90776. sprites: Sprite[];
  90777. /** Gets or sets the rendering group id (0 by default) */
  90778. renderingGroupId: number;
  90779. /** Gets or sets camera layer mask */
  90780. layerMask: number;
  90781. /** Gets or sets a boolean indicating if the manager must consider scene fog when rendering */
  90782. fogEnabled: boolean;
  90783. /** Gets or sets a boolean indicating if the sprites are pickable */
  90784. isPickable: boolean;
  90785. /** Defines the default width of a cell in the spritesheet */
  90786. cellWidth: number;
  90787. /** Defines the default height of a cell in the spritesheet */
  90788. cellHeight: number;
  90789. /** Associative array from JSON sprite data file */
  90790. private _cellData;
  90791. /** Array of sprite names from JSON sprite data file */
  90792. private _spriteMap;
  90793. /** True when packed cell data from JSON file is ready*/
  90794. private _packedAndReady;
  90795. private _textureContent;
  90796. private _useInstancing;
  90797. /**
  90798. * An event triggered when the manager is disposed.
  90799. */
  90800. onDisposeObservable: Observable<SpriteManager>;
  90801. private _onDisposeObserver;
  90802. /**
  90803. * Callback called when the manager is disposed
  90804. */
  90805. set onDispose(callback: () => void);
  90806. private _capacity;
  90807. private _fromPacked;
  90808. private _spriteTexture;
  90809. private _epsilon;
  90810. private _scene;
  90811. private _vertexData;
  90812. private _buffer;
  90813. private _vertexBuffers;
  90814. private _spriteBuffer;
  90815. private _indexBuffer;
  90816. private _effectBase;
  90817. private _effectFog;
  90818. private _vertexBufferSize;
  90819. /**
  90820. * Gets or sets the unique id of the sprite
  90821. */
  90822. uniqueId: number;
  90823. /**
  90824. * Gets the array of sprites
  90825. */
  90826. get children(): Sprite[];
  90827. /**
  90828. * Gets the hosting scene
  90829. */
  90830. get scene(): Scene;
  90831. /**
  90832. * Gets the capacity of the manager
  90833. */
  90834. get capacity(): number;
  90835. /**
  90836. * Gets or sets the spritesheet texture
  90837. */
  90838. get texture(): Texture;
  90839. set texture(value: Texture);
  90840. private _blendMode;
  90841. /**
  90842. * Blend mode use to render the particle, it can be any of
  90843. * the static Constants.ALPHA_x properties provided in this class.
  90844. * Default value is Constants.ALPHA_COMBINE
  90845. */
  90846. get blendMode(): number;
  90847. set blendMode(blendMode: number);
  90848. /** Disables writing to the depth buffer when rendering the sprites.
  90849. * It can be handy to disable depth writing when using textures without alpha channel
  90850. * and setting some specific blend modes.
  90851. */
  90852. disableDepthWrite: boolean;
  90853. /**
  90854. * Creates a new sprite manager
  90855. * @param name defines the manager's name
  90856. * @param imgUrl defines the sprite sheet url
  90857. * @param capacity defines the maximum allowed number of sprites
  90858. * @param cellSize defines the size of a sprite cell
  90859. * @param scene defines the hosting scene
  90860. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  90861. * @param samplingMode defines the smapling mode to use with spritesheet
  90862. * @param fromPacked set to false; do not alter
  90863. * @param spriteJSON null otherwise a JSON object defining sprite sheet data; do not alter
  90864. */
  90865. constructor(
  90866. /** defines the manager's name */
  90867. name: string, imgUrl: string, capacity: number, cellSize: any, scene: Scene, epsilon?: number, samplingMode?: number, fromPacked?: boolean, spriteJSON?: any | null);
  90868. /**
  90869. * Returns the string "SpriteManager"
  90870. * @returns "SpriteManager"
  90871. */
  90872. getClassName(): string;
  90873. private _makePacked;
  90874. private _appendSpriteVertex;
  90875. private _checkTextureAlpha;
  90876. /**
  90877. * Intersects the sprites with a ray
  90878. * @param ray defines the ray to intersect with
  90879. * @param camera defines the current active camera
  90880. * @param predicate defines a predicate used to select candidate sprites
  90881. * @param fastCheck defines if a fast check only must be done (the first potential sprite is will be used and not the closer)
  90882. * @returns null if no hit or a PickingInfo
  90883. */
  90884. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  90885. /**
  90886. * Intersects the sprites with a ray
  90887. * @param ray defines the ray to intersect with
  90888. * @param camera defines the current active camera
  90889. * @param predicate defines a predicate used to select candidate sprites
  90890. * @returns null if no hit or a PickingInfo array
  90891. */
  90892. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  90893. /**
  90894. * Render all child sprites
  90895. */
  90896. render(): void;
  90897. /**
  90898. * Release associated resources
  90899. */
  90900. dispose(): void;
  90901. /**
  90902. * Serializes the sprite manager to a JSON object
  90903. * @param serializeTexture defines if the texture must be serialized as well
  90904. * @returns the JSON object
  90905. */
  90906. serialize(serializeTexture?: boolean): any;
  90907. /**
  90908. * Parses a JSON object to create a new sprite manager.
  90909. * @param parsedManager The JSON object to parse
  90910. * @param scene The scene to create the sprite managerin
  90911. * @param rootUrl The root url to use to load external dependencies like texture
  90912. * @returns the new sprite manager
  90913. */
  90914. static Parse(parsedManager: any, scene: Scene, rootUrl: string): SpriteManager;
  90915. /**
  90916. * Creates a sprite manager from a snippet saved in a remote file
  90917. * @param name defines the name of the sprite manager to create (can be null or empty to use the one from the json data)
  90918. * @param url defines the url to load from
  90919. * @param scene defines the hosting scene
  90920. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  90921. * @returns a promise that will resolve to the new sprite manager
  90922. */
  90923. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  90924. /**
  90925. * Creates a sprite manager from a snippet saved by the sprite editor
  90926. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  90927. * @param scene defines the hosting scene
  90928. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  90929. * @returns a promise that will resolve to the new sprite manager
  90930. */
  90931. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  90932. }
  90933. }
  90934. declare module BABYLON {
  90935. /** Interface used by value gradients (color, factor, ...) */
  90936. export interface IValueGradient {
  90937. /**
  90938. * Gets or sets the gradient value (between 0 and 1)
  90939. */
  90940. gradient: number;
  90941. }
  90942. /** Class used to store color4 gradient */
  90943. export class ColorGradient implements IValueGradient {
  90944. /**
  90945. * Gets or sets the gradient value (between 0 and 1)
  90946. */
  90947. gradient: number;
  90948. /**
  90949. * Gets or sets first associated color
  90950. */
  90951. color1: Color4;
  90952. /**
  90953. * Gets or sets second associated color
  90954. */
  90955. color2?: Color4 | undefined;
  90956. /**
  90957. * Creates a new color4 gradient
  90958. * @param gradient gets or sets the gradient value (between 0 and 1)
  90959. * @param color1 gets or sets first associated color
  90960. * @param color2 gets or sets first second color
  90961. */
  90962. constructor(
  90963. /**
  90964. * Gets or sets the gradient value (between 0 and 1)
  90965. */
  90966. gradient: number,
  90967. /**
  90968. * Gets or sets first associated color
  90969. */
  90970. color1: Color4,
  90971. /**
  90972. * Gets or sets second associated color
  90973. */
  90974. color2?: Color4 | undefined);
  90975. /**
  90976. * Will get a color picked randomly between color1 and color2.
  90977. * If color2 is undefined then color1 will be used
  90978. * @param result defines the target Color4 to store the result in
  90979. */
  90980. getColorToRef(result: Color4): void;
  90981. }
  90982. /** Class used to store color 3 gradient */
  90983. export class Color3Gradient implements IValueGradient {
  90984. /**
  90985. * Gets or sets the gradient value (between 0 and 1)
  90986. */
  90987. gradient: number;
  90988. /**
  90989. * Gets or sets the associated color
  90990. */
  90991. color: Color3;
  90992. /**
  90993. * Creates a new color3 gradient
  90994. * @param gradient gets or sets the gradient value (between 0 and 1)
  90995. * @param color gets or sets associated color
  90996. */
  90997. constructor(
  90998. /**
  90999. * Gets or sets the gradient value (between 0 and 1)
  91000. */
  91001. gradient: number,
  91002. /**
  91003. * Gets or sets the associated color
  91004. */
  91005. color: Color3);
  91006. }
  91007. /** Class used to store factor gradient */
  91008. export class FactorGradient implements IValueGradient {
  91009. /**
  91010. * Gets or sets the gradient value (between 0 and 1)
  91011. */
  91012. gradient: number;
  91013. /**
  91014. * Gets or sets first associated factor
  91015. */
  91016. factor1: number;
  91017. /**
  91018. * Gets or sets second associated factor
  91019. */
  91020. factor2?: number | undefined;
  91021. /**
  91022. * Creates a new factor gradient
  91023. * @param gradient gets or sets the gradient value (between 0 and 1)
  91024. * @param factor1 gets or sets first associated factor
  91025. * @param factor2 gets or sets second associated factor
  91026. */
  91027. constructor(
  91028. /**
  91029. * Gets or sets the gradient value (between 0 and 1)
  91030. */
  91031. gradient: number,
  91032. /**
  91033. * Gets or sets first associated factor
  91034. */
  91035. factor1: number,
  91036. /**
  91037. * Gets or sets second associated factor
  91038. */
  91039. factor2?: number | undefined);
  91040. /**
  91041. * Will get a number picked randomly between factor1 and factor2.
  91042. * If factor2 is undefined then factor1 will be used
  91043. * @returns the picked number
  91044. */
  91045. getFactor(): number;
  91046. }
  91047. /**
  91048. * Helper used to simplify some generic gradient tasks
  91049. */
  91050. export class GradientHelper {
  91051. /**
  91052. * Gets the current gradient from an array of IValueGradient
  91053. * @param ratio defines the current ratio to get
  91054. * @param gradients defines the array of IValueGradient
  91055. * @param updateFunc defines the callback function used to get the final value from the selected gradients
  91056. */
  91057. static GetCurrentGradient(ratio: number, gradients: IValueGradient[], updateFunc: (current: IValueGradient, next: IValueGradient, scale: number) => void): void;
  91058. }
  91059. }
  91060. declare module BABYLON {
  91061. interface ThinEngine {
  91062. /**
  91063. * Creates a raw texture
  91064. * @param data defines the data to store in the texture
  91065. * @param width defines the width of the texture
  91066. * @param height defines the height of the texture
  91067. * @param format defines the format of the data
  91068. * @param generateMipMaps defines if the engine should generate the mip levels
  91069. * @param invertY defines if data must be stored with Y axis inverted
  91070. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  91071. * @param compression defines the compression used (null by default)
  91072. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  91073. * @returns the raw texture inside an InternalTexture
  91074. */
  91075. createRawTexture(data: Nullable<ArrayBufferView>, width: number, height: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, type: number): InternalTexture;
  91076. /**
  91077. * Update a raw texture
  91078. * @param texture defines the texture to update
  91079. * @param data defines the data to store in the texture
  91080. * @param format defines the format of the data
  91081. * @param invertY defines if data must be stored with Y axis inverted
  91082. */
  91083. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  91084. /**
  91085. * Update a raw texture
  91086. * @param texture defines the texture to update
  91087. * @param data defines the data to store in the texture
  91088. * @param format defines the format of the data
  91089. * @param invertY defines if data must be stored with Y axis inverted
  91090. * @param compression defines the compression used (null by default)
  91091. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  91092. */
  91093. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, type: number): void;
  91094. /**
  91095. * Creates a new raw cube texture
  91096. * @param data defines the array of data to use to create each face
  91097. * @param size defines the size of the textures
  91098. * @param format defines the format of the data
  91099. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  91100. * @param generateMipMaps defines if the engine should generate the mip levels
  91101. * @param invertY defines if data must be stored with Y axis inverted
  91102. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  91103. * @param compression defines the compression used (null by default)
  91104. * @returns the cube texture as an InternalTexture
  91105. */
  91106. createRawCubeTexture(data: Nullable<ArrayBufferView[]>, size: number, format: number, type: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>): InternalTexture;
  91107. /**
  91108. * Update a raw cube texture
  91109. * @param texture defines the texture to udpdate
  91110. * @param data defines the data to store
  91111. * @param format defines the data format
  91112. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  91113. * @param invertY defines if data must be stored with Y axis inverted
  91114. */
  91115. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean): void;
  91116. /**
  91117. * Update a raw cube texture
  91118. * @param texture defines the texture to udpdate
  91119. * @param data defines the data to store
  91120. * @param format defines the data format
  91121. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  91122. * @param invertY defines if data must be stored with Y axis inverted
  91123. * @param compression defines the compression used (null by default)
  91124. */
  91125. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>): void;
  91126. /**
  91127. * Update a raw cube texture
  91128. * @param texture defines the texture to udpdate
  91129. * @param data defines the data to store
  91130. * @param format defines the data format
  91131. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  91132. * @param invertY defines if data must be stored with Y axis inverted
  91133. * @param compression defines the compression used (null by default)
  91134. * @param level defines which level of the texture to update
  91135. */
  91136. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>, level: number): void;
  91137. /**
  91138. * Creates a new raw cube texture from a specified url
  91139. * @param url defines the url where the data is located
  91140. * @param scene defines the current scene
  91141. * @param size defines the size of the textures
  91142. * @param format defines the format of the data
  91143. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  91144. * @param noMipmap defines if the engine should avoid generating the mip levels
  91145. * @param callback defines a callback used to extract texture data from loaded data
  91146. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  91147. * @param onLoad defines a callback called when texture is loaded
  91148. * @param onError defines a callback called if there is an error
  91149. * @returns the cube texture as an InternalTexture
  91150. */
  91151. 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;
  91152. /**
  91153. * Creates a new raw cube texture from a specified url
  91154. * @param url defines the url where the data is located
  91155. * @param scene defines the current scene
  91156. * @param size defines the size of the textures
  91157. * @param format defines the format of the data
  91158. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  91159. * @param noMipmap defines if the engine should avoid generating the mip levels
  91160. * @param callback defines a callback used to extract texture data from loaded data
  91161. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  91162. * @param onLoad defines a callback called when texture is loaded
  91163. * @param onError defines a callback called if there is an error
  91164. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  91165. * @param invertY defines if data must be stored with Y axis inverted
  91166. * @returns the cube texture as an InternalTexture
  91167. */
  91168. 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;
  91169. /**
  91170. * Creates a new raw 3D texture
  91171. * @param data defines the data used to create the texture
  91172. * @param width defines the width of the texture
  91173. * @param height defines the height of the texture
  91174. * @param depth defines the depth of the texture
  91175. * @param format defines the format of the texture
  91176. * @param generateMipMaps defines if the engine must generate mip levels
  91177. * @param invertY defines if data must be stored with Y axis inverted
  91178. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  91179. * @param compression defines the compressed used (can be null)
  91180. * @param textureType defines the compressed used (can be null)
  91181. * @returns a new raw 3D texture (stored in an InternalTexture)
  91182. */
  91183. createRawTexture3D(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  91184. /**
  91185. * Update a raw 3D texture
  91186. * @param texture defines the texture to update
  91187. * @param data defines the data to store
  91188. * @param format defines the data format
  91189. * @param invertY defines if data must be stored with Y axis inverted
  91190. */
  91191. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  91192. /**
  91193. * Update a raw 3D texture
  91194. * @param texture defines the texture to update
  91195. * @param data defines the data to store
  91196. * @param format defines the data format
  91197. * @param invertY defines if data must be stored with Y axis inverted
  91198. * @param compression defines the used compression (can be null)
  91199. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  91200. */
  91201. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  91202. /**
  91203. * Creates a new raw 2D array texture
  91204. * @param data defines the data used to create the texture
  91205. * @param width defines the width of the texture
  91206. * @param height defines the height of the texture
  91207. * @param depth defines the number of layers of the texture
  91208. * @param format defines the format of the texture
  91209. * @param generateMipMaps defines if the engine must generate mip levels
  91210. * @param invertY defines if data must be stored with Y axis inverted
  91211. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  91212. * @param compression defines the compressed used (can be null)
  91213. * @param textureType defines the compressed used (can be null)
  91214. * @returns a new raw 2D array texture (stored in an InternalTexture)
  91215. */
  91216. createRawTexture2DArray(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  91217. /**
  91218. * Update a raw 2D array texture
  91219. * @param texture defines the texture to update
  91220. * @param data defines the data to store
  91221. * @param format defines the data format
  91222. * @param invertY defines if data must be stored with Y axis inverted
  91223. */
  91224. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  91225. /**
  91226. * Update a raw 2D array texture
  91227. * @param texture defines the texture to update
  91228. * @param data defines the data to store
  91229. * @param format defines the data format
  91230. * @param invertY defines if data must be stored with Y axis inverted
  91231. * @param compression defines the used compression (can be null)
  91232. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  91233. */
  91234. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  91235. }
  91236. }
  91237. declare module BABYLON {
  91238. /**
  91239. * Raw texture can help creating a texture directly from an array of data.
  91240. * This can be super useful if you either get the data from an uncompressed source or
  91241. * if you wish to create your texture pixel by pixel.
  91242. */
  91243. export class RawTexture extends Texture {
  91244. /**
  91245. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  91246. */
  91247. format: number;
  91248. /**
  91249. * Instantiates a new RawTexture.
  91250. * Raw texture can help creating a texture directly from an array of data.
  91251. * This can be super useful if you either get the data from an uncompressed source or
  91252. * if you wish to create your texture pixel by pixel.
  91253. * @param data define the array of data to use to create the texture
  91254. * @param width define the width of the texture
  91255. * @param height define the height of the texture
  91256. * @param format define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  91257. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91258. * @param generateMipMaps define whether mip maps should be generated or not
  91259. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91260. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91261. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  91262. */
  91263. constructor(data: ArrayBufferView, width: number, height: number,
  91264. /**
  91265. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  91266. */
  91267. format: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number);
  91268. /**
  91269. * Updates the texture underlying data.
  91270. * @param data Define the new data of the texture
  91271. */
  91272. update(data: ArrayBufferView): void;
  91273. /**
  91274. * Creates a luminance texture from some data.
  91275. * @param data Define the texture data
  91276. * @param width Define the width of the texture
  91277. * @param height Define the height of the texture
  91278. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91279. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91280. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91281. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91282. * @returns the luminance texture
  91283. */
  91284. static CreateLuminanceTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  91285. /**
  91286. * Creates a luminance alpha texture from some data.
  91287. * @param data Define the texture data
  91288. * @param width Define the width of the texture
  91289. * @param height Define the height of the texture
  91290. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91291. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91292. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91293. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91294. * @returns the luminance alpha texture
  91295. */
  91296. static CreateLuminanceAlphaTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  91297. /**
  91298. * Creates an alpha texture from some data.
  91299. * @param data Define the texture data
  91300. * @param width Define the width of the texture
  91301. * @param height Define the height of the texture
  91302. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91303. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91304. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91305. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91306. * @returns the alpha texture
  91307. */
  91308. static CreateAlphaTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  91309. /**
  91310. * Creates a RGB texture from some data.
  91311. * @param data Define the texture data
  91312. * @param width Define the width of the texture
  91313. * @param height Define the height of the texture
  91314. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91315. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91316. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91317. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91318. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  91319. * @returns the RGB alpha texture
  91320. */
  91321. static CreateRGBTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  91322. /**
  91323. * Creates a RGBA texture from some data.
  91324. * @param data Define the texture data
  91325. * @param width Define the width of the texture
  91326. * @param height Define the height of the texture
  91327. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91328. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91329. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91330. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91331. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  91332. * @returns the RGBA texture
  91333. */
  91334. static CreateRGBATexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  91335. /**
  91336. * Creates a R texture from some data.
  91337. * @param data Define the texture data
  91338. * @param width Define the width of the texture
  91339. * @param height Define the height of the texture
  91340. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91341. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91342. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91343. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91344. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  91345. * @returns the R texture
  91346. */
  91347. static CreateRTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  91348. }
  91349. }
  91350. declare module BABYLON {
  91351. interface ThinEngine {
  91352. /**
  91353. * Update a dynamic index buffer
  91354. * @param indexBuffer defines the target index buffer
  91355. * @param indices defines the data to update
  91356. * @param offset defines the offset in the target index buffer where update should start
  91357. */
  91358. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  91359. /**
  91360. * Updates a dynamic vertex buffer.
  91361. * @param vertexBuffer the vertex buffer to update
  91362. * @param data the data used to update the vertex buffer
  91363. * @param byteOffset the byte offset of the data
  91364. * @param byteLength the byte length of the data
  91365. */
  91366. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  91367. }
  91368. }
  91369. declare module BABYLON {
  91370. interface AbstractScene {
  91371. /**
  91372. * The list of procedural textures added to the scene
  91373. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  91374. */
  91375. proceduralTextures: Array<ProceduralTexture>;
  91376. }
  91377. /**
  91378. * Defines the Procedural Texture scene component responsible to manage any Procedural Texture
  91379. * in a given scene.
  91380. */
  91381. export class ProceduralTextureSceneComponent implements ISceneComponent {
  91382. /**
  91383. * The component name helpfull to identify the component in the list of scene components.
  91384. */
  91385. readonly name: string;
  91386. /**
  91387. * The scene the component belongs to.
  91388. */
  91389. scene: Scene;
  91390. /**
  91391. * Creates a new instance of the component for the given scene
  91392. * @param scene Defines the scene to register the component in
  91393. */
  91394. constructor(scene: Scene);
  91395. /**
  91396. * Registers the component in a given scene
  91397. */
  91398. register(): void;
  91399. /**
  91400. * Rebuilds the elements related to this component in case of
  91401. * context lost for instance.
  91402. */
  91403. rebuild(): void;
  91404. /**
  91405. * Disposes the component and the associated ressources.
  91406. */
  91407. dispose(): void;
  91408. private _beforeClear;
  91409. }
  91410. }
  91411. declare module BABYLON {
  91412. interface ThinEngine {
  91413. /**
  91414. * Creates a new render target cube texture
  91415. * @param size defines the size of the texture
  91416. * @param options defines the options used to create the texture
  91417. * @returns a new render target cube texture stored in an InternalTexture
  91418. */
  91419. createRenderTargetCubeTexture(size: number, options?: Partial<RenderTargetCreationOptions>): InternalTexture;
  91420. }
  91421. }
  91422. declare module BABYLON {
  91423. /** @hidden */
  91424. export var proceduralVertexShader: {
  91425. name: string;
  91426. shader: string;
  91427. };
  91428. }
  91429. declare module BABYLON {
  91430. /**
  91431. * 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.
  91432. * This is the base class of any Procedural texture and contains most of the shareable code.
  91433. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  91434. */
  91435. export class ProceduralTexture extends Texture {
  91436. /**
  91437. * Define if the texture is enabled or not (disabled texture will not render)
  91438. */
  91439. isEnabled: boolean;
  91440. /**
  91441. * Define if the texture must be cleared before rendering (default is true)
  91442. */
  91443. autoClear: boolean;
  91444. /**
  91445. * Callback called when the texture is generated
  91446. */
  91447. onGenerated: () => void;
  91448. /**
  91449. * Event raised when the texture is generated
  91450. */
  91451. onGeneratedObservable: Observable<ProceduralTexture>;
  91452. /** @hidden */
  91453. _generateMipMaps: boolean;
  91454. /** @hidden **/
  91455. _effect: Effect;
  91456. /** @hidden */
  91457. _textures: {
  91458. [key: string]: Texture;
  91459. };
  91460. /** @hidden */
  91461. protected _fallbackTexture: Nullable<Texture>;
  91462. private _size;
  91463. private _currentRefreshId;
  91464. private _frameId;
  91465. private _refreshRate;
  91466. private _vertexBuffers;
  91467. private _indexBuffer;
  91468. private _uniforms;
  91469. private _samplers;
  91470. private _fragment;
  91471. private _floats;
  91472. private _ints;
  91473. private _floatsArrays;
  91474. private _colors3;
  91475. private _colors4;
  91476. private _vectors2;
  91477. private _vectors3;
  91478. private _matrices;
  91479. private _fallbackTextureUsed;
  91480. private _fullEngine;
  91481. private _cachedDefines;
  91482. private _contentUpdateId;
  91483. private _contentData;
  91484. /**
  91485. * Instantiates a new procedural texture.
  91486. * 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.
  91487. * This is the base class of any Procedural texture and contains most of the shareable code.
  91488. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  91489. * @param name Define the name of the texture
  91490. * @param size Define the size of the texture to create
  91491. * @param fragment Define the fragment shader to use to generate the texture or null if it is defined later
  91492. * @param scene Define the scene the texture belongs to
  91493. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  91494. * @param generateMipMaps Define if the texture should creates mip maps or not
  91495. * @param isCube Define if the texture is a cube texture or not (this will render each faces of the cube)
  91496. */
  91497. constructor(name: string, size: any, fragment: any, scene: Nullable<Scene>, fallbackTexture?: Nullable<Texture>, generateMipMaps?: boolean, isCube?: boolean);
  91498. /**
  91499. * The effect that is created when initializing the post process.
  91500. * @returns The created effect corresponding the the postprocess.
  91501. */
  91502. getEffect(): Effect;
  91503. /**
  91504. * Gets texture content (Use this function wisely as reading from a texture can be slow)
  91505. * @returns an ArrayBufferView (Uint8Array or Float32Array)
  91506. */
  91507. getContent(): Nullable<ArrayBufferView>;
  91508. private _createIndexBuffer;
  91509. /** @hidden */
  91510. _rebuild(): void;
  91511. /**
  91512. * Resets the texture in order to recreate its associated resources.
  91513. * This can be called in case of context loss
  91514. */
  91515. reset(): void;
  91516. protected _getDefines(): string;
  91517. /**
  91518. * Is the texture ready to be used ? (rendered at least once)
  91519. * @returns true if ready, otherwise, false.
  91520. */
  91521. isReady(): boolean;
  91522. /**
  91523. * Resets the refresh counter of the texture and start bak from scratch.
  91524. * Could be useful to regenerate the texture if it is setup to render only once.
  91525. */
  91526. resetRefreshCounter(): void;
  91527. /**
  91528. * Set the fragment shader to use in order to render the texture.
  91529. * @param fragment This can be set to a path (into the shader store) or to a json object containing a fragmentElement property.
  91530. */
  91531. setFragment(fragment: any): void;
  91532. /**
  91533. * Define the refresh rate of the texture or the rendering frequency.
  91534. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  91535. */
  91536. get refreshRate(): number;
  91537. set refreshRate(value: number);
  91538. /** @hidden */
  91539. _shouldRender(): boolean;
  91540. /**
  91541. * Get the size the texture is rendering at.
  91542. * @returns the size (texture is always squared)
  91543. */
  91544. getRenderSize(): number;
  91545. /**
  91546. * Resize the texture to new value.
  91547. * @param size Define the new size the texture should have
  91548. * @param generateMipMaps Define whether the new texture should create mip maps
  91549. */
  91550. resize(size: number, generateMipMaps: boolean): void;
  91551. private _checkUniform;
  91552. /**
  91553. * Set a texture in the shader program used to render.
  91554. * @param name Define the name of the uniform samplers as defined in the shader
  91555. * @param texture Define the texture to bind to this sampler
  91556. * @return the texture itself allowing "fluent" like uniform updates
  91557. */
  91558. setTexture(name: string, texture: Texture): ProceduralTexture;
  91559. /**
  91560. * Set a float in the shader.
  91561. * @param name Define the name of the uniform as defined in the shader
  91562. * @param value Define the value to give to the uniform
  91563. * @return the texture itself allowing "fluent" like uniform updates
  91564. */
  91565. setFloat(name: string, value: number): ProceduralTexture;
  91566. /**
  91567. * Set a int in the shader.
  91568. * @param name Define the name of the uniform as defined in the shader
  91569. * @param value Define the value to give to the uniform
  91570. * @return the texture itself allowing "fluent" like uniform updates
  91571. */
  91572. setInt(name: string, value: number): ProceduralTexture;
  91573. /**
  91574. * Set an array of floats in the shader.
  91575. * @param name Define the name of the uniform as defined in the shader
  91576. * @param value Define the value to give to the uniform
  91577. * @return the texture itself allowing "fluent" like uniform updates
  91578. */
  91579. setFloats(name: string, value: number[]): ProceduralTexture;
  91580. /**
  91581. * Set a vec3 in the shader from a Color3.
  91582. * @param name Define the name of the uniform as defined in the shader
  91583. * @param value Define the value to give to the uniform
  91584. * @return the texture itself allowing "fluent" like uniform updates
  91585. */
  91586. setColor3(name: string, value: Color3): ProceduralTexture;
  91587. /**
  91588. * Set a vec4 in the shader from a Color4.
  91589. * @param name Define the name of the uniform as defined in the shader
  91590. * @param value Define the value to give to the uniform
  91591. * @return the texture itself allowing "fluent" like uniform updates
  91592. */
  91593. setColor4(name: string, value: Color4): ProceduralTexture;
  91594. /**
  91595. * Set a vec2 in the shader from a Vector2.
  91596. * @param name Define the name of the uniform as defined in the shader
  91597. * @param value Define the value to give to the uniform
  91598. * @return the texture itself allowing "fluent" like uniform updates
  91599. */
  91600. setVector2(name: string, value: Vector2): ProceduralTexture;
  91601. /**
  91602. * Set a vec3 in the shader from a Vector3.
  91603. * @param name Define the name of the uniform as defined in the shader
  91604. * @param value Define the value to give to the uniform
  91605. * @return the texture itself allowing "fluent" like uniform updates
  91606. */
  91607. setVector3(name: string, value: Vector3): ProceduralTexture;
  91608. /**
  91609. * Set a mat4 in the shader from a MAtrix.
  91610. * @param name Define the name of the uniform as defined in the shader
  91611. * @param value Define the value to give to the uniform
  91612. * @return the texture itself allowing "fluent" like uniform updates
  91613. */
  91614. setMatrix(name: string, value: Matrix): ProceduralTexture;
  91615. /**
  91616. * Render the texture to its associated render target.
  91617. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  91618. */
  91619. render(useCameraPostProcess?: boolean): void;
  91620. /**
  91621. * Clone the texture.
  91622. * @returns the cloned texture
  91623. */
  91624. clone(): ProceduralTexture;
  91625. /**
  91626. * Dispose the texture and release its asoociated resources.
  91627. */
  91628. dispose(): void;
  91629. }
  91630. }
  91631. declare module BABYLON {
  91632. /**
  91633. * This represents the base class for particle system in Babylon.
  91634. * 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.
  91635. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  91636. * @example https://doc.babylonjs.com/babylon101/particles
  91637. */
  91638. export class BaseParticleSystem {
  91639. /**
  91640. * Source color is added to the destination color without alpha affecting the result
  91641. */
  91642. static BLENDMODE_ONEONE: number;
  91643. /**
  91644. * Blend current color and particle color using particle’s alpha
  91645. */
  91646. static BLENDMODE_STANDARD: number;
  91647. /**
  91648. * Add current color and particle color multiplied by particle’s alpha
  91649. */
  91650. static BLENDMODE_ADD: number;
  91651. /**
  91652. * Multiply current color with particle color
  91653. */
  91654. static BLENDMODE_MULTIPLY: number;
  91655. /**
  91656. * Multiply current color with particle color then add current color and particle color multiplied by particle’s alpha
  91657. */
  91658. static BLENDMODE_MULTIPLYADD: number;
  91659. /**
  91660. * List of animations used by the particle system.
  91661. */
  91662. animations: Animation[];
  91663. /**
  91664. * Gets or sets the unique id of the particle system
  91665. */
  91666. uniqueId: number;
  91667. /**
  91668. * The id of the Particle system.
  91669. */
  91670. id: string;
  91671. /**
  91672. * The friendly name of the Particle system.
  91673. */
  91674. name: string;
  91675. /**
  91676. * Snippet ID if the particle system was created from the snippet server
  91677. */
  91678. snippetId: string;
  91679. /**
  91680. * The rendering group used by the Particle system to chose when to render.
  91681. */
  91682. renderingGroupId: number;
  91683. /**
  91684. * The emitter represents the Mesh or position we are attaching the particle system to.
  91685. */
  91686. emitter: Nullable<AbstractMesh | Vector3>;
  91687. /**
  91688. * The maximum number of particles to emit per frame
  91689. */
  91690. emitRate: number;
  91691. /**
  91692. * If you want to launch only a few particles at once, that can be done, as well.
  91693. */
  91694. manualEmitCount: number;
  91695. /**
  91696. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  91697. */
  91698. updateSpeed: number;
  91699. /**
  91700. * The amount of time the particle system is running (depends of the overall update speed).
  91701. */
  91702. targetStopDuration: number;
  91703. /**
  91704. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  91705. */
  91706. disposeOnStop: boolean;
  91707. /**
  91708. * Minimum power of emitting particles.
  91709. */
  91710. minEmitPower: number;
  91711. /**
  91712. * Maximum power of emitting particles.
  91713. */
  91714. maxEmitPower: number;
  91715. /**
  91716. * Minimum life time of emitting particles.
  91717. */
  91718. minLifeTime: number;
  91719. /**
  91720. * Maximum life time of emitting particles.
  91721. */
  91722. maxLifeTime: number;
  91723. /**
  91724. * Minimum Size of emitting particles.
  91725. */
  91726. minSize: number;
  91727. /**
  91728. * Maximum Size of emitting particles.
  91729. */
  91730. maxSize: number;
  91731. /**
  91732. * Minimum scale of emitting particles on X axis.
  91733. */
  91734. minScaleX: number;
  91735. /**
  91736. * Maximum scale of emitting particles on X axis.
  91737. */
  91738. maxScaleX: number;
  91739. /**
  91740. * Minimum scale of emitting particles on Y axis.
  91741. */
  91742. minScaleY: number;
  91743. /**
  91744. * Maximum scale of emitting particles on Y axis.
  91745. */
  91746. maxScaleY: number;
  91747. /**
  91748. * Gets or sets the minimal initial rotation in radians.
  91749. */
  91750. minInitialRotation: number;
  91751. /**
  91752. * Gets or sets the maximal initial rotation in radians.
  91753. */
  91754. maxInitialRotation: number;
  91755. /**
  91756. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  91757. */
  91758. minAngularSpeed: number;
  91759. /**
  91760. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  91761. */
  91762. maxAngularSpeed: number;
  91763. /**
  91764. * The texture used to render each particle. (this can be a spritesheet)
  91765. */
  91766. particleTexture: Nullable<BaseTexture>;
  91767. /**
  91768. * The layer mask we are rendering the particles through.
  91769. */
  91770. layerMask: number;
  91771. /**
  91772. * This can help using your own shader to render the particle system.
  91773. * The according effect will be created
  91774. */
  91775. customShader: any;
  91776. /**
  91777. * By default particle system starts as soon as they are created. This prevents the
  91778. * automatic start to happen and let you decide when to start emitting particles.
  91779. */
  91780. preventAutoStart: boolean;
  91781. private _noiseTexture;
  91782. /**
  91783. * Gets or sets a texture used to add random noise to particle positions
  91784. */
  91785. get noiseTexture(): Nullable<ProceduralTexture>;
  91786. set noiseTexture(value: Nullable<ProceduralTexture>);
  91787. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  91788. noiseStrength: Vector3;
  91789. /**
  91790. * Callback triggered when the particle animation is ending.
  91791. */
  91792. onAnimationEnd: Nullable<() => void>;
  91793. /**
  91794. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE or ParticleSystem.BLENDMODE_STANDARD.
  91795. */
  91796. blendMode: number;
  91797. /**
  91798. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  91799. * to override the particles.
  91800. */
  91801. forceDepthWrite: boolean;
  91802. /** 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 */
  91803. preWarmCycles: number;
  91804. /** Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1) */
  91805. preWarmStepOffset: number;
  91806. /**
  91807. * 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)
  91808. */
  91809. spriteCellChangeSpeed: number;
  91810. /**
  91811. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  91812. */
  91813. startSpriteCellID: number;
  91814. /**
  91815. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  91816. */
  91817. endSpriteCellID: number;
  91818. /**
  91819. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  91820. */
  91821. spriteCellWidth: number;
  91822. /**
  91823. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  91824. */
  91825. spriteCellHeight: number;
  91826. /**
  91827. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  91828. */
  91829. spriteRandomStartCell: boolean;
  91830. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  91831. translationPivot: Vector2;
  91832. /** @hidden */
  91833. protected _isAnimationSheetEnabled: boolean;
  91834. /**
  91835. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  91836. */
  91837. beginAnimationOnStart: boolean;
  91838. /**
  91839. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  91840. */
  91841. beginAnimationFrom: number;
  91842. /**
  91843. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  91844. */
  91845. beginAnimationTo: number;
  91846. /**
  91847. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  91848. */
  91849. beginAnimationLoop: boolean;
  91850. /**
  91851. * Gets or sets a world offset applied to all particles
  91852. */
  91853. worldOffset: Vector3;
  91854. /**
  91855. * Gets or sets whether an animation sprite sheet is enabled or not on the particle system
  91856. */
  91857. get isAnimationSheetEnabled(): boolean;
  91858. set isAnimationSheetEnabled(value: boolean);
  91859. /**
  91860. * Get hosting scene
  91861. * @returns the scene
  91862. */
  91863. getScene(): Nullable<Scene>;
  91864. /**
  91865. * You can use gravity if you want to give an orientation to your particles.
  91866. */
  91867. gravity: Vector3;
  91868. protected _colorGradients: Nullable<Array<ColorGradient>>;
  91869. protected _sizeGradients: Nullable<Array<FactorGradient>>;
  91870. protected _lifeTimeGradients: Nullable<Array<FactorGradient>>;
  91871. protected _angularSpeedGradients: Nullable<Array<FactorGradient>>;
  91872. protected _velocityGradients: Nullable<Array<FactorGradient>>;
  91873. protected _limitVelocityGradients: Nullable<Array<FactorGradient>>;
  91874. protected _dragGradients: Nullable<Array<FactorGradient>>;
  91875. protected _emitRateGradients: Nullable<Array<FactorGradient>>;
  91876. protected _startSizeGradients: Nullable<Array<FactorGradient>>;
  91877. protected _rampGradients: Nullable<Array<Color3Gradient>>;
  91878. protected _colorRemapGradients: Nullable<Array<FactorGradient>>;
  91879. protected _alphaRemapGradients: Nullable<Array<FactorGradient>>;
  91880. protected _hasTargetStopDurationDependantGradient(): boolean | null;
  91881. /**
  91882. * Defines the delay in milliseconds before starting the system (0 by default)
  91883. */
  91884. startDelay: number;
  91885. /**
  91886. * Gets the current list of drag gradients.
  91887. * You must use addDragGradient and removeDragGradient to udpate this list
  91888. * @returns the list of drag gradients
  91889. */
  91890. getDragGradients(): Nullable<Array<FactorGradient>>;
  91891. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  91892. limitVelocityDamping: number;
  91893. /**
  91894. * Gets the current list of limit velocity gradients.
  91895. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  91896. * @returns the list of limit velocity gradients
  91897. */
  91898. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  91899. /**
  91900. * Gets the current list of color gradients.
  91901. * You must use addColorGradient and removeColorGradient to udpate this list
  91902. * @returns the list of color gradients
  91903. */
  91904. getColorGradients(): Nullable<Array<ColorGradient>>;
  91905. /**
  91906. * Gets the current list of size gradients.
  91907. * You must use addSizeGradient and removeSizeGradient to udpate this list
  91908. * @returns the list of size gradients
  91909. */
  91910. getSizeGradients(): Nullable<Array<FactorGradient>>;
  91911. /**
  91912. * Gets the current list of color remap gradients.
  91913. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  91914. * @returns the list of color remap gradients
  91915. */
  91916. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  91917. /**
  91918. * Gets the current list of alpha remap gradients.
  91919. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  91920. * @returns the list of alpha remap gradients
  91921. */
  91922. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  91923. /**
  91924. * Gets the current list of life time gradients.
  91925. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  91926. * @returns the list of life time gradients
  91927. */
  91928. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  91929. /**
  91930. * Gets the current list of angular speed gradients.
  91931. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  91932. * @returns the list of angular speed gradients
  91933. */
  91934. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  91935. /**
  91936. * Gets the current list of velocity gradients.
  91937. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  91938. * @returns the list of velocity gradients
  91939. */
  91940. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  91941. /**
  91942. * Gets the current list of start size gradients.
  91943. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  91944. * @returns the list of start size gradients
  91945. */
  91946. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  91947. /**
  91948. * Gets the current list of emit rate gradients.
  91949. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  91950. * @returns the list of emit rate gradients
  91951. */
  91952. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  91953. /**
  91954. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  91955. * This only works when particleEmitterTyps is a BoxParticleEmitter
  91956. */
  91957. get direction1(): Vector3;
  91958. set direction1(value: Vector3);
  91959. /**
  91960. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  91961. * This only works when particleEmitterTyps is a BoxParticleEmitter
  91962. */
  91963. get direction2(): Vector3;
  91964. set direction2(value: Vector3);
  91965. /**
  91966. * 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.
  91967. * This only works when particleEmitterTyps is a BoxParticleEmitter
  91968. */
  91969. get minEmitBox(): Vector3;
  91970. set minEmitBox(value: Vector3);
  91971. /**
  91972. * 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.
  91973. * This only works when particleEmitterTyps is a BoxParticleEmitter
  91974. */
  91975. get maxEmitBox(): Vector3;
  91976. set maxEmitBox(value: Vector3);
  91977. /**
  91978. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  91979. */
  91980. color1: Color4;
  91981. /**
  91982. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  91983. */
  91984. color2: Color4;
  91985. /**
  91986. * Color the particle will have at the end of its lifetime
  91987. */
  91988. colorDead: Color4;
  91989. /**
  91990. * An optional mask to filter some colors out of the texture, or filter a part of the alpha channel
  91991. */
  91992. textureMask: Color4;
  91993. /**
  91994. * The particle emitter type defines the emitter used by the particle system.
  91995. * It can be for example box, sphere, or cone...
  91996. */
  91997. particleEmitterType: IParticleEmitterType;
  91998. /** @hidden */
  91999. _isSubEmitter: boolean;
  92000. /**
  92001. * Gets or sets the billboard mode to use when isBillboardBased = true.
  92002. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  92003. */
  92004. billboardMode: number;
  92005. protected _isBillboardBased: boolean;
  92006. /**
  92007. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  92008. */
  92009. get isBillboardBased(): boolean;
  92010. set isBillboardBased(value: boolean);
  92011. /**
  92012. * The scene the particle system belongs to.
  92013. */
  92014. protected _scene: Nullable<Scene>;
  92015. /**
  92016. * The engine the particle system belongs to.
  92017. */
  92018. protected _engine: ThinEngine;
  92019. /**
  92020. * Local cache of defines for image processing.
  92021. */
  92022. protected _imageProcessingConfigurationDefines: ImageProcessingConfigurationDefines;
  92023. /**
  92024. * Default configuration related to image processing available in the standard Material.
  92025. */
  92026. protected _imageProcessingConfiguration: Nullable<ImageProcessingConfiguration>;
  92027. /**
  92028. * Gets the image processing configuration used either in this material.
  92029. */
  92030. get imageProcessingConfiguration(): Nullable<ImageProcessingConfiguration>;
  92031. /**
  92032. * Sets the Default image processing configuration used either in the this material.
  92033. *
  92034. * If sets to null, the scene one is in use.
  92035. */
  92036. set imageProcessingConfiguration(value: Nullable<ImageProcessingConfiguration>);
  92037. /**
  92038. * Attaches a new image processing configuration to the Standard Material.
  92039. * @param configuration
  92040. */
  92041. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  92042. /** @hidden */
  92043. protected _reset(): void;
  92044. /** @hidden */
  92045. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: Nullable<RawTexture>): BaseParticleSystem;
  92046. /**
  92047. * Instantiates a particle system.
  92048. * 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.
  92049. * @param name The name of the particle system
  92050. */
  92051. constructor(name: string);
  92052. /**
  92053. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  92054. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  92055. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  92056. * @returns the emitter
  92057. */
  92058. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  92059. /**
  92060. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  92061. * @param radius The radius of the hemisphere to emit from
  92062. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  92063. * @returns the emitter
  92064. */
  92065. createHemisphericEmitter(radius?: number, radiusRange?: number): HemisphericParticleEmitter;
  92066. /**
  92067. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  92068. * @param radius The radius of the sphere to emit from
  92069. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  92070. * @returns the emitter
  92071. */
  92072. createSphereEmitter(radius?: number, radiusRange?: number): SphereParticleEmitter;
  92073. /**
  92074. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  92075. * @param radius The radius of the sphere to emit from
  92076. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  92077. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  92078. * @returns the emitter
  92079. */
  92080. createDirectedSphereEmitter(radius?: number, direction1?: Vector3, direction2?: Vector3): SphereDirectedParticleEmitter;
  92081. /**
  92082. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  92083. * @param radius The radius of the emission cylinder
  92084. * @param height The height of the emission cylinder
  92085. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  92086. * @param directionRandomizer How much to randomize the particle direction [0-1]
  92087. * @returns the emitter
  92088. */
  92089. createCylinderEmitter(radius?: number, height?: number, radiusRange?: number, directionRandomizer?: number): CylinderParticleEmitter;
  92090. /**
  92091. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  92092. * @param radius The radius of the cylinder to emit from
  92093. * @param height The height of the emission cylinder
  92094. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  92095. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  92096. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  92097. * @returns the emitter
  92098. */
  92099. createDirectedCylinderEmitter(radius?: number, height?: number, radiusRange?: number, direction1?: Vector3, direction2?: Vector3): CylinderDirectedParticleEmitter;
  92100. /**
  92101. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  92102. * @param radius The radius of the cone to emit from
  92103. * @param angle The base angle of the cone
  92104. * @returns the emitter
  92105. */
  92106. createConeEmitter(radius?: number, angle?: number): ConeParticleEmitter;
  92107. /**
  92108. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  92109. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  92110. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  92111. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  92112. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  92113. * @returns the emitter
  92114. */
  92115. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  92116. }
  92117. }
  92118. declare module BABYLON {
  92119. /**
  92120. * Type of sub emitter
  92121. */
  92122. export enum SubEmitterType {
  92123. /**
  92124. * Attached to the particle over it's lifetime
  92125. */
  92126. ATTACHED = 0,
  92127. /**
  92128. * Created when the particle dies
  92129. */
  92130. END = 1
  92131. }
  92132. /**
  92133. * Sub emitter class used to emit particles from an existing particle
  92134. */
  92135. export class SubEmitter {
  92136. /**
  92137. * the particle system to be used by the sub emitter
  92138. */
  92139. particleSystem: ParticleSystem;
  92140. /**
  92141. * Type of the submitter (Default: END)
  92142. */
  92143. type: SubEmitterType;
  92144. /**
  92145. * 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)
  92146. * Note: This only is supported when using an emitter of type Mesh
  92147. */
  92148. inheritDirection: boolean;
  92149. /**
  92150. * How much of the attached particles speed should be added to the sub emitted particle (default: 0)
  92151. */
  92152. inheritedVelocityAmount: number;
  92153. /**
  92154. * Creates a sub emitter
  92155. * @param particleSystem the particle system to be used by the sub emitter
  92156. */
  92157. constructor(
  92158. /**
  92159. * the particle system to be used by the sub emitter
  92160. */
  92161. particleSystem: ParticleSystem);
  92162. /**
  92163. * Clones the sub emitter
  92164. * @returns the cloned sub emitter
  92165. */
  92166. clone(): SubEmitter;
  92167. /**
  92168. * Serialize current object to a JSON object
  92169. * @returns the serialized object
  92170. */
  92171. serialize(): any;
  92172. /** @hidden */
  92173. static _ParseParticleSystem(system: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string): ParticleSystem;
  92174. /**
  92175. * Creates a new SubEmitter from a serialized JSON version
  92176. * @param serializationObject defines the JSON object to read from
  92177. * @param sceneOrEngine defines the hosting scene or the hosting engine
  92178. * @param rootUrl defines the rootUrl for data loading
  92179. * @returns a new SubEmitter
  92180. */
  92181. static Parse(serializationObject: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string): SubEmitter;
  92182. /** Release associated resources */
  92183. dispose(): void;
  92184. }
  92185. }
  92186. declare module BABYLON {
  92187. /** @hidden */
  92188. export var imageProcessingDeclaration: {
  92189. name: string;
  92190. shader: string;
  92191. };
  92192. }
  92193. declare module BABYLON {
  92194. /** @hidden */
  92195. export var imageProcessingFunctions: {
  92196. name: string;
  92197. shader: string;
  92198. };
  92199. }
  92200. declare module BABYLON {
  92201. /** @hidden */
  92202. export var particlesPixelShader: {
  92203. name: string;
  92204. shader: string;
  92205. };
  92206. }
  92207. declare module BABYLON {
  92208. /** @hidden */
  92209. export var particlesVertexShader: {
  92210. name: string;
  92211. shader: string;
  92212. };
  92213. }
  92214. declare module BABYLON {
  92215. /**
  92216. * Interface used to define entities containing multiple clip planes
  92217. */
  92218. export interface IClipPlanesHolder {
  92219. /**
  92220. * Gets or sets the active clipplane 1
  92221. */
  92222. clipPlane: Nullable<Plane>;
  92223. /**
  92224. * Gets or sets the active clipplane 2
  92225. */
  92226. clipPlane2: Nullable<Plane>;
  92227. /**
  92228. * Gets or sets the active clipplane 3
  92229. */
  92230. clipPlane3: Nullable<Plane>;
  92231. /**
  92232. * Gets or sets the active clipplane 4
  92233. */
  92234. clipPlane4: Nullable<Plane>;
  92235. /**
  92236. * Gets or sets the active clipplane 5
  92237. */
  92238. clipPlane5: Nullable<Plane>;
  92239. /**
  92240. * Gets or sets the active clipplane 6
  92241. */
  92242. clipPlane6: Nullable<Plane>;
  92243. }
  92244. }
  92245. declare module BABYLON {
  92246. /**
  92247. * "Static Class" containing a few commonly used helper while dealing with material for rendering purpose.
  92248. *
  92249. * It is complementary with MaterialHelper but provides completely independent functions (for tree shaking sake)
  92250. *
  92251. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  92252. */
  92253. export class ThinMaterialHelper {
  92254. /**
  92255. * Binds the clip plane information from the holder to the effect.
  92256. * @param effect The effect we are binding the data to
  92257. * @param holder The entity containing the clip plane information
  92258. */
  92259. static BindClipPlane(effect: Effect, holder: IClipPlanesHolder): void;
  92260. }
  92261. }
  92262. declare module BABYLON {
  92263. interface ThinEngine {
  92264. /**
  92265. * Sets alpha constants used by some alpha blending modes
  92266. * @param r defines the red component
  92267. * @param g defines the green component
  92268. * @param b defines the blue component
  92269. * @param a defines the alpha component
  92270. */
  92271. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  92272. /**
  92273. * Sets the current alpha mode
  92274. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  92275. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  92276. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  92277. */
  92278. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  92279. /**
  92280. * Gets the current alpha mode
  92281. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  92282. * @returns the current alpha mode
  92283. */
  92284. getAlphaMode(): number;
  92285. /**
  92286. * Sets the current alpha equation
  92287. * @param equation defines the equation to use (one of the Engine.ALPHA_EQUATION_XXX)
  92288. */
  92289. setAlphaEquation(equation: number): void;
  92290. /**
  92291. * Gets the current alpha equation.
  92292. * @returns the current alpha equation
  92293. */
  92294. getAlphaEquation(): number;
  92295. }
  92296. }
  92297. declare module BABYLON {
  92298. /**
  92299. * This represents a particle system in Babylon.
  92300. * 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.
  92301. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  92302. * @example https://doc.babylonjs.com/babylon101/particles
  92303. */
  92304. export class ParticleSystem extends BaseParticleSystem implements IDisposable, IAnimatable, IParticleSystem {
  92305. /**
  92306. * Billboard mode will only apply to Y axis
  92307. */
  92308. static readonly BILLBOARDMODE_Y: number;
  92309. /**
  92310. * Billboard mode will apply to all axes
  92311. */
  92312. static readonly BILLBOARDMODE_ALL: number;
  92313. /**
  92314. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  92315. */
  92316. static readonly BILLBOARDMODE_STRETCHED: number;
  92317. /**
  92318. * This function can be defined to provide custom update for active particles.
  92319. * This function will be called instead of regular update (age, position, color, etc.).
  92320. * Do not forget that this function will be called on every frame so try to keep it simple and fast :)
  92321. */
  92322. updateFunction: (particles: Particle[]) => void;
  92323. private _emitterWorldMatrix;
  92324. /**
  92325. * This function can be defined to specify initial direction for every new particle.
  92326. * It by default use the emitterType defined function
  92327. */
  92328. startDirectionFunction: (worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  92329. /**
  92330. * This function can be defined to specify initial position for every new particle.
  92331. * It by default use the emitterType defined function
  92332. */
  92333. startPositionFunction: (worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  92334. /**
  92335. * @hidden
  92336. */
  92337. _inheritedVelocityOffset: Vector3;
  92338. /**
  92339. * An event triggered when the system is disposed
  92340. */
  92341. onDisposeObservable: Observable<IParticleSystem>;
  92342. private _onDisposeObserver;
  92343. /**
  92344. * Sets a callback that will be triggered when the system is disposed
  92345. */
  92346. set onDispose(callback: () => void);
  92347. private _particles;
  92348. private _epsilon;
  92349. private _capacity;
  92350. private _stockParticles;
  92351. private _newPartsExcess;
  92352. private _vertexData;
  92353. private _vertexBuffer;
  92354. private _vertexBuffers;
  92355. private _spriteBuffer;
  92356. private _indexBuffer;
  92357. private _effect;
  92358. private _customEffect;
  92359. private _cachedDefines;
  92360. private _scaledColorStep;
  92361. private _colorDiff;
  92362. private _scaledDirection;
  92363. private _scaledGravity;
  92364. private _currentRenderId;
  92365. private _alive;
  92366. private _useInstancing;
  92367. private _started;
  92368. private _stopped;
  92369. private _actualFrame;
  92370. private _scaledUpdateSpeed;
  92371. private _vertexBufferSize;
  92372. /** @hidden */
  92373. _currentEmitRateGradient: Nullable<FactorGradient>;
  92374. /** @hidden */
  92375. _currentEmitRate1: number;
  92376. /** @hidden */
  92377. _currentEmitRate2: number;
  92378. /** @hidden */
  92379. _currentStartSizeGradient: Nullable<FactorGradient>;
  92380. /** @hidden */
  92381. _currentStartSize1: number;
  92382. /** @hidden */
  92383. _currentStartSize2: number;
  92384. private readonly _rawTextureWidth;
  92385. private _rampGradientsTexture;
  92386. private _useRampGradients;
  92387. /** Gets or sets a matrix to use to compute projection */
  92388. defaultProjectionMatrix: Matrix;
  92389. /** Gets or sets a matrix to use to compute view */
  92390. defaultViewMatrix: Matrix;
  92391. /** Gets or sets a boolean indicating that ramp gradients must be used
  92392. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  92393. */
  92394. get useRampGradients(): boolean;
  92395. set useRampGradients(value: boolean);
  92396. /**
  92397. * 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.
  92398. * 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: [])
  92399. */
  92400. subEmitters: Array<ParticleSystem | SubEmitter | Array<SubEmitter>>;
  92401. private _subEmitters;
  92402. /**
  92403. * @hidden
  92404. * If the particle systems emitter should be disposed when the particle system is disposed
  92405. */
  92406. _disposeEmitterOnDispose: boolean;
  92407. /**
  92408. * The current active Sub-systems, this property is used by the root particle system only.
  92409. */
  92410. activeSubSystems: Array<ParticleSystem>;
  92411. /**
  92412. * Specifies if the particles are updated in emitter local space or world space
  92413. */
  92414. isLocal: boolean;
  92415. private _rootParticleSystem;
  92416. /**
  92417. * Gets the current list of active particles
  92418. */
  92419. get particles(): Particle[];
  92420. /**
  92421. * Gets the number of particles active at the same time.
  92422. * @returns The number of active particles.
  92423. */
  92424. getActiveCount(): number;
  92425. /**
  92426. * Returns the string "ParticleSystem"
  92427. * @returns a string containing the class name
  92428. */
  92429. getClassName(): string;
  92430. /**
  92431. * Gets a boolean indicating that the system is stopping
  92432. * @returns true if the system is currently stopping
  92433. */
  92434. isStopping(): boolean;
  92435. /**
  92436. * Gets the custom effect used to render the particles
  92437. * @param blendMode Blend mode for which the effect should be retrieved
  92438. * @returns The effect
  92439. */
  92440. getCustomEffect(blendMode?: number): Nullable<Effect>;
  92441. /**
  92442. * Sets the custom effect used to render the particles
  92443. * @param effect The effect to set
  92444. * @param blendMode Blend mode for which the effect should be set
  92445. */
  92446. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  92447. /** @hidden */
  92448. private _onBeforeDrawParticlesObservable;
  92449. /**
  92450. * Observable that will be called just before the particles are drawn
  92451. */
  92452. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  92453. /**
  92454. * Gets the name of the particle vertex shader
  92455. */
  92456. get vertexShaderName(): string;
  92457. /**
  92458. * Instantiates a particle system.
  92459. * 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.
  92460. * @param name The name of the particle system
  92461. * @param capacity The max number of particles alive at the same time
  92462. * @param sceneOrEngine The scene the particle system belongs to or the engine to use if no scene
  92463. * @param customEffect a custom effect used to change the way particles are rendered by default
  92464. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  92465. * @param epsilon Offset used to render the particles
  92466. */
  92467. constructor(name: string, capacity: number, sceneOrEngine: Scene | ThinEngine, customEffect?: Nullable<Effect>, isAnimationSheetEnabled?: boolean, epsilon?: number);
  92468. private _addFactorGradient;
  92469. private _removeFactorGradient;
  92470. /**
  92471. * Adds a new life time gradient
  92472. * @param gradient defines the gradient to use (between 0 and 1)
  92473. * @param factor defines the life time factor to affect to the specified gradient
  92474. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92475. * @returns the current particle system
  92476. */
  92477. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92478. /**
  92479. * Remove a specific life time gradient
  92480. * @param gradient defines the gradient to remove
  92481. * @returns the current particle system
  92482. */
  92483. removeLifeTimeGradient(gradient: number): IParticleSystem;
  92484. /**
  92485. * Adds a new size gradient
  92486. * @param gradient defines the gradient to use (between 0 and 1)
  92487. * @param factor defines the size factor to affect to the specified gradient
  92488. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92489. * @returns the current particle system
  92490. */
  92491. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92492. /**
  92493. * Remove a specific size gradient
  92494. * @param gradient defines the gradient to remove
  92495. * @returns the current particle system
  92496. */
  92497. removeSizeGradient(gradient: number): IParticleSystem;
  92498. /**
  92499. * Adds a new color remap gradient
  92500. * @param gradient defines the gradient to use (between 0 and 1)
  92501. * @param min defines the color remap minimal range
  92502. * @param max defines the color remap maximal range
  92503. * @returns the current particle system
  92504. */
  92505. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  92506. /**
  92507. * Remove a specific color remap gradient
  92508. * @param gradient defines the gradient to remove
  92509. * @returns the current particle system
  92510. */
  92511. removeColorRemapGradient(gradient: number): IParticleSystem;
  92512. /**
  92513. * Adds a new alpha remap gradient
  92514. * @param gradient defines the gradient to use (between 0 and 1)
  92515. * @param min defines the alpha remap minimal range
  92516. * @param max defines the alpha remap maximal range
  92517. * @returns the current particle system
  92518. */
  92519. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  92520. /**
  92521. * Remove a specific alpha remap gradient
  92522. * @param gradient defines the gradient to remove
  92523. * @returns the current particle system
  92524. */
  92525. removeAlphaRemapGradient(gradient: number): IParticleSystem;
  92526. /**
  92527. * Adds a new angular speed gradient
  92528. * @param gradient defines the gradient to use (between 0 and 1)
  92529. * @param factor defines the angular speed to affect to the specified gradient
  92530. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92531. * @returns the current particle system
  92532. */
  92533. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92534. /**
  92535. * Remove a specific angular speed gradient
  92536. * @param gradient defines the gradient to remove
  92537. * @returns the current particle system
  92538. */
  92539. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  92540. /**
  92541. * Adds a new velocity gradient
  92542. * @param gradient defines the gradient to use (between 0 and 1)
  92543. * @param factor defines the velocity to affect to the specified gradient
  92544. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92545. * @returns the current particle system
  92546. */
  92547. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92548. /**
  92549. * Remove a specific velocity gradient
  92550. * @param gradient defines the gradient to remove
  92551. * @returns the current particle system
  92552. */
  92553. removeVelocityGradient(gradient: number): IParticleSystem;
  92554. /**
  92555. * Adds a new limit velocity gradient
  92556. * @param gradient defines the gradient to use (between 0 and 1)
  92557. * @param factor defines the limit velocity value to affect to the specified gradient
  92558. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92559. * @returns the current particle system
  92560. */
  92561. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92562. /**
  92563. * Remove a specific limit velocity gradient
  92564. * @param gradient defines the gradient to remove
  92565. * @returns the current particle system
  92566. */
  92567. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  92568. /**
  92569. * Adds a new drag gradient
  92570. * @param gradient defines the gradient to use (between 0 and 1)
  92571. * @param factor defines the drag value to affect to the specified gradient
  92572. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92573. * @returns the current particle system
  92574. */
  92575. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92576. /**
  92577. * Remove a specific drag gradient
  92578. * @param gradient defines the gradient to remove
  92579. * @returns the current particle system
  92580. */
  92581. removeDragGradient(gradient: number): IParticleSystem;
  92582. /**
  92583. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  92584. * @param gradient defines the gradient to use (between 0 and 1)
  92585. * @param factor defines the emit rate value to affect to the specified gradient
  92586. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92587. * @returns the current particle system
  92588. */
  92589. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92590. /**
  92591. * Remove a specific emit rate gradient
  92592. * @param gradient defines the gradient to remove
  92593. * @returns the current particle system
  92594. */
  92595. removeEmitRateGradient(gradient: number): IParticleSystem;
  92596. /**
  92597. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  92598. * @param gradient defines the gradient to use (between 0 and 1)
  92599. * @param factor defines the start size value to affect to the specified gradient
  92600. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92601. * @returns the current particle system
  92602. */
  92603. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92604. /**
  92605. * Remove a specific start size gradient
  92606. * @param gradient defines the gradient to remove
  92607. * @returns the current particle system
  92608. */
  92609. removeStartSizeGradient(gradient: number): IParticleSystem;
  92610. private _createRampGradientTexture;
  92611. /**
  92612. * Gets the current list of ramp gradients.
  92613. * You must use addRampGradient and removeRampGradient to udpate this list
  92614. * @returns the list of ramp gradients
  92615. */
  92616. getRampGradients(): Nullable<Array<Color3Gradient>>;
  92617. /** Force the system to rebuild all gradients that need to be resync */
  92618. forceRefreshGradients(): void;
  92619. private _syncRampGradientTexture;
  92620. /**
  92621. * Adds a new ramp gradient used to remap particle colors
  92622. * @param gradient defines the gradient to use (between 0 and 1)
  92623. * @param color defines the color to affect to the specified gradient
  92624. * @returns the current particle system
  92625. */
  92626. addRampGradient(gradient: number, color: Color3): ParticleSystem;
  92627. /**
  92628. * Remove a specific ramp gradient
  92629. * @param gradient defines the gradient to remove
  92630. * @returns the current particle system
  92631. */
  92632. removeRampGradient(gradient: number): ParticleSystem;
  92633. /**
  92634. * Adds a new color gradient
  92635. * @param gradient defines the gradient to use (between 0 and 1)
  92636. * @param color1 defines the color to affect to the specified gradient
  92637. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  92638. * @returns this particle system
  92639. */
  92640. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  92641. /**
  92642. * Remove a specific color gradient
  92643. * @param gradient defines the gradient to remove
  92644. * @returns this particle system
  92645. */
  92646. removeColorGradient(gradient: number): IParticleSystem;
  92647. private _fetchR;
  92648. protected _reset(): void;
  92649. private _resetEffect;
  92650. private _createVertexBuffers;
  92651. private _createIndexBuffer;
  92652. /**
  92653. * Gets the maximum number of particles active at the same time.
  92654. * @returns The max number of active particles.
  92655. */
  92656. getCapacity(): number;
  92657. /**
  92658. * Gets whether there are still active particles in the system.
  92659. * @returns True if it is alive, otherwise false.
  92660. */
  92661. isAlive(): boolean;
  92662. /**
  92663. * Gets if the system has been started. (Note: this will still be true after stop is called)
  92664. * @returns True if it has been started, otherwise false.
  92665. */
  92666. isStarted(): boolean;
  92667. private _prepareSubEmitterInternalArray;
  92668. /**
  92669. * Starts the particle system and begins to emit
  92670. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  92671. */
  92672. start(delay?: number): void;
  92673. /**
  92674. * Stops the particle system.
  92675. * @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.
  92676. */
  92677. stop(stopSubEmitters?: boolean): void;
  92678. /**
  92679. * Remove all active particles
  92680. */
  92681. reset(): void;
  92682. /**
  92683. * @hidden (for internal use only)
  92684. */
  92685. _appendParticleVertex(index: number, particle: Particle, offsetX: number, offsetY: number): void;
  92686. /**
  92687. * "Recycles" one of the particle by copying it back to the "stock" of particles and removing it from the active list.
  92688. * Its lifetime will start back at 0.
  92689. */
  92690. recycleParticle: (particle: Particle) => void;
  92691. private _stopSubEmitters;
  92692. private _createParticle;
  92693. private _removeFromRoot;
  92694. private _emitFromParticle;
  92695. private _update;
  92696. /** @hidden */
  92697. static _GetAttributeNamesOrOptions(isAnimationSheetEnabled?: boolean, isBillboardBased?: boolean, useRampGradients?: boolean): string[];
  92698. /** @hidden */
  92699. static _GetEffectCreationOptions(isAnimationSheetEnabled?: boolean): string[];
  92700. /**
  92701. * Fill the defines array according to the current settings of the particle system
  92702. * @param defines Array to be updated
  92703. * @param blendMode blend mode to take into account when updating the array
  92704. */
  92705. fillDefines(defines: Array<string>, blendMode: number): void;
  92706. /**
  92707. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  92708. * @param uniforms Uniforms array to fill
  92709. * @param attributes Attributes array to fill
  92710. * @param samplers Samplers array to fill
  92711. */
  92712. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  92713. /** @hidden */
  92714. private _getEffect;
  92715. /**
  92716. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  92717. * @param preWarmOnly will prevent the system from updating the vertex buffer (default is false)
  92718. */
  92719. animate(preWarmOnly?: boolean): void;
  92720. private _appendParticleVertices;
  92721. /**
  92722. * Rebuilds the particle system.
  92723. */
  92724. rebuild(): void;
  92725. /**
  92726. * Is this system ready to be used/rendered
  92727. * @return true if the system is ready
  92728. */
  92729. isReady(): boolean;
  92730. private _render;
  92731. /**
  92732. * Renders the particle system in its current state.
  92733. * @returns the current number of particles
  92734. */
  92735. render(): number;
  92736. /**
  92737. * Disposes the particle system and free the associated resources
  92738. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  92739. */
  92740. dispose(disposeTexture?: boolean): void;
  92741. /**
  92742. * Clones the particle system.
  92743. * @param name The name of the cloned object
  92744. * @param newEmitter The new emitter to use
  92745. * @returns the cloned particle system
  92746. */
  92747. clone(name: string, newEmitter: any): ParticleSystem;
  92748. /**
  92749. * Serializes the particle system to a JSON object
  92750. * @param serializeTexture defines if the texture must be serialized as well
  92751. * @returns the JSON object
  92752. */
  92753. serialize(serializeTexture?: boolean): any;
  92754. /** @hidden */
  92755. static _Serialize(serializationObject: any, particleSystem: IParticleSystem, serializeTexture: boolean): void;
  92756. /** @hidden */
  92757. static _Parse(parsedParticleSystem: any, particleSystem: IParticleSystem, sceneOrEngine: Scene | ThinEngine, rootUrl: string): void;
  92758. /**
  92759. * Parses a JSON object to create a particle system.
  92760. * @param parsedParticleSystem The JSON object to parse
  92761. * @param sceneOrEngine The scene or the engine to create the particle system in
  92762. * @param rootUrl The root url to use to load external dependencies like texture
  92763. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  92764. * @returns the Parsed particle system
  92765. */
  92766. static Parse(parsedParticleSystem: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string, doNotStart?: boolean): ParticleSystem;
  92767. }
  92768. }
  92769. declare module BABYLON {
  92770. /**
  92771. * A particle represents one of the element emitted by a particle system.
  92772. * This is mainly define by its coordinates, direction, velocity and age.
  92773. */
  92774. export class Particle {
  92775. /**
  92776. * The particle system the particle belongs to.
  92777. */
  92778. particleSystem: ParticleSystem;
  92779. private static _Count;
  92780. /**
  92781. * Unique ID of the particle
  92782. */
  92783. id: number;
  92784. /**
  92785. * The world position of the particle in the scene.
  92786. */
  92787. position: Vector3;
  92788. /**
  92789. * The world direction of the particle in the scene.
  92790. */
  92791. direction: Vector3;
  92792. /**
  92793. * The color of the particle.
  92794. */
  92795. color: Color4;
  92796. /**
  92797. * The color change of the particle per step.
  92798. */
  92799. colorStep: Color4;
  92800. /**
  92801. * Defines how long will the life of the particle be.
  92802. */
  92803. lifeTime: number;
  92804. /**
  92805. * The current age of the particle.
  92806. */
  92807. age: number;
  92808. /**
  92809. * The current size of the particle.
  92810. */
  92811. size: number;
  92812. /**
  92813. * The current scale of the particle.
  92814. */
  92815. scale: Vector2;
  92816. /**
  92817. * The current angle of the particle.
  92818. */
  92819. angle: number;
  92820. /**
  92821. * Defines how fast is the angle changing.
  92822. */
  92823. angularSpeed: number;
  92824. /**
  92825. * Defines the cell index used by the particle to be rendered from a sprite.
  92826. */
  92827. cellIndex: number;
  92828. /**
  92829. * The information required to support color remapping
  92830. */
  92831. remapData: Vector4;
  92832. /** @hidden */
  92833. _randomCellOffset?: number;
  92834. /** @hidden */
  92835. _initialDirection: Nullable<Vector3>;
  92836. /** @hidden */
  92837. _attachedSubEmitters: Nullable<Array<SubEmitter>>;
  92838. /** @hidden */
  92839. _initialStartSpriteCellID: number;
  92840. /** @hidden */
  92841. _initialEndSpriteCellID: number;
  92842. /** @hidden */
  92843. _currentColorGradient: Nullable<ColorGradient>;
  92844. /** @hidden */
  92845. _currentColor1: Color4;
  92846. /** @hidden */
  92847. _currentColor2: Color4;
  92848. /** @hidden */
  92849. _currentSizeGradient: Nullable<FactorGradient>;
  92850. /** @hidden */
  92851. _currentSize1: number;
  92852. /** @hidden */
  92853. _currentSize2: number;
  92854. /** @hidden */
  92855. _currentAngularSpeedGradient: Nullable<FactorGradient>;
  92856. /** @hidden */
  92857. _currentAngularSpeed1: number;
  92858. /** @hidden */
  92859. _currentAngularSpeed2: number;
  92860. /** @hidden */
  92861. _currentVelocityGradient: Nullable<FactorGradient>;
  92862. /** @hidden */
  92863. _currentVelocity1: number;
  92864. /** @hidden */
  92865. _currentVelocity2: number;
  92866. /** @hidden */
  92867. _currentLimitVelocityGradient: Nullable<FactorGradient>;
  92868. /** @hidden */
  92869. _currentLimitVelocity1: number;
  92870. /** @hidden */
  92871. _currentLimitVelocity2: number;
  92872. /** @hidden */
  92873. _currentDragGradient: Nullable<FactorGradient>;
  92874. /** @hidden */
  92875. _currentDrag1: number;
  92876. /** @hidden */
  92877. _currentDrag2: number;
  92878. /** @hidden */
  92879. _randomNoiseCoordinates1: Vector3;
  92880. /** @hidden */
  92881. _randomNoiseCoordinates2: Vector3;
  92882. /** @hidden */
  92883. _localPosition?: Vector3;
  92884. /**
  92885. * Creates a new instance Particle
  92886. * @param particleSystem the particle system the particle belongs to
  92887. */
  92888. constructor(
  92889. /**
  92890. * The particle system the particle belongs to.
  92891. */
  92892. particleSystem: ParticleSystem);
  92893. private updateCellInfoFromSystem;
  92894. /**
  92895. * Defines how the sprite cell index is updated for the particle
  92896. */
  92897. updateCellIndex(): void;
  92898. /** @hidden */
  92899. _inheritParticleInfoToSubEmitter(subEmitter: SubEmitter): void;
  92900. /** @hidden */
  92901. _inheritParticleInfoToSubEmitters(): void;
  92902. /** @hidden */
  92903. _reset(): void;
  92904. /**
  92905. * Copy the properties of particle to another one.
  92906. * @param other the particle to copy the information to.
  92907. */
  92908. copyTo(other: Particle): void;
  92909. }
  92910. }
  92911. declare module BABYLON {
  92912. /**
  92913. * Particle emitter represents a volume emitting particles.
  92914. * This is the responsibility of the implementation to define the volume shape like cone/sphere/box.
  92915. */
  92916. export interface IParticleEmitterType {
  92917. /**
  92918. * Called by the particle System when the direction is computed for the created particle.
  92919. * @param worldMatrix is the world matrix of the particle system
  92920. * @param directionToUpdate is the direction vector to update with the result
  92921. * @param particle is the particle we are computed the direction for
  92922. * @param isLocal defines if the direction should be set in local space
  92923. */
  92924. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92925. /**
  92926. * Called by the particle System when the position is computed for the created particle.
  92927. * @param worldMatrix is the world matrix of the particle system
  92928. * @param positionToUpdate is the position vector to update with the result
  92929. * @param particle is the particle we are computed the position for
  92930. * @param isLocal defines if the position should be set in local space
  92931. */
  92932. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92933. /**
  92934. * Clones the current emitter and returns a copy of it
  92935. * @returns the new emitter
  92936. */
  92937. clone(): IParticleEmitterType;
  92938. /**
  92939. * Called by the GPUParticleSystem to setup the update shader
  92940. * @param effect defines the update shader
  92941. */
  92942. applyToShader(effect: Effect): void;
  92943. /**
  92944. * Returns a string to use to update the GPU particles update shader
  92945. * @returns the effect defines string
  92946. */
  92947. getEffectDefines(): string;
  92948. /**
  92949. * Returns a string representing the class name
  92950. * @returns a string containing the class name
  92951. */
  92952. getClassName(): string;
  92953. /**
  92954. * Serializes the particle system to a JSON object.
  92955. * @returns the JSON object
  92956. */
  92957. serialize(): any;
  92958. /**
  92959. * Parse properties from a JSON object
  92960. * @param serializationObject defines the JSON object
  92961. * @param scene defines the hosting scene
  92962. */
  92963. parse(serializationObject: any, scene: Nullable<Scene>): void;
  92964. }
  92965. }
  92966. declare module BABYLON {
  92967. /**
  92968. * Particle emitter emitting particles from the inside of a box.
  92969. * It emits the particles randomly between 2 given directions.
  92970. */
  92971. export class BoxParticleEmitter implements IParticleEmitterType {
  92972. /**
  92973. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  92974. */
  92975. direction1: Vector3;
  92976. /**
  92977. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  92978. */
  92979. direction2: Vector3;
  92980. /**
  92981. * 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.
  92982. */
  92983. minEmitBox: Vector3;
  92984. /**
  92985. * 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.
  92986. */
  92987. maxEmitBox: Vector3;
  92988. /**
  92989. * Creates a new instance BoxParticleEmitter
  92990. */
  92991. constructor();
  92992. /**
  92993. * Called by the particle System when the direction is computed for the created particle.
  92994. * @param worldMatrix is the world matrix of the particle system
  92995. * @param directionToUpdate is the direction vector to update with the result
  92996. * @param particle is the particle we are computed the direction for
  92997. * @param isLocal defines if the direction should be set in local space
  92998. */
  92999. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93000. /**
  93001. * Called by the particle System when the position is computed for the created particle.
  93002. * @param worldMatrix is the world matrix of the particle system
  93003. * @param positionToUpdate is the position vector to update with the result
  93004. * @param particle is the particle we are computed the position for
  93005. * @param isLocal defines if the position should be set in local space
  93006. */
  93007. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93008. /**
  93009. * Clones the current emitter and returns a copy of it
  93010. * @returns the new emitter
  93011. */
  93012. clone(): BoxParticleEmitter;
  93013. /**
  93014. * Called by the GPUParticleSystem to setup the update shader
  93015. * @param effect defines the update shader
  93016. */
  93017. applyToShader(effect: Effect): void;
  93018. /**
  93019. * Returns a string to use to update the GPU particles update shader
  93020. * @returns a string containng the defines string
  93021. */
  93022. getEffectDefines(): string;
  93023. /**
  93024. * Returns the string "BoxParticleEmitter"
  93025. * @returns a string containing the class name
  93026. */
  93027. getClassName(): string;
  93028. /**
  93029. * Serializes the particle system to a JSON object.
  93030. * @returns the JSON object
  93031. */
  93032. serialize(): any;
  93033. /**
  93034. * Parse properties from a JSON object
  93035. * @param serializationObject defines the JSON object
  93036. */
  93037. parse(serializationObject: any): void;
  93038. }
  93039. }
  93040. declare module BABYLON {
  93041. /**
  93042. * Particle emitter emitting particles from the inside of a cone.
  93043. * It emits the particles alongside the cone volume from the base to the particle.
  93044. * The emission direction might be randomized.
  93045. */
  93046. export class ConeParticleEmitter implements IParticleEmitterType {
  93047. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  93048. directionRandomizer: number;
  93049. private _radius;
  93050. private _angle;
  93051. private _height;
  93052. /**
  93053. * Gets or sets a value indicating where on the radius the start position should be picked (1 = everywhere, 0 = only surface)
  93054. */
  93055. radiusRange: number;
  93056. /**
  93057. * Gets or sets a value indicating where on the height the start position should be picked (1 = everywhere, 0 = only surface)
  93058. */
  93059. heightRange: number;
  93060. /**
  93061. * Gets or sets a value indicating if all the particles should be emitted from the spawn point only (the base of the cone)
  93062. */
  93063. emitFromSpawnPointOnly: boolean;
  93064. /**
  93065. * Gets or sets the radius of the emission cone
  93066. */
  93067. get radius(): number;
  93068. set radius(value: number);
  93069. /**
  93070. * Gets or sets the angle of the emission cone
  93071. */
  93072. get angle(): number;
  93073. set angle(value: number);
  93074. private _buildHeight;
  93075. /**
  93076. * Creates a new instance ConeParticleEmitter
  93077. * @param radius the radius of the emission cone (1 by default)
  93078. * @param angle the cone base angle (PI by default)
  93079. * @param directionRandomizer defines how much to randomize the particle direction [0-1] (default is 0)
  93080. */
  93081. constructor(radius?: number, angle?: number,
  93082. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  93083. directionRandomizer?: number);
  93084. /**
  93085. * Called by the particle System when the direction is computed for the created particle.
  93086. * @param worldMatrix is the world matrix of the particle system
  93087. * @param directionToUpdate is the direction vector to update with the result
  93088. * @param particle is the particle we are computed the direction for
  93089. * @param isLocal defines if the direction should be set in local space
  93090. */
  93091. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93092. /**
  93093. * Called by the particle System when the position is computed for the created particle.
  93094. * @param worldMatrix is the world matrix of the particle system
  93095. * @param positionToUpdate is the position vector to update with the result
  93096. * @param particle is the particle we are computed the position for
  93097. * @param isLocal defines if the position should be set in local space
  93098. */
  93099. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93100. /**
  93101. * Clones the current emitter and returns a copy of it
  93102. * @returns the new emitter
  93103. */
  93104. clone(): ConeParticleEmitter;
  93105. /**
  93106. * Called by the GPUParticleSystem to setup the update shader
  93107. * @param effect defines the update shader
  93108. */
  93109. applyToShader(effect: Effect): void;
  93110. /**
  93111. * Returns a string to use to update the GPU particles update shader
  93112. * @returns a string containng the defines string
  93113. */
  93114. getEffectDefines(): string;
  93115. /**
  93116. * Returns the string "ConeParticleEmitter"
  93117. * @returns a string containing the class name
  93118. */
  93119. getClassName(): string;
  93120. /**
  93121. * Serializes the particle system to a JSON object.
  93122. * @returns the JSON object
  93123. */
  93124. serialize(): any;
  93125. /**
  93126. * Parse properties from a JSON object
  93127. * @param serializationObject defines the JSON object
  93128. */
  93129. parse(serializationObject: any): void;
  93130. }
  93131. }
  93132. declare module BABYLON {
  93133. /**
  93134. * Particle emitter emitting particles from the inside of a cylinder.
  93135. * It emits the particles alongside the cylinder radius. The emission direction might be randomized.
  93136. */
  93137. export class CylinderParticleEmitter implements IParticleEmitterType {
  93138. /**
  93139. * The radius of the emission cylinder.
  93140. */
  93141. radius: number;
  93142. /**
  93143. * The height of the emission cylinder.
  93144. */
  93145. height: number;
  93146. /**
  93147. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93148. */
  93149. radiusRange: number;
  93150. /**
  93151. * How much to randomize the particle direction [0-1].
  93152. */
  93153. directionRandomizer: number;
  93154. /**
  93155. * Creates a new instance CylinderParticleEmitter
  93156. * @param radius the radius of the emission cylinder (1 by default)
  93157. * @param height the height of the emission cylinder (1 by default)
  93158. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  93159. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  93160. */
  93161. constructor(
  93162. /**
  93163. * The radius of the emission cylinder.
  93164. */
  93165. radius?: number,
  93166. /**
  93167. * The height of the emission cylinder.
  93168. */
  93169. height?: number,
  93170. /**
  93171. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93172. */
  93173. radiusRange?: number,
  93174. /**
  93175. * How much to randomize the particle direction [0-1].
  93176. */
  93177. directionRandomizer?: number);
  93178. /**
  93179. * Called by the particle System when the direction is computed for the created particle.
  93180. * @param worldMatrix is the world matrix of the particle system
  93181. * @param directionToUpdate is the direction vector to update with the result
  93182. * @param particle is the particle we are computed the direction for
  93183. * @param isLocal defines if the direction should be set in local space
  93184. */
  93185. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93186. /**
  93187. * Called by the particle System when the position is computed for the created particle.
  93188. * @param worldMatrix is the world matrix of the particle system
  93189. * @param positionToUpdate is the position vector to update with the result
  93190. * @param particle is the particle we are computed the position for
  93191. * @param isLocal defines if the position should be set in local space
  93192. */
  93193. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93194. /**
  93195. * Clones the current emitter and returns a copy of it
  93196. * @returns the new emitter
  93197. */
  93198. clone(): CylinderParticleEmitter;
  93199. /**
  93200. * Called by the GPUParticleSystem to setup the update shader
  93201. * @param effect defines the update shader
  93202. */
  93203. applyToShader(effect: Effect): void;
  93204. /**
  93205. * Returns a string to use to update the GPU particles update shader
  93206. * @returns a string containng the defines string
  93207. */
  93208. getEffectDefines(): string;
  93209. /**
  93210. * Returns the string "CylinderParticleEmitter"
  93211. * @returns a string containing the class name
  93212. */
  93213. getClassName(): string;
  93214. /**
  93215. * Serializes the particle system to a JSON object.
  93216. * @returns the JSON object
  93217. */
  93218. serialize(): any;
  93219. /**
  93220. * Parse properties from a JSON object
  93221. * @param serializationObject defines the JSON object
  93222. */
  93223. parse(serializationObject: any): void;
  93224. }
  93225. /**
  93226. * Particle emitter emitting particles from the inside of a cylinder.
  93227. * It emits the particles randomly between two vectors.
  93228. */
  93229. export class CylinderDirectedParticleEmitter extends CylinderParticleEmitter {
  93230. /**
  93231. * The min limit of the emission direction.
  93232. */
  93233. direction1: Vector3;
  93234. /**
  93235. * The max limit of the emission direction.
  93236. */
  93237. direction2: Vector3;
  93238. /**
  93239. * Creates a new instance CylinderDirectedParticleEmitter
  93240. * @param radius the radius of the emission cylinder (1 by default)
  93241. * @param height the height of the emission cylinder (1 by default)
  93242. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  93243. * @param direction1 the min limit of the emission direction (up vector by default)
  93244. * @param direction2 the max limit of the emission direction (up vector by default)
  93245. */
  93246. constructor(radius?: number, height?: number, radiusRange?: number,
  93247. /**
  93248. * The min limit of the emission direction.
  93249. */
  93250. direction1?: Vector3,
  93251. /**
  93252. * The max limit of the emission direction.
  93253. */
  93254. direction2?: Vector3);
  93255. /**
  93256. * Called by the particle System when the direction is computed for the created particle.
  93257. * @param worldMatrix is the world matrix of the particle system
  93258. * @param directionToUpdate is the direction vector to update with the result
  93259. * @param particle is the particle we are computed the direction for
  93260. */
  93261. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  93262. /**
  93263. * Clones the current emitter and returns a copy of it
  93264. * @returns the new emitter
  93265. */
  93266. clone(): CylinderDirectedParticleEmitter;
  93267. /**
  93268. * Called by the GPUParticleSystem to setup the update shader
  93269. * @param effect defines the update shader
  93270. */
  93271. applyToShader(effect: Effect): void;
  93272. /**
  93273. * Returns a string to use to update the GPU particles update shader
  93274. * @returns a string containng the defines string
  93275. */
  93276. getEffectDefines(): string;
  93277. /**
  93278. * Returns the string "CylinderDirectedParticleEmitter"
  93279. * @returns a string containing the class name
  93280. */
  93281. getClassName(): string;
  93282. /**
  93283. * Serializes the particle system to a JSON object.
  93284. * @returns the JSON object
  93285. */
  93286. serialize(): any;
  93287. /**
  93288. * Parse properties from a JSON object
  93289. * @param serializationObject defines the JSON object
  93290. */
  93291. parse(serializationObject: any): void;
  93292. }
  93293. }
  93294. declare module BABYLON {
  93295. /**
  93296. * Particle emitter emitting particles from the inside of a hemisphere.
  93297. * It emits the particles alongside the hemisphere radius. The emission direction might be randomized.
  93298. */
  93299. export class HemisphericParticleEmitter implements IParticleEmitterType {
  93300. /**
  93301. * The radius of the emission hemisphere.
  93302. */
  93303. radius: number;
  93304. /**
  93305. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93306. */
  93307. radiusRange: number;
  93308. /**
  93309. * How much to randomize the particle direction [0-1].
  93310. */
  93311. directionRandomizer: number;
  93312. /**
  93313. * Creates a new instance HemisphericParticleEmitter
  93314. * @param radius the radius of the emission hemisphere (1 by default)
  93315. * @param radiusRange the range of the emission hemisphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  93316. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  93317. */
  93318. constructor(
  93319. /**
  93320. * The radius of the emission hemisphere.
  93321. */
  93322. radius?: number,
  93323. /**
  93324. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93325. */
  93326. radiusRange?: number,
  93327. /**
  93328. * How much to randomize the particle direction [0-1].
  93329. */
  93330. directionRandomizer?: number);
  93331. /**
  93332. * Called by the particle System when the direction is computed for the created particle.
  93333. * @param worldMatrix is the world matrix of the particle system
  93334. * @param directionToUpdate is the direction vector to update with the result
  93335. * @param particle is the particle we are computed the direction for
  93336. * @param isLocal defines if the direction should be set in local space
  93337. */
  93338. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93339. /**
  93340. * Called by the particle System when the position is computed for the created particle.
  93341. * @param worldMatrix is the world matrix of the particle system
  93342. * @param positionToUpdate is the position vector to update with the result
  93343. * @param particle is the particle we are computed the position for
  93344. * @param isLocal defines if the position should be set in local space
  93345. */
  93346. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93347. /**
  93348. * Clones the current emitter and returns a copy of it
  93349. * @returns the new emitter
  93350. */
  93351. clone(): HemisphericParticleEmitter;
  93352. /**
  93353. * Called by the GPUParticleSystem to setup the update shader
  93354. * @param effect defines the update shader
  93355. */
  93356. applyToShader(effect: Effect): void;
  93357. /**
  93358. * Returns a string to use to update the GPU particles update shader
  93359. * @returns a string containng the defines string
  93360. */
  93361. getEffectDefines(): string;
  93362. /**
  93363. * Returns the string "HemisphericParticleEmitter"
  93364. * @returns a string containing the class name
  93365. */
  93366. getClassName(): string;
  93367. /**
  93368. * Serializes the particle system to a JSON object.
  93369. * @returns the JSON object
  93370. */
  93371. serialize(): any;
  93372. /**
  93373. * Parse properties from a JSON object
  93374. * @param serializationObject defines the JSON object
  93375. */
  93376. parse(serializationObject: any): void;
  93377. }
  93378. }
  93379. declare module BABYLON {
  93380. /**
  93381. * Particle emitter emitting particles from a point.
  93382. * It emits the particles randomly between 2 given directions.
  93383. */
  93384. export class PointParticleEmitter implements IParticleEmitterType {
  93385. /**
  93386. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  93387. */
  93388. direction1: Vector3;
  93389. /**
  93390. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  93391. */
  93392. direction2: Vector3;
  93393. /**
  93394. * Creates a new instance PointParticleEmitter
  93395. */
  93396. constructor();
  93397. /**
  93398. * Called by the particle System when the direction is computed for the created particle.
  93399. * @param worldMatrix is the world matrix of the particle system
  93400. * @param directionToUpdate is the direction vector to update with the result
  93401. * @param particle is the particle we are computed the direction for
  93402. * @param isLocal defines if the direction should be set in local space
  93403. */
  93404. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93405. /**
  93406. * Called by the particle System when the position is computed for the created particle.
  93407. * @param worldMatrix is the world matrix of the particle system
  93408. * @param positionToUpdate is the position vector to update with the result
  93409. * @param particle is the particle we are computed the position for
  93410. * @param isLocal defines if the position should be set in local space
  93411. */
  93412. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93413. /**
  93414. * Clones the current emitter and returns a copy of it
  93415. * @returns the new emitter
  93416. */
  93417. clone(): PointParticleEmitter;
  93418. /**
  93419. * Called by the GPUParticleSystem to setup the update shader
  93420. * @param effect defines the update shader
  93421. */
  93422. applyToShader(effect: Effect): void;
  93423. /**
  93424. * Returns a string to use to update the GPU particles update shader
  93425. * @returns a string containng the defines string
  93426. */
  93427. getEffectDefines(): string;
  93428. /**
  93429. * Returns the string "PointParticleEmitter"
  93430. * @returns a string containing the class name
  93431. */
  93432. getClassName(): string;
  93433. /**
  93434. * Serializes the particle system to a JSON object.
  93435. * @returns the JSON object
  93436. */
  93437. serialize(): any;
  93438. /**
  93439. * Parse properties from a JSON object
  93440. * @param serializationObject defines the JSON object
  93441. */
  93442. parse(serializationObject: any): void;
  93443. }
  93444. }
  93445. declare module BABYLON {
  93446. /**
  93447. * Particle emitter emitting particles from the inside of a sphere.
  93448. * It emits the particles alongside the sphere radius. The emission direction might be randomized.
  93449. */
  93450. export class SphereParticleEmitter implements IParticleEmitterType {
  93451. /**
  93452. * The radius of the emission sphere.
  93453. */
  93454. radius: number;
  93455. /**
  93456. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93457. */
  93458. radiusRange: number;
  93459. /**
  93460. * How much to randomize the particle direction [0-1].
  93461. */
  93462. directionRandomizer: number;
  93463. /**
  93464. * Creates a new instance SphereParticleEmitter
  93465. * @param radius the radius of the emission sphere (1 by default)
  93466. * @param radiusRange the range of the emission sphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  93467. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  93468. */
  93469. constructor(
  93470. /**
  93471. * The radius of the emission sphere.
  93472. */
  93473. radius?: number,
  93474. /**
  93475. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93476. */
  93477. radiusRange?: number,
  93478. /**
  93479. * How much to randomize the particle direction [0-1].
  93480. */
  93481. directionRandomizer?: number);
  93482. /**
  93483. * Called by the particle System when the direction is computed for the created particle.
  93484. * @param worldMatrix is the world matrix of the particle system
  93485. * @param directionToUpdate is the direction vector to update with the result
  93486. * @param particle is the particle we are computed the direction for
  93487. * @param isLocal defines if the direction should be set in local space
  93488. */
  93489. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93490. /**
  93491. * Called by the particle System when the position is computed for the created particle.
  93492. * @param worldMatrix is the world matrix of the particle system
  93493. * @param positionToUpdate is the position vector to update with the result
  93494. * @param particle is the particle we are computed the position for
  93495. * @param isLocal defines if the position should be set in local space
  93496. */
  93497. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93498. /**
  93499. * Clones the current emitter and returns a copy of it
  93500. * @returns the new emitter
  93501. */
  93502. clone(): SphereParticleEmitter;
  93503. /**
  93504. * Called by the GPUParticleSystem to setup the update shader
  93505. * @param effect defines the update shader
  93506. */
  93507. applyToShader(effect: Effect): void;
  93508. /**
  93509. * Returns a string to use to update the GPU particles update shader
  93510. * @returns a string containng the defines string
  93511. */
  93512. getEffectDefines(): string;
  93513. /**
  93514. * Returns the string "SphereParticleEmitter"
  93515. * @returns a string containing the class name
  93516. */
  93517. getClassName(): string;
  93518. /**
  93519. * Serializes the particle system to a JSON object.
  93520. * @returns the JSON object
  93521. */
  93522. serialize(): any;
  93523. /**
  93524. * Parse properties from a JSON object
  93525. * @param serializationObject defines the JSON object
  93526. */
  93527. parse(serializationObject: any): void;
  93528. }
  93529. /**
  93530. * Particle emitter emitting particles from the inside of a sphere.
  93531. * It emits the particles randomly between two vectors.
  93532. */
  93533. export class SphereDirectedParticleEmitter extends SphereParticleEmitter {
  93534. /**
  93535. * The min limit of the emission direction.
  93536. */
  93537. direction1: Vector3;
  93538. /**
  93539. * The max limit of the emission direction.
  93540. */
  93541. direction2: Vector3;
  93542. /**
  93543. * Creates a new instance SphereDirectedParticleEmitter
  93544. * @param radius the radius of the emission sphere (1 by default)
  93545. * @param direction1 the min limit of the emission direction (up vector by default)
  93546. * @param direction2 the max limit of the emission direction (up vector by default)
  93547. */
  93548. constructor(radius?: number,
  93549. /**
  93550. * The min limit of the emission direction.
  93551. */
  93552. direction1?: Vector3,
  93553. /**
  93554. * The max limit of the emission direction.
  93555. */
  93556. direction2?: Vector3);
  93557. /**
  93558. * Called by the particle System when the direction is computed for the created particle.
  93559. * @param worldMatrix is the world matrix of the particle system
  93560. * @param directionToUpdate is the direction vector to update with the result
  93561. * @param particle is the particle we are computed the direction for
  93562. */
  93563. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  93564. /**
  93565. * Clones the current emitter and returns a copy of it
  93566. * @returns the new emitter
  93567. */
  93568. clone(): SphereDirectedParticleEmitter;
  93569. /**
  93570. * Called by the GPUParticleSystem to setup the update shader
  93571. * @param effect defines the update shader
  93572. */
  93573. applyToShader(effect: Effect): void;
  93574. /**
  93575. * Returns a string to use to update the GPU particles update shader
  93576. * @returns a string containng the defines string
  93577. */
  93578. getEffectDefines(): string;
  93579. /**
  93580. * Returns the string "SphereDirectedParticleEmitter"
  93581. * @returns a string containing the class name
  93582. */
  93583. getClassName(): string;
  93584. /**
  93585. * Serializes the particle system to a JSON object.
  93586. * @returns the JSON object
  93587. */
  93588. serialize(): any;
  93589. /**
  93590. * Parse properties from a JSON object
  93591. * @param serializationObject defines the JSON object
  93592. */
  93593. parse(serializationObject: any): void;
  93594. }
  93595. }
  93596. declare module BABYLON {
  93597. /**
  93598. * Particle emitter emitting particles from a custom list of positions.
  93599. */
  93600. export class CustomParticleEmitter implements IParticleEmitterType {
  93601. /**
  93602. * Gets or sets the position generator that will create the inital position of each particle.
  93603. * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  93604. */
  93605. particlePositionGenerator: (index: number, particle: Nullable<Particle>, outPosition: Vector3) => void;
  93606. /**
  93607. * Gets or sets the destination generator that will create the final destination of each particle.
  93608. * * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  93609. */
  93610. particleDestinationGenerator: (index: number, particle: Nullable<Particle>, outDestination: Vector3) => void;
  93611. /**
  93612. * Creates a new instance CustomParticleEmitter
  93613. */
  93614. constructor();
  93615. /**
  93616. * Called by the particle System when the direction is computed for the created particle.
  93617. * @param worldMatrix is the world matrix of the particle system
  93618. * @param directionToUpdate is the direction vector to update with the result
  93619. * @param particle is the particle we are computed the direction for
  93620. * @param isLocal defines if the direction should be set in local space
  93621. */
  93622. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93623. /**
  93624. * Called by the particle System when the position is computed for the created particle.
  93625. * @param worldMatrix is the world matrix of the particle system
  93626. * @param positionToUpdate is the position vector to update with the result
  93627. * @param particle is the particle we are computed the position for
  93628. * @param isLocal defines if the position should be set in local space
  93629. */
  93630. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93631. /**
  93632. * Clones the current emitter and returns a copy of it
  93633. * @returns the new emitter
  93634. */
  93635. clone(): CustomParticleEmitter;
  93636. /**
  93637. * Called by the GPUParticleSystem to setup the update shader
  93638. * @param effect defines the update shader
  93639. */
  93640. applyToShader(effect: Effect): void;
  93641. /**
  93642. * Returns a string to use to update the GPU particles update shader
  93643. * @returns a string containng the defines string
  93644. */
  93645. getEffectDefines(): string;
  93646. /**
  93647. * Returns the string "PointParticleEmitter"
  93648. * @returns a string containing the class name
  93649. */
  93650. getClassName(): string;
  93651. /**
  93652. * Serializes the particle system to a JSON object.
  93653. * @returns the JSON object
  93654. */
  93655. serialize(): any;
  93656. /**
  93657. * Parse properties from a JSON object
  93658. * @param serializationObject defines the JSON object
  93659. */
  93660. parse(serializationObject: any): void;
  93661. }
  93662. }
  93663. declare module BABYLON {
  93664. /**
  93665. * Particle emitter emitting particles from the inside of a box.
  93666. * It emits the particles randomly between 2 given directions.
  93667. */
  93668. export class MeshParticleEmitter implements IParticleEmitterType {
  93669. private _indices;
  93670. private _positions;
  93671. private _normals;
  93672. private _storedNormal;
  93673. private _mesh;
  93674. /**
  93675. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  93676. */
  93677. direction1: Vector3;
  93678. /**
  93679. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  93680. */
  93681. direction2: Vector3;
  93682. /**
  93683. * Gets or sets a boolean indicating that particle directions must be built from mesh face normals
  93684. */
  93685. useMeshNormalsForDirection: boolean;
  93686. /** Defines the mesh to use as source */
  93687. get mesh(): Nullable<AbstractMesh>;
  93688. set mesh(value: Nullable<AbstractMesh>);
  93689. /**
  93690. * Creates a new instance MeshParticleEmitter
  93691. * @param mesh defines the mesh to use as source
  93692. */
  93693. constructor(mesh?: Nullable<AbstractMesh>);
  93694. /**
  93695. * Called by the particle System when the direction is computed for the created particle.
  93696. * @param worldMatrix is the world matrix of the particle system
  93697. * @param directionToUpdate is the direction vector to update with the result
  93698. * @param particle is the particle we are computed the direction for
  93699. * @param isLocal defines if the direction should be set in local space
  93700. */
  93701. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93702. /**
  93703. * Called by the particle System when the position is computed for the created particle.
  93704. * @param worldMatrix is the world matrix of the particle system
  93705. * @param positionToUpdate is the position vector to update with the result
  93706. * @param particle is the particle we are computed the position for
  93707. * @param isLocal defines if the position should be set in local space
  93708. */
  93709. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93710. /**
  93711. * Clones the current emitter and returns a copy of it
  93712. * @returns the new emitter
  93713. */
  93714. clone(): MeshParticleEmitter;
  93715. /**
  93716. * Called by the GPUParticleSystem to setup the update shader
  93717. * @param effect defines the update shader
  93718. */
  93719. applyToShader(effect: Effect): void;
  93720. /**
  93721. * Returns a string to use to update the GPU particles update shader
  93722. * @returns a string containng the defines string
  93723. */
  93724. getEffectDefines(): string;
  93725. /**
  93726. * Returns the string "BoxParticleEmitter"
  93727. * @returns a string containing the class name
  93728. */
  93729. getClassName(): string;
  93730. /**
  93731. * Serializes the particle system to a JSON object.
  93732. * @returns the JSON object
  93733. */
  93734. serialize(): any;
  93735. /**
  93736. * Parse properties from a JSON object
  93737. * @param serializationObject defines the JSON object
  93738. * @param scene defines the hosting scene
  93739. */
  93740. parse(serializationObject: any, scene: Nullable<Scene>): void;
  93741. }
  93742. }
  93743. declare module BABYLON {
  93744. /**
  93745. * Interface representing a particle system in Babylon.js.
  93746. * This groups the common functionalities that needs to be implemented in order to create a particle system.
  93747. * A particle system represents a way to manage particles from their emission to their animation and rendering.
  93748. */
  93749. export interface IParticleSystem {
  93750. /**
  93751. * List of animations used by the particle system.
  93752. */
  93753. animations: Animation[];
  93754. /**
  93755. * The id of the Particle system.
  93756. */
  93757. id: string;
  93758. /**
  93759. * The name of the Particle system.
  93760. */
  93761. name: string;
  93762. /**
  93763. * The emitter represents the Mesh or position we are attaching the particle system to.
  93764. */
  93765. emitter: Nullable<AbstractMesh | Vector3>;
  93766. /**
  93767. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  93768. */
  93769. isBillboardBased: boolean;
  93770. /**
  93771. * The rendering group used by the Particle system to chose when to render.
  93772. */
  93773. renderingGroupId: number;
  93774. /**
  93775. * The layer mask we are rendering the particles through.
  93776. */
  93777. layerMask: number;
  93778. /**
  93779. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  93780. */
  93781. updateSpeed: number;
  93782. /**
  93783. * The amount of time the particle system is running (depends of the overall update speed).
  93784. */
  93785. targetStopDuration: number;
  93786. /**
  93787. * The texture used to render each particle. (this can be a spritesheet)
  93788. */
  93789. particleTexture: Nullable<BaseTexture>;
  93790. /**
  93791. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE, ParticleSystem.BLENDMODE_STANDARD or ParticleSystem.BLENDMODE_ADD.
  93792. */
  93793. blendMode: number;
  93794. /**
  93795. * Minimum life time of emitting particles.
  93796. */
  93797. minLifeTime: number;
  93798. /**
  93799. * Maximum life time of emitting particles.
  93800. */
  93801. maxLifeTime: number;
  93802. /**
  93803. * Minimum Size of emitting particles.
  93804. */
  93805. minSize: number;
  93806. /**
  93807. * Maximum Size of emitting particles.
  93808. */
  93809. maxSize: number;
  93810. /**
  93811. * Minimum scale of emitting particles on X axis.
  93812. */
  93813. minScaleX: number;
  93814. /**
  93815. * Maximum scale of emitting particles on X axis.
  93816. */
  93817. maxScaleX: number;
  93818. /**
  93819. * Minimum scale of emitting particles on Y axis.
  93820. */
  93821. minScaleY: number;
  93822. /**
  93823. * Maximum scale of emitting particles on Y axis.
  93824. */
  93825. maxScaleY: number;
  93826. /**
  93827. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  93828. */
  93829. color1: Color4;
  93830. /**
  93831. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  93832. */
  93833. color2: Color4;
  93834. /**
  93835. * Color the particle will have at the end of its lifetime.
  93836. */
  93837. colorDead: Color4;
  93838. /**
  93839. * The maximum number of particles to emit per frame until we reach the activeParticleCount value
  93840. */
  93841. emitRate: number;
  93842. /**
  93843. * You can use gravity if you want to give an orientation to your particles.
  93844. */
  93845. gravity: Vector3;
  93846. /**
  93847. * Minimum power of emitting particles.
  93848. */
  93849. minEmitPower: number;
  93850. /**
  93851. * Maximum power of emitting particles.
  93852. */
  93853. maxEmitPower: number;
  93854. /**
  93855. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  93856. */
  93857. minAngularSpeed: number;
  93858. /**
  93859. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  93860. */
  93861. maxAngularSpeed: number;
  93862. /**
  93863. * Gets or sets the minimal initial rotation in radians.
  93864. */
  93865. minInitialRotation: number;
  93866. /**
  93867. * Gets or sets the maximal initial rotation in radians.
  93868. */
  93869. maxInitialRotation: number;
  93870. /**
  93871. * The particle emitter type defines the emitter used by the particle system.
  93872. * It can be for example box, sphere, or cone...
  93873. */
  93874. particleEmitterType: Nullable<IParticleEmitterType>;
  93875. /**
  93876. * Defines the delay in milliseconds before starting the system (0 by default)
  93877. */
  93878. startDelay: number;
  93879. /**
  93880. * 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
  93881. */
  93882. preWarmCycles: number;
  93883. /**
  93884. * Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1)
  93885. */
  93886. preWarmStepOffset: number;
  93887. /**
  93888. * 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)
  93889. */
  93890. spriteCellChangeSpeed: number;
  93891. /**
  93892. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  93893. */
  93894. startSpriteCellID: number;
  93895. /**
  93896. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  93897. */
  93898. endSpriteCellID: number;
  93899. /**
  93900. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  93901. */
  93902. spriteCellWidth: number;
  93903. /**
  93904. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  93905. */
  93906. spriteCellHeight: number;
  93907. /**
  93908. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  93909. */
  93910. spriteRandomStartCell: boolean;
  93911. /**
  93912. * Gets or sets a boolean indicating if a spritesheet is used to animate the particles texture
  93913. */
  93914. isAnimationSheetEnabled: boolean;
  93915. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  93916. translationPivot: Vector2;
  93917. /**
  93918. * Gets or sets a texture used to add random noise to particle positions
  93919. */
  93920. noiseTexture: Nullable<BaseTexture>;
  93921. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  93922. noiseStrength: Vector3;
  93923. /**
  93924. * Gets or sets the billboard mode to use when isBillboardBased = true.
  93925. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  93926. */
  93927. billboardMode: number;
  93928. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  93929. limitVelocityDamping: number;
  93930. /**
  93931. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  93932. */
  93933. beginAnimationOnStart: boolean;
  93934. /**
  93935. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  93936. */
  93937. beginAnimationFrom: number;
  93938. /**
  93939. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  93940. */
  93941. beginAnimationTo: number;
  93942. /**
  93943. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  93944. */
  93945. beginAnimationLoop: boolean;
  93946. /**
  93947. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  93948. */
  93949. disposeOnStop: boolean;
  93950. /**
  93951. * Specifies if the particles are updated in emitter local space or world space
  93952. */
  93953. isLocal: boolean;
  93954. /** Snippet ID if the particle system was created from the snippet server */
  93955. snippetId: string;
  93956. /** Gets or sets a matrix to use to compute projection */
  93957. defaultProjectionMatrix: Matrix;
  93958. /**
  93959. * Gets the maximum number of particles active at the same time.
  93960. * @returns The max number of active particles.
  93961. */
  93962. getCapacity(): number;
  93963. /**
  93964. * Gets the number of particles active at the same time.
  93965. * @returns The number of active particles.
  93966. */
  93967. getActiveCount(): number;
  93968. /**
  93969. * Gets if the system has been started. (Note: this will still be true after stop is called)
  93970. * @returns True if it has been started, otherwise false.
  93971. */
  93972. isStarted(): boolean;
  93973. /**
  93974. * Animates the particle system for this frame.
  93975. */
  93976. animate(): void;
  93977. /**
  93978. * Renders the particle system in its current state.
  93979. * @returns the current number of particles
  93980. */
  93981. render(): number;
  93982. /**
  93983. * Dispose the particle system and frees its associated resources.
  93984. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  93985. */
  93986. dispose(disposeTexture?: boolean): void;
  93987. /**
  93988. * An event triggered when the system is disposed
  93989. */
  93990. onDisposeObservable: Observable<IParticleSystem>;
  93991. /**
  93992. * Clones the particle system.
  93993. * @param name The name of the cloned object
  93994. * @param newEmitter The new emitter to use
  93995. * @returns the cloned particle system
  93996. */
  93997. clone(name: string, newEmitter: any): Nullable<IParticleSystem>;
  93998. /**
  93999. * Serializes the particle system to a JSON object
  94000. * @param serializeTexture defines if the texture must be serialized as well
  94001. * @returns the JSON object
  94002. */
  94003. serialize(serializeTexture: boolean): any;
  94004. /**
  94005. * Rebuild the particle system
  94006. */
  94007. rebuild(): void;
  94008. /** Force the system to rebuild all gradients that need to be resync */
  94009. forceRefreshGradients(): void;
  94010. /**
  94011. * Starts the particle system and begins to emit
  94012. * @param delay defines the delay in milliseconds before starting the system (0 by default)
  94013. */
  94014. start(delay?: number): void;
  94015. /**
  94016. * Stops the particle system.
  94017. */
  94018. stop(): void;
  94019. /**
  94020. * Remove all active particles
  94021. */
  94022. reset(): void;
  94023. /**
  94024. * Gets a boolean indicating that the system is stopping
  94025. * @returns true if the system is currently stopping
  94026. */
  94027. isStopping(): boolean;
  94028. /**
  94029. * Is this system ready to be used/rendered
  94030. * @return true if the system is ready
  94031. */
  94032. isReady(): boolean;
  94033. /**
  94034. * Returns the string "ParticleSystem"
  94035. * @returns a string containing the class name
  94036. */
  94037. getClassName(): string;
  94038. /**
  94039. * Gets the custom effect used to render the particles
  94040. * @param blendMode Blend mode for which the effect should be retrieved
  94041. * @returns The effect
  94042. */
  94043. getCustomEffect(blendMode: number): Nullable<Effect>;
  94044. /**
  94045. * Sets the custom effect used to render the particles
  94046. * @param effect The effect to set
  94047. * @param blendMode Blend mode for which the effect should be set
  94048. */
  94049. setCustomEffect(effect: Nullable<Effect>, blendMode: number): void;
  94050. /**
  94051. * Fill the defines array according to the current settings of the particle system
  94052. * @param defines Array to be updated
  94053. * @param blendMode blend mode to take into account when updating the array
  94054. */
  94055. fillDefines(defines: Array<string>, blendMode: number): void;
  94056. /**
  94057. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  94058. * @param uniforms Uniforms array to fill
  94059. * @param attributes Attributes array to fill
  94060. * @param samplers Samplers array to fill
  94061. */
  94062. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  94063. /**
  94064. * Observable that will be called just before the particles are drawn
  94065. */
  94066. onBeforeDrawParticlesObservable: Observable<Nullable<Effect>>;
  94067. /**
  94068. * Gets the name of the particle vertex shader
  94069. */
  94070. vertexShaderName: string;
  94071. /**
  94072. * Adds a new color gradient
  94073. * @param gradient defines the gradient to use (between 0 and 1)
  94074. * @param color1 defines the color to affect to the specified gradient
  94075. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  94076. * @returns the current particle system
  94077. */
  94078. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  94079. /**
  94080. * Remove a specific color gradient
  94081. * @param gradient defines the gradient to remove
  94082. * @returns the current particle system
  94083. */
  94084. removeColorGradient(gradient: number): IParticleSystem;
  94085. /**
  94086. * Adds a new size gradient
  94087. * @param gradient defines the gradient to use (between 0 and 1)
  94088. * @param factor defines the size factor to affect to the specified gradient
  94089. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94090. * @returns the current particle system
  94091. */
  94092. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94093. /**
  94094. * Remove a specific size gradient
  94095. * @param gradient defines the gradient to remove
  94096. * @returns the current particle system
  94097. */
  94098. removeSizeGradient(gradient: number): IParticleSystem;
  94099. /**
  94100. * Gets the current list of color gradients.
  94101. * You must use addColorGradient and removeColorGradient to udpate this list
  94102. * @returns the list of color gradients
  94103. */
  94104. getColorGradients(): Nullable<Array<ColorGradient>>;
  94105. /**
  94106. * Gets the current list of size gradients.
  94107. * You must use addSizeGradient and removeSizeGradient to udpate this list
  94108. * @returns the list of size gradients
  94109. */
  94110. getSizeGradients(): Nullable<Array<FactorGradient>>;
  94111. /**
  94112. * Gets the current list of angular speed gradients.
  94113. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  94114. * @returns the list of angular speed gradients
  94115. */
  94116. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  94117. /**
  94118. * Adds a new angular speed gradient
  94119. * @param gradient defines the gradient to use (between 0 and 1)
  94120. * @param factor defines the angular speed to affect to the specified gradient
  94121. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94122. * @returns the current particle system
  94123. */
  94124. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94125. /**
  94126. * Remove a specific angular speed gradient
  94127. * @param gradient defines the gradient to remove
  94128. * @returns the current particle system
  94129. */
  94130. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  94131. /**
  94132. * Gets the current list of velocity gradients.
  94133. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  94134. * @returns the list of velocity gradients
  94135. */
  94136. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  94137. /**
  94138. * Adds a new velocity gradient
  94139. * @param gradient defines the gradient to use (between 0 and 1)
  94140. * @param factor defines the velocity to affect to the specified gradient
  94141. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94142. * @returns the current particle system
  94143. */
  94144. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94145. /**
  94146. * Remove a specific velocity gradient
  94147. * @param gradient defines the gradient to remove
  94148. * @returns the current particle system
  94149. */
  94150. removeVelocityGradient(gradient: number): IParticleSystem;
  94151. /**
  94152. * Gets the current list of limit velocity gradients.
  94153. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  94154. * @returns the list of limit velocity gradients
  94155. */
  94156. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  94157. /**
  94158. * Adds a new limit velocity gradient
  94159. * @param gradient defines the gradient to use (between 0 and 1)
  94160. * @param factor defines the limit velocity to affect to the specified gradient
  94161. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94162. * @returns the current particle system
  94163. */
  94164. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94165. /**
  94166. * Remove a specific limit velocity gradient
  94167. * @param gradient defines the gradient to remove
  94168. * @returns the current particle system
  94169. */
  94170. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  94171. /**
  94172. * Adds a new drag gradient
  94173. * @param gradient defines the gradient to use (between 0 and 1)
  94174. * @param factor defines the drag to affect to the specified gradient
  94175. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94176. * @returns the current particle system
  94177. */
  94178. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94179. /**
  94180. * Remove a specific drag gradient
  94181. * @param gradient defines the gradient to remove
  94182. * @returns the current particle system
  94183. */
  94184. removeDragGradient(gradient: number): IParticleSystem;
  94185. /**
  94186. * Gets the current list of drag gradients.
  94187. * You must use addDragGradient and removeDragGradient to udpate this list
  94188. * @returns the list of drag gradients
  94189. */
  94190. getDragGradients(): Nullable<Array<FactorGradient>>;
  94191. /**
  94192. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  94193. * @param gradient defines the gradient to use (between 0 and 1)
  94194. * @param factor defines the emit rate to affect to the specified gradient
  94195. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94196. * @returns the current particle system
  94197. */
  94198. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94199. /**
  94200. * Remove a specific emit rate gradient
  94201. * @param gradient defines the gradient to remove
  94202. * @returns the current particle system
  94203. */
  94204. removeEmitRateGradient(gradient: number): IParticleSystem;
  94205. /**
  94206. * Gets the current list of emit rate gradients.
  94207. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  94208. * @returns the list of emit rate gradients
  94209. */
  94210. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  94211. /**
  94212. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  94213. * @param gradient defines the gradient to use (between 0 and 1)
  94214. * @param factor defines the start size to affect to the specified gradient
  94215. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94216. * @returns the current particle system
  94217. */
  94218. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94219. /**
  94220. * Remove a specific start size gradient
  94221. * @param gradient defines the gradient to remove
  94222. * @returns the current particle system
  94223. */
  94224. removeStartSizeGradient(gradient: number): IParticleSystem;
  94225. /**
  94226. * Gets the current list of start size gradients.
  94227. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  94228. * @returns the list of start size gradients
  94229. */
  94230. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  94231. /**
  94232. * Adds a new life time gradient
  94233. * @param gradient defines the gradient to use (between 0 and 1)
  94234. * @param factor defines the life time factor to affect to the specified gradient
  94235. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94236. * @returns the current particle system
  94237. */
  94238. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94239. /**
  94240. * Remove a specific life time gradient
  94241. * @param gradient defines the gradient to remove
  94242. * @returns the current particle system
  94243. */
  94244. removeLifeTimeGradient(gradient: number): IParticleSystem;
  94245. /**
  94246. * Gets the current list of life time gradients.
  94247. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  94248. * @returns the list of life time gradients
  94249. */
  94250. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  94251. /**
  94252. * Gets the current list of color gradients.
  94253. * You must use addColorGradient and removeColorGradient to udpate this list
  94254. * @returns the list of color gradients
  94255. */
  94256. getColorGradients(): Nullable<Array<ColorGradient>>;
  94257. /**
  94258. * Adds a new ramp gradient used to remap particle colors
  94259. * @param gradient defines the gradient to use (between 0 and 1)
  94260. * @param color defines the color to affect to the specified gradient
  94261. * @returns the current particle system
  94262. */
  94263. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  94264. /**
  94265. * Gets the current list of ramp gradients.
  94266. * You must use addRampGradient and removeRampGradient to udpate this list
  94267. * @returns the list of ramp gradients
  94268. */
  94269. getRampGradients(): Nullable<Array<Color3Gradient>>;
  94270. /** Gets or sets a boolean indicating that ramp gradients must be used
  94271. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  94272. */
  94273. useRampGradients: boolean;
  94274. /**
  94275. * Adds a new color remap gradient
  94276. * @param gradient defines the gradient to use (between 0 and 1)
  94277. * @param min defines the color remap minimal range
  94278. * @param max defines the color remap maximal range
  94279. * @returns the current particle system
  94280. */
  94281. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  94282. /**
  94283. * Gets the current list of color remap gradients.
  94284. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  94285. * @returns the list of color remap gradients
  94286. */
  94287. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  94288. /**
  94289. * Adds a new alpha remap gradient
  94290. * @param gradient defines the gradient to use (between 0 and 1)
  94291. * @param min defines the alpha remap minimal range
  94292. * @param max defines the alpha remap maximal range
  94293. * @returns the current particle system
  94294. */
  94295. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  94296. /**
  94297. * Gets the current list of alpha remap gradients.
  94298. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  94299. * @returns the list of alpha remap gradients
  94300. */
  94301. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  94302. /**
  94303. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  94304. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  94305. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  94306. * @returns the emitter
  94307. */
  94308. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  94309. /**
  94310. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  94311. * @param radius The radius of the hemisphere to emit from
  94312. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  94313. * @returns the emitter
  94314. */
  94315. createHemisphericEmitter(radius: number, radiusRange: number): HemisphericParticleEmitter;
  94316. /**
  94317. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  94318. * @param radius The radius of the sphere to emit from
  94319. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  94320. * @returns the emitter
  94321. */
  94322. createSphereEmitter(radius: number, radiusRange: number): SphereParticleEmitter;
  94323. /**
  94324. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  94325. * @param radius The radius of the sphere to emit from
  94326. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  94327. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  94328. * @returns the emitter
  94329. */
  94330. createDirectedSphereEmitter(radius: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  94331. /**
  94332. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  94333. * @param radius The radius of the emission cylinder
  94334. * @param height The height of the emission cylinder
  94335. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  94336. * @param directionRandomizer How much to randomize the particle direction [0-1]
  94337. * @returns the emitter
  94338. */
  94339. createCylinderEmitter(radius: number, height: number, radiusRange: number, directionRandomizer: number): CylinderParticleEmitter;
  94340. /**
  94341. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  94342. * @param radius The radius of the cylinder to emit from
  94343. * @param height The height of the emission cylinder
  94344. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  94345. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  94346. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  94347. * @returns the emitter
  94348. */
  94349. createDirectedCylinderEmitter(radius: number, height: number, radiusRange: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  94350. /**
  94351. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  94352. * @param radius The radius of the cone to emit from
  94353. * @param angle The base angle of the cone
  94354. * @returns the emitter
  94355. */
  94356. createConeEmitter(radius: number, angle: number): ConeParticleEmitter;
  94357. /**
  94358. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  94359. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  94360. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  94361. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  94362. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  94363. * @returns the emitter
  94364. */
  94365. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  94366. /**
  94367. * Get hosting scene
  94368. * @returns the scene
  94369. */
  94370. getScene(): Nullable<Scene>;
  94371. }
  94372. }
  94373. declare module BABYLON {
  94374. /**
  94375. * 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.
  94376. * @see https://doc.babylonjs.com/how_to/transformnode
  94377. */
  94378. export class TransformNode extends Node {
  94379. /**
  94380. * Object will not rotate to face the camera
  94381. */
  94382. static BILLBOARDMODE_NONE: number;
  94383. /**
  94384. * Object will rotate to face the camera but only on the x axis
  94385. */
  94386. static BILLBOARDMODE_X: number;
  94387. /**
  94388. * Object will rotate to face the camera but only on the y axis
  94389. */
  94390. static BILLBOARDMODE_Y: number;
  94391. /**
  94392. * Object will rotate to face the camera but only on the z axis
  94393. */
  94394. static BILLBOARDMODE_Z: number;
  94395. /**
  94396. * Object will rotate to face the camera
  94397. */
  94398. static BILLBOARDMODE_ALL: number;
  94399. /**
  94400. * Object will rotate to face the camera's position instead of orientation
  94401. */
  94402. static BILLBOARDMODE_USE_POSITION: number;
  94403. private static _TmpRotation;
  94404. private static _TmpScaling;
  94405. private static _TmpTranslation;
  94406. private _forward;
  94407. private _forwardInverted;
  94408. private _up;
  94409. private _right;
  94410. private _rightInverted;
  94411. private _position;
  94412. private _rotation;
  94413. private _rotationQuaternion;
  94414. protected _scaling: Vector3;
  94415. protected _isDirty: boolean;
  94416. private _transformToBoneReferal;
  94417. private _isAbsoluteSynced;
  94418. private _billboardMode;
  94419. /**
  94420. * Gets or sets the billboard mode. Default is 0.
  94421. *
  94422. * | Value | Type | Description |
  94423. * | --- | --- | --- |
  94424. * | 0 | BILLBOARDMODE_NONE | |
  94425. * | 1 | BILLBOARDMODE_X | |
  94426. * | 2 | BILLBOARDMODE_Y | |
  94427. * | 4 | BILLBOARDMODE_Z | |
  94428. * | 7 | BILLBOARDMODE_ALL | |
  94429. *
  94430. */
  94431. get billboardMode(): number;
  94432. set billboardMode(value: number);
  94433. private _preserveParentRotationForBillboard;
  94434. /**
  94435. * Gets or sets a boolean indicating that parent rotation should be preserved when using billboards.
  94436. * This could be useful for glTF objects where parent rotation helps converting from right handed to left handed
  94437. */
  94438. get preserveParentRotationForBillboard(): boolean;
  94439. set preserveParentRotationForBillboard(value: boolean);
  94440. /**
  94441. * 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
  94442. */
  94443. scalingDeterminant: number;
  94444. private _infiniteDistance;
  94445. /**
  94446. * Gets or sets the distance of the object to max, often used by skybox
  94447. */
  94448. get infiniteDistance(): boolean;
  94449. set infiniteDistance(value: boolean);
  94450. /**
  94451. * Gets or sets a boolean indicating that non uniform scaling (when at least one component is different from others) should be ignored.
  94452. * By default the system will update normals to compensate
  94453. */
  94454. ignoreNonUniformScaling: boolean;
  94455. /**
  94456. * 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
  94457. */
  94458. reIntegrateRotationIntoRotationQuaternion: boolean;
  94459. /** @hidden */
  94460. _poseMatrix: Nullable<Matrix>;
  94461. /** @hidden */
  94462. _localMatrix: Matrix;
  94463. private _usePivotMatrix;
  94464. private _absolutePosition;
  94465. private _absoluteScaling;
  94466. private _absoluteRotationQuaternion;
  94467. private _pivotMatrix;
  94468. private _pivotMatrixInverse;
  94469. /** @hidden */
  94470. _postMultiplyPivotMatrix: boolean;
  94471. protected _isWorldMatrixFrozen: boolean;
  94472. /** @hidden */
  94473. _indexInSceneTransformNodesArray: number;
  94474. /**
  94475. * An event triggered after the world matrix is updated
  94476. */
  94477. onAfterWorldMatrixUpdateObservable: Observable<TransformNode>;
  94478. constructor(name: string, scene?: Nullable<Scene>, isPure?: boolean);
  94479. /**
  94480. * Gets a string identifying the name of the class
  94481. * @returns "TransformNode" string
  94482. */
  94483. getClassName(): string;
  94484. /**
  94485. * Gets or set the node position (default is (0.0, 0.0, 0.0))
  94486. */
  94487. get position(): Vector3;
  94488. set position(newPosition: Vector3);
  94489. /**
  94490. * 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)).
  94491. * If rotation quaternion is set, this Vector3 will be ignored and copy from the quaternion
  94492. */
  94493. get rotation(): Vector3;
  94494. set rotation(newRotation: Vector3);
  94495. /**
  94496. * 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)).
  94497. */
  94498. get scaling(): Vector3;
  94499. set scaling(newScaling: Vector3);
  94500. /**
  94501. * 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).
  94502. * If set, only the rotationQuaternion is then used to compute the node rotation (ie. node.rotation will be ignored)
  94503. */
  94504. get rotationQuaternion(): Nullable<Quaternion>;
  94505. set rotationQuaternion(quaternion: Nullable<Quaternion>);
  94506. /**
  94507. * The forward direction of that transform in world space.
  94508. */
  94509. get forward(): Vector3;
  94510. /**
  94511. * The up direction of that transform in world space.
  94512. */
  94513. get up(): Vector3;
  94514. /**
  94515. * The right direction of that transform in world space.
  94516. */
  94517. get right(): Vector3;
  94518. /**
  94519. * Copies the parameter passed Matrix into the mesh Pose matrix.
  94520. * @param matrix the matrix to copy the pose from
  94521. * @returns this TransformNode.
  94522. */
  94523. updatePoseMatrix(matrix: Matrix): TransformNode;
  94524. /**
  94525. * Returns the mesh Pose matrix.
  94526. * @returns the pose matrix
  94527. */
  94528. getPoseMatrix(): Matrix;
  94529. /** @hidden */
  94530. _isSynchronized(): boolean;
  94531. /** @hidden */
  94532. _initCache(): void;
  94533. /**
  94534. * Flag the transform node as dirty (Forcing it to update everything)
  94535. * @param property if set to "rotation" the objects rotationQuaternion will be set to null
  94536. * @returns this transform node
  94537. */
  94538. markAsDirty(property: string): TransformNode;
  94539. /**
  94540. * Returns the current mesh absolute position.
  94541. * Returns a Vector3.
  94542. */
  94543. get absolutePosition(): Vector3;
  94544. /**
  94545. * Returns the current mesh absolute scaling.
  94546. * Returns a Vector3.
  94547. */
  94548. get absoluteScaling(): Vector3;
  94549. /**
  94550. * Returns the current mesh absolute rotation.
  94551. * Returns a Quaternion.
  94552. */
  94553. get absoluteRotationQuaternion(): Quaternion;
  94554. /**
  94555. * Sets a new matrix to apply before all other transformation
  94556. * @param matrix defines the transform matrix
  94557. * @returns the current TransformNode
  94558. */
  94559. setPreTransformMatrix(matrix: Matrix): TransformNode;
  94560. /**
  94561. * Sets a new pivot matrix to the current node
  94562. * @param matrix defines the new pivot matrix to use
  94563. * @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
  94564. * @returns the current TransformNode
  94565. */
  94566. setPivotMatrix(matrix: DeepImmutable<Matrix>, postMultiplyPivotMatrix?: boolean): TransformNode;
  94567. /**
  94568. * Returns the mesh pivot matrix.
  94569. * Default : Identity.
  94570. * @returns the matrix
  94571. */
  94572. getPivotMatrix(): Matrix;
  94573. /**
  94574. * Instantiate (when possible) or clone that node with its hierarchy
  94575. * @param newParent defines the new parent to use for the instance (or clone)
  94576. * @param options defines options to configure how copy is done
  94577. * @param onNewNodeCreated defines an option callback to call when a clone or an instance is created
  94578. * @returns an instance (or a clone) of the current node with its hiearchy
  94579. */
  94580. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  94581. doNotInstantiate: boolean;
  94582. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  94583. /**
  94584. * Prevents the World matrix to be computed any longer
  94585. * @param newWorldMatrix defines an optional matrix to use as world matrix
  94586. * @returns the TransformNode.
  94587. */
  94588. freezeWorldMatrix(newWorldMatrix?: Nullable<Matrix>): TransformNode;
  94589. /**
  94590. * Allows back the World matrix computation.
  94591. * @returns the TransformNode.
  94592. */
  94593. unfreezeWorldMatrix(): this;
  94594. /**
  94595. * True if the World matrix has been frozen.
  94596. */
  94597. get isWorldMatrixFrozen(): boolean;
  94598. /**
  94599. * Retuns the mesh absolute position in the World.
  94600. * @returns a Vector3.
  94601. */
  94602. getAbsolutePosition(): Vector3;
  94603. /**
  94604. * Sets the mesh absolute position in the World from a Vector3 or an Array(3).
  94605. * @param absolutePosition the absolute position to set
  94606. * @returns the TransformNode.
  94607. */
  94608. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  94609. /**
  94610. * Sets the mesh position in its local space.
  94611. * @param vector3 the position to set in localspace
  94612. * @returns the TransformNode.
  94613. */
  94614. setPositionWithLocalVector(vector3: Vector3): TransformNode;
  94615. /**
  94616. * Returns the mesh position in the local space from the current World matrix values.
  94617. * @returns a new Vector3.
  94618. */
  94619. getPositionExpressedInLocalSpace(): Vector3;
  94620. /**
  94621. * Translates the mesh along the passed Vector3 in its local space.
  94622. * @param vector3 the distance to translate in localspace
  94623. * @returns the TransformNode.
  94624. */
  94625. locallyTranslate(vector3: Vector3): TransformNode;
  94626. private static _lookAtVectorCache;
  94627. /**
  94628. * Orients a mesh towards a target point. Mesh must be drawn facing user.
  94629. * @param targetPoint the position (must be in same space as current mesh) to look at
  94630. * @param yawCor optional yaw (y-axis) correction in radians
  94631. * @param pitchCor optional pitch (x-axis) correction in radians
  94632. * @param rollCor optional roll (z-axis) correction in radians
  94633. * @param space the choosen space of the target
  94634. * @returns the TransformNode.
  94635. */
  94636. lookAt(targetPoint: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number, space?: Space): TransformNode;
  94637. /**
  94638. * Returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  94639. * This Vector3 is expressed in the World space.
  94640. * @param localAxis axis to rotate
  94641. * @returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  94642. */
  94643. getDirection(localAxis: Vector3): Vector3;
  94644. /**
  94645. * Sets the Vector3 "result" as the rotated Vector3 "localAxis" in the same rotation than the mesh.
  94646. * localAxis is expressed in the mesh local space.
  94647. * result is computed in the Wordl space from the mesh World matrix.
  94648. * @param localAxis axis to rotate
  94649. * @param result the resulting transformnode
  94650. * @returns this TransformNode.
  94651. */
  94652. getDirectionToRef(localAxis: Vector3, result: Vector3): TransformNode;
  94653. /**
  94654. * Sets this transform node rotation to the given local axis.
  94655. * @param localAxis the axis in local space
  94656. * @param yawCor optional yaw (y-axis) correction in radians
  94657. * @param pitchCor optional pitch (x-axis) correction in radians
  94658. * @param rollCor optional roll (z-axis) correction in radians
  94659. * @returns this TransformNode
  94660. */
  94661. setDirection(localAxis: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number): TransformNode;
  94662. /**
  94663. * Sets a new pivot point to the current node
  94664. * @param point defines the new pivot point to use
  94665. * @param space defines if the point is in world or local space (local by default)
  94666. * @returns the current TransformNode
  94667. */
  94668. setPivotPoint(point: Vector3, space?: Space): TransformNode;
  94669. /**
  94670. * Returns a new Vector3 set with the mesh pivot point coordinates in the local space.
  94671. * @returns the pivot point
  94672. */
  94673. getPivotPoint(): Vector3;
  94674. /**
  94675. * Sets the passed Vector3 "result" with the coordinates of the mesh pivot point in the local space.
  94676. * @param result the vector3 to store the result
  94677. * @returns this TransformNode.
  94678. */
  94679. getPivotPointToRef(result: Vector3): TransformNode;
  94680. /**
  94681. * Returns a new Vector3 set with the mesh pivot point World coordinates.
  94682. * @returns a new Vector3 set with the mesh pivot point World coordinates.
  94683. */
  94684. getAbsolutePivotPoint(): Vector3;
  94685. /**
  94686. * Sets the Vector3 "result" coordinates with the mesh pivot point World coordinates.
  94687. * @param result vector3 to store the result
  94688. * @returns this TransformNode.
  94689. */
  94690. getAbsolutePivotPointToRef(result: Vector3): TransformNode;
  94691. /**
  94692. * Defines the passed node as the parent of the current node.
  94693. * The node will remain exactly where it is and its position / rotation will be updated accordingly
  94694. * @see https://doc.babylonjs.com/how_to/parenting
  94695. * @param node the node ot set as the parent
  94696. * @returns this TransformNode.
  94697. */
  94698. setParent(node: Nullable<Node>): TransformNode;
  94699. private _nonUniformScaling;
  94700. /**
  94701. * True if the scaling property of this object is non uniform eg. (1,2,1)
  94702. */
  94703. get nonUniformScaling(): boolean;
  94704. /** @hidden */
  94705. _updateNonUniformScalingState(value: boolean): boolean;
  94706. /**
  94707. * Attach the current TransformNode to another TransformNode associated with a bone
  94708. * @param bone Bone affecting the TransformNode
  94709. * @param affectedTransformNode TransformNode associated with the bone
  94710. * @returns this object
  94711. */
  94712. attachToBone(bone: Bone, affectedTransformNode: TransformNode): TransformNode;
  94713. /**
  94714. * Detach the transform node if its associated with a bone
  94715. * @returns this object
  94716. */
  94717. detachFromBone(): TransformNode;
  94718. private static _rotationAxisCache;
  94719. /**
  94720. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in the given space.
  94721. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  94722. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  94723. * The passed axis is also normalized.
  94724. * @param axis the axis to rotate around
  94725. * @param amount the amount to rotate in radians
  94726. * @param space Space to rotate in (Default: local)
  94727. * @returns the TransformNode.
  94728. */
  94729. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  94730. /**
  94731. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in world space.
  94732. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  94733. * The passed axis is also normalized. .
  94734. * Method is based on http://www.euclideanspace.com/maths/geometry/affine/aroundPoint/index.htm
  94735. * @param point the point to rotate around
  94736. * @param axis the axis to rotate around
  94737. * @param amount the amount to rotate in radians
  94738. * @returns the TransformNode
  94739. */
  94740. rotateAround(point: Vector3, axis: Vector3, amount: number): TransformNode;
  94741. /**
  94742. * Translates the mesh along the axis vector for the passed distance in the given space.
  94743. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  94744. * @param axis the axis to translate in
  94745. * @param distance the distance to translate
  94746. * @param space Space to rotate in (Default: local)
  94747. * @returns the TransformNode.
  94748. */
  94749. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  94750. /**
  94751. * Adds a rotation step to the mesh current rotation.
  94752. * x, y, z are Euler angles expressed in radians.
  94753. * This methods updates the current mesh rotation, either mesh.rotation, either mesh.rotationQuaternion if it's set.
  94754. * This means this rotation is made in the mesh local space only.
  94755. * It's useful to set a custom rotation order different from the BJS standard one YXZ.
  94756. * Example : this rotates the mesh first around its local X axis, then around its local Z axis, finally around its local Y axis.
  94757. * ```javascript
  94758. * mesh.addRotation(x1, 0, 0).addRotation(0, 0, z2).addRotation(0, 0, y3);
  94759. * ```
  94760. * Note that `addRotation()` accumulates the passed rotation values to the current ones and computes the .rotation or .rotationQuaternion updated values.
  94761. * 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.
  94762. * @param x Rotation to add
  94763. * @param y Rotation to add
  94764. * @param z Rotation to add
  94765. * @returns the TransformNode.
  94766. */
  94767. addRotation(x: number, y: number, z: number): TransformNode;
  94768. /**
  94769. * @hidden
  94770. */
  94771. protected _getEffectiveParent(): Nullable<Node>;
  94772. /**
  94773. * Computes the world matrix of the node
  94774. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  94775. * @returns the world matrix
  94776. */
  94777. computeWorldMatrix(force?: boolean): Matrix;
  94778. /**
  94779. * Resets this nodeTransform's local matrix to Matrix.Identity().
  94780. * @param independentOfChildren indicates if all child nodeTransform's world-space transform should be preserved.
  94781. */
  94782. resetLocalMatrix(independentOfChildren?: boolean): void;
  94783. protected _afterComputeWorldMatrix(): void;
  94784. /**
  94785. * If you'd like to be called back after the mesh position, rotation or scaling has been updated.
  94786. * @param func callback function to add
  94787. *
  94788. * @returns the TransformNode.
  94789. */
  94790. registerAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  94791. /**
  94792. * Removes a registered callback function.
  94793. * @param func callback function to remove
  94794. * @returns the TransformNode.
  94795. */
  94796. unregisterAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  94797. /**
  94798. * Gets the position of the current mesh in camera space
  94799. * @param camera defines the camera to use
  94800. * @returns a position
  94801. */
  94802. getPositionInCameraSpace(camera?: Nullable<Camera>): Vector3;
  94803. /**
  94804. * Returns the distance from the mesh to the active camera
  94805. * @param camera defines the camera to use
  94806. * @returns the distance
  94807. */
  94808. getDistanceToCamera(camera?: Nullable<Camera>): number;
  94809. /**
  94810. * Clone the current transform node
  94811. * @param name Name of the new clone
  94812. * @param newParent New parent for the clone
  94813. * @param doNotCloneChildren Do not clone children hierarchy
  94814. * @returns the new transform node
  94815. */
  94816. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<TransformNode>;
  94817. /**
  94818. * Serializes the objects information.
  94819. * @param currentSerializationObject defines the object to serialize in
  94820. * @returns the serialized object
  94821. */
  94822. serialize(currentSerializationObject?: any): any;
  94823. /**
  94824. * Returns a new TransformNode object parsed from the source provided.
  94825. * @param parsedTransformNode is the source.
  94826. * @param scene the scne the object belongs to
  94827. * @param rootUrl is a string, it's the root URL to prefix the `delayLoadingFile` property with
  94828. * @returns a new TransformNode object parsed from the source provided.
  94829. */
  94830. static Parse(parsedTransformNode: any, scene: Scene, rootUrl: string): TransformNode;
  94831. /**
  94832. * Get all child-transformNodes of this node
  94833. * @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
  94834. * @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
  94835. * @returns an array of TransformNode
  94836. */
  94837. getChildTransformNodes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): TransformNode[];
  94838. /**
  94839. * Releases resources associated with this transform node.
  94840. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  94841. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  94842. */
  94843. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  94844. /**
  94845. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  94846. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  94847. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  94848. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  94849. * @returns the current mesh
  94850. */
  94851. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): TransformNode;
  94852. private _syncAbsoluteScalingAndRotation;
  94853. }
  94854. }
  94855. declare module BABYLON {
  94856. /**
  94857. * Class used to override all child animations of a given target
  94858. */
  94859. export class AnimationPropertiesOverride {
  94860. /**
  94861. * Gets or sets a value indicating if animation blending must be used
  94862. */
  94863. enableBlending: boolean;
  94864. /**
  94865. * Gets or sets the blending speed to use when enableBlending is true
  94866. */
  94867. blendingSpeed: number;
  94868. /**
  94869. * Gets or sets the default loop mode to use
  94870. */
  94871. loopMode: number;
  94872. }
  94873. }
  94874. declare module BABYLON {
  94875. /**
  94876. * Class used to store bone information
  94877. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  94878. */
  94879. export class Bone extends Node {
  94880. /**
  94881. * defines the bone name
  94882. */
  94883. name: string;
  94884. private static _tmpVecs;
  94885. private static _tmpQuat;
  94886. private static _tmpMats;
  94887. /**
  94888. * Gets the list of child bones
  94889. */
  94890. children: Bone[];
  94891. /** Gets the animations associated with this bone */
  94892. animations: Animation[];
  94893. /**
  94894. * Gets or sets bone length
  94895. */
  94896. length: number;
  94897. /**
  94898. * @hidden Internal only
  94899. * Set this value to map this bone to a different index in the transform matrices
  94900. * Set this value to -1 to exclude the bone from the transform matrices
  94901. */
  94902. _index: Nullable<number>;
  94903. private _skeleton;
  94904. private _localMatrix;
  94905. private _restPose;
  94906. private _bindPose;
  94907. private _baseMatrix;
  94908. private _absoluteTransform;
  94909. private _invertedAbsoluteTransform;
  94910. private _parent;
  94911. private _scalingDeterminant;
  94912. private _worldTransform;
  94913. private _localScaling;
  94914. private _localRotation;
  94915. private _localPosition;
  94916. private _needToDecompose;
  94917. private _needToCompose;
  94918. /** @hidden */
  94919. _linkedTransformNode: Nullable<TransformNode>;
  94920. /** @hidden */
  94921. _waitingTransformNodeId: Nullable<string>;
  94922. /** @hidden */
  94923. get _matrix(): Matrix;
  94924. /** @hidden */
  94925. set _matrix(value: Matrix);
  94926. /**
  94927. * Create a new bone
  94928. * @param name defines the bone name
  94929. * @param skeleton defines the parent skeleton
  94930. * @param parentBone defines the parent (can be null if the bone is the root)
  94931. * @param localMatrix defines the local matrix
  94932. * @param restPose defines the rest pose matrix
  94933. * @param baseMatrix defines the base matrix
  94934. * @param index defines index of the bone in the hiearchy
  94935. */
  94936. constructor(
  94937. /**
  94938. * defines the bone name
  94939. */
  94940. name: string, skeleton: Skeleton, parentBone?: Nullable<Bone>, localMatrix?: Nullable<Matrix>, restPose?: Nullable<Matrix>, baseMatrix?: Nullable<Matrix>, index?: Nullable<number>);
  94941. /**
  94942. * Gets the current object class name.
  94943. * @return the class name
  94944. */
  94945. getClassName(): string;
  94946. /**
  94947. * Gets the parent skeleton
  94948. * @returns a skeleton
  94949. */
  94950. getSkeleton(): Skeleton;
  94951. /**
  94952. * Gets parent bone
  94953. * @returns a bone or null if the bone is the root of the bone hierarchy
  94954. */
  94955. getParent(): Nullable<Bone>;
  94956. /**
  94957. * Returns an array containing the root bones
  94958. * @returns an array containing the root bones
  94959. */
  94960. getChildren(): Array<Bone>;
  94961. /**
  94962. * Gets the node index in matrix array generated for rendering
  94963. * @returns the node index
  94964. */
  94965. getIndex(): number;
  94966. /**
  94967. * Sets the parent bone
  94968. * @param parent defines the parent (can be null if the bone is the root)
  94969. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  94970. */
  94971. setParent(parent: Nullable<Bone>, updateDifferenceMatrix?: boolean): void;
  94972. /**
  94973. * Gets the local matrix
  94974. * @returns a matrix
  94975. */
  94976. getLocalMatrix(): Matrix;
  94977. /**
  94978. * Gets the base matrix (initial matrix which remains unchanged)
  94979. * @returns a matrix
  94980. */
  94981. getBaseMatrix(): Matrix;
  94982. /**
  94983. * Gets the rest pose matrix
  94984. * @returns a matrix
  94985. */
  94986. getRestPose(): Matrix;
  94987. /**
  94988. * Sets the rest pose matrix
  94989. * @param matrix the local-space rest pose to set for this bone
  94990. */
  94991. setRestPose(matrix: Matrix): void;
  94992. /**
  94993. * Gets the bind pose matrix
  94994. * @returns the bind pose matrix
  94995. */
  94996. getBindPose(): Matrix;
  94997. /**
  94998. * Sets the bind pose matrix
  94999. * @param matrix the local-space bind pose to set for this bone
  95000. */
  95001. setBindPose(matrix: Matrix): void;
  95002. /**
  95003. * Gets a matrix used to store world matrix (ie. the matrix sent to shaders)
  95004. */
  95005. getWorldMatrix(): Matrix;
  95006. /**
  95007. * Sets the local matrix to rest pose matrix
  95008. */
  95009. returnToRest(): void;
  95010. /**
  95011. * Gets the inverse of the absolute transform matrix.
  95012. * This matrix will be multiplied by local matrix to get the difference matrix (ie. the difference between original state and current state)
  95013. * @returns a matrix
  95014. */
  95015. getInvertedAbsoluteTransform(): Matrix;
  95016. /**
  95017. * Gets the absolute transform matrix (ie base matrix * parent world matrix)
  95018. * @returns a matrix
  95019. */
  95020. getAbsoluteTransform(): Matrix;
  95021. /**
  95022. * Links with the given transform node.
  95023. * The local matrix of this bone is copied from the transform node every frame.
  95024. * @param transformNode defines the transform node to link to
  95025. */
  95026. linkTransformNode(transformNode: Nullable<TransformNode>): void;
  95027. /**
  95028. * Gets the node used to drive the bone's transformation
  95029. * @returns a transform node or null
  95030. */
  95031. getTransformNode(): Nullable<TransformNode>;
  95032. /** Gets or sets current position (in local space) */
  95033. get position(): Vector3;
  95034. set position(newPosition: Vector3);
  95035. /** Gets or sets current rotation (in local space) */
  95036. get rotation(): Vector3;
  95037. set rotation(newRotation: Vector3);
  95038. /** Gets or sets current rotation quaternion (in local space) */
  95039. get rotationQuaternion(): Quaternion;
  95040. set rotationQuaternion(newRotation: Quaternion);
  95041. /** Gets or sets current scaling (in local space) */
  95042. get scaling(): Vector3;
  95043. set scaling(newScaling: Vector3);
  95044. /**
  95045. * Gets the animation properties override
  95046. */
  95047. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  95048. private _decompose;
  95049. private _compose;
  95050. /**
  95051. * Update the base and local matrices
  95052. * @param matrix defines the new base or local matrix
  95053. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  95054. * @param updateLocalMatrix defines if the local matrix should be updated
  95055. */
  95056. updateMatrix(matrix: Matrix, updateDifferenceMatrix?: boolean, updateLocalMatrix?: boolean): void;
  95057. /** @hidden */
  95058. _updateDifferenceMatrix(rootMatrix?: Matrix, updateChildren?: boolean): void;
  95059. /**
  95060. * Flag the bone as dirty (Forcing it to update everything)
  95061. */
  95062. markAsDirty(): void;
  95063. /** @hidden */
  95064. _markAsDirtyAndCompose(): void;
  95065. private _markAsDirtyAndDecompose;
  95066. /**
  95067. * Translate the bone in local or world space
  95068. * @param vec The amount to translate the bone
  95069. * @param space The space that the translation is in
  95070. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95071. */
  95072. translate(vec: Vector3, space?: Space, mesh?: AbstractMesh): void;
  95073. /**
  95074. * Set the postion of the bone in local or world space
  95075. * @param position The position to set the bone
  95076. * @param space The space that the position is in
  95077. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95078. */
  95079. setPosition(position: Vector3, space?: Space, mesh?: AbstractMesh): void;
  95080. /**
  95081. * Set the absolute position of the bone (world space)
  95082. * @param position The position to set the bone
  95083. * @param mesh The mesh that this bone is attached to
  95084. */
  95085. setAbsolutePosition(position: Vector3, mesh?: AbstractMesh): void;
  95086. /**
  95087. * Scale the bone on the x, y and z axes (in local space)
  95088. * @param x The amount to scale the bone on the x axis
  95089. * @param y The amount to scale the bone on the y axis
  95090. * @param z The amount to scale the bone on the z axis
  95091. * @param scaleChildren sets this to true if children of the bone should be scaled as well (false by default)
  95092. */
  95093. scale(x: number, y: number, z: number, scaleChildren?: boolean): void;
  95094. /**
  95095. * Set the bone scaling in local space
  95096. * @param scale defines the scaling vector
  95097. */
  95098. setScale(scale: Vector3): void;
  95099. /**
  95100. * Gets the current scaling in local space
  95101. * @returns the current scaling vector
  95102. */
  95103. getScale(): Vector3;
  95104. /**
  95105. * Gets the current scaling in local space and stores it in a target vector
  95106. * @param result defines the target vector
  95107. */
  95108. getScaleToRef(result: Vector3): void;
  95109. /**
  95110. * Set the yaw, pitch, and roll of the bone in local or world space
  95111. * @param yaw The rotation of the bone on the y axis
  95112. * @param pitch The rotation of the bone on the x axis
  95113. * @param roll The rotation of the bone on the z axis
  95114. * @param space The space that the axes of rotation are in
  95115. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95116. */
  95117. setYawPitchRoll(yaw: number, pitch: number, roll: number, space?: Space, mesh?: AbstractMesh): void;
  95118. /**
  95119. * Add a rotation to the bone on an axis in local or world space
  95120. * @param axis The axis to rotate the bone on
  95121. * @param amount The amount to rotate the bone
  95122. * @param space The space that the axis is in
  95123. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95124. */
  95125. rotate(axis: Vector3, amount: number, space?: Space, mesh?: AbstractMesh): void;
  95126. /**
  95127. * Set the rotation of the bone to a particular axis angle in local or world space
  95128. * @param axis The axis to rotate the bone on
  95129. * @param angle The angle that the bone should be rotated to
  95130. * @param space The space that the axis is in
  95131. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95132. */
  95133. setAxisAngle(axis: Vector3, angle: number, space?: Space, mesh?: AbstractMesh): void;
  95134. /**
  95135. * Set the euler rotation of the bone in local of world space
  95136. * @param rotation The euler rotation that the bone should be set to
  95137. * @param space The space that the rotation is in
  95138. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95139. */
  95140. setRotation(rotation: Vector3, space?: Space, mesh?: AbstractMesh): void;
  95141. /**
  95142. * Set the quaternion rotation of the bone in local of world space
  95143. * @param quat The quaternion rotation that the bone should be set to
  95144. * @param space The space that the rotation is in
  95145. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95146. */
  95147. setRotationQuaternion(quat: Quaternion, space?: Space, mesh?: AbstractMesh): void;
  95148. /**
  95149. * Set the rotation matrix of the bone in local of world space
  95150. * @param rotMat The rotation matrix that the bone should be set to
  95151. * @param space The space that the rotation is in
  95152. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95153. */
  95154. setRotationMatrix(rotMat: Matrix, space?: Space, mesh?: AbstractMesh): void;
  95155. private _rotateWithMatrix;
  95156. private _getNegativeRotationToRef;
  95157. /**
  95158. * Get the position of the bone in local or world space
  95159. * @param space The space that the returned position is in
  95160. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95161. * @returns The position of the bone
  95162. */
  95163. getPosition(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  95164. /**
  95165. * Copy the position of the bone to a vector3 in local or world space
  95166. * @param space The space that the returned position is in
  95167. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95168. * @param result The vector3 to copy the position to
  95169. */
  95170. getPositionToRef(space: Space | undefined, mesh: Nullable<AbstractMesh>, result: Vector3): void;
  95171. /**
  95172. * Get the absolute position of the bone (world space)
  95173. * @param mesh The mesh that this bone is attached to
  95174. * @returns The absolute position of the bone
  95175. */
  95176. getAbsolutePosition(mesh?: Nullable<AbstractMesh>): Vector3;
  95177. /**
  95178. * Copy the absolute position of the bone (world space) to the result param
  95179. * @param mesh The mesh that this bone is attached to
  95180. * @param result The vector3 to copy the absolute position to
  95181. */
  95182. getAbsolutePositionToRef(mesh: AbstractMesh, result: Vector3): void;
  95183. /**
  95184. * Compute the absolute transforms of this bone and its children
  95185. */
  95186. computeAbsoluteTransforms(): void;
  95187. /**
  95188. * Get the world direction from an axis that is in the local space of the bone
  95189. * @param localAxis The local direction that is used to compute the world direction
  95190. * @param mesh The mesh that this bone is attached to
  95191. * @returns The world direction
  95192. */
  95193. getDirection(localAxis: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  95194. /**
  95195. * Copy the world direction to a vector3 from an axis that is in the local space of the bone
  95196. * @param localAxis The local direction that is used to compute the world direction
  95197. * @param mesh The mesh that this bone is attached to
  95198. * @param result The vector3 that the world direction will be copied to
  95199. */
  95200. getDirectionToRef(localAxis: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  95201. /**
  95202. * Get the euler rotation of the bone in local or world space
  95203. * @param space The space that the rotation should be in
  95204. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95205. * @returns The euler rotation
  95206. */
  95207. getRotation(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  95208. /**
  95209. * Copy the euler rotation of the bone to a vector3. The rotation can be in either local or world space
  95210. * @param space The space that the rotation should be in
  95211. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95212. * @param result The vector3 that the rotation should be copied to
  95213. */
  95214. getRotationToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  95215. /**
  95216. * Get the quaternion rotation of the bone in either local or world space
  95217. * @param space The space that the rotation should be in
  95218. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95219. * @returns The quaternion rotation
  95220. */
  95221. getRotationQuaternion(space?: Space, mesh?: Nullable<AbstractMesh>): Quaternion;
  95222. /**
  95223. * Copy the quaternion rotation of the bone to a quaternion. The rotation can be in either local or world space
  95224. * @param space The space that the rotation should be in
  95225. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95226. * @param result The quaternion that the rotation should be copied to
  95227. */
  95228. getRotationQuaternionToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Quaternion): void;
  95229. /**
  95230. * Get the rotation matrix of the bone in local or world space
  95231. * @param space The space that the rotation should be in
  95232. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95233. * @returns The rotation matrix
  95234. */
  95235. getRotationMatrix(space: Space | undefined, mesh: AbstractMesh): Matrix;
  95236. /**
  95237. * Copy the rotation matrix of the bone to a matrix. The rotation can be in either local or world space
  95238. * @param space The space that the rotation should be in
  95239. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95240. * @param result The quaternion that the rotation should be copied to
  95241. */
  95242. getRotationMatrixToRef(space: Space | undefined, mesh: AbstractMesh, result: Matrix): void;
  95243. /**
  95244. * Get the world position of a point that is in the local space of the bone
  95245. * @param position The local position
  95246. * @param mesh The mesh that this bone is attached to
  95247. * @returns The world position
  95248. */
  95249. getAbsolutePositionFromLocal(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  95250. /**
  95251. * Get the world position of a point that is in the local space of the bone and copy it to the result param
  95252. * @param position The local position
  95253. * @param mesh The mesh that this bone is attached to
  95254. * @param result The vector3 that the world position should be copied to
  95255. */
  95256. getAbsolutePositionFromLocalToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  95257. /**
  95258. * Get the local position of a point that is in world space
  95259. * @param position The world position
  95260. * @param mesh The mesh that this bone is attached to
  95261. * @returns The local position
  95262. */
  95263. getLocalPositionFromAbsolute(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  95264. /**
  95265. * Get the local position of a point that is in world space and copy it to the result param
  95266. * @param position The world position
  95267. * @param mesh The mesh that this bone is attached to
  95268. * @param result The vector3 that the local position should be copied to
  95269. */
  95270. getLocalPositionFromAbsoluteToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  95271. }
  95272. }
  95273. declare module BABYLON {
  95274. /**
  95275. * Defines a runtime animation
  95276. */
  95277. export class RuntimeAnimation {
  95278. private _events;
  95279. /**
  95280. * The current frame of the runtime animation
  95281. */
  95282. private _currentFrame;
  95283. /**
  95284. * The animation used by the runtime animation
  95285. */
  95286. private _animation;
  95287. /**
  95288. * The target of the runtime animation
  95289. */
  95290. private _target;
  95291. /**
  95292. * The initiating animatable
  95293. */
  95294. private _host;
  95295. /**
  95296. * The original value of the runtime animation
  95297. */
  95298. private _originalValue;
  95299. /**
  95300. * The original blend value of the runtime animation
  95301. */
  95302. private _originalBlendValue;
  95303. /**
  95304. * The offsets cache of the runtime animation
  95305. */
  95306. private _offsetsCache;
  95307. /**
  95308. * The high limits cache of the runtime animation
  95309. */
  95310. private _highLimitsCache;
  95311. /**
  95312. * Specifies if the runtime animation has been stopped
  95313. */
  95314. private _stopped;
  95315. /**
  95316. * The blending factor of the runtime animation
  95317. */
  95318. private _blendingFactor;
  95319. /**
  95320. * The BabylonJS scene
  95321. */
  95322. private _scene;
  95323. /**
  95324. * The current value of the runtime animation
  95325. */
  95326. private _currentValue;
  95327. /** @hidden */
  95328. _animationState: _IAnimationState;
  95329. /**
  95330. * The active target of the runtime animation
  95331. */
  95332. private _activeTargets;
  95333. private _currentActiveTarget;
  95334. private _directTarget;
  95335. /**
  95336. * The target path of the runtime animation
  95337. */
  95338. private _targetPath;
  95339. /**
  95340. * The weight of the runtime animation
  95341. */
  95342. private _weight;
  95343. /**
  95344. * The ratio offset of the runtime animation
  95345. */
  95346. private _ratioOffset;
  95347. /**
  95348. * The previous delay of the runtime animation
  95349. */
  95350. private _previousDelay;
  95351. /**
  95352. * The previous ratio of the runtime animation
  95353. */
  95354. private _previousRatio;
  95355. private _enableBlending;
  95356. private _keys;
  95357. private _minFrame;
  95358. private _maxFrame;
  95359. private _minValue;
  95360. private _maxValue;
  95361. private _targetIsArray;
  95362. /**
  95363. * Gets the current frame of the runtime animation
  95364. */
  95365. get currentFrame(): number;
  95366. /**
  95367. * Gets the weight of the runtime animation
  95368. */
  95369. get weight(): number;
  95370. /**
  95371. * Gets the current value of the runtime animation
  95372. */
  95373. get currentValue(): any;
  95374. /**
  95375. * Gets the target path of the runtime animation
  95376. */
  95377. get targetPath(): string;
  95378. /**
  95379. * Gets the actual target of the runtime animation
  95380. */
  95381. get target(): any;
  95382. /**
  95383. * Gets the additive state of the runtime animation
  95384. */
  95385. get isAdditive(): boolean;
  95386. /** @hidden */
  95387. _onLoop: () => void;
  95388. /**
  95389. * Create a new RuntimeAnimation object
  95390. * @param target defines the target of the animation
  95391. * @param animation defines the source animation object
  95392. * @param scene defines the hosting scene
  95393. * @param host defines the initiating Animatable
  95394. */
  95395. constructor(target: any, animation: Animation, scene: Scene, host: Animatable);
  95396. private _preparePath;
  95397. /**
  95398. * Gets the animation from the runtime animation
  95399. */
  95400. get animation(): Animation;
  95401. /**
  95402. * Resets the runtime animation to the beginning
  95403. * @param restoreOriginal defines whether to restore the target property to the original value
  95404. */
  95405. reset(restoreOriginal?: boolean): void;
  95406. /**
  95407. * Specifies if the runtime animation is stopped
  95408. * @returns Boolean specifying if the runtime animation is stopped
  95409. */
  95410. isStopped(): boolean;
  95411. /**
  95412. * Disposes of the runtime animation
  95413. */
  95414. dispose(): void;
  95415. /**
  95416. * Apply the interpolated value to the target
  95417. * @param currentValue defines the value computed by the animation
  95418. * @param weight defines the weight to apply to this value (Defaults to 1.0)
  95419. */
  95420. setValue(currentValue: any, weight: number): void;
  95421. private _getOriginalValues;
  95422. private _setValue;
  95423. /**
  95424. * Gets the loop pmode of the runtime animation
  95425. * @returns Loop Mode
  95426. */
  95427. private _getCorrectLoopMode;
  95428. /**
  95429. * Move the current animation to a given frame
  95430. * @param frame defines the frame to move to
  95431. */
  95432. goToFrame(frame: number): void;
  95433. /**
  95434. * @hidden Internal use only
  95435. */
  95436. _prepareForSpeedRatioChange(newSpeedRatio: number): void;
  95437. /**
  95438. * Execute the current animation
  95439. * @param delay defines the delay to add to the current frame
  95440. * @param from defines the lower bound of the animation range
  95441. * @param to defines the upper bound of the animation range
  95442. * @param loop defines if the current animation must loop
  95443. * @param speedRatio defines the current speed ratio
  95444. * @param weight defines the weight of the animation (default is -1 so no weight)
  95445. * @param onLoop optional callback called when animation loops
  95446. * @returns a boolean indicating if the animation is running
  95447. */
  95448. animate(delay: number, from: number, to: number, loop: boolean, speedRatio: number, weight?: number): boolean;
  95449. }
  95450. }
  95451. declare module BABYLON {
  95452. /**
  95453. * Class used to store an actual running animation
  95454. */
  95455. export class Animatable {
  95456. /** defines the target object */
  95457. target: any;
  95458. /** defines the starting frame number (default is 0) */
  95459. fromFrame: number;
  95460. /** defines the ending frame number (default is 100) */
  95461. toFrame: number;
  95462. /** defines if the animation must loop (default is false) */
  95463. loopAnimation: boolean;
  95464. /** defines a callback to call when animation ends if it is not looping */
  95465. onAnimationEnd?: (() => void) | null | undefined;
  95466. /** defines a callback to call when animation loops */
  95467. onAnimationLoop?: (() => void) | null | undefined;
  95468. /** defines whether the animation should be evaluated additively */
  95469. isAdditive: boolean;
  95470. private _localDelayOffset;
  95471. private _pausedDelay;
  95472. private _runtimeAnimations;
  95473. private _paused;
  95474. private _scene;
  95475. private _speedRatio;
  95476. private _weight;
  95477. private _syncRoot;
  95478. /**
  95479. * Gets or sets a boolean indicating if the animatable must be disposed and removed at the end of the animation.
  95480. * This will only apply for non looping animation (default is true)
  95481. */
  95482. disposeOnEnd: boolean;
  95483. /**
  95484. * Gets a boolean indicating if the animation has started
  95485. */
  95486. animationStarted: boolean;
  95487. /**
  95488. * Observer raised when the animation ends
  95489. */
  95490. onAnimationEndObservable: Observable<Animatable>;
  95491. /**
  95492. * Observer raised when the animation loops
  95493. */
  95494. onAnimationLoopObservable: Observable<Animatable>;
  95495. /**
  95496. * Gets the root Animatable used to synchronize and normalize animations
  95497. */
  95498. get syncRoot(): Nullable<Animatable>;
  95499. /**
  95500. * Gets the current frame of the first RuntimeAnimation
  95501. * Used to synchronize Animatables
  95502. */
  95503. get masterFrame(): number;
  95504. /**
  95505. * Gets or sets the animatable weight (-1.0 by default meaning not weighted)
  95506. */
  95507. get weight(): number;
  95508. set weight(value: number);
  95509. /**
  95510. * Gets or sets the speed ratio to apply to the animatable (1.0 by default)
  95511. */
  95512. get speedRatio(): number;
  95513. set speedRatio(value: number);
  95514. /**
  95515. * Creates a new Animatable
  95516. * @param scene defines the hosting scene
  95517. * @param target defines the target object
  95518. * @param fromFrame defines the starting frame number (default is 0)
  95519. * @param toFrame defines the ending frame number (default is 100)
  95520. * @param loopAnimation defines if the animation must loop (default is false)
  95521. * @param speedRatio defines the factor to apply to animation speed (default is 1)
  95522. * @param onAnimationEnd defines a callback to call when animation ends if it is not looping
  95523. * @param animations defines a group of animation to add to the new Animatable
  95524. * @param onAnimationLoop defines a callback to call when animation loops
  95525. * @param isAdditive defines whether the animation should be evaluated additively
  95526. */
  95527. constructor(scene: Scene,
  95528. /** defines the target object */
  95529. target: any,
  95530. /** defines the starting frame number (default is 0) */
  95531. fromFrame?: number,
  95532. /** defines the ending frame number (default is 100) */
  95533. toFrame?: number,
  95534. /** defines if the animation must loop (default is false) */
  95535. loopAnimation?: boolean, speedRatio?: number,
  95536. /** defines a callback to call when animation ends if it is not looping */
  95537. onAnimationEnd?: (() => void) | null | undefined, animations?: Animation[],
  95538. /** defines a callback to call when animation loops */
  95539. onAnimationLoop?: (() => void) | null | undefined,
  95540. /** defines whether the animation should be evaluated additively */
  95541. isAdditive?: boolean);
  95542. /**
  95543. * Synchronize and normalize current Animatable with a source Animatable
  95544. * This is useful when using animation weights and when animations are not of the same length
  95545. * @param root defines the root Animatable to synchronize with
  95546. * @returns the current Animatable
  95547. */
  95548. syncWith(root: Animatable): Animatable;
  95549. /**
  95550. * Gets the list of runtime animations
  95551. * @returns an array of RuntimeAnimation
  95552. */
  95553. getAnimations(): RuntimeAnimation[];
  95554. /**
  95555. * Adds more animations to the current animatable
  95556. * @param target defines the target of the animations
  95557. * @param animations defines the new animations to add
  95558. */
  95559. appendAnimations(target: any, animations: Animation[]): void;
  95560. /**
  95561. * Gets the source animation for a specific property
  95562. * @param property defines the propertyu to look for
  95563. * @returns null or the source animation for the given property
  95564. */
  95565. getAnimationByTargetProperty(property: string): Nullable<Animation>;
  95566. /**
  95567. * Gets the runtime animation for a specific property
  95568. * @param property defines the propertyu to look for
  95569. * @returns null or the runtime animation for the given property
  95570. */
  95571. getRuntimeAnimationByTargetProperty(property: string): Nullable<RuntimeAnimation>;
  95572. /**
  95573. * Resets the animatable to its original state
  95574. */
  95575. reset(): void;
  95576. /**
  95577. * Allows the animatable to blend with current running animations
  95578. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  95579. * @param blendingSpeed defines the blending speed to use
  95580. */
  95581. enableBlending(blendingSpeed: number): void;
  95582. /**
  95583. * Disable animation blending
  95584. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  95585. */
  95586. disableBlending(): void;
  95587. /**
  95588. * Jump directly to a given frame
  95589. * @param frame defines the frame to jump to
  95590. */
  95591. goToFrame(frame: number): void;
  95592. /**
  95593. * Pause the animation
  95594. */
  95595. pause(): void;
  95596. /**
  95597. * Restart the animation
  95598. */
  95599. restart(): void;
  95600. private _raiseOnAnimationEnd;
  95601. /**
  95602. * Stop and delete the current animation
  95603. * @param animationName defines a string used to only stop some of the runtime animations instead of all
  95604. * @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)
  95605. */
  95606. stop(animationName?: string, targetMask?: (target: any) => boolean): void;
  95607. /**
  95608. * Wait asynchronously for the animation to end
  95609. * @returns a promise which will be fullfilled when the animation ends
  95610. */
  95611. waitAsync(): Promise<Animatable>;
  95612. /** @hidden */
  95613. _animate(delay: number): boolean;
  95614. }
  95615. interface Scene {
  95616. /** @hidden */
  95617. _registerTargetForLateAnimationBinding(runtimeAnimation: RuntimeAnimation, originalValue: any): void;
  95618. /** @hidden */
  95619. _processLateAnimationBindingsForMatrices(holder: {
  95620. totalWeight: number;
  95621. totalAdditiveWeight: number;
  95622. animations: RuntimeAnimation[];
  95623. additiveAnimations: RuntimeAnimation[];
  95624. originalValue: Matrix;
  95625. }): any;
  95626. /** @hidden */
  95627. _processLateAnimationBindingsForQuaternions(holder: {
  95628. totalWeight: number;
  95629. totalAdditiveWeight: number;
  95630. animations: RuntimeAnimation[];
  95631. additiveAnimations: RuntimeAnimation[];
  95632. originalValue: Quaternion;
  95633. }, refQuaternion: Quaternion): Quaternion;
  95634. /** @hidden */
  95635. _processLateAnimationBindings(): void;
  95636. /**
  95637. * Will start the animation sequence of a given target
  95638. * @param target defines the target
  95639. * @param from defines from which frame should animation start
  95640. * @param to defines until which frame should animation run.
  95641. * @param weight defines the weight to apply to the animation (1.0 by default)
  95642. * @param loop defines if the animation loops
  95643. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  95644. * @param onAnimationEnd defines the function to be executed when the animation ends
  95645. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  95646. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  95647. * @param onAnimationLoop defines the callback to call when an animation loops
  95648. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  95649. * @returns the animatable object created for this animation
  95650. */
  95651. 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;
  95652. /**
  95653. * Will start the animation sequence of a given target
  95654. * @param target defines the target
  95655. * @param from defines from which frame should animation start
  95656. * @param to defines until which frame should animation run.
  95657. * @param loop defines if the animation loops
  95658. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  95659. * @param onAnimationEnd defines the function to be executed when the animation ends
  95660. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  95661. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  95662. * @param targetMask defines if the target should be animate if animations are present (this is called recursively on descendant animatables regardless of return value)
  95663. * @param onAnimationLoop defines the callback to call when an animation loops
  95664. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  95665. * @returns the animatable object created for this animation
  95666. */
  95667. 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;
  95668. /**
  95669. * Will start the animation sequence of a given target and its hierarchy
  95670. * @param target defines the target
  95671. * @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.
  95672. * @param from defines from which frame should animation start
  95673. * @param to defines until which frame should animation run.
  95674. * @param loop defines if the animation loops
  95675. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  95676. * @param onAnimationEnd defines the function to be executed when the animation ends
  95677. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  95678. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  95679. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  95680. * @param onAnimationLoop defines the callback to call when an animation loops
  95681. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  95682. * @returns the list of created animatables
  95683. */
  95684. 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[];
  95685. /**
  95686. * Begin a new animation on a given node
  95687. * @param target defines the target where the animation will take place
  95688. * @param animations defines the list of animations to start
  95689. * @param from defines the initial value
  95690. * @param to defines the final value
  95691. * @param loop defines if you want animation to loop (off by default)
  95692. * @param speedRatio defines the speed ratio to apply to all animations
  95693. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  95694. * @param onAnimationLoop defines the callback to call when an animation loops
  95695. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  95696. * @returns the list of created animatables
  95697. */
  95698. beginDirectAnimation(target: any, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable;
  95699. /**
  95700. * Begin a new animation on a given node and its hierarchy
  95701. * @param target defines the root node where the animation will take place
  95702. * @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.
  95703. * @param animations defines the list of animations to start
  95704. * @param from defines the initial value
  95705. * @param to defines the final value
  95706. * @param loop defines if you want animation to loop (off by default)
  95707. * @param speedRatio defines the speed ratio to apply to all animations
  95708. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  95709. * @param onAnimationLoop defines the callback to call when an animation loops
  95710. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  95711. * @returns the list of animatables created for all nodes
  95712. */
  95713. beginDirectHierarchyAnimation(target: Node, directDescendantsOnly: boolean, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable[];
  95714. /**
  95715. * Gets the animatable associated with a specific target
  95716. * @param target defines the target of the animatable
  95717. * @returns the required animatable if found
  95718. */
  95719. getAnimatableByTarget(target: any): Nullable<Animatable>;
  95720. /**
  95721. * Gets all animatables associated with a given target
  95722. * @param target defines the target to look animatables for
  95723. * @returns an array of Animatables
  95724. */
  95725. getAllAnimatablesByTarget(target: any): Array<Animatable>;
  95726. /**
  95727. * Stops and removes all animations that have been applied to the scene
  95728. */
  95729. stopAllAnimations(): void;
  95730. /**
  95731. * Gets the current delta time used by animation engine
  95732. */
  95733. deltaTime: number;
  95734. }
  95735. interface Bone {
  95736. /**
  95737. * Copy an animation range from another bone
  95738. * @param source defines the source bone
  95739. * @param rangeName defines the range name to copy
  95740. * @param frameOffset defines the frame offset
  95741. * @param rescaleAsRequired defines if rescaling must be applied if required
  95742. * @param skelDimensionsRatio defines the scaling ratio
  95743. * @returns true if operation was successful
  95744. */
  95745. copyAnimationRange(source: Bone, rangeName: string, frameOffset: number, rescaleAsRequired: boolean, skelDimensionsRatio: Nullable<Vector3>): boolean;
  95746. }
  95747. }
  95748. declare module BABYLON {
  95749. /**
  95750. * Class used to handle skinning animations
  95751. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  95752. */
  95753. export class Skeleton implements IAnimatable {
  95754. /** defines the skeleton name */
  95755. name: string;
  95756. /** defines the skeleton Id */
  95757. id: string;
  95758. /**
  95759. * Defines the list of child bones
  95760. */
  95761. bones: Bone[];
  95762. /**
  95763. * Defines an estimate of the dimension of the skeleton at rest
  95764. */
  95765. dimensionsAtRest: Vector3;
  95766. /**
  95767. * Defines a boolean indicating if the root matrix is provided by meshes or by the current skeleton (this is the default value)
  95768. */
  95769. needInitialSkinMatrix: boolean;
  95770. /**
  95771. * Defines a mesh that override the matrix used to get the world matrix (null by default).
  95772. */
  95773. overrideMesh: Nullable<AbstractMesh>;
  95774. /**
  95775. * Gets the list of animations attached to this skeleton
  95776. */
  95777. animations: Array<Animation>;
  95778. private _scene;
  95779. private _isDirty;
  95780. private _transformMatrices;
  95781. private _transformMatrixTexture;
  95782. private _meshesWithPoseMatrix;
  95783. private _animatables;
  95784. private _identity;
  95785. private _synchronizedWithMesh;
  95786. private _ranges;
  95787. private _lastAbsoluteTransformsUpdateId;
  95788. private _canUseTextureForBones;
  95789. private _uniqueId;
  95790. /** @hidden */
  95791. _numBonesWithLinkedTransformNode: number;
  95792. /** @hidden */
  95793. _hasWaitingData: Nullable<boolean>;
  95794. /** @hidden */
  95795. _waitingOverrideMeshId: Nullable<string>;
  95796. /**
  95797. * Specifies if the skeleton should be serialized
  95798. */
  95799. doNotSerialize: boolean;
  95800. private _useTextureToStoreBoneMatrices;
  95801. /**
  95802. * Gets or sets a boolean indicating that bone matrices should be stored as a texture instead of using shader uniforms (default is true).
  95803. * Please note that this option is not available if the hardware does not support it
  95804. */
  95805. get useTextureToStoreBoneMatrices(): boolean;
  95806. set useTextureToStoreBoneMatrices(value: boolean);
  95807. private _animationPropertiesOverride;
  95808. /**
  95809. * Gets or sets the animation properties override
  95810. */
  95811. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  95812. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  95813. /**
  95814. * List of inspectable custom properties (used by the Inspector)
  95815. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  95816. */
  95817. inspectableCustomProperties: IInspectable[];
  95818. /**
  95819. * An observable triggered before computing the skeleton's matrices
  95820. */
  95821. onBeforeComputeObservable: Observable<Skeleton>;
  95822. /**
  95823. * Gets a boolean indicating that the skeleton effectively stores matrices into a texture
  95824. */
  95825. get isUsingTextureForMatrices(): boolean;
  95826. /**
  95827. * Gets the unique ID of this skeleton
  95828. */
  95829. get uniqueId(): number;
  95830. /**
  95831. * Creates a new skeleton
  95832. * @param name defines the skeleton name
  95833. * @param id defines the skeleton Id
  95834. * @param scene defines the hosting scene
  95835. */
  95836. constructor(
  95837. /** defines the skeleton name */
  95838. name: string,
  95839. /** defines the skeleton Id */
  95840. id: string, scene: Scene);
  95841. /**
  95842. * Gets the current object class name.
  95843. * @return the class name
  95844. */
  95845. getClassName(): string;
  95846. /**
  95847. * Returns an array containing the root bones
  95848. * @returns an array containing the root bones
  95849. */
  95850. getChildren(): Array<Bone>;
  95851. /**
  95852. * Gets the list of transform matrices to send to shaders (one matrix per bone)
  95853. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  95854. * @returns a Float32Array containing matrices data
  95855. */
  95856. getTransformMatrices(mesh: AbstractMesh): Float32Array;
  95857. /**
  95858. * Gets the list of transform matrices to send to shaders inside a texture (one matrix per bone)
  95859. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  95860. * @returns a raw texture containing the data
  95861. */
  95862. getTransformMatrixTexture(mesh: AbstractMesh): Nullable<RawTexture>;
  95863. /**
  95864. * Gets the current hosting scene
  95865. * @returns a scene object
  95866. */
  95867. getScene(): Scene;
  95868. /**
  95869. * Gets a string representing the current skeleton data
  95870. * @param fullDetails defines a boolean indicating if we want a verbose version
  95871. * @returns a string representing the current skeleton data
  95872. */
  95873. toString(fullDetails?: boolean): string;
  95874. /**
  95875. * Get bone's index searching by name
  95876. * @param name defines bone's name to search for
  95877. * @return the indice of the bone. Returns -1 if not found
  95878. */
  95879. getBoneIndexByName(name: string): number;
  95880. /**
  95881. * Creater a new animation range
  95882. * @param name defines the name of the range
  95883. * @param from defines the start key
  95884. * @param to defines the end key
  95885. */
  95886. createAnimationRange(name: string, from: number, to: number): void;
  95887. /**
  95888. * Delete a specific animation range
  95889. * @param name defines the name of the range
  95890. * @param deleteFrames defines if frames must be removed as well
  95891. */
  95892. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  95893. /**
  95894. * Gets a specific animation range
  95895. * @param name defines the name of the range to look for
  95896. * @returns the requested animation range or null if not found
  95897. */
  95898. getAnimationRange(name: string): Nullable<AnimationRange>;
  95899. /**
  95900. * Gets the list of all animation ranges defined on this skeleton
  95901. * @returns an array
  95902. */
  95903. getAnimationRanges(): Nullable<AnimationRange>[];
  95904. /**
  95905. * Copy animation range from a source skeleton.
  95906. * This is not for a complete retargeting, only between very similar skeleton's with only possible bone length differences
  95907. * @param source defines the source skeleton
  95908. * @param name defines the name of the range to copy
  95909. * @param rescaleAsRequired defines if rescaling must be applied if required
  95910. * @returns true if operation was successful
  95911. */
  95912. copyAnimationRange(source: Skeleton, name: string, rescaleAsRequired?: boolean): boolean;
  95913. /**
  95914. * Forces the skeleton to go to rest pose
  95915. */
  95916. returnToRest(): void;
  95917. private _getHighestAnimationFrame;
  95918. /**
  95919. * Begin a specific animation range
  95920. * @param name defines the name of the range to start
  95921. * @param loop defines if looping must be turned on (false by default)
  95922. * @param speedRatio defines the speed ratio to apply (1 by default)
  95923. * @param onAnimationEnd defines a callback which will be called when animation will end
  95924. * @returns a new animatable
  95925. */
  95926. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  95927. /**
  95928. * Convert the keyframes for a range of animation on a skeleton to be relative to a given reference frame.
  95929. * @param skeleton defines the Skeleton containing the animation range to convert
  95930. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  95931. * @param range defines the name of the AnimationRange belonging to the Skeleton to convert
  95932. * @returns the original skeleton
  95933. */
  95934. static MakeAnimationAdditive(skeleton: Skeleton, referenceFrame: number | undefined, range: string): Nullable<Skeleton>;
  95935. /** @hidden */
  95936. _markAsDirty(): void;
  95937. /** @hidden */
  95938. _registerMeshWithPoseMatrix(mesh: AbstractMesh): void;
  95939. /** @hidden */
  95940. _unregisterMeshWithPoseMatrix(mesh: AbstractMesh): void;
  95941. private _computeTransformMatrices;
  95942. /**
  95943. * Build all resources required to render a skeleton
  95944. */
  95945. prepare(): void;
  95946. /**
  95947. * Gets the list of animatables currently running for this skeleton
  95948. * @returns an array of animatables
  95949. */
  95950. getAnimatables(): IAnimatable[];
  95951. /**
  95952. * Clone the current skeleton
  95953. * @param name defines the name of the new skeleton
  95954. * @param id defines the id of the new skeleton
  95955. * @returns the new skeleton
  95956. */
  95957. clone(name: string, id?: string): Skeleton;
  95958. /**
  95959. * Enable animation blending for this skeleton
  95960. * @param blendingSpeed defines the blending speed to apply
  95961. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  95962. */
  95963. enableBlending(blendingSpeed?: number): void;
  95964. /**
  95965. * Releases all resources associated with the current skeleton
  95966. */
  95967. dispose(): void;
  95968. /**
  95969. * Serialize the skeleton in a JSON object
  95970. * @returns a JSON object
  95971. */
  95972. serialize(): any;
  95973. /**
  95974. * Creates a new skeleton from serialized data
  95975. * @param parsedSkeleton defines the serialized data
  95976. * @param scene defines the hosting scene
  95977. * @returns a new skeleton
  95978. */
  95979. static Parse(parsedSkeleton: any, scene: Scene): Skeleton;
  95980. /**
  95981. * Compute all node absolute transforms
  95982. * @param forceUpdate defines if computation must be done even if cache is up to date
  95983. */
  95984. computeAbsoluteTransforms(forceUpdate?: boolean): void;
  95985. /**
  95986. * Gets the root pose matrix
  95987. * @returns a matrix
  95988. */
  95989. getPoseMatrix(): Nullable<Matrix>;
  95990. /**
  95991. * Sorts bones per internal index
  95992. */
  95993. sortBones(): void;
  95994. private _sortBones;
  95995. }
  95996. }
  95997. declare module BABYLON {
  95998. /**
  95999. * Creates an instance based on a source mesh.
  96000. */
  96001. export class InstancedMesh extends AbstractMesh {
  96002. private _sourceMesh;
  96003. private _currentLOD;
  96004. /** @hidden */
  96005. _indexInSourceMeshInstanceArray: number;
  96006. constructor(name: string, source: Mesh);
  96007. /**
  96008. * Returns the string "InstancedMesh".
  96009. */
  96010. getClassName(): string;
  96011. /** Gets the list of lights affecting that mesh */
  96012. get lightSources(): Light[];
  96013. _resyncLightSources(): void;
  96014. _resyncLightSource(light: Light): void;
  96015. _removeLightSource(light: Light, dispose: boolean): void;
  96016. /**
  96017. * If the source mesh receives shadows
  96018. */
  96019. get receiveShadows(): boolean;
  96020. /**
  96021. * The material of the source mesh
  96022. */
  96023. get material(): Nullable<Material>;
  96024. /**
  96025. * Visibility of the source mesh
  96026. */
  96027. get visibility(): number;
  96028. /**
  96029. * Skeleton of the source mesh
  96030. */
  96031. get skeleton(): Nullable<Skeleton>;
  96032. /**
  96033. * Rendering ground id of the source mesh
  96034. */
  96035. get renderingGroupId(): number;
  96036. set renderingGroupId(value: number);
  96037. /**
  96038. * Returns the total number of vertices (integer).
  96039. */
  96040. getTotalVertices(): number;
  96041. /**
  96042. * Returns a positive integer : the total number of indices in this mesh geometry.
  96043. * @returns the numner of indices or zero if the mesh has no geometry.
  96044. */
  96045. getTotalIndices(): number;
  96046. /**
  96047. * The source mesh of the instance
  96048. */
  96049. get sourceMesh(): Mesh;
  96050. /**
  96051. * Creates a new InstancedMesh object from the mesh model.
  96052. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  96053. * @param name defines the name of the new instance
  96054. * @returns a new InstancedMesh
  96055. */
  96056. createInstance(name: string): InstancedMesh;
  96057. /**
  96058. * Is this node ready to be used/rendered
  96059. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  96060. * @return {boolean} is it ready
  96061. */
  96062. isReady(completeCheck?: boolean): boolean;
  96063. /**
  96064. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  96065. * @param kind kind of verticies to retreive (eg. positons, normals, uvs, etc.)
  96066. * @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.
  96067. * @returns a float array or a Float32Array of the requested kind of data : positons, normals, uvs, etc.
  96068. */
  96069. getVerticesData(kind: string, copyWhenShared?: boolean): Nullable<FloatArray>;
  96070. /**
  96071. * Sets the vertex data of the mesh geometry for the requested `kind`.
  96072. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  96073. * The `data` are either a numeric array either a Float32Array.
  96074. * The parameter `updatable` is passed as is to the underlying Geometry object constructor (if initianilly none) or updater.
  96075. * 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).
  96076. * Note that a new underlying VertexBuffer object is created each call.
  96077. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  96078. *
  96079. * Possible `kind` values :
  96080. * - VertexBuffer.PositionKind
  96081. * - VertexBuffer.UVKind
  96082. * - VertexBuffer.UV2Kind
  96083. * - VertexBuffer.UV3Kind
  96084. * - VertexBuffer.UV4Kind
  96085. * - VertexBuffer.UV5Kind
  96086. * - VertexBuffer.UV6Kind
  96087. * - VertexBuffer.ColorKind
  96088. * - VertexBuffer.MatricesIndicesKind
  96089. * - VertexBuffer.MatricesIndicesExtraKind
  96090. * - VertexBuffer.MatricesWeightsKind
  96091. * - VertexBuffer.MatricesWeightsExtraKind
  96092. *
  96093. * Returns the Mesh.
  96094. */
  96095. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  96096. /**
  96097. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  96098. * If the mesh has no geometry, it is simply returned as it is.
  96099. * The `data` are either a numeric array either a Float32Array.
  96100. * No new underlying VertexBuffer object is created.
  96101. * 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.
  96102. * If the parameter `makeItUnique` is true, a new global geometry is created from this positions and is set to the mesh.
  96103. *
  96104. * Possible `kind` values :
  96105. * - VertexBuffer.PositionKind
  96106. * - VertexBuffer.UVKind
  96107. * - VertexBuffer.UV2Kind
  96108. * - VertexBuffer.UV3Kind
  96109. * - VertexBuffer.UV4Kind
  96110. * - VertexBuffer.UV5Kind
  96111. * - VertexBuffer.UV6Kind
  96112. * - VertexBuffer.ColorKind
  96113. * - VertexBuffer.MatricesIndicesKind
  96114. * - VertexBuffer.MatricesIndicesExtraKind
  96115. * - VertexBuffer.MatricesWeightsKind
  96116. * - VertexBuffer.MatricesWeightsExtraKind
  96117. *
  96118. * Returns the Mesh.
  96119. */
  96120. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): Mesh;
  96121. /**
  96122. * Sets the mesh indices.
  96123. * Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array).
  96124. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  96125. * This method creates a new index buffer each call.
  96126. * Returns the Mesh.
  96127. */
  96128. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>): Mesh;
  96129. /**
  96130. * Boolean : True if the mesh owns the requested kind of data.
  96131. */
  96132. isVerticesDataPresent(kind: string): boolean;
  96133. /**
  96134. * Returns an array of indices (IndicesArray).
  96135. */
  96136. getIndices(): Nullable<IndicesArray>;
  96137. get _positions(): Nullable<Vector3[]>;
  96138. /**
  96139. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  96140. * This means the mesh underlying bounding box and sphere are recomputed.
  96141. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  96142. * @returns the current mesh
  96143. */
  96144. refreshBoundingInfo(applySkeleton?: boolean): InstancedMesh;
  96145. /** @hidden */
  96146. _preActivate(): InstancedMesh;
  96147. /** @hidden */
  96148. _activate(renderId: number, intermediateRendering: boolean): boolean;
  96149. /** @hidden */
  96150. _postActivate(): void;
  96151. getWorldMatrix(): Matrix;
  96152. get isAnInstance(): boolean;
  96153. /**
  96154. * Returns the current associated LOD AbstractMesh.
  96155. */
  96156. getLOD(camera: Camera): AbstractMesh;
  96157. /** @hidden */
  96158. _preActivateForIntermediateRendering(renderId: number): Mesh;
  96159. /** @hidden */
  96160. _syncSubMeshes(): InstancedMesh;
  96161. /** @hidden */
  96162. _generatePointsArray(): boolean;
  96163. /** @hidden */
  96164. _updateBoundingInfo(): AbstractMesh;
  96165. /**
  96166. * Creates a new InstancedMesh from the current mesh.
  96167. * - name (string) : the cloned mesh name
  96168. * - newParent (optional Node) : the optional Node to parent the clone to.
  96169. * - doNotCloneChildren (optional boolean, default `false`) : if `true` the model children aren't cloned.
  96170. *
  96171. * Returns the clone.
  96172. */
  96173. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): InstancedMesh;
  96174. /**
  96175. * Disposes the InstancedMesh.
  96176. * Returns nothing.
  96177. */
  96178. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  96179. }
  96180. interface Mesh {
  96181. /**
  96182. * Register a custom buffer that will be instanced
  96183. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  96184. * @param kind defines the buffer kind
  96185. * @param stride defines the stride in floats
  96186. */
  96187. registerInstancedBuffer(kind: string, stride: number): void;
  96188. /**
  96189. * true to use the edge renderer for all instances of this mesh
  96190. */
  96191. edgesShareWithInstances: boolean;
  96192. /** @hidden */
  96193. _userInstancedBuffersStorage: {
  96194. data: {
  96195. [key: string]: Float32Array;
  96196. };
  96197. sizes: {
  96198. [key: string]: number;
  96199. };
  96200. vertexBuffers: {
  96201. [key: string]: Nullable<VertexBuffer>;
  96202. };
  96203. strides: {
  96204. [key: string]: number;
  96205. };
  96206. };
  96207. }
  96208. interface AbstractMesh {
  96209. /**
  96210. * Object used to store instanced buffers defined by user
  96211. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  96212. */
  96213. instancedBuffers: {
  96214. [key: string]: any;
  96215. };
  96216. }
  96217. }
  96218. declare module BABYLON {
  96219. /**
  96220. * Defines the options associated with the creation of a shader material.
  96221. */
  96222. export interface IShaderMaterialOptions {
  96223. /**
  96224. * Does the material work in alpha blend mode
  96225. */
  96226. needAlphaBlending: boolean;
  96227. /**
  96228. * Does the material work in alpha test mode
  96229. */
  96230. needAlphaTesting: boolean;
  96231. /**
  96232. * The list of attribute names used in the shader
  96233. */
  96234. attributes: string[];
  96235. /**
  96236. * The list of unifrom names used in the shader
  96237. */
  96238. uniforms: string[];
  96239. /**
  96240. * The list of UBO names used in the shader
  96241. */
  96242. uniformBuffers: string[];
  96243. /**
  96244. * The list of sampler names used in the shader
  96245. */
  96246. samplers: string[];
  96247. /**
  96248. * The list of defines used in the shader
  96249. */
  96250. defines: string[];
  96251. }
  96252. /**
  96253. * 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.
  96254. *
  96255. * This returned material effects how the mesh will look based on the code in the shaders.
  96256. *
  96257. * @see https://doc.babylonjs.com/how_to/shader_material
  96258. */
  96259. export class ShaderMaterial extends Material {
  96260. private _shaderPath;
  96261. private _options;
  96262. private _textures;
  96263. private _textureArrays;
  96264. private _floats;
  96265. private _ints;
  96266. private _floatsArrays;
  96267. private _colors3;
  96268. private _colors3Arrays;
  96269. private _colors4;
  96270. private _colors4Arrays;
  96271. private _vectors2;
  96272. private _vectors3;
  96273. private _vectors4;
  96274. private _matrices;
  96275. private _matrixArrays;
  96276. private _matrices3x3;
  96277. private _matrices2x2;
  96278. private _vectors2Arrays;
  96279. private _vectors3Arrays;
  96280. private _vectors4Arrays;
  96281. private _cachedWorldViewMatrix;
  96282. private _cachedWorldViewProjectionMatrix;
  96283. private _renderId;
  96284. private _multiview;
  96285. private _cachedDefines;
  96286. /** Define the Url to load snippets */
  96287. static SnippetUrl: string;
  96288. /** Snippet ID if the material was created from the snippet server */
  96289. snippetId: string;
  96290. /**
  96291. * Instantiate a new shader material.
  96292. * 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.
  96293. * This returned material effects how the mesh will look based on the code in the shaders.
  96294. * @see https://doc.babylonjs.com/how_to/shader_material
  96295. * @param name Define the name of the material in the scene
  96296. * @param scene Define the scene the material belongs to
  96297. * @param shaderPath Defines the route to the shader code in one of three ways:
  96298. * * object: { vertex: "custom", fragment: "custom" }, used with Effect.ShadersStore["customVertexShader"] and Effect.ShadersStore["customFragmentShader"]
  96299. * * object: { vertexElement: "vertexShaderCode", fragmentElement: "fragmentShaderCode" }, used with shader code in script tags
  96300. * * object: { vertexSource: "vertex shader code string", fragmentSource: "fragment shader code string" } using with strings containing the shaders code
  96301. * * string: "./COMMON_NAME", used with external files COMMON_NAME.vertex.fx and COMMON_NAME.fragment.fx in index.html folder.
  96302. * @param options Define the options used to create the shader
  96303. */
  96304. constructor(name: string, scene: Scene, shaderPath: any, options?: Partial<IShaderMaterialOptions>);
  96305. /**
  96306. * Gets the shader path used to define the shader code
  96307. * It can be modified to trigger a new compilation
  96308. */
  96309. get shaderPath(): any;
  96310. /**
  96311. * Sets the shader path used to define the shader code
  96312. * It can be modified to trigger a new compilation
  96313. */
  96314. set shaderPath(shaderPath: any);
  96315. /**
  96316. * Gets the options used to compile the shader.
  96317. * They can be modified to trigger a new compilation
  96318. */
  96319. get options(): IShaderMaterialOptions;
  96320. /**
  96321. * Gets the current class name of the material e.g. "ShaderMaterial"
  96322. * Mainly use in serialization.
  96323. * @returns the class name
  96324. */
  96325. getClassName(): string;
  96326. /**
  96327. * Specifies if the material will require alpha blending
  96328. * @returns a boolean specifying if alpha blending is needed
  96329. */
  96330. needAlphaBlending(): boolean;
  96331. /**
  96332. * Specifies if this material should be rendered in alpha test mode
  96333. * @returns a boolean specifying if an alpha test is needed.
  96334. */
  96335. needAlphaTesting(): boolean;
  96336. private _checkUniform;
  96337. /**
  96338. * Set a texture in the shader.
  96339. * @param name Define the name of the uniform samplers as defined in the shader
  96340. * @param texture Define the texture to bind to this sampler
  96341. * @return the material itself allowing "fluent" like uniform updates
  96342. */
  96343. setTexture(name: string, texture: BaseTexture): ShaderMaterial;
  96344. /**
  96345. * Set a texture array in the shader.
  96346. * @param name Define the name of the uniform sampler array as defined in the shader
  96347. * @param textures Define the list of textures to bind to this sampler
  96348. * @return the material itself allowing "fluent" like uniform updates
  96349. */
  96350. setTextureArray(name: string, textures: BaseTexture[]): ShaderMaterial;
  96351. /**
  96352. * Set a float in the shader.
  96353. * @param name Define the name of the uniform as defined in the shader
  96354. * @param value Define the value to give to the uniform
  96355. * @return the material itself allowing "fluent" like uniform updates
  96356. */
  96357. setFloat(name: string, value: number): ShaderMaterial;
  96358. /**
  96359. * Set a int in the shader.
  96360. * @param name Define the name of the uniform as defined in the shader
  96361. * @param value Define the value to give to the uniform
  96362. * @return the material itself allowing "fluent" like uniform updates
  96363. */
  96364. setInt(name: string, value: number): ShaderMaterial;
  96365. /**
  96366. * Set an array of floats in the shader.
  96367. * @param name Define the name of the uniform as defined in the shader
  96368. * @param value Define the value to give to the uniform
  96369. * @return the material itself allowing "fluent" like uniform updates
  96370. */
  96371. setFloats(name: string, value: number[]): ShaderMaterial;
  96372. /**
  96373. * Set a vec3 in the shader from a Color3.
  96374. * @param name Define the name of the uniform as defined in the shader
  96375. * @param value Define the value to give to the uniform
  96376. * @return the material itself allowing "fluent" like uniform updates
  96377. */
  96378. setColor3(name: string, value: Color3): ShaderMaterial;
  96379. /**
  96380. * Set a vec3 array in the shader from a Color3 array.
  96381. * @param name Define the name of the uniform as defined in the shader
  96382. * @param value Define the value to give to the uniform
  96383. * @return the material itself allowing "fluent" like uniform updates
  96384. */
  96385. setColor3Array(name: string, value: Color3[]): ShaderMaterial;
  96386. /**
  96387. * Set a vec4 in the shader from a Color4.
  96388. * @param name Define the name of the uniform as defined in the shader
  96389. * @param value Define the value to give to the uniform
  96390. * @return the material itself allowing "fluent" like uniform updates
  96391. */
  96392. setColor4(name: string, value: Color4): ShaderMaterial;
  96393. /**
  96394. * Set a vec4 array in the shader from a Color4 array.
  96395. * @param name Define the name of the uniform as defined in the shader
  96396. * @param value Define the value to give to the uniform
  96397. * @return the material itself allowing "fluent" like uniform updates
  96398. */
  96399. setColor4Array(name: string, value: Color4[]): ShaderMaterial;
  96400. /**
  96401. * Set a vec2 in the shader from a Vector2.
  96402. * @param name Define the name of the uniform as defined in the shader
  96403. * @param value Define the value to give to the uniform
  96404. * @return the material itself allowing "fluent" like uniform updates
  96405. */
  96406. setVector2(name: string, value: Vector2): ShaderMaterial;
  96407. /**
  96408. * Set a vec3 in the shader from a Vector3.
  96409. * @param name Define the name of the uniform as defined in the shader
  96410. * @param value Define the value to give to the uniform
  96411. * @return the material itself allowing "fluent" like uniform updates
  96412. */
  96413. setVector3(name: string, value: Vector3): ShaderMaterial;
  96414. /**
  96415. * Set a vec4 in the shader from a Vector4.
  96416. * @param name Define the name of the uniform as defined in the shader
  96417. * @param value Define the value to give to the uniform
  96418. * @return the material itself allowing "fluent" like uniform updates
  96419. */
  96420. setVector4(name: string, value: Vector4): ShaderMaterial;
  96421. /**
  96422. * Set a mat4 in the shader from a Matrix.
  96423. * @param name Define the name of the uniform as defined in the shader
  96424. * @param value Define the value to give to the uniform
  96425. * @return the material itself allowing "fluent" like uniform updates
  96426. */
  96427. setMatrix(name: string, value: Matrix): ShaderMaterial;
  96428. /**
  96429. * Set a float32Array in the shader from a matrix array.
  96430. * @param name Define the name of the uniform as defined in the shader
  96431. * @param value Define the value to give to the uniform
  96432. * @return the material itself allowing "fluent" like uniform updates
  96433. */
  96434. setMatrices(name: string, value: Matrix[]): ShaderMaterial;
  96435. /**
  96436. * Set a mat3 in the shader from a Float32Array.
  96437. * @param name Define the name of the uniform as defined in the shader
  96438. * @param value Define the value to give to the uniform
  96439. * @return the material itself allowing "fluent" like uniform updates
  96440. */
  96441. setMatrix3x3(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  96442. /**
  96443. * Set a mat2 in the shader from a Float32Array.
  96444. * @param name Define the name of the uniform as defined in the shader
  96445. * @param value Define the value to give to the uniform
  96446. * @return the material itself allowing "fluent" like uniform updates
  96447. */
  96448. setMatrix2x2(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  96449. /**
  96450. * Set a vec2 array in the shader from a number array.
  96451. * @param name Define the name of the uniform as defined in the shader
  96452. * @param value Define the value to give to the uniform
  96453. * @return the material itself allowing "fluent" like uniform updates
  96454. */
  96455. setArray2(name: string, value: number[]): ShaderMaterial;
  96456. /**
  96457. * Set a vec3 array in the shader from a number array.
  96458. * @param name Define the name of the uniform as defined in the shader
  96459. * @param value Define the value to give to the uniform
  96460. * @return the material itself allowing "fluent" like uniform updates
  96461. */
  96462. setArray3(name: string, value: number[]): ShaderMaterial;
  96463. /**
  96464. * Set a vec4 array in the shader from a number array.
  96465. * @param name Define the name of the uniform as defined in the shader
  96466. * @param value Define the value to give to the uniform
  96467. * @return the material itself allowing "fluent" like uniform updates
  96468. */
  96469. setArray4(name: string, value: number[]): ShaderMaterial;
  96470. private _checkCache;
  96471. /**
  96472. * Specifies that the submesh is ready to be used
  96473. * @param mesh defines the mesh to check
  96474. * @param subMesh defines which submesh to check
  96475. * @param useInstances specifies that instances should be used
  96476. * @returns a boolean indicating that the submesh is ready or not
  96477. */
  96478. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  96479. /**
  96480. * Checks if the material is ready to render the requested mesh
  96481. * @param mesh Define the mesh to render
  96482. * @param useInstances Define whether or not the material is used with instances
  96483. * @returns true if ready, otherwise false
  96484. */
  96485. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  96486. /**
  96487. * Binds the world matrix to the material
  96488. * @param world defines the world transformation matrix
  96489. * @param effectOverride - If provided, use this effect instead of internal effect
  96490. */
  96491. bindOnlyWorldMatrix(world: Matrix, effectOverride?: Nullable<Effect>): void;
  96492. /**
  96493. * Binds the submesh to this material by preparing the effect and shader to draw
  96494. * @param world defines the world transformation matrix
  96495. * @param mesh defines the mesh containing the submesh
  96496. * @param subMesh defines the submesh to bind the material to
  96497. */
  96498. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  96499. /**
  96500. * Binds the material to the mesh
  96501. * @param world defines the world transformation matrix
  96502. * @param mesh defines the mesh to bind the material to
  96503. * @param effectOverride - If provided, use this effect instead of internal effect
  96504. */
  96505. bind(world: Matrix, mesh?: Mesh, effectOverride?: Nullable<Effect>): void;
  96506. protected _afterBind(mesh?: Mesh): void;
  96507. /**
  96508. * Gets the active textures from the material
  96509. * @returns an array of textures
  96510. */
  96511. getActiveTextures(): BaseTexture[];
  96512. /**
  96513. * Specifies if the material uses a texture
  96514. * @param texture defines the texture to check against the material
  96515. * @returns a boolean specifying if the material uses the texture
  96516. */
  96517. hasTexture(texture: BaseTexture): boolean;
  96518. /**
  96519. * Makes a duplicate of the material, and gives it a new name
  96520. * @param name defines the new name for the duplicated material
  96521. * @returns the cloned material
  96522. */
  96523. clone(name: string): ShaderMaterial;
  96524. /**
  96525. * Disposes the material
  96526. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  96527. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  96528. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  96529. */
  96530. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  96531. /**
  96532. * Serializes this material in a JSON representation
  96533. * @returns the serialized material object
  96534. */
  96535. serialize(): any;
  96536. /**
  96537. * Creates a shader material from parsed shader material data
  96538. * @param source defines the JSON represnetation of the material
  96539. * @param scene defines the hosting scene
  96540. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  96541. * @returns a new material
  96542. */
  96543. static Parse(source: any, scene: Scene, rootUrl: string): ShaderMaterial;
  96544. /**
  96545. * Creates a new ShaderMaterial from a snippet saved in a remote file
  96546. * @param name defines the name of the ShaderMaterial to create (can be null or empty to use the one from the json data)
  96547. * @param url defines the url to load from
  96548. * @param scene defines the hosting scene
  96549. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  96550. * @returns a promise that will resolve to the new ShaderMaterial
  96551. */
  96552. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  96553. /**
  96554. * Creates a ShaderMaterial from a snippet saved by the Inspector
  96555. * @param snippetId defines the snippet to load
  96556. * @param scene defines the hosting scene
  96557. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  96558. * @returns a promise that will resolve to the new ShaderMaterial
  96559. */
  96560. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  96561. }
  96562. }
  96563. declare module BABYLON {
  96564. /** @hidden */
  96565. export var colorPixelShader: {
  96566. name: string;
  96567. shader: string;
  96568. };
  96569. }
  96570. declare module BABYLON {
  96571. /** @hidden */
  96572. export var colorVertexShader: {
  96573. name: string;
  96574. shader: string;
  96575. };
  96576. }
  96577. declare module BABYLON {
  96578. /**
  96579. * Line mesh
  96580. * @see https://doc.babylonjs.com/babylon101/parametric_shapes
  96581. */
  96582. export class LinesMesh extends Mesh {
  96583. /**
  96584. * If vertex color should be applied to the mesh
  96585. */
  96586. readonly useVertexColor?: boolean | undefined;
  96587. /**
  96588. * If vertex alpha should be applied to the mesh
  96589. */
  96590. readonly useVertexAlpha?: boolean | undefined;
  96591. /**
  96592. * Color of the line (Default: White)
  96593. */
  96594. color: Color3;
  96595. /**
  96596. * Alpha of the line (Default: 1)
  96597. */
  96598. alpha: number;
  96599. /**
  96600. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  96601. * This margin is expressed in world space coordinates, so its value may vary.
  96602. * Default value is 0.1
  96603. */
  96604. intersectionThreshold: number;
  96605. private _colorShader;
  96606. private color4;
  96607. /**
  96608. * Creates a new LinesMesh
  96609. * @param name defines the name
  96610. * @param scene defines the hosting scene
  96611. * @param parent defines the parent mesh if any
  96612. * @param source defines the optional source LinesMesh used to clone data from
  96613. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  96614. * When false, achieved by calling a clone(), also passing False.
  96615. * This will make creation of children, recursive.
  96616. * @param useVertexColor defines if this LinesMesh supports vertex color
  96617. * @param useVertexAlpha defines if this LinesMesh supports vertex alpha
  96618. */
  96619. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<LinesMesh>, doNotCloneChildren?: boolean,
  96620. /**
  96621. * If vertex color should be applied to the mesh
  96622. */
  96623. useVertexColor?: boolean | undefined,
  96624. /**
  96625. * If vertex alpha should be applied to the mesh
  96626. */
  96627. useVertexAlpha?: boolean | undefined);
  96628. private _addClipPlaneDefine;
  96629. private _removeClipPlaneDefine;
  96630. isReady(): boolean;
  96631. /**
  96632. * Returns the string "LineMesh"
  96633. */
  96634. getClassName(): string;
  96635. /**
  96636. * @hidden
  96637. */
  96638. get material(): Material;
  96639. /**
  96640. * @hidden
  96641. */
  96642. set material(value: Material);
  96643. /**
  96644. * @hidden
  96645. */
  96646. get checkCollisions(): boolean;
  96647. /** @hidden */
  96648. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  96649. /** @hidden */
  96650. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  96651. /**
  96652. * Disposes of the line mesh
  96653. * @param doNotRecurse If children should be disposed
  96654. */
  96655. dispose(doNotRecurse?: boolean): void;
  96656. /**
  96657. * Returns a new LineMesh object cloned from the current one.
  96658. */
  96659. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): LinesMesh;
  96660. /**
  96661. * Creates a new InstancedLinesMesh object from the mesh model.
  96662. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  96663. * @param name defines the name of the new instance
  96664. * @returns a new InstancedLinesMesh
  96665. */
  96666. createInstance(name: string): InstancedLinesMesh;
  96667. }
  96668. /**
  96669. * Creates an instance based on a source LinesMesh
  96670. */
  96671. export class InstancedLinesMesh extends InstancedMesh {
  96672. /**
  96673. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  96674. * This margin is expressed in world space coordinates, so its value may vary.
  96675. * Initilized with the intersectionThreshold value of the source LinesMesh
  96676. */
  96677. intersectionThreshold: number;
  96678. constructor(name: string, source: LinesMesh);
  96679. /**
  96680. * Returns the string "InstancedLinesMesh".
  96681. */
  96682. getClassName(): string;
  96683. }
  96684. }
  96685. declare module BABYLON {
  96686. /** @hidden */
  96687. export var linePixelShader: {
  96688. name: string;
  96689. shader: string;
  96690. };
  96691. }
  96692. declare module BABYLON {
  96693. /** @hidden */
  96694. export var lineVertexShader: {
  96695. name: string;
  96696. shader: string;
  96697. };
  96698. }
  96699. declare module BABYLON {
  96700. interface Scene {
  96701. /** @hidden */
  96702. _edgeRenderLineShader: Nullable<ShaderMaterial>;
  96703. }
  96704. interface AbstractMesh {
  96705. /**
  96706. * Gets the edgesRenderer associated with the mesh
  96707. */
  96708. edgesRenderer: Nullable<EdgesRenderer>;
  96709. }
  96710. interface LinesMesh {
  96711. /**
  96712. * Enables the edge rendering mode on the mesh.
  96713. * This mode makes the mesh edges visible
  96714. * @param epsilon defines the maximal distance between two angles to detect a face
  96715. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  96716. * @returns the currentAbstractMesh
  96717. * @see https://www.babylonjs-playground.com/#19O9TU#0
  96718. */
  96719. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  96720. }
  96721. interface InstancedLinesMesh {
  96722. /**
  96723. * Enables the edge rendering mode on the mesh.
  96724. * This mode makes the mesh edges visible
  96725. * @param epsilon defines the maximal distance between two angles to detect a face
  96726. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  96727. * @returns the current InstancedLinesMesh
  96728. * @see https://www.babylonjs-playground.com/#19O9TU#0
  96729. */
  96730. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): InstancedLinesMesh;
  96731. }
  96732. /**
  96733. * Defines the minimum contract an Edges renderer should follow.
  96734. */
  96735. export interface IEdgesRenderer extends IDisposable {
  96736. /**
  96737. * Gets or sets a boolean indicating if the edgesRenderer is active
  96738. */
  96739. isEnabled: boolean;
  96740. /**
  96741. * Renders the edges of the attached mesh,
  96742. */
  96743. render(): void;
  96744. /**
  96745. * Checks wether or not the edges renderer is ready to render.
  96746. * @return true if ready, otherwise false.
  96747. */
  96748. isReady(): boolean;
  96749. /**
  96750. * List of instances to render in case the source mesh has instances
  96751. */
  96752. customInstances: SmartArray<Matrix>;
  96753. }
  96754. /**
  96755. * Defines the additional options of the edges renderer
  96756. */
  96757. export interface IEdgesRendererOptions {
  96758. /**
  96759. * Gets or sets a boolean indicating that the alternate edge finder algorithm must be used
  96760. * If not defined, the default value is true
  96761. */
  96762. useAlternateEdgeFinder?: boolean;
  96763. /**
  96764. * Gets or sets a boolean indicating that the vertex merger fast processing must be used.
  96765. * If not defined, the default value is true.
  96766. * 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)
  96767. * This option is used only if useAlternateEdgeFinder = true
  96768. */
  96769. useFastVertexMerger?: boolean;
  96770. /**
  96771. * During edges processing, the vertices are merged if they are close enough: epsilonVertexMerge is the limit whithin which vertices are considered to be equal.
  96772. * The default value is 1e-6
  96773. * This option is used only if useAlternateEdgeFinder = true
  96774. */
  96775. epsilonVertexMerge?: number;
  96776. /**
  96777. * 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
  96778. * 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.
  96779. * This option is used only if useAlternateEdgeFinder = true
  96780. */
  96781. applyTessellation?: boolean;
  96782. /**
  96783. * 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
  96784. * The default value is 1e-6
  96785. * This option is used only if useAlternateEdgeFinder = true
  96786. */
  96787. epsilonVertexAligned?: number;
  96788. }
  96789. /**
  96790. * This class is used to generate edges of the mesh that could then easily be rendered in a scene.
  96791. */
  96792. export class EdgesRenderer implements IEdgesRenderer {
  96793. /**
  96794. * Define the size of the edges with an orthographic camera
  96795. */
  96796. edgesWidthScalerForOrthographic: number;
  96797. /**
  96798. * Define the size of the edges with a perspective camera
  96799. */
  96800. edgesWidthScalerForPerspective: number;
  96801. protected _source: AbstractMesh;
  96802. protected _linesPositions: number[];
  96803. protected _linesNormals: number[];
  96804. protected _linesIndices: number[];
  96805. protected _epsilon: number;
  96806. protected _indicesCount: number;
  96807. protected _lineShader: ShaderMaterial;
  96808. protected _ib: DataBuffer;
  96809. protected _buffers: {
  96810. [key: string]: Nullable<VertexBuffer>;
  96811. };
  96812. protected _buffersForInstances: {
  96813. [key: string]: Nullable<VertexBuffer>;
  96814. };
  96815. protected _checkVerticesInsteadOfIndices: boolean;
  96816. protected _options: Nullable<IEdgesRendererOptions>;
  96817. private _meshRebuildObserver;
  96818. private _meshDisposeObserver;
  96819. /** Gets or sets a boolean indicating if the edgesRenderer is active */
  96820. isEnabled: boolean;
  96821. /**
  96822. * List of instances to render in case the source mesh has instances
  96823. */
  96824. customInstances: SmartArray<Matrix>;
  96825. private static GetShader;
  96826. /**
  96827. * Creates an instance of the EdgesRenderer. It is primarily use to display edges of a mesh.
  96828. * Beware when you use this class with complex objects as the adjacencies computation can be really long
  96829. * @param source Mesh used to create edges
  96830. * @param epsilon sum of angles in adjacency to check for edge
  96831. * @param checkVerticesInsteadOfIndices bases the edges detection on vertices vs indices. Note that this parameter is not used if options.useAlternateEdgeFinder = true
  96832. * @param generateEdgesLines - should generate Lines or only prepare resources.
  96833. * @param options The options to apply when generating the edges
  96834. */
  96835. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean, generateEdgesLines?: boolean, options?: IEdgesRendererOptions);
  96836. protected _prepareRessources(): void;
  96837. /** @hidden */
  96838. _rebuild(): void;
  96839. /**
  96840. * Releases the required resources for the edges renderer
  96841. */
  96842. dispose(): void;
  96843. protected _processEdgeForAdjacencies(pa: number, pb: number, p0: number, p1: number, p2: number): number;
  96844. protected _processEdgeForAdjacenciesWithVertices(pa: Vector3, pb: Vector3, p0: Vector3, p1: Vector3, p2: Vector3): number;
  96845. /**
  96846. * Checks if the pair of p0 and p1 is en edge
  96847. * @param faceIndex
  96848. * @param edge
  96849. * @param faceNormals
  96850. * @param p0
  96851. * @param p1
  96852. * @private
  96853. */
  96854. protected _checkEdge(faceIndex: number, edge: number, faceNormals: Array<Vector3>, p0: Vector3, p1: Vector3): void;
  96855. /**
  96856. * push line into the position, normal and index buffer
  96857. * @protected
  96858. */
  96859. protected createLine(p0: Vector3, p1: Vector3, offset: number): void;
  96860. /**
  96861. * See https://playground.babylonjs.com/#R3JR6V#1 for a visual display of the algorithm
  96862. */
  96863. private _tessellateTriangle;
  96864. private _generateEdgesLinesAlternate;
  96865. /**
  96866. * Generates lines edges from adjacencjes
  96867. * @private
  96868. */
  96869. _generateEdgesLines(): void;
  96870. /**
  96871. * Checks wether or not the edges renderer is ready to render.
  96872. * @return true if ready, otherwise false.
  96873. */
  96874. isReady(): boolean;
  96875. /**
  96876. * Renders the edges of the attached mesh,
  96877. */
  96878. render(): void;
  96879. }
  96880. /**
  96881. * LineEdgesRenderer for LineMeshes to remove unnecessary triangulation
  96882. */
  96883. export class LineEdgesRenderer extends EdgesRenderer {
  96884. /**
  96885. * This constructor turns off auto generating edges line in Edges Renderer to make it here.
  96886. * @param source LineMesh used to generate edges
  96887. * @param epsilon not important (specified angle for edge detection)
  96888. * @param checkVerticesInsteadOfIndices not important for LineMesh
  96889. */
  96890. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean);
  96891. /**
  96892. * Generate edges for each line in LinesMesh. Every Line should be rendered as edge.
  96893. */
  96894. _generateEdgesLines(): void;
  96895. }
  96896. }
  96897. declare module BABYLON {
  96898. /**
  96899. * This represents the object necessary to create a rendering group.
  96900. * This is exclusively used and created by the rendering manager.
  96901. * To modify the behavior, you use the available helpers in your scene or meshes.
  96902. * @hidden
  96903. */
  96904. export class RenderingGroup {
  96905. index: number;
  96906. private static _zeroVector;
  96907. private _scene;
  96908. private _opaqueSubMeshes;
  96909. private _transparentSubMeshes;
  96910. private _alphaTestSubMeshes;
  96911. private _depthOnlySubMeshes;
  96912. private _particleSystems;
  96913. private _spriteManagers;
  96914. private _opaqueSortCompareFn;
  96915. private _alphaTestSortCompareFn;
  96916. private _transparentSortCompareFn;
  96917. private _renderOpaque;
  96918. private _renderAlphaTest;
  96919. private _renderTransparent;
  96920. /** @hidden */
  96921. _edgesRenderers: SmartArrayNoDuplicate<IEdgesRenderer>;
  96922. onBeforeTransparentRendering: () => void;
  96923. /**
  96924. * Set the opaque sort comparison function.
  96925. * If null the sub meshes will be render in the order they were created
  96926. */
  96927. set opaqueSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  96928. /**
  96929. * Set the alpha test sort comparison function.
  96930. * If null the sub meshes will be render in the order they were created
  96931. */
  96932. set alphaTestSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  96933. /**
  96934. * Set the transparent sort comparison function.
  96935. * If null the sub meshes will be render in the order they were created
  96936. */
  96937. set transparentSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  96938. /**
  96939. * Creates a new rendering group.
  96940. * @param index The rendering group index
  96941. * @param opaqueSortCompareFn The opaque sort comparison function. If null no order is applied
  96942. * @param alphaTestSortCompareFn The alpha test sort comparison function. If null no order is applied
  96943. * @param transparentSortCompareFn The transparent sort comparison function. If null back to front + alpha index sort is applied
  96944. */
  96945. 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>);
  96946. /**
  96947. * Render all the sub meshes contained in the group.
  96948. * @param customRenderFunction Used to override the default render behaviour of the group.
  96949. * @returns true if rendered some submeshes.
  96950. */
  96951. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, renderSprites: boolean, renderParticles: boolean, activeMeshes: Nullable<AbstractMesh[]>): void;
  96952. /**
  96953. * Renders the opaque submeshes in the order from the opaqueSortCompareFn.
  96954. * @param subMeshes The submeshes to render
  96955. */
  96956. private renderOpaqueSorted;
  96957. /**
  96958. * Renders the opaque submeshes in the order from the alphatestSortCompareFn.
  96959. * @param subMeshes The submeshes to render
  96960. */
  96961. private renderAlphaTestSorted;
  96962. /**
  96963. * Renders the opaque submeshes in the order from the transparentSortCompareFn.
  96964. * @param subMeshes The submeshes to render
  96965. */
  96966. private renderTransparentSorted;
  96967. /**
  96968. * Renders the submeshes in a specified order.
  96969. * @param subMeshes The submeshes to sort before render
  96970. * @param sortCompareFn The comparison function use to sort
  96971. * @param cameraPosition The camera position use to preprocess the submeshes to help sorting
  96972. * @param transparent Specifies to activate blending if true
  96973. */
  96974. private static renderSorted;
  96975. /**
  96976. * Renders the submeshes in the order they were dispatched (no sort applied).
  96977. * @param subMeshes The submeshes to render
  96978. */
  96979. private static renderUnsorted;
  96980. /**
  96981. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  96982. * are rendered back to front if in the same alpha index.
  96983. *
  96984. * @param a The first submesh
  96985. * @param b The second submesh
  96986. * @returns The result of the comparison
  96987. */
  96988. static defaultTransparentSortCompare(a: SubMesh, b: SubMesh): number;
  96989. /**
  96990. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  96991. * are rendered back to front.
  96992. *
  96993. * @param a The first submesh
  96994. * @param b The second submesh
  96995. * @returns The result of the comparison
  96996. */
  96997. static backToFrontSortCompare(a: SubMesh, b: SubMesh): number;
  96998. /**
  96999. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  97000. * are rendered front to back (prevent overdraw).
  97001. *
  97002. * @param a The first submesh
  97003. * @param b The second submesh
  97004. * @returns The result of the comparison
  97005. */
  97006. static frontToBackSortCompare(a: SubMesh, b: SubMesh): number;
  97007. /**
  97008. * Resets the different lists of submeshes to prepare a new frame.
  97009. */
  97010. prepare(): void;
  97011. dispose(): void;
  97012. /**
  97013. * Inserts the submesh in its correct queue depending on its material.
  97014. * @param subMesh The submesh to dispatch
  97015. * @param [mesh] Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  97016. * @param [material] Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  97017. */
  97018. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  97019. dispatchSprites(spriteManager: ISpriteManager): void;
  97020. dispatchParticles(particleSystem: IParticleSystem): void;
  97021. private _renderParticles;
  97022. private _renderSprites;
  97023. }
  97024. }
  97025. declare module BABYLON {
  97026. /**
  97027. * Interface describing the different options available in the rendering manager
  97028. * regarding Auto Clear between groups.
  97029. */
  97030. export interface IRenderingManagerAutoClearSetup {
  97031. /**
  97032. * Defines whether or not autoclear is enable.
  97033. */
  97034. autoClear: boolean;
  97035. /**
  97036. * Defines whether or not to autoclear the depth buffer.
  97037. */
  97038. depth: boolean;
  97039. /**
  97040. * Defines whether or not to autoclear the stencil buffer.
  97041. */
  97042. stencil: boolean;
  97043. }
  97044. /**
  97045. * This class is used by the onRenderingGroupObservable
  97046. */
  97047. export class RenderingGroupInfo {
  97048. /**
  97049. * The Scene that being rendered
  97050. */
  97051. scene: Scene;
  97052. /**
  97053. * The camera currently used for the rendering pass
  97054. */
  97055. camera: Nullable<Camera>;
  97056. /**
  97057. * The ID of the renderingGroup being processed
  97058. */
  97059. renderingGroupId: number;
  97060. }
  97061. /**
  97062. * This is the manager responsible of all the rendering for meshes sprites and particles.
  97063. * It is enable to manage the different groups as well as the different necessary sort functions.
  97064. * This should not be used directly aside of the few static configurations
  97065. */
  97066. export class RenderingManager {
  97067. /**
  97068. * The max id used for rendering groups (not included)
  97069. */
  97070. static MAX_RENDERINGGROUPS: number;
  97071. /**
  97072. * The min id used for rendering groups (included)
  97073. */
  97074. static MIN_RENDERINGGROUPS: number;
  97075. /**
  97076. * Used to globally prevent autoclearing scenes.
  97077. */
  97078. static AUTOCLEAR: boolean;
  97079. /**
  97080. * @hidden
  97081. */
  97082. _useSceneAutoClearSetup: boolean;
  97083. private _scene;
  97084. private _renderingGroups;
  97085. private _depthStencilBufferAlreadyCleaned;
  97086. private _autoClearDepthStencil;
  97087. private _customOpaqueSortCompareFn;
  97088. private _customAlphaTestSortCompareFn;
  97089. private _customTransparentSortCompareFn;
  97090. private _renderingGroupInfo;
  97091. /**
  97092. * Instantiates a new rendering group for a particular scene
  97093. * @param scene Defines the scene the groups belongs to
  97094. */
  97095. constructor(scene: Scene);
  97096. private _clearDepthStencilBuffer;
  97097. /**
  97098. * Renders the entire managed groups. This is used by the scene or the different rennder targets.
  97099. * @hidden
  97100. */
  97101. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, activeMeshes: Nullable<AbstractMesh[]>, renderParticles: boolean, renderSprites: boolean): void;
  97102. /**
  97103. * Resets the different information of the group to prepare a new frame
  97104. * @hidden
  97105. */
  97106. reset(): void;
  97107. /**
  97108. * Dispose and release the group and its associated resources.
  97109. * @hidden
  97110. */
  97111. dispose(): void;
  97112. /**
  97113. * Clear the info related to rendering groups preventing retention points during dispose.
  97114. */
  97115. freeRenderingGroups(): void;
  97116. private _prepareRenderingGroup;
  97117. /**
  97118. * Add a sprite manager to the rendering manager in order to render it this frame.
  97119. * @param spriteManager Define the sprite manager to render
  97120. */
  97121. dispatchSprites(spriteManager: ISpriteManager): void;
  97122. /**
  97123. * Add a particle system to the rendering manager in order to render it this frame.
  97124. * @param particleSystem Define the particle system to render
  97125. */
  97126. dispatchParticles(particleSystem: IParticleSystem): void;
  97127. /**
  97128. * Add a submesh to the manager in order to render it this frame
  97129. * @param subMesh The submesh to dispatch
  97130. * @param mesh Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  97131. * @param material Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  97132. */
  97133. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  97134. /**
  97135. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  97136. * This allowed control for front to back rendering or reversly depending of the special needs.
  97137. *
  97138. * @param renderingGroupId The rendering group id corresponding to its index
  97139. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  97140. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  97141. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  97142. */
  97143. 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;
  97144. /**
  97145. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  97146. *
  97147. * @param renderingGroupId The rendering group id corresponding to its index
  97148. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  97149. * @param depth Automatically clears depth between groups if true and autoClear is true.
  97150. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  97151. */
  97152. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  97153. /**
  97154. * Gets the current auto clear configuration for one rendering group of the rendering
  97155. * manager.
  97156. * @param index the rendering group index to get the information for
  97157. * @returns The auto clear setup for the requested rendering group
  97158. */
  97159. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  97160. }
  97161. }
  97162. declare module BABYLON {
  97163. /**
  97164. * Defines the options associated with the creation of a custom shader for a shadow generator.
  97165. */
  97166. export interface ICustomShaderOptions {
  97167. /**
  97168. * Gets or sets the custom shader name to use
  97169. */
  97170. shaderName: string;
  97171. /**
  97172. * The list of attribute names used in the shader
  97173. */
  97174. attributes?: string[];
  97175. /**
  97176. * The list of unifrom names used in the shader
  97177. */
  97178. uniforms?: string[];
  97179. /**
  97180. * The list of sampler names used in the shader
  97181. */
  97182. samplers?: string[];
  97183. /**
  97184. * The list of defines used in the shader
  97185. */
  97186. defines?: string[];
  97187. }
  97188. /**
  97189. * Interface to implement to create a shadow generator compatible with BJS.
  97190. */
  97191. export interface IShadowGenerator {
  97192. /** Gets or set the id of the shadow generator. It will be the one from the light if not defined */
  97193. id: string;
  97194. /**
  97195. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  97196. * @returns The render target texture if present otherwise, null
  97197. */
  97198. getShadowMap(): Nullable<RenderTargetTexture>;
  97199. /**
  97200. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  97201. * @param subMesh The submesh we want to render in the shadow map
  97202. * @param useInstances Defines wether will draw in the map using instances
  97203. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  97204. * @returns true if ready otherwise, false
  97205. */
  97206. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  97207. /**
  97208. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  97209. * @param defines Defines of the material we want to update
  97210. * @param lightIndex Index of the light in the enabled light list of the material
  97211. */
  97212. prepareDefines(defines: MaterialDefines, lightIndex: number): void;
  97213. /**
  97214. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  97215. * defined in the generator but impacting the effect).
  97216. * It implies the unifroms available on the materials are the standard BJS ones.
  97217. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  97218. * @param effect The effect we are binfing the information for
  97219. */
  97220. bindShadowLight(lightIndex: string, effect: Effect): void;
  97221. /**
  97222. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  97223. * (eq to shadow prjection matrix * light transform matrix)
  97224. * @returns The transform matrix used to create the shadow map
  97225. */
  97226. getTransformMatrix(): Matrix;
  97227. /**
  97228. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  97229. * Cube and 2D textures for instance.
  97230. */
  97231. recreateShadowMap(): void;
  97232. /**
  97233. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  97234. * @param onCompiled Callback triggered at the and of the effects compilation
  97235. * @param options Sets of optional options forcing the compilation with different modes
  97236. */
  97237. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  97238. useInstances: boolean;
  97239. }>): void;
  97240. /**
  97241. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  97242. * @param options Sets of optional options forcing the compilation with different modes
  97243. * @returns A promise that resolves when the compilation completes
  97244. */
  97245. forceCompilationAsync(options?: Partial<{
  97246. useInstances: boolean;
  97247. }>): Promise<void>;
  97248. /**
  97249. * Serializes the shadow generator setup to a json object.
  97250. * @returns The serialized JSON object
  97251. */
  97252. serialize(): any;
  97253. /**
  97254. * Disposes the Shadow map and related Textures and effects.
  97255. */
  97256. dispose(): void;
  97257. }
  97258. /**
  97259. * Default implementation IShadowGenerator.
  97260. * This is the main object responsible of generating shadows in the framework.
  97261. * Documentation: https://doc.babylonjs.com/babylon101/shadows
  97262. */
  97263. export class ShadowGenerator implements IShadowGenerator {
  97264. /**
  97265. * Name of the shadow generator class
  97266. */
  97267. static CLASSNAME: string;
  97268. /**
  97269. * Shadow generator mode None: no filtering applied.
  97270. */
  97271. static readonly FILTER_NONE: number;
  97272. /**
  97273. * Shadow generator mode ESM: Exponential Shadow Mapping.
  97274. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  97275. */
  97276. static readonly FILTER_EXPONENTIALSHADOWMAP: number;
  97277. /**
  97278. * Shadow generator mode Poisson Sampling: Percentage Closer Filtering.
  97279. * (Multiple Tap around evenly distributed around the pixel are used to evaluate the shadow strength)
  97280. */
  97281. static readonly FILTER_POISSONSAMPLING: number;
  97282. /**
  97283. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping.
  97284. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  97285. */
  97286. static readonly FILTER_BLUREXPONENTIALSHADOWMAP: number;
  97287. /**
  97288. * Shadow generator mode ESM: Exponential Shadow Mapping using the inverse of the exponential preventing
  97289. * edge artifacts on steep falloff.
  97290. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  97291. */
  97292. static readonly FILTER_CLOSEEXPONENTIALSHADOWMAP: number;
  97293. /**
  97294. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping using the inverse of the exponential preventing
  97295. * edge artifacts on steep falloff.
  97296. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  97297. */
  97298. static readonly FILTER_BLURCLOSEEXPONENTIALSHADOWMAP: number;
  97299. /**
  97300. * Shadow generator mode PCF: Percentage Closer Filtering
  97301. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  97302. * (https://developer.nvidia.com/gpugems/GPUGems/gpugems_ch11.html)
  97303. */
  97304. static readonly FILTER_PCF: number;
  97305. /**
  97306. * Shadow generator mode PCSS: Percentage Closering Soft Shadow.
  97307. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  97308. * Contact Hardening
  97309. */
  97310. static readonly FILTER_PCSS: number;
  97311. /**
  97312. * Reserved for PCF and PCSS
  97313. * Highest Quality.
  97314. *
  97315. * Execute PCF on a 5*5 kernel improving a lot the shadow aliasing artifacts.
  97316. *
  97317. * Execute PCSS with 32 taps blocker search and 64 taps PCF.
  97318. */
  97319. static readonly QUALITY_HIGH: number;
  97320. /**
  97321. * Reserved for PCF and PCSS
  97322. * Good tradeoff for quality/perf cross devices
  97323. *
  97324. * Execute PCF on a 3*3 kernel.
  97325. *
  97326. * Execute PCSS with 16 taps blocker search and 32 taps PCF.
  97327. */
  97328. static readonly QUALITY_MEDIUM: number;
  97329. /**
  97330. * Reserved for PCF and PCSS
  97331. * The lowest quality but the fastest.
  97332. *
  97333. * Execute PCF on a 1*1 kernel.
  97334. *
  97335. * Execute PCSS with 16 taps blocker search and 16 taps PCF.
  97336. */
  97337. static readonly QUALITY_LOW: number;
  97338. /** Gets or set the id of the shadow generator. It will be the one from the light if not defined */
  97339. id: string;
  97340. /** Gets or sets the custom shader name to use */
  97341. customShaderOptions: ICustomShaderOptions;
  97342. /**
  97343. * Observable triggered before the shadow is rendered. Can be used to update internal effect state
  97344. */
  97345. onBeforeShadowMapRenderObservable: Observable<Effect>;
  97346. /**
  97347. * Observable triggered after the shadow is rendered. Can be used to restore internal effect state
  97348. */
  97349. onAfterShadowMapRenderObservable: Observable<Effect>;
  97350. /**
  97351. * Observable triggered before a mesh is rendered in the shadow map.
  97352. * Can be used to update internal effect state (that you can get from the onBeforeShadowMapRenderObservable)
  97353. */
  97354. onBeforeShadowMapRenderMeshObservable: Observable<Mesh>;
  97355. /**
  97356. * Observable triggered after a mesh is rendered in the shadow map.
  97357. * Can be used to update internal effect state (that you can get from the onAfterShadowMapRenderObservable)
  97358. */
  97359. onAfterShadowMapRenderMeshObservable: Observable<Mesh>;
  97360. protected _bias: number;
  97361. /**
  97362. * Gets the bias: offset applied on the depth preventing acnea (in light direction).
  97363. */
  97364. get bias(): number;
  97365. /**
  97366. * Sets the bias: offset applied on the depth preventing acnea (in light direction).
  97367. */
  97368. set bias(bias: number);
  97369. protected _normalBias: number;
  97370. /**
  97371. * Gets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  97372. */
  97373. get normalBias(): number;
  97374. /**
  97375. * Sets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  97376. */
  97377. set normalBias(normalBias: number);
  97378. protected _blurBoxOffset: number;
  97379. /**
  97380. * Gets the blur box offset: offset applied during the blur pass.
  97381. * Only useful if useKernelBlur = false
  97382. */
  97383. get blurBoxOffset(): number;
  97384. /**
  97385. * Sets the blur box offset: offset applied during the blur pass.
  97386. * Only useful if useKernelBlur = false
  97387. */
  97388. set blurBoxOffset(value: number);
  97389. protected _blurScale: number;
  97390. /**
  97391. * Gets the blur scale: scale of the blurred texture compared to the main shadow map.
  97392. * 2 means half of the size.
  97393. */
  97394. get blurScale(): number;
  97395. /**
  97396. * Sets the blur scale: scale of the blurred texture compared to the main shadow map.
  97397. * 2 means half of the size.
  97398. */
  97399. set blurScale(value: number);
  97400. protected _blurKernel: number;
  97401. /**
  97402. * Gets the blur kernel: kernel size of the blur pass.
  97403. * Only useful if useKernelBlur = true
  97404. */
  97405. get blurKernel(): number;
  97406. /**
  97407. * Sets the blur kernel: kernel size of the blur pass.
  97408. * Only useful if useKernelBlur = true
  97409. */
  97410. set blurKernel(value: number);
  97411. protected _useKernelBlur: boolean;
  97412. /**
  97413. * Gets whether the blur pass is a kernel blur (if true) or box blur.
  97414. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  97415. */
  97416. get useKernelBlur(): boolean;
  97417. /**
  97418. * Sets whether the blur pass is a kernel blur (if true) or box blur.
  97419. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  97420. */
  97421. set useKernelBlur(value: boolean);
  97422. protected _depthScale: number;
  97423. /**
  97424. * Gets the depth scale used in ESM mode.
  97425. */
  97426. get depthScale(): number;
  97427. /**
  97428. * Sets the depth scale used in ESM mode.
  97429. * This can override the scale stored on the light.
  97430. */
  97431. set depthScale(value: number);
  97432. protected _validateFilter(filter: number): number;
  97433. protected _filter: number;
  97434. /**
  97435. * Gets the current mode of the shadow generator (normal, PCF, ESM...).
  97436. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  97437. */
  97438. get filter(): number;
  97439. /**
  97440. * Sets the current mode of the shadow generator (normal, PCF, ESM...).
  97441. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  97442. */
  97443. set filter(value: number);
  97444. /**
  97445. * Gets if the current filter is set to Poisson Sampling.
  97446. */
  97447. get usePoissonSampling(): boolean;
  97448. /**
  97449. * Sets the current filter to Poisson Sampling.
  97450. */
  97451. set usePoissonSampling(value: boolean);
  97452. /**
  97453. * Gets if the current filter is set to ESM.
  97454. */
  97455. get useExponentialShadowMap(): boolean;
  97456. /**
  97457. * Sets the current filter is to ESM.
  97458. */
  97459. set useExponentialShadowMap(value: boolean);
  97460. /**
  97461. * Gets if the current filter is set to filtered ESM.
  97462. */
  97463. get useBlurExponentialShadowMap(): boolean;
  97464. /**
  97465. * Gets if the current filter is set to filtered ESM.
  97466. */
  97467. set useBlurExponentialShadowMap(value: boolean);
  97468. /**
  97469. * Gets if the current filter is set to "close ESM" (using the inverse of the
  97470. * exponential to prevent steep falloff artifacts).
  97471. */
  97472. get useCloseExponentialShadowMap(): boolean;
  97473. /**
  97474. * Sets the current filter to "close ESM" (using the inverse of the
  97475. * exponential to prevent steep falloff artifacts).
  97476. */
  97477. set useCloseExponentialShadowMap(value: boolean);
  97478. /**
  97479. * Gets if the current filter is set to filtered "close ESM" (using the inverse of the
  97480. * exponential to prevent steep falloff artifacts).
  97481. */
  97482. get useBlurCloseExponentialShadowMap(): boolean;
  97483. /**
  97484. * Sets the current filter to filtered "close ESM" (using the inverse of the
  97485. * exponential to prevent steep falloff artifacts).
  97486. */
  97487. set useBlurCloseExponentialShadowMap(value: boolean);
  97488. /**
  97489. * Gets if the current filter is set to "PCF" (percentage closer filtering).
  97490. */
  97491. get usePercentageCloserFiltering(): boolean;
  97492. /**
  97493. * Sets the current filter to "PCF" (percentage closer filtering).
  97494. */
  97495. set usePercentageCloserFiltering(value: boolean);
  97496. protected _filteringQuality: number;
  97497. /**
  97498. * Gets the PCF or PCSS Quality.
  97499. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  97500. */
  97501. get filteringQuality(): number;
  97502. /**
  97503. * Sets the PCF or PCSS Quality.
  97504. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  97505. */
  97506. set filteringQuality(filteringQuality: number);
  97507. /**
  97508. * Gets if the current filter is set to "PCSS" (contact hardening).
  97509. */
  97510. get useContactHardeningShadow(): boolean;
  97511. /**
  97512. * Sets the current filter to "PCSS" (contact hardening).
  97513. */
  97514. set useContactHardeningShadow(value: boolean);
  97515. protected _contactHardeningLightSizeUVRatio: number;
  97516. /**
  97517. * Gets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  97518. * Using a ratio helps keeping shape stability independently of the map size.
  97519. *
  97520. * It does not account for the light projection as it was having too much
  97521. * instability during the light setup or during light position changes.
  97522. *
  97523. * Only valid if useContactHardeningShadow is true.
  97524. */
  97525. get contactHardeningLightSizeUVRatio(): number;
  97526. /**
  97527. * Sets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  97528. * Using a ratio helps keeping shape stability independently of the map size.
  97529. *
  97530. * It does not account for the light projection as it was having too much
  97531. * instability during the light setup or during light position changes.
  97532. *
  97533. * Only valid if useContactHardeningShadow is true.
  97534. */
  97535. set contactHardeningLightSizeUVRatio(contactHardeningLightSizeUVRatio: number);
  97536. protected _darkness: number;
  97537. /** Gets or sets the actual darkness of a shadow */
  97538. get darkness(): number;
  97539. set darkness(value: number);
  97540. /**
  97541. * Returns the darkness value (float). This can only decrease the actual darkness of a shadow.
  97542. * 0 means strongest and 1 would means no shadow.
  97543. * @returns the darkness.
  97544. */
  97545. getDarkness(): number;
  97546. /**
  97547. * Sets the darkness value (float). This can only decrease the actual darkness of a shadow.
  97548. * @param darkness The darkness value 0 means strongest and 1 would means no shadow.
  97549. * @returns the shadow generator allowing fluent coding.
  97550. */
  97551. setDarkness(darkness: number): ShadowGenerator;
  97552. protected _transparencyShadow: boolean;
  97553. /** Gets or sets the ability to have transparent shadow */
  97554. get transparencyShadow(): boolean;
  97555. set transparencyShadow(value: boolean);
  97556. /**
  97557. * Sets the ability to have transparent shadow (boolean).
  97558. * @param transparent True if transparent else False
  97559. * @returns the shadow generator allowing fluent coding
  97560. */
  97561. setTransparencyShadow(transparent: boolean): ShadowGenerator;
  97562. /**
  97563. * Enables or disables shadows with varying strength based on the transparency
  97564. * When it is enabled, the strength of the shadow is taken equal to mesh.visibility
  97565. * If you enabled an alpha texture on your material, the alpha value red from the texture is also combined to compute the strength:
  97566. * mesh.visibility * alphaTexture.a
  97567. * Note that by definition transparencyShadow must be set to true for enableSoftTransparentShadow to work!
  97568. */
  97569. enableSoftTransparentShadow: boolean;
  97570. protected _shadowMap: Nullable<RenderTargetTexture>;
  97571. protected _shadowMap2: Nullable<RenderTargetTexture>;
  97572. /**
  97573. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  97574. * @returns The render target texture if present otherwise, null
  97575. */
  97576. getShadowMap(): Nullable<RenderTargetTexture>;
  97577. /**
  97578. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  97579. * @returns The render target texture if the shadow map is present otherwise, null
  97580. */
  97581. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  97582. /**
  97583. * Gets the class name of that object
  97584. * @returns "ShadowGenerator"
  97585. */
  97586. getClassName(): string;
  97587. /**
  97588. * Helper function to add a mesh and its descendants to the list of shadow casters.
  97589. * @param mesh Mesh to add
  97590. * @param includeDescendants boolean indicating if the descendants should be added. Default to true
  97591. * @returns the Shadow Generator itself
  97592. */
  97593. addShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  97594. /**
  97595. * Helper function to remove a mesh and its descendants from the list of shadow casters
  97596. * @param mesh Mesh to remove
  97597. * @param includeDescendants boolean indicating if the descendants should be removed. Default to true
  97598. * @returns the Shadow Generator itself
  97599. */
  97600. removeShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  97601. /**
  97602. * Controls the extent to which the shadows fade out at the edge of the frustum
  97603. */
  97604. frustumEdgeFalloff: number;
  97605. protected _light: IShadowLight;
  97606. /**
  97607. * Returns the associated light object.
  97608. * @returns the light generating the shadow
  97609. */
  97610. getLight(): IShadowLight;
  97611. /**
  97612. * If true the shadow map is generated by rendering the back face of the mesh instead of the front face.
  97613. * This can help with self-shadowing as the geometry making up the back of objects is slightly offset.
  97614. * It might on the other hand introduce peter panning.
  97615. */
  97616. forceBackFacesOnly: boolean;
  97617. protected _scene: Scene;
  97618. protected _lightDirection: Vector3;
  97619. protected _effect: Effect;
  97620. protected _viewMatrix: Matrix;
  97621. protected _projectionMatrix: Matrix;
  97622. protected _transformMatrix: Matrix;
  97623. protected _cachedPosition: Vector3;
  97624. protected _cachedDirection: Vector3;
  97625. protected _cachedDefines: string;
  97626. protected _currentRenderID: number;
  97627. protected _boxBlurPostprocess: Nullable<PostProcess>;
  97628. protected _kernelBlurXPostprocess: Nullable<PostProcess>;
  97629. protected _kernelBlurYPostprocess: Nullable<PostProcess>;
  97630. protected _blurPostProcesses: PostProcess[];
  97631. protected _mapSize: number;
  97632. protected _currentFaceIndex: number;
  97633. protected _currentFaceIndexCache: number;
  97634. protected _textureType: number;
  97635. protected _defaultTextureMatrix: Matrix;
  97636. protected _storedUniqueId: Nullable<number>;
  97637. /** @hidden */
  97638. static _SceneComponentInitialization: (scene: Scene) => void;
  97639. /**
  97640. * Creates a ShadowGenerator object.
  97641. * A ShadowGenerator is the required tool to use the shadows.
  97642. * Each light casting shadows needs to use its own ShadowGenerator.
  97643. * Documentation : https://doc.babylonjs.com/babylon101/shadows
  97644. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  97645. * @param light The light object generating the shadows.
  97646. * @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.
  97647. */
  97648. constructor(mapSize: number, light: IShadowLight, usefulFloatFirst?: boolean);
  97649. protected _initializeGenerator(): void;
  97650. protected _createTargetRenderTexture(): void;
  97651. protected _initializeShadowMap(): void;
  97652. protected _initializeBlurRTTAndPostProcesses(): void;
  97653. protected _renderForShadowMap(opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>): void;
  97654. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  97655. protected _renderSubMeshForShadowMap(subMesh: SubMesh, isTransparent?: boolean): void;
  97656. protected _applyFilterValues(): void;
  97657. /**
  97658. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  97659. * @param onCompiled Callback triggered at the and of the effects compilation
  97660. * @param options Sets of optional options forcing the compilation with different modes
  97661. */
  97662. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  97663. useInstances: boolean;
  97664. }>): void;
  97665. /**
  97666. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  97667. * @param options Sets of optional options forcing the compilation with different modes
  97668. * @returns A promise that resolves when the compilation completes
  97669. */
  97670. forceCompilationAsync(options?: Partial<{
  97671. useInstances: boolean;
  97672. }>): Promise<void>;
  97673. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  97674. private _prepareShadowDefines;
  97675. /**
  97676. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  97677. * @param subMesh The submesh we want to render in the shadow map
  97678. * @param useInstances Defines wether will draw in the map using instances
  97679. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  97680. * @returns true if ready otherwise, false
  97681. */
  97682. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  97683. /**
  97684. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  97685. * @param defines Defines of the material we want to update
  97686. * @param lightIndex Index of the light in the enabled light list of the material
  97687. */
  97688. prepareDefines(defines: any, lightIndex: number): void;
  97689. /**
  97690. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  97691. * defined in the generator but impacting the effect).
  97692. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  97693. * @param effect The effect we are binfing the information for
  97694. */
  97695. bindShadowLight(lightIndex: string, effect: Effect): void;
  97696. /**
  97697. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  97698. * (eq to shadow prjection matrix * light transform matrix)
  97699. * @returns The transform matrix used to create the shadow map
  97700. */
  97701. getTransformMatrix(): Matrix;
  97702. /**
  97703. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  97704. * Cube and 2D textures for instance.
  97705. */
  97706. recreateShadowMap(): void;
  97707. protected _disposeBlurPostProcesses(): void;
  97708. protected _disposeRTTandPostProcesses(): void;
  97709. /**
  97710. * Disposes the ShadowGenerator.
  97711. * Returns nothing.
  97712. */
  97713. dispose(): void;
  97714. /**
  97715. * Serializes the shadow generator setup to a json object.
  97716. * @returns The serialized JSON object
  97717. */
  97718. serialize(): any;
  97719. /**
  97720. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  97721. * @param parsedShadowGenerator The JSON object to parse
  97722. * @param scene The scene to create the shadow map for
  97723. * @param constr A function that builds a shadow generator or undefined to create an instance of the default shadow generator
  97724. * @returns The parsed shadow generator
  97725. */
  97726. static Parse(parsedShadowGenerator: any, scene: Scene, constr?: (mapSize: number, light: IShadowLight) => ShadowGenerator): ShadowGenerator;
  97727. }
  97728. }
  97729. declare module BABYLON {
  97730. /**
  97731. * Base class of all the lights in Babylon. It groups all the generic information about lights.
  97732. * Lights are used, as you would expect, to affect how meshes are seen, in terms of both illumination and colour.
  97733. * 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.
  97734. */
  97735. export abstract class Light extends Node {
  97736. /**
  97737. * Falloff Default: light is falling off following the material specification:
  97738. * standard material is using standard falloff whereas pbr material can request special falloff per materials.
  97739. */
  97740. static readonly FALLOFF_DEFAULT: number;
  97741. /**
  97742. * Falloff Physical: light is falling off following the inverse squared distance law.
  97743. */
  97744. static readonly FALLOFF_PHYSICAL: number;
  97745. /**
  97746. * Falloff gltf: light is falling off as described in the gltf moving to PBR document
  97747. * to enhance interoperability with other engines.
  97748. */
  97749. static readonly FALLOFF_GLTF: number;
  97750. /**
  97751. * Falloff Standard: light is falling off like in the standard material
  97752. * to enhance interoperability with other materials.
  97753. */
  97754. static readonly FALLOFF_STANDARD: number;
  97755. /**
  97756. * If every light affecting the material is in this lightmapMode,
  97757. * material.lightmapTexture adds or multiplies
  97758. * (depends on material.useLightmapAsShadowmap)
  97759. * after every other light calculations.
  97760. */
  97761. static readonly LIGHTMAP_DEFAULT: number;
  97762. /**
  97763. * material.lightmapTexture as only diffuse lighting from this light
  97764. * adds only specular lighting from this light
  97765. * adds dynamic shadows
  97766. */
  97767. static readonly LIGHTMAP_SPECULAR: number;
  97768. /**
  97769. * material.lightmapTexture as only lighting
  97770. * no light calculation from this light
  97771. * only adds dynamic shadows from this light
  97772. */
  97773. static readonly LIGHTMAP_SHADOWSONLY: number;
  97774. /**
  97775. * Each light type uses the default quantity according to its type:
  97776. * point/spot lights use luminous intensity
  97777. * directional lights use illuminance
  97778. */
  97779. static readonly INTENSITYMODE_AUTOMATIC: number;
  97780. /**
  97781. * lumen (lm)
  97782. */
  97783. static readonly INTENSITYMODE_LUMINOUSPOWER: number;
  97784. /**
  97785. * candela (lm/sr)
  97786. */
  97787. static readonly INTENSITYMODE_LUMINOUSINTENSITY: number;
  97788. /**
  97789. * lux (lm/m^2)
  97790. */
  97791. static readonly INTENSITYMODE_ILLUMINANCE: number;
  97792. /**
  97793. * nit (cd/m^2)
  97794. */
  97795. static readonly INTENSITYMODE_LUMINANCE: number;
  97796. /**
  97797. * Light type const id of the point light.
  97798. */
  97799. static readonly LIGHTTYPEID_POINTLIGHT: number;
  97800. /**
  97801. * Light type const id of the directional light.
  97802. */
  97803. static readonly LIGHTTYPEID_DIRECTIONALLIGHT: number;
  97804. /**
  97805. * Light type const id of the spot light.
  97806. */
  97807. static readonly LIGHTTYPEID_SPOTLIGHT: number;
  97808. /**
  97809. * Light type const id of the hemispheric light.
  97810. */
  97811. static readonly LIGHTTYPEID_HEMISPHERICLIGHT: number;
  97812. /**
  97813. * Diffuse gives the basic color to an object.
  97814. */
  97815. diffuse: Color3;
  97816. /**
  97817. * Specular produces a highlight color on an object.
  97818. * Note: This is note affecting PBR materials.
  97819. */
  97820. specular: Color3;
  97821. /**
  97822. * Defines the falloff type for this light. This lets overrriding how punctual light are
  97823. * falling off base on range or angle.
  97824. * This can be set to any values in Light.FALLOFF_x.
  97825. *
  97826. * Note: This is only useful for PBR Materials at the moment. This could be extended if required to
  97827. * other types of materials.
  97828. */
  97829. falloffType: number;
  97830. /**
  97831. * Strength of the light.
  97832. * Note: By default it is define in the framework own unit.
  97833. * Note: In PBR materials the intensityMode can be use to chose what unit the intensity is defined in.
  97834. */
  97835. intensity: number;
  97836. private _range;
  97837. protected _inverseSquaredRange: number;
  97838. /**
  97839. * Defines how far from the source the light is impacting in scene units.
  97840. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  97841. */
  97842. get range(): number;
  97843. /**
  97844. * Defines how far from the source the light is impacting in scene units.
  97845. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  97846. */
  97847. set range(value: number);
  97848. /**
  97849. * Cached photometric scale default to 1.0 as the automatic intensity mode defaults to 1.0 for every type
  97850. * of light.
  97851. */
  97852. private _photometricScale;
  97853. private _intensityMode;
  97854. /**
  97855. * Gets the photometric scale used to interpret the intensity.
  97856. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  97857. */
  97858. get intensityMode(): number;
  97859. /**
  97860. * Sets the photometric scale used to interpret the intensity.
  97861. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  97862. */
  97863. set intensityMode(value: number);
  97864. private _radius;
  97865. /**
  97866. * Gets the light radius used by PBR Materials to simulate soft area lights.
  97867. */
  97868. get radius(): number;
  97869. /**
  97870. * sets the light radius used by PBR Materials to simulate soft area lights.
  97871. */
  97872. set radius(value: number);
  97873. private _renderPriority;
  97874. /**
  97875. * Defines the rendering priority of the lights. It can help in case of fallback or number of lights
  97876. * exceeding the number allowed of the materials.
  97877. */
  97878. renderPriority: number;
  97879. private _shadowEnabled;
  97880. /**
  97881. * Gets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  97882. * the current shadow generator.
  97883. */
  97884. get shadowEnabled(): boolean;
  97885. /**
  97886. * Sets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  97887. * the current shadow generator.
  97888. */
  97889. set shadowEnabled(value: boolean);
  97890. private _includedOnlyMeshes;
  97891. /**
  97892. * Gets the only meshes impacted by this light.
  97893. */
  97894. get includedOnlyMeshes(): AbstractMesh[];
  97895. /**
  97896. * Sets the only meshes impacted by this light.
  97897. */
  97898. set includedOnlyMeshes(value: AbstractMesh[]);
  97899. private _excludedMeshes;
  97900. /**
  97901. * Gets the meshes not impacted by this light.
  97902. */
  97903. get excludedMeshes(): AbstractMesh[];
  97904. /**
  97905. * Sets the meshes not impacted by this light.
  97906. */
  97907. set excludedMeshes(value: AbstractMesh[]);
  97908. private _excludeWithLayerMask;
  97909. /**
  97910. * Gets the layer id use to find what meshes are not impacted by the light.
  97911. * Inactive if 0
  97912. */
  97913. get excludeWithLayerMask(): number;
  97914. /**
  97915. * Sets the layer id use to find what meshes are not impacted by the light.
  97916. * Inactive if 0
  97917. */
  97918. set excludeWithLayerMask(value: number);
  97919. private _includeOnlyWithLayerMask;
  97920. /**
  97921. * Gets the layer id use to find what meshes are impacted by the light.
  97922. * Inactive if 0
  97923. */
  97924. get includeOnlyWithLayerMask(): number;
  97925. /**
  97926. * Sets the layer id use to find what meshes are impacted by the light.
  97927. * Inactive if 0
  97928. */
  97929. set includeOnlyWithLayerMask(value: number);
  97930. private _lightmapMode;
  97931. /**
  97932. * Gets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  97933. */
  97934. get lightmapMode(): number;
  97935. /**
  97936. * Sets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  97937. */
  97938. set lightmapMode(value: number);
  97939. /**
  97940. * Shadow generator associted to the light.
  97941. * @hidden Internal use only.
  97942. */
  97943. _shadowGenerator: Nullable<IShadowGenerator>;
  97944. /**
  97945. * @hidden Internal use only.
  97946. */
  97947. _excludedMeshesIds: string[];
  97948. /**
  97949. * @hidden Internal use only.
  97950. */
  97951. _includedOnlyMeshesIds: string[];
  97952. /**
  97953. * The current light unifom buffer.
  97954. * @hidden Internal use only.
  97955. */
  97956. _uniformBuffer: UniformBuffer;
  97957. /** @hidden */
  97958. _renderId: number;
  97959. /**
  97960. * Creates a Light object in the scene.
  97961. * Documentation : https://doc.babylonjs.com/babylon101/lights
  97962. * @param name The firendly name of the light
  97963. * @param scene The scene the light belongs too
  97964. */
  97965. constructor(name: string, scene: Scene);
  97966. protected abstract _buildUniformLayout(): void;
  97967. /**
  97968. * Sets the passed Effect "effect" with the Light information.
  97969. * @param effect The effect to update
  97970. * @param lightIndex The index of the light in the effect to update
  97971. * @returns The light
  97972. */
  97973. abstract transferToEffect(effect: Effect, lightIndex: string): Light;
  97974. /**
  97975. * Sets the passed Effect "effect" with the Light textures.
  97976. * @param effect The effect to update
  97977. * @param lightIndex The index of the light in the effect to update
  97978. * @returns The light
  97979. */
  97980. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  97981. /**
  97982. * Binds the lights information from the scene to the effect for the given mesh.
  97983. * @param lightIndex Light index
  97984. * @param scene The scene where the light belongs to
  97985. * @param effect The effect we are binding the data to
  97986. * @param useSpecular Defines if specular is supported
  97987. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  97988. */
  97989. _bindLight(lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  97990. /**
  97991. * Sets the passed Effect "effect" with the Light information.
  97992. * @param effect The effect to update
  97993. * @param lightDataUniformName The uniform used to store light data (position or direction)
  97994. * @returns The light
  97995. */
  97996. abstract transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  97997. /**
  97998. * Returns the string "Light".
  97999. * @returns the class name
  98000. */
  98001. getClassName(): string;
  98002. /** @hidden */
  98003. readonly _isLight: boolean;
  98004. /**
  98005. * Converts the light information to a readable string for debug purpose.
  98006. * @param fullDetails Supports for multiple levels of logging within scene loading
  98007. * @returns the human readable light info
  98008. */
  98009. toString(fullDetails?: boolean): string;
  98010. /** @hidden */
  98011. protected _syncParentEnabledState(): void;
  98012. /**
  98013. * Set the enabled state of this node.
  98014. * @param value - the new enabled state
  98015. */
  98016. setEnabled(value: boolean): void;
  98017. /**
  98018. * Returns the Light associated shadow generator if any.
  98019. * @return the associated shadow generator.
  98020. */
  98021. getShadowGenerator(): Nullable<IShadowGenerator>;
  98022. /**
  98023. * Returns a Vector3, the absolute light position in the World.
  98024. * @returns the world space position of the light
  98025. */
  98026. getAbsolutePosition(): Vector3;
  98027. /**
  98028. * Specifies if the light will affect the passed mesh.
  98029. * @param mesh The mesh to test against the light
  98030. * @return true the mesh is affected otherwise, false.
  98031. */
  98032. canAffectMesh(mesh: AbstractMesh): boolean;
  98033. /**
  98034. * Sort function to order lights for rendering.
  98035. * @param a First Light object to compare to second.
  98036. * @param b Second Light object to compare first.
  98037. * @return -1 to reduce's a's index relative to be, 0 for no change, 1 to increase a's index relative to b.
  98038. */
  98039. static CompareLightsPriority(a: Light, b: Light): number;
  98040. /**
  98041. * Releases resources associated with this node.
  98042. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  98043. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  98044. */
  98045. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  98046. /**
  98047. * Returns the light type ID (integer).
  98048. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  98049. */
  98050. getTypeID(): number;
  98051. /**
  98052. * Returns the intensity scaled by the Photometric Scale according to the light type and intensity mode.
  98053. * @returns the scaled intensity in intensity mode unit
  98054. */
  98055. getScaledIntensity(): number;
  98056. /**
  98057. * Returns a new Light object, named "name", from the current one.
  98058. * @param name The name of the cloned light
  98059. * @param newParent The parent of this light, if it has one
  98060. * @returns the new created light
  98061. */
  98062. clone(name: string, newParent?: Nullable<Node>): Nullable<Light>;
  98063. /**
  98064. * Serializes the current light into a Serialization object.
  98065. * @returns the serialized object.
  98066. */
  98067. serialize(): any;
  98068. /**
  98069. * Creates a new typed light from the passed type (integer) : point light = 0, directional light = 1, spot light = 2, hemispheric light = 3.
  98070. * This new light is named "name" and added to the passed scene.
  98071. * @param type Type according to the types available in Light.LIGHTTYPEID_x
  98072. * @param name The friendly name of the light
  98073. * @param scene The scene the new light will belong to
  98074. * @returns the constructor function
  98075. */
  98076. static GetConstructorFromName(type: number, name: string, scene: Scene): Nullable<() => Light>;
  98077. /**
  98078. * Parses the passed "parsedLight" and returns a new instanced Light from this parsing.
  98079. * @param parsedLight The JSON representation of the light
  98080. * @param scene The scene to create the parsed light in
  98081. * @returns the created light after parsing
  98082. */
  98083. static Parse(parsedLight: any, scene: Scene): Nullable<Light>;
  98084. private _hookArrayForExcluded;
  98085. private _hookArrayForIncludedOnly;
  98086. private _resyncMeshes;
  98087. /**
  98088. * Forces the meshes to update their light related information in their rendering used effects
  98089. * @hidden Internal Use Only
  98090. */
  98091. _markMeshesAsLightDirty(): void;
  98092. /**
  98093. * Recomputes the cached photometric scale if needed.
  98094. */
  98095. private _computePhotometricScale;
  98096. /**
  98097. * Returns the Photometric Scale according to the light type and intensity mode.
  98098. */
  98099. private _getPhotometricScale;
  98100. /**
  98101. * Reorder the light in the scene according to their defined priority.
  98102. * @hidden Internal Use Only
  98103. */
  98104. _reorderLightsInScene(): void;
  98105. /**
  98106. * Prepares the list of defines specific to the light type.
  98107. * @param defines the list of defines
  98108. * @param lightIndex defines the index of the light for the effect
  98109. */
  98110. abstract prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  98111. }
  98112. }
  98113. declare module BABYLON {
  98114. /**
  98115. * A target camera takes a mesh or position as a target and continues to look at it while it moves.
  98116. * This is the base of the follow, arc rotate cameras and Free camera
  98117. * @see https://doc.babylonjs.com/features/cameras
  98118. */
  98119. export class TargetCamera extends Camera {
  98120. private static _RigCamTransformMatrix;
  98121. private static _TargetTransformMatrix;
  98122. private static _TargetFocalPoint;
  98123. private _tmpUpVector;
  98124. private _tmpTargetVector;
  98125. /**
  98126. * Define the current direction the camera is moving to
  98127. */
  98128. cameraDirection: Vector3;
  98129. /**
  98130. * Define the current rotation the camera is rotating to
  98131. */
  98132. cameraRotation: Vector2;
  98133. /** Gets or sets a boolean indicating that the scaling of the parent hierarchy will not be taken in account by the camera */
  98134. ignoreParentScaling: boolean;
  98135. /**
  98136. * When set, the up vector of the camera will be updated by the rotation of the camera
  98137. */
  98138. updateUpVectorFromRotation: boolean;
  98139. private _tmpQuaternion;
  98140. /**
  98141. * Define the current rotation of the camera
  98142. */
  98143. rotation: Vector3;
  98144. /**
  98145. * Define the current rotation of the camera as a quaternion to prevent Gimbal lock
  98146. */
  98147. rotationQuaternion: Quaternion;
  98148. /**
  98149. * Define the current speed of the camera
  98150. */
  98151. speed: number;
  98152. /**
  98153. * Add constraint to the camera to prevent it to move freely in all directions and
  98154. * around all axis.
  98155. */
  98156. noRotationConstraint: boolean;
  98157. /**
  98158. * Reverses mouselook direction to 'natural' panning as opposed to traditional direct
  98159. * panning
  98160. */
  98161. invertRotation: boolean;
  98162. /**
  98163. * Speed multiplier for inverse camera panning
  98164. */
  98165. inverseRotationSpeed: number;
  98166. /**
  98167. * Define the current target of the camera as an object or a position.
  98168. */
  98169. lockedTarget: any;
  98170. /** @hidden */
  98171. _currentTarget: Vector3;
  98172. /** @hidden */
  98173. _initialFocalDistance: number;
  98174. /** @hidden */
  98175. _viewMatrix: Matrix;
  98176. /** @hidden */
  98177. _camMatrix: Matrix;
  98178. /** @hidden */
  98179. _cameraTransformMatrix: Matrix;
  98180. /** @hidden */
  98181. _cameraRotationMatrix: Matrix;
  98182. /** @hidden */
  98183. _referencePoint: Vector3;
  98184. /** @hidden */
  98185. _transformedReferencePoint: Vector3;
  98186. /** @hidden */
  98187. _reset: () => void;
  98188. private _defaultUp;
  98189. /**
  98190. * Instantiates a target camera that takes a mesh or position as a target and continues to look at it while it moves.
  98191. * This is the base of the follow, arc rotate cameras and Free camera
  98192. * @see https://doc.babylonjs.com/features/cameras
  98193. * @param name Defines the name of the camera in the scene
  98194. * @param position Defines the start position of the camera in the scene
  98195. * @param scene Defines the scene the camera belongs to
  98196. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  98197. */
  98198. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  98199. /**
  98200. * Gets the position in front of the camera at a given distance.
  98201. * @param distance The distance from the camera we want the position to be
  98202. * @returns the position
  98203. */
  98204. getFrontPosition(distance: number): Vector3;
  98205. /** @hidden */
  98206. _getLockedTargetPosition(): Nullable<Vector3>;
  98207. private _storedPosition;
  98208. private _storedRotation;
  98209. private _storedRotationQuaternion;
  98210. /**
  98211. * Store current camera state of the camera (fov, position, rotation, etc..)
  98212. * @returns the camera
  98213. */
  98214. storeState(): Camera;
  98215. /**
  98216. * Restored camera state. You must call storeState() first
  98217. * @returns whether it was successful or not
  98218. * @hidden
  98219. */
  98220. _restoreStateValues(): boolean;
  98221. /** @hidden */
  98222. _initCache(): void;
  98223. /** @hidden */
  98224. _updateCache(ignoreParentClass?: boolean): void;
  98225. /** @hidden */
  98226. _isSynchronizedViewMatrix(): boolean;
  98227. /** @hidden */
  98228. _computeLocalCameraSpeed(): number;
  98229. /**
  98230. * Defines the target the camera should look at.
  98231. * @param target Defines the new target as a Vector or a mesh
  98232. */
  98233. setTarget(target: Vector3): void;
  98234. /**
  98235. * Defines the target point of the camera.
  98236. * The camera looks towards it form the radius distance.
  98237. */
  98238. get target(): Vector3;
  98239. set target(value: Vector3);
  98240. /**
  98241. * Return the current target position of the camera. This value is expressed in local space.
  98242. * @returns the target position
  98243. */
  98244. getTarget(): Vector3;
  98245. /** @hidden */
  98246. _decideIfNeedsToMove(): boolean;
  98247. /** @hidden */
  98248. _updatePosition(): void;
  98249. /** @hidden */
  98250. _checkInputs(): void;
  98251. protected _updateCameraRotationMatrix(): void;
  98252. /**
  98253. * 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)
  98254. * @returns the current camera
  98255. */
  98256. private _rotateUpVectorWithCameraRotationMatrix;
  98257. private _cachedRotationZ;
  98258. private _cachedQuaternionRotationZ;
  98259. /** @hidden */
  98260. _getViewMatrix(): Matrix;
  98261. protected _computeViewMatrix(position: Vector3, target: Vector3, up: Vector3): void;
  98262. /**
  98263. * @hidden
  98264. */
  98265. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  98266. /**
  98267. * @hidden
  98268. */
  98269. _updateRigCameras(): void;
  98270. private _getRigCamPositionAndTarget;
  98271. /**
  98272. * Gets the current object class name.
  98273. * @return the class name
  98274. */
  98275. getClassName(): string;
  98276. }
  98277. }
  98278. declare module BABYLON {
  98279. /**
  98280. * Gather the list of keyboard event types as constants.
  98281. */
  98282. export class KeyboardEventTypes {
  98283. /**
  98284. * The keydown event is fired when a key becomes active (pressed).
  98285. */
  98286. static readonly KEYDOWN: number;
  98287. /**
  98288. * The keyup event is fired when a key has been released.
  98289. */
  98290. static readonly KEYUP: number;
  98291. }
  98292. /**
  98293. * This class is used to store keyboard related info for the onKeyboardObservable event.
  98294. */
  98295. export class KeyboardInfo {
  98296. /**
  98297. * Defines the type of event (KeyboardEventTypes)
  98298. */
  98299. type: number;
  98300. /**
  98301. * Defines the related dom event
  98302. */
  98303. event: KeyboardEvent;
  98304. /**
  98305. * Instantiates a new keyboard info.
  98306. * This class is used to store keyboard related info for the onKeyboardObservable event.
  98307. * @param type Defines the type of event (KeyboardEventTypes)
  98308. * @param event Defines the related dom event
  98309. */
  98310. constructor(
  98311. /**
  98312. * Defines the type of event (KeyboardEventTypes)
  98313. */
  98314. type: number,
  98315. /**
  98316. * Defines the related dom event
  98317. */
  98318. event: KeyboardEvent);
  98319. }
  98320. /**
  98321. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  98322. * Set the skipOnKeyboardObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onKeyboardObservable
  98323. */
  98324. export class KeyboardInfoPre extends KeyboardInfo {
  98325. /**
  98326. * Defines the type of event (KeyboardEventTypes)
  98327. */
  98328. type: number;
  98329. /**
  98330. * Defines the related dom event
  98331. */
  98332. event: KeyboardEvent;
  98333. /**
  98334. * Defines whether the engine should skip the next onKeyboardObservable associated to this pre.
  98335. */
  98336. skipOnPointerObservable: boolean;
  98337. /**
  98338. * Instantiates a new keyboard pre info.
  98339. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  98340. * @param type Defines the type of event (KeyboardEventTypes)
  98341. * @param event Defines the related dom event
  98342. */
  98343. constructor(
  98344. /**
  98345. * Defines the type of event (KeyboardEventTypes)
  98346. */
  98347. type: number,
  98348. /**
  98349. * Defines the related dom event
  98350. */
  98351. event: KeyboardEvent);
  98352. }
  98353. }
  98354. declare module BABYLON {
  98355. /**
  98356. * Manage the keyboard inputs to control the movement of a free camera.
  98357. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98358. */
  98359. export class FreeCameraKeyboardMoveInput implements ICameraInput<FreeCamera> {
  98360. /**
  98361. * Defines the camera the input is attached to.
  98362. */
  98363. camera: FreeCamera;
  98364. /**
  98365. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  98366. */
  98367. keysUp: number[];
  98368. /**
  98369. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  98370. */
  98371. keysUpward: number[];
  98372. /**
  98373. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  98374. */
  98375. keysDown: number[];
  98376. /**
  98377. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  98378. */
  98379. keysDownward: number[];
  98380. /**
  98381. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  98382. */
  98383. keysLeft: number[];
  98384. /**
  98385. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  98386. */
  98387. keysRight: number[];
  98388. private _keys;
  98389. private _onCanvasBlurObserver;
  98390. private _onKeyboardObserver;
  98391. private _engine;
  98392. private _scene;
  98393. /**
  98394. * Attach the input controls to a specific dom element to get the input from.
  98395. * @param element Defines the element the controls should be listened from
  98396. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  98397. */
  98398. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  98399. /**
  98400. * Detach the current controls from the specified dom element.
  98401. * @param element Defines the element to stop listening the inputs from
  98402. */
  98403. detachControl(element: Nullable<HTMLElement>): void;
  98404. /**
  98405. * Update the current camera state depending on the inputs that have been used this frame.
  98406. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  98407. */
  98408. checkInputs(): void;
  98409. /**
  98410. * Gets the class name of the current intput.
  98411. * @returns the class name
  98412. */
  98413. getClassName(): string;
  98414. /** @hidden */
  98415. _onLostFocus(): void;
  98416. /**
  98417. * Get the friendly name associated with the input class.
  98418. * @returns the input friendly name
  98419. */
  98420. getSimpleName(): string;
  98421. }
  98422. }
  98423. declare module BABYLON {
  98424. /**
  98425. * Gather the list of pointer event types as constants.
  98426. */
  98427. export class PointerEventTypes {
  98428. /**
  98429. * 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.
  98430. */
  98431. static readonly POINTERDOWN: number;
  98432. /**
  98433. * The pointerup event is fired when a pointer is no longer active.
  98434. */
  98435. static readonly POINTERUP: number;
  98436. /**
  98437. * The pointermove event is fired when a pointer changes coordinates.
  98438. */
  98439. static readonly POINTERMOVE: number;
  98440. /**
  98441. * The pointerwheel event is fired when a mouse wheel has been rotated.
  98442. */
  98443. static readonly POINTERWHEEL: number;
  98444. /**
  98445. * The pointerpick event is fired when a mesh or sprite has been picked by the pointer.
  98446. */
  98447. static readonly POINTERPICK: number;
  98448. /**
  98449. * The pointertap event is fired when a the object has been touched and released without drag.
  98450. */
  98451. static readonly POINTERTAP: number;
  98452. /**
  98453. * The pointerdoubletap event is fired when a the object has been touched and released twice without drag.
  98454. */
  98455. static readonly POINTERDOUBLETAP: number;
  98456. }
  98457. /**
  98458. * Base class of pointer info types.
  98459. */
  98460. export class PointerInfoBase {
  98461. /**
  98462. * Defines the type of event (PointerEventTypes)
  98463. */
  98464. type: number;
  98465. /**
  98466. * Defines the related dom event
  98467. */
  98468. event: PointerEvent | MouseWheelEvent;
  98469. /**
  98470. * Instantiates the base class of pointers info.
  98471. * @param type Defines the type of event (PointerEventTypes)
  98472. * @param event Defines the related dom event
  98473. */
  98474. constructor(
  98475. /**
  98476. * Defines the type of event (PointerEventTypes)
  98477. */
  98478. type: number,
  98479. /**
  98480. * Defines the related dom event
  98481. */
  98482. event: PointerEvent | MouseWheelEvent);
  98483. }
  98484. /**
  98485. * This class is used to store pointer related info for the onPrePointerObservable event.
  98486. * Set the skipOnPointerObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onPointerObservable
  98487. */
  98488. export class PointerInfoPre extends PointerInfoBase {
  98489. /**
  98490. * Ray from a pointer if availible (eg. 6dof controller)
  98491. */
  98492. ray: Nullable<Ray>;
  98493. /**
  98494. * Defines the local position of the pointer on the canvas.
  98495. */
  98496. localPosition: Vector2;
  98497. /**
  98498. * Defines whether the engine should skip the next OnPointerObservable associated to this pre.
  98499. */
  98500. skipOnPointerObservable: boolean;
  98501. /**
  98502. * Instantiates a PointerInfoPre to store pointer related info to the onPrePointerObservable event.
  98503. * @param type Defines the type of event (PointerEventTypes)
  98504. * @param event Defines the related dom event
  98505. * @param localX Defines the local x coordinates of the pointer when the event occured
  98506. * @param localY Defines the local y coordinates of the pointer when the event occured
  98507. */
  98508. constructor(type: number, event: PointerEvent | MouseWheelEvent, localX: number, localY: number);
  98509. }
  98510. /**
  98511. * This type contains all the data related to a pointer event in Babylon.js.
  98512. * 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.
  98513. */
  98514. export class PointerInfo extends PointerInfoBase {
  98515. /**
  98516. * Defines the picking info associated to the info (if any)\
  98517. */
  98518. pickInfo: Nullable<PickingInfo>;
  98519. /**
  98520. * Instantiates a PointerInfo to store pointer related info to the onPointerObservable event.
  98521. * @param type Defines the type of event (PointerEventTypes)
  98522. * @param event Defines the related dom event
  98523. * @param pickInfo Defines the picking info associated to the info (if any)\
  98524. */
  98525. constructor(type: number, event: PointerEvent | MouseWheelEvent,
  98526. /**
  98527. * Defines the picking info associated to the info (if any)\
  98528. */
  98529. pickInfo: Nullable<PickingInfo>);
  98530. }
  98531. /**
  98532. * Data relating to a touch event on the screen.
  98533. */
  98534. export interface PointerTouch {
  98535. /**
  98536. * X coordinate of touch.
  98537. */
  98538. x: number;
  98539. /**
  98540. * Y coordinate of touch.
  98541. */
  98542. y: number;
  98543. /**
  98544. * Id of touch. Unique for each finger.
  98545. */
  98546. pointerId: number;
  98547. /**
  98548. * Event type passed from DOM.
  98549. */
  98550. type: any;
  98551. }
  98552. }
  98553. declare module BABYLON {
  98554. /**
  98555. * Manage the mouse inputs to control the movement of a free camera.
  98556. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98557. */
  98558. export class FreeCameraMouseInput implements ICameraInput<FreeCamera> {
  98559. /**
  98560. * Define if touch is enabled in the mouse input
  98561. */
  98562. touchEnabled: boolean;
  98563. /**
  98564. * Defines the camera the input is attached to.
  98565. */
  98566. camera: FreeCamera;
  98567. /**
  98568. * Defines the buttons associated with the input to handle camera move.
  98569. */
  98570. buttons: number[];
  98571. /**
  98572. * Defines the pointer angular sensibility along the X and Y axis or how fast is the camera rotating.
  98573. */
  98574. angularSensibility: number;
  98575. private _pointerInput;
  98576. private _onMouseMove;
  98577. private _observer;
  98578. private previousPosition;
  98579. /**
  98580. * Observable for when a pointer move event occurs containing the move offset
  98581. */
  98582. onPointerMovedObservable: Observable<{
  98583. offsetX: number;
  98584. offsetY: number;
  98585. }>;
  98586. /**
  98587. * @hidden
  98588. * If the camera should be rotated automatically based on pointer movement
  98589. */
  98590. _allowCameraRotation: boolean;
  98591. /**
  98592. * Manage the mouse inputs to control the movement of a free camera.
  98593. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98594. * @param touchEnabled Defines if touch is enabled or not
  98595. */
  98596. constructor(
  98597. /**
  98598. * Define if touch is enabled in the mouse input
  98599. */
  98600. touchEnabled?: boolean);
  98601. /**
  98602. * Attach the input controls to a specific dom element to get the input from.
  98603. * @param element Defines the element the controls should be listened from
  98604. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  98605. */
  98606. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  98607. /**
  98608. * Called on JS contextmenu event.
  98609. * Override this method to provide functionality.
  98610. */
  98611. protected onContextMenu(evt: PointerEvent): void;
  98612. /**
  98613. * Detach the current controls from the specified dom element.
  98614. * @param element Defines the element to stop listening the inputs from
  98615. */
  98616. detachControl(element: Nullable<HTMLElement>): void;
  98617. /**
  98618. * Gets the class name of the current intput.
  98619. * @returns the class name
  98620. */
  98621. getClassName(): string;
  98622. /**
  98623. * Get the friendly name associated with the input class.
  98624. * @returns the input friendly name
  98625. */
  98626. getSimpleName(): string;
  98627. }
  98628. }
  98629. declare module BABYLON {
  98630. /**
  98631. * Manage the touch inputs to control the movement of a free camera.
  98632. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98633. */
  98634. export class FreeCameraTouchInput implements ICameraInput<FreeCamera> {
  98635. /**
  98636. * Define if mouse events can be treated as touch events
  98637. */
  98638. allowMouse: boolean;
  98639. /**
  98640. * Defines the camera the input is attached to.
  98641. */
  98642. camera: FreeCamera;
  98643. /**
  98644. * Defines the touch sensibility for rotation.
  98645. * The higher the faster.
  98646. */
  98647. touchAngularSensibility: number;
  98648. /**
  98649. * Defines the touch sensibility for move.
  98650. * The higher the faster.
  98651. */
  98652. touchMoveSensibility: number;
  98653. private _offsetX;
  98654. private _offsetY;
  98655. private _pointerPressed;
  98656. private _pointerInput;
  98657. private _observer;
  98658. private _onLostFocus;
  98659. /**
  98660. * Manage the touch inputs to control the movement of a free camera.
  98661. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98662. * @param allowMouse Defines if mouse events can be treated as touch events
  98663. */
  98664. constructor(
  98665. /**
  98666. * Define if mouse events can be treated as touch events
  98667. */
  98668. allowMouse?: boolean);
  98669. /**
  98670. * Attach the input controls to a specific dom element to get the input from.
  98671. * @param element Defines the element the controls should be listened from
  98672. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  98673. */
  98674. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  98675. /**
  98676. * Detach the current controls from the specified dom element.
  98677. * @param element Defines the element to stop listening the inputs from
  98678. */
  98679. detachControl(element: Nullable<HTMLElement>): void;
  98680. /**
  98681. * Update the current camera state depending on the inputs that have been used this frame.
  98682. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  98683. */
  98684. checkInputs(): void;
  98685. /**
  98686. * Gets the class name of the current intput.
  98687. * @returns the class name
  98688. */
  98689. getClassName(): string;
  98690. /**
  98691. * Get the friendly name associated with the input class.
  98692. * @returns the input friendly name
  98693. */
  98694. getSimpleName(): string;
  98695. }
  98696. }
  98697. declare module BABYLON {
  98698. /**
  98699. * Default Inputs manager for the FreeCamera.
  98700. * It groups all the default supported inputs for ease of use.
  98701. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98702. */
  98703. export class FreeCameraInputsManager extends CameraInputsManager<FreeCamera> {
  98704. /**
  98705. * @hidden
  98706. */
  98707. _mouseInput: Nullable<FreeCameraMouseInput>;
  98708. /**
  98709. * Instantiates a new FreeCameraInputsManager.
  98710. * @param camera Defines the camera the inputs belong to
  98711. */
  98712. constructor(camera: FreeCamera);
  98713. /**
  98714. * Add keyboard input support to the input manager.
  98715. * @returns the current input manager
  98716. */
  98717. addKeyboard(): FreeCameraInputsManager;
  98718. /**
  98719. * Add mouse input support to the input manager.
  98720. * @param touchEnabled if the FreeCameraMouseInput should support touch (default: true)
  98721. * @returns the current input manager
  98722. */
  98723. addMouse(touchEnabled?: boolean): FreeCameraInputsManager;
  98724. /**
  98725. * Removes the mouse input support from the manager
  98726. * @returns the current input manager
  98727. */
  98728. removeMouse(): FreeCameraInputsManager;
  98729. /**
  98730. * Add touch input support to the input manager.
  98731. * @returns the current input manager
  98732. */
  98733. addTouch(): FreeCameraInputsManager;
  98734. /**
  98735. * Remove all attached input methods from a camera
  98736. */
  98737. clear(): void;
  98738. }
  98739. }
  98740. declare module BABYLON {
  98741. /**
  98742. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  98743. * Please consider using the new UniversalCamera instead as it adds more functionality like the gamepad.
  98744. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  98745. */
  98746. export class FreeCamera extends TargetCamera {
  98747. /**
  98748. * Define the collision ellipsoid of the camera.
  98749. * This is helpful to simulate a camera body like the player body around the camera
  98750. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  98751. */
  98752. ellipsoid: Vector3;
  98753. /**
  98754. * Define an offset for the position of the ellipsoid around the camera.
  98755. * This can be helpful to determine the center of the body near the gravity center of the body
  98756. * instead of its head.
  98757. */
  98758. ellipsoidOffset: Vector3;
  98759. /**
  98760. * Enable or disable collisions of the camera with the rest of the scene objects.
  98761. */
  98762. checkCollisions: boolean;
  98763. /**
  98764. * Enable or disable gravity on the camera.
  98765. */
  98766. applyGravity: boolean;
  98767. /**
  98768. * Define the input manager associated to the camera.
  98769. */
  98770. inputs: FreeCameraInputsManager;
  98771. /**
  98772. * Gets the input sensibility for a mouse input. (default is 2000.0)
  98773. * Higher values reduce sensitivity.
  98774. */
  98775. get angularSensibility(): number;
  98776. /**
  98777. * Sets the input sensibility for a mouse input. (default is 2000.0)
  98778. * Higher values reduce sensitivity.
  98779. */
  98780. set angularSensibility(value: number);
  98781. /**
  98782. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  98783. */
  98784. get keysUp(): number[];
  98785. set keysUp(value: number[]);
  98786. /**
  98787. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  98788. */
  98789. get keysUpward(): number[];
  98790. set keysUpward(value: number[]);
  98791. /**
  98792. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  98793. */
  98794. get keysDown(): number[];
  98795. set keysDown(value: number[]);
  98796. /**
  98797. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  98798. */
  98799. get keysDownward(): number[];
  98800. set keysDownward(value: number[]);
  98801. /**
  98802. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  98803. */
  98804. get keysLeft(): number[];
  98805. set keysLeft(value: number[]);
  98806. /**
  98807. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  98808. */
  98809. get keysRight(): number[];
  98810. set keysRight(value: number[]);
  98811. /**
  98812. * Event raised when the camera collide with a mesh in the scene.
  98813. */
  98814. onCollide: (collidedMesh: AbstractMesh) => void;
  98815. private _collider;
  98816. private _needMoveForGravity;
  98817. private _oldPosition;
  98818. private _diffPosition;
  98819. private _newPosition;
  98820. /** @hidden */
  98821. _localDirection: Vector3;
  98822. /** @hidden */
  98823. _transformedDirection: Vector3;
  98824. /**
  98825. * Instantiates a Free Camera.
  98826. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  98827. * Please consider using the new UniversalCamera instead as it adds more functionality like touch to this camera.
  98828. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  98829. * @param name Define the name of the camera in the scene
  98830. * @param position Define the start position of the camera in the scene
  98831. * @param scene Define the scene the camera belongs to
  98832. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  98833. */
  98834. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  98835. /**
  98836. * Attached controls to the current camera.
  98837. * @param element Defines the element the controls should be listened from
  98838. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  98839. */
  98840. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  98841. /**
  98842. * Detach the current controls from the camera.
  98843. * The camera will stop reacting to inputs.
  98844. * @param element Defines the element to stop listening the inputs from
  98845. */
  98846. detachControl(element: HTMLElement): void;
  98847. private _collisionMask;
  98848. /**
  98849. * Define a collision mask to limit the list of object the camera can collide with
  98850. */
  98851. get collisionMask(): number;
  98852. set collisionMask(mask: number);
  98853. /** @hidden */
  98854. _collideWithWorld(displacement: Vector3): void;
  98855. private _onCollisionPositionChange;
  98856. /** @hidden */
  98857. _checkInputs(): void;
  98858. /** @hidden */
  98859. _decideIfNeedsToMove(): boolean;
  98860. /** @hidden */
  98861. _updatePosition(): void;
  98862. /**
  98863. * Destroy the camera and release the current resources hold by it.
  98864. */
  98865. dispose(): void;
  98866. /**
  98867. * Gets the current object class name.
  98868. * @return the class name
  98869. */
  98870. getClassName(): string;
  98871. }
  98872. }
  98873. declare module BABYLON {
  98874. /**
  98875. * Represents a gamepad control stick position
  98876. */
  98877. export class StickValues {
  98878. /**
  98879. * The x component of the control stick
  98880. */
  98881. x: number;
  98882. /**
  98883. * The y component of the control stick
  98884. */
  98885. y: number;
  98886. /**
  98887. * Initializes the gamepad x and y control stick values
  98888. * @param x The x component of the gamepad control stick value
  98889. * @param y The y component of the gamepad control stick value
  98890. */
  98891. constructor(
  98892. /**
  98893. * The x component of the control stick
  98894. */
  98895. x: number,
  98896. /**
  98897. * The y component of the control stick
  98898. */
  98899. y: number);
  98900. }
  98901. /**
  98902. * An interface which manages callbacks for gamepad button changes
  98903. */
  98904. export interface GamepadButtonChanges {
  98905. /**
  98906. * Called when a gamepad has been changed
  98907. */
  98908. changed: boolean;
  98909. /**
  98910. * Called when a gamepad press event has been triggered
  98911. */
  98912. pressChanged: boolean;
  98913. /**
  98914. * Called when a touch event has been triggered
  98915. */
  98916. touchChanged: boolean;
  98917. /**
  98918. * Called when a value has changed
  98919. */
  98920. valueChanged: boolean;
  98921. }
  98922. /**
  98923. * Represents a gamepad
  98924. */
  98925. export class Gamepad {
  98926. /**
  98927. * The id of the gamepad
  98928. */
  98929. id: string;
  98930. /**
  98931. * The index of the gamepad
  98932. */
  98933. index: number;
  98934. /**
  98935. * The browser gamepad
  98936. */
  98937. browserGamepad: any;
  98938. /**
  98939. * Specifies what type of gamepad this represents
  98940. */
  98941. type: number;
  98942. private _leftStick;
  98943. private _rightStick;
  98944. /** @hidden */
  98945. _isConnected: boolean;
  98946. private _leftStickAxisX;
  98947. private _leftStickAxisY;
  98948. private _rightStickAxisX;
  98949. private _rightStickAxisY;
  98950. /**
  98951. * Triggered when the left control stick has been changed
  98952. */
  98953. private _onleftstickchanged;
  98954. /**
  98955. * Triggered when the right control stick has been changed
  98956. */
  98957. private _onrightstickchanged;
  98958. /**
  98959. * Represents a gamepad controller
  98960. */
  98961. static GAMEPAD: number;
  98962. /**
  98963. * Represents a generic controller
  98964. */
  98965. static GENERIC: number;
  98966. /**
  98967. * Represents an XBox controller
  98968. */
  98969. static XBOX: number;
  98970. /**
  98971. * Represents a pose-enabled controller
  98972. */
  98973. static POSE_ENABLED: number;
  98974. /**
  98975. * Represents an Dual Shock controller
  98976. */
  98977. static DUALSHOCK: number;
  98978. /**
  98979. * Specifies whether the left control stick should be Y-inverted
  98980. */
  98981. protected _invertLeftStickY: boolean;
  98982. /**
  98983. * Specifies if the gamepad has been connected
  98984. */
  98985. get isConnected(): boolean;
  98986. /**
  98987. * Initializes the gamepad
  98988. * @param id The id of the gamepad
  98989. * @param index The index of the gamepad
  98990. * @param browserGamepad The browser gamepad
  98991. * @param leftStickX The x component of the left joystick
  98992. * @param leftStickY The y component of the left joystick
  98993. * @param rightStickX The x component of the right joystick
  98994. * @param rightStickY The y component of the right joystick
  98995. */
  98996. constructor(
  98997. /**
  98998. * The id of the gamepad
  98999. */
  99000. id: string,
  99001. /**
  99002. * The index of the gamepad
  99003. */
  99004. index: number,
  99005. /**
  99006. * The browser gamepad
  99007. */
  99008. browserGamepad: any, leftStickX?: number, leftStickY?: number, rightStickX?: number, rightStickY?: number);
  99009. /**
  99010. * Callback triggered when the left joystick has changed
  99011. * @param callback
  99012. */
  99013. onleftstickchanged(callback: (values: StickValues) => void): void;
  99014. /**
  99015. * Callback triggered when the right joystick has changed
  99016. * @param callback
  99017. */
  99018. onrightstickchanged(callback: (values: StickValues) => void): void;
  99019. /**
  99020. * Gets the left joystick
  99021. */
  99022. get leftStick(): StickValues;
  99023. /**
  99024. * Sets the left joystick values
  99025. */
  99026. set leftStick(newValues: StickValues);
  99027. /**
  99028. * Gets the right joystick
  99029. */
  99030. get rightStick(): StickValues;
  99031. /**
  99032. * Sets the right joystick value
  99033. */
  99034. set rightStick(newValues: StickValues);
  99035. /**
  99036. * Updates the gamepad joystick positions
  99037. */
  99038. update(): void;
  99039. /**
  99040. * Disposes the gamepad
  99041. */
  99042. dispose(): void;
  99043. }
  99044. /**
  99045. * Represents a generic gamepad
  99046. */
  99047. export class GenericPad extends Gamepad {
  99048. private _buttons;
  99049. private _onbuttondown;
  99050. private _onbuttonup;
  99051. /**
  99052. * Observable triggered when a button has been pressed
  99053. */
  99054. onButtonDownObservable: Observable<number>;
  99055. /**
  99056. * Observable triggered when a button has been released
  99057. */
  99058. onButtonUpObservable: Observable<number>;
  99059. /**
  99060. * Callback triggered when a button has been pressed
  99061. * @param callback Called when a button has been pressed
  99062. */
  99063. onbuttondown(callback: (buttonPressed: number) => void): void;
  99064. /**
  99065. * Callback triggered when a button has been released
  99066. * @param callback Called when a button has been released
  99067. */
  99068. onbuttonup(callback: (buttonReleased: number) => void): void;
  99069. /**
  99070. * Initializes the generic gamepad
  99071. * @param id The id of the generic gamepad
  99072. * @param index The index of the generic gamepad
  99073. * @param browserGamepad The browser gamepad
  99074. */
  99075. constructor(id: string, index: number, browserGamepad: any);
  99076. private _setButtonValue;
  99077. /**
  99078. * Updates the generic gamepad
  99079. */
  99080. update(): void;
  99081. /**
  99082. * Disposes the generic gamepad
  99083. */
  99084. dispose(): void;
  99085. }
  99086. }
  99087. declare module BABYLON {
  99088. /**
  99089. * Defines the types of pose enabled controllers that are supported
  99090. */
  99091. export enum PoseEnabledControllerType {
  99092. /**
  99093. * HTC Vive
  99094. */
  99095. VIVE = 0,
  99096. /**
  99097. * Oculus Rift
  99098. */
  99099. OCULUS = 1,
  99100. /**
  99101. * Windows mixed reality
  99102. */
  99103. WINDOWS = 2,
  99104. /**
  99105. * Samsung gear VR
  99106. */
  99107. GEAR_VR = 3,
  99108. /**
  99109. * Google Daydream
  99110. */
  99111. DAYDREAM = 4,
  99112. /**
  99113. * Generic
  99114. */
  99115. GENERIC = 5
  99116. }
  99117. /**
  99118. * Defines the MutableGamepadButton interface for the state of a gamepad button
  99119. */
  99120. export interface MutableGamepadButton {
  99121. /**
  99122. * Value of the button/trigger
  99123. */
  99124. value: number;
  99125. /**
  99126. * If the button/trigger is currently touched
  99127. */
  99128. touched: boolean;
  99129. /**
  99130. * If the button/trigger is currently pressed
  99131. */
  99132. pressed: boolean;
  99133. }
  99134. /**
  99135. * Defines the ExtendedGamepadButton interface for a gamepad button which includes state provided by a pose controller
  99136. * @hidden
  99137. */
  99138. export interface ExtendedGamepadButton extends GamepadButton {
  99139. /**
  99140. * If the button/trigger is currently pressed
  99141. */
  99142. readonly pressed: boolean;
  99143. /**
  99144. * If the button/trigger is currently touched
  99145. */
  99146. readonly touched: boolean;
  99147. /**
  99148. * Value of the button/trigger
  99149. */
  99150. readonly value: number;
  99151. }
  99152. /** @hidden */
  99153. export interface _GamePadFactory {
  99154. /**
  99155. * Returns whether or not the current gamepad can be created for this type of controller.
  99156. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  99157. * @returns true if it can be created, otherwise false
  99158. */
  99159. canCreate(gamepadInfo: any): boolean;
  99160. /**
  99161. * Creates a new instance of the Gamepad.
  99162. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  99163. * @returns the new gamepad instance
  99164. */
  99165. create(gamepadInfo: any): Gamepad;
  99166. }
  99167. /**
  99168. * Defines the PoseEnabledControllerHelper object that is used initialize a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  99169. */
  99170. export class PoseEnabledControllerHelper {
  99171. /** @hidden */
  99172. static _ControllerFactories: _GamePadFactory[];
  99173. /** @hidden */
  99174. static _DefaultControllerFactory: Nullable<(gamepadInfo: any) => Gamepad>;
  99175. /**
  99176. * Initializes a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  99177. * @param vrGamepad the gamepad to initialized
  99178. * @returns a vr controller of the type the gamepad identified as
  99179. */
  99180. static InitiateController(vrGamepad: any): Gamepad;
  99181. }
  99182. /**
  99183. * Defines the PoseEnabledController object that contains state of a vr capable controller
  99184. */
  99185. export class PoseEnabledController extends Gamepad implements PoseControlled {
  99186. /**
  99187. * If the controller is used in a webXR session
  99188. */
  99189. isXR: boolean;
  99190. private _deviceRoomPosition;
  99191. private _deviceRoomRotationQuaternion;
  99192. /**
  99193. * The device position in babylon space
  99194. */
  99195. devicePosition: Vector3;
  99196. /**
  99197. * The device rotation in babylon space
  99198. */
  99199. deviceRotationQuaternion: Quaternion;
  99200. /**
  99201. * The scale factor of the device in babylon space
  99202. */
  99203. deviceScaleFactor: number;
  99204. /**
  99205. * (Likely devicePosition should be used instead) The device position in its room space
  99206. */
  99207. position: Vector3;
  99208. /**
  99209. * (Likely deviceRotationQuaternion should be used instead) The device rotation in its room space
  99210. */
  99211. rotationQuaternion: Quaternion;
  99212. /**
  99213. * The type of controller (Eg. Windows mixed reality)
  99214. */
  99215. controllerType: PoseEnabledControllerType;
  99216. protected _calculatedPosition: Vector3;
  99217. private _calculatedRotation;
  99218. /**
  99219. * The raw pose from the device
  99220. */
  99221. rawPose: DevicePose;
  99222. private _trackPosition;
  99223. private _maxRotationDistFromHeadset;
  99224. private _draggedRoomRotation;
  99225. /**
  99226. * @hidden
  99227. */
  99228. _disableTrackPosition(fixedPosition: Vector3): void;
  99229. /**
  99230. * Internal, the mesh attached to the controller
  99231. * @hidden
  99232. */
  99233. _mesh: Nullable<AbstractMesh>;
  99234. private _poseControlledCamera;
  99235. private _leftHandSystemQuaternion;
  99236. /**
  99237. * Internal, matrix used to convert room space to babylon space
  99238. * @hidden
  99239. */
  99240. _deviceToWorld: Matrix;
  99241. /**
  99242. * Node to be used when casting a ray from the controller
  99243. * @hidden
  99244. */
  99245. _pointingPoseNode: Nullable<TransformNode>;
  99246. /**
  99247. * Name of the child mesh that can be used to cast a ray from the controller
  99248. */
  99249. static readonly POINTING_POSE: string;
  99250. /**
  99251. * Creates a new PoseEnabledController from a gamepad
  99252. * @param browserGamepad the gamepad that the PoseEnabledController should be created from
  99253. */
  99254. constructor(browserGamepad: any);
  99255. private _workingMatrix;
  99256. /**
  99257. * Updates the state of the pose enbaled controller and mesh based on the current position and rotation of the controller
  99258. */
  99259. update(): void;
  99260. /**
  99261. * Updates only the pose device and mesh without doing any button event checking
  99262. */
  99263. protected _updatePoseAndMesh(): void;
  99264. /**
  99265. * Updates the state of the pose enbaled controller based on the raw pose data from the device
  99266. * @param poseData raw pose fromthe device
  99267. */
  99268. updateFromDevice(poseData: DevicePose): void;
  99269. /**
  99270. * @hidden
  99271. */
  99272. _meshAttachedObservable: Observable<AbstractMesh>;
  99273. /**
  99274. * Attaches a mesh to the controller
  99275. * @param mesh the mesh to be attached
  99276. */
  99277. attachToMesh(mesh: AbstractMesh): void;
  99278. /**
  99279. * Attaches the controllers mesh to a camera
  99280. * @param camera the camera the mesh should be attached to
  99281. */
  99282. attachToPoseControlledCamera(camera: TargetCamera): void;
  99283. /**
  99284. * Disposes of the controller
  99285. */
  99286. dispose(): void;
  99287. /**
  99288. * The mesh that is attached to the controller
  99289. */
  99290. get mesh(): Nullable<AbstractMesh>;
  99291. /**
  99292. * Gets the ray of the controller in the direction the controller is pointing
  99293. * @param length the length the resulting ray should be
  99294. * @returns a ray in the direction the controller is pointing
  99295. */
  99296. getForwardRay(length?: number): Ray;
  99297. }
  99298. }
  99299. declare module BABYLON {
  99300. /**
  99301. * Defines the WebVRController object that represents controllers tracked in 3D space
  99302. */
  99303. export abstract class WebVRController extends PoseEnabledController {
  99304. /**
  99305. * Internal, the default controller model for the controller
  99306. */
  99307. protected _defaultModel: Nullable<AbstractMesh>;
  99308. /**
  99309. * Fired when the trigger state has changed
  99310. */
  99311. onTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  99312. /**
  99313. * Fired when the main button state has changed
  99314. */
  99315. onMainButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  99316. /**
  99317. * Fired when the secondary button state has changed
  99318. */
  99319. onSecondaryButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  99320. /**
  99321. * Fired when the pad state has changed
  99322. */
  99323. onPadStateChangedObservable: Observable<ExtendedGamepadButton>;
  99324. /**
  99325. * Fired when controllers stick values have changed
  99326. */
  99327. onPadValuesChangedObservable: Observable<StickValues>;
  99328. /**
  99329. * Array of button availible on the controller
  99330. */
  99331. protected _buttons: Array<MutableGamepadButton>;
  99332. private _onButtonStateChange;
  99333. /**
  99334. * Fired when a controller button's state has changed
  99335. * @param callback the callback containing the button that was modified
  99336. */
  99337. onButtonStateChange(callback: (controlledIndex: number, buttonIndex: number, state: ExtendedGamepadButton) => void): void;
  99338. /**
  99339. * X and Y axis corresponding to the controllers joystick
  99340. */
  99341. pad: StickValues;
  99342. /**
  99343. * 'left' or 'right', see https://w3c.github.io/gamepad/extensions.html#gamepadhand-enum
  99344. */
  99345. hand: string;
  99346. /**
  99347. * The default controller model for the controller
  99348. */
  99349. get defaultModel(): Nullable<AbstractMesh>;
  99350. /**
  99351. * Creates a new WebVRController from a gamepad
  99352. * @param vrGamepad the gamepad that the WebVRController should be created from
  99353. */
  99354. constructor(vrGamepad: any);
  99355. /**
  99356. * Updates the state of the controller and mesh based on the current position and rotation of the controller
  99357. */
  99358. update(): void;
  99359. /**
  99360. * Function to be called when a button is modified
  99361. */
  99362. protected abstract _handleButtonChange(buttonIdx: number, value: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  99363. /**
  99364. * Loads a mesh and attaches it to the controller
  99365. * @param scene the scene the mesh should be added to
  99366. * @param meshLoaded callback for when the mesh has been loaded
  99367. */
  99368. abstract initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  99369. private _setButtonValue;
  99370. private _changes;
  99371. private _checkChanges;
  99372. /**
  99373. * Disposes of th webVRCOntroller
  99374. */
  99375. dispose(): void;
  99376. }
  99377. }
  99378. declare module BABYLON {
  99379. /**
  99380. * The HemisphericLight simulates the ambient environment light,
  99381. * so the passed direction is the light reflection direction, not the incoming direction.
  99382. */
  99383. export class HemisphericLight extends Light {
  99384. /**
  99385. * The groundColor is the light in the opposite direction to the one specified during creation.
  99386. * 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.
  99387. */
  99388. groundColor: Color3;
  99389. /**
  99390. * The light reflection direction, not the incoming direction.
  99391. */
  99392. direction: Vector3;
  99393. /**
  99394. * Creates a HemisphericLight object in the scene according to the passed direction (Vector3).
  99395. * The HemisphericLight simulates the ambient environment light, so the passed direction is the light reflection direction, not the incoming direction.
  99396. * The HemisphericLight can't cast shadows.
  99397. * Documentation : https://doc.babylonjs.com/babylon101/lights
  99398. * @param name The friendly name of the light
  99399. * @param direction The direction of the light reflection
  99400. * @param scene The scene the light belongs to
  99401. */
  99402. constructor(name: string, direction: Vector3, scene: Scene);
  99403. protected _buildUniformLayout(): void;
  99404. /**
  99405. * Returns the string "HemisphericLight".
  99406. * @return The class name
  99407. */
  99408. getClassName(): string;
  99409. /**
  99410. * Sets the HemisphericLight direction towards the passed target (Vector3).
  99411. * Returns the updated direction.
  99412. * @param target The target the direction should point to
  99413. * @return The computed direction
  99414. */
  99415. setDirectionToTarget(target: Vector3): Vector3;
  99416. /**
  99417. * Returns the shadow generator associated to the light.
  99418. * @returns Always null for hemispheric lights because it does not support shadows.
  99419. */
  99420. getShadowGenerator(): Nullable<IShadowGenerator>;
  99421. /**
  99422. * Sets the passed Effect object with the HemisphericLight normalized direction and color and the passed name (string).
  99423. * @param effect The effect to update
  99424. * @param lightIndex The index of the light in the effect to update
  99425. * @returns The hemispheric light
  99426. */
  99427. transferToEffect(effect: Effect, lightIndex: string): HemisphericLight;
  99428. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  99429. /**
  99430. * Computes the world matrix of the node
  99431. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  99432. * @param useWasUpdatedFlag defines a reserved property
  99433. * @returns the world matrix
  99434. */
  99435. computeWorldMatrix(): Matrix;
  99436. /**
  99437. * Returns the integer 3.
  99438. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  99439. */
  99440. getTypeID(): number;
  99441. /**
  99442. * Prepares the list of defines specific to the light type.
  99443. * @param defines the list of defines
  99444. * @param lightIndex defines the index of the light for the effect
  99445. */
  99446. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  99447. }
  99448. }
  99449. declare module BABYLON {
  99450. /** @hidden */
  99451. export var vrMultiviewToSingleviewPixelShader: {
  99452. name: string;
  99453. shader: string;
  99454. };
  99455. }
  99456. declare module BABYLON {
  99457. /**
  99458. * Renders to multiple views with a single draw call
  99459. * @see https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/
  99460. */
  99461. export class MultiviewRenderTarget extends RenderTargetTexture {
  99462. /**
  99463. * Creates a multiview render target
  99464. * @param scene scene used with the render target
  99465. * @param size the size of the render target (used for each view)
  99466. */
  99467. constructor(scene: Scene, size?: number | {
  99468. width: number;
  99469. height: number;
  99470. } | {
  99471. ratio: number;
  99472. });
  99473. /**
  99474. * @hidden
  99475. * @param faceIndex the face index, if its a cube texture
  99476. */
  99477. _bindFrameBuffer(faceIndex?: number): void;
  99478. /**
  99479. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  99480. * @returns the view count
  99481. */
  99482. getViewCount(): number;
  99483. }
  99484. }
  99485. declare module BABYLON {
  99486. interface Engine {
  99487. /**
  99488. * Creates a new multiview render target
  99489. * @param width defines the width of the texture
  99490. * @param height defines the height of the texture
  99491. * @returns the created multiview texture
  99492. */
  99493. createMultiviewRenderTargetTexture(width: number, height: number): InternalTexture;
  99494. /**
  99495. * Binds a multiview framebuffer to be drawn to
  99496. * @param multiviewTexture texture to bind
  99497. */
  99498. bindMultiviewFramebuffer(multiviewTexture: InternalTexture): void;
  99499. }
  99500. interface Camera {
  99501. /**
  99502. * @hidden
  99503. * 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)
  99504. */
  99505. _useMultiviewToSingleView: boolean;
  99506. /**
  99507. * @hidden
  99508. * 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)
  99509. */
  99510. _multiviewTexture: Nullable<RenderTargetTexture>;
  99511. /**
  99512. * @hidden
  99513. * ensures the multiview texture of the camera exists and has the specified width/height
  99514. * @param width height to set on the multiview texture
  99515. * @param height width to set on the multiview texture
  99516. */
  99517. _resizeOrCreateMultiviewTexture(width: number, height: number): void;
  99518. }
  99519. interface Scene {
  99520. /** @hidden */
  99521. _transformMatrixR: Matrix;
  99522. /** @hidden */
  99523. _multiviewSceneUbo: Nullable<UniformBuffer>;
  99524. /** @hidden */
  99525. _createMultiviewUbo(): void;
  99526. /** @hidden */
  99527. _updateMultiviewUbo(viewR?: Matrix, projectionR?: Matrix): void;
  99528. /** @hidden */
  99529. _renderMultiviewToSingleView(camera: Camera): void;
  99530. }
  99531. }
  99532. declare module BABYLON {
  99533. /**
  99534. * VRMultiviewToSingleview used to convert multiview texture arrays to standard textures for scenarios such as webVR
  99535. * This will not be used for webXR as it supports displaying texture arrays directly
  99536. */
  99537. export class VRMultiviewToSingleviewPostProcess extends PostProcess {
  99538. /**
  99539. * Gets a string identifying the name of the class
  99540. * @returns "VRMultiviewToSingleviewPostProcess" string
  99541. */
  99542. getClassName(): string;
  99543. /**
  99544. * Initializes a VRMultiviewToSingleview
  99545. * @param name name of the post process
  99546. * @param camera camera to be applied to
  99547. * @param scaleFactor scaling factor to the size of the output texture
  99548. */
  99549. constructor(name: string, camera: Camera, scaleFactor: number);
  99550. }
  99551. }
  99552. declare module BABYLON {
  99553. /**
  99554. * Interface used to define additional presentation attributes
  99555. */
  99556. export interface IVRPresentationAttributes {
  99557. /**
  99558. * Defines a boolean indicating that we want to get 72hz mode on Oculus Browser (default is off eg. 60hz)
  99559. */
  99560. highRefreshRate: boolean;
  99561. /**
  99562. * Enables foveation in VR to improve perf. 0 none, 1 low, 2 medium, 3 high (Default is 1)
  99563. */
  99564. foveationLevel: number;
  99565. }
  99566. interface Engine {
  99567. /** @hidden */
  99568. _vrDisplay: any;
  99569. /** @hidden */
  99570. _vrSupported: boolean;
  99571. /** @hidden */
  99572. _oldSize: Size;
  99573. /** @hidden */
  99574. _oldHardwareScaleFactor: number;
  99575. /** @hidden */
  99576. _vrExclusivePointerMode: boolean;
  99577. /** @hidden */
  99578. _webVRInitPromise: Promise<IDisplayChangedEventArgs>;
  99579. /** @hidden */
  99580. _onVRDisplayPointerRestricted: () => void;
  99581. /** @hidden */
  99582. _onVRDisplayPointerUnrestricted: () => void;
  99583. /** @hidden */
  99584. _onVrDisplayConnect: Nullable<(display: any) => void>;
  99585. /** @hidden */
  99586. _onVrDisplayDisconnect: Nullable<() => void>;
  99587. /** @hidden */
  99588. _onVrDisplayPresentChange: Nullable<() => void>;
  99589. /**
  99590. * Observable signaled when VR display mode changes
  99591. */
  99592. onVRDisplayChangedObservable: Observable<IDisplayChangedEventArgs>;
  99593. /**
  99594. * Observable signaled when VR request present is complete
  99595. */
  99596. onVRRequestPresentComplete: Observable<boolean>;
  99597. /**
  99598. * Observable signaled when VR request present starts
  99599. */
  99600. onVRRequestPresentStart: Observable<Engine>;
  99601. /**
  99602. * Gets a boolean indicating that the engine is currently in VR exclusive mode for the pointers
  99603. * @see https://docs.microsoft.com/en-us/microsoft-edge/webvr/essentials#mouse-input
  99604. */
  99605. isInVRExclusivePointerMode: boolean;
  99606. /**
  99607. * Gets a boolean indicating if a webVR device was detected
  99608. * @returns true if a webVR device was detected
  99609. */
  99610. isVRDevicePresent(): boolean;
  99611. /**
  99612. * Gets the current webVR device
  99613. * @returns the current webVR device (or null)
  99614. */
  99615. getVRDevice(): any;
  99616. /**
  99617. * Initializes a webVR display and starts listening to display change events
  99618. * The onVRDisplayChangedObservable will be notified upon these changes
  99619. * @returns A promise containing a VRDisplay and if vr is supported
  99620. */
  99621. initWebVRAsync(): Promise<IDisplayChangedEventArgs>;
  99622. /** @hidden */
  99623. _getVRDisplaysAsync(): Promise<IDisplayChangedEventArgs>;
  99624. /**
  99625. * Gets or sets the presentation attributes used to configure VR rendering
  99626. */
  99627. vrPresentationAttributes?: IVRPresentationAttributes;
  99628. /**
  99629. * Call this function to switch to webVR mode
  99630. * Will do nothing if webVR is not supported or if there is no webVR device
  99631. * @param options the webvr options provided to the camera. mainly used for multiview
  99632. * @see https://doc.babylonjs.com/how_to/webvr_camera
  99633. */
  99634. enableVR(options: WebVROptions): void;
  99635. /** @hidden */
  99636. _onVRFullScreenTriggered(): void;
  99637. }
  99638. }
  99639. declare module BABYLON {
  99640. /**
  99641. * This is a copy of VRPose. See https://developer.mozilla.org/en-US/docs/Web/API/VRPose
  99642. * IMPORTANT!! The data is right-hand data.
  99643. * @export
  99644. * @interface DevicePose
  99645. */
  99646. export interface DevicePose {
  99647. /**
  99648. * The position of the device, values in array are [x,y,z].
  99649. */
  99650. readonly position: Nullable<Float32Array>;
  99651. /**
  99652. * The linearVelocity of the device, values in array are [x,y,z].
  99653. */
  99654. readonly linearVelocity: Nullable<Float32Array>;
  99655. /**
  99656. * The linearAcceleration of the device, values in array are [x,y,z].
  99657. */
  99658. readonly linearAcceleration: Nullable<Float32Array>;
  99659. /**
  99660. * The orientation of the device in a quaternion array, values in array are [x,y,z,w].
  99661. */
  99662. readonly orientation: Nullable<Float32Array>;
  99663. /**
  99664. * The angularVelocity of the device, values in array are [x,y,z].
  99665. */
  99666. readonly angularVelocity: Nullable<Float32Array>;
  99667. /**
  99668. * The angularAcceleration of the device, values in array are [x,y,z].
  99669. */
  99670. readonly angularAcceleration: Nullable<Float32Array>;
  99671. }
  99672. /**
  99673. * Interface representing a pose controlled object in Babylon.
  99674. * A pose controlled object has both regular pose values as well as pose values
  99675. * from an external device such as a VR head mounted display
  99676. */
  99677. export interface PoseControlled {
  99678. /**
  99679. * The position of the object in babylon space.
  99680. */
  99681. position: Vector3;
  99682. /**
  99683. * The rotation quaternion of the object in babylon space.
  99684. */
  99685. rotationQuaternion: Quaternion;
  99686. /**
  99687. * The position of the device in babylon space.
  99688. */
  99689. devicePosition?: Vector3;
  99690. /**
  99691. * The rotation quaternion of the device in babylon space.
  99692. */
  99693. deviceRotationQuaternion: Quaternion;
  99694. /**
  99695. * The raw pose coming from the device.
  99696. */
  99697. rawPose: Nullable<DevicePose>;
  99698. /**
  99699. * The scale of the device to be used when translating from device space to babylon space.
  99700. */
  99701. deviceScaleFactor: number;
  99702. /**
  99703. * Updates the poseControlled values based on the input device pose.
  99704. * @param poseData the pose data to update the object with
  99705. */
  99706. updateFromDevice(poseData: DevicePose): void;
  99707. }
  99708. /**
  99709. * Set of options to customize the webVRCamera
  99710. */
  99711. export interface WebVROptions {
  99712. /**
  99713. * Sets if the webVR camera should be tracked to the vrDevice. (default: true)
  99714. */
  99715. trackPosition?: boolean;
  99716. /**
  99717. * Sets the scale of the vrDevice in babylon space. (default: 1)
  99718. */
  99719. positionScale?: number;
  99720. /**
  99721. * If there are more than one VRDisplays, this will choose the display matching this name. (default: pick first vrDisplay)
  99722. */
  99723. displayName?: string;
  99724. /**
  99725. * Should the native controller meshes be initialized. (default: true)
  99726. */
  99727. controllerMeshes?: boolean;
  99728. /**
  99729. * Creating a default HemiLight only on controllers. (default: true)
  99730. */
  99731. defaultLightingOnControllers?: boolean;
  99732. /**
  99733. * If you don't want to use the default VR button of the helper. (default: false)
  99734. */
  99735. useCustomVRButton?: boolean;
  99736. /**
  99737. * If you'd like to provide your own button to the VRHelper. (default: standard babylon vr button)
  99738. */
  99739. customVRButton?: HTMLButtonElement;
  99740. /**
  99741. * To change the length of the ray for gaze/controllers. Will be scaled by positionScale. (default: 100)
  99742. */
  99743. rayLength?: number;
  99744. /**
  99745. * To change the default offset from the ground to account for user's height in meters. Will be scaled by positionScale. (default: 1.7)
  99746. */
  99747. defaultHeight?: number;
  99748. /**
  99749. * If multiview should be used if availible (default: false)
  99750. */
  99751. useMultiview?: boolean;
  99752. }
  99753. /**
  99754. * This represents a WebVR camera.
  99755. * The WebVR camera is Babylon's simple interface to interaction with Windows Mixed Reality, HTC Vive and Oculus Rift.
  99756. * @example https://doc.babylonjs.com/how_to/webvr_camera
  99757. */
  99758. export class WebVRFreeCamera extends FreeCamera implements PoseControlled {
  99759. private webVROptions;
  99760. /**
  99761. * @hidden
  99762. * The vrDisplay tied to the camera. See https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay
  99763. */
  99764. _vrDevice: any;
  99765. /**
  99766. * The rawPose of the vrDevice.
  99767. */
  99768. rawPose: Nullable<DevicePose>;
  99769. private _onVREnabled;
  99770. private _specsVersion;
  99771. private _attached;
  99772. private _frameData;
  99773. protected _descendants: Array<Node>;
  99774. private _deviceRoomPosition;
  99775. /** @hidden */
  99776. _deviceRoomRotationQuaternion: Quaternion;
  99777. private _standingMatrix;
  99778. /**
  99779. * Represents device position in babylon space.
  99780. */
  99781. devicePosition: Vector3;
  99782. /**
  99783. * Represents device rotation in babylon space.
  99784. */
  99785. deviceRotationQuaternion: Quaternion;
  99786. /**
  99787. * The scale of the device to be used when translating from device space to babylon space.
  99788. */
  99789. deviceScaleFactor: number;
  99790. private _deviceToWorld;
  99791. private _worldToDevice;
  99792. /**
  99793. * References to the webVR controllers for the vrDevice.
  99794. */
  99795. controllers: Array<WebVRController>;
  99796. /**
  99797. * Emits an event when a controller is attached.
  99798. */
  99799. onControllersAttachedObservable: Observable<WebVRController[]>;
  99800. /**
  99801. * Emits an event when a controller's mesh has been loaded;
  99802. */
  99803. onControllerMeshLoadedObservable: Observable<WebVRController>;
  99804. /**
  99805. * Emits an event when the HMD's pose has been updated.
  99806. */
  99807. onPoseUpdatedFromDeviceObservable: Observable<any>;
  99808. private _poseSet;
  99809. /**
  99810. * If the rig cameras be used as parent instead of this camera.
  99811. */
  99812. rigParenting: boolean;
  99813. private _lightOnControllers;
  99814. private _defaultHeight?;
  99815. /**
  99816. * Instantiates a WebVRFreeCamera.
  99817. * @param name The name of the WebVRFreeCamera
  99818. * @param position The starting anchor position for the camera
  99819. * @param scene The scene the camera belongs to
  99820. * @param webVROptions a set of customizable options for the webVRCamera
  99821. */
  99822. constructor(name: string, position: Vector3, scene: Scene, webVROptions?: WebVROptions);
  99823. /**
  99824. * Gets the device distance from the ground in meters.
  99825. * @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.
  99826. */
  99827. deviceDistanceToRoomGround(): number;
  99828. /**
  99829. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  99830. * @param callback will be called when the standing matrix is set. Callback parameter is if the standing matrix is supported.
  99831. */
  99832. useStandingMatrix(callback?: (bool: boolean) => void): void;
  99833. /**
  99834. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  99835. * @returns A promise with a boolean set to if the standing matrix is supported.
  99836. */
  99837. useStandingMatrixAsync(): Promise<boolean>;
  99838. /**
  99839. * Disposes the camera
  99840. */
  99841. dispose(): void;
  99842. /**
  99843. * Gets a vrController by name.
  99844. * @param name The name of the controller to retreive
  99845. * @returns the controller matching the name specified or null if not found
  99846. */
  99847. getControllerByName(name: string): Nullable<WebVRController>;
  99848. private _leftController;
  99849. /**
  99850. * The controller corresponding to the users left hand.
  99851. */
  99852. get leftController(): Nullable<WebVRController>;
  99853. private _rightController;
  99854. /**
  99855. * The controller corresponding to the users right hand.
  99856. */
  99857. get rightController(): Nullable<WebVRController>;
  99858. /**
  99859. * Casts a ray forward from the vrCamera's gaze.
  99860. * @param length Length of the ray (default: 100)
  99861. * @returns the ray corresponding to the gaze
  99862. */
  99863. getForwardRay(length?: number): Ray;
  99864. /**
  99865. * @hidden
  99866. * Updates the camera based on device's frame data
  99867. */
  99868. _checkInputs(): void;
  99869. /**
  99870. * Updates the poseControlled values based on the input device pose.
  99871. * @param poseData Pose coming from the device
  99872. */
  99873. updateFromDevice(poseData: DevicePose): void;
  99874. private _htmlElementAttached;
  99875. private _detachIfAttached;
  99876. /**
  99877. * WebVR's attach control will start broadcasting frames to the device.
  99878. * Note that in certain browsers (chrome for example) this function must be called
  99879. * within a user-interaction callback. Example:
  99880. * <pre> scene.onPointerDown = function() { camera.attachControl(canvas); }</pre>
  99881. *
  99882. * @param element html element to attach the vrDevice to
  99883. * @param noPreventDefault prevent the default html element operation when attaching the vrDevice
  99884. */
  99885. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  99886. /**
  99887. * Detaches the camera from the html element and disables VR
  99888. *
  99889. * @param element html element to detach from
  99890. */
  99891. detachControl(element: HTMLElement): void;
  99892. /**
  99893. * @returns the name of this class
  99894. */
  99895. getClassName(): string;
  99896. /**
  99897. * Calls resetPose on the vrDisplay
  99898. * See: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/resetPose
  99899. */
  99900. resetToCurrentRotation(): void;
  99901. /**
  99902. * @hidden
  99903. * Updates the rig cameras (left and right eye)
  99904. */
  99905. _updateRigCameras(): void;
  99906. private _workingVector;
  99907. private _oneVector;
  99908. private _workingMatrix;
  99909. private updateCacheCalled;
  99910. private _correctPositionIfNotTrackPosition;
  99911. /**
  99912. * @hidden
  99913. * Updates the cached values of the camera
  99914. * @param ignoreParentClass ignores updating the parent class's cache (default: false)
  99915. */
  99916. _updateCache(ignoreParentClass?: boolean): void;
  99917. /**
  99918. * @hidden
  99919. * Get current device position in babylon world
  99920. */
  99921. _computeDevicePosition(): void;
  99922. /**
  99923. * Updates the current device position and rotation in the babylon world
  99924. */
  99925. update(): void;
  99926. /**
  99927. * @hidden
  99928. * Gets the view matrix of this camera (Always set to identity as left and right eye cameras contain the actual view matrix)
  99929. * @returns an identity matrix
  99930. */
  99931. _getViewMatrix(): Matrix;
  99932. private _tmpMatrix;
  99933. /**
  99934. * This function is called by the two RIG cameras.
  99935. * 'this' is the left or right camera (and NOT (!!!) the WebVRFreeCamera instance)
  99936. * @hidden
  99937. */
  99938. _getWebVRViewMatrix(): Matrix;
  99939. /** @hidden */
  99940. _getWebVRProjectionMatrix(): Matrix;
  99941. private _onGamepadConnectedObserver;
  99942. private _onGamepadDisconnectedObserver;
  99943. private _updateCacheWhenTrackingDisabledObserver;
  99944. /**
  99945. * Initializes the controllers and their meshes
  99946. */
  99947. initControllers(): void;
  99948. }
  99949. }
  99950. declare module BABYLON {
  99951. /**
  99952. * "Static Class" containing the most commonly used helper while dealing with material for rendering purpose.
  99953. *
  99954. * It contains the basic tools to help defining defines, binding uniform for the common part of the materials.
  99955. *
  99956. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  99957. */
  99958. export class MaterialHelper {
  99959. /**
  99960. * Bind the current view position to an effect.
  99961. * @param effect The effect to be bound
  99962. * @param scene The scene the eyes position is used from
  99963. * @param variableName name of the shader variable that will hold the eye position
  99964. */
  99965. static BindEyePosition(effect: Effect, scene: Scene, variableName?: string): void;
  99966. /**
  99967. * Helps preparing the defines values about the UVs in used in the effect.
  99968. * UVs are shared as much as we can accross channels in the shaders.
  99969. * @param texture The texture we are preparing the UVs for
  99970. * @param defines The defines to update
  99971. * @param key The channel key "diffuse", "specular"... used in the shader
  99972. */
  99973. static PrepareDefinesForMergedUV(texture: BaseTexture, defines: any, key: string): void;
  99974. /**
  99975. * Binds a texture matrix value to its corrsponding uniform
  99976. * @param texture The texture to bind the matrix for
  99977. * @param uniformBuffer The uniform buffer receivin the data
  99978. * @param key The channel key "diffuse", "specular"... used in the shader
  99979. */
  99980. static BindTextureMatrix(texture: BaseTexture, uniformBuffer: UniformBuffer, key: string): void;
  99981. /**
  99982. * Gets the current status of the fog (should it be enabled?)
  99983. * @param mesh defines the mesh to evaluate for fog support
  99984. * @param scene defines the hosting scene
  99985. * @returns true if fog must be enabled
  99986. */
  99987. static GetFogState(mesh: AbstractMesh, scene: Scene): boolean;
  99988. /**
  99989. * Helper used to prepare the list of defines associated with misc. values for shader compilation
  99990. * @param mesh defines the current mesh
  99991. * @param scene defines the current scene
  99992. * @param useLogarithmicDepth defines if logarithmic depth has to be turned on
  99993. * @param pointsCloud defines if point cloud rendering has to be turned on
  99994. * @param fogEnabled defines if fog has to be turned on
  99995. * @param alphaTest defines if alpha testing has to be turned on
  99996. * @param defines defines the current list of defines
  99997. */
  99998. static PrepareDefinesForMisc(mesh: AbstractMesh, scene: Scene, useLogarithmicDepth: boolean, pointsCloud: boolean, fogEnabled: boolean, alphaTest: boolean, defines: any): void;
  99999. /**
  100000. * Helper used to prepare the list of defines associated with frame values for shader compilation
  100001. * @param scene defines the current scene
  100002. * @param engine defines the current engine
  100003. * @param defines specifies the list of active defines
  100004. * @param useInstances defines if instances have to be turned on
  100005. * @param useClipPlane defines if clip plane have to be turned on
  100006. * @param useInstances defines if instances have to be turned on
  100007. * @param useThinInstances defines if thin instances have to be turned on
  100008. */
  100009. static PrepareDefinesForFrameBoundValues(scene: Scene, engine: Engine, defines: any, useInstances: boolean, useClipPlane?: Nullable<boolean>, useThinInstances?: boolean): void;
  100010. /**
  100011. * Prepares the defines for bones
  100012. * @param mesh The mesh containing the geometry data we will draw
  100013. * @param defines The defines to update
  100014. */
  100015. static PrepareDefinesForBones(mesh: AbstractMesh, defines: any): void;
  100016. /**
  100017. * Prepares the defines for morph targets
  100018. * @param mesh The mesh containing the geometry data we will draw
  100019. * @param defines The defines to update
  100020. */
  100021. static PrepareDefinesForMorphTargets(mesh: AbstractMesh, defines: any): void;
  100022. /**
  100023. * Prepares the defines used in the shader depending on the attributes data available in the mesh
  100024. * @param mesh The mesh containing the geometry data we will draw
  100025. * @param defines The defines to update
  100026. * @param useVertexColor Precise whether vertex colors should be used or not (override mesh info)
  100027. * @param useBones Precise whether bones should be used or not (override mesh info)
  100028. * @param useMorphTargets Precise whether morph targets should be used or not (override mesh info)
  100029. * @param useVertexAlpha Precise whether vertex alpha should be used or not (override mesh info)
  100030. * @returns false if defines are considered not dirty and have not been checked
  100031. */
  100032. static PrepareDefinesForAttributes(mesh: AbstractMesh, defines: any, useVertexColor: boolean, useBones: boolean, useMorphTargets?: boolean, useVertexAlpha?: boolean): boolean;
  100033. /**
  100034. * Prepares the defines related to multiview
  100035. * @param scene The scene we are intending to draw
  100036. * @param defines The defines to update
  100037. */
  100038. static PrepareDefinesForMultiview(scene: Scene, defines: any): void;
  100039. /**
  100040. * Prepares the defines related to the prepass
  100041. * @param scene The scene we are intending to draw
  100042. * @param defines The defines to update
  100043. * @param canRenderToMRT Indicates if this material renders to several textures in the prepass
  100044. */
  100045. static PrepareDefinesForPrePass(scene: Scene, defines: any, canRenderToMRT: boolean): void;
  100046. /**
  100047. * Prepares the defines related to the light information passed in parameter
  100048. * @param scene The scene we are intending to draw
  100049. * @param mesh The mesh the effect is compiling for
  100050. * @param light The light the effect is compiling for
  100051. * @param lightIndex The index of the light
  100052. * @param defines The defines to update
  100053. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  100054. * @param state Defines the current state regarding what is needed (normals, etc...)
  100055. */
  100056. static PrepareDefinesForLight(scene: Scene, mesh: AbstractMesh, light: Light, lightIndex: number, defines: any, specularSupported: boolean, state: {
  100057. needNormals: boolean;
  100058. needRebuild: boolean;
  100059. shadowEnabled: boolean;
  100060. specularEnabled: boolean;
  100061. lightmapMode: boolean;
  100062. }): void;
  100063. /**
  100064. * Prepares the defines related to the light information passed in parameter
  100065. * @param scene The scene we are intending to draw
  100066. * @param mesh The mesh the effect is compiling for
  100067. * @param defines The defines to update
  100068. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  100069. * @param maxSimultaneousLights Specfies how manuy lights can be added to the effect at max
  100070. * @param disableLighting Specifies whether the lighting is disabled (override scene and light)
  100071. * @returns true if normals will be required for the rest of the effect
  100072. */
  100073. static PrepareDefinesForLights(scene: Scene, mesh: AbstractMesh, defines: any, specularSupported: boolean, maxSimultaneousLights?: number, disableLighting?: boolean): boolean;
  100074. /**
  100075. * Prepares the uniforms and samplers list to be used in the effect (for a specific light)
  100076. * @param lightIndex defines the light index
  100077. * @param uniformsList The uniform list
  100078. * @param samplersList The sampler list
  100079. * @param projectedLightTexture defines if projected texture must be used
  100080. * @param uniformBuffersList defines an optional list of uniform buffers
  100081. */
  100082. static PrepareUniformsAndSamplersForLight(lightIndex: number, uniformsList: string[], samplersList: string[], projectedLightTexture?: any, uniformBuffersList?: Nullable<string[]>): void;
  100083. /**
  100084. * Prepares the uniforms and samplers list to be used in the effect
  100085. * @param uniformsListOrOptions The uniform names to prepare or an EffectCreationOptions containing the liist and extra information
  100086. * @param samplersList The sampler list
  100087. * @param defines The defines helping in the list generation
  100088. * @param maxSimultaneousLights The maximum number of simultanous light allowed in the effect
  100089. */
  100090. static PrepareUniformsAndSamplersList(uniformsListOrOptions: string[] | IEffectCreationOptions, samplersList?: string[], defines?: any, maxSimultaneousLights?: number): void;
  100091. /**
  100092. * This helps decreasing rank by rank the shadow quality (0 being the highest rank and quality)
  100093. * @param defines The defines to update while falling back
  100094. * @param fallbacks The authorized effect fallbacks
  100095. * @param maxSimultaneousLights The maximum number of lights allowed
  100096. * @param rank the current rank of the Effect
  100097. * @returns The newly affected rank
  100098. */
  100099. static HandleFallbacksForShadows(defines: any, fallbacks: EffectFallbacks, maxSimultaneousLights?: number, rank?: number): number;
  100100. private static _TmpMorphInfluencers;
  100101. /**
  100102. * Prepares the list of attributes required for morph targets according to the effect defines.
  100103. * @param attribs The current list of supported attribs
  100104. * @param mesh The mesh to prepare the morph targets attributes for
  100105. * @param influencers The number of influencers
  100106. */
  100107. static PrepareAttributesForMorphTargetsInfluencers(attribs: string[], mesh: AbstractMesh, influencers: number): void;
  100108. /**
  100109. * Prepares the list of attributes required for morph targets according to the effect defines.
  100110. * @param attribs The current list of supported attribs
  100111. * @param mesh The mesh to prepare the morph targets attributes for
  100112. * @param defines The current Defines of the effect
  100113. */
  100114. static PrepareAttributesForMorphTargets(attribs: string[], mesh: AbstractMesh, defines: any): void;
  100115. /**
  100116. * Prepares the list of attributes required for bones according to the effect defines.
  100117. * @param attribs The current list of supported attribs
  100118. * @param mesh The mesh to prepare the bones attributes for
  100119. * @param defines The current Defines of the effect
  100120. * @param fallbacks The current efffect fallback strategy
  100121. */
  100122. static PrepareAttributesForBones(attribs: string[], mesh: AbstractMesh, defines: any, fallbacks: EffectFallbacks): void;
  100123. /**
  100124. * Check and prepare the list of attributes required for instances according to the effect defines.
  100125. * @param attribs The current list of supported attribs
  100126. * @param defines The current MaterialDefines of the effect
  100127. */
  100128. static PrepareAttributesForInstances(attribs: string[], defines: MaterialDefines): void;
  100129. /**
  100130. * Add the list of attributes required for instances to the attribs array.
  100131. * @param attribs The current list of supported attribs
  100132. */
  100133. static PushAttributesForInstances(attribs: string[]): void;
  100134. /**
  100135. * Binds the light information to the effect.
  100136. * @param light The light containing the generator
  100137. * @param effect The effect we are binding the data to
  100138. * @param lightIndex The light index in the effect used to render
  100139. */
  100140. static BindLightProperties(light: Light, effect: Effect, lightIndex: number): void;
  100141. /**
  100142. * Binds the lights information from the scene to the effect for the given mesh.
  100143. * @param light Light to bind
  100144. * @param lightIndex Light index
  100145. * @param scene The scene where the light belongs to
  100146. * @param effect The effect we are binding the data to
  100147. * @param useSpecular Defines if specular is supported
  100148. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  100149. */
  100150. static BindLight(light: Light, lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  100151. /**
  100152. * Binds the lights information from the scene to the effect for the given mesh.
  100153. * @param scene The scene the lights belongs to
  100154. * @param mesh The mesh we are binding the information to render
  100155. * @param effect The effect we are binding the data to
  100156. * @param defines The generated defines for the effect
  100157. * @param maxSimultaneousLights The maximum number of light that can be bound to the effect
  100158. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  100159. */
  100160. static BindLights(scene: Scene, mesh: AbstractMesh, effect: Effect, defines: any, maxSimultaneousLights?: number, rebuildInParallel?: boolean): void;
  100161. private static _tempFogColor;
  100162. /**
  100163. * Binds the fog information from the scene to the effect for the given mesh.
  100164. * @param scene The scene the lights belongs to
  100165. * @param mesh The mesh we are binding the information to render
  100166. * @param effect The effect we are binding the data to
  100167. * @param linearSpace Defines if the fog effect is applied in linear space
  100168. */
  100169. static BindFogParameters(scene: Scene, mesh: AbstractMesh, effect: Effect, linearSpace?: boolean): void;
  100170. /**
  100171. * Binds the bones information from the mesh to the effect.
  100172. * @param mesh The mesh we are binding the information to render
  100173. * @param effect The effect we are binding the data to
  100174. */
  100175. static BindBonesParameters(mesh?: AbstractMesh, effect?: Effect): void;
  100176. /**
  100177. * Binds the morph targets information from the mesh to the effect.
  100178. * @param abstractMesh The mesh we are binding the information to render
  100179. * @param effect The effect we are binding the data to
  100180. */
  100181. static BindMorphTargetParameters(abstractMesh: AbstractMesh, effect: Effect): void;
  100182. /**
  100183. * Binds the logarithmic depth information from the scene to the effect for the given defines.
  100184. * @param defines The generated defines used in the effect
  100185. * @param effect The effect we are binding the data to
  100186. * @param scene The scene we are willing to render with logarithmic scale for
  100187. */
  100188. static BindLogDepth(defines: any, effect: Effect, scene: Scene): void;
  100189. /**
  100190. * Binds the clip plane information from the scene to the effect.
  100191. * @param scene The scene the clip plane information are extracted from
  100192. * @param effect The effect we are binding the data to
  100193. */
  100194. static BindClipPlane(effect: Effect, scene: Scene): void;
  100195. }
  100196. }
  100197. declare module BABYLON {
  100198. /**
  100199. * Block used to expose an input value
  100200. */
  100201. export class InputBlock extends NodeMaterialBlock {
  100202. private _mode;
  100203. private _associatedVariableName;
  100204. private _storedValue;
  100205. private _valueCallback;
  100206. private _type;
  100207. private _animationType;
  100208. /** Gets or set a value used to limit the range of float values */
  100209. min: number;
  100210. /** Gets or set a value used to limit the range of float values */
  100211. max: number;
  100212. /** Gets or set a value indicating that this input can only get 0 and 1 values */
  100213. isBoolean: boolean;
  100214. /** Gets or sets a value used by the Node Material editor to determine how to configure the current value if it is a matrix */
  100215. matrixMode: number;
  100216. /** @hidden */
  100217. _systemValue: Nullable<NodeMaterialSystemValues>;
  100218. /** Gets or sets a boolean indicating that this input can be edited in the Inspector (false by default) */
  100219. visibleInInspector: boolean;
  100220. /** Gets or sets a boolean indicating that the value of this input will not change after a build */
  100221. isConstant: boolean;
  100222. /** Gets or sets the group to use to display this block in the Inspector */
  100223. groupInInspector: string;
  100224. /** Gets an observable raised when the value is changed */
  100225. onValueChangedObservable: Observable<InputBlock>;
  100226. /**
  100227. * Gets or sets the connection point type (default is float)
  100228. */
  100229. get type(): NodeMaterialBlockConnectionPointTypes;
  100230. /**
  100231. * Creates a new InputBlock
  100232. * @param name defines the block name
  100233. * @param target defines the target of that block (Vertex by default)
  100234. * @param type defines the type of the input (can be set to NodeMaterialBlockConnectionPointTypes.AutoDetect)
  100235. */
  100236. constructor(name: string, target?: NodeMaterialBlockTargets, type?: NodeMaterialBlockConnectionPointTypes);
  100237. /**
  100238. * Validates if a name is a reserve word.
  100239. * @param newName the new name to be given to the node.
  100240. * @returns false if the name is a reserve word, else true.
  100241. */
  100242. validateBlockName(newName: string): boolean;
  100243. /**
  100244. * Gets the output component
  100245. */
  100246. get output(): NodeMaterialConnectionPoint;
  100247. /**
  100248. * Set the source of this connection point to a vertex attribute
  100249. * @param attributeName defines the attribute name (position, uv, normal, etc...). If not specified it will take the connection point name
  100250. * @returns the current connection point
  100251. */
  100252. setAsAttribute(attributeName?: string): InputBlock;
  100253. /**
  100254. * Set the source of this connection point to a system value
  100255. * @param value define the system value to use (world, view, etc...) or null to switch to manual value
  100256. * @returns the current connection point
  100257. */
  100258. setAsSystemValue(value: Nullable<NodeMaterialSystemValues>): InputBlock;
  100259. /**
  100260. * Gets or sets the value of that point.
  100261. * Please note that this value will be ignored if valueCallback is defined
  100262. */
  100263. get value(): any;
  100264. set value(value: any);
  100265. /**
  100266. * Gets or sets a callback used to get the value of that point.
  100267. * Please note that setting this value will force the connection point to ignore the value property
  100268. */
  100269. get valueCallback(): () => any;
  100270. set valueCallback(value: () => any);
  100271. /**
  100272. * Gets or sets the associated variable name in the shader
  100273. */
  100274. get associatedVariableName(): string;
  100275. set associatedVariableName(value: string);
  100276. /** Gets or sets the type of animation applied to the input */
  100277. get animationType(): AnimatedInputBlockTypes;
  100278. set animationType(value: AnimatedInputBlockTypes);
  100279. /**
  100280. * Gets a boolean indicating that this connection point not defined yet
  100281. */
  100282. get isUndefined(): boolean;
  100283. /**
  100284. * Gets or sets a boolean indicating that this connection point is coming from an uniform.
  100285. * In this case the connection point name must be the name of the uniform to use.
  100286. * Can only be set on inputs
  100287. */
  100288. get isUniform(): boolean;
  100289. set isUniform(value: boolean);
  100290. /**
  100291. * Gets or sets a boolean indicating that this connection point is coming from an attribute.
  100292. * In this case the connection point name must be the name of the attribute to use
  100293. * Can only be set on inputs
  100294. */
  100295. get isAttribute(): boolean;
  100296. set isAttribute(value: boolean);
  100297. /**
  100298. * Gets or sets a boolean indicating that this connection point is generating a varying variable.
  100299. * Can only be set on exit points
  100300. */
  100301. get isVarying(): boolean;
  100302. set isVarying(value: boolean);
  100303. /**
  100304. * Gets a boolean indicating that the current connection point is a system value
  100305. */
  100306. get isSystemValue(): boolean;
  100307. /**
  100308. * Gets or sets the current well known value or null if not defined as a system value
  100309. */
  100310. get systemValue(): Nullable<NodeMaterialSystemValues>;
  100311. set systemValue(value: Nullable<NodeMaterialSystemValues>);
  100312. /**
  100313. * Gets the current class name
  100314. * @returns the class name
  100315. */
  100316. getClassName(): string;
  100317. /**
  100318. * Animate the input if animationType !== None
  100319. * @param scene defines the rendering scene
  100320. */
  100321. animate(scene: Scene): void;
  100322. private _emitDefine;
  100323. initialize(state: NodeMaterialBuildState): void;
  100324. /**
  100325. * Set the input block to its default value (based on its type)
  100326. */
  100327. setDefaultValue(): void;
  100328. private _emitConstant;
  100329. /** @hidden */
  100330. get _noContextSwitch(): boolean;
  100331. private _emit;
  100332. /** @hidden */
  100333. _transmitWorld(effect: Effect, world: Matrix, worldView: Matrix, worldViewProjection: Matrix): void;
  100334. /** @hidden */
  100335. _transmit(effect: Effect, scene: Scene): void;
  100336. protected _buildBlock(state: NodeMaterialBuildState): void;
  100337. protected _dumpPropertiesCode(): string;
  100338. dispose(): void;
  100339. serialize(): any;
  100340. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100341. }
  100342. }
  100343. declare module BABYLON {
  100344. /**
  100345. * Enum used to define the compatibility state between two connection points
  100346. */
  100347. export enum NodeMaterialConnectionPointCompatibilityStates {
  100348. /** Points are compatibles */
  100349. Compatible = 0,
  100350. /** Points are incompatible because of their types */
  100351. TypeIncompatible = 1,
  100352. /** Points are incompatible because of their targets (vertex vs fragment) */
  100353. TargetIncompatible = 2
  100354. }
  100355. /**
  100356. * Defines the direction of a connection point
  100357. */
  100358. export enum NodeMaterialConnectionPointDirection {
  100359. /** Input */
  100360. Input = 0,
  100361. /** Output */
  100362. Output = 1
  100363. }
  100364. /**
  100365. * Defines a connection point for a block
  100366. */
  100367. export class NodeMaterialConnectionPoint {
  100368. /** @hidden */
  100369. _ownerBlock: NodeMaterialBlock;
  100370. /** @hidden */
  100371. _connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  100372. private _endpoints;
  100373. private _associatedVariableName;
  100374. private _direction;
  100375. /** @hidden */
  100376. _typeConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  100377. /** @hidden */
  100378. _linkedConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  100379. private _type;
  100380. /** @hidden */
  100381. _enforceAssociatedVariableName: boolean;
  100382. /** Gets the direction of the point */
  100383. get direction(): NodeMaterialConnectionPointDirection;
  100384. /** Indicates that this connection point needs dual validation before being connected to another point */
  100385. needDualDirectionValidation: boolean;
  100386. /**
  100387. * Gets or sets the additional types supported by this connection point
  100388. */
  100389. acceptedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  100390. /**
  100391. * Gets or sets the additional types excluded by this connection point
  100392. */
  100393. excludedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  100394. /**
  100395. * Observable triggered when this point is connected
  100396. */
  100397. onConnectionObservable: Observable<NodeMaterialConnectionPoint>;
  100398. /**
  100399. * Gets or sets the associated variable name in the shader
  100400. */
  100401. get associatedVariableName(): string;
  100402. set associatedVariableName(value: string);
  100403. /** Get the inner type (ie AutoDetect for instance instead of the inferred one) */
  100404. get innerType(): NodeMaterialBlockConnectionPointTypes;
  100405. /**
  100406. * Gets or sets the connection point type (default is float)
  100407. */
  100408. get type(): NodeMaterialBlockConnectionPointTypes;
  100409. set type(value: NodeMaterialBlockConnectionPointTypes);
  100410. /**
  100411. * Gets or sets the connection point name
  100412. */
  100413. name: string;
  100414. /**
  100415. * Gets or sets the connection point name
  100416. */
  100417. displayName: string;
  100418. /**
  100419. * Gets or sets a boolean indicating that this connection point can be omitted
  100420. */
  100421. isOptional: boolean;
  100422. /**
  100423. * Gets or sets a boolean indicating that this connection point is exposed on a frame
  100424. */
  100425. isExposedOnFrame: boolean;
  100426. /**
  100427. * Gets or sets a string indicating that this uniform must be defined under a #ifdef
  100428. */
  100429. define: string;
  100430. /** @hidden */
  100431. _prioritizeVertex: boolean;
  100432. private _target;
  100433. /** Gets or sets the target of that connection point */
  100434. get target(): NodeMaterialBlockTargets;
  100435. set target(value: NodeMaterialBlockTargets);
  100436. /**
  100437. * Gets a boolean indicating that the current point is connected to another NodeMaterialBlock
  100438. */
  100439. get isConnected(): boolean;
  100440. /**
  100441. * Gets a boolean indicating that the current point is connected to an input block
  100442. */
  100443. get isConnectedToInputBlock(): boolean;
  100444. /**
  100445. * Gets a the connected input block (if any)
  100446. */
  100447. get connectInputBlock(): Nullable<InputBlock>;
  100448. /** Get the other side of the connection (if any) */
  100449. get connectedPoint(): Nullable<NodeMaterialConnectionPoint>;
  100450. /** Get the block that owns this connection point */
  100451. get ownerBlock(): NodeMaterialBlock;
  100452. /** Get the block connected on the other side of this connection (if any) */
  100453. get sourceBlock(): Nullable<NodeMaterialBlock>;
  100454. /** Get the block connected on the endpoints of this connection (if any) */
  100455. get connectedBlocks(): Array<NodeMaterialBlock>;
  100456. /** Gets the list of connected endpoints */
  100457. get endpoints(): NodeMaterialConnectionPoint[];
  100458. /** Gets a boolean indicating if that output point is connected to at least one input */
  100459. get hasEndpoints(): boolean;
  100460. /** Gets a boolean indicating that this connection will be used in the vertex shader */
  100461. get isConnectedInVertexShader(): boolean;
  100462. /** Gets a boolean indicating that this connection will be used in the fragment shader */
  100463. get isConnectedInFragmentShader(): boolean;
  100464. /**
  100465. * Creates a block suitable to be used as an input for this input point.
  100466. * If null is returned, a block based on the point type will be created.
  100467. * @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
  100468. */
  100469. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  100470. /**
  100471. * Creates a new connection point
  100472. * @param name defines the connection point name
  100473. * @param ownerBlock defines the block hosting this connection point
  100474. * @param direction defines the direction of the connection point
  100475. */
  100476. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection);
  100477. /**
  100478. * Gets the current class name e.g. "NodeMaterialConnectionPoint"
  100479. * @returns the class name
  100480. */
  100481. getClassName(): string;
  100482. /**
  100483. * Gets a boolean indicating if the current point can be connected to another point
  100484. * @param connectionPoint defines the other connection point
  100485. * @returns a boolean
  100486. */
  100487. canConnectTo(connectionPoint: NodeMaterialConnectionPoint): boolean;
  100488. /**
  100489. * Gets a number indicating if the current point can be connected to another point
  100490. * @param connectionPoint defines the other connection point
  100491. * @returns a number defining the compatibility state
  100492. */
  100493. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  100494. /**
  100495. * Connect this point to another connection point
  100496. * @param connectionPoint defines the other connection point
  100497. * @param ignoreConstraints defines if the system will ignore connection type constraints (default is false)
  100498. * @returns the current connection point
  100499. */
  100500. connectTo(connectionPoint: NodeMaterialConnectionPoint, ignoreConstraints?: boolean): NodeMaterialConnectionPoint;
  100501. /**
  100502. * Disconnect this point from one of his endpoint
  100503. * @param endpoint defines the other connection point
  100504. * @returns the current connection point
  100505. */
  100506. disconnectFrom(endpoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPoint;
  100507. /**
  100508. * Serializes this point in a JSON representation
  100509. * @param isInput defines if the connection point is an input (default is true)
  100510. * @returns the serialized point object
  100511. */
  100512. serialize(isInput?: boolean): any;
  100513. /**
  100514. * Release resources
  100515. */
  100516. dispose(): void;
  100517. }
  100518. }
  100519. declare module BABYLON {
  100520. /**
  100521. * Enum used to define the material modes
  100522. */
  100523. export enum NodeMaterialModes {
  100524. /** Regular material */
  100525. Material = 0,
  100526. /** For post process */
  100527. PostProcess = 1,
  100528. /** For particle system */
  100529. Particle = 2
  100530. }
  100531. }
  100532. declare module BABYLON {
  100533. /**
  100534. * Block used to read a texture from a sampler
  100535. */
  100536. export class TextureBlock extends NodeMaterialBlock {
  100537. private _defineName;
  100538. private _linearDefineName;
  100539. private _gammaDefineName;
  100540. private _tempTextureRead;
  100541. private _samplerName;
  100542. private _transformedUVName;
  100543. private _textureTransformName;
  100544. private _textureInfoName;
  100545. private _mainUVName;
  100546. private _mainUVDefineName;
  100547. private _fragmentOnly;
  100548. /**
  100549. * Gets or sets the texture associated with the node
  100550. */
  100551. texture: Nullable<Texture>;
  100552. /**
  100553. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  100554. */
  100555. convertToGammaSpace: boolean;
  100556. /**
  100557. * Gets or sets a boolean indicating if content needs to be converted to linear space
  100558. */
  100559. convertToLinearSpace: boolean;
  100560. /**
  100561. * Create a new TextureBlock
  100562. * @param name defines the block name
  100563. */
  100564. constructor(name: string, fragmentOnly?: boolean);
  100565. /**
  100566. * Gets the current class name
  100567. * @returns the class name
  100568. */
  100569. getClassName(): string;
  100570. /**
  100571. * Gets the uv input component
  100572. */
  100573. get uv(): NodeMaterialConnectionPoint;
  100574. /**
  100575. * Gets the rgba output component
  100576. */
  100577. get rgba(): NodeMaterialConnectionPoint;
  100578. /**
  100579. * Gets the rgb output component
  100580. */
  100581. get rgb(): NodeMaterialConnectionPoint;
  100582. /**
  100583. * Gets the r output component
  100584. */
  100585. get r(): NodeMaterialConnectionPoint;
  100586. /**
  100587. * Gets the g output component
  100588. */
  100589. get g(): NodeMaterialConnectionPoint;
  100590. /**
  100591. * Gets the b output component
  100592. */
  100593. get b(): NodeMaterialConnectionPoint;
  100594. /**
  100595. * Gets the a output component
  100596. */
  100597. get a(): NodeMaterialConnectionPoint;
  100598. get target(): NodeMaterialBlockTargets;
  100599. autoConfigure(material: NodeMaterial): void;
  100600. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  100601. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  100602. isReady(): boolean;
  100603. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  100604. private get _isMixed();
  100605. private _injectVertexCode;
  100606. private _writeTextureRead;
  100607. private _writeOutput;
  100608. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  100609. protected _dumpPropertiesCode(): string;
  100610. serialize(): any;
  100611. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100612. }
  100613. }
  100614. declare module BABYLON {
  100615. /** @hidden */
  100616. export var reflectionFunction: {
  100617. name: string;
  100618. shader: string;
  100619. };
  100620. }
  100621. declare module BABYLON {
  100622. /**
  100623. * Base block used to read a reflection texture from a sampler
  100624. */
  100625. export abstract class ReflectionTextureBaseBlock extends NodeMaterialBlock {
  100626. /** @hidden */
  100627. _define3DName: string;
  100628. /** @hidden */
  100629. _defineCubicName: string;
  100630. /** @hidden */
  100631. _defineExplicitName: string;
  100632. /** @hidden */
  100633. _defineProjectionName: string;
  100634. /** @hidden */
  100635. _defineLocalCubicName: string;
  100636. /** @hidden */
  100637. _defineSphericalName: string;
  100638. /** @hidden */
  100639. _definePlanarName: string;
  100640. /** @hidden */
  100641. _defineEquirectangularName: string;
  100642. /** @hidden */
  100643. _defineMirroredEquirectangularFixedName: string;
  100644. /** @hidden */
  100645. _defineEquirectangularFixedName: string;
  100646. /** @hidden */
  100647. _defineSkyboxName: string;
  100648. /** @hidden */
  100649. _defineOppositeZ: string;
  100650. /** @hidden */
  100651. _cubeSamplerName: string;
  100652. /** @hidden */
  100653. _2DSamplerName: string;
  100654. protected _positionUVWName: string;
  100655. protected _directionWName: string;
  100656. protected _reflectionVectorName: string;
  100657. /** @hidden */
  100658. _reflectionCoordsName: string;
  100659. /** @hidden */
  100660. _reflectionMatrixName: string;
  100661. protected _reflectionColorName: string;
  100662. /**
  100663. * Gets or sets the texture associated with the node
  100664. */
  100665. texture: Nullable<BaseTexture>;
  100666. /**
  100667. * Create a new ReflectionTextureBaseBlock
  100668. * @param name defines the block name
  100669. */
  100670. constructor(name: string);
  100671. /**
  100672. * Gets the current class name
  100673. * @returns the class name
  100674. */
  100675. getClassName(): string;
  100676. /**
  100677. * Gets the world position input component
  100678. */
  100679. abstract get position(): NodeMaterialConnectionPoint;
  100680. /**
  100681. * Gets the world position input component
  100682. */
  100683. abstract get worldPosition(): NodeMaterialConnectionPoint;
  100684. /**
  100685. * Gets the world normal input component
  100686. */
  100687. abstract get worldNormal(): NodeMaterialConnectionPoint;
  100688. /**
  100689. * Gets the world input component
  100690. */
  100691. abstract get world(): NodeMaterialConnectionPoint;
  100692. /**
  100693. * Gets the camera (or eye) position component
  100694. */
  100695. abstract get cameraPosition(): NodeMaterialConnectionPoint;
  100696. /**
  100697. * Gets the view input component
  100698. */
  100699. abstract get view(): NodeMaterialConnectionPoint;
  100700. protected _getTexture(): Nullable<BaseTexture>;
  100701. autoConfigure(material: NodeMaterial): void;
  100702. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  100703. isReady(): boolean;
  100704. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  100705. /**
  100706. * Gets the code to inject in the vertex shader
  100707. * @param state current state of the node material building
  100708. * @returns the shader code
  100709. */
  100710. handleVertexSide(state: NodeMaterialBuildState): string;
  100711. /**
  100712. * Handles the inits for the fragment code path
  100713. * @param state node material build state
  100714. */
  100715. handleFragmentSideInits(state: NodeMaterialBuildState): void;
  100716. /**
  100717. * Generates the reflection coords code for the fragment code path
  100718. * @param worldNormalVarName name of the world normal variable
  100719. * @param worldPos name of the world position variable. If not provided, will use the world position connected to this block
  100720. * @param onlyReflectionVector if true, generates code only for the reflection vector computation, not for the reflection coordinates
  100721. * @returns the shader code
  100722. */
  100723. handleFragmentSideCodeReflectionCoords(worldNormalVarName: string, worldPos?: string, onlyReflectionVector?: boolean): string;
  100724. /**
  100725. * Generates the reflection color code for the fragment code path
  100726. * @param lodVarName name of the lod variable
  100727. * @param swizzleLookupTexture swizzle to use for the final color variable
  100728. * @returns the shader code
  100729. */
  100730. handleFragmentSideCodeReflectionColor(lodVarName?: string, swizzleLookupTexture?: string): string;
  100731. /**
  100732. * Generates the code corresponding to the connected output points
  100733. * @param state node material build state
  100734. * @param varName name of the variable to output
  100735. * @returns the shader code
  100736. */
  100737. writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  100738. protected _buildBlock(state: NodeMaterialBuildState): this;
  100739. protected _dumpPropertiesCode(): string;
  100740. serialize(): any;
  100741. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100742. }
  100743. }
  100744. declare module BABYLON {
  100745. /**
  100746. * Defines a connection point to be used for points with a custom object type
  100747. */
  100748. export class NodeMaterialConnectionPointCustomObject<T extends NodeMaterialBlock> extends NodeMaterialConnectionPoint {
  100749. private _blockType;
  100750. private _blockName;
  100751. private _nameForCheking?;
  100752. /**
  100753. * Creates a new connection point
  100754. * @param name defines the connection point name
  100755. * @param ownerBlock defines the block hosting this connection point
  100756. * @param direction defines the direction of the connection point
  100757. */
  100758. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection, _blockType: new (...args: any[]) => T, _blockName: string, _nameForCheking?: string | undefined);
  100759. /**
  100760. * Gets a number indicating if the current point can be connected to another point
  100761. * @param connectionPoint defines the other connection point
  100762. * @returns a number defining the compatibility state
  100763. */
  100764. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  100765. /**
  100766. * Creates a block suitable to be used as an input for this input point.
  100767. * If null is returned, a block based on the point type will be created.
  100768. * @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
  100769. */
  100770. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  100771. }
  100772. }
  100773. declare module BABYLON {
  100774. /**
  100775. * Enum defining the type of properties that can be edited in the property pages in the NME
  100776. */
  100777. export enum PropertyTypeForEdition {
  100778. /** property is a boolean */
  100779. Boolean = 0,
  100780. /** property is a float */
  100781. Float = 1,
  100782. /** property is a Vector2 */
  100783. Vector2 = 2,
  100784. /** property is a list of values */
  100785. List = 3
  100786. }
  100787. /**
  100788. * Interface that defines an option in a variable of type list
  100789. */
  100790. export interface IEditablePropertyListOption {
  100791. /** label of the option */
  100792. "label": string;
  100793. /** value of the option */
  100794. "value": number;
  100795. }
  100796. /**
  100797. * Interface that defines the options available for an editable property
  100798. */
  100799. export interface IEditablePropertyOption {
  100800. /** min value */
  100801. "min"?: number;
  100802. /** max value */
  100803. "max"?: number;
  100804. /** notifiers: indicates which actions to take when the property is changed */
  100805. "notifiers"?: {
  100806. /** the material should be rebuilt */
  100807. "rebuild"?: boolean;
  100808. /** the preview should be updated */
  100809. "update"?: boolean;
  100810. };
  100811. /** list of the options for a variable of type list */
  100812. "options"?: IEditablePropertyListOption[];
  100813. }
  100814. /**
  100815. * Interface that describes an editable property
  100816. */
  100817. export interface IPropertyDescriptionForEdition {
  100818. /** name of the property */
  100819. "propertyName": string;
  100820. /** display name of the property */
  100821. "displayName": string;
  100822. /** type of the property */
  100823. "type": PropertyTypeForEdition;
  100824. /** group of the property - all properties with the same group value will be displayed in a specific section */
  100825. "groupName": string;
  100826. /** options for the property */
  100827. "options": IEditablePropertyOption;
  100828. }
  100829. /**
  100830. * Decorator that flags a property in a node material block as being editable
  100831. */
  100832. export function editableInPropertyPage(displayName: string, propertyType?: PropertyTypeForEdition, groupName?: string, options?: IEditablePropertyOption): (target: any, propertyKey: string) => void;
  100833. }
  100834. declare module BABYLON {
  100835. /**
  100836. * Block used to implement the refraction part of the sub surface module of the PBR material
  100837. */
  100838. export class RefractionBlock extends NodeMaterialBlock {
  100839. /** @hidden */
  100840. _define3DName: string;
  100841. /** @hidden */
  100842. _refractionMatrixName: string;
  100843. /** @hidden */
  100844. _defineLODRefractionAlpha: string;
  100845. /** @hidden */
  100846. _defineLinearSpecularRefraction: string;
  100847. /** @hidden */
  100848. _defineOppositeZ: string;
  100849. /** @hidden */
  100850. _cubeSamplerName: string;
  100851. /** @hidden */
  100852. _2DSamplerName: string;
  100853. /** @hidden */
  100854. _vRefractionMicrosurfaceInfosName: string;
  100855. /** @hidden */
  100856. _vRefractionInfosName: string;
  100857. private _scene;
  100858. /**
  100859. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  100860. * Materials half opaque for instance using refraction could benefit from this control.
  100861. */
  100862. linkRefractionWithTransparency: boolean;
  100863. /**
  100864. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  100865. */
  100866. invertRefractionY: boolean;
  100867. /**
  100868. * Gets or sets the texture associated with the node
  100869. */
  100870. texture: Nullable<BaseTexture>;
  100871. /**
  100872. * Create a new RefractionBlock
  100873. * @param name defines the block name
  100874. */
  100875. constructor(name: string);
  100876. /**
  100877. * Gets the current class name
  100878. * @returns the class name
  100879. */
  100880. getClassName(): string;
  100881. /**
  100882. * Gets the intensity input component
  100883. */
  100884. get intensity(): NodeMaterialConnectionPoint;
  100885. /**
  100886. * Gets the index of refraction input component
  100887. */
  100888. get indexOfRefraction(): NodeMaterialConnectionPoint;
  100889. /**
  100890. * Gets the tint at distance input component
  100891. */
  100892. get tintAtDistance(): NodeMaterialConnectionPoint;
  100893. /**
  100894. * Gets the view input component
  100895. */
  100896. get view(): NodeMaterialConnectionPoint;
  100897. /**
  100898. * Gets the refraction object output component
  100899. */
  100900. get refraction(): NodeMaterialConnectionPoint;
  100901. /**
  100902. * Returns true if the block has a texture
  100903. */
  100904. get hasTexture(): boolean;
  100905. protected _getTexture(): Nullable<BaseTexture>;
  100906. autoConfigure(material: NodeMaterial): void;
  100907. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  100908. isReady(): boolean;
  100909. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  100910. /**
  100911. * Gets the main code of the block (fragment side)
  100912. * @param state current state of the node material building
  100913. * @returns the shader code
  100914. */
  100915. getCode(state: NodeMaterialBuildState): string;
  100916. protected _buildBlock(state: NodeMaterialBuildState): this;
  100917. protected _dumpPropertiesCode(): string;
  100918. serialize(): any;
  100919. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100920. }
  100921. }
  100922. declare module BABYLON {
  100923. /**
  100924. * Base block used as input for post process
  100925. */
  100926. export class CurrentScreenBlock extends NodeMaterialBlock {
  100927. private _samplerName;
  100928. private _linearDefineName;
  100929. private _gammaDefineName;
  100930. private _mainUVName;
  100931. private _tempTextureRead;
  100932. /**
  100933. * Gets or sets the texture associated with the node
  100934. */
  100935. texture: Nullable<BaseTexture>;
  100936. /**
  100937. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  100938. */
  100939. convertToGammaSpace: boolean;
  100940. /**
  100941. * Gets or sets a boolean indicating if content needs to be converted to linear space
  100942. */
  100943. convertToLinearSpace: boolean;
  100944. /**
  100945. * Create a new CurrentScreenBlock
  100946. * @param name defines the block name
  100947. */
  100948. constructor(name: string);
  100949. /**
  100950. * Gets the current class name
  100951. * @returns the class name
  100952. */
  100953. getClassName(): string;
  100954. /**
  100955. * Gets the uv input component
  100956. */
  100957. get uv(): NodeMaterialConnectionPoint;
  100958. /**
  100959. * Gets the rgba output component
  100960. */
  100961. get rgba(): NodeMaterialConnectionPoint;
  100962. /**
  100963. * Gets the rgb output component
  100964. */
  100965. get rgb(): NodeMaterialConnectionPoint;
  100966. /**
  100967. * Gets the r output component
  100968. */
  100969. get r(): NodeMaterialConnectionPoint;
  100970. /**
  100971. * Gets the g output component
  100972. */
  100973. get g(): NodeMaterialConnectionPoint;
  100974. /**
  100975. * Gets the b output component
  100976. */
  100977. get b(): NodeMaterialConnectionPoint;
  100978. /**
  100979. * Gets the a output component
  100980. */
  100981. get a(): NodeMaterialConnectionPoint;
  100982. /**
  100983. * Initialize the block and prepare the context for build
  100984. * @param state defines the state that will be used for the build
  100985. */
  100986. initialize(state: NodeMaterialBuildState): void;
  100987. get target(): NodeMaterialBlockTargets;
  100988. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  100989. isReady(): boolean;
  100990. private _injectVertexCode;
  100991. private _writeTextureRead;
  100992. private _writeOutput;
  100993. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  100994. serialize(): any;
  100995. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100996. }
  100997. }
  100998. declare module BABYLON {
  100999. /**
  101000. * Base block used for the particle texture
  101001. */
  101002. export class ParticleTextureBlock extends NodeMaterialBlock {
  101003. private _samplerName;
  101004. private _linearDefineName;
  101005. private _gammaDefineName;
  101006. private _tempTextureRead;
  101007. /**
  101008. * Gets or sets the texture associated with the node
  101009. */
  101010. texture: Nullable<BaseTexture>;
  101011. /**
  101012. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  101013. */
  101014. convertToGammaSpace: boolean;
  101015. /**
  101016. * Gets or sets a boolean indicating if content needs to be converted to linear space
  101017. */
  101018. convertToLinearSpace: boolean;
  101019. /**
  101020. * Create a new ParticleTextureBlock
  101021. * @param name defines the block name
  101022. */
  101023. constructor(name: string);
  101024. /**
  101025. * Gets the current class name
  101026. * @returns the class name
  101027. */
  101028. getClassName(): string;
  101029. /**
  101030. * Gets the uv input component
  101031. */
  101032. get uv(): NodeMaterialConnectionPoint;
  101033. /**
  101034. * Gets the rgba output component
  101035. */
  101036. get rgba(): NodeMaterialConnectionPoint;
  101037. /**
  101038. * Gets the rgb output component
  101039. */
  101040. get rgb(): NodeMaterialConnectionPoint;
  101041. /**
  101042. * Gets the r output component
  101043. */
  101044. get r(): NodeMaterialConnectionPoint;
  101045. /**
  101046. * Gets the g output component
  101047. */
  101048. get g(): NodeMaterialConnectionPoint;
  101049. /**
  101050. * Gets the b output component
  101051. */
  101052. get b(): NodeMaterialConnectionPoint;
  101053. /**
  101054. * Gets the a output component
  101055. */
  101056. get a(): NodeMaterialConnectionPoint;
  101057. /**
  101058. * Initialize the block and prepare the context for build
  101059. * @param state defines the state that will be used for the build
  101060. */
  101061. initialize(state: NodeMaterialBuildState): void;
  101062. autoConfigure(material: NodeMaterial): void;
  101063. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  101064. isReady(): boolean;
  101065. private _writeOutput;
  101066. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  101067. serialize(): any;
  101068. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  101069. }
  101070. }
  101071. declare module BABYLON {
  101072. /**
  101073. * Class used to store shared data between 2 NodeMaterialBuildState
  101074. */
  101075. export class NodeMaterialBuildStateSharedData {
  101076. /**
  101077. * Gets the list of emitted varyings
  101078. */
  101079. temps: string[];
  101080. /**
  101081. * Gets the list of emitted varyings
  101082. */
  101083. varyings: string[];
  101084. /**
  101085. * Gets the varying declaration string
  101086. */
  101087. varyingDeclaration: string;
  101088. /**
  101089. * Input blocks
  101090. */
  101091. inputBlocks: InputBlock[];
  101092. /**
  101093. * Input blocks
  101094. */
  101095. textureBlocks: (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  101096. /**
  101097. * Bindable blocks (Blocks that need to set data to the effect)
  101098. */
  101099. bindableBlocks: NodeMaterialBlock[];
  101100. /**
  101101. * List of blocks that can provide a compilation fallback
  101102. */
  101103. blocksWithFallbacks: NodeMaterialBlock[];
  101104. /**
  101105. * List of blocks that can provide a define update
  101106. */
  101107. blocksWithDefines: NodeMaterialBlock[];
  101108. /**
  101109. * List of blocks that can provide a repeatable content
  101110. */
  101111. repeatableContentBlocks: NodeMaterialBlock[];
  101112. /**
  101113. * List of blocks that can provide a dynamic list of uniforms
  101114. */
  101115. dynamicUniformBlocks: NodeMaterialBlock[];
  101116. /**
  101117. * List of blocks that can block the isReady function for the material
  101118. */
  101119. blockingBlocks: NodeMaterialBlock[];
  101120. /**
  101121. * Gets the list of animated inputs
  101122. */
  101123. animatedInputs: InputBlock[];
  101124. /**
  101125. * Build Id used to avoid multiple recompilations
  101126. */
  101127. buildId: number;
  101128. /** List of emitted variables */
  101129. variableNames: {
  101130. [key: string]: number;
  101131. };
  101132. /** List of emitted defines */
  101133. defineNames: {
  101134. [key: string]: number;
  101135. };
  101136. /** Should emit comments? */
  101137. emitComments: boolean;
  101138. /** Emit build activity */
  101139. verbose: boolean;
  101140. /** Gets or sets the hosting scene */
  101141. scene: Scene;
  101142. /**
  101143. * Gets the compilation hints emitted at compilation time
  101144. */
  101145. hints: {
  101146. needWorldViewMatrix: boolean;
  101147. needWorldViewProjectionMatrix: boolean;
  101148. needAlphaBlending: boolean;
  101149. needAlphaTesting: boolean;
  101150. };
  101151. /**
  101152. * List of compilation checks
  101153. */
  101154. checks: {
  101155. emitVertex: boolean;
  101156. emitFragment: boolean;
  101157. notConnectedNonOptionalInputs: NodeMaterialConnectionPoint[];
  101158. };
  101159. /**
  101160. * Is vertex program allowed to be empty?
  101161. */
  101162. allowEmptyVertexProgram: boolean;
  101163. /** Creates a new shared data */
  101164. constructor();
  101165. /**
  101166. * Emits console errors and exceptions if there is a failing check
  101167. */
  101168. emitErrors(): void;
  101169. }
  101170. }
  101171. declare module BABYLON {
  101172. /**
  101173. * Class used to store node based material build state
  101174. */
  101175. export class NodeMaterialBuildState {
  101176. /** Gets or sets a boolean indicating if the current state can emit uniform buffers */
  101177. supportUniformBuffers: boolean;
  101178. /**
  101179. * Gets the list of emitted attributes
  101180. */
  101181. attributes: string[];
  101182. /**
  101183. * Gets the list of emitted uniforms
  101184. */
  101185. uniforms: string[];
  101186. /**
  101187. * Gets the list of emitted constants
  101188. */
  101189. constants: string[];
  101190. /**
  101191. * Gets the list of emitted samplers
  101192. */
  101193. samplers: string[];
  101194. /**
  101195. * Gets the list of emitted functions
  101196. */
  101197. functions: {
  101198. [key: string]: string;
  101199. };
  101200. /**
  101201. * Gets the list of emitted extensions
  101202. */
  101203. extensions: {
  101204. [key: string]: string;
  101205. };
  101206. /**
  101207. * Gets the target of the compilation state
  101208. */
  101209. target: NodeMaterialBlockTargets;
  101210. /**
  101211. * Gets the list of emitted counters
  101212. */
  101213. counters: {
  101214. [key: string]: number;
  101215. };
  101216. /**
  101217. * Shared data between multiple NodeMaterialBuildState instances
  101218. */
  101219. sharedData: NodeMaterialBuildStateSharedData;
  101220. /** @hidden */
  101221. _vertexState: NodeMaterialBuildState;
  101222. /** @hidden */
  101223. _attributeDeclaration: string;
  101224. /** @hidden */
  101225. _uniformDeclaration: string;
  101226. /** @hidden */
  101227. _constantDeclaration: string;
  101228. /** @hidden */
  101229. _samplerDeclaration: string;
  101230. /** @hidden */
  101231. _varyingTransfer: string;
  101232. /** @hidden */
  101233. _injectAtEnd: string;
  101234. private _repeatableContentAnchorIndex;
  101235. /** @hidden */
  101236. _builtCompilationString: string;
  101237. /**
  101238. * Gets the emitted compilation strings
  101239. */
  101240. compilationString: string;
  101241. /**
  101242. * Finalize the compilation strings
  101243. * @param state defines the current compilation state
  101244. */
  101245. finalize(state: NodeMaterialBuildState): void;
  101246. /** @hidden */
  101247. get _repeatableContentAnchor(): string;
  101248. /** @hidden */
  101249. _getFreeVariableName(prefix: string): string;
  101250. /** @hidden */
  101251. _getFreeDefineName(prefix: string): string;
  101252. /** @hidden */
  101253. _excludeVariableName(name: string): void;
  101254. /** @hidden */
  101255. _emit2DSampler(name: string): void;
  101256. /** @hidden */
  101257. _getGLType(type: NodeMaterialBlockConnectionPointTypes): string;
  101258. /** @hidden */
  101259. _emitExtension(name: string, extension: string, define?: string): void;
  101260. /** @hidden */
  101261. _emitFunction(name: string, code: string, comments: string): void;
  101262. /** @hidden */
  101263. _emitCodeFromInclude(includeName: string, comments: string, options?: {
  101264. replaceStrings?: {
  101265. search: RegExp;
  101266. replace: string;
  101267. }[];
  101268. repeatKey?: string;
  101269. }): string;
  101270. /** @hidden */
  101271. _emitFunctionFromInclude(includeName: string, comments: string, options?: {
  101272. repeatKey?: string;
  101273. removeAttributes?: boolean;
  101274. removeUniforms?: boolean;
  101275. removeVaryings?: boolean;
  101276. removeIfDef?: boolean;
  101277. replaceStrings?: {
  101278. search: RegExp;
  101279. replace: string;
  101280. }[];
  101281. }, storeKey?: string): void;
  101282. /** @hidden */
  101283. _registerTempVariable(name: string): boolean;
  101284. /** @hidden */
  101285. _emitVaryingFromString(name: string, type: string, define?: string, notDefine?: boolean): boolean;
  101286. /** @hidden */
  101287. _emitUniformFromString(name: string, type: string, define?: string, notDefine?: boolean): void;
  101288. /** @hidden */
  101289. _emitFloat(value: number): string;
  101290. }
  101291. }
  101292. declare module BABYLON {
  101293. /**
  101294. * Helper class used to generate session unique ID
  101295. */
  101296. export class UniqueIdGenerator {
  101297. private static _UniqueIdCounter;
  101298. /**
  101299. * Gets an unique (relatively to the current scene) Id
  101300. */
  101301. static get UniqueId(): number;
  101302. }
  101303. }
  101304. declare module BABYLON {
  101305. /**
  101306. * Defines a block that can be used inside a node based material
  101307. */
  101308. export class NodeMaterialBlock {
  101309. private _buildId;
  101310. private _buildTarget;
  101311. private _target;
  101312. private _isFinalMerger;
  101313. private _isInput;
  101314. private _name;
  101315. protected _isUnique: boolean;
  101316. /** Gets or sets a boolean indicating that only one input can be connected at a time */
  101317. inputsAreExclusive: boolean;
  101318. /** @hidden */
  101319. _codeVariableName: string;
  101320. /** @hidden */
  101321. _inputs: NodeMaterialConnectionPoint[];
  101322. /** @hidden */
  101323. _outputs: NodeMaterialConnectionPoint[];
  101324. /** @hidden */
  101325. _preparationId: number;
  101326. /**
  101327. * Gets the name of the block
  101328. */
  101329. get name(): string;
  101330. /**
  101331. * Sets the name of the block. Will check if the name is valid.
  101332. */
  101333. set name(newName: string);
  101334. /**
  101335. * Gets or sets the unique id of the node
  101336. */
  101337. uniqueId: number;
  101338. /**
  101339. * Gets or sets the comments associated with this block
  101340. */
  101341. comments: string;
  101342. /**
  101343. * Gets a boolean indicating that this block can only be used once per NodeMaterial
  101344. */
  101345. get isUnique(): boolean;
  101346. /**
  101347. * Gets a boolean indicating that this block is an end block (e.g. it is generating a system value)
  101348. */
  101349. get isFinalMerger(): boolean;
  101350. /**
  101351. * Gets a boolean indicating that this block is an input (e.g. it sends data to the shader)
  101352. */
  101353. get isInput(): boolean;
  101354. /**
  101355. * Gets or sets the build Id
  101356. */
  101357. get buildId(): number;
  101358. set buildId(value: number);
  101359. /**
  101360. * Gets or sets the target of the block
  101361. */
  101362. get target(): NodeMaterialBlockTargets;
  101363. set target(value: NodeMaterialBlockTargets);
  101364. /**
  101365. * Gets the list of input points
  101366. */
  101367. get inputs(): NodeMaterialConnectionPoint[];
  101368. /** Gets the list of output points */
  101369. get outputs(): NodeMaterialConnectionPoint[];
  101370. /**
  101371. * Find an input by its name
  101372. * @param name defines the name of the input to look for
  101373. * @returns the input or null if not found
  101374. */
  101375. getInputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  101376. /**
  101377. * Find an output by its name
  101378. * @param name defines the name of the outputto look for
  101379. * @returns the output or null if not found
  101380. */
  101381. getOutputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  101382. /**
  101383. * Creates a new NodeMaterialBlock
  101384. * @param name defines the block name
  101385. * @param target defines the target of that block (Vertex by default)
  101386. * @param isFinalMerger defines a boolean indicating that this block is an end block (e.g. it is generating a system value). Default is false
  101387. * @param isInput defines a boolean indicating that this block is an input (e.g. it sends data to the shader). Default is false
  101388. */
  101389. constructor(name: string, target?: NodeMaterialBlockTargets, isFinalMerger?: boolean, isInput?: boolean);
  101390. /**
  101391. * Initialize the block and prepare the context for build
  101392. * @param state defines the state that will be used for the build
  101393. */
  101394. initialize(state: NodeMaterialBuildState): void;
  101395. /**
  101396. * Bind data to effect. Will only be called for blocks with isBindable === true
  101397. * @param effect defines the effect to bind data to
  101398. * @param nodeMaterial defines the hosting NodeMaterial
  101399. * @param mesh defines the mesh that will be rendered
  101400. * @param subMesh defines the submesh that will be rendered
  101401. */
  101402. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  101403. protected _declareOutput(output: NodeMaterialConnectionPoint, state: NodeMaterialBuildState): string;
  101404. protected _writeVariable(currentPoint: NodeMaterialConnectionPoint): string;
  101405. protected _writeFloat(value: number): string;
  101406. /**
  101407. * Gets the current class name e.g. "NodeMaterialBlock"
  101408. * @returns the class name
  101409. */
  101410. getClassName(): string;
  101411. /**
  101412. * Register a new input. Must be called inside a block constructor
  101413. * @param name defines the connection point name
  101414. * @param type defines the connection point type
  101415. * @param isOptional defines a boolean indicating that this input can be omitted
  101416. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  101417. * @param point an already created connection point. If not provided, create a new one
  101418. * @returns the current block
  101419. */
  101420. registerInput(name: string, type: NodeMaterialBlockConnectionPointTypes, isOptional?: boolean, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  101421. /**
  101422. * Register a new output. Must be called inside a block constructor
  101423. * @param name defines the connection point name
  101424. * @param type defines the connection point type
  101425. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  101426. * @param point an already created connection point. If not provided, create a new one
  101427. * @returns the current block
  101428. */
  101429. registerOutput(name: string, type: NodeMaterialBlockConnectionPointTypes, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  101430. /**
  101431. * Will return the first available input e.g. the first one which is not an uniform or an attribute
  101432. * @param forOutput defines an optional connection point to check compatibility with
  101433. * @returns the first available input or null
  101434. */
  101435. getFirstAvailableInput(forOutput?: Nullable<NodeMaterialConnectionPoint>): Nullable<NodeMaterialConnectionPoint>;
  101436. /**
  101437. * Will return the first available output e.g. the first one which is not yet connected and not a varying
  101438. * @param forBlock defines an optional block to check compatibility with
  101439. * @returns the first available input or null
  101440. */
  101441. getFirstAvailableOutput(forBlock?: Nullable<NodeMaterialBlock>): Nullable<NodeMaterialConnectionPoint>;
  101442. /**
  101443. * Gets the sibling of the given output
  101444. * @param current defines the current output
  101445. * @returns the next output in the list or null
  101446. */
  101447. getSiblingOutput(current: NodeMaterialConnectionPoint): Nullable<NodeMaterialConnectionPoint>;
  101448. /**
  101449. * Connect current block with another block
  101450. * @param other defines the block to connect with
  101451. * @param options define the various options to help pick the right connections
  101452. * @returns the current block
  101453. */
  101454. connectTo(other: NodeMaterialBlock, options?: {
  101455. input?: string;
  101456. output?: string;
  101457. outputSwizzle?: string;
  101458. }): this | undefined;
  101459. protected _buildBlock(state: NodeMaterialBuildState): void;
  101460. /**
  101461. * Add uniforms, samplers and uniform buffers at compilation time
  101462. * @param state defines the state to update
  101463. * @param nodeMaterial defines the node material requesting the update
  101464. * @param defines defines the material defines to update
  101465. * @param uniformBuffers defines the list of uniform buffer names
  101466. */
  101467. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  101468. /**
  101469. * Add potential fallbacks if shader compilation fails
  101470. * @param mesh defines the mesh to be rendered
  101471. * @param fallbacks defines the current prioritized list of fallbacks
  101472. */
  101473. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  101474. /**
  101475. * Initialize defines for shader compilation
  101476. * @param mesh defines the mesh to be rendered
  101477. * @param nodeMaterial defines the node material requesting the update
  101478. * @param defines defines the material defines to update
  101479. * @param useInstances specifies that instances should be used
  101480. */
  101481. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  101482. /**
  101483. * Update defines for shader compilation
  101484. * @param mesh defines the mesh to be rendered
  101485. * @param nodeMaterial defines the node material requesting the update
  101486. * @param defines defines the material defines to update
  101487. * @param useInstances specifies that instances should be used
  101488. * @param subMesh defines which submesh to render
  101489. */
  101490. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  101491. /**
  101492. * Lets the block try to connect some inputs automatically
  101493. * @param material defines the hosting NodeMaterial
  101494. */
  101495. autoConfigure(material: NodeMaterial): void;
  101496. /**
  101497. * Function called when a block is declared as repeatable content generator
  101498. * @param vertexShaderState defines the current compilation state for the vertex shader
  101499. * @param fragmentShaderState defines the current compilation state for the fragment shader
  101500. * @param mesh defines the mesh to be rendered
  101501. * @param defines defines the material defines to update
  101502. */
  101503. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  101504. /**
  101505. * Checks if the block is ready
  101506. * @param mesh defines the mesh to be rendered
  101507. * @param nodeMaterial defines the node material requesting the update
  101508. * @param defines defines the material defines to update
  101509. * @param useInstances specifies that instances should be used
  101510. * @returns true if the block is ready
  101511. */
  101512. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): boolean;
  101513. protected _linkConnectionTypes(inputIndex0: number, inputIndex1: number): void;
  101514. private _processBuild;
  101515. /**
  101516. * Validates the new name for the block node.
  101517. * @param newName the new name to be given to the node.
  101518. * @returns false if the name is a reserve word, else true.
  101519. */
  101520. validateBlockName(newName: string): boolean;
  101521. /**
  101522. * Compile the current node and generate the shader code
  101523. * @param state defines the current compilation state (uniforms, samplers, current string)
  101524. * @param activeBlocks defines the list of active blocks (i.e. blocks to compile)
  101525. * @returns true if already built
  101526. */
  101527. build(state: NodeMaterialBuildState, activeBlocks: NodeMaterialBlock[]): boolean;
  101528. protected _inputRename(name: string): string;
  101529. protected _outputRename(name: string): string;
  101530. protected _dumpPropertiesCode(): string;
  101531. /** @hidden */
  101532. _dumpCode(uniqueNames: string[], alreadyDumped: NodeMaterialBlock[]): string;
  101533. /** @hidden */
  101534. _dumpCodeForOutputConnections(alreadyDumped: NodeMaterialBlock[]): string;
  101535. /**
  101536. * Clone the current block to a new identical block
  101537. * @param scene defines the hosting scene
  101538. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  101539. * @returns a copy of the current block
  101540. */
  101541. clone(scene: Scene, rootUrl?: string): Nullable<NodeMaterialBlock>;
  101542. /**
  101543. * Serializes this block in a JSON representation
  101544. * @returns the serialized block object
  101545. */
  101546. serialize(): any;
  101547. /** @hidden */
  101548. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  101549. private _deserializePortDisplayNamesAndExposedOnFrame;
  101550. /**
  101551. * Release resources
  101552. */
  101553. dispose(): void;
  101554. }
  101555. }
  101556. declare module BABYLON {
  101557. /**
  101558. * Base class of materials working in push mode in babylon JS
  101559. * @hidden
  101560. */
  101561. export class PushMaterial extends Material {
  101562. protected _activeEffect: Effect;
  101563. protected _normalMatrix: Matrix;
  101564. constructor(name: string, scene: Scene);
  101565. getEffect(): Effect;
  101566. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  101567. protected _isReadyForSubMesh(subMesh: SubMesh): boolean;
  101568. /**
  101569. * Binds the given world matrix to the active effect
  101570. *
  101571. * @param world the matrix to bind
  101572. */
  101573. bindOnlyWorldMatrix(world: Matrix): void;
  101574. /**
  101575. * Binds the given normal matrix to the active effect
  101576. *
  101577. * @param normalMatrix the matrix to bind
  101578. */
  101579. bindOnlyNormalMatrix(normalMatrix: Matrix): void;
  101580. bind(world: Matrix, mesh?: Mesh): void;
  101581. protected _afterBind(mesh: Mesh, effect?: Nullable<Effect>): void;
  101582. protected _mustRebind(scene: Scene, effect: Effect, visibility?: number): boolean;
  101583. }
  101584. }
  101585. declare module BABYLON {
  101586. /**
  101587. * Root class for all node material optimizers
  101588. */
  101589. export class NodeMaterialOptimizer {
  101590. /**
  101591. * Function used to optimize a NodeMaterial graph
  101592. * @param vertexOutputNodes defines the list of output nodes for the vertex shader
  101593. * @param fragmentOutputNodes defines the list of output nodes for the fragment shader
  101594. */
  101595. optimize(vertexOutputNodes: NodeMaterialBlock[], fragmentOutputNodes: NodeMaterialBlock[]): void;
  101596. }
  101597. }
  101598. declare module BABYLON {
  101599. /**
  101600. * Block used to transform a vector (2, 3 or 4) with a matrix. It will generate a Vector4
  101601. */
  101602. export class TransformBlock extends NodeMaterialBlock {
  101603. /**
  101604. * Defines the value to use to complement W value to transform it to a Vector4
  101605. */
  101606. complementW: number;
  101607. /**
  101608. * Defines the value to use to complement z value to transform it to a Vector4
  101609. */
  101610. complementZ: number;
  101611. /**
  101612. * Creates a new TransformBlock
  101613. * @param name defines the block name
  101614. */
  101615. constructor(name: string);
  101616. /**
  101617. * Gets the current class name
  101618. * @returns the class name
  101619. */
  101620. getClassName(): string;
  101621. /**
  101622. * Gets the vector input
  101623. */
  101624. get vector(): NodeMaterialConnectionPoint;
  101625. /**
  101626. * Gets the output component
  101627. */
  101628. get output(): NodeMaterialConnectionPoint;
  101629. /**
  101630. * Gets the xyz output component
  101631. */
  101632. get xyz(): NodeMaterialConnectionPoint;
  101633. /**
  101634. * Gets the matrix transform input
  101635. */
  101636. get transform(): NodeMaterialConnectionPoint;
  101637. protected _buildBlock(state: NodeMaterialBuildState): this;
  101638. /**
  101639. * Update defines for shader compilation
  101640. * @param mesh defines the mesh to be rendered
  101641. * @param nodeMaterial defines the node material requesting the update
  101642. * @param defines defines the material defines to update
  101643. * @param useInstances specifies that instances should be used
  101644. * @param subMesh defines which submesh to render
  101645. */
  101646. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  101647. serialize(): any;
  101648. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  101649. protected _dumpPropertiesCode(): string;
  101650. }
  101651. }
  101652. declare module BABYLON {
  101653. /**
  101654. * Block used to output the vertex position
  101655. */
  101656. export class VertexOutputBlock extends NodeMaterialBlock {
  101657. /**
  101658. * Creates a new VertexOutputBlock
  101659. * @param name defines the block name
  101660. */
  101661. constructor(name: string);
  101662. /**
  101663. * Gets the current class name
  101664. * @returns the class name
  101665. */
  101666. getClassName(): string;
  101667. /**
  101668. * Gets the vector input component
  101669. */
  101670. get vector(): NodeMaterialConnectionPoint;
  101671. protected _buildBlock(state: NodeMaterialBuildState): this;
  101672. }
  101673. }
  101674. declare module BABYLON {
  101675. /**
  101676. * Block used to output the final color
  101677. */
  101678. export class FragmentOutputBlock extends NodeMaterialBlock {
  101679. /**
  101680. * Create a new FragmentOutputBlock
  101681. * @param name defines the block name
  101682. */
  101683. constructor(name: string);
  101684. /**
  101685. * Gets the current class name
  101686. * @returns the class name
  101687. */
  101688. getClassName(): string;
  101689. /**
  101690. * Gets the rgba input component
  101691. */
  101692. get rgba(): NodeMaterialConnectionPoint;
  101693. /**
  101694. * Gets the rgb input component
  101695. */
  101696. get rgb(): NodeMaterialConnectionPoint;
  101697. /**
  101698. * Gets the a input component
  101699. */
  101700. get a(): NodeMaterialConnectionPoint;
  101701. protected _buildBlock(state: NodeMaterialBuildState): this;
  101702. }
  101703. }
  101704. declare module BABYLON {
  101705. /**
  101706. * Block used for the particle ramp gradient section
  101707. */
  101708. export class ParticleRampGradientBlock extends NodeMaterialBlock {
  101709. /**
  101710. * Create a new ParticleRampGradientBlock
  101711. * @param name defines the block name
  101712. */
  101713. constructor(name: string);
  101714. /**
  101715. * Gets the current class name
  101716. * @returns the class name
  101717. */
  101718. getClassName(): string;
  101719. /**
  101720. * Gets the color input component
  101721. */
  101722. get color(): NodeMaterialConnectionPoint;
  101723. /**
  101724. * Gets the rampColor output component
  101725. */
  101726. get rampColor(): NodeMaterialConnectionPoint;
  101727. /**
  101728. * Initialize the block and prepare the context for build
  101729. * @param state defines the state that will be used for the build
  101730. */
  101731. initialize(state: NodeMaterialBuildState): void;
  101732. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  101733. }
  101734. }
  101735. declare module BABYLON {
  101736. /**
  101737. * Block used for the particle blend multiply section
  101738. */
  101739. export class ParticleBlendMultiplyBlock extends NodeMaterialBlock {
  101740. /**
  101741. * Create a new ParticleBlendMultiplyBlock
  101742. * @param name defines the block name
  101743. */
  101744. constructor(name: string);
  101745. /**
  101746. * Gets the current class name
  101747. * @returns the class name
  101748. */
  101749. getClassName(): string;
  101750. /**
  101751. * Gets the color input component
  101752. */
  101753. get color(): NodeMaterialConnectionPoint;
  101754. /**
  101755. * Gets the alphaTexture input component
  101756. */
  101757. get alphaTexture(): NodeMaterialConnectionPoint;
  101758. /**
  101759. * Gets the alphaColor input component
  101760. */
  101761. get alphaColor(): NodeMaterialConnectionPoint;
  101762. /**
  101763. * Gets the blendColor output component
  101764. */
  101765. get blendColor(): NodeMaterialConnectionPoint;
  101766. /**
  101767. * Initialize the block and prepare the context for build
  101768. * @param state defines the state that will be used for the build
  101769. */
  101770. initialize(state: NodeMaterialBuildState): void;
  101771. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  101772. }
  101773. }
  101774. declare module BABYLON {
  101775. /**
  101776. * Block used to create a Vector2/3/4 out of individual inputs (one for each component)
  101777. */
  101778. export class VectorMergerBlock extends NodeMaterialBlock {
  101779. /**
  101780. * Create a new VectorMergerBlock
  101781. * @param name defines the block name
  101782. */
  101783. constructor(name: string);
  101784. /**
  101785. * Gets the current class name
  101786. * @returns the class name
  101787. */
  101788. getClassName(): string;
  101789. /**
  101790. * Gets the xyz component (input)
  101791. */
  101792. get xyzIn(): NodeMaterialConnectionPoint;
  101793. /**
  101794. * Gets the xy component (input)
  101795. */
  101796. get xyIn(): NodeMaterialConnectionPoint;
  101797. /**
  101798. * Gets the x component (input)
  101799. */
  101800. get x(): NodeMaterialConnectionPoint;
  101801. /**
  101802. * Gets the y component (input)
  101803. */
  101804. get y(): NodeMaterialConnectionPoint;
  101805. /**
  101806. * Gets the z component (input)
  101807. */
  101808. get z(): NodeMaterialConnectionPoint;
  101809. /**
  101810. * Gets the w component (input)
  101811. */
  101812. get w(): NodeMaterialConnectionPoint;
  101813. /**
  101814. * Gets the xyzw component (output)
  101815. */
  101816. get xyzw(): NodeMaterialConnectionPoint;
  101817. /**
  101818. * Gets the xyz component (output)
  101819. */
  101820. get xyzOut(): NodeMaterialConnectionPoint;
  101821. /**
  101822. * Gets the xy component (output)
  101823. */
  101824. get xyOut(): NodeMaterialConnectionPoint;
  101825. /**
  101826. * Gets the xy component (output)
  101827. * @deprecated Please use xyOut instead.
  101828. */
  101829. get xy(): NodeMaterialConnectionPoint;
  101830. /**
  101831. * Gets the xyz component (output)
  101832. * @deprecated Please use xyzOut instead.
  101833. */
  101834. get xyz(): NodeMaterialConnectionPoint;
  101835. protected _buildBlock(state: NodeMaterialBuildState): this;
  101836. }
  101837. }
  101838. declare module BABYLON {
  101839. /**
  101840. * Block used to remap a float from a range to a new one
  101841. */
  101842. export class RemapBlock extends NodeMaterialBlock {
  101843. /**
  101844. * Gets or sets the source range
  101845. */
  101846. sourceRange: Vector2;
  101847. /**
  101848. * Gets or sets the target range
  101849. */
  101850. targetRange: Vector2;
  101851. /**
  101852. * Creates a new RemapBlock
  101853. * @param name defines the block name
  101854. */
  101855. constructor(name: string);
  101856. /**
  101857. * Gets the current class name
  101858. * @returns the class name
  101859. */
  101860. getClassName(): string;
  101861. /**
  101862. * Gets the input component
  101863. */
  101864. get input(): NodeMaterialConnectionPoint;
  101865. /**
  101866. * Gets the source min input component
  101867. */
  101868. get sourceMin(): NodeMaterialConnectionPoint;
  101869. /**
  101870. * Gets the source max input component
  101871. */
  101872. get sourceMax(): NodeMaterialConnectionPoint;
  101873. /**
  101874. * Gets the target min input component
  101875. */
  101876. get targetMin(): NodeMaterialConnectionPoint;
  101877. /**
  101878. * Gets the target max input component
  101879. */
  101880. get targetMax(): NodeMaterialConnectionPoint;
  101881. /**
  101882. * Gets the output component
  101883. */
  101884. get output(): NodeMaterialConnectionPoint;
  101885. protected _buildBlock(state: NodeMaterialBuildState): this;
  101886. protected _dumpPropertiesCode(): string;
  101887. serialize(): any;
  101888. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  101889. }
  101890. }
  101891. declare module BABYLON {
  101892. /**
  101893. * Block used to multiply 2 values
  101894. */
  101895. export class MultiplyBlock extends NodeMaterialBlock {
  101896. /**
  101897. * Creates a new MultiplyBlock
  101898. * @param name defines the block name
  101899. */
  101900. constructor(name: string);
  101901. /**
  101902. * Gets the current class name
  101903. * @returns the class name
  101904. */
  101905. getClassName(): string;
  101906. /**
  101907. * Gets the left operand input component
  101908. */
  101909. get left(): NodeMaterialConnectionPoint;
  101910. /**
  101911. * Gets the right operand input component
  101912. */
  101913. get right(): NodeMaterialConnectionPoint;
  101914. /**
  101915. * Gets the output component
  101916. */
  101917. get output(): NodeMaterialConnectionPoint;
  101918. protected _buildBlock(state: NodeMaterialBuildState): this;
  101919. }
  101920. }
  101921. declare module BABYLON {
  101922. /**
  101923. * Block used to expand a Color3/4 into 4 outputs (one for each component)
  101924. */
  101925. export class ColorSplitterBlock extends NodeMaterialBlock {
  101926. /**
  101927. * Create a new ColorSplitterBlock
  101928. * @param name defines the block name
  101929. */
  101930. constructor(name: string);
  101931. /**
  101932. * Gets the current class name
  101933. * @returns the class name
  101934. */
  101935. getClassName(): string;
  101936. /**
  101937. * Gets the rgba component (input)
  101938. */
  101939. get rgba(): NodeMaterialConnectionPoint;
  101940. /**
  101941. * Gets the rgb component (input)
  101942. */
  101943. get rgbIn(): NodeMaterialConnectionPoint;
  101944. /**
  101945. * Gets the rgb component (output)
  101946. */
  101947. get rgbOut(): NodeMaterialConnectionPoint;
  101948. /**
  101949. * Gets the r component (output)
  101950. */
  101951. get r(): NodeMaterialConnectionPoint;
  101952. /**
  101953. * Gets the g component (output)
  101954. */
  101955. get g(): NodeMaterialConnectionPoint;
  101956. /**
  101957. * Gets the b component (output)
  101958. */
  101959. get b(): NodeMaterialConnectionPoint;
  101960. /**
  101961. * Gets the a component (output)
  101962. */
  101963. get a(): NodeMaterialConnectionPoint;
  101964. protected _inputRename(name: string): string;
  101965. protected _outputRename(name: string): string;
  101966. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  101967. }
  101968. }
  101969. declare module BABYLON {
  101970. /**
  101971. * Interface used to configure the node material editor
  101972. */
  101973. export interface INodeMaterialEditorOptions {
  101974. /** Define the URl to load node editor script */
  101975. editorURL?: string;
  101976. }
  101977. /** @hidden */
  101978. export class NodeMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  101979. NORMAL: boolean;
  101980. TANGENT: boolean;
  101981. UV1: boolean;
  101982. /** BONES */
  101983. NUM_BONE_INFLUENCERS: number;
  101984. BonesPerMesh: number;
  101985. BONETEXTURE: boolean;
  101986. /** MORPH TARGETS */
  101987. MORPHTARGETS: boolean;
  101988. MORPHTARGETS_NORMAL: boolean;
  101989. MORPHTARGETS_TANGENT: boolean;
  101990. MORPHTARGETS_UV: boolean;
  101991. NUM_MORPH_INFLUENCERS: number;
  101992. /** IMAGE PROCESSING */
  101993. IMAGEPROCESSING: boolean;
  101994. VIGNETTE: boolean;
  101995. VIGNETTEBLENDMODEMULTIPLY: boolean;
  101996. VIGNETTEBLENDMODEOPAQUE: boolean;
  101997. TONEMAPPING: boolean;
  101998. TONEMAPPING_ACES: boolean;
  101999. CONTRAST: boolean;
  102000. EXPOSURE: boolean;
  102001. COLORCURVES: boolean;
  102002. COLORGRADING: boolean;
  102003. COLORGRADING3D: boolean;
  102004. SAMPLER3DGREENDEPTH: boolean;
  102005. SAMPLER3DBGRMAP: boolean;
  102006. IMAGEPROCESSINGPOSTPROCESS: boolean;
  102007. /** MISC. */
  102008. BUMPDIRECTUV: number;
  102009. constructor();
  102010. setValue(name: string, value: any, markAsUnprocessedIfDirty?: boolean): void;
  102011. }
  102012. /**
  102013. * Class used to configure NodeMaterial
  102014. */
  102015. export interface INodeMaterialOptions {
  102016. /**
  102017. * Defines if blocks should emit comments
  102018. */
  102019. emitComments: boolean;
  102020. }
  102021. /**
  102022. * Class used to create a node based material built by assembling shader blocks
  102023. */
  102024. export class NodeMaterial extends PushMaterial {
  102025. private static _BuildIdGenerator;
  102026. private _options;
  102027. private _vertexCompilationState;
  102028. private _fragmentCompilationState;
  102029. private _sharedData;
  102030. private _buildId;
  102031. private _buildWasSuccessful;
  102032. private _cachedWorldViewMatrix;
  102033. private _cachedWorldViewProjectionMatrix;
  102034. private _optimizers;
  102035. private _animationFrame;
  102036. /** Define the Url to load node editor script */
  102037. static EditorURL: string;
  102038. /** Define the Url to load snippets */
  102039. static SnippetUrl: string;
  102040. /** Gets or sets a boolean indicating that node materials should not deserialize textures from json / snippet content */
  102041. static IgnoreTexturesAtLoadTime: boolean;
  102042. private BJSNODEMATERIALEDITOR;
  102043. /** Get the inspector from bundle or global */
  102044. private _getGlobalNodeMaterialEditor;
  102045. /**
  102046. * Snippet ID if the material was created from the snippet server
  102047. */
  102048. snippetId: string;
  102049. /**
  102050. * Gets or sets data used by visual editor
  102051. * @see https://nme.babylonjs.com
  102052. */
  102053. editorData: any;
  102054. /**
  102055. * 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)
  102056. */
  102057. ignoreAlpha: boolean;
  102058. /**
  102059. * Defines the maximum number of lights that can be used in the material
  102060. */
  102061. maxSimultaneousLights: number;
  102062. /**
  102063. * Observable raised when the material is built
  102064. */
  102065. onBuildObservable: Observable<NodeMaterial>;
  102066. /**
  102067. * Gets or sets the root nodes of the material vertex shader
  102068. */
  102069. _vertexOutputNodes: NodeMaterialBlock[];
  102070. /**
  102071. * Gets or sets the root nodes of the material fragment (pixel) shader
  102072. */
  102073. _fragmentOutputNodes: NodeMaterialBlock[];
  102074. /** Gets or sets options to control the node material overall behavior */
  102075. get options(): INodeMaterialOptions;
  102076. set options(options: INodeMaterialOptions);
  102077. /**
  102078. * Default configuration related to image processing available in the standard Material.
  102079. */
  102080. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  102081. /**
  102082. * Gets the image processing configuration used either in this material.
  102083. */
  102084. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  102085. /**
  102086. * Sets the Default image processing configuration used either in the this material.
  102087. *
  102088. * If sets to null, the scene one is in use.
  102089. */
  102090. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  102091. /**
  102092. * Gets an array of blocks that needs to be serialized even if they are not yet connected
  102093. */
  102094. attachedBlocks: NodeMaterialBlock[];
  102095. /**
  102096. * Specifies the mode of the node material
  102097. * @hidden
  102098. */
  102099. _mode: NodeMaterialModes;
  102100. /**
  102101. * Gets the mode property
  102102. */
  102103. get mode(): NodeMaterialModes;
  102104. /**
  102105. * Create a new node based material
  102106. * @param name defines the material name
  102107. * @param scene defines the hosting scene
  102108. * @param options defines creation option
  102109. */
  102110. constructor(name: string, scene?: Scene, options?: Partial<INodeMaterialOptions>);
  102111. /**
  102112. * Gets the current class name of the material e.g. "NodeMaterial"
  102113. * @returns the class name
  102114. */
  102115. getClassName(): string;
  102116. /**
  102117. * Keep track of the image processing observer to allow dispose and replace.
  102118. */
  102119. private _imageProcessingObserver;
  102120. /**
  102121. * Attaches a new image processing configuration to the Standard Material.
  102122. * @param configuration
  102123. */
  102124. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  102125. /**
  102126. * Get a block by its name
  102127. * @param name defines the name of the block to retrieve
  102128. * @returns the required block or null if not found
  102129. */
  102130. getBlockByName(name: string): Nullable<NodeMaterialBlock>;
  102131. /**
  102132. * Get a block by its name
  102133. * @param predicate defines the predicate used to find the good candidate
  102134. * @returns the required block or null if not found
  102135. */
  102136. getBlockByPredicate(predicate: (block: NodeMaterialBlock) => boolean): Nullable<NodeMaterialBlock>;
  102137. /**
  102138. * Get an input block by its name
  102139. * @param predicate defines the predicate used to find the good candidate
  102140. * @returns the required input block or null if not found
  102141. */
  102142. getInputBlockByPredicate(predicate: (block: InputBlock) => boolean): Nullable<InputBlock>;
  102143. /**
  102144. * Gets the list of input blocks attached to this material
  102145. * @returns an array of InputBlocks
  102146. */
  102147. getInputBlocks(): InputBlock[];
  102148. /**
  102149. * Adds a new optimizer to the list of optimizers
  102150. * @param optimizer defines the optimizers to add
  102151. * @returns the current material
  102152. */
  102153. registerOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  102154. /**
  102155. * Remove an optimizer from the list of optimizers
  102156. * @param optimizer defines the optimizers to remove
  102157. * @returns the current material
  102158. */
  102159. unregisterOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  102160. /**
  102161. * Add a new block to the list of output nodes
  102162. * @param node defines the node to add
  102163. * @returns the current material
  102164. */
  102165. addOutputNode(node: NodeMaterialBlock): this;
  102166. /**
  102167. * Remove a block from the list of root nodes
  102168. * @param node defines the node to remove
  102169. * @returns the current material
  102170. */
  102171. removeOutputNode(node: NodeMaterialBlock): this;
  102172. private _addVertexOutputNode;
  102173. private _removeVertexOutputNode;
  102174. private _addFragmentOutputNode;
  102175. private _removeFragmentOutputNode;
  102176. /**
  102177. * Specifies if the material will require alpha blending
  102178. * @returns a boolean specifying if alpha blending is needed
  102179. */
  102180. needAlphaBlending(): boolean;
  102181. /**
  102182. * Specifies if this material should be rendered in alpha test mode
  102183. * @returns a boolean specifying if an alpha test is needed.
  102184. */
  102185. needAlphaTesting(): boolean;
  102186. private _initializeBlock;
  102187. private _resetDualBlocks;
  102188. /**
  102189. * Remove a block from the current node material
  102190. * @param block defines the block to remove
  102191. */
  102192. removeBlock(block: NodeMaterialBlock): void;
  102193. /**
  102194. * Build the material and generates the inner effect
  102195. * @param verbose defines if the build should log activity
  102196. */
  102197. build(verbose?: boolean): void;
  102198. /**
  102199. * Runs an otpimization phase to try to improve the shader code
  102200. */
  102201. optimize(): void;
  102202. private _prepareDefinesForAttributes;
  102203. /**
  102204. * Create a post process from the material
  102205. * @param camera The camera to apply the render pass to.
  102206. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  102207. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  102208. * @param engine The engine which the post process will be applied. (default: current engine)
  102209. * @param reusable If the post process can be reused on the same frame. (default: false)
  102210. * @param textureType Type of textures used when performing the post process. (default: 0)
  102211. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  102212. * @returns the post process created
  102213. */
  102214. createPostProcess(camera: Nullable<Camera>, options?: number | PostProcessOptions, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, textureFormat?: number): PostProcess;
  102215. /**
  102216. * Create the post process effect from the material
  102217. * @param postProcess The post process to create the effect for
  102218. */
  102219. createEffectForPostProcess(postProcess: PostProcess): void;
  102220. private _createEffectOrPostProcess;
  102221. private _createEffectForParticles;
  102222. /**
  102223. * Create the effect to be used as the custom effect for a particle system
  102224. * @param particleSystem Particle system to create the effect for
  102225. * @param onCompiled defines a function to call when the effect creation is successful
  102226. * @param onError defines a function to call when the effect creation has failed
  102227. */
  102228. createEffectForParticles(particleSystem: IParticleSystem, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  102229. private _processDefines;
  102230. /**
  102231. * Get if the submesh is ready to be used and all its information available.
  102232. * Child classes can use it to update shaders
  102233. * @param mesh defines the mesh to check
  102234. * @param subMesh defines which submesh to check
  102235. * @param useInstances specifies that instances should be used
  102236. * @returns a boolean indicating that the submesh is ready or not
  102237. */
  102238. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  102239. /**
  102240. * Get a string representing the shaders built by the current node graph
  102241. */
  102242. get compiledShaders(): string;
  102243. /**
  102244. * Binds the world matrix to the material
  102245. * @param world defines the world transformation matrix
  102246. */
  102247. bindOnlyWorldMatrix(world: Matrix): void;
  102248. /**
  102249. * Binds the submesh to this material by preparing the effect and shader to draw
  102250. * @param world defines the world transformation matrix
  102251. * @param mesh defines the mesh containing the submesh
  102252. * @param subMesh defines the submesh to bind the material to
  102253. */
  102254. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  102255. /**
  102256. * Gets the active textures from the material
  102257. * @returns an array of textures
  102258. */
  102259. getActiveTextures(): BaseTexture[];
  102260. /**
  102261. * Gets the list of texture blocks
  102262. * @returns an array of texture blocks
  102263. */
  102264. getTextureBlocks(): (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  102265. /**
  102266. * Specifies if the material uses a texture
  102267. * @param texture defines the texture to check against the material
  102268. * @returns a boolean specifying if the material uses the texture
  102269. */
  102270. hasTexture(texture: BaseTexture): boolean;
  102271. /**
  102272. * Disposes the material
  102273. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  102274. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  102275. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  102276. */
  102277. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  102278. /** Creates the node editor window. */
  102279. private _createNodeEditor;
  102280. /**
  102281. * Launch the node material editor
  102282. * @param config Define the configuration of the editor
  102283. * @return a promise fulfilled when the node editor is visible
  102284. */
  102285. edit(config?: INodeMaterialEditorOptions): Promise<void>;
  102286. /**
  102287. * Clear the current material
  102288. */
  102289. clear(): void;
  102290. /**
  102291. * Clear the current material and set it to a default state
  102292. */
  102293. setToDefault(): void;
  102294. /**
  102295. * Clear the current material and set it to a default state for post process
  102296. */
  102297. setToDefaultPostProcess(): void;
  102298. /**
  102299. * Clear the current material and set it to a default state for particle
  102300. */
  102301. setToDefaultParticle(): void;
  102302. /**
  102303. * Loads the current Node Material from a url pointing to a file save by the Node Material Editor
  102304. * @param url defines the url to load from
  102305. * @returns a promise that will fullfil when the material is fully loaded
  102306. */
  102307. loadAsync(url: string): Promise<void>;
  102308. private _gatherBlocks;
  102309. /**
  102310. * Generate a string containing the code declaration required to create an equivalent of this material
  102311. * @returns a string
  102312. */
  102313. generateCode(): string;
  102314. /**
  102315. * Serializes this material in a JSON representation
  102316. * @returns the serialized material object
  102317. */
  102318. serialize(selectedBlocks?: NodeMaterialBlock[]): any;
  102319. private _restoreConnections;
  102320. /**
  102321. * Clear the current graph and load a new one from a serialization object
  102322. * @param source defines the JSON representation of the material
  102323. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  102324. * @param merge defines whether or not the source must be merged or replace the current content
  102325. */
  102326. loadFromSerialization(source: any, rootUrl?: string, merge?: boolean): void;
  102327. /**
  102328. * Makes a duplicate of the current material.
  102329. * @param name - name to use for the new material.
  102330. */
  102331. clone(name: string): NodeMaterial;
  102332. /**
  102333. * Creates a node material from parsed material data
  102334. * @param source defines the JSON representation of the material
  102335. * @param scene defines the hosting scene
  102336. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  102337. * @returns a new node material
  102338. */
  102339. static Parse(source: any, scene: Scene, rootUrl?: string): NodeMaterial;
  102340. /**
  102341. * Creates a node material from a snippet saved in a remote file
  102342. * @param name defines the name of the material to create
  102343. * @param url defines the url to load from
  102344. * @param scene defines the hosting scene
  102345. * @returns a promise that will resolve to the new node material
  102346. */
  102347. static ParseFromFileAsync(name: string, url: string, scene: Scene): Promise<NodeMaterial>;
  102348. /**
  102349. * Creates a node material from a snippet saved by the node material editor
  102350. * @param snippetId defines the snippet to load
  102351. * @param scene defines the hosting scene
  102352. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  102353. * @param nodeMaterial defines a node material to update (instead of creating a new one)
  102354. * @returns a promise that will resolve to the new node material
  102355. */
  102356. static ParseFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string, nodeMaterial?: NodeMaterial): Promise<NodeMaterial>;
  102357. /**
  102358. * Creates a new node material set to default basic configuration
  102359. * @param name defines the name of the material
  102360. * @param scene defines the hosting scene
  102361. * @returns a new NodeMaterial
  102362. */
  102363. static CreateDefault(name: string, scene?: Scene): NodeMaterial;
  102364. }
  102365. }
  102366. declare module BABYLON {
  102367. /**
  102368. * Size options for a post process
  102369. */
  102370. export type PostProcessOptions = {
  102371. width: number;
  102372. height: number;
  102373. };
  102374. /**
  102375. * PostProcess can be used to apply a shader to a texture after it has been rendered
  102376. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  102377. */
  102378. export class PostProcess {
  102379. /**
  102380. * Gets or sets the unique id of the post process
  102381. */
  102382. uniqueId: number;
  102383. /** Name of the PostProcess. */
  102384. name: string;
  102385. /**
  102386. * Width of the texture to apply the post process on
  102387. */
  102388. width: number;
  102389. /**
  102390. * Height of the texture to apply the post process on
  102391. */
  102392. height: number;
  102393. /**
  102394. * Gets the node material used to create this postprocess (null if the postprocess was manually created)
  102395. */
  102396. nodeMaterialSource: Nullable<NodeMaterial>;
  102397. /**
  102398. * Internal, reference to the location where this postprocess was output to. (Typically the texture on the next postprocess in the chain)
  102399. * @hidden
  102400. */
  102401. _outputTexture: Nullable<InternalTexture>;
  102402. /**
  102403. * Sampling mode used by the shader
  102404. * See https://doc.babylonjs.com/classes/3.1/texture
  102405. */
  102406. renderTargetSamplingMode: number;
  102407. /**
  102408. * Clear color to use when screen clearing
  102409. */
  102410. clearColor: Color4;
  102411. /**
  102412. * If the buffer needs to be cleared before applying the post process. (default: true)
  102413. * Should be set to false if shader will overwrite all previous pixels.
  102414. */
  102415. autoClear: boolean;
  102416. /**
  102417. * Type of alpha mode to use when performing the post process (default: Engine.ALPHA_DISABLE)
  102418. */
  102419. alphaMode: number;
  102420. /**
  102421. * Sets the setAlphaBlendConstants of the babylon engine
  102422. */
  102423. alphaConstants: Color4;
  102424. /**
  102425. * Animations to be used for the post processing
  102426. */
  102427. animations: Animation[];
  102428. /**
  102429. * Enable Pixel Perfect mode where texture is not scaled to be power of 2.
  102430. * Can only be used on a single postprocess or on the last one of a chain. (default: false)
  102431. */
  102432. enablePixelPerfectMode: boolean;
  102433. /**
  102434. * Force the postprocess to be applied without taking in account viewport
  102435. */
  102436. forceFullscreenViewport: boolean;
  102437. /**
  102438. * List of inspectable custom properties (used by the Inspector)
  102439. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  102440. */
  102441. inspectableCustomProperties: IInspectable[];
  102442. /**
  102443. * Scale mode for the post process (default: Engine.SCALEMODE_FLOOR)
  102444. *
  102445. * | Value | Type | Description |
  102446. * | ----- | ----------------------------------- | ----------- |
  102447. * | 1 | SCALEMODE_FLOOR | [engine.scalemode_floor](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_floor) |
  102448. * | 2 | SCALEMODE_NEAREST | [engine.scalemode_nearest](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_nearest) |
  102449. * | 3 | SCALEMODE_CEILING | [engine.scalemode_ceiling](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_ceiling) |
  102450. *
  102451. */
  102452. scaleMode: number;
  102453. /**
  102454. * Force textures to be a power of two (default: false)
  102455. */
  102456. alwaysForcePOT: boolean;
  102457. private _samples;
  102458. /**
  102459. * Number of sample textures (default: 1)
  102460. */
  102461. get samples(): number;
  102462. set samples(n: number);
  102463. /**
  102464. * Modify the scale of the post process to be the same as the viewport (default: false)
  102465. */
  102466. adaptScaleToCurrentViewport: boolean;
  102467. private _camera;
  102468. protected _scene: Scene;
  102469. private _engine;
  102470. private _options;
  102471. private _reusable;
  102472. private _textureType;
  102473. private _textureFormat;
  102474. /**
  102475. * Smart array of input and output textures for the post process.
  102476. * @hidden
  102477. */
  102478. _textures: SmartArray<InternalTexture>;
  102479. /**
  102480. * The index in _textures that corresponds to the output texture.
  102481. * @hidden
  102482. */
  102483. _currentRenderTextureInd: number;
  102484. private _effect;
  102485. private _samplers;
  102486. private _fragmentUrl;
  102487. private _vertexUrl;
  102488. private _parameters;
  102489. private _scaleRatio;
  102490. protected _indexParameters: any;
  102491. private _shareOutputWithPostProcess;
  102492. private _texelSize;
  102493. private _forcedOutputTexture;
  102494. /**
  102495. * Returns the fragment url or shader name used in the post process.
  102496. * @returns the fragment url or name in the shader store.
  102497. */
  102498. getEffectName(): string;
  102499. /**
  102500. * An event triggered when the postprocess is activated.
  102501. */
  102502. onActivateObservable: Observable<Camera>;
  102503. private _onActivateObserver;
  102504. /**
  102505. * A function that is added to the onActivateObservable
  102506. */
  102507. set onActivate(callback: Nullable<(camera: Camera) => void>);
  102508. /**
  102509. * An event triggered when the postprocess changes its size.
  102510. */
  102511. onSizeChangedObservable: Observable<PostProcess>;
  102512. private _onSizeChangedObserver;
  102513. /**
  102514. * A function that is added to the onSizeChangedObservable
  102515. */
  102516. set onSizeChanged(callback: (postProcess: PostProcess) => void);
  102517. /**
  102518. * An event triggered when the postprocess applies its effect.
  102519. */
  102520. onApplyObservable: Observable<Effect>;
  102521. private _onApplyObserver;
  102522. /**
  102523. * A function that is added to the onApplyObservable
  102524. */
  102525. set onApply(callback: (effect: Effect) => void);
  102526. /**
  102527. * An event triggered before rendering the postprocess
  102528. */
  102529. onBeforeRenderObservable: Observable<Effect>;
  102530. private _onBeforeRenderObserver;
  102531. /**
  102532. * A function that is added to the onBeforeRenderObservable
  102533. */
  102534. set onBeforeRender(callback: (effect: Effect) => void);
  102535. /**
  102536. * An event triggered after rendering the postprocess
  102537. */
  102538. onAfterRenderObservable: Observable<Effect>;
  102539. private _onAfterRenderObserver;
  102540. /**
  102541. * A function that is added to the onAfterRenderObservable
  102542. */
  102543. set onAfterRender(callback: (efect: Effect) => void);
  102544. /**
  102545. * 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
  102546. * render it's output into this texture and this texture will be used as textureSampler in the fragment shader of this post process.
  102547. */
  102548. get inputTexture(): InternalTexture;
  102549. set inputTexture(value: InternalTexture);
  102550. /**
  102551. * Since inputTexture should always be defined, if we previously manually set `inputTexture`,
  102552. * the only way to unset it is to use this function to restore its internal state
  102553. */
  102554. restoreDefaultInputTexture(): void;
  102555. /**
  102556. * Gets the camera which post process is applied to.
  102557. * @returns The camera the post process is applied to.
  102558. */
  102559. getCamera(): Camera;
  102560. /**
  102561. * Gets the texel size of the postprocess.
  102562. * See https://en.wikipedia.org/wiki/Texel_(graphics)
  102563. */
  102564. get texelSize(): Vector2;
  102565. /**
  102566. * Creates a new instance PostProcess
  102567. * @param name The name of the PostProcess.
  102568. * @param fragmentUrl The url of the fragment shader to be used.
  102569. * @param parameters Array of the names of uniform non-sampler2D variables that will be passed to the shader.
  102570. * @param samplers Array of the names of uniform sampler2D variables that will be passed to the shader.
  102571. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  102572. * @param camera The camera to apply the render pass to.
  102573. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  102574. * @param engine The engine which the post process will be applied. (default: current engine)
  102575. * @param reusable If the post process can be reused on the same frame. (default: false)
  102576. * @param defines String of defines that will be set when running the fragment shader. (default: null)
  102577. * @param textureType Type of textures used when performing the post process. (default: 0)
  102578. * @param vertexUrl The url of the vertex shader to be used. (default: "postprocess")
  102579. * @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
  102580. * @param blockCompilation If the shader should not be compiled imediatly. (default: false)
  102581. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  102582. */
  102583. 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);
  102584. /**
  102585. * Gets a string identifying the name of the class
  102586. * @returns "PostProcess" string
  102587. */
  102588. getClassName(): string;
  102589. /**
  102590. * Gets the engine which this post process belongs to.
  102591. * @returns The engine the post process was enabled with.
  102592. */
  102593. getEngine(): Engine;
  102594. /**
  102595. * The effect that is created when initializing the post process.
  102596. * @returns The created effect corresponding the the postprocess.
  102597. */
  102598. getEffect(): Effect;
  102599. /**
  102600. * To avoid multiple redundant textures for multiple post process, the output the output texture for this post process can be shared with another.
  102601. * @param postProcess The post process to share the output with.
  102602. * @returns This post process.
  102603. */
  102604. shareOutputWith(postProcess: PostProcess): PostProcess;
  102605. /**
  102606. * Reverses the effect of calling shareOutputWith and returns the post process back to its original state.
  102607. * This should be called if the post process that shares output with this post process is disabled/disposed.
  102608. */
  102609. useOwnOutput(): void;
  102610. /**
  102611. * Updates the effect with the current post process compile time values and recompiles the shader.
  102612. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  102613. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  102614. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  102615. * @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
  102616. * @param onCompiled Called when the shader has been compiled.
  102617. * @param onError Called if there is an error when compiling a shader.
  102618. * @param vertexUrl The url of the vertex shader to be used (default: the one given at construction time)
  102619. * @param fragmentUrl The url of the fragment shader to be used (default: the one given at construction time)
  102620. */
  102621. 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;
  102622. /**
  102623. * The post process is reusable if it can be used multiple times within one frame.
  102624. * @returns If the post process is reusable
  102625. */
  102626. isReusable(): boolean;
  102627. /** invalidate frameBuffer to hint the postprocess to create a depth buffer */
  102628. markTextureDirty(): void;
  102629. /**
  102630. * Activates the post process by intializing the textures to be used when executed. Notifies onActivateObservable.
  102631. * 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.
  102632. * @param camera The camera that will be used in the post process. This camera will be used when calling onActivateObservable.
  102633. * @param sourceTexture The source texture to be inspected to get the width and height if not specified in the post process constructor. (default: null)
  102634. * @param forceDepthStencil If true, a depth and stencil buffer will be generated. (default: false)
  102635. * @returns The target texture that was bound to be written to.
  102636. */
  102637. activate(camera: Nullable<Camera>, sourceTexture?: Nullable<InternalTexture>, forceDepthStencil?: boolean): InternalTexture;
  102638. /**
  102639. * If the post process is supported.
  102640. */
  102641. get isSupported(): boolean;
  102642. /**
  102643. * The aspect ratio of the output texture.
  102644. */
  102645. get aspectRatio(): number;
  102646. /**
  102647. * Get a value indicating if the post-process is ready to be used
  102648. * @returns true if the post-process is ready (shader is compiled)
  102649. */
  102650. isReady(): boolean;
  102651. /**
  102652. * Binds all textures and uniforms to the shader, this will be run on every pass.
  102653. * @returns the effect corresponding to this post process. Null if not compiled or not ready.
  102654. */
  102655. apply(): Nullable<Effect>;
  102656. private _disposeTextures;
  102657. /**
  102658. * Disposes the post process.
  102659. * @param camera The camera to dispose the post process on.
  102660. */
  102661. dispose(camera?: Camera): void;
  102662. /**
  102663. * Serializes the particle system to a JSON object
  102664. * @returns the JSON object
  102665. */
  102666. serialize(): any;
  102667. /**
  102668. * Creates a material from parsed material data
  102669. * @param parsedPostProcess defines parsed post process data
  102670. * @param scene defines the hosting scene
  102671. * @param rootUrl defines the root URL to use to load textures
  102672. * @returns a new post process
  102673. */
  102674. static Parse(parsedPostProcess: any, scene: Scene, rootUrl: string): Nullable<PostProcess>;
  102675. }
  102676. }
  102677. declare module BABYLON {
  102678. /** @hidden */
  102679. export var kernelBlurVaryingDeclaration: {
  102680. name: string;
  102681. shader: string;
  102682. };
  102683. }
  102684. declare module BABYLON {
  102685. /** @hidden */
  102686. export var kernelBlurFragment: {
  102687. name: string;
  102688. shader: string;
  102689. };
  102690. }
  102691. declare module BABYLON {
  102692. /** @hidden */
  102693. export var kernelBlurFragment2: {
  102694. name: string;
  102695. shader: string;
  102696. };
  102697. }
  102698. declare module BABYLON {
  102699. /** @hidden */
  102700. export var kernelBlurPixelShader: {
  102701. name: string;
  102702. shader: string;
  102703. };
  102704. }
  102705. declare module BABYLON {
  102706. /** @hidden */
  102707. export var kernelBlurVertex: {
  102708. name: string;
  102709. shader: string;
  102710. };
  102711. }
  102712. declare module BABYLON {
  102713. /** @hidden */
  102714. export var kernelBlurVertexShader: {
  102715. name: string;
  102716. shader: string;
  102717. };
  102718. }
  102719. declare module BABYLON {
  102720. /**
  102721. * The Blur Post Process which blurs an image based on a kernel and direction.
  102722. * Can be used twice in x and y directions to perform a guassian blur in two passes.
  102723. */
  102724. export class BlurPostProcess extends PostProcess {
  102725. private blockCompilation;
  102726. protected _kernel: number;
  102727. protected _idealKernel: number;
  102728. protected _packedFloat: boolean;
  102729. private _staticDefines;
  102730. /** The direction in which to blur the image. */
  102731. direction: Vector2;
  102732. /**
  102733. * Sets the length in pixels of the blur sample region
  102734. */
  102735. set kernel(v: number);
  102736. /**
  102737. * Gets the length in pixels of the blur sample region
  102738. */
  102739. get kernel(): number;
  102740. /**
  102741. * Sets wether or not the blur needs to unpack/repack floats
  102742. */
  102743. set packedFloat(v: boolean);
  102744. /**
  102745. * Gets wether or not the blur is unpacking/repacking floats
  102746. */
  102747. get packedFloat(): boolean;
  102748. /**
  102749. * Gets a string identifying the name of the class
  102750. * @returns "BlurPostProcess" string
  102751. */
  102752. getClassName(): string;
  102753. /**
  102754. * Creates a new instance BlurPostProcess
  102755. * @param name The name of the effect.
  102756. * @param direction The direction in which to blur the image.
  102757. * @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.
  102758. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  102759. * @param camera The camera to apply the render pass to.
  102760. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  102761. * @param engine The engine which the post process will be applied. (default: current engine)
  102762. * @param reusable If the post process can be reused on the same frame. (default: false)
  102763. * @param textureType Type of textures used when performing the post process. (default: 0)
  102764. * @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)
  102765. */
  102766. 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);
  102767. /**
  102768. * Updates the effect with the current post process compile time values and recompiles the shader.
  102769. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  102770. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  102771. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  102772. * @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
  102773. * @param onCompiled Called when the shader has been compiled.
  102774. * @param onError Called if there is an error when compiling a shader.
  102775. */
  102776. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  102777. protected _updateParameters(onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  102778. /**
  102779. * Best kernels are odd numbers that when divided by 2, their integer part is even, so 5, 9 or 13.
  102780. * Other odd kernels optimize correctly but require proportionally more samples, even kernels are
  102781. * possible but will produce minor visual artifacts. Since each new kernel requires a new shader we
  102782. * want to minimize kernel changes, having gaps between physical kernels is helpful in that regard.
  102783. * The gaps between physical kernels are compensated for in the weighting of the samples
  102784. * @param idealKernel Ideal blur kernel.
  102785. * @return Nearest best kernel.
  102786. */
  102787. protected _nearestBestKernel(idealKernel: number): number;
  102788. /**
  102789. * Calculates the value of a Gaussian distribution with sigma 3 at a given point.
  102790. * @param x The point on the Gaussian distribution to sample.
  102791. * @return the value of the Gaussian function at x.
  102792. */
  102793. protected _gaussianWeight(x: number): number;
  102794. /**
  102795. * Generates a string that can be used as a floating point number in GLSL.
  102796. * @param x Value to print.
  102797. * @param decimalFigures Number of decimal places to print the number to (excluding trailing 0s).
  102798. * @return GLSL float string.
  102799. */
  102800. protected _glslFloat(x: number, decimalFigures?: number): string;
  102801. /** @hidden */
  102802. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<BlurPostProcess>;
  102803. }
  102804. }
  102805. declare module BABYLON {
  102806. /**
  102807. * Mirror texture can be used to simulate the view from a mirror in a scene.
  102808. * It will dynamically be rendered every frame to adapt to the camera point of view.
  102809. * You can then easily use it as a reflectionTexture on a flat surface.
  102810. * In case the surface is not a plane, please consider relying on reflection probes.
  102811. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  102812. */
  102813. export class MirrorTexture extends RenderTargetTexture {
  102814. private scene;
  102815. /**
  102816. * Define the reflection plane we want to use. The mirrorPlane is usually set to the constructed reflector.
  102817. * 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.
  102818. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  102819. */
  102820. mirrorPlane: Plane;
  102821. /**
  102822. * Define the blur ratio used to blur the reflection if needed.
  102823. */
  102824. set blurRatio(value: number);
  102825. get blurRatio(): number;
  102826. /**
  102827. * Define the adaptive blur kernel used to blur the reflection if needed.
  102828. * This will autocompute the closest best match for the `blurKernel`
  102829. */
  102830. set adaptiveBlurKernel(value: number);
  102831. /**
  102832. * Define the blur kernel used to blur the reflection if needed.
  102833. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  102834. */
  102835. set blurKernel(value: number);
  102836. /**
  102837. * Define the blur kernel on the X Axis used to blur the reflection if needed.
  102838. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  102839. */
  102840. set blurKernelX(value: number);
  102841. get blurKernelX(): number;
  102842. /**
  102843. * Define the blur kernel on the Y Axis used to blur the reflection if needed.
  102844. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  102845. */
  102846. set blurKernelY(value: number);
  102847. get blurKernelY(): number;
  102848. private _autoComputeBlurKernel;
  102849. protected _onRatioRescale(): void;
  102850. private _updateGammaSpace;
  102851. private _imageProcessingConfigChangeObserver;
  102852. private _transformMatrix;
  102853. private _mirrorMatrix;
  102854. private _savedViewMatrix;
  102855. private _blurX;
  102856. private _blurY;
  102857. private _adaptiveBlurKernel;
  102858. private _blurKernelX;
  102859. private _blurKernelY;
  102860. private _blurRatio;
  102861. /**
  102862. * Instantiates a Mirror Texture.
  102863. * Mirror texture can be used to simulate the view from a mirror in a scene.
  102864. * It will dynamically be rendered every frame to adapt to the camera point of view.
  102865. * You can then easily use it as a reflectionTexture on a flat surface.
  102866. * In case the surface is not a plane, please consider relying on reflection probes.
  102867. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  102868. * @param name
  102869. * @param size
  102870. * @param scene
  102871. * @param generateMipMaps
  102872. * @param type
  102873. * @param samplingMode
  102874. * @param generateDepthBuffer
  102875. */
  102876. constructor(name: string, size: number | {
  102877. width: number;
  102878. height: number;
  102879. } | {
  102880. ratio: number;
  102881. }, scene: Scene, generateMipMaps?: boolean, type?: number, samplingMode?: number, generateDepthBuffer?: boolean);
  102882. private _preparePostProcesses;
  102883. /**
  102884. * Clone the mirror texture.
  102885. * @returns the cloned texture
  102886. */
  102887. clone(): MirrorTexture;
  102888. /**
  102889. * Serialize the texture to a JSON representation you could use in Parse later on
  102890. * @returns the serialized JSON representation
  102891. */
  102892. serialize(): any;
  102893. /**
  102894. * Dispose the texture and release its associated resources.
  102895. */
  102896. dispose(): void;
  102897. }
  102898. }
  102899. declare module BABYLON {
  102900. /**
  102901. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  102902. * @see https://doc.babylonjs.com/babylon101/materials#texture
  102903. */
  102904. export class Texture extends BaseTexture {
  102905. /**
  102906. * Gets or sets a general boolean used to indicate that textures containing direct data (buffers) must be saved as part of the serialization process
  102907. */
  102908. static SerializeBuffers: boolean;
  102909. /** @hidden */
  102910. static _CubeTextureParser: (jsonTexture: any, scene: Scene, rootUrl: string) => CubeTexture;
  102911. /** @hidden */
  102912. static _CreateMirror: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => MirrorTexture;
  102913. /** @hidden */
  102914. static _CreateRenderTargetTexture: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => RenderTargetTexture;
  102915. /** nearest is mag = nearest and min = nearest and mip = linear */
  102916. static readonly NEAREST_SAMPLINGMODE: number;
  102917. /** nearest is mag = nearest and min = nearest and mip = linear */
  102918. static readonly NEAREST_NEAREST_MIPLINEAR: number;
  102919. /** Bilinear is mag = linear and min = linear and mip = nearest */
  102920. static readonly BILINEAR_SAMPLINGMODE: number;
  102921. /** Bilinear is mag = linear and min = linear and mip = nearest */
  102922. static readonly LINEAR_LINEAR_MIPNEAREST: number;
  102923. /** Trilinear is mag = linear and min = linear and mip = linear */
  102924. static readonly TRILINEAR_SAMPLINGMODE: number;
  102925. /** Trilinear is mag = linear and min = linear and mip = linear */
  102926. static readonly LINEAR_LINEAR_MIPLINEAR: number;
  102927. /** mag = nearest and min = nearest and mip = nearest */
  102928. static readonly NEAREST_NEAREST_MIPNEAREST: number;
  102929. /** mag = nearest and min = linear and mip = nearest */
  102930. static readonly NEAREST_LINEAR_MIPNEAREST: number;
  102931. /** mag = nearest and min = linear and mip = linear */
  102932. static readonly NEAREST_LINEAR_MIPLINEAR: number;
  102933. /** mag = nearest and min = linear and mip = none */
  102934. static readonly NEAREST_LINEAR: number;
  102935. /** mag = nearest and min = nearest and mip = none */
  102936. static readonly NEAREST_NEAREST: number;
  102937. /** mag = linear and min = nearest and mip = nearest */
  102938. static readonly LINEAR_NEAREST_MIPNEAREST: number;
  102939. /** mag = linear and min = nearest and mip = linear */
  102940. static readonly LINEAR_NEAREST_MIPLINEAR: number;
  102941. /** mag = linear and min = linear and mip = none */
  102942. static readonly LINEAR_LINEAR: number;
  102943. /** mag = linear and min = nearest and mip = none */
  102944. static readonly LINEAR_NEAREST: number;
  102945. /** Explicit coordinates mode */
  102946. static readonly EXPLICIT_MODE: number;
  102947. /** Spherical coordinates mode */
  102948. static readonly SPHERICAL_MODE: number;
  102949. /** Planar coordinates mode */
  102950. static readonly PLANAR_MODE: number;
  102951. /** Cubic coordinates mode */
  102952. static readonly CUBIC_MODE: number;
  102953. /** Projection coordinates mode */
  102954. static readonly PROJECTION_MODE: number;
  102955. /** Inverse Cubic coordinates mode */
  102956. static readonly SKYBOX_MODE: number;
  102957. /** Inverse Cubic coordinates mode */
  102958. static readonly INVCUBIC_MODE: number;
  102959. /** Equirectangular coordinates mode */
  102960. static readonly EQUIRECTANGULAR_MODE: number;
  102961. /** Equirectangular Fixed coordinates mode */
  102962. static readonly FIXED_EQUIRECTANGULAR_MODE: number;
  102963. /** Equirectangular Fixed Mirrored coordinates mode */
  102964. static readonly FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  102965. /** Texture is not repeating outside of 0..1 UVs */
  102966. static readonly CLAMP_ADDRESSMODE: number;
  102967. /** Texture is repeating outside of 0..1 UVs */
  102968. static readonly WRAP_ADDRESSMODE: number;
  102969. /** Texture is repeating and mirrored */
  102970. static readonly MIRROR_ADDRESSMODE: number;
  102971. /**
  102972. * 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
  102973. */
  102974. static UseSerializedUrlIfAny: boolean;
  102975. /**
  102976. * Define the url of the texture.
  102977. */
  102978. url: Nullable<string>;
  102979. /**
  102980. * Define an offset on the texture to offset the u coordinates of the UVs
  102981. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  102982. */
  102983. uOffset: number;
  102984. /**
  102985. * Define an offset on the texture to offset the v coordinates of the UVs
  102986. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  102987. */
  102988. vOffset: number;
  102989. /**
  102990. * Define an offset on the texture to scale the u coordinates of the UVs
  102991. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  102992. */
  102993. uScale: number;
  102994. /**
  102995. * Define an offset on the texture to scale the v coordinates of the UVs
  102996. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  102997. */
  102998. vScale: number;
  102999. /**
  103000. * Define an offset on the texture to rotate around the u coordinates of the UVs
  103001. * @see https://doc.babylonjs.com/how_to/more_materials
  103002. */
  103003. uAng: number;
  103004. /**
  103005. * Define an offset on the texture to rotate around the v coordinates of the UVs
  103006. * @see https://doc.babylonjs.com/how_to/more_materials
  103007. */
  103008. vAng: number;
  103009. /**
  103010. * Define an offset on the texture to rotate around the w coordinates of the UVs (in case of 3d texture)
  103011. * @see https://doc.babylonjs.com/how_to/more_materials
  103012. */
  103013. wAng: number;
  103014. /**
  103015. * Defines the center of rotation (U)
  103016. */
  103017. uRotationCenter: number;
  103018. /**
  103019. * Defines the center of rotation (V)
  103020. */
  103021. vRotationCenter: number;
  103022. /**
  103023. * Defines the center of rotation (W)
  103024. */
  103025. wRotationCenter: number;
  103026. /**
  103027. * Are mip maps generated for this texture or not.
  103028. */
  103029. get noMipmap(): boolean;
  103030. /**
  103031. * List of inspectable custom properties (used by the Inspector)
  103032. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  103033. */
  103034. inspectableCustomProperties: Nullable<IInspectable[]>;
  103035. private _noMipmap;
  103036. /** @hidden */
  103037. _invertY: boolean;
  103038. private _rowGenerationMatrix;
  103039. private _cachedTextureMatrix;
  103040. private _projectionModeMatrix;
  103041. private _t0;
  103042. private _t1;
  103043. private _t2;
  103044. private _cachedUOffset;
  103045. private _cachedVOffset;
  103046. private _cachedUScale;
  103047. private _cachedVScale;
  103048. private _cachedUAng;
  103049. private _cachedVAng;
  103050. private _cachedWAng;
  103051. private _cachedProjectionMatrixId;
  103052. private _cachedCoordinatesMode;
  103053. /** @hidden */
  103054. protected _initialSamplingMode: number;
  103055. /** @hidden */
  103056. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  103057. private _deleteBuffer;
  103058. protected _format: Nullable<number>;
  103059. private _delayedOnLoad;
  103060. private _delayedOnError;
  103061. private _mimeType?;
  103062. /** Returns the texture mime type if it was defined by a loader (undefined else) */
  103063. get mimeType(): string | undefined;
  103064. /**
  103065. * Observable triggered once the texture has been loaded.
  103066. */
  103067. onLoadObservable: Observable<Texture>;
  103068. protected _isBlocking: boolean;
  103069. /**
  103070. * Is the texture preventing material to render while loading.
  103071. * If false, a default texture will be used instead of the loading one during the preparation step.
  103072. */
  103073. set isBlocking(value: boolean);
  103074. get isBlocking(): boolean;
  103075. /**
  103076. * Get the current sampling mode associated with the texture.
  103077. */
  103078. get samplingMode(): number;
  103079. /**
  103080. * Gets a boolean indicating if the texture needs to be inverted on the y axis during loading
  103081. */
  103082. get invertY(): boolean;
  103083. /**
  103084. * Instantiates a new texture.
  103085. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  103086. * @see https://doc.babylonjs.com/babylon101/materials#texture
  103087. * @param url defines the url of the picture to load as a texture
  103088. * @param sceneOrEngine defines the scene or engine the texture will belong to
  103089. * @param noMipmap defines if the texture will require mip maps or not
  103090. * @param invertY defines if the texture needs to be inverted on the y axis during loading
  103091. * @param samplingMode defines the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  103092. * @param onLoad defines a callback triggered when the texture has been loaded
  103093. * @param onError defines a callback triggered when an error occurred during the loading session
  103094. * @param buffer defines the buffer to load the texture from in case the texture is loaded from a buffer representation
  103095. * @param deleteBuffer defines if the buffer we are loading the texture from should be deleted after load
  103096. * @param format defines the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  103097. * @param mimeType defines an optional mime type information
  103098. */
  103099. 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);
  103100. /**
  103101. * Update the url (and optional buffer) of this texture if url was null during construction.
  103102. * @param url the url of the texture
  103103. * @param buffer the buffer of the texture (defaults to null)
  103104. * @param onLoad callback called when the texture is loaded (defaults to null)
  103105. */
  103106. updateURL(url: string, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob>, onLoad?: () => void): void;
  103107. /**
  103108. * Finish the loading sequence of a texture flagged as delayed load.
  103109. * @hidden
  103110. */
  103111. delayLoad(): void;
  103112. private _prepareRowForTextureGeneration;
  103113. /**
  103114. * Get the current texture matrix which includes the requested offsetting, tiling and rotation components.
  103115. * @returns the transform matrix of the texture.
  103116. */
  103117. getTextureMatrix(uBase?: number): Matrix;
  103118. /**
  103119. * Get the current matrix used to apply reflection. This is useful to rotate an environment texture for instance.
  103120. * @returns The reflection texture transform
  103121. */
  103122. getReflectionTextureMatrix(): Matrix;
  103123. /**
  103124. * Clones the texture.
  103125. * @returns the cloned texture
  103126. */
  103127. clone(): Texture;
  103128. /**
  103129. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  103130. * @returns The JSON representation of the texture
  103131. */
  103132. serialize(): any;
  103133. /**
  103134. * Get the current class name of the texture useful for serialization or dynamic coding.
  103135. * @returns "Texture"
  103136. */
  103137. getClassName(): string;
  103138. /**
  103139. * Dispose the texture and release its associated resources.
  103140. */
  103141. dispose(): void;
  103142. /**
  103143. * Parse the JSON representation of a texture in order to recreate the texture in the given scene.
  103144. * @param parsedTexture Define the JSON representation of the texture
  103145. * @param scene Define the scene the parsed texture should be instantiated in
  103146. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  103147. * @returns The parsed texture if successful
  103148. */
  103149. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<BaseTexture>;
  103150. /**
  103151. * Creates a texture from its base 64 representation.
  103152. * @param data Define the base64 payload without the data: prefix
  103153. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  103154. * @param scene Define the scene the texture should belong to
  103155. * @param noMipmap Forces the texture to not create mip map information if true
  103156. * @param invertY define if the texture needs to be inverted on the y axis during loading
  103157. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  103158. * @param onLoad define a callback triggered when the texture has been loaded
  103159. * @param onError define a callback triggered when an error occurred during the loading session
  103160. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  103161. * @returns the created texture
  103162. */
  103163. static CreateFromBase64String(data: string, name: string, scene: Scene, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<() => void>, format?: number): Texture;
  103164. /**
  103165. * Creates a texture from its data: representation. (data: will be added in case only the payload has been passed in)
  103166. * @param data Define the base64 payload without the data: prefix
  103167. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  103168. * @param buffer define the buffer to load the texture from in case the texture is loaded from a buffer representation
  103169. * @param scene Define the scene the texture should belong to
  103170. * @param deleteBuffer define if the buffer we are loading the texture from should be deleted after load
  103171. * @param noMipmap Forces the texture to not create mip map information if true
  103172. * @param invertY define if the texture needs to be inverted on the y axis during loading
  103173. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  103174. * @param onLoad define a callback triggered when the texture has been loaded
  103175. * @param onError define a callback triggered when an error occurred during the loading session
  103176. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  103177. * @returns the created texture
  103178. */
  103179. 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;
  103180. }
  103181. }
  103182. declare module BABYLON {
  103183. /**
  103184. * PostProcessManager is used to manage one or more post processes or post process pipelines
  103185. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  103186. */
  103187. export class PostProcessManager {
  103188. private _scene;
  103189. private _indexBuffer;
  103190. private _vertexBuffers;
  103191. /**
  103192. * Creates a new instance PostProcess
  103193. * @param scene The scene that the post process is associated with.
  103194. */
  103195. constructor(scene: Scene);
  103196. private _prepareBuffers;
  103197. private _buildIndexBuffer;
  103198. /**
  103199. * Rebuilds the vertex buffers of the manager.
  103200. * @hidden
  103201. */
  103202. _rebuild(): void;
  103203. /**
  103204. * Prepares a frame to be run through a post process.
  103205. * @param sourceTexture The input texture to the post procesess. (default: null)
  103206. * @param postProcesses An array of post processes to be run. (default: null)
  103207. * @returns True if the post processes were able to be run.
  103208. * @hidden
  103209. */
  103210. _prepareFrame(sourceTexture?: Nullable<InternalTexture>, postProcesses?: Nullable<PostProcess[]>): boolean;
  103211. /**
  103212. * Manually render a set of post processes to a texture.
  103213. * Please note, the frame buffer won't be unbound after the call in case you have more render to do.
  103214. * @param postProcesses An array of post processes to be run.
  103215. * @param targetTexture The target texture to render to.
  103216. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight
  103217. * @param faceIndex defines the face to render to if a cubemap is defined as the target
  103218. * @param lodLevel defines which lod of the texture to render to
  103219. * @param doNotBindFrambuffer If set to true, assumes that the framebuffer has been bound previously
  103220. */
  103221. directRender(postProcesses: PostProcess[], targetTexture?: Nullable<InternalTexture>, forceFullscreenViewport?: boolean, faceIndex?: number, lodLevel?: number, doNotBindFrambuffer?: boolean): void;
  103222. /**
  103223. * Finalize the result of the output of the postprocesses.
  103224. * @param doNotPresent If true the result will not be displayed to the screen.
  103225. * @param targetTexture The target texture to render to.
  103226. * @param faceIndex The index of the face to bind the target texture to.
  103227. * @param postProcesses The array of post processes to render.
  103228. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight (default: false)
  103229. * @hidden
  103230. */
  103231. _finalizeFrame(doNotPresent?: boolean, targetTexture?: InternalTexture, faceIndex?: number, postProcesses?: Array<PostProcess>, forceFullscreenViewport?: boolean): void;
  103232. /**
  103233. * Disposes of the post process manager.
  103234. */
  103235. dispose(): void;
  103236. }
  103237. }
  103238. declare module BABYLON {
  103239. /**
  103240. * This Helps creating a texture that will be created from a camera in your scene.
  103241. * It is basically a dynamic texture that could be used to create special effects for instance.
  103242. * Actually, It is the base of lot of effects in the framework like post process, shadows, effect layers and rendering pipelines...
  103243. */
  103244. export class RenderTargetTexture extends Texture {
  103245. /**
  103246. * The texture will only be rendered once which can be useful to improve performance if everything in your render is static for instance.
  103247. */
  103248. static readonly REFRESHRATE_RENDER_ONCE: number;
  103249. /**
  103250. * The texture will only be rendered rendered every frame and is recomended for dynamic contents.
  103251. */
  103252. static readonly REFRESHRATE_RENDER_ONEVERYFRAME: number;
  103253. /**
  103254. * The texture will be rendered every 2 frames which could be enough if your dynamic objects are not
  103255. * the central point of your effect and can save a lot of performances.
  103256. */
  103257. static readonly REFRESHRATE_RENDER_ONEVERYTWOFRAMES: number;
  103258. /**
  103259. * Use this predicate to dynamically define the list of mesh you want to render.
  103260. * If set, the renderList property will be overwritten.
  103261. */
  103262. renderListPredicate: (AbstractMesh: AbstractMesh) => boolean;
  103263. private _renderList;
  103264. /**
  103265. * Use this list to define the list of mesh you want to render.
  103266. */
  103267. get renderList(): Nullable<Array<AbstractMesh>>;
  103268. set renderList(value: Nullable<Array<AbstractMesh>>);
  103269. /**
  103270. * Use this function to overload the renderList array at rendering time.
  103271. * Return null to render with the curent renderList, else return the list of meshes to use for rendering.
  103272. * For 2DArray RTT, layerOrFace is the index of the layer that is going to be rendered, else it is the faceIndex of
  103273. * the cube (if the RTT is a cube, else layerOrFace=0).
  103274. * The renderList passed to the function is the current render list (the one that will be used if the function returns null).
  103275. * The length of this list is passed through renderListLength: don't use renderList.length directly because the array can
  103276. * hold dummy elements!
  103277. */
  103278. getCustomRenderList: (layerOrFace: number, renderList: Nullable<Immutable<Array<AbstractMesh>>>, renderListLength: number) => Nullable<Array<AbstractMesh>>;
  103279. private _hookArray;
  103280. /**
  103281. * Define if particles should be rendered in your texture.
  103282. */
  103283. renderParticles: boolean;
  103284. /**
  103285. * Define if sprites should be rendered in your texture.
  103286. */
  103287. renderSprites: boolean;
  103288. /**
  103289. * Define the camera used to render the texture.
  103290. */
  103291. activeCamera: Nullable<Camera>;
  103292. /**
  103293. * Override the mesh isReady function with your own one.
  103294. */
  103295. customIsReadyFunction: (mesh: AbstractMesh, refreshRate: number) => boolean;
  103296. /**
  103297. * Override the render function of the texture with your own one.
  103298. */
  103299. customRenderFunction: (opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>, beforeTransparents?: () => void) => void;
  103300. /**
  103301. * Define if camera post processes should be use while rendering the texture.
  103302. */
  103303. useCameraPostProcesses: boolean;
  103304. /**
  103305. * Define if the camera viewport should be respected while rendering the texture or if the render should be done to the entire texture.
  103306. */
  103307. ignoreCameraViewport: boolean;
  103308. private _postProcessManager;
  103309. private _postProcesses;
  103310. private _resizeObserver;
  103311. /**
  103312. * An event triggered when the texture is unbind.
  103313. */
  103314. onBeforeBindObservable: Observable<RenderTargetTexture>;
  103315. /**
  103316. * An event triggered when the texture is unbind.
  103317. */
  103318. onAfterUnbindObservable: Observable<RenderTargetTexture>;
  103319. private _onAfterUnbindObserver;
  103320. /**
  103321. * Set a after unbind callback in the texture.
  103322. * This has been kept for backward compatibility and use of onAfterUnbindObservable is recommended.
  103323. */
  103324. set onAfterUnbind(callback: () => void);
  103325. /**
  103326. * An event triggered before rendering the texture
  103327. */
  103328. onBeforeRenderObservable: Observable<number>;
  103329. private _onBeforeRenderObserver;
  103330. /**
  103331. * Set a before render callback in the texture.
  103332. * This has been kept for backward compatibility and use of onBeforeRenderObservable is recommended.
  103333. */
  103334. set onBeforeRender(callback: (faceIndex: number) => void);
  103335. /**
  103336. * An event triggered after rendering the texture
  103337. */
  103338. onAfterRenderObservable: Observable<number>;
  103339. private _onAfterRenderObserver;
  103340. /**
  103341. * Set a after render callback in the texture.
  103342. * This has been kept for backward compatibility and use of onAfterRenderObservable is recommended.
  103343. */
  103344. set onAfterRender(callback: (faceIndex: number) => void);
  103345. /**
  103346. * An event triggered after the texture clear
  103347. */
  103348. onClearObservable: Observable<Engine>;
  103349. private _onClearObserver;
  103350. /**
  103351. * Set a clear callback in the texture.
  103352. * This has been kept for backward compatibility and use of onClearObservable is recommended.
  103353. */
  103354. set onClear(callback: (Engine: Engine) => void);
  103355. /**
  103356. * An event triggered when the texture is resized.
  103357. */
  103358. onResizeObservable: Observable<RenderTargetTexture>;
  103359. /**
  103360. * Define the clear color of the Render Target if it should be different from the scene.
  103361. */
  103362. clearColor: Color4;
  103363. protected _size: number | {
  103364. width: number;
  103365. height: number;
  103366. layers?: number;
  103367. };
  103368. protected _initialSizeParameter: number | {
  103369. width: number;
  103370. height: number;
  103371. } | {
  103372. ratio: number;
  103373. };
  103374. protected _sizeRatio: Nullable<number>;
  103375. /** @hidden */
  103376. _generateMipMaps: boolean;
  103377. protected _renderingManager: RenderingManager;
  103378. /** @hidden */
  103379. _waitingRenderList?: string[];
  103380. protected _doNotChangeAspectRatio: boolean;
  103381. protected _currentRefreshId: number;
  103382. protected _refreshRate: number;
  103383. protected _textureMatrix: Matrix;
  103384. protected _samples: number;
  103385. protected _renderTargetOptions: RenderTargetCreationOptions;
  103386. /**
  103387. * Gets render target creation options that were used.
  103388. */
  103389. get renderTargetOptions(): RenderTargetCreationOptions;
  103390. protected _onRatioRescale(): void;
  103391. /**
  103392. * Gets or sets the center of the bounding box associated with the texture (when in cube mode)
  103393. * It must define where the camera used to render the texture is set
  103394. */
  103395. boundingBoxPosition: Vector3;
  103396. private _boundingBoxSize;
  103397. /**
  103398. * Gets or sets the size of the bounding box associated with the texture (when in cube mode)
  103399. * When defined, the cubemap will switch to local mode
  103400. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  103401. * @example https://www.babylonjs-playground.com/#RNASML
  103402. */
  103403. set boundingBoxSize(value: Vector3);
  103404. get boundingBoxSize(): Vector3;
  103405. /**
  103406. * In case the RTT has been created with a depth texture, get the associated
  103407. * depth texture.
  103408. * Otherwise, return null.
  103409. */
  103410. get depthStencilTexture(): Nullable<InternalTexture>;
  103411. /**
  103412. * Instantiate a render target texture. This is mainly used to render of screen the scene to for instance apply post processse
  103413. * or used a shadow, depth texture...
  103414. * @param name The friendly name of the texture
  103415. * @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)
  103416. * @param scene The scene the RTT belongs to. The latest created scene will be used if not precised.
  103417. * @param generateMipMaps True if mip maps need to be generated after render.
  103418. * @param doNotChangeAspectRatio True to not change the aspect ratio of the scene in the RTT
  103419. * @param type The type of the buffer in the RTT (int, half float, float...)
  103420. * @param isCube True if a cube texture needs to be created
  103421. * @param samplingMode The sampling mode to be usedwith the render target (Linear, Nearest...)
  103422. * @param generateDepthBuffer True to generate a depth buffer
  103423. * @param generateStencilBuffer True to generate a stencil buffer
  103424. * @param isMulti True if multiple textures need to be created (Draw Buffers)
  103425. * @param format The internal format of the buffer in the RTT (RED, RG, RGB, RGBA, ALPHA...)
  103426. * @param delayAllocation if the texture allocation should be delayed (default: false)
  103427. */
  103428. constructor(name: string, size: number | {
  103429. width: number;
  103430. height: number;
  103431. layers?: number;
  103432. } | {
  103433. ratio: number;
  103434. }, scene: Nullable<Scene>, generateMipMaps?: boolean, doNotChangeAspectRatio?: boolean, type?: number, isCube?: boolean, samplingMode?: number, generateDepthBuffer?: boolean, generateStencilBuffer?: boolean, isMulti?: boolean, format?: number, delayAllocation?: boolean);
  103435. /**
  103436. * Creates a depth stencil texture.
  103437. * This is only available in WebGL 2 or with the depth texture extension available.
  103438. * @param comparisonFunction Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode
  103439. * @param bilinearFiltering Specifies whether or not bilinear filtering is enable on the texture
  103440. * @param generateStencil Specifies whether or not a stencil should be allocated in the texture
  103441. */
  103442. createDepthStencilTexture(comparisonFunction?: number, bilinearFiltering?: boolean, generateStencil?: boolean): void;
  103443. private _processSizeParameter;
  103444. /**
  103445. * Define the number of samples to use in case of MSAA.
  103446. * It defaults to one meaning no MSAA has been enabled.
  103447. */
  103448. get samples(): number;
  103449. set samples(value: number);
  103450. /**
  103451. * Resets the refresh counter of the texture and start bak from scratch.
  103452. * Could be useful to regenerate the texture if it is setup to render only once.
  103453. */
  103454. resetRefreshCounter(): void;
  103455. /**
  103456. * Define the refresh rate of the texture or the rendering frequency.
  103457. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  103458. */
  103459. get refreshRate(): number;
  103460. set refreshRate(value: number);
  103461. /**
  103462. * Adds a post process to the render target rendering passes.
  103463. * @param postProcess define the post process to add
  103464. */
  103465. addPostProcess(postProcess: PostProcess): void;
  103466. /**
  103467. * Clear all the post processes attached to the render target
  103468. * @param dispose define if the cleared post processesshould also be disposed (false by default)
  103469. */
  103470. clearPostProcesses(dispose?: boolean): void;
  103471. /**
  103472. * Remove one of the post process from the list of attached post processes to the texture
  103473. * @param postProcess define the post process to remove from the list
  103474. */
  103475. removePostProcess(postProcess: PostProcess): void;
  103476. /** @hidden */
  103477. _shouldRender(): boolean;
  103478. /**
  103479. * Gets the actual render size of the texture.
  103480. * @returns the width of the render size
  103481. */
  103482. getRenderSize(): number;
  103483. /**
  103484. * Gets the actual render width of the texture.
  103485. * @returns the width of the render size
  103486. */
  103487. getRenderWidth(): number;
  103488. /**
  103489. * Gets the actual render height of the texture.
  103490. * @returns the height of the render size
  103491. */
  103492. getRenderHeight(): number;
  103493. /**
  103494. * Gets the actual number of layers of the texture.
  103495. * @returns the number of layers
  103496. */
  103497. getRenderLayers(): number;
  103498. /**
  103499. * Get if the texture can be rescaled or not.
  103500. */
  103501. get canRescale(): boolean;
  103502. /**
  103503. * Resize the texture using a ratio.
  103504. * @param ratio the ratio to apply to the texture size in order to compute the new target size
  103505. */
  103506. scale(ratio: number): void;
  103507. /**
  103508. * Get the texture reflection matrix used to rotate/transform the reflection.
  103509. * @returns the reflection matrix
  103510. */
  103511. getReflectionTextureMatrix(): Matrix;
  103512. /**
  103513. * Resize the texture to a new desired size.
  103514. * Be carrefull as it will recreate all the data in the new texture.
  103515. * @param size Define the new size. It can be:
  103516. * - a number for squared texture,
  103517. * - an object containing { width: number, height: number }
  103518. * - or an object containing a ratio { ratio: number }
  103519. */
  103520. resize(size: number | {
  103521. width: number;
  103522. height: number;
  103523. } | {
  103524. ratio: number;
  103525. }): void;
  103526. private _defaultRenderListPrepared;
  103527. /**
  103528. * Renders all the objects from the render list into the texture.
  103529. * @param useCameraPostProcess Define if camera post processes should be used during the rendering
  103530. * @param dumpForDebug Define if the rendering result should be dumped (copied) for debugging purpose
  103531. */
  103532. render(useCameraPostProcess?: boolean, dumpForDebug?: boolean): void;
  103533. private _bestReflectionRenderTargetDimension;
  103534. private _prepareRenderingManager;
  103535. /**
  103536. * @hidden
  103537. * @param faceIndex face index to bind to if this is a cubetexture
  103538. * @param layer defines the index of the texture to bind in the array
  103539. */
  103540. _bindFrameBuffer(faceIndex?: number, layer?: number): void;
  103541. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  103542. private renderToTarget;
  103543. /**
  103544. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  103545. * This allowed control for front to back rendering or reversly depending of the special needs.
  103546. *
  103547. * @param renderingGroupId The rendering group id corresponding to its index
  103548. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  103549. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  103550. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  103551. */
  103552. 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;
  103553. /**
  103554. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  103555. *
  103556. * @param renderingGroupId The rendering group id corresponding to its index
  103557. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  103558. */
  103559. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  103560. /**
  103561. * Clones the texture.
  103562. * @returns the cloned texture
  103563. */
  103564. clone(): RenderTargetTexture;
  103565. /**
  103566. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  103567. * @returns The JSON representation of the texture
  103568. */
  103569. serialize(): any;
  103570. /**
  103571. * This will remove the attached framebuffer objects. The texture will not be able to be used as render target anymore
  103572. */
  103573. disposeFramebufferObjects(): void;
  103574. /**
  103575. * Dispose the texture and release its associated resources.
  103576. */
  103577. dispose(): void;
  103578. /** @hidden */
  103579. _rebuild(): void;
  103580. /**
  103581. * Clear the info related to rendering groups preventing retention point in material dispose.
  103582. */
  103583. freeRenderingGroups(): void;
  103584. /**
  103585. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  103586. * @returns the view count
  103587. */
  103588. getViewCount(): number;
  103589. }
  103590. }
  103591. declare module BABYLON {
  103592. /**
  103593. * Class used to manipulate GUIDs
  103594. */
  103595. export class GUID {
  103596. /**
  103597. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  103598. * Be aware Math.random() could cause collisions, but:
  103599. * "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"
  103600. * @returns a pseudo random id
  103601. */
  103602. static RandomId(): string;
  103603. }
  103604. }
  103605. declare module BABYLON {
  103606. /**
  103607. * Options to be used when creating a shadow depth material
  103608. */
  103609. export interface IIOptionShadowDepthMaterial {
  103610. /** Variables in the vertex shader code that need to have their names remapped.
  103611. * The format is: ["var_name", "var_remapped_name", "var_name", "var_remapped_name", ...]
  103612. * "var_name" should be either: worldPos or vNormalW
  103613. * So, if the variable holding the world position in your vertex shader is not named worldPos, you must tell the system
  103614. * the name to use instead by using: ["worldPos", "myWorldPosVar"] assuming the variable is named myWorldPosVar in your code.
  103615. * If the normal must also be remapped: ["worldPos", "myWorldPosVar", "vNormalW", "myWorldNormal"]
  103616. */
  103617. remappedVariables?: string[];
  103618. /** Set standalone to true if the base material wrapped by ShadowDepthMaterial is not used for a regular object but for depth shadow generation only */
  103619. standalone?: boolean;
  103620. }
  103621. /**
  103622. * Class that can be used to wrap a base material to generate accurate shadows when using custom vertex/fragment code in the base material
  103623. */
  103624. export class ShadowDepthWrapper {
  103625. private _scene;
  103626. private _options?;
  103627. private _baseMaterial;
  103628. private _onEffectCreatedObserver;
  103629. private _subMeshToEffect;
  103630. private _subMeshToDepthEffect;
  103631. private _meshes;
  103632. /** @hidden */
  103633. _matriceNames: any;
  103634. /** Gets the standalone status of the wrapper */
  103635. get standalone(): boolean;
  103636. /** Gets the base material the wrapper is built upon */
  103637. get baseMaterial(): Material;
  103638. /**
  103639. * Instantiate a new shadow depth wrapper.
  103640. * It works by injecting some specific code in the vertex/fragment shaders of the base material and is used by a shadow generator to
  103641. * generate the shadow depth map. For more information, please refer to the documentation:
  103642. * https://doc.babylonjs.com/babylon101/shadows
  103643. * @param baseMaterial Material to wrap
  103644. * @param scene Define the scene the material belongs to
  103645. * @param options Options used to create the wrapper
  103646. */
  103647. constructor(baseMaterial: Material, scene: Scene, options?: IIOptionShadowDepthMaterial);
  103648. /**
  103649. * Gets the effect to use to generate the depth map
  103650. * @param subMesh subMesh to get the effect for
  103651. * @param shadowGenerator shadow generator to get the effect for
  103652. * @returns the effect to use to generate the depth map for the subMesh + shadow generator specified
  103653. */
  103654. getEffect(subMesh: Nullable<SubMesh>, shadowGenerator: ShadowGenerator): Nullable<Effect>;
  103655. /**
  103656. * Specifies that the submesh is ready to be used for depth rendering
  103657. * @param subMesh submesh to check
  103658. * @param defines the list of defines to take into account when checking the effect
  103659. * @param shadowGenerator combined with subMesh, it defines the effect to check
  103660. * @param useInstances specifies that instances should be used
  103661. * @returns a boolean indicating that the submesh is ready or not
  103662. */
  103663. isReadyForSubMesh(subMesh: SubMesh, defines: string[], shadowGenerator: ShadowGenerator, useInstances: boolean): boolean;
  103664. /**
  103665. * Disposes the resources
  103666. */
  103667. dispose(): void;
  103668. private _makeEffect;
  103669. }
  103670. }
  103671. declare module BABYLON {
  103672. interface ThinEngine {
  103673. /**
  103674. * Unbind a list of render target textures from the webGL context
  103675. * This is used only when drawBuffer extension or webGL2 are active
  103676. * @param textures defines the render target textures to unbind
  103677. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  103678. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  103679. */
  103680. unBindMultiColorAttachmentFramebuffer(textures: InternalTexture[], disableGenerateMipMaps: boolean, onBeforeUnbind?: () => void): void;
  103681. /**
  103682. * Create a multi render target texture
  103683. * @see https://doc.babylonjs.com/features/webgl2#multiple-render-target
  103684. * @param size defines the size of the texture
  103685. * @param options defines the creation options
  103686. * @returns the cube texture as an InternalTexture
  103687. */
  103688. createMultipleRenderTarget(size: any, options: IMultiRenderTargetOptions): InternalTexture[];
  103689. /**
  103690. * Update the sample count for a given multiple render target texture
  103691. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  103692. * @param textures defines the textures to update
  103693. * @param samples defines the sample count to set
  103694. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  103695. */
  103696. updateMultipleRenderTargetTextureSampleCount(textures: Nullable<InternalTexture[]>, samples: number): number;
  103697. /**
  103698. * Select a subsets of attachments to draw to.
  103699. * @param attachments gl attachments
  103700. */
  103701. bindAttachments(attachments: number[]): void;
  103702. }
  103703. }
  103704. declare module BABYLON {
  103705. /**
  103706. * Creation options of the multi render target texture.
  103707. */
  103708. export interface IMultiRenderTargetOptions {
  103709. /**
  103710. * Define if the texture needs to create mip maps after render.
  103711. */
  103712. generateMipMaps?: boolean;
  103713. /**
  103714. * Define the types of all the draw buffers we want to create
  103715. */
  103716. types?: number[];
  103717. /**
  103718. * Define the sampling modes of all the draw buffers we want to create
  103719. */
  103720. samplingModes?: number[];
  103721. /**
  103722. * Define if a depth buffer is required
  103723. */
  103724. generateDepthBuffer?: boolean;
  103725. /**
  103726. * Define if a stencil buffer is required
  103727. */
  103728. generateStencilBuffer?: boolean;
  103729. /**
  103730. * Define if a depth texture is required instead of a depth buffer
  103731. */
  103732. generateDepthTexture?: boolean;
  103733. /**
  103734. * Define the number of desired draw buffers
  103735. */
  103736. textureCount?: number;
  103737. /**
  103738. * Define if aspect ratio should be adapted to the texture or stay the scene one
  103739. */
  103740. doNotChangeAspectRatio?: boolean;
  103741. /**
  103742. * Define the default type of the buffers we are creating
  103743. */
  103744. defaultType?: number;
  103745. }
  103746. /**
  103747. * A multi render target, like a render target provides the ability to render to a texture.
  103748. * Unlike the render target, it can render to several draw buffers in one draw.
  103749. * This is specially interesting in deferred rendering or for any effects requiring more than
  103750. * just one color from a single pass.
  103751. */
  103752. export class MultiRenderTarget extends RenderTargetTexture {
  103753. private _internalTextures;
  103754. private _textures;
  103755. private _multiRenderTargetOptions;
  103756. private _count;
  103757. /**
  103758. * Get if draw buffers are currently supported by the used hardware and browser.
  103759. */
  103760. get isSupported(): boolean;
  103761. /**
  103762. * Get the list of textures generated by the multi render target.
  103763. */
  103764. get textures(): Texture[];
  103765. /**
  103766. * Gets the number of textures in this MRT. This number can be different from `_textures.length` in case a depth texture is generated.
  103767. */
  103768. get count(): number;
  103769. /**
  103770. * Get the depth texture generated by the multi render target if options.generateDepthTexture has been set
  103771. */
  103772. get depthTexture(): Texture;
  103773. /**
  103774. * Set the wrapping mode on U of all the textures we are rendering to.
  103775. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  103776. */
  103777. set wrapU(wrap: number);
  103778. /**
  103779. * Set the wrapping mode on V of all the textures we are rendering to.
  103780. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  103781. */
  103782. set wrapV(wrap: number);
  103783. /**
  103784. * Instantiate a new multi render target texture.
  103785. * A multi render target, like a render target provides the ability to render to a texture.
  103786. * Unlike the render target, it can render to several draw buffers in one draw.
  103787. * This is specially interesting in deferred rendering or for any effects requiring more than
  103788. * just one color from a single pass.
  103789. * @param name Define the name of the texture
  103790. * @param size Define the size of the buffers to render to
  103791. * @param count Define the number of target we are rendering into
  103792. * @param scene Define the scene the texture belongs to
  103793. * @param options Define the options used to create the multi render target
  103794. */
  103795. constructor(name: string, size: any, count: number, scene: Scene, options?: IMultiRenderTargetOptions);
  103796. /** @hidden */
  103797. _rebuild(): void;
  103798. private _createInternalTextures;
  103799. private _createTextures;
  103800. /**
  103801. * Define the number of samples used if MSAA is enabled.
  103802. */
  103803. get samples(): number;
  103804. set samples(value: number);
  103805. /**
  103806. * Resize all the textures in the multi render target.
  103807. * Be carrefull as it will recreate all the data in the new texture.
  103808. * @param size Define the new size
  103809. */
  103810. resize(size: any): void;
  103811. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  103812. /**
  103813. * Dispose the render targets and their associated resources
  103814. */
  103815. dispose(): void;
  103816. /**
  103817. * Release all the underlying texture used as draw buffers.
  103818. */
  103819. releaseInternalTextures(): void;
  103820. }
  103821. }
  103822. declare module BABYLON {
  103823. /** @hidden */
  103824. export var imageProcessingPixelShader: {
  103825. name: string;
  103826. shader: string;
  103827. };
  103828. }
  103829. declare module BABYLON {
  103830. /**
  103831. * ImageProcessingPostProcess
  103832. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#imageprocessing
  103833. */
  103834. export class ImageProcessingPostProcess extends PostProcess {
  103835. /**
  103836. * Default configuration related to image processing available in the PBR Material.
  103837. */
  103838. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  103839. /**
  103840. * Gets the image processing configuration used either in this material.
  103841. */
  103842. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  103843. /**
  103844. * Sets the Default image processing configuration used either in the this material.
  103845. *
  103846. * If sets to null, the scene one is in use.
  103847. */
  103848. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  103849. /**
  103850. * Keep track of the image processing observer to allow dispose and replace.
  103851. */
  103852. private _imageProcessingObserver;
  103853. /**
  103854. * Attaches a new image processing configuration to the PBR Material.
  103855. * @param configuration
  103856. */
  103857. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>, doNotBuild?: boolean): void;
  103858. /**
  103859. * If the post process is supported.
  103860. */
  103861. get isSupported(): boolean;
  103862. /**
  103863. * Gets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  103864. */
  103865. get colorCurves(): Nullable<ColorCurves>;
  103866. /**
  103867. * Sets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  103868. */
  103869. set colorCurves(value: Nullable<ColorCurves>);
  103870. /**
  103871. * Gets wether the color curves effect is enabled.
  103872. */
  103873. get colorCurvesEnabled(): boolean;
  103874. /**
  103875. * Sets wether the color curves effect is enabled.
  103876. */
  103877. set colorCurvesEnabled(value: boolean);
  103878. /**
  103879. * Gets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  103880. */
  103881. get colorGradingTexture(): Nullable<BaseTexture>;
  103882. /**
  103883. * Sets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  103884. */
  103885. set colorGradingTexture(value: Nullable<BaseTexture>);
  103886. /**
  103887. * Gets wether the color grading effect is enabled.
  103888. */
  103889. get colorGradingEnabled(): boolean;
  103890. /**
  103891. * Gets wether the color grading effect is enabled.
  103892. */
  103893. set colorGradingEnabled(value: boolean);
  103894. /**
  103895. * Gets exposure used in the effect.
  103896. */
  103897. get exposure(): number;
  103898. /**
  103899. * Sets exposure used in the effect.
  103900. */
  103901. set exposure(value: number);
  103902. /**
  103903. * Gets wether tonemapping is enabled or not.
  103904. */
  103905. get toneMappingEnabled(): boolean;
  103906. /**
  103907. * Sets wether tonemapping is enabled or not
  103908. */
  103909. set toneMappingEnabled(value: boolean);
  103910. /**
  103911. * Gets the type of tone mapping effect.
  103912. */
  103913. get toneMappingType(): number;
  103914. /**
  103915. * Sets the type of tone mapping effect.
  103916. */
  103917. set toneMappingType(value: number);
  103918. /**
  103919. * Gets contrast used in the effect.
  103920. */
  103921. get contrast(): number;
  103922. /**
  103923. * Sets contrast used in the effect.
  103924. */
  103925. set contrast(value: number);
  103926. /**
  103927. * Gets Vignette stretch size.
  103928. */
  103929. get vignetteStretch(): number;
  103930. /**
  103931. * Sets Vignette stretch size.
  103932. */
  103933. set vignetteStretch(value: number);
  103934. /**
  103935. * Gets Vignette centre X Offset.
  103936. */
  103937. get vignetteCentreX(): number;
  103938. /**
  103939. * Sets Vignette centre X Offset.
  103940. */
  103941. set vignetteCentreX(value: number);
  103942. /**
  103943. * Gets Vignette centre Y Offset.
  103944. */
  103945. get vignetteCentreY(): number;
  103946. /**
  103947. * Sets Vignette centre Y Offset.
  103948. */
  103949. set vignetteCentreY(value: number);
  103950. /**
  103951. * Gets Vignette weight or intensity of the vignette effect.
  103952. */
  103953. get vignetteWeight(): number;
  103954. /**
  103955. * Sets Vignette weight or intensity of the vignette effect.
  103956. */
  103957. set vignetteWeight(value: number);
  103958. /**
  103959. * Gets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  103960. * if vignetteEnabled is set to true.
  103961. */
  103962. get vignetteColor(): Color4;
  103963. /**
  103964. * Sets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  103965. * if vignetteEnabled is set to true.
  103966. */
  103967. set vignetteColor(value: Color4);
  103968. /**
  103969. * Gets Camera field of view used by the Vignette effect.
  103970. */
  103971. get vignetteCameraFov(): number;
  103972. /**
  103973. * Sets Camera field of view used by the Vignette effect.
  103974. */
  103975. set vignetteCameraFov(value: number);
  103976. /**
  103977. * Gets the vignette blend mode allowing different kind of effect.
  103978. */
  103979. get vignetteBlendMode(): number;
  103980. /**
  103981. * Sets the vignette blend mode allowing different kind of effect.
  103982. */
  103983. set vignetteBlendMode(value: number);
  103984. /**
  103985. * Gets wether the vignette effect is enabled.
  103986. */
  103987. get vignetteEnabled(): boolean;
  103988. /**
  103989. * Sets wether the vignette effect is enabled.
  103990. */
  103991. set vignetteEnabled(value: boolean);
  103992. private _fromLinearSpace;
  103993. /**
  103994. * Gets wether the input of the processing is in Gamma or Linear Space.
  103995. */
  103996. get fromLinearSpace(): boolean;
  103997. /**
  103998. * Sets wether the input of the processing is in Gamma or Linear Space.
  103999. */
  104000. set fromLinearSpace(value: boolean);
  104001. /**
  104002. * Defines cache preventing GC.
  104003. */
  104004. private _defines;
  104005. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, imageProcessingConfiguration?: ImageProcessingConfiguration);
  104006. /**
  104007. * "ImageProcessingPostProcess"
  104008. * @returns "ImageProcessingPostProcess"
  104009. */
  104010. getClassName(): string;
  104011. /**
  104012. * @hidden
  104013. */
  104014. _updateParameters(): void;
  104015. dispose(camera?: Camera): void;
  104016. }
  104017. }
  104018. declare module BABYLON {
  104019. /** @hidden */
  104020. export var fibonacci: {
  104021. name: string;
  104022. shader: string;
  104023. };
  104024. }
  104025. declare module BABYLON {
  104026. /** @hidden */
  104027. export var subSurfaceScatteringFunctions: {
  104028. name: string;
  104029. shader: string;
  104030. };
  104031. }
  104032. declare module BABYLON {
  104033. /** @hidden */
  104034. export var diffusionProfile: {
  104035. name: string;
  104036. shader: string;
  104037. };
  104038. }
  104039. declare module BABYLON {
  104040. /** @hidden */
  104041. export var subSurfaceScatteringPixelShader: {
  104042. name: string;
  104043. shader: string;
  104044. };
  104045. }
  104046. declare module BABYLON {
  104047. /**
  104048. * Sub surface scattering post process
  104049. */
  104050. export class SubSurfaceScatteringPostProcess extends PostProcess {
  104051. /**
  104052. * Gets a string identifying the name of the class
  104053. * @returns "SubSurfaceScatteringPostProcess" string
  104054. */
  104055. getClassName(): string;
  104056. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  104057. }
  104058. }
  104059. declare module BABYLON {
  104060. /**
  104061. * Interface for defining prepass effects in the prepass post-process pipeline
  104062. */
  104063. export interface PrePassEffectConfiguration {
  104064. /**
  104065. * Post process to attach for this effect
  104066. */
  104067. postProcess: PostProcess;
  104068. /**
  104069. * Is the effect enabled
  104070. */
  104071. enabled: boolean;
  104072. /**
  104073. * Disposes the effect configuration
  104074. */
  104075. dispose(): void;
  104076. /**
  104077. * Disposes the effect configuration
  104078. */
  104079. createPostProcess: () => PostProcess;
  104080. }
  104081. }
  104082. declare module BABYLON {
  104083. /**
  104084. * Contains all parameters needed for the prepass to perform
  104085. * screen space subsurface scattering
  104086. */
  104087. export class SubSurfaceConfiguration implements PrePassEffectConfiguration {
  104088. private _ssDiffusionS;
  104089. private _ssFilterRadii;
  104090. private _ssDiffusionD;
  104091. /**
  104092. * Post process to attach for screen space subsurface scattering
  104093. */
  104094. postProcess: SubSurfaceScatteringPostProcess;
  104095. /**
  104096. * Diffusion profile color for subsurface scattering
  104097. */
  104098. get ssDiffusionS(): number[];
  104099. /**
  104100. * Diffusion profile max color channel value for subsurface scattering
  104101. */
  104102. get ssDiffusionD(): number[];
  104103. /**
  104104. * Diffusion profile filter radius for subsurface scattering
  104105. */
  104106. get ssFilterRadii(): number[];
  104107. /**
  104108. * Is subsurface enabled
  104109. */
  104110. enabled: boolean;
  104111. /**
  104112. * Diffusion profile colors for subsurface scattering
  104113. * You can add one diffusion color using `addDiffusionProfile` on `scene.prePassRenderer`
  104114. * See ...
  104115. * Note that you can only store up to 5 of them
  104116. */
  104117. ssDiffusionProfileColors: Color3[];
  104118. /**
  104119. * Defines the ratio real world => scene units.
  104120. * Used for subsurface scattering
  104121. */
  104122. metersPerUnit: number;
  104123. private _scene;
  104124. /**
  104125. * Builds a subsurface configuration object
  104126. * @param scene The scene
  104127. */
  104128. constructor(scene: Scene);
  104129. /**
  104130. * Adds a new diffusion profile.
  104131. * Useful for more realistic subsurface scattering on diverse materials.
  104132. * @param color The color of the diffusion profile. Should be the average color of the material.
  104133. * @return The index of the diffusion profile for the material subsurface configuration
  104134. */
  104135. addDiffusionProfile(color: Color3): number;
  104136. /**
  104137. * Creates the sss post process
  104138. * @return The created post process
  104139. */
  104140. createPostProcess(): SubSurfaceScatteringPostProcess;
  104141. /**
  104142. * Deletes all diffusion profiles.
  104143. * Note that in order to render subsurface scattering, you should have at least 1 diffusion profile.
  104144. */
  104145. clearAllDiffusionProfiles(): void;
  104146. /**
  104147. * Disposes this object
  104148. */
  104149. dispose(): void;
  104150. /**
  104151. * @hidden
  104152. * https://zero-radiance.github.io/post/sampling-diffusion/
  104153. *
  104154. * Importance sample the normalized diffuse reflectance profile for the computed value of 's'.
  104155. * ------------------------------------------------------------------------------------
  104156. * R[r, phi, s] = s * (Exp[-r * s] + Exp[-r * s / 3]) / (8 * Pi * r)
  104157. * PDF[r, phi, s] = r * R[r, phi, s]
  104158. * CDF[r, s] = 1 - 1/4 * Exp[-r * s] - 3/4 * Exp[-r * s / 3]
  104159. * ------------------------------------------------------------------------------------
  104160. * We importance sample the color channel with the widest scattering distance.
  104161. */
  104162. getDiffusionProfileParameters(color: Color3): number;
  104163. /**
  104164. * Performs sampling of a Normalized Burley diffusion profile in polar coordinates.
  104165. * 'u' is the random number (the value of the CDF): [0, 1).
  104166. * rcp(s) = 1 / ShapeParam = ScatteringDistance.
  104167. * Returns the sampled radial distance, s.t. (u = 0 -> r = 0) and (u = 1 -> r = Inf).
  104168. */
  104169. private _sampleBurleyDiffusionProfile;
  104170. }
  104171. }
  104172. declare module BABYLON {
  104173. /**
  104174. * Renders a pre pass of the scene
  104175. * This means every mesh in the scene will be rendered to a render target texture
  104176. * And then this texture will be composited to the rendering canvas with post processes
  104177. * It is necessary for effects like subsurface scattering or deferred shading
  104178. */
  104179. export class PrePassRenderer {
  104180. /** @hidden */
  104181. static _SceneComponentInitialization: (scene: Scene) => void;
  104182. private _scene;
  104183. private _engine;
  104184. private _isDirty;
  104185. /**
  104186. * Number of textures in the multi render target texture where the scene is directly rendered
  104187. */
  104188. readonly mrtCount: number;
  104189. /**
  104190. * The render target where the scene is directly rendered
  104191. */
  104192. prePassRT: MultiRenderTarget;
  104193. private _mrtTypes;
  104194. private _multiRenderAttachments;
  104195. private _defaultAttachments;
  104196. private _clearAttachments;
  104197. private _postProcesses;
  104198. private readonly _clearColor;
  104199. /**
  104200. * Image processing post process for composition
  104201. */
  104202. imageProcessingPostProcess: ImageProcessingPostProcess;
  104203. /**
  104204. * Configuration for sub surface scattering post process
  104205. */
  104206. subSurfaceConfiguration: SubSurfaceConfiguration;
  104207. /**
  104208. * Should materials render their geometry on the MRT
  104209. */
  104210. materialsShouldRenderGeometry: boolean;
  104211. /**
  104212. * Should materials render the irradiance information on the MRT
  104213. */
  104214. materialsShouldRenderIrradiance: boolean;
  104215. private _enabled;
  104216. /**
  104217. * Indicates if the prepass is enabled
  104218. */
  104219. get enabled(): boolean;
  104220. /**
  104221. * How many samples are used for MSAA of the scene render target
  104222. */
  104223. get samples(): number;
  104224. set samples(n: number);
  104225. /**
  104226. * Instanciates a prepass renderer
  104227. * @param scene The scene
  104228. */
  104229. constructor(scene: Scene);
  104230. private _initializeAttachments;
  104231. private _createCompositionEffect;
  104232. /**
  104233. * Indicates if rendering a prepass is supported
  104234. */
  104235. get isSupported(): boolean;
  104236. /**
  104237. * Sets the proper output textures to draw in the engine.
  104238. * @param effect The effect that is drawn. It can be or not be compatible with drawing to several output textures.
  104239. */
  104240. bindAttachmentsForEffect(effect: Effect): void;
  104241. /**
  104242. * @hidden
  104243. */
  104244. _beforeCameraDraw(): void;
  104245. /**
  104246. * @hidden
  104247. */
  104248. _afterCameraDraw(): void;
  104249. private _checkRTSize;
  104250. private _bindFrameBuffer;
  104251. /**
  104252. * Clears the scene render target (in the sense of settings pixels to the scene clear color value)
  104253. */
  104254. clear(): void;
  104255. private _setState;
  104256. private _enable;
  104257. private _disable;
  104258. private _resetPostProcessChain;
  104259. private _bindPostProcessChain;
  104260. /**
  104261. * Marks the prepass renderer as dirty, triggering a check if the prepass is necessary for the next rendering.
  104262. */
  104263. markAsDirty(): void;
  104264. private _update;
  104265. /**
  104266. * Disposes the prepass renderer.
  104267. */
  104268. dispose(): void;
  104269. }
  104270. }
  104271. declare module BABYLON {
  104272. /**
  104273. * Options for compiling materials.
  104274. */
  104275. export interface IMaterialCompilationOptions {
  104276. /**
  104277. * Defines whether clip planes are enabled.
  104278. */
  104279. clipPlane: boolean;
  104280. /**
  104281. * Defines whether instances are enabled.
  104282. */
  104283. useInstances: boolean;
  104284. }
  104285. /**
  104286. * Options passed when calling customShaderNameResolve
  104287. */
  104288. export interface ICustomShaderNameResolveOptions {
  104289. /**
  104290. * 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
  104291. */
  104292. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  104293. }
  104294. /**
  104295. * Base class for the main features of a material in Babylon.js
  104296. */
  104297. export class Material implements IAnimatable {
  104298. /**
  104299. * Returns the triangle fill mode
  104300. */
  104301. static readonly TriangleFillMode: number;
  104302. /**
  104303. * Returns the wireframe mode
  104304. */
  104305. static readonly WireFrameFillMode: number;
  104306. /**
  104307. * Returns the point fill mode
  104308. */
  104309. static readonly PointFillMode: number;
  104310. /**
  104311. * Returns the point list draw mode
  104312. */
  104313. static readonly PointListDrawMode: number;
  104314. /**
  104315. * Returns the line list draw mode
  104316. */
  104317. static readonly LineListDrawMode: number;
  104318. /**
  104319. * Returns the line loop draw mode
  104320. */
  104321. static readonly LineLoopDrawMode: number;
  104322. /**
  104323. * Returns the line strip draw mode
  104324. */
  104325. static readonly LineStripDrawMode: number;
  104326. /**
  104327. * Returns the triangle strip draw mode
  104328. */
  104329. static readonly TriangleStripDrawMode: number;
  104330. /**
  104331. * Returns the triangle fan draw mode
  104332. */
  104333. static readonly TriangleFanDrawMode: number;
  104334. /**
  104335. * Stores the clock-wise side orientation
  104336. */
  104337. static readonly ClockWiseSideOrientation: number;
  104338. /**
  104339. * Stores the counter clock-wise side orientation
  104340. */
  104341. static readonly CounterClockWiseSideOrientation: number;
  104342. /**
  104343. * The dirty texture flag value
  104344. */
  104345. static readonly TextureDirtyFlag: number;
  104346. /**
  104347. * The dirty light flag value
  104348. */
  104349. static readonly LightDirtyFlag: number;
  104350. /**
  104351. * The dirty fresnel flag value
  104352. */
  104353. static readonly FresnelDirtyFlag: number;
  104354. /**
  104355. * The dirty attribute flag value
  104356. */
  104357. static readonly AttributesDirtyFlag: number;
  104358. /**
  104359. * The dirty misc flag value
  104360. */
  104361. static readonly MiscDirtyFlag: number;
  104362. /**
  104363. * The all dirty flag value
  104364. */
  104365. static readonly AllDirtyFlag: number;
  104366. /**
  104367. * MaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  104368. */
  104369. static readonly MATERIAL_OPAQUE: number;
  104370. /**
  104371. * MaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  104372. */
  104373. static readonly MATERIAL_ALPHATEST: number;
  104374. /**
  104375. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  104376. */
  104377. static readonly MATERIAL_ALPHABLEND: number;
  104378. /**
  104379. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  104380. * They are also discarded below the alpha cutoff threshold to improve performances.
  104381. */
  104382. static readonly MATERIAL_ALPHATESTANDBLEND: number;
  104383. /**
  104384. * The Whiteout method is used to blend normals.
  104385. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  104386. */
  104387. static readonly MATERIAL_NORMALBLENDMETHOD_WHITEOUT: number;
  104388. /**
  104389. * The Reoriented Normal Mapping method is used to blend normals.
  104390. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  104391. */
  104392. static readonly MATERIAL_NORMALBLENDMETHOD_RNM: number;
  104393. /**
  104394. * Custom callback helping to override the default shader used in the material.
  104395. */
  104396. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: MaterialDefines | string[], attributes?: string[], options?: ICustomShaderNameResolveOptions) => string;
  104397. /**
  104398. * Custom shadow depth material to use for shadow rendering instead of the in-built one
  104399. */
  104400. shadowDepthWrapper: Nullable<ShadowDepthWrapper>;
  104401. /**
  104402. * Gets or sets a boolean indicating that the material is allowed (if supported) to do shader hot swapping.
  104403. * This means that the material can keep using a previous shader while a new one is being compiled.
  104404. * This is mostly used when shader parallel compilation is supported (true by default)
  104405. */
  104406. allowShaderHotSwapping: boolean;
  104407. /**
  104408. * The ID of the material
  104409. */
  104410. id: string;
  104411. /**
  104412. * Gets or sets the unique id of the material
  104413. */
  104414. uniqueId: number;
  104415. /**
  104416. * The name of the material
  104417. */
  104418. name: string;
  104419. /**
  104420. * Gets or sets user defined metadata
  104421. */
  104422. metadata: any;
  104423. /**
  104424. * For internal use only. Please do not use.
  104425. */
  104426. reservedDataStore: any;
  104427. /**
  104428. * Specifies if the ready state should be checked on each call
  104429. */
  104430. checkReadyOnEveryCall: boolean;
  104431. /**
  104432. * Specifies if the ready state should be checked once
  104433. */
  104434. checkReadyOnlyOnce: boolean;
  104435. /**
  104436. * The state of the material
  104437. */
  104438. state: string;
  104439. /**
  104440. * If the material can be rendered to several textures with MRT extension
  104441. */
  104442. get canRenderToMRT(): boolean;
  104443. /**
  104444. * The alpha value of the material
  104445. */
  104446. protected _alpha: number;
  104447. /**
  104448. * List of inspectable custom properties (used by the Inspector)
  104449. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  104450. */
  104451. inspectableCustomProperties: IInspectable[];
  104452. /**
  104453. * Sets the alpha value of the material
  104454. */
  104455. set alpha(value: number);
  104456. /**
  104457. * Gets the alpha value of the material
  104458. */
  104459. get alpha(): number;
  104460. /**
  104461. * Specifies if back face culling is enabled
  104462. */
  104463. protected _backFaceCulling: boolean;
  104464. /**
  104465. * Sets the back-face culling state
  104466. */
  104467. set backFaceCulling(value: boolean);
  104468. /**
  104469. * Gets the back-face culling state
  104470. */
  104471. get backFaceCulling(): boolean;
  104472. /**
  104473. * Stores the value for side orientation
  104474. */
  104475. sideOrientation: number;
  104476. /**
  104477. * Callback triggered when the material is compiled
  104478. */
  104479. onCompiled: Nullable<(effect: Effect) => void>;
  104480. /**
  104481. * Callback triggered when an error occurs
  104482. */
  104483. onError: Nullable<(effect: Effect, errors: string) => void>;
  104484. /**
  104485. * Callback triggered to get the render target textures
  104486. */
  104487. getRenderTargetTextures: Nullable<() => SmartArray<RenderTargetTexture>>;
  104488. /**
  104489. * Gets a boolean indicating that current material needs to register RTT
  104490. */
  104491. get hasRenderTargetTextures(): boolean;
  104492. /**
  104493. * Specifies if the material should be serialized
  104494. */
  104495. doNotSerialize: boolean;
  104496. /**
  104497. * @hidden
  104498. */
  104499. _storeEffectOnSubMeshes: boolean;
  104500. /**
  104501. * Stores the animations for the material
  104502. */
  104503. animations: Nullable<Array<Animation>>;
  104504. /**
  104505. * An event triggered when the material is disposed
  104506. */
  104507. onDisposeObservable: Observable<Material>;
  104508. /**
  104509. * An observer which watches for dispose events
  104510. */
  104511. private _onDisposeObserver;
  104512. private _onUnBindObservable;
  104513. /**
  104514. * Called during a dispose event
  104515. */
  104516. set onDispose(callback: () => void);
  104517. private _onBindObservable;
  104518. /**
  104519. * An event triggered when the material is bound
  104520. */
  104521. get onBindObservable(): Observable<AbstractMesh>;
  104522. /**
  104523. * An observer which watches for bind events
  104524. */
  104525. private _onBindObserver;
  104526. /**
  104527. * Called during a bind event
  104528. */
  104529. set onBind(callback: (Mesh: AbstractMesh) => void);
  104530. /**
  104531. * An event triggered when the material is unbound
  104532. */
  104533. get onUnBindObservable(): Observable<Material>;
  104534. protected _onEffectCreatedObservable: Nullable<Observable<{
  104535. effect: Effect;
  104536. subMesh: Nullable<SubMesh>;
  104537. }>>;
  104538. /**
  104539. * An event triggered when the effect is (re)created
  104540. */
  104541. get onEffectCreatedObservable(): Observable<{
  104542. effect: Effect;
  104543. subMesh: Nullable<SubMesh>;
  104544. }>;
  104545. /**
  104546. * Stores the value of the alpha mode
  104547. */
  104548. private _alphaMode;
  104549. /**
  104550. * Sets the value of the alpha mode.
  104551. *
  104552. * | Value | Type | Description |
  104553. * | --- | --- | --- |
  104554. * | 0 | ALPHA_DISABLE | |
  104555. * | 1 | ALPHA_ADD | |
  104556. * | 2 | ALPHA_COMBINE | |
  104557. * | 3 | ALPHA_SUBTRACT | |
  104558. * | 4 | ALPHA_MULTIPLY | |
  104559. * | 5 | ALPHA_MAXIMIZED | |
  104560. * | 6 | ALPHA_ONEONE | |
  104561. * | 7 | ALPHA_PREMULTIPLIED | |
  104562. * | 8 | ALPHA_PREMULTIPLIED_PORTERDUFF | |
  104563. * | 9 | ALPHA_INTERPOLATE | |
  104564. * | 10 | ALPHA_SCREENMODE | |
  104565. *
  104566. */
  104567. set alphaMode(value: number);
  104568. /**
  104569. * Gets the value of the alpha mode
  104570. */
  104571. get alphaMode(): number;
  104572. /**
  104573. * Stores the state of the need depth pre-pass value
  104574. */
  104575. private _needDepthPrePass;
  104576. /**
  104577. * Sets the need depth pre-pass value
  104578. */
  104579. set needDepthPrePass(value: boolean);
  104580. /**
  104581. * Gets the depth pre-pass value
  104582. */
  104583. get needDepthPrePass(): boolean;
  104584. /**
  104585. * Specifies if depth writing should be disabled
  104586. */
  104587. disableDepthWrite: boolean;
  104588. /**
  104589. * Specifies if color writing should be disabled
  104590. */
  104591. disableColorWrite: boolean;
  104592. /**
  104593. * Specifies if depth writing should be forced
  104594. */
  104595. forceDepthWrite: boolean;
  104596. /**
  104597. * Specifies the depth function that should be used. 0 means the default engine function
  104598. */
  104599. depthFunction: number;
  104600. /**
  104601. * Specifies if there should be a separate pass for culling
  104602. */
  104603. separateCullingPass: boolean;
  104604. /**
  104605. * Stores the state specifing if fog should be enabled
  104606. */
  104607. private _fogEnabled;
  104608. /**
  104609. * Sets the state for enabling fog
  104610. */
  104611. set fogEnabled(value: boolean);
  104612. /**
  104613. * Gets the value of the fog enabled state
  104614. */
  104615. get fogEnabled(): boolean;
  104616. /**
  104617. * Stores the size of points
  104618. */
  104619. pointSize: number;
  104620. /**
  104621. * Stores the z offset value
  104622. */
  104623. zOffset: number;
  104624. get wireframe(): boolean;
  104625. /**
  104626. * Sets the state of wireframe mode
  104627. */
  104628. set wireframe(value: boolean);
  104629. /**
  104630. * Gets the value specifying if point clouds are enabled
  104631. */
  104632. get pointsCloud(): boolean;
  104633. /**
  104634. * Sets the state of point cloud mode
  104635. */
  104636. set pointsCloud(value: boolean);
  104637. /**
  104638. * Gets the material fill mode
  104639. */
  104640. get fillMode(): number;
  104641. /**
  104642. * Sets the material fill mode
  104643. */
  104644. set fillMode(value: number);
  104645. /**
  104646. * @hidden
  104647. * Stores the effects for the material
  104648. */
  104649. _effect: Nullable<Effect>;
  104650. /**
  104651. * Specifies if uniform buffers should be used
  104652. */
  104653. private _useUBO;
  104654. /**
  104655. * Stores a reference to the scene
  104656. */
  104657. private _scene;
  104658. /**
  104659. * Stores the fill mode state
  104660. */
  104661. private _fillMode;
  104662. /**
  104663. * Specifies if the depth write state should be cached
  104664. */
  104665. private _cachedDepthWriteState;
  104666. /**
  104667. * Specifies if the color write state should be cached
  104668. */
  104669. private _cachedColorWriteState;
  104670. /**
  104671. * Specifies if the depth function state should be cached
  104672. */
  104673. private _cachedDepthFunctionState;
  104674. /**
  104675. * Stores the uniform buffer
  104676. */
  104677. protected _uniformBuffer: UniformBuffer;
  104678. /** @hidden */
  104679. _indexInSceneMaterialArray: number;
  104680. /** @hidden */
  104681. meshMap: Nullable<{
  104682. [id: string]: AbstractMesh | undefined;
  104683. }>;
  104684. /**
  104685. * Creates a material instance
  104686. * @param name defines the name of the material
  104687. * @param scene defines the scene to reference
  104688. * @param doNotAdd specifies if the material should be added to the scene
  104689. */
  104690. constructor(name: string, scene: Scene, doNotAdd?: boolean);
  104691. /**
  104692. * Returns a string representation of the current material
  104693. * @param fullDetails defines a boolean indicating which levels of logging is desired
  104694. * @returns a string with material information
  104695. */
  104696. toString(fullDetails?: boolean): string;
  104697. /**
  104698. * Gets the class name of the material
  104699. * @returns a string with the class name of the material
  104700. */
  104701. getClassName(): string;
  104702. /**
  104703. * Specifies if updates for the material been locked
  104704. */
  104705. get isFrozen(): boolean;
  104706. /**
  104707. * Locks updates for the material
  104708. */
  104709. freeze(): void;
  104710. /**
  104711. * Unlocks updates for the material
  104712. */
  104713. unfreeze(): void;
  104714. /**
  104715. * Specifies if the material is ready to be used
  104716. * @param mesh defines the mesh to check
  104717. * @param useInstances specifies if instances should be used
  104718. * @returns a boolean indicating if the material is ready to be used
  104719. */
  104720. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  104721. /**
  104722. * Specifies that the submesh is ready to be used
  104723. * @param mesh defines the mesh to check
  104724. * @param subMesh defines which submesh to check
  104725. * @param useInstances specifies that instances should be used
  104726. * @returns a boolean indicating that the submesh is ready or not
  104727. */
  104728. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  104729. /**
  104730. * Returns the material effect
  104731. * @returns the effect associated with the material
  104732. */
  104733. getEffect(): Nullable<Effect>;
  104734. /**
  104735. * Returns the current scene
  104736. * @returns a Scene
  104737. */
  104738. getScene(): Scene;
  104739. /**
  104740. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  104741. */
  104742. protected _forceAlphaTest: boolean;
  104743. /**
  104744. * The transparency mode of the material.
  104745. */
  104746. protected _transparencyMode: Nullable<number>;
  104747. /**
  104748. * Gets the current transparency mode.
  104749. */
  104750. get transparencyMode(): Nullable<number>;
  104751. /**
  104752. * Sets the transparency mode of the material.
  104753. *
  104754. * | Value | Type | Description |
  104755. * | ----- | ----------------------------------- | ----------- |
  104756. * | 0 | OPAQUE | |
  104757. * | 1 | ALPHATEST | |
  104758. * | 2 | ALPHABLEND | |
  104759. * | 3 | ALPHATESTANDBLEND | |
  104760. *
  104761. */
  104762. set transparencyMode(value: Nullable<number>);
  104763. /**
  104764. * Returns true if alpha blending should be disabled.
  104765. */
  104766. protected get _disableAlphaBlending(): boolean;
  104767. /**
  104768. * Specifies whether or not this material should be rendered in alpha blend mode.
  104769. * @returns a boolean specifying if alpha blending is needed
  104770. */
  104771. needAlphaBlending(): boolean;
  104772. /**
  104773. * Specifies if the mesh will require alpha blending
  104774. * @param mesh defines the mesh to check
  104775. * @returns a boolean specifying if alpha blending is needed for the mesh
  104776. */
  104777. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  104778. /**
  104779. * Specifies whether or not this material should be rendered in alpha test mode.
  104780. * @returns a boolean specifying if an alpha test is needed.
  104781. */
  104782. needAlphaTesting(): boolean;
  104783. /**
  104784. * Specifies if material alpha testing should be turned on for the mesh
  104785. * @param mesh defines the mesh to check
  104786. */
  104787. protected _shouldTurnAlphaTestOn(mesh: AbstractMesh): boolean;
  104788. /**
  104789. * Gets the texture used for the alpha test
  104790. * @returns the texture to use for alpha testing
  104791. */
  104792. getAlphaTestTexture(): Nullable<BaseTexture>;
  104793. /**
  104794. * Marks the material to indicate that it needs to be re-calculated
  104795. */
  104796. markDirty(): void;
  104797. /** @hidden */
  104798. _preBind(effect?: Effect, overrideOrientation?: Nullable<number>): boolean;
  104799. /**
  104800. * Binds the material to the mesh
  104801. * @param world defines the world transformation matrix
  104802. * @param mesh defines the mesh to bind the material to
  104803. */
  104804. bind(world: Matrix, mesh?: Mesh): void;
  104805. /**
  104806. * Binds the submesh to the material
  104807. * @param world defines the world transformation matrix
  104808. * @param mesh defines the mesh containing the submesh
  104809. * @param subMesh defines the submesh to bind the material to
  104810. */
  104811. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  104812. /**
  104813. * Binds the world matrix to the material
  104814. * @param world defines the world transformation matrix
  104815. */
  104816. bindOnlyWorldMatrix(world: Matrix): void;
  104817. /**
  104818. * Binds the scene's uniform buffer to the effect.
  104819. * @param effect defines the effect to bind to the scene uniform buffer
  104820. * @param sceneUbo defines the uniform buffer storing scene data
  104821. */
  104822. bindSceneUniformBuffer(effect: Effect, sceneUbo: UniformBuffer): void;
  104823. /**
  104824. * Binds the view matrix to the effect
  104825. * @param effect defines the effect to bind the view matrix to
  104826. */
  104827. bindView(effect: Effect): void;
  104828. /**
  104829. * Binds the view projection matrix to the effect
  104830. * @param effect defines the effect to bind the view projection matrix to
  104831. */
  104832. bindViewProjection(effect: Effect): void;
  104833. /**
  104834. * Processes to execute after binding the material to a mesh
  104835. * @param mesh defines the rendered mesh
  104836. */
  104837. protected _afterBind(mesh?: Mesh): void;
  104838. /**
  104839. * Unbinds the material from the mesh
  104840. */
  104841. unbind(): void;
  104842. /**
  104843. * Gets the active textures from the material
  104844. * @returns an array of textures
  104845. */
  104846. getActiveTextures(): BaseTexture[];
  104847. /**
  104848. * Specifies if the material uses a texture
  104849. * @param texture defines the texture to check against the material
  104850. * @returns a boolean specifying if the material uses the texture
  104851. */
  104852. hasTexture(texture: BaseTexture): boolean;
  104853. /**
  104854. * Makes a duplicate of the material, and gives it a new name
  104855. * @param name defines the new name for the duplicated material
  104856. * @returns the cloned material
  104857. */
  104858. clone(name: string): Nullable<Material>;
  104859. /**
  104860. * Gets the meshes bound to the material
  104861. * @returns an array of meshes bound to the material
  104862. */
  104863. getBindedMeshes(): AbstractMesh[];
  104864. /**
  104865. * Force shader compilation
  104866. * @param mesh defines the mesh associated with this material
  104867. * @param onCompiled defines a function to execute once the material is compiled
  104868. * @param options defines the options to configure the compilation
  104869. * @param onError defines a function to execute if the material fails compiling
  104870. */
  104871. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>, onError?: (reason: string) => void): void;
  104872. /**
  104873. * Force shader compilation
  104874. * @param mesh defines the mesh that will use this material
  104875. * @param options defines additional options for compiling the shaders
  104876. * @returns a promise that resolves when the compilation completes
  104877. */
  104878. forceCompilationAsync(mesh: AbstractMesh, options?: Partial<IMaterialCompilationOptions>): Promise<void>;
  104879. private static readonly _AllDirtyCallBack;
  104880. private static readonly _ImageProcessingDirtyCallBack;
  104881. private static readonly _TextureDirtyCallBack;
  104882. private static readonly _FresnelDirtyCallBack;
  104883. private static readonly _MiscDirtyCallBack;
  104884. private static readonly _LightsDirtyCallBack;
  104885. private static readonly _AttributeDirtyCallBack;
  104886. private static _FresnelAndMiscDirtyCallBack;
  104887. private static _TextureAndMiscDirtyCallBack;
  104888. private static readonly _DirtyCallbackArray;
  104889. private static readonly _RunDirtyCallBacks;
  104890. /**
  104891. * Marks a define in the material to indicate that it needs to be re-computed
  104892. * @param flag defines a flag used to determine which parts of the material have to be marked as dirty
  104893. */
  104894. markAsDirty(flag: number): void;
  104895. /**
  104896. * Marks all submeshes of a material to indicate that their material defines need to be re-calculated
  104897. * @param func defines a function which checks material defines against the submeshes
  104898. */
  104899. protected _markAllSubMeshesAsDirty(func: (defines: MaterialDefines) => void): void;
  104900. /**
  104901. * Indicates that the scene should check if the rendering now needs a prepass
  104902. */
  104903. protected _markScenePrePassDirty(): void;
  104904. /**
  104905. * Indicates that we need to re-calculated for all submeshes
  104906. */
  104907. protected _markAllSubMeshesAsAllDirty(): void;
  104908. /**
  104909. * Indicates that image processing needs to be re-calculated for all submeshes
  104910. */
  104911. protected _markAllSubMeshesAsImageProcessingDirty(): void;
  104912. /**
  104913. * Indicates that textures need to be re-calculated for all submeshes
  104914. */
  104915. protected _markAllSubMeshesAsTexturesDirty(): void;
  104916. /**
  104917. * Indicates that fresnel needs to be re-calculated for all submeshes
  104918. */
  104919. protected _markAllSubMeshesAsFresnelDirty(): void;
  104920. /**
  104921. * Indicates that fresnel and misc need to be re-calculated for all submeshes
  104922. */
  104923. protected _markAllSubMeshesAsFresnelAndMiscDirty(): void;
  104924. /**
  104925. * Indicates that lights need to be re-calculated for all submeshes
  104926. */
  104927. protected _markAllSubMeshesAsLightsDirty(): void;
  104928. /**
  104929. * Indicates that attributes need to be re-calculated for all submeshes
  104930. */
  104931. protected _markAllSubMeshesAsAttributesDirty(): void;
  104932. /**
  104933. * Indicates that misc needs to be re-calculated for all submeshes
  104934. */
  104935. protected _markAllSubMeshesAsMiscDirty(): void;
  104936. /**
  104937. * Indicates that textures and misc need to be re-calculated for all submeshes
  104938. */
  104939. protected _markAllSubMeshesAsTexturesAndMiscDirty(): void;
  104940. /**
  104941. * Sets the required values to the prepass renderer.
  104942. * @param prePassRenderer defines the prepass renderer to setup.
  104943. * @returns true if the pre pass is needed.
  104944. */
  104945. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  104946. /**
  104947. * Disposes the material
  104948. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  104949. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  104950. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  104951. */
  104952. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  104953. /** @hidden */
  104954. private releaseVertexArrayObject;
  104955. /**
  104956. * Serializes this material
  104957. * @returns the serialized material object
  104958. */
  104959. serialize(): any;
  104960. /**
  104961. * Creates a material from parsed material data
  104962. * @param parsedMaterial defines parsed material data
  104963. * @param scene defines the hosting scene
  104964. * @param rootUrl defines the root URL to use to load textures
  104965. * @returns a new material
  104966. */
  104967. static Parse(parsedMaterial: any, scene: Scene, rootUrl: string): Nullable<Material>;
  104968. }
  104969. }
  104970. declare module BABYLON {
  104971. /**
  104972. * A multi-material is used to apply different materials to different parts of the same object without the need of
  104973. * separate meshes. This can be use to improve performances.
  104974. * @see https://doc.babylonjs.com/how_to/multi_materials
  104975. */
  104976. export class MultiMaterial extends Material {
  104977. private _subMaterials;
  104978. /**
  104979. * Gets or Sets the list of Materials used within the multi material.
  104980. * They need to be ordered according to the submeshes order in the associated mesh
  104981. */
  104982. get subMaterials(): Nullable<Material>[];
  104983. set subMaterials(value: Nullable<Material>[]);
  104984. /**
  104985. * Function used to align with Node.getChildren()
  104986. * @returns the list of Materials used within the multi material
  104987. */
  104988. getChildren(): Nullable<Material>[];
  104989. /**
  104990. * Instantiates a new Multi Material
  104991. * A multi-material is used to apply different materials to different parts of the same object without the need of
  104992. * separate meshes. This can be use to improve performances.
  104993. * @see https://doc.babylonjs.com/how_to/multi_materials
  104994. * @param name Define the name in the scene
  104995. * @param scene Define the scene the material belongs to
  104996. */
  104997. constructor(name: string, scene: Scene);
  104998. private _hookArray;
  104999. /**
  105000. * Get one of the submaterial by its index in the submaterials array
  105001. * @param index The index to look the sub material at
  105002. * @returns The Material if the index has been defined
  105003. */
  105004. getSubMaterial(index: number): Nullable<Material>;
  105005. /**
  105006. * Get the list of active textures for the whole sub materials list.
  105007. * @returns All the textures that will be used during the rendering
  105008. */
  105009. getActiveTextures(): BaseTexture[];
  105010. /**
  105011. * Gets the current class name of the material e.g. "MultiMaterial"
  105012. * Mainly use in serialization.
  105013. * @returns the class name
  105014. */
  105015. getClassName(): string;
  105016. /**
  105017. * Checks if the material is ready to render the requested sub mesh
  105018. * @param mesh Define the mesh the submesh belongs to
  105019. * @param subMesh Define the sub mesh to look readyness for
  105020. * @param useInstances Define whether or not the material is used with instances
  105021. * @returns true if ready, otherwise false
  105022. */
  105023. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  105024. /**
  105025. * Clones the current material and its related sub materials
  105026. * @param name Define the name of the newly cloned material
  105027. * @param cloneChildren Define if submaterial will be cloned or shared with the parent instance
  105028. * @returns the cloned material
  105029. */
  105030. clone(name: string, cloneChildren?: boolean): MultiMaterial;
  105031. /**
  105032. * Serializes the materials into a JSON representation.
  105033. * @returns the JSON representation
  105034. */
  105035. serialize(): any;
  105036. /**
  105037. * Dispose the material and release its associated resources
  105038. * @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)
  105039. * @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)
  105040. * @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)
  105041. */
  105042. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, forceDisposeChildren?: boolean): void;
  105043. /**
  105044. * Creates a MultiMaterial from parsed MultiMaterial data.
  105045. * @param parsedMultiMaterial defines parsed MultiMaterial data.
  105046. * @param scene defines the hosting scene
  105047. * @returns a new MultiMaterial
  105048. */
  105049. static ParseMultiMaterial(parsedMultiMaterial: any, scene: Scene): MultiMaterial;
  105050. }
  105051. }
  105052. declare module BABYLON {
  105053. /**
  105054. * Defines a subdivision inside a mesh
  105055. */
  105056. export class SubMesh implements ICullable {
  105057. /** the material index to use */
  105058. materialIndex: number;
  105059. /** vertex index start */
  105060. verticesStart: number;
  105061. /** vertices count */
  105062. verticesCount: number;
  105063. /** index start */
  105064. indexStart: number;
  105065. /** indices count */
  105066. indexCount: number;
  105067. /** @hidden */
  105068. _materialDefines: Nullable<MaterialDefines>;
  105069. /** @hidden */
  105070. _materialEffect: Nullable<Effect>;
  105071. /** @hidden */
  105072. _effectOverride: Nullable<Effect>;
  105073. /**
  105074. * Gets material defines used by the effect associated to the sub mesh
  105075. */
  105076. get materialDefines(): Nullable<MaterialDefines>;
  105077. /**
  105078. * Sets material defines used by the effect associated to the sub mesh
  105079. */
  105080. set materialDefines(defines: Nullable<MaterialDefines>);
  105081. /**
  105082. * Gets associated effect
  105083. */
  105084. get effect(): Nullable<Effect>;
  105085. /**
  105086. * Sets associated effect (effect used to render this submesh)
  105087. * @param effect defines the effect to associate with
  105088. * @param defines defines the set of defines used to compile this effect
  105089. */
  105090. setEffect(effect: Nullable<Effect>, defines?: Nullable<MaterialDefines>): void;
  105091. /** @hidden */
  105092. _linesIndexCount: number;
  105093. private _mesh;
  105094. private _renderingMesh;
  105095. private _boundingInfo;
  105096. private _linesIndexBuffer;
  105097. /** @hidden */
  105098. _lastColliderWorldVertices: Nullable<Vector3[]>;
  105099. /** @hidden */
  105100. _trianglePlanes: Plane[];
  105101. /** @hidden */
  105102. _lastColliderTransformMatrix: Nullable<Matrix>;
  105103. /** @hidden */
  105104. _renderId: number;
  105105. /** @hidden */
  105106. _alphaIndex: number;
  105107. /** @hidden */
  105108. _distanceToCamera: number;
  105109. /** @hidden */
  105110. _id: number;
  105111. private _currentMaterial;
  105112. /**
  105113. * Add a new submesh to a mesh
  105114. * @param materialIndex defines the material index to use
  105115. * @param verticesStart defines vertex index start
  105116. * @param verticesCount defines vertices count
  105117. * @param indexStart defines index start
  105118. * @param indexCount defines indices count
  105119. * @param mesh defines the parent mesh
  105120. * @param renderingMesh defines an optional rendering mesh
  105121. * @param createBoundingBox defines if bounding box should be created for this submesh
  105122. * @returns the new submesh
  105123. */
  105124. static AddToMesh(materialIndex: number, verticesStart: number, verticesCount: number, indexStart: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean): SubMesh;
  105125. /**
  105126. * Creates a new submesh
  105127. * @param materialIndex defines the material index to use
  105128. * @param verticesStart defines vertex index start
  105129. * @param verticesCount defines vertices count
  105130. * @param indexStart defines index start
  105131. * @param indexCount defines indices count
  105132. * @param mesh defines the parent mesh
  105133. * @param renderingMesh defines an optional rendering mesh
  105134. * @param createBoundingBox defines if bounding box should be created for this submesh
  105135. * @param addToMesh defines a boolean indicating that the submesh must be added to the mesh.subMeshes array (true by default)
  105136. */
  105137. constructor(
  105138. /** the material index to use */
  105139. materialIndex: number,
  105140. /** vertex index start */
  105141. verticesStart: number,
  105142. /** vertices count */
  105143. verticesCount: number,
  105144. /** index start */
  105145. indexStart: number,
  105146. /** indices count */
  105147. indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean, addToMesh?: boolean);
  105148. /**
  105149. * Returns true if this submesh covers the entire parent mesh
  105150. * @ignorenaming
  105151. */
  105152. get IsGlobal(): boolean;
  105153. /**
  105154. * Returns the submesh BoudingInfo object
  105155. * @returns current bounding info (or mesh's one if the submesh is global)
  105156. */
  105157. getBoundingInfo(): BoundingInfo;
  105158. /**
  105159. * Sets the submesh BoundingInfo
  105160. * @param boundingInfo defines the new bounding info to use
  105161. * @returns the SubMesh
  105162. */
  105163. setBoundingInfo(boundingInfo: BoundingInfo): SubMesh;
  105164. /**
  105165. * Returns the mesh of the current submesh
  105166. * @return the parent mesh
  105167. */
  105168. getMesh(): AbstractMesh;
  105169. /**
  105170. * Returns the rendering mesh of the submesh
  105171. * @returns the rendering mesh (could be different from parent mesh)
  105172. */
  105173. getRenderingMesh(): Mesh;
  105174. /**
  105175. * Returns the replacement mesh of the submesh
  105176. * @returns the replacement mesh (could be different from parent mesh)
  105177. */
  105178. getReplacementMesh(): Nullable<AbstractMesh>;
  105179. /**
  105180. * Returns the effective mesh of the submesh
  105181. * @returns the effective mesh (could be different from parent mesh)
  105182. */
  105183. getEffectiveMesh(): AbstractMesh;
  105184. /**
  105185. * Returns the submesh material
  105186. * @returns null or the current material
  105187. */
  105188. getMaterial(): Nullable<Material>;
  105189. private _IsMultiMaterial;
  105190. /**
  105191. * Sets a new updated BoundingInfo object to the submesh
  105192. * @param data defines an optional position array to use to determine the bounding info
  105193. * @returns the SubMesh
  105194. */
  105195. refreshBoundingInfo(data?: Nullable<FloatArray>): SubMesh;
  105196. /** @hidden */
  105197. _checkCollision(collider: Collider): boolean;
  105198. /**
  105199. * Updates the submesh BoundingInfo
  105200. * @param world defines the world matrix to use to update the bounding info
  105201. * @returns the submesh
  105202. */
  105203. updateBoundingInfo(world: DeepImmutable<Matrix>): SubMesh;
  105204. /**
  105205. * True is the submesh bounding box intersects the frustum defined by the passed array of planes.
  105206. * @param frustumPlanes defines the frustum planes
  105207. * @returns true if the submesh is intersecting with the frustum
  105208. */
  105209. isInFrustum(frustumPlanes: Plane[]): boolean;
  105210. /**
  105211. * True is the submesh bounding box is completely inside the frustum defined by the passed array of planes
  105212. * @param frustumPlanes defines the frustum planes
  105213. * @returns true if the submesh is inside the frustum
  105214. */
  105215. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  105216. /**
  105217. * Renders the submesh
  105218. * @param enableAlphaMode defines if alpha needs to be used
  105219. * @returns the submesh
  105220. */
  105221. render(enableAlphaMode: boolean): SubMesh;
  105222. /**
  105223. * @hidden
  105224. */
  105225. _getLinesIndexBuffer(indices: IndicesArray, engine: Engine): DataBuffer;
  105226. /**
  105227. * Checks if the submesh intersects with a ray
  105228. * @param ray defines the ray to test
  105229. * @returns true is the passed ray intersects the submesh bounding box
  105230. */
  105231. canIntersects(ray: Ray): boolean;
  105232. /**
  105233. * Intersects current submesh with a ray
  105234. * @param ray defines the ray to test
  105235. * @param positions defines mesh's positions array
  105236. * @param indices defines mesh's indices array
  105237. * @param fastCheck defines if the first intersection will be used (and not the closest)
  105238. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  105239. * @returns intersection info or null if no intersection
  105240. */
  105241. intersects(ray: Ray, positions: Vector3[], indices: IndicesArray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<IntersectionInfo>;
  105242. /** @hidden */
  105243. private _intersectLines;
  105244. /** @hidden */
  105245. private _intersectUnIndexedLines;
  105246. /** @hidden */
  105247. private _intersectTriangles;
  105248. /** @hidden */
  105249. private _intersectUnIndexedTriangles;
  105250. /** @hidden */
  105251. _rebuild(): void;
  105252. /**
  105253. * Creates a new submesh from the passed mesh
  105254. * @param newMesh defines the new hosting mesh
  105255. * @param newRenderingMesh defines an optional rendering mesh
  105256. * @returns the new submesh
  105257. */
  105258. clone(newMesh: AbstractMesh, newRenderingMesh?: Mesh): SubMesh;
  105259. /**
  105260. * Release associated resources
  105261. */
  105262. dispose(): void;
  105263. /**
  105264. * Gets the class name
  105265. * @returns the string "SubMesh".
  105266. */
  105267. getClassName(): string;
  105268. /**
  105269. * Creates a new submesh from indices data
  105270. * @param materialIndex the index of the main mesh material
  105271. * @param startIndex the index where to start the copy in the mesh indices array
  105272. * @param indexCount the number of indices to copy then from the startIndex
  105273. * @param mesh the main mesh to create the submesh from
  105274. * @param renderingMesh the optional rendering mesh
  105275. * @returns a new submesh
  105276. */
  105277. static CreateFromIndices(materialIndex: number, startIndex: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh): SubMesh;
  105278. }
  105279. }
  105280. declare module BABYLON {
  105281. /**
  105282. * Class used to represent data loading progression
  105283. */
  105284. export class SceneLoaderFlags {
  105285. private static _ForceFullSceneLoadingForIncremental;
  105286. private static _ShowLoadingScreen;
  105287. private static _CleanBoneMatrixWeights;
  105288. private static _loggingLevel;
  105289. /**
  105290. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  105291. */
  105292. static get ForceFullSceneLoadingForIncremental(): boolean;
  105293. static set ForceFullSceneLoadingForIncremental(value: boolean);
  105294. /**
  105295. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  105296. */
  105297. static get ShowLoadingScreen(): boolean;
  105298. static set ShowLoadingScreen(value: boolean);
  105299. /**
  105300. * Defines the current logging level (while loading the scene)
  105301. * @ignorenaming
  105302. */
  105303. static get loggingLevel(): number;
  105304. static set loggingLevel(value: number);
  105305. /**
  105306. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  105307. */
  105308. static get CleanBoneMatrixWeights(): boolean;
  105309. static set CleanBoneMatrixWeights(value: boolean);
  105310. }
  105311. }
  105312. declare module BABYLON {
  105313. /**
  105314. * Class used to store geometry data (vertex buffers + index buffer)
  105315. */
  105316. export class Geometry implements IGetSetVerticesData {
  105317. /**
  105318. * Gets or sets the ID of the geometry
  105319. */
  105320. id: string;
  105321. /**
  105322. * Gets or sets the unique ID of the geometry
  105323. */
  105324. uniqueId: number;
  105325. /**
  105326. * Gets the delay loading state of the geometry (none by default which means not delayed)
  105327. */
  105328. delayLoadState: number;
  105329. /**
  105330. * Gets the file containing the data to load when running in delay load state
  105331. */
  105332. delayLoadingFile: Nullable<string>;
  105333. /**
  105334. * Callback called when the geometry is updated
  105335. */
  105336. onGeometryUpdated: (geometry: Geometry, kind?: string) => void;
  105337. private _scene;
  105338. private _engine;
  105339. private _meshes;
  105340. private _totalVertices;
  105341. /** @hidden */
  105342. _indices: IndicesArray;
  105343. /** @hidden */
  105344. _vertexBuffers: {
  105345. [key: string]: VertexBuffer;
  105346. };
  105347. private _isDisposed;
  105348. private _extend;
  105349. private _boundingBias;
  105350. /** @hidden */
  105351. _delayInfo: Array<string>;
  105352. private _indexBuffer;
  105353. private _indexBufferIsUpdatable;
  105354. /** @hidden */
  105355. _boundingInfo: Nullable<BoundingInfo>;
  105356. /** @hidden */
  105357. _delayLoadingFunction: Nullable<(any: any, geometry: Geometry) => void>;
  105358. /** @hidden */
  105359. _softwareSkinningFrameId: number;
  105360. private _vertexArrayObjects;
  105361. private _updatable;
  105362. /** @hidden */
  105363. _positions: Nullable<Vector3[]>;
  105364. /**
  105365. * 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
  105366. */
  105367. get boundingBias(): Vector2;
  105368. /**
  105369. * 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
  105370. */
  105371. set boundingBias(value: Vector2);
  105372. /**
  105373. * Static function used to attach a new empty geometry to a mesh
  105374. * @param mesh defines the mesh to attach the geometry to
  105375. * @returns the new Geometry
  105376. */
  105377. static CreateGeometryForMesh(mesh: Mesh): Geometry;
  105378. /** Get the list of meshes using this geometry */
  105379. get meshes(): Mesh[];
  105380. /**
  105381. * 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
  105382. * and won't be computed based on the vertex positions (which is what we get when useBoundingInfoFromGeometry = false)
  105383. */
  105384. useBoundingInfoFromGeometry: boolean;
  105385. /**
  105386. * Creates a new geometry
  105387. * @param id defines the unique ID
  105388. * @param scene defines the hosting scene
  105389. * @param vertexData defines the VertexData used to get geometry data
  105390. * @param updatable defines if geometry must be updatable (false by default)
  105391. * @param mesh defines the mesh that will be associated with the geometry
  105392. */
  105393. constructor(id: string, scene: Scene, vertexData?: VertexData, updatable?: boolean, mesh?: Nullable<Mesh>);
  105394. /**
  105395. * Gets the current extend of the geometry
  105396. */
  105397. get extend(): {
  105398. minimum: Vector3;
  105399. maximum: Vector3;
  105400. };
  105401. /**
  105402. * Gets the hosting scene
  105403. * @returns the hosting Scene
  105404. */
  105405. getScene(): Scene;
  105406. /**
  105407. * Gets the hosting engine
  105408. * @returns the hosting Engine
  105409. */
  105410. getEngine(): Engine;
  105411. /**
  105412. * Defines if the geometry is ready to use
  105413. * @returns true if the geometry is ready to be used
  105414. */
  105415. isReady(): boolean;
  105416. /**
  105417. * Gets a value indicating that the geometry should not be serialized
  105418. */
  105419. get doNotSerialize(): boolean;
  105420. /** @hidden */
  105421. _rebuild(): void;
  105422. /**
  105423. * Affects all geometry data in one call
  105424. * @param vertexData defines the geometry data
  105425. * @param updatable defines if the geometry must be flagged as updatable (false as default)
  105426. */
  105427. setAllVerticesData(vertexData: VertexData, updatable?: boolean): void;
  105428. /**
  105429. * Set specific vertex data
  105430. * @param kind defines the data kind (Position, normal, etc...)
  105431. * @param data defines the vertex data to use
  105432. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  105433. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  105434. */
  105435. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): void;
  105436. /**
  105437. * Removes a specific vertex data
  105438. * @param kind defines the data kind (Position, normal, etc...)
  105439. */
  105440. removeVerticesData(kind: string): void;
  105441. /**
  105442. * Affect a vertex buffer to the geometry. the vertexBuffer.getKind() function is used to determine where to store the data
  105443. * @param buffer defines the vertex buffer to use
  105444. * @param totalVertices defines the total number of vertices for position kind (could be null)
  105445. */
  105446. setVerticesBuffer(buffer: VertexBuffer, totalVertices?: Nullable<number>): void;
  105447. /**
  105448. * Update a specific vertex buffer
  105449. * This function will directly update the underlying DataBuffer according to the passed numeric array or Float32Array
  105450. * It will do nothing if the buffer is not updatable
  105451. * @param kind defines the data kind (Position, normal, etc...)
  105452. * @param data defines the data to use
  105453. * @param offset defines the offset in the target buffer where to store the data
  105454. * @param useBytes set to true if the offset is in bytes
  105455. */
  105456. updateVerticesDataDirectly(kind: string, data: DataArray, offset: number, useBytes?: boolean): void;
  105457. /**
  105458. * Update a specific vertex buffer
  105459. * This function will create a new buffer if the current one is not updatable
  105460. * @param kind defines the data kind (Position, normal, etc...)
  105461. * @param data defines the data to use
  105462. * @param updateExtends defines if the geometry extends must be recomputed (false by default)
  105463. */
  105464. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean): void;
  105465. private _updateBoundingInfo;
  105466. /** @hidden */
  105467. _bind(effect: Nullable<Effect>, indexToBind?: Nullable<DataBuffer>): void;
  105468. /**
  105469. * Gets total number of vertices
  105470. * @returns the total number of vertices
  105471. */
  105472. getTotalVertices(): number;
  105473. /**
  105474. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  105475. * @param kind defines the data kind (Position, normal, etc...)
  105476. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  105477. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  105478. * @returns a float array containing vertex data
  105479. */
  105480. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  105481. /**
  105482. * Returns a boolean defining if the vertex data for the requested `kind` is updatable
  105483. * @param kind defines the data kind (Position, normal, etc...)
  105484. * @returns true if the vertex buffer with the specified kind is updatable
  105485. */
  105486. isVertexBufferUpdatable(kind: string): boolean;
  105487. /**
  105488. * Gets a specific vertex buffer
  105489. * @param kind defines the data kind (Position, normal, etc...)
  105490. * @returns a VertexBuffer
  105491. */
  105492. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  105493. /**
  105494. * Returns all vertex buffers
  105495. * @return an object holding all vertex buffers indexed by kind
  105496. */
  105497. getVertexBuffers(): Nullable<{
  105498. [key: string]: VertexBuffer;
  105499. }>;
  105500. /**
  105501. * Gets a boolean indicating if specific vertex buffer is present
  105502. * @param kind defines the data kind (Position, normal, etc...)
  105503. * @returns true if data is present
  105504. */
  105505. isVerticesDataPresent(kind: string): boolean;
  105506. /**
  105507. * Gets a list of all attached data kinds (Position, normal, etc...)
  105508. * @returns a list of string containing all kinds
  105509. */
  105510. getVerticesDataKinds(): string[];
  105511. /**
  105512. * Update index buffer
  105513. * @param indices defines the indices to store in the index buffer
  105514. * @param offset defines the offset in the target buffer where to store the data
  105515. * @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)
  105516. */
  105517. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): void;
  105518. /**
  105519. * Creates a new index buffer
  105520. * @param indices defines the indices to store in the index buffer
  105521. * @param totalVertices defines the total number of vertices (could be null)
  105522. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  105523. */
  105524. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): void;
  105525. /**
  105526. * Return the total number of indices
  105527. * @returns the total number of indices
  105528. */
  105529. getTotalIndices(): number;
  105530. /**
  105531. * Gets the index buffer array
  105532. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  105533. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  105534. * @returns the index buffer array
  105535. */
  105536. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  105537. /**
  105538. * Gets the index buffer
  105539. * @return the index buffer
  105540. */
  105541. getIndexBuffer(): Nullable<DataBuffer>;
  105542. /** @hidden */
  105543. _releaseVertexArrayObject(effect?: Nullable<Effect>): void;
  105544. /**
  105545. * Release the associated resources for a specific mesh
  105546. * @param mesh defines the source mesh
  105547. * @param shouldDispose defines if the geometry must be disposed if there is no more mesh pointing to it
  105548. */
  105549. releaseForMesh(mesh: Mesh, shouldDispose?: boolean): void;
  105550. /**
  105551. * Apply current geometry to a given mesh
  105552. * @param mesh defines the mesh to apply geometry to
  105553. */
  105554. applyToMesh(mesh: Mesh): void;
  105555. private _updateExtend;
  105556. private _applyToMesh;
  105557. private notifyUpdate;
  105558. /**
  105559. * Load the geometry if it was flagged as delay loaded
  105560. * @param scene defines the hosting scene
  105561. * @param onLoaded defines a callback called when the geometry is loaded
  105562. */
  105563. load(scene: Scene, onLoaded?: () => void): void;
  105564. private _queueLoad;
  105565. /**
  105566. * Invert the geometry to move from a right handed system to a left handed one.
  105567. */
  105568. toLeftHanded(): void;
  105569. /** @hidden */
  105570. _resetPointsArrayCache(): void;
  105571. /** @hidden */
  105572. _generatePointsArray(): boolean;
  105573. /**
  105574. * Gets a value indicating if the geometry is disposed
  105575. * @returns true if the geometry was disposed
  105576. */
  105577. isDisposed(): boolean;
  105578. private _disposeVertexArrayObjects;
  105579. /**
  105580. * Free all associated resources
  105581. */
  105582. dispose(): void;
  105583. /**
  105584. * Clone the current geometry into a new geometry
  105585. * @param id defines the unique ID of the new geometry
  105586. * @returns a new geometry object
  105587. */
  105588. copy(id: string): Geometry;
  105589. /**
  105590. * Serialize the current geometry info (and not the vertices data) into a JSON object
  105591. * @return a JSON representation of the current geometry data (without the vertices data)
  105592. */
  105593. serialize(): any;
  105594. private toNumberArray;
  105595. /**
  105596. * Serialize all vertices data into a JSON oject
  105597. * @returns a JSON representation of the current geometry data
  105598. */
  105599. serializeVerticeData(): any;
  105600. /**
  105601. * Extracts a clone of a mesh geometry
  105602. * @param mesh defines the source mesh
  105603. * @param id defines the unique ID of the new geometry object
  105604. * @returns the new geometry object
  105605. */
  105606. static ExtractFromMesh(mesh: Mesh, id: string): Nullable<Geometry>;
  105607. /**
  105608. * You should now use Tools.RandomId(), this method is still here for legacy reasons.
  105609. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  105610. * Be aware Math.random() could cause collisions, but:
  105611. * "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"
  105612. * @returns a string containing a new GUID
  105613. */
  105614. static RandomId(): string;
  105615. /** @hidden */
  105616. static _ImportGeometry(parsedGeometry: any, mesh: Mesh): void;
  105617. private static _CleanMatricesWeights;
  105618. /**
  105619. * Create a new geometry from persisted data (Using .babylon file format)
  105620. * @param parsedVertexData defines the persisted data
  105621. * @param scene defines the hosting scene
  105622. * @param rootUrl defines the root url to use to load assets (like delayed data)
  105623. * @returns the new geometry object
  105624. */
  105625. static Parse(parsedVertexData: any, scene: Scene, rootUrl: string): Nullable<Geometry>;
  105626. }
  105627. }
  105628. declare module BABYLON {
  105629. /**
  105630. * Define an interface for all classes that will get and set the data on vertices
  105631. */
  105632. export interface IGetSetVerticesData {
  105633. /**
  105634. * Gets a boolean indicating if specific vertex data is present
  105635. * @param kind defines the vertex data kind to use
  105636. * @returns true is data kind is present
  105637. */
  105638. isVerticesDataPresent(kind: string): boolean;
  105639. /**
  105640. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  105641. * @param kind defines the data kind (Position, normal, etc...)
  105642. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  105643. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  105644. * @returns a float array containing vertex data
  105645. */
  105646. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  105647. /**
  105648. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  105649. * @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.
  105650. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  105651. * @returns the indices array or an empty array if the mesh has no geometry
  105652. */
  105653. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  105654. /**
  105655. * Set specific vertex data
  105656. * @param kind defines the data kind (Position, normal, etc...)
  105657. * @param data defines the vertex data to use
  105658. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  105659. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  105660. */
  105661. setVerticesData(kind: string, data: FloatArray, updatable: boolean): void;
  105662. /**
  105663. * Update a specific associated vertex buffer
  105664. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  105665. * - VertexBuffer.PositionKind
  105666. * - VertexBuffer.UVKind
  105667. * - VertexBuffer.UV2Kind
  105668. * - VertexBuffer.UV3Kind
  105669. * - VertexBuffer.UV4Kind
  105670. * - VertexBuffer.UV5Kind
  105671. * - VertexBuffer.UV6Kind
  105672. * - VertexBuffer.ColorKind
  105673. * - VertexBuffer.MatricesIndicesKind
  105674. * - VertexBuffer.MatricesIndicesExtraKind
  105675. * - VertexBuffer.MatricesWeightsKind
  105676. * - VertexBuffer.MatricesWeightsExtraKind
  105677. * @param data defines the data source
  105678. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  105679. * @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)
  105680. */
  105681. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): void;
  105682. /**
  105683. * Creates a new index buffer
  105684. * @param indices defines the indices to store in the index buffer
  105685. * @param totalVertices defines the total number of vertices (could be null)
  105686. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  105687. */
  105688. setIndices(indices: IndicesArray, totalVertices: Nullable<number>, updatable?: boolean): void;
  105689. }
  105690. /**
  105691. * This class contains the various kinds of data on every vertex of a mesh used in determining its shape and appearance
  105692. */
  105693. export class VertexData {
  105694. /**
  105695. * Mesh side orientation : usually the external or front surface
  105696. */
  105697. static readonly FRONTSIDE: number;
  105698. /**
  105699. * Mesh side orientation : usually the internal or back surface
  105700. */
  105701. static readonly BACKSIDE: number;
  105702. /**
  105703. * Mesh side orientation : both internal and external or front and back surfaces
  105704. */
  105705. static readonly DOUBLESIDE: number;
  105706. /**
  105707. * Mesh side orientation : by default, `FRONTSIDE`
  105708. */
  105709. static readonly DEFAULTSIDE: number;
  105710. /**
  105711. * An array of the x, y, z position of each vertex [...., x, y, z, .....]
  105712. */
  105713. positions: Nullable<FloatArray>;
  105714. /**
  105715. * An array of the x, y, z normal vector of each vertex [...., x, y, z, .....]
  105716. */
  105717. normals: Nullable<FloatArray>;
  105718. /**
  105719. * An array of the x, y, z tangent vector of each vertex [...., x, y, z, .....]
  105720. */
  105721. tangents: Nullable<FloatArray>;
  105722. /**
  105723. * An array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105724. */
  105725. uvs: Nullable<FloatArray>;
  105726. /**
  105727. * A second array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105728. */
  105729. uvs2: Nullable<FloatArray>;
  105730. /**
  105731. * A third array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105732. */
  105733. uvs3: Nullable<FloatArray>;
  105734. /**
  105735. * A fourth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105736. */
  105737. uvs4: Nullable<FloatArray>;
  105738. /**
  105739. * A fifth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105740. */
  105741. uvs5: Nullable<FloatArray>;
  105742. /**
  105743. * A sixth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105744. */
  105745. uvs6: Nullable<FloatArray>;
  105746. /**
  105747. * An array of the r, g, b, a, color of each vertex [...., r, g, b, a, .....]
  105748. */
  105749. colors: Nullable<FloatArray>;
  105750. /**
  105751. * 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).
  105752. */
  105753. matricesIndices: Nullable<FloatArray>;
  105754. /**
  105755. * An array containing the list of weights defining the weight of each indexed matrix in the final computation
  105756. */
  105757. matricesWeights: Nullable<FloatArray>;
  105758. /**
  105759. * An array extending the number of possible indices
  105760. */
  105761. matricesIndicesExtra: Nullable<FloatArray>;
  105762. /**
  105763. * An array extending the number of possible weights when the number of indices is extended
  105764. */
  105765. matricesWeightsExtra: Nullable<FloatArray>;
  105766. /**
  105767. * An array of i, j, k the three vertex indices required for each triangular facet [...., i, j, k .....]
  105768. */
  105769. indices: Nullable<IndicesArray>;
  105770. /**
  105771. * Uses the passed data array to set the set the values for the specified kind of data
  105772. * @param data a linear array of floating numbers
  105773. * @param kind the type of data that is being set, eg positions, colors etc
  105774. */
  105775. set(data: FloatArray, kind: string): void;
  105776. /**
  105777. * Associates the vertexData to the passed Mesh.
  105778. * Sets it as updatable or not (default `false`)
  105779. * @param mesh the mesh the vertexData is applied to
  105780. * @param updatable when used and having the value true allows new data to update the vertexData
  105781. * @returns the VertexData
  105782. */
  105783. applyToMesh(mesh: Mesh, updatable?: boolean): VertexData;
  105784. /**
  105785. * Associates the vertexData to the passed Geometry.
  105786. * Sets it as updatable or not (default `false`)
  105787. * @param geometry the geometry the vertexData is applied to
  105788. * @param updatable when used and having the value true allows new data to update the vertexData
  105789. * @returns VertexData
  105790. */
  105791. applyToGeometry(geometry: Geometry, updatable?: boolean): VertexData;
  105792. /**
  105793. * Updates the associated mesh
  105794. * @param mesh the mesh to be updated
  105795. * @param updateExtends when true the mesh BoundingInfo will be renewed when and if position kind is updated, optional with default false
  105796. * @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
  105797. * @returns VertexData
  105798. */
  105799. updateMesh(mesh: Mesh): VertexData;
  105800. /**
  105801. * Updates the associated geometry
  105802. * @param geometry the geometry to be updated
  105803. * @param updateExtends when true BoundingInfo will be renewed when and if position kind is updated, optional with default false
  105804. * @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
  105805. * @returns VertexData.
  105806. */
  105807. updateGeometry(geometry: Geometry): VertexData;
  105808. private _applyTo;
  105809. private _update;
  105810. /**
  105811. * Transforms each position and each normal of the vertexData according to the passed Matrix
  105812. * @param matrix the transforming matrix
  105813. * @returns the VertexData
  105814. */
  105815. transform(matrix: Matrix): VertexData;
  105816. /**
  105817. * Merges the passed VertexData into the current one
  105818. * @param other the VertexData to be merged into the current one
  105819. * @param use32BitsIndices defines a boolean indicating if indices must be store in a 32 bits array
  105820. * @returns the modified VertexData
  105821. */
  105822. merge(other: VertexData, use32BitsIndices?: boolean): VertexData;
  105823. private _mergeElement;
  105824. private _validate;
  105825. /**
  105826. * Serializes the VertexData
  105827. * @returns a serialized object
  105828. */
  105829. serialize(): any;
  105830. /**
  105831. * Extracts the vertexData from a mesh
  105832. * @param mesh the mesh from which to extract the VertexData
  105833. * @param copyWhenShared defines if the VertexData must be cloned when shared between multiple meshes, optional, default false
  105834. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  105835. * @returns the object VertexData associated to the passed mesh
  105836. */
  105837. static ExtractFromMesh(mesh: Mesh, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  105838. /**
  105839. * Extracts the vertexData from the geometry
  105840. * @param geometry the geometry from which to extract the VertexData
  105841. * @param copyWhenShared defines if the VertexData must be cloned when the geometrty is shared between multiple meshes, optional, default false
  105842. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  105843. * @returns the object VertexData associated to the passed mesh
  105844. */
  105845. static ExtractFromGeometry(geometry: Geometry, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  105846. private static _ExtractFrom;
  105847. /**
  105848. * Creates the VertexData for a Ribbon
  105849. * @param options an object used to set the following optional parameters for the ribbon, required but can be empty
  105850. * * pathArray array of paths, each of which an array of successive Vector3
  105851. * * closeArray creates a seam between the first and the last paths of the pathArray, optional, default false
  105852. * * closePath creates a seam between the first and the last points of each path of the path array, optional, default false
  105853. * * 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
  105854. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105855. * * 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)
  105856. * * 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)
  105857. * * invertUV swaps in the U and V coordinates when applying a texture, optional, default false
  105858. * * uvs a linear array, of length 2 * number of vertices, of custom UV values, optional
  105859. * * colors a linear array, of length 4 * number of vertices, of custom color values, optional
  105860. * @returns the VertexData of the ribbon
  105861. */
  105862. static CreateRibbon(options: {
  105863. pathArray: Vector3[][];
  105864. closeArray?: boolean;
  105865. closePath?: boolean;
  105866. offset?: number;
  105867. sideOrientation?: number;
  105868. frontUVs?: Vector4;
  105869. backUVs?: Vector4;
  105870. invertUV?: boolean;
  105871. uvs?: Vector2[];
  105872. colors?: Color4[];
  105873. }): VertexData;
  105874. /**
  105875. * Creates the VertexData for a box
  105876. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105877. * * size sets the width, height and depth of the box to the value of size, optional default 1
  105878. * * width sets the width (x direction) of the box, overwrites the width set by size, optional, default size
  105879. * * height sets the height (y direction) of the box, overwrites the height set by size, optional, default size
  105880. * * depth sets the depth (z direction) of the box, overwrites the depth set by size, optional, default size
  105881. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  105882. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  105883. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105884. * * 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)
  105885. * * 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)
  105886. * @returns the VertexData of the box
  105887. */
  105888. static CreateBox(options: {
  105889. size?: number;
  105890. width?: number;
  105891. height?: number;
  105892. depth?: number;
  105893. faceUV?: Vector4[];
  105894. faceColors?: Color4[];
  105895. sideOrientation?: number;
  105896. frontUVs?: Vector4;
  105897. backUVs?: Vector4;
  105898. }): VertexData;
  105899. /**
  105900. * Creates the VertexData for a tiled box
  105901. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105902. * * faceTiles sets the pattern, tile size and number of tiles for a face
  105903. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  105904. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  105905. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105906. * @returns the VertexData of the box
  105907. */
  105908. static CreateTiledBox(options: {
  105909. pattern?: number;
  105910. width?: number;
  105911. height?: number;
  105912. depth?: number;
  105913. tileSize?: number;
  105914. tileWidth?: number;
  105915. tileHeight?: number;
  105916. alignHorizontal?: number;
  105917. alignVertical?: number;
  105918. faceUV?: Vector4[];
  105919. faceColors?: Color4[];
  105920. sideOrientation?: number;
  105921. }): VertexData;
  105922. /**
  105923. * Creates the VertexData for a tiled plane
  105924. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105925. * * pattern a limited pattern arrangement depending on the number
  105926. * * tileSize sets the width, height and depth of the tile to the value of size, optional default 1
  105927. * * tileWidth sets the width (x direction) of the tile, overwrites the width set by size, optional, default size
  105928. * * tileHeight sets the height (y direction) of the tile, overwrites the height set by size, optional, default size
  105929. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105930. * * 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)
  105931. * * 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)
  105932. * @returns the VertexData of the tiled plane
  105933. */
  105934. static CreateTiledPlane(options: {
  105935. pattern?: number;
  105936. tileSize?: number;
  105937. tileWidth?: number;
  105938. tileHeight?: number;
  105939. size?: number;
  105940. width?: number;
  105941. height?: number;
  105942. alignHorizontal?: number;
  105943. alignVertical?: number;
  105944. sideOrientation?: number;
  105945. frontUVs?: Vector4;
  105946. backUVs?: Vector4;
  105947. }): VertexData;
  105948. /**
  105949. * Creates the VertexData for an ellipsoid, defaults to a sphere
  105950. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105951. * * segments sets the number of horizontal strips optional, default 32
  105952. * * diameter sets the axes dimensions, diameterX, diameterY and diameterZ to the value of diameter, optional default 1
  105953. * * diameterX sets the diameterX (x direction) of the ellipsoid, overwrites the diameterX set by diameter, optional, default diameter
  105954. * * diameterY sets the diameterY (y direction) of the ellipsoid, overwrites the diameterY set by diameter, optional, default diameter
  105955. * * diameterZ sets the diameterZ (z direction) of the ellipsoid, overwrites the diameterZ set by diameter, optional, default diameter
  105956. * * 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
  105957. * * 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
  105958. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105959. * * 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)
  105960. * * 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)
  105961. * @returns the VertexData of the ellipsoid
  105962. */
  105963. static CreateSphere(options: {
  105964. segments?: number;
  105965. diameter?: number;
  105966. diameterX?: number;
  105967. diameterY?: number;
  105968. diameterZ?: number;
  105969. arc?: number;
  105970. slice?: number;
  105971. sideOrientation?: number;
  105972. frontUVs?: Vector4;
  105973. backUVs?: Vector4;
  105974. }): VertexData;
  105975. /**
  105976. * Creates the VertexData for a cylinder, cone or prism
  105977. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105978. * * height sets the height (y direction) of the cylinder, optional, default 2
  105979. * * diameterTop sets the diameter of the top of the cone, overwrites diameter, optional, default diameter
  105980. * * diameterBottom sets the diameter of the bottom of the cone, overwrites diameter, optional, default diameter
  105981. * * diameter sets the diameter of the top and bottom of the cone, optional default 1
  105982. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  105983. * * subdivisions` the number of rings along the cylinder height, optional, default 1
  105984. * * 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
  105985. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  105986. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  105987. * * hasRings when true makes each subdivision independantly treated as a face for faceUV and faceColors, optional, default false
  105988. * * enclose when true closes an open cylinder by adding extra flat faces between the height axis and vertical edges, think cut cake
  105989. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105990. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  105991. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  105992. * @returns the VertexData of the cylinder, cone or prism
  105993. */
  105994. static CreateCylinder(options: {
  105995. height?: number;
  105996. diameterTop?: number;
  105997. diameterBottom?: number;
  105998. diameter?: number;
  105999. tessellation?: number;
  106000. subdivisions?: number;
  106001. arc?: number;
  106002. faceColors?: Color4[];
  106003. faceUV?: Vector4[];
  106004. hasRings?: boolean;
  106005. enclose?: boolean;
  106006. sideOrientation?: number;
  106007. frontUVs?: Vector4;
  106008. backUVs?: Vector4;
  106009. }): VertexData;
  106010. /**
  106011. * Creates the VertexData for a torus
  106012. * @param options an object used to set the following optional parameters for the box, required but can be empty
  106013. * * diameter the diameter of the torus, optional default 1
  106014. * * thickness the diameter of the tube forming the torus, optional default 0.5
  106015. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  106016. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106017. * * 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)
  106018. * * 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)
  106019. * @returns the VertexData of the torus
  106020. */
  106021. static CreateTorus(options: {
  106022. diameter?: number;
  106023. thickness?: number;
  106024. tessellation?: number;
  106025. sideOrientation?: number;
  106026. frontUVs?: Vector4;
  106027. backUVs?: Vector4;
  106028. }): VertexData;
  106029. /**
  106030. * Creates the VertexData of the LineSystem
  106031. * @param options an object used to set the following optional parameters for the LineSystem, required but can be empty
  106032. * - lines an array of lines, each line being an array of successive Vector3
  106033. * - colors an array of line colors, each of the line colors being an array of successive Color4, one per line point
  106034. * @returns the VertexData of the LineSystem
  106035. */
  106036. static CreateLineSystem(options: {
  106037. lines: Vector3[][];
  106038. colors?: Nullable<Color4[][]>;
  106039. }): VertexData;
  106040. /**
  106041. * Create the VertexData for a DashedLines
  106042. * @param options an object used to set the following optional parameters for the DashedLines, required but can be empty
  106043. * - points an array successive Vector3
  106044. * - dashSize the size of the dashes relative to the dash number, optional, default 3
  106045. * - gapSize the size of the gap between two successive dashes relative to the dash number, optional, default 1
  106046. * - dashNb the intended total number of dashes, optional, default 200
  106047. * @returns the VertexData for the DashedLines
  106048. */
  106049. static CreateDashedLines(options: {
  106050. points: Vector3[];
  106051. dashSize?: number;
  106052. gapSize?: number;
  106053. dashNb?: number;
  106054. }): VertexData;
  106055. /**
  106056. * Creates the VertexData for a Ground
  106057. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  106058. * - width the width (x direction) of the ground, optional, default 1
  106059. * - height the height (z direction) of the ground, optional, default 1
  106060. * - subdivisions the number of subdivisions per side, optional, default 1
  106061. * @returns the VertexData of the Ground
  106062. */
  106063. static CreateGround(options: {
  106064. width?: number;
  106065. height?: number;
  106066. subdivisions?: number;
  106067. subdivisionsX?: number;
  106068. subdivisionsY?: number;
  106069. }): VertexData;
  106070. /**
  106071. * Creates the VertexData for a TiledGround by subdividing the ground into tiles
  106072. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  106073. * * xmin the ground minimum X coordinate, optional, default -1
  106074. * * zmin the ground minimum Z coordinate, optional, default -1
  106075. * * xmax the ground maximum X coordinate, optional, default 1
  106076. * * zmax the ground maximum Z coordinate, optional, default 1
  106077. * * 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}
  106078. * * 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}
  106079. * @returns the VertexData of the TiledGround
  106080. */
  106081. static CreateTiledGround(options: {
  106082. xmin: number;
  106083. zmin: number;
  106084. xmax: number;
  106085. zmax: number;
  106086. subdivisions?: {
  106087. w: number;
  106088. h: number;
  106089. };
  106090. precision?: {
  106091. w: number;
  106092. h: number;
  106093. };
  106094. }): VertexData;
  106095. /**
  106096. * Creates the VertexData of the Ground designed from a heightmap
  106097. * @param options an object used to set the following parameters for the Ground, required and provided by MeshBuilder.CreateGroundFromHeightMap
  106098. * * width the width (x direction) of the ground
  106099. * * height the height (z direction) of the ground
  106100. * * subdivisions the number of subdivisions per side
  106101. * * minHeight the minimum altitude on the ground, optional, default 0
  106102. * * maxHeight the maximum altitude on the ground, optional default 1
  106103. * * colorFilter the filter to apply to the image pixel colors to compute the height, optional Color3, default (0.3, 0.59, 0.11)
  106104. * * buffer the array holding the image color data
  106105. * * bufferWidth the width of image
  106106. * * bufferHeight the height of image
  106107. * * alphaFilter Remove any data where the alpha channel is below this value, defaults 0 (all data visible)
  106108. * @returns the VertexData of the Ground designed from a heightmap
  106109. */
  106110. static CreateGroundFromHeightMap(options: {
  106111. width: number;
  106112. height: number;
  106113. subdivisions: number;
  106114. minHeight: number;
  106115. maxHeight: number;
  106116. colorFilter: Color3;
  106117. buffer: Uint8Array;
  106118. bufferWidth: number;
  106119. bufferHeight: number;
  106120. alphaFilter: number;
  106121. }): VertexData;
  106122. /**
  106123. * Creates the VertexData for a Plane
  106124. * @param options an object used to set the following optional parameters for the plane, required but can be empty
  106125. * * size sets the width and height of the plane to the value of size, optional default 1
  106126. * * width sets the width (x direction) of the plane, overwrites the width set by size, optional, default size
  106127. * * height sets the height (y direction) of the plane, overwrites the height set by size, optional, default size
  106128. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106129. * * 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)
  106130. * * 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)
  106131. * @returns the VertexData of the box
  106132. */
  106133. static CreatePlane(options: {
  106134. size?: number;
  106135. width?: number;
  106136. height?: number;
  106137. sideOrientation?: number;
  106138. frontUVs?: Vector4;
  106139. backUVs?: Vector4;
  106140. }): VertexData;
  106141. /**
  106142. * Creates the VertexData of the Disc or regular Polygon
  106143. * @param options an object used to set the following optional parameters for the disc, required but can be empty
  106144. * * radius the radius of the disc, optional default 0.5
  106145. * * tessellation the number of polygon sides, optional, default 64
  106146. * * 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
  106147. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106148. * * 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)
  106149. * * 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)
  106150. * @returns the VertexData of the box
  106151. */
  106152. static CreateDisc(options: {
  106153. radius?: number;
  106154. tessellation?: number;
  106155. arc?: number;
  106156. sideOrientation?: number;
  106157. frontUVs?: Vector4;
  106158. backUVs?: Vector4;
  106159. }): VertexData;
  106160. /**
  106161. * Creates the VertexData for an irregular Polygon in the XoZ plane using a mesh built by polygonTriangulation.build()
  106162. * All parameters are provided by MeshBuilder.CreatePolygon as needed
  106163. * @param polygon a mesh built from polygonTriangulation.build()
  106164. * @param sideOrientation takes the values Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106165. * @param fUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  106166. * @param fColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  106167. * @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)
  106168. * @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)
  106169. * @param wrap a boolean, default false, when true and fUVs used texture is wrapped around all sides, when false texture is applied side
  106170. * @returns the VertexData of the Polygon
  106171. */
  106172. static CreatePolygon(polygon: Mesh, sideOrientation: number, fUV?: Vector4[], fColors?: Color4[], frontUVs?: Vector4, backUVs?: Vector4, wrap?: boolean): VertexData;
  106173. /**
  106174. * Creates the VertexData of the IcoSphere
  106175. * @param options an object used to set the following optional parameters for the IcoSphere, required but can be empty
  106176. * * radius the radius of the IcoSphere, optional default 1
  106177. * * radiusX allows stretching in the x direction, optional, default radius
  106178. * * radiusY allows stretching in the y direction, optional, default radius
  106179. * * radiusZ allows stretching in the z direction, optional, default radius
  106180. * * flat when true creates a flat shaded mesh, optional, default true
  106181. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  106182. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106183. * * 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)
  106184. * * 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)
  106185. * @returns the VertexData of the IcoSphere
  106186. */
  106187. static CreateIcoSphere(options: {
  106188. radius?: number;
  106189. radiusX?: number;
  106190. radiusY?: number;
  106191. radiusZ?: number;
  106192. flat?: boolean;
  106193. subdivisions?: number;
  106194. sideOrientation?: number;
  106195. frontUVs?: Vector4;
  106196. backUVs?: Vector4;
  106197. }): VertexData;
  106198. /**
  106199. * Creates the VertexData for a Polyhedron
  106200. * @param options an object used to set the following optional parameters for the polyhedron, required but can be empty
  106201. * * type provided types are:
  106202. * * 0 : Tetrahedron, 1 : Octahedron, 2 : Dodecahedron, 3 : Icosahedron, 4 : Rhombicuboctahedron, 5 : Triangular Prism, 6 : Pentagonal Prism, 7 : Hexagonal Prism, 8 : Square Pyramid (J1)
  106203. * * 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)
  106204. * * size the size of the IcoSphere, optional default 1
  106205. * * sizeX allows stretching in the x direction, optional, default size
  106206. * * sizeY allows stretching in the y direction, optional, default size
  106207. * * sizeZ allows stretching in the z direction, optional, default size
  106208. * * 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
  106209. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  106210. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  106211. * * flat when true creates a flat shaded mesh, optional, default true
  106212. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  106213. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106214. * * 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)
  106215. * * 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)
  106216. * @returns the VertexData of the Polyhedron
  106217. */
  106218. static CreatePolyhedron(options: {
  106219. type?: number;
  106220. size?: number;
  106221. sizeX?: number;
  106222. sizeY?: number;
  106223. sizeZ?: number;
  106224. custom?: any;
  106225. faceUV?: Vector4[];
  106226. faceColors?: Color4[];
  106227. flat?: boolean;
  106228. sideOrientation?: number;
  106229. frontUVs?: Vector4;
  106230. backUVs?: Vector4;
  106231. }): VertexData;
  106232. /**
  106233. * Creates the VertexData for a TorusKnot
  106234. * @param options an object used to set the following optional parameters for the TorusKnot, required but can be empty
  106235. * * radius the radius of the torus knot, optional, default 2
  106236. * * tube the thickness of the tube, optional, default 0.5
  106237. * * radialSegments the number of sides on each tube segments, optional, default 32
  106238. * * tubularSegments the number of tubes to decompose the knot into, optional, default 32
  106239. * * p the number of windings around the z axis, optional, default 2
  106240. * * q the number of windings around the x axis, optional, default 3
  106241. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106242. * * 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)
  106243. * * 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)
  106244. * @returns the VertexData of the Torus Knot
  106245. */
  106246. static CreateTorusKnot(options: {
  106247. radius?: number;
  106248. tube?: number;
  106249. radialSegments?: number;
  106250. tubularSegments?: number;
  106251. p?: number;
  106252. q?: number;
  106253. sideOrientation?: number;
  106254. frontUVs?: Vector4;
  106255. backUVs?: Vector4;
  106256. }): VertexData;
  106257. /**
  106258. * Compute normals for given positions and indices
  106259. * @param positions an array of vertex positions, [...., x, y, z, ......]
  106260. * @param indices an array of indices in groups of three for each triangular facet, [...., i, j, k, ......]
  106261. * @param normals an array of vertex normals, [...., x, y, z, ......]
  106262. * @param options an object used to set the following optional parameters for the TorusKnot, optional
  106263. * * facetNormals : optional array of facet normals (vector3)
  106264. * * facetPositions : optional array of facet positions (vector3)
  106265. * * facetPartitioning : optional partitioning array. facetPositions is required for facetPartitioning computation
  106266. * * ratio : optional partitioning ratio / bounding box, required for facetPartitioning computation
  106267. * * bInfo : optional bounding info, required for facetPartitioning computation
  106268. * * bbSize : optional bounding box size data, required for facetPartitioning computation
  106269. * * subDiv : optional partitioning data about subdivsions on each axis (int), required for facetPartitioning computation
  106270. * * useRightHandedSystem: optional boolean to for right handed system computation
  106271. * * depthSort : optional boolean to enable the facet depth sort computation
  106272. * * distanceTo : optional Vector3 to compute the facet depth from this location
  106273. * * depthSortedFacets : optional array of depthSortedFacets to store the facet distances from the reference location
  106274. */
  106275. static ComputeNormals(positions: any, indices: any, normals: any, options?: {
  106276. facetNormals?: any;
  106277. facetPositions?: any;
  106278. facetPartitioning?: any;
  106279. ratio?: number;
  106280. bInfo?: any;
  106281. bbSize?: Vector3;
  106282. subDiv?: any;
  106283. useRightHandedSystem?: boolean;
  106284. depthSort?: boolean;
  106285. distanceTo?: Vector3;
  106286. depthSortedFacets?: any;
  106287. }): void;
  106288. /** @hidden */
  106289. static _ComputeSides(sideOrientation: number, positions: FloatArray, indices: FloatArray, normals: FloatArray, uvs: FloatArray, frontUVs?: Vector4, backUVs?: Vector4): void;
  106290. /**
  106291. * Applies VertexData created from the imported parameters to the geometry
  106292. * @param parsedVertexData the parsed data from an imported file
  106293. * @param geometry the geometry to apply the VertexData to
  106294. */
  106295. static ImportVertexData(parsedVertexData: any, geometry: Geometry): void;
  106296. }
  106297. }
  106298. declare module BABYLON {
  106299. /**
  106300. * Defines a target to use with MorphTargetManager
  106301. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  106302. */
  106303. export class MorphTarget implements IAnimatable {
  106304. /** defines the name of the target */
  106305. name: string;
  106306. /**
  106307. * Gets or sets the list of animations
  106308. */
  106309. animations: Animation[];
  106310. private _scene;
  106311. private _positions;
  106312. private _normals;
  106313. private _tangents;
  106314. private _uvs;
  106315. private _influence;
  106316. private _uniqueId;
  106317. /**
  106318. * Observable raised when the influence changes
  106319. */
  106320. onInfluenceChanged: Observable<boolean>;
  106321. /** @hidden */
  106322. _onDataLayoutChanged: Observable<void>;
  106323. /**
  106324. * Gets or sets the influence of this target (ie. its weight in the overall morphing)
  106325. */
  106326. get influence(): number;
  106327. set influence(influence: number);
  106328. /**
  106329. * Gets or sets the id of the morph Target
  106330. */
  106331. id: string;
  106332. private _animationPropertiesOverride;
  106333. /**
  106334. * Gets or sets the animation properties override
  106335. */
  106336. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  106337. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  106338. /**
  106339. * Creates a new MorphTarget
  106340. * @param name defines the name of the target
  106341. * @param influence defines the influence to use
  106342. * @param scene defines the scene the morphtarget belongs to
  106343. */
  106344. constructor(
  106345. /** defines the name of the target */
  106346. name: string, influence?: number, scene?: Nullable<Scene>);
  106347. /**
  106348. * Gets the unique ID of this manager
  106349. */
  106350. get uniqueId(): number;
  106351. /**
  106352. * Gets a boolean defining if the target contains position data
  106353. */
  106354. get hasPositions(): boolean;
  106355. /**
  106356. * Gets a boolean defining if the target contains normal data
  106357. */
  106358. get hasNormals(): boolean;
  106359. /**
  106360. * Gets a boolean defining if the target contains tangent data
  106361. */
  106362. get hasTangents(): boolean;
  106363. /**
  106364. * Gets a boolean defining if the target contains texture coordinates data
  106365. */
  106366. get hasUVs(): boolean;
  106367. /**
  106368. * Affects position data to this target
  106369. * @param data defines the position data to use
  106370. */
  106371. setPositions(data: Nullable<FloatArray>): void;
  106372. /**
  106373. * Gets the position data stored in this target
  106374. * @returns a FloatArray containing the position data (or null if not present)
  106375. */
  106376. getPositions(): Nullable<FloatArray>;
  106377. /**
  106378. * Affects normal data to this target
  106379. * @param data defines the normal data to use
  106380. */
  106381. setNormals(data: Nullable<FloatArray>): void;
  106382. /**
  106383. * Gets the normal data stored in this target
  106384. * @returns a FloatArray containing the normal data (or null if not present)
  106385. */
  106386. getNormals(): Nullable<FloatArray>;
  106387. /**
  106388. * Affects tangent data to this target
  106389. * @param data defines the tangent data to use
  106390. */
  106391. setTangents(data: Nullable<FloatArray>): void;
  106392. /**
  106393. * Gets the tangent data stored in this target
  106394. * @returns a FloatArray containing the tangent data (or null if not present)
  106395. */
  106396. getTangents(): Nullable<FloatArray>;
  106397. /**
  106398. * Affects texture coordinates data to this target
  106399. * @param data defines the texture coordinates data to use
  106400. */
  106401. setUVs(data: Nullable<FloatArray>): void;
  106402. /**
  106403. * Gets the texture coordinates data stored in this target
  106404. * @returns a FloatArray containing the texture coordinates data (or null if not present)
  106405. */
  106406. getUVs(): Nullable<FloatArray>;
  106407. /**
  106408. * Clone the current target
  106409. * @returns a new MorphTarget
  106410. */
  106411. clone(): MorphTarget;
  106412. /**
  106413. * Serializes the current target into a Serialization object
  106414. * @returns the serialized object
  106415. */
  106416. serialize(): any;
  106417. /**
  106418. * Returns the string "MorphTarget"
  106419. * @returns "MorphTarget"
  106420. */
  106421. getClassName(): string;
  106422. /**
  106423. * Creates a new target from serialized data
  106424. * @param serializationObject defines the serialized data to use
  106425. * @returns a new MorphTarget
  106426. */
  106427. static Parse(serializationObject: any): MorphTarget;
  106428. /**
  106429. * Creates a MorphTarget from mesh data
  106430. * @param mesh defines the source mesh
  106431. * @param name defines the name to use for the new target
  106432. * @param influence defines the influence to attach to the target
  106433. * @returns a new MorphTarget
  106434. */
  106435. static FromMesh(mesh: AbstractMesh, name?: string, influence?: number): MorphTarget;
  106436. }
  106437. }
  106438. declare module BABYLON {
  106439. /**
  106440. * This class is used to deform meshes using morphing between different targets
  106441. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  106442. */
  106443. export class MorphTargetManager {
  106444. private _targets;
  106445. private _targetInfluenceChangedObservers;
  106446. private _targetDataLayoutChangedObservers;
  106447. private _activeTargets;
  106448. private _scene;
  106449. private _influences;
  106450. private _supportsNormals;
  106451. private _supportsTangents;
  106452. private _supportsUVs;
  106453. private _vertexCount;
  106454. private _uniqueId;
  106455. private _tempInfluences;
  106456. /**
  106457. * Gets or sets a boolean indicating if normals must be morphed
  106458. */
  106459. enableNormalMorphing: boolean;
  106460. /**
  106461. * Gets or sets a boolean indicating if tangents must be morphed
  106462. */
  106463. enableTangentMorphing: boolean;
  106464. /**
  106465. * Gets or sets a boolean indicating if UV must be morphed
  106466. */
  106467. enableUVMorphing: boolean;
  106468. /**
  106469. * Creates a new MorphTargetManager
  106470. * @param scene defines the current scene
  106471. */
  106472. constructor(scene?: Nullable<Scene>);
  106473. /**
  106474. * Gets the unique ID of this manager
  106475. */
  106476. get uniqueId(): number;
  106477. /**
  106478. * Gets the number of vertices handled by this manager
  106479. */
  106480. get vertexCount(): number;
  106481. /**
  106482. * Gets a boolean indicating if this manager supports morphing of normals
  106483. */
  106484. get supportsNormals(): boolean;
  106485. /**
  106486. * Gets a boolean indicating if this manager supports morphing of tangents
  106487. */
  106488. get supportsTangents(): boolean;
  106489. /**
  106490. * Gets a boolean indicating if this manager supports morphing of texture coordinates
  106491. */
  106492. get supportsUVs(): boolean;
  106493. /**
  106494. * Gets the number of targets stored in this manager
  106495. */
  106496. get numTargets(): number;
  106497. /**
  106498. * Gets the number of influencers (ie. the number of targets with influences > 0)
  106499. */
  106500. get numInfluencers(): number;
  106501. /**
  106502. * Gets the list of influences (one per target)
  106503. */
  106504. get influences(): Float32Array;
  106505. /**
  106506. * Gets the active target at specified index. An active target is a target with an influence > 0
  106507. * @param index defines the index to check
  106508. * @returns the requested target
  106509. */
  106510. getActiveTarget(index: number): MorphTarget;
  106511. /**
  106512. * Gets the target at specified index
  106513. * @param index defines the index to check
  106514. * @returns the requested target
  106515. */
  106516. getTarget(index: number): MorphTarget;
  106517. /**
  106518. * Add a new target to this manager
  106519. * @param target defines the target to add
  106520. */
  106521. addTarget(target: MorphTarget): void;
  106522. /**
  106523. * Removes a target from the manager
  106524. * @param target defines the target to remove
  106525. */
  106526. removeTarget(target: MorphTarget): void;
  106527. /**
  106528. * Clone the current manager
  106529. * @returns a new MorphTargetManager
  106530. */
  106531. clone(): MorphTargetManager;
  106532. /**
  106533. * Serializes the current manager into a Serialization object
  106534. * @returns the serialized object
  106535. */
  106536. serialize(): any;
  106537. private _syncActiveTargets;
  106538. /**
  106539. * Syncrhonize the targets with all the meshes using this morph target manager
  106540. */
  106541. synchronize(): void;
  106542. /**
  106543. * Creates a new MorphTargetManager from serialized data
  106544. * @param serializationObject defines the serialized data
  106545. * @param scene defines the hosting scene
  106546. * @returns the new MorphTargetManager
  106547. */
  106548. static Parse(serializationObject: any, scene: Scene): MorphTargetManager;
  106549. }
  106550. }
  106551. declare module BABYLON {
  106552. /**
  106553. * Class used to represent a specific level of detail of a mesh
  106554. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  106555. */
  106556. export class MeshLODLevel {
  106557. /** Defines the distance where this level should start being displayed */
  106558. distance: number;
  106559. /** Defines the mesh to use to render this level */
  106560. mesh: Nullable<Mesh>;
  106561. /**
  106562. * Creates a new LOD level
  106563. * @param distance defines the distance where this level should star being displayed
  106564. * @param mesh defines the mesh to use to render this level
  106565. */
  106566. constructor(
  106567. /** Defines the distance where this level should start being displayed */
  106568. distance: number,
  106569. /** Defines the mesh to use to render this level */
  106570. mesh: Nullable<Mesh>);
  106571. }
  106572. }
  106573. declare module BABYLON {
  106574. /**
  106575. * Helper class used to generate a canvas to manipulate images
  106576. */
  106577. export class CanvasGenerator {
  106578. /**
  106579. * Create a new canvas (or offscreen canvas depending on the context)
  106580. * @param width defines the expected width
  106581. * @param height defines the expected height
  106582. * @return a new canvas or offscreen canvas
  106583. */
  106584. static CreateCanvas(width: number, height: number): HTMLCanvasElement | OffscreenCanvas;
  106585. }
  106586. }
  106587. declare module BABYLON {
  106588. /**
  106589. * Mesh representing the gorund
  106590. */
  106591. export class GroundMesh extends Mesh {
  106592. /** If octree should be generated */
  106593. generateOctree: boolean;
  106594. private _heightQuads;
  106595. /** @hidden */
  106596. _subdivisionsX: number;
  106597. /** @hidden */
  106598. _subdivisionsY: number;
  106599. /** @hidden */
  106600. _width: number;
  106601. /** @hidden */
  106602. _height: number;
  106603. /** @hidden */
  106604. _minX: number;
  106605. /** @hidden */
  106606. _maxX: number;
  106607. /** @hidden */
  106608. _minZ: number;
  106609. /** @hidden */
  106610. _maxZ: number;
  106611. constructor(name: string, scene: Scene);
  106612. /**
  106613. * "GroundMesh"
  106614. * @returns "GroundMesh"
  106615. */
  106616. getClassName(): string;
  106617. /**
  106618. * The minimum of x and y subdivisions
  106619. */
  106620. get subdivisions(): number;
  106621. /**
  106622. * X subdivisions
  106623. */
  106624. get subdivisionsX(): number;
  106625. /**
  106626. * Y subdivisions
  106627. */
  106628. get subdivisionsY(): number;
  106629. /**
  106630. * This function will update an octree to help to select the right submeshes for rendering, picking and collision computations.
  106631. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  106632. * @param chunksCount the number of subdivisions for x and y
  106633. * @param octreeBlocksSize (Default: 32)
  106634. */
  106635. optimize(chunksCount: number, octreeBlocksSize?: number): void;
  106636. /**
  106637. * Returns a height (y) value in the Worl system :
  106638. * the ground altitude at the coordinates (x, z) expressed in the World system.
  106639. * @param x x coordinate
  106640. * @param z z coordinate
  106641. * @returns the ground y position if (x, z) are outside the ground surface.
  106642. */
  106643. getHeightAtCoordinates(x: number, z: number): number;
  106644. /**
  106645. * Returns a normalized vector (Vector3) orthogonal to the ground
  106646. * at the ground coordinates (x, z) expressed in the World system.
  106647. * @param x x coordinate
  106648. * @param z z coordinate
  106649. * @returns Vector3(0.0, 1.0, 0.0) if (x, z) are outside the ground surface.
  106650. */
  106651. getNormalAtCoordinates(x: number, z: number): Vector3;
  106652. /**
  106653. * Updates the Vector3 passed a reference with a normalized vector orthogonal to the ground
  106654. * at the ground coordinates (x, z) expressed in the World system.
  106655. * Doesn't uptade the reference Vector3 if (x, z) are outside the ground surface.
  106656. * @param x x coordinate
  106657. * @param z z coordinate
  106658. * @param ref vector to store the result
  106659. * @returns the GroundMesh.
  106660. */
  106661. getNormalAtCoordinatesToRef(x: number, z: number, ref: Vector3): GroundMesh;
  106662. /**
  106663. * Force the heights to be recomputed for getHeightAtCoordinates() or getNormalAtCoordinates()
  106664. * if the ground has been updated.
  106665. * This can be used in the render loop.
  106666. * @returns the GroundMesh.
  106667. */
  106668. updateCoordinateHeights(): GroundMesh;
  106669. private _getFacetAt;
  106670. private _initHeightQuads;
  106671. private _computeHeightQuads;
  106672. /**
  106673. * Serializes this ground mesh
  106674. * @param serializationObject object to write serialization to
  106675. */
  106676. serialize(serializationObject: any): void;
  106677. /**
  106678. * Parses a serialized ground mesh
  106679. * @param parsedMesh the serialized mesh
  106680. * @param scene the scene to create the ground mesh in
  106681. * @returns the created ground mesh
  106682. */
  106683. static Parse(parsedMesh: any, scene: Scene): GroundMesh;
  106684. }
  106685. }
  106686. declare module BABYLON {
  106687. /**
  106688. * Interface for Physics-Joint data
  106689. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106690. */
  106691. export interface PhysicsJointData {
  106692. /**
  106693. * The main pivot of the joint
  106694. */
  106695. mainPivot?: Vector3;
  106696. /**
  106697. * The connected pivot of the joint
  106698. */
  106699. connectedPivot?: Vector3;
  106700. /**
  106701. * The main axis of the joint
  106702. */
  106703. mainAxis?: Vector3;
  106704. /**
  106705. * The connected axis of the joint
  106706. */
  106707. connectedAxis?: Vector3;
  106708. /**
  106709. * The collision of the joint
  106710. */
  106711. collision?: boolean;
  106712. /**
  106713. * Native Oimo/Cannon/Energy data
  106714. */
  106715. nativeParams?: any;
  106716. }
  106717. /**
  106718. * This is a holder class for the physics joint created by the physics plugin
  106719. * It holds a set of functions to control the underlying joint
  106720. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106721. */
  106722. export class PhysicsJoint {
  106723. /**
  106724. * The type of the physics joint
  106725. */
  106726. type: number;
  106727. /**
  106728. * The data for the physics joint
  106729. */
  106730. jointData: PhysicsJointData;
  106731. private _physicsJoint;
  106732. protected _physicsPlugin: IPhysicsEnginePlugin;
  106733. /**
  106734. * Initializes the physics joint
  106735. * @param type The type of the physics joint
  106736. * @param jointData The data for the physics joint
  106737. */
  106738. constructor(
  106739. /**
  106740. * The type of the physics joint
  106741. */
  106742. type: number,
  106743. /**
  106744. * The data for the physics joint
  106745. */
  106746. jointData: PhysicsJointData);
  106747. /**
  106748. * Gets the physics joint
  106749. */
  106750. get physicsJoint(): any;
  106751. /**
  106752. * Sets the physics joint
  106753. */
  106754. set physicsJoint(newJoint: any);
  106755. /**
  106756. * Sets the physics plugin
  106757. */
  106758. set physicsPlugin(physicsPlugin: IPhysicsEnginePlugin);
  106759. /**
  106760. * Execute a function that is physics-plugin specific.
  106761. * @param {Function} func the function that will be executed.
  106762. * It accepts two parameters: the physics world and the physics joint
  106763. */
  106764. executeNativeFunction(func: (world: any, physicsJoint: any) => void): void;
  106765. /**
  106766. * Distance-Joint type
  106767. */
  106768. static DistanceJoint: number;
  106769. /**
  106770. * Hinge-Joint type
  106771. */
  106772. static HingeJoint: number;
  106773. /**
  106774. * Ball-and-Socket joint type
  106775. */
  106776. static BallAndSocketJoint: number;
  106777. /**
  106778. * Wheel-Joint type
  106779. */
  106780. static WheelJoint: number;
  106781. /**
  106782. * Slider-Joint type
  106783. */
  106784. static SliderJoint: number;
  106785. /**
  106786. * Prismatic-Joint type
  106787. */
  106788. static PrismaticJoint: number;
  106789. /**
  106790. * Universal-Joint type
  106791. * ENERGY FTW! (compare with this - @see http://ode-wiki.org/wiki/index.php?title=Manual:_Joint_Types_and_Functions)
  106792. */
  106793. static UniversalJoint: number;
  106794. /**
  106795. * Hinge-Joint 2 type
  106796. */
  106797. static Hinge2Joint: number;
  106798. /**
  106799. * Point to Point Joint type. Similar to a Ball-Joint. Different in parameters
  106800. */
  106801. static PointToPointJoint: number;
  106802. /**
  106803. * Spring-Joint type
  106804. */
  106805. static SpringJoint: number;
  106806. /**
  106807. * Lock-Joint type
  106808. */
  106809. static LockJoint: number;
  106810. }
  106811. /**
  106812. * A class representing a physics distance joint
  106813. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106814. */
  106815. export class DistanceJoint extends PhysicsJoint {
  106816. /**
  106817. *
  106818. * @param jointData The data for the Distance-Joint
  106819. */
  106820. constructor(jointData: DistanceJointData);
  106821. /**
  106822. * Update the predefined distance.
  106823. * @param maxDistance The maximum preferred distance
  106824. * @param minDistance The minimum preferred distance
  106825. */
  106826. updateDistance(maxDistance: number, minDistance?: number): void;
  106827. }
  106828. /**
  106829. * Represents a Motor-Enabled Joint
  106830. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106831. */
  106832. export class MotorEnabledJoint extends PhysicsJoint implements IMotorEnabledJoint {
  106833. /**
  106834. * Initializes the Motor-Enabled Joint
  106835. * @param type The type of the joint
  106836. * @param jointData The physica joint data for the joint
  106837. */
  106838. constructor(type: number, jointData: PhysicsJointData);
  106839. /**
  106840. * Set the motor values.
  106841. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106842. * @param force the force to apply
  106843. * @param maxForce max force for this motor.
  106844. */
  106845. setMotor(force?: number, maxForce?: number): void;
  106846. /**
  106847. * Set the motor's limits.
  106848. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106849. * @param upperLimit The upper limit of the motor
  106850. * @param lowerLimit The lower limit of the motor
  106851. */
  106852. setLimit(upperLimit: number, lowerLimit?: number): void;
  106853. }
  106854. /**
  106855. * This class represents a single physics Hinge-Joint
  106856. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106857. */
  106858. export class HingeJoint extends MotorEnabledJoint {
  106859. /**
  106860. * Initializes the Hinge-Joint
  106861. * @param jointData The joint data for the Hinge-Joint
  106862. */
  106863. constructor(jointData: PhysicsJointData);
  106864. /**
  106865. * Set the motor values.
  106866. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106867. * @param {number} force the force to apply
  106868. * @param {number} maxForce max force for this motor.
  106869. */
  106870. setMotor(force?: number, maxForce?: number): void;
  106871. /**
  106872. * Set the motor's limits.
  106873. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106874. * @param upperLimit The upper limit of the motor
  106875. * @param lowerLimit The lower limit of the motor
  106876. */
  106877. setLimit(upperLimit: number, lowerLimit?: number): void;
  106878. }
  106879. /**
  106880. * This class represents a dual hinge physics joint (same as wheel joint)
  106881. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106882. */
  106883. export class Hinge2Joint extends MotorEnabledJoint {
  106884. /**
  106885. * Initializes the Hinge2-Joint
  106886. * @param jointData The joint data for the Hinge2-Joint
  106887. */
  106888. constructor(jointData: PhysicsJointData);
  106889. /**
  106890. * Set the motor values.
  106891. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106892. * @param {number} targetSpeed the speed the motor is to reach
  106893. * @param {number} maxForce max force for this motor.
  106894. * @param {motorIndex} the motor's index, 0 or 1.
  106895. */
  106896. setMotor(targetSpeed?: number, maxForce?: number, motorIndex?: number): void;
  106897. /**
  106898. * Set the motor limits.
  106899. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106900. * @param {number} upperLimit the upper limit
  106901. * @param {number} lowerLimit lower limit
  106902. * @param {motorIndex} the motor's index, 0 or 1.
  106903. */
  106904. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  106905. }
  106906. /**
  106907. * Interface for a motor enabled joint
  106908. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106909. */
  106910. export interface IMotorEnabledJoint {
  106911. /**
  106912. * Physics joint
  106913. */
  106914. physicsJoint: any;
  106915. /**
  106916. * Sets the motor of the motor-enabled joint
  106917. * @param force The force of the motor
  106918. * @param maxForce The maximum force of the motor
  106919. * @param motorIndex The index of the motor
  106920. */
  106921. setMotor(force?: number, maxForce?: number, motorIndex?: number): void;
  106922. /**
  106923. * Sets the limit of the motor
  106924. * @param upperLimit The upper limit of the motor
  106925. * @param lowerLimit The lower limit of the motor
  106926. * @param motorIndex The index of the motor
  106927. */
  106928. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  106929. }
  106930. /**
  106931. * Joint data for a Distance-Joint
  106932. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106933. */
  106934. export interface DistanceJointData extends PhysicsJointData {
  106935. /**
  106936. * Max distance the 2 joint objects can be apart
  106937. */
  106938. maxDistance: number;
  106939. }
  106940. /**
  106941. * Joint data from a spring joint
  106942. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106943. */
  106944. export interface SpringJointData extends PhysicsJointData {
  106945. /**
  106946. * Length of the spring
  106947. */
  106948. length: number;
  106949. /**
  106950. * Stiffness of the spring
  106951. */
  106952. stiffness: number;
  106953. /**
  106954. * Damping of the spring
  106955. */
  106956. damping: number;
  106957. /** this callback will be called when applying the force to the impostors. */
  106958. forceApplicationCallback: () => void;
  106959. }
  106960. }
  106961. declare module BABYLON {
  106962. /**
  106963. * Holds the data for the raycast result
  106964. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106965. */
  106966. export class PhysicsRaycastResult {
  106967. private _hasHit;
  106968. private _hitDistance;
  106969. private _hitNormalWorld;
  106970. private _hitPointWorld;
  106971. private _rayFromWorld;
  106972. private _rayToWorld;
  106973. /**
  106974. * Gets if there was a hit
  106975. */
  106976. get hasHit(): boolean;
  106977. /**
  106978. * Gets the distance from the hit
  106979. */
  106980. get hitDistance(): number;
  106981. /**
  106982. * Gets the hit normal/direction in the world
  106983. */
  106984. get hitNormalWorld(): Vector3;
  106985. /**
  106986. * Gets the hit point in the world
  106987. */
  106988. get hitPointWorld(): Vector3;
  106989. /**
  106990. * Gets the ray "start point" of the ray in the world
  106991. */
  106992. get rayFromWorld(): Vector3;
  106993. /**
  106994. * Gets the ray "end point" of the ray in the world
  106995. */
  106996. get rayToWorld(): Vector3;
  106997. /**
  106998. * Sets the hit data (normal & point in world space)
  106999. * @param hitNormalWorld defines the normal in world space
  107000. * @param hitPointWorld defines the point in world space
  107001. */
  107002. setHitData(hitNormalWorld: IXYZ, hitPointWorld: IXYZ): void;
  107003. /**
  107004. * Sets the distance from the start point to the hit point
  107005. * @param distance
  107006. */
  107007. setHitDistance(distance: number): void;
  107008. /**
  107009. * Calculates the distance manually
  107010. */
  107011. calculateHitDistance(): void;
  107012. /**
  107013. * Resets all the values to default
  107014. * @param from The from point on world space
  107015. * @param to The to point on world space
  107016. */
  107017. reset(from?: Vector3, to?: Vector3): void;
  107018. }
  107019. /**
  107020. * Interface for the size containing width and height
  107021. */
  107022. interface IXYZ {
  107023. /**
  107024. * X
  107025. */
  107026. x: number;
  107027. /**
  107028. * Y
  107029. */
  107030. y: number;
  107031. /**
  107032. * Z
  107033. */
  107034. z: number;
  107035. }
  107036. }
  107037. declare module BABYLON {
  107038. /**
  107039. * Interface used to describe a physics joint
  107040. */
  107041. export interface PhysicsImpostorJoint {
  107042. /** Defines the main impostor to which the joint is linked */
  107043. mainImpostor: PhysicsImpostor;
  107044. /** Defines the impostor that is connected to the main impostor using this joint */
  107045. connectedImpostor: PhysicsImpostor;
  107046. /** Defines the joint itself */
  107047. joint: PhysicsJoint;
  107048. }
  107049. /** @hidden */
  107050. export interface IPhysicsEnginePlugin {
  107051. world: any;
  107052. name: string;
  107053. setGravity(gravity: Vector3): void;
  107054. setTimeStep(timeStep: number): void;
  107055. getTimeStep(): number;
  107056. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  107057. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  107058. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  107059. generatePhysicsBody(impostor: PhysicsImpostor): void;
  107060. removePhysicsBody(impostor: PhysicsImpostor): void;
  107061. generateJoint(joint: PhysicsImpostorJoint): void;
  107062. removeJoint(joint: PhysicsImpostorJoint): void;
  107063. isSupported(): boolean;
  107064. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  107065. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  107066. setLinearVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  107067. setAngularVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  107068. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  107069. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  107070. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  107071. getBodyMass(impostor: PhysicsImpostor): number;
  107072. getBodyFriction(impostor: PhysicsImpostor): number;
  107073. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  107074. getBodyRestitution(impostor: PhysicsImpostor): number;
  107075. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  107076. getBodyPressure?(impostor: PhysicsImpostor): number;
  107077. setBodyPressure?(impostor: PhysicsImpostor, pressure: number): void;
  107078. getBodyStiffness?(impostor: PhysicsImpostor): number;
  107079. setBodyStiffness?(impostor: PhysicsImpostor, stiffness: number): void;
  107080. getBodyVelocityIterations?(impostor: PhysicsImpostor): number;
  107081. setBodyVelocityIterations?(impostor: PhysicsImpostor, velocityIterations: number): void;
  107082. getBodyPositionIterations?(impostor: PhysicsImpostor): number;
  107083. setBodyPositionIterations?(impostor: PhysicsImpostor, positionIterations: number): void;
  107084. appendAnchor?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  107085. appendHook?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  107086. sleepBody(impostor: PhysicsImpostor): void;
  107087. wakeUpBody(impostor: PhysicsImpostor): void;
  107088. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  107089. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  107090. setMotor(joint: IMotorEnabledJoint, speed: number, maxForce?: number, motorIndex?: number): void;
  107091. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  107092. getRadius(impostor: PhysicsImpostor): number;
  107093. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  107094. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  107095. dispose(): void;
  107096. }
  107097. /**
  107098. * Interface used to define a physics engine
  107099. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  107100. */
  107101. export interface IPhysicsEngine {
  107102. /**
  107103. * Gets the gravity vector used by the simulation
  107104. */
  107105. gravity: Vector3;
  107106. /**
  107107. * Sets the gravity vector used by the simulation
  107108. * @param gravity defines the gravity vector to use
  107109. */
  107110. setGravity(gravity: Vector3): void;
  107111. /**
  107112. * Set the time step of the physics engine.
  107113. * Default is 1/60.
  107114. * To slow it down, enter 1/600 for example.
  107115. * To speed it up, 1/30
  107116. * @param newTimeStep the new timestep to apply to this world.
  107117. */
  107118. setTimeStep(newTimeStep: number): void;
  107119. /**
  107120. * Get the time step of the physics engine.
  107121. * @returns the current time step
  107122. */
  107123. getTimeStep(): number;
  107124. /**
  107125. * Set the sub time step of the physics engine.
  107126. * Default is 0 meaning there is no sub steps
  107127. * To increase physics resolution precision, set a small value (like 1 ms)
  107128. * @param subTimeStep defines the new sub timestep used for physics resolution.
  107129. */
  107130. setSubTimeStep(subTimeStep: number): void;
  107131. /**
  107132. * Get the sub time step of the physics engine.
  107133. * @returns the current sub time step
  107134. */
  107135. getSubTimeStep(): number;
  107136. /**
  107137. * Release all resources
  107138. */
  107139. dispose(): void;
  107140. /**
  107141. * Gets the name of the current physics plugin
  107142. * @returns the name of the plugin
  107143. */
  107144. getPhysicsPluginName(): string;
  107145. /**
  107146. * Adding a new impostor for the impostor tracking.
  107147. * This will be done by the impostor itself.
  107148. * @param impostor the impostor to add
  107149. */
  107150. addImpostor(impostor: PhysicsImpostor): void;
  107151. /**
  107152. * Remove an impostor from the engine.
  107153. * This impostor and its mesh will not longer be updated by the physics engine.
  107154. * @param impostor the impostor to remove
  107155. */
  107156. removeImpostor(impostor: PhysicsImpostor): void;
  107157. /**
  107158. * Add a joint to the physics engine
  107159. * @param mainImpostor defines the main impostor to which the joint is added.
  107160. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  107161. * @param joint defines the joint that will connect both impostors.
  107162. */
  107163. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  107164. /**
  107165. * Removes a joint from the simulation
  107166. * @param mainImpostor defines the impostor used with the joint
  107167. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  107168. * @param joint defines the joint to remove
  107169. */
  107170. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  107171. /**
  107172. * Gets the current plugin used to run the simulation
  107173. * @returns current plugin
  107174. */
  107175. getPhysicsPlugin(): IPhysicsEnginePlugin;
  107176. /**
  107177. * Gets the list of physic impostors
  107178. * @returns an array of PhysicsImpostor
  107179. */
  107180. getImpostors(): Array<PhysicsImpostor>;
  107181. /**
  107182. * Gets the impostor for a physics enabled object
  107183. * @param object defines the object impersonated by the impostor
  107184. * @returns the PhysicsImpostor or null if not found
  107185. */
  107186. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  107187. /**
  107188. * Gets the impostor for a physics body object
  107189. * @param body defines physics body used by the impostor
  107190. * @returns the PhysicsImpostor or null if not found
  107191. */
  107192. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  107193. /**
  107194. * Does a raycast in the physics world
  107195. * @param from when should the ray start?
  107196. * @param to when should the ray end?
  107197. * @returns PhysicsRaycastResult
  107198. */
  107199. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  107200. /**
  107201. * Called by the scene. No need to call it.
  107202. * @param delta defines the timespam between frames
  107203. */
  107204. _step(delta: number): void;
  107205. }
  107206. }
  107207. declare module BABYLON {
  107208. /**
  107209. * The interface for the physics imposter parameters
  107210. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  107211. */
  107212. export interface PhysicsImpostorParameters {
  107213. /**
  107214. * The mass of the physics imposter
  107215. */
  107216. mass: number;
  107217. /**
  107218. * The friction of the physics imposter
  107219. */
  107220. friction?: number;
  107221. /**
  107222. * The coefficient of restitution of the physics imposter
  107223. */
  107224. restitution?: number;
  107225. /**
  107226. * The native options of the physics imposter
  107227. */
  107228. nativeOptions?: any;
  107229. /**
  107230. * Specifies if the parent should be ignored
  107231. */
  107232. ignoreParent?: boolean;
  107233. /**
  107234. * Specifies if bi-directional transformations should be disabled
  107235. */
  107236. disableBidirectionalTransformation?: boolean;
  107237. /**
  107238. * The pressure inside the physics imposter, soft object only
  107239. */
  107240. pressure?: number;
  107241. /**
  107242. * The stiffness the physics imposter, soft object only
  107243. */
  107244. stiffness?: number;
  107245. /**
  107246. * The number of iterations used in maintaining consistent vertex velocities, soft object only
  107247. */
  107248. velocityIterations?: number;
  107249. /**
  107250. * The number of iterations used in maintaining consistent vertex positions, soft object only
  107251. */
  107252. positionIterations?: number;
  107253. /**
  107254. * The number used to fix points on a cloth (0, 1, 2, 4, 8) or rope (0, 1, 2) only
  107255. * 0 None, 1, back left or top, 2, back right or bottom, 4, front left, 8, front right
  107256. * Add to fix multiple points
  107257. */
  107258. fixedPoints?: number;
  107259. /**
  107260. * The collision margin around a soft object
  107261. */
  107262. margin?: number;
  107263. /**
  107264. * The collision margin around a soft object
  107265. */
  107266. damping?: number;
  107267. /**
  107268. * The path for a rope based on an extrusion
  107269. */
  107270. path?: any;
  107271. /**
  107272. * The shape of an extrusion used for a rope based on an extrusion
  107273. */
  107274. shape?: any;
  107275. }
  107276. /**
  107277. * Interface for a physics-enabled object
  107278. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  107279. */
  107280. export interface IPhysicsEnabledObject {
  107281. /**
  107282. * The position of the physics-enabled object
  107283. */
  107284. position: Vector3;
  107285. /**
  107286. * The rotation of the physics-enabled object
  107287. */
  107288. rotationQuaternion: Nullable<Quaternion>;
  107289. /**
  107290. * The scale of the physics-enabled object
  107291. */
  107292. scaling: Vector3;
  107293. /**
  107294. * The rotation of the physics-enabled object
  107295. */
  107296. rotation?: Vector3;
  107297. /**
  107298. * The parent of the physics-enabled object
  107299. */
  107300. parent?: any;
  107301. /**
  107302. * The bounding info of the physics-enabled object
  107303. * @returns The bounding info of the physics-enabled object
  107304. */
  107305. getBoundingInfo(): BoundingInfo;
  107306. /**
  107307. * Computes the world matrix
  107308. * @param force Specifies if the world matrix should be computed by force
  107309. * @returns A world matrix
  107310. */
  107311. computeWorldMatrix(force: boolean): Matrix;
  107312. /**
  107313. * Gets the world matrix
  107314. * @returns A world matrix
  107315. */
  107316. getWorldMatrix?(): Matrix;
  107317. /**
  107318. * Gets the child meshes
  107319. * @param directDescendantsOnly Specifies if only direct-descendants should be obtained
  107320. * @returns An array of abstract meshes
  107321. */
  107322. getChildMeshes?(directDescendantsOnly?: boolean): Array<AbstractMesh>;
  107323. /**
  107324. * Gets the vertex data
  107325. * @param kind The type of vertex data
  107326. * @returns A nullable array of numbers, or a float32 array
  107327. */
  107328. getVerticesData(kind: string): Nullable<Array<number> | Float32Array>;
  107329. /**
  107330. * Gets the indices from the mesh
  107331. * @returns A nullable array of index arrays
  107332. */
  107333. getIndices?(): Nullable<IndicesArray>;
  107334. /**
  107335. * Gets the scene from the mesh
  107336. * @returns the indices array or null
  107337. */
  107338. getScene?(): Scene;
  107339. /**
  107340. * Gets the absolute position from the mesh
  107341. * @returns the absolute position
  107342. */
  107343. getAbsolutePosition(): Vector3;
  107344. /**
  107345. * Gets the absolute pivot point from the mesh
  107346. * @returns the absolute pivot point
  107347. */
  107348. getAbsolutePivotPoint(): Vector3;
  107349. /**
  107350. * Rotates the mesh
  107351. * @param axis The axis of rotation
  107352. * @param amount The amount of rotation
  107353. * @param space The space of the rotation
  107354. * @returns The rotation transform node
  107355. */
  107356. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  107357. /**
  107358. * Translates the mesh
  107359. * @param axis The axis of translation
  107360. * @param distance The distance of translation
  107361. * @param space The space of the translation
  107362. * @returns The transform node
  107363. */
  107364. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  107365. /**
  107366. * Sets the absolute position of the mesh
  107367. * @param absolutePosition The absolute position of the mesh
  107368. * @returns The transform node
  107369. */
  107370. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  107371. /**
  107372. * Gets the class name of the mesh
  107373. * @returns The class name
  107374. */
  107375. getClassName(): string;
  107376. }
  107377. /**
  107378. * Represents a physics imposter
  107379. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  107380. */
  107381. export class PhysicsImpostor {
  107382. /**
  107383. * The physics-enabled object used as the physics imposter
  107384. */
  107385. object: IPhysicsEnabledObject;
  107386. /**
  107387. * The type of the physics imposter
  107388. */
  107389. type: number;
  107390. private _options;
  107391. private _scene?;
  107392. /**
  107393. * The default object size of the imposter
  107394. */
  107395. static DEFAULT_OBJECT_SIZE: Vector3;
  107396. /**
  107397. * The identity quaternion of the imposter
  107398. */
  107399. static IDENTITY_QUATERNION: Quaternion;
  107400. /** @hidden */
  107401. _pluginData: any;
  107402. private _physicsEngine;
  107403. private _physicsBody;
  107404. private _bodyUpdateRequired;
  107405. private _onBeforePhysicsStepCallbacks;
  107406. private _onAfterPhysicsStepCallbacks;
  107407. /** @hidden */
  107408. _onPhysicsCollideCallbacks: Array<{
  107409. callback: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void;
  107410. otherImpostors: Array<PhysicsImpostor>;
  107411. }>;
  107412. private _deltaPosition;
  107413. private _deltaRotation;
  107414. private _deltaRotationConjugated;
  107415. /** @hidden */
  107416. _isFromLine: boolean;
  107417. private _parent;
  107418. private _isDisposed;
  107419. private static _tmpVecs;
  107420. private static _tmpQuat;
  107421. /**
  107422. * Specifies if the physics imposter is disposed
  107423. */
  107424. get isDisposed(): boolean;
  107425. /**
  107426. * Gets the mass of the physics imposter
  107427. */
  107428. get mass(): number;
  107429. set mass(value: number);
  107430. /**
  107431. * Gets the coefficient of friction
  107432. */
  107433. get friction(): number;
  107434. /**
  107435. * Sets the coefficient of friction
  107436. */
  107437. set friction(value: number);
  107438. /**
  107439. * Gets the coefficient of restitution
  107440. */
  107441. get restitution(): number;
  107442. /**
  107443. * Sets the coefficient of restitution
  107444. */
  107445. set restitution(value: number);
  107446. /**
  107447. * Gets the pressure of a soft body; only supported by the AmmoJSPlugin
  107448. */
  107449. get pressure(): number;
  107450. /**
  107451. * Sets the pressure of a soft body; only supported by the AmmoJSPlugin
  107452. */
  107453. set pressure(value: number);
  107454. /**
  107455. * Gets the stiffness of a soft body; only supported by the AmmoJSPlugin
  107456. */
  107457. get stiffness(): number;
  107458. /**
  107459. * Sets the stiffness of a soft body; only supported by the AmmoJSPlugin
  107460. */
  107461. set stiffness(value: number);
  107462. /**
  107463. * Gets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  107464. */
  107465. get velocityIterations(): number;
  107466. /**
  107467. * Sets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  107468. */
  107469. set velocityIterations(value: number);
  107470. /**
  107471. * Gets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  107472. */
  107473. get positionIterations(): number;
  107474. /**
  107475. * Sets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  107476. */
  107477. set positionIterations(value: number);
  107478. /**
  107479. * The unique id of the physics imposter
  107480. * set by the physics engine when adding this impostor to the array
  107481. */
  107482. uniqueId: number;
  107483. /**
  107484. * @hidden
  107485. */
  107486. soft: boolean;
  107487. /**
  107488. * @hidden
  107489. */
  107490. segments: number;
  107491. private _joints;
  107492. /**
  107493. * Initializes the physics imposter
  107494. * @param object The physics-enabled object used as the physics imposter
  107495. * @param type The type of the physics imposter
  107496. * @param _options The options for the physics imposter
  107497. * @param _scene The Babylon scene
  107498. */
  107499. constructor(
  107500. /**
  107501. * The physics-enabled object used as the physics imposter
  107502. */
  107503. object: IPhysicsEnabledObject,
  107504. /**
  107505. * The type of the physics imposter
  107506. */
  107507. type: number, _options?: PhysicsImpostorParameters, _scene?: Scene | undefined);
  107508. /**
  107509. * This function will completly initialize this impostor.
  107510. * It will create a new body - but only if this mesh has no parent.
  107511. * If it has, this impostor will not be used other than to define the impostor
  107512. * of the child mesh.
  107513. * @hidden
  107514. */
  107515. _init(): void;
  107516. private _getPhysicsParent;
  107517. /**
  107518. * Should a new body be generated.
  107519. * @returns boolean specifying if body initialization is required
  107520. */
  107521. isBodyInitRequired(): boolean;
  107522. /**
  107523. * Sets the updated scaling
  107524. * @param updated Specifies if the scaling is updated
  107525. */
  107526. setScalingUpdated(): void;
  107527. /**
  107528. * Force a regeneration of this or the parent's impostor's body.
  107529. * Use under cautious - This will remove all joints already implemented.
  107530. */
  107531. forceUpdate(): void;
  107532. /**
  107533. * Gets the body that holds this impostor. Either its own, or its parent.
  107534. */
  107535. get physicsBody(): any;
  107536. /**
  107537. * Get the parent of the physics imposter
  107538. * @returns Physics imposter or null
  107539. */
  107540. get parent(): Nullable<PhysicsImpostor>;
  107541. /**
  107542. * Sets the parent of the physics imposter
  107543. */
  107544. set parent(value: Nullable<PhysicsImpostor>);
  107545. /**
  107546. * Set the physics body. Used mainly by the physics engine/plugin
  107547. */
  107548. set physicsBody(physicsBody: any);
  107549. /**
  107550. * Resets the update flags
  107551. */
  107552. resetUpdateFlags(): void;
  107553. /**
  107554. * Gets the object extend size
  107555. * @returns the object extend size
  107556. */
  107557. getObjectExtendSize(): Vector3;
  107558. /**
  107559. * Gets the object center
  107560. * @returns The object center
  107561. */
  107562. getObjectCenter(): Vector3;
  107563. /**
  107564. * Get a specific parameter from the options parameters
  107565. * @param paramName The object parameter name
  107566. * @returns The object parameter
  107567. */
  107568. getParam(paramName: string): any;
  107569. /**
  107570. * Sets a specific parameter in the options given to the physics plugin
  107571. * @param paramName The parameter name
  107572. * @param value The value of the parameter
  107573. */
  107574. setParam(paramName: string, value: number): void;
  107575. /**
  107576. * Specifically change the body's mass option. Won't recreate the physics body object
  107577. * @param mass The mass of the physics imposter
  107578. */
  107579. setMass(mass: number): void;
  107580. /**
  107581. * Gets the linear velocity
  107582. * @returns linear velocity or null
  107583. */
  107584. getLinearVelocity(): Nullable<Vector3>;
  107585. /**
  107586. * Sets the linear velocity
  107587. * @param velocity linear velocity or null
  107588. */
  107589. setLinearVelocity(velocity: Nullable<Vector3>): void;
  107590. /**
  107591. * Gets the angular velocity
  107592. * @returns angular velocity or null
  107593. */
  107594. getAngularVelocity(): Nullable<Vector3>;
  107595. /**
  107596. * Sets the angular velocity
  107597. * @param velocity The velocity or null
  107598. */
  107599. setAngularVelocity(velocity: Nullable<Vector3>): void;
  107600. /**
  107601. * Execute a function with the physics plugin native code
  107602. * Provide a function the will have two variables - the world object and the physics body object
  107603. * @param func The function to execute with the physics plugin native code
  107604. */
  107605. executeNativeFunction(func: (world: any, physicsBody: any) => void): void;
  107606. /**
  107607. * Register a function that will be executed before the physics world is stepping forward
  107608. * @param func The function to execute before the physics world is stepped forward
  107609. */
  107610. registerBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  107611. /**
  107612. * Unregister a function that will be executed before the physics world is stepping forward
  107613. * @param func The function to execute before the physics world is stepped forward
  107614. */
  107615. unregisterBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  107616. /**
  107617. * Register a function that will be executed after the physics step
  107618. * @param func The function to execute after physics step
  107619. */
  107620. registerAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  107621. /**
  107622. * Unregisters a function that will be executed after the physics step
  107623. * @param func The function to execute after physics step
  107624. */
  107625. unregisterAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  107626. /**
  107627. * register a function that will be executed when this impostor collides against a different body
  107628. * @param collideAgainst Physics imposter, or array of physics imposters to collide against
  107629. * @param func Callback that is executed on collision
  107630. */
  107631. registerOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void): void;
  107632. /**
  107633. * Unregisters the physics imposter on contact
  107634. * @param collideAgainst The physics object to collide against
  107635. * @param func Callback to execute on collision
  107636. */
  107637. unregisterOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor | Array<PhysicsImpostor>) => void): void;
  107638. private _tmpQuat;
  107639. private _tmpQuat2;
  107640. /**
  107641. * Get the parent rotation
  107642. * @returns The parent rotation
  107643. */
  107644. getParentsRotation(): Quaternion;
  107645. /**
  107646. * this function is executed by the physics engine.
  107647. */
  107648. beforeStep: () => void;
  107649. /**
  107650. * this function is executed by the physics engine
  107651. */
  107652. afterStep: () => void;
  107653. /**
  107654. * Legacy collision detection event support
  107655. */
  107656. onCollideEvent: Nullable<(collider: PhysicsImpostor, collidedWith: PhysicsImpostor) => void>;
  107657. /**
  107658. * event and body object due to cannon's event-based architecture.
  107659. */
  107660. onCollide: (e: {
  107661. body: any;
  107662. }) => void;
  107663. /**
  107664. * Apply a force
  107665. * @param force The force to apply
  107666. * @param contactPoint The contact point for the force
  107667. * @returns The physics imposter
  107668. */
  107669. applyForce(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  107670. /**
  107671. * Apply an impulse
  107672. * @param force The impulse force
  107673. * @param contactPoint The contact point for the impulse force
  107674. * @returns The physics imposter
  107675. */
  107676. applyImpulse(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  107677. /**
  107678. * A help function to create a joint
  107679. * @param otherImpostor A physics imposter used to create a joint
  107680. * @param jointType The type of joint
  107681. * @param jointData The data for the joint
  107682. * @returns The physics imposter
  107683. */
  107684. createJoint(otherImpostor: PhysicsImpostor, jointType: number, jointData: PhysicsJointData): PhysicsImpostor;
  107685. /**
  107686. * Add a joint to this impostor with a different impostor
  107687. * @param otherImpostor A physics imposter used to add a joint
  107688. * @param joint The joint to add
  107689. * @returns The physics imposter
  107690. */
  107691. addJoint(otherImpostor: PhysicsImpostor, joint: PhysicsJoint): PhysicsImpostor;
  107692. /**
  107693. * Add an anchor to a cloth impostor
  107694. * @param otherImpostor rigid impostor to anchor to
  107695. * @param width ratio across width from 0 to 1
  107696. * @param height ratio up height from 0 to 1
  107697. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  107698. * @param noCollisionBetweenLinkedBodies when true collisions between cloth impostor and anchor are ignored; default false
  107699. * @returns impostor the soft imposter
  107700. */
  107701. addAnchor(otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  107702. /**
  107703. * Add a hook to a rope impostor
  107704. * @param otherImpostor rigid impostor to anchor to
  107705. * @param length ratio across rope from 0 to 1
  107706. * @param influence the elasticity between rope impostor and anchor from 0, very stretchy to 1, little strech
  107707. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  107708. * @returns impostor the rope imposter
  107709. */
  107710. addHook(otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  107711. /**
  107712. * Will keep this body still, in a sleep mode.
  107713. * @returns the physics imposter
  107714. */
  107715. sleep(): PhysicsImpostor;
  107716. /**
  107717. * Wake the body up.
  107718. * @returns The physics imposter
  107719. */
  107720. wakeUp(): PhysicsImpostor;
  107721. /**
  107722. * Clones the physics imposter
  107723. * @param newObject The physics imposter clones to this physics-enabled object
  107724. * @returns A nullable physics imposter
  107725. */
  107726. clone(newObject: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  107727. /**
  107728. * Disposes the physics imposter
  107729. */
  107730. dispose(): void;
  107731. /**
  107732. * Sets the delta position
  107733. * @param position The delta position amount
  107734. */
  107735. setDeltaPosition(position: Vector3): void;
  107736. /**
  107737. * Sets the delta rotation
  107738. * @param rotation The delta rotation amount
  107739. */
  107740. setDeltaRotation(rotation: Quaternion): void;
  107741. /**
  107742. * Gets the box size of the physics imposter and stores the result in the input parameter
  107743. * @param result Stores the box size
  107744. * @returns The physics imposter
  107745. */
  107746. getBoxSizeToRef(result: Vector3): PhysicsImpostor;
  107747. /**
  107748. * Gets the radius of the physics imposter
  107749. * @returns Radius of the physics imposter
  107750. */
  107751. getRadius(): number;
  107752. /**
  107753. * Sync a bone with this impostor
  107754. * @param bone The bone to sync to the impostor.
  107755. * @param boneMesh The mesh that the bone is influencing.
  107756. * @param jointPivot The pivot of the joint / bone in local space.
  107757. * @param distToJoint Optional distance from the impostor to the joint.
  107758. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  107759. */
  107760. syncBoneWithImpostor(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion): void;
  107761. /**
  107762. * Sync impostor to a bone
  107763. * @param bone The bone that the impostor will be synced to.
  107764. * @param boneMesh The mesh that the bone is influencing.
  107765. * @param jointPivot The pivot of the joint / bone in local space.
  107766. * @param distToJoint Optional distance from the impostor to the joint.
  107767. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  107768. * @param boneAxis Optional vector3 axis the bone is aligned with
  107769. */
  107770. syncImpostorWithBone(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion, boneAxis?: Vector3): void;
  107771. /**
  107772. * No-Imposter type
  107773. */
  107774. static NoImpostor: number;
  107775. /**
  107776. * Sphere-Imposter type
  107777. */
  107778. static SphereImpostor: number;
  107779. /**
  107780. * Box-Imposter type
  107781. */
  107782. static BoxImpostor: number;
  107783. /**
  107784. * Plane-Imposter type
  107785. */
  107786. static PlaneImpostor: number;
  107787. /**
  107788. * Mesh-imposter type
  107789. */
  107790. static MeshImpostor: number;
  107791. /**
  107792. * Capsule-Impostor type (Ammo.js plugin only)
  107793. */
  107794. static CapsuleImpostor: number;
  107795. /**
  107796. * Cylinder-Imposter type
  107797. */
  107798. static CylinderImpostor: number;
  107799. /**
  107800. * Particle-Imposter type
  107801. */
  107802. static ParticleImpostor: number;
  107803. /**
  107804. * Heightmap-Imposter type
  107805. */
  107806. static HeightmapImpostor: number;
  107807. /**
  107808. * ConvexHull-Impostor type (Ammo.js plugin only)
  107809. */
  107810. static ConvexHullImpostor: number;
  107811. /**
  107812. * Custom-Imposter type (Ammo.js plugin only)
  107813. */
  107814. static CustomImpostor: number;
  107815. /**
  107816. * Rope-Imposter type
  107817. */
  107818. static RopeImpostor: number;
  107819. /**
  107820. * Cloth-Imposter type
  107821. */
  107822. static ClothImpostor: number;
  107823. /**
  107824. * Softbody-Imposter type
  107825. */
  107826. static SoftbodyImpostor: number;
  107827. }
  107828. }
  107829. declare module BABYLON {
  107830. /**
  107831. * @hidden
  107832. **/
  107833. export class _CreationDataStorage {
  107834. closePath?: boolean;
  107835. closeArray?: boolean;
  107836. idx: number[];
  107837. dashSize: number;
  107838. gapSize: number;
  107839. path3D: Path3D;
  107840. pathArray: Vector3[][];
  107841. arc: number;
  107842. radius: number;
  107843. cap: number;
  107844. tessellation: number;
  107845. }
  107846. /**
  107847. * @hidden
  107848. **/
  107849. class _InstanceDataStorage {
  107850. visibleInstances: any;
  107851. batchCache: _InstancesBatch;
  107852. instancesBufferSize: number;
  107853. instancesBuffer: Nullable<Buffer>;
  107854. instancesData: Float32Array;
  107855. overridenInstanceCount: number;
  107856. isFrozen: boolean;
  107857. previousBatch: Nullable<_InstancesBatch>;
  107858. hardwareInstancedRendering: boolean;
  107859. sideOrientation: number;
  107860. manualUpdate: boolean;
  107861. }
  107862. /**
  107863. * @hidden
  107864. **/
  107865. export class _InstancesBatch {
  107866. mustReturn: boolean;
  107867. visibleInstances: Nullable<InstancedMesh[]>[];
  107868. renderSelf: boolean[];
  107869. hardwareInstancedRendering: boolean[];
  107870. }
  107871. /**
  107872. * @hidden
  107873. **/
  107874. class _ThinInstanceDataStorage {
  107875. instancesCount: number;
  107876. matrixBuffer: Nullable<Buffer>;
  107877. matrixBufferSize: number;
  107878. matrixData: Nullable<Float32Array>;
  107879. boundingVectors: Array<Vector3>;
  107880. worldMatrices: Nullable<Matrix[]>;
  107881. }
  107882. /**
  107883. * Class used to represent renderable models
  107884. */
  107885. export class Mesh extends AbstractMesh implements IGetSetVerticesData {
  107886. /**
  107887. * Mesh side orientation : usually the external or front surface
  107888. */
  107889. static readonly FRONTSIDE: number;
  107890. /**
  107891. * Mesh side orientation : usually the internal or back surface
  107892. */
  107893. static readonly BACKSIDE: number;
  107894. /**
  107895. * Mesh side orientation : both internal and external or front and back surfaces
  107896. */
  107897. static readonly DOUBLESIDE: number;
  107898. /**
  107899. * Mesh side orientation : by default, `FRONTSIDE`
  107900. */
  107901. static readonly DEFAULTSIDE: number;
  107902. /**
  107903. * Mesh cap setting : no cap
  107904. */
  107905. static readonly NO_CAP: number;
  107906. /**
  107907. * Mesh cap setting : one cap at the beginning of the mesh
  107908. */
  107909. static readonly CAP_START: number;
  107910. /**
  107911. * Mesh cap setting : one cap at the end of the mesh
  107912. */
  107913. static readonly CAP_END: number;
  107914. /**
  107915. * Mesh cap setting : two caps, one at the beginning and one at the end of the mesh
  107916. */
  107917. static readonly CAP_ALL: number;
  107918. /**
  107919. * Mesh pattern setting : no flip or rotate
  107920. */
  107921. static readonly NO_FLIP: number;
  107922. /**
  107923. * Mesh pattern setting : flip (reflect in y axis) alternate tiles on each row or column
  107924. */
  107925. static readonly FLIP_TILE: number;
  107926. /**
  107927. * Mesh pattern setting : rotate (180degs) alternate tiles on each row or column
  107928. */
  107929. static readonly ROTATE_TILE: number;
  107930. /**
  107931. * Mesh pattern setting : flip (reflect in y axis) all tiles on alternate rows
  107932. */
  107933. static readonly FLIP_ROW: number;
  107934. /**
  107935. * Mesh pattern setting : rotate (180degs) all tiles on alternate rows
  107936. */
  107937. static readonly ROTATE_ROW: number;
  107938. /**
  107939. * Mesh pattern setting : flip and rotate alternate tiles on each row or column
  107940. */
  107941. static readonly FLIP_N_ROTATE_TILE: number;
  107942. /**
  107943. * Mesh pattern setting : rotate pattern and rotate
  107944. */
  107945. static readonly FLIP_N_ROTATE_ROW: number;
  107946. /**
  107947. * Mesh tile positioning : part tiles same on left/right or top/bottom
  107948. */
  107949. static readonly CENTER: number;
  107950. /**
  107951. * Mesh tile positioning : part tiles on left
  107952. */
  107953. static readonly LEFT: number;
  107954. /**
  107955. * Mesh tile positioning : part tiles on right
  107956. */
  107957. static readonly RIGHT: number;
  107958. /**
  107959. * Mesh tile positioning : part tiles on top
  107960. */
  107961. static readonly TOP: number;
  107962. /**
  107963. * Mesh tile positioning : part tiles on bottom
  107964. */
  107965. static readonly BOTTOM: number;
  107966. /**
  107967. * Gets the default side orientation.
  107968. * @param orientation the orientation to value to attempt to get
  107969. * @returns the default orientation
  107970. * @hidden
  107971. */
  107972. static _GetDefaultSideOrientation(orientation?: number): number;
  107973. private _internalMeshDataInfo;
  107974. get computeBonesUsingShaders(): boolean;
  107975. set computeBonesUsingShaders(value: boolean);
  107976. /**
  107977. * An event triggered before rendering the mesh
  107978. */
  107979. get onBeforeRenderObservable(): Observable<Mesh>;
  107980. /**
  107981. * An event triggered before binding the mesh
  107982. */
  107983. get onBeforeBindObservable(): Observable<Mesh>;
  107984. /**
  107985. * An event triggered after rendering the mesh
  107986. */
  107987. get onAfterRenderObservable(): Observable<Mesh>;
  107988. /**
  107989. * An event triggered before drawing the mesh
  107990. */
  107991. get onBeforeDrawObservable(): Observable<Mesh>;
  107992. private _onBeforeDrawObserver;
  107993. /**
  107994. * Sets a callback to call before drawing the mesh. It is recommended to use onBeforeDrawObservable instead
  107995. */
  107996. set onBeforeDraw(callback: () => void);
  107997. get hasInstances(): boolean;
  107998. get hasThinInstances(): boolean;
  107999. /**
  108000. * Gets the delay loading state of the mesh (when delay loading is turned on)
  108001. * @see https://doc.babylonjs.com/how_to/using_the_incremental_loading_system
  108002. */
  108003. delayLoadState: number;
  108004. /**
  108005. * Gets the list of instances created from this mesh
  108006. * it is not supposed to be modified manually.
  108007. * Note also that the order of the InstancedMesh wihin the array is not significant and might change.
  108008. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  108009. */
  108010. instances: InstancedMesh[];
  108011. /**
  108012. * Gets the file containing delay loading data for this mesh
  108013. */
  108014. delayLoadingFile: string;
  108015. /** @hidden */
  108016. _binaryInfo: any;
  108017. /**
  108018. * User defined function used to change how LOD level selection is done
  108019. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  108020. */
  108021. onLODLevelSelection: (distance: number, mesh: Mesh, selectedLevel: Nullable<Mesh>) => void;
  108022. /**
  108023. * Gets or sets the morph target manager
  108024. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  108025. */
  108026. get morphTargetManager(): Nullable<MorphTargetManager>;
  108027. set morphTargetManager(value: Nullable<MorphTargetManager>);
  108028. /** @hidden */
  108029. _creationDataStorage: Nullable<_CreationDataStorage>;
  108030. /** @hidden */
  108031. _geometry: Nullable<Geometry>;
  108032. /** @hidden */
  108033. _delayInfo: Array<string>;
  108034. /** @hidden */
  108035. _delayLoadingFunction: (any: any, mesh: Mesh) => void;
  108036. /** @hidden */
  108037. _instanceDataStorage: _InstanceDataStorage;
  108038. /** @hidden */
  108039. _thinInstanceDataStorage: _ThinInstanceDataStorage;
  108040. private _effectiveMaterial;
  108041. /** @hidden */
  108042. _shouldGenerateFlatShading: boolean;
  108043. /** @hidden */
  108044. _originalBuilderSideOrientation: number;
  108045. /**
  108046. * Use this property to change the original side orientation defined at construction time
  108047. */
  108048. overrideMaterialSideOrientation: Nullable<number>;
  108049. /**
  108050. * Gets the source mesh (the one used to clone this one from)
  108051. */
  108052. get source(): Nullable<Mesh>;
  108053. /**
  108054. * Gets the list of clones of this mesh
  108055. * The scene must have been constructed with useClonedMeshMap=true for this to work!
  108056. * Note that useClonedMeshMap=true is the default setting
  108057. */
  108058. get cloneMeshMap(): Nullable<{
  108059. [id: string]: Mesh | undefined;
  108060. }>;
  108061. /**
  108062. * Gets or sets a boolean indicating that this mesh does not use index buffer
  108063. */
  108064. get isUnIndexed(): boolean;
  108065. set isUnIndexed(value: boolean);
  108066. /** Gets the array buffer used to store the instanced buffer used for instances' world matrices */
  108067. get worldMatrixInstancedBuffer(): Float32Array;
  108068. /** Gets or sets a boolean indicating that the update of the instance buffer of the world matrices is manual */
  108069. get manualUpdateOfWorldMatrixInstancedBuffer(): boolean;
  108070. set manualUpdateOfWorldMatrixInstancedBuffer(value: boolean);
  108071. /**
  108072. * @constructor
  108073. * @param name The value used by scene.getMeshByName() to do a lookup.
  108074. * @param scene The scene to add this mesh to.
  108075. * @param parent The parent of this mesh, if it has one
  108076. * @param source An optional Mesh from which geometry is shared, cloned.
  108077. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  108078. * When false, achieved by calling a clone(), also passing False.
  108079. * This will make creation of children, recursive.
  108080. * @param clonePhysicsImpostor When cloning, include cloning mesh physics impostor, default True.
  108081. */
  108082. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<Mesh>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean);
  108083. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  108084. doNotInstantiate: boolean;
  108085. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  108086. /**
  108087. * Gets the class name
  108088. * @returns the string "Mesh".
  108089. */
  108090. getClassName(): string;
  108091. /** @hidden */
  108092. get _isMesh(): boolean;
  108093. /**
  108094. * Returns a description of this mesh
  108095. * @param fullDetails define if full details about this mesh must be used
  108096. * @returns a descriptive string representing this mesh
  108097. */
  108098. toString(fullDetails?: boolean): string;
  108099. /** @hidden */
  108100. _unBindEffect(): void;
  108101. /**
  108102. * Gets a boolean indicating if this mesh has LOD
  108103. */
  108104. get hasLODLevels(): boolean;
  108105. /**
  108106. * Gets the list of MeshLODLevel associated with the current mesh
  108107. * @returns an array of MeshLODLevel
  108108. */
  108109. getLODLevels(): MeshLODLevel[];
  108110. private _sortLODLevels;
  108111. /**
  108112. * Add a mesh as LOD level triggered at the given distance.
  108113. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  108114. * @param distance The distance from the center of the object to show this level
  108115. * @param mesh The mesh to be added as LOD level (can be null)
  108116. * @return This mesh (for chaining)
  108117. */
  108118. addLODLevel(distance: number, mesh: Nullable<Mesh>): Mesh;
  108119. /**
  108120. * Returns the LOD level mesh at the passed distance or null if not found.
  108121. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  108122. * @param distance The distance from the center of the object to show this level
  108123. * @returns a Mesh or `null`
  108124. */
  108125. getLODLevelAtDistance(distance: number): Nullable<Mesh>;
  108126. /**
  108127. * Remove a mesh from the LOD array
  108128. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  108129. * @param mesh defines the mesh to be removed
  108130. * @return This mesh (for chaining)
  108131. */
  108132. removeLODLevel(mesh: Mesh): Mesh;
  108133. /**
  108134. * Returns the registered LOD mesh distant from the parameter `camera` position if any, else returns the current mesh.
  108135. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  108136. * @param camera defines the camera to use to compute distance
  108137. * @param boundingSphere defines a custom bounding sphere to use instead of the one from this mesh
  108138. * @return This mesh (for chaining)
  108139. */
  108140. getLOD(camera: Camera, boundingSphere?: BoundingSphere): Nullable<AbstractMesh>;
  108141. /**
  108142. * Gets the mesh internal Geometry object
  108143. */
  108144. get geometry(): Nullable<Geometry>;
  108145. /**
  108146. * Returns the total number of vertices within the mesh geometry or zero if the mesh has no geometry.
  108147. * @returns the total number of vertices
  108148. */
  108149. getTotalVertices(): number;
  108150. /**
  108151. * Returns the content of an associated vertex buffer
  108152. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  108153. * - VertexBuffer.PositionKind
  108154. * - VertexBuffer.UVKind
  108155. * - VertexBuffer.UV2Kind
  108156. * - VertexBuffer.UV3Kind
  108157. * - VertexBuffer.UV4Kind
  108158. * - VertexBuffer.UV5Kind
  108159. * - VertexBuffer.UV6Kind
  108160. * - VertexBuffer.ColorKind
  108161. * - VertexBuffer.MatricesIndicesKind
  108162. * - VertexBuffer.MatricesIndicesExtraKind
  108163. * - VertexBuffer.MatricesWeightsKind
  108164. * - VertexBuffer.MatricesWeightsExtraKind
  108165. * @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
  108166. * @param forceCopy defines a boolean forcing the copy of the buffer no matter what the value of copyWhenShared is
  108167. * @returns a FloatArray or null if the mesh has no geometry or no vertex buffer for this kind.
  108168. */
  108169. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  108170. /**
  108171. * Returns the mesh VertexBuffer object from the requested `kind`
  108172. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  108173. * - VertexBuffer.PositionKind
  108174. * - VertexBuffer.NormalKind
  108175. * - VertexBuffer.UVKind
  108176. * - VertexBuffer.UV2Kind
  108177. * - VertexBuffer.UV3Kind
  108178. * - VertexBuffer.UV4Kind
  108179. * - VertexBuffer.UV5Kind
  108180. * - VertexBuffer.UV6Kind
  108181. * - VertexBuffer.ColorKind
  108182. * - VertexBuffer.MatricesIndicesKind
  108183. * - VertexBuffer.MatricesIndicesExtraKind
  108184. * - VertexBuffer.MatricesWeightsKind
  108185. * - VertexBuffer.MatricesWeightsExtraKind
  108186. * @returns a FloatArray or null if the mesh has no vertex buffer for this kind.
  108187. */
  108188. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  108189. /**
  108190. * Tests if a specific vertex buffer is associated with this mesh
  108191. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  108192. * - VertexBuffer.PositionKind
  108193. * - VertexBuffer.NormalKind
  108194. * - VertexBuffer.UVKind
  108195. * - VertexBuffer.UV2Kind
  108196. * - VertexBuffer.UV3Kind
  108197. * - VertexBuffer.UV4Kind
  108198. * - VertexBuffer.UV5Kind
  108199. * - VertexBuffer.UV6Kind
  108200. * - VertexBuffer.ColorKind
  108201. * - VertexBuffer.MatricesIndicesKind
  108202. * - VertexBuffer.MatricesIndicesExtraKind
  108203. * - VertexBuffer.MatricesWeightsKind
  108204. * - VertexBuffer.MatricesWeightsExtraKind
  108205. * @returns a boolean
  108206. */
  108207. isVerticesDataPresent(kind: string): boolean;
  108208. /**
  108209. * Returns a boolean defining if the vertex data for the requested `kind` is updatable.
  108210. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  108211. * - VertexBuffer.PositionKind
  108212. * - VertexBuffer.UVKind
  108213. * - VertexBuffer.UV2Kind
  108214. * - VertexBuffer.UV3Kind
  108215. * - VertexBuffer.UV4Kind
  108216. * - VertexBuffer.UV5Kind
  108217. * - VertexBuffer.UV6Kind
  108218. * - VertexBuffer.ColorKind
  108219. * - VertexBuffer.MatricesIndicesKind
  108220. * - VertexBuffer.MatricesIndicesExtraKind
  108221. * - VertexBuffer.MatricesWeightsKind
  108222. * - VertexBuffer.MatricesWeightsExtraKind
  108223. * @returns a boolean
  108224. */
  108225. isVertexBufferUpdatable(kind: string): boolean;
  108226. /**
  108227. * Returns a string which contains the list of existing `kinds` of Vertex Data associated with this mesh.
  108228. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  108229. * - VertexBuffer.PositionKind
  108230. * - VertexBuffer.NormalKind
  108231. * - VertexBuffer.UVKind
  108232. * - VertexBuffer.UV2Kind
  108233. * - VertexBuffer.UV3Kind
  108234. * - VertexBuffer.UV4Kind
  108235. * - VertexBuffer.UV5Kind
  108236. * - VertexBuffer.UV6Kind
  108237. * - VertexBuffer.ColorKind
  108238. * - VertexBuffer.MatricesIndicesKind
  108239. * - VertexBuffer.MatricesIndicesExtraKind
  108240. * - VertexBuffer.MatricesWeightsKind
  108241. * - VertexBuffer.MatricesWeightsExtraKind
  108242. * @returns an array of strings
  108243. */
  108244. getVerticesDataKinds(): string[];
  108245. /**
  108246. * Returns a positive integer : the total number of indices in this mesh geometry.
  108247. * @returns the numner of indices or zero if the mesh has no geometry.
  108248. */
  108249. getTotalIndices(): number;
  108250. /**
  108251. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  108252. * @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.
  108253. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  108254. * @returns the indices array or an empty array if the mesh has no geometry
  108255. */
  108256. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  108257. get isBlocked(): boolean;
  108258. /**
  108259. * Determine if the current mesh is ready to be rendered
  108260. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  108261. * @param forceInstanceSupport will check if the mesh will be ready when used with instances (false by default)
  108262. * @returns true if all associated assets are ready (material, textures, shaders)
  108263. */
  108264. isReady(completeCheck?: boolean, forceInstanceSupport?: boolean): boolean;
  108265. /**
  108266. * 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.
  108267. */
  108268. get areNormalsFrozen(): boolean;
  108269. /**
  108270. * 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.
  108271. * @returns the current mesh
  108272. */
  108273. freezeNormals(): Mesh;
  108274. /**
  108275. * 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
  108276. * @returns the current mesh
  108277. */
  108278. unfreezeNormals(): Mesh;
  108279. /**
  108280. * Sets a value overriding the instance count. Only applicable when custom instanced InterleavedVertexBuffer are used rather than InstancedMeshs
  108281. */
  108282. set overridenInstanceCount(count: number);
  108283. /** @hidden */
  108284. _preActivate(): Mesh;
  108285. /** @hidden */
  108286. _preActivateForIntermediateRendering(renderId: number): Mesh;
  108287. /** @hidden */
  108288. _registerInstanceForRenderId(instance: InstancedMesh, renderId: number): Mesh;
  108289. protected _afterComputeWorldMatrix(): void;
  108290. /** @hidden */
  108291. _postActivate(): void;
  108292. /**
  108293. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  108294. * This means the mesh underlying bounding box and sphere are recomputed.
  108295. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  108296. * @returns the current mesh
  108297. */
  108298. refreshBoundingInfo(applySkeleton?: boolean): Mesh;
  108299. /** @hidden */
  108300. _createGlobalSubMesh(force: boolean): Nullable<SubMesh>;
  108301. /**
  108302. * This function will subdivide the mesh into multiple submeshes
  108303. * @param count defines the expected number of submeshes
  108304. */
  108305. subdivide(count: number): void;
  108306. /**
  108307. * Copy a FloatArray into a specific associated vertex buffer
  108308. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  108309. * - VertexBuffer.PositionKind
  108310. * - VertexBuffer.UVKind
  108311. * - VertexBuffer.UV2Kind
  108312. * - VertexBuffer.UV3Kind
  108313. * - VertexBuffer.UV4Kind
  108314. * - VertexBuffer.UV5Kind
  108315. * - VertexBuffer.UV6Kind
  108316. * - VertexBuffer.ColorKind
  108317. * - VertexBuffer.MatricesIndicesKind
  108318. * - VertexBuffer.MatricesIndicesExtraKind
  108319. * - VertexBuffer.MatricesWeightsKind
  108320. * - VertexBuffer.MatricesWeightsExtraKind
  108321. * @param data defines the data source
  108322. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  108323. * @param stride defines the data stride size (can be null)
  108324. * @returns the current mesh
  108325. */
  108326. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  108327. /**
  108328. * Delete a vertex buffer associated with this mesh
  108329. * @param kind defines which buffer to delete (positions, indices, normals, etc). Possible `kind` values :
  108330. * - VertexBuffer.PositionKind
  108331. * - VertexBuffer.UVKind
  108332. * - VertexBuffer.UV2Kind
  108333. * - VertexBuffer.UV3Kind
  108334. * - VertexBuffer.UV4Kind
  108335. * - VertexBuffer.UV5Kind
  108336. * - VertexBuffer.UV6Kind
  108337. * - VertexBuffer.ColorKind
  108338. * - VertexBuffer.MatricesIndicesKind
  108339. * - VertexBuffer.MatricesIndicesExtraKind
  108340. * - VertexBuffer.MatricesWeightsKind
  108341. * - VertexBuffer.MatricesWeightsExtraKind
  108342. */
  108343. removeVerticesData(kind: string): void;
  108344. /**
  108345. * Flags an associated vertex buffer as updatable
  108346. * @param kind defines which buffer to use (positions, indices, normals, etc). Possible `kind` values :
  108347. * - VertexBuffer.PositionKind
  108348. * - VertexBuffer.UVKind
  108349. * - VertexBuffer.UV2Kind
  108350. * - VertexBuffer.UV3Kind
  108351. * - VertexBuffer.UV4Kind
  108352. * - VertexBuffer.UV5Kind
  108353. * - VertexBuffer.UV6Kind
  108354. * - VertexBuffer.ColorKind
  108355. * - VertexBuffer.MatricesIndicesKind
  108356. * - VertexBuffer.MatricesIndicesExtraKind
  108357. * - VertexBuffer.MatricesWeightsKind
  108358. * - VertexBuffer.MatricesWeightsExtraKind
  108359. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  108360. */
  108361. markVerticesDataAsUpdatable(kind: string, updatable?: boolean): void;
  108362. /**
  108363. * Sets the mesh global Vertex Buffer
  108364. * @param buffer defines the buffer to use
  108365. * @returns the current mesh
  108366. */
  108367. setVerticesBuffer(buffer: VertexBuffer): Mesh;
  108368. /**
  108369. * Update a specific associated vertex buffer
  108370. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  108371. * - VertexBuffer.PositionKind
  108372. * - VertexBuffer.UVKind
  108373. * - VertexBuffer.UV2Kind
  108374. * - VertexBuffer.UV3Kind
  108375. * - VertexBuffer.UV4Kind
  108376. * - VertexBuffer.UV5Kind
  108377. * - VertexBuffer.UV6Kind
  108378. * - VertexBuffer.ColorKind
  108379. * - VertexBuffer.MatricesIndicesKind
  108380. * - VertexBuffer.MatricesIndicesExtraKind
  108381. * - VertexBuffer.MatricesWeightsKind
  108382. * - VertexBuffer.MatricesWeightsExtraKind
  108383. * @param data defines the data source
  108384. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  108385. * @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)
  108386. * @returns the current mesh
  108387. */
  108388. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  108389. /**
  108390. * This method updates the vertex positions of an updatable mesh according to the `positionFunction` returned values.
  108391. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#other-shapes-updatemeshpositions
  108392. * @param positionFunction is a simple JS function what is passed the mesh `positions` array. It doesn't need to return anything
  108393. * @param computeNormals is a boolean (default true) to enable/disable the mesh normal recomputation after the vertex position update
  108394. * @returns the current mesh
  108395. */
  108396. updateMeshPositions(positionFunction: (data: FloatArray) => void, computeNormals?: boolean): Mesh;
  108397. /**
  108398. * Creates a un-shared specific occurence of the geometry for the mesh.
  108399. * @returns the current mesh
  108400. */
  108401. makeGeometryUnique(): Mesh;
  108402. /**
  108403. * Set the index buffer of this mesh
  108404. * @param indices defines the source data
  108405. * @param totalVertices defines the total number of vertices referenced by this index data (can be null)
  108406. * @param updatable defines if the updated index buffer must be flagged as updatable (default is false)
  108407. * @returns the current mesh
  108408. */
  108409. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): AbstractMesh;
  108410. /**
  108411. * Update the current index buffer
  108412. * @param indices defines the source data
  108413. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  108414. * @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)
  108415. * @returns the current mesh
  108416. */
  108417. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  108418. /**
  108419. * Invert the geometry to move from a right handed system to a left handed one.
  108420. * @returns the current mesh
  108421. */
  108422. toLeftHanded(): Mesh;
  108423. /** @hidden */
  108424. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  108425. /** @hidden */
  108426. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  108427. /**
  108428. * Registers for this mesh a javascript function called just before the rendering process
  108429. * @param func defines the function to call before rendering this mesh
  108430. * @returns the current mesh
  108431. */
  108432. registerBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  108433. /**
  108434. * Disposes a previously registered javascript function called before the rendering
  108435. * @param func defines the function to remove
  108436. * @returns the current mesh
  108437. */
  108438. unregisterBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  108439. /**
  108440. * Registers for this mesh a javascript function called just after the rendering is complete
  108441. * @param func defines the function to call after rendering this mesh
  108442. * @returns the current mesh
  108443. */
  108444. registerAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  108445. /**
  108446. * Disposes a previously registered javascript function called after the rendering.
  108447. * @param func defines the function to remove
  108448. * @returns the current mesh
  108449. */
  108450. unregisterAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  108451. /** @hidden */
  108452. _getInstancesRenderList(subMeshId: number, isReplacementMode?: boolean): _InstancesBatch;
  108453. /** @hidden */
  108454. _renderWithInstances(subMesh: SubMesh, fillMode: number, batch: _InstancesBatch, effect: Effect, engine: Engine): Mesh;
  108455. /** @hidden */
  108456. _renderWithThinInstances(subMesh: SubMesh, fillMode: number, effect: Effect, engine: Engine): void;
  108457. /** @hidden */
  108458. _processInstancedBuffers(visibleInstances: InstancedMesh[], renderSelf: boolean): void;
  108459. /** @hidden */
  108460. _processRendering(renderingMesh: AbstractMesh, subMesh: SubMesh, effect: Effect, fillMode: number, batch: _InstancesBatch, hardwareInstancedRendering: boolean, onBeforeDraw: (isInstance: boolean, world: Matrix, effectiveMaterial?: Material) => void, effectiveMaterial?: Material): Mesh;
  108461. /** @hidden */
  108462. _rebuild(): void;
  108463. /** @hidden */
  108464. _freeze(): void;
  108465. /** @hidden */
  108466. _unFreeze(): void;
  108467. /**
  108468. * 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
  108469. * @param subMesh defines the subMesh to render
  108470. * @param enableAlphaMode defines if alpha mode can be changed
  108471. * @param effectiveMeshReplacement defines an optional mesh used to provide info for the rendering
  108472. * @returns the current mesh
  108473. */
  108474. render(subMesh: SubMesh, enableAlphaMode: boolean, effectiveMeshReplacement?: AbstractMesh): Mesh;
  108475. private _onBeforeDraw;
  108476. /**
  108477. * Renormalize the mesh and patch it up if there are no weights
  108478. * Similar to normalization by adding the weights compute the reciprocal and multiply all elements, this wil ensure that everything adds to 1.
  108479. * However in the case of zero weights then we set just a single influence to 1.
  108480. * We check in the function for extra's present and if so we use the normalizeSkinWeightsWithExtras rather than the FourWeights version.
  108481. */
  108482. cleanMatrixWeights(): void;
  108483. private normalizeSkinFourWeights;
  108484. private normalizeSkinWeightsAndExtra;
  108485. /**
  108486. * ValidateSkinning is used to determine that a mesh has valid skinning data along with skin metrics, if missing weights,
  108487. * or not normalized it is returned as invalid mesh the string can be used for console logs, or on screen messages to let
  108488. * the user know there was an issue with importing the mesh
  108489. * @returns a validation object with skinned, valid and report string
  108490. */
  108491. validateSkinning(): {
  108492. skinned: boolean;
  108493. valid: boolean;
  108494. report: string;
  108495. };
  108496. /** @hidden */
  108497. _checkDelayState(): Mesh;
  108498. private _queueLoad;
  108499. /**
  108500. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  108501. * A mesh is in the frustum if its bounding box intersects the frustum
  108502. * @param frustumPlanes defines the frustum to test
  108503. * @returns true if the mesh is in the frustum planes
  108504. */
  108505. isInFrustum(frustumPlanes: Plane[]): boolean;
  108506. /**
  108507. * Sets the mesh material by the material or multiMaterial `id` property
  108508. * @param id is a string identifying the material or the multiMaterial
  108509. * @returns the current mesh
  108510. */
  108511. setMaterialByID(id: string): Mesh;
  108512. /**
  108513. * Returns as a new array populated with the mesh material and/or skeleton, if any.
  108514. * @returns an array of IAnimatable
  108515. */
  108516. getAnimatables(): IAnimatable[];
  108517. /**
  108518. * Modifies the mesh geometry according to the passed transformation matrix.
  108519. * This method returns nothing but it really modifies the mesh even if it's originally not set as updatable.
  108520. * The mesh normals are modified using the same transformation.
  108521. * Note that, under the hood, this method sets a new VertexBuffer each call.
  108522. * @param transform defines the transform matrix to use
  108523. * @see https://doc.babylonjs.com/resources/baking_transformations
  108524. * @returns the current mesh
  108525. */
  108526. bakeTransformIntoVertices(transform: Matrix): Mesh;
  108527. /**
  108528. * Modifies the mesh geometry according to its own current World Matrix.
  108529. * The mesh World Matrix is then reset.
  108530. * This method returns nothing but really modifies the mesh even if it's originally not set as updatable.
  108531. * Note that, under the hood, this method sets a new VertexBuffer each call.
  108532. * @see https://doc.babylonjs.com/resources/baking_transformations
  108533. * @param bakeIndependenlyOfChildren indicates whether to preserve all child nodes' World Matrix during baking
  108534. * @returns the current mesh
  108535. */
  108536. bakeCurrentTransformIntoVertices(bakeIndependenlyOfChildren?: boolean): Mesh;
  108537. /** @hidden */
  108538. get _positions(): Nullable<Vector3[]>;
  108539. /** @hidden */
  108540. _resetPointsArrayCache(): Mesh;
  108541. /** @hidden */
  108542. _generatePointsArray(): boolean;
  108543. /**
  108544. * Returns a new Mesh object generated from the current mesh properties.
  108545. * This method must not get confused with createInstance()
  108546. * @param name is a string, the name given to the new mesh
  108547. * @param newParent can be any Node object (default `null`)
  108548. * @param doNotCloneChildren allows/denies the recursive cloning of the original mesh children if any (default `false`)
  108549. * @param clonePhysicsImpostor allows/denies the cloning in the same time of the original mesh `body` used by the physics engine, if any (default `true`)
  108550. * @returns a new mesh
  108551. */
  108552. clone(name?: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean): Mesh;
  108553. /**
  108554. * Releases resources associated with this mesh.
  108555. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  108556. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  108557. */
  108558. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  108559. /** @hidden */
  108560. _disposeInstanceSpecificData(): void;
  108561. /** @hidden */
  108562. _disposeThinInstanceSpecificData(): void;
  108563. /**
  108564. * Modifies the mesh geometry according to a displacement map.
  108565. * 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.
  108566. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  108567. * @param url is a string, the URL from the image file is to be downloaded.
  108568. * @param minHeight is the lower limit of the displacement.
  108569. * @param maxHeight is the upper limit of the displacement.
  108570. * @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.
  108571. * @param uvOffset is an optional vector2 used to offset UV.
  108572. * @param uvScale is an optional vector2 used to scale UV.
  108573. * @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.
  108574. * @returns the Mesh.
  108575. */
  108576. applyDisplacementMap(url: string, minHeight: number, maxHeight: number, onSuccess?: (mesh: Mesh) => void, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  108577. /**
  108578. * Modifies the mesh geometry according to a displacementMap buffer.
  108579. * 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.
  108580. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  108581. * @param buffer is a `Uint8Array` buffer containing series of `Uint8` lower than 255, the red, green, blue and alpha values of each successive pixel.
  108582. * @param heightMapWidth is the width of the buffer image.
  108583. * @param heightMapHeight is the height of the buffer image.
  108584. * @param minHeight is the lower limit of the displacement.
  108585. * @param maxHeight is the upper limit of the displacement.
  108586. * @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.
  108587. * @param uvOffset is an optional vector2 used to offset UV.
  108588. * @param uvScale is an optional vector2 used to scale UV.
  108589. * @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.
  108590. * @returns the Mesh.
  108591. */
  108592. applyDisplacementMapFromBuffer(buffer: Uint8Array, heightMapWidth: number, heightMapHeight: number, minHeight: number, maxHeight: number, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  108593. /**
  108594. * Modify the mesh to get a flat shading rendering.
  108595. * This means each mesh facet will then have its own normals. Usually new vertices are added in the mesh geometry to get this result.
  108596. * Warning : the mesh is really modified even if not set originally as updatable and, under the hood, a new VertexBuffer is allocated.
  108597. * @returns current mesh
  108598. */
  108599. convertToFlatShadedMesh(): Mesh;
  108600. /**
  108601. * This method removes all the mesh indices and add new vertices (duplication) in order to unfold facets into buffers.
  108602. * In other words, more vertices, no more indices and a single bigger VBO.
  108603. * The mesh is really modified even if not set originally as updatable. Under the hood, a new VertexBuffer is allocated.
  108604. * @returns current mesh
  108605. */
  108606. convertToUnIndexedMesh(): Mesh;
  108607. /**
  108608. * Inverses facet orientations.
  108609. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  108610. * @param flipNormals will also inverts the normals
  108611. * @returns current mesh
  108612. */
  108613. flipFaces(flipNormals?: boolean): Mesh;
  108614. /**
  108615. * Increase the number of facets and hence vertices in a mesh
  108616. * Vertex normals are interpolated from existing vertex normals
  108617. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  108618. * @param numberPerEdge the number of new vertices to add to each edge of a facet, optional default 1
  108619. */
  108620. increaseVertices(numberPerEdge: number): void;
  108621. /**
  108622. * Force adjacent facets to share vertices and remove any facets that have all vertices in a line
  108623. * This will undo any application of covertToFlatShadedMesh
  108624. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  108625. */
  108626. forceSharedVertices(): void;
  108627. /** @hidden */
  108628. static _instancedMeshFactory(name: string, mesh: Mesh): InstancedMesh;
  108629. /** @hidden */
  108630. static _PhysicsImpostorParser(scene: Scene, physicObject: IPhysicsEnabledObject, jsonObject: any): PhysicsImpostor;
  108631. /**
  108632. * Creates a new InstancedMesh object from the mesh model.
  108633. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  108634. * @param name defines the name of the new instance
  108635. * @returns a new InstancedMesh
  108636. */
  108637. createInstance(name: string): InstancedMesh;
  108638. /**
  108639. * Synchronises all the mesh instance submeshes to the current mesh submeshes, if any.
  108640. * After this call, all the mesh instances have the same submeshes than the current mesh.
  108641. * @returns the current mesh
  108642. */
  108643. synchronizeInstances(): Mesh;
  108644. /**
  108645. * Optimization of the mesh's indices, in case a mesh has duplicated vertices.
  108646. * The function will only reorder the indices and will not remove unused vertices to avoid problems with submeshes.
  108647. * This should be used together with the simplification to avoid disappearing triangles.
  108648. * @param successCallback an optional success callback to be called after the optimization finished.
  108649. * @returns the current mesh
  108650. */
  108651. optimizeIndices(successCallback?: (mesh?: Mesh) => void): Mesh;
  108652. /**
  108653. * Serialize current mesh
  108654. * @param serializationObject defines the object which will receive the serialization data
  108655. */
  108656. serialize(serializationObject: any): void;
  108657. /** @hidden */
  108658. _syncGeometryWithMorphTargetManager(): void;
  108659. /** @hidden */
  108660. static _GroundMeshParser: (parsedMesh: any, scene: Scene) => Mesh;
  108661. /**
  108662. * Returns a new Mesh object parsed from the source provided.
  108663. * @param parsedMesh is the source
  108664. * @param scene defines the hosting scene
  108665. * @param rootUrl is the root URL to prefix the `delayLoadingFile` property with
  108666. * @returns a new Mesh
  108667. */
  108668. static Parse(parsedMesh: any, scene: Scene, rootUrl: string): Mesh;
  108669. /**
  108670. * Creates a ribbon mesh. Please consider using the same method from the MeshBuilder class instead
  108671. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  108672. * @param name defines the name of the mesh to create
  108673. * @param pathArray is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry.
  108674. * @param closeArray creates a seam between the first and the last paths of the path array (default is false)
  108675. * @param closePath creates a seam between the first and the last points of each path of the path array
  108676. * @param offset is taken in account only if the `pathArray` is containing a single path
  108677. * @param scene defines the hosting scene
  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 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)
  108681. * @returns a new Mesh
  108682. */
  108683. static CreateRibbon(name: string, pathArray: Vector3[][], closeArray: boolean, closePath: boolean, offset: number, scene?: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  108684. /**
  108685. * Creates a plane polygonal mesh. By default, this is a disc. Please consider using the same method from the MeshBuilder class instead
  108686. * @param name defines the name of the mesh to create
  108687. * @param radius sets the radius size (float) of the polygon (default 0.5)
  108688. * @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
  108689. * @param scene defines the hosting scene
  108690. * @param updatable defines if the mesh must be flagged as updatable
  108691. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108692. * @returns a new Mesh
  108693. */
  108694. static CreateDisc(name: string, radius: number, tessellation: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  108695. /**
  108696. * Creates a box mesh. Please consider using the same method from the MeshBuilder class instead
  108697. * @param name defines the name of the mesh to create
  108698. * @param size sets the size (float) of each box side (default 1)
  108699. * @param scene defines the hosting scene
  108700. * @param updatable defines if the mesh must be flagged as updatable
  108701. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108702. * @returns a new Mesh
  108703. */
  108704. static CreateBox(name: string, size: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  108705. /**
  108706. * Creates a sphere mesh. Please consider using the same method from the MeshBuilder class instead
  108707. * @param name defines the name of the mesh to create
  108708. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  108709. * @param diameter sets the diameter size (float) of the sphere (default 1)
  108710. * @param scene defines the hosting scene
  108711. * @param updatable defines if the mesh must be flagged as updatable
  108712. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108713. * @returns a new Mesh
  108714. */
  108715. static CreateSphere(name: string, segments: number, diameter: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  108716. /**
  108717. * Creates a hemisphere mesh. Please consider using the same method from the MeshBuilder class instead
  108718. * @param name defines the name of the mesh to create
  108719. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  108720. * @param diameter sets the diameter size (float) of the sphere (default 1)
  108721. * @param scene defines the hosting scene
  108722. * @returns a new Mesh
  108723. */
  108724. static CreateHemisphere(name: string, segments: number, diameter: number, scene?: Scene): Mesh;
  108725. /**
  108726. * Creates a cylinder or a cone mesh. Please consider using the same method from the MeshBuilder class instead
  108727. * @param name defines the name of the mesh to create
  108728. * @param height sets the height size (float) of the cylinder/cone (float, default 2)
  108729. * @param diameterTop set the top cap diameter (floats, default 1)
  108730. * @param diameterBottom set the bottom cap diameter (floats, default 1). This value can't be zero
  108731. * @param tessellation sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance
  108732. * @param subdivisions sets the number of rings along the cylinder height (positive integer, default 1)
  108733. * @param scene defines the hosting scene
  108734. * @param updatable defines if the mesh must be flagged as updatable
  108735. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108736. * @returns a new Mesh
  108737. */
  108738. static CreateCylinder(name: string, height: number, diameterTop: number, diameterBottom: number, tessellation: number, subdivisions: any, scene?: Scene, updatable?: any, sideOrientation?: number): Mesh;
  108739. /**
  108740. * Creates a torus mesh. Please consider using the same method from the MeshBuilder class instead
  108741. * @param name defines the name of the mesh to create
  108742. * @param diameter sets the diameter size (float) of the torus (default 1)
  108743. * @param thickness sets the diameter size of the tube of the torus (float, default 0.5)
  108744. * @param tessellation sets the number of torus sides (postive integer, default 16)
  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 CreateTorus(name: string, diameter: number, thickness: number, tessellation: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  108751. /**
  108752. * Creates a torus knot 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 radius sets the global radius size (float) of the torus knot (default 2)
  108755. * @param tube sets the diameter size of the tube of the torus (float, default 0.5)
  108756. * @param radialSegments sets the number of sides on each tube segments (positive integer, default 32)
  108757. * @param tubularSegments sets the number of tubes to decompose the knot into (positive integer, default 32)
  108758. * @param p the number of windings on X axis (positive integers, default 2)
  108759. * @param q the number of windings on Y axis (positive integers, default 3)
  108760. * @param scene defines the hosting scene
  108761. * @param updatable defines if the mesh must be flagged as updatable
  108762. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108763. * @returns a new Mesh
  108764. */
  108765. static CreateTorusKnot(name: string, radius: number, tube: number, radialSegments: number, tubularSegments: number, p: number, q: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  108766. /**
  108767. * Creates a line mesh. Please consider using the same method from the MeshBuilder class instead.
  108768. * @param name defines the name of the mesh to create
  108769. * @param points is an array successive Vector3
  108770. * @param scene defines the hosting scene
  108771. * @param updatable defines if the mesh must be flagged as updatable
  108772. * @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).
  108773. * @returns a new Mesh
  108774. */
  108775. static CreateLines(name: string, points: Vector3[], scene?: Nullable<Scene>, updatable?: boolean, instance?: Nullable<LinesMesh>): LinesMesh;
  108776. /**
  108777. * Creates a dashed line mesh. Please consider using the same method from the MeshBuilder class instead
  108778. * @param name defines the name of the mesh to create
  108779. * @param points is an array successive Vector3
  108780. * @param dashSize is the size of the dashes relatively the dash number (positive float, default 3)
  108781. * @param gapSize is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  108782. * @param dashNb is the intended total number of dashes (positive integer, default 200)
  108783. * @param scene defines the hosting scene
  108784. * @param updatable defines if the mesh must be flagged as updatable
  108785. * @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)
  108786. * @returns a new Mesh
  108787. */
  108788. static CreateDashedLines(name: string, points: Vector3[], dashSize: number, gapSize: number, dashNb: number, scene?: Nullable<Scene>, updatable?: boolean, instance?: LinesMesh): LinesMesh;
  108789. /**
  108790. * Creates a polygon mesh.Please consider using the same method from the MeshBuilder class instead
  108791. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh.
  108792. * 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.
  108793. * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  108794. * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  108795. * Remember you can only change the shape positions, not their number when updating a polygon.
  108796. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  108797. * @param name defines the name of the mesh to create
  108798. * @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
  108799. * @param scene defines the hosting scene
  108800. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  108801. * @param updatable defines if the mesh must be flagged as updatable
  108802. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108803. * @param earcutInjection can be used to inject your own earcut reference
  108804. * @returns a new Mesh
  108805. */
  108806. static CreatePolygon(name: string, shape: Vector3[], scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  108807. /**
  108808. * Creates an extruded polygon mesh, with depth in the Y direction. Please consider using the same method from the MeshBuilder class instead.
  108809. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-non-regular-polygon
  108810. * @param name defines the name of the mesh to create
  108811. * @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
  108812. * @param depth defines the height of extrusion
  108813. * @param scene defines the hosting scene
  108814. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  108815. * @param updatable defines if the mesh must be flagged as updatable
  108816. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108817. * @param earcutInjection can be used to inject your own earcut reference
  108818. * @returns a new Mesh
  108819. */
  108820. static ExtrudePolygon(name: string, shape: Vector3[], depth: number, scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  108821. /**
  108822. * Creates an extruded shape mesh.
  108823. * 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
  108824. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  108825. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  108826. * @param name defines the name of the mesh to create
  108827. * @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
  108828. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  108829. * @param scale is the value to scale the shape
  108830. * @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
  108831. * @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
  108832. * @param scene defines the hosting scene
  108833. * @param updatable defines if the mesh must be flagged as updatable
  108834. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108835. * @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)
  108836. * @returns a new Mesh
  108837. */
  108838. static ExtrudeShape(name: string, shape: Vector3[], path: Vector3[], scale: number, rotation: number, cap: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  108839. /**
  108840. * Creates an custom extruded shape mesh.
  108841. * The custom extrusion is a parametric shape.
  108842. * It has no predefined shape. Its final shape will depend on the input parameters.
  108843. * Please consider using the same method from the MeshBuilder class instead
  108844. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  108845. * @param name defines the name of the mesh to create
  108846. * @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
  108847. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  108848. * @param scaleFunction is a custom Javascript function called on each path point
  108849. * @param rotationFunction is a custom Javascript function called on each path point
  108850. * @param ribbonCloseArray forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  108851. * @param ribbonClosePath forces the extrusion underlying ribbon to close its `pathArray`
  108852. * @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
  108853. * @param scene defines the hosting scene
  108854. * @param updatable defines if the mesh must be flagged as updatable
  108855. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108856. * @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)
  108857. * @returns a new Mesh
  108858. */
  108859. 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;
  108860. /**
  108861. * Creates lathe mesh.
  108862. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe.
  108863. * Please consider using the same method from the MeshBuilder class instead
  108864. * @param name defines the name of the mesh to create
  108865. * @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
  108866. * @param radius is the radius value of the lathe
  108867. * @param tessellation is the side number of the lathe.
  108868. * @param scene defines the hosting scene
  108869. * @param updatable defines if the mesh must be flagged as updatable
  108870. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108871. * @returns a new Mesh
  108872. */
  108873. static CreateLathe(name: string, shape: Vector3[], radius: number, tessellation: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  108874. /**
  108875. * Creates a plane mesh. Please consider using the same method from the MeshBuilder class instead
  108876. * @param name defines the name of the mesh to create
  108877. * @param size sets the size (float) of both sides of the plane at once (default 1)
  108878. * @param scene defines the hosting scene
  108879. * @param updatable defines if the mesh must be flagged as updatable
  108880. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108881. * @returns a new Mesh
  108882. */
  108883. static CreatePlane(name: string, size: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  108884. /**
  108885. * Creates a ground mesh.
  108886. * Please consider using the same method from the MeshBuilder class instead
  108887. * @param name defines the name of the mesh to create
  108888. * @param width set the width of the ground
  108889. * @param height set the height of the ground
  108890. * @param subdivisions sets the number of subdivisions per side
  108891. * @param scene defines the hosting scene
  108892. * @param updatable defines if the mesh must be flagged as updatable
  108893. * @returns a new Mesh
  108894. */
  108895. static CreateGround(name: string, width: number, height: number, subdivisions: number, scene?: Scene, updatable?: boolean): Mesh;
  108896. /**
  108897. * Creates a tiled ground mesh.
  108898. * Please consider using the same method from the MeshBuilder class instead
  108899. * @param name defines the name of the mesh to create
  108900. * @param xmin set the ground minimum X coordinate
  108901. * @param zmin set the ground minimum Y coordinate
  108902. * @param xmax set the ground maximum X coordinate
  108903. * @param zmax set the ground maximum Z coordinate
  108904. * @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
  108905. * @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
  108906. * @param scene defines the hosting scene
  108907. * @param updatable defines if the mesh must be flagged as updatable
  108908. * @returns a new Mesh
  108909. */
  108910. static CreateTiledGround(name: string, xmin: number, zmin: number, xmax: number, zmax: number, subdivisions: {
  108911. w: number;
  108912. h: number;
  108913. }, precision: {
  108914. w: number;
  108915. h: number;
  108916. }, scene: Scene, updatable?: boolean): Mesh;
  108917. /**
  108918. * Creates a ground mesh from a height map.
  108919. * Please consider using the same method from the MeshBuilder class instead
  108920. * @see https://doc.babylonjs.com/babylon101/height_map
  108921. * @param name defines the name of the mesh to create
  108922. * @param url sets the URL of the height map image resource
  108923. * @param width set the ground width size
  108924. * @param height set the ground height size
  108925. * @param subdivisions sets the number of subdivision per side
  108926. * @param minHeight is the minimum altitude on the ground
  108927. * @param maxHeight is the maximum altitude on the ground
  108928. * @param scene defines the hosting scene
  108929. * @param updatable defines if the mesh must be flagged as updatable
  108930. * @param onReady is a callback function that will be called once the mesh is built (the height map download can last some time)
  108931. * @param alphaFilter will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  108932. * @returns a new Mesh
  108933. */
  108934. 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;
  108935. /**
  108936. * Creates a tube mesh.
  108937. * The tube is a parametric shape.
  108938. * It has no predefined shape. Its final shape will depend on the input parameters.
  108939. * Please consider using the same method from the MeshBuilder class instead
  108940. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  108941. * @param name defines the name of the mesh to create
  108942. * @param path is a required array of successive Vector3. It is the curve used as the axis of the tube
  108943. * @param radius sets the tube radius size
  108944. * @param tessellation is the number of sides on the tubular surface
  108945. * @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
  108946. * @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
  108947. * @param scene defines the hosting scene
  108948. * @param updatable defines if the mesh must be flagged as updatable
  108949. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108950. * @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)
  108951. * @returns a new Mesh
  108952. */
  108953. static CreateTube(name: string, path: Vector3[], radius: number, tessellation: number, radiusFunction: {
  108954. (i: number, distance: number): number;
  108955. }, cap: number, scene: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  108956. /**
  108957. * Creates a polyhedron mesh.
  108958. * Please consider using the same method from the MeshBuilder class instead.
  108959. * * 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
  108960. * * The parameter `size` (positive float, default 1) sets the polygon size
  108961. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  108962. * * 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`
  108963. * * 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
  108964. * * 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)`)
  108965. * * 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
  108966. * * 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
  108967. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  108968. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  108969. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  108970. * @param name defines the name of the mesh to create
  108971. * @param options defines the options used to create the mesh
  108972. * @param scene defines the hosting scene
  108973. * @returns a new Mesh
  108974. */
  108975. static CreatePolyhedron(name: string, options: {
  108976. type?: number;
  108977. size?: number;
  108978. sizeX?: number;
  108979. sizeY?: number;
  108980. sizeZ?: number;
  108981. custom?: any;
  108982. faceUV?: Vector4[];
  108983. faceColors?: Color4[];
  108984. updatable?: boolean;
  108985. sideOrientation?: number;
  108986. }, scene: Scene): Mesh;
  108987. /**
  108988. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  108989. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  108990. * * 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`)
  108991. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  108992. * * 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
  108993. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  108994. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  108995. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  108996. * @param name defines the name of the mesh
  108997. * @param options defines the options used to create the mesh
  108998. * @param scene defines the hosting scene
  108999. * @returns a new Mesh
  109000. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  109001. */
  109002. static CreateIcoSphere(name: string, options: {
  109003. radius?: number;
  109004. flat?: boolean;
  109005. subdivisions?: number;
  109006. sideOrientation?: number;
  109007. updatable?: boolean;
  109008. }, scene: Scene): Mesh;
  109009. /**
  109010. * Creates a decal mesh.
  109011. * Please consider using the same method from the MeshBuilder class instead.
  109012. * A decal is a mesh usually applied as a model onto the surface of another mesh
  109013. * @param name defines the name of the mesh
  109014. * @param sourceMesh defines the mesh receiving the decal
  109015. * @param position sets the position of the decal in world coordinates
  109016. * @param normal sets the normal of the mesh where the decal is applied onto in world coordinates
  109017. * @param size sets the decal scaling
  109018. * @param angle sets the angle to rotate the decal
  109019. * @returns a new Mesh
  109020. */
  109021. static CreateDecal(name: string, sourceMesh: AbstractMesh, position: Vector3, normal: Vector3, size: Vector3, angle: number): Mesh;
  109022. /**
  109023. * Prepare internal position array for software CPU skinning
  109024. * @returns original positions used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh
  109025. */
  109026. setPositionsForCPUSkinning(): Float32Array;
  109027. /**
  109028. * Prepare internal normal array for software CPU skinning
  109029. * @returns original normals used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh.
  109030. */
  109031. setNormalsForCPUSkinning(): Float32Array;
  109032. /**
  109033. * Updates the vertex buffer by applying transformation from the bones
  109034. * @param skeleton defines the skeleton to apply to current mesh
  109035. * @returns the current mesh
  109036. */
  109037. applySkeleton(skeleton: Skeleton): Mesh;
  109038. /**
  109039. * 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
  109040. * @param meshes defines the list of meshes to scan
  109041. * @returns an object `{min:` Vector3`, max:` Vector3`}`
  109042. */
  109043. static MinMax(meshes: AbstractMesh[]): {
  109044. min: Vector3;
  109045. max: Vector3;
  109046. };
  109047. /**
  109048. * Returns the center of the `{min:` Vector3`, max:` Vector3`}` or the center of MinMax vector3 computed from a mesh array
  109049. * @param meshesOrMinMaxVector could be an array of meshes or a `{min:` Vector3`, max:` Vector3`}` object
  109050. * @returns a vector3
  109051. */
  109052. static Center(meshesOrMinMaxVector: {
  109053. min: Vector3;
  109054. max: Vector3;
  109055. } | AbstractMesh[]): Vector3;
  109056. /**
  109057. * Merge the array of meshes into a single mesh for performance reasons.
  109058. * @param meshes defines he vertices source. They should all be of the same material. Entries can empty
  109059. * @param disposeSource when true (default), dispose of the vertices from the source meshes
  109060. * @param allow32BitsIndices when the sum of the vertices > 64k, this must be set to true
  109061. * @param meshSubclass when set, vertices inserted into this Mesh. Meshes can then be merged into a Mesh sub-class.
  109062. * @param subdivideWithSubMeshes when true (false default), subdivide mesh to his subMesh array with meshes source.
  109063. * @param multiMultiMaterials when true (false default), subdivide mesh and accept multiple multi materials, ignores subdivideWithSubMeshes.
  109064. * @returns a new mesh
  109065. */
  109066. static MergeMeshes(meshes: Array<Mesh>, disposeSource?: boolean, allow32BitsIndices?: boolean, meshSubclass?: Mesh, subdivideWithSubMeshes?: boolean, multiMultiMaterials?: boolean): Nullable<Mesh>;
  109067. /** @hidden */
  109068. addInstance(instance: InstancedMesh): void;
  109069. /** @hidden */
  109070. removeInstance(instance: InstancedMesh): void;
  109071. }
  109072. }
  109073. declare module BABYLON {
  109074. /**
  109075. * This is the base class of all the camera used in the application.
  109076. * @see https://doc.babylonjs.com/features/cameras
  109077. */
  109078. export class Camera extends Node {
  109079. /** @hidden */
  109080. static _createDefaultParsedCamera: (name: string, scene: Scene) => Camera;
  109081. /**
  109082. * This is the default projection mode used by the cameras.
  109083. * It helps recreating a feeling of perspective and better appreciate depth.
  109084. * This is the best way to simulate real life cameras.
  109085. */
  109086. static readonly PERSPECTIVE_CAMERA: number;
  109087. /**
  109088. * This helps creating camera with an orthographic mode.
  109089. * 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.
  109090. */
  109091. static readonly ORTHOGRAPHIC_CAMERA: number;
  109092. /**
  109093. * This is the default FOV mode for perspective cameras.
  109094. * This setting aligns the upper and lower bounds of the viewport to the upper and lower bounds of the camera frustum.
  109095. */
  109096. static readonly FOVMODE_VERTICAL_FIXED: number;
  109097. /**
  109098. * This setting aligns the left and right bounds of the viewport to the left and right bounds of the camera frustum.
  109099. */
  109100. static readonly FOVMODE_HORIZONTAL_FIXED: number;
  109101. /**
  109102. * This specifies ther is no need for a camera rig.
  109103. * Basically only one eye is rendered corresponding to the camera.
  109104. */
  109105. static readonly RIG_MODE_NONE: number;
  109106. /**
  109107. * Simulates a camera Rig with one blue eye and one red eye.
  109108. * This can be use with 3d blue and red glasses.
  109109. */
  109110. static readonly RIG_MODE_STEREOSCOPIC_ANAGLYPH: number;
  109111. /**
  109112. * Defines that both eyes of the camera will be rendered side by side with a parallel target.
  109113. */
  109114. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_PARALLEL: number;
  109115. /**
  109116. * Defines that both eyes of the camera will be rendered side by side with a none parallel target.
  109117. */
  109118. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_CROSSEYED: number;
  109119. /**
  109120. * Defines that both eyes of the camera will be rendered over under each other.
  109121. */
  109122. static readonly RIG_MODE_STEREOSCOPIC_OVERUNDER: number;
  109123. /**
  109124. * Defines that both eyes of the camera will be rendered on successive lines interlaced for passive 3d monitors.
  109125. */
  109126. static readonly RIG_MODE_STEREOSCOPIC_INTERLACED: number;
  109127. /**
  109128. * Defines that both eyes of the camera should be renderered in a VR mode (carbox).
  109129. */
  109130. static readonly RIG_MODE_VR: number;
  109131. /**
  109132. * Defines that both eyes of the camera should be renderered in a VR mode (webVR).
  109133. */
  109134. static readonly RIG_MODE_WEBVR: number;
  109135. /**
  109136. * Custom rig mode allowing rig cameras to be populated manually with any number of cameras
  109137. */
  109138. static readonly RIG_MODE_CUSTOM: number;
  109139. /**
  109140. * Defines if by default attaching controls should prevent the default javascript event to continue.
  109141. */
  109142. static ForceAttachControlToAlwaysPreventDefault: boolean;
  109143. /**
  109144. * Define the input manager associated with the camera.
  109145. */
  109146. inputs: CameraInputsManager<Camera>;
  109147. /** @hidden */
  109148. _position: Vector3;
  109149. /**
  109150. * Define the current local position of the camera in the scene
  109151. */
  109152. get position(): Vector3;
  109153. set position(newPosition: Vector3);
  109154. protected _upVector: Vector3;
  109155. /**
  109156. * The vector the camera should consider as up.
  109157. * (default is Vector3(0, 1, 0) aka Vector3.Up())
  109158. */
  109159. set upVector(vec: Vector3);
  109160. get upVector(): Vector3;
  109161. /**
  109162. * Define the current limit on the left side for an orthographic camera
  109163. * In scene unit
  109164. */
  109165. orthoLeft: Nullable<number>;
  109166. /**
  109167. * Define the current limit on the right side for an orthographic camera
  109168. * In scene unit
  109169. */
  109170. orthoRight: Nullable<number>;
  109171. /**
  109172. * Define the current limit on the bottom side for an orthographic camera
  109173. * In scene unit
  109174. */
  109175. orthoBottom: Nullable<number>;
  109176. /**
  109177. * Define the current limit on the top side for an orthographic camera
  109178. * In scene unit
  109179. */
  109180. orthoTop: Nullable<number>;
  109181. /**
  109182. * Field Of View is set in Radians. (default is 0.8)
  109183. */
  109184. fov: number;
  109185. /**
  109186. * Define the minimum distance the camera can see from.
  109187. * This is important to note that the depth buffer are not infinite and the closer it starts
  109188. * the more your scene might encounter depth fighting issue.
  109189. */
  109190. minZ: number;
  109191. /**
  109192. * Define the maximum distance the camera can see to.
  109193. * This is important to note that the depth buffer are not infinite and the further it end
  109194. * the more your scene might encounter depth fighting issue.
  109195. */
  109196. maxZ: number;
  109197. /**
  109198. * Define the default inertia of the camera.
  109199. * This helps giving a smooth feeling to the camera movement.
  109200. */
  109201. inertia: number;
  109202. /**
  109203. * Define the mode of the camera (Camera.PERSPECTIVE_CAMERA or Camera.ORTHOGRAPHIC_CAMERA)
  109204. */
  109205. mode: number;
  109206. /**
  109207. * Define whether the camera is intermediate.
  109208. * This is useful to not present the output directly to the screen in case of rig without post process for instance
  109209. */
  109210. isIntermediate: boolean;
  109211. /**
  109212. * Define the viewport of the camera.
  109213. * This correspond to the portion of the screen the camera will render to in normalized 0 to 1 unit.
  109214. */
  109215. viewport: Viewport;
  109216. /**
  109217. * Restricts the camera to viewing objects with the same layerMask.
  109218. * A camera with a layerMask of 1 will render mesh.layerMask & camera.layerMask!== 0
  109219. */
  109220. layerMask: number;
  109221. /**
  109222. * fovMode sets the camera frustum bounds to the viewport bounds. (default is FOVMODE_VERTICAL_FIXED)
  109223. */
  109224. fovMode: number;
  109225. /**
  109226. * Rig mode of the camera.
  109227. * This is useful to create the camera with two "eyes" instead of one to create VR or stereoscopic scenes.
  109228. * This is normally controlled byt the camera themselves as internal use.
  109229. */
  109230. cameraRigMode: number;
  109231. /**
  109232. * Defines the distance between both "eyes" in case of a RIG
  109233. */
  109234. interaxialDistance: number;
  109235. /**
  109236. * Defines if stereoscopic rendering is done side by side or over under.
  109237. */
  109238. isStereoscopicSideBySide: boolean;
  109239. /**
  109240. * 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
  109241. * This is pretty helpfull if you wish to make a camera render to a texture you could reuse somewhere
  109242. * else in the scene. (Eg. security camera)
  109243. *
  109244. * 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)
  109245. */
  109246. customRenderTargets: RenderTargetTexture[];
  109247. /**
  109248. * When set, the camera will render to this render target instead of the default canvas
  109249. *
  109250. * If the desire is to use the output of a camera as a texture in the scene consider using camera.customRenderTargets instead
  109251. */
  109252. outputRenderTarget: Nullable<RenderTargetTexture>;
  109253. /**
  109254. * Observable triggered when the camera view matrix has changed.
  109255. */
  109256. onViewMatrixChangedObservable: Observable<Camera>;
  109257. /**
  109258. * Observable triggered when the camera Projection matrix has changed.
  109259. */
  109260. onProjectionMatrixChangedObservable: Observable<Camera>;
  109261. /**
  109262. * Observable triggered when the inputs have been processed.
  109263. */
  109264. onAfterCheckInputsObservable: Observable<Camera>;
  109265. /**
  109266. * Observable triggered when reset has been called and applied to the camera.
  109267. */
  109268. onRestoreStateObservable: Observable<Camera>;
  109269. /**
  109270. * Is this camera a part of a rig system?
  109271. */
  109272. isRigCamera: boolean;
  109273. /**
  109274. * If isRigCamera set to true this will be set with the parent camera.
  109275. * The parent camera is not (!) necessarily the .parent of this camera (like in the case of XR)
  109276. */
  109277. rigParent?: Camera;
  109278. /** @hidden */
  109279. _cameraRigParams: any;
  109280. /** @hidden */
  109281. _rigCameras: Camera[];
  109282. /** @hidden */
  109283. _rigPostProcess: Nullable<PostProcess>;
  109284. protected _webvrViewMatrix: Matrix;
  109285. /** @hidden */
  109286. _skipRendering: boolean;
  109287. /** @hidden */
  109288. _projectionMatrix: Matrix;
  109289. /** @hidden */
  109290. _postProcesses: Nullable<PostProcess>[];
  109291. /** @hidden */
  109292. _activeMeshes: SmartArray<AbstractMesh>;
  109293. protected _globalPosition: Vector3;
  109294. /** @hidden */
  109295. _computedViewMatrix: Matrix;
  109296. private _doNotComputeProjectionMatrix;
  109297. private _transformMatrix;
  109298. private _frustumPlanes;
  109299. private _refreshFrustumPlanes;
  109300. private _storedFov;
  109301. private _stateStored;
  109302. /**
  109303. * Instantiates a new camera object.
  109304. * This should not be used directly but through the inherited cameras: ArcRotate, Free...
  109305. * @see https://doc.babylonjs.com/features/cameras
  109306. * @param name Defines the name of the camera in the scene
  109307. * @param position Defines the position of the camera
  109308. * @param scene Defines the scene the camera belongs too
  109309. * @param setActiveOnSceneIfNoneActive Defines if the camera should be set as active after creation if no other camera have been defined in the scene
  109310. */
  109311. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  109312. /**
  109313. * Store current camera state (fov, position, etc..)
  109314. * @returns the camera
  109315. */
  109316. storeState(): Camera;
  109317. /**
  109318. * Restores the camera state values if it has been stored. You must call storeState() first
  109319. */
  109320. protected _restoreStateValues(): boolean;
  109321. /**
  109322. * Restored camera state. You must call storeState() first.
  109323. * @returns true if restored and false otherwise
  109324. */
  109325. restoreState(): boolean;
  109326. /**
  109327. * Gets the class name of the camera.
  109328. * @returns the class name
  109329. */
  109330. getClassName(): string;
  109331. /** @hidden */
  109332. readonly _isCamera: boolean;
  109333. /**
  109334. * Gets a string representation of the camera useful for debug purpose.
  109335. * @param fullDetails Defines that a more verboe level of logging is required
  109336. * @returns the string representation
  109337. */
  109338. toString(fullDetails?: boolean): string;
  109339. /**
  109340. * Gets the current world space position of the camera.
  109341. */
  109342. get globalPosition(): Vector3;
  109343. /**
  109344. * Gets the list of active meshes this frame (meshes no culled or excluded by lod s in the frame)
  109345. * @returns the active meshe list
  109346. */
  109347. getActiveMeshes(): SmartArray<AbstractMesh>;
  109348. /**
  109349. * Check whether a mesh is part of the current active mesh list of the camera
  109350. * @param mesh Defines the mesh to check
  109351. * @returns true if active, false otherwise
  109352. */
  109353. isActiveMesh(mesh: Mesh): boolean;
  109354. /**
  109355. * Is this camera ready to be used/rendered
  109356. * @param completeCheck defines if a complete check (including post processes) has to be done (false by default)
  109357. * @return true if the camera is ready
  109358. */
  109359. isReady(completeCheck?: boolean): boolean;
  109360. /** @hidden */
  109361. _initCache(): void;
  109362. /** @hidden */
  109363. _updateCache(ignoreParentClass?: boolean): void;
  109364. /** @hidden */
  109365. _isSynchronized(): boolean;
  109366. /** @hidden */
  109367. _isSynchronizedViewMatrix(): boolean;
  109368. /** @hidden */
  109369. _isSynchronizedProjectionMatrix(): boolean;
  109370. /**
  109371. * Attach the input controls to a specific dom element to get the input from.
  109372. * @param element Defines the element the controls should be listened from
  109373. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  109374. */
  109375. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  109376. /**
  109377. * Detach the current controls from the specified dom element.
  109378. * @param element Defines the element to stop listening the inputs from
  109379. */
  109380. detachControl(element: HTMLElement): void;
  109381. /**
  109382. * Update the camera state according to the different inputs gathered during the frame.
  109383. */
  109384. update(): void;
  109385. /** @hidden */
  109386. _checkInputs(): void;
  109387. /** @hidden */
  109388. get rigCameras(): Camera[];
  109389. /**
  109390. * Gets the post process used by the rig cameras
  109391. */
  109392. get rigPostProcess(): Nullable<PostProcess>;
  109393. /**
  109394. * Internal, gets the first post proces.
  109395. * @returns the first post process to be run on this camera.
  109396. */
  109397. _getFirstPostProcess(): Nullable<PostProcess>;
  109398. private _cascadePostProcessesToRigCams;
  109399. /**
  109400. * Attach a post process to the camera.
  109401. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  109402. * @param postProcess The post process to attach to the camera
  109403. * @param insertAt The position of the post process in case several of them are in use in the scene
  109404. * @returns the position the post process has been inserted at
  109405. */
  109406. attachPostProcess(postProcess: PostProcess, insertAt?: Nullable<number>): number;
  109407. /**
  109408. * Detach a post process to the camera.
  109409. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  109410. * @param postProcess The post process to detach from the camera
  109411. */
  109412. detachPostProcess(postProcess: PostProcess): void;
  109413. /**
  109414. * Gets the current world matrix of the camera
  109415. */
  109416. getWorldMatrix(): Matrix;
  109417. /** @hidden */
  109418. _getViewMatrix(): Matrix;
  109419. /**
  109420. * Gets the current view matrix of the camera.
  109421. * @param force forces the camera to recompute the matrix without looking at the cached state
  109422. * @returns the view matrix
  109423. */
  109424. getViewMatrix(force?: boolean): Matrix;
  109425. /**
  109426. * Freeze the projection matrix.
  109427. * It will prevent the cache check of the camera projection compute and can speed up perf
  109428. * if no parameter of the camera are meant to change
  109429. * @param projection Defines manually a projection if necessary
  109430. */
  109431. freezeProjectionMatrix(projection?: Matrix): void;
  109432. /**
  109433. * Unfreeze the projection matrix if it has previously been freezed by freezeProjectionMatrix.
  109434. */
  109435. unfreezeProjectionMatrix(): void;
  109436. /**
  109437. * Gets the current projection matrix of the camera.
  109438. * @param force forces the camera to recompute the matrix without looking at the cached state
  109439. * @returns the projection matrix
  109440. */
  109441. getProjectionMatrix(force?: boolean): Matrix;
  109442. /**
  109443. * Gets the transformation matrix (ie. the multiplication of view by projection matrices)
  109444. * @returns a Matrix
  109445. */
  109446. getTransformationMatrix(): Matrix;
  109447. private _updateFrustumPlanes;
  109448. /**
  109449. * Checks if a cullable object (mesh...) is in the camera frustum
  109450. * This checks the bounding box center. See isCompletelyInFrustum for a full bounding check
  109451. * @param target The object to check
  109452. * @param checkRigCameras If the rig cameras should be checked (eg. with webVR camera both eyes should be checked) (Default: false)
  109453. * @returns true if the object is in frustum otherwise false
  109454. */
  109455. isInFrustum(target: ICullable, checkRigCameras?: boolean): boolean;
  109456. /**
  109457. * Checks if a cullable object (mesh...) is in the camera frustum
  109458. * Unlike isInFrustum this cheks the full bounding box
  109459. * @param target The object to check
  109460. * @returns true if the object is in frustum otherwise false
  109461. */
  109462. isCompletelyInFrustum(target: ICullable): boolean;
  109463. /**
  109464. * Gets a ray in the forward direction from the camera.
  109465. * @param length Defines the length of the ray to create
  109466. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  109467. * @param origin Defines the start point of the ray which defaults to the camera position
  109468. * @returns the forward ray
  109469. */
  109470. getForwardRay(length?: number, transform?: Matrix, origin?: Vector3): Ray;
  109471. /**
  109472. * Gets a ray in the forward direction from the camera.
  109473. * @param refRay the ray to (re)use when setting the values
  109474. * @param length Defines the length of the ray to create
  109475. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  109476. * @param origin Defines the start point of the ray which defaults to the camera position
  109477. * @returns the forward ray
  109478. */
  109479. getForwardRayToRef(refRay: Ray, length?: number, transform?: Matrix, origin?: Vector3): Ray;
  109480. /**
  109481. * Releases resources associated with this node.
  109482. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  109483. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  109484. */
  109485. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  109486. /** @hidden */
  109487. _isLeftCamera: boolean;
  109488. /**
  109489. * Gets the left camera of a rig setup in case of Rigged Camera
  109490. */
  109491. get isLeftCamera(): boolean;
  109492. /** @hidden */
  109493. _isRightCamera: boolean;
  109494. /**
  109495. * Gets the right camera of a rig setup in case of Rigged Camera
  109496. */
  109497. get isRightCamera(): boolean;
  109498. /**
  109499. * Gets the left camera of a rig setup in case of Rigged Camera
  109500. */
  109501. get leftCamera(): Nullable<FreeCamera>;
  109502. /**
  109503. * Gets the right camera of a rig setup in case of Rigged Camera
  109504. */
  109505. get rightCamera(): Nullable<FreeCamera>;
  109506. /**
  109507. * Gets the left camera target of a rig setup in case of Rigged Camera
  109508. * @returns the target position
  109509. */
  109510. getLeftTarget(): Nullable<Vector3>;
  109511. /**
  109512. * Gets the right camera target of a rig setup in case of Rigged Camera
  109513. * @returns the target position
  109514. */
  109515. getRightTarget(): Nullable<Vector3>;
  109516. /**
  109517. * @hidden
  109518. */
  109519. setCameraRigMode(mode: number, rigParams: any): void;
  109520. /** @hidden */
  109521. static _setStereoscopicRigMode(camera: Camera): void;
  109522. /** @hidden */
  109523. static _setStereoscopicAnaglyphRigMode(camera: Camera): void;
  109524. /** @hidden */
  109525. static _setVRRigMode(camera: Camera, rigParams: any): void;
  109526. /** @hidden */
  109527. static _setWebVRRigMode(camera: Camera, rigParams: any): void;
  109528. /** @hidden */
  109529. _getVRProjectionMatrix(): Matrix;
  109530. protected _updateCameraRotationMatrix(): void;
  109531. protected _updateWebVRCameraRotationMatrix(): void;
  109532. /**
  109533. * This function MUST be overwritten by the different WebVR cameras available.
  109534. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  109535. * @hidden
  109536. */
  109537. _getWebVRProjectionMatrix(): Matrix;
  109538. /**
  109539. * This function MUST be overwritten by the different WebVR cameras available.
  109540. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  109541. * @hidden
  109542. */
  109543. _getWebVRViewMatrix(): Matrix;
  109544. /** @hidden */
  109545. setCameraRigParameter(name: string, value: any): void;
  109546. /**
  109547. * needs to be overridden by children so sub has required properties to be copied
  109548. * @hidden
  109549. */
  109550. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  109551. /**
  109552. * May need to be overridden by children
  109553. * @hidden
  109554. */
  109555. _updateRigCameras(): void;
  109556. /** @hidden */
  109557. _setupInputs(): void;
  109558. /**
  109559. * Serialiaze the camera setup to a json represention
  109560. * @returns the JSON representation
  109561. */
  109562. serialize(): any;
  109563. /**
  109564. * Clones the current camera.
  109565. * @param name The cloned camera name
  109566. * @returns the cloned camera
  109567. */
  109568. clone(name: string): Camera;
  109569. /**
  109570. * Gets the direction of the camera relative to a given local axis.
  109571. * @param localAxis Defines the reference axis to provide a relative direction.
  109572. * @return the direction
  109573. */
  109574. getDirection(localAxis: Vector3): Vector3;
  109575. /**
  109576. * Returns the current camera absolute rotation
  109577. */
  109578. get absoluteRotation(): Quaternion;
  109579. /**
  109580. * Gets the direction of the camera relative to a given local axis into a passed vector.
  109581. * @param localAxis Defines the reference axis to provide a relative direction.
  109582. * @param result Defines the vector to store the result in
  109583. */
  109584. getDirectionToRef(localAxis: Vector3, result: Vector3): void;
  109585. /**
  109586. * Gets a camera constructor for a given camera type
  109587. * @param type The type of the camera to construct (should be equal to one of the camera class name)
  109588. * @param name The name of the camera the result will be able to instantiate
  109589. * @param scene The scene the result will construct the camera in
  109590. * @param interaxial_distance In case of stereoscopic setup, the distance between both eyes
  109591. * @param isStereoscopicSideBySide In case of stereoscopic setup, should the sereo be side b side
  109592. * @returns a factory method to construc the camera
  109593. */
  109594. static GetConstructorFromName(type: string, name: string, scene: Scene, interaxial_distance?: number, isStereoscopicSideBySide?: boolean): () => Camera;
  109595. /**
  109596. * Compute the world matrix of the camera.
  109597. * @returns the camera world matrix
  109598. */
  109599. computeWorldMatrix(): Matrix;
  109600. /**
  109601. * Parse a JSON and creates the camera from the parsed information
  109602. * @param parsedCamera The JSON to parse
  109603. * @param scene The scene to instantiate the camera in
  109604. * @returns the newly constructed camera
  109605. */
  109606. static Parse(parsedCamera: any, scene: Scene): Camera;
  109607. }
  109608. }
  109609. declare module BABYLON {
  109610. /**
  109611. * Class containing static functions to help procedurally build meshes
  109612. */
  109613. export class DiscBuilder {
  109614. /**
  109615. * Creates a plane polygonal mesh. By default, this is a disc
  109616. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  109617. * * 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
  109618. * * 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
  109619. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  109620. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  109621. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  109622. * @param name defines the name of the mesh
  109623. * @param options defines the options used to create the mesh
  109624. * @param scene defines the hosting scene
  109625. * @returns the plane polygonal mesh
  109626. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  109627. */
  109628. static CreateDisc(name: string, options: {
  109629. radius?: number;
  109630. tessellation?: number;
  109631. arc?: number;
  109632. updatable?: boolean;
  109633. sideOrientation?: number;
  109634. frontUVs?: Vector4;
  109635. backUVs?: Vector4;
  109636. }, scene?: Nullable<Scene>): Mesh;
  109637. }
  109638. }
  109639. declare module BABYLON {
  109640. /**
  109641. * Options to be used when creating a FresnelParameters.
  109642. */
  109643. export type IFresnelParametersCreationOptions = {
  109644. /**
  109645. * Define the color used on edges (grazing angle)
  109646. */
  109647. leftColor?: Color3;
  109648. /**
  109649. * Define the color used on center
  109650. */
  109651. rightColor?: Color3;
  109652. /**
  109653. * Define bias applied to computed fresnel term
  109654. */
  109655. bias?: number;
  109656. /**
  109657. * Defined the power exponent applied to fresnel term
  109658. */
  109659. power?: number;
  109660. /**
  109661. * Define if the fresnel effect is enable or not.
  109662. */
  109663. isEnabled?: boolean;
  109664. };
  109665. /**
  109666. * Serialized format for FresnelParameters.
  109667. */
  109668. export type IFresnelParametersSerialized = {
  109669. /**
  109670. * Define the color used on edges (grazing angle) [as an array]
  109671. */
  109672. leftColor: number[];
  109673. /**
  109674. * Define the color used on center [as an array]
  109675. */
  109676. rightColor: number[];
  109677. /**
  109678. * Define bias applied to computed fresnel term
  109679. */
  109680. bias: number;
  109681. /**
  109682. * Defined the power exponent applied to fresnel term
  109683. */
  109684. power?: number;
  109685. /**
  109686. * Define if the fresnel effect is enable or not.
  109687. */
  109688. isEnabled: boolean;
  109689. };
  109690. /**
  109691. * This represents all the required information to add a fresnel effect on a material:
  109692. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  109693. */
  109694. export class FresnelParameters {
  109695. private _isEnabled;
  109696. /**
  109697. * Define if the fresnel effect is enable or not.
  109698. */
  109699. get isEnabled(): boolean;
  109700. set isEnabled(value: boolean);
  109701. /**
  109702. * Define the color used on edges (grazing angle)
  109703. */
  109704. leftColor: Color3;
  109705. /**
  109706. * Define the color used on center
  109707. */
  109708. rightColor: Color3;
  109709. /**
  109710. * Define bias applied to computed fresnel term
  109711. */
  109712. bias: number;
  109713. /**
  109714. * Defined the power exponent applied to fresnel term
  109715. */
  109716. power: number;
  109717. /**
  109718. * Creates a new FresnelParameters object.
  109719. *
  109720. * @param options provide your own settings to optionally to override defaults
  109721. */
  109722. constructor(options?: IFresnelParametersCreationOptions);
  109723. /**
  109724. * Clones the current fresnel and its valuues
  109725. * @returns a clone fresnel configuration
  109726. */
  109727. clone(): FresnelParameters;
  109728. /**
  109729. * Determines equality between FresnelParameters objects
  109730. * @param otherFresnelParameters defines the second operand
  109731. * @returns true if the power, bias, leftColor, rightColor and isEnabled values are equal to the given ones
  109732. */
  109733. equals(otherFresnelParameters: DeepImmutable<FresnelParameters>): boolean;
  109734. /**
  109735. * Serializes the current fresnel parameters to a JSON representation.
  109736. * @return the JSON serialization
  109737. */
  109738. serialize(): IFresnelParametersSerialized;
  109739. /**
  109740. * Parse a JSON object and deserialize it to a new Fresnel parameter object.
  109741. * @param parsedFresnelParameters Define the JSON representation
  109742. * @returns the parsed parameters
  109743. */
  109744. static Parse(parsedFresnelParameters: IFresnelParametersSerialized): FresnelParameters;
  109745. }
  109746. }
  109747. declare module BABYLON {
  109748. /**
  109749. * This groups all the flags used to control the materials channel.
  109750. */
  109751. export class MaterialFlags {
  109752. private static _DiffuseTextureEnabled;
  109753. /**
  109754. * Are diffuse textures enabled in the application.
  109755. */
  109756. static get DiffuseTextureEnabled(): boolean;
  109757. static set DiffuseTextureEnabled(value: boolean);
  109758. private static _DetailTextureEnabled;
  109759. /**
  109760. * Are detail textures enabled in the application.
  109761. */
  109762. static get DetailTextureEnabled(): boolean;
  109763. static set DetailTextureEnabled(value: boolean);
  109764. private static _AmbientTextureEnabled;
  109765. /**
  109766. * Are ambient textures enabled in the application.
  109767. */
  109768. static get AmbientTextureEnabled(): boolean;
  109769. static set AmbientTextureEnabled(value: boolean);
  109770. private static _OpacityTextureEnabled;
  109771. /**
  109772. * Are opacity textures enabled in the application.
  109773. */
  109774. static get OpacityTextureEnabled(): boolean;
  109775. static set OpacityTextureEnabled(value: boolean);
  109776. private static _ReflectionTextureEnabled;
  109777. /**
  109778. * Are reflection textures enabled in the application.
  109779. */
  109780. static get ReflectionTextureEnabled(): boolean;
  109781. static set ReflectionTextureEnabled(value: boolean);
  109782. private static _EmissiveTextureEnabled;
  109783. /**
  109784. * Are emissive textures enabled in the application.
  109785. */
  109786. static get EmissiveTextureEnabled(): boolean;
  109787. static set EmissiveTextureEnabled(value: boolean);
  109788. private static _SpecularTextureEnabled;
  109789. /**
  109790. * Are specular textures enabled in the application.
  109791. */
  109792. static get SpecularTextureEnabled(): boolean;
  109793. static set SpecularTextureEnabled(value: boolean);
  109794. private static _BumpTextureEnabled;
  109795. /**
  109796. * Are bump textures enabled in the application.
  109797. */
  109798. static get BumpTextureEnabled(): boolean;
  109799. static set BumpTextureEnabled(value: boolean);
  109800. private static _LightmapTextureEnabled;
  109801. /**
  109802. * Are lightmap textures enabled in the application.
  109803. */
  109804. static get LightmapTextureEnabled(): boolean;
  109805. static set LightmapTextureEnabled(value: boolean);
  109806. private static _RefractionTextureEnabled;
  109807. /**
  109808. * Are refraction textures enabled in the application.
  109809. */
  109810. static get RefractionTextureEnabled(): boolean;
  109811. static set RefractionTextureEnabled(value: boolean);
  109812. private static _ColorGradingTextureEnabled;
  109813. /**
  109814. * Are color grading textures enabled in the application.
  109815. */
  109816. static get ColorGradingTextureEnabled(): boolean;
  109817. static set ColorGradingTextureEnabled(value: boolean);
  109818. private static _FresnelEnabled;
  109819. /**
  109820. * Are fresnels enabled in the application.
  109821. */
  109822. static get FresnelEnabled(): boolean;
  109823. static set FresnelEnabled(value: boolean);
  109824. private static _ClearCoatTextureEnabled;
  109825. /**
  109826. * Are clear coat textures enabled in the application.
  109827. */
  109828. static get ClearCoatTextureEnabled(): boolean;
  109829. static set ClearCoatTextureEnabled(value: boolean);
  109830. private static _ClearCoatBumpTextureEnabled;
  109831. /**
  109832. * Are clear coat bump textures enabled in the application.
  109833. */
  109834. static get ClearCoatBumpTextureEnabled(): boolean;
  109835. static set ClearCoatBumpTextureEnabled(value: boolean);
  109836. private static _ClearCoatTintTextureEnabled;
  109837. /**
  109838. * Are clear coat tint textures enabled in the application.
  109839. */
  109840. static get ClearCoatTintTextureEnabled(): boolean;
  109841. static set ClearCoatTintTextureEnabled(value: boolean);
  109842. private static _SheenTextureEnabled;
  109843. /**
  109844. * Are sheen textures enabled in the application.
  109845. */
  109846. static get SheenTextureEnabled(): boolean;
  109847. static set SheenTextureEnabled(value: boolean);
  109848. private static _AnisotropicTextureEnabled;
  109849. /**
  109850. * Are anisotropic textures enabled in the application.
  109851. */
  109852. static get AnisotropicTextureEnabled(): boolean;
  109853. static set AnisotropicTextureEnabled(value: boolean);
  109854. private static _ThicknessTextureEnabled;
  109855. /**
  109856. * Are thickness textures enabled in the application.
  109857. */
  109858. static get ThicknessTextureEnabled(): boolean;
  109859. static set ThicknessTextureEnabled(value: boolean);
  109860. }
  109861. }
  109862. declare module BABYLON {
  109863. /** @hidden */
  109864. export var defaultFragmentDeclaration: {
  109865. name: string;
  109866. shader: string;
  109867. };
  109868. }
  109869. declare module BABYLON {
  109870. /** @hidden */
  109871. export var defaultUboDeclaration: {
  109872. name: string;
  109873. shader: string;
  109874. };
  109875. }
  109876. declare module BABYLON {
  109877. /** @hidden */
  109878. export var prePassDeclaration: {
  109879. name: string;
  109880. shader: string;
  109881. };
  109882. }
  109883. declare module BABYLON {
  109884. /** @hidden */
  109885. export var lightFragmentDeclaration: {
  109886. name: string;
  109887. shader: string;
  109888. };
  109889. }
  109890. declare module BABYLON {
  109891. /** @hidden */
  109892. export var lightUboDeclaration: {
  109893. name: string;
  109894. shader: string;
  109895. };
  109896. }
  109897. declare module BABYLON {
  109898. /** @hidden */
  109899. export var lightsFragmentFunctions: {
  109900. name: string;
  109901. shader: string;
  109902. };
  109903. }
  109904. declare module BABYLON {
  109905. /** @hidden */
  109906. export var shadowsFragmentFunctions: {
  109907. name: string;
  109908. shader: string;
  109909. };
  109910. }
  109911. declare module BABYLON {
  109912. /** @hidden */
  109913. export var fresnelFunction: {
  109914. name: string;
  109915. shader: string;
  109916. };
  109917. }
  109918. declare module BABYLON {
  109919. /** @hidden */
  109920. export var bumpFragmentMainFunctions: {
  109921. name: string;
  109922. shader: string;
  109923. };
  109924. }
  109925. declare module BABYLON {
  109926. /** @hidden */
  109927. export var bumpFragmentFunctions: {
  109928. name: string;
  109929. shader: string;
  109930. };
  109931. }
  109932. declare module BABYLON {
  109933. /** @hidden */
  109934. export var logDepthDeclaration: {
  109935. name: string;
  109936. shader: string;
  109937. };
  109938. }
  109939. declare module BABYLON {
  109940. /** @hidden */
  109941. export var bumpFragment: {
  109942. name: string;
  109943. shader: string;
  109944. };
  109945. }
  109946. declare module BABYLON {
  109947. /** @hidden */
  109948. export var depthPrePass: {
  109949. name: string;
  109950. shader: string;
  109951. };
  109952. }
  109953. declare module BABYLON {
  109954. /** @hidden */
  109955. export var lightFragment: {
  109956. name: string;
  109957. shader: string;
  109958. };
  109959. }
  109960. declare module BABYLON {
  109961. /** @hidden */
  109962. export var logDepthFragment: {
  109963. name: string;
  109964. shader: string;
  109965. };
  109966. }
  109967. declare module BABYLON {
  109968. /** @hidden */
  109969. export var defaultPixelShader: {
  109970. name: string;
  109971. shader: string;
  109972. };
  109973. }
  109974. declare module BABYLON {
  109975. /** @hidden */
  109976. export var defaultVertexDeclaration: {
  109977. name: string;
  109978. shader: string;
  109979. };
  109980. }
  109981. declare module BABYLON {
  109982. /** @hidden */
  109983. export var bumpVertexDeclaration: {
  109984. name: string;
  109985. shader: string;
  109986. };
  109987. }
  109988. declare module BABYLON {
  109989. /** @hidden */
  109990. export var bumpVertex: {
  109991. name: string;
  109992. shader: string;
  109993. };
  109994. }
  109995. declare module BABYLON {
  109996. /** @hidden */
  109997. export var fogVertex: {
  109998. name: string;
  109999. shader: string;
  110000. };
  110001. }
  110002. declare module BABYLON {
  110003. /** @hidden */
  110004. export var shadowsVertex: {
  110005. name: string;
  110006. shader: string;
  110007. };
  110008. }
  110009. declare module BABYLON {
  110010. /** @hidden */
  110011. export var pointCloudVertex: {
  110012. name: string;
  110013. shader: string;
  110014. };
  110015. }
  110016. declare module BABYLON {
  110017. /** @hidden */
  110018. export var logDepthVertex: {
  110019. name: string;
  110020. shader: string;
  110021. };
  110022. }
  110023. declare module BABYLON {
  110024. /** @hidden */
  110025. export var defaultVertexShader: {
  110026. name: string;
  110027. shader: string;
  110028. };
  110029. }
  110030. declare module BABYLON {
  110031. /**
  110032. * @hidden
  110033. */
  110034. export interface IMaterialDetailMapDefines {
  110035. DETAIL: boolean;
  110036. DETAILDIRECTUV: number;
  110037. DETAIL_NORMALBLENDMETHOD: number;
  110038. /** @hidden */
  110039. _areTexturesDirty: boolean;
  110040. }
  110041. /**
  110042. * Define the code related to the detail map parameters of a material
  110043. *
  110044. * Inspired from:
  110045. * 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
  110046. * Unreal: https://docs.unrealengine.com/en-US/Engine/Rendering/Materials/HowTo/DetailTexturing/index.html
  110047. * Cryengine: https://docs.cryengine.com/display/SDKDOC2/Detail+Maps
  110048. */
  110049. export class DetailMapConfiguration {
  110050. private _texture;
  110051. /**
  110052. * The detail texture of the material.
  110053. */
  110054. texture: Nullable<BaseTexture>;
  110055. /**
  110056. * Defines how strongly the detail diffuse/albedo channel is blended with the regular diffuse/albedo texture
  110057. * Bigger values mean stronger blending
  110058. */
  110059. diffuseBlendLevel: number;
  110060. /**
  110061. * Defines how strongly the detail roughness channel is blended with the regular roughness value
  110062. * Bigger values mean stronger blending. Only used with PBR materials
  110063. */
  110064. roughnessBlendLevel: number;
  110065. /**
  110066. * Defines how strong the bump effect from the detail map is
  110067. * Bigger values mean stronger effect
  110068. */
  110069. bumpLevel: number;
  110070. private _normalBlendMethod;
  110071. /**
  110072. * The method used to blend the bump and detail normals together
  110073. */
  110074. normalBlendMethod: number;
  110075. private _isEnabled;
  110076. /**
  110077. * Enable or disable the detail map on this material
  110078. */
  110079. isEnabled: boolean;
  110080. /** @hidden */
  110081. private _internalMarkAllSubMeshesAsTexturesDirty;
  110082. /** @hidden */
  110083. _markAllSubMeshesAsTexturesDirty(): void;
  110084. /**
  110085. * Instantiate a new detail map
  110086. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  110087. */
  110088. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  110089. /**
  110090. * Gets whether the submesh is ready to be used or not.
  110091. * @param defines the list of "defines" to update.
  110092. * @param scene defines the scene the material belongs to.
  110093. * @returns - boolean indicating that the submesh is ready or not.
  110094. */
  110095. isReadyForSubMesh(defines: IMaterialDetailMapDefines, scene: Scene): boolean;
  110096. /**
  110097. * Update the defines for detail map usage
  110098. * @param defines the list of "defines" to update.
  110099. * @param scene defines the scene the material belongs to.
  110100. */
  110101. prepareDefines(defines: IMaterialDetailMapDefines, scene: Scene): void;
  110102. /**
  110103. * Binds the material data.
  110104. * @param uniformBuffer defines the Uniform buffer to fill in.
  110105. * @param scene defines the scene the material belongs to.
  110106. * @param isFrozen defines whether the material is frozen or not.
  110107. */
  110108. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  110109. /**
  110110. * Checks to see if a texture is used in the material.
  110111. * @param texture - Base texture to use.
  110112. * @returns - Boolean specifying if a texture is used in the material.
  110113. */
  110114. hasTexture(texture: BaseTexture): boolean;
  110115. /**
  110116. * Returns an array of the actively used textures.
  110117. * @param activeTextures Array of BaseTextures
  110118. */
  110119. getActiveTextures(activeTextures: BaseTexture[]): void;
  110120. /**
  110121. * Returns the animatable textures.
  110122. * @param animatables Array of animatable textures.
  110123. */
  110124. getAnimatables(animatables: IAnimatable[]): void;
  110125. /**
  110126. * Disposes the resources of the material.
  110127. * @param forceDisposeTextures - Forces the disposal of all textures.
  110128. */
  110129. dispose(forceDisposeTextures?: boolean): void;
  110130. /**
  110131. * Get the current class name useful for serialization or dynamic coding.
  110132. * @returns "DetailMap"
  110133. */
  110134. getClassName(): string;
  110135. /**
  110136. * Add the required uniforms to the current list.
  110137. * @param uniforms defines the current uniform list.
  110138. */
  110139. static AddUniforms(uniforms: string[]): void;
  110140. /**
  110141. * Add the required samplers to the current list.
  110142. * @param samplers defines the current sampler list.
  110143. */
  110144. static AddSamplers(samplers: string[]): void;
  110145. /**
  110146. * Add the required uniforms to the current buffer.
  110147. * @param uniformBuffer defines the current uniform buffer.
  110148. */
  110149. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  110150. /**
  110151. * Makes a duplicate of the current instance into another one.
  110152. * @param detailMap define the instance where to copy the info
  110153. */
  110154. copyTo(detailMap: DetailMapConfiguration): void;
  110155. /**
  110156. * Serializes this detail map instance
  110157. * @returns - An object with the serialized instance.
  110158. */
  110159. serialize(): any;
  110160. /**
  110161. * Parses a detail map setting from a serialized object.
  110162. * @param source - Serialized object.
  110163. * @param scene Defines the scene we are parsing for
  110164. * @param rootUrl Defines the rootUrl to load from
  110165. */
  110166. parse(source: any, scene: Scene, rootUrl: string): void;
  110167. }
  110168. }
  110169. declare module BABYLON {
  110170. /** @hidden */
  110171. export class StandardMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialDetailMapDefines {
  110172. MAINUV1: boolean;
  110173. MAINUV2: boolean;
  110174. DIFFUSE: boolean;
  110175. DIFFUSEDIRECTUV: number;
  110176. DETAIL: boolean;
  110177. DETAILDIRECTUV: number;
  110178. DETAIL_NORMALBLENDMETHOD: number;
  110179. AMBIENT: boolean;
  110180. AMBIENTDIRECTUV: number;
  110181. OPACITY: boolean;
  110182. OPACITYDIRECTUV: number;
  110183. OPACITYRGB: boolean;
  110184. REFLECTION: boolean;
  110185. EMISSIVE: boolean;
  110186. EMISSIVEDIRECTUV: number;
  110187. SPECULAR: boolean;
  110188. SPECULARDIRECTUV: number;
  110189. BUMP: boolean;
  110190. BUMPDIRECTUV: number;
  110191. PARALLAX: boolean;
  110192. PARALLAXOCCLUSION: boolean;
  110193. SPECULAROVERALPHA: boolean;
  110194. CLIPPLANE: boolean;
  110195. CLIPPLANE2: boolean;
  110196. CLIPPLANE3: boolean;
  110197. CLIPPLANE4: boolean;
  110198. CLIPPLANE5: boolean;
  110199. CLIPPLANE6: boolean;
  110200. ALPHATEST: boolean;
  110201. DEPTHPREPASS: boolean;
  110202. ALPHAFROMDIFFUSE: boolean;
  110203. POINTSIZE: boolean;
  110204. FOG: boolean;
  110205. SPECULARTERM: boolean;
  110206. DIFFUSEFRESNEL: boolean;
  110207. OPACITYFRESNEL: boolean;
  110208. REFLECTIONFRESNEL: boolean;
  110209. REFRACTIONFRESNEL: boolean;
  110210. EMISSIVEFRESNEL: boolean;
  110211. FRESNEL: boolean;
  110212. NORMAL: boolean;
  110213. UV1: boolean;
  110214. UV2: boolean;
  110215. VERTEXCOLOR: boolean;
  110216. VERTEXALPHA: boolean;
  110217. NUM_BONE_INFLUENCERS: number;
  110218. BonesPerMesh: number;
  110219. BONETEXTURE: boolean;
  110220. INSTANCES: boolean;
  110221. THIN_INSTANCES: boolean;
  110222. GLOSSINESS: boolean;
  110223. ROUGHNESS: boolean;
  110224. EMISSIVEASILLUMINATION: boolean;
  110225. LINKEMISSIVEWITHDIFFUSE: boolean;
  110226. REFLECTIONFRESNELFROMSPECULAR: boolean;
  110227. LIGHTMAP: boolean;
  110228. LIGHTMAPDIRECTUV: number;
  110229. OBJECTSPACE_NORMALMAP: boolean;
  110230. USELIGHTMAPASSHADOWMAP: boolean;
  110231. REFLECTIONMAP_3D: boolean;
  110232. REFLECTIONMAP_SPHERICAL: boolean;
  110233. REFLECTIONMAP_PLANAR: boolean;
  110234. REFLECTIONMAP_CUBIC: boolean;
  110235. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  110236. REFLECTIONMAP_PROJECTION: boolean;
  110237. REFLECTIONMAP_SKYBOX: boolean;
  110238. REFLECTIONMAP_EXPLICIT: boolean;
  110239. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  110240. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  110241. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  110242. INVERTCUBICMAP: boolean;
  110243. LOGARITHMICDEPTH: boolean;
  110244. REFRACTION: boolean;
  110245. REFRACTIONMAP_3D: boolean;
  110246. REFLECTIONOVERALPHA: boolean;
  110247. TWOSIDEDLIGHTING: boolean;
  110248. SHADOWFLOAT: boolean;
  110249. MORPHTARGETS: boolean;
  110250. MORPHTARGETS_NORMAL: boolean;
  110251. MORPHTARGETS_TANGENT: boolean;
  110252. MORPHTARGETS_UV: boolean;
  110253. NUM_MORPH_INFLUENCERS: number;
  110254. NONUNIFORMSCALING: boolean;
  110255. PREMULTIPLYALPHA: boolean;
  110256. ALPHATEST_AFTERALLALPHACOMPUTATIONS: boolean;
  110257. ALPHABLEND: boolean;
  110258. PREPASS: boolean;
  110259. SCENE_MRT_COUNT: number;
  110260. RGBDLIGHTMAP: boolean;
  110261. RGBDREFLECTION: boolean;
  110262. RGBDREFRACTION: boolean;
  110263. IMAGEPROCESSING: boolean;
  110264. VIGNETTE: boolean;
  110265. VIGNETTEBLENDMODEMULTIPLY: boolean;
  110266. VIGNETTEBLENDMODEOPAQUE: boolean;
  110267. TONEMAPPING: boolean;
  110268. TONEMAPPING_ACES: boolean;
  110269. CONTRAST: boolean;
  110270. COLORCURVES: boolean;
  110271. COLORGRADING: boolean;
  110272. COLORGRADING3D: boolean;
  110273. SAMPLER3DGREENDEPTH: boolean;
  110274. SAMPLER3DBGRMAP: boolean;
  110275. IMAGEPROCESSINGPOSTPROCESS: boolean;
  110276. MULTIVIEW: boolean;
  110277. /**
  110278. * If the reflection texture on this material is in linear color space
  110279. * @hidden
  110280. */
  110281. IS_REFLECTION_LINEAR: boolean;
  110282. /**
  110283. * If the refraction texture on this material is in linear color space
  110284. * @hidden
  110285. */
  110286. IS_REFRACTION_LINEAR: boolean;
  110287. EXPOSURE: boolean;
  110288. constructor();
  110289. setReflectionMode(modeToEnable: string): void;
  110290. }
  110291. /**
  110292. * This is the default material used in Babylon. It is the best trade off between quality
  110293. * and performances.
  110294. * @see https://doc.babylonjs.com/babylon101/materials
  110295. */
  110296. export class StandardMaterial extends PushMaterial {
  110297. private _diffuseTexture;
  110298. /**
  110299. * The basic texture of the material as viewed under a light.
  110300. */
  110301. diffuseTexture: Nullable<BaseTexture>;
  110302. private _ambientTexture;
  110303. /**
  110304. * AKA Occlusion Texture in other nomenclature, it helps adding baked shadows into your material.
  110305. */
  110306. ambientTexture: Nullable<BaseTexture>;
  110307. private _opacityTexture;
  110308. /**
  110309. * Define the transparency of the material from a texture.
  110310. * The final alpha value can be read either from the red channel (if texture.getAlphaFromRGB is false)
  110311. * or from the luminance or the current texel (if texture.getAlphaFromRGB is true)
  110312. */
  110313. opacityTexture: Nullable<BaseTexture>;
  110314. private _reflectionTexture;
  110315. /**
  110316. * Define the texture used to display the reflection.
  110317. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  110318. */
  110319. reflectionTexture: Nullable<BaseTexture>;
  110320. private _emissiveTexture;
  110321. /**
  110322. * Define texture of the material as if self lit.
  110323. * This will be mixed in the final result even in the absence of light.
  110324. */
  110325. emissiveTexture: Nullable<BaseTexture>;
  110326. private _specularTexture;
  110327. /**
  110328. * Define how the color and intensity of the highlight given by the light in the material.
  110329. */
  110330. specularTexture: Nullable<BaseTexture>;
  110331. private _bumpTexture;
  110332. /**
  110333. * Bump mapping is a technique to simulate bump and dents on a rendered surface.
  110334. * 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.
  110335. * @see https://doc.babylonjs.com/how_to/more_materials#bump-map
  110336. */
  110337. bumpTexture: Nullable<BaseTexture>;
  110338. private _lightmapTexture;
  110339. /**
  110340. * Complex lighting can be computationally expensive to compute at runtime.
  110341. * To save on computation, lightmaps may be used to store calculated lighting in a texture which will be applied to a given mesh.
  110342. * @see https://doc.babylonjs.com/babylon101/lights#lightmaps
  110343. */
  110344. lightmapTexture: Nullable<BaseTexture>;
  110345. private _refractionTexture;
  110346. /**
  110347. * Define the texture used to display the refraction.
  110348. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  110349. */
  110350. refractionTexture: Nullable<BaseTexture>;
  110351. /**
  110352. * The color of the material lit by the environmental background lighting.
  110353. * @see https://doc.babylonjs.com/babylon101/materials#ambient-color-example
  110354. */
  110355. ambientColor: Color3;
  110356. /**
  110357. * The basic color of the material as viewed under a light.
  110358. */
  110359. diffuseColor: Color3;
  110360. /**
  110361. * Define how the color and intensity of the highlight given by the light in the material.
  110362. */
  110363. specularColor: Color3;
  110364. /**
  110365. * Define the color of the material as if self lit.
  110366. * This will be mixed in the final result even in the absence of light.
  110367. */
  110368. emissiveColor: Color3;
  110369. /**
  110370. * Defines how sharp are the highlights in the material.
  110371. * The bigger the value the sharper giving a more glossy feeling to the result.
  110372. * Reversely, the smaller the value the blurrier giving a more rough feeling to the result.
  110373. */
  110374. specularPower: number;
  110375. private _useAlphaFromDiffuseTexture;
  110376. /**
  110377. * Does the transparency come from the diffuse texture alpha channel.
  110378. */
  110379. useAlphaFromDiffuseTexture: boolean;
  110380. private _useEmissiveAsIllumination;
  110381. /**
  110382. * If true, the emissive value is added into the end result, otherwise it is multiplied in.
  110383. */
  110384. useEmissiveAsIllumination: boolean;
  110385. private _linkEmissiveWithDiffuse;
  110386. /**
  110387. * If true, some kind of energy conservation will prevent the end result to be more than 1 by reducing
  110388. * the emissive level when the final color is close to one.
  110389. */
  110390. linkEmissiveWithDiffuse: boolean;
  110391. private _useSpecularOverAlpha;
  110392. /**
  110393. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  110394. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  110395. */
  110396. useSpecularOverAlpha: boolean;
  110397. private _useReflectionOverAlpha;
  110398. /**
  110399. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  110400. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  110401. */
  110402. useReflectionOverAlpha: boolean;
  110403. private _disableLighting;
  110404. /**
  110405. * Does lights from the scene impacts this material.
  110406. * It can be a nice trick for performance to disable lighting on a fully emissive material.
  110407. */
  110408. disableLighting: boolean;
  110409. private _useObjectSpaceNormalMap;
  110410. /**
  110411. * Allows using an object space normal map (instead of tangent space).
  110412. */
  110413. useObjectSpaceNormalMap: boolean;
  110414. private _useParallax;
  110415. /**
  110416. * Is parallax enabled or not.
  110417. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  110418. */
  110419. useParallax: boolean;
  110420. private _useParallaxOcclusion;
  110421. /**
  110422. * Is parallax occlusion enabled or not.
  110423. * If true, the outcome is way more realistic than traditional Parallax but you can expect a performance hit that worthes consideration.
  110424. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  110425. */
  110426. useParallaxOcclusion: boolean;
  110427. /**
  110428. * 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.
  110429. */
  110430. parallaxScaleBias: number;
  110431. private _roughness;
  110432. /**
  110433. * Helps to define how blurry the reflections should appears in the material.
  110434. */
  110435. roughness: number;
  110436. /**
  110437. * In case of refraction, define the value of the index of refraction.
  110438. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  110439. */
  110440. indexOfRefraction: number;
  110441. /**
  110442. * Invert the refraction texture alongside the y axis.
  110443. * It can be useful with procedural textures or probe for instance.
  110444. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  110445. */
  110446. invertRefractionY: boolean;
  110447. /**
  110448. * Defines the alpha limits in alpha test mode.
  110449. */
  110450. alphaCutOff: number;
  110451. private _useLightmapAsShadowmap;
  110452. /**
  110453. * In case of light mapping, define whether the map contains light or shadow informations.
  110454. */
  110455. useLightmapAsShadowmap: boolean;
  110456. private _diffuseFresnelParameters;
  110457. /**
  110458. * Define the diffuse fresnel parameters of the material.
  110459. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  110460. */
  110461. diffuseFresnelParameters: FresnelParameters;
  110462. private _opacityFresnelParameters;
  110463. /**
  110464. * Define the opacity fresnel parameters of the material.
  110465. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  110466. */
  110467. opacityFresnelParameters: FresnelParameters;
  110468. private _reflectionFresnelParameters;
  110469. /**
  110470. * Define the reflection fresnel parameters of the material.
  110471. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  110472. */
  110473. reflectionFresnelParameters: FresnelParameters;
  110474. private _refractionFresnelParameters;
  110475. /**
  110476. * Define the refraction fresnel parameters of the material.
  110477. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  110478. */
  110479. refractionFresnelParameters: FresnelParameters;
  110480. private _emissiveFresnelParameters;
  110481. /**
  110482. * Define the emissive fresnel parameters of the material.
  110483. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  110484. */
  110485. emissiveFresnelParameters: FresnelParameters;
  110486. private _useReflectionFresnelFromSpecular;
  110487. /**
  110488. * If true automatically deducts the fresnels values from the material specularity.
  110489. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  110490. */
  110491. useReflectionFresnelFromSpecular: boolean;
  110492. private _useGlossinessFromSpecularMapAlpha;
  110493. /**
  110494. * Defines if the glossiness/roughness of the material should be read from the specular map alpha channel
  110495. */
  110496. useGlossinessFromSpecularMapAlpha: boolean;
  110497. private _maxSimultaneousLights;
  110498. /**
  110499. * Defines the maximum number of lights that can be used in the material
  110500. */
  110501. maxSimultaneousLights: number;
  110502. private _invertNormalMapX;
  110503. /**
  110504. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  110505. */
  110506. invertNormalMapX: boolean;
  110507. private _invertNormalMapY;
  110508. /**
  110509. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  110510. */
  110511. invertNormalMapY: boolean;
  110512. private _twoSidedLighting;
  110513. /**
  110514. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  110515. */
  110516. twoSidedLighting: boolean;
  110517. /**
  110518. * Default configuration related to image processing available in the standard Material.
  110519. */
  110520. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  110521. /**
  110522. * Gets the image processing configuration used either in this material.
  110523. */
  110524. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  110525. /**
  110526. * Sets the Default image processing configuration used either in the this material.
  110527. *
  110528. * If sets to null, the scene one is in use.
  110529. */
  110530. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  110531. /**
  110532. * Keep track of the image processing observer to allow dispose and replace.
  110533. */
  110534. private _imageProcessingObserver;
  110535. /**
  110536. * Attaches a new image processing configuration to the Standard Material.
  110537. * @param configuration
  110538. */
  110539. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  110540. /**
  110541. * Gets wether the color curves effect is enabled.
  110542. */
  110543. get cameraColorCurvesEnabled(): boolean;
  110544. /**
  110545. * Sets wether the color curves effect is enabled.
  110546. */
  110547. set cameraColorCurvesEnabled(value: boolean);
  110548. /**
  110549. * Gets wether the color grading effect is enabled.
  110550. */
  110551. get cameraColorGradingEnabled(): boolean;
  110552. /**
  110553. * Gets wether the color grading effect is enabled.
  110554. */
  110555. set cameraColorGradingEnabled(value: boolean);
  110556. /**
  110557. * Gets wether tonemapping is enabled or not.
  110558. */
  110559. get cameraToneMappingEnabled(): boolean;
  110560. /**
  110561. * Sets wether tonemapping is enabled or not
  110562. */
  110563. set cameraToneMappingEnabled(value: boolean);
  110564. /**
  110565. * The camera exposure used on this material.
  110566. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  110567. * This corresponds to a photographic exposure.
  110568. */
  110569. get cameraExposure(): number;
  110570. /**
  110571. * The camera exposure used on this material.
  110572. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  110573. * This corresponds to a photographic exposure.
  110574. */
  110575. set cameraExposure(value: number);
  110576. /**
  110577. * Gets The camera contrast used on this material.
  110578. */
  110579. get cameraContrast(): number;
  110580. /**
  110581. * Sets The camera contrast used on this material.
  110582. */
  110583. set cameraContrast(value: number);
  110584. /**
  110585. * Gets the Color Grading 2D Lookup Texture.
  110586. */
  110587. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  110588. /**
  110589. * Sets the Color Grading 2D Lookup Texture.
  110590. */
  110591. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  110592. /**
  110593. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  110594. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  110595. * 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;
  110596. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  110597. */
  110598. get cameraColorCurves(): Nullable<ColorCurves>;
  110599. /**
  110600. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  110601. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  110602. * 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;
  110603. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  110604. */
  110605. set cameraColorCurves(value: Nullable<ColorCurves>);
  110606. /**
  110607. * Can this material render to several textures at once
  110608. */
  110609. get canRenderToMRT(): boolean;
  110610. /**
  110611. * Defines the detail map parameters for the material.
  110612. */
  110613. readonly detailMap: DetailMapConfiguration;
  110614. protected _renderTargets: SmartArray<RenderTargetTexture>;
  110615. protected _worldViewProjectionMatrix: Matrix;
  110616. protected _globalAmbientColor: Color3;
  110617. protected _useLogarithmicDepth: boolean;
  110618. protected _rebuildInParallel: boolean;
  110619. /**
  110620. * Instantiates a new standard material.
  110621. * This is the default material used in Babylon. It is the best trade off between quality
  110622. * and performances.
  110623. * @see https://doc.babylonjs.com/babylon101/materials
  110624. * @param name Define the name of the material in the scene
  110625. * @param scene Define the scene the material belong to
  110626. */
  110627. constructor(name: string, scene: Scene);
  110628. /**
  110629. * Gets a boolean indicating that current material needs to register RTT
  110630. */
  110631. get hasRenderTargetTextures(): boolean;
  110632. /**
  110633. * Gets the current class name of the material e.g. "StandardMaterial"
  110634. * Mainly use in serialization.
  110635. * @returns the class name
  110636. */
  110637. getClassName(): string;
  110638. /**
  110639. * In case the depth buffer does not allow enough depth precision for your scene (might be the case in large scenes)
  110640. * You can try switching to logarithmic depth.
  110641. * @see https://doc.babylonjs.com/how_to/using_logarithmic_depth_buffer
  110642. */
  110643. get useLogarithmicDepth(): boolean;
  110644. set useLogarithmicDepth(value: boolean);
  110645. /**
  110646. * Specifies if the material will require alpha blending
  110647. * @returns a boolean specifying if alpha blending is needed
  110648. */
  110649. needAlphaBlending(): boolean;
  110650. /**
  110651. * Specifies if this material should be rendered in alpha test mode
  110652. * @returns a boolean specifying if an alpha test is needed.
  110653. */
  110654. needAlphaTesting(): boolean;
  110655. protected _shouldUseAlphaFromDiffuseTexture(): boolean;
  110656. /**
  110657. * Get the texture used for alpha test purpose.
  110658. * @returns the diffuse texture in case of the standard material.
  110659. */
  110660. getAlphaTestTexture(): Nullable<BaseTexture>;
  110661. /**
  110662. * Get if the submesh is ready to be used and all its information available.
  110663. * Child classes can use it to update shaders
  110664. * @param mesh defines the mesh to check
  110665. * @param subMesh defines which submesh to check
  110666. * @param useInstances specifies that instances should be used
  110667. * @returns a boolean indicating that the submesh is ready or not
  110668. */
  110669. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  110670. /**
  110671. * Builds the material UBO layouts.
  110672. * Used internally during the effect preparation.
  110673. */
  110674. buildUniformLayout(): void;
  110675. /**
  110676. * Unbinds the material from the mesh
  110677. */
  110678. unbind(): void;
  110679. /**
  110680. * Binds the submesh to this material by preparing the effect and shader to draw
  110681. * @param world defines the world transformation matrix
  110682. * @param mesh defines the mesh containing the submesh
  110683. * @param subMesh defines the submesh to bind the material to
  110684. */
  110685. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  110686. /**
  110687. * Get the list of animatables in the material.
  110688. * @returns the list of animatables object used in the material
  110689. */
  110690. getAnimatables(): IAnimatable[];
  110691. /**
  110692. * Gets the active textures from the material
  110693. * @returns an array of textures
  110694. */
  110695. getActiveTextures(): BaseTexture[];
  110696. /**
  110697. * Specifies if the material uses a texture
  110698. * @param texture defines the texture to check against the material
  110699. * @returns a boolean specifying if the material uses the texture
  110700. */
  110701. hasTexture(texture: BaseTexture): boolean;
  110702. /**
  110703. * Disposes the material
  110704. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  110705. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  110706. */
  110707. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  110708. /**
  110709. * Makes a duplicate of the material, and gives it a new name
  110710. * @param name defines the new name for the duplicated material
  110711. * @returns the cloned material
  110712. */
  110713. clone(name: string): StandardMaterial;
  110714. /**
  110715. * Serializes this material in a JSON representation
  110716. * @returns the serialized material object
  110717. */
  110718. serialize(): any;
  110719. /**
  110720. * Creates a standard material from parsed material data
  110721. * @param source defines the JSON representation of the material
  110722. * @param scene defines the hosting scene
  110723. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  110724. * @returns a new standard material
  110725. */
  110726. static Parse(source: any, scene: Scene, rootUrl: string): StandardMaterial;
  110727. /**
  110728. * Are diffuse textures enabled in the application.
  110729. */
  110730. static get DiffuseTextureEnabled(): boolean;
  110731. static set DiffuseTextureEnabled(value: boolean);
  110732. /**
  110733. * Are detail textures enabled in the application.
  110734. */
  110735. static get DetailTextureEnabled(): boolean;
  110736. static set DetailTextureEnabled(value: boolean);
  110737. /**
  110738. * Are ambient textures enabled in the application.
  110739. */
  110740. static get AmbientTextureEnabled(): boolean;
  110741. static set AmbientTextureEnabled(value: boolean);
  110742. /**
  110743. * Are opacity textures enabled in the application.
  110744. */
  110745. static get OpacityTextureEnabled(): boolean;
  110746. static set OpacityTextureEnabled(value: boolean);
  110747. /**
  110748. * Are reflection textures enabled in the application.
  110749. */
  110750. static get ReflectionTextureEnabled(): boolean;
  110751. static set ReflectionTextureEnabled(value: boolean);
  110752. /**
  110753. * Are emissive textures enabled in the application.
  110754. */
  110755. static get EmissiveTextureEnabled(): boolean;
  110756. static set EmissiveTextureEnabled(value: boolean);
  110757. /**
  110758. * Are specular textures enabled in the application.
  110759. */
  110760. static get SpecularTextureEnabled(): boolean;
  110761. static set SpecularTextureEnabled(value: boolean);
  110762. /**
  110763. * Are bump textures enabled in the application.
  110764. */
  110765. static get BumpTextureEnabled(): boolean;
  110766. static set BumpTextureEnabled(value: boolean);
  110767. /**
  110768. * Are lightmap textures enabled in the application.
  110769. */
  110770. static get LightmapTextureEnabled(): boolean;
  110771. static set LightmapTextureEnabled(value: boolean);
  110772. /**
  110773. * Are refraction textures enabled in the application.
  110774. */
  110775. static get RefractionTextureEnabled(): boolean;
  110776. static set RefractionTextureEnabled(value: boolean);
  110777. /**
  110778. * Are color grading textures enabled in the application.
  110779. */
  110780. static get ColorGradingTextureEnabled(): boolean;
  110781. static set ColorGradingTextureEnabled(value: boolean);
  110782. /**
  110783. * Are fresnels enabled in the application.
  110784. */
  110785. static get FresnelEnabled(): boolean;
  110786. static set FresnelEnabled(value: boolean);
  110787. }
  110788. }
  110789. declare module BABYLON {
  110790. /**
  110791. * The SPS is a single updatable mesh. The solid particles are simply separate parts or faces fo this big mesh.
  110792. *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.
  110793. * The SPS is also a particle system. It provides some methods to manage the particles.
  110794. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  110795. *
  110796. * Full documentation here : https://doc.babylonjs.com/how_to/Solid_Particle_System
  110797. */
  110798. export class SolidParticleSystem implements IDisposable {
  110799. /**
  110800. * The SPS array of Solid Particle objects. Just access each particle as with any classic array.
  110801. * Example : var p = SPS.particles[i];
  110802. */
  110803. particles: SolidParticle[];
  110804. /**
  110805. * The SPS total number of particles. Read only. Use SPS.counter instead if you need to set your own value.
  110806. */
  110807. nbParticles: number;
  110808. /**
  110809. * If the particles must ever face the camera (default false). Useful for planar particles.
  110810. */
  110811. billboard: boolean;
  110812. /**
  110813. * Recompute normals when adding a shape
  110814. */
  110815. recomputeNormals: boolean;
  110816. /**
  110817. * This a counter ofr your own usage. It's not set by any SPS functions.
  110818. */
  110819. counter: number;
  110820. /**
  110821. * The SPS name. This name is also given to the underlying mesh.
  110822. */
  110823. name: string;
  110824. /**
  110825. * The SPS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  110826. */
  110827. mesh: Mesh;
  110828. /**
  110829. * This empty object is intended to store some SPS specific or temporary values in order to lower the Garbage Collector activity.
  110830. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#garbage-collector-concerns
  110831. */
  110832. vars: any;
  110833. /**
  110834. * This array is populated when the SPS is set as 'pickable'.
  110835. * Each key of this array is a `faceId` value that you can get from a pickResult object.
  110836. * Each element of this array is an object `{idx: int, faceId: int}`.
  110837. * `idx` is the picked particle index in the `SPS.particles` array
  110838. * `faceId` is the picked face index counted within this particle.
  110839. * This array is the first element of the pickedBySubMesh array : sps.pickBySubMesh[0].
  110840. * It's not pertinent to use it when using a SPS with the support for MultiMaterial enabled.
  110841. * Use the method SPS.pickedParticle(pickingInfo) instead.
  110842. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  110843. */
  110844. pickedParticles: {
  110845. idx: number;
  110846. faceId: number;
  110847. }[];
  110848. /**
  110849. * This array is populated when the SPS is set as 'pickable'
  110850. * Each key of this array is a submesh index.
  110851. * Each element of this array is a second array defined like this :
  110852. * Each key of this second array is a `faceId` value that you can get from a pickResult object.
  110853. * Each element of this second array is an object `{idx: int, faceId: int}`.
  110854. * `idx` is the picked particle index in the `SPS.particles` array
  110855. * `faceId` is the picked face index counted within this particle.
  110856. * It's better to use the method SPS.pickedParticle(pickingInfo) rather than using directly this array.
  110857. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  110858. */
  110859. pickedBySubMesh: {
  110860. idx: number;
  110861. faceId: number;
  110862. }[][];
  110863. /**
  110864. * This array is populated when `enableDepthSort` is set to true.
  110865. * Each element of this array is an instance of the class DepthSortedParticle.
  110866. */
  110867. depthSortedParticles: DepthSortedParticle[];
  110868. /**
  110869. * If the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster). (Internal use only)
  110870. * @hidden
  110871. */
  110872. _bSphereOnly: boolean;
  110873. /**
  110874. * A number to multiply the boundind sphere radius by in order to reduce it for instance. (Internal use only)
  110875. * @hidden
  110876. */
  110877. _bSphereRadiusFactor: number;
  110878. private _scene;
  110879. private _positions;
  110880. private _indices;
  110881. private _normals;
  110882. private _colors;
  110883. private _uvs;
  110884. private _indices32;
  110885. private _positions32;
  110886. private _normals32;
  110887. private _fixedNormal32;
  110888. private _colors32;
  110889. private _uvs32;
  110890. private _index;
  110891. private _updatable;
  110892. private _pickable;
  110893. private _isVisibilityBoxLocked;
  110894. private _alwaysVisible;
  110895. private _depthSort;
  110896. private _expandable;
  110897. private _shapeCounter;
  110898. private _copy;
  110899. private _color;
  110900. private _computeParticleColor;
  110901. private _computeParticleTexture;
  110902. private _computeParticleRotation;
  110903. private _computeParticleVertex;
  110904. private _computeBoundingBox;
  110905. private _depthSortParticles;
  110906. private _camera;
  110907. private _mustUnrotateFixedNormals;
  110908. private _particlesIntersect;
  110909. private _needs32Bits;
  110910. private _isNotBuilt;
  110911. private _lastParticleId;
  110912. private _idxOfId;
  110913. private _multimaterialEnabled;
  110914. private _useModelMaterial;
  110915. private _indicesByMaterial;
  110916. private _materialIndexes;
  110917. private _depthSortFunction;
  110918. private _materialSortFunction;
  110919. private _materials;
  110920. private _multimaterial;
  110921. private _materialIndexesById;
  110922. private _defaultMaterial;
  110923. private _autoUpdateSubMeshes;
  110924. private _tmpVertex;
  110925. /**
  110926. * Creates a SPS (Solid Particle System) object.
  110927. * @param name (String) is the SPS name, this will be the underlying mesh name.
  110928. * @param scene (Scene) is the scene in which the SPS is added.
  110929. * @param options defines the options of the sps e.g.
  110930. * * updatable (optional boolean, default true) : if the SPS must be updatable or immutable.
  110931. * * isPickable (optional boolean, default false) : if the solid particles must be pickable.
  110932. * * enableDepthSort (optional boolean, default false) : if the solid particles must be sorted in the geometry according to their distance to the camera.
  110933. * * 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.
  110934. * * enableMultiMaterial (optional boolean, default false) : if the solid particles can be given different materials.
  110935. * * expandable (optional boolean, default false) : if particles can still be added after the initial SPS mesh creation.
  110936. * * particleIntersection (optional boolean, default false) : if the solid particle intersections must be computed.
  110937. * * boundingSphereOnly (optional boolean, default false) : if the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster).
  110938. * * bSphereRadiusFactor (optional float, default 1.0) : a number to multiply the boundind sphere radius by in order to reduce it for instance.
  110939. * @example bSphereRadiusFactor = 1.0 / Math.sqrt(3.0) => the bounding sphere exactly matches a spherical mesh.
  110940. */
  110941. constructor(name: string, scene: Scene, options?: {
  110942. updatable?: boolean;
  110943. isPickable?: boolean;
  110944. enableDepthSort?: boolean;
  110945. particleIntersection?: boolean;
  110946. boundingSphereOnly?: boolean;
  110947. bSphereRadiusFactor?: number;
  110948. expandable?: boolean;
  110949. useModelMaterial?: boolean;
  110950. enableMultiMaterial?: boolean;
  110951. });
  110952. /**
  110953. * Builds the SPS underlying mesh. Returns a standard Mesh.
  110954. * If no model shape was added to the SPS, the returned mesh is just a single triangular plane.
  110955. * @returns the created mesh
  110956. */
  110957. buildMesh(): Mesh;
  110958. /**
  110959. * Digests the mesh and generates as many solid particles in the system as wanted. Returns the SPS.
  110960. * These particles will have the same geometry than the mesh parts and will be positioned at the same localisation than the mesh original places.
  110961. * Thus the particles generated from `digest()` have their property `position` set yet.
  110962. * @param mesh ( Mesh ) is the mesh to be digested
  110963. * @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
  110964. * {delta} (optional integer, default 0) is the random extra number of facets per particle , each particle will have between `facetNb` and `facetNb + delta` facets
  110965. * {number} (optional positive integer) is the wanted number of particles : each particle is built with `mesh_total_facets / number` facets
  110966. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  110967. * @returns the current SPS
  110968. */
  110969. digest(mesh: Mesh, options?: {
  110970. facetNb?: number;
  110971. number?: number;
  110972. delta?: number;
  110973. storage?: [];
  110974. }): SolidParticleSystem;
  110975. /**
  110976. * Unrotate the fixed normals in case the mesh was built with pre-rotated particles, ex : use of positionFunction in addShape()
  110977. * @hidden
  110978. */
  110979. private _unrotateFixedNormals;
  110980. /**
  110981. * Resets the temporary working copy particle
  110982. * @hidden
  110983. */
  110984. private _resetCopy;
  110985. /**
  110986. * Inserts the shape model geometry in the global SPS mesh by updating the positions, indices, normals, colors, uvs arrays
  110987. * @param p the current index in the positions array to be updated
  110988. * @param ind the current index in the indices array
  110989. * @param shape a Vector3 array, the shape geometry
  110990. * @param positions the positions array to be updated
  110991. * @param meshInd the shape indices array
  110992. * @param indices the indices array to be updated
  110993. * @param meshUV the shape uv array
  110994. * @param uvs the uv array to be updated
  110995. * @param meshCol the shape color array
  110996. * @param colors the color array to be updated
  110997. * @param meshNor the shape normals array
  110998. * @param normals the normals array to be updated
  110999. * @param idx the particle index
  111000. * @param idxInShape the particle index in its shape
  111001. * @param options the addShape() method passed options
  111002. * @model the particle model
  111003. * @hidden
  111004. */
  111005. private _meshBuilder;
  111006. /**
  111007. * Returns a shape Vector3 array from positions float array
  111008. * @param positions float array
  111009. * @returns a vector3 array
  111010. * @hidden
  111011. */
  111012. private _posToShape;
  111013. /**
  111014. * Returns a shapeUV array from a float uvs (array deep copy)
  111015. * @param uvs as a float array
  111016. * @returns a shapeUV array
  111017. * @hidden
  111018. */
  111019. private _uvsToShapeUV;
  111020. /**
  111021. * Adds a new particle object in the particles array
  111022. * @param idx particle index in particles array
  111023. * @param id particle id
  111024. * @param idxpos positionIndex : the starting index of the particle vertices in the SPS "positions" array
  111025. * @param idxind indiceIndex : he starting index of the particle indices in the SPS "indices" array
  111026. * @param model particle ModelShape object
  111027. * @param shapeId model shape identifier
  111028. * @param idxInShape index of the particle in the current model
  111029. * @param bInfo model bounding info object
  111030. * @param storage target storage array, if any
  111031. * @hidden
  111032. */
  111033. private _addParticle;
  111034. /**
  111035. * Adds some particles to the SPS from the model shape. Returns the shape id.
  111036. * Please read the doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#create-an-immutable-sps
  111037. * @param mesh is any Mesh object that will be used as a model for the solid particles.
  111038. * @param nb (positive integer) the number of particles to be created from this model
  111039. * @param options {positionFunction} is an optional javascript function to called for each particle on SPS creation.
  111040. * {vertexFunction} is an optional javascript function to called for each vertex of each particle on SPS creation
  111041. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  111042. * @returns the number of shapes in the system
  111043. */
  111044. addShape(mesh: Mesh, nb: number, options?: {
  111045. positionFunction?: any;
  111046. vertexFunction?: any;
  111047. storage?: [];
  111048. }): number;
  111049. /**
  111050. * Rebuilds a particle back to its just built status : if needed, recomputes the custom positions and vertices
  111051. * @hidden
  111052. */
  111053. private _rebuildParticle;
  111054. /**
  111055. * Rebuilds the whole mesh and updates the VBO : custom positions and vertices are recomputed if needed.
  111056. * @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.
  111057. * @returns the SPS.
  111058. */
  111059. rebuildMesh(reset?: boolean): SolidParticleSystem;
  111060. /** Removes the particles from the start-th to the end-th included from an expandable SPS (required).
  111061. * Returns an array with the removed particles.
  111062. * 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.
  111063. * The SPS can't be empty so at least one particle needs to remain in place.
  111064. * Under the hood, the VertexData array, so the VBO buffer, is recreated each call.
  111065. * @param start index of the first particle to remove
  111066. * @param end index of the last particle to remove (included)
  111067. * @returns an array populated with the removed particles
  111068. */
  111069. removeParticles(start: number, end: number): SolidParticle[];
  111070. /**
  111071. * Inserts some pre-created particles in the solid particle system so that they can be managed by setParticles().
  111072. * @param solidParticleArray an array populated with Solid Particles objects
  111073. * @returns the SPS
  111074. */
  111075. insertParticlesFromArray(solidParticleArray: SolidParticle[]): SolidParticleSystem;
  111076. /**
  111077. * Creates a new particle and modifies the SPS mesh geometry :
  111078. * - calls _meshBuilder() to increase the SPS mesh geometry step by step
  111079. * - calls _addParticle() to populate the particle array
  111080. * factorized code from addShape() and insertParticlesFromArray()
  111081. * @param idx particle index in the particles array
  111082. * @param i particle index in its shape
  111083. * @param modelShape particle ModelShape object
  111084. * @param shape shape vertex array
  111085. * @param meshInd shape indices array
  111086. * @param meshUV shape uv array
  111087. * @param meshCol shape color array
  111088. * @param meshNor shape normals array
  111089. * @param bbInfo shape bounding info
  111090. * @param storage target particle storage
  111091. * @options addShape() passed options
  111092. * @hidden
  111093. */
  111094. private _insertNewParticle;
  111095. /**
  111096. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  111097. * This method calls `updateParticle()` for each particle of the SPS.
  111098. * For an animated SPS, it is usually called within the render loop.
  111099. * 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.
  111100. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  111101. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  111102. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  111103. * @returns the SPS.
  111104. */
  111105. setParticles(start?: number, end?: number, update?: boolean): SolidParticleSystem;
  111106. /**
  111107. * Disposes the SPS.
  111108. */
  111109. dispose(): void;
  111110. /** Returns an object {idx: numbern faceId: number} for the picked particle from the passed pickingInfo object.
  111111. * idx is the particle index in the SPS
  111112. * faceId is the picked face index counted within this particle.
  111113. * Returns null if the pickInfo can't identify a picked particle.
  111114. * @param pickingInfo (PickingInfo object)
  111115. * @returns {idx: number, faceId: number} or null
  111116. */
  111117. pickedParticle(pickingInfo: PickingInfo): Nullable<{
  111118. idx: number;
  111119. faceId: number;
  111120. }>;
  111121. /**
  111122. * Returns a SolidParticle object from its identifier : particle.id
  111123. * @param id (integer) the particle Id
  111124. * @returns the searched particle or null if not found in the SPS.
  111125. */
  111126. getParticleById(id: number): Nullable<SolidParticle>;
  111127. /**
  111128. * Returns a new array populated with the particles having the passed shapeId.
  111129. * @param shapeId (integer) the shape identifier
  111130. * @returns a new solid particle array
  111131. */
  111132. getParticlesByShapeId(shapeId: number): SolidParticle[];
  111133. /**
  111134. * Populates the passed array "ref" with the particles having the passed shapeId.
  111135. * @param shapeId the shape identifier
  111136. * @returns the SPS
  111137. * @param ref
  111138. */
  111139. getParticlesByShapeIdToRef(shapeId: number, ref: SolidParticle[]): SolidParticleSystem;
  111140. /**
  111141. * Computes the required SubMeshes according the materials assigned to the particles.
  111142. * @returns the solid particle system.
  111143. * Does nothing if called before the SPS mesh is built.
  111144. */
  111145. computeSubMeshes(): SolidParticleSystem;
  111146. /**
  111147. * Sorts the solid particles by material when MultiMaterial is enabled.
  111148. * Updates the indices32 array.
  111149. * Updates the indicesByMaterial array.
  111150. * Updates the mesh indices array.
  111151. * @returns the SPS
  111152. * @hidden
  111153. */
  111154. private _sortParticlesByMaterial;
  111155. /**
  111156. * Sets the material indexes by id materialIndexesById[id] = materialIndex
  111157. * @hidden
  111158. */
  111159. private _setMaterialIndexesById;
  111160. /**
  111161. * Returns an array with unique values of Materials from the passed array
  111162. * @param array the material array to be checked and filtered
  111163. * @hidden
  111164. */
  111165. private _filterUniqueMaterialId;
  111166. /**
  111167. * Sets a new Standard Material as _defaultMaterial if not already set.
  111168. * @hidden
  111169. */
  111170. private _setDefaultMaterial;
  111171. /**
  111172. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  111173. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111174. * @returns the SPS.
  111175. */
  111176. refreshVisibleSize(): SolidParticleSystem;
  111177. /**
  111178. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  111179. * @param size the size (float) of the visibility box
  111180. * note : this doesn't lock the SPS mesh bounding box.
  111181. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111182. */
  111183. setVisibilityBox(size: number): void;
  111184. /**
  111185. * Gets whether the SPS as always visible or not
  111186. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111187. */
  111188. get isAlwaysVisible(): boolean;
  111189. /**
  111190. * Sets the SPS as always visible or not
  111191. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111192. */
  111193. set isAlwaysVisible(val: boolean);
  111194. /**
  111195. * Sets the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  111196. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111197. */
  111198. set isVisibilityBoxLocked(val: boolean);
  111199. /**
  111200. * Gets if the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  111201. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111202. */
  111203. get isVisibilityBoxLocked(): boolean;
  111204. /**
  111205. * Tells to `setParticles()` to compute the particle rotations or not.
  111206. * Default value : true. The SPS is faster when it's set to false.
  111207. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  111208. */
  111209. set computeParticleRotation(val: boolean);
  111210. /**
  111211. * Tells to `setParticles()` to compute the particle colors or not.
  111212. * Default value : true. The SPS is faster when it's set to false.
  111213. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  111214. */
  111215. set computeParticleColor(val: boolean);
  111216. set computeParticleTexture(val: boolean);
  111217. /**
  111218. * Tells to `setParticles()` to call the vertex function for each vertex of each particle, or not.
  111219. * Default value : false. The SPS is faster when it's set to false.
  111220. * Note : the particle custom vertex positions aren't stored values.
  111221. */
  111222. set computeParticleVertex(val: boolean);
  111223. /**
  111224. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  111225. */
  111226. set computeBoundingBox(val: boolean);
  111227. /**
  111228. * Tells to `setParticles()` to sort or not the distance between each particle and the camera.
  111229. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  111230. * Default : `true`
  111231. */
  111232. set depthSortParticles(val: boolean);
  111233. /**
  111234. * Gets if `setParticles()` computes the particle rotations or not.
  111235. * Default value : true. The SPS is faster when it's set to false.
  111236. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  111237. */
  111238. get computeParticleRotation(): boolean;
  111239. /**
  111240. * Gets if `setParticles()` computes the particle colors or not.
  111241. * Default value : true. The SPS is faster when it's set to false.
  111242. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  111243. */
  111244. get computeParticleColor(): boolean;
  111245. /**
  111246. * Gets if `setParticles()` computes the particle textures or not.
  111247. * Default value : true. The SPS is faster when it's set to false.
  111248. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  111249. */
  111250. get computeParticleTexture(): boolean;
  111251. /**
  111252. * Gets if `setParticles()` calls the vertex function for each vertex of each particle, or not.
  111253. * Default value : false. The SPS is faster when it's set to false.
  111254. * Note : the particle custom vertex positions aren't stored values.
  111255. */
  111256. get computeParticleVertex(): boolean;
  111257. /**
  111258. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  111259. */
  111260. get computeBoundingBox(): boolean;
  111261. /**
  111262. * Gets if `setParticles()` sorts or not the distance between each particle and the camera.
  111263. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  111264. * Default : `true`
  111265. */
  111266. get depthSortParticles(): boolean;
  111267. /**
  111268. * Gets if the SPS is created as expandable at construction time.
  111269. * Default : `false`
  111270. */
  111271. get expandable(): boolean;
  111272. /**
  111273. * Gets if the SPS supports the Multi Materials
  111274. */
  111275. get multimaterialEnabled(): boolean;
  111276. /**
  111277. * Gets if the SPS uses the model materials for its own multimaterial.
  111278. */
  111279. get useModelMaterial(): boolean;
  111280. /**
  111281. * The SPS used material array.
  111282. */
  111283. get materials(): Material[];
  111284. /**
  111285. * Sets the SPS MultiMaterial from the passed materials.
  111286. * Note : the passed array is internally copied and not used then by reference.
  111287. * @param materials an array of material objects. This array indexes are the materialIndex values of the particles.
  111288. */
  111289. setMultiMaterial(materials: Material[]): void;
  111290. /**
  111291. * The SPS computed multimaterial object
  111292. */
  111293. get multimaterial(): MultiMaterial;
  111294. set multimaterial(mm: MultiMaterial);
  111295. /**
  111296. * If the subMeshes must be updated on the next call to setParticles()
  111297. */
  111298. get autoUpdateSubMeshes(): boolean;
  111299. set autoUpdateSubMeshes(val: boolean);
  111300. /**
  111301. * This function does nothing. It may be overwritten to set all the particle first values.
  111302. * The SPS doesn't call this function, you may have to call it by your own.
  111303. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  111304. */
  111305. initParticles(): void;
  111306. /**
  111307. * This function does nothing. It may be overwritten to recycle a particle.
  111308. * The SPS doesn't call this function, you may have to call it by your own.
  111309. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  111310. * @param particle The particle to recycle
  111311. * @returns the recycled particle
  111312. */
  111313. recycleParticle(particle: SolidParticle): SolidParticle;
  111314. /**
  111315. * Updates a particle : this function should be overwritten by the user.
  111316. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  111317. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  111318. * @example : just set a particle position or velocity and recycle conditions
  111319. * @param particle The particle to update
  111320. * @returns the updated particle
  111321. */
  111322. updateParticle(particle: SolidParticle): SolidParticle;
  111323. /**
  111324. * Updates a vertex of a particle : it can be overwritten by the user.
  111325. * This will be called on each vertex particle by `setParticles()` if `computeParticleVertex` is set to true only.
  111326. * @param particle the current particle
  111327. * @param vertex the current vertex of the current particle : a SolidParticleVertex object
  111328. * @param pt the index of the current vertex in the particle shape
  111329. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#update-each-particle-shape
  111330. * @example : just set a vertex particle position or color
  111331. * @returns the sps
  111332. */
  111333. updateParticleVertex(particle: SolidParticle, vertex: SolidParticleVertex, pt: number): SolidParticleSystem;
  111334. /**
  111335. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  111336. * This does nothing and may be overwritten by the user.
  111337. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  111338. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  111339. * @param update the boolean update value actually passed to setParticles()
  111340. */
  111341. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  111342. /**
  111343. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  111344. * This will be passed three parameters.
  111345. * This does nothing and may be overwritten by the user.
  111346. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  111347. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  111348. * @param update the boolean update value actually passed to setParticles()
  111349. */
  111350. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  111351. }
  111352. }
  111353. declare module BABYLON {
  111354. /**
  111355. * Represents one particle of a solid particle system.
  111356. */
  111357. export class SolidParticle {
  111358. /**
  111359. * particle global index
  111360. */
  111361. idx: number;
  111362. /**
  111363. * particle identifier
  111364. */
  111365. id: number;
  111366. /**
  111367. * The color of the particle
  111368. */
  111369. color: Nullable<Color4>;
  111370. /**
  111371. * The world space position of the particle.
  111372. */
  111373. position: Vector3;
  111374. /**
  111375. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  111376. */
  111377. rotation: Vector3;
  111378. /**
  111379. * The world space rotation quaternion of the particle.
  111380. */
  111381. rotationQuaternion: Nullable<Quaternion>;
  111382. /**
  111383. * The scaling of the particle.
  111384. */
  111385. scaling: Vector3;
  111386. /**
  111387. * The uvs of the particle.
  111388. */
  111389. uvs: Vector4;
  111390. /**
  111391. * The current speed of the particle.
  111392. */
  111393. velocity: Vector3;
  111394. /**
  111395. * The pivot point in the particle local space.
  111396. */
  111397. pivot: Vector3;
  111398. /**
  111399. * Must the particle be translated from its pivot point in its local space ?
  111400. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  111401. * Default : false
  111402. */
  111403. translateFromPivot: boolean;
  111404. /**
  111405. * Is the particle active or not ?
  111406. */
  111407. alive: boolean;
  111408. /**
  111409. * Is the particle visible or not ?
  111410. */
  111411. isVisible: boolean;
  111412. /**
  111413. * Index of this particle in the global "positions" array (Internal use)
  111414. * @hidden
  111415. */
  111416. _pos: number;
  111417. /**
  111418. * @hidden Index of this particle in the global "indices" array (Internal use)
  111419. */
  111420. _ind: number;
  111421. /**
  111422. * @hidden ModelShape of this particle (Internal use)
  111423. */
  111424. _model: ModelShape;
  111425. /**
  111426. * ModelShape id of this particle
  111427. */
  111428. shapeId: number;
  111429. /**
  111430. * Index of the particle in its shape id
  111431. */
  111432. idxInShape: number;
  111433. /**
  111434. * @hidden Reference to the shape model BoundingInfo object (Internal use)
  111435. */
  111436. _modelBoundingInfo: BoundingInfo;
  111437. /**
  111438. * @hidden Particle BoundingInfo object (Internal use)
  111439. */
  111440. _boundingInfo: BoundingInfo;
  111441. /**
  111442. * @hidden Reference to the SPS what the particle belongs to (Internal use)
  111443. */
  111444. _sps: SolidParticleSystem;
  111445. /**
  111446. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  111447. */
  111448. _stillInvisible: boolean;
  111449. /**
  111450. * @hidden Last computed particle rotation matrix
  111451. */
  111452. _rotationMatrix: number[];
  111453. /**
  111454. * Parent particle Id, if any.
  111455. * Default null.
  111456. */
  111457. parentId: Nullable<number>;
  111458. /**
  111459. * The particle material identifier (integer) when MultiMaterials are enabled in the SPS.
  111460. */
  111461. materialIndex: Nullable<number>;
  111462. /**
  111463. * Custom object or properties.
  111464. */
  111465. props: Nullable<any>;
  111466. /**
  111467. * The culling strategy to use to check whether the solid particle must be culled or not when using isInFrustum().
  111468. * The possible values are :
  111469. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  111470. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  111471. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  111472. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  111473. * The default value for solid particles is AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  111474. * Please read each static variable documentation in the class AbstractMesh to get details about the culling process.
  111475. * */
  111476. cullingStrategy: number;
  111477. /**
  111478. * @hidden Internal global position in the SPS.
  111479. */
  111480. _globalPosition: Vector3;
  111481. /**
  111482. * Creates a Solid Particle object.
  111483. * Don't create particles manually, use instead the Solid Particle System internal tools like _addParticle()
  111484. * @param particleIndex (integer) is the particle index in the Solid Particle System pool.
  111485. * @param particleId (integer) is the particle identifier. Unless some particles are removed from the SPS, it's the same value than the particle idx.
  111486. * @param positionIndex (integer) is the starting index of the particle vertices in the SPS "positions" array.
  111487. * @param indiceIndex (integer) is the starting index of the particle indices in the SPS "indices" array.
  111488. * @param model (ModelShape) is a reference to the model shape on what the particle is designed.
  111489. * @param shapeId (integer) is the model shape identifier in the SPS.
  111490. * @param idxInShape (integer) is the index of the particle in the current model (ex: the 10th box of addShape(box, 30))
  111491. * @param sps defines the sps it is associated to
  111492. * @param modelBoundingInfo is the reference to the model BoundingInfo used for intersection computations.
  111493. * @param materialIndex is the particle material identifier (integer) when the MultiMaterials are enabled in the SPS.
  111494. */
  111495. constructor(particleIndex: number, particleId: number, positionIndex: number, indiceIndex: number, model: Nullable<ModelShape>, shapeId: number, idxInShape: number, sps: SolidParticleSystem, modelBoundingInfo?: Nullable<BoundingInfo>, materialIndex?: Nullable<number>);
  111496. /**
  111497. * Copies the particle property values into the existing target : position, rotation, scaling, uvs, colors, pivot, parent, visibility, alive
  111498. * @param target the particle target
  111499. * @returns the current particle
  111500. */
  111501. copyToRef(target: SolidParticle): SolidParticle;
  111502. /**
  111503. * Legacy support, changed scale to scaling
  111504. */
  111505. get scale(): Vector3;
  111506. /**
  111507. * Legacy support, changed scale to scaling
  111508. */
  111509. set scale(scale: Vector3);
  111510. /**
  111511. * Legacy support, changed quaternion to rotationQuaternion
  111512. */
  111513. get quaternion(): Nullable<Quaternion>;
  111514. /**
  111515. * Legacy support, changed quaternion to rotationQuaternion
  111516. */
  111517. set quaternion(q: Nullable<Quaternion>);
  111518. /**
  111519. * Returns a boolean. True if the particle intersects another particle or another mesh, else false.
  111520. * The intersection is computed on the particle bounding sphere and Axis Aligned Bounding Box (AABB)
  111521. * @param target is the object (solid particle or mesh) what the intersection is computed against.
  111522. * @returns true if it intersects
  111523. */
  111524. intersectsMesh(target: Mesh | SolidParticle): boolean;
  111525. /**
  111526. * Returns `true` if the solid particle is within the frustum defined by the passed array of planes.
  111527. * A particle is in the frustum if its bounding box intersects the frustum
  111528. * @param frustumPlanes defines the frustum to test
  111529. * @returns true if the particle is in the frustum planes
  111530. */
  111531. isInFrustum(frustumPlanes: Plane[]): boolean;
  111532. /**
  111533. * get the rotation matrix of the particle
  111534. * @hidden
  111535. */
  111536. getRotationMatrix(m: Matrix): void;
  111537. }
  111538. /**
  111539. * Represents the shape of the model used by one particle of a solid particle system.
  111540. * SPS internal tool, don't use it manually.
  111541. */
  111542. export class ModelShape {
  111543. /**
  111544. * The shape id
  111545. * @hidden
  111546. */
  111547. shapeID: number;
  111548. /**
  111549. * flat array of model positions (internal use)
  111550. * @hidden
  111551. */
  111552. _shape: Vector3[];
  111553. /**
  111554. * flat array of model UVs (internal use)
  111555. * @hidden
  111556. */
  111557. _shapeUV: number[];
  111558. /**
  111559. * color array of the model
  111560. * @hidden
  111561. */
  111562. _shapeColors: number[];
  111563. /**
  111564. * indices array of the model
  111565. * @hidden
  111566. */
  111567. _indices: number[];
  111568. /**
  111569. * normals array of the model
  111570. * @hidden
  111571. */
  111572. _normals: number[];
  111573. /**
  111574. * length of the shape in the model indices array (internal use)
  111575. * @hidden
  111576. */
  111577. _indicesLength: number;
  111578. /**
  111579. * Custom position function (internal use)
  111580. * @hidden
  111581. */
  111582. _positionFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>;
  111583. /**
  111584. * Custom vertex function (internal use)
  111585. * @hidden
  111586. */
  111587. _vertexFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>;
  111588. /**
  111589. * Model material (internal use)
  111590. * @hidden
  111591. */
  111592. _material: Nullable<Material>;
  111593. /**
  111594. * 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.
  111595. * SPS internal tool, don't use it manually.
  111596. * @hidden
  111597. */
  111598. 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>);
  111599. }
  111600. /**
  111601. * Represents a Depth Sorted Particle in the solid particle system.
  111602. * @hidden
  111603. */
  111604. export class DepthSortedParticle {
  111605. /**
  111606. * Particle index
  111607. */
  111608. idx: number;
  111609. /**
  111610. * Index of the particle in the "indices" array
  111611. */
  111612. ind: number;
  111613. /**
  111614. * Length of the particle shape in the "indices" array
  111615. */
  111616. indicesLength: number;
  111617. /**
  111618. * Squared distance from the particle to the camera
  111619. */
  111620. sqDistance: number;
  111621. /**
  111622. * Material index when used with MultiMaterials
  111623. */
  111624. materialIndex: number;
  111625. /**
  111626. * Creates a new sorted particle
  111627. * @param materialIndex
  111628. */
  111629. constructor(idx: number, ind: number, indLength: number, materialIndex: number);
  111630. }
  111631. /**
  111632. * Represents a solid particle vertex
  111633. */
  111634. export class SolidParticleVertex {
  111635. /**
  111636. * Vertex position
  111637. */
  111638. position: Vector3;
  111639. /**
  111640. * Vertex color
  111641. */
  111642. color: Color4;
  111643. /**
  111644. * Vertex UV
  111645. */
  111646. uv: Vector2;
  111647. /**
  111648. * Creates a new solid particle vertex
  111649. */
  111650. constructor();
  111651. /** Vertex x coordinate */
  111652. get x(): number;
  111653. set x(val: number);
  111654. /** Vertex y coordinate */
  111655. get y(): number;
  111656. set y(val: number);
  111657. /** Vertex z coordinate */
  111658. get z(): number;
  111659. set z(val: number);
  111660. }
  111661. }
  111662. declare module BABYLON {
  111663. /**
  111664. * @hidden
  111665. */
  111666. export class _MeshCollisionData {
  111667. _checkCollisions: boolean;
  111668. _collisionMask: number;
  111669. _collisionGroup: number;
  111670. _surroundingMeshes: Nullable<AbstractMesh[]>;
  111671. _collider: Nullable<Collider>;
  111672. _oldPositionForCollisions: Vector3;
  111673. _diffPositionForCollisions: Vector3;
  111674. _onCollideObserver: Nullable<Observer<AbstractMesh>>;
  111675. _onCollisionPositionChangeObserver: Nullable<Observer<Vector3>>;
  111676. }
  111677. }
  111678. declare module BABYLON {
  111679. /** @hidden */
  111680. class _FacetDataStorage {
  111681. facetPositions: Vector3[];
  111682. facetNormals: Vector3[];
  111683. facetPartitioning: number[][];
  111684. facetNb: number;
  111685. partitioningSubdivisions: number;
  111686. partitioningBBoxRatio: number;
  111687. facetDataEnabled: boolean;
  111688. facetParameters: any;
  111689. bbSize: Vector3;
  111690. subDiv: {
  111691. max: number;
  111692. X: number;
  111693. Y: number;
  111694. Z: number;
  111695. };
  111696. facetDepthSort: boolean;
  111697. facetDepthSortEnabled: boolean;
  111698. depthSortedIndices: IndicesArray;
  111699. depthSortedFacets: {
  111700. ind: number;
  111701. sqDistance: number;
  111702. }[];
  111703. facetDepthSortFunction: (f1: {
  111704. ind: number;
  111705. sqDistance: number;
  111706. }, f2: {
  111707. ind: number;
  111708. sqDistance: number;
  111709. }) => number;
  111710. facetDepthSortFrom: Vector3;
  111711. facetDepthSortOrigin: Vector3;
  111712. invertedMatrix: Matrix;
  111713. }
  111714. /**
  111715. * @hidden
  111716. **/
  111717. class _InternalAbstractMeshDataInfo {
  111718. _hasVertexAlpha: boolean;
  111719. _useVertexColors: boolean;
  111720. _numBoneInfluencers: number;
  111721. _applyFog: boolean;
  111722. _receiveShadows: boolean;
  111723. _facetData: _FacetDataStorage;
  111724. _visibility: number;
  111725. _skeleton: Nullable<Skeleton>;
  111726. _layerMask: number;
  111727. _computeBonesUsingShaders: boolean;
  111728. _isActive: boolean;
  111729. _onlyForInstances: boolean;
  111730. _isActiveIntermediate: boolean;
  111731. _onlyForInstancesIntermediate: boolean;
  111732. _actAsRegularMesh: boolean;
  111733. }
  111734. /**
  111735. * Class used to store all common mesh properties
  111736. */
  111737. export class AbstractMesh extends TransformNode implements IDisposable, ICullable, IGetSetVerticesData {
  111738. /** No occlusion */
  111739. static OCCLUSION_TYPE_NONE: number;
  111740. /** Occlusion set to optimisitic */
  111741. static OCCLUSION_TYPE_OPTIMISTIC: number;
  111742. /** Occlusion set to strict */
  111743. static OCCLUSION_TYPE_STRICT: number;
  111744. /** Use an accurante occlusion algorithm */
  111745. static OCCLUSION_ALGORITHM_TYPE_ACCURATE: number;
  111746. /** Use a conservative occlusion algorithm */
  111747. static OCCLUSION_ALGORITHM_TYPE_CONSERVATIVE: number;
  111748. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  111749. * Test order :
  111750. * Is the bounding sphere outside the frustum ?
  111751. * If not, are the bounding box vertices outside the frustum ?
  111752. * It not, then the cullable object is in the frustum.
  111753. */
  111754. static readonly CULLINGSTRATEGY_STANDARD: number;
  111755. /** Culling strategy : Bounding Sphere Only.
  111756. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  111757. * It's also less accurate than the standard because some not visible objects can still be selected.
  111758. * Test : is the bounding sphere outside the frustum ?
  111759. * If not, then the cullable object is in the frustum.
  111760. */
  111761. static readonly CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  111762. /** Culling strategy : Optimistic Inclusion.
  111763. * This in an inclusion test first, then the standard exclusion test.
  111764. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  111765. * 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.
  111766. * Anyway, it's as accurate as the standard strategy.
  111767. * Test :
  111768. * Is the cullable object bounding sphere center in the frustum ?
  111769. * If not, apply the default culling strategy.
  111770. */
  111771. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  111772. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  111773. * This in an inclusion test first, then the bounding sphere only exclusion test.
  111774. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  111775. * 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.
  111776. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  111777. * Test :
  111778. * Is the cullable object bounding sphere center in the frustum ?
  111779. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  111780. */
  111781. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  111782. /**
  111783. * No billboard
  111784. */
  111785. static get BILLBOARDMODE_NONE(): number;
  111786. /** Billboard on X axis */
  111787. static get BILLBOARDMODE_X(): number;
  111788. /** Billboard on Y axis */
  111789. static get BILLBOARDMODE_Y(): number;
  111790. /** Billboard on Z axis */
  111791. static get BILLBOARDMODE_Z(): number;
  111792. /** Billboard on all axes */
  111793. static get BILLBOARDMODE_ALL(): number;
  111794. /** Billboard on using position instead of orientation */
  111795. static get BILLBOARDMODE_USE_POSITION(): number;
  111796. /** @hidden */
  111797. _internalAbstractMeshDataInfo: _InternalAbstractMeshDataInfo;
  111798. /**
  111799. * The culling strategy to use to check whether the mesh must be rendered or not.
  111800. * This value can be changed at any time and will be used on the next render mesh selection.
  111801. * The possible values are :
  111802. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  111803. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  111804. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  111805. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  111806. * Please read each static variable documentation to get details about the culling process.
  111807. * */
  111808. cullingStrategy: number;
  111809. /**
  111810. * Gets the number of facets in the mesh
  111811. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  111812. */
  111813. get facetNb(): number;
  111814. /**
  111815. * Gets or set the number (integer) of subdivisions per axis in the partioning space
  111816. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  111817. */
  111818. get partitioningSubdivisions(): number;
  111819. set partitioningSubdivisions(nb: number);
  111820. /**
  111821. * The ratio (float) to apply to the bouding box size to set to the partioning space.
  111822. * Ex : 1.01 (default) the partioning space is 1% bigger than the bounding box
  111823. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  111824. */
  111825. get partitioningBBoxRatio(): number;
  111826. set partitioningBBoxRatio(ratio: number);
  111827. /**
  111828. * Gets or sets a boolean indicating that the facets must be depth sorted on next call to `updateFacetData()`.
  111829. * Works only for updatable meshes.
  111830. * Doesn't work with multi-materials
  111831. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  111832. */
  111833. get mustDepthSortFacets(): boolean;
  111834. set mustDepthSortFacets(sort: boolean);
  111835. /**
  111836. * The location (Vector3) where the facet depth sort must be computed from.
  111837. * By default, the active camera position.
  111838. * Used only when facet depth sort is enabled
  111839. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  111840. */
  111841. get facetDepthSortFrom(): Vector3;
  111842. set facetDepthSortFrom(location: Vector3);
  111843. /**
  111844. * gets a boolean indicating if facetData is enabled
  111845. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  111846. */
  111847. get isFacetDataEnabled(): boolean;
  111848. /** @hidden */
  111849. _updateNonUniformScalingState(value: boolean): boolean;
  111850. /**
  111851. * An event triggered when this mesh collides with another one
  111852. */
  111853. onCollideObservable: Observable<AbstractMesh>;
  111854. /** Set a function to call when this mesh collides with another one */
  111855. set onCollide(callback: () => void);
  111856. /**
  111857. * An event triggered when the collision's position changes
  111858. */
  111859. onCollisionPositionChangeObservable: Observable<Vector3>;
  111860. /** Set a function to call when the collision's position changes */
  111861. set onCollisionPositionChange(callback: () => void);
  111862. /**
  111863. * An event triggered when material is changed
  111864. */
  111865. onMaterialChangedObservable: Observable<AbstractMesh>;
  111866. /**
  111867. * Gets or sets the orientation for POV movement & rotation
  111868. */
  111869. definedFacingForward: boolean;
  111870. /** @hidden */
  111871. _occlusionQuery: Nullable<WebGLQuery>;
  111872. /** @hidden */
  111873. _renderingGroup: Nullable<RenderingGroup>;
  111874. /**
  111875. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  111876. */
  111877. get visibility(): number;
  111878. /**
  111879. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  111880. */
  111881. set visibility(value: number);
  111882. /** Gets or sets the alpha index used to sort transparent meshes
  111883. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#alpha-index
  111884. */
  111885. alphaIndex: number;
  111886. /**
  111887. * Gets or sets a boolean indicating if the mesh is visible (renderable). Default is true
  111888. */
  111889. isVisible: boolean;
  111890. /**
  111891. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  111892. */
  111893. isPickable: boolean;
  111894. /** Gets or sets a boolean indicating that bounding boxes of subMeshes must be rendered as well (false by default) */
  111895. showSubMeshesBoundingBox: boolean;
  111896. /** Gets or sets a boolean indicating if the mesh must be considered as a ray blocker for lens flares (false by default)
  111897. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  111898. */
  111899. isBlocker: boolean;
  111900. /**
  111901. * Gets or sets a boolean indicating that pointer move events must be supported on this mesh (false by default)
  111902. */
  111903. enablePointerMoveEvents: boolean;
  111904. private _renderingGroupId;
  111905. /**
  111906. * Specifies the rendering group id for this mesh (0 by default)
  111907. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  111908. */
  111909. get renderingGroupId(): number;
  111910. set renderingGroupId(value: number);
  111911. private _material;
  111912. /** Gets or sets current material */
  111913. get material(): Nullable<Material>;
  111914. set material(value: Nullable<Material>);
  111915. /**
  111916. * Gets or sets a boolean indicating that this mesh can receive realtime shadows
  111917. * @see https://doc.babylonjs.com/babylon101/shadows
  111918. */
  111919. get receiveShadows(): boolean;
  111920. set receiveShadows(value: boolean);
  111921. /** Defines color to use when rendering outline */
  111922. outlineColor: Color3;
  111923. /** Define width to use when rendering outline */
  111924. outlineWidth: number;
  111925. /** Defines color to use when rendering overlay */
  111926. overlayColor: Color3;
  111927. /** Defines alpha to use when rendering overlay */
  111928. overlayAlpha: number;
  111929. /** Gets or sets a boolean indicating that this mesh contains vertex color data with alpha values */
  111930. get hasVertexAlpha(): boolean;
  111931. set hasVertexAlpha(value: boolean);
  111932. /** 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) */
  111933. get useVertexColors(): boolean;
  111934. set useVertexColors(value: boolean);
  111935. /**
  111936. * Gets or sets a boolean indicating that bone animations must be computed by the CPU (false by default)
  111937. */
  111938. get computeBonesUsingShaders(): boolean;
  111939. set computeBonesUsingShaders(value: boolean);
  111940. /** Gets or sets the number of allowed bone influences per vertex (4 by default) */
  111941. get numBoneInfluencers(): number;
  111942. set numBoneInfluencers(value: number);
  111943. /** Gets or sets a boolean indicating that this mesh will allow fog to be rendered on it (true by default) */
  111944. get applyFog(): boolean;
  111945. set applyFog(value: boolean);
  111946. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes selection (true by default) */
  111947. useOctreeForRenderingSelection: boolean;
  111948. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes picking (true by default) */
  111949. useOctreeForPicking: boolean;
  111950. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes collision (true by default) */
  111951. useOctreeForCollisions: boolean;
  111952. /**
  111953. * Gets or sets the current layer mask (default is 0x0FFFFFFF)
  111954. * @see https://doc.babylonjs.com/how_to/layermasks_and_multi-cam_textures
  111955. */
  111956. get layerMask(): number;
  111957. set layerMask(value: number);
  111958. /**
  111959. * True if the mesh must be rendered in any case (this will shortcut the frustum clipping phase)
  111960. */
  111961. alwaysSelectAsActiveMesh: boolean;
  111962. /**
  111963. * Gets or sets a boolean indicating that the bounding info does not need to be kept in sync (for performance reason)
  111964. */
  111965. doNotSyncBoundingInfo: boolean;
  111966. /**
  111967. * Gets or sets the current action manager
  111968. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  111969. */
  111970. actionManager: Nullable<AbstractActionManager>;
  111971. private _meshCollisionData;
  111972. /**
  111973. * Gets or sets the ellipsoid used to impersonate this mesh when using collision engine (default is (0.5, 1, 0.5))
  111974. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  111975. */
  111976. ellipsoid: Vector3;
  111977. /**
  111978. * Gets or sets the ellipsoid offset used to impersonate this mesh when using collision engine (default is (0, 0, 0))
  111979. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  111980. */
  111981. ellipsoidOffset: Vector3;
  111982. /**
  111983. * Gets or sets a collision mask used to mask collisions (default is -1).
  111984. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  111985. */
  111986. get collisionMask(): number;
  111987. set collisionMask(mask: number);
  111988. /**
  111989. * Gets or sets the current collision group mask (-1 by default).
  111990. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  111991. */
  111992. get collisionGroup(): number;
  111993. set collisionGroup(mask: number);
  111994. /**
  111995. * Gets or sets current surrounding meshes (null by default).
  111996. *
  111997. * By default collision detection is tested against every mesh in the scene.
  111998. * It is possible to set surroundingMeshes to a defined list of meshes and then only these specified
  111999. * meshes will be tested for the collision.
  112000. *
  112001. * Note: if set to an empty array no collision will happen when this mesh is moved.
  112002. */
  112003. get surroundingMeshes(): Nullable<AbstractMesh[]>;
  112004. set surroundingMeshes(meshes: Nullable<AbstractMesh[]>);
  112005. /**
  112006. * Defines edge width used when edgesRenderer is enabled
  112007. * @see https://www.babylonjs-playground.com/#10OJSG#13
  112008. */
  112009. edgesWidth: number;
  112010. /**
  112011. * Defines edge color used when edgesRenderer is enabled
  112012. * @see https://www.babylonjs-playground.com/#10OJSG#13
  112013. */
  112014. edgesColor: Color4;
  112015. /** @hidden */
  112016. _edgesRenderer: Nullable<IEdgesRenderer>;
  112017. /** @hidden */
  112018. _masterMesh: Nullable<AbstractMesh>;
  112019. /** @hidden */
  112020. _boundingInfo: Nullable<BoundingInfo>;
  112021. /** @hidden */
  112022. _renderId: number;
  112023. /**
  112024. * Gets or sets the list of subMeshes
  112025. * @see https://doc.babylonjs.com/how_to/multi_materials
  112026. */
  112027. subMeshes: SubMesh[];
  112028. /** @hidden */
  112029. _intersectionsInProgress: AbstractMesh[];
  112030. /** @hidden */
  112031. _unIndexed: boolean;
  112032. /** @hidden */
  112033. _lightSources: Light[];
  112034. /** Gets the list of lights affecting that mesh */
  112035. get lightSources(): Light[];
  112036. /** @hidden */
  112037. get _positions(): Nullable<Vector3[]>;
  112038. /** @hidden */
  112039. _waitingData: {
  112040. lods: Nullable<any>;
  112041. actions: Nullable<any>;
  112042. freezeWorldMatrix: Nullable<boolean>;
  112043. };
  112044. /** @hidden */
  112045. _bonesTransformMatrices: Nullable<Float32Array>;
  112046. /** @hidden */
  112047. _transformMatrixTexture: Nullable<RawTexture>;
  112048. /**
  112049. * Gets or sets a skeleton to apply skining transformations
  112050. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  112051. */
  112052. set skeleton(value: Nullable<Skeleton>);
  112053. get skeleton(): Nullable<Skeleton>;
  112054. /**
  112055. * An event triggered when the mesh is rebuilt.
  112056. */
  112057. onRebuildObservable: Observable<AbstractMesh>;
  112058. /**
  112059. * Creates a new AbstractMesh
  112060. * @param name defines the name of the mesh
  112061. * @param scene defines the hosting scene
  112062. */
  112063. constructor(name: string, scene?: Nullable<Scene>);
  112064. /**
  112065. * Returns the string "AbstractMesh"
  112066. * @returns "AbstractMesh"
  112067. */
  112068. getClassName(): string;
  112069. /**
  112070. * Gets a string representation of the current mesh
  112071. * @param fullDetails defines a boolean indicating if full details must be included
  112072. * @returns a string representation of the current mesh
  112073. */
  112074. toString(fullDetails?: boolean): string;
  112075. /**
  112076. * @hidden
  112077. */
  112078. protected _getEffectiveParent(): Nullable<Node>;
  112079. /** @hidden */
  112080. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  112081. /** @hidden */
  112082. _rebuild(): void;
  112083. /** @hidden */
  112084. _resyncLightSources(): void;
  112085. /** @hidden */
  112086. _resyncLightSource(light: Light): void;
  112087. /** @hidden */
  112088. _unBindEffect(): void;
  112089. /** @hidden */
  112090. _removeLightSource(light: Light, dispose: boolean): void;
  112091. private _markSubMeshesAsDirty;
  112092. /** @hidden */
  112093. _markSubMeshesAsLightDirty(dispose?: boolean): void;
  112094. /** @hidden */
  112095. _markSubMeshesAsAttributesDirty(): void;
  112096. /** @hidden */
  112097. _markSubMeshesAsMiscDirty(): void;
  112098. /**
  112099. * Gets or sets a Vector3 depicting the mesh scaling along each local axis X, Y, Z. Default is (1.0, 1.0, 1.0)
  112100. */
  112101. get scaling(): Vector3;
  112102. set scaling(newScaling: Vector3);
  112103. /**
  112104. * Returns true if the mesh is blocked. Implemented by child classes
  112105. */
  112106. get isBlocked(): boolean;
  112107. /**
  112108. * Returns the mesh itself by default. Implemented by child classes
  112109. * @param camera defines the camera to use to pick the right LOD level
  112110. * @returns the currentAbstractMesh
  112111. */
  112112. getLOD(camera: Camera): Nullable<AbstractMesh>;
  112113. /**
  112114. * Returns 0 by default. Implemented by child classes
  112115. * @returns an integer
  112116. */
  112117. getTotalVertices(): number;
  112118. /**
  112119. * Returns a positive integer : the total number of indices in this mesh geometry.
  112120. * @returns the numner of indices or zero if the mesh has no geometry.
  112121. */
  112122. getTotalIndices(): number;
  112123. /**
  112124. * Returns null by default. Implemented by child classes
  112125. * @returns null
  112126. */
  112127. getIndices(): Nullable<IndicesArray>;
  112128. /**
  112129. * Returns the array of the requested vertex data kind. Implemented by child classes
  112130. * @param kind defines the vertex data kind to use
  112131. * @returns null
  112132. */
  112133. getVerticesData(kind: string): Nullable<FloatArray>;
  112134. /**
  112135. * Sets the vertex data of the mesh geometry for the requested `kind`.
  112136. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  112137. * Note that a new underlying VertexBuffer object is created each call.
  112138. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  112139. * @param kind defines vertex data kind:
  112140. * * VertexBuffer.PositionKind
  112141. * * VertexBuffer.UVKind
  112142. * * VertexBuffer.UV2Kind
  112143. * * VertexBuffer.UV3Kind
  112144. * * VertexBuffer.UV4Kind
  112145. * * VertexBuffer.UV5Kind
  112146. * * VertexBuffer.UV6Kind
  112147. * * VertexBuffer.ColorKind
  112148. * * VertexBuffer.MatricesIndicesKind
  112149. * * VertexBuffer.MatricesIndicesExtraKind
  112150. * * VertexBuffer.MatricesWeightsKind
  112151. * * VertexBuffer.MatricesWeightsExtraKind
  112152. * @param data defines the data source
  112153. * @param updatable defines if the data must be flagged as updatable (or static)
  112154. * @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
  112155. * @returns the current mesh
  112156. */
  112157. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  112158. /**
  112159. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  112160. * If the mesh has no geometry, it is simply returned as it is.
  112161. * @param kind defines vertex data kind:
  112162. * * VertexBuffer.PositionKind
  112163. * * VertexBuffer.UVKind
  112164. * * VertexBuffer.UV2Kind
  112165. * * VertexBuffer.UV3Kind
  112166. * * VertexBuffer.UV4Kind
  112167. * * VertexBuffer.UV5Kind
  112168. * * VertexBuffer.UV6Kind
  112169. * * VertexBuffer.ColorKind
  112170. * * VertexBuffer.MatricesIndicesKind
  112171. * * VertexBuffer.MatricesIndicesExtraKind
  112172. * * VertexBuffer.MatricesWeightsKind
  112173. * * VertexBuffer.MatricesWeightsExtraKind
  112174. * @param data defines the data source
  112175. * @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
  112176. * @param makeItUnique If true, a new global geometry is created from this data and is set to the mesh
  112177. * @returns the current mesh
  112178. */
  112179. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  112180. /**
  112181. * Sets the mesh indices,
  112182. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  112183. * @param indices Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array)
  112184. * @param totalVertices Defines the total number of vertices
  112185. * @returns the current mesh
  112186. */
  112187. setIndices(indices: IndicesArray, totalVertices: Nullable<number>): AbstractMesh;
  112188. /**
  112189. * Gets a boolean indicating if specific vertex data is present
  112190. * @param kind defines the vertex data kind to use
  112191. * @returns true is data kind is present
  112192. */
  112193. isVerticesDataPresent(kind: string): boolean;
  112194. /**
  112195. * Returns the mesh BoundingInfo object or creates a new one and returns if it was undefined.
  112196. * Note that it returns a shallow bounding of the mesh (i.e. it does not include children).
  112197. * To get the full bounding of all children, call `getHierarchyBoundingVectors` instead.
  112198. * @returns a BoundingInfo
  112199. */
  112200. getBoundingInfo(): BoundingInfo;
  112201. /**
  112202. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  112203. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  112204. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  112205. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  112206. * @returns the current mesh
  112207. */
  112208. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): AbstractMesh;
  112209. /**
  112210. * Overwrite the current bounding info
  112211. * @param boundingInfo defines the new bounding info
  112212. * @returns the current mesh
  112213. */
  112214. setBoundingInfo(boundingInfo: BoundingInfo): AbstractMesh;
  112215. /** Gets a boolean indicating if this mesh has skinning data and an attached skeleton */
  112216. get useBones(): boolean;
  112217. /** @hidden */
  112218. _preActivate(): void;
  112219. /** @hidden */
  112220. _preActivateForIntermediateRendering(renderId: number): void;
  112221. /** @hidden */
  112222. _activate(renderId: number, intermediateRendering: boolean): boolean;
  112223. /** @hidden */
  112224. _postActivate(): void;
  112225. /** @hidden */
  112226. _freeze(): void;
  112227. /** @hidden */
  112228. _unFreeze(): void;
  112229. /**
  112230. * Gets the current world matrix
  112231. * @returns a Matrix
  112232. */
  112233. getWorldMatrix(): Matrix;
  112234. /** @hidden */
  112235. _getWorldMatrixDeterminant(): number;
  112236. /**
  112237. * Gets a boolean indicating if this mesh is an instance or a regular mesh
  112238. */
  112239. get isAnInstance(): boolean;
  112240. /**
  112241. * Gets a boolean indicating if this mesh has instances
  112242. */
  112243. get hasInstances(): boolean;
  112244. /**
  112245. * Gets a boolean indicating if this mesh has thin instances
  112246. */
  112247. get hasThinInstances(): boolean;
  112248. /**
  112249. * Perform relative position change from the point of view of behind the front of the mesh.
  112250. * This is performed taking into account the meshes current rotation, so you do not have to care.
  112251. * Supports definition of mesh facing forward or backward
  112252. * @param amountRight defines the distance on the right axis
  112253. * @param amountUp defines the distance on the up axis
  112254. * @param amountForward defines the distance on the forward axis
  112255. * @returns the current mesh
  112256. */
  112257. movePOV(amountRight: number, amountUp: number, amountForward: number): AbstractMesh;
  112258. /**
  112259. * Calculate relative position change from the point of view of behind the front of the mesh.
  112260. * This is performed taking into account the meshes current rotation, so you do not have to care.
  112261. * Supports definition of mesh facing forward or backward
  112262. * @param amountRight defines the distance on the right axis
  112263. * @param amountUp defines the distance on the up axis
  112264. * @param amountForward defines the distance on the forward axis
  112265. * @returns the new displacement vector
  112266. */
  112267. calcMovePOV(amountRight: number, amountUp: number, amountForward: number): Vector3;
  112268. /**
  112269. * Perform relative rotation change from the point of view of behind the front of the mesh.
  112270. * Supports definition of mesh facing forward or backward
  112271. * @param flipBack defines the flip
  112272. * @param twirlClockwise defines the twirl
  112273. * @param tiltRight defines the tilt
  112274. * @returns the current mesh
  112275. */
  112276. rotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): AbstractMesh;
  112277. /**
  112278. * Calculate relative rotation change from the point of view of behind the front of the mesh.
  112279. * Supports definition of mesh facing forward or backward.
  112280. * @param flipBack defines the flip
  112281. * @param twirlClockwise defines the twirl
  112282. * @param tiltRight defines the tilt
  112283. * @returns the new rotation vector
  112284. */
  112285. calcRotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): Vector3;
  112286. /**
  112287. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  112288. * This means the mesh underlying bounding box and sphere are recomputed.
  112289. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  112290. * @returns the current mesh
  112291. */
  112292. refreshBoundingInfo(applySkeleton?: boolean): AbstractMesh;
  112293. /** @hidden */
  112294. _refreshBoundingInfo(data: Nullable<FloatArray>, bias: Nullable<Vector2>): void;
  112295. /** @hidden */
  112296. _getPositionData(applySkeleton: boolean): Nullable<FloatArray>;
  112297. /** @hidden */
  112298. _updateBoundingInfo(): AbstractMesh;
  112299. /** @hidden */
  112300. _updateSubMeshesBoundingInfo(matrix: DeepImmutable<Matrix>): AbstractMesh;
  112301. /** @hidden */
  112302. protected _afterComputeWorldMatrix(): void;
  112303. /** @hidden */
  112304. get _effectiveMesh(): AbstractMesh;
  112305. /**
  112306. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  112307. * A mesh is in the frustum if its bounding box intersects the frustum
  112308. * @param frustumPlanes defines the frustum to test
  112309. * @returns true if the mesh is in the frustum planes
  112310. */
  112311. isInFrustum(frustumPlanes: Plane[]): boolean;
  112312. /**
  112313. * Returns `true` if the mesh is completely in the frustum defined be the passed array of planes.
  112314. * A mesh is completely in the frustum if its bounding box it completely inside the frustum.
  112315. * @param frustumPlanes defines the frustum to test
  112316. * @returns true if the mesh is completely in the frustum planes
  112317. */
  112318. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  112319. /**
  112320. * True if the mesh intersects another mesh or a SolidParticle object
  112321. * @param mesh defines a target mesh or SolidParticle to test
  112322. * @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)
  112323. * @param includeDescendants Can be set to true to test if the mesh defined in parameters intersects with the current mesh or any child meshes
  112324. * @returns true if there is an intersection
  112325. */
  112326. intersectsMesh(mesh: AbstractMesh | SolidParticle, precise?: boolean, includeDescendants?: boolean): boolean;
  112327. /**
  112328. * Returns true if the passed point (Vector3) is inside the mesh bounding box
  112329. * @param point defines the point to test
  112330. * @returns true if there is an intersection
  112331. */
  112332. intersectsPoint(point: Vector3): boolean;
  112333. /**
  112334. * Gets or sets a boolean indicating that this mesh can be used in the collision engine
  112335. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  112336. */
  112337. get checkCollisions(): boolean;
  112338. set checkCollisions(collisionEnabled: boolean);
  112339. /**
  112340. * Gets Collider object used to compute collisions (not physics)
  112341. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  112342. */
  112343. get collider(): Nullable<Collider>;
  112344. /**
  112345. * Move the mesh using collision engine
  112346. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  112347. * @param displacement defines the requested displacement vector
  112348. * @returns the current mesh
  112349. */
  112350. moveWithCollisions(displacement: Vector3): AbstractMesh;
  112351. private _onCollisionPositionChange;
  112352. /** @hidden */
  112353. _collideForSubMesh(subMesh: SubMesh, transformMatrix: Matrix, collider: Collider): AbstractMesh;
  112354. /** @hidden */
  112355. _processCollisionsForSubMeshes(collider: Collider, transformMatrix: Matrix): AbstractMesh;
  112356. /** @hidden */
  112357. _checkCollision(collider: Collider): AbstractMesh;
  112358. /** @hidden */
  112359. _generatePointsArray(): boolean;
  112360. /**
  112361. * Checks if the passed Ray intersects with the mesh
  112362. * @param ray defines the ray to use
  112363. * @param fastCheck defines if fast mode (but less precise) must be used (false by default)
  112364. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  112365. * @param onlyBoundingInfo defines a boolean indicating if picking should only happen using bounding info (false by default)
  112366. * @param worldToUse defines the world matrix to use to get the world coordinate of the intersection point
  112367. * @returns the picking info
  112368. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  112369. */
  112370. intersects(ray: Ray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate, onlyBoundingInfo?: boolean, worldToUse?: Matrix): PickingInfo;
  112371. /**
  112372. * Clones the current mesh
  112373. * @param name defines the mesh name
  112374. * @param newParent defines the new mesh parent
  112375. * @param doNotCloneChildren defines a boolean indicating that children must not be cloned (false by default)
  112376. * @returns the new mesh
  112377. */
  112378. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  112379. /**
  112380. * Disposes all the submeshes of the current meshnp
  112381. * @returns the current mesh
  112382. */
  112383. releaseSubMeshes(): AbstractMesh;
  112384. /**
  112385. * Releases resources associated with this abstract mesh.
  112386. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  112387. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  112388. */
  112389. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  112390. /**
  112391. * Adds the passed mesh as a child to the current mesh
  112392. * @param mesh defines the child mesh
  112393. * @returns the current mesh
  112394. */
  112395. addChild(mesh: AbstractMesh): AbstractMesh;
  112396. /**
  112397. * Removes the passed mesh from the current mesh children list
  112398. * @param mesh defines the child mesh
  112399. * @returns the current mesh
  112400. */
  112401. removeChild(mesh: AbstractMesh): AbstractMesh;
  112402. /** @hidden */
  112403. private _initFacetData;
  112404. /**
  112405. * Updates the mesh facetData arrays and the internal partitioning when the mesh is morphed or updated.
  112406. * This method can be called within the render loop.
  112407. * 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
  112408. * @returns the current mesh
  112409. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112410. */
  112411. updateFacetData(): AbstractMesh;
  112412. /**
  112413. * Returns the facetLocalNormals array.
  112414. * The normals are expressed in the mesh local spac
  112415. * @returns an array of Vector3
  112416. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112417. */
  112418. getFacetLocalNormals(): Vector3[];
  112419. /**
  112420. * Returns the facetLocalPositions array.
  112421. * The facet positions are expressed in the mesh local space
  112422. * @returns an array of Vector3
  112423. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112424. */
  112425. getFacetLocalPositions(): Vector3[];
  112426. /**
  112427. * Returns the facetLocalPartioning array
  112428. * @returns an array of array of numbers
  112429. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112430. */
  112431. getFacetLocalPartitioning(): number[][];
  112432. /**
  112433. * Returns the i-th facet position in the world system.
  112434. * This method allocates a new Vector3 per call
  112435. * @param i defines the facet index
  112436. * @returns a new Vector3
  112437. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112438. */
  112439. getFacetPosition(i: number): Vector3;
  112440. /**
  112441. * Sets the reference Vector3 with the i-th facet position in the world system
  112442. * @param i defines the facet index
  112443. * @param ref defines the target vector
  112444. * @returns the current mesh
  112445. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112446. */
  112447. getFacetPositionToRef(i: number, ref: Vector3): AbstractMesh;
  112448. /**
  112449. * Returns the i-th facet normal in the world system.
  112450. * This method allocates a new Vector3 per call
  112451. * @param i defines the facet index
  112452. * @returns a new Vector3
  112453. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112454. */
  112455. getFacetNormal(i: number): Vector3;
  112456. /**
  112457. * Sets the reference Vector3 with the i-th facet normal in the world system
  112458. * @param i defines the facet index
  112459. * @param ref defines the target vector
  112460. * @returns the current mesh
  112461. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112462. */
  112463. getFacetNormalToRef(i: number, ref: Vector3): this;
  112464. /**
  112465. * 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)
  112466. * @param x defines x coordinate
  112467. * @param y defines y coordinate
  112468. * @param z defines z coordinate
  112469. * @returns the array of facet indexes
  112470. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112471. */
  112472. getFacetsAtLocalCoordinates(x: number, y: number, z: number): Nullable<number[]>;
  112473. /**
  112474. * Returns the closest mesh facet index at (x,y,z) World coordinates, null if not found
  112475. * @param projected sets as the (x,y,z) world projection on the facet
  112476. * @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
  112477. * @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
  112478. * @param x defines x coordinate
  112479. * @param y defines y coordinate
  112480. * @param z defines z coordinate
  112481. * @returns the face index if found (or null instead)
  112482. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112483. */
  112484. getClosestFacetAtCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  112485. /**
  112486. * Returns the closest mesh facet index at (x,y,z) local coordinates, null if not found
  112487. * @param projected sets as the (x,y,z) local projection on the facet
  112488. * @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
  112489. * @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
  112490. * @param x defines x coordinate
  112491. * @param y defines y coordinate
  112492. * @param z defines z coordinate
  112493. * @returns the face index if found (or null instead)
  112494. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112495. */
  112496. getClosestFacetAtLocalCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  112497. /**
  112498. * Returns the object "parameter" set with all the expected parameters for facetData computation by ComputeNormals()
  112499. * @returns the parameters
  112500. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112501. */
  112502. getFacetDataParameters(): any;
  112503. /**
  112504. * Disables the feature FacetData and frees the related memory
  112505. * @returns the current mesh
  112506. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112507. */
  112508. disableFacetData(): AbstractMesh;
  112509. /**
  112510. * Updates the AbstractMesh indices array
  112511. * @param indices defines the data source
  112512. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  112513. * @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)
  112514. * @returns the current mesh
  112515. */
  112516. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  112517. /**
  112518. * Creates new normals data for the mesh
  112519. * @param updatable defines if the normal vertex buffer must be flagged as updatable
  112520. * @returns the current mesh
  112521. */
  112522. createNormals(updatable: boolean): AbstractMesh;
  112523. /**
  112524. * Align the mesh with a normal
  112525. * @param normal defines the normal to use
  112526. * @param upDirection can be used to redefined the up vector to use (will use the (0, 1, 0) by default)
  112527. * @returns the current mesh
  112528. */
  112529. alignWithNormal(normal: Vector3, upDirection?: Vector3): AbstractMesh;
  112530. /** @hidden */
  112531. _checkOcclusionQuery(): boolean;
  112532. /**
  112533. * Disables the mesh edge rendering mode
  112534. * @returns the currentAbstractMesh
  112535. */
  112536. disableEdgesRendering(): AbstractMesh;
  112537. /**
  112538. * Enables the edge rendering mode on the mesh.
  112539. * This mode makes the mesh edges visible
  112540. * @param epsilon defines the maximal distance between two angles to detect a face
  112541. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  112542. * @returns the currentAbstractMesh
  112543. * @see https://www.babylonjs-playground.com/#19O9TU#0
  112544. */
  112545. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  112546. /**
  112547. * This function returns all of the particle systems in the scene that use the mesh as an emitter.
  112548. * @returns an array of particle systems in the scene that use the mesh as an emitter
  112549. */
  112550. getConnectedParticleSystems(): IParticleSystem[];
  112551. }
  112552. }
  112553. declare module BABYLON {
  112554. /**
  112555. * Interface used to define ActionEvent
  112556. */
  112557. export interface IActionEvent {
  112558. /** The mesh or sprite that triggered the action */
  112559. source: any;
  112560. /** The X mouse cursor position at the time of the event */
  112561. pointerX: number;
  112562. /** The Y mouse cursor position at the time of the event */
  112563. pointerY: number;
  112564. /** The mesh that is currently pointed at (can be null) */
  112565. meshUnderPointer: Nullable<AbstractMesh>;
  112566. /** the original (browser) event that triggered the ActionEvent */
  112567. sourceEvent?: any;
  112568. /** additional data for the event */
  112569. additionalData?: any;
  112570. }
  112571. /**
  112572. * ActionEvent is the event being sent when an action is triggered.
  112573. */
  112574. export class ActionEvent implements IActionEvent {
  112575. /** The mesh or sprite that triggered the action */
  112576. source: any;
  112577. /** The X mouse cursor position at the time of the event */
  112578. pointerX: number;
  112579. /** The Y mouse cursor position at the time of the event */
  112580. pointerY: number;
  112581. /** The mesh that is currently pointed at (can be null) */
  112582. meshUnderPointer: Nullable<AbstractMesh>;
  112583. /** the original (browser) event that triggered the ActionEvent */
  112584. sourceEvent?: any;
  112585. /** additional data for the event */
  112586. additionalData?: any;
  112587. /**
  112588. * Creates a new ActionEvent
  112589. * @param source The mesh or sprite that triggered the action
  112590. * @param pointerX The X mouse cursor position at the time of the event
  112591. * @param pointerY The Y mouse cursor position at the time of the event
  112592. * @param meshUnderPointer The mesh that is currently pointed at (can be null)
  112593. * @param sourceEvent the original (browser) event that triggered the ActionEvent
  112594. * @param additionalData additional data for the event
  112595. */
  112596. constructor(
  112597. /** The mesh or sprite that triggered the action */
  112598. source: any,
  112599. /** The X mouse cursor position at the time of the event */
  112600. pointerX: number,
  112601. /** The Y mouse cursor position at the time of the event */
  112602. pointerY: number,
  112603. /** The mesh that is currently pointed at (can be null) */
  112604. meshUnderPointer: Nullable<AbstractMesh>,
  112605. /** the original (browser) event that triggered the ActionEvent */
  112606. sourceEvent?: any,
  112607. /** additional data for the event */
  112608. additionalData?: any);
  112609. /**
  112610. * Helper function to auto-create an ActionEvent from a source mesh.
  112611. * @param source The source mesh that triggered the event
  112612. * @param evt The original (browser) event
  112613. * @param additionalData additional data for the event
  112614. * @returns the new ActionEvent
  112615. */
  112616. static CreateNew(source: AbstractMesh, evt?: Event, additionalData?: any): ActionEvent;
  112617. /**
  112618. * Helper function to auto-create an ActionEvent from a source sprite
  112619. * @param source The source sprite that triggered the event
  112620. * @param scene Scene associated with the sprite
  112621. * @param evt The original (browser) event
  112622. * @param additionalData additional data for the event
  112623. * @returns the new ActionEvent
  112624. */
  112625. static CreateNewFromSprite(source: Sprite, scene: Scene, evt?: Event, additionalData?: any): ActionEvent;
  112626. /**
  112627. * Helper function to auto-create an ActionEvent from a scene. If triggered by a mesh use ActionEvent.CreateNew
  112628. * @param scene the scene where the event occurred
  112629. * @param evt The original (browser) event
  112630. * @returns the new ActionEvent
  112631. */
  112632. static CreateNewFromScene(scene: Scene, evt: Event): ActionEvent;
  112633. /**
  112634. * Helper function to auto-create an ActionEvent from a primitive
  112635. * @param prim defines the target primitive
  112636. * @param pointerPos defines the pointer position
  112637. * @param evt The original (browser) event
  112638. * @param additionalData additional data for the event
  112639. * @returns the new ActionEvent
  112640. */
  112641. static CreateNewFromPrimitive(prim: any, pointerPos: Vector2, evt?: Event, additionalData?: any): ActionEvent;
  112642. }
  112643. }
  112644. declare module BABYLON {
  112645. /**
  112646. * Abstract class used to decouple action Manager from scene and meshes.
  112647. * Do not instantiate.
  112648. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  112649. */
  112650. export abstract class AbstractActionManager implements IDisposable {
  112651. /** Gets the list of active triggers */
  112652. static Triggers: {
  112653. [key: string]: number;
  112654. };
  112655. /** Gets the cursor to use when hovering items */
  112656. hoverCursor: string;
  112657. /** Gets the list of actions */
  112658. actions: IAction[];
  112659. /**
  112660. * Gets or sets a boolean indicating that the manager is recursive meaning that it can trigger action from children
  112661. */
  112662. isRecursive: boolean;
  112663. /**
  112664. * Releases all associated resources
  112665. */
  112666. abstract dispose(): void;
  112667. /**
  112668. * Does this action manager has pointer triggers
  112669. */
  112670. abstract get hasPointerTriggers(): boolean;
  112671. /**
  112672. * Does this action manager has pick triggers
  112673. */
  112674. abstract get hasPickTriggers(): boolean;
  112675. /**
  112676. * Process a specific trigger
  112677. * @param trigger defines the trigger to process
  112678. * @param evt defines the event details to be processed
  112679. */
  112680. abstract processTrigger(trigger: number, evt?: IActionEvent): void;
  112681. /**
  112682. * Does this action manager handles actions of any of the given triggers
  112683. * @param triggers defines the triggers to be tested
  112684. * @return a boolean indicating whether one (or more) of the triggers is handled
  112685. */
  112686. abstract hasSpecificTriggers(triggers: number[]): boolean;
  112687. /**
  112688. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  112689. * speed.
  112690. * @param triggerA defines the trigger to be tested
  112691. * @param triggerB defines the trigger to be tested
  112692. * @return a boolean indicating whether one (or more) of the triggers is handled
  112693. */
  112694. abstract hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  112695. /**
  112696. * Does this action manager handles actions of a given trigger
  112697. * @param trigger defines the trigger to be tested
  112698. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  112699. * @return whether the trigger is handled
  112700. */
  112701. abstract hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  112702. /**
  112703. * Serialize this manager to a JSON object
  112704. * @param name defines the property name to store this manager
  112705. * @returns a JSON representation of this manager
  112706. */
  112707. abstract serialize(name: string): any;
  112708. /**
  112709. * Registers an action to this action manager
  112710. * @param action defines the action to be registered
  112711. * @return the action amended (prepared) after registration
  112712. */
  112713. abstract registerAction(action: IAction): Nullable<IAction>;
  112714. /**
  112715. * Unregisters an action to this action manager
  112716. * @param action defines the action to be unregistered
  112717. * @return a boolean indicating whether the action has been unregistered
  112718. */
  112719. abstract unregisterAction(action: IAction): Boolean;
  112720. /**
  112721. * Does exist one action manager with at least one trigger
  112722. **/
  112723. static get HasTriggers(): boolean;
  112724. /**
  112725. * Does exist one action manager with at least one pick trigger
  112726. **/
  112727. static get HasPickTriggers(): boolean;
  112728. /**
  112729. * Does exist one action manager that handles actions of a given trigger
  112730. * @param trigger defines the trigger to be tested
  112731. * @return a boolean indicating whether the trigger is handeled by at least one action manager
  112732. **/
  112733. static HasSpecificTrigger(trigger: number): boolean;
  112734. }
  112735. }
  112736. declare module BABYLON {
  112737. /**
  112738. * Defines how a node can be built from a string name.
  112739. */
  112740. export type NodeConstructor = (name: string, scene: Scene, options?: any) => () => Node;
  112741. /**
  112742. * Node is the basic class for all scene objects (Mesh, Light, Camera.)
  112743. */
  112744. export class Node implements IBehaviorAware<Node> {
  112745. /** @hidden */
  112746. static _AnimationRangeFactory: (name: string, from: number, to: number) => AnimationRange;
  112747. private static _NodeConstructors;
  112748. /**
  112749. * Add a new node constructor
  112750. * @param type defines the type name of the node to construct
  112751. * @param constructorFunc defines the constructor function
  112752. */
  112753. static AddNodeConstructor(type: string, constructorFunc: NodeConstructor): void;
  112754. /**
  112755. * Returns a node constructor based on type name
  112756. * @param type defines the type name
  112757. * @param name defines the new node name
  112758. * @param scene defines the hosting scene
  112759. * @param options defines optional options to transmit to constructors
  112760. * @returns the new constructor or null
  112761. */
  112762. static Construct(type: string, name: string, scene: Scene, options?: any): Nullable<() => Node>;
  112763. /**
  112764. * Gets or sets the name of the node
  112765. */
  112766. name: string;
  112767. /**
  112768. * Gets or sets the id of the node
  112769. */
  112770. id: string;
  112771. /**
  112772. * Gets or sets the unique id of the node
  112773. */
  112774. uniqueId: number;
  112775. /**
  112776. * Gets or sets a string used to store user defined state for the node
  112777. */
  112778. state: string;
  112779. /**
  112780. * Gets or sets an object used to store user defined information for the node
  112781. */
  112782. metadata: any;
  112783. /**
  112784. * For internal use only. Please do not use.
  112785. */
  112786. reservedDataStore: any;
  112787. /**
  112788. * List of inspectable custom properties (used by the Inspector)
  112789. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  112790. */
  112791. inspectableCustomProperties: IInspectable[];
  112792. private _doNotSerialize;
  112793. /**
  112794. * Gets or sets a boolean used to define if the node must be serialized
  112795. */
  112796. get doNotSerialize(): boolean;
  112797. set doNotSerialize(value: boolean);
  112798. /** @hidden */
  112799. _isDisposed: boolean;
  112800. /**
  112801. * Gets a list of Animations associated with the node
  112802. */
  112803. animations: Animation[];
  112804. protected _ranges: {
  112805. [name: string]: Nullable<AnimationRange>;
  112806. };
  112807. /**
  112808. * Callback raised when the node is ready to be used
  112809. */
  112810. onReady: Nullable<(node: Node) => void>;
  112811. private _isEnabled;
  112812. private _isParentEnabled;
  112813. private _isReady;
  112814. /** @hidden */
  112815. _currentRenderId: number;
  112816. private _parentUpdateId;
  112817. /** @hidden */
  112818. _childUpdateId: number;
  112819. /** @hidden */
  112820. _waitingParentId: Nullable<string>;
  112821. /** @hidden */
  112822. _scene: Scene;
  112823. /** @hidden */
  112824. _cache: any;
  112825. private _parentNode;
  112826. private _children;
  112827. /** @hidden */
  112828. _worldMatrix: Matrix;
  112829. /** @hidden */
  112830. _worldMatrixDeterminant: number;
  112831. /** @hidden */
  112832. _worldMatrixDeterminantIsDirty: boolean;
  112833. /** @hidden */
  112834. private _sceneRootNodesIndex;
  112835. /**
  112836. * Gets a boolean indicating if the node has been disposed
  112837. * @returns true if the node was disposed
  112838. */
  112839. isDisposed(): boolean;
  112840. /**
  112841. * Gets or sets the parent of the node (without keeping the current position in the scene)
  112842. * @see https://doc.babylonjs.com/how_to/parenting
  112843. */
  112844. set parent(parent: Nullable<Node>);
  112845. get parent(): Nullable<Node>;
  112846. /** @hidden */
  112847. _addToSceneRootNodes(): void;
  112848. /** @hidden */
  112849. _removeFromSceneRootNodes(): void;
  112850. private _animationPropertiesOverride;
  112851. /**
  112852. * Gets or sets the animation properties override
  112853. */
  112854. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  112855. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  112856. /**
  112857. * Gets a string identifying the name of the class
  112858. * @returns "Node" string
  112859. */
  112860. getClassName(): string;
  112861. /** @hidden */
  112862. readonly _isNode: boolean;
  112863. /**
  112864. * An event triggered when the mesh is disposed
  112865. */
  112866. onDisposeObservable: Observable<Node>;
  112867. private _onDisposeObserver;
  112868. /**
  112869. * Sets a callback that will be raised when the node will be disposed
  112870. */
  112871. set onDispose(callback: () => void);
  112872. /**
  112873. * Creates a new Node
  112874. * @param name the name and id to be given to this node
  112875. * @param scene the scene this node will be added to
  112876. */
  112877. constructor(name: string, scene?: Nullable<Scene>);
  112878. /**
  112879. * Gets the scene of the node
  112880. * @returns a scene
  112881. */
  112882. getScene(): Scene;
  112883. /**
  112884. * Gets the engine of the node
  112885. * @returns a Engine
  112886. */
  112887. getEngine(): Engine;
  112888. private _behaviors;
  112889. /**
  112890. * Attach a behavior to the node
  112891. * @see https://doc.babylonjs.com/features/behaviour
  112892. * @param behavior defines the behavior to attach
  112893. * @param attachImmediately defines that the behavior must be attached even if the scene is still loading
  112894. * @returns the current Node
  112895. */
  112896. addBehavior(behavior: Behavior<Node>, attachImmediately?: boolean): Node;
  112897. /**
  112898. * Remove an attached behavior
  112899. * @see https://doc.babylonjs.com/features/behaviour
  112900. * @param behavior defines the behavior to attach
  112901. * @returns the current Node
  112902. */
  112903. removeBehavior(behavior: Behavior<Node>): Node;
  112904. /**
  112905. * Gets the list of attached behaviors
  112906. * @see https://doc.babylonjs.com/features/behaviour
  112907. */
  112908. get behaviors(): Behavior<Node>[];
  112909. /**
  112910. * Gets an attached behavior by name
  112911. * @param name defines the name of the behavior to look for
  112912. * @see https://doc.babylonjs.com/features/behaviour
  112913. * @returns null if behavior was not found else the requested behavior
  112914. */
  112915. getBehaviorByName(name: string): Nullable<Behavior<Node>>;
  112916. /**
  112917. * Returns the latest update of the World matrix
  112918. * @returns a Matrix
  112919. */
  112920. getWorldMatrix(): Matrix;
  112921. /** @hidden */
  112922. _getWorldMatrixDeterminant(): number;
  112923. /**
  112924. * Returns directly the latest state of the mesh World matrix.
  112925. * A Matrix is returned.
  112926. */
  112927. get worldMatrixFromCache(): Matrix;
  112928. /** @hidden */
  112929. _initCache(): void;
  112930. /** @hidden */
  112931. updateCache(force?: boolean): void;
  112932. /** @hidden */
  112933. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  112934. /** @hidden */
  112935. _updateCache(ignoreParentClass?: boolean): void;
  112936. /** @hidden */
  112937. _isSynchronized(): boolean;
  112938. /** @hidden */
  112939. _markSyncedWithParent(): void;
  112940. /** @hidden */
  112941. isSynchronizedWithParent(): boolean;
  112942. /** @hidden */
  112943. isSynchronized(): boolean;
  112944. /**
  112945. * Is this node ready to be used/rendered
  112946. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  112947. * @return true if the node is ready
  112948. */
  112949. isReady(completeCheck?: boolean): boolean;
  112950. /**
  112951. * Is this node enabled?
  112952. * 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
  112953. * @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
  112954. * @return whether this node (and its parent) is enabled
  112955. */
  112956. isEnabled(checkAncestors?: boolean): boolean;
  112957. /** @hidden */
  112958. protected _syncParentEnabledState(): void;
  112959. /**
  112960. * Set the enabled state of this node
  112961. * @param value defines the new enabled state
  112962. */
  112963. setEnabled(value: boolean): void;
  112964. /**
  112965. * Is this node a descendant of the given node?
  112966. * The function will iterate up the hierarchy until the ancestor was found or no more parents defined
  112967. * @param ancestor defines the parent node to inspect
  112968. * @returns a boolean indicating if this node is a descendant of the given node
  112969. */
  112970. isDescendantOf(ancestor: Node): boolean;
  112971. /** @hidden */
  112972. _getDescendants(results: Node[], directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): void;
  112973. /**
  112974. * Will return all nodes that have this node as ascendant
  112975. * @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
  112976. * @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
  112977. * @return all children nodes of all types
  112978. */
  112979. getDescendants(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): Node[];
  112980. /**
  112981. * Get all child-meshes of this node
  112982. * @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)
  112983. * @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
  112984. * @returns an array of AbstractMesh
  112985. */
  112986. getChildMeshes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): AbstractMesh[];
  112987. /**
  112988. * Get all direct children of this node
  112989. * @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
  112990. * @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)
  112991. * @returns an array of Node
  112992. */
  112993. getChildren(predicate?: (node: Node) => boolean, directDescendantsOnly?: boolean): Node[];
  112994. /** @hidden */
  112995. _setReady(state: boolean): void;
  112996. /**
  112997. * Get an animation by name
  112998. * @param name defines the name of the animation to look for
  112999. * @returns null if not found else the requested animation
  113000. */
  113001. getAnimationByName(name: string): Nullable<Animation>;
  113002. /**
  113003. * Creates an animation range for this node
  113004. * @param name defines the name of the range
  113005. * @param from defines the starting key
  113006. * @param to defines the end key
  113007. */
  113008. createAnimationRange(name: string, from: number, to: number): void;
  113009. /**
  113010. * Delete a specific animation range
  113011. * @param name defines the name of the range to delete
  113012. * @param deleteFrames defines if animation frames from the range must be deleted as well
  113013. */
  113014. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  113015. /**
  113016. * Get an animation range by name
  113017. * @param name defines the name of the animation range to look for
  113018. * @returns null if not found else the requested animation range
  113019. */
  113020. getAnimationRange(name: string): Nullable<AnimationRange>;
  113021. /**
  113022. * Gets the list of all animation ranges defined on this node
  113023. * @returns an array
  113024. */
  113025. getAnimationRanges(): Nullable<AnimationRange>[];
  113026. /**
  113027. * Will start the animation sequence
  113028. * @param name defines the range frames for animation sequence
  113029. * @param loop defines if the animation should loop (false by default)
  113030. * @param speedRatio defines the speed factor in which to run the animation (1 by default)
  113031. * @param onAnimationEnd defines a function to be executed when the animation ended (undefined by default)
  113032. * @returns the object created for this animation. If range does not exist, it will return null
  113033. */
  113034. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  113035. /**
  113036. * Serialize animation ranges into a JSON compatible object
  113037. * @returns serialization object
  113038. */
  113039. serializeAnimationRanges(): any;
  113040. /**
  113041. * Computes the world matrix of the node
  113042. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  113043. * @returns the world matrix
  113044. */
  113045. computeWorldMatrix(force?: boolean): Matrix;
  113046. /**
  113047. * Releases resources associated with this node.
  113048. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  113049. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  113050. */
  113051. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  113052. /**
  113053. * Parse animation range data from a serialization object and store them into a given node
  113054. * @param node defines where to store the animation ranges
  113055. * @param parsedNode defines the serialization object to read data from
  113056. * @param scene defines the hosting scene
  113057. */
  113058. static ParseAnimationRanges(node: Node, parsedNode: any, scene: Scene): void;
  113059. /**
  113060. * Return the minimum and maximum world vectors of the entire hierarchy under current node
  113061. * @param includeDescendants Include bounding info from descendants as well (true by default)
  113062. * @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
  113063. * @returns the new bounding vectors
  113064. */
  113065. getHierarchyBoundingVectors(includeDescendants?: boolean, predicate?: Nullable<(abstractMesh: AbstractMesh) => boolean>): {
  113066. min: Vector3;
  113067. max: Vector3;
  113068. };
  113069. }
  113070. }
  113071. declare module BABYLON {
  113072. /**
  113073. * @hidden
  113074. */
  113075. export class _IAnimationState {
  113076. key: number;
  113077. repeatCount: number;
  113078. workValue?: any;
  113079. loopMode?: number;
  113080. offsetValue?: any;
  113081. highLimitValue?: any;
  113082. }
  113083. /**
  113084. * Class used to store any kind of animation
  113085. */
  113086. export class Animation {
  113087. /**Name of the animation */
  113088. name: string;
  113089. /**Property to animate */
  113090. targetProperty: string;
  113091. /**The frames per second of the animation */
  113092. framePerSecond: number;
  113093. /**The data type of the animation */
  113094. dataType: number;
  113095. /**The loop mode of the animation */
  113096. loopMode?: number | undefined;
  113097. /**Specifies if blending should be enabled */
  113098. enableBlending?: boolean | undefined;
  113099. /**
  113100. * Use matrix interpolation instead of using direct key value when animating matrices
  113101. */
  113102. static AllowMatricesInterpolation: boolean;
  113103. /**
  113104. * When matrix interpolation is enabled, this boolean forces the system to use Matrix.DecomposeLerp instead of Matrix.Lerp. Interpolation is more precise but slower
  113105. */
  113106. static AllowMatrixDecomposeForInterpolation: boolean;
  113107. /** Define the Url to load snippets */
  113108. static SnippetUrl: string;
  113109. /** Snippet ID if the animation was created from the snippet server */
  113110. snippetId: string;
  113111. /**
  113112. * Stores the key frames of the animation
  113113. */
  113114. private _keys;
  113115. /**
  113116. * Stores the easing function of the animation
  113117. */
  113118. private _easingFunction;
  113119. /**
  113120. * @hidden Internal use only
  113121. */
  113122. _runtimeAnimations: RuntimeAnimation[];
  113123. /**
  113124. * The set of event that will be linked to this animation
  113125. */
  113126. private _events;
  113127. /**
  113128. * Stores an array of target property paths
  113129. */
  113130. targetPropertyPath: string[];
  113131. /**
  113132. * Stores the blending speed of the animation
  113133. */
  113134. blendingSpeed: number;
  113135. /**
  113136. * Stores the animation ranges for the animation
  113137. */
  113138. private _ranges;
  113139. /**
  113140. * @hidden Internal use
  113141. */
  113142. static _PrepareAnimation(name: string, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction): Nullable<Animation>;
  113143. /**
  113144. * Sets up an animation
  113145. * @param property The property to animate
  113146. * @param animationType The animation type to apply
  113147. * @param framePerSecond The frames per second of the animation
  113148. * @param easingFunction The easing function used in the animation
  113149. * @returns The created animation
  113150. */
  113151. static CreateAnimation(property: string, animationType: number, framePerSecond: number, easingFunction: EasingFunction): Animation;
  113152. /**
  113153. * Create and start an animation on a node
  113154. * @param name defines the name of the global animation that will be run on all nodes
  113155. * @param node defines the root node where the animation will take place
  113156. * @param targetProperty defines property to animate
  113157. * @param framePerSecond defines the number of frame per second yo use
  113158. * @param totalFrame defines the number of frames in total
  113159. * @param from defines the initial value
  113160. * @param to defines the final value
  113161. * @param loopMode defines which loop mode you want to use (off by default)
  113162. * @param easingFunction defines the easing function to use (linear by default)
  113163. * @param onAnimationEnd defines the callback to call when animation end
  113164. * @returns the animatable created for this animation
  113165. */
  113166. static CreateAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  113167. /**
  113168. * Create and start an animation on a node and its descendants
  113169. * @param name defines the name of the global animation that will be run on all nodes
  113170. * @param node defines the root node where the animation will take place
  113171. * @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
  113172. * @param targetProperty defines property to animate
  113173. * @param framePerSecond defines the number of frame per second to use
  113174. * @param totalFrame defines the number of frames in total
  113175. * @param from defines the initial value
  113176. * @param to defines the final value
  113177. * @param loopMode defines which loop mode you want to use (off by default)
  113178. * @param easingFunction defines the easing function to use (linear by default)
  113179. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  113180. * @returns the list of animatables created for all nodes
  113181. * @example https://www.babylonjs-playground.com/#MH0VLI
  113182. */
  113183. 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[]>;
  113184. /**
  113185. * Creates a new animation, merges it with the existing animations and starts it
  113186. * @param name Name of the animation
  113187. * @param node Node which contains the scene that begins the animations
  113188. * @param targetProperty Specifies which property to animate
  113189. * @param framePerSecond The frames per second of the animation
  113190. * @param totalFrame The total number of frames
  113191. * @param from The frame at the beginning of the animation
  113192. * @param to The frame at the end of the animation
  113193. * @param loopMode Specifies the loop mode of the animation
  113194. * @param easingFunction (Optional) The easing function of the animation, which allow custom mathematical formulas for animations
  113195. * @param onAnimationEnd Callback to run once the animation is complete
  113196. * @returns Nullable animation
  113197. */
  113198. static CreateMergeAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  113199. /**
  113200. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  113201. * @param sourceAnimation defines the Animation containing keyframes to convert
  113202. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  113203. * @param range defines the name of the AnimationRange belonging to the Animation to convert
  113204. * @param cloneOriginal defines whether or not to clone the animation and convert the clone or convert the original animation (default is false)
  113205. * @param clonedName defines the name of the resulting cloned Animation if cloneOriginal is true
  113206. * @returns a new Animation if cloneOriginal is true or the original Animation if cloneOriginal is false
  113207. */
  113208. static MakeAnimationAdditive(sourceAnimation: Animation, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): Animation;
  113209. /**
  113210. * Transition property of an host to the target Value
  113211. * @param property The property to transition
  113212. * @param targetValue The target Value of the property
  113213. * @param host The object where the property to animate belongs
  113214. * @param scene Scene used to run the animation
  113215. * @param frameRate Framerate (in frame/s) to use
  113216. * @param transition The transition type we want to use
  113217. * @param duration The duration of the animation, in milliseconds
  113218. * @param onAnimationEnd Callback trigger at the end of the animation
  113219. * @returns Nullable animation
  113220. */
  113221. static TransitionTo(property: string, targetValue: any, host: any, scene: Scene, frameRate: number, transition: Animation, duration: number, onAnimationEnd?: Nullable<() => void>): Nullable<Animatable>;
  113222. /**
  113223. * Return the array of runtime animations currently using this animation
  113224. */
  113225. get runtimeAnimations(): RuntimeAnimation[];
  113226. /**
  113227. * Specifies if any of the runtime animations are currently running
  113228. */
  113229. get hasRunningRuntimeAnimations(): boolean;
  113230. /**
  113231. * Initializes the animation
  113232. * @param name Name of the animation
  113233. * @param targetProperty Property to animate
  113234. * @param framePerSecond The frames per second of the animation
  113235. * @param dataType The data type of the animation
  113236. * @param loopMode The loop mode of the animation
  113237. * @param enableBlending Specifies if blending should be enabled
  113238. */
  113239. constructor(
  113240. /**Name of the animation */
  113241. name: string,
  113242. /**Property to animate */
  113243. targetProperty: string,
  113244. /**The frames per second of the animation */
  113245. framePerSecond: number,
  113246. /**The data type of the animation */
  113247. dataType: number,
  113248. /**The loop mode of the animation */
  113249. loopMode?: number | undefined,
  113250. /**Specifies if blending should be enabled */
  113251. enableBlending?: boolean | undefined);
  113252. /**
  113253. * Converts the animation to a string
  113254. * @param fullDetails support for multiple levels of logging within scene loading
  113255. * @returns String form of the animation
  113256. */
  113257. toString(fullDetails?: boolean): string;
  113258. /**
  113259. * Add an event to this animation
  113260. * @param event Event to add
  113261. */
  113262. addEvent(event: AnimationEvent): void;
  113263. /**
  113264. * Remove all events found at the given frame
  113265. * @param frame The frame to remove events from
  113266. */
  113267. removeEvents(frame: number): void;
  113268. /**
  113269. * Retrieves all the events from the animation
  113270. * @returns Events from the animation
  113271. */
  113272. getEvents(): AnimationEvent[];
  113273. /**
  113274. * Creates an animation range
  113275. * @param name Name of the animation range
  113276. * @param from Starting frame of the animation range
  113277. * @param to Ending frame of the animation
  113278. */
  113279. createRange(name: string, from: number, to: number): void;
  113280. /**
  113281. * Deletes an animation range by name
  113282. * @param name Name of the animation range to delete
  113283. * @param deleteFrames Specifies if the key frames for the range should also be deleted (true) or not (false)
  113284. */
  113285. deleteRange(name: string, deleteFrames?: boolean): void;
  113286. /**
  113287. * Gets the animation range by name, or null if not defined
  113288. * @param name Name of the animation range
  113289. * @returns Nullable animation range
  113290. */
  113291. getRange(name: string): Nullable<AnimationRange>;
  113292. /**
  113293. * Gets the key frames from the animation
  113294. * @returns The key frames of the animation
  113295. */
  113296. getKeys(): Array<IAnimationKey>;
  113297. /**
  113298. * Gets the highest frame rate of the animation
  113299. * @returns Highest frame rate of the animation
  113300. */
  113301. getHighestFrame(): number;
  113302. /**
  113303. * Gets the easing function of the animation
  113304. * @returns Easing function of the animation
  113305. */
  113306. getEasingFunction(): IEasingFunction;
  113307. /**
  113308. * Sets the easing function of the animation
  113309. * @param easingFunction A custom mathematical formula for animation
  113310. */
  113311. setEasingFunction(easingFunction: EasingFunction): void;
  113312. /**
  113313. * Interpolates a scalar linearly
  113314. * @param startValue Start value of the animation curve
  113315. * @param endValue End value of the animation curve
  113316. * @param gradient Scalar amount to interpolate
  113317. * @returns Interpolated scalar value
  113318. */
  113319. floatInterpolateFunction(startValue: number, endValue: number, gradient: number): number;
  113320. /**
  113321. * Interpolates a scalar cubically
  113322. * @param startValue Start value of the animation curve
  113323. * @param outTangent End tangent of the animation
  113324. * @param endValue End value of the animation curve
  113325. * @param inTangent Start tangent of the animation curve
  113326. * @param gradient Scalar amount to interpolate
  113327. * @returns Interpolated scalar value
  113328. */
  113329. floatInterpolateFunctionWithTangents(startValue: number, outTangent: number, endValue: number, inTangent: number, gradient: number): number;
  113330. /**
  113331. * Interpolates a quaternion using a spherical linear interpolation
  113332. * @param startValue Start value of the animation curve
  113333. * @param endValue End value of the animation curve
  113334. * @param gradient Scalar amount to interpolate
  113335. * @returns Interpolated quaternion value
  113336. */
  113337. quaternionInterpolateFunction(startValue: Quaternion, endValue: Quaternion, gradient: number): Quaternion;
  113338. /**
  113339. * Interpolates a quaternion cubically
  113340. * @param startValue Start value of the animation curve
  113341. * @param outTangent End tangent of the animation curve
  113342. * @param endValue End value of the animation curve
  113343. * @param inTangent Start tangent of the animation curve
  113344. * @param gradient Scalar amount to interpolate
  113345. * @returns Interpolated quaternion value
  113346. */
  113347. quaternionInterpolateFunctionWithTangents(startValue: Quaternion, outTangent: Quaternion, endValue: Quaternion, inTangent: Quaternion, gradient: number): Quaternion;
  113348. /**
  113349. * Interpolates a Vector3 linearl
  113350. * @param startValue Start value of the animation curve
  113351. * @param endValue End value of the animation curve
  113352. * @param gradient Scalar amount to interpolate
  113353. * @returns Interpolated scalar value
  113354. */
  113355. vector3InterpolateFunction(startValue: Vector3, endValue: Vector3, gradient: number): Vector3;
  113356. /**
  113357. * Interpolates a Vector3 cubically
  113358. * @param startValue Start value of the animation curve
  113359. * @param outTangent End tangent of the animation
  113360. * @param endValue End value of the animation curve
  113361. * @param inTangent Start tangent of the animation curve
  113362. * @param gradient Scalar amount to interpolate
  113363. * @returns InterpolatedVector3 value
  113364. */
  113365. vector3InterpolateFunctionWithTangents(startValue: Vector3, outTangent: Vector3, endValue: Vector3, inTangent: Vector3, gradient: number): Vector3;
  113366. /**
  113367. * Interpolates a Vector2 linearly
  113368. * @param startValue Start value of the animation curve
  113369. * @param endValue End value of the animation curve
  113370. * @param gradient Scalar amount to interpolate
  113371. * @returns Interpolated Vector2 value
  113372. */
  113373. vector2InterpolateFunction(startValue: Vector2, endValue: Vector2, gradient: number): Vector2;
  113374. /**
  113375. * Interpolates a Vector2 cubically
  113376. * @param startValue Start value of the animation curve
  113377. * @param outTangent End tangent of the animation
  113378. * @param endValue End value of the animation curve
  113379. * @param inTangent Start tangent of the animation curve
  113380. * @param gradient Scalar amount to interpolate
  113381. * @returns Interpolated Vector2 value
  113382. */
  113383. vector2InterpolateFunctionWithTangents(startValue: Vector2, outTangent: Vector2, endValue: Vector2, inTangent: Vector2, gradient: number): Vector2;
  113384. /**
  113385. * Interpolates a size linearly
  113386. * @param startValue Start value of the animation curve
  113387. * @param endValue End value of the animation curve
  113388. * @param gradient Scalar amount to interpolate
  113389. * @returns Interpolated Size value
  113390. */
  113391. sizeInterpolateFunction(startValue: Size, endValue: Size, gradient: number): Size;
  113392. /**
  113393. * Interpolates a Color3 linearly
  113394. * @param startValue Start value of the animation curve
  113395. * @param endValue End value of the animation curve
  113396. * @param gradient Scalar amount to interpolate
  113397. * @returns Interpolated Color3 value
  113398. */
  113399. color3InterpolateFunction(startValue: Color3, endValue: Color3, gradient: number): Color3;
  113400. /**
  113401. * Interpolates a Color4 linearly
  113402. * @param startValue Start value of the animation curve
  113403. * @param endValue End value of the animation curve
  113404. * @param gradient Scalar amount to interpolate
  113405. * @returns Interpolated Color3 value
  113406. */
  113407. color4InterpolateFunction(startValue: Color4, endValue: Color4, gradient: number): Color4;
  113408. /**
  113409. * @hidden Internal use only
  113410. */
  113411. _getKeyValue(value: any): any;
  113412. /**
  113413. * @hidden Internal use only
  113414. */
  113415. _interpolate(currentFrame: number, state: _IAnimationState): any;
  113416. /**
  113417. * Defines the function to use to interpolate matrices
  113418. * @param startValue defines the start matrix
  113419. * @param endValue defines the end matrix
  113420. * @param gradient defines the gradient between both matrices
  113421. * @param result defines an optional target matrix where to store the interpolation
  113422. * @returns the interpolated matrix
  113423. */
  113424. matrixInterpolateFunction(startValue: Matrix, endValue: Matrix, gradient: number, result?: Matrix): Matrix;
  113425. /**
  113426. * Makes a copy of the animation
  113427. * @returns Cloned animation
  113428. */
  113429. clone(): Animation;
  113430. /**
  113431. * Sets the key frames of the animation
  113432. * @param values The animation key frames to set
  113433. */
  113434. setKeys(values: Array<IAnimationKey>): void;
  113435. /**
  113436. * Serializes the animation to an object
  113437. * @returns Serialized object
  113438. */
  113439. serialize(): any;
  113440. /**
  113441. * Float animation type
  113442. */
  113443. static readonly ANIMATIONTYPE_FLOAT: number;
  113444. /**
  113445. * Vector3 animation type
  113446. */
  113447. static readonly ANIMATIONTYPE_VECTOR3: number;
  113448. /**
  113449. * Quaternion animation type
  113450. */
  113451. static readonly ANIMATIONTYPE_QUATERNION: number;
  113452. /**
  113453. * Matrix animation type
  113454. */
  113455. static readonly ANIMATIONTYPE_MATRIX: number;
  113456. /**
  113457. * Color3 animation type
  113458. */
  113459. static readonly ANIMATIONTYPE_COLOR3: number;
  113460. /**
  113461. * Color3 animation type
  113462. */
  113463. static readonly ANIMATIONTYPE_COLOR4: number;
  113464. /**
  113465. * Vector2 animation type
  113466. */
  113467. static readonly ANIMATIONTYPE_VECTOR2: number;
  113468. /**
  113469. * Size animation type
  113470. */
  113471. static readonly ANIMATIONTYPE_SIZE: number;
  113472. /**
  113473. * Relative Loop Mode
  113474. */
  113475. static readonly ANIMATIONLOOPMODE_RELATIVE: number;
  113476. /**
  113477. * Cycle Loop Mode
  113478. */
  113479. static readonly ANIMATIONLOOPMODE_CYCLE: number;
  113480. /**
  113481. * Constant Loop Mode
  113482. */
  113483. static readonly ANIMATIONLOOPMODE_CONSTANT: number;
  113484. /** @hidden */
  113485. static _UniversalLerp(left: any, right: any, amount: number): any;
  113486. /**
  113487. * Parses an animation object and creates an animation
  113488. * @param parsedAnimation Parsed animation object
  113489. * @returns Animation object
  113490. */
  113491. static Parse(parsedAnimation: any): Animation;
  113492. /**
  113493. * Appends the serialized animations from the source animations
  113494. * @param source Source containing the animations
  113495. * @param destination Target to store the animations
  113496. */
  113497. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  113498. /**
  113499. * Creates a new animation or an array of animations from a snippet saved in a remote file
  113500. * @param name defines the name of the animation to create (can be null or empty to use the one from the json data)
  113501. * @param url defines the url to load from
  113502. * @returns a promise that will resolve to the new animation or an array of animations
  113503. */
  113504. static ParseFromFileAsync(name: Nullable<string>, url: string): Promise<Animation | Array<Animation>>;
  113505. /**
  113506. * Creates an animation or an array of animations from a snippet saved by the Inspector
  113507. * @param snippetId defines the snippet to load
  113508. * @returns a promise that will resolve to the new animation or a new array of animations
  113509. */
  113510. static CreateFromSnippetAsync(snippetId: string): Promise<Animation | Array<Animation>>;
  113511. }
  113512. }
  113513. declare module BABYLON {
  113514. /**
  113515. * Interface containing an array of animations
  113516. */
  113517. export interface IAnimatable {
  113518. /**
  113519. * Array of animations
  113520. */
  113521. animations: Nullable<Array<Animation>>;
  113522. }
  113523. }
  113524. declare module BABYLON {
  113525. export function expandToProperty(callback: string, targetKey?: Nullable<string>): (target: any, propertyKey: string) => void;
  113526. export function serialize(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113527. export function serializeAsTexture(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113528. export function serializeAsColor3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113529. export function serializeAsFresnelParameters(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113530. export function serializeAsVector2(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113531. export function serializeAsVector3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113532. export function serializeAsMeshReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113533. export function serializeAsColorCurves(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113534. export function serializeAsColor4(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113535. export function serializeAsImageProcessingConfiguration(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113536. export function serializeAsQuaternion(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113537. export function serializeAsMatrix(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113538. /**
  113539. * Decorator used to define property that can be serialized as reference to a camera
  113540. * @param sourceName defines the name of the property to decorate
  113541. */
  113542. export function serializeAsCameraReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113543. /**
  113544. * Class used to help serialization objects
  113545. */
  113546. export class SerializationHelper {
  113547. /** @hidden */
  113548. static _ImageProcessingConfigurationParser: (sourceProperty: any) => ImageProcessingConfiguration;
  113549. /** @hidden */
  113550. static _FresnelParametersParser: (sourceProperty: any) => FresnelParameters;
  113551. /** @hidden */
  113552. static _ColorCurvesParser: (sourceProperty: any) => ColorCurves;
  113553. /** @hidden */
  113554. static _TextureParser: (sourceProperty: any, scene: Scene, rootUrl: string) => Nullable<BaseTexture>;
  113555. /**
  113556. * Appends the serialized animations from the source animations
  113557. * @param source Source containing the animations
  113558. * @param destination Target to store the animations
  113559. */
  113560. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  113561. /**
  113562. * Static function used to serialized a specific entity
  113563. * @param entity defines the entity to serialize
  113564. * @param serializationObject defines the optional target obecjt where serialization data will be stored
  113565. * @returns a JSON compatible object representing the serialization of the entity
  113566. */
  113567. static Serialize<T>(entity: T, serializationObject?: any): any;
  113568. /**
  113569. * Creates a new entity from a serialization data object
  113570. * @param creationFunction defines a function used to instanciated the new entity
  113571. * @param source defines the source serialization data
  113572. * @param scene defines the hosting scene
  113573. * @param rootUrl defines the root url for resources
  113574. * @returns a new entity
  113575. */
  113576. static Parse<T>(creationFunction: () => T, source: any, scene: Nullable<Scene>, rootUrl?: Nullable<string>): T;
  113577. /**
  113578. * Clones an object
  113579. * @param creationFunction defines the function used to instanciate the new object
  113580. * @param source defines the source object
  113581. * @returns the cloned object
  113582. */
  113583. static Clone<T>(creationFunction: () => T, source: T): T;
  113584. /**
  113585. * Instanciates a new object based on a source one (some data will be shared between both object)
  113586. * @param creationFunction defines the function used to instanciate the new object
  113587. * @param source defines the source object
  113588. * @returns the new object
  113589. */
  113590. static Instanciate<T>(creationFunction: () => T, source: T): T;
  113591. }
  113592. }
  113593. declare module BABYLON {
  113594. /**
  113595. * Base class of all the textures in babylon.
  113596. * It groups all the common properties the materials, post process, lights... might need
  113597. * in order to make a correct use of the texture.
  113598. */
  113599. export class BaseTexture implements IAnimatable {
  113600. /**
  113601. * Default anisotropic filtering level for the application.
  113602. * It is set to 4 as a good tradeoff between perf and quality.
  113603. */
  113604. static DEFAULT_ANISOTROPIC_FILTERING_LEVEL: number;
  113605. /**
  113606. * Gets or sets the unique id of the texture
  113607. */
  113608. uniqueId: number;
  113609. /**
  113610. * Define the name of the texture.
  113611. */
  113612. name: string;
  113613. /**
  113614. * Gets or sets an object used to store user defined information.
  113615. */
  113616. metadata: any;
  113617. /**
  113618. * For internal use only. Please do not use.
  113619. */
  113620. reservedDataStore: any;
  113621. private _hasAlpha;
  113622. /**
  113623. * Define if the texture is having a usable alpha value (can be use for transparency or glossiness for instance).
  113624. */
  113625. set hasAlpha(value: boolean);
  113626. get hasAlpha(): boolean;
  113627. /**
  113628. * Defines if the alpha value should be determined via the rgb values.
  113629. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  113630. */
  113631. getAlphaFromRGB: boolean;
  113632. /**
  113633. * Intensity or strength of the texture.
  113634. * It is commonly used by materials to fine tune the intensity of the texture
  113635. */
  113636. level: number;
  113637. /**
  113638. * Define the UV chanel to use starting from 0 and defaulting to 0.
  113639. * This is part of the texture as textures usually maps to one uv set.
  113640. */
  113641. coordinatesIndex: number;
  113642. protected _coordinatesMode: number;
  113643. /**
  113644. * How a texture is mapped.
  113645. *
  113646. * | Value | Type | Description |
  113647. * | ----- | ----------------------------------- | ----------- |
  113648. * | 0 | EXPLICIT_MODE | |
  113649. * | 1 | SPHERICAL_MODE | |
  113650. * | 2 | PLANAR_MODE | |
  113651. * | 3 | CUBIC_MODE | |
  113652. * | 4 | PROJECTION_MODE | |
  113653. * | 5 | SKYBOX_MODE | |
  113654. * | 6 | INVCUBIC_MODE | |
  113655. * | 7 | EQUIRECTANGULAR_MODE | |
  113656. * | 8 | FIXED_EQUIRECTANGULAR_MODE | |
  113657. * | 9 | FIXED_EQUIRECTANGULAR_MIRRORED_MODE | |
  113658. */
  113659. set coordinatesMode(value: number);
  113660. get coordinatesMode(): number;
  113661. private _wrapU;
  113662. /**
  113663. * | Value | Type | Description |
  113664. * | ----- | ------------------ | ----------- |
  113665. * | 0 | CLAMP_ADDRESSMODE | |
  113666. * | 1 | WRAP_ADDRESSMODE | |
  113667. * | 2 | MIRROR_ADDRESSMODE | |
  113668. */
  113669. get wrapU(): number;
  113670. set wrapU(value: number);
  113671. private _wrapV;
  113672. /**
  113673. * | Value | Type | Description |
  113674. * | ----- | ------------------ | ----------- |
  113675. * | 0 | CLAMP_ADDRESSMODE | |
  113676. * | 1 | WRAP_ADDRESSMODE | |
  113677. * | 2 | MIRROR_ADDRESSMODE | |
  113678. */
  113679. get wrapV(): number;
  113680. set wrapV(value: number);
  113681. /**
  113682. * | Value | Type | Description |
  113683. * | ----- | ------------------ | ----------- |
  113684. * | 0 | CLAMP_ADDRESSMODE | |
  113685. * | 1 | WRAP_ADDRESSMODE | |
  113686. * | 2 | MIRROR_ADDRESSMODE | |
  113687. */
  113688. wrapR: number;
  113689. /**
  113690. * With compliant hardware and browser (supporting anisotropic filtering)
  113691. * this defines the level of anisotropic filtering in the texture.
  113692. * The higher the better but the slower. This defaults to 4 as it seems to be the best tradeoff.
  113693. */
  113694. anisotropicFilteringLevel: number;
  113695. /**
  113696. * Define if the texture is a cube texture or if false a 2d texture.
  113697. */
  113698. get isCube(): boolean;
  113699. set isCube(value: boolean);
  113700. /**
  113701. * Define if the texture is a 3d texture (webgl 2) or if false a 2d texture.
  113702. */
  113703. get is3D(): boolean;
  113704. set is3D(value: boolean);
  113705. /**
  113706. * Define if the texture is a 2d array texture (webgl 2) or if false a 2d texture.
  113707. */
  113708. get is2DArray(): boolean;
  113709. set is2DArray(value: boolean);
  113710. private _gammaSpace;
  113711. /**
  113712. * Define if the texture contains data in gamma space (most of the png/jpg aside bump).
  113713. * HDR texture are usually stored in linear space.
  113714. * This only impacts the PBR and Background materials
  113715. */
  113716. get gammaSpace(): boolean;
  113717. set gammaSpace(gamma: boolean);
  113718. /**
  113719. * Gets or sets whether or not the texture contains RGBD data.
  113720. */
  113721. get isRGBD(): boolean;
  113722. set isRGBD(value: boolean);
  113723. /**
  113724. * Is Z inverted in the texture (useful in a cube texture).
  113725. */
  113726. invertZ: boolean;
  113727. /**
  113728. * Are mip maps generated for this texture or not.
  113729. */
  113730. get noMipmap(): boolean;
  113731. /**
  113732. * @hidden
  113733. */
  113734. lodLevelInAlpha: boolean;
  113735. /**
  113736. * With prefiltered texture, defined the offset used during the prefiltering steps.
  113737. */
  113738. get lodGenerationOffset(): number;
  113739. set lodGenerationOffset(value: number);
  113740. /**
  113741. * With prefiltered texture, defined the scale used during the prefiltering steps.
  113742. */
  113743. get lodGenerationScale(): number;
  113744. set lodGenerationScale(value: number);
  113745. /**
  113746. * With prefiltered texture, defined if the specular generation is based on a linear ramp.
  113747. * By default we are using a log2 of the linear roughness helping to keep a better resolution for
  113748. * average roughness values.
  113749. */
  113750. get linearSpecularLOD(): boolean;
  113751. set linearSpecularLOD(value: boolean);
  113752. /**
  113753. * In case a better definition than spherical harmonics is required for the diffuse part of the environment.
  113754. * You can set the irradiance texture to rely on a texture instead of the spherical approach.
  113755. * This texture need to have the same characteristics than its parent (Cube vs 2d, coordinates mode, Gamma/Linear, RGBD).
  113756. */
  113757. get irradianceTexture(): Nullable<BaseTexture>;
  113758. set irradianceTexture(value: Nullable<BaseTexture>);
  113759. /**
  113760. * Define if the texture is a render target.
  113761. */
  113762. isRenderTarget: boolean;
  113763. /**
  113764. * Define the unique id of the texture in the scene.
  113765. */
  113766. get uid(): string;
  113767. /** @hidden */
  113768. _prefiltered: boolean;
  113769. /**
  113770. * Return a string representation of the texture.
  113771. * @returns the texture as a string
  113772. */
  113773. toString(): string;
  113774. /**
  113775. * Get the class name of the texture.
  113776. * @returns "BaseTexture"
  113777. */
  113778. getClassName(): string;
  113779. /**
  113780. * Define the list of animation attached to the texture.
  113781. */
  113782. animations: Animation[];
  113783. /**
  113784. * An event triggered when the texture is disposed.
  113785. */
  113786. onDisposeObservable: Observable<BaseTexture>;
  113787. private _onDisposeObserver;
  113788. /**
  113789. * Callback triggered when the texture has been disposed.
  113790. * Kept for back compatibility, you can use the onDisposeObservable instead.
  113791. */
  113792. set onDispose(callback: () => void);
  113793. /**
  113794. * Define the current state of the loading sequence when in delayed load mode.
  113795. */
  113796. delayLoadState: number;
  113797. protected _scene: Nullable<Scene>;
  113798. protected _engine: Nullable<ThinEngine>;
  113799. /** @hidden */
  113800. _texture: Nullable<InternalTexture>;
  113801. private _uid;
  113802. /**
  113803. * Define if the texture is preventinga material to render or not.
  113804. * If not and the texture is not ready, the engine will use a default black texture instead.
  113805. */
  113806. get isBlocking(): boolean;
  113807. /**
  113808. * Instantiates a new BaseTexture.
  113809. * Base class of all the textures in babylon.
  113810. * It groups all the common properties the materials, post process, lights... might need
  113811. * in order to make a correct use of the texture.
  113812. * @param sceneOrEngine Define the scene or engine the texture blongs to
  113813. */
  113814. constructor(sceneOrEngine: Nullable<Scene | ThinEngine>);
  113815. /**
  113816. * Get the scene the texture belongs to.
  113817. * @returns the scene or null if undefined
  113818. */
  113819. getScene(): Nullable<Scene>;
  113820. /** @hidden */
  113821. protected _getEngine(): Nullable<ThinEngine>;
  113822. /**
  113823. * Get the texture transform matrix used to offset tile the texture for istance.
  113824. * @returns the transformation matrix
  113825. */
  113826. getTextureMatrix(): Matrix;
  113827. /**
  113828. * Get the texture reflection matrix used to rotate/transform the reflection.
  113829. * @returns the reflection matrix
  113830. */
  113831. getReflectionTextureMatrix(): Matrix;
  113832. /**
  113833. * Get the underlying lower level texture from Babylon.
  113834. * @returns the insternal texture
  113835. */
  113836. getInternalTexture(): Nullable<InternalTexture>;
  113837. /**
  113838. * Get if the texture is ready to be consumed (either it is ready or it is not blocking)
  113839. * @returns true if ready or not blocking
  113840. */
  113841. isReadyOrNotBlocking(): boolean;
  113842. /**
  113843. * Get if the texture is ready to be used (downloaded, converted, mip mapped...).
  113844. * @returns true if fully ready
  113845. */
  113846. isReady(): boolean;
  113847. private _cachedSize;
  113848. /**
  113849. * Get the size of the texture.
  113850. * @returns the texture size.
  113851. */
  113852. getSize(): ISize;
  113853. /**
  113854. * Get the base size of the texture.
  113855. * It can be different from the size if the texture has been resized for POT for instance
  113856. * @returns the base size
  113857. */
  113858. getBaseSize(): ISize;
  113859. /**
  113860. * Update the sampling mode of the texture.
  113861. * Default is Trilinear mode.
  113862. *
  113863. * | Value | Type | Description |
  113864. * | ----- | ------------------ | ----------- |
  113865. * | 1 | NEAREST_SAMPLINGMODE or NEAREST_NEAREST_MIPLINEAR | Nearest is: mag = nearest, min = nearest, mip = linear |
  113866. * | 2 | BILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPNEAREST | Bilinear is: mag = linear, min = linear, mip = nearest |
  113867. * | 3 | TRILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPLINEAR | Trilinear is: mag = linear, min = linear, mip = linear |
  113868. * | 4 | NEAREST_NEAREST_MIPNEAREST | |
  113869. * | 5 | NEAREST_LINEAR_MIPNEAREST | |
  113870. * | 6 | NEAREST_LINEAR_MIPLINEAR | |
  113871. * | 7 | NEAREST_LINEAR | |
  113872. * | 8 | NEAREST_NEAREST | |
  113873. * | 9 | LINEAR_NEAREST_MIPNEAREST | |
  113874. * | 10 | LINEAR_NEAREST_MIPLINEAR | |
  113875. * | 11 | LINEAR_LINEAR | |
  113876. * | 12 | LINEAR_NEAREST | |
  113877. *
  113878. * > _mag_: magnification filter (close to the viewer)
  113879. * > _min_: minification filter (far from the viewer)
  113880. * > _mip_: filter used between mip map levels
  113881. *@param samplingMode Define the new sampling mode of the texture
  113882. */
  113883. updateSamplingMode(samplingMode: number): void;
  113884. /**
  113885. * Scales the texture if is `canRescale()`
  113886. * @param ratio the resize factor we want to use to rescale
  113887. */
  113888. scale(ratio: number): void;
  113889. /**
  113890. * Get if the texture can rescale.
  113891. */
  113892. get canRescale(): boolean;
  113893. /** @hidden */
  113894. _getFromCache(url: Nullable<string>, noMipmap: boolean, sampling?: number, invertY?: boolean): Nullable<InternalTexture>;
  113895. /** @hidden */
  113896. _rebuild(): void;
  113897. /**
  113898. * Triggers the load sequence in delayed load mode.
  113899. */
  113900. delayLoad(): void;
  113901. /**
  113902. * Clones the texture.
  113903. * @returns the cloned texture
  113904. */
  113905. clone(): Nullable<BaseTexture>;
  113906. /**
  113907. * Get the texture underlying type (INT, FLOAT...)
  113908. */
  113909. get textureType(): number;
  113910. /**
  113911. * Get the texture underlying format (RGB, RGBA...)
  113912. */
  113913. get textureFormat(): number;
  113914. /**
  113915. * Indicates that textures need to be re-calculated for all materials
  113916. */
  113917. protected _markAllSubMeshesAsTexturesDirty(): void;
  113918. /**
  113919. * Reads the pixels stored in the webgl texture and returns them as an ArrayBuffer.
  113920. * This will returns an RGBA array buffer containing either in values (0-255) or
  113921. * float values (0-1) depending of the underlying buffer type.
  113922. * @param faceIndex defines the face of the texture to read (in case of cube texture)
  113923. * @param level defines the LOD level of the texture to read (in case of Mip Maps)
  113924. * @param buffer defines a user defined buffer to fill with data (can be null)
  113925. * @returns The Array buffer containing the pixels data.
  113926. */
  113927. readPixels(faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): Nullable<ArrayBufferView>;
  113928. /**
  113929. * Release and destroy the underlying lower level texture aka internalTexture.
  113930. */
  113931. releaseInternalTexture(): void;
  113932. /** @hidden */
  113933. get _lodTextureHigh(): Nullable<BaseTexture>;
  113934. /** @hidden */
  113935. get _lodTextureMid(): Nullable<BaseTexture>;
  113936. /** @hidden */
  113937. get _lodTextureLow(): Nullable<BaseTexture>;
  113938. /**
  113939. * Dispose the texture and release its associated resources.
  113940. */
  113941. dispose(): void;
  113942. /**
  113943. * Serialize the texture into a JSON representation that can be parsed later on.
  113944. * @returns the JSON representation of the texture
  113945. */
  113946. serialize(): any;
  113947. /**
  113948. * Helper function to be called back once a list of texture contains only ready textures.
  113949. * @param textures Define the list of textures to wait for
  113950. * @param callback Define the callback triggered once the entire list will be ready
  113951. */
  113952. static WhenAllReady(textures: BaseTexture[], callback: () => void): void;
  113953. private static _isScene;
  113954. }
  113955. }
  113956. declare module BABYLON {
  113957. /**
  113958. * Options to be used when creating an effect.
  113959. */
  113960. export interface IEffectCreationOptions {
  113961. /**
  113962. * Atrributes that will be used in the shader.
  113963. */
  113964. attributes: string[];
  113965. /**
  113966. * Uniform varible names that will be set in the shader.
  113967. */
  113968. uniformsNames: string[];
  113969. /**
  113970. * Uniform buffer variable names that will be set in the shader.
  113971. */
  113972. uniformBuffersNames: string[];
  113973. /**
  113974. * Sampler texture variable names that will be set in the shader.
  113975. */
  113976. samplers: string[];
  113977. /**
  113978. * Define statements that will be set in the shader.
  113979. */
  113980. defines: any;
  113981. /**
  113982. * Possible fallbacks for this effect to improve performance when needed.
  113983. */
  113984. fallbacks: Nullable<IEffectFallbacks>;
  113985. /**
  113986. * Callback that will be called when the shader is compiled.
  113987. */
  113988. onCompiled: Nullable<(effect: Effect) => void>;
  113989. /**
  113990. * Callback that will be called if an error occurs during shader compilation.
  113991. */
  113992. onError: Nullable<(effect: Effect, errors: string) => void>;
  113993. /**
  113994. * Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  113995. */
  113996. indexParameters?: any;
  113997. /**
  113998. * Max number of lights that can be used in the shader.
  113999. */
  114000. maxSimultaneousLights?: number;
  114001. /**
  114002. * See https://developer.mozilla.org/en-US/docs/Web/API/WebGL2RenderingContext/transformFeedbackVaryings
  114003. */
  114004. transformFeedbackVaryings?: Nullable<string[]>;
  114005. /**
  114006. * 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
  114007. */
  114008. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  114009. /**
  114010. * Is this effect rendering to several color attachments ?
  114011. */
  114012. multiTarget?: boolean;
  114013. }
  114014. /**
  114015. * Effect containing vertex and fragment shader that can be executed on an object.
  114016. */
  114017. export class Effect implements IDisposable {
  114018. /**
  114019. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  114020. */
  114021. static ShadersRepository: string;
  114022. /**
  114023. * Enable logging of the shader code when a compilation error occurs
  114024. */
  114025. static LogShaderCodeOnCompilationError: boolean;
  114026. /**
  114027. * Name of the effect.
  114028. */
  114029. name: any;
  114030. /**
  114031. * String container all the define statements that should be set on the shader.
  114032. */
  114033. defines: string;
  114034. /**
  114035. * Callback that will be called when the shader is compiled.
  114036. */
  114037. onCompiled: Nullable<(effect: Effect) => void>;
  114038. /**
  114039. * Callback that will be called if an error occurs during shader compilation.
  114040. */
  114041. onError: Nullable<(effect: Effect, errors: string) => void>;
  114042. /**
  114043. * Callback that will be called when effect is bound.
  114044. */
  114045. onBind: Nullable<(effect: Effect) => void>;
  114046. /**
  114047. * Unique ID of the effect.
  114048. */
  114049. uniqueId: number;
  114050. /**
  114051. * Observable that will be called when the shader is compiled.
  114052. * It is recommended to use executeWhenCompile() or to make sure that scene.isReady() is called to get this observable raised.
  114053. */
  114054. onCompileObservable: Observable<Effect>;
  114055. /**
  114056. * Observable that will be called if an error occurs during shader compilation.
  114057. */
  114058. onErrorObservable: Observable<Effect>;
  114059. /** @hidden */
  114060. _onBindObservable: Nullable<Observable<Effect>>;
  114061. /**
  114062. * @hidden
  114063. * Specifies if the effect was previously ready
  114064. */
  114065. _wasPreviouslyReady: boolean;
  114066. /**
  114067. * Observable that will be called when effect is bound.
  114068. */
  114069. get onBindObservable(): Observable<Effect>;
  114070. /** @hidden */
  114071. _bonesComputationForcedToCPU: boolean;
  114072. /** @hidden */
  114073. _multiTarget: boolean;
  114074. private static _uniqueIdSeed;
  114075. private _engine;
  114076. private _uniformBuffersNames;
  114077. private _uniformBuffersNamesList;
  114078. private _uniformsNames;
  114079. private _samplerList;
  114080. private _samplers;
  114081. private _isReady;
  114082. private _compilationError;
  114083. private _allFallbacksProcessed;
  114084. private _attributesNames;
  114085. private _attributes;
  114086. private _attributeLocationByName;
  114087. private _uniforms;
  114088. /**
  114089. * Key for the effect.
  114090. * @hidden
  114091. */
  114092. _key: string;
  114093. private _indexParameters;
  114094. private _fallbacks;
  114095. private _vertexSourceCode;
  114096. private _fragmentSourceCode;
  114097. private _vertexSourceCodeOverride;
  114098. private _fragmentSourceCodeOverride;
  114099. private _transformFeedbackVaryings;
  114100. /**
  114101. * Compiled shader to webGL program.
  114102. * @hidden
  114103. */
  114104. _pipelineContext: Nullable<IPipelineContext>;
  114105. private _valueCache;
  114106. private static _baseCache;
  114107. /**
  114108. * Instantiates an effect.
  114109. * An effect can be used to create/manage/execute vertex and fragment shaders.
  114110. * @param baseName Name of the effect.
  114111. * @param attributesNamesOrOptions List of attribute names that will be passed to the shader or set of all options to create the effect.
  114112. * @param uniformsNamesOrEngine List of uniform variable names that will be passed to the shader or the engine that will be used to render effect.
  114113. * @param samplers List of sampler variables that will be passed to the shader.
  114114. * @param engine Engine to be used to render the effect
  114115. * @param defines Define statements to be added to the shader.
  114116. * @param fallbacks Possible fallbacks for this effect to improve performance when needed.
  114117. * @param onCompiled Callback that will be called when the shader is compiled.
  114118. * @param onError Callback that will be called if an error occurs during shader compilation.
  114119. * @param indexParameters Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  114120. */
  114121. 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);
  114122. private _useFinalCode;
  114123. /**
  114124. * Unique key for this effect
  114125. */
  114126. get key(): string;
  114127. /**
  114128. * If the effect has been compiled and prepared.
  114129. * @returns if the effect is compiled and prepared.
  114130. */
  114131. isReady(): boolean;
  114132. private _isReadyInternal;
  114133. /**
  114134. * The engine the effect was initialized with.
  114135. * @returns the engine.
  114136. */
  114137. getEngine(): Engine;
  114138. /**
  114139. * The pipeline context for this effect
  114140. * @returns the associated pipeline context
  114141. */
  114142. getPipelineContext(): Nullable<IPipelineContext>;
  114143. /**
  114144. * The set of names of attribute variables for the shader.
  114145. * @returns An array of attribute names.
  114146. */
  114147. getAttributesNames(): string[];
  114148. /**
  114149. * Returns the attribute at the given index.
  114150. * @param index The index of the attribute.
  114151. * @returns The location of the attribute.
  114152. */
  114153. getAttributeLocation(index: number): number;
  114154. /**
  114155. * Returns the attribute based on the name of the variable.
  114156. * @param name of the attribute to look up.
  114157. * @returns the attribute location.
  114158. */
  114159. getAttributeLocationByName(name: string): number;
  114160. /**
  114161. * The number of attributes.
  114162. * @returns the numnber of attributes.
  114163. */
  114164. getAttributesCount(): number;
  114165. /**
  114166. * Gets the index of a uniform variable.
  114167. * @param uniformName of the uniform to look up.
  114168. * @returns the index.
  114169. */
  114170. getUniformIndex(uniformName: string): number;
  114171. /**
  114172. * Returns the attribute based on the name of the variable.
  114173. * @param uniformName of the uniform to look up.
  114174. * @returns the location of the uniform.
  114175. */
  114176. getUniform(uniformName: string): Nullable<WebGLUniformLocation>;
  114177. /**
  114178. * Returns an array of sampler variable names
  114179. * @returns The array of sampler variable names.
  114180. */
  114181. getSamplers(): string[];
  114182. /**
  114183. * Returns an array of uniform variable names
  114184. * @returns The array of uniform variable names.
  114185. */
  114186. getUniformNames(): string[];
  114187. /**
  114188. * Returns an array of uniform buffer variable names
  114189. * @returns The array of uniform buffer variable names.
  114190. */
  114191. getUniformBuffersNames(): string[];
  114192. /**
  114193. * Returns the index parameters used to create the effect
  114194. * @returns The index parameters object
  114195. */
  114196. getIndexParameters(): any;
  114197. /**
  114198. * The error from the last compilation.
  114199. * @returns the error string.
  114200. */
  114201. getCompilationError(): string;
  114202. /**
  114203. * Gets a boolean indicating that all fallbacks were used during compilation
  114204. * @returns true if all fallbacks were used
  114205. */
  114206. allFallbacksProcessed(): boolean;
  114207. /**
  114208. * Adds a callback to the onCompiled observable and call the callback imediatly if already ready.
  114209. * @param func The callback to be used.
  114210. */
  114211. executeWhenCompiled(func: (effect: Effect) => void): void;
  114212. private _checkIsReady;
  114213. private _loadShader;
  114214. /**
  114215. * Gets the vertex shader source code of this effect
  114216. */
  114217. get vertexSourceCode(): string;
  114218. /**
  114219. * Gets the fragment shader source code of this effect
  114220. */
  114221. get fragmentSourceCode(): string;
  114222. /**
  114223. * Recompiles the webGL program
  114224. * @param vertexSourceCode The source code for the vertex shader.
  114225. * @param fragmentSourceCode The source code for the fragment shader.
  114226. * @param onCompiled Callback called when completed.
  114227. * @param onError Callback called on error.
  114228. * @hidden
  114229. */
  114230. _rebuildProgram(vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (pipelineContext: IPipelineContext) => void, onError: (message: string) => void): void;
  114231. /**
  114232. * Prepares the effect
  114233. * @hidden
  114234. */
  114235. _prepareEffect(): void;
  114236. private _getShaderCodeAndErrorLine;
  114237. private _processCompilationErrors;
  114238. /**
  114239. * Checks if the effect is supported. (Must be called after compilation)
  114240. */
  114241. get isSupported(): boolean;
  114242. /**
  114243. * Binds a texture to the engine to be used as output of the shader.
  114244. * @param channel Name of the output variable.
  114245. * @param texture Texture to bind.
  114246. * @hidden
  114247. */
  114248. _bindTexture(channel: string, texture: Nullable<InternalTexture>): void;
  114249. /**
  114250. * Sets a texture on the engine to be used in the shader.
  114251. * @param channel Name of the sampler variable.
  114252. * @param texture Texture to set.
  114253. */
  114254. setTexture(channel: string, texture: Nullable<BaseTexture>): void;
  114255. /**
  114256. * Sets a depth stencil texture from a render target on the engine to be used in the shader.
  114257. * @param channel Name of the sampler variable.
  114258. * @param texture Texture to set.
  114259. */
  114260. setDepthStencilTexture(channel: string, texture: Nullable<RenderTargetTexture>): void;
  114261. /**
  114262. * Sets an array of textures on the engine to be used in the shader.
  114263. * @param channel Name of the variable.
  114264. * @param textures Textures to set.
  114265. */
  114266. setTextureArray(channel: string, textures: BaseTexture[]): void;
  114267. /**
  114268. * 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)
  114269. * @param channel Name of the sampler variable.
  114270. * @param postProcess Post process to get the input texture from.
  114271. */
  114272. setTextureFromPostProcess(channel: string, postProcess: Nullable<PostProcess>): void;
  114273. /**
  114274. * (Warning! setTextureFromPostProcessOutput may be desired instead)
  114275. * 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)
  114276. * @param channel Name of the sampler variable.
  114277. * @param postProcess Post process to get the output texture from.
  114278. */
  114279. setTextureFromPostProcessOutput(channel: string, postProcess: Nullable<PostProcess>): void;
  114280. /** @hidden */
  114281. _cacheMatrix(uniformName: string, matrix: IMatrixLike): boolean;
  114282. /** @hidden */
  114283. _cacheFloat2(uniformName: string, x: number, y: number): boolean;
  114284. /** @hidden */
  114285. _cacheFloat3(uniformName: string, x: number, y: number, z: number): boolean;
  114286. /** @hidden */
  114287. _cacheFloat4(uniformName: string, x: number, y: number, z: number, w: number): boolean;
  114288. /**
  114289. * Binds a buffer to a uniform.
  114290. * @param buffer Buffer to bind.
  114291. * @param name Name of the uniform variable to bind to.
  114292. */
  114293. bindUniformBuffer(buffer: DataBuffer, name: string): void;
  114294. /**
  114295. * Binds block to a uniform.
  114296. * @param blockName Name of the block to bind.
  114297. * @param index Index to bind.
  114298. */
  114299. bindUniformBlock(blockName: string, index: number): void;
  114300. /**
  114301. * Sets an interger value on a uniform variable.
  114302. * @param uniformName Name of the variable.
  114303. * @param value Value to be set.
  114304. * @returns this effect.
  114305. */
  114306. setInt(uniformName: string, value: number): Effect;
  114307. /**
  114308. * Sets an int array on a uniform variable.
  114309. * @param uniformName Name of the variable.
  114310. * @param array array to be set.
  114311. * @returns this effect.
  114312. */
  114313. setIntArray(uniformName: string, array: Int32Array): Effect;
  114314. /**
  114315. * 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)
  114316. * @param uniformName Name of the variable.
  114317. * @param array array to be set.
  114318. * @returns this effect.
  114319. */
  114320. setIntArray2(uniformName: string, array: Int32Array): Effect;
  114321. /**
  114322. * 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)
  114323. * @param uniformName Name of the variable.
  114324. * @param array array to be set.
  114325. * @returns this effect.
  114326. */
  114327. setIntArray3(uniformName: string, array: Int32Array): Effect;
  114328. /**
  114329. * 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)
  114330. * @param uniformName Name of the variable.
  114331. * @param array array to be set.
  114332. * @returns this effect.
  114333. */
  114334. setIntArray4(uniformName: string, array: Int32Array): Effect;
  114335. /**
  114336. * Sets an float array on a uniform variable.
  114337. * @param uniformName Name of the variable.
  114338. * @param array array to be set.
  114339. * @returns this effect.
  114340. */
  114341. setFloatArray(uniformName: string, array: Float32Array): Effect;
  114342. /**
  114343. * 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)
  114344. * @param uniformName Name of the variable.
  114345. * @param array array to be set.
  114346. * @returns this effect.
  114347. */
  114348. setFloatArray2(uniformName: string, array: Float32Array): Effect;
  114349. /**
  114350. * 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)
  114351. * @param uniformName Name of the variable.
  114352. * @param array array to be set.
  114353. * @returns this effect.
  114354. */
  114355. setFloatArray3(uniformName: string, array: Float32Array): Effect;
  114356. /**
  114357. * 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)
  114358. * @param uniformName Name of the variable.
  114359. * @param array array to be set.
  114360. * @returns this effect.
  114361. */
  114362. setFloatArray4(uniformName: string, array: Float32Array): Effect;
  114363. /**
  114364. * Sets an array on a uniform variable.
  114365. * @param uniformName Name of the variable.
  114366. * @param array array to be set.
  114367. * @returns this effect.
  114368. */
  114369. setArray(uniformName: string, array: number[]): Effect;
  114370. /**
  114371. * 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)
  114372. * @param uniformName Name of the variable.
  114373. * @param array array to be set.
  114374. * @returns this effect.
  114375. */
  114376. setArray2(uniformName: string, array: number[]): Effect;
  114377. /**
  114378. * 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)
  114379. * @param uniformName Name of the variable.
  114380. * @param array array to be set.
  114381. * @returns this effect.
  114382. */
  114383. setArray3(uniformName: string, array: number[]): Effect;
  114384. /**
  114385. * 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)
  114386. * @param uniformName Name of the variable.
  114387. * @param array array to be set.
  114388. * @returns this effect.
  114389. */
  114390. setArray4(uniformName: string, array: number[]): Effect;
  114391. /**
  114392. * Sets matrices on a uniform variable.
  114393. * @param uniformName Name of the variable.
  114394. * @param matrices matrices to be set.
  114395. * @returns this effect.
  114396. */
  114397. setMatrices(uniformName: string, matrices: Float32Array | Array<number>): Effect;
  114398. /**
  114399. * Sets matrix on a uniform variable.
  114400. * @param uniformName Name of the variable.
  114401. * @param matrix matrix to be set.
  114402. * @returns this effect.
  114403. */
  114404. setMatrix(uniformName: string, matrix: IMatrixLike): Effect;
  114405. /**
  114406. * 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)
  114407. * @param uniformName Name of the variable.
  114408. * @param matrix matrix to be set.
  114409. * @returns this effect.
  114410. */
  114411. setMatrix3x3(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  114412. /**
  114413. * Sets a 2x2 matrix on a uniform variable. (Speicified as [1,2,3,4] will result in [1,2][3,4] matrix)
  114414. * @param uniformName Name of the variable.
  114415. * @param matrix matrix to be set.
  114416. * @returns this effect.
  114417. */
  114418. setMatrix2x2(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  114419. /**
  114420. * Sets a float on a uniform variable.
  114421. * @param uniformName Name of the variable.
  114422. * @param value value to be set.
  114423. * @returns this effect.
  114424. */
  114425. setFloat(uniformName: string, value: number): Effect;
  114426. /**
  114427. * Sets a boolean on a uniform variable.
  114428. * @param uniformName Name of the variable.
  114429. * @param bool value to be set.
  114430. * @returns this effect.
  114431. */
  114432. setBool(uniformName: string, bool: boolean): Effect;
  114433. /**
  114434. * Sets a Vector2 on a uniform variable.
  114435. * @param uniformName Name of the variable.
  114436. * @param vector2 vector2 to be set.
  114437. * @returns this effect.
  114438. */
  114439. setVector2(uniformName: string, vector2: IVector2Like): Effect;
  114440. /**
  114441. * Sets a float2 on a uniform variable.
  114442. * @param uniformName Name of the variable.
  114443. * @param x First float in float2.
  114444. * @param y Second float in float2.
  114445. * @returns this effect.
  114446. */
  114447. setFloat2(uniformName: string, x: number, y: number): Effect;
  114448. /**
  114449. * Sets a Vector3 on a uniform variable.
  114450. * @param uniformName Name of the variable.
  114451. * @param vector3 Value to be set.
  114452. * @returns this effect.
  114453. */
  114454. setVector3(uniformName: string, vector3: IVector3Like): Effect;
  114455. /**
  114456. * Sets a float3 on a uniform variable.
  114457. * @param uniformName Name of the variable.
  114458. * @param x First float in float3.
  114459. * @param y Second float in float3.
  114460. * @param z Third float in float3.
  114461. * @returns this effect.
  114462. */
  114463. setFloat3(uniformName: string, x: number, y: number, z: number): Effect;
  114464. /**
  114465. * Sets a Vector4 on a uniform variable.
  114466. * @param uniformName Name of the variable.
  114467. * @param vector4 Value to be set.
  114468. * @returns this effect.
  114469. */
  114470. setVector4(uniformName: string, vector4: IVector4Like): Effect;
  114471. /**
  114472. * Sets a float4 on a uniform variable.
  114473. * @param uniformName Name of the variable.
  114474. * @param x First float in float4.
  114475. * @param y Second float in float4.
  114476. * @param z Third float in float4.
  114477. * @param w Fourth float in float4.
  114478. * @returns this effect.
  114479. */
  114480. setFloat4(uniformName: string, x: number, y: number, z: number, w: number): Effect;
  114481. /**
  114482. * Sets a Color3 on a uniform variable.
  114483. * @param uniformName Name of the variable.
  114484. * @param color3 Value to be set.
  114485. * @returns this effect.
  114486. */
  114487. setColor3(uniformName: string, color3: IColor3Like): Effect;
  114488. /**
  114489. * Sets a Color4 on a uniform variable.
  114490. * @param uniformName Name of the variable.
  114491. * @param color3 Value to be set.
  114492. * @param alpha Alpha value to be set.
  114493. * @returns this effect.
  114494. */
  114495. setColor4(uniformName: string, color3: IColor3Like, alpha: number): Effect;
  114496. /**
  114497. * Sets a Color4 on a uniform variable
  114498. * @param uniformName defines the name of the variable
  114499. * @param color4 defines the value to be set
  114500. * @returns this effect.
  114501. */
  114502. setDirectColor4(uniformName: string, color4: IColor4Like): Effect;
  114503. /** Release all associated resources */
  114504. dispose(): void;
  114505. /**
  114506. * This function will add a new shader to the shader store
  114507. * @param name the name of the shader
  114508. * @param pixelShader optional pixel shader content
  114509. * @param vertexShader optional vertex shader content
  114510. */
  114511. static RegisterShader(name: string, pixelShader?: string, vertexShader?: string): void;
  114512. /**
  114513. * Store of each shader (The can be looked up using effect.key)
  114514. */
  114515. static ShadersStore: {
  114516. [key: string]: string;
  114517. };
  114518. /**
  114519. * Store of each included file for a shader (The can be looked up using effect.key)
  114520. */
  114521. static IncludesShadersStore: {
  114522. [key: string]: string;
  114523. };
  114524. /**
  114525. * Resets the cache of effects.
  114526. */
  114527. static ResetCache(): void;
  114528. }
  114529. }
  114530. declare module BABYLON {
  114531. /**
  114532. * Interface used to describe the capabilities of the engine relatively to the current browser
  114533. */
  114534. export interface EngineCapabilities {
  114535. /** Maximum textures units per fragment shader */
  114536. maxTexturesImageUnits: number;
  114537. /** Maximum texture units per vertex shader */
  114538. maxVertexTextureImageUnits: number;
  114539. /** Maximum textures units in the entire pipeline */
  114540. maxCombinedTexturesImageUnits: number;
  114541. /** Maximum texture size */
  114542. maxTextureSize: number;
  114543. /** Maximum texture samples */
  114544. maxSamples?: number;
  114545. /** Maximum cube texture size */
  114546. maxCubemapTextureSize: number;
  114547. /** Maximum render texture size */
  114548. maxRenderTextureSize: number;
  114549. /** Maximum number of vertex attributes */
  114550. maxVertexAttribs: number;
  114551. /** Maximum number of varyings */
  114552. maxVaryingVectors: number;
  114553. /** Maximum number of uniforms per vertex shader */
  114554. maxVertexUniformVectors: number;
  114555. /** Maximum number of uniforms per fragment shader */
  114556. maxFragmentUniformVectors: number;
  114557. /** Defines if standard derivates (dx/dy) are supported */
  114558. standardDerivatives: boolean;
  114559. /** Defines if s3tc texture compression is supported */
  114560. s3tc?: WEBGL_compressed_texture_s3tc;
  114561. /** Defines if pvrtc texture compression is supported */
  114562. pvrtc: any;
  114563. /** Defines if etc1 texture compression is supported */
  114564. etc1: any;
  114565. /** Defines if etc2 texture compression is supported */
  114566. etc2: any;
  114567. /** Defines if astc texture compression is supported */
  114568. astc: any;
  114569. /** Defines if bptc texture compression is supported */
  114570. bptc: any;
  114571. /** Defines if float textures are supported */
  114572. textureFloat: boolean;
  114573. /** Defines if vertex array objects are supported */
  114574. vertexArrayObject: boolean;
  114575. /** Gets the webgl extension for anisotropic filtering (null if not supported) */
  114576. textureAnisotropicFilterExtension?: EXT_texture_filter_anisotropic;
  114577. /** Gets the maximum level of anisotropy supported */
  114578. maxAnisotropy: number;
  114579. /** Defines if instancing is supported */
  114580. instancedArrays: boolean;
  114581. /** Defines if 32 bits indices are supported */
  114582. uintIndices: boolean;
  114583. /** Defines if high precision shaders are supported */
  114584. highPrecisionShaderSupported: boolean;
  114585. /** Defines if depth reading in the fragment shader is supported */
  114586. fragmentDepthSupported: boolean;
  114587. /** Defines if float texture linear filtering is supported*/
  114588. textureFloatLinearFiltering: boolean;
  114589. /** Defines if rendering to float textures is supported */
  114590. textureFloatRender: boolean;
  114591. /** Defines if half float textures are supported*/
  114592. textureHalfFloat: boolean;
  114593. /** Defines if half float texture linear filtering is supported*/
  114594. textureHalfFloatLinearFiltering: boolean;
  114595. /** Defines if rendering to half float textures is supported */
  114596. textureHalfFloatRender: boolean;
  114597. /** Defines if textureLOD shader command is supported */
  114598. textureLOD: boolean;
  114599. /** Defines if draw buffers extension is supported */
  114600. drawBuffersExtension: boolean;
  114601. /** Defines if depth textures are supported */
  114602. depthTextureExtension: boolean;
  114603. /** Defines if float color buffer are supported */
  114604. colorBufferFloat: boolean;
  114605. /** Gets disjoint timer query extension (null if not supported) */
  114606. timerQuery?: EXT_disjoint_timer_query;
  114607. /** Defines if timestamp can be used with timer query */
  114608. canUseTimestampForTimerQuery: boolean;
  114609. /** Defines if multiview is supported (https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/) */
  114610. multiview?: any;
  114611. /** Defines if oculus multiview is supported (https://developer.oculus.com/documentation/oculus-browser/latest/concepts/browser-multiview/) */
  114612. oculusMultiview?: any;
  114613. /** Function used to let the system compiles shaders in background */
  114614. parallelShaderCompile?: {
  114615. COMPLETION_STATUS_KHR: number;
  114616. };
  114617. /** Max number of texture samples for MSAA */
  114618. maxMSAASamples: number;
  114619. /** Defines if the blend min max extension is supported */
  114620. blendMinMax: boolean;
  114621. }
  114622. }
  114623. declare module BABYLON {
  114624. /**
  114625. * @hidden
  114626. **/
  114627. export class DepthCullingState {
  114628. private _isDepthTestDirty;
  114629. private _isDepthMaskDirty;
  114630. private _isDepthFuncDirty;
  114631. private _isCullFaceDirty;
  114632. private _isCullDirty;
  114633. private _isZOffsetDirty;
  114634. private _isFrontFaceDirty;
  114635. private _depthTest;
  114636. private _depthMask;
  114637. private _depthFunc;
  114638. private _cull;
  114639. private _cullFace;
  114640. private _zOffset;
  114641. private _frontFace;
  114642. /**
  114643. * Initializes the state.
  114644. */
  114645. constructor();
  114646. get isDirty(): boolean;
  114647. get zOffset(): number;
  114648. set zOffset(value: number);
  114649. get cullFace(): Nullable<number>;
  114650. set cullFace(value: Nullable<number>);
  114651. get cull(): Nullable<boolean>;
  114652. set cull(value: Nullable<boolean>);
  114653. get depthFunc(): Nullable<number>;
  114654. set depthFunc(value: Nullable<number>);
  114655. get depthMask(): boolean;
  114656. set depthMask(value: boolean);
  114657. get depthTest(): boolean;
  114658. set depthTest(value: boolean);
  114659. get frontFace(): Nullable<number>;
  114660. set frontFace(value: Nullable<number>);
  114661. reset(): void;
  114662. apply(gl: WebGLRenderingContext): void;
  114663. }
  114664. }
  114665. declare module BABYLON {
  114666. /**
  114667. * @hidden
  114668. **/
  114669. export class StencilState {
  114670. /** 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 */
  114671. static readonly ALWAYS: number;
  114672. /** Passed to stencilOperation to specify that stencil value must be kept */
  114673. static readonly KEEP: number;
  114674. /** Passed to stencilOperation to specify that stencil value must be replaced */
  114675. static readonly REPLACE: number;
  114676. private _isStencilTestDirty;
  114677. private _isStencilMaskDirty;
  114678. private _isStencilFuncDirty;
  114679. private _isStencilOpDirty;
  114680. private _stencilTest;
  114681. private _stencilMask;
  114682. private _stencilFunc;
  114683. private _stencilFuncRef;
  114684. private _stencilFuncMask;
  114685. private _stencilOpStencilFail;
  114686. private _stencilOpDepthFail;
  114687. private _stencilOpStencilDepthPass;
  114688. get isDirty(): boolean;
  114689. get stencilFunc(): number;
  114690. set stencilFunc(value: number);
  114691. get stencilFuncRef(): number;
  114692. set stencilFuncRef(value: number);
  114693. get stencilFuncMask(): number;
  114694. set stencilFuncMask(value: number);
  114695. get stencilOpStencilFail(): number;
  114696. set stencilOpStencilFail(value: number);
  114697. get stencilOpDepthFail(): number;
  114698. set stencilOpDepthFail(value: number);
  114699. get stencilOpStencilDepthPass(): number;
  114700. set stencilOpStencilDepthPass(value: number);
  114701. get stencilMask(): number;
  114702. set stencilMask(value: number);
  114703. get stencilTest(): boolean;
  114704. set stencilTest(value: boolean);
  114705. constructor();
  114706. reset(): void;
  114707. apply(gl: WebGLRenderingContext): void;
  114708. }
  114709. }
  114710. declare module BABYLON {
  114711. /**
  114712. * @hidden
  114713. **/
  114714. export class AlphaState {
  114715. private _isAlphaBlendDirty;
  114716. private _isBlendFunctionParametersDirty;
  114717. private _isBlendEquationParametersDirty;
  114718. private _isBlendConstantsDirty;
  114719. private _alphaBlend;
  114720. private _blendFunctionParameters;
  114721. private _blendEquationParameters;
  114722. private _blendConstants;
  114723. /**
  114724. * Initializes the state.
  114725. */
  114726. constructor();
  114727. get isDirty(): boolean;
  114728. get alphaBlend(): boolean;
  114729. set alphaBlend(value: boolean);
  114730. setAlphaBlendConstants(r: number, g: number, b: number, a: number): void;
  114731. setAlphaBlendFunctionParameters(value0: number, value1: number, value2: number, value3: number): void;
  114732. setAlphaEquationParameters(rgb: number, alpha: number): void;
  114733. reset(): void;
  114734. apply(gl: WebGLRenderingContext): void;
  114735. }
  114736. }
  114737. declare module BABYLON {
  114738. /** @hidden */
  114739. export class WebGL2ShaderProcessor implements IShaderProcessor {
  114740. attributeProcessor(attribute: string): string;
  114741. varyingProcessor(varying: string, isFragment: boolean): string;
  114742. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  114743. }
  114744. }
  114745. declare module BABYLON {
  114746. /**
  114747. * Interface for attribute information associated with buffer instanciation
  114748. */
  114749. export interface InstancingAttributeInfo {
  114750. /**
  114751. * Name of the GLSL attribute
  114752. * if attribute index is not specified, this is used to retrieve the index from the effect
  114753. */
  114754. attributeName: string;
  114755. /**
  114756. * Index/offset of the attribute in the vertex shader
  114757. * if not specified, this will be computes from the name.
  114758. */
  114759. index?: number;
  114760. /**
  114761. * size of the attribute, 1, 2, 3 or 4
  114762. */
  114763. attributeSize: number;
  114764. /**
  114765. * Offset of the data in the Vertex Buffer acting as the instancing buffer
  114766. */
  114767. offset: number;
  114768. /**
  114769. * Modifies the rate at which generic vertex attributes advance when rendering multiple instances
  114770. * default to 1
  114771. */
  114772. divisor?: number;
  114773. /**
  114774. * type of the attribute, gl.BYTE, gl.UNSIGNED_BYTE, gl.SHORT, gl.UNSIGNED_SHORT, gl.FIXED, gl.FLOAT.
  114775. * default is FLOAT
  114776. */
  114777. attributeType?: number;
  114778. /**
  114779. * normalization of fixed-point data. behavior unclear, use FALSE, default is FALSE
  114780. */
  114781. normalized?: boolean;
  114782. }
  114783. }
  114784. declare module BABYLON {
  114785. interface ThinEngine {
  114786. /**
  114787. * Update a video texture
  114788. * @param texture defines the texture to update
  114789. * @param video defines the video element to use
  114790. * @param invertY defines if data must be stored with Y axis inverted
  114791. */
  114792. updateVideoTexture(texture: Nullable<InternalTexture>, video: HTMLVideoElement, invertY: boolean): void;
  114793. }
  114794. }
  114795. declare module BABYLON {
  114796. interface ThinEngine {
  114797. /**
  114798. * Creates a dynamic texture
  114799. * @param width defines the width of the texture
  114800. * @param height defines the height of the texture
  114801. * @param generateMipMaps defines if the engine should generate the mip levels
  114802. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  114803. * @returns the dynamic texture inside an InternalTexture
  114804. */
  114805. createDynamicTexture(width: number, height: number, generateMipMaps: boolean, samplingMode: number): InternalTexture;
  114806. /**
  114807. * Update the content of a dynamic texture
  114808. * @param texture defines the texture to update
  114809. * @param canvas defines the canvas containing the source
  114810. * @param invertY defines if data must be stored with Y axis inverted
  114811. * @param premulAlpha defines if alpha is stored as premultiplied
  114812. * @param format defines the format of the data
  114813. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  114814. */
  114815. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement | OffscreenCanvas, invertY: boolean, premulAlpha?: boolean, format?: number, forceBindTexture?: boolean): void;
  114816. }
  114817. }
  114818. declare module BABYLON {
  114819. /**
  114820. * Settings for finer control over video usage
  114821. */
  114822. export interface VideoTextureSettings {
  114823. /**
  114824. * Applies `autoplay` to video, if specified
  114825. */
  114826. autoPlay?: boolean;
  114827. /**
  114828. * Applies `loop` to video, if specified
  114829. */
  114830. loop?: boolean;
  114831. /**
  114832. * Automatically updates internal texture from video at every frame in the render loop
  114833. */
  114834. autoUpdateTexture: boolean;
  114835. /**
  114836. * Image src displayed during the video loading or until the user interacts with the video.
  114837. */
  114838. poster?: string;
  114839. }
  114840. /**
  114841. * If you want to display a video in your scene, this is the special texture for that.
  114842. * This special texture works similar to other textures, with the exception of a few parameters.
  114843. * @see https://doc.babylonjs.com/how_to/video_texture
  114844. */
  114845. export class VideoTexture extends Texture {
  114846. /**
  114847. * Tells whether textures will be updated automatically or user is required to call `updateTexture` manually
  114848. */
  114849. readonly autoUpdateTexture: boolean;
  114850. /**
  114851. * The video instance used by the texture internally
  114852. */
  114853. readonly video: HTMLVideoElement;
  114854. private _onUserActionRequestedObservable;
  114855. /**
  114856. * Event triggerd when a dom action is required by the user to play the video.
  114857. * This happens due to recent changes in browser policies preventing video to auto start.
  114858. */
  114859. get onUserActionRequestedObservable(): Observable<Texture>;
  114860. private _generateMipMaps;
  114861. private _stillImageCaptured;
  114862. private _displayingPosterTexture;
  114863. private _settings;
  114864. private _createInternalTextureOnEvent;
  114865. private _frameId;
  114866. private _currentSrc;
  114867. /**
  114868. * Creates a video texture.
  114869. * If you want to display a video in your scene, this is the special texture for that.
  114870. * This special texture works similar to other textures, with the exception of a few parameters.
  114871. * @see https://doc.babylonjs.com/how_to/video_texture
  114872. * @param name optional name, will detect from video source, if not defined
  114873. * @param src can be used to provide an url, array of urls or an already setup HTML video element.
  114874. * @param scene is obviously the current scene.
  114875. * @param generateMipMaps can be used to turn on mipmaps (Can be expensive for videoTextures because they are often updated).
  114876. * @param invertY is false by default but can be used to invert video on Y axis
  114877. * @param samplingMode controls the sampling method and is set to TRILINEAR_SAMPLINGMODE by default
  114878. * @param settings allows finer control over video usage
  114879. */
  114880. constructor(name: Nullable<string>, src: string | string[] | HTMLVideoElement, scene: Nullable<Scene>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, settings?: VideoTextureSettings);
  114881. private _getName;
  114882. private _getVideo;
  114883. private _createInternalTexture;
  114884. private reset;
  114885. /**
  114886. * @hidden Internal method to initiate `update`.
  114887. */
  114888. _rebuild(): void;
  114889. /**
  114890. * Update Texture in the `auto` mode. Does not do anything if `settings.autoUpdateTexture` is false.
  114891. */
  114892. update(): void;
  114893. /**
  114894. * Update Texture in `manual` mode. Does not do anything if not visible or paused.
  114895. * @param isVisible Visibility state, detected by user using `scene.getActiveMeshes()` or othervise.
  114896. */
  114897. updateTexture(isVisible: boolean): void;
  114898. protected _updateInternalTexture: () => void;
  114899. /**
  114900. * Change video content. Changing video instance or setting multiple urls (as in constructor) is not supported.
  114901. * @param url New url.
  114902. */
  114903. updateURL(url: string): void;
  114904. /**
  114905. * Clones the texture.
  114906. * @returns the cloned texture
  114907. */
  114908. clone(): VideoTexture;
  114909. /**
  114910. * Dispose the texture and release its associated resources.
  114911. */
  114912. dispose(): void;
  114913. /**
  114914. * Creates a video texture straight from a stream.
  114915. * @param scene Define the scene the texture should be created in
  114916. * @param stream Define the stream the texture should be created from
  114917. * @returns The created video texture as a promise
  114918. */
  114919. static CreateFromStreamAsync(scene: Scene, stream: MediaStream): Promise<VideoTexture>;
  114920. /**
  114921. * Creates a video texture straight from your WebCam video feed.
  114922. * @param scene Define the scene the texture should be created in
  114923. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  114924. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  114925. * @returns The created video texture as a promise
  114926. */
  114927. static CreateFromWebCamAsync(scene: Scene, constraints: {
  114928. minWidth: number;
  114929. maxWidth: number;
  114930. minHeight: number;
  114931. maxHeight: number;
  114932. deviceId: string;
  114933. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): Promise<VideoTexture>;
  114934. /**
  114935. * Creates a video texture straight from your WebCam video feed.
  114936. * @param scene Define the scene the texture should be created in
  114937. * @param onReady Define a callback to triggered once the texture will be ready
  114938. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  114939. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  114940. */
  114941. static CreateFromWebCam(scene: Scene, onReady: (videoTexture: VideoTexture) => void, constraints: {
  114942. minWidth: number;
  114943. maxWidth: number;
  114944. minHeight: number;
  114945. maxHeight: number;
  114946. deviceId: string;
  114947. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): void;
  114948. }
  114949. }
  114950. declare module BABYLON {
  114951. /**
  114952. * Defines the interface used by objects working like Scene
  114953. * @hidden
  114954. */
  114955. export interface ISceneLike {
  114956. _addPendingData(data: any): void;
  114957. _removePendingData(data: any): void;
  114958. offlineProvider: IOfflineProvider;
  114959. }
  114960. /**
  114961. * Information about the current host
  114962. */
  114963. export interface HostInformation {
  114964. /**
  114965. * Defines if the current host is a mobile
  114966. */
  114967. isMobile: boolean;
  114968. }
  114969. /** Interface defining initialization parameters for Engine class */
  114970. export interface EngineOptions extends WebGLContextAttributes {
  114971. /**
  114972. * Defines if the engine should no exceed a specified device ratio
  114973. * @see https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio
  114974. */
  114975. limitDeviceRatio?: number;
  114976. /**
  114977. * Defines if webvr should be enabled automatically
  114978. * @see https://doc.babylonjs.com/how_to/webvr_camera
  114979. */
  114980. autoEnableWebVR?: boolean;
  114981. /**
  114982. * Defines if webgl2 should be turned off even if supported
  114983. * @see https://doc.babylonjs.com/features/webgl2
  114984. */
  114985. disableWebGL2Support?: boolean;
  114986. /**
  114987. * Defines if webaudio should be initialized as well
  114988. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  114989. */
  114990. audioEngine?: boolean;
  114991. /**
  114992. * Defines if animations should run using a deterministic lock step
  114993. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  114994. */
  114995. deterministicLockstep?: boolean;
  114996. /** Defines the maximum steps to use with deterministic lock step mode */
  114997. lockstepMaxSteps?: number;
  114998. /** Defines the seconds between each deterministic lock step */
  114999. timeStep?: number;
  115000. /**
  115001. * Defines that engine should ignore context lost events
  115002. * If this event happens when this parameter is true, you will have to reload the page to restore rendering
  115003. */
  115004. doNotHandleContextLost?: boolean;
  115005. /**
  115006. * Defines that engine should ignore modifying touch action attribute and style
  115007. * If not handle, you might need to set it up on your side for expected touch devices behavior.
  115008. */
  115009. doNotHandleTouchAction?: boolean;
  115010. /**
  115011. * Defines that engine should compile shaders with high precision floats (if supported). True by default
  115012. */
  115013. useHighPrecisionFloats?: boolean;
  115014. /**
  115015. * Make the canvas XR Compatible for XR sessions
  115016. */
  115017. xrCompatible?: boolean;
  115018. /**
  115019. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  115020. */
  115021. useHighPrecisionMatrix?: boolean;
  115022. }
  115023. /**
  115024. * The base engine class (root of all engines)
  115025. */
  115026. export class ThinEngine {
  115027. /** Use this array to turn off some WebGL2 features on known buggy browsers version */
  115028. static ExceptionList: ({
  115029. key: string;
  115030. capture: string;
  115031. captureConstraint: number;
  115032. targets: string[];
  115033. } | {
  115034. key: string;
  115035. capture: null;
  115036. captureConstraint: null;
  115037. targets: string[];
  115038. })[];
  115039. /** @hidden */
  115040. static _TextureLoaders: IInternalTextureLoader[];
  115041. /**
  115042. * Returns the current npm package of the sdk
  115043. */
  115044. static get NpmPackage(): string;
  115045. /**
  115046. * Returns the current version of the framework
  115047. */
  115048. static get Version(): string;
  115049. /**
  115050. * Returns a string describing the current engine
  115051. */
  115052. get description(): string;
  115053. /**
  115054. * Gets or sets the epsilon value used by collision engine
  115055. */
  115056. static CollisionsEpsilon: number;
  115057. /**
  115058. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  115059. */
  115060. static get ShadersRepository(): string;
  115061. static set ShadersRepository(value: string);
  115062. /** @hidden */
  115063. _shaderProcessor: IShaderProcessor;
  115064. /**
  115065. * Gets or sets a boolean that indicates if textures must be forced to power of 2 size even if not required
  115066. */
  115067. forcePOTTextures: boolean;
  115068. /**
  115069. * Gets a boolean indicating if the engine is currently rendering in fullscreen mode
  115070. */
  115071. isFullscreen: boolean;
  115072. /**
  115073. * Gets or sets a boolean indicating if back faces must be culled (true by default)
  115074. */
  115075. cullBackFaces: boolean;
  115076. /**
  115077. * Gets or sets a boolean indicating if the engine must keep rendering even if the window is not in foregroun
  115078. */
  115079. renderEvenInBackground: boolean;
  115080. /**
  115081. * Gets or sets a boolean indicating that cache can be kept between frames
  115082. */
  115083. preventCacheWipeBetweenFrames: boolean;
  115084. /** Gets or sets a boolean indicating if the engine should validate programs after compilation */
  115085. validateShaderPrograms: boolean;
  115086. /**
  115087. * Gets or sets a boolean indicating if depth buffer should be reverse, going from far to near.
  115088. * This can provide greater z depth for distant objects.
  115089. */
  115090. useReverseDepthBuffer: boolean;
  115091. /**
  115092. * Gets or sets a boolean indicating that uniform buffers must be disabled even if they are supported
  115093. */
  115094. disableUniformBuffers: boolean;
  115095. /** @hidden */
  115096. _uniformBuffers: UniformBuffer[];
  115097. /**
  115098. * Gets a boolean indicating that the engine supports uniform buffers
  115099. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  115100. */
  115101. get supportsUniformBuffers(): boolean;
  115102. /** @hidden */
  115103. _gl: WebGLRenderingContext;
  115104. /** @hidden */
  115105. _webGLVersion: number;
  115106. protected _renderingCanvas: Nullable<HTMLCanvasElement>;
  115107. protected _windowIsBackground: boolean;
  115108. protected _creationOptions: EngineOptions;
  115109. protected _highPrecisionShadersAllowed: boolean;
  115110. /** @hidden */
  115111. get _shouldUseHighPrecisionShader(): boolean;
  115112. /**
  115113. * Gets a boolean indicating that only power of 2 textures are supported
  115114. * Please note that you can still use non power of 2 textures but in this case the engine will forcefully convert them
  115115. */
  115116. get needPOTTextures(): boolean;
  115117. /** @hidden */
  115118. _badOS: boolean;
  115119. /** @hidden */
  115120. _badDesktopOS: boolean;
  115121. private _hardwareScalingLevel;
  115122. /** @hidden */
  115123. _caps: EngineCapabilities;
  115124. private _isStencilEnable;
  115125. private _glVersion;
  115126. private _glRenderer;
  115127. private _glVendor;
  115128. /** @hidden */
  115129. _videoTextureSupported: boolean;
  115130. protected _renderingQueueLaunched: boolean;
  115131. protected _activeRenderLoops: (() => void)[];
  115132. /**
  115133. * Observable signaled when a context lost event is raised
  115134. */
  115135. onContextLostObservable: Observable<ThinEngine>;
  115136. /**
  115137. * Observable signaled when a context restored event is raised
  115138. */
  115139. onContextRestoredObservable: Observable<ThinEngine>;
  115140. private _onContextLost;
  115141. private _onContextRestored;
  115142. protected _contextWasLost: boolean;
  115143. /** @hidden */
  115144. _doNotHandleContextLost: boolean;
  115145. /**
  115146. * Gets or sets a boolean indicating if resources should be retained to be able to handle context lost events
  115147. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#handling-webgl-context-lost
  115148. */
  115149. get doNotHandleContextLost(): boolean;
  115150. set doNotHandleContextLost(value: boolean);
  115151. /**
  115152. * Gets or sets a boolean indicating that vertex array object must be disabled even if they are supported
  115153. */
  115154. disableVertexArrayObjects: boolean;
  115155. /** @hidden */
  115156. protected _colorWrite: boolean;
  115157. /** @hidden */
  115158. protected _colorWriteChanged: boolean;
  115159. /** @hidden */
  115160. protected _depthCullingState: DepthCullingState;
  115161. /** @hidden */
  115162. protected _stencilState: StencilState;
  115163. /** @hidden */
  115164. _alphaState: AlphaState;
  115165. /** @hidden */
  115166. _alphaMode: number;
  115167. /** @hidden */
  115168. _alphaEquation: number;
  115169. /** @hidden */
  115170. _internalTexturesCache: InternalTexture[];
  115171. /** @hidden */
  115172. protected _activeChannel: number;
  115173. private _currentTextureChannel;
  115174. /** @hidden */
  115175. protected _boundTexturesCache: {
  115176. [key: string]: Nullable<InternalTexture>;
  115177. };
  115178. /** @hidden */
  115179. protected _currentEffect: Nullable<Effect>;
  115180. /** @hidden */
  115181. protected _currentProgram: Nullable<WebGLProgram>;
  115182. private _compiledEffects;
  115183. private _vertexAttribArraysEnabled;
  115184. /** @hidden */
  115185. protected _cachedViewport: Nullable<IViewportLike>;
  115186. private _cachedVertexArrayObject;
  115187. /** @hidden */
  115188. protected _cachedVertexBuffers: any;
  115189. /** @hidden */
  115190. protected _cachedIndexBuffer: Nullable<DataBuffer>;
  115191. /** @hidden */
  115192. protected _cachedEffectForVertexBuffers: Nullable<Effect>;
  115193. /** @hidden */
  115194. _currentRenderTarget: Nullable<InternalTexture>;
  115195. private _uintIndicesCurrentlySet;
  115196. protected _currentBoundBuffer: Nullable<WebGLBuffer>[];
  115197. /** @hidden */
  115198. _currentFramebuffer: Nullable<WebGLFramebuffer>;
  115199. /** @hidden */
  115200. _dummyFramebuffer: Nullable<WebGLFramebuffer>;
  115201. private _currentBufferPointers;
  115202. private _currentInstanceLocations;
  115203. private _currentInstanceBuffers;
  115204. private _textureUnits;
  115205. /** @hidden */
  115206. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  115207. /** @hidden */
  115208. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  115209. /** @hidden */
  115210. _boundRenderFunction: any;
  115211. private _vaoRecordInProgress;
  115212. private _mustWipeVertexAttributes;
  115213. private _emptyTexture;
  115214. private _emptyCubeTexture;
  115215. private _emptyTexture3D;
  115216. private _emptyTexture2DArray;
  115217. /** @hidden */
  115218. _frameHandler: number;
  115219. private _nextFreeTextureSlots;
  115220. private _maxSimultaneousTextures;
  115221. private _activeRequests;
  115222. /** @hidden */
  115223. _transformTextureUrl: Nullable<(url: string) => string>;
  115224. /**
  115225. * Gets information about the current host
  115226. */
  115227. hostInformation: HostInformation;
  115228. protected get _supportsHardwareTextureRescaling(): boolean;
  115229. private _framebufferDimensionsObject;
  115230. /**
  115231. * sets the object from which width and height will be taken from when getting render width and height
  115232. * Will fallback to the gl object
  115233. * @param dimensions the framebuffer width and height that will be used.
  115234. */
  115235. set framebufferDimensionsObject(dimensions: Nullable<{
  115236. framebufferWidth: number;
  115237. framebufferHeight: number;
  115238. }>);
  115239. /**
  115240. * Gets the current viewport
  115241. */
  115242. get currentViewport(): Nullable<IViewportLike>;
  115243. /**
  115244. * Gets the default empty texture
  115245. */
  115246. get emptyTexture(): InternalTexture;
  115247. /**
  115248. * Gets the default empty 3D texture
  115249. */
  115250. get emptyTexture3D(): InternalTexture;
  115251. /**
  115252. * Gets the default empty 2D array texture
  115253. */
  115254. get emptyTexture2DArray(): InternalTexture;
  115255. /**
  115256. * Gets the default empty cube texture
  115257. */
  115258. get emptyCubeTexture(): InternalTexture;
  115259. /**
  115260. * Defines whether the engine has been created with the premultipliedAlpha option on or not.
  115261. */
  115262. readonly premultipliedAlpha: boolean;
  115263. /**
  115264. * Observable event triggered before each texture is initialized
  115265. */
  115266. onBeforeTextureInitObservable: Observable<Texture>;
  115267. /**
  115268. * Creates a new engine
  115269. * @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
  115270. * @param antialias defines enable antialiasing (default: false)
  115271. * @param options defines further options to be sent to the getContext() function
  115272. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  115273. */
  115274. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext | WebGL2RenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  115275. private _rebuildInternalTextures;
  115276. private _rebuildEffects;
  115277. /**
  115278. * Gets a boolean indicating if all created effects are ready
  115279. * @returns true if all effects are ready
  115280. */
  115281. areAllEffectsReady(): boolean;
  115282. protected _rebuildBuffers(): void;
  115283. protected _initGLContext(): void;
  115284. /**
  115285. * Gets version of the current webGL context
  115286. */
  115287. get webGLVersion(): number;
  115288. /**
  115289. * Gets a string identifying the name of the class
  115290. * @returns "Engine" string
  115291. */
  115292. getClassName(): string;
  115293. /**
  115294. * Returns true if the stencil buffer has been enabled through the creation option of the context.
  115295. */
  115296. get isStencilEnable(): boolean;
  115297. /** @hidden */
  115298. _prepareWorkingCanvas(): void;
  115299. /**
  115300. * Reset the texture cache to empty state
  115301. */
  115302. resetTextureCache(): void;
  115303. /**
  115304. * Gets an object containing information about the current webGL context
  115305. * @returns an object containing the vender, the renderer and the version of the current webGL context
  115306. */
  115307. getGlInfo(): {
  115308. vendor: string;
  115309. renderer: string;
  115310. version: string;
  115311. };
  115312. /**
  115313. * Defines the hardware scaling level.
  115314. * By default the hardware scaling level is computed from the window device ratio.
  115315. * 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.
  115316. * @param level defines the level to use
  115317. */
  115318. setHardwareScalingLevel(level: number): void;
  115319. /**
  115320. * Gets the current hardware scaling level.
  115321. * By default the hardware scaling level is computed from the window device ratio.
  115322. * 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.
  115323. * @returns a number indicating the current hardware scaling level
  115324. */
  115325. getHardwareScalingLevel(): number;
  115326. /**
  115327. * Gets the list of loaded textures
  115328. * @returns an array containing all loaded textures
  115329. */
  115330. getLoadedTexturesCache(): InternalTexture[];
  115331. /**
  115332. * Gets the object containing all engine capabilities
  115333. * @returns the EngineCapabilities object
  115334. */
  115335. getCaps(): EngineCapabilities;
  115336. /**
  115337. * stop executing a render loop function and remove it from the execution array
  115338. * @param renderFunction defines the function to be removed. If not provided all functions will be removed.
  115339. */
  115340. stopRenderLoop(renderFunction?: () => void): void;
  115341. /** @hidden */
  115342. _renderLoop(): void;
  115343. /**
  115344. * Gets the HTML canvas attached with the current webGL context
  115345. * @returns a HTML canvas
  115346. */
  115347. getRenderingCanvas(): Nullable<HTMLCanvasElement>;
  115348. /**
  115349. * Gets host window
  115350. * @returns the host window object
  115351. */
  115352. getHostWindow(): Nullable<Window>;
  115353. /**
  115354. * Gets the current render width
  115355. * @param useScreen defines if screen size must be used (or the current render target if any)
  115356. * @returns a number defining the current render width
  115357. */
  115358. getRenderWidth(useScreen?: boolean): number;
  115359. /**
  115360. * Gets the current render height
  115361. * @param useScreen defines if screen size must be used (or the current render target if any)
  115362. * @returns a number defining the current render height
  115363. */
  115364. getRenderHeight(useScreen?: boolean): number;
  115365. /**
  115366. * Can be used to override the current requestAnimationFrame requester.
  115367. * @hidden
  115368. */
  115369. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  115370. /**
  115371. * Register and execute a render loop. The engine can have more than one render function
  115372. * @param renderFunction defines the function to continuously execute
  115373. */
  115374. runRenderLoop(renderFunction: () => void): void;
  115375. /**
  115376. * Clear the current render buffer or the current render target (if any is set up)
  115377. * @param color defines the color to use
  115378. * @param backBuffer defines if the back buffer must be cleared
  115379. * @param depth defines if the depth buffer must be cleared
  115380. * @param stencil defines if the stencil buffer must be cleared
  115381. */
  115382. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  115383. private _viewportCached;
  115384. /** @hidden */
  115385. _viewport(x: number, y: number, width: number, height: number): void;
  115386. /**
  115387. * Set the WebGL's viewport
  115388. * @param viewport defines the viewport element to be used
  115389. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  115390. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  115391. */
  115392. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  115393. /**
  115394. * Begin a new frame
  115395. */
  115396. beginFrame(): void;
  115397. /**
  115398. * Enf the current frame
  115399. */
  115400. endFrame(): void;
  115401. /**
  115402. * Resize the view according to the canvas' size
  115403. */
  115404. resize(): void;
  115405. /**
  115406. * Force a specific size of the canvas
  115407. * @param width defines the new canvas' width
  115408. * @param height defines the new canvas' height
  115409. * @returns true if the size was changed
  115410. */
  115411. setSize(width: number, height: number): boolean;
  115412. /**
  115413. * Binds the frame buffer to the specified texture.
  115414. * @param texture The texture to render to or null for the default canvas
  115415. * @param faceIndex The face of the texture to render to in case of cube texture
  115416. * @param requiredWidth The width of the target to render to
  115417. * @param requiredHeight The height of the target to render to
  115418. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  115419. * @param lodLevel defines the lod level to bind to the frame buffer
  115420. * @param layer defines the 2d array index to bind to frame buffer to
  115421. */
  115422. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean, lodLevel?: number, layer?: number): void;
  115423. /** @hidden */
  115424. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  115425. /**
  115426. * Unbind the current render target texture from the webGL context
  115427. * @param texture defines the render target texture to unbind
  115428. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  115429. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  115430. */
  115431. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  115432. /**
  115433. * Force a webGL flush (ie. a flush of all waiting webGL commands)
  115434. */
  115435. flushFramebuffer(): void;
  115436. /**
  115437. * Unbind the current render target and bind the default framebuffer
  115438. */
  115439. restoreDefaultFramebuffer(): void;
  115440. /** @hidden */
  115441. protected _resetVertexBufferBinding(): void;
  115442. /**
  115443. * Creates a vertex buffer
  115444. * @param data the data for the vertex buffer
  115445. * @returns the new WebGL static buffer
  115446. */
  115447. createVertexBuffer(data: DataArray): DataBuffer;
  115448. private _createVertexBuffer;
  115449. /**
  115450. * Creates a dynamic vertex buffer
  115451. * @param data the data for the dynamic vertex buffer
  115452. * @returns the new WebGL dynamic buffer
  115453. */
  115454. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  115455. protected _resetIndexBufferBinding(): void;
  115456. /**
  115457. * Creates a new index buffer
  115458. * @param indices defines the content of the index buffer
  115459. * @param updatable defines if the index buffer must be updatable
  115460. * @returns a new webGL buffer
  115461. */
  115462. createIndexBuffer(indices: IndicesArray, updatable?: boolean): DataBuffer;
  115463. protected _normalizeIndexData(indices: IndicesArray): Uint16Array | Uint32Array;
  115464. /**
  115465. * Bind a webGL buffer to the webGL context
  115466. * @param buffer defines the buffer to bind
  115467. */
  115468. bindArrayBuffer(buffer: Nullable<DataBuffer>): void;
  115469. protected bindIndexBuffer(buffer: Nullable<DataBuffer>): void;
  115470. private bindBuffer;
  115471. /**
  115472. * update the bound buffer with the given data
  115473. * @param data defines the data to update
  115474. */
  115475. updateArrayBuffer(data: Float32Array): void;
  115476. private _vertexAttribPointer;
  115477. /** @hidden */
  115478. _bindIndexBufferWithCache(indexBuffer: Nullable<DataBuffer>): void;
  115479. private _bindVertexBuffersAttributes;
  115480. /**
  115481. * Records a vertex array object
  115482. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  115483. * @param vertexBuffers defines the list of vertex buffers to store
  115484. * @param indexBuffer defines the index buffer to store
  115485. * @param effect defines the effect to store
  115486. * @returns the new vertex array object
  115487. */
  115488. recordVertexArrayObject(vertexBuffers: {
  115489. [key: string]: VertexBuffer;
  115490. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): WebGLVertexArrayObject;
  115491. /**
  115492. * Bind a specific vertex array object
  115493. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  115494. * @param vertexArrayObject defines the vertex array object to bind
  115495. * @param indexBuffer defines the index buffer to bind
  115496. */
  115497. bindVertexArrayObject(vertexArrayObject: WebGLVertexArrayObject, indexBuffer: Nullable<DataBuffer>): void;
  115498. /**
  115499. * Bind webGl buffers directly to the webGL context
  115500. * @param vertexBuffer defines the vertex buffer to bind
  115501. * @param indexBuffer defines the index buffer to bind
  115502. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  115503. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  115504. * @param effect defines the effect associated with the vertex buffer
  115505. */
  115506. bindBuffersDirectly(vertexBuffer: DataBuffer, indexBuffer: DataBuffer, vertexDeclaration: number[], vertexStrideSize: number, effect: Effect): void;
  115507. private _unbindVertexArrayObject;
  115508. /**
  115509. * Bind a list of vertex buffers to the webGL context
  115510. * @param vertexBuffers defines the list of vertex buffers to bind
  115511. * @param indexBuffer defines the index buffer to bind
  115512. * @param effect defines the effect associated with the vertex buffers
  115513. */
  115514. bindBuffers(vertexBuffers: {
  115515. [key: string]: Nullable<VertexBuffer>;
  115516. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): void;
  115517. /**
  115518. * Unbind all instance attributes
  115519. */
  115520. unbindInstanceAttributes(): void;
  115521. /**
  115522. * Release and free the memory of a vertex array object
  115523. * @param vao defines the vertex array object to delete
  115524. */
  115525. releaseVertexArrayObject(vao: WebGLVertexArrayObject): void;
  115526. /** @hidden */
  115527. _releaseBuffer(buffer: DataBuffer): boolean;
  115528. protected _deleteBuffer(buffer: DataBuffer): void;
  115529. /**
  115530. * Update the content of a webGL buffer used with instanciation and bind it to the webGL context
  115531. * @param instancesBuffer defines the webGL buffer to update and bind
  115532. * @param data defines the data to store in the buffer
  115533. * @param offsetLocations defines the offsets or attributes information used to determine where data must be stored in the buffer
  115534. */
  115535. updateAndBindInstancesBuffer(instancesBuffer: DataBuffer, data: Float32Array, offsetLocations: number[] | InstancingAttributeInfo[]): void;
  115536. /**
  115537. * Bind the content of a webGL buffer used with instantiation
  115538. * @param instancesBuffer defines the webGL buffer to bind
  115539. * @param attributesInfo defines the offsets or attributes information used to determine where data must be stored in the buffer
  115540. * @param computeStride defines Whether to compute the strides from the info or use the default 0
  115541. */
  115542. bindInstancesBuffer(instancesBuffer: DataBuffer, attributesInfo: InstancingAttributeInfo[], computeStride?: boolean): void;
  115543. /**
  115544. * Disable the instance attribute corresponding to the name in parameter
  115545. * @param name defines the name of the attribute to disable
  115546. */
  115547. disableInstanceAttributeByName(name: string): void;
  115548. /**
  115549. * Disable the instance attribute corresponding to the location in parameter
  115550. * @param attributeLocation defines the attribute location of the attribute to disable
  115551. */
  115552. disableInstanceAttribute(attributeLocation: number): void;
  115553. /**
  115554. * Disable the attribute corresponding to the location in parameter
  115555. * @param attributeLocation defines the attribute location of the attribute to disable
  115556. */
  115557. disableAttributeByIndex(attributeLocation: number): void;
  115558. /**
  115559. * Send a draw order
  115560. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  115561. * @param indexStart defines the starting index
  115562. * @param indexCount defines the number of index to draw
  115563. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  115564. */
  115565. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  115566. /**
  115567. * Draw a list of points
  115568. * @param verticesStart defines the index of first vertex to draw
  115569. * @param verticesCount defines the count of vertices to draw
  115570. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  115571. */
  115572. drawPointClouds(verticesStart: number, verticesCount: number, instancesCount?: number): void;
  115573. /**
  115574. * Draw a list of unindexed primitives
  115575. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  115576. * @param verticesStart defines the index of first vertex to draw
  115577. * @param verticesCount defines the count of vertices to draw
  115578. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  115579. */
  115580. drawUnIndexed(useTriangles: boolean, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  115581. /**
  115582. * Draw a list of indexed primitives
  115583. * @param fillMode defines the primitive to use
  115584. * @param indexStart defines the starting index
  115585. * @param indexCount defines the number of index to draw
  115586. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  115587. */
  115588. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  115589. /**
  115590. * Draw a list of unindexed primitives
  115591. * @param fillMode defines the primitive to use
  115592. * @param verticesStart defines the index of first vertex to draw
  115593. * @param verticesCount defines the count of vertices to draw
  115594. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  115595. */
  115596. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  115597. private _drawMode;
  115598. /** @hidden */
  115599. protected _reportDrawCall(): void;
  115600. /** @hidden */
  115601. _releaseEffect(effect: Effect): void;
  115602. /** @hidden */
  115603. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  115604. /**
  115605. * Create a new effect (used to store vertex/fragment shaders)
  115606. * @param baseName defines the base name of the effect (The name of file without .fragment.fx or .vertex.fx)
  115607. * @param attributesNamesOrOptions defines either a list of attribute names or an IEffectCreationOptions object
  115608. * @param uniformsNamesOrEngine defines either a list of uniform names or the engine to use
  115609. * @param samplers defines an array of string used to represent textures
  115610. * @param defines defines the string containing the defines to use to compile the shaders
  115611. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  115612. * @param onCompiled defines a function to call when the effect creation is successful
  115613. * @param onError defines a function to call when the effect creation has failed
  115614. * @param indexParameters defines an object containing the index values to use to compile shaders (like the maximum number of simultaneous lights)
  115615. * @returns the new Effect
  115616. */
  115617. 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;
  115618. protected static _ConcatenateShader(source: string, defines: Nullable<string>, shaderVersion?: string): string;
  115619. private _compileShader;
  115620. private _compileRawShader;
  115621. /** @hidden */
  115622. _getShaderSource(shader: WebGLShader): Nullable<string>;
  115623. /**
  115624. * Directly creates a webGL program
  115625. * @param pipelineContext defines the pipeline context to attach to
  115626. * @param vertexCode defines the vertex shader code to use
  115627. * @param fragmentCode defines the fragment shader code to use
  115628. * @param context defines the webGL context to use (if not set, the current one will be used)
  115629. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  115630. * @returns the new webGL program
  115631. */
  115632. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  115633. /**
  115634. * Creates a webGL program
  115635. * @param pipelineContext defines the pipeline context to attach to
  115636. * @param vertexCode defines the vertex shader code to use
  115637. * @param fragmentCode defines the fragment shader code to use
  115638. * @param defines defines the string containing the defines to use to compile the shaders
  115639. * @param context defines the webGL context to use (if not set, the current one will be used)
  115640. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  115641. * @returns the new webGL program
  115642. */
  115643. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  115644. /**
  115645. * Creates a new pipeline context
  115646. * @returns the new pipeline
  115647. */
  115648. createPipelineContext(): IPipelineContext;
  115649. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  115650. protected _finalizePipelineContext(pipelineContext: WebGLPipelineContext): void;
  115651. /** @hidden */
  115652. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  115653. /** @hidden */
  115654. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  115655. /** @hidden */
  115656. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  115657. /**
  115658. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  115659. * @param pipelineContext defines the pipeline context to use
  115660. * @param uniformsNames defines the list of uniform names
  115661. * @returns an array of webGL uniform locations
  115662. */
  115663. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  115664. /**
  115665. * Gets the lsit of active attributes for a given webGL program
  115666. * @param pipelineContext defines the pipeline context to use
  115667. * @param attributesNames defines the list of attribute names to get
  115668. * @returns an array of indices indicating the offset of each attribute
  115669. */
  115670. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  115671. /**
  115672. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  115673. * @param effect defines the effect to activate
  115674. */
  115675. enableEffect(effect: Nullable<Effect>): void;
  115676. /**
  115677. * Set the value of an uniform to a number (int)
  115678. * @param uniform defines the webGL uniform location where to store the value
  115679. * @param value defines the int number to store
  115680. */
  115681. setInt(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  115682. /**
  115683. * Set the value of an uniform to an array of int32
  115684. * @param uniform defines the webGL uniform location where to store the value
  115685. * @param array defines the array of int32 to store
  115686. */
  115687. setIntArray(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  115688. /**
  115689. * Set the value of an uniform to an array of int32 (stored as vec2)
  115690. * @param uniform defines the webGL uniform location where to store the value
  115691. * @param array defines the array of int32 to store
  115692. */
  115693. setIntArray2(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  115694. /**
  115695. * Set the value of an uniform to an array of int32 (stored as vec3)
  115696. * @param uniform defines the webGL uniform location where to store the value
  115697. * @param array defines the array of int32 to store
  115698. */
  115699. setIntArray3(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  115700. /**
  115701. * Set the value of an uniform to an array of int32 (stored as vec4)
  115702. * @param uniform defines the webGL uniform location where to store the value
  115703. * @param array defines the array of int32 to store
  115704. */
  115705. setIntArray4(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  115706. /**
  115707. * Set the value of an uniform to an array of number
  115708. * @param uniform defines the webGL uniform location where to store the value
  115709. * @param array defines the array of number to store
  115710. */
  115711. setArray(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  115712. /**
  115713. * Set the value of an uniform to an array of number (stored as vec2)
  115714. * @param uniform defines the webGL uniform location where to store the value
  115715. * @param array defines the array of number to store
  115716. */
  115717. setArray2(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  115718. /**
  115719. * Set the value of an uniform to an array of number (stored as vec3)
  115720. * @param uniform defines the webGL uniform location where to store the value
  115721. * @param array defines the array of number to store
  115722. */
  115723. setArray3(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  115724. /**
  115725. * Set the value of an uniform to an array of number (stored as vec4)
  115726. * @param uniform defines the webGL uniform location where to store the value
  115727. * @param array defines the array of number to store
  115728. */
  115729. setArray4(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  115730. /**
  115731. * Set the value of an uniform to an array of float32 (stored as matrices)
  115732. * @param uniform defines the webGL uniform location where to store the value
  115733. * @param matrices defines the array of float32 to store
  115734. */
  115735. setMatrices(uniform: Nullable<WebGLUniformLocation>, matrices: Float32Array): void;
  115736. /**
  115737. * Set the value of an uniform to a matrix (3x3)
  115738. * @param uniform defines the webGL uniform location where to store the value
  115739. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  115740. */
  115741. setMatrix3x3(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  115742. /**
  115743. * Set the value of an uniform to a matrix (2x2)
  115744. * @param uniform defines the webGL uniform location where to store the value
  115745. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  115746. */
  115747. setMatrix2x2(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  115748. /**
  115749. * Set the value of an uniform to a number (float)
  115750. * @param uniform defines the webGL uniform location where to store the value
  115751. * @param value defines the float number to store
  115752. */
  115753. setFloat(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  115754. /**
  115755. * Set the value of an uniform to a vec2
  115756. * @param uniform defines the webGL uniform location where to store the value
  115757. * @param x defines the 1st component of the value
  115758. * @param y defines the 2nd component of the value
  115759. */
  115760. setFloat2(uniform: Nullable<WebGLUniformLocation>, x: number, y: number): void;
  115761. /**
  115762. * Set the value of an uniform to a vec3
  115763. * @param uniform defines the webGL uniform location where to store the value
  115764. * @param x defines the 1st component of the value
  115765. * @param y defines the 2nd component of the value
  115766. * @param z defines the 3rd component of the value
  115767. */
  115768. setFloat3(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number): void;
  115769. /**
  115770. * Set the value of an uniform to a vec4
  115771. * @param uniform defines the webGL uniform location where to store the value
  115772. * @param x defines the 1st component of the value
  115773. * @param y defines the 2nd component of the value
  115774. * @param z defines the 3rd component of the value
  115775. * @param w defines the 4th component of the value
  115776. */
  115777. setFloat4(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number, w: number): void;
  115778. /**
  115779. * Apply all cached states (depth, culling, stencil and alpha)
  115780. */
  115781. applyStates(): void;
  115782. /**
  115783. * Enable or disable color writing
  115784. * @param enable defines the state to set
  115785. */
  115786. setColorWrite(enable: boolean): void;
  115787. /**
  115788. * Gets a boolean indicating if color writing is enabled
  115789. * @returns the current color writing state
  115790. */
  115791. getColorWrite(): boolean;
  115792. /**
  115793. * Gets the depth culling state manager
  115794. */
  115795. get depthCullingState(): DepthCullingState;
  115796. /**
  115797. * Gets the alpha state manager
  115798. */
  115799. get alphaState(): AlphaState;
  115800. /**
  115801. * Gets the stencil state manager
  115802. */
  115803. get stencilState(): StencilState;
  115804. /**
  115805. * Clears the list of texture accessible through engine.
  115806. * This can help preventing texture load conflict due to name collision.
  115807. */
  115808. clearInternalTexturesCache(): void;
  115809. /**
  115810. * Force the entire cache to be cleared
  115811. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  115812. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  115813. */
  115814. wipeCaches(bruteForce?: boolean): void;
  115815. /** @hidden */
  115816. _getSamplingParameters(samplingMode: number, generateMipMaps: boolean): {
  115817. min: number;
  115818. mag: number;
  115819. };
  115820. /** @hidden */
  115821. _createTexture(): WebGLTexture;
  115822. /**
  115823. * Usually called from Texture.ts.
  115824. * Passed information to create a WebGLTexture
  115825. * @param url defines a value which contains one of the following:
  115826. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  115827. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  115828. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  115829. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  115830. * @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)
  115831. * @param scene needed for loading to the correct scene
  115832. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  115833. * @param onLoad optional callback to be called upon successful completion
  115834. * @param onError optional callback to be called upon failure
  115835. * @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
  115836. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  115837. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  115838. * @param forcedExtension defines the extension to use to pick the right loader
  115839. * @param mimeType defines an optional mime type
  115840. * @returns a InternalTexture for assignment back into BABYLON.Texture
  115841. */
  115842. 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;
  115843. /**
  115844. * Loads an image as an HTMLImageElement.
  115845. * @param input url string, ArrayBuffer, or Blob to load
  115846. * @param onLoad callback called when the image successfully loads
  115847. * @param onError callback called when the image fails to load
  115848. * @param offlineProvider offline provider for caching
  115849. * @param mimeType optional mime type
  115850. * @returns the HTMLImageElement of the loaded image
  115851. * @hidden
  115852. */
  115853. 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>;
  115854. /**
  115855. * @hidden
  115856. */
  115857. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  115858. private _unpackFlipYCached;
  115859. /**
  115860. * In case you are sharing the context with other applications, it might
  115861. * be interested to not cache the unpack flip y state to ensure a consistent
  115862. * value would be set.
  115863. */
  115864. enableUnpackFlipYCached: boolean;
  115865. /** @hidden */
  115866. _unpackFlipY(value: boolean): void;
  115867. /** @hidden */
  115868. _getUnpackAlignement(): number;
  115869. private _getTextureTarget;
  115870. /**
  115871. * Update the sampling mode of a given texture
  115872. * @param samplingMode defines the required sampling mode
  115873. * @param texture defines the texture to update
  115874. * @param generateMipMaps defines whether to generate mipmaps for the texture
  115875. */
  115876. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture, generateMipMaps?: boolean): void;
  115877. /**
  115878. * Update the sampling mode of a given texture
  115879. * @param texture defines the texture to update
  115880. * @param wrapU defines the texture wrap mode of the u coordinates
  115881. * @param wrapV defines the texture wrap mode of the v coordinates
  115882. * @param wrapR defines the texture wrap mode of the r coordinates
  115883. */
  115884. updateTextureWrappingMode(texture: InternalTexture, wrapU: Nullable<number>, wrapV?: Nullable<number>, wrapR?: Nullable<number>): void;
  115885. /** @hidden */
  115886. _setupDepthStencilTexture(internalTexture: InternalTexture, size: number | {
  115887. width: number;
  115888. height: number;
  115889. layers?: number;
  115890. }, generateStencil: boolean, bilinearFiltering: boolean, comparisonFunction: number): void;
  115891. /** @hidden */
  115892. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  115893. /** @hidden */
  115894. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number, babylonInternalFormat?: number, useTextureWidthAndHeight?: boolean): void;
  115895. /**
  115896. * Update a portion of an internal texture
  115897. * @param texture defines the texture to update
  115898. * @param imageData defines the data to store into the texture
  115899. * @param xOffset defines the x coordinates of the update rectangle
  115900. * @param yOffset defines the y coordinates of the update rectangle
  115901. * @param width defines the width of the update rectangle
  115902. * @param height defines the height of the update rectangle
  115903. * @param faceIndex defines the face index if texture is a cube (0 by default)
  115904. * @param lod defines the lod level to update (0 by default)
  115905. */
  115906. updateTextureData(texture: InternalTexture, imageData: ArrayBufferView, xOffset: number, yOffset: number, width: number, height: number, faceIndex?: number, lod?: number): void;
  115907. /** @hidden */
  115908. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  115909. protected _prepareWebGLTextureContinuation(texture: InternalTexture, scene: Nullable<ISceneLike>, noMipmap: boolean, isCompressed: boolean, samplingMode: number): void;
  115910. private _prepareWebGLTexture;
  115911. /** @hidden */
  115912. _setupFramebufferDepthAttachments(generateStencilBuffer: boolean, generateDepthBuffer: boolean, width: number, height: number, samples?: number): Nullable<WebGLRenderbuffer>;
  115913. private _getDepthStencilBuffer;
  115914. /** @hidden */
  115915. _releaseFramebufferObjects(texture: InternalTexture): void;
  115916. /** @hidden */
  115917. _releaseTexture(texture: InternalTexture): void;
  115918. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  115919. protected _setProgram(program: WebGLProgram): void;
  115920. protected _boundUniforms: {
  115921. [key: number]: WebGLUniformLocation;
  115922. };
  115923. /**
  115924. * Binds an effect to the webGL context
  115925. * @param effect defines the effect to bind
  115926. */
  115927. bindSamplers(effect: Effect): void;
  115928. private _activateCurrentTexture;
  115929. /** @hidden */
  115930. _bindTextureDirectly(target: number, texture: Nullable<InternalTexture>, forTextureDataUpdate?: boolean, force?: boolean): boolean;
  115931. /** @hidden */
  115932. _bindTexture(channel: number, texture: Nullable<InternalTexture>): void;
  115933. /**
  115934. * Unbind all textures from the webGL context
  115935. */
  115936. unbindAllTextures(): void;
  115937. /**
  115938. * Sets a texture to the according uniform.
  115939. * @param channel The texture channel
  115940. * @param uniform The uniform to set
  115941. * @param texture The texture to apply
  115942. */
  115943. setTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<BaseTexture>): void;
  115944. private _bindSamplerUniformToChannel;
  115945. private _getTextureWrapMode;
  115946. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  115947. /**
  115948. * Sets an array of texture to the webGL context
  115949. * @param channel defines the channel where the texture array must be set
  115950. * @param uniform defines the associated uniform location
  115951. * @param textures defines the array of textures to bind
  115952. */
  115953. setTextureArray(channel: number, uniform: Nullable<WebGLUniformLocation>, textures: BaseTexture[]): void;
  115954. /** @hidden */
  115955. _setAnisotropicLevel(target: number, internalTexture: InternalTexture, anisotropicFilteringLevel: number): void;
  115956. private _setTextureParameterFloat;
  115957. private _setTextureParameterInteger;
  115958. /**
  115959. * Unbind all vertex attributes from the webGL context
  115960. */
  115961. unbindAllAttributes(): void;
  115962. /**
  115963. * 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
  115964. */
  115965. releaseEffects(): void;
  115966. /**
  115967. * Dispose and release all associated resources
  115968. */
  115969. dispose(): void;
  115970. /**
  115971. * Attach a new callback raised when context lost event is fired
  115972. * @param callback defines the callback to call
  115973. */
  115974. attachContextLostEvent(callback: ((event: WebGLContextEvent) => void)): void;
  115975. /**
  115976. * Attach a new callback raised when context restored event is fired
  115977. * @param callback defines the callback to call
  115978. */
  115979. attachContextRestoredEvent(callback: ((event: WebGLContextEvent) => void)): void;
  115980. /**
  115981. * Get the current error code of the webGL context
  115982. * @returns the error code
  115983. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  115984. */
  115985. getError(): number;
  115986. private _canRenderToFloatFramebuffer;
  115987. private _canRenderToHalfFloatFramebuffer;
  115988. private _canRenderToFramebuffer;
  115989. /** @hidden */
  115990. _getWebGLTextureType(type: number): number;
  115991. /** @hidden */
  115992. _getInternalFormat(format: number): number;
  115993. /** @hidden */
  115994. _getRGBABufferInternalSizedFormat(type: number, format?: number): number;
  115995. /** @hidden */
  115996. _getRGBAMultiSampleBufferFormat(type: number): number;
  115997. /** @hidden */
  115998. _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;
  115999. /**
  116000. * Loads a file from a url
  116001. * @param url url to load
  116002. * @param onSuccess callback called when the file successfully loads
  116003. * @param onProgress callback called while file is loading (if the server supports this mode)
  116004. * @param offlineProvider defines the offline provider for caching
  116005. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  116006. * @param onError callback called when the file fails to load
  116007. * @returns a file request object
  116008. * @hidden
  116009. */
  116010. 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;
  116011. /**
  116012. * Reads pixels from the current frame buffer. Please note that this function can be slow
  116013. * @param x defines the x coordinate of the rectangle where pixels must be read
  116014. * @param y defines the y coordinate of the rectangle where pixels must be read
  116015. * @param width defines the width of the rectangle where pixels must be read
  116016. * @param height defines the height of the rectangle where pixels must be read
  116017. * @param hasAlpha defines whether the output should have alpha or not (defaults to true)
  116018. * @returns a Uint8Array containing RGBA colors
  116019. */
  116020. readPixels(x: number, y: number, width: number, height: number, hasAlpha?: boolean): Uint8Array;
  116021. private static _isSupported;
  116022. /**
  116023. * Gets a boolean indicating if the engine can be instanciated (ie. if a webGL context can be found)
  116024. * @returns true if the engine can be created
  116025. * @ignorenaming
  116026. */
  116027. static isSupported(): boolean;
  116028. /**
  116029. * Find the next highest power of two.
  116030. * @param x Number to start search from.
  116031. * @return Next highest power of two.
  116032. */
  116033. static CeilingPOT(x: number): number;
  116034. /**
  116035. * Find the next lowest power of two.
  116036. * @param x Number to start search from.
  116037. * @return Next lowest power of two.
  116038. */
  116039. static FloorPOT(x: number): number;
  116040. /**
  116041. * Find the nearest power of two.
  116042. * @param x Number to start search from.
  116043. * @return Next nearest power of two.
  116044. */
  116045. static NearestPOT(x: number): number;
  116046. /**
  116047. * Get the closest exponent of two
  116048. * @param value defines the value to approximate
  116049. * @param max defines the maximum value to return
  116050. * @param mode defines how to define the closest value
  116051. * @returns closest exponent of two of the given value
  116052. */
  116053. static GetExponentOfTwo(value: number, max: number, mode?: number): number;
  116054. /**
  116055. * Queue a new function into the requested animation frame pool (ie. this function will be executed byt the browser for the next frame)
  116056. * @param func - the function to be called
  116057. * @param requester - the object that will request the next frame. Falls back to window.
  116058. * @returns frame number
  116059. */
  116060. static QueueNewFrame(func: () => void, requester?: any): number;
  116061. /**
  116062. * Gets host document
  116063. * @returns the host document object
  116064. */
  116065. getHostDocument(): Nullable<Document>;
  116066. }
  116067. }
  116068. declare module BABYLON {
  116069. /**
  116070. * Class representing spherical harmonics coefficients to the 3rd degree
  116071. */
  116072. export class SphericalHarmonics {
  116073. /**
  116074. * Defines whether or not the harmonics have been prescaled for rendering.
  116075. */
  116076. preScaled: boolean;
  116077. /**
  116078. * The l0,0 coefficients of the spherical harmonics
  116079. */
  116080. l00: Vector3;
  116081. /**
  116082. * The l1,-1 coefficients of the spherical harmonics
  116083. */
  116084. l1_1: Vector3;
  116085. /**
  116086. * The l1,0 coefficients of the spherical harmonics
  116087. */
  116088. l10: Vector3;
  116089. /**
  116090. * The l1,1 coefficients of the spherical harmonics
  116091. */
  116092. l11: Vector3;
  116093. /**
  116094. * The l2,-2 coefficients of the spherical harmonics
  116095. */
  116096. l2_2: Vector3;
  116097. /**
  116098. * The l2,-1 coefficients of the spherical harmonics
  116099. */
  116100. l2_1: Vector3;
  116101. /**
  116102. * The l2,0 coefficients of the spherical harmonics
  116103. */
  116104. l20: Vector3;
  116105. /**
  116106. * The l2,1 coefficients of the spherical harmonics
  116107. */
  116108. l21: Vector3;
  116109. /**
  116110. * The l2,2 coefficients of the spherical harmonics
  116111. */
  116112. l22: Vector3;
  116113. /**
  116114. * Adds a light to the spherical harmonics
  116115. * @param direction the direction of the light
  116116. * @param color the color of the light
  116117. * @param deltaSolidAngle the delta solid angle of the light
  116118. */
  116119. addLight(direction: Vector3, color: Color3, deltaSolidAngle: number): void;
  116120. /**
  116121. * Scales the spherical harmonics by the given amount
  116122. * @param scale the amount to scale
  116123. */
  116124. scaleInPlace(scale: number): void;
  116125. /**
  116126. * Convert from incident radiance (Li) to irradiance (E) by applying convolution with the cosine-weighted hemisphere.
  116127. *
  116128. * ```
  116129. * E_lm = A_l * L_lm
  116130. * ```
  116131. *
  116132. * In spherical harmonics this convolution amounts to scaling factors for each frequency band.
  116133. * This corresponds to equation 5 in "An Efficient Representation for Irradiance Environment Maps", where
  116134. * the scaling factors are given in equation 9.
  116135. */
  116136. convertIncidentRadianceToIrradiance(): void;
  116137. /**
  116138. * Convert from irradiance to outgoing radiance for Lambertian BDRF, suitable for efficient shader evaluation.
  116139. *
  116140. * ```
  116141. * L = (1/pi) * E * rho
  116142. * ```
  116143. *
  116144. * This is done by an additional scale by 1/pi, so is a fairly trivial operation but important conceptually.
  116145. */
  116146. convertIrradianceToLambertianRadiance(): void;
  116147. /**
  116148. * Integrates the reconstruction coefficients directly in to the SH preventing further
  116149. * required operations at run time.
  116150. *
  116151. * This is simply done by scaling back the SH with Ylm constants parameter.
  116152. * The trigonometric part being applied by the shader at run time.
  116153. */
  116154. preScaleForRendering(): void;
  116155. /**
  116156. * Constructs a spherical harmonics from an array.
  116157. * @param data defines the 9x3 coefficients (l00, l1-1, l10, l11, l2-2, l2-1, l20, l21, l22)
  116158. * @returns the spherical harmonics
  116159. */
  116160. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalHarmonics;
  116161. /**
  116162. * Gets the spherical harmonics from polynomial
  116163. * @param polynomial the spherical polynomial
  116164. * @returns the spherical harmonics
  116165. */
  116166. static FromPolynomial(polynomial: SphericalPolynomial): SphericalHarmonics;
  116167. }
  116168. /**
  116169. * Class representing spherical polynomial coefficients to the 3rd degree
  116170. */
  116171. export class SphericalPolynomial {
  116172. private _harmonics;
  116173. /**
  116174. * The spherical harmonics used to create the polynomials.
  116175. */
  116176. get preScaledHarmonics(): SphericalHarmonics;
  116177. /**
  116178. * The x coefficients of the spherical polynomial
  116179. */
  116180. x: Vector3;
  116181. /**
  116182. * The y coefficients of the spherical polynomial
  116183. */
  116184. y: Vector3;
  116185. /**
  116186. * The z coefficients of the spherical polynomial
  116187. */
  116188. z: Vector3;
  116189. /**
  116190. * The xx coefficients of the spherical polynomial
  116191. */
  116192. xx: Vector3;
  116193. /**
  116194. * The yy coefficients of the spherical polynomial
  116195. */
  116196. yy: Vector3;
  116197. /**
  116198. * The zz coefficients of the spherical polynomial
  116199. */
  116200. zz: Vector3;
  116201. /**
  116202. * The xy coefficients of the spherical polynomial
  116203. */
  116204. xy: Vector3;
  116205. /**
  116206. * The yz coefficients of the spherical polynomial
  116207. */
  116208. yz: Vector3;
  116209. /**
  116210. * The zx coefficients of the spherical polynomial
  116211. */
  116212. zx: Vector3;
  116213. /**
  116214. * Adds an ambient color to the spherical polynomial
  116215. * @param color the color to add
  116216. */
  116217. addAmbient(color: Color3): void;
  116218. /**
  116219. * Scales the spherical polynomial by the given amount
  116220. * @param scale the amount to scale
  116221. */
  116222. scaleInPlace(scale: number): void;
  116223. /**
  116224. * Gets the spherical polynomial from harmonics
  116225. * @param harmonics the spherical harmonics
  116226. * @returns the spherical polynomial
  116227. */
  116228. static FromHarmonics(harmonics: SphericalHarmonics): SphericalPolynomial;
  116229. /**
  116230. * Constructs a spherical polynomial from an array.
  116231. * @param data defines the 9x3 coefficients (x, y, z, xx, yy, zz, yz, zx, xy)
  116232. * @returns the spherical polynomial
  116233. */
  116234. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalPolynomial;
  116235. }
  116236. }
  116237. declare module BABYLON {
  116238. /**
  116239. * Defines the source of the internal texture
  116240. */
  116241. export enum InternalTextureSource {
  116242. /**
  116243. * The source of the texture data is unknown
  116244. */
  116245. Unknown = 0,
  116246. /**
  116247. * Texture data comes from an URL
  116248. */
  116249. Url = 1,
  116250. /**
  116251. * Texture data is only used for temporary storage
  116252. */
  116253. Temp = 2,
  116254. /**
  116255. * Texture data comes from raw data (ArrayBuffer)
  116256. */
  116257. Raw = 3,
  116258. /**
  116259. * Texture content is dynamic (video or dynamic texture)
  116260. */
  116261. Dynamic = 4,
  116262. /**
  116263. * Texture content is generated by rendering to it
  116264. */
  116265. RenderTarget = 5,
  116266. /**
  116267. * Texture content is part of a multi render target process
  116268. */
  116269. MultiRenderTarget = 6,
  116270. /**
  116271. * Texture data comes from a cube data file
  116272. */
  116273. Cube = 7,
  116274. /**
  116275. * Texture data comes from a raw cube data
  116276. */
  116277. CubeRaw = 8,
  116278. /**
  116279. * Texture data come from a prefiltered cube data file
  116280. */
  116281. CubePrefiltered = 9,
  116282. /**
  116283. * Texture content is raw 3D data
  116284. */
  116285. Raw3D = 10,
  116286. /**
  116287. * Texture content is raw 2D array data
  116288. */
  116289. Raw2DArray = 11,
  116290. /**
  116291. * Texture content is a depth texture
  116292. */
  116293. Depth = 12,
  116294. /**
  116295. * Texture data comes from a raw cube data encoded with RGBD
  116296. */
  116297. CubeRawRGBD = 13
  116298. }
  116299. /**
  116300. * Class used to store data associated with WebGL texture data for the engine
  116301. * This class should not be used directly
  116302. */
  116303. export class InternalTexture {
  116304. /** @hidden */
  116305. static _UpdateRGBDAsync: (internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number) => Promise<void>;
  116306. /**
  116307. * Defines if the texture is ready
  116308. */
  116309. isReady: boolean;
  116310. /**
  116311. * Defines if the texture is a cube texture
  116312. */
  116313. isCube: boolean;
  116314. /**
  116315. * Defines if the texture contains 3D data
  116316. */
  116317. is3D: boolean;
  116318. /**
  116319. * Defines if the texture contains 2D array data
  116320. */
  116321. is2DArray: boolean;
  116322. /**
  116323. * Defines if the texture contains multiview data
  116324. */
  116325. isMultiview: boolean;
  116326. /**
  116327. * Gets the URL used to load this texture
  116328. */
  116329. url: string;
  116330. /**
  116331. * Gets the sampling mode of the texture
  116332. */
  116333. samplingMode: number;
  116334. /**
  116335. * Gets a boolean indicating if the texture needs mipmaps generation
  116336. */
  116337. generateMipMaps: boolean;
  116338. /**
  116339. * Gets the number of samples used by the texture (WebGL2+ only)
  116340. */
  116341. samples: number;
  116342. /**
  116343. * Gets the type of the texture (int, float...)
  116344. */
  116345. type: number;
  116346. /**
  116347. * Gets the format of the texture (RGB, RGBA...)
  116348. */
  116349. format: number;
  116350. /**
  116351. * Observable called when the texture is loaded
  116352. */
  116353. onLoadedObservable: Observable<InternalTexture>;
  116354. /**
  116355. * Gets the width of the texture
  116356. */
  116357. width: number;
  116358. /**
  116359. * Gets the height of the texture
  116360. */
  116361. height: number;
  116362. /**
  116363. * Gets the depth of the texture
  116364. */
  116365. depth: number;
  116366. /**
  116367. * Gets the initial width of the texture (It could be rescaled if the current system does not support non power of two textures)
  116368. */
  116369. baseWidth: number;
  116370. /**
  116371. * Gets the initial height of the texture (It could be rescaled if the current system does not support non power of two textures)
  116372. */
  116373. baseHeight: number;
  116374. /**
  116375. * Gets the initial depth of the texture (It could be rescaled if the current system does not support non power of two textures)
  116376. */
  116377. baseDepth: number;
  116378. /**
  116379. * Gets a boolean indicating if the texture is inverted on Y axis
  116380. */
  116381. invertY: boolean;
  116382. /** @hidden */
  116383. _invertVScale: boolean;
  116384. /** @hidden */
  116385. _associatedChannel: number;
  116386. /** @hidden */
  116387. _source: InternalTextureSource;
  116388. /** @hidden */
  116389. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  116390. /** @hidden */
  116391. _bufferView: Nullable<ArrayBufferView>;
  116392. /** @hidden */
  116393. _bufferViewArray: Nullable<ArrayBufferView[]>;
  116394. /** @hidden */
  116395. _bufferViewArrayArray: Nullable<ArrayBufferView[][]>;
  116396. /** @hidden */
  116397. _size: number;
  116398. /** @hidden */
  116399. _extension: string;
  116400. /** @hidden */
  116401. _files: Nullable<string[]>;
  116402. /** @hidden */
  116403. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  116404. /** @hidden */
  116405. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  116406. /** @hidden */
  116407. _framebuffer: Nullable<WebGLFramebuffer>;
  116408. /** @hidden */
  116409. _depthStencilBuffer: Nullable<WebGLRenderbuffer>;
  116410. /** @hidden */
  116411. _MSAAFramebuffer: Nullable<WebGLFramebuffer>;
  116412. /** @hidden */
  116413. _MSAARenderBuffer: Nullable<WebGLRenderbuffer>;
  116414. /** @hidden */
  116415. _attachments: Nullable<number[]>;
  116416. /** @hidden */
  116417. _textureArray: Nullable<InternalTexture[]>;
  116418. /** @hidden */
  116419. _cachedCoordinatesMode: Nullable<number>;
  116420. /** @hidden */
  116421. _cachedWrapU: Nullable<number>;
  116422. /** @hidden */
  116423. _cachedWrapV: Nullable<number>;
  116424. /** @hidden */
  116425. _cachedWrapR: Nullable<number>;
  116426. /** @hidden */
  116427. _cachedAnisotropicFilteringLevel: Nullable<number>;
  116428. /** @hidden */
  116429. _isDisabled: boolean;
  116430. /** @hidden */
  116431. _compression: Nullable<string>;
  116432. /** @hidden */
  116433. _generateStencilBuffer: boolean;
  116434. /** @hidden */
  116435. _generateDepthBuffer: boolean;
  116436. /** @hidden */
  116437. _comparisonFunction: number;
  116438. /** @hidden */
  116439. _sphericalPolynomial: Nullable<SphericalPolynomial>;
  116440. /** @hidden */
  116441. _lodGenerationScale: number;
  116442. /** @hidden */
  116443. _lodGenerationOffset: number;
  116444. /** @hidden */
  116445. _depthStencilTexture: Nullable<InternalTexture>;
  116446. /** @hidden */
  116447. _colorTextureArray: Nullable<WebGLTexture>;
  116448. /** @hidden */
  116449. _depthStencilTextureArray: Nullable<WebGLTexture>;
  116450. /** @hidden */
  116451. _lodTextureHigh: Nullable<BaseTexture>;
  116452. /** @hidden */
  116453. _lodTextureMid: Nullable<BaseTexture>;
  116454. /** @hidden */
  116455. _lodTextureLow: Nullable<BaseTexture>;
  116456. /** @hidden */
  116457. _isRGBD: boolean;
  116458. /** @hidden */
  116459. _linearSpecularLOD: boolean;
  116460. /** @hidden */
  116461. _irradianceTexture: Nullable<BaseTexture>;
  116462. /** @hidden */
  116463. _webGLTexture: Nullable<WebGLTexture>;
  116464. /** @hidden */
  116465. _references: number;
  116466. /** @hidden */
  116467. _gammaSpace: Nullable<boolean>;
  116468. private _engine;
  116469. /**
  116470. * Gets the Engine the texture belongs to.
  116471. * @returns The babylon engine
  116472. */
  116473. getEngine(): ThinEngine;
  116474. /**
  116475. * Gets the data source type of the texture
  116476. */
  116477. get source(): InternalTextureSource;
  116478. /**
  116479. * Creates a new InternalTexture
  116480. * @param engine defines the engine to use
  116481. * @param source defines the type of data that will be used
  116482. * @param delayAllocation if the texture allocation should be delayed (default: false)
  116483. */
  116484. constructor(engine: ThinEngine, source: InternalTextureSource, delayAllocation?: boolean);
  116485. /**
  116486. * Increments the number of references (ie. the number of Texture that point to it)
  116487. */
  116488. incrementReferences(): void;
  116489. /**
  116490. * Change the size of the texture (not the size of the content)
  116491. * @param width defines the new width
  116492. * @param height defines the new height
  116493. * @param depth defines the new depth (1 by default)
  116494. */
  116495. updateSize(width: int, height: int, depth?: int): void;
  116496. /** @hidden */
  116497. _rebuild(): void;
  116498. /** @hidden */
  116499. _swapAndDie(target: InternalTexture): void;
  116500. /**
  116501. * Dispose the current allocated resources
  116502. */
  116503. dispose(): void;
  116504. }
  116505. }
  116506. declare module BABYLON {
  116507. /**
  116508. * Class used to work with sound analyzer using fast fourier transform (FFT)
  116509. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  116510. */
  116511. export class Analyser {
  116512. /**
  116513. * Gets or sets the smoothing
  116514. * @ignorenaming
  116515. */
  116516. SMOOTHING: number;
  116517. /**
  116518. * Gets or sets the FFT table size
  116519. * @ignorenaming
  116520. */
  116521. FFT_SIZE: number;
  116522. /**
  116523. * Gets or sets the bar graph amplitude
  116524. * @ignorenaming
  116525. */
  116526. BARGRAPHAMPLITUDE: number;
  116527. /**
  116528. * Gets or sets the position of the debug canvas
  116529. * @ignorenaming
  116530. */
  116531. DEBUGCANVASPOS: {
  116532. x: number;
  116533. y: number;
  116534. };
  116535. /**
  116536. * Gets or sets the debug canvas size
  116537. * @ignorenaming
  116538. */
  116539. DEBUGCANVASSIZE: {
  116540. width: number;
  116541. height: number;
  116542. };
  116543. private _byteFreqs;
  116544. private _byteTime;
  116545. private _floatFreqs;
  116546. private _webAudioAnalyser;
  116547. private _debugCanvas;
  116548. private _debugCanvasContext;
  116549. private _scene;
  116550. private _registerFunc;
  116551. private _audioEngine;
  116552. /**
  116553. * Creates a new analyser
  116554. * @param scene defines hosting scene
  116555. */
  116556. constructor(scene: Scene);
  116557. /**
  116558. * Get the number of data values you will have to play with for the visualization
  116559. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/frequencyBinCount
  116560. * @returns a number
  116561. */
  116562. getFrequencyBinCount(): number;
  116563. /**
  116564. * Gets the current frequency data as a byte array
  116565. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  116566. * @returns a Uint8Array
  116567. */
  116568. getByteFrequencyData(): Uint8Array;
  116569. /**
  116570. * Gets the current waveform as a byte array
  116571. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteTimeDomainData
  116572. * @returns a Uint8Array
  116573. */
  116574. getByteTimeDomainData(): Uint8Array;
  116575. /**
  116576. * Gets the current frequency data as a float array
  116577. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  116578. * @returns a Float32Array
  116579. */
  116580. getFloatFrequencyData(): Float32Array;
  116581. /**
  116582. * Renders the debug canvas
  116583. */
  116584. drawDebugCanvas(): void;
  116585. /**
  116586. * Stops rendering the debug canvas and removes it
  116587. */
  116588. stopDebugCanvas(): void;
  116589. /**
  116590. * Connects two audio nodes
  116591. * @param inputAudioNode defines first node to connect
  116592. * @param outputAudioNode defines second node to connect
  116593. */
  116594. connectAudioNodes(inputAudioNode: AudioNode, outputAudioNode: AudioNode): void;
  116595. /**
  116596. * Releases all associated resources
  116597. */
  116598. dispose(): void;
  116599. }
  116600. }
  116601. declare module BABYLON {
  116602. /**
  116603. * This represents an audio engine and it is responsible
  116604. * to play, synchronize and analyse sounds throughout the application.
  116605. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  116606. */
  116607. export interface IAudioEngine extends IDisposable {
  116608. /**
  116609. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  116610. */
  116611. readonly canUseWebAudio: boolean;
  116612. /**
  116613. * Gets the current AudioContext if available.
  116614. */
  116615. readonly audioContext: Nullable<AudioContext>;
  116616. /**
  116617. * The master gain node defines the global audio volume of your audio engine.
  116618. */
  116619. readonly masterGain: GainNode;
  116620. /**
  116621. * Gets whether or not mp3 are supported by your browser.
  116622. */
  116623. readonly isMP3supported: boolean;
  116624. /**
  116625. * Gets whether or not ogg are supported by your browser.
  116626. */
  116627. readonly isOGGsupported: boolean;
  116628. /**
  116629. * Defines if Babylon should emit a warning if WebAudio is not supported.
  116630. * @ignoreNaming
  116631. */
  116632. WarnedWebAudioUnsupported: boolean;
  116633. /**
  116634. * Defines if the audio engine relies on a custom unlocked button.
  116635. * In this case, the embedded button will not be displayed.
  116636. */
  116637. useCustomUnlockedButton: boolean;
  116638. /**
  116639. * Gets whether or not the audio engine is unlocked (require first a user gesture on some browser).
  116640. */
  116641. readonly unlocked: boolean;
  116642. /**
  116643. * Event raised when audio has been unlocked on the browser.
  116644. */
  116645. onAudioUnlockedObservable: Observable<AudioEngine>;
  116646. /**
  116647. * Event raised when audio has been locked on the browser.
  116648. */
  116649. onAudioLockedObservable: Observable<AudioEngine>;
  116650. /**
  116651. * Flags the audio engine in Locked state.
  116652. * This happens due to new browser policies preventing audio to autoplay.
  116653. */
  116654. lock(): void;
  116655. /**
  116656. * Unlocks the audio engine once a user action has been done on the dom.
  116657. * This is helpful to resume play once browser policies have been satisfied.
  116658. */
  116659. unlock(): void;
  116660. /**
  116661. * Gets the global volume sets on the master gain.
  116662. * @returns the global volume if set or -1 otherwise
  116663. */
  116664. getGlobalVolume(): number;
  116665. /**
  116666. * Sets the global volume of your experience (sets on the master gain).
  116667. * @param newVolume Defines the new global volume of the application
  116668. */
  116669. setGlobalVolume(newVolume: number): void;
  116670. /**
  116671. * Connect the audio engine to an audio analyser allowing some amazing
  116672. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  116673. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  116674. * @param analyser The analyser to connect to the engine
  116675. */
  116676. connectToAnalyser(analyser: Analyser): void;
  116677. }
  116678. /**
  116679. * This represents the default audio engine used in babylon.
  116680. * It is responsible to play, synchronize and analyse sounds throughout the application.
  116681. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  116682. */
  116683. export class AudioEngine implements IAudioEngine {
  116684. private _audioContext;
  116685. private _audioContextInitialized;
  116686. private _muteButton;
  116687. private _hostElement;
  116688. /**
  116689. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  116690. */
  116691. canUseWebAudio: boolean;
  116692. /**
  116693. * The master gain node defines the global audio volume of your audio engine.
  116694. */
  116695. masterGain: GainNode;
  116696. /**
  116697. * Defines if Babylon should emit a warning if WebAudio is not supported.
  116698. * @ignoreNaming
  116699. */
  116700. WarnedWebAudioUnsupported: boolean;
  116701. /**
  116702. * Gets whether or not mp3 are supported by your browser.
  116703. */
  116704. isMP3supported: boolean;
  116705. /**
  116706. * Gets whether or not ogg are supported by your browser.
  116707. */
  116708. isOGGsupported: boolean;
  116709. /**
  116710. * Gets whether audio has been unlocked on the device.
  116711. * Some Browsers have strong restrictions about Audio and won t autoplay unless
  116712. * a user interaction has happened.
  116713. */
  116714. unlocked: boolean;
  116715. /**
  116716. * Defines if the audio engine relies on a custom unlocked button.
  116717. * In this case, the embedded button will not be displayed.
  116718. */
  116719. useCustomUnlockedButton: boolean;
  116720. /**
  116721. * Event raised when audio has been unlocked on the browser.
  116722. */
  116723. onAudioUnlockedObservable: Observable<AudioEngine>;
  116724. /**
  116725. * Event raised when audio has been locked on the browser.
  116726. */
  116727. onAudioLockedObservable: Observable<AudioEngine>;
  116728. /**
  116729. * Gets the current AudioContext if available.
  116730. */
  116731. get audioContext(): Nullable<AudioContext>;
  116732. private _connectedAnalyser;
  116733. /**
  116734. * Instantiates a new audio engine.
  116735. *
  116736. * There should be only one per page as some browsers restrict the number
  116737. * of audio contexts you can create.
  116738. * @param hostElement defines the host element where to display the mute icon if necessary
  116739. */
  116740. constructor(hostElement?: Nullable<HTMLElement>);
  116741. /**
  116742. * Flags the audio engine in Locked state.
  116743. * This happens due to new browser policies preventing audio to autoplay.
  116744. */
  116745. lock(): void;
  116746. /**
  116747. * Unlocks the audio engine once a user action has been done on the dom.
  116748. * This is helpful to resume play once browser policies have been satisfied.
  116749. */
  116750. unlock(): void;
  116751. private _resumeAudioContext;
  116752. private _initializeAudioContext;
  116753. private _tryToRun;
  116754. private _triggerRunningState;
  116755. private _triggerSuspendedState;
  116756. private _displayMuteButton;
  116757. private _moveButtonToTopLeft;
  116758. private _onResize;
  116759. private _hideMuteButton;
  116760. /**
  116761. * Destroy and release the resources associated with the audio ccontext.
  116762. */
  116763. dispose(): void;
  116764. /**
  116765. * Gets the global volume sets on the master gain.
  116766. * @returns the global volume if set or -1 otherwise
  116767. */
  116768. getGlobalVolume(): number;
  116769. /**
  116770. * Sets the global volume of your experience (sets on the master gain).
  116771. * @param newVolume Defines the new global volume of the application
  116772. */
  116773. setGlobalVolume(newVolume: number): void;
  116774. /**
  116775. * Connect the audio engine to an audio analyser allowing some amazing
  116776. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  116777. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  116778. * @param analyser The analyser to connect to the engine
  116779. */
  116780. connectToAnalyser(analyser: Analyser): void;
  116781. }
  116782. }
  116783. declare module BABYLON {
  116784. /**
  116785. * Interface used to present a loading screen while loading a scene
  116786. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  116787. */
  116788. export interface ILoadingScreen {
  116789. /**
  116790. * Function called to display the loading screen
  116791. */
  116792. displayLoadingUI: () => void;
  116793. /**
  116794. * Function called to hide the loading screen
  116795. */
  116796. hideLoadingUI: () => void;
  116797. /**
  116798. * Gets or sets the color to use for the background
  116799. */
  116800. loadingUIBackgroundColor: string;
  116801. /**
  116802. * Gets or sets the text to display while loading
  116803. */
  116804. loadingUIText: string;
  116805. }
  116806. /**
  116807. * Class used for the default loading screen
  116808. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  116809. */
  116810. export class DefaultLoadingScreen implements ILoadingScreen {
  116811. private _renderingCanvas;
  116812. private _loadingText;
  116813. private _loadingDivBackgroundColor;
  116814. private _loadingDiv;
  116815. private _loadingTextDiv;
  116816. /** Gets or sets the logo url to use for the default loading screen */
  116817. static DefaultLogoUrl: string;
  116818. /** Gets or sets the spinner url to use for the default loading screen */
  116819. static DefaultSpinnerUrl: string;
  116820. /**
  116821. * Creates a new default loading screen
  116822. * @param _renderingCanvas defines the canvas used to render the scene
  116823. * @param _loadingText defines the default text to display
  116824. * @param _loadingDivBackgroundColor defines the default background color
  116825. */
  116826. constructor(_renderingCanvas: HTMLCanvasElement, _loadingText?: string, _loadingDivBackgroundColor?: string);
  116827. /**
  116828. * Function called to display the loading screen
  116829. */
  116830. displayLoadingUI(): void;
  116831. /**
  116832. * Function called to hide the loading screen
  116833. */
  116834. hideLoadingUI(): void;
  116835. /**
  116836. * Gets or sets the text to display while loading
  116837. */
  116838. set loadingUIText(text: string);
  116839. get loadingUIText(): string;
  116840. /**
  116841. * Gets or sets the color to use for the background
  116842. */
  116843. get loadingUIBackgroundColor(): string;
  116844. set loadingUIBackgroundColor(color: string);
  116845. private _resizeLoadingUI;
  116846. }
  116847. }
  116848. declare module BABYLON {
  116849. /**
  116850. * Interface for any object that can request an animation frame
  116851. */
  116852. export interface ICustomAnimationFrameRequester {
  116853. /**
  116854. * This function will be called when the render loop is ready. If this is not populated, the engine's renderloop function will be called
  116855. */
  116856. renderFunction?: Function;
  116857. /**
  116858. * Called to request the next frame to render to
  116859. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame
  116860. */
  116861. requestAnimationFrame: Function;
  116862. /**
  116863. * You can pass this value to cancelAnimationFrame() to cancel the refresh callback request
  116864. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame#Return_value
  116865. */
  116866. requestID?: number;
  116867. }
  116868. }
  116869. declare module BABYLON {
  116870. /**
  116871. * Performance monitor tracks rolling average frame-time and frame-time variance over a user defined sliding-window
  116872. */
  116873. export class PerformanceMonitor {
  116874. private _enabled;
  116875. private _rollingFrameTime;
  116876. private _lastFrameTimeMs;
  116877. /**
  116878. * constructor
  116879. * @param frameSampleSize The number of samples required to saturate the sliding window
  116880. */
  116881. constructor(frameSampleSize?: number);
  116882. /**
  116883. * Samples current frame
  116884. * @param timeMs A timestamp in milliseconds of the current frame to compare with other frames
  116885. */
  116886. sampleFrame(timeMs?: number): void;
  116887. /**
  116888. * Returns the average frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  116889. */
  116890. get averageFrameTime(): number;
  116891. /**
  116892. * Returns the variance frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  116893. */
  116894. get averageFrameTimeVariance(): number;
  116895. /**
  116896. * Returns the frame time of the most recent frame
  116897. */
  116898. get instantaneousFrameTime(): number;
  116899. /**
  116900. * Returns the average framerate in frames per second over the sliding window (or the subset of frames sampled so far)
  116901. */
  116902. get averageFPS(): number;
  116903. /**
  116904. * Returns the average framerate in frames per second using the most recent frame time
  116905. */
  116906. get instantaneousFPS(): number;
  116907. /**
  116908. * Returns true if enough samples have been taken to completely fill the sliding window
  116909. */
  116910. get isSaturated(): boolean;
  116911. /**
  116912. * Enables contributions to the sliding window sample set
  116913. */
  116914. enable(): void;
  116915. /**
  116916. * Disables contributions to the sliding window sample set
  116917. * Samples will not be interpolated over the disabled period
  116918. */
  116919. disable(): void;
  116920. /**
  116921. * Returns true if sampling is enabled
  116922. */
  116923. get isEnabled(): boolean;
  116924. /**
  116925. * Resets performance monitor
  116926. */
  116927. reset(): void;
  116928. }
  116929. /**
  116930. * RollingAverage
  116931. *
  116932. * Utility to efficiently compute the rolling average and variance over a sliding window of samples
  116933. */
  116934. export class RollingAverage {
  116935. /**
  116936. * Current average
  116937. */
  116938. average: number;
  116939. /**
  116940. * Current variance
  116941. */
  116942. variance: number;
  116943. protected _samples: Array<number>;
  116944. protected _sampleCount: number;
  116945. protected _pos: number;
  116946. protected _m2: number;
  116947. /**
  116948. * constructor
  116949. * @param length The number of samples required to saturate the sliding window
  116950. */
  116951. constructor(length: number);
  116952. /**
  116953. * Adds a sample to the sample set
  116954. * @param v The sample value
  116955. */
  116956. add(v: number): void;
  116957. /**
  116958. * Returns previously added values or null if outside of history or outside the sliding window domain
  116959. * @param i Index in history. For example, pass 0 for the most recent value and 1 for the value before that
  116960. * @return Value previously recorded with add() or null if outside of range
  116961. */
  116962. history(i: number): number;
  116963. /**
  116964. * Returns true if enough samples have been taken to completely fill the sliding window
  116965. * @return true if sample-set saturated
  116966. */
  116967. isSaturated(): boolean;
  116968. /**
  116969. * Resets the rolling average (equivalent to 0 samples taken so far)
  116970. */
  116971. reset(): void;
  116972. /**
  116973. * Wraps a value around the sample range boundaries
  116974. * @param i Position in sample range, for example if the sample length is 5, and i is -3, then 2 will be returned.
  116975. * @return Wrapped position in sample range
  116976. */
  116977. protected _wrapPosition(i: number): number;
  116978. }
  116979. }
  116980. declare module BABYLON {
  116981. /**
  116982. * This class is used to track a performance counter which is number based.
  116983. * The user has access to many properties which give statistics of different nature.
  116984. *
  116985. * The implementer can track two kinds of Performance Counter: time and count.
  116986. * 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.
  116987. * 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.
  116988. */
  116989. export class PerfCounter {
  116990. /**
  116991. * Gets or sets a global boolean to turn on and off all the counters
  116992. */
  116993. static Enabled: boolean;
  116994. /**
  116995. * Returns the smallest value ever
  116996. */
  116997. get min(): number;
  116998. /**
  116999. * Returns the biggest value ever
  117000. */
  117001. get max(): number;
  117002. /**
  117003. * Returns the average value since the performance counter is running
  117004. */
  117005. get average(): number;
  117006. /**
  117007. * Returns the average value of the last second the counter was monitored
  117008. */
  117009. get lastSecAverage(): number;
  117010. /**
  117011. * Returns the current value
  117012. */
  117013. get current(): number;
  117014. /**
  117015. * Gets the accumulated total
  117016. */
  117017. get total(): number;
  117018. /**
  117019. * Gets the total value count
  117020. */
  117021. get count(): number;
  117022. /**
  117023. * Creates a new counter
  117024. */
  117025. constructor();
  117026. /**
  117027. * Call this method to start monitoring a new frame.
  117028. * 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.
  117029. */
  117030. fetchNewFrame(): void;
  117031. /**
  117032. * Call this method to monitor a count of something (e.g. mesh drawn in viewport count)
  117033. * @param newCount the count value to add to the monitored count
  117034. * @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.
  117035. */
  117036. addCount(newCount: number, fetchResult: boolean): void;
  117037. /**
  117038. * Start monitoring this performance counter
  117039. */
  117040. beginMonitoring(): void;
  117041. /**
  117042. * Compute the time lapsed since the previous beginMonitoring() call.
  117043. * @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
  117044. */
  117045. endMonitoring(newFrame?: boolean): void;
  117046. private _fetchResult;
  117047. private _startMonitoringTime;
  117048. private _min;
  117049. private _max;
  117050. private _average;
  117051. private _current;
  117052. private _totalValueCount;
  117053. private _totalAccumulated;
  117054. private _lastSecAverage;
  117055. private _lastSecAccumulated;
  117056. private _lastSecTime;
  117057. private _lastSecValueCount;
  117058. }
  117059. }
  117060. declare module BABYLON {
  117061. interface ThinEngine {
  117062. /** @hidden */
  117063. _readTexturePixels(texture: InternalTexture, width: number, height: number, faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): ArrayBufferView;
  117064. }
  117065. }
  117066. declare module BABYLON {
  117067. /**
  117068. * Defines the interface used by display changed events
  117069. */
  117070. export interface IDisplayChangedEventArgs {
  117071. /** Gets the vrDisplay object (if any) */
  117072. vrDisplay: Nullable<any>;
  117073. /** Gets a boolean indicating if webVR is supported */
  117074. vrSupported: boolean;
  117075. }
  117076. /**
  117077. * Defines the interface used by objects containing a viewport (like a camera)
  117078. */
  117079. interface IViewportOwnerLike {
  117080. /**
  117081. * Gets or sets the viewport
  117082. */
  117083. viewport: IViewportLike;
  117084. }
  117085. /**
  117086. * The engine class is responsible for interfacing with all lower-level APIs such as WebGL and Audio
  117087. */
  117088. export class Engine extends ThinEngine {
  117089. /** Defines that alpha blending is disabled */
  117090. static readonly ALPHA_DISABLE: number;
  117091. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  117092. static readonly ALPHA_ADD: number;
  117093. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  117094. static readonly ALPHA_COMBINE: number;
  117095. /** Defines that alpha blending to DEST - SRC * DEST */
  117096. static readonly ALPHA_SUBTRACT: number;
  117097. /** Defines that alpha blending to SRC * DEST */
  117098. static readonly ALPHA_MULTIPLY: number;
  117099. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  117100. static readonly ALPHA_MAXIMIZED: number;
  117101. /** Defines that alpha blending to SRC + DEST */
  117102. static readonly ALPHA_ONEONE: number;
  117103. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  117104. static readonly ALPHA_PREMULTIPLIED: number;
  117105. /**
  117106. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  117107. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  117108. */
  117109. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  117110. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  117111. static readonly ALPHA_INTERPOLATE: number;
  117112. /**
  117113. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  117114. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  117115. */
  117116. static readonly ALPHA_SCREENMODE: number;
  117117. /** Defines that the ressource is not delayed*/
  117118. static readonly DELAYLOADSTATE_NONE: number;
  117119. /** Defines that the ressource was successfully delay loaded */
  117120. static readonly DELAYLOADSTATE_LOADED: number;
  117121. /** Defines that the ressource is currently delay loading */
  117122. static readonly DELAYLOADSTATE_LOADING: number;
  117123. /** Defines that the ressource is delayed and has not started loading */
  117124. static readonly DELAYLOADSTATE_NOTLOADED: number;
  117125. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  117126. static readonly NEVER: number;
  117127. /** 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 */
  117128. static readonly ALWAYS: number;
  117129. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  117130. static readonly LESS: number;
  117131. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  117132. static readonly EQUAL: number;
  117133. /** 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 */
  117134. static readonly LEQUAL: number;
  117135. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  117136. static readonly GREATER: number;
  117137. /** 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 */
  117138. static readonly GEQUAL: number;
  117139. /** 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 */
  117140. static readonly NOTEQUAL: number;
  117141. /** Passed to stencilOperation to specify that stencil value must be kept */
  117142. static readonly KEEP: number;
  117143. /** Passed to stencilOperation to specify that stencil value must be replaced */
  117144. static readonly REPLACE: number;
  117145. /** Passed to stencilOperation to specify that stencil value must be incremented */
  117146. static readonly INCR: number;
  117147. /** Passed to stencilOperation to specify that stencil value must be decremented */
  117148. static readonly DECR: number;
  117149. /** Passed to stencilOperation to specify that stencil value must be inverted */
  117150. static readonly INVERT: number;
  117151. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  117152. static readonly INCR_WRAP: number;
  117153. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  117154. static readonly DECR_WRAP: number;
  117155. /** Texture is not repeating outside of 0..1 UVs */
  117156. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  117157. /** Texture is repeating outside of 0..1 UVs */
  117158. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  117159. /** Texture is repeating and mirrored */
  117160. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  117161. /** ALPHA */
  117162. static readonly TEXTUREFORMAT_ALPHA: number;
  117163. /** LUMINANCE */
  117164. static readonly TEXTUREFORMAT_LUMINANCE: number;
  117165. /** LUMINANCE_ALPHA */
  117166. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  117167. /** RGB */
  117168. static readonly TEXTUREFORMAT_RGB: number;
  117169. /** RGBA */
  117170. static readonly TEXTUREFORMAT_RGBA: number;
  117171. /** RED */
  117172. static readonly TEXTUREFORMAT_RED: number;
  117173. /** RED (2nd reference) */
  117174. static readonly TEXTUREFORMAT_R: number;
  117175. /** RG */
  117176. static readonly TEXTUREFORMAT_RG: number;
  117177. /** RED_INTEGER */
  117178. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  117179. /** RED_INTEGER (2nd reference) */
  117180. static readonly TEXTUREFORMAT_R_INTEGER: number;
  117181. /** RG_INTEGER */
  117182. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  117183. /** RGB_INTEGER */
  117184. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  117185. /** RGBA_INTEGER */
  117186. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  117187. /** UNSIGNED_BYTE */
  117188. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  117189. /** UNSIGNED_BYTE (2nd reference) */
  117190. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  117191. /** FLOAT */
  117192. static readonly TEXTURETYPE_FLOAT: number;
  117193. /** HALF_FLOAT */
  117194. static readonly TEXTURETYPE_HALF_FLOAT: number;
  117195. /** BYTE */
  117196. static readonly TEXTURETYPE_BYTE: number;
  117197. /** SHORT */
  117198. static readonly TEXTURETYPE_SHORT: number;
  117199. /** UNSIGNED_SHORT */
  117200. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  117201. /** INT */
  117202. static readonly TEXTURETYPE_INT: number;
  117203. /** UNSIGNED_INT */
  117204. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  117205. /** UNSIGNED_SHORT_4_4_4_4 */
  117206. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  117207. /** UNSIGNED_SHORT_5_5_5_1 */
  117208. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  117209. /** UNSIGNED_SHORT_5_6_5 */
  117210. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  117211. /** UNSIGNED_INT_2_10_10_10_REV */
  117212. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  117213. /** UNSIGNED_INT_24_8 */
  117214. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  117215. /** UNSIGNED_INT_10F_11F_11F_REV */
  117216. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  117217. /** UNSIGNED_INT_5_9_9_9_REV */
  117218. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  117219. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  117220. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  117221. /** nearest is mag = nearest and min = nearest and mip = linear */
  117222. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  117223. /** Bilinear is mag = linear and min = linear and mip = nearest */
  117224. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  117225. /** Trilinear is mag = linear and min = linear and mip = linear */
  117226. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  117227. /** nearest is mag = nearest and min = nearest and mip = linear */
  117228. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  117229. /** Bilinear is mag = linear and min = linear and mip = nearest */
  117230. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  117231. /** Trilinear is mag = linear and min = linear and mip = linear */
  117232. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  117233. /** mag = nearest and min = nearest and mip = nearest */
  117234. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  117235. /** mag = nearest and min = linear and mip = nearest */
  117236. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  117237. /** mag = nearest and min = linear and mip = linear */
  117238. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  117239. /** mag = nearest and min = linear and mip = none */
  117240. static readonly TEXTURE_NEAREST_LINEAR: number;
  117241. /** mag = nearest and min = nearest and mip = none */
  117242. static readonly TEXTURE_NEAREST_NEAREST: number;
  117243. /** mag = linear and min = nearest and mip = nearest */
  117244. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  117245. /** mag = linear and min = nearest and mip = linear */
  117246. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  117247. /** mag = linear and min = linear and mip = none */
  117248. static readonly TEXTURE_LINEAR_LINEAR: number;
  117249. /** mag = linear and min = nearest and mip = none */
  117250. static readonly TEXTURE_LINEAR_NEAREST: number;
  117251. /** Explicit coordinates mode */
  117252. static readonly TEXTURE_EXPLICIT_MODE: number;
  117253. /** Spherical coordinates mode */
  117254. static readonly TEXTURE_SPHERICAL_MODE: number;
  117255. /** Planar coordinates mode */
  117256. static readonly TEXTURE_PLANAR_MODE: number;
  117257. /** Cubic coordinates mode */
  117258. static readonly TEXTURE_CUBIC_MODE: number;
  117259. /** Projection coordinates mode */
  117260. static readonly TEXTURE_PROJECTION_MODE: number;
  117261. /** Skybox coordinates mode */
  117262. static readonly TEXTURE_SKYBOX_MODE: number;
  117263. /** Inverse Cubic coordinates mode */
  117264. static readonly TEXTURE_INVCUBIC_MODE: number;
  117265. /** Equirectangular coordinates mode */
  117266. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  117267. /** Equirectangular Fixed coordinates mode */
  117268. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  117269. /** Equirectangular Fixed Mirrored coordinates mode */
  117270. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  117271. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  117272. static readonly SCALEMODE_FLOOR: number;
  117273. /** Defines that texture rescaling will look for the nearest power of 2 size */
  117274. static readonly SCALEMODE_NEAREST: number;
  117275. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  117276. static readonly SCALEMODE_CEILING: number;
  117277. /**
  117278. * Returns the current npm package of the sdk
  117279. */
  117280. static get NpmPackage(): string;
  117281. /**
  117282. * Returns the current version of the framework
  117283. */
  117284. static get Version(): string;
  117285. /** Gets the list of created engines */
  117286. static get Instances(): Engine[];
  117287. /**
  117288. * Gets the latest created engine
  117289. */
  117290. static get LastCreatedEngine(): Nullable<Engine>;
  117291. /**
  117292. * Gets the latest created scene
  117293. */
  117294. static get LastCreatedScene(): Nullable<Scene>;
  117295. /**
  117296. * Will flag all materials in all scenes in all engines as dirty to trigger new shader compilation
  117297. * @param flag defines which part of the materials must be marked as dirty
  117298. * @param predicate defines a predicate used to filter which materials should be affected
  117299. */
  117300. static MarkAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  117301. /**
  117302. * Method called to create the default loading screen.
  117303. * This can be overriden in your own app.
  117304. * @param canvas The rendering canvas element
  117305. * @returns The loading screen
  117306. */
  117307. static DefaultLoadingScreenFactory(canvas: HTMLCanvasElement): ILoadingScreen;
  117308. /**
  117309. * Method called to create the default rescale post process on each engine.
  117310. */
  117311. static _RescalePostProcessFactory: Nullable<(engine: Engine) => PostProcess>;
  117312. /**
  117313. * Gets or sets a boolean to enable/disable IndexedDB support and avoid XHR on .manifest
  117314. **/
  117315. enableOfflineSupport: boolean;
  117316. /**
  117317. * 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)
  117318. **/
  117319. disableManifestCheck: boolean;
  117320. /**
  117321. * Gets the list of created scenes
  117322. */
  117323. scenes: Scene[];
  117324. /**
  117325. * Event raised when a new scene is created
  117326. */
  117327. onNewSceneAddedObservable: Observable<Scene>;
  117328. /**
  117329. * Gets the list of created postprocesses
  117330. */
  117331. postProcesses: PostProcess[];
  117332. /**
  117333. * Gets a boolean indicating if the pointer is currently locked
  117334. */
  117335. isPointerLock: boolean;
  117336. /**
  117337. * Observable event triggered each time the rendering canvas is resized
  117338. */
  117339. onResizeObservable: Observable<Engine>;
  117340. /**
  117341. * Observable event triggered each time the canvas loses focus
  117342. */
  117343. onCanvasBlurObservable: Observable<Engine>;
  117344. /**
  117345. * Observable event triggered each time the canvas gains focus
  117346. */
  117347. onCanvasFocusObservable: Observable<Engine>;
  117348. /**
  117349. * Observable event triggered each time the canvas receives pointerout event
  117350. */
  117351. onCanvasPointerOutObservable: Observable<PointerEvent>;
  117352. /**
  117353. * Observable raised when the engine begins a new frame
  117354. */
  117355. onBeginFrameObservable: Observable<Engine>;
  117356. /**
  117357. * If set, will be used to request the next animation frame for the render loop
  117358. */
  117359. customAnimationFrameRequester: Nullable<ICustomAnimationFrameRequester>;
  117360. /**
  117361. * Observable raised when the engine ends the current frame
  117362. */
  117363. onEndFrameObservable: Observable<Engine>;
  117364. /**
  117365. * Observable raised when the engine is about to compile a shader
  117366. */
  117367. onBeforeShaderCompilationObservable: Observable<Engine>;
  117368. /**
  117369. * Observable raised when the engine has jsut compiled a shader
  117370. */
  117371. onAfterShaderCompilationObservable: Observable<Engine>;
  117372. /**
  117373. * Gets the audio engine
  117374. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  117375. * @ignorenaming
  117376. */
  117377. static audioEngine: IAudioEngine;
  117378. /**
  117379. * Default AudioEngine factory responsible of creating the Audio Engine.
  117380. * By default, this will create a BabylonJS Audio Engine if the workload has been embedded.
  117381. */
  117382. static AudioEngineFactory: (hostElement: Nullable<HTMLElement>) => IAudioEngine;
  117383. /**
  117384. * Default offline support factory responsible of creating a tool used to store data locally.
  117385. * By default, this will create a Database object if the workload has been embedded.
  117386. */
  117387. static OfflineProviderFactory: (urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck: boolean) => IOfflineProvider;
  117388. private _loadingScreen;
  117389. private _pointerLockRequested;
  117390. private _rescalePostProcess;
  117391. private _deterministicLockstep;
  117392. private _lockstepMaxSteps;
  117393. private _timeStep;
  117394. protected get _supportsHardwareTextureRescaling(): boolean;
  117395. private _fps;
  117396. private _deltaTime;
  117397. /** @hidden */
  117398. _drawCalls: PerfCounter;
  117399. /** 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 */
  117400. canvasTabIndex: number;
  117401. /**
  117402. * Turn this value on if you want to pause FPS computation when in background
  117403. */
  117404. disablePerformanceMonitorInBackground: boolean;
  117405. private _performanceMonitor;
  117406. /**
  117407. * Gets the performance monitor attached to this engine
  117408. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  117409. */
  117410. get performanceMonitor(): PerformanceMonitor;
  117411. private _onFocus;
  117412. private _onBlur;
  117413. private _onCanvasPointerOut;
  117414. private _onCanvasBlur;
  117415. private _onCanvasFocus;
  117416. private _onFullscreenChange;
  117417. private _onPointerLockChange;
  117418. /**
  117419. * Gets the HTML element used to attach event listeners
  117420. * @returns a HTML element
  117421. */
  117422. getInputElement(): Nullable<HTMLElement>;
  117423. /**
  117424. * Creates a new engine
  117425. * @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
  117426. * @param antialias defines enable antialiasing (default: false)
  117427. * @param options defines further options to be sent to the getContext() function
  117428. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  117429. */
  117430. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  117431. /**
  117432. * Gets current aspect ratio
  117433. * @param viewportOwner defines the camera to use to get the aspect ratio
  117434. * @param useScreen defines if screen size must be used (or the current render target if any)
  117435. * @returns a number defining the aspect ratio
  117436. */
  117437. getAspectRatio(viewportOwner: IViewportOwnerLike, useScreen?: boolean): number;
  117438. /**
  117439. * Gets current screen aspect ratio
  117440. * @returns a number defining the aspect ratio
  117441. */
  117442. getScreenAspectRatio(): number;
  117443. /**
  117444. * Gets the client rect of the HTML canvas attached with the current webGL context
  117445. * @returns a client rectanglee
  117446. */
  117447. getRenderingCanvasClientRect(): Nullable<ClientRect>;
  117448. /**
  117449. * Gets the client rect of the HTML element used for events
  117450. * @returns a client rectanglee
  117451. */
  117452. getInputElementClientRect(): Nullable<ClientRect>;
  117453. /**
  117454. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  117455. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  117456. * @returns true if engine is in deterministic lock step mode
  117457. */
  117458. isDeterministicLockStep(): boolean;
  117459. /**
  117460. * Gets the max steps when engine is running in deterministic lock step
  117461. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  117462. * @returns the max steps
  117463. */
  117464. getLockstepMaxSteps(): number;
  117465. /**
  117466. * Returns the time in ms between steps when using deterministic lock step.
  117467. * @returns time step in (ms)
  117468. */
  117469. getTimeStep(): number;
  117470. /**
  117471. * Force the mipmap generation for the given render target texture
  117472. * @param texture defines the render target texture to use
  117473. * @param unbind defines whether or not to unbind the texture after generation. Defaults to true.
  117474. */
  117475. generateMipMapsForCubemap(texture: InternalTexture, unbind?: boolean): void;
  117476. /** States */
  117477. /**
  117478. * Set various states to the webGL context
  117479. * @param culling defines backface culling state
  117480. * @param zOffset defines the value to apply to zOffset (0 by default)
  117481. * @param force defines if states must be applied even if cache is up to date
  117482. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  117483. */
  117484. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  117485. /**
  117486. * Set the z offset to apply to current rendering
  117487. * @param value defines the offset to apply
  117488. */
  117489. setZOffset(value: number): void;
  117490. /**
  117491. * Gets the current value of the zOffset
  117492. * @returns the current zOffset state
  117493. */
  117494. getZOffset(): number;
  117495. /**
  117496. * Enable or disable depth buffering
  117497. * @param enable defines the state to set
  117498. */
  117499. setDepthBuffer(enable: boolean): void;
  117500. /**
  117501. * Gets a boolean indicating if depth writing is enabled
  117502. * @returns the current depth writing state
  117503. */
  117504. getDepthWrite(): boolean;
  117505. /**
  117506. * Enable or disable depth writing
  117507. * @param enable defines the state to set
  117508. */
  117509. setDepthWrite(enable: boolean): void;
  117510. /**
  117511. * Gets a boolean indicating if stencil buffer is enabled
  117512. * @returns the current stencil buffer state
  117513. */
  117514. getStencilBuffer(): boolean;
  117515. /**
  117516. * Enable or disable the stencil buffer
  117517. * @param enable defines if the stencil buffer must be enabled or disabled
  117518. */
  117519. setStencilBuffer(enable: boolean): void;
  117520. /**
  117521. * Gets the current stencil mask
  117522. * @returns a number defining the new stencil mask to use
  117523. */
  117524. getStencilMask(): number;
  117525. /**
  117526. * Sets the current stencil mask
  117527. * @param mask defines the new stencil mask to use
  117528. */
  117529. setStencilMask(mask: number): void;
  117530. /**
  117531. * Gets the current stencil function
  117532. * @returns a number defining the stencil function to use
  117533. */
  117534. getStencilFunction(): number;
  117535. /**
  117536. * Gets the current stencil reference value
  117537. * @returns a number defining the stencil reference value to use
  117538. */
  117539. getStencilFunctionReference(): number;
  117540. /**
  117541. * Gets the current stencil mask
  117542. * @returns a number defining the stencil mask to use
  117543. */
  117544. getStencilFunctionMask(): number;
  117545. /**
  117546. * Sets the current stencil function
  117547. * @param stencilFunc defines the new stencil function to use
  117548. */
  117549. setStencilFunction(stencilFunc: number): void;
  117550. /**
  117551. * Sets the current stencil reference
  117552. * @param reference defines the new stencil reference to use
  117553. */
  117554. setStencilFunctionReference(reference: number): void;
  117555. /**
  117556. * Sets the current stencil mask
  117557. * @param mask defines the new stencil mask to use
  117558. */
  117559. setStencilFunctionMask(mask: number): void;
  117560. /**
  117561. * Gets the current stencil operation when stencil fails
  117562. * @returns a number defining stencil operation to use when stencil fails
  117563. */
  117564. getStencilOperationFail(): number;
  117565. /**
  117566. * Gets the current stencil operation when depth fails
  117567. * @returns a number defining stencil operation to use when depth fails
  117568. */
  117569. getStencilOperationDepthFail(): number;
  117570. /**
  117571. * Gets the current stencil operation when stencil passes
  117572. * @returns a number defining stencil operation to use when stencil passes
  117573. */
  117574. getStencilOperationPass(): number;
  117575. /**
  117576. * Sets the stencil operation to use when stencil fails
  117577. * @param operation defines the stencil operation to use when stencil fails
  117578. */
  117579. setStencilOperationFail(operation: number): void;
  117580. /**
  117581. * Sets the stencil operation to use when depth fails
  117582. * @param operation defines the stencil operation to use when depth fails
  117583. */
  117584. setStencilOperationDepthFail(operation: number): void;
  117585. /**
  117586. * Sets the stencil operation to use when stencil passes
  117587. * @param operation defines the stencil operation to use when stencil passes
  117588. */
  117589. setStencilOperationPass(operation: number): void;
  117590. /**
  117591. * Sets a boolean indicating if the dithering state is enabled or disabled
  117592. * @param value defines the dithering state
  117593. */
  117594. setDitheringState(value: boolean): void;
  117595. /**
  117596. * Sets a boolean indicating if the rasterizer state is enabled or disabled
  117597. * @param value defines the rasterizer state
  117598. */
  117599. setRasterizerState(value: boolean): void;
  117600. /**
  117601. * Gets the current depth function
  117602. * @returns a number defining the depth function
  117603. */
  117604. getDepthFunction(): Nullable<number>;
  117605. /**
  117606. * Sets the current depth function
  117607. * @param depthFunc defines the function to use
  117608. */
  117609. setDepthFunction(depthFunc: number): void;
  117610. /**
  117611. * Sets the current depth function to GREATER
  117612. */
  117613. setDepthFunctionToGreater(): void;
  117614. /**
  117615. * Sets the current depth function to GEQUAL
  117616. */
  117617. setDepthFunctionToGreaterOrEqual(): void;
  117618. /**
  117619. * Sets the current depth function to LESS
  117620. */
  117621. setDepthFunctionToLess(): void;
  117622. /**
  117623. * Sets the current depth function to LEQUAL
  117624. */
  117625. setDepthFunctionToLessOrEqual(): void;
  117626. private _cachedStencilBuffer;
  117627. private _cachedStencilFunction;
  117628. private _cachedStencilMask;
  117629. private _cachedStencilOperationPass;
  117630. private _cachedStencilOperationFail;
  117631. private _cachedStencilOperationDepthFail;
  117632. private _cachedStencilReference;
  117633. /**
  117634. * Caches the the state of the stencil buffer
  117635. */
  117636. cacheStencilState(): void;
  117637. /**
  117638. * Restores the state of the stencil buffer
  117639. */
  117640. restoreStencilState(): void;
  117641. /**
  117642. * Directly set the WebGL Viewport
  117643. * @param x defines the x coordinate of the viewport (in screen space)
  117644. * @param y defines the y coordinate of the viewport (in screen space)
  117645. * @param width defines the width of the viewport (in screen space)
  117646. * @param height defines the height of the viewport (in screen space)
  117647. * @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
  117648. */
  117649. setDirectViewport(x: number, y: number, width: number, height: number): Nullable<IViewportLike>;
  117650. /**
  117651. * Executes a scissor clear (ie. a clear on a specific portion of the screen)
  117652. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  117653. * @param y defines the y-coordinate of the corner of the clear rectangle
  117654. * @param width defines the width of the clear rectangle
  117655. * @param height defines the height of the clear rectangle
  117656. * @param clearColor defines the clear color
  117657. */
  117658. scissorClear(x: number, y: number, width: number, height: number, clearColor: IColor4Like): void;
  117659. /**
  117660. * Enable scissor test on a specific rectangle (ie. render will only be executed on a specific portion of the screen)
  117661. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  117662. * @param y defines the y-coordinate of the corner of the clear rectangle
  117663. * @param width defines the width of the clear rectangle
  117664. * @param height defines the height of the clear rectangle
  117665. */
  117666. enableScissor(x: number, y: number, width: number, height: number): void;
  117667. /**
  117668. * Disable previously set scissor test rectangle
  117669. */
  117670. disableScissor(): void;
  117671. protected _reportDrawCall(): void;
  117672. /**
  117673. * Initializes a webVR display and starts listening to display change events
  117674. * The onVRDisplayChangedObservable will be notified upon these changes
  117675. * @returns The onVRDisplayChangedObservable
  117676. */
  117677. initWebVR(): Observable<IDisplayChangedEventArgs>;
  117678. /** @hidden */
  117679. _prepareVRComponent(): void;
  117680. /** @hidden */
  117681. _connectVREvents(canvas?: HTMLCanvasElement, document?: any): void;
  117682. /** @hidden */
  117683. _submitVRFrame(): void;
  117684. /**
  117685. * Call this function to leave webVR mode
  117686. * Will do nothing if webVR is not supported or if there is no webVR device
  117687. * @see https://doc.babylonjs.com/how_to/webvr_camera
  117688. */
  117689. disableVR(): void;
  117690. /**
  117691. * Gets a boolean indicating that the system is in VR mode and is presenting
  117692. * @returns true if VR mode is engaged
  117693. */
  117694. isVRPresenting(): boolean;
  117695. /** @hidden */
  117696. _requestVRFrame(): void;
  117697. /** @hidden */
  117698. _loadFileAsync(url: string, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  117699. /**
  117700. * Gets the source code of the vertex shader associated with a specific webGL program
  117701. * @param program defines the program to use
  117702. * @returns a string containing the source code of the vertex shader associated with the program
  117703. */
  117704. getVertexShaderSource(program: WebGLProgram): Nullable<string>;
  117705. /**
  117706. * Gets the source code of the fragment shader associated with a specific webGL program
  117707. * @param program defines the program to use
  117708. * @returns a string containing the source code of the fragment shader associated with the program
  117709. */
  117710. getFragmentShaderSource(program: WebGLProgram): Nullable<string>;
  117711. /**
  117712. * Sets a depth stencil texture from a render target to the according uniform.
  117713. * @param channel The texture channel
  117714. * @param uniform The uniform to set
  117715. * @param texture The render target texture containing the depth stencil texture to apply
  117716. */
  117717. setDepthStencilTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<RenderTargetTexture>): void;
  117718. /**
  117719. * Sets a texture to the webGL context from a postprocess
  117720. * @param channel defines the channel to use
  117721. * @param postProcess defines the source postprocess
  117722. */
  117723. setTextureFromPostProcess(channel: number, postProcess: Nullable<PostProcess>): void;
  117724. /**
  117725. * Binds the output of the passed in post process to the texture channel specified
  117726. * @param channel The channel the texture should be bound to
  117727. * @param postProcess The post process which's output should be bound
  117728. */
  117729. setTextureFromPostProcessOutput(channel: number, postProcess: Nullable<PostProcess>): void;
  117730. protected _rebuildBuffers(): void;
  117731. /** @hidden */
  117732. _renderFrame(): void;
  117733. _renderLoop(): void;
  117734. /** @hidden */
  117735. _renderViews(): boolean;
  117736. /**
  117737. * Toggle full screen mode
  117738. * @param requestPointerLock defines if a pointer lock should be requested from the user
  117739. */
  117740. switchFullscreen(requestPointerLock: boolean): void;
  117741. /**
  117742. * Enters full screen mode
  117743. * @param requestPointerLock defines if a pointer lock should be requested from the user
  117744. */
  117745. enterFullscreen(requestPointerLock: boolean): void;
  117746. /**
  117747. * Exits full screen mode
  117748. */
  117749. exitFullscreen(): void;
  117750. /**
  117751. * Enters Pointerlock mode
  117752. */
  117753. enterPointerlock(): void;
  117754. /**
  117755. * Exits Pointerlock mode
  117756. */
  117757. exitPointerlock(): void;
  117758. /**
  117759. * Begin a new frame
  117760. */
  117761. beginFrame(): void;
  117762. /**
  117763. * Enf the current frame
  117764. */
  117765. endFrame(): void;
  117766. resize(): void;
  117767. /**
  117768. * Force a specific size of the canvas
  117769. * @param width defines the new canvas' width
  117770. * @param height defines the new canvas' height
  117771. * @returns true if the size was changed
  117772. */
  117773. setSize(width: number, height: number): boolean;
  117774. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  117775. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  117776. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  117777. _releaseTexture(texture: InternalTexture): void;
  117778. /**
  117779. * @hidden
  117780. * Rescales a texture
  117781. * @param source input texutre
  117782. * @param destination destination texture
  117783. * @param scene scene to use to render the resize
  117784. * @param internalFormat format to use when resizing
  117785. * @param onComplete callback to be called when resize has completed
  117786. */
  117787. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  117788. /**
  117789. * Gets the current framerate
  117790. * @returns a number representing the framerate
  117791. */
  117792. getFps(): number;
  117793. /**
  117794. * Gets the time spent between current and previous frame
  117795. * @returns a number representing the delta time in ms
  117796. */
  117797. getDeltaTime(): number;
  117798. private _measureFps;
  117799. /** @hidden */
  117800. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement | ImageBitmap, faceIndex?: number, lod?: number): void;
  117801. /**
  117802. * Updates the sample count of a render target texture
  117803. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  117804. * @param texture defines the texture to update
  117805. * @param samples defines the sample count to set
  117806. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  117807. */
  117808. updateRenderTargetTextureSampleCount(texture: Nullable<InternalTexture>, samples: number): number;
  117809. /**
  117810. * Updates a depth texture Comparison Mode and Function.
  117811. * If the comparison Function is equal to 0, the mode will be set to none.
  117812. * Otherwise, this only works in webgl 2 and requires a shadow sampler in the shader.
  117813. * @param texture The texture to set the comparison function for
  117814. * @param comparisonFunction The comparison function to set, 0 if no comparison required
  117815. */
  117816. updateTextureComparisonFunction(texture: InternalTexture, comparisonFunction: number): void;
  117817. /**
  117818. * Creates a webGL buffer to use with instanciation
  117819. * @param capacity defines the size of the buffer
  117820. * @returns the webGL buffer
  117821. */
  117822. createInstancesBuffer(capacity: number): DataBuffer;
  117823. /**
  117824. * Delete a webGL buffer used with instanciation
  117825. * @param buffer defines the webGL buffer to delete
  117826. */
  117827. deleteInstancesBuffer(buffer: WebGLBuffer): void;
  117828. private _clientWaitAsync;
  117829. /** @hidden */
  117830. _readPixelsAsync(x: number, y: number, w: number, h: number, format: number, type: number, outputBuffer: ArrayBufferView): Promise<ArrayBufferView> | null;
  117831. dispose(): void;
  117832. private _disableTouchAction;
  117833. /**
  117834. * Display the loading screen
  117835. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117836. */
  117837. displayLoadingUI(): void;
  117838. /**
  117839. * Hide the loading screen
  117840. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117841. */
  117842. hideLoadingUI(): void;
  117843. /**
  117844. * Gets the current loading screen object
  117845. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117846. */
  117847. get loadingScreen(): ILoadingScreen;
  117848. /**
  117849. * Sets the current loading screen object
  117850. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117851. */
  117852. set loadingScreen(loadingScreen: ILoadingScreen);
  117853. /**
  117854. * Sets the current loading screen text
  117855. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117856. */
  117857. set loadingUIText(text: string);
  117858. /**
  117859. * Sets the current loading screen background color
  117860. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117861. */
  117862. set loadingUIBackgroundColor(color: string);
  117863. /** Pointerlock and fullscreen */
  117864. /**
  117865. * Ask the browser to promote the current element to pointerlock mode
  117866. * @param element defines the DOM element to promote
  117867. */
  117868. static _RequestPointerlock(element: HTMLElement): void;
  117869. /**
  117870. * Asks the browser to exit pointerlock mode
  117871. */
  117872. static _ExitPointerlock(): void;
  117873. /**
  117874. * Ask the browser to promote the current element to fullscreen rendering mode
  117875. * @param element defines the DOM element to promote
  117876. */
  117877. static _RequestFullscreen(element: HTMLElement): void;
  117878. /**
  117879. * Asks the browser to exit fullscreen mode
  117880. */
  117881. static _ExitFullscreen(): void;
  117882. }
  117883. }
  117884. declare module BABYLON {
  117885. /**
  117886. * The engine store class is responsible to hold all the instances of Engine and Scene created
  117887. * during the life time of the application.
  117888. */
  117889. export class EngineStore {
  117890. /** Gets the list of created engines */
  117891. static Instances: Engine[];
  117892. /** @hidden */
  117893. static _LastCreatedScene: Nullable<Scene>;
  117894. /**
  117895. * Gets the latest created engine
  117896. */
  117897. static get LastCreatedEngine(): Nullable<Engine>;
  117898. /**
  117899. * Gets the latest created scene
  117900. */
  117901. static get LastCreatedScene(): Nullable<Scene>;
  117902. /**
  117903. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  117904. * @ignorenaming
  117905. */
  117906. static UseFallbackTexture: boolean;
  117907. /**
  117908. * Texture content used if a texture cannot loaded
  117909. * @ignorenaming
  117910. */
  117911. static FallbackTexture: string;
  117912. }
  117913. }
  117914. declare module BABYLON {
  117915. /**
  117916. * Helper class that provides a small promise polyfill
  117917. */
  117918. export class PromisePolyfill {
  117919. /**
  117920. * Static function used to check if the polyfill is required
  117921. * If this is the case then the function will inject the polyfill to window.Promise
  117922. * @param force defines a boolean used to force the injection (mostly for testing purposes)
  117923. */
  117924. static Apply(force?: boolean): void;
  117925. }
  117926. }
  117927. declare module BABYLON {
  117928. /**
  117929. * Interface for screenshot methods with describe argument called `size` as object with options
  117930. * @link https://doc.babylonjs.com/api/classes/babylon.screenshottools
  117931. */
  117932. export interface IScreenshotSize {
  117933. /**
  117934. * number in pixels for canvas height
  117935. */
  117936. height?: number;
  117937. /**
  117938. * multiplier allowing render at a higher or lower resolution
  117939. * If value is defined then height and width will be ignored and taken from camera
  117940. */
  117941. precision?: number;
  117942. /**
  117943. * number in pixels for canvas width
  117944. */
  117945. width?: number;
  117946. }
  117947. }
  117948. declare module BABYLON {
  117949. interface IColor4Like {
  117950. r: float;
  117951. g: float;
  117952. b: float;
  117953. a: float;
  117954. }
  117955. /**
  117956. * Class containing a set of static utilities functions
  117957. */
  117958. export class Tools {
  117959. /**
  117960. * Gets or sets the base URL to use to load assets
  117961. */
  117962. static get BaseUrl(): string;
  117963. static set BaseUrl(value: string);
  117964. /**
  117965. * Enable/Disable Custom HTTP Request Headers globally.
  117966. * default = false
  117967. * @see CustomRequestHeaders
  117968. */
  117969. static UseCustomRequestHeaders: boolean;
  117970. /**
  117971. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  117972. * i.e. when loading files, where the server/service expects an Authorization header
  117973. */
  117974. static CustomRequestHeaders: {
  117975. [key: string]: string;
  117976. };
  117977. /**
  117978. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  117979. */
  117980. static get DefaultRetryStrategy(): (url: string, request: WebRequest, retryIndex: number) => number;
  117981. static set DefaultRetryStrategy(strategy: (url: string, request: WebRequest, retryIndex: number) => number);
  117982. /**
  117983. * Default behaviour for cors in the application.
  117984. * It can be a string if the expected behavior is identical in the entire app.
  117985. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  117986. */
  117987. static get CorsBehavior(): string | ((url: string | string[]) => string);
  117988. static set CorsBehavior(value: string | ((url: string | string[]) => string));
  117989. /**
  117990. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  117991. * @ignorenaming
  117992. */
  117993. static get UseFallbackTexture(): boolean;
  117994. static set UseFallbackTexture(value: boolean);
  117995. /**
  117996. * Use this object to register external classes like custom textures or material
  117997. * to allow the laoders to instantiate them
  117998. */
  117999. static get RegisteredExternalClasses(): {
  118000. [key: string]: Object;
  118001. };
  118002. static set RegisteredExternalClasses(classes: {
  118003. [key: string]: Object;
  118004. });
  118005. /**
  118006. * Texture content used if a texture cannot loaded
  118007. * @ignorenaming
  118008. */
  118009. static get fallbackTexture(): string;
  118010. static set fallbackTexture(value: string);
  118011. /**
  118012. * Read the content of a byte array at a specified coordinates (taking in account wrapping)
  118013. * @param u defines the coordinate on X axis
  118014. * @param v defines the coordinate on Y axis
  118015. * @param width defines the width of the source data
  118016. * @param height defines the height of the source data
  118017. * @param pixels defines the source byte array
  118018. * @param color defines the output color
  118019. */
  118020. static FetchToRef(u: number, v: number, width: number, height: number, pixels: Uint8Array, color: IColor4Like): void;
  118021. /**
  118022. * Interpolates between a and b via alpha
  118023. * @param a The lower value (returned when alpha = 0)
  118024. * @param b The upper value (returned when alpha = 1)
  118025. * @param alpha The interpolation-factor
  118026. * @return The mixed value
  118027. */
  118028. static Mix(a: number, b: number, alpha: number): number;
  118029. /**
  118030. * Tries to instantiate a new object from a given class name
  118031. * @param className defines the class name to instantiate
  118032. * @returns the new object or null if the system was not able to do the instantiation
  118033. */
  118034. static Instantiate(className: string): any;
  118035. /**
  118036. * Provides a slice function that will work even on IE
  118037. * @param data defines the array to slice
  118038. * @param start defines the start of the data (optional)
  118039. * @param end defines the end of the data (optional)
  118040. * @returns the new sliced array
  118041. */
  118042. static Slice<T>(data: T, start?: number, end?: number): T;
  118043. /**
  118044. * Polyfill for setImmediate
  118045. * @param action defines the action to execute after the current execution block
  118046. */
  118047. static SetImmediate(action: () => void): void;
  118048. /**
  118049. * Function indicating if a number is an exponent of 2
  118050. * @param value defines the value to test
  118051. * @returns true if the value is an exponent of 2
  118052. */
  118053. static IsExponentOfTwo(value: number): boolean;
  118054. private static _tmpFloatArray;
  118055. /**
  118056. * Returns the nearest 32-bit single precision float representation of a Number
  118057. * @param value A Number. If the parameter is of a different type, it will get converted
  118058. * to a number or to NaN if it cannot be converted
  118059. * @returns number
  118060. */
  118061. static FloatRound(value: number): number;
  118062. /**
  118063. * Extracts the filename from a path
  118064. * @param path defines the path to use
  118065. * @returns the filename
  118066. */
  118067. static GetFilename(path: string): string;
  118068. /**
  118069. * Extracts the "folder" part of a path (everything before the filename).
  118070. * @param uri The URI to extract the info from
  118071. * @param returnUnchangedIfNoSlash Do not touch the URI if no slashes are present
  118072. * @returns The "folder" part of the path
  118073. */
  118074. static GetFolderPath(uri: string, returnUnchangedIfNoSlash?: boolean): string;
  118075. /**
  118076. * Extracts text content from a DOM element hierarchy
  118077. * Back Compat only, please use DomManagement.GetDOMTextContent instead.
  118078. */
  118079. static GetDOMTextContent: typeof DomManagement.GetDOMTextContent;
  118080. /**
  118081. * Convert an angle in radians to degrees
  118082. * @param angle defines the angle to convert
  118083. * @returns the angle in degrees
  118084. */
  118085. static ToDegrees(angle: number): number;
  118086. /**
  118087. * Convert an angle in degrees to radians
  118088. * @param angle defines the angle to convert
  118089. * @returns the angle in radians
  118090. */
  118091. static ToRadians(angle: number): number;
  118092. /**
  118093. * Returns an array if obj is not an array
  118094. * @param obj defines the object to evaluate as an array
  118095. * @param allowsNullUndefined defines a boolean indicating if obj is allowed to be null or undefined
  118096. * @returns either obj directly if obj is an array or a new array containing obj
  118097. */
  118098. static MakeArray(obj: any, allowsNullUndefined?: boolean): Nullable<Array<any>>;
  118099. /**
  118100. * Gets the pointer prefix to use
  118101. * @param engine defines the engine we are finding the prefix for
  118102. * @returns "pointer" if touch is enabled. Else returns "mouse"
  118103. */
  118104. static GetPointerPrefix(engine: Engine): string;
  118105. /**
  118106. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  118107. * @param url define the url we are trying
  118108. * @param element define the dom element where to configure the cors policy
  118109. */
  118110. static SetCorsBehavior(url: string | string[], element: {
  118111. crossOrigin: string | null;
  118112. }): void;
  118113. /**
  118114. * Removes unwanted characters from an url
  118115. * @param url defines the url to clean
  118116. * @returns the cleaned url
  118117. */
  118118. static CleanUrl(url: string): string;
  118119. /**
  118120. * Gets or sets a function used to pre-process url before using them to load assets
  118121. */
  118122. static get PreprocessUrl(): (url: string) => string;
  118123. static set PreprocessUrl(processor: (url: string) => string);
  118124. /**
  118125. * Loads an image as an HTMLImageElement.
  118126. * @param input url string, ArrayBuffer, or Blob to load
  118127. * @param onLoad callback called when the image successfully loads
  118128. * @param onError callback called when the image fails to load
  118129. * @param offlineProvider offline provider for caching
  118130. * @param mimeType optional mime type
  118131. * @returns the HTMLImageElement of the loaded image
  118132. */
  118133. static LoadImage(input: string | ArrayBuffer | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  118134. /**
  118135. * Loads a file from a url
  118136. * @param url url string, ArrayBuffer, or Blob to load
  118137. * @param onSuccess callback called when the file successfully loads
  118138. * @param onProgress callback called while file is loading (if the server supports this mode)
  118139. * @param offlineProvider defines the offline provider for caching
  118140. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  118141. * @param onError callback called when the file fails to load
  118142. * @returns a file request object
  118143. */
  118144. 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;
  118145. /**
  118146. * Loads a file from a url
  118147. * @param url the file url to load
  118148. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  118149. * @returns a promise containing an ArrayBuffer corresponding to the loaded file
  118150. */
  118151. static LoadFileAsync(url: string, useArrayBuffer?: boolean): Promise<ArrayBuffer | string>;
  118152. /**
  118153. * Load a script (identified by an url). When the url returns, the
  118154. * content of this file is added into a new script element, attached to the DOM (body element)
  118155. * @param scriptUrl defines the url of the script to laod
  118156. * @param onSuccess defines the callback called when the script is loaded
  118157. * @param onError defines the callback to call if an error occurs
  118158. * @param scriptId defines the id of the script element
  118159. */
  118160. static LoadScript(scriptUrl: string, onSuccess: () => void, onError?: (message?: string, exception?: any) => void, scriptId?: string): void;
  118161. /**
  118162. * Load an asynchronous script (identified by an url). When the url returns, the
  118163. * content of this file is added into a new script element, attached to the DOM (body element)
  118164. * @param scriptUrl defines the url of the script to laod
  118165. * @param scriptId defines the id of the script element
  118166. * @returns a promise request object
  118167. */
  118168. static LoadScriptAsync(scriptUrl: string, scriptId?: string): Promise<void>;
  118169. /**
  118170. * Loads a file from a blob
  118171. * @param fileToLoad defines the blob to use
  118172. * @param callback defines the callback to call when data is loaded
  118173. * @param progressCallback defines the callback to call during loading process
  118174. * @returns a file request object
  118175. */
  118176. static ReadFileAsDataURL(fileToLoad: Blob, callback: (data: any) => void, progressCallback: (ev: ProgressEvent) => any): IFileRequest;
  118177. /**
  118178. * Reads a file from a File object
  118179. * @param file defines the file to load
  118180. * @param onSuccess defines the callback to call when data is loaded
  118181. * @param onProgress defines the callback to call during loading process
  118182. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  118183. * @param onError defines the callback to call when an error occurs
  118184. * @returns a file request object
  118185. */
  118186. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  118187. /**
  118188. * Creates a data url from a given string content
  118189. * @param content defines the content to convert
  118190. * @returns the new data url link
  118191. */
  118192. static FileAsURL(content: string): string;
  118193. /**
  118194. * Format the given number to a specific decimal format
  118195. * @param value defines the number to format
  118196. * @param decimals defines the number of decimals to use
  118197. * @returns the formatted string
  118198. */
  118199. static Format(value: number, decimals?: number): string;
  118200. /**
  118201. * Tries to copy an object by duplicating every property
  118202. * @param source defines the source object
  118203. * @param destination defines the target object
  118204. * @param doNotCopyList defines a list of properties to avoid
  118205. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  118206. */
  118207. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  118208. /**
  118209. * Gets a boolean indicating if the given object has no own property
  118210. * @param obj defines the object to test
  118211. * @returns true if object has no own property
  118212. */
  118213. static IsEmpty(obj: any): boolean;
  118214. /**
  118215. * Function used to register events at window level
  118216. * @param windowElement defines the Window object to use
  118217. * @param events defines the events to register
  118218. */
  118219. static RegisterTopRootEvents(windowElement: Window, events: {
  118220. name: string;
  118221. handler: Nullable<(e: FocusEvent) => any>;
  118222. }[]): void;
  118223. /**
  118224. * Function used to unregister events from window level
  118225. * @param windowElement defines the Window object to use
  118226. * @param events defines the events to unregister
  118227. */
  118228. static UnregisterTopRootEvents(windowElement: Window, events: {
  118229. name: string;
  118230. handler: Nullable<(e: FocusEvent) => any>;
  118231. }[]): void;
  118232. /**
  118233. * @ignore
  118234. */
  118235. static _ScreenshotCanvas: HTMLCanvasElement;
  118236. /**
  118237. * Dumps the current bound framebuffer
  118238. * @param width defines the rendering width
  118239. * @param height defines the rendering height
  118240. * @param engine defines the hosting engine
  118241. * @param successCallback defines the callback triggered once the data are available
  118242. * @param mimeType defines the mime type of the result
  118243. * @param fileName defines the filename to download. If present, the result will automatically be downloaded
  118244. */
  118245. static DumpFramebuffer(width: number, height: number, engine: Engine, successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  118246. /**
  118247. * Converts the canvas data to blob.
  118248. * This acts as a polyfill for browsers not supporting the to blob function.
  118249. * @param canvas Defines the canvas to extract the data from
  118250. * @param successCallback Defines the callback triggered once the data are available
  118251. * @param mimeType Defines the mime type of the result
  118252. */
  118253. static ToBlob(canvas: HTMLCanvasElement, successCallback: (blob: Nullable<Blob>) => void, mimeType?: string): void;
  118254. /**
  118255. * Encodes the canvas data to base 64 or automatically download the result if filename is defined
  118256. * @param successCallback defines the callback triggered once the data are available
  118257. * @param mimeType defines the mime type of the result
  118258. * @param fileName defines he filename to download. If present, the result will automatically be downloaded
  118259. */
  118260. static EncodeScreenshotCanvasData(successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  118261. /**
  118262. * Downloads a blob in the browser
  118263. * @param blob defines the blob to download
  118264. * @param fileName defines the name of the downloaded file
  118265. */
  118266. static Download(blob: Blob, fileName: string): void;
  118267. /**
  118268. * Captures a screenshot of the current rendering
  118269. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  118270. * @param engine defines the rendering engine
  118271. * @param camera defines the source camera
  118272. * @param size This parameter can be set to a single number or to an object with the
  118273. * following (optional) properties: precision, width, height. If a single number is passed,
  118274. * it will be used for both width and height. If an object is passed, the screenshot size
  118275. * will be derived from the parameters. The precision property is a multiplier allowing
  118276. * rendering at a higher or lower resolution
  118277. * @param successCallback defines the callback receives a single parameter which contains the
  118278. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  118279. * src parameter of an <img> to display it
  118280. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  118281. * Check your browser for supported MIME types
  118282. */
  118283. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  118284. /**
  118285. * Captures a screenshot of the current rendering
  118286. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  118287. * @param engine defines the rendering engine
  118288. * @param camera defines the source camera
  118289. * @param size This parameter can be set to a single number or to an object with the
  118290. * following (optional) properties: precision, width, height. If a single number is passed,
  118291. * it will be used for both width and height. If an object is passed, the screenshot size
  118292. * will be derived from the parameters. The precision property is a multiplier allowing
  118293. * rendering at a higher or lower resolution
  118294. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  118295. * Check your browser for supported MIME types
  118296. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  118297. * to the src parameter of an <img> to display it
  118298. */
  118299. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string): Promise<string>;
  118300. /**
  118301. * Generates an image screenshot from the specified camera.
  118302. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  118303. * @param engine The engine to use for rendering
  118304. * @param camera The camera to use for rendering
  118305. * @param size This parameter can be set to a single number or to an object with the
  118306. * following (optional) properties: precision, width, height. If a single number is passed,
  118307. * it will be used for both width and height. If an object is passed, the screenshot size
  118308. * will be derived from the parameters. The precision property is a multiplier allowing
  118309. * rendering at a higher or lower resolution
  118310. * @param successCallback The callback receives a single parameter which contains the
  118311. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  118312. * src parameter of an <img> to display it
  118313. * @param mimeType The MIME type of the screenshot image (default: image/png).
  118314. * Check your browser for supported MIME types
  118315. * @param samples Texture samples (default: 1)
  118316. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  118317. * @param fileName A name for for the downloaded file.
  118318. */
  118319. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  118320. /**
  118321. * Generates an image screenshot from the specified camera.
  118322. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  118323. * @param engine The engine to use for rendering
  118324. * @param camera The camera to use for rendering
  118325. * @param size This parameter can be set to a single number or to an object with the
  118326. * following (optional) properties: precision, width, height. If a single number is passed,
  118327. * it will be used for both width and height. If an object is passed, the screenshot size
  118328. * will be derived from the parameters. The precision property is a multiplier allowing
  118329. * rendering at a higher or lower resolution
  118330. * @param mimeType The MIME type of the screenshot image (default: image/png).
  118331. * Check your browser for supported MIME types
  118332. * @param samples Texture samples (default: 1)
  118333. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  118334. * @param fileName A name for for the downloaded file.
  118335. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  118336. * to the src parameter of an <img> to display it
  118337. */
  118338. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  118339. /**
  118340. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  118341. * Be aware Math.random() could cause collisions, but:
  118342. * "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"
  118343. * @returns a pseudo random id
  118344. */
  118345. static RandomId(): string;
  118346. /**
  118347. * Test if the given uri is a base64 string
  118348. * @param uri The uri to test
  118349. * @return True if the uri is a base64 string or false otherwise
  118350. */
  118351. static IsBase64(uri: string): boolean;
  118352. /**
  118353. * Decode the given base64 uri.
  118354. * @param uri The uri to decode
  118355. * @return The decoded base64 data.
  118356. */
  118357. static DecodeBase64(uri: string): ArrayBuffer;
  118358. /**
  118359. * Gets the absolute url.
  118360. * @param url the input url
  118361. * @return the absolute url
  118362. */
  118363. static GetAbsoluteUrl(url: string): string;
  118364. /**
  118365. * No log
  118366. */
  118367. static readonly NoneLogLevel: number;
  118368. /**
  118369. * Only message logs
  118370. */
  118371. static readonly MessageLogLevel: number;
  118372. /**
  118373. * Only warning logs
  118374. */
  118375. static readonly WarningLogLevel: number;
  118376. /**
  118377. * Only error logs
  118378. */
  118379. static readonly ErrorLogLevel: number;
  118380. /**
  118381. * All logs
  118382. */
  118383. static readonly AllLogLevel: number;
  118384. /**
  118385. * Gets a value indicating the number of loading errors
  118386. * @ignorenaming
  118387. */
  118388. static get errorsCount(): number;
  118389. /**
  118390. * Callback called when a new log is added
  118391. */
  118392. static OnNewCacheEntry: (entry: string) => void;
  118393. /**
  118394. * Log a message to the console
  118395. * @param message defines the message to log
  118396. */
  118397. static Log(message: string): void;
  118398. /**
  118399. * Write a warning message to the console
  118400. * @param message defines the message to log
  118401. */
  118402. static Warn(message: string): void;
  118403. /**
  118404. * Write an error message to the console
  118405. * @param message defines the message to log
  118406. */
  118407. static Error(message: string): void;
  118408. /**
  118409. * Gets current log cache (list of logs)
  118410. */
  118411. static get LogCache(): string;
  118412. /**
  118413. * Clears the log cache
  118414. */
  118415. static ClearLogCache(): void;
  118416. /**
  118417. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  118418. */
  118419. static set LogLevels(level: number);
  118420. /**
  118421. * Checks if the window object exists
  118422. * Back Compat only, please use DomManagement.IsWindowObjectExist instead.
  118423. */
  118424. static IsWindowObjectExist: typeof DomManagement.IsWindowObjectExist;
  118425. /**
  118426. * No performance log
  118427. */
  118428. static readonly PerformanceNoneLogLevel: number;
  118429. /**
  118430. * Use user marks to log performance
  118431. */
  118432. static readonly PerformanceUserMarkLogLevel: number;
  118433. /**
  118434. * Log performance to the console
  118435. */
  118436. static readonly PerformanceConsoleLogLevel: number;
  118437. private static _performance;
  118438. /**
  118439. * Sets the current performance log level
  118440. */
  118441. static set PerformanceLogLevel(level: number);
  118442. private static _StartPerformanceCounterDisabled;
  118443. private static _EndPerformanceCounterDisabled;
  118444. private static _StartUserMark;
  118445. private static _EndUserMark;
  118446. private static _StartPerformanceConsole;
  118447. private static _EndPerformanceConsole;
  118448. /**
  118449. * Starts a performance counter
  118450. */
  118451. static StartPerformanceCounter: (counterName: string, condition?: boolean) => void;
  118452. /**
  118453. * Ends a specific performance coutner
  118454. */
  118455. static EndPerformanceCounter: (counterName: string, condition?: boolean) => void;
  118456. /**
  118457. * Gets either window.performance.now() if supported or Date.now() else
  118458. */
  118459. static get Now(): number;
  118460. /**
  118461. * This method will return the name of the class used to create the instance of the given object.
  118462. * It will works only on Javascript basic data types (number, string, ...) and instance of class declared with the @className decorator.
  118463. * @param object the object to get the class name from
  118464. * @param isType defines if the object is actually a type
  118465. * @returns the name of the class, will be "object" for a custom data type not using the @className decorator
  118466. */
  118467. static GetClassName(object: any, isType?: boolean): string;
  118468. /**
  118469. * Gets the first element of an array satisfying a given predicate
  118470. * @param array defines the array to browse
  118471. * @param predicate defines the predicate to use
  118472. * @returns null if not found or the element
  118473. */
  118474. static First<T>(array: Array<T>, predicate: (item: T) => boolean): Nullable<T>;
  118475. /**
  118476. * This method will return the name of the full name of the class, including its owning module (if any).
  118477. * 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).
  118478. * @param object the object to get the class name from
  118479. * @param isType defines if the object is actually a type
  118480. * @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.
  118481. * @ignorenaming
  118482. */
  118483. static getFullClassName(object: any, isType?: boolean): Nullable<string>;
  118484. /**
  118485. * Returns a promise that resolves after the given amount of time.
  118486. * @param delay Number of milliseconds to delay
  118487. * @returns Promise that resolves after the given amount of time
  118488. */
  118489. static DelayAsync(delay: number): Promise<void>;
  118490. /**
  118491. * Utility function to detect if the current user agent is Safari
  118492. * @returns whether or not the current user agent is safari
  118493. */
  118494. static IsSafari(): boolean;
  118495. }
  118496. /**
  118497. * Use this className as a decorator on a given class definition to add it a name and optionally its module.
  118498. * You can then use the Tools.getClassName(obj) on an instance to retrieve its class name.
  118499. * This method is the only way to get it done in all cases, even if the .js file declaring the class is minified
  118500. * @param name The name of the class, case should be preserved
  118501. * @param module The name of the Module hosting the class, optional, but strongly recommended to specify if possible. Case should be preserved.
  118502. */
  118503. export function className(name: string, module?: string): (target: Object) => void;
  118504. /**
  118505. * An implementation of a loop for asynchronous functions.
  118506. */
  118507. export class AsyncLoop {
  118508. /**
  118509. * Defines the number of iterations for the loop
  118510. */
  118511. iterations: number;
  118512. /**
  118513. * Defines the current index of the loop.
  118514. */
  118515. index: number;
  118516. private _done;
  118517. private _fn;
  118518. private _successCallback;
  118519. /**
  118520. * Constructor.
  118521. * @param iterations the number of iterations.
  118522. * @param func the function to run each iteration
  118523. * @param successCallback the callback that will be called upon succesful execution
  118524. * @param offset starting offset.
  118525. */
  118526. constructor(
  118527. /**
  118528. * Defines the number of iterations for the loop
  118529. */
  118530. iterations: number, func: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number);
  118531. /**
  118532. * Execute the next iteration. Must be called after the last iteration was finished.
  118533. */
  118534. executeNext(): void;
  118535. /**
  118536. * Break the loop and run the success callback.
  118537. */
  118538. breakLoop(): void;
  118539. /**
  118540. * Create and run an async loop.
  118541. * @param iterations the number of iterations.
  118542. * @param fn the function to run each iteration
  118543. * @param successCallback the callback that will be called upon succesful execution
  118544. * @param offset starting offset.
  118545. * @returns the created async loop object
  118546. */
  118547. static Run(iterations: number, fn: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number): AsyncLoop;
  118548. /**
  118549. * A for-loop that will run a given number of iterations synchronous and the rest async.
  118550. * @param iterations total number of iterations
  118551. * @param syncedIterations number of synchronous iterations in each async iteration.
  118552. * @param fn the function to call each iteration.
  118553. * @param callback a success call back that will be called when iterating stops.
  118554. * @param breakFunction a break condition (optional)
  118555. * @param timeout timeout settings for the setTimeout function. default - 0.
  118556. * @returns the created async loop object
  118557. */
  118558. static SyncAsyncForLoop(iterations: number, syncedIterations: number, fn: (iteration: number) => void, callback: () => void, breakFunction?: () => boolean, timeout?: number): AsyncLoop;
  118559. }
  118560. }
  118561. declare module BABYLON {
  118562. /**
  118563. * This class implement a typical dictionary using a string as key and the generic type T as value.
  118564. * The underlying implementation relies on an associative array to ensure the best performances.
  118565. * The value can be anything including 'null' but except 'undefined'
  118566. */
  118567. export class StringDictionary<T> {
  118568. /**
  118569. * This will clear this dictionary and copy the content from the 'source' one.
  118570. * If the T value is a custom object, it won't be copied/cloned, the same object will be used
  118571. * @param source the dictionary to take the content from and copy to this dictionary
  118572. */
  118573. copyFrom(source: StringDictionary<T>): void;
  118574. /**
  118575. * Get a value based from its key
  118576. * @param key the given key to get the matching value from
  118577. * @return the value if found, otherwise undefined is returned
  118578. */
  118579. get(key: string): T | undefined;
  118580. /**
  118581. * Get a value from its key or add it if it doesn't exist.
  118582. * This method will ensure you that a given key/data will be present in the dictionary.
  118583. * @param key the given key to get the matching value from
  118584. * @param factory the factory that will create the value if the key is not present in the dictionary.
  118585. * The factory will only be invoked if there's no data for the given key.
  118586. * @return the value corresponding to the key.
  118587. */
  118588. getOrAddWithFactory(key: string, factory: (key: string) => T): T;
  118589. /**
  118590. * Get a value from its key if present in the dictionary otherwise add it
  118591. * @param key the key to get the value from
  118592. * @param val if there's no such key/value pair in the dictionary add it with this value
  118593. * @return the value corresponding to the key
  118594. */
  118595. getOrAdd(key: string, val: T): T;
  118596. /**
  118597. * Check if there's a given key in the dictionary
  118598. * @param key the key to check for
  118599. * @return true if the key is present, false otherwise
  118600. */
  118601. contains(key: string): boolean;
  118602. /**
  118603. * Add a new key and its corresponding value
  118604. * @param key the key to add
  118605. * @param value the value corresponding to the key
  118606. * @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
  118607. */
  118608. add(key: string, value: T): boolean;
  118609. /**
  118610. * Update a specific value associated to a key
  118611. * @param key defines the key to use
  118612. * @param value defines the value to store
  118613. * @returns true if the value was updated (or false if the key was not found)
  118614. */
  118615. set(key: string, value: T): boolean;
  118616. /**
  118617. * Get the element of the given key and remove it from the dictionary
  118618. * @param key defines the key to search
  118619. * @returns the value associated with the key or null if not found
  118620. */
  118621. getAndRemove(key: string): Nullable<T>;
  118622. /**
  118623. * Remove a key/value from the dictionary.
  118624. * @param key the key to remove
  118625. * @return true if the item was successfully deleted, false if no item with such key exist in the dictionary
  118626. */
  118627. remove(key: string): boolean;
  118628. /**
  118629. * Clear the whole content of the dictionary
  118630. */
  118631. clear(): void;
  118632. /**
  118633. * Gets the current count
  118634. */
  118635. get count(): number;
  118636. /**
  118637. * Execute a callback on each key/val of the dictionary.
  118638. * Note that you can remove any element in this dictionary in the callback implementation
  118639. * @param callback the callback to execute on a given key/value pair
  118640. */
  118641. forEach(callback: (key: string, val: T) => void): void;
  118642. /**
  118643. * Execute a callback on every occurrence of the dictionary until it returns a valid TRes object.
  118644. * If the callback returns null or undefined the method will iterate to the next key/value pair
  118645. * Note that you can remove any element in this dictionary in the callback implementation
  118646. * @param callback the callback to execute, if it return a valid T instanced object the enumeration will stop and the object will be returned
  118647. * @returns the first item
  118648. */
  118649. first<TRes>(callback: (key: string, val: T) => TRes): TRes | null;
  118650. private _count;
  118651. private _data;
  118652. }
  118653. }
  118654. declare module BABYLON {
  118655. /** @hidden */
  118656. export interface ICollisionCoordinator {
  118657. createCollider(): Collider;
  118658. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: Nullable<AbstractMesh>, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  118659. init(scene: Scene): void;
  118660. }
  118661. /** @hidden */
  118662. export class DefaultCollisionCoordinator implements ICollisionCoordinator {
  118663. private _scene;
  118664. private _scaledPosition;
  118665. private _scaledVelocity;
  118666. private _finalPosition;
  118667. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: AbstractMesh, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  118668. createCollider(): Collider;
  118669. init(scene: Scene): void;
  118670. private _collideWithWorld;
  118671. }
  118672. }
  118673. declare module BABYLON {
  118674. /**
  118675. * Class used to manage all inputs for the scene.
  118676. */
  118677. export class InputManager {
  118678. /** The distance in pixel that you have to move to prevent some events */
  118679. static DragMovementThreshold: number;
  118680. /** Time in milliseconds to wait to raise long press events if button is still pressed */
  118681. static LongPressDelay: number;
  118682. /** Time in milliseconds with two consecutive clicks will be considered as a double click */
  118683. static DoubleClickDelay: number;
  118684. /** If you need to check double click without raising a single click at first click, enable this flag */
  118685. static ExclusiveDoubleClickMode: boolean;
  118686. /** 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. */
  118687. private _alreadyAttached;
  118688. private _wheelEventName;
  118689. private _onPointerMove;
  118690. private _onPointerDown;
  118691. private _onPointerUp;
  118692. private _initClickEvent;
  118693. private _initActionManager;
  118694. private _delayedSimpleClick;
  118695. private _delayedSimpleClickTimeout;
  118696. private _previousDelayedSimpleClickTimeout;
  118697. private _meshPickProceed;
  118698. private _previousButtonPressed;
  118699. private _currentPickResult;
  118700. private _previousPickResult;
  118701. private _totalPointersPressed;
  118702. private _doubleClickOccured;
  118703. private _pointerOverMesh;
  118704. private _pickedDownMesh;
  118705. private _pickedUpMesh;
  118706. private _pointerX;
  118707. private _pointerY;
  118708. private _unTranslatedPointerX;
  118709. private _unTranslatedPointerY;
  118710. private _startingPointerPosition;
  118711. private _previousStartingPointerPosition;
  118712. private _startingPointerTime;
  118713. private _previousStartingPointerTime;
  118714. private _pointerCaptures;
  118715. private _meshUnderPointerId;
  118716. private _onKeyDown;
  118717. private _onKeyUp;
  118718. private _onCanvasFocusObserver;
  118719. private _onCanvasBlurObserver;
  118720. private _scene;
  118721. /**
  118722. * Creates a new InputManager
  118723. * @param scene defines the hosting scene
  118724. */
  118725. constructor(scene: Scene);
  118726. /**
  118727. * Gets the mesh that is currently under the pointer
  118728. */
  118729. get meshUnderPointer(): Nullable<AbstractMesh>;
  118730. /**
  118731. * When using more than one pointer (for example in XR) you can get the mesh under the specific pointer
  118732. * @param pointerId the pointer id to use
  118733. * @returns The mesh under this pointer id or null if not found
  118734. */
  118735. getMeshUnderPointerByPointerId(pointerId: number): Nullable<AbstractMesh>;
  118736. /**
  118737. * Gets the pointer coordinates in 2D without any translation (ie. straight out of the pointer event)
  118738. */
  118739. get unTranslatedPointer(): Vector2;
  118740. /**
  118741. * Gets or sets the current on-screen X position of the pointer
  118742. */
  118743. get pointerX(): number;
  118744. set pointerX(value: number);
  118745. /**
  118746. * Gets or sets the current on-screen Y position of the pointer
  118747. */
  118748. get pointerY(): number;
  118749. set pointerY(value: number);
  118750. private _updatePointerPosition;
  118751. private _processPointerMove;
  118752. private _setRayOnPointerInfo;
  118753. private _checkPrePointerObservable;
  118754. /**
  118755. * Use this method to simulate a pointer move on a mesh
  118756. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  118757. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  118758. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  118759. */
  118760. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  118761. /**
  118762. * Use this method to simulate a pointer down on a mesh
  118763. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  118764. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  118765. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  118766. */
  118767. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  118768. private _processPointerDown;
  118769. /** @hidden */
  118770. _isPointerSwiping(): boolean;
  118771. /**
  118772. * Use this method to simulate a pointer up on a mesh
  118773. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  118774. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  118775. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  118776. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  118777. */
  118778. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): void;
  118779. private _processPointerUp;
  118780. /**
  118781. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  118782. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  118783. * @returns true if the pointer was captured
  118784. */
  118785. isPointerCaptured(pointerId?: number): boolean;
  118786. /**
  118787. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  118788. * @param attachUp defines if you want to attach events to pointerup
  118789. * @param attachDown defines if you want to attach events to pointerdown
  118790. * @param attachMove defines if you want to attach events to pointermove
  118791. * @param elementToAttachTo defines the target DOM element to attach to (will use the canvas by default)
  118792. */
  118793. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean, elementToAttachTo?: Nullable<HTMLElement>): void;
  118794. /**
  118795. * Detaches all event handlers
  118796. */
  118797. detachControl(): void;
  118798. /**
  118799. * Force the value of meshUnderPointer
  118800. * @param mesh defines the mesh to use
  118801. * @param pointerId optional pointer id when using more than one pointer. Defaults to 0
  118802. */
  118803. setPointerOverMesh(mesh: Nullable<AbstractMesh>, pointerId?: number): void;
  118804. /**
  118805. * Gets the mesh under the pointer
  118806. * @returns a Mesh or null if no mesh is under the pointer
  118807. */
  118808. getPointerOverMesh(): Nullable<AbstractMesh>;
  118809. }
  118810. }
  118811. declare module BABYLON {
  118812. /**
  118813. * This class defines the direct association between an animation and a target
  118814. */
  118815. export class TargetedAnimation {
  118816. /**
  118817. * Animation to perform
  118818. */
  118819. animation: Animation;
  118820. /**
  118821. * Target to animate
  118822. */
  118823. target: any;
  118824. /**
  118825. * Returns the string "TargetedAnimation"
  118826. * @returns "TargetedAnimation"
  118827. */
  118828. getClassName(): string;
  118829. /**
  118830. * Serialize the object
  118831. * @returns the JSON object representing the current entity
  118832. */
  118833. serialize(): any;
  118834. }
  118835. /**
  118836. * Use this class to create coordinated animations on multiple targets
  118837. */
  118838. export class AnimationGroup implements IDisposable {
  118839. /** The name of the animation group */
  118840. name: string;
  118841. private _scene;
  118842. private _targetedAnimations;
  118843. private _animatables;
  118844. private _from;
  118845. private _to;
  118846. private _isStarted;
  118847. private _isPaused;
  118848. private _speedRatio;
  118849. private _loopAnimation;
  118850. private _isAdditive;
  118851. /**
  118852. * Gets or sets the unique id of the node
  118853. */
  118854. uniqueId: number;
  118855. /**
  118856. * This observable will notify when one animation have ended
  118857. */
  118858. onAnimationEndObservable: Observable<TargetedAnimation>;
  118859. /**
  118860. * Observer raised when one animation loops
  118861. */
  118862. onAnimationLoopObservable: Observable<TargetedAnimation>;
  118863. /**
  118864. * Observer raised when all animations have looped
  118865. */
  118866. onAnimationGroupLoopObservable: Observable<AnimationGroup>;
  118867. /**
  118868. * This observable will notify when all animations have ended.
  118869. */
  118870. onAnimationGroupEndObservable: Observable<AnimationGroup>;
  118871. /**
  118872. * This observable will notify when all animations have paused.
  118873. */
  118874. onAnimationGroupPauseObservable: Observable<AnimationGroup>;
  118875. /**
  118876. * This observable will notify when all animations are playing.
  118877. */
  118878. onAnimationGroupPlayObservable: Observable<AnimationGroup>;
  118879. /**
  118880. * Gets the first frame
  118881. */
  118882. get from(): number;
  118883. /**
  118884. * Gets the last frame
  118885. */
  118886. get to(): number;
  118887. /**
  118888. * Define if the animations are started
  118889. */
  118890. get isStarted(): boolean;
  118891. /**
  118892. * Gets a value indicating that the current group is playing
  118893. */
  118894. get isPlaying(): boolean;
  118895. /**
  118896. * Gets or sets the speed ratio to use for all animations
  118897. */
  118898. get speedRatio(): number;
  118899. /**
  118900. * Gets or sets the speed ratio to use for all animations
  118901. */
  118902. set speedRatio(value: number);
  118903. /**
  118904. * Gets or sets if all animations should loop or not
  118905. */
  118906. get loopAnimation(): boolean;
  118907. set loopAnimation(value: boolean);
  118908. /**
  118909. * Gets or sets if all animations should be evaluated additively
  118910. */
  118911. get isAdditive(): boolean;
  118912. set isAdditive(value: boolean);
  118913. /**
  118914. * Gets the targeted animations for this animation group
  118915. */
  118916. get targetedAnimations(): Array<TargetedAnimation>;
  118917. /**
  118918. * returning the list of animatables controlled by this animation group.
  118919. */
  118920. get animatables(): Array<Animatable>;
  118921. /**
  118922. * Gets the list of target animations
  118923. */
  118924. get children(): TargetedAnimation[];
  118925. /**
  118926. * Instantiates a new Animation Group.
  118927. * This helps managing several animations at once.
  118928. * @see https://doc.babylonjs.com/how_to/group
  118929. * @param name Defines the name of the group
  118930. * @param scene Defines the scene the group belongs to
  118931. */
  118932. constructor(
  118933. /** The name of the animation group */
  118934. name: string, scene?: Nullable<Scene>);
  118935. /**
  118936. * Add an animation (with its target) in the group
  118937. * @param animation defines the animation we want to add
  118938. * @param target defines the target of the animation
  118939. * @returns the TargetedAnimation object
  118940. */
  118941. addTargetedAnimation(animation: Animation, target: any): TargetedAnimation;
  118942. /**
  118943. * This function will normalize every animation in the group to make sure they all go from beginFrame to endFrame
  118944. * It can add constant keys at begin or end
  118945. * @param beginFrame defines the new begin frame for all animations or the smallest begin frame of all animations if null (defaults to null)
  118946. * @param endFrame defines the new end frame for all animations or the largest end frame of all animations if null (defaults to null)
  118947. * @returns the animation group
  118948. */
  118949. normalize(beginFrame?: Nullable<number>, endFrame?: Nullable<number>): AnimationGroup;
  118950. private _animationLoopCount;
  118951. private _animationLoopFlags;
  118952. private _processLoop;
  118953. /**
  118954. * Start all animations on given targets
  118955. * @param loop defines if animations must loop
  118956. * @param speedRatio defines the ratio to apply to animation speed (1 by default)
  118957. * @param from defines the from key (optional)
  118958. * @param to defines the to key (optional)
  118959. * @param isAdditive defines the additive state for the resulting animatables (optional)
  118960. * @returns the current animation group
  118961. */
  118962. start(loop?: boolean, speedRatio?: number, from?: number, to?: number, isAdditive?: boolean): AnimationGroup;
  118963. /**
  118964. * Pause all animations
  118965. * @returns the animation group
  118966. */
  118967. pause(): AnimationGroup;
  118968. /**
  118969. * Play all animations to initial state
  118970. * This function will start() the animations if they were not started or will restart() them if they were paused
  118971. * @param loop defines if animations must loop
  118972. * @returns the animation group
  118973. */
  118974. play(loop?: boolean): AnimationGroup;
  118975. /**
  118976. * Reset all animations to initial state
  118977. * @returns the animation group
  118978. */
  118979. reset(): AnimationGroup;
  118980. /**
  118981. * Restart animations from key 0
  118982. * @returns the animation group
  118983. */
  118984. restart(): AnimationGroup;
  118985. /**
  118986. * Stop all animations
  118987. * @returns the animation group
  118988. */
  118989. stop(): AnimationGroup;
  118990. /**
  118991. * Set animation weight for all animatables
  118992. * @param weight defines the weight to use
  118993. * @return the animationGroup
  118994. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  118995. */
  118996. setWeightForAllAnimatables(weight: number): AnimationGroup;
  118997. /**
  118998. * Synchronize and normalize all animatables with a source animatable
  118999. * @param root defines the root animatable to synchronize with
  119000. * @return the animationGroup
  119001. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  119002. */
  119003. syncAllAnimationsWith(root: Animatable): AnimationGroup;
  119004. /**
  119005. * Goes to a specific frame in this animation group
  119006. * @param frame the frame number to go to
  119007. * @return the animationGroup
  119008. */
  119009. goToFrame(frame: number): AnimationGroup;
  119010. /**
  119011. * Dispose all associated resources
  119012. */
  119013. dispose(): void;
  119014. private _checkAnimationGroupEnded;
  119015. /**
  119016. * Clone the current animation group and returns a copy
  119017. * @param newName defines the name of the new group
  119018. * @param targetConverter defines an optional function used to convert current animation targets to new ones
  119019. * @returns the new aniamtion group
  119020. */
  119021. clone(newName: string, targetConverter?: (oldTarget: any) => any): AnimationGroup;
  119022. /**
  119023. * Serializes the animationGroup to an object
  119024. * @returns Serialized object
  119025. */
  119026. serialize(): any;
  119027. /**
  119028. * Returns a new AnimationGroup object parsed from the source provided.
  119029. * @param parsedAnimationGroup defines the source
  119030. * @param scene defines the scene that will receive the animationGroup
  119031. * @returns a new AnimationGroup
  119032. */
  119033. static Parse(parsedAnimationGroup: any, scene: Scene): AnimationGroup;
  119034. /**
  119035. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  119036. * @param sourceAnimationGroup defines the AnimationGroup containing animations to convert
  119037. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  119038. * @param range defines the name of the AnimationRange belonging to the animations in the group to convert
  119039. * @param cloneOriginal defines whether or not to clone the group and convert the clone or convert the original group (default is false)
  119040. * @param clonedName defines the name of the resulting cloned AnimationGroup if cloneOriginal is true
  119041. * @returns a new AnimationGroup if cloneOriginal is true or the original AnimationGroup if cloneOriginal is false
  119042. */
  119043. static MakeAnimationAdditive(sourceAnimationGroup: AnimationGroup, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): AnimationGroup;
  119044. /**
  119045. * Returns the string "AnimationGroup"
  119046. * @returns "AnimationGroup"
  119047. */
  119048. getClassName(): string;
  119049. /**
  119050. * Creates a detailled string about the object
  119051. * @param fullDetails defines if the output string will support multiple levels of logging within scene loading
  119052. * @returns a string representing the object
  119053. */
  119054. toString(fullDetails?: boolean): string;
  119055. }
  119056. }
  119057. declare module BABYLON {
  119058. /**
  119059. * Define an interface for all classes that will hold resources
  119060. */
  119061. export interface IDisposable {
  119062. /**
  119063. * Releases all held resources
  119064. */
  119065. dispose(): void;
  119066. }
  119067. /** Interface defining initialization parameters for Scene class */
  119068. export interface SceneOptions {
  119069. /**
  119070. * Defines that scene should keep up-to-date a map of geometry to enable fast look-up by uniqueId
  119071. * It will improve performance when the number of geometries becomes important.
  119072. */
  119073. useGeometryUniqueIdsMap?: boolean;
  119074. /**
  119075. * Defines that each material of the scene should keep up-to-date a map of referencing meshes for fast diposing
  119076. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  119077. */
  119078. useMaterialMeshMap?: boolean;
  119079. /**
  119080. * Defines that each mesh of the scene should keep up-to-date a map of referencing cloned meshes for fast diposing
  119081. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  119082. */
  119083. useClonedMeshMap?: boolean;
  119084. /** Defines if the creation of the scene should impact the engine (Eg. UtilityLayer's scene) */
  119085. virtual?: boolean;
  119086. }
  119087. /**
  119088. * Represents a scene to be rendered by the engine.
  119089. * @see https://doc.babylonjs.com/features/scene
  119090. */
  119091. export class Scene extends AbstractScene implements IAnimatable, IClipPlanesHolder {
  119092. /** The fog is deactivated */
  119093. static readonly FOGMODE_NONE: number;
  119094. /** The fog density is following an exponential function */
  119095. static readonly FOGMODE_EXP: number;
  119096. /** The fog density is following an exponential function faster than FOGMODE_EXP */
  119097. static readonly FOGMODE_EXP2: number;
  119098. /** The fog density is following a linear function. */
  119099. static readonly FOGMODE_LINEAR: number;
  119100. /**
  119101. * Gets or sets the minimum deltatime when deterministic lock step is enabled
  119102. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  119103. */
  119104. static MinDeltaTime: number;
  119105. /**
  119106. * Gets or sets the maximum deltatime when deterministic lock step is enabled
  119107. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  119108. */
  119109. static MaxDeltaTime: number;
  119110. /**
  119111. * Factory used to create the default material.
  119112. * @param name The name of the material to create
  119113. * @param scene The scene to create the material for
  119114. * @returns The default material
  119115. */
  119116. static DefaultMaterialFactory(scene: Scene): Material;
  119117. /**
  119118. * Factory used to create the a collision coordinator.
  119119. * @returns The collision coordinator
  119120. */
  119121. static CollisionCoordinatorFactory(): ICollisionCoordinator;
  119122. /** @hidden */
  119123. _inputManager: InputManager;
  119124. /** Define this parameter if you are using multiple cameras and you want to specify which one should be used for pointer position */
  119125. cameraToUseForPointers: Nullable<Camera>;
  119126. /** @hidden */
  119127. readonly _isScene: boolean;
  119128. /** @hidden */
  119129. _blockEntityCollection: boolean;
  119130. /**
  119131. * Gets or sets a boolean that indicates if the scene must clear the render buffer before rendering a frame
  119132. */
  119133. autoClear: boolean;
  119134. /**
  119135. * Gets or sets a boolean that indicates if the scene must clear the depth and stencil buffers before rendering a frame
  119136. */
  119137. autoClearDepthAndStencil: boolean;
  119138. /**
  119139. * Defines the color used to clear the render buffer (Default is (0.2, 0.2, 0.3, 1.0))
  119140. */
  119141. clearColor: Color4;
  119142. /**
  119143. * Defines the color used to simulate the ambient color (Default is (0, 0, 0))
  119144. */
  119145. ambientColor: Color3;
  119146. /**
  119147. * This is use to store the default BRDF lookup for PBR materials in your scene.
  119148. * It should only be one of the following (if not the default embedded one):
  119149. * * For uncorrelated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = false) : https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  119150. * * For correlated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedBRDF.dds
  119151. * * For correlated multi scattering BRDF (pbr.brdf.useEnergyConservation = true and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  119152. * The material properties need to be setup according to the type of texture in use.
  119153. */
  119154. environmentBRDFTexture: BaseTexture;
  119155. /**
  119156. * Texture used in all pbr material as the reflection texture.
  119157. * As in the majority of the scene they are the same (exception for multi room and so on),
  119158. * this is easier to reference from here than from all the materials.
  119159. */
  119160. get environmentTexture(): Nullable<BaseTexture>;
  119161. /**
  119162. * Texture used in all pbr material as the reflection texture.
  119163. * As in the majority of the scene they are the same (exception for multi room and so on),
  119164. * this is easier to set here than in all the materials.
  119165. */
  119166. set environmentTexture(value: Nullable<BaseTexture>);
  119167. /** @hidden */
  119168. protected _environmentIntensity: number;
  119169. /**
  119170. * Intensity of the environment in all pbr material.
  119171. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  119172. * As in the majority of the scene they are the same (exception for multi room and so on),
  119173. * this is easier to reference from here than from all the materials.
  119174. */
  119175. get environmentIntensity(): number;
  119176. /**
  119177. * Intensity of the environment in all pbr material.
  119178. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  119179. * As in the majority of the scene they are the same (exception for multi room and so on),
  119180. * this is easier to set here than in all the materials.
  119181. */
  119182. set environmentIntensity(value: number);
  119183. /** @hidden */
  119184. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  119185. /**
  119186. * Default image processing configuration used either in the rendering
  119187. * Forward main pass or through the imageProcessingPostProcess if present.
  119188. * As in the majority of the scene they are the same (exception for multi camera),
  119189. * this is easier to reference from here than from all the materials and post process.
  119190. *
  119191. * No setter as we it is a shared configuration, you can set the values instead.
  119192. */
  119193. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  119194. private _forceWireframe;
  119195. /**
  119196. * Gets or sets a boolean indicating if all rendering must be done in wireframe
  119197. */
  119198. set forceWireframe(value: boolean);
  119199. get forceWireframe(): boolean;
  119200. private _skipFrustumClipping;
  119201. /**
  119202. * Gets or sets a boolean indicating if we should skip the frustum clipping part of the active meshes selection
  119203. */
  119204. set skipFrustumClipping(value: boolean);
  119205. get skipFrustumClipping(): boolean;
  119206. private _forcePointsCloud;
  119207. /**
  119208. * Gets or sets a boolean indicating if all rendering must be done in point cloud
  119209. */
  119210. set forcePointsCloud(value: boolean);
  119211. get forcePointsCloud(): boolean;
  119212. /**
  119213. * Gets or sets the active clipplane 1
  119214. */
  119215. clipPlane: Nullable<Plane>;
  119216. /**
  119217. * Gets or sets the active clipplane 2
  119218. */
  119219. clipPlane2: Nullable<Plane>;
  119220. /**
  119221. * Gets or sets the active clipplane 3
  119222. */
  119223. clipPlane3: Nullable<Plane>;
  119224. /**
  119225. * Gets or sets the active clipplane 4
  119226. */
  119227. clipPlane4: Nullable<Plane>;
  119228. /**
  119229. * Gets or sets the active clipplane 5
  119230. */
  119231. clipPlane5: Nullable<Plane>;
  119232. /**
  119233. * Gets or sets the active clipplane 6
  119234. */
  119235. clipPlane6: Nullable<Plane>;
  119236. /**
  119237. * Gets or sets a boolean indicating if animations are enabled
  119238. */
  119239. animationsEnabled: boolean;
  119240. private _animationPropertiesOverride;
  119241. /**
  119242. * Gets or sets the animation properties override
  119243. */
  119244. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  119245. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  119246. /**
  119247. * Gets or sets a boolean indicating if a constant deltatime has to be used
  119248. * This is mostly useful for testing purposes when you do not want the animations to scale with the framerate
  119249. */
  119250. useConstantAnimationDeltaTime: boolean;
  119251. /**
  119252. * Gets or sets a boolean indicating if the scene must keep the meshUnderPointer property updated
  119253. * Please note that it requires to run a ray cast through the scene on every frame
  119254. */
  119255. constantlyUpdateMeshUnderPointer: boolean;
  119256. /**
  119257. * Defines the HTML cursor to use when hovering over interactive elements
  119258. */
  119259. hoverCursor: string;
  119260. /**
  119261. * Defines the HTML default cursor to use (empty by default)
  119262. */
  119263. defaultCursor: string;
  119264. /**
  119265. * Defines whether cursors are handled by the scene.
  119266. */
  119267. doNotHandleCursors: boolean;
  119268. /**
  119269. * This is used to call preventDefault() on pointer down
  119270. * in order to block unwanted artifacts like system double clicks
  119271. */
  119272. preventDefaultOnPointerDown: boolean;
  119273. /**
  119274. * This is used to call preventDefault() on pointer up
  119275. * in order to block unwanted artifacts like system double clicks
  119276. */
  119277. preventDefaultOnPointerUp: boolean;
  119278. /**
  119279. * Gets or sets user defined metadata
  119280. */
  119281. metadata: any;
  119282. /**
  119283. * For internal use only. Please do not use.
  119284. */
  119285. reservedDataStore: any;
  119286. /**
  119287. * Gets the name of the plugin used to load this scene (null by default)
  119288. */
  119289. loadingPluginName: string;
  119290. /**
  119291. * Use this array to add regular expressions used to disable offline support for specific urls
  119292. */
  119293. disableOfflineSupportExceptionRules: RegExp[];
  119294. /**
  119295. * An event triggered when the scene is disposed.
  119296. */
  119297. onDisposeObservable: Observable<Scene>;
  119298. private _onDisposeObserver;
  119299. /** Sets a function to be executed when this scene is disposed. */
  119300. set onDispose(callback: () => void);
  119301. /**
  119302. * An event triggered before rendering the scene (right after animations and physics)
  119303. */
  119304. onBeforeRenderObservable: Observable<Scene>;
  119305. private _onBeforeRenderObserver;
  119306. /** Sets a function to be executed before rendering this scene */
  119307. set beforeRender(callback: Nullable<() => void>);
  119308. /**
  119309. * An event triggered after rendering the scene
  119310. */
  119311. onAfterRenderObservable: Observable<Scene>;
  119312. /**
  119313. * An event triggered after rendering the scene for an active camera (When scene.render is called this will be called after each camera)
  119314. */
  119315. onAfterRenderCameraObservable: Observable<Camera>;
  119316. private _onAfterRenderObserver;
  119317. /** Sets a function to be executed after rendering this scene */
  119318. set afterRender(callback: Nullable<() => void>);
  119319. /**
  119320. * An event triggered before animating the scene
  119321. */
  119322. onBeforeAnimationsObservable: Observable<Scene>;
  119323. /**
  119324. * An event triggered after animations processing
  119325. */
  119326. onAfterAnimationsObservable: Observable<Scene>;
  119327. /**
  119328. * An event triggered before draw calls are ready to be sent
  119329. */
  119330. onBeforeDrawPhaseObservable: Observable<Scene>;
  119331. /**
  119332. * An event triggered after draw calls have been sent
  119333. */
  119334. onAfterDrawPhaseObservable: Observable<Scene>;
  119335. /**
  119336. * An event triggered when the scene is ready
  119337. */
  119338. onReadyObservable: Observable<Scene>;
  119339. /**
  119340. * An event triggered before rendering a camera
  119341. */
  119342. onBeforeCameraRenderObservable: Observable<Camera>;
  119343. private _onBeforeCameraRenderObserver;
  119344. /** Sets a function to be executed before rendering a camera*/
  119345. set beforeCameraRender(callback: () => void);
  119346. /**
  119347. * An event triggered after rendering a camera
  119348. */
  119349. onAfterCameraRenderObservable: Observable<Camera>;
  119350. private _onAfterCameraRenderObserver;
  119351. /** Sets a function to be executed after rendering a camera*/
  119352. set afterCameraRender(callback: () => void);
  119353. /**
  119354. * An event triggered when active meshes evaluation is about to start
  119355. */
  119356. onBeforeActiveMeshesEvaluationObservable: Observable<Scene>;
  119357. /**
  119358. * An event triggered when active meshes evaluation is done
  119359. */
  119360. onAfterActiveMeshesEvaluationObservable: Observable<Scene>;
  119361. /**
  119362. * An event triggered when particles rendering is about to start
  119363. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  119364. */
  119365. onBeforeParticlesRenderingObservable: Observable<Scene>;
  119366. /**
  119367. * An event triggered when particles rendering is done
  119368. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  119369. */
  119370. onAfterParticlesRenderingObservable: Observable<Scene>;
  119371. /**
  119372. * An event triggered when SceneLoader.Append or SceneLoader.Load or SceneLoader.ImportMesh were successfully executed
  119373. */
  119374. onDataLoadedObservable: Observable<Scene>;
  119375. /**
  119376. * An event triggered when a camera is created
  119377. */
  119378. onNewCameraAddedObservable: Observable<Camera>;
  119379. /**
  119380. * An event triggered when a camera is removed
  119381. */
  119382. onCameraRemovedObservable: Observable<Camera>;
  119383. /**
  119384. * An event triggered when a light is created
  119385. */
  119386. onNewLightAddedObservable: Observable<Light>;
  119387. /**
  119388. * An event triggered when a light is removed
  119389. */
  119390. onLightRemovedObservable: Observable<Light>;
  119391. /**
  119392. * An event triggered when a geometry is created
  119393. */
  119394. onNewGeometryAddedObservable: Observable<Geometry>;
  119395. /**
  119396. * An event triggered when a geometry is removed
  119397. */
  119398. onGeometryRemovedObservable: Observable<Geometry>;
  119399. /**
  119400. * An event triggered when a transform node is created
  119401. */
  119402. onNewTransformNodeAddedObservable: Observable<TransformNode>;
  119403. /**
  119404. * An event triggered when a transform node is removed
  119405. */
  119406. onTransformNodeRemovedObservable: Observable<TransformNode>;
  119407. /**
  119408. * An event triggered when a mesh is created
  119409. */
  119410. onNewMeshAddedObservable: Observable<AbstractMesh>;
  119411. /**
  119412. * An event triggered when a mesh is removed
  119413. */
  119414. onMeshRemovedObservable: Observable<AbstractMesh>;
  119415. /**
  119416. * An event triggered when a skeleton is created
  119417. */
  119418. onNewSkeletonAddedObservable: Observable<Skeleton>;
  119419. /**
  119420. * An event triggered when a skeleton is removed
  119421. */
  119422. onSkeletonRemovedObservable: Observable<Skeleton>;
  119423. /**
  119424. * An event triggered when a material is created
  119425. */
  119426. onNewMaterialAddedObservable: Observable<Material>;
  119427. /**
  119428. * An event triggered when a material is removed
  119429. */
  119430. onMaterialRemovedObservable: Observable<Material>;
  119431. /**
  119432. * An event triggered when a texture is created
  119433. */
  119434. onNewTextureAddedObservable: Observable<BaseTexture>;
  119435. /**
  119436. * An event triggered when a texture is removed
  119437. */
  119438. onTextureRemovedObservable: Observable<BaseTexture>;
  119439. /**
  119440. * An event triggered when render targets are about to be rendered
  119441. * Can happen multiple times per frame.
  119442. */
  119443. onBeforeRenderTargetsRenderObservable: Observable<Scene>;
  119444. /**
  119445. * An event triggered when render targets were rendered.
  119446. * Can happen multiple times per frame.
  119447. */
  119448. onAfterRenderTargetsRenderObservable: Observable<Scene>;
  119449. /**
  119450. * An event triggered before calculating deterministic simulation step
  119451. */
  119452. onBeforeStepObservable: Observable<Scene>;
  119453. /**
  119454. * An event triggered after calculating deterministic simulation step
  119455. */
  119456. onAfterStepObservable: Observable<Scene>;
  119457. /**
  119458. * An event triggered when the activeCamera property is updated
  119459. */
  119460. onActiveCameraChanged: Observable<Scene>;
  119461. /**
  119462. * This Observable will be triggered before rendering each renderingGroup of each rendered camera.
  119463. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  119464. * 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)
  119465. */
  119466. onBeforeRenderingGroupObservable: Observable<RenderingGroupInfo>;
  119467. /**
  119468. * This Observable will be triggered after rendering each renderingGroup of each rendered camera.
  119469. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  119470. * 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)
  119471. */
  119472. onAfterRenderingGroupObservable: Observable<RenderingGroupInfo>;
  119473. /**
  119474. * This Observable will when a mesh has been imported into the scene.
  119475. */
  119476. onMeshImportedObservable: Observable<AbstractMesh>;
  119477. /**
  119478. * This Observable will when an animation file has been imported into the scene.
  119479. */
  119480. onAnimationFileImportedObservable: Observable<Scene>;
  119481. /**
  119482. * Gets or sets a user defined funtion to select LOD from a mesh and a camera.
  119483. * By default this function is undefined and Babylon.js will select LOD based on distance to camera
  119484. */
  119485. customLODSelector: (mesh: AbstractMesh, camera: Camera) => Nullable<AbstractMesh>;
  119486. /** @hidden */
  119487. _registeredForLateAnimationBindings: SmartArrayNoDuplicate<any>;
  119488. /**
  119489. * Gets or sets a predicate used to select candidate meshes for a pointer down event
  119490. */
  119491. pointerDownPredicate: (Mesh: AbstractMesh) => boolean;
  119492. /**
  119493. * Gets or sets a predicate used to select candidate meshes for a pointer up event
  119494. */
  119495. pointerUpPredicate: (Mesh: AbstractMesh) => boolean;
  119496. /**
  119497. * Gets or sets a predicate used to select candidate meshes for a pointer move event
  119498. */
  119499. pointerMovePredicate: (Mesh: AbstractMesh) => boolean;
  119500. /** Callback called when a pointer move is detected */
  119501. onPointerMove: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  119502. /** Callback called when a pointer down is detected */
  119503. onPointerDown: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  119504. /** Callback called when a pointer up is detected */
  119505. onPointerUp: (evt: PointerEvent, pickInfo: Nullable<PickingInfo>, type: PointerEventTypes) => void;
  119506. /** Callback called when a pointer pick is detected */
  119507. onPointerPick: (evt: PointerEvent, pickInfo: PickingInfo) => void;
  119508. /**
  119509. * 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).
  119510. * You have the possibility to skip the process and the call to onPointerObservable by setting PointerInfoPre.skipOnPointerObservable to true
  119511. */
  119512. onPrePointerObservable: Observable<PointerInfoPre>;
  119513. /**
  119514. * Observable event triggered each time an input event is received from the rendering canvas
  119515. */
  119516. onPointerObservable: Observable<PointerInfo>;
  119517. /**
  119518. * Gets the pointer coordinates without any translation (ie. straight out of the pointer event)
  119519. */
  119520. get unTranslatedPointer(): Vector2;
  119521. /**
  119522. * Gets or sets the distance in pixel that you have to move to prevent some events. Default is 10 pixels
  119523. */
  119524. static get DragMovementThreshold(): number;
  119525. static set DragMovementThreshold(value: number);
  119526. /**
  119527. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 500 ms
  119528. */
  119529. static get LongPressDelay(): number;
  119530. static set LongPressDelay(value: number);
  119531. /**
  119532. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 300 ms
  119533. */
  119534. static get DoubleClickDelay(): number;
  119535. static set DoubleClickDelay(value: number);
  119536. /** If you need to check double click without raising a single click at first click, enable this flag */
  119537. static get ExclusiveDoubleClickMode(): boolean;
  119538. static set ExclusiveDoubleClickMode(value: boolean);
  119539. /** @hidden */
  119540. _mirroredCameraPosition: Nullable<Vector3>;
  119541. /**
  119542. * This observable event is triggered when any keyboard event si raised and registered during Scene.attachControl()
  119543. * You have the possibility to skip the process and the call to onKeyboardObservable by setting KeyboardInfoPre.skipOnPointerObservable to true
  119544. */
  119545. onPreKeyboardObservable: Observable<KeyboardInfoPre>;
  119546. /**
  119547. * Observable event triggered each time an keyboard event is received from the hosting window
  119548. */
  119549. onKeyboardObservable: Observable<KeyboardInfo>;
  119550. private _useRightHandedSystem;
  119551. /**
  119552. * Gets or sets a boolean indicating if the scene must use right-handed coordinates system
  119553. */
  119554. set useRightHandedSystem(value: boolean);
  119555. get useRightHandedSystem(): boolean;
  119556. private _timeAccumulator;
  119557. private _currentStepId;
  119558. private _currentInternalStep;
  119559. /**
  119560. * Sets the step Id used by deterministic lock step
  119561. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  119562. * @param newStepId defines the step Id
  119563. */
  119564. setStepId(newStepId: number): void;
  119565. /**
  119566. * Gets the step Id used by deterministic lock step
  119567. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  119568. * @returns the step Id
  119569. */
  119570. getStepId(): number;
  119571. /**
  119572. * Gets the internal step used by deterministic lock step
  119573. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  119574. * @returns the internal step
  119575. */
  119576. getInternalStep(): number;
  119577. private _fogEnabled;
  119578. /**
  119579. * Gets or sets a boolean indicating if fog is enabled on this scene
  119580. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119581. * (Default is true)
  119582. */
  119583. set fogEnabled(value: boolean);
  119584. get fogEnabled(): boolean;
  119585. private _fogMode;
  119586. /**
  119587. * Gets or sets the fog mode to use
  119588. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119589. * | mode | value |
  119590. * | --- | --- |
  119591. * | FOGMODE_NONE | 0 |
  119592. * | FOGMODE_EXP | 1 |
  119593. * | FOGMODE_EXP2 | 2 |
  119594. * | FOGMODE_LINEAR | 3 |
  119595. */
  119596. set fogMode(value: number);
  119597. get fogMode(): number;
  119598. /**
  119599. * Gets or sets the fog color to use
  119600. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119601. * (Default is Color3(0.2, 0.2, 0.3))
  119602. */
  119603. fogColor: Color3;
  119604. /**
  119605. * Gets or sets the fog density to use
  119606. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119607. * (Default is 0.1)
  119608. */
  119609. fogDensity: number;
  119610. /**
  119611. * Gets or sets the fog start distance to use
  119612. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119613. * (Default is 0)
  119614. */
  119615. fogStart: number;
  119616. /**
  119617. * Gets or sets the fog end distance to use
  119618. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119619. * (Default is 1000)
  119620. */
  119621. fogEnd: number;
  119622. /**
  119623. * Flag indicating that the frame buffer binding is handled by another component
  119624. */
  119625. prePass: boolean;
  119626. private _shadowsEnabled;
  119627. /**
  119628. * Gets or sets a boolean indicating if shadows are enabled on this scene
  119629. */
  119630. set shadowsEnabled(value: boolean);
  119631. get shadowsEnabled(): boolean;
  119632. private _lightsEnabled;
  119633. /**
  119634. * Gets or sets a boolean indicating if lights are enabled on this scene
  119635. */
  119636. set lightsEnabled(value: boolean);
  119637. get lightsEnabled(): boolean;
  119638. /** All of the active cameras added to this scene. */
  119639. activeCameras: Camera[];
  119640. /** @hidden */
  119641. _activeCamera: Nullable<Camera>;
  119642. /** Gets or sets the current active camera */
  119643. get activeCamera(): Nullable<Camera>;
  119644. set activeCamera(value: Nullable<Camera>);
  119645. private _defaultMaterial;
  119646. /** The default material used on meshes when no material is affected */
  119647. get defaultMaterial(): Material;
  119648. /** The default material used on meshes when no material is affected */
  119649. set defaultMaterial(value: Material);
  119650. private _texturesEnabled;
  119651. /**
  119652. * Gets or sets a boolean indicating if textures are enabled on this scene
  119653. */
  119654. set texturesEnabled(value: boolean);
  119655. get texturesEnabled(): boolean;
  119656. /**
  119657. * Gets or sets a boolean indicating if physic engines are enabled on this scene
  119658. */
  119659. physicsEnabled: boolean;
  119660. /**
  119661. * Gets or sets a boolean indicating if particles are enabled on this scene
  119662. */
  119663. particlesEnabled: boolean;
  119664. /**
  119665. * Gets or sets a boolean indicating if sprites are enabled on this scene
  119666. */
  119667. spritesEnabled: boolean;
  119668. private _skeletonsEnabled;
  119669. /**
  119670. * Gets or sets a boolean indicating if skeletons are enabled on this scene
  119671. */
  119672. set skeletonsEnabled(value: boolean);
  119673. get skeletonsEnabled(): boolean;
  119674. /**
  119675. * Gets or sets a boolean indicating if lens flares are enabled on this scene
  119676. */
  119677. lensFlaresEnabled: boolean;
  119678. /**
  119679. * Gets or sets a boolean indicating if collisions are enabled on this scene
  119680. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  119681. */
  119682. collisionsEnabled: boolean;
  119683. private _collisionCoordinator;
  119684. /** @hidden */
  119685. get collisionCoordinator(): ICollisionCoordinator;
  119686. /**
  119687. * Defines the gravity applied to this scene (used only for collisions)
  119688. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  119689. */
  119690. gravity: Vector3;
  119691. /**
  119692. * Gets or sets a boolean indicating if postprocesses are enabled on this scene
  119693. */
  119694. postProcessesEnabled: boolean;
  119695. /**
  119696. * Gets the current postprocess manager
  119697. */
  119698. postProcessManager: PostProcessManager;
  119699. /**
  119700. * Gets or sets a boolean indicating if render targets are enabled on this scene
  119701. */
  119702. renderTargetsEnabled: boolean;
  119703. /**
  119704. * Gets or sets a boolean indicating if next render targets must be dumped as image for debugging purposes
  119705. * We recommend not using it and instead rely on Spector.js: http://spector.babylonjs.com
  119706. */
  119707. dumpNextRenderTargets: boolean;
  119708. /**
  119709. * The list of user defined render targets added to the scene
  119710. */
  119711. customRenderTargets: RenderTargetTexture[];
  119712. /**
  119713. * Defines if texture loading must be delayed
  119714. * If true, textures will only be loaded when they need to be rendered
  119715. */
  119716. useDelayedTextureLoading: boolean;
  119717. /**
  119718. * Gets the list of meshes imported to the scene through SceneLoader
  119719. */
  119720. importedMeshesFiles: String[];
  119721. /**
  119722. * Gets or sets a boolean indicating if probes are enabled on this scene
  119723. */
  119724. probesEnabled: boolean;
  119725. /**
  119726. * Gets or sets the current offline provider to use to store scene data
  119727. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  119728. */
  119729. offlineProvider: IOfflineProvider;
  119730. /**
  119731. * Gets or sets the action manager associated with the scene
  119732. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  119733. */
  119734. actionManager: AbstractActionManager;
  119735. private _meshesForIntersections;
  119736. /**
  119737. * Gets or sets a boolean indicating if procedural textures are enabled on this scene
  119738. */
  119739. proceduralTexturesEnabled: boolean;
  119740. private _engine;
  119741. private _totalVertices;
  119742. /** @hidden */
  119743. _activeIndices: PerfCounter;
  119744. /** @hidden */
  119745. _activeParticles: PerfCounter;
  119746. /** @hidden */
  119747. _activeBones: PerfCounter;
  119748. private _animationRatio;
  119749. /** @hidden */
  119750. _animationTimeLast: number;
  119751. /** @hidden */
  119752. _animationTime: number;
  119753. /**
  119754. * Gets or sets a general scale for animation speed
  119755. * @see https://www.babylonjs-playground.com/#IBU2W7#3
  119756. */
  119757. animationTimeScale: number;
  119758. /** @hidden */
  119759. _cachedMaterial: Nullable<Material>;
  119760. /** @hidden */
  119761. _cachedEffect: Nullable<Effect>;
  119762. /** @hidden */
  119763. _cachedVisibility: Nullable<number>;
  119764. private _renderId;
  119765. private _frameId;
  119766. private _executeWhenReadyTimeoutId;
  119767. private _intermediateRendering;
  119768. private _viewUpdateFlag;
  119769. private _projectionUpdateFlag;
  119770. /** @hidden */
  119771. _toBeDisposed: Nullable<IDisposable>[];
  119772. private _activeRequests;
  119773. /** @hidden */
  119774. _pendingData: any[];
  119775. private _isDisposed;
  119776. /**
  119777. * Gets or sets a boolean indicating that all submeshes of active meshes must be rendered
  119778. * Use this boolean to avoid computing frustum clipping on submeshes (This could help when you are CPU bound)
  119779. */
  119780. dispatchAllSubMeshesOfActiveMeshes: boolean;
  119781. private _activeMeshes;
  119782. private _processedMaterials;
  119783. private _renderTargets;
  119784. /** @hidden */
  119785. _activeParticleSystems: SmartArray<IParticleSystem>;
  119786. private _activeSkeletons;
  119787. private _softwareSkinnedMeshes;
  119788. private _renderingManager;
  119789. /** @hidden */
  119790. _activeAnimatables: Animatable[];
  119791. private _transformMatrix;
  119792. private _sceneUbo;
  119793. /** @hidden */
  119794. _viewMatrix: Matrix;
  119795. private _projectionMatrix;
  119796. /** @hidden */
  119797. _forcedViewPosition: Nullable<Vector3>;
  119798. /** @hidden */
  119799. _frustumPlanes: Plane[];
  119800. /**
  119801. * Gets the list of frustum planes (built from the active camera)
  119802. */
  119803. get frustumPlanes(): Plane[];
  119804. /**
  119805. * Gets or sets a boolean indicating if lights must be sorted by priority (off by default)
  119806. * This is useful if there are more lights that the maximum simulteanous authorized
  119807. */
  119808. requireLightSorting: boolean;
  119809. /** @hidden */
  119810. readonly useMaterialMeshMap: boolean;
  119811. /** @hidden */
  119812. readonly useClonedMeshMap: boolean;
  119813. private _externalData;
  119814. private _uid;
  119815. /**
  119816. * @hidden
  119817. * Backing store of defined scene components.
  119818. */
  119819. _components: ISceneComponent[];
  119820. /**
  119821. * @hidden
  119822. * Backing store of defined scene components.
  119823. */
  119824. _serializableComponents: ISceneSerializableComponent[];
  119825. /**
  119826. * List of components to register on the next registration step.
  119827. */
  119828. private _transientComponents;
  119829. /**
  119830. * Registers the transient components if needed.
  119831. */
  119832. private _registerTransientComponents;
  119833. /**
  119834. * @hidden
  119835. * Add a component to the scene.
  119836. * Note that the ccomponent could be registered on th next frame if this is called after
  119837. * the register component stage.
  119838. * @param component Defines the component to add to the scene
  119839. */
  119840. _addComponent(component: ISceneComponent): void;
  119841. /**
  119842. * @hidden
  119843. * Gets a component from the scene.
  119844. * @param name defines the name of the component to retrieve
  119845. * @returns the component or null if not present
  119846. */
  119847. _getComponent(name: string): Nullable<ISceneComponent>;
  119848. /**
  119849. * @hidden
  119850. * Defines the actions happening before camera updates.
  119851. */
  119852. _beforeCameraUpdateStage: Stage<SimpleStageAction>;
  119853. /**
  119854. * @hidden
  119855. * Defines the actions happening before clear the canvas.
  119856. */
  119857. _beforeClearStage: Stage<SimpleStageAction>;
  119858. /**
  119859. * @hidden
  119860. * Defines the actions when collecting render targets for the frame.
  119861. */
  119862. _gatherRenderTargetsStage: Stage<RenderTargetsStageAction>;
  119863. /**
  119864. * @hidden
  119865. * Defines the actions happening for one camera in the frame.
  119866. */
  119867. _gatherActiveCameraRenderTargetsStage: Stage<RenderTargetsStageAction>;
  119868. /**
  119869. * @hidden
  119870. * Defines the actions happening during the per mesh ready checks.
  119871. */
  119872. _isReadyForMeshStage: Stage<MeshStageAction>;
  119873. /**
  119874. * @hidden
  119875. * Defines the actions happening before evaluate active mesh checks.
  119876. */
  119877. _beforeEvaluateActiveMeshStage: Stage<SimpleStageAction>;
  119878. /**
  119879. * @hidden
  119880. * Defines the actions happening during the evaluate sub mesh checks.
  119881. */
  119882. _evaluateSubMeshStage: Stage<EvaluateSubMeshStageAction>;
  119883. /**
  119884. * @hidden
  119885. * Defines the actions happening during the active mesh stage.
  119886. */
  119887. _activeMeshStage: Stage<ActiveMeshStageAction>;
  119888. /**
  119889. * @hidden
  119890. * Defines the actions happening during the per camera render target step.
  119891. */
  119892. _cameraDrawRenderTargetStage: Stage<CameraStageFrameBufferAction>;
  119893. /**
  119894. * @hidden
  119895. * Defines the actions happening just before the active camera is drawing.
  119896. */
  119897. _beforeCameraDrawStage: Stage<CameraStageAction>;
  119898. /**
  119899. * @hidden
  119900. * Defines the actions happening just before a render target is drawing.
  119901. */
  119902. _beforeRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  119903. /**
  119904. * @hidden
  119905. * Defines the actions happening just before a rendering group is drawing.
  119906. */
  119907. _beforeRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  119908. /**
  119909. * @hidden
  119910. * Defines the actions happening just before a mesh is drawing.
  119911. */
  119912. _beforeRenderingMeshStage: Stage<RenderingMeshStageAction>;
  119913. /**
  119914. * @hidden
  119915. * Defines the actions happening just after a mesh has been drawn.
  119916. */
  119917. _afterRenderingMeshStage: Stage<RenderingMeshStageAction>;
  119918. /**
  119919. * @hidden
  119920. * Defines the actions happening just after a rendering group has been drawn.
  119921. */
  119922. _afterRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  119923. /**
  119924. * @hidden
  119925. * Defines the actions happening just after the active camera has been drawn.
  119926. */
  119927. _afterCameraDrawStage: Stage<CameraStageAction>;
  119928. /**
  119929. * @hidden
  119930. * Defines the actions happening just after a render target has been drawn.
  119931. */
  119932. _afterRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  119933. /**
  119934. * @hidden
  119935. * Defines the actions happening just after rendering all cameras and computing intersections.
  119936. */
  119937. _afterRenderStage: Stage<SimpleStageAction>;
  119938. /**
  119939. * @hidden
  119940. * Defines the actions happening when a pointer move event happens.
  119941. */
  119942. _pointerMoveStage: Stage<PointerMoveStageAction>;
  119943. /**
  119944. * @hidden
  119945. * Defines the actions happening when a pointer down event happens.
  119946. */
  119947. _pointerDownStage: Stage<PointerUpDownStageAction>;
  119948. /**
  119949. * @hidden
  119950. * Defines the actions happening when a pointer up event happens.
  119951. */
  119952. _pointerUpStage: Stage<PointerUpDownStageAction>;
  119953. /**
  119954. * an optional map from Geometry Id to Geometry index in the 'geometries' array
  119955. */
  119956. private geometriesByUniqueId;
  119957. /**
  119958. * Creates a new Scene
  119959. * @param engine defines the engine to use to render this scene
  119960. * @param options defines the scene options
  119961. */
  119962. constructor(engine: Engine, options?: SceneOptions);
  119963. /**
  119964. * Gets a string identifying the name of the class
  119965. * @returns "Scene" string
  119966. */
  119967. getClassName(): string;
  119968. private _defaultMeshCandidates;
  119969. /**
  119970. * @hidden
  119971. */
  119972. _getDefaultMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  119973. private _defaultSubMeshCandidates;
  119974. /**
  119975. * @hidden
  119976. */
  119977. _getDefaultSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  119978. /**
  119979. * Sets the default candidate providers for the scene.
  119980. * This sets the getActiveMeshCandidates, getActiveSubMeshCandidates, getIntersectingSubMeshCandidates
  119981. * and getCollidingSubMeshCandidates to their default function
  119982. */
  119983. setDefaultCandidateProviders(): void;
  119984. /**
  119985. * Gets the mesh that is currently under the pointer
  119986. */
  119987. get meshUnderPointer(): Nullable<AbstractMesh>;
  119988. /**
  119989. * Gets or sets the current on-screen X position of the pointer
  119990. */
  119991. get pointerX(): number;
  119992. set pointerX(value: number);
  119993. /**
  119994. * Gets or sets the current on-screen Y position of the pointer
  119995. */
  119996. get pointerY(): number;
  119997. set pointerY(value: number);
  119998. /**
  119999. * Gets the cached material (ie. the latest rendered one)
  120000. * @returns the cached material
  120001. */
  120002. getCachedMaterial(): Nullable<Material>;
  120003. /**
  120004. * Gets the cached effect (ie. the latest rendered one)
  120005. * @returns the cached effect
  120006. */
  120007. getCachedEffect(): Nullable<Effect>;
  120008. /**
  120009. * Gets the cached visibility state (ie. the latest rendered one)
  120010. * @returns the cached visibility state
  120011. */
  120012. getCachedVisibility(): Nullable<number>;
  120013. /**
  120014. * Gets a boolean indicating if the current material / effect / visibility must be bind again
  120015. * @param material defines the current material
  120016. * @param effect defines the current effect
  120017. * @param visibility defines the current visibility state
  120018. * @returns true if one parameter is not cached
  120019. */
  120020. isCachedMaterialInvalid(material: Material, effect: Effect, visibility?: number): boolean;
  120021. /**
  120022. * Gets the engine associated with the scene
  120023. * @returns an Engine
  120024. */
  120025. getEngine(): Engine;
  120026. /**
  120027. * Gets the total number of vertices rendered per frame
  120028. * @returns the total number of vertices rendered per frame
  120029. */
  120030. getTotalVertices(): number;
  120031. /**
  120032. * Gets the performance counter for total vertices
  120033. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  120034. */
  120035. get totalVerticesPerfCounter(): PerfCounter;
  120036. /**
  120037. * Gets the total number of active indices rendered per frame (You can deduce the number of rendered triangles by dividing this number by 3)
  120038. * @returns the total number of active indices rendered per frame
  120039. */
  120040. getActiveIndices(): number;
  120041. /**
  120042. * Gets the performance counter for active indices
  120043. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  120044. */
  120045. get totalActiveIndicesPerfCounter(): PerfCounter;
  120046. /**
  120047. * Gets the total number of active particles rendered per frame
  120048. * @returns the total number of active particles rendered per frame
  120049. */
  120050. getActiveParticles(): number;
  120051. /**
  120052. * Gets the performance counter for active particles
  120053. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  120054. */
  120055. get activeParticlesPerfCounter(): PerfCounter;
  120056. /**
  120057. * Gets the total number of active bones rendered per frame
  120058. * @returns the total number of active bones rendered per frame
  120059. */
  120060. getActiveBones(): number;
  120061. /**
  120062. * Gets the performance counter for active bones
  120063. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  120064. */
  120065. get activeBonesPerfCounter(): PerfCounter;
  120066. /**
  120067. * Gets the array of active meshes
  120068. * @returns an array of AbstractMesh
  120069. */
  120070. getActiveMeshes(): SmartArray<AbstractMesh>;
  120071. /**
  120072. * Gets the animation ratio (which is 1.0 is the scene renders at 60fps and 2 if the scene renders at 30fps, etc.)
  120073. * @returns a number
  120074. */
  120075. getAnimationRatio(): number;
  120076. /**
  120077. * Gets an unique Id for the current render phase
  120078. * @returns a number
  120079. */
  120080. getRenderId(): number;
  120081. /**
  120082. * Gets an unique Id for the current frame
  120083. * @returns a number
  120084. */
  120085. getFrameId(): number;
  120086. /** Call this function if you want to manually increment the render Id*/
  120087. incrementRenderId(): void;
  120088. private _createUbo;
  120089. /**
  120090. * Use this method to simulate a pointer move on a mesh
  120091. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  120092. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  120093. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  120094. * @returns the current scene
  120095. */
  120096. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  120097. /**
  120098. * Use this method to simulate a pointer down on a mesh
  120099. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  120100. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  120101. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  120102. * @returns the current scene
  120103. */
  120104. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  120105. /**
  120106. * Use this method to simulate a pointer up on a mesh
  120107. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  120108. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  120109. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  120110. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  120111. * @returns the current scene
  120112. */
  120113. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): Scene;
  120114. /**
  120115. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  120116. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  120117. * @returns true if the pointer was captured
  120118. */
  120119. isPointerCaptured(pointerId?: number): boolean;
  120120. /**
  120121. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  120122. * @param attachUp defines if you want to attach events to pointerup
  120123. * @param attachDown defines if you want to attach events to pointerdown
  120124. * @param attachMove defines if you want to attach events to pointermove
  120125. */
  120126. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  120127. /** Detaches all event handlers*/
  120128. detachControl(): void;
  120129. /**
  120130. * This function will check if the scene can be rendered (textures are loaded, shaders are compiled)
  120131. * Delay loaded resources are not taking in account
  120132. * @return true if all required resources are ready
  120133. */
  120134. isReady(): boolean;
  120135. /** Resets all cached information relative to material (including effect and visibility) */
  120136. resetCachedMaterial(): void;
  120137. /**
  120138. * Registers a function to be called before every frame render
  120139. * @param func defines the function to register
  120140. */
  120141. registerBeforeRender(func: () => void): void;
  120142. /**
  120143. * Unregisters a function called before every frame render
  120144. * @param func defines the function to unregister
  120145. */
  120146. unregisterBeforeRender(func: () => void): void;
  120147. /**
  120148. * Registers a function to be called after every frame render
  120149. * @param func defines the function to register
  120150. */
  120151. registerAfterRender(func: () => void): void;
  120152. /**
  120153. * Unregisters a function called after every frame render
  120154. * @param func defines the function to unregister
  120155. */
  120156. unregisterAfterRender(func: () => void): void;
  120157. private _executeOnceBeforeRender;
  120158. /**
  120159. * The provided function will run before render once and will be disposed afterwards.
  120160. * A timeout delay can be provided so that the function will be executed in N ms.
  120161. * The timeout is using the browser's native setTimeout so time percision cannot be guaranteed.
  120162. * @param func The function to be executed.
  120163. * @param timeout optional delay in ms
  120164. */
  120165. executeOnceBeforeRender(func: () => void, timeout?: number): void;
  120166. /** @hidden */
  120167. _addPendingData(data: any): void;
  120168. /** @hidden */
  120169. _removePendingData(data: any): void;
  120170. /**
  120171. * Returns the number of items waiting to be loaded
  120172. * @returns the number of items waiting to be loaded
  120173. */
  120174. getWaitingItemsCount(): number;
  120175. /**
  120176. * Returns a boolean indicating if the scene is still loading data
  120177. */
  120178. get isLoading(): boolean;
  120179. /**
  120180. * Registers a function to be executed when the scene is ready
  120181. * @param {Function} func - the function to be executed
  120182. */
  120183. executeWhenReady(func: () => void): void;
  120184. /**
  120185. * Returns a promise that resolves when the scene is ready
  120186. * @returns A promise that resolves when the scene is ready
  120187. */
  120188. whenReadyAsync(): Promise<void>;
  120189. /** @hidden */
  120190. _checkIsReady(): void;
  120191. /**
  120192. * Gets all animatable attached to the scene
  120193. */
  120194. get animatables(): Animatable[];
  120195. /**
  120196. * Resets the last animation time frame.
  120197. * Useful to override when animations start running when loading a scene for the first time.
  120198. */
  120199. resetLastAnimationTimeFrame(): void;
  120200. /**
  120201. * Gets the current view matrix
  120202. * @returns a Matrix
  120203. */
  120204. getViewMatrix(): Matrix;
  120205. /**
  120206. * Gets the current projection matrix
  120207. * @returns a Matrix
  120208. */
  120209. getProjectionMatrix(): Matrix;
  120210. /**
  120211. * Gets the current transform matrix
  120212. * @returns a Matrix made of View * Projection
  120213. */
  120214. getTransformMatrix(): Matrix;
  120215. /**
  120216. * Sets the current transform matrix
  120217. * @param viewL defines the View matrix to use
  120218. * @param projectionL defines the Projection matrix to use
  120219. * @param viewR defines the right View matrix to use (if provided)
  120220. * @param projectionR defines the right Projection matrix to use (if provided)
  120221. */
  120222. setTransformMatrix(viewL: Matrix, projectionL: Matrix, viewR?: Matrix, projectionR?: Matrix): void;
  120223. /**
  120224. * Gets the uniform buffer used to store scene data
  120225. * @returns a UniformBuffer
  120226. */
  120227. getSceneUniformBuffer(): UniformBuffer;
  120228. /**
  120229. * Gets an unique (relatively to the current scene) Id
  120230. * @returns an unique number for the scene
  120231. */
  120232. getUniqueId(): number;
  120233. /**
  120234. * Add a mesh to the list of scene's meshes
  120235. * @param newMesh defines the mesh to add
  120236. * @param recursive if all child meshes should also be added to the scene
  120237. */
  120238. addMesh(newMesh: AbstractMesh, recursive?: boolean): void;
  120239. /**
  120240. * Remove a mesh for the list of scene's meshes
  120241. * @param toRemove defines the mesh to remove
  120242. * @param recursive if all child meshes should also be removed from the scene
  120243. * @returns the index where the mesh was in the mesh list
  120244. */
  120245. removeMesh(toRemove: AbstractMesh, recursive?: boolean): number;
  120246. /**
  120247. * Add a transform node to the list of scene's transform nodes
  120248. * @param newTransformNode defines the transform node to add
  120249. */
  120250. addTransformNode(newTransformNode: TransformNode): void;
  120251. /**
  120252. * Remove a transform node for the list of scene's transform nodes
  120253. * @param toRemove defines the transform node to remove
  120254. * @returns the index where the transform node was in the transform node list
  120255. */
  120256. removeTransformNode(toRemove: TransformNode): number;
  120257. /**
  120258. * Remove a skeleton for the list of scene's skeletons
  120259. * @param toRemove defines the skeleton to remove
  120260. * @returns the index where the skeleton was in the skeleton list
  120261. */
  120262. removeSkeleton(toRemove: Skeleton): number;
  120263. /**
  120264. * Remove a morph target for the list of scene's morph targets
  120265. * @param toRemove defines the morph target to remove
  120266. * @returns the index where the morph target was in the morph target list
  120267. */
  120268. removeMorphTargetManager(toRemove: MorphTargetManager): number;
  120269. /**
  120270. * Remove a light for the list of scene's lights
  120271. * @param toRemove defines the light to remove
  120272. * @returns the index where the light was in the light list
  120273. */
  120274. removeLight(toRemove: Light): number;
  120275. /**
  120276. * Remove a camera for the list of scene's cameras
  120277. * @param toRemove defines the camera to remove
  120278. * @returns the index where the camera was in the camera list
  120279. */
  120280. removeCamera(toRemove: Camera): number;
  120281. /**
  120282. * Remove a particle system for the list of scene's particle systems
  120283. * @param toRemove defines the particle system to remove
  120284. * @returns the index where the particle system was in the particle system list
  120285. */
  120286. removeParticleSystem(toRemove: IParticleSystem): number;
  120287. /**
  120288. * Remove a animation for the list of scene's animations
  120289. * @param toRemove defines the animation to remove
  120290. * @returns the index where the animation was in the animation list
  120291. */
  120292. removeAnimation(toRemove: Animation): number;
  120293. /**
  120294. * Will stop the animation of the given target
  120295. * @param target - the target
  120296. * @param animationName - the name of the animation to stop (all animations will be stopped if both this and targetMask are empty)
  120297. * @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)
  120298. */
  120299. stopAnimation(target: any, animationName?: string, targetMask?: (target: any) => boolean): void;
  120300. /**
  120301. * Removes the given animation group from this scene.
  120302. * @param toRemove The animation group to remove
  120303. * @returns The index of the removed animation group
  120304. */
  120305. removeAnimationGroup(toRemove: AnimationGroup): number;
  120306. /**
  120307. * Removes the given multi-material from this scene.
  120308. * @param toRemove The multi-material to remove
  120309. * @returns The index of the removed multi-material
  120310. */
  120311. removeMultiMaterial(toRemove: MultiMaterial): number;
  120312. /**
  120313. * Removes the given material from this scene.
  120314. * @param toRemove The material to remove
  120315. * @returns The index of the removed material
  120316. */
  120317. removeMaterial(toRemove: Material): number;
  120318. /**
  120319. * Removes the given action manager from this scene.
  120320. * @param toRemove The action manager to remove
  120321. * @returns The index of the removed action manager
  120322. */
  120323. removeActionManager(toRemove: AbstractActionManager): number;
  120324. /**
  120325. * Removes the given texture from this scene.
  120326. * @param toRemove The texture to remove
  120327. * @returns The index of the removed texture
  120328. */
  120329. removeTexture(toRemove: BaseTexture): number;
  120330. /**
  120331. * Adds the given light to this scene
  120332. * @param newLight The light to add
  120333. */
  120334. addLight(newLight: Light): void;
  120335. /**
  120336. * Sorts the list list based on light priorities
  120337. */
  120338. sortLightsByPriority(): void;
  120339. /**
  120340. * Adds the given camera to this scene
  120341. * @param newCamera The camera to add
  120342. */
  120343. addCamera(newCamera: Camera): void;
  120344. /**
  120345. * Adds the given skeleton to this scene
  120346. * @param newSkeleton The skeleton to add
  120347. */
  120348. addSkeleton(newSkeleton: Skeleton): void;
  120349. /**
  120350. * Adds the given particle system to this scene
  120351. * @param newParticleSystem The particle system to add
  120352. */
  120353. addParticleSystem(newParticleSystem: IParticleSystem): void;
  120354. /**
  120355. * Adds the given animation to this scene
  120356. * @param newAnimation The animation to add
  120357. */
  120358. addAnimation(newAnimation: Animation): void;
  120359. /**
  120360. * Adds the given animation group to this scene.
  120361. * @param newAnimationGroup The animation group to add
  120362. */
  120363. addAnimationGroup(newAnimationGroup: AnimationGroup): void;
  120364. /**
  120365. * Adds the given multi-material to this scene
  120366. * @param newMultiMaterial The multi-material to add
  120367. */
  120368. addMultiMaterial(newMultiMaterial: MultiMaterial): void;
  120369. /**
  120370. * Adds the given material to this scene
  120371. * @param newMaterial The material to add
  120372. */
  120373. addMaterial(newMaterial: Material): void;
  120374. /**
  120375. * Adds the given morph target to this scene
  120376. * @param newMorphTargetManager The morph target to add
  120377. */
  120378. addMorphTargetManager(newMorphTargetManager: MorphTargetManager): void;
  120379. /**
  120380. * Adds the given geometry to this scene
  120381. * @param newGeometry The geometry to add
  120382. */
  120383. addGeometry(newGeometry: Geometry): void;
  120384. /**
  120385. * Adds the given action manager to this scene
  120386. * @param newActionManager The action manager to add
  120387. */
  120388. addActionManager(newActionManager: AbstractActionManager): void;
  120389. /**
  120390. * Adds the given texture to this scene.
  120391. * @param newTexture The texture to add
  120392. */
  120393. addTexture(newTexture: BaseTexture): void;
  120394. /**
  120395. * Switch active camera
  120396. * @param newCamera defines the new active camera
  120397. * @param attachControl defines if attachControl must be called for the new active camera (default: true)
  120398. */
  120399. switchActiveCamera(newCamera: Camera, attachControl?: boolean): void;
  120400. /**
  120401. * sets the active camera of the scene using its ID
  120402. * @param id defines the camera's ID
  120403. * @return the new active camera or null if none found.
  120404. */
  120405. setActiveCameraByID(id: string): Nullable<Camera>;
  120406. /**
  120407. * sets the active camera of the scene using its name
  120408. * @param name defines the camera's name
  120409. * @returns the new active camera or null if none found.
  120410. */
  120411. setActiveCameraByName(name: string): Nullable<Camera>;
  120412. /**
  120413. * get an animation group using its name
  120414. * @param name defines the material's name
  120415. * @return the animation group or null if none found.
  120416. */
  120417. getAnimationGroupByName(name: string): Nullable<AnimationGroup>;
  120418. /**
  120419. * Get a material using its unique id
  120420. * @param uniqueId defines the material's unique id
  120421. * @return the material or null if none found.
  120422. */
  120423. getMaterialByUniqueID(uniqueId: number): Nullable<Material>;
  120424. /**
  120425. * get a material using its id
  120426. * @param id defines the material's ID
  120427. * @return the material or null if none found.
  120428. */
  120429. getMaterialByID(id: string): Nullable<Material>;
  120430. /**
  120431. * Gets a the last added material using a given id
  120432. * @param id defines the material's ID
  120433. * @return the last material with the given id or null if none found.
  120434. */
  120435. getLastMaterialByID(id: string): Nullable<Material>;
  120436. /**
  120437. * Gets a material using its name
  120438. * @param name defines the material's name
  120439. * @return the material or null if none found.
  120440. */
  120441. getMaterialByName(name: string): Nullable<Material>;
  120442. /**
  120443. * Get a texture using its unique id
  120444. * @param uniqueId defines the texture's unique id
  120445. * @return the texture or null if none found.
  120446. */
  120447. getTextureByUniqueID(uniqueId: number): Nullable<BaseTexture>;
  120448. /**
  120449. * Gets a camera using its id
  120450. * @param id defines the id to look for
  120451. * @returns the camera or null if not found
  120452. */
  120453. getCameraByID(id: string): Nullable<Camera>;
  120454. /**
  120455. * Gets a camera using its unique id
  120456. * @param uniqueId defines the unique id to look for
  120457. * @returns the camera or null if not found
  120458. */
  120459. getCameraByUniqueID(uniqueId: number): Nullable<Camera>;
  120460. /**
  120461. * Gets a camera using its name
  120462. * @param name defines the camera's name
  120463. * @return the camera or null if none found.
  120464. */
  120465. getCameraByName(name: string): Nullable<Camera>;
  120466. /**
  120467. * Gets a bone using its id
  120468. * @param id defines the bone's id
  120469. * @return the bone or null if not found
  120470. */
  120471. getBoneByID(id: string): Nullable<Bone>;
  120472. /**
  120473. * Gets a bone using its id
  120474. * @param name defines the bone's name
  120475. * @return the bone or null if not found
  120476. */
  120477. getBoneByName(name: string): Nullable<Bone>;
  120478. /**
  120479. * Gets a light node using its name
  120480. * @param name defines the the light's name
  120481. * @return the light or null if none found.
  120482. */
  120483. getLightByName(name: string): Nullable<Light>;
  120484. /**
  120485. * Gets a light node using its id
  120486. * @param id defines the light's id
  120487. * @return the light or null if none found.
  120488. */
  120489. getLightByID(id: string): Nullable<Light>;
  120490. /**
  120491. * Gets a light node using its scene-generated unique ID
  120492. * @param uniqueId defines the light's unique id
  120493. * @return the light or null if none found.
  120494. */
  120495. getLightByUniqueID(uniqueId: number): Nullable<Light>;
  120496. /**
  120497. * Gets a particle system by id
  120498. * @param id defines the particle system id
  120499. * @return the corresponding system or null if none found
  120500. */
  120501. getParticleSystemByID(id: string): Nullable<IParticleSystem>;
  120502. /**
  120503. * Gets a geometry using its ID
  120504. * @param id defines the geometry's id
  120505. * @return the geometry or null if none found.
  120506. */
  120507. getGeometryByID(id: string): Nullable<Geometry>;
  120508. private _getGeometryByUniqueID;
  120509. /**
  120510. * Add a new geometry to this scene
  120511. * @param geometry defines the geometry to be added to the scene.
  120512. * @param force defines if the geometry must be pushed even if a geometry with this id already exists
  120513. * @return a boolean defining if the geometry was added or not
  120514. */
  120515. pushGeometry(geometry: Geometry, force?: boolean): boolean;
  120516. /**
  120517. * Removes an existing geometry
  120518. * @param geometry defines the geometry to be removed from the scene
  120519. * @return a boolean defining if the geometry was removed or not
  120520. */
  120521. removeGeometry(geometry: Geometry): boolean;
  120522. /**
  120523. * Gets the list of geometries attached to the scene
  120524. * @returns an array of Geometry
  120525. */
  120526. getGeometries(): Geometry[];
  120527. /**
  120528. * Gets the first added mesh found of a given ID
  120529. * @param id defines the id to search for
  120530. * @return the mesh found or null if not found at all
  120531. */
  120532. getMeshByID(id: string): Nullable<AbstractMesh>;
  120533. /**
  120534. * Gets a list of meshes using their id
  120535. * @param id defines the id to search for
  120536. * @returns a list of meshes
  120537. */
  120538. getMeshesByID(id: string): Array<AbstractMesh>;
  120539. /**
  120540. * Gets the first added transform node found of a given ID
  120541. * @param id defines the id to search for
  120542. * @return the found transform node or null if not found at all.
  120543. */
  120544. getTransformNodeByID(id: string): Nullable<TransformNode>;
  120545. /**
  120546. * Gets a transform node with its auto-generated unique id
  120547. * @param uniqueId efines the unique id to search for
  120548. * @return the found transform node or null if not found at all.
  120549. */
  120550. getTransformNodeByUniqueID(uniqueId: number): Nullable<TransformNode>;
  120551. /**
  120552. * Gets a list of transform nodes using their id
  120553. * @param id defines the id to search for
  120554. * @returns a list of transform nodes
  120555. */
  120556. getTransformNodesByID(id: string): Array<TransformNode>;
  120557. /**
  120558. * Gets a mesh with its auto-generated unique id
  120559. * @param uniqueId defines the unique id to search for
  120560. * @return the found mesh or null if not found at all.
  120561. */
  120562. getMeshByUniqueID(uniqueId: number): Nullable<AbstractMesh>;
  120563. /**
  120564. * Gets a the last added mesh using a given id
  120565. * @param id defines the id to search for
  120566. * @return the found mesh or null if not found at all.
  120567. */
  120568. getLastMeshByID(id: string): Nullable<AbstractMesh>;
  120569. /**
  120570. * Gets a the last added node (Mesh, Camera, Light) using a given id
  120571. * @param id defines the id to search for
  120572. * @return the found node or null if not found at all
  120573. */
  120574. getLastEntryByID(id: string): Nullable<Node>;
  120575. /**
  120576. * Gets a node (Mesh, Camera, Light) using a given id
  120577. * @param id defines the id to search for
  120578. * @return the found node or null if not found at all
  120579. */
  120580. getNodeByID(id: string): Nullable<Node>;
  120581. /**
  120582. * Gets a node (Mesh, Camera, Light) using a given name
  120583. * @param name defines the name to search for
  120584. * @return the found node or null if not found at all.
  120585. */
  120586. getNodeByName(name: string): Nullable<Node>;
  120587. /**
  120588. * Gets a mesh using a given name
  120589. * @param name defines the name to search for
  120590. * @return the found mesh or null if not found at all.
  120591. */
  120592. getMeshByName(name: string): Nullable<AbstractMesh>;
  120593. /**
  120594. * Gets a transform node using a given name
  120595. * @param name defines the name to search for
  120596. * @return the found transform node or null if not found at all.
  120597. */
  120598. getTransformNodeByName(name: string): Nullable<TransformNode>;
  120599. /**
  120600. * Gets a skeleton using a given id (if many are found, this function will pick the last one)
  120601. * @param id defines the id to search for
  120602. * @return the found skeleton or null if not found at all.
  120603. */
  120604. getLastSkeletonByID(id: string): Nullable<Skeleton>;
  120605. /**
  120606. * Gets a skeleton using a given auto generated unique id
  120607. * @param uniqueId defines the unique id to search for
  120608. * @return the found skeleton or null if not found at all.
  120609. */
  120610. getSkeletonByUniqueId(uniqueId: number): Nullable<Skeleton>;
  120611. /**
  120612. * Gets a skeleton using a given id (if many are found, this function will pick the first one)
  120613. * @param id defines the id to search for
  120614. * @return the found skeleton or null if not found at all.
  120615. */
  120616. getSkeletonById(id: string): Nullable<Skeleton>;
  120617. /**
  120618. * Gets a skeleton using a given name
  120619. * @param name defines the name to search for
  120620. * @return the found skeleton or null if not found at all.
  120621. */
  120622. getSkeletonByName(name: string): Nullable<Skeleton>;
  120623. /**
  120624. * Gets a morph target manager using a given id (if many are found, this function will pick the last one)
  120625. * @param id defines the id to search for
  120626. * @return the found morph target manager or null if not found at all.
  120627. */
  120628. getMorphTargetManagerById(id: number): Nullable<MorphTargetManager>;
  120629. /**
  120630. * Gets a morph target using a given id (if many are found, this function will pick the first one)
  120631. * @param id defines the id to search for
  120632. * @return the found morph target or null if not found at all.
  120633. */
  120634. getMorphTargetById(id: string): Nullable<MorphTarget>;
  120635. /**
  120636. * Gets a morph target using a given name (if many are found, this function will pick the first one)
  120637. * @param name defines the name to search for
  120638. * @return the found morph target or null if not found at all.
  120639. */
  120640. getMorphTargetByName(name: string): Nullable<MorphTarget>;
  120641. /**
  120642. * Gets a post process using a given name (if many are found, this function will pick the first one)
  120643. * @param name defines the name to search for
  120644. * @return the found post process or null if not found at all.
  120645. */
  120646. getPostProcessByName(name: string): Nullable<PostProcess>;
  120647. /**
  120648. * Gets a boolean indicating if the given mesh is active
  120649. * @param mesh defines the mesh to look for
  120650. * @returns true if the mesh is in the active list
  120651. */
  120652. isActiveMesh(mesh: AbstractMesh): boolean;
  120653. /**
  120654. * Return a unique id as a string which can serve as an identifier for the scene
  120655. */
  120656. get uid(): string;
  120657. /**
  120658. * Add an externaly attached data from its key.
  120659. * This method call will fail and return false, if such key already exists.
  120660. * If you don't care and just want to get the data no matter what, use the more convenient getOrAddExternalDataWithFactory() method.
  120661. * @param key the unique key that identifies the data
  120662. * @param data the data object to associate to the key for this Engine instance
  120663. * @return true if no such key were already present and the data was added successfully, false otherwise
  120664. */
  120665. addExternalData<T>(key: string, data: T): boolean;
  120666. /**
  120667. * Get an externaly attached data from its key
  120668. * @param key the unique key that identifies the data
  120669. * @return the associated data, if present (can be null), or undefined if not present
  120670. */
  120671. getExternalData<T>(key: string): Nullable<T>;
  120672. /**
  120673. * Get an externaly attached data from its key, create it using a factory if it's not already present
  120674. * @param key the unique key that identifies the data
  120675. * @param factory the factory that will be called to create the instance if and only if it doesn't exists
  120676. * @return the associated data, can be null if the factory returned null.
  120677. */
  120678. getOrAddExternalDataWithFactory<T>(key: string, factory: (k: string) => T): T;
  120679. /**
  120680. * Remove an externaly attached data from the Engine instance
  120681. * @param key the unique key that identifies the data
  120682. * @return true if the data was successfully removed, false if it doesn't exist
  120683. */
  120684. removeExternalData(key: string): boolean;
  120685. private _evaluateSubMesh;
  120686. /**
  120687. * Clear the processed materials smart array preventing retention point in material dispose.
  120688. */
  120689. freeProcessedMaterials(): void;
  120690. private _preventFreeActiveMeshesAndRenderingGroups;
  120691. /** Gets or sets a boolean blocking all the calls to freeActiveMeshes and freeRenderingGroups
  120692. * It can be used in order to prevent going through methods freeRenderingGroups and freeActiveMeshes several times to improve performance
  120693. * when disposing several meshes in a row or a hierarchy of meshes.
  120694. * When used, it is the responsability of the user to blockfreeActiveMeshesAndRenderingGroups back to false.
  120695. */
  120696. get blockfreeActiveMeshesAndRenderingGroups(): boolean;
  120697. set blockfreeActiveMeshesAndRenderingGroups(value: boolean);
  120698. /**
  120699. * Clear the active meshes smart array preventing retention point in mesh dispose.
  120700. */
  120701. freeActiveMeshes(): void;
  120702. /**
  120703. * Clear the info related to rendering groups preventing retention points during dispose.
  120704. */
  120705. freeRenderingGroups(): void;
  120706. /** @hidden */
  120707. _isInIntermediateRendering(): boolean;
  120708. /**
  120709. * Lambda returning the list of potentially active meshes.
  120710. */
  120711. getActiveMeshCandidates: () => ISmartArrayLike<AbstractMesh>;
  120712. /**
  120713. * Lambda returning the list of potentially active sub meshes.
  120714. */
  120715. getActiveSubMeshCandidates: (mesh: AbstractMesh) => ISmartArrayLike<SubMesh>;
  120716. /**
  120717. * Lambda returning the list of potentially intersecting sub meshes.
  120718. */
  120719. getIntersectingSubMeshCandidates: (mesh: AbstractMesh, localRay: Ray) => ISmartArrayLike<SubMesh>;
  120720. /**
  120721. * Lambda returning the list of potentially colliding sub meshes.
  120722. */
  120723. getCollidingSubMeshCandidates: (mesh: AbstractMesh, collider: Collider) => ISmartArrayLike<SubMesh>;
  120724. private _activeMeshesFrozen;
  120725. private _skipEvaluateActiveMeshesCompletely;
  120726. /**
  120727. * Use this function to stop evaluating active meshes. The current list will be keep alive between frames
  120728. * @param skipEvaluateActiveMeshes defines an optional boolean indicating that the evaluate active meshes step must be completely skipped
  120729. * @returns the current scene
  120730. */
  120731. freezeActiveMeshes(skipEvaluateActiveMeshes?: boolean): Scene;
  120732. /**
  120733. * Use this function to restart evaluating active meshes on every frame
  120734. * @returns the current scene
  120735. */
  120736. unfreezeActiveMeshes(): Scene;
  120737. private _evaluateActiveMeshes;
  120738. private _activeMesh;
  120739. /**
  120740. * Update the transform matrix to update from the current active camera
  120741. * @param force defines a boolean used to force the update even if cache is up to date
  120742. */
  120743. updateTransformMatrix(force?: boolean): void;
  120744. private _bindFrameBuffer;
  120745. /** @hidden */
  120746. _allowPostProcessClearColor: boolean;
  120747. /** @hidden */
  120748. _renderForCamera(camera: Camera, rigParent?: Camera): void;
  120749. private _processSubCameras;
  120750. private _checkIntersections;
  120751. /** @hidden */
  120752. _advancePhysicsEngineStep(step: number): void;
  120753. /**
  120754. * User updatable function that will return a deterministic frame time when engine is in deterministic lock step mode
  120755. */
  120756. getDeterministicFrameTime: () => number;
  120757. /** @hidden */
  120758. _animate(): void;
  120759. /** Execute all animations (for a frame) */
  120760. animate(): void;
  120761. /**
  120762. * Render the scene
  120763. * @param updateCameras defines a boolean indicating if cameras must update according to their inputs (true by default)
  120764. * @param ignoreAnimations defines a boolean indicating if animations should not be executed (false by default)
  120765. */
  120766. render(updateCameras?: boolean, ignoreAnimations?: boolean): void;
  120767. /**
  120768. * Freeze all materials
  120769. * A frozen material will not be updatable but should be faster to render
  120770. */
  120771. freezeMaterials(): void;
  120772. /**
  120773. * Unfreeze all materials
  120774. * A frozen material will not be updatable but should be faster to render
  120775. */
  120776. unfreezeMaterials(): void;
  120777. /**
  120778. * Releases all held ressources
  120779. */
  120780. dispose(): void;
  120781. /**
  120782. * Gets if the scene is already disposed
  120783. */
  120784. get isDisposed(): boolean;
  120785. /**
  120786. * Call this function to reduce memory footprint of the scene.
  120787. * Vertex buffers will not store CPU data anymore (this will prevent picking, collisions or physics to work correctly)
  120788. */
  120789. clearCachedVertexData(): void;
  120790. /**
  120791. * This function will remove the local cached buffer data from texture.
  120792. * It will save memory but will prevent the texture from being rebuilt
  120793. */
  120794. cleanCachedTextureBuffer(): void;
  120795. /**
  120796. * Get the world extend vectors with an optional filter
  120797. *
  120798. * @param filterPredicate the predicate - which meshes should be included when calculating the world size
  120799. * @returns {{ min: Vector3; max: Vector3 }} min and max vectors
  120800. */
  120801. getWorldExtends(filterPredicate?: (mesh: AbstractMesh) => boolean): {
  120802. min: Vector3;
  120803. max: Vector3;
  120804. };
  120805. /**
  120806. * Creates a ray that can be used to pick in the scene
  120807. * @param x defines the x coordinate of the origin (on-screen)
  120808. * @param y defines the y coordinate of the origin (on-screen)
  120809. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  120810. * @param camera defines the camera to use for the picking
  120811. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  120812. * @returns a Ray
  120813. */
  120814. createPickingRay(x: number, y: number, world: Matrix, camera: Nullable<Camera>, cameraViewSpace?: boolean): Ray;
  120815. /**
  120816. * Creates a ray that can be used to pick in the scene
  120817. * @param x defines the x coordinate of the origin (on-screen)
  120818. * @param y defines the y coordinate of the origin (on-screen)
  120819. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  120820. * @param result defines the ray where to store the picking ray
  120821. * @param camera defines the camera to use for the picking
  120822. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  120823. * @returns the current scene
  120824. */
  120825. createPickingRayToRef(x: number, y: number, world: Matrix, result: Ray, camera: Nullable<Camera>, cameraViewSpace?: boolean): Scene;
  120826. /**
  120827. * Creates a ray that can be used to pick in the scene
  120828. * @param x defines the x coordinate of the origin (on-screen)
  120829. * @param y defines the y coordinate of the origin (on-screen)
  120830. * @param camera defines the camera to use for the picking
  120831. * @returns a Ray
  120832. */
  120833. createPickingRayInCameraSpace(x: number, y: number, camera?: Camera): Ray;
  120834. /**
  120835. * Creates a ray that can be used to pick in the scene
  120836. * @param x defines the x coordinate of the origin (on-screen)
  120837. * @param y defines the y coordinate of the origin (on-screen)
  120838. * @param result defines the ray where to store the picking ray
  120839. * @param camera defines the camera to use for the picking
  120840. * @returns the current scene
  120841. */
  120842. createPickingRayInCameraSpaceToRef(x: number, y: number, result: Ray, camera?: Camera): Scene;
  120843. /** Launch a ray to try to pick a mesh in the scene
  120844. * @param x position on screen
  120845. * @param y position on screen
  120846. * @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
  120847. * @param fastCheck defines if the first intersection will be used (and not the closest)
  120848. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  120849. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  120850. * @returns a PickingInfo
  120851. */
  120852. pick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  120853. /** Launch a ray to try to pick a mesh in the scene using only bounding information of the main mesh (not using submeshes)
  120854. * @param x position on screen
  120855. * @param y position on screen
  120856. * @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
  120857. * @param fastCheck defines if the first intersection will be used (and not the closest)
  120858. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  120859. * @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)
  120860. */
  120861. pickWithBoundingInfo(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>): Nullable<PickingInfo>;
  120862. /** Use the given ray to pick a mesh in the scene
  120863. * @param ray The ray to use to pick meshes
  120864. * @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
  120865. * @param fastCheck defines if the first intersection will be used (and not the closest)
  120866. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  120867. * @returns a PickingInfo
  120868. */
  120869. pickWithRay(ray: Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  120870. /**
  120871. * Launch a ray to try to pick a mesh in the scene
  120872. * @param x X position on screen
  120873. * @param y Y position on screen
  120874. * @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
  120875. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  120876. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  120877. * @returns an array of PickingInfo
  120878. */
  120879. multiPick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, camera?: Camera, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  120880. /**
  120881. * Launch a ray to try to pick a mesh in the scene
  120882. * @param ray Ray to use
  120883. * @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
  120884. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  120885. * @returns an array of PickingInfo
  120886. */
  120887. multiPickWithRay(ray: Ray, predicate: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  120888. /**
  120889. * Force the value of meshUnderPointer
  120890. * @param mesh defines the mesh to use
  120891. * @param pointerId optional pointer id when using more than one pointer
  120892. */
  120893. setPointerOverMesh(mesh: Nullable<AbstractMesh>, pointerId?: number): void;
  120894. /**
  120895. * Gets the mesh under the pointer
  120896. * @returns a Mesh or null if no mesh is under the pointer
  120897. */
  120898. getPointerOverMesh(): Nullable<AbstractMesh>;
  120899. /** @hidden */
  120900. _rebuildGeometries(): void;
  120901. /** @hidden */
  120902. _rebuildTextures(): void;
  120903. private _getByTags;
  120904. /**
  120905. * Get a list of meshes by tags
  120906. * @param tagsQuery defines the tags query to use
  120907. * @param forEach defines a predicate used to filter results
  120908. * @returns an array of Mesh
  120909. */
  120910. getMeshesByTags(tagsQuery: string, forEach?: (mesh: AbstractMesh) => void): Mesh[];
  120911. /**
  120912. * Get a list of cameras by tags
  120913. * @param tagsQuery defines the tags query to use
  120914. * @param forEach defines a predicate used to filter results
  120915. * @returns an array of Camera
  120916. */
  120917. getCamerasByTags(tagsQuery: string, forEach?: (camera: Camera) => void): Camera[];
  120918. /**
  120919. * Get a list of lights by tags
  120920. * @param tagsQuery defines the tags query to use
  120921. * @param forEach defines a predicate used to filter results
  120922. * @returns an array of Light
  120923. */
  120924. getLightsByTags(tagsQuery: string, forEach?: (light: Light) => void): Light[];
  120925. /**
  120926. * Get a list of materials by tags
  120927. * @param tagsQuery defines the tags query to use
  120928. * @param forEach defines a predicate used to filter results
  120929. * @returns an array of Material
  120930. */
  120931. getMaterialByTags(tagsQuery: string, forEach?: (material: Material) => void): Material[];
  120932. /**
  120933. * Get a list of transform nodes by tags
  120934. * @param tagsQuery defines the tags query to use
  120935. * @param forEach defines a predicate used to filter results
  120936. * @returns an array of TransformNode
  120937. */
  120938. getTransformNodesByTags(tagsQuery: string, forEach?: (transform: TransformNode) => void): TransformNode[];
  120939. /**
  120940. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  120941. * This allowed control for front to back rendering or reversly depending of the special needs.
  120942. *
  120943. * @param renderingGroupId The rendering group id corresponding to its index
  120944. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  120945. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  120946. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  120947. */
  120948. 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;
  120949. /**
  120950. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  120951. *
  120952. * @param renderingGroupId The rendering group id corresponding to its index
  120953. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  120954. * @param depth Automatically clears depth between groups if true and autoClear is true.
  120955. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  120956. */
  120957. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  120958. /**
  120959. * Gets the current auto clear configuration for one rendering group of the rendering
  120960. * manager.
  120961. * @param index the rendering group index to get the information for
  120962. * @returns The auto clear setup for the requested rendering group
  120963. */
  120964. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  120965. private _blockMaterialDirtyMechanism;
  120966. /** Gets or sets a boolean blocking all the calls to markAllMaterialsAsDirty (ie. the materials won't be updated if they are out of sync) */
  120967. get blockMaterialDirtyMechanism(): boolean;
  120968. set blockMaterialDirtyMechanism(value: boolean);
  120969. /**
  120970. * Will flag all materials as dirty to trigger new shader compilation
  120971. * @param flag defines the flag used to specify which material part must be marked as dirty
  120972. * @param predicate If not null, it will be used to specifiy if a material has to be marked as dirty
  120973. */
  120974. markAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  120975. /** @hidden */
  120976. _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;
  120977. /** @hidden */
  120978. _loadFileAsync(url: string, onProgress?: (data: any) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  120979. /** @hidden */
  120980. _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;
  120981. /** @hidden */
  120982. _requestFileAsync(url: string, onProgress?: (ev: ProgressEvent) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onOpened?: (request: WebRequest) => void): Promise<string | ArrayBuffer>;
  120983. /** @hidden */
  120984. _readFile(file: File, onSuccess: (data: string | ArrayBuffer) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  120985. /** @hidden */
  120986. _readFileAsync(file: File, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  120987. }
  120988. }
  120989. declare module BABYLON {
  120990. /**
  120991. * Set of assets to keep when moving a scene into an asset container.
  120992. */
  120993. export class KeepAssets extends AbstractScene {
  120994. }
  120995. /**
  120996. * Class used to store the output of the AssetContainer.instantiateAllMeshesToScene function
  120997. */
  120998. export class InstantiatedEntries {
  120999. /**
  121000. * List of new root nodes (eg. nodes with no parent)
  121001. */
  121002. rootNodes: TransformNode[];
  121003. /**
  121004. * List of new skeletons
  121005. */
  121006. skeletons: Skeleton[];
  121007. /**
  121008. * List of new animation groups
  121009. */
  121010. animationGroups: AnimationGroup[];
  121011. }
  121012. /**
  121013. * Container with a set of assets that can be added or removed from a scene.
  121014. */
  121015. export class AssetContainer extends AbstractScene {
  121016. private _wasAddedToScene;
  121017. /**
  121018. * The scene the AssetContainer belongs to.
  121019. */
  121020. scene: Scene;
  121021. /**
  121022. * Instantiates an AssetContainer.
  121023. * @param scene The scene the AssetContainer belongs to.
  121024. */
  121025. constructor(scene: Scene);
  121026. /**
  121027. * Instantiate or clone all meshes and add the new ones to the scene.
  121028. * Skeletons and animation groups will all be cloned
  121029. * @param nameFunction defines an optional function used to get new names for clones
  121030. * @param cloneMaterials defines an optional boolean that defines if materials must be cloned as well (false by default)
  121031. * @returns a list of rootNodes, skeletons and aniamtion groups that were duplicated
  121032. */
  121033. instantiateModelsToScene(nameFunction?: (sourceName: string) => string, cloneMaterials?: boolean): InstantiatedEntries;
  121034. /**
  121035. * Adds all the assets from the container to the scene.
  121036. */
  121037. addAllToScene(): void;
  121038. /**
  121039. * Removes all the assets in the container from the scene
  121040. */
  121041. removeAllFromScene(): void;
  121042. /**
  121043. * Disposes all the assets in the container
  121044. */
  121045. dispose(): void;
  121046. private _moveAssets;
  121047. /**
  121048. * Removes all the assets contained in the scene and adds them to the container.
  121049. * @param keepAssets Set of assets to keep in the scene. (default: empty)
  121050. */
  121051. moveAllFromScene(keepAssets?: KeepAssets): void;
  121052. /**
  121053. * 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.
  121054. * @returns the root mesh
  121055. */
  121056. createRootMesh(): Mesh;
  121057. /**
  121058. * Merge animations (direct and animation groups) from this asset container into a scene
  121059. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  121060. * @param animatables set of animatables to retarget to a node from the scene
  121061. * @param targetConverter defines a function used to convert animation targets from the asset container to the scene (default: search node by name)
  121062. * @returns an array of the new AnimationGroup added to the scene (empty array if none)
  121063. */
  121064. mergeAnimationsTo(scene: Scene | null | undefined, animatables: Animatable[], targetConverter?: Nullable<(target: any) => Nullable<Node>>): AnimationGroup[];
  121065. }
  121066. }
  121067. declare module BABYLON {
  121068. /**
  121069. * Defines how the parser contract is defined.
  121070. * These parsers are used to parse a list of specific assets (like particle systems, etc..)
  121071. */
  121072. export type BabylonFileParser = (parsedData: any, scene: Scene, container: AssetContainer, rootUrl: string) => void;
  121073. /**
  121074. * Defines how the individual parser contract is defined.
  121075. * These parser can parse an individual asset
  121076. */
  121077. export type IndividualBabylonFileParser = (parsedData: any, scene: Scene, rootUrl: string) => any;
  121078. /**
  121079. * Base class of the scene acting as a container for the different elements composing a scene.
  121080. * This class is dynamically extended by the different components of the scene increasing
  121081. * flexibility and reducing coupling
  121082. */
  121083. export abstract class AbstractScene {
  121084. /**
  121085. * Stores the list of available parsers in the application.
  121086. */
  121087. private static _BabylonFileParsers;
  121088. /**
  121089. * Stores the list of available individual parsers in the application.
  121090. */
  121091. private static _IndividualBabylonFileParsers;
  121092. /**
  121093. * Adds a parser in the list of available ones
  121094. * @param name Defines the name of the parser
  121095. * @param parser Defines the parser to add
  121096. */
  121097. static AddParser(name: string, parser: BabylonFileParser): void;
  121098. /**
  121099. * Gets a general parser from the list of avaialble ones
  121100. * @param name Defines the name of the parser
  121101. * @returns the requested parser or null
  121102. */
  121103. static GetParser(name: string): Nullable<BabylonFileParser>;
  121104. /**
  121105. * Adds n individual parser in the list of available ones
  121106. * @param name Defines the name of the parser
  121107. * @param parser Defines the parser to add
  121108. */
  121109. static AddIndividualParser(name: string, parser: IndividualBabylonFileParser): void;
  121110. /**
  121111. * Gets an individual parser from the list of avaialble ones
  121112. * @param name Defines the name of the parser
  121113. * @returns the requested parser or null
  121114. */
  121115. static GetIndividualParser(name: string): Nullable<IndividualBabylonFileParser>;
  121116. /**
  121117. * Parser json data and populate both a scene and its associated container object
  121118. * @param jsonData Defines the data to parse
  121119. * @param scene Defines the scene to parse the data for
  121120. * @param container Defines the container attached to the parsing sequence
  121121. * @param rootUrl Defines the root url of the data
  121122. */
  121123. static Parse(jsonData: any, scene: Scene, container: AssetContainer, rootUrl: string): void;
  121124. /**
  121125. * Gets the list of root nodes (ie. nodes with no parent)
  121126. */
  121127. rootNodes: Node[];
  121128. /** All of the cameras added to this scene
  121129. * @see https://doc.babylonjs.com/babylon101/cameras
  121130. */
  121131. cameras: Camera[];
  121132. /**
  121133. * All of the lights added to this scene
  121134. * @see https://doc.babylonjs.com/babylon101/lights
  121135. */
  121136. lights: Light[];
  121137. /**
  121138. * All of the (abstract) meshes added to this scene
  121139. */
  121140. meshes: AbstractMesh[];
  121141. /**
  121142. * The list of skeletons added to the scene
  121143. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  121144. */
  121145. skeletons: Skeleton[];
  121146. /**
  121147. * All of the particle systems added to this scene
  121148. * @see https://doc.babylonjs.com/babylon101/particles
  121149. */
  121150. particleSystems: IParticleSystem[];
  121151. /**
  121152. * Gets a list of Animations associated with the scene
  121153. */
  121154. animations: Animation[];
  121155. /**
  121156. * All of the animation groups added to this scene
  121157. * @see https://doc.babylonjs.com/how_to/group
  121158. */
  121159. animationGroups: AnimationGroup[];
  121160. /**
  121161. * All of the multi-materials added to this scene
  121162. * @see https://doc.babylonjs.com/how_to/multi_materials
  121163. */
  121164. multiMaterials: MultiMaterial[];
  121165. /**
  121166. * All of the materials added to this scene
  121167. * In the context of a Scene, it is not supposed to be modified manually.
  121168. * Any addition or removal should be done using the addMaterial and removeMaterial Scene methods.
  121169. * Note also that the order of the Material within the array is not significant and might change.
  121170. * @see https://doc.babylonjs.com/babylon101/materials
  121171. */
  121172. materials: Material[];
  121173. /**
  121174. * The list of morph target managers added to the scene
  121175. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh
  121176. */
  121177. morphTargetManagers: MorphTargetManager[];
  121178. /**
  121179. * The list of geometries used in the scene.
  121180. */
  121181. geometries: Geometry[];
  121182. /**
  121183. * All of the tranform nodes added to this scene
  121184. * In the context of a Scene, it is not supposed to be modified manually.
  121185. * Any addition or removal should be done using the addTransformNode and removeTransformNode Scene methods.
  121186. * Note also that the order of the TransformNode wihin the array is not significant and might change.
  121187. * @see https://doc.babylonjs.com/how_to/transformnode
  121188. */
  121189. transformNodes: TransformNode[];
  121190. /**
  121191. * ActionManagers available on the scene.
  121192. */
  121193. actionManagers: AbstractActionManager[];
  121194. /**
  121195. * Textures to keep.
  121196. */
  121197. textures: BaseTexture[];
  121198. /** @hidden */
  121199. protected _environmentTexture: Nullable<BaseTexture>;
  121200. /**
  121201. * Texture used in all pbr material as the reflection texture.
  121202. * As in the majority of the scene they are the same (exception for multi room and so on),
  121203. * this is easier to reference from here than from all the materials.
  121204. */
  121205. get environmentTexture(): Nullable<BaseTexture>;
  121206. set environmentTexture(value: Nullable<BaseTexture>);
  121207. /**
  121208. * The list of postprocesses added to the scene
  121209. */
  121210. postProcesses: PostProcess[];
  121211. /**
  121212. * @returns all meshes, lights, cameras, transformNodes and bones
  121213. */
  121214. getNodes(): Array<Node>;
  121215. }
  121216. }
  121217. declare module BABYLON {
  121218. /**
  121219. * Interface used to define options for Sound class
  121220. */
  121221. export interface ISoundOptions {
  121222. /**
  121223. * Does the sound autoplay once loaded.
  121224. */
  121225. autoplay?: boolean;
  121226. /**
  121227. * Does the sound loop after it finishes playing once.
  121228. */
  121229. loop?: boolean;
  121230. /**
  121231. * Sound's volume
  121232. */
  121233. volume?: number;
  121234. /**
  121235. * Is it a spatial sound?
  121236. */
  121237. spatialSound?: boolean;
  121238. /**
  121239. * Maximum distance to hear that sound
  121240. */
  121241. maxDistance?: number;
  121242. /**
  121243. * Uses user defined attenuation function
  121244. */
  121245. useCustomAttenuation?: boolean;
  121246. /**
  121247. * Define the roll off factor of spatial sounds.
  121248. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121249. */
  121250. rolloffFactor?: number;
  121251. /**
  121252. * Define the reference distance the sound should be heard perfectly.
  121253. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121254. */
  121255. refDistance?: number;
  121256. /**
  121257. * Define the distance attenuation model the sound will follow.
  121258. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121259. */
  121260. distanceModel?: string;
  121261. /**
  121262. * Defines the playback speed (1 by default)
  121263. */
  121264. playbackRate?: number;
  121265. /**
  121266. * Defines if the sound is from a streaming source
  121267. */
  121268. streaming?: boolean;
  121269. /**
  121270. * Defines an optional length (in seconds) inside the sound file
  121271. */
  121272. length?: number;
  121273. /**
  121274. * Defines an optional offset (in seconds) inside the sound file
  121275. */
  121276. offset?: number;
  121277. /**
  121278. * If true, URLs will not be required to state the audio file codec to use.
  121279. */
  121280. skipCodecCheck?: boolean;
  121281. }
  121282. /**
  121283. * Defines a sound that can be played in the application.
  121284. * The sound can either be an ambient track or a simple sound played in reaction to a user action.
  121285. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  121286. */
  121287. export class Sound {
  121288. /**
  121289. * The name of the sound in the scene.
  121290. */
  121291. name: string;
  121292. /**
  121293. * Does the sound autoplay once loaded.
  121294. */
  121295. autoplay: boolean;
  121296. /**
  121297. * Does the sound loop after it finishes playing once.
  121298. */
  121299. loop: boolean;
  121300. /**
  121301. * Does the sound use a custom attenuation curve to simulate the falloff
  121302. * happening when the source gets further away from the camera.
  121303. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  121304. */
  121305. useCustomAttenuation: boolean;
  121306. /**
  121307. * The sound track id this sound belongs to.
  121308. */
  121309. soundTrackId: number;
  121310. /**
  121311. * Is this sound currently played.
  121312. */
  121313. isPlaying: boolean;
  121314. /**
  121315. * Is this sound currently paused.
  121316. */
  121317. isPaused: boolean;
  121318. /**
  121319. * Does this sound enables spatial sound.
  121320. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121321. */
  121322. spatialSound: boolean;
  121323. /**
  121324. * Define the reference distance the sound should be heard perfectly.
  121325. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121326. */
  121327. refDistance: number;
  121328. /**
  121329. * Define the roll off factor of spatial sounds.
  121330. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121331. */
  121332. rolloffFactor: number;
  121333. /**
  121334. * Define the max distance the sound should be heard (intensity just became 0 at this point).
  121335. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121336. */
  121337. maxDistance: number;
  121338. /**
  121339. * Define the distance attenuation model the sound will follow.
  121340. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121341. */
  121342. distanceModel: string;
  121343. /**
  121344. * @hidden
  121345. * Back Compat
  121346. **/
  121347. onended: () => any;
  121348. /**
  121349. * Gets or sets an object used to store user defined information for the sound.
  121350. */
  121351. metadata: any;
  121352. /**
  121353. * Observable event when the current playing sound finishes.
  121354. */
  121355. onEndedObservable: Observable<Sound>;
  121356. private _panningModel;
  121357. private _playbackRate;
  121358. private _streaming;
  121359. private _startTime;
  121360. private _startOffset;
  121361. private _position;
  121362. /** @hidden */
  121363. _positionInEmitterSpace: boolean;
  121364. private _localDirection;
  121365. private _volume;
  121366. private _isReadyToPlay;
  121367. private _isDirectional;
  121368. private _readyToPlayCallback;
  121369. private _audioBuffer;
  121370. private _soundSource;
  121371. private _streamingSource;
  121372. private _soundPanner;
  121373. private _soundGain;
  121374. private _inputAudioNode;
  121375. private _outputAudioNode;
  121376. private _coneInnerAngle;
  121377. private _coneOuterAngle;
  121378. private _coneOuterGain;
  121379. private _scene;
  121380. private _connectedTransformNode;
  121381. private _customAttenuationFunction;
  121382. private _registerFunc;
  121383. private _isOutputConnected;
  121384. private _htmlAudioElement;
  121385. private _urlType;
  121386. private _length?;
  121387. private _offset?;
  121388. /** @hidden */
  121389. static _SceneComponentInitialization: (scene: Scene) => void;
  121390. /**
  121391. * Create a sound and attach it to a scene
  121392. * @param name Name of your sound
  121393. * @param urlOrArrayBuffer Url to the sound to load async or ArrayBuffer, it also works with MediaStreams
  121394. * @param scene defines the scene the sound belongs to
  121395. * @param readyToPlayCallback Provide a callback function if you'd like to load your code once the sound is ready to be played
  121396. * @param options Objects to provide with the current available options: autoplay, loop, volume, spatialSound, maxDistance, rolloffFactor, refDistance, distanceModel, panningModel, streaming
  121397. */
  121398. constructor(name: string, urlOrArrayBuffer: any, scene: Scene, readyToPlayCallback?: Nullable<() => void>, options?: ISoundOptions);
  121399. /**
  121400. * Release the sound and its associated resources
  121401. */
  121402. dispose(): void;
  121403. /**
  121404. * Gets if the sounds is ready to be played or not.
  121405. * @returns true if ready, otherwise false
  121406. */
  121407. isReady(): boolean;
  121408. private _soundLoaded;
  121409. /**
  121410. * Sets the data of the sound from an audiobuffer
  121411. * @param audioBuffer The audioBuffer containing the data
  121412. */
  121413. setAudioBuffer(audioBuffer: AudioBuffer): void;
  121414. /**
  121415. * Updates the current sounds options such as maxdistance, loop...
  121416. * @param options A JSON object containing values named as the object properties
  121417. */
  121418. updateOptions(options: ISoundOptions): void;
  121419. private _createSpatialParameters;
  121420. private _updateSpatialParameters;
  121421. /**
  121422. * Switch the panning model to HRTF:
  121423. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  121424. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121425. */
  121426. switchPanningModelToHRTF(): void;
  121427. /**
  121428. * Switch the panning model to Equal Power:
  121429. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  121430. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121431. */
  121432. switchPanningModelToEqualPower(): void;
  121433. private _switchPanningModel;
  121434. /**
  121435. * Connect this sound to a sound track audio node like gain...
  121436. * @param soundTrackAudioNode the sound track audio node to connect to
  121437. */
  121438. connectToSoundTrackAudioNode(soundTrackAudioNode: AudioNode): void;
  121439. /**
  121440. * Transform this sound into a directional source
  121441. * @param coneInnerAngle Size of the inner cone in degree
  121442. * @param coneOuterAngle Size of the outer cone in degree
  121443. * @param coneOuterGain Volume of the sound outside the outer cone (between 0.0 and 1.0)
  121444. */
  121445. setDirectionalCone(coneInnerAngle: number, coneOuterAngle: number, coneOuterGain: number): void;
  121446. /**
  121447. * Gets or sets the inner angle for the directional cone.
  121448. */
  121449. get directionalConeInnerAngle(): number;
  121450. /**
  121451. * Gets or sets the inner angle for the directional cone.
  121452. */
  121453. set directionalConeInnerAngle(value: number);
  121454. /**
  121455. * Gets or sets the outer angle for the directional cone.
  121456. */
  121457. get directionalConeOuterAngle(): number;
  121458. /**
  121459. * Gets or sets the outer angle for the directional cone.
  121460. */
  121461. set directionalConeOuterAngle(value: number);
  121462. /**
  121463. * Sets the position of the emitter if spatial sound is enabled
  121464. * @param newPosition Defines the new posisiton
  121465. */
  121466. setPosition(newPosition: Vector3): void;
  121467. /**
  121468. * Sets the local direction of the emitter if spatial sound is enabled
  121469. * @param newLocalDirection Defines the new local direction
  121470. */
  121471. setLocalDirectionToMesh(newLocalDirection: Vector3): void;
  121472. private _updateDirection;
  121473. /** @hidden */
  121474. updateDistanceFromListener(): void;
  121475. /**
  121476. * Sets a new custom attenuation function for the sound.
  121477. * @param callback Defines the function used for the attenuation
  121478. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  121479. */
  121480. setAttenuationFunction(callback: (currentVolume: number, currentDistance: number, maxDistance: number, refDistance: number, rolloffFactor: number) => number): void;
  121481. /**
  121482. * Play the sound
  121483. * @param time (optional) Start the sound after X seconds. Start immediately (0) by default.
  121484. * @param offset (optional) Start the sound at a specific time in seconds
  121485. * @param length (optional) Sound duration (in seconds)
  121486. */
  121487. play(time?: number, offset?: number, length?: number): void;
  121488. private _onended;
  121489. /**
  121490. * Stop the sound
  121491. * @param time (optional) Stop the sound after X seconds. Stop immediately (0) by default.
  121492. */
  121493. stop(time?: number): void;
  121494. /**
  121495. * Put the sound in pause
  121496. */
  121497. pause(): void;
  121498. /**
  121499. * Sets a dedicated volume for this sounds
  121500. * @param newVolume Define the new volume of the sound
  121501. * @param time Define time for gradual change to new volume
  121502. */
  121503. setVolume(newVolume: number, time?: number): void;
  121504. /**
  121505. * Set the sound play back rate
  121506. * @param newPlaybackRate Define the playback rate the sound should be played at
  121507. */
  121508. setPlaybackRate(newPlaybackRate: number): void;
  121509. /**
  121510. * Gets the volume of the sound.
  121511. * @returns the volume of the sound
  121512. */
  121513. getVolume(): number;
  121514. /**
  121515. * Attach the sound to a dedicated mesh
  121516. * @param transformNode The transform node to connect the sound with
  121517. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  121518. */
  121519. attachToMesh(transformNode: TransformNode): void;
  121520. /**
  121521. * Detach the sound from the previously attached mesh
  121522. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  121523. */
  121524. detachFromMesh(): void;
  121525. private _onRegisterAfterWorldMatrixUpdate;
  121526. /**
  121527. * Clone the current sound in the scene.
  121528. * @returns the new sound clone
  121529. */
  121530. clone(): Nullable<Sound>;
  121531. /**
  121532. * Gets the current underlying audio buffer containing the data
  121533. * @returns the audio buffer
  121534. */
  121535. getAudioBuffer(): Nullable<AudioBuffer>;
  121536. /**
  121537. * Gets the WebAudio AudioBufferSourceNode, lets you keep track of and stop instances of this Sound.
  121538. * @returns the source node
  121539. */
  121540. getSoundSource(): Nullable<AudioBufferSourceNode>;
  121541. /**
  121542. * Gets the WebAudio GainNode, gives you precise control over the gain of instances of this Sound.
  121543. * @returns the gain node
  121544. */
  121545. getSoundGain(): Nullable<GainNode>;
  121546. /**
  121547. * Serializes the Sound in a JSON representation
  121548. * @returns the JSON representation of the sound
  121549. */
  121550. serialize(): any;
  121551. /**
  121552. * Parse a JSON representation of a sound to innstantiate in a given scene
  121553. * @param parsedSound Define the JSON representation of the sound (usually coming from the serialize method)
  121554. * @param scene Define the scene the new parsed sound should be created in
  121555. * @param rootUrl Define the rooturl of the load in case we need to fetch relative dependencies
  121556. * @param sourceSound Define a cound place holder if do not need to instantiate a new one
  121557. * @returns the newly parsed sound
  121558. */
  121559. static Parse(parsedSound: any, scene: Scene, rootUrl: string, sourceSound?: Sound): Sound;
  121560. }
  121561. }
  121562. declare module BABYLON {
  121563. /**
  121564. * This defines an action helpful to play a defined sound on a triggered action.
  121565. */
  121566. export class PlaySoundAction extends Action {
  121567. private _sound;
  121568. /**
  121569. * Instantiate the action
  121570. * @param triggerOptions defines the trigger options
  121571. * @param sound defines the sound to play
  121572. * @param condition defines the trigger related conditions
  121573. */
  121574. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  121575. /** @hidden */
  121576. _prepare(): void;
  121577. /**
  121578. * Execute the action and play the sound.
  121579. */
  121580. execute(): void;
  121581. /**
  121582. * Serializes the actions and its related information.
  121583. * @param parent defines the object to serialize in
  121584. * @returns the serialized object
  121585. */
  121586. serialize(parent: any): any;
  121587. }
  121588. /**
  121589. * This defines an action helpful to stop a defined sound on a triggered action.
  121590. */
  121591. export class StopSoundAction extends Action {
  121592. private _sound;
  121593. /**
  121594. * Instantiate the action
  121595. * @param triggerOptions defines the trigger options
  121596. * @param sound defines the sound to stop
  121597. * @param condition defines the trigger related conditions
  121598. */
  121599. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  121600. /** @hidden */
  121601. _prepare(): void;
  121602. /**
  121603. * Execute the action and stop the sound.
  121604. */
  121605. execute(): void;
  121606. /**
  121607. * Serializes the actions and its related information.
  121608. * @param parent defines the object to serialize in
  121609. * @returns the serialized object
  121610. */
  121611. serialize(parent: any): any;
  121612. }
  121613. }
  121614. declare module BABYLON {
  121615. /**
  121616. * This defines an action responsible to change the value of a property
  121617. * by interpolating between its current value and the newly set one once triggered.
  121618. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  121619. */
  121620. export class InterpolateValueAction extends Action {
  121621. /**
  121622. * Defines the path of the property where the value should be interpolated
  121623. */
  121624. propertyPath: string;
  121625. /**
  121626. * Defines the target value at the end of the interpolation.
  121627. */
  121628. value: any;
  121629. /**
  121630. * Defines the time it will take for the property to interpolate to the value.
  121631. */
  121632. duration: number;
  121633. /**
  121634. * Defines if the other scene animations should be stopped when the action has been triggered
  121635. */
  121636. stopOtherAnimations?: boolean;
  121637. /**
  121638. * Defines a callback raised once the interpolation animation has been done.
  121639. */
  121640. onInterpolationDone?: () => void;
  121641. /**
  121642. * Observable triggered once the interpolation animation has been done.
  121643. */
  121644. onInterpolationDoneObservable: Observable<InterpolateValueAction>;
  121645. private _target;
  121646. private _effectiveTarget;
  121647. private _property;
  121648. /**
  121649. * Instantiate the action
  121650. * @param triggerOptions defines the trigger options
  121651. * @param target defines the object containing the value to interpolate
  121652. * @param propertyPath defines the path to the property in the target object
  121653. * @param value defines the target value at the end of the interpolation
  121654. * @param duration deines the time it will take for the property to interpolate to the value.
  121655. * @param condition defines the trigger related conditions
  121656. * @param stopOtherAnimations defines if the other scene animations should be stopped when the action has been triggered
  121657. * @param onInterpolationDone defines a callback raised once the interpolation animation has been done
  121658. */
  121659. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, duration?: number, condition?: Condition, stopOtherAnimations?: boolean, onInterpolationDone?: () => void);
  121660. /** @hidden */
  121661. _prepare(): void;
  121662. /**
  121663. * Execute the action starts the value interpolation.
  121664. */
  121665. execute(): void;
  121666. /**
  121667. * Serializes the actions and its related information.
  121668. * @param parent defines the object to serialize in
  121669. * @returns the serialized object
  121670. */
  121671. serialize(parent: any): any;
  121672. }
  121673. }
  121674. declare module BABYLON {
  121675. /**
  121676. * Options allowed during the creation of a sound track.
  121677. */
  121678. export interface ISoundTrackOptions {
  121679. /**
  121680. * The volume the sound track should take during creation
  121681. */
  121682. volume?: number;
  121683. /**
  121684. * Define if the sound track is the main sound track of the scene
  121685. */
  121686. mainTrack?: boolean;
  121687. }
  121688. /**
  121689. * It could be useful to isolate your music & sounds on several tracks to better manage volume on a grouped instance of sounds.
  121690. * It will be also used in a future release to apply effects on a specific track.
  121691. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  121692. */
  121693. export class SoundTrack {
  121694. /**
  121695. * The unique identifier of the sound track in the scene.
  121696. */
  121697. id: number;
  121698. /**
  121699. * The list of sounds included in the sound track.
  121700. */
  121701. soundCollection: Array<Sound>;
  121702. private _outputAudioNode;
  121703. private _scene;
  121704. private _connectedAnalyser;
  121705. private _options;
  121706. private _isInitialized;
  121707. /**
  121708. * Creates a new sound track.
  121709. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  121710. * @param scene Define the scene the sound track belongs to
  121711. * @param options
  121712. */
  121713. constructor(scene: Scene, options?: ISoundTrackOptions);
  121714. private _initializeSoundTrackAudioGraph;
  121715. /**
  121716. * Release the sound track and its associated resources
  121717. */
  121718. dispose(): void;
  121719. /**
  121720. * Adds a sound to this sound track
  121721. * @param sound define the cound to add
  121722. * @ignoreNaming
  121723. */
  121724. AddSound(sound: Sound): void;
  121725. /**
  121726. * Removes a sound to this sound track
  121727. * @param sound define the cound to remove
  121728. * @ignoreNaming
  121729. */
  121730. RemoveSound(sound: Sound): void;
  121731. /**
  121732. * Set a global volume for the full sound track.
  121733. * @param newVolume Define the new volume of the sound track
  121734. */
  121735. setVolume(newVolume: number): void;
  121736. /**
  121737. * Switch the panning model to HRTF:
  121738. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  121739. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121740. */
  121741. switchPanningModelToHRTF(): void;
  121742. /**
  121743. * Switch the panning model to Equal Power:
  121744. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  121745. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121746. */
  121747. switchPanningModelToEqualPower(): void;
  121748. /**
  121749. * Connect the sound track to an audio analyser allowing some amazing
  121750. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  121751. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  121752. * @param analyser The analyser to connect to the engine
  121753. */
  121754. connectToAnalyser(analyser: Analyser): void;
  121755. }
  121756. }
  121757. declare module BABYLON {
  121758. interface AbstractScene {
  121759. /**
  121760. * The list of sounds used in the scene.
  121761. */
  121762. sounds: Nullable<Array<Sound>>;
  121763. }
  121764. interface Scene {
  121765. /**
  121766. * @hidden
  121767. * Backing field
  121768. */
  121769. _mainSoundTrack: SoundTrack;
  121770. /**
  121771. * The main sound track played by the scene.
  121772. * It cotains your primary collection of sounds.
  121773. */
  121774. mainSoundTrack: SoundTrack;
  121775. /**
  121776. * The list of sound tracks added to the scene
  121777. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  121778. */
  121779. soundTracks: Nullable<Array<SoundTrack>>;
  121780. /**
  121781. * Gets a sound using a given name
  121782. * @param name defines the name to search for
  121783. * @return the found sound or null if not found at all.
  121784. */
  121785. getSoundByName(name: string): Nullable<Sound>;
  121786. /**
  121787. * Gets or sets if audio support is enabled
  121788. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  121789. */
  121790. audioEnabled: boolean;
  121791. /**
  121792. * Gets or sets if audio will be output to headphones
  121793. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  121794. */
  121795. headphone: boolean;
  121796. /**
  121797. * Gets or sets custom audio listener position provider
  121798. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  121799. */
  121800. audioListenerPositionProvider: Nullable<() => Vector3>;
  121801. /**
  121802. * Gets or sets a refresh rate when using 3D audio positioning
  121803. */
  121804. audioPositioningRefreshRate: number;
  121805. }
  121806. /**
  121807. * Defines the sound scene component responsible to manage any sounds
  121808. * in a given scene.
  121809. */
  121810. export class AudioSceneComponent implements ISceneSerializableComponent {
  121811. private static _CameraDirectionLH;
  121812. private static _CameraDirectionRH;
  121813. /**
  121814. * The component name helpfull to identify the component in the list of scene components.
  121815. */
  121816. readonly name: string;
  121817. /**
  121818. * The scene the component belongs to.
  121819. */
  121820. scene: Scene;
  121821. private _audioEnabled;
  121822. /**
  121823. * Gets whether audio is enabled or not.
  121824. * Please use related enable/disable method to switch state.
  121825. */
  121826. get audioEnabled(): boolean;
  121827. private _headphone;
  121828. /**
  121829. * Gets whether audio is outputing to headphone or not.
  121830. * Please use the according Switch methods to change output.
  121831. */
  121832. get headphone(): boolean;
  121833. /**
  121834. * Gets or sets a refresh rate when using 3D audio positioning
  121835. */
  121836. audioPositioningRefreshRate: number;
  121837. private _audioListenerPositionProvider;
  121838. /**
  121839. * Gets the current audio listener position provider
  121840. */
  121841. get audioListenerPositionProvider(): Nullable<() => Vector3>;
  121842. /**
  121843. * Sets a custom listener position for all sounds in the scene
  121844. * By default, this is the position of the first active camera
  121845. */
  121846. set audioListenerPositionProvider(value: Nullable<() => Vector3>);
  121847. /**
  121848. * Creates a new instance of the component for the given scene
  121849. * @param scene Defines the scene to register the component in
  121850. */
  121851. constructor(scene: Scene);
  121852. /**
  121853. * Registers the component in a given scene
  121854. */
  121855. register(): void;
  121856. /**
  121857. * Rebuilds the elements related to this component in case of
  121858. * context lost for instance.
  121859. */
  121860. rebuild(): void;
  121861. /**
  121862. * Serializes the component data to the specified json object
  121863. * @param serializationObject The object to serialize to
  121864. */
  121865. serialize(serializationObject: any): void;
  121866. /**
  121867. * Adds all the elements from the container to the scene
  121868. * @param container the container holding the elements
  121869. */
  121870. addFromContainer(container: AbstractScene): void;
  121871. /**
  121872. * Removes all the elements in the container from the scene
  121873. * @param container contains the elements to remove
  121874. * @param dispose if the removed element should be disposed (default: false)
  121875. */
  121876. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  121877. /**
  121878. * Disposes the component and the associated ressources.
  121879. */
  121880. dispose(): void;
  121881. /**
  121882. * Disables audio in the associated scene.
  121883. */
  121884. disableAudio(): void;
  121885. /**
  121886. * Enables audio in the associated scene.
  121887. */
  121888. enableAudio(): void;
  121889. /**
  121890. * Switch audio to headphone output.
  121891. */
  121892. switchAudioModeForHeadphones(): void;
  121893. /**
  121894. * Switch audio to normal speakers.
  121895. */
  121896. switchAudioModeForNormalSpeakers(): void;
  121897. private _cachedCameraDirection;
  121898. private _cachedCameraPosition;
  121899. private _lastCheck;
  121900. private _afterRender;
  121901. }
  121902. }
  121903. declare module BABYLON {
  121904. /**
  121905. * Wraps one or more Sound objects and selects one with random weight for playback.
  121906. */
  121907. export class WeightedSound {
  121908. /** When true a Sound will be selected and played when the current playing Sound completes. */
  121909. loop: boolean;
  121910. private _coneInnerAngle;
  121911. private _coneOuterAngle;
  121912. private _volume;
  121913. /** A Sound is currently playing. */
  121914. isPlaying: boolean;
  121915. /** A Sound is currently paused. */
  121916. isPaused: boolean;
  121917. private _sounds;
  121918. private _weights;
  121919. private _currentIndex?;
  121920. /**
  121921. * Creates a new WeightedSound from the list of sounds given.
  121922. * @param loop When true a Sound will be selected and played when the current playing Sound completes.
  121923. * @param sounds Array of Sounds that will be selected from.
  121924. * @param weights Array of number values for selection weights; length must equal sounds, values will be normalized to 1
  121925. */
  121926. constructor(loop: boolean, sounds: Sound[], weights: number[]);
  121927. /**
  121928. * The size of cone in degrees for a directional sound in which there will be no attenuation.
  121929. */
  121930. get directionalConeInnerAngle(): number;
  121931. /**
  121932. * The size of cone in degress for a directional sound in which there will be no attenuation.
  121933. */
  121934. set directionalConeInnerAngle(value: number);
  121935. /**
  121936. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  121937. * Listener angles between innerAngle and outerAngle will falloff linearly.
  121938. */
  121939. get directionalConeOuterAngle(): number;
  121940. /**
  121941. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  121942. * Listener angles between innerAngle and outerAngle will falloff linearly.
  121943. */
  121944. set directionalConeOuterAngle(value: number);
  121945. /**
  121946. * Playback volume.
  121947. */
  121948. get volume(): number;
  121949. /**
  121950. * Playback volume.
  121951. */
  121952. set volume(value: number);
  121953. private _onended;
  121954. /**
  121955. * Suspend playback
  121956. */
  121957. pause(): void;
  121958. /**
  121959. * Stop playback
  121960. */
  121961. stop(): void;
  121962. /**
  121963. * Start playback.
  121964. * @param startOffset Position the clip head at a specific time in seconds.
  121965. */
  121966. play(startOffset?: number): void;
  121967. }
  121968. }
  121969. declare module BABYLON {
  121970. /**
  121971. * Add a bouncing effect to an ArcRotateCamera when reaching a specified minimum and maximum radius
  121972. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  121973. */
  121974. export class BouncingBehavior implements Behavior<ArcRotateCamera> {
  121975. /**
  121976. * Gets the name of the behavior.
  121977. */
  121978. get name(): string;
  121979. /**
  121980. * The easing function used by animations
  121981. */
  121982. static EasingFunction: BackEase;
  121983. /**
  121984. * The easing mode used by animations
  121985. */
  121986. static EasingMode: number;
  121987. /**
  121988. * The duration of the animation, in milliseconds
  121989. */
  121990. transitionDuration: number;
  121991. /**
  121992. * Length of the distance animated by the transition when lower radius is reached
  121993. */
  121994. lowerRadiusTransitionRange: number;
  121995. /**
  121996. * Length of the distance animated by the transition when upper radius is reached
  121997. */
  121998. upperRadiusTransitionRange: number;
  121999. private _autoTransitionRange;
  122000. /**
  122001. * Gets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  122002. */
  122003. get autoTransitionRange(): boolean;
  122004. /**
  122005. * Sets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  122006. * Transition ranges will be set to 5% of the bounding box diagonal in world space
  122007. */
  122008. set autoTransitionRange(value: boolean);
  122009. private _attachedCamera;
  122010. private _onAfterCheckInputsObserver;
  122011. private _onMeshTargetChangedObserver;
  122012. /**
  122013. * Initializes the behavior.
  122014. */
  122015. init(): void;
  122016. /**
  122017. * Attaches the behavior to its arc rotate camera.
  122018. * @param camera Defines the camera to attach the behavior to
  122019. */
  122020. attach(camera: ArcRotateCamera): void;
  122021. /**
  122022. * Detaches the behavior from its current arc rotate camera.
  122023. */
  122024. detach(): void;
  122025. private _radiusIsAnimating;
  122026. private _radiusBounceTransition;
  122027. private _animatables;
  122028. private _cachedWheelPrecision;
  122029. /**
  122030. * Checks if the camera radius is at the specified limit. Takes into account animation locks.
  122031. * @param radiusLimit The limit to check against.
  122032. * @return Bool to indicate if at limit.
  122033. */
  122034. private _isRadiusAtLimit;
  122035. /**
  122036. * Applies an animation to the radius of the camera, extending by the radiusDelta.
  122037. * @param radiusDelta The delta by which to animate to. Can be negative.
  122038. */
  122039. private _applyBoundRadiusAnimation;
  122040. /**
  122041. * Removes all animation locks. Allows new animations to be added to any of the camera properties.
  122042. */
  122043. protected _clearAnimationLocks(): void;
  122044. /**
  122045. * Stops and removes all animations that have been applied to the camera
  122046. */
  122047. stopAllAnimations(): void;
  122048. }
  122049. }
  122050. declare module BABYLON {
  122051. /**
  122052. * 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.
  122053. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  122054. */
  122055. export class FramingBehavior implements Behavior<ArcRotateCamera> {
  122056. /**
  122057. * Gets the name of the behavior.
  122058. */
  122059. get name(): string;
  122060. private _mode;
  122061. private _radiusScale;
  122062. private _positionScale;
  122063. private _defaultElevation;
  122064. private _elevationReturnTime;
  122065. private _elevationReturnWaitTime;
  122066. private _zoomStopsAnimation;
  122067. private _framingTime;
  122068. /**
  122069. * The easing function used by animations
  122070. */
  122071. static EasingFunction: ExponentialEase;
  122072. /**
  122073. * The easing mode used by animations
  122074. */
  122075. static EasingMode: number;
  122076. /**
  122077. * Sets the current mode used by the behavior
  122078. */
  122079. set mode(mode: number);
  122080. /**
  122081. * Gets current mode used by the behavior.
  122082. */
  122083. get mode(): number;
  122084. /**
  122085. * Sets the scale applied to the radius (1 by default)
  122086. */
  122087. set radiusScale(radius: number);
  122088. /**
  122089. * Gets the scale applied to the radius
  122090. */
  122091. get radiusScale(): number;
  122092. /**
  122093. * Sets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  122094. */
  122095. set positionScale(scale: number);
  122096. /**
  122097. * Gets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  122098. */
  122099. get positionScale(): number;
  122100. /**
  122101. * Sets the angle above/below the horizontal plane to return to when the return to default elevation idle
  122102. * behaviour is triggered, in radians.
  122103. */
  122104. set defaultElevation(elevation: number);
  122105. /**
  122106. * Gets the angle above/below the horizontal plane to return to when the return to default elevation idle
  122107. * behaviour is triggered, in radians.
  122108. */
  122109. get defaultElevation(): number;
  122110. /**
  122111. * Sets the time (in milliseconds) taken to return to the default beta position.
  122112. * Negative value indicates camera should not return to default.
  122113. */
  122114. set elevationReturnTime(speed: number);
  122115. /**
  122116. * Gets the time (in milliseconds) taken to return to the default beta position.
  122117. * Negative value indicates camera should not return to default.
  122118. */
  122119. get elevationReturnTime(): number;
  122120. /**
  122121. * Sets the delay (in milliseconds) taken before the camera returns to the default beta position.
  122122. */
  122123. set elevationReturnWaitTime(time: number);
  122124. /**
  122125. * Gets the delay (in milliseconds) taken before the camera returns to the default beta position.
  122126. */
  122127. get elevationReturnWaitTime(): number;
  122128. /**
  122129. * Sets the flag that indicates if user zooming should stop animation.
  122130. */
  122131. set zoomStopsAnimation(flag: boolean);
  122132. /**
  122133. * Gets the flag that indicates if user zooming should stop animation.
  122134. */
  122135. get zoomStopsAnimation(): boolean;
  122136. /**
  122137. * Sets the transition time when framing the mesh, in milliseconds
  122138. */
  122139. set framingTime(time: number);
  122140. /**
  122141. * Gets the transition time when framing the mesh, in milliseconds
  122142. */
  122143. get framingTime(): number;
  122144. /**
  122145. * Define if the behavior should automatically change the configured
  122146. * camera limits and sensibilities.
  122147. */
  122148. autoCorrectCameraLimitsAndSensibility: boolean;
  122149. private _onPrePointerObservableObserver;
  122150. private _onAfterCheckInputsObserver;
  122151. private _onMeshTargetChangedObserver;
  122152. private _attachedCamera;
  122153. private _isPointerDown;
  122154. private _lastInteractionTime;
  122155. /**
  122156. * Initializes the behavior.
  122157. */
  122158. init(): void;
  122159. /**
  122160. * Attaches the behavior to its arc rotate camera.
  122161. * @param camera Defines the camera to attach the behavior to
  122162. */
  122163. attach(camera: ArcRotateCamera): void;
  122164. /**
  122165. * Detaches the behavior from its current arc rotate camera.
  122166. */
  122167. detach(): void;
  122168. private _animatables;
  122169. private _betaIsAnimating;
  122170. private _betaTransition;
  122171. private _radiusTransition;
  122172. private _vectorTransition;
  122173. /**
  122174. * Targets the given mesh and updates zoom level accordingly.
  122175. * @param mesh The mesh to target.
  122176. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  122177. * @param onAnimationEnd Callback triggered at the end of the framing animation
  122178. */
  122179. zoomOnMesh(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  122180. /**
  122181. * Targets the given mesh with its children and updates zoom level accordingly.
  122182. * @param mesh The mesh to target.
  122183. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  122184. * @param onAnimationEnd Callback triggered at the end of the framing animation
  122185. */
  122186. zoomOnMeshHierarchy(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  122187. /**
  122188. * Targets the given meshes with their children and updates zoom level accordingly.
  122189. * @param meshes The mesh to target.
  122190. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  122191. * @param onAnimationEnd Callback triggered at the end of the framing animation
  122192. */
  122193. zoomOnMeshesHierarchy(meshes: AbstractMesh[], focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  122194. /**
  122195. * Targets the bounding box info defined by its extends and updates zoom level accordingly.
  122196. * @param minimumWorld Determines the smaller position of the bounding box extend
  122197. * @param maximumWorld Determines the bigger position of the bounding box extend
  122198. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  122199. * @param onAnimationEnd Callback triggered at the end of the framing animation
  122200. */
  122201. zoomOnBoundingInfo(minimumWorld: Vector3, maximumWorld: Vector3, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  122202. /**
  122203. * Calculates the lowest radius for the camera based on the bounding box of the mesh.
  122204. * @param mesh The mesh on which to base the calculation. mesh boundingInfo used to estimate necessary
  122205. * frustum width.
  122206. * @return The minimum distance from the primary mesh's center point at which the camera must be kept in order
  122207. * to fully enclose the mesh in the viewing frustum.
  122208. */
  122209. protected _calculateLowerRadiusFromModelBoundingSphere(minimumWorld: Vector3, maximumWorld: Vector3): number;
  122210. /**
  122211. * Keeps the camera above the ground plane. If the user pulls the camera below the ground plane, the camera
  122212. * is automatically returned to its default position (expected to be above ground plane).
  122213. */
  122214. private _maintainCameraAboveGround;
  122215. /**
  122216. * Returns the frustum slope based on the canvas ratio and camera FOV
  122217. * @returns The frustum slope represented as a Vector2 with X and Y slopes
  122218. */
  122219. private _getFrustumSlope;
  122220. /**
  122221. * Removes all animation locks. Allows new animations to be added to any of the arcCamera properties.
  122222. */
  122223. private _clearAnimationLocks;
  122224. /**
  122225. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  122226. */
  122227. private _applyUserInteraction;
  122228. /**
  122229. * Stops and removes all animations that have been applied to the camera
  122230. */
  122231. stopAllAnimations(): void;
  122232. /**
  122233. * Gets a value indicating if the user is moving the camera
  122234. */
  122235. get isUserIsMoving(): boolean;
  122236. /**
  122237. * The camera can move all the way towards the mesh.
  122238. */
  122239. static IgnoreBoundsSizeMode: number;
  122240. /**
  122241. * The camera is not allowed to zoom closer to the mesh than the point at which the adjusted bounding sphere touches the frustum sides
  122242. */
  122243. static FitFrustumSidesMode: number;
  122244. }
  122245. }
  122246. declare module BABYLON {
  122247. /**
  122248. * Base class for Camera Pointer Inputs.
  122249. * See FollowCameraPointersInput in src/Cameras/Inputs/followCameraPointersInput.ts
  122250. * for example usage.
  122251. */
  122252. export abstract class BaseCameraPointersInput implements ICameraInput<Camera> {
  122253. /**
  122254. * Defines the camera the input is attached to.
  122255. */
  122256. abstract camera: Camera;
  122257. /**
  122258. * Whether keyboard modifier keys are pressed at time of last mouse event.
  122259. */
  122260. protected _altKey: boolean;
  122261. protected _ctrlKey: boolean;
  122262. protected _metaKey: boolean;
  122263. protected _shiftKey: boolean;
  122264. /**
  122265. * Which mouse buttons were pressed at time of last mouse event.
  122266. * https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/buttons
  122267. */
  122268. protected _buttonsPressed: number;
  122269. /**
  122270. * Defines the buttons associated with the input to handle camera move.
  122271. */
  122272. buttons: number[];
  122273. /**
  122274. * Attach the input controls to a specific dom element to get the input from.
  122275. * @param element Defines the element the controls should be listened from
  122276. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  122277. */
  122278. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  122279. /**
  122280. * Detach the current controls from the specified dom element.
  122281. * @param element Defines the element to stop listening the inputs from
  122282. */
  122283. detachControl(element: Nullable<HTMLElement>): void;
  122284. /**
  122285. * Gets the class name of the current input.
  122286. * @returns the class name
  122287. */
  122288. getClassName(): string;
  122289. /**
  122290. * Get the friendly name associated with the input class.
  122291. * @returns the input friendly name
  122292. */
  122293. getSimpleName(): string;
  122294. /**
  122295. * Called on pointer POINTERDOUBLETAP event.
  122296. * Override this method to provide functionality on POINTERDOUBLETAP event.
  122297. */
  122298. protected onDoubleTap(type: string): void;
  122299. /**
  122300. * Called on pointer POINTERMOVE event if only a single touch is active.
  122301. * Override this method to provide functionality.
  122302. */
  122303. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  122304. /**
  122305. * Called on pointer POINTERMOVE event if multiple touches are active.
  122306. * Override this method to provide functionality.
  122307. */
  122308. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  122309. /**
  122310. * Called on JS contextmenu event.
  122311. * Override this method to provide functionality.
  122312. */
  122313. protected onContextMenu(evt: PointerEvent): void;
  122314. /**
  122315. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  122316. * press.
  122317. * Override this method to provide functionality.
  122318. */
  122319. protected onButtonDown(evt: PointerEvent): void;
  122320. /**
  122321. * Called each time a new POINTERUP event occurs. Ie, for each button
  122322. * release.
  122323. * Override this method to provide functionality.
  122324. */
  122325. protected onButtonUp(evt: PointerEvent): void;
  122326. /**
  122327. * Called when window becomes inactive.
  122328. * Override this method to provide functionality.
  122329. */
  122330. protected onLostFocus(): void;
  122331. private _pointerInput;
  122332. private _observer;
  122333. private _onLostFocus;
  122334. private pointA;
  122335. private pointB;
  122336. }
  122337. }
  122338. declare module BABYLON {
  122339. /**
  122340. * Manage the pointers inputs to control an arc rotate camera.
  122341. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  122342. */
  122343. export class ArcRotateCameraPointersInput extends BaseCameraPointersInput {
  122344. /**
  122345. * Defines the camera the input is attached to.
  122346. */
  122347. camera: ArcRotateCamera;
  122348. /**
  122349. * Gets the class name of the current input.
  122350. * @returns the class name
  122351. */
  122352. getClassName(): string;
  122353. /**
  122354. * Defines the buttons associated with the input to handle camera move.
  122355. */
  122356. buttons: number[];
  122357. /**
  122358. * Defines the pointer angular sensibility along the X axis or how fast is
  122359. * the camera rotating.
  122360. */
  122361. angularSensibilityX: number;
  122362. /**
  122363. * Defines the pointer angular sensibility along the Y axis or how fast is
  122364. * the camera rotating.
  122365. */
  122366. angularSensibilityY: number;
  122367. /**
  122368. * Defines the pointer pinch precision or how fast is the camera zooming.
  122369. */
  122370. pinchPrecision: number;
  122371. /**
  122372. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  122373. * from 0.
  122374. * It defines the percentage of current camera.radius to use as delta when
  122375. * pinch zoom is used.
  122376. */
  122377. pinchDeltaPercentage: number;
  122378. /**
  122379. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  122380. * that any object in the plane at the camera's target point will scale
  122381. * perfectly with finger motion.
  122382. * Overrides pinchDeltaPercentage and pinchPrecision.
  122383. */
  122384. useNaturalPinchZoom: boolean;
  122385. /**
  122386. * Defines the pointer panning sensibility or how fast is the camera moving.
  122387. */
  122388. panningSensibility: number;
  122389. /**
  122390. * Defines whether panning (2 fingers swipe) is enabled through multitouch.
  122391. */
  122392. multiTouchPanning: boolean;
  122393. /**
  122394. * Defines whether panning is enabled for both pan (2 fingers swipe) and
  122395. * zoom (pinch) through multitouch.
  122396. */
  122397. multiTouchPanAndZoom: boolean;
  122398. /**
  122399. * Revers pinch action direction.
  122400. */
  122401. pinchInwards: boolean;
  122402. private _isPanClick;
  122403. private _twoFingerActivityCount;
  122404. private _isPinching;
  122405. /**
  122406. * Called on pointer POINTERMOVE event if only a single touch is active.
  122407. */
  122408. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  122409. /**
  122410. * Called on pointer POINTERDOUBLETAP event.
  122411. */
  122412. protected onDoubleTap(type: string): void;
  122413. /**
  122414. * Called on pointer POINTERMOVE event if multiple touches are active.
  122415. */
  122416. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  122417. /**
  122418. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  122419. * press.
  122420. */
  122421. protected onButtonDown(evt: PointerEvent): void;
  122422. /**
  122423. * Called each time a new POINTERUP event occurs. Ie, for each button
  122424. * release.
  122425. */
  122426. protected onButtonUp(evt: PointerEvent): void;
  122427. /**
  122428. * Called when window becomes inactive.
  122429. */
  122430. protected onLostFocus(): void;
  122431. }
  122432. }
  122433. declare module BABYLON {
  122434. /**
  122435. * Manage the keyboard inputs to control the movement of an arc rotate camera.
  122436. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  122437. */
  122438. export class ArcRotateCameraKeyboardMoveInput implements ICameraInput<ArcRotateCamera> {
  122439. /**
  122440. * Defines the camera the input is attached to.
  122441. */
  122442. camera: ArcRotateCamera;
  122443. /**
  122444. * Defines the list of key codes associated with the up action (increase alpha)
  122445. */
  122446. keysUp: number[];
  122447. /**
  122448. * Defines the list of key codes associated with the down action (decrease alpha)
  122449. */
  122450. keysDown: number[];
  122451. /**
  122452. * Defines the list of key codes associated with the left action (increase beta)
  122453. */
  122454. keysLeft: number[];
  122455. /**
  122456. * Defines the list of key codes associated with the right action (decrease beta)
  122457. */
  122458. keysRight: number[];
  122459. /**
  122460. * Defines the list of key codes associated with the reset action.
  122461. * Those keys reset the camera to its last stored state (with the method camera.storeState())
  122462. */
  122463. keysReset: number[];
  122464. /**
  122465. * Defines the panning sensibility of the inputs.
  122466. * (How fast is the camera panning)
  122467. */
  122468. panningSensibility: number;
  122469. /**
  122470. * Defines the zooming sensibility of the inputs.
  122471. * (How fast is the camera zooming)
  122472. */
  122473. zoomingSensibility: number;
  122474. /**
  122475. * Defines whether maintaining the alt key down switch the movement mode from
  122476. * orientation to zoom.
  122477. */
  122478. useAltToZoom: boolean;
  122479. /**
  122480. * Rotation speed of the camera
  122481. */
  122482. angularSpeed: number;
  122483. private _keys;
  122484. private _ctrlPressed;
  122485. private _altPressed;
  122486. private _onCanvasBlurObserver;
  122487. private _onKeyboardObserver;
  122488. private _engine;
  122489. private _scene;
  122490. /**
  122491. * Attach the input controls to a specific dom element to get the input from.
  122492. * @param element Defines the element the controls should be listened from
  122493. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  122494. */
  122495. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  122496. /**
  122497. * Detach the current controls from the specified dom element.
  122498. * @param element Defines the element to stop listening the inputs from
  122499. */
  122500. detachControl(element: Nullable<HTMLElement>): void;
  122501. /**
  122502. * Update the current camera state depending on the inputs that have been used this frame.
  122503. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  122504. */
  122505. checkInputs(): void;
  122506. /**
  122507. * Gets the class name of the current intput.
  122508. * @returns the class name
  122509. */
  122510. getClassName(): string;
  122511. /**
  122512. * Get the friendly name associated with the input class.
  122513. * @returns the input friendly name
  122514. */
  122515. getSimpleName(): string;
  122516. }
  122517. }
  122518. declare module BABYLON {
  122519. /**
  122520. * Manage the mouse wheel inputs to control an arc rotate camera.
  122521. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  122522. */
  122523. export class ArcRotateCameraMouseWheelInput implements ICameraInput<ArcRotateCamera> {
  122524. /**
  122525. * Defines the camera the input is attached to.
  122526. */
  122527. camera: ArcRotateCamera;
  122528. /**
  122529. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  122530. */
  122531. wheelPrecision: number;
  122532. /**
  122533. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  122534. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  122535. */
  122536. wheelDeltaPercentage: number;
  122537. private _wheel;
  122538. private _observer;
  122539. private computeDeltaFromMouseWheelLegacyEvent;
  122540. /**
  122541. * Attach the input controls to a specific dom element to get the input from.
  122542. * @param element Defines the element the controls should be listened from
  122543. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  122544. */
  122545. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  122546. /**
  122547. * Detach the current controls from the specified dom element.
  122548. * @param element Defines the element to stop listening the inputs from
  122549. */
  122550. detachControl(element: Nullable<HTMLElement>): void;
  122551. /**
  122552. * Gets the class name of the current intput.
  122553. * @returns the class name
  122554. */
  122555. getClassName(): string;
  122556. /**
  122557. * Get the friendly name associated with the input class.
  122558. * @returns the input friendly name
  122559. */
  122560. getSimpleName(): string;
  122561. }
  122562. }
  122563. declare module BABYLON {
  122564. /**
  122565. * Default Inputs manager for the ArcRotateCamera.
  122566. * It groups all the default supported inputs for ease of use.
  122567. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  122568. */
  122569. export class ArcRotateCameraInputsManager extends CameraInputsManager<ArcRotateCamera> {
  122570. /**
  122571. * Instantiates a new ArcRotateCameraInputsManager.
  122572. * @param camera Defines the camera the inputs belong to
  122573. */
  122574. constructor(camera: ArcRotateCamera);
  122575. /**
  122576. * Add mouse wheel input support to the input manager.
  122577. * @returns the current input manager
  122578. */
  122579. addMouseWheel(): ArcRotateCameraInputsManager;
  122580. /**
  122581. * Add pointers input support to the input manager.
  122582. * @returns the current input manager
  122583. */
  122584. addPointers(): ArcRotateCameraInputsManager;
  122585. /**
  122586. * Add keyboard input support to the input manager.
  122587. * @returns the current input manager
  122588. */
  122589. addKeyboard(): ArcRotateCameraInputsManager;
  122590. }
  122591. }
  122592. declare module BABYLON {
  122593. /**
  122594. * This represents an orbital type of camera.
  122595. *
  122596. * 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.
  122597. * 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.
  122598. * @see https://doc.babylonjs.com/babylon101/cameras#arc-rotate-camera
  122599. */
  122600. export class ArcRotateCamera extends TargetCamera {
  122601. /**
  122602. * Defines the rotation angle of the camera along the longitudinal axis.
  122603. */
  122604. alpha: number;
  122605. /**
  122606. * Defines the rotation angle of the camera along the latitudinal axis.
  122607. */
  122608. beta: number;
  122609. /**
  122610. * Defines the radius of the camera from it s target point.
  122611. */
  122612. radius: number;
  122613. protected _target: Vector3;
  122614. protected _targetHost: Nullable<AbstractMesh>;
  122615. /**
  122616. * Defines the target point of the camera.
  122617. * The camera looks towards it form the radius distance.
  122618. * Please note that you can set the target to a mesh and thus the target will be copied from mesh.position
  122619. */
  122620. get target(): Vector3;
  122621. set target(value: Vector3);
  122622. /**
  122623. * Define the current local position of the camera in the scene
  122624. */
  122625. get position(): Vector3;
  122626. set position(newPosition: Vector3);
  122627. protected _upToYMatrix: Matrix;
  122628. protected _YToUpMatrix: Matrix;
  122629. /**
  122630. * The vector the camera should consider as up. (default is Vector3(0, 1, 0) as returned by Vector3.Up())
  122631. * Setting this will copy the given vector to the camera's upVector, and set rotation matrices to and from Y up.
  122632. * DO NOT set the up vector using copyFrom or copyFromFloats, as this bypasses setting the above matrices.
  122633. */
  122634. set upVector(vec: Vector3);
  122635. get upVector(): Vector3;
  122636. /**
  122637. * Sets the Y-up to camera up-vector rotation matrix, and the up-vector to Y-up rotation matrix.
  122638. */
  122639. setMatUp(): void;
  122640. /**
  122641. * Current inertia value on the longitudinal axis.
  122642. * The bigger this number the longer it will take for the camera to stop.
  122643. */
  122644. inertialAlphaOffset: number;
  122645. /**
  122646. * Current inertia value on the latitudinal axis.
  122647. * The bigger this number the longer it will take for the camera to stop.
  122648. */
  122649. inertialBetaOffset: number;
  122650. /**
  122651. * Current inertia value on the radius axis.
  122652. * The bigger this number the longer it will take for the camera to stop.
  122653. */
  122654. inertialRadiusOffset: number;
  122655. /**
  122656. * Minimum allowed angle on the longitudinal axis.
  122657. * This can help limiting how the Camera is able to move in the scene.
  122658. */
  122659. lowerAlphaLimit: Nullable<number>;
  122660. /**
  122661. * Maximum allowed angle on the longitudinal axis.
  122662. * This can help limiting how the Camera is able to move in the scene.
  122663. */
  122664. upperAlphaLimit: Nullable<number>;
  122665. /**
  122666. * Minimum allowed angle on the latitudinal axis.
  122667. * This can help limiting how the Camera is able to move in the scene.
  122668. */
  122669. lowerBetaLimit: number;
  122670. /**
  122671. * Maximum allowed angle on the latitudinal axis.
  122672. * This can help limiting how the Camera is able to move in the scene.
  122673. */
  122674. upperBetaLimit: number;
  122675. /**
  122676. * Minimum allowed distance of the camera to the target (The camera can not get closer).
  122677. * This can help limiting how the Camera is able to move in the scene.
  122678. */
  122679. lowerRadiusLimit: Nullable<number>;
  122680. /**
  122681. * Maximum allowed distance of the camera to the target (The camera can not get further).
  122682. * This can help limiting how the Camera is able to move in the scene.
  122683. */
  122684. upperRadiusLimit: Nullable<number>;
  122685. /**
  122686. * Defines the current inertia value used during panning of the camera along the X axis.
  122687. */
  122688. inertialPanningX: number;
  122689. /**
  122690. * Defines the current inertia value used during panning of the camera along the Y axis.
  122691. */
  122692. inertialPanningY: number;
  122693. /**
  122694. * Defines the distance used to consider the camera in pan mode vs pinch/zoom.
  122695. * Basically if your fingers moves away from more than this distance you will be considered
  122696. * in pinch mode.
  122697. */
  122698. pinchToPanMaxDistance: number;
  122699. /**
  122700. * Defines the maximum distance the camera can pan.
  122701. * This could help keeping the cammera always in your scene.
  122702. */
  122703. panningDistanceLimit: Nullable<number>;
  122704. /**
  122705. * Defines the target of the camera before paning.
  122706. */
  122707. panningOriginTarget: Vector3;
  122708. /**
  122709. * Defines the value of the inertia used during panning.
  122710. * 0 would mean stop inertia and one would mean no decelleration at all.
  122711. */
  122712. panningInertia: number;
  122713. /**
  122714. * Gets or Set the pointer angular sensibility along the X axis or how fast is the camera rotating.
  122715. */
  122716. get angularSensibilityX(): number;
  122717. set angularSensibilityX(value: number);
  122718. /**
  122719. * Gets or Set the pointer angular sensibility along the Y axis or how fast is the camera rotating.
  122720. */
  122721. get angularSensibilityY(): number;
  122722. set angularSensibilityY(value: number);
  122723. /**
  122724. * Gets or Set the pointer pinch precision or how fast is the camera zooming.
  122725. */
  122726. get pinchPrecision(): number;
  122727. set pinchPrecision(value: number);
  122728. /**
  122729. * Gets or Set the pointer pinch delta percentage or how fast is the camera zooming.
  122730. * It will be used instead of pinchDeltaPrecision if different from 0.
  122731. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  122732. */
  122733. get pinchDeltaPercentage(): number;
  122734. set pinchDeltaPercentage(value: number);
  122735. /**
  122736. * Gets or Set the pointer use natural pinch zoom to override the pinch precision
  122737. * and pinch delta percentage.
  122738. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  122739. * that any object in the plane at the camera's target point will scale
  122740. * perfectly with finger motion.
  122741. */
  122742. get useNaturalPinchZoom(): boolean;
  122743. set useNaturalPinchZoom(value: boolean);
  122744. /**
  122745. * Gets or Set the pointer panning sensibility or how fast is the camera moving.
  122746. */
  122747. get panningSensibility(): number;
  122748. set panningSensibility(value: number);
  122749. /**
  122750. * Gets or Set the list of keyboard keys used to control beta angle in a positive direction.
  122751. */
  122752. get keysUp(): number[];
  122753. set keysUp(value: number[]);
  122754. /**
  122755. * Gets or Set the list of keyboard keys used to control beta angle in a negative direction.
  122756. */
  122757. get keysDown(): number[];
  122758. set keysDown(value: number[]);
  122759. /**
  122760. * Gets or Set the list of keyboard keys used to control alpha angle in a negative direction.
  122761. */
  122762. get keysLeft(): number[];
  122763. set keysLeft(value: number[]);
  122764. /**
  122765. * Gets or Set the list of keyboard keys used to control alpha angle in a positive direction.
  122766. */
  122767. get keysRight(): number[];
  122768. set keysRight(value: number[]);
  122769. /**
  122770. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  122771. */
  122772. get wheelPrecision(): number;
  122773. set wheelPrecision(value: number);
  122774. /**
  122775. * Gets or Set the mouse wheel delta percentage or how fast is the camera zooming.
  122776. * It will be used instead of pinchDeltaPrecision if different from 0.
  122777. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  122778. */
  122779. get wheelDeltaPercentage(): number;
  122780. set wheelDeltaPercentage(value: number);
  122781. /**
  122782. * Defines how much the radius should be scaled while zomming on a particular mesh (through the zoomOn function)
  122783. */
  122784. zoomOnFactor: number;
  122785. /**
  122786. * Defines a screen offset for the camera position.
  122787. */
  122788. targetScreenOffset: Vector2;
  122789. /**
  122790. * Allows the camera to be completely reversed.
  122791. * If false the camera can not arrive upside down.
  122792. */
  122793. allowUpsideDown: boolean;
  122794. /**
  122795. * Define if double tap/click is used to restore the previously saved state of the camera.
  122796. */
  122797. useInputToRestoreState: boolean;
  122798. /** @hidden */
  122799. _viewMatrix: Matrix;
  122800. /** @hidden */
  122801. _useCtrlForPanning: boolean;
  122802. /** @hidden */
  122803. _panningMouseButton: number;
  122804. /**
  122805. * Defines the input associated to the camera.
  122806. */
  122807. inputs: ArcRotateCameraInputsManager;
  122808. /** @hidden */
  122809. _reset: () => void;
  122810. /**
  122811. * Defines the allowed panning axis.
  122812. */
  122813. panningAxis: Vector3;
  122814. protected _localDirection: Vector3;
  122815. protected _transformedDirection: Vector3;
  122816. private _bouncingBehavior;
  122817. /**
  122818. * Gets the bouncing behavior of the camera if it has been enabled.
  122819. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  122820. */
  122821. get bouncingBehavior(): Nullable<BouncingBehavior>;
  122822. /**
  122823. * Defines if the bouncing behavior of the camera is enabled on the camera.
  122824. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  122825. */
  122826. get useBouncingBehavior(): boolean;
  122827. set useBouncingBehavior(value: boolean);
  122828. private _framingBehavior;
  122829. /**
  122830. * Gets the framing behavior of the camera if it has been enabled.
  122831. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  122832. */
  122833. get framingBehavior(): Nullable<FramingBehavior>;
  122834. /**
  122835. * Defines if the framing behavior of the camera is enabled on the camera.
  122836. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  122837. */
  122838. get useFramingBehavior(): boolean;
  122839. set useFramingBehavior(value: boolean);
  122840. private _autoRotationBehavior;
  122841. /**
  122842. * Gets the auto rotation behavior of the camera if it has been enabled.
  122843. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  122844. */
  122845. get autoRotationBehavior(): Nullable<AutoRotationBehavior>;
  122846. /**
  122847. * Defines if the auto rotation behavior of the camera is enabled on the camera.
  122848. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  122849. */
  122850. get useAutoRotationBehavior(): boolean;
  122851. set useAutoRotationBehavior(value: boolean);
  122852. /**
  122853. * Observable triggered when the mesh target has been changed on the camera.
  122854. */
  122855. onMeshTargetChangedObservable: Observable<Nullable<AbstractMesh>>;
  122856. /**
  122857. * Event raised when the camera is colliding with a mesh.
  122858. */
  122859. onCollide: (collidedMesh: AbstractMesh) => void;
  122860. /**
  122861. * Defines whether the camera should check collision with the objects oh the scene.
  122862. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#how-can-i-do-this
  122863. */
  122864. checkCollisions: boolean;
  122865. /**
  122866. * Defines the collision radius of the camera.
  122867. * This simulates a sphere around the camera.
  122868. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  122869. */
  122870. collisionRadius: Vector3;
  122871. protected _collider: Collider;
  122872. protected _previousPosition: Vector3;
  122873. protected _collisionVelocity: Vector3;
  122874. protected _newPosition: Vector3;
  122875. protected _previousAlpha: number;
  122876. protected _previousBeta: number;
  122877. protected _previousRadius: number;
  122878. protected _collisionTriggered: boolean;
  122879. protected _targetBoundingCenter: Nullable<Vector3>;
  122880. private _computationVector;
  122881. /**
  122882. * Instantiates a new ArcRotateCamera in a given scene
  122883. * @param name Defines the name of the camera
  122884. * @param alpha Defines the camera rotation along the logitudinal axis
  122885. * @param beta Defines the camera rotation along the latitudinal axis
  122886. * @param radius Defines the camera distance from its target
  122887. * @param target Defines the camera target
  122888. * @param scene Defines the scene the camera belongs to
  122889. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  122890. */
  122891. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  122892. /** @hidden */
  122893. _initCache(): void;
  122894. /** @hidden */
  122895. _updateCache(ignoreParentClass?: boolean): void;
  122896. protected _getTargetPosition(): Vector3;
  122897. private _storedAlpha;
  122898. private _storedBeta;
  122899. private _storedRadius;
  122900. private _storedTarget;
  122901. private _storedTargetScreenOffset;
  122902. /**
  122903. * Stores the current state of the camera (alpha, beta, radius and target)
  122904. * @returns the camera itself
  122905. */
  122906. storeState(): Camera;
  122907. /**
  122908. * @hidden
  122909. * Restored camera state. You must call storeState() first
  122910. */
  122911. _restoreStateValues(): boolean;
  122912. /** @hidden */
  122913. _isSynchronizedViewMatrix(): boolean;
  122914. /**
  122915. * Attached controls to the current camera.
  122916. * @param element Defines the element the controls should be listened from
  122917. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  122918. * @param useCtrlForPanning Defines whether ctrl is used for paning within the controls
  122919. * @param panningMouseButton Defines whether panning is allowed through mouse click button
  122920. */
  122921. attachControl(element: HTMLElement, noPreventDefault?: boolean, useCtrlForPanning?: boolean, panningMouseButton?: number): void;
  122922. /**
  122923. * Detach the current controls from the camera.
  122924. * The camera will stop reacting to inputs.
  122925. * @param element Defines the element to stop listening the inputs from
  122926. */
  122927. detachControl(element: HTMLElement): void;
  122928. /** @hidden */
  122929. _checkInputs(): void;
  122930. protected _checkLimits(): void;
  122931. /**
  122932. * Rebuilds angles (alpha, beta) and radius from the give position and target
  122933. */
  122934. rebuildAnglesAndRadius(): void;
  122935. /**
  122936. * Use a position to define the current camera related information like alpha, beta and radius
  122937. * @param position Defines the position to set the camera at
  122938. */
  122939. setPosition(position: Vector3): void;
  122940. /**
  122941. * Defines the target the camera should look at.
  122942. * This will automatically adapt alpha beta and radius to fit within the new target.
  122943. * @param target Defines the new target as a Vector or a mesh
  122944. * @param toBoundingCenter In case of a mesh target, defines whether to target the mesh position or its bounding information center
  122945. * @param allowSamePosition If false, prevents reapplying the new computed position if it is identical to the current one (optim)
  122946. */
  122947. setTarget(target: AbstractMesh | Vector3, toBoundingCenter?: boolean, allowSamePosition?: boolean): void;
  122948. /** @hidden */
  122949. _getViewMatrix(): Matrix;
  122950. protected _onCollisionPositionChange: (collisionId: number, newPosition: Vector3, collidedMesh?: Nullable<AbstractMesh>) => void;
  122951. /**
  122952. * Zooms on a mesh to be at the min distance where we could see it fully in the current viewport.
  122953. * @param meshes Defines the mesh to zoom on
  122954. * @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)
  122955. */
  122956. zoomOn(meshes?: AbstractMesh[], doNotUpdateMaxZ?: boolean): void;
  122957. /**
  122958. * Focus on a mesh or a bounding box. This adapts the target and maxRadius if necessary but does not update the current radius.
  122959. * The target will be changed but the radius
  122960. * @param meshesOrMinMaxVectorAndDistance Defines the mesh or bounding info to focus on
  122961. * @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)
  122962. */
  122963. focusOn(meshesOrMinMaxVectorAndDistance: AbstractMesh[] | {
  122964. min: Vector3;
  122965. max: Vector3;
  122966. distance: number;
  122967. }, doNotUpdateMaxZ?: boolean): void;
  122968. /**
  122969. * @override
  122970. * Override Camera.createRigCamera
  122971. */
  122972. createRigCamera(name: string, cameraIndex: number): Camera;
  122973. /**
  122974. * @hidden
  122975. * @override
  122976. * Override Camera._updateRigCameras
  122977. */
  122978. _updateRigCameras(): void;
  122979. /**
  122980. * Destroy the camera and release the current resources hold by it.
  122981. */
  122982. dispose(): void;
  122983. /**
  122984. * Gets the current object class name.
  122985. * @return the class name
  122986. */
  122987. getClassName(): string;
  122988. }
  122989. }
  122990. declare module BABYLON {
  122991. /**
  122992. * The autoRotation behavior (AutoRotationBehavior) is designed to create a smooth rotation of an ArcRotateCamera when there is no user interaction.
  122993. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  122994. */
  122995. export class AutoRotationBehavior implements Behavior<ArcRotateCamera> {
  122996. /**
  122997. * Gets the name of the behavior.
  122998. */
  122999. get name(): string;
  123000. private _zoomStopsAnimation;
  123001. private _idleRotationSpeed;
  123002. private _idleRotationWaitTime;
  123003. private _idleRotationSpinupTime;
  123004. /**
  123005. * Sets the flag that indicates if user zooming should stop animation.
  123006. */
  123007. set zoomStopsAnimation(flag: boolean);
  123008. /**
  123009. * Gets the flag that indicates if user zooming should stop animation.
  123010. */
  123011. get zoomStopsAnimation(): boolean;
  123012. /**
  123013. * Sets the default speed at which the camera rotates around the model.
  123014. */
  123015. set idleRotationSpeed(speed: number);
  123016. /**
  123017. * Gets the default speed at which the camera rotates around the model.
  123018. */
  123019. get idleRotationSpeed(): number;
  123020. /**
  123021. * Sets the time (in milliseconds) to wait after user interaction before the camera starts rotating.
  123022. */
  123023. set idleRotationWaitTime(time: number);
  123024. /**
  123025. * Gets the time (milliseconds) to wait after user interaction before the camera starts rotating.
  123026. */
  123027. get idleRotationWaitTime(): number;
  123028. /**
  123029. * Sets the time (milliseconds) to take to spin up to the full idle rotation speed.
  123030. */
  123031. set idleRotationSpinupTime(time: number);
  123032. /**
  123033. * Gets the time (milliseconds) to take to spin up to the full idle rotation speed.
  123034. */
  123035. get idleRotationSpinupTime(): number;
  123036. /**
  123037. * Gets a value indicating if the camera is currently rotating because of this behavior
  123038. */
  123039. get rotationInProgress(): boolean;
  123040. private _onPrePointerObservableObserver;
  123041. private _onAfterCheckInputsObserver;
  123042. private _attachedCamera;
  123043. private _isPointerDown;
  123044. private _lastFrameTime;
  123045. private _lastInteractionTime;
  123046. private _cameraRotationSpeed;
  123047. /**
  123048. * Initializes the behavior.
  123049. */
  123050. init(): void;
  123051. /**
  123052. * Attaches the behavior to its arc rotate camera.
  123053. * @param camera Defines the camera to attach the behavior to
  123054. */
  123055. attach(camera: ArcRotateCamera): void;
  123056. /**
  123057. * Detaches the behavior from its current arc rotate camera.
  123058. */
  123059. detach(): void;
  123060. /**
  123061. * Returns true if user is scrolling.
  123062. * @return true if user is scrolling.
  123063. */
  123064. private _userIsZooming;
  123065. private _lastFrameRadius;
  123066. private _shouldAnimationStopForInteraction;
  123067. /**
  123068. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  123069. */
  123070. private _applyUserInteraction;
  123071. private _userIsMoving;
  123072. }
  123073. }
  123074. declare module BABYLON {
  123075. /**
  123076. * A behavior that when attached to a mesh will will place a specified node on the meshes face pointing towards the camera
  123077. */
  123078. export class AttachToBoxBehavior implements Behavior<Mesh> {
  123079. private ui;
  123080. /**
  123081. * The name of the behavior
  123082. */
  123083. name: string;
  123084. /**
  123085. * The distance away from the face of the mesh that the UI should be attached to (default: 0.15)
  123086. */
  123087. distanceAwayFromFace: number;
  123088. /**
  123089. * The distance from the bottom of the face that the UI should be attached to (default: 0.15)
  123090. */
  123091. distanceAwayFromBottomOfFace: number;
  123092. private _faceVectors;
  123093. private _target;
  123094. private _scene;
  123095. private _onRenderObserver;
  123096. private _tmpMatrix;
  123097. private _tmpVector;
  123098. /**
  123099. * Creates the AttachToBoxBehavior, used to attach UI to the closest face of the box to a camera
  123100. * @param ui The transform node that should be attched to the mesh
  123101. */
  123102. constructor(ui: TransformNode);
  123103. /**
  123104. * Initializes the behavior
  123105. */
  123106. init(): void;
  123107. private _closestFace;
  123108. private _zeroVector;
  123109. private _lookAtTmpMatrix;
  123110. private _lookAtToRef;
  123111. /**
  123112. * Attaches the AttachToBoxBehavior to the passed in mesh
  123113. * @param target The mesh that the specified node will be attached to
  123114. */
  123115. attach(target: Mesh): void;
  123116. /**
  123117. * Detaches the behavior from the mesh
  123118. */
  123119. detach(): void;
  123120. }
  123121. }
  123122. declare module BABYLON {
  123123. /**
  123124. * A behavior that when attached to a mesh will allow the mesh to fade in and out
  123125. */
  123126. export class FadeInOutBehavior implements Behavior<Mesh> {
  123127. /**
  123128. * Time in milliseconds to delay before fading in (Default: 0)
  123129. */
  123130. delay: number;
  123131. /**
  123132. * Time in milliseconds for the mesh to fade in (Default: 300)
  123133. */
  123134. fadeInTime: number;
  123135. private _millisecondsPerFrame;
  123136. private _hovered;
  123137. private _hoverValue;
  123138. private _ownerNode;
  123139. /**
  123140. * Instatiates the FadeInOutBehavior
  123141. */
  123142. constructor();
  123143. /**
  123144. * The name of the behavior
  123145. */
  123146. get name(): string;
  123147. /**
  123148. * Initializes the behavior
  123149. */
  123150. init(): void;
  123151. /**
  123152. * Attaches the fade behavior on the passed in mesh
  123153. * @param ownerNode The mesh that will be faded in/out once attached
  123154. */
  123155. attach(ownerNode: Mesh): void;
  123156. /**
  123157. * Detaches the behavior from the mesh
  123158. */
  123159. detach(): void;
  123160. /**
  123161. * Triggers the mesh to begin fading in or out
  123162. * @param value if the object should fade in or out (true to fade in)
  123163. */
  123164. fadeIn(value: boolean): void;
  123165. private _update;
  123166. private _setAllVisibility;
  123167. }
  123168. }
  123169. declare module BABYLON {
  123170. /**
  123171. * Class containing a set of static utilities functions for managing Pivots
  123172. * @hidden
  123173. */
  123174. export class PivotTools {
  123175. private static _PivotCached;
  123176. private static _OldPivotPoint;
  123177. private static _PivotTranslation;
  123178. private static _PivotTmpVector;
  123179. private static _PivotPostMultiplyPivotMatrix;
  123180. /** @hidden */
  123181. static _RemoveAndStorePivotPoint(mesh: AbstractMesh): void;
  123182. /** @hidden */
  123183. static _RestorePivotPoint(mesh: AbstractMesh): void;
  123184. }
  123185. }
  123186. declare module BABYLON {
  123187. /**
  123188. * Class containing static functions to help procedurally build meshes
  123189. */
  123190. export class PlaneBuilder {
  123191. /**
  123192. * Creates a plane mesh
  123193. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  123194. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  123195. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  123196. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  123197. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  123198. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  123199. * @param name defines the name of the mesh
  123200. * @param options defines the options used to create the mesh
  123201. * @param scene defines the hosting scene
  123202. * @returns the plane mesh
  123203. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  123204. */
  123205. static CreatePlane(name: string, options: {
  123206. size?: number;
  123207. width?: number;
  123208. height?: number;
  123209. sideOrientation?: number;
  123210. frontUVs?: Vector4;
  123211. backUVs?: Vector4;
  123212. updatable?: boolean;
  123213. sourcePlane?: Plane;
  123214. }, scene?: Nullable<Scene>): Mesh;
  123215. }
  123216. }
  123217. declare module BABYLON {
  123218. /**
  123219. * A behavior that when attached to a mesh will allow the mesh to be dragged around the screen based on pointer events
  123220. */
  123221. export class PointerDragBehavior implements Behavior<AbstractMesh> {
  123222. private static _AnyMouseID;
  123223. /**
  123224. * Abstract mesh the behavior is set on
  123225. */
  123226. attachedNode: AbstractMesh;
  123227. private _dragPlane;
  123228. private _scene;
  123229. private _pointerObserver;
  123230. private _beforeRenderObserver;
  123231. private static _planeScene;
  123232. private _useAlternatePickedPointAboveMaxDragAngleDragSpeed;
  123233. /**
  123234. * 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)
  123235. */
  123236. maxDragAngle: number;
  123237. /**
  123238. * @hidden
  123239. */
  123240. _useAlternatePickedPointAboveMaxDragAngle: boolean;
  123241. /**
  123242. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  123243. */
  123244. currentDraggingPointerID: number;
  123245. /**
  123246. * The last position where the pointer hit the drag plane in world space
  123247. */
  123248. lastDragPosition: Vector3;
  123249. /**
  123250. * If the behavior is currently in a dragging state
  123251. */
  123252. dragging: boolean;
  123253. /**
  123254. * 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)
  123255. */
  123256. dragDeltaRatio: number;
  123257. /**
  123258. * If the drag plane orientation should be updated during the dragging (Default: true)
  123259. */
  123260. updateDragPlane: boolean;
  123261. private _debugMode;
  123262. private _moving;
  123263. /**
  123264. * Fires each time the attached mesh is dragged with the pointer
  123265. * * delta between last drag position and current drag position in world space
  123266. * * dragDistance along the drag axis
  123267. * * dragPlaneNormal normal of the current drag plane used during the drag
  123268. * * dragPlanePoint in world space where the drag intersects the drag plane
  123269. */
  123270. onDragObservable: Observable<{
  123271. delta: Vector3;
  123272. dragPlanePoint: Vector3;
  123273. dragPlaneNormal: Vector3;
  123274. dragDistance: number;
  123275. pointerId: number;
  123276. }>;
  123277. /**
  123278. * Fires each time a drag begins (eg. mouse down on mesh)
  123279. */
  123280. onDragStartObservable: Observable<{
  123281. dragPlanePoint: Vector3;
  123282. pointerId: number;
  123283. }>;
  123284. /**
  123285. * Fires each time a drag ends (eg. mouse release after drag)
  123286. */
  123287. onDragEndObservable: Observable<{
  123288. dragPlanePoint: Vector3;
  123289. pointerId: number;
  123290. }>;
  123291. /**
  123292. * If the attached mesh should be moved when dragged
  123293. */
  123294. moveAttached: boolean;
  123295. /**
  123296. * If the drag behavior will react to drag events (Default: true)
  123297. */
  123298. enabled: boolean;
  123299. /**
  123300. * If pointer events should start and release the drag (Default: true)
  123301. */
  123302. startAndReleaseDragOnPointerEvents: boolean;
  123303. /**
  123304. * If camera controls should be detached during the drag
  123305. */
  123306. detachCameraControls: boolean;
  123307. /**
  123308. * If set, the drag plane/axis will be rotated based on the attached mesh's world rotation (Default: true)
  123309. */
  123310. useObjectOrientationForDragging: boolean;
  123311. private _options;
  123312. /**
  123313. * Gets the options used by the behavior
  123314. */
  123315. get options(): {
  123316. dragAxis?: Vector3;
  123317. dragPlaneNormal?: Vector3;
  123318. };
  123319. /**
  123320. * Sets the options used by the behavior
  123321. */
  123322. set options(options: {
  123323. dragAxis?: Vector3;
  123324. dragPlaneNormal?: Vector3;
  123325. });
  123326. /**
  123327. * Creates a pointer drag behavior that can be attached to a mesh
  123328. * @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)
  123329. */
  123330. constructor(options?: {
  123331. dragAxis?: Vector3;
  123332. dragPlaneNormal?: Vector3;
  123333. });
  123334. /**
  123335. * Predicate to determine if it is valid to move the object to a new position when it is moved
  123336. */
  123337. validateDrag: (targetPosition: Vector3) => boolean;
  123338. /**
  123339. * The name of the behavior
  123340. */
  123341. get name(): string;
  123342. /**
  123343. * Initializes the behavior
  123344. */
  123345. init(): void;
  123346. private _tmpVector;
  123347. private _alternatePickedPoint;
  123348. private _worldDragAxis;
  123349. private _targetPosition;
  123350. private _attachedElement;
  123351. /**
  123352. * Attaches the drag behavior the passed in mesh
  123353. * @param ownerNode The mesh that will be dragged around once attached
  123354. * @param predicate Predicate to use for pick filtering
  123355. */
  123356. attach(ownerNode: AbstractMesh, predicate?: (m: AbstractMesh) => boolean): void;
  123357. /**
  123358. * Force relase the drag action by code.
  123359. */
  123360. releaseDrag(): void;
  123361. private _startDragRay;
  123362. private _lastPointerRay;
  123363. /**
  123364. * Simulates the start of a pointer drag event on the behavior
  123365. * @param pointerId pointerID of the pointer that should be simulated (Default: Any mouse pointer ID)
  123366. * @param fromRay initial ray of the pointer to be simulated (Default: Ray from camera to attached mesh)
  123367. * @param startPickedPoint picked point of the pointer to be simulated (Default: attached mesh position)
  123368. */
  123369. startDrag(pointerId?: number, fromRay?: Ray, startPickedPoint?: Vector3): void;
  123370. private _startDrag;
  123371. private _dragDelta;
  123372. private _moveDrag;
  123373. private _pickWithRayOnDragPlane;
  123374. private _pointA;
  123375. private _pointC;
  123376. private _localAxis;
  123377. private _lookAt;
  123378. private _updateDragPlanePosition;
  123379. /**
  123380. * Detaches the behavior from the mesh
  123381. */
  123382. detach(): void;
  123383. }
  123384. }
  123385. declare module BABYLON {
  123386. /**
  123387. * A behavior that when attached to a mesh will allow the mesh to be scaled
  123388. */
  123389. export class MultiPointerScaleBehavior implements Behavior<Mesh> {
  123390. private _dragBehaviorA;
  123391. private _dragBehaviorB;
  123392. private _startDistance;
  123393. private _initialScale;
  123394. private _targetScale;
  123395. private _ownerNode;
  123396. private _sceneRenderObserver;
  123397. /**
  123398. * Instantiate a new behavior that when attached to a mesh will allow the mesh to be scaled
  123399. */
  123400. constructor();
  123401. /**
  123402. * The name of the behavior
  123403. */
  123404. get name(): string;
  123405. /**
  123406. * Initializes the behavior
  123407. */
  123408. init(): void;
  123409. private _getCurrentDistance;
  123410. /**
  123411. * Attaches the scale behavior the passed in mesh
  123412. * @param ownerNode The mesh that will be scaled around once attached
  123413. */
  123414. attach(ownerNode: Mesh): void;
  123415. /**
  123416. * Detaches the behavior from the mesh
  123417. */
  123418. detach(): void;
  123419. }
  123420. }
  123421. declare module BABYLON {
  123422. /**
  123423. * 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
  123424. */
  123425. export class SixDofDragBehavior implements Behavior<Mesh> {
  123426. private static _virtualScene;
  123427. private _ownerNode;
  123428. private _sceneRenderObserver;
  123429. private _scene;
  123430. private _targetPosition;
  123431. private _virtualOriginMesh;
  123432. private _virtualDragMesh;
  123433. private _pointerObserver;
  123434. private _moving;
  123435. private _startingOrientation;
  123436. private _attachedElement;
  123437. /**
  123438. * 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)
  123439. */
  123440. private zDragFactor;
  123441. /**
  123442. * If the object should rotate to face the drag origin
  123443. */
  123444. rotateDraggedObject: boolean;
  123445. /**
  123446. * If the behavior is currently in a dragging state
  123447. */
  123448. dragging: boolean;
  123449. /**
  123450. * 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)
  123451. */
  123452. dragDeltaRatio: number;
  123453. /**
  123454. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  123455. */
  123456. currentDraggingPointerID: number;
  123457. /**
  123458. * If camera controls should be detached during the drag
  123459. */
  123460. detachCameraControls: boolean;
  123461. /**
  123462. * Fires each time a drag starts
  123463. */
  123464. onDragStartObservable: Observable<{}>;
  123465. /**
  123466. * Fires each time a drag ends (eg. mouse release after drag)
  123467. */
  123468. onDragEndObservable: Observable<{}>;
  123469. /**
  123470. * 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
  123471. */
  123472. constructor();
  123473. /**
  123474. * The name of the behavior
  123475. */
  123476. get name(): string;
  123477. /**
  123478. * Initializes the behavior
  123479. */
  123480. init(): void;
  123481. /**
  123482. * In the case of multiplea active cameras, the cameraToUseForPointers should be used if set instead of active camera
  123483. */
  123484. private get _pointerCamera();
  123485. /**
  123486. * Attaches the scale behavior the passed in mesh
  123487. * @param ownerNode The mesh that will be scaled around once attached
  123488. */
  123489. attach(ownerNode: Mesh): void;
  123490. /**
  123491. * Detaches the behavior from the mesh
  123492. */
  123493. detach(): void;
  123494. }
  123495. }
  123496. declare module BABYLON {
  123497. /**
  123498. * Class used to apply inverse kinematics to bones
  123499. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#boneikcontroller
  123500. */
  123501. export class BoneIKController {
  123502. private static _tmpVecs;
  123503. private static _tmpQuat;
  123504. private static _tmpMats;
  123505. /**
  123506. * Gets or sets the target mesh
  123507. */
  123508. targetMesh: AbstractMesh;
  123509. /** Gets or sets the mesh used as pole */
  123510. poleTargetMesh: AbstractMesh;
  123511. /**
  123512. * Gets or sets the bone used as pole
  123513. */
  123514. poleTargetBone: Nullable<Bone>;
  123515. /**
  123516. * Gets or sets the target position
  123517. */
  123518. targetPosition: Vector3;
  123519. /**
  123520. * Gets or sets the pole target position
  123521. */
  123522. poleTargetPosition: Vector3;
  123523. /**
  123524. * Gets or sets the pole target local offset
  123525. */
  123526. poleTargetLocalOffset: Vector3;
  123527. /**
  123528. * Gets or sets the pole angle
  123529. */
  123530. poleAngle: number;
  123531. /**
  123532. * Gets or sets the mesh associated with the controller
  123533. */
  123534. mesh: AbstractMesh;
  123535. /**
  123536. * 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)
  123537. */
  123538. slerpAmount: number;
  123539. private _bone1Quat;
  123540. private _bone1Mat;
  123541. private _bone2Ang;
  123542. private _bone1;
  123543. private _bone2;
  123544. private _bone1Length;
  123545. private _bone2Length;
  123546. private _maxAngle;
  123547. private _maxReach;
  123548. private _rightHandedSystem;
  123549. private _bendAxis;
  123550. private _slerping;
  123551. private _adjustRoll;
  123552. /**
  123553. * Gets or sets maximum allowed angle
  123554. */
  123555. get maxAngle(): number;
  123556. set maxAngle(value: number);
  123557. /**
  123558. * Creates a new BoneIKController
  123559. * @param mesh defines the mesh to control
  123560. * @param bone defines the bone to control
  123561. * @param options defines options to set up the controller
  123562. */
  123563. constructor(mesh: AbstractMesh, bone: Bone, options?: {
  123564. targetMesh?: AbstractMesh;
  123565. poleTargetMesh?: AbstractMesh;
  123566. poleTargetBone?: Bone;
  123567. poleTargetLocalOffset?: Vector3;
  123568. poleAngle?: number;
  123569. bendAxis?: Vector3;
  123570. maxAngle?: number;
  123571. slerpAmount?: number;
  123572. });
  123573. private _setMaxAngle;
  123574. /**
  123575. * Force the controller to update the bones
  123576. */
  123577. update(): void;
  123578. }
  123579. }
  123580. declare module BABYLON {
  123581. /**
  123582. * Class used to make a bone look toward a point in space
  123583. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#bonelookcontroller
  123584. */
  123585. export class BoneLookController {
  123586. private static _tmpVecs;
  123587. private static _tmpQuat;
  123588. private static _tmpMats;
  123589. /**
  123590. * The target Vector3 that the bone will look at
  123591. */
  123592. target: Vector3;
  123593. /**
  123594. * The mesh that the bone is attached to
  123595. */
  123596. mesh: AbstractMesh;
  123597. /**
  123598. * The bone that will be looking to the target
  123599. */
  123600. bone: Bone;
  123601. /**
  123602. * The up axis of the coordinate system that is used when the bone is rotated
  123603. */
  123604. upAxis: Vector3;
  123605. /**
  123606. * The space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD
  123607. */
  123608. upAxisSpace: Space;
  123609. /**
  123610. * Used to make an adjustment to the yaw of the bone
  123611. */
  123612. adjustYaw: number;
  123613. /**
  123614. * Used to make an adjustment to the pitch of the bone
  123615. */
  123616. adjustPitch: number;
  123617. /**
  123618. * Used to make an adjustment to the roll of the bone
  123619. */
  123620. adjustRoll: number;
  123621. /**
  123622. * 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)
  123623. */
  123624. slerpAmount: number;
  123625. private _minYaw;
  123626. private _maxYaw;
  123627. private _minPitch;
  123628. private _maxPitch;
  123629. private _minYawSin;
  123630. private _minYawCos;
  123631. private _maxYawSin;
  123632. private _maxYawCos;
  123633. private _midYawConstraint;
  123634. private _minPitchTan;
  123635. private _maxPitchTan;
  123636. private _boneQuat;
  123637. private _slerping;
  123638. private _transformYawPitch;
  123639. private _transformYawPitchInv;
  123640. private _firstFrameSkipped;
  123641. private _yawRange;
  123642. private _fowardAxis;
  123643. /**
  123644. * Gets or sets the minimum yaw angle that the bone can look to
  123645. */
  123646. get minYaw(): number;
  123647. set minYaw(value: number);
  123648. /**
  123649. * Gets or sets the maximum yaw angle that the bone can look to
  123650. */
  123651. get maxYaw(): number;
  123652. set maxYaw(value: number);
  123653. /**
  123654. * Gets or sets the minimum pitch angle that the bone can look to
  123655. */
  123656. get minPitch(): number;
  123657. set minPitch(value: number);
  123658. /**
  123659. * Gets or sets the maximum pitch angle that the bone can look to
  123660. */
  123661. get maxPitch(): number;
  123662. set maxPitch(value: number);
  123663. /**
  123664. * Create a BoneLookController
  123665. * @param mesh the mesh that the bone belongs to
  123666. * @param bone the bone that will be looking to the target
  123667. * @param target the target Vector3 to look at
  123668. * @param options optional settings:
  123669. * * maxYaw: the maximum angle the bone will yaw to
  123670. * * minYaw: the minimum angle the bone will yaw to
  123671. * * maxPitch: the maximum angle the bone will pitch to
  123672. * * minPitch: the minimum angle the bone will yaw to
  123673. * * slerpAmount: set the between 0 and 1 to make the bone slerp to the target.
  123674. * * upAxis: the up axis of the coordinate system
  123675. * * upAxisSpace: the space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD.
  123676. * * yawAxis: set yawAxis if the bone does not yaw on the y axis
  123677. * * pitchAxis: set pitchAxis if the bone does not pitch on the x axis
  123678. * * adjustYaw: used to make an adjustment to the yaw of the bone
  123679. * * adjustPitch: used to make an adjustment to the pitch of the bone
  123680. * * adjustRoll: used to make an adjustment to the roll of the bone
  123681. **/
  123682. constructor(mesh: AbstractMesh, bone: Bone, target: Vector3, options?: {
  123683. maxYaw?: number;
  123684. minYaw?: number;
  123685. maxPitch?: number;
  123686. minPitch?: number;
  123687. slerpAmount?: number;
  123688. upAxis?: Vector3;
  123689. upAxisSpace?: Space;
  123690. yawAxis?: Vector3;
  123691. pitchAxis?: Vector3;
  123692. adjustYaw?: number;
  123693. adjustPitch?: number;
  123694. adjustRoll?: number;
  123695. });
  123696. /**
  123697. * Update the bone to look at the target. This should be called before the scene is rendered (use scene.registerBeforeRender())
  123698. */
  123699. update(): void;
  123700. private _getAngleDiff;
  123701. private _getAngleBetween;
  123702. private _isAngleBetween;
  123703. }
  123704. }
  123705. declare module BABYLON {
  123706. /**
  123707. * Manage the gamepad inputs to control an arc rotate camera.
  123708. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123709. */
  123710. export class ArcRotateCameraGamepadInput implements ICameraInput<ArcRotateCamera> {
  123711. /**
  123712. * Defines the camera the input is attached to.
  123713. */
  123714. camera: ArcRotateCamera;
  123715. /**
  123716. * Defines the gamepad the input is gathering event from.
  123717. */
  123718. gamepad: Nullable<Gamepad>;
  123719. /**
  123720. * Defines the gamepad rotation sensiblity.
  123721. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  123722. */
  123723. gamepadRotationSensibility: number;
  123724. /**
  123725. * Defines the gamepad move sensiblity.
  123726. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  123727. */
  123728. gamepadMoveSensibility: number;
  123729. private _yAxisScale;
  123730. /**
  123731. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  123732. */
  123733. get invertYAxis(): boolean;
  123734. set invertYAxis(value: boolean);
  123735. private _onGamepadConnectedObserver;
  123736. private _onGamepadDisconnectedObserver;
  123737. /**
  123738. * Attach the input controls to a specific dom element to get the input from.
  123739. * @param element Defines the element the controls should be listened from
  123740. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  123741. */
  123742. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  123743. /**
  123744. * Detach the current controls from the specified dom element.
  123745. * @param element Defines the element to stop listening the inputs from
  123746. */
  123747. detachControl(element: Nullable<HTMLElement>): void;
  123748. /**
  123749. * Update the current camera state depending on the inputs that have been used this frame.
  123750. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  123751. */
  123752. checkInputs(): void;
  123753. /**
  123754. * Gets the class name of the current intput.
  123755. * @returns the class name
  123756. */
  123757. getClassName(): string;
  123758. /**
  123759. * Get the friendly name associated with the input class.
  123760. * @returns the input friendly name
  123761. */
  123762. getSimpleName(): string;
  123763. }
  123764. }
  123765. declare module BABYLON {
  123766. interface ArcRotateCameraInputsManager {
  123767. /**
  123768. * Add orientation input support to the input manager.
  123769. * @returns the current input manager
  123770. */
  123771. addVRDeviceOrientation(): ArcRotateCameraInputsManager;
  123772. }
  123773. /**
  123774. * Manage the device orientation inputs (gyroscope) to control an arc rotate camera.
  123775. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123776. */
  123777. export class ArcRotateCameraVRDeviceOrientationInput implements ICameraInput<ArcRotateCamera> {
  123778. /**
  123779. * Defines the camera the input is attached to.
  123780. */
  123781. camera: ArcRotateCamera;
  123782. /**
  123783. * Defines a correction factor applied on the alpha value retrieved from the orientation events.
  123784. */
  123785. alphaCorrection: number;
  123786. /**
  123787. * Defines a correction factor applied on the gamma value retrieved from the orientation events.
  123788. */
  123789. gammaCorrection: number;
  123790. private _alpha;
  123791. private _gamma;
  123792. private _dirty;
  123793. private _deviceOrientationHandler;
  123794. /**
  123795. * Instantiate a new ArcRotateCameraVRDeviceOrientationInput.
  123796. */
  123797. constructor();
  123798. /**
  123799. * Attach the input controls to a specific dom element to get the input from.
  123800. * @param element Defines the element the controls should be listened from
  123801. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  123802. */
  123803. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  123804. /** @hidden */
  123805. _onOrientationEvent(evt: DeviceOrientationEvent): void;
  123806. /**
  123807. * Update the current camera state depending on the inputs that have been used this frame.
  123808. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  123809. */
  123810. checkInputs(): void;
  123811. /**
  123812. * Detach the current controls from the specified dom element.
  123813. * @param element Defines the element to stop listening the inputs from
  123814. */
  123815. detachControl(element: Nullable<HTMLElement>): void;
  123816. /**
  123817. * Gets the class name of the current intput.
  123818. * @returns the class name
  123819. */
  123820. getClassName(): string;
  123821. /**
  123822. * Get the friendly name associated with the input class.
  123823. * @returns the input friendly name
  123824. */
  123825. getSimpleName(): string;
  123826. }
  123827. }
  123828. declare module BABYLON {
  123829. /**
  123830. * Listen to mouse events to control the camera.
  123831. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123832. */
  123833. export class FlyCameraMouseInput implements ICameraInput<FlyCamera> {
  123834. /**
  123835. * Defines the camera the input is attached to.
  123836. */
  123837. camera: FlyCamera;
  123838. /**
  123839. * Defines if touch is enabled. (Default is true.)
  123840. */
  123841. touchEnabled: boolean;
  123842. /**
  123843. * Defines the buttons associated with the input to handle camera rotation.
  123844. */
  123845. buttons: number[];
  123846. /**
  123847. * Assign buttons for Yaw control.
  123848. */
  123849. buttonsYaw: number[];
  123850. /**
  123851. * Assign buttons for Pitch control.
  123852. */
  123853. buttonsPitch: number[];
  123854. /**
  123855. * Assign buttons for Roll control.
  123856. */
  123857. buttonsRoll: number[];
  123858. /**
  123859. * Detect if any button is being pressed while mouse is moved.
  123860. * -1 = Mouse locked.
  123861. * 0 = Left button.
  123862. * 1 = Middle Button.
  123863. * 2 = Right Button.
  123864. */
  123865. activeButton: number;
  123866. /**
  123867. * Defines the pointer's angular sensibility, to control the camera rotation speed.
  123868. * Higher values reduce its sensitivity.
  123869. */
  123870. angularSensibility: number;
  123871. private _mousemoveCallback;
  123872. private _observer;
  123873. private _rollObserver;
  123874. private previousPosition;
  123875. private noPreventDefault;
  123876. private element;
  123877. /**
  123878. * Listen to mouse events to control the camera.
  123879. * @param touchEnabled Define if touch is enabled. (Default is true.)
  123880. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123881. */
  123882. constructor(touchEnabled?: boolean);
  123883. /**
  123884. * Attach the mouse control to the HTML DOM element.
  123885. * @param element Defines the element that listens to the input events.
  123886. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault().
  123887. */
  123888. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  123889. /**
  123890. * Detach the current controls from the specified dom element.
  123891. * @param element Defines the element to stop listening the inputs from
  123892. */
  123893. detachControl(element: Nullable<HTMLElement>): void;
  123894. /**
  123895. * Gets the class name of the current input.
  123896. * @returns the class name.
  123897. */
  123898. getClassName(): string;
  123899. /**
  123900. * Get the friendly name associated with the input class.
  123901. * @returns the input's friendly name.
  123902. */
  123903. getSimpleName(): string;
  123904. private _pointerInput;
  123905. private _onMouseMove;
  123906. /**
  123907. * Rotate camera by mouse offset.
  123908. */
  123909. private rotateCamera;
  123910. }
  123911. }
  123912. declare module BABYLON {
  123913. /**
  123914. * Default Inputs manager for the FlyCamera.
  123915. * It groups all the default supported inputs for ease of use.
  123916. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123917. */
  123918. export class FlyCameraInputsManager extends CameraInputsManager<FlyCamera> {
  123919. /**
  123920. * Instantiates a new FlyCameraInputsManager.
  123921. * @param camera Defines the camera the inputs belong to.
  123922. */
  123923. constructor(camera: FlyCamera);
  123924. /**
  123925. * Add keyboard input support to the input manager.
  123926. * @returns the new FlyCameraKeyboardMoveInput().
  123927. */
  123928. addKeyboard(): FlyCameraInputsManager;
  123929. /**
  123930. * Add mouse input support to the input manager.
  123931. * @param touchEnabled Enable touch screen support.
  123932. * @returns the new FlyCameraMouseInput().
  123933. */
  123934. addMouse(touchEnabled?: boolean): FlyCameraInputsManager;
  123935. }
  123936. }
  123937. declare module BABYLON {
  123938. /**
  123939. * This is a flying camera, designed for 3D movement and rotation in all directions,
  123940. * such as in a 3D Space Shooter or a Flight Simulator.
  123941. */
  123942. export class FlyCamera extends TargetCamera {
  123943. /**
  123944. * Define the collision ellipsoid of the camera.
  123945. * This is helpful for simulating a camera body, like a player's body.
  123946. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  123947. */
  123948. ellipsoid: Vector3;
  123949. /**
  123950. * Define an offset for the position of the ellipsoid around the camera.
  123951. * This can be helpful if the camera is attached away from the player's body center,
  123952. * such as at its head.
  123953. */
  123954. ellipsoidOffset: Vector3;
  123955. /**
  123956. * Enable or disable collisions of the camera with the rest of the scene objects.
  123957. */
  123958. checkCollisions: boolean;
  123959. /**
  123960. * Enable or disable gravity on the camera.
  123961. */
  123962. applyGravity: boolean;
  123963. /**
  123964. * Define the current direction the camera is moving to.
  123965. */
  123966. cameraDirection: Vector3;
  123967. /**
  123968. * Define the current local rotation of the camera as a quaternion to prevent Gimbal lock.
  123969. * This overrides and empties cameraRotation.
  123970. */
  123971. rotationQuaternion: Quaternion;
  123972. /**
  123973. * Track Roll to maintain the wanted Rolling when looking around.
  123974. */
  123975. _trackRoll: number;
  123976. /**
  123977. * Slowly correct the Roll to its original value after a Pitch+Yaw rotation.
  123978. */
  123979. rollCorrect: number;
  123980. /**
  123981. * Mimic a banked turn, Rolling the camera when Yawing.
  123982. * It's recommended to use rollCorrect = 10 for faster banking correction.
  123983. */
  123984. bankedTurn: boolean;
  123985. /**
  123986. * Limit in radians for how much Roll banking will add. (Default: 90°)
  123987. */
  123988. bankedTurnLimit: number;
  123989. /**
  123990. * Value of 0 disables the banked Roll.
  123991. * Value of 1 is equal to the Yaw angle in radians.
  123992. */
  123993. bankedTurnMultiplier: number;
  123994. /**
  123995. * The inputs manager loads all the input sources, such as keyboard and mouse.
  123996. */
  123997. inputs: FlyCameraInputsManager;
  123998. /**
  123999. * Gets the input sensibility for mouse input.
  124000. * Higher values reduce sensitivity.
  124001. */
  124002. get angularSensibility(): number;
  124003. /**
  124004. * Sets the input sensibility for a mouse input.
  124005. * Higher values reduce sensitivity.
  124006. */
  124007. set angularSensibility(value: number);
  124008. /**
  124009. * Get the keys for camera movement forward.
  124010. */
  124011. get keysForward(): number[];
  124012. /**
  124013. * Set the keys for camera movement forward.
  124014. */
  124015. set keysForward(value: number[]);
  124016. /**
  124017. * Get the keys for camera movement backward.
  124018. */
  124019. get keysBackward(): number[];
  124020. set keysBackward(value: number[]);
  124021. /**
  124022. * Get the keys for camera movement up.
  124023. */
  124024. get keysUp(): number[];
  124025. /**
  124026. * Set the keys for camera movement up.
  124027. */
  124028. set keysUp(value: number[]);
  124029. /**
  124030. * Get the keys for camera movement down.
  124031. */
  124032. get keysDown(): number[];
  124033. /**
  124034. * Set the keys for camera movement down.
  124035. */
  124036. set keysDown(value: number[]);
  124037. /**
  124038. * Get the keys for camera movement left.
  124039. */
  124040. get keysLeft(): number[];
  124041. /**
  124042. * Set the keys for camera movement left.
  124043. */
  124044. set keysLeft(value: number[]);
  124045. /**
  124046. * Set the keys for camera movement right.
  124047. */
  124048. get keysRight(): number[];
  124049. /**
  124050. * Set the keys for camera movement right.
  124051. */
  124052. set keysRight(value: number[]);
  124053. /**
  124054. * Event raised when the camera collides with a mesh in the scene.
  124055. */
  124056. onCollide: (collidedMesh: AbstractMesh) => void;
  124057. private _collider;
  124058. private _needMoveForGravity;
  124059. private _oldPosition;
  124060. private _diffPosition;
  124061. private _newPosition;
  124062. /** @hidden */
  124063. _localDirection: Vector3;
  124064. /** @hidden */
  124065. _transformedDirection: Vector3;
  124066. /**
  124067. * Instantiates a FlyCamera.
  124068. * This is a flying camera, designed for 3D movement and rotation in all directions,
  124069. * such as in a 3D Space Shooter or a Flight Simulator.
  124070. * @param name Define the name of the camera in the scene.
  124071. * @param position Define the starting position of the camera in the scene.
  124072. * @param scene Define the scene the camera belongs to.
  124073. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active, if no other camera has been defined as active.
  124074. */
  124075. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  124076. /**
  124077. * Attach a control to the HTML DOM element.
  124078. * @param element Defines the element that listens to the input events.
  124079. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault(). https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault
  124080. */
  124081. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124082. /**
  124083. * Detach a control from the HTML DOM element.
  124084. * The camera will stop reacting to that input.
  124085. * @param element Defines the element that listens to the input events.
  124086. */
  124087. detachControl(element: HTMLElement): void;
  124088. private _collisionMask;
  124089. /**
  124090. * Get the mask that the camera ignores in collision events.
  124091. */
  124092. get collisionMask(): number;
  124093. /**
  124094. * Set the mask that the camera ignores in collision events.
  124095. */
  124096. set collisionMask(mask: number);
  124097. /** @hidden */
  124098. _collideWithWorld(displacement: Vector3): void;
  124099. /** @hidden */
  124100. private _onCollisionPositionChange;
  124101. /** @hidden */
  124102. _checkInputs(): void;
  124103. /** @hidden */
  124104. _decideIfNeedsToMove(): boolean;
  124105. /** @hidden */
  124106. _updatePosition(): void;
  124107. /**
  124108. * Restore the Roll to its target value at the rate specified.
  124109. * @param rate - Higher means slower restoring.
  124110. * @hidden
  124111. */
  124112. restoreRoll(rate: number): void;
  124113. /**
  124114. * Destroy the camera and release the current resources held by it.
  124115. */
  124116. dispose(): void;
  124117. /**
  124118. * Get the current object class name.
  124119. * @returns the class name.
  124120. */
  124121. getClassName(): string;
  124122. }
  124123. }
  124124. declare module BABYLON {
  124125. /**
  124126. * Listen to keyboard events to control the camera.
  124127. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124128. */
  124129. export class FlyCameraKeyboardInput implements ICameraInput<FlyCamera> {
  124130. /**
  124131. * Defines the camera the input is attached to.
  124132. */
  124133. camera: FlyCamera;
  124134. /**
  124135. * The list of keyboard keys used to control the forward move of the camera.
  124136. */
  124137. keysForward: number[];
  124138. /**
  124139. * The list of keyboard keys used to control the backward move of the camera.
  124140. */
  124141. keysBackward: number[];
  124142. /**
  124143. * The list of keyboard keys used to control the forward move of the camera.
  124144. */
  124145. keysUp: number[];
  124146. /**
  124147. * The list of keyboard keys used to control the backward move of the camera.
  124148. */
  124149. keysDown: number[];
  124150. /**
  124151. * The list of keyboard keys used to control the right strafe move of the camera.
  124152. */
  124153. keysRight: number[];
  124154. /**
  124155. * The list of keyboard keys used to control the left strafe move of the camera.
  124156. */
  124157. keysLeft: number[];
  124158. private _keys;
  124159. private _onCanvasBlurObserver;
  124160. private _onKeyboardObserver;
  124161. private _engine;
  124162. private _scene;
  124163. /**
  124164. * Attach the input controls to a specific dom element to get the input from.
  124165. * @param element Defines the element the controls should be listened from
  124166. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124167. */
  124168. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124169. /**
  124170. * Detach the current controls from the specified dom element.
  124171. * @param element Defines the element to stop listening the inputs from
  124172. */
  124173. detachControl(element: Nullable<HTMLElement>): void;
  124174. /**
  124175. * Gets the class name of the current intput.
  124176. * @returns the class name
  124177. */
  124178. getClassName(): string;
  124179. /** @hidden */
  124180. _onLostFocus(e: FocusEvent): void;
  124181. /**
  124182. * Get the friendly name associated with the input class.
  124183. * @returns the input friendly name
  124184. */
  124185. getSimpleName(): string;
  124186. /**
  124187. * Update the current camera state depending on the inputs that have been used this frame.
  124188. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  124189. */
  124190. checkInputs(): void;
  124191. }
  124192. }
  124193. declare module BABYLON {
  124194. /**
  124195. * Manage the mouse wheel inputs to control a follow camera.
  124196. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124197. */
  124198. export class FollowCameraMouseWheelInput implements ICameraInput<FollowCamera> {
  124199. /**
  124200. * Defines the camera the input is attached to.
  124201. */
  124202. camera: FollowCamera;
  124203. /**
  124204. * Moue wheel controls zoom. (Mouse wheel modifies camera.radius value.)
  124205. */
  124206. axisControlRadius: boolean;
  124207. /**
  124208. * Moue wheel controls height. (Mouse wheel modifies camera.heightOffset value.)
  124209. */
  124210. axisControlHeight: boolean;
  124211. /**
  124212. * Moue wheel controls angle. (Mouse wheel modifies camera.rotationOffset value.)
  124213. */
  124214. axisControlRotation: boolean;
  124215. /**
  124216. * Gets or Set the mouse wheel precision or how fast is the camera moves in
  124217. * relation to mouseWheel events.
  124218. */
  124219. wheelPrecision: number;
  124220. /**
  124221. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  124222. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  124223. */
  124224. wheelDeltaPercentage: number;
  124225. private _wheel;
  124226. private _observer;
  124227. /**
  124228. * Attach the input controls to a specific dom element to get the input from.
  124229. * @param element Defines the element the controls should be listened from
  124230. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124231. */
  124232. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124233. /**
  124234. * Detach the current controls from the specified dom element.
  124235. * @param element Defines the element to stop listening the inputs from
  124236. */
  124237. detachControl(element: Nullable<HTMLElement>): void;
  124238. /**
  124239. * Gets the class name of the current intput.
  124240. * @returns the class name
  124241. */
  124242. getClassName(): string;
  124243. /**
  124244. * Get the friendly name associated with the input class.
  124245. * @returns the input friendly name
  124246. */
  124247. getSimpleName(): string;
  124248. }
  124249. }
  124250. declare module BABYLON {
  124251. /**
  124252. * Manage the pointers inputs to control an follow camera.
  124253. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124254. */
  124255. export class FollowCameraPointersInput extends BaseCameraPointersInput {
  124256. /**
  124257. * Defines the camera the input is attached to.
  124258. */
  124259. camera: FollowCamera;
  124260. /**
  124261. * Gets the class name of the current input.
  124262. * @returns the class name
  124263. */
  124264. getClassName(): string;
  124265. /**
  124266. * Defines the pointer angular sensibility along the X axis or how fast is
  124267. * the camera rotating.
  124268. * A negative number will reverse the axis direction.
  124269. */
  124270. angularSensibilityX: number;
  124271. /**
  124272. * Defines the pointer angular sensibility along the Y axis or how fast is
  124273. * the camera rotating.
  124274. * A negative number will reverse the axis direction.
  124275. */
  124276. angularSensibilityY: number;
  124277. /**
  124278. * Defines the pointer pinch precision or how fast is the camera zooming.
  124279. * A negative number will reverse the axis direction.
  124280. */
  124281. pinchPrecision: number;
  124282. /**
  124283. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  124284. * from 0.
  124285. * It defines the percentage of current camera.radius to use as delta when
  124286. * pinch zoom is used.
  124287. */
  124288. pinchDeltaPercentage: number;
  124289. /**
  124290. * Pointer X axis controls zoom. (X axis modifies camera.radius value.)
  124291. */
  124292. axisXControlRadius: boolean;
  124293. /**
  124294. * Pointer X axis controls height. (X axis modifies camera.heightOffset value.)
  124295. */
  124296. axisXControlHeight: boolean;
  124297. /**
  124298. * Pointer X axis controls angle. (X axis modifies camera.rotationOffset value.)
  124299. */
  124300. axisXControlRotation: boolean;
  124301. /**
  124302. * Pointer Y axis controls zoom. (Y axis modifies camera.radius value.)
  124303. */
  124304. axisYControlRadius: boolean;
  124305. /**
  124306. * Pointer Y axis controls height. (Y axis modifies camera.heightOffset value.)
  124307. */
  124308. axisYControlHeight: boolean;
  124309. /**
  124310. * Pointer Y axis controls angle. (Y axis modifies camera.rotationOffset value.)
  124311. */
  124312. axisYControlRotation: boolean;
  124313. /**
  124314. * Pinch controls zoom. (Pinch modifies camera.radius value.)
  124315. */
  124316. axisPinchControlRadius: boolean;
  124317. /**
  124318. * Pinch controls height. (Pinch modifies camera.heightOffset value.)
  124319. */
  124320. axisPinchControlHeight: boolean;
  124321. /**
  124322. * Pinch controls angle. (Pinch modifies camera.rotationOffset value.)
  124323. */
  124324. axisPinchControlRotation: boolean;
  124325. /**
  124326. * Log error messages if basic misconfiguration has occurred.
  124327. */
  124328. warningEnable: boolean;
  124329. protected onTouch(pointA: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  124330. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  124331. private _warningCounter;
  124332. private _warning;
  124333. }
  124334. }
  124335. declare module BABYLON {
  124336. /**
  124337. * Default Inputs manager for the FollowCamera.
  124338. * It groups all the default supported inputs for ease of use.
  124339. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124340. */
  124341. export class FollowCameraInputsManager extends CameraInputsManager<FollowCamera> {
  124342. /**
  124343. * Instantiates a new FollowCameraInputsManager.
  124344. * @param camera Defines the camera the inputs belong to
  124345. */
  124346. constructor(camera: FollowCamera);
  124347. /**
  124348. * Add keyboard input support to the input manager.
  124349. * @returns the current input manager
  124350. */
  124351. addKeyboard(): FollowCameraInputsManager;
  124352. /**
  124353. * Add mouse wheel input support to the input manager.
  124354. * @returns the current input manager
  124355. */
  124356. addMouseWheel(): FollowCameraInputsManager;
  124357. /**
  124358. * Add pointers input support to the input manager.
  124359. * @returns the current input manager
  124360. */
  124361. addPointers(): FollowCameraInputsManager;
  124362. /**
  124363. * Add orientation input support to the input manager.
  124364. * @returns the current input manager
  124365. */
  124366. addVRDeviceOrientation(): FollowCameraInputsManager;
  124367. }
  124368. }
  124369. declare module BABYLON {
  124370. /**
  124371. * A follow camera takes a mesh as a target and follows it as it moves. Both a free camera version followCamera and
  124372. * an arc rotate version arcFollowCamera are available.
  124373. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  124374. */
  124375. export class FollowCamera extends TargetCamera {
  124376. /**
  124377. * Distance the follow camera should follow an object at
  124378. */
  124379. radius: number;
  124380. /**
  124381. * Minimum allowed distance of the camera to the axis of rotation
  124382. * (The camera can not get closer).
  124383. * This can help limiting how the Camera is able to move in the scene.
  124384. */
  124385. lowerRadiusLimit: Nullable<number>;
  124386. /**
  124387. * Maximum allowed distance of the camera to the axis of rotation
  124388. * (The camera can not get further).
  124389. * This can help limiting how the Camera is able to move in the scene.
  124390. */
  124391. upperRadiusLimit: Nullable<number>;
  124392. /**
  124393. * Define a rotation offset between the camera and the object it follows
  124394. */
  124395. rotationOffset: number;
  124396. /**
  124397. * Minimum allowed angle to camera position relative to target object.
  124398. * This can help limiting how the Camera is able to move in the scene.
  124399. */
  124400. lowerRotationOffsetLimit: Nullable<number>;
  124401. /**
  124402. * Maximum allowed angle to camera position relative to target object.
  124403. * This can help limiting how the Camera is able to move in the scene.
  124404. */
  124405. upperRotationOffsetLimit: Nullable<number>;
  124406. /**
  124407. * Define a height offset between the camera and the object it follows.
  124408. * It can help following an object from the top (like a car chaing a plane)
  124409. */
  124410. heightOffset: number;
  124411. /**
  124412. * Minimum allowed height of camera position relative to target object.
  124413. * This can help limiting how the Camera is able to move in the scene.
  124414. */
  124415. lowerHeightOffsetLimit: Nullable<number>;
  124416. /**
  124417. * Maximum allowed height of camera position relative to target object.
  124418. * This can help limiting how the Camera is able to move in the scene.
  124419. */
  124420. upperHeightOffsetLimit: Nullable<number>;
  124421. /**
  124422. * Define how fast the camera can accelerate to follow it s target.
  124423. */
  124424. cameraAcceleration: number;
  124425. /**
  124426. * Define the speed limit of the camera following an object.
  124427. */
  124428. maxCameraSpeed: number;
  124429. /**
  124430. * Define the target of the camera.
  124431. */
  124432. lockedTarget: Nullable<AbstractMesh>;
  124433. /**
  124434. * Defines the input associated with the camera.
  124435. */
  124436. inputs: FollowCameraInputsManager;
  124437. /**
  124438. * Instantiates the follow camera.
  124439. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  124440. * @param name Define the name of the camera in the scene
  124441. * @param position Define the position of the camera
  124442. * @param scene Define the scene the camera belong to
  124443. * @param lockedTarget Define the target of the camera
  124444. */
  124445. constructor(name: string, position: Vector3, scene: Scene, lockedTarget?: Nullable<AbstractMesh>);
  124446. private _follow;
  124447. /**
  124448. * Attached controls to the current camera.
  124449. * @param element Defines the element the controls should be listened from
  124450. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124451. */
  124452. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124453. /**
  124454. * Detach the current controls from the camera.
  124455. * The camera will stop reacting to inputs.
  124456. * @param element Defines the element to stop listening the inputs from
  124457. */
  124458. detachControl(element: HTMLElement): void;
  124459. /** @hidden */
  124460. _checkInputs(): void;
  124461. private _checkLimits;
  124462. /**
  124463. * Gets the camera class name.
  124464. * @returns the class name
  124465. */
  124466. getClassName(): string;
  124467. }
  124468. /**
  124469. * Arc Rotate version of the follow camera.
  124470. * It still follows a Defined mesh but in an Arc Rotate Camera fashion.
  124471. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  124472. */
  124473. export class ArcFollowCamera extends TargetCamera {
  124474. /** The longitudinal angle of the camera */
  124475. alpha: number;
  124476. /** The latitudinal angle of the camera */
  124477. beta: number;
  124478. /** The radius of the camera from its target */
  124479. radius: number;
  124480. private _cartesianCoordinates;
  124481. /** Define the camera target (the mesh it should follow) */
  124482. private _meshTarget;
  124483. /**
  124484. * Instantiates a new ArcFollowCamera
  124485. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  124486. * @param name Define the name of the camera
  124487. * @param alpha Define the rotation angle of the camera around the logitudinal axis
  124488. * @param beta Define the rotation angle of the camera around the elevation axis
  124489. * @param radius Define the radius of the camera from its target point
  124490. * @param target Define the target of the camera
  124491. * @param scene Define the scene the camera belongs to
  124492. */
  124493. constructor(name: string,
  124494. /** The longitudinal angle of the camera */
  124495. alpha: number,
  124496. /** The latitudinal angle of the camera */
  124497. beta: number,
  124498. /** The radius of the camera from its target */
  124499. radius: number,
  124500. /** Define the camera target (the mesh it should follow) */
  124501. target: Nullable<AbstractMesh>, scene: Scene);
  124502. private _follow;
  124503. /** @hidden */
  124504. _checkInputs(): void;
  124505. /**
  124506. * Returns the class name of the object.
  124507. * It is mostly used internally for serialization purposes.
  124508. */
  124509. getClassName(): string;
  124510. }
  124511. }
  124512. declare module BABYLON {
  124513. /**
  124514. * Manage the keyboard inputs to control the movement of a follow camera.
  124515. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124516. */
  124517. export class FollowCameraKeyboardMoveInput implements ICameraInput<FollowCamera> {
  124518. /**
  124519. * Defines the camera the input is attached to.
  124520. */
  124521. camera: FollowCamera;
  124522. /**
  124523. * Defines the list of key codes associated with the up action (increase heightOffset)
  124524. */
  124525. keysHeightOffsetIncr: number[];
  124526. /**
  124527. * Defines the list of key codes associated with the down action (decrease heightOffset)
  124528. */
  124529. keysHeightOffsetDecr: number[];
  124530. /**
  124531. * Defines whether the Alt modifier key is required to move up/down (alter heightOffset)
  124532. */
  124533. keysHeightOffsetModifierAlt: boolean;
  124534. /**
  124535. * Defines whether the Ctrl modifier key is required to move up/down (alter heightOffset)
  124536. */
  124537. keysHeightOffsetModifierCtrl: boolean;
  124538. /**
  124539. * Defines whether the Shift modifier key is required to move up/down (alter heightOffset)
  124540. */
  124541. keysHeightOffsetModifierShift: boolean;
  124542. /**
  124543. * Defines the list of key codes associated with the left action (increase rotationOffset)
  124544. */
  124545. keysRotationOffsetIncr: number[];
  124546. /**
  124547. * Defines the list of key codes associated with the right action (decrease rotationOffset)
  124548. */
  124549. keysRotationOffsetDecr: number[];
  124550. /**
  124551. * Defines whether the Alt modifier key is required to move left/right (alter rotationOffset)
  124552. */
  124553. keysRotationOffsetModifierAlt: boolean;
  124554. /**
  124555. * Defines whether the Ctrl modifier key is required to move left/right (alter rotationOffset)
  124556. */
  124557. keysRotationOffsetModifierCtrl: boolean;
  124558. /**
  124559. * Defines whether the Shift modifier key is required to move left/right (alter rotationOffset)
  124560. */
  124561. keysRotationOffsetModifierShift: boolean;
  124562. /**
  124563. * Defines the list of key codes associated with the zoom-in action (decrease radius)
  124564. */
  124565. keysRadiusIncr: number[];
  124566. /**
  124567. * Defines the list of key codes associated with the zoom-out action (increase radius)
  124568. */
  124569. keysRadiusDecr: number[];
  124570. /**
  124571. * Defines whether the Alt modifier key is required to zoom in/out (alter radius value)
  124572. */
  124573. keysRadiusModifierAlt: boolean;
  124574. /**
  124575. * Defines whether the Ctrl modifier key is required to zoom in/out (alter radius value)
  124576. */
  124577. keysRadiusModifierCtrl: boolean;
  124578. /**
  124579. * Defines whether the Shift modifier key is required to zoom in/out (alter radius value)
  124580. */
  124581. keysRadiusModifierShift: boolean;
  124582. /**
  124583. * Defines the rate of change of heightOffset.
  124584. */
  124585. heightSensibility: number;
  124586. /**
  124587. * Defines the rate of change of rotationOffset.
  124588. */
  124589. rotationSensibility: number;
  124590. /**
  124591. * Defines the rate of change of radius.
  124592. */
  124593. radiusSensibility: number;
  124594. private _keys;
  124595. private _ctrlPressed;
  124596. private _altPressed;
  124597. private _shiftPressed;
  124598. private _onCanvasBlurObserver;
  124599. private _onKeyboardObserver;
  124600. private _engine;
  124601. private _scene;
  124602. /**
  124603. * Attach the input controls to a specific dom element to get the input from.
  124604. * @param element Defines the element the controls should be listened from
  124605. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124606. */
  124607. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124608. /**
  124609. * Detach the current controls from the specified dom element.
  124610. * @param element Defines the element to stop listening the inputs from
  124611. */
  124612. detachControl(element: Nullable<HTMLElement>): void;
  124613. /**
  124614. * Update the current camera state depending on the inputs that have been used this frame.
  124615. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  124616. */
  124617. checkInputs(): void;
  124618. /**
  124619. * Gets the class name of the current input.
  124620. * @returns the class name
  124621. */
  124622. getClassName(): string;
  124623. /**
  124624. * Get the friendly name associated with the input class.
  124625. * @returns the input friendly name
  124626. */
  124627. getSimpleName(): string;
  124628. /**
  124629. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  124630. * allow modification of the heightOffset value.
  124631. */
  124632. private _modifierHeightOffset;
  124633. /**
  124634. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  124635. * allow modification of the rotationOffset value.
  124636. */
  124637. private _modifierRotationOffset;
  124638. /**
  124639. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  124640. * allow modification of the radius value.
  124641. */
  124642. private _modifierRadius;
  124643. }
  124644. }
  124645. declare module BABYLON {
  124646. interface FreeCameraInputsManager {
  124647. /**
  124648. * @hidden
  124649. */
  124650. _deviceOrientationInput: Nullable<FreeCameraDeviceOrientationInput>;
  124651. /**
  124652. * Add orientation input support to the input manager.
  124653. * @returns the current input manager
  124654. */
  124655. addDeviceOrientation(): FreeCameraInputsManager;
  124656. }
  124657. /**
  124658. * Takes information about the orientation of the device as reported by the deviceorientation event to orient the camera.
  124659. * Screen rotation is taken into account.
  124660. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124661. */
  124662. export class FreeCameraDeviceOrientationInput implements ICameraInput<FreeCamera> {
  124663. private _camera;
  124664. private _screenOrientationAngle;
  124665. private _constantTranform;
  124666. private _screenQuaternion;
  124667. private _alpha;
  124668. private _beta;
  124669. private _gamma;
  124670. /**
  124671. * Can be used to detect if a device orientation sensor is available on a device
  124672. * @param timeout amount of time in milliseconds to wait for a response from the sensor (default: infinite)
  124673. * @returns a promise that will resolve on orientation change
  124674. */
  124675. static WaitForOrientationChangeAsync(timeout?: number): Promise<unknown>;
  124676. /**
  124677. * @hidden
  124678. */
  124679. _onDeviceOrientationChangedObservable: Observable<void>;
  124680. /**
  124681. * Instantiates a new input
  124682. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124683. */
  124684. constructor();
  124685. /**
  124686. * Define the camera controlled by the input.
  124687. */
  124688. get camera(): FreeCamera;
  124689. set camera(camera: FreeCamera);
  124690. /**
  124691. * Attach the input controls to a specific dom element to get the input from.
  124692. * @param element Defines the element the controls should be listened from
  124693. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124694. */
  124695. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124696. private _orientationChanged;
  124697. private _deviceOrientation;
  124698. /**
  124699. * Detach the current controls from the specified dom element.
  124700. * @param element Defines the element to stop listening the inputs from
  124701. */
  124702. detachControl(element: Nullable<HTMLElement>): void;
  124703. /**
  124704. * Update the current camera state depending on the inputs that have been used this frame.
  124705. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  124706. */
  124707. checkInputs(): void;
  124708. /**
  124709. * Gets the class name of the current intput.
  124710. * @returns the class name
  124711. */
  124712. getClassName(): string;
  124713. /**
  124714. * Get the friendly name associated with the input class.
  124715. * @returns the input friendly name
  124716. */
  124717. getSimpleName(): string;
  124718. }
  124719. }
  124720. declare module BABYLON {
  124721. /**
  124722. * Manage the gamepad inputs to control a free camera.
  124723. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124724. */
  124725. export class FreeCameraGamepadInput implements ICameraInput<FreeCamera> {
  124726. /**
  124727. * Define the camera the input is attached to.
  124728. */
  124729. camera: FreeCamera;
  124730. /**
  124731. * Define the Gamepad controlling the input
  124732. */
  124733. gamepad: Nullable<Gamepad>;
  124734. /**
  124735. * Defines the gamepad rotation sensiblity.
  124736. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  124737. */
  124738. gamepadAngularSensibility: number;
  124739. /**
  124740. * Defines the gamepad move sensiblity.
  124741. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  124742. */
  124743. gamepadMoveSensibility: number;
  124744. private _yAxisScale;
  124745. /**
  124746. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  124747. */
  124748. get invertYAxis(): boolean;
  124749. set invertYAxis(value: boolean);
  124750. private _onGamepadConnectedObserver;
  124751. private _onGamepadDisconnectedObserver;
  124752. private _cameraTransform;
  124753. private _deltaTransform;
  124754. private _vector3;
  124755. private _vector2;
  124756. /**
  124757. * Attach the input controls to a specific dom element to get the input from.
  124758. * @param element Defines the element the controls should be listened from
  124759. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124760. */
  124761. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124762. /**
  124763. * Detach the current controls from the specified dom element.
  124764. * @param element Defines the element to stop listening the inputs from
  124765. */
  124766. detachControl(element: Nullable<HTMLElement>): void;
  124767. /**
  124768. * Update the current camera state depending on the inputs that have been used this frame.
  124769. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  124770. */
  124771. checkInputs(): void;
  124772. /**
  124773. * Gets the class name of the current intput.
  124774. * @returns the class name
  124775. */
  124776. getClassName(): string;
  124777. /**
  124778. * Get the friendly name associated with the input class.
  124779. * @returns the input friendly name
  124780. */
  124781. getSimpleName(): string;
  124782. }
  124783. }
  124784. declare module BABYLON {
  124785. /**
  124786. * Defines the potential axis of a Joystick
  124787. */
  124788. export enum JoystickAxis {
  124789. /** X axis */
  124790. X = 0,
  124791. /** Y axis */
  124792. Y = 1,
  124793. /** Z axis */
  124794. Z = 2
  124795. }
  124796. /**
  124797. * Represents the different customization options available
  124798. * for VirtualJoystick
  124799. */
  124800. interface VirtualJoystickCustomizations {
  124801. /**
  124802. * Size of the joystick's puck
  124803. */
  124804. puckSize: number;
  124805. /**
  124806. * Size of the joystick's container
  124807. */
  124808. containerSize: number;
  124809. /**
  124810. * Color of the joystick && puck
  124811. */
  124812. color: string;
  124813. /**
  124814. * Image URL for the joystick's puck
  124815. */
  124816. puckImage?: string;
  124817. /**
  124818. * Image URL for the joystick's container
  124819. */
  124820. containerImage?: string;
  124821. /**
  124822. * Defines the unmoving position of the joystick container
  124823. */
  124824. position?: {
  124825. x: number;
  124826. y: number;
  124827. };
  124828. /**
  124829. * Defines whether or not the joystick container is always visible
  124830. */
  124831. alwaysVisible: boolean;
  124832. /**
  124833. * Defines whether or not to limit the movement of the puck to the joystick's container
  124834. */
  124835. limitToContainer: boolean;
  124836. }
  124837. /**
  124838. * Class used to define virtual joystick (used in touch mode)
  124839. */
  124840. export class VirtualJoystick {
  124841. /**
  124842. * Gets or sets a boolean indicating that left and right values must be inverted
  124843. */
  124844. reverseLeftRight: boolean;
  124845. /**
  124846. * Gets or sets a boolean indicating that up and down values must be inverted
  124847. */
  124848. reverseUpDown: boolean;
  124849. /**
  124850. * Gets the offset value for the position (ie. the change of the position value)
  124851. */
  124852. deltaPosition: Vector3;
  124853. /**
  124854. * Gets a boolean indicating if the virtual joystick was pressed
  124855. */
  124856. pressed: boolean;
  124857. /**
  124858. * Canvas the virtual joystick will render onto, default z-index of this is 5
  124859. */
  124860. static Canvas: Nullable<HTMLCanvasElement>;
  124861. /**
  124862. * boolean indicating whether or not the joystick's puck's movement should be limited to the joystick's container area
  124863. */
  124864. limitToContainer: boolean;
  124865. private static _globalJoystickIndex;
  124866. private static _alwaysVisibleSticks;
  124867. private static vjCanvasContext;
  124868. private static vjCanvasWidth;
  124869. private static vjCanvasHeight;
  124870. private static halfWidth;
  124871. private static _GetDefaultOptions;
  124872. private _action;
  124873. private _axisTargetedByLeftAndRight;
  124874. private _axisTargetedByUpAndDown;
  124875. private _joystickSensibility;
  124876. private _inversedSensibility;
  124877. private _joystickPointerID;
  124878. private _joystickColor;
  124879. private _joystickPointerPos;
  124880. private _joystickPreviousPointerPos;
  124881. private _joystickPointerStartPos;
  124882. private _deltaJoystickVector;
  124883. private _leftJoystick;
  124884. private _touches;
  124885. private _joystickPosition;
  124886. private _alwaysVisible;
  124887. private _puckImage;
  124888. private _containerImage;
  124889. private _joystickPuckSize;
  124890. private _joystickContainerSize;
  124891. private _clearPuckSize;
  124892. private _clearContainerSize;
  124893. private _clearPuckSizeOffset;
  124894. private _clearContainerSizeOffset;
  124895. private _onPointerDownHandlerRef;
  124896. private _onPointerMoveHandlerRef;
  124897. private _onPointerUpHandlerRef;
  124898. private _onResize;
  124899. /**
  124900. * Creates a new virtual joystick
  124901. * @param leftJoystick defines that the joystick is for left hand (false by default)
  124902. * @param customizations Defines the options we want to customize the VirtualJoystick
  124903. */
  124904. constructor(leftJoystick?: boolean, customizations?: Partial<VirtualJoystickCustomizations>);
  124905. /**
  124906. * Defines joystick sensibility (ie. the ratio beteen a physical move and virtual joystick position change)
  124907. * @param newJoystickSensibility defines the new sensibility
  124908. */
  124909. setJoystickSensibility(newJoystickSensibility: number): void;
  124910. private _onPointerDown;
  124911. private _onPointerMove;
  124912. private _onPointerUp;
  124913. /**
  124914. * Change the color of the virtual joystick
  124915. * @param newColor a string that must be a CSS color value (like "red") or the hexa value (like "#FF0000")
  124916. */
  124917. setJoystickColor(newColor: string): void;
  124918. /**
  124919. * Size of the joystick's container
  124920. */
  124921. set containerSize(newSize: number);
  124922. get containerSize(): number;
  124923. /**
  124924. * Size of the joystick's puck
  124925. */
  124926. set puckSize(newSize: number);
  124927. get puckSize(): number;
  124928. /**
  124929. * Clears the set position of the joystick
  124930. */
  124931. clearPosition(): void;
  124932. /**
  124933. * Defines whether or not the joystick container is always visible
  124934. */
  124935. set alwaysVisible(value: boolean);
  124936. get alwaysVisible(): boolean;
  124937. /**
  124938. * Sets the constant position of the Joystick container
  124939. * @param x X axis coordinate
  124940. * @param y Y axis coordinate
  124941. */
  124942. setPosition(x: number, y: number): void;
  124943. /**
  124944. * Defines a callback to call when the joystick is touched
  124945. * @param action defines the callback
  124946. */
  124947. setActionOnTouch(action: () => any): void;
  124948. /**
  124949. * Defines which axis you'd like to control for left & right
  124950. * @param axis defines the axis to use
  124951. */
  124952. setAxisForLeftRight(axis: JoystickAxis): void;
  124953. /**
  124954. * Defines which axis you'd like to control for up & down
  124955. * @param axis defines the axis to use
  124956. */
  124957. setAxisForUpDown(axis: JoystickAxis): void;
  124958. /**
  124959. * Clears the canvas from the previous puck / container draw
  124960. */
  124961. private _clearPreviousDraw;
  124962. /**
  124963. * Loads `urlPath` to be used for the container's image
  124964. * @param urlPath defines the urlPath of an image to use
  124965. */
  124966. setContainerImage(urlPath: string): void;
  124967. /**
  124968. * Loads `urlPath` to be used for the puck's image
  124969. * @param urlPath defines the urlPath of an image to use
  124970. */
  124971. setPuckImage(urlPath: string): void;
  124972. /**
  124973. * Draws the Virtual Joystick's container
  124974. */
  124975. private _drawContainer;
  124976. /**
  124977. * Draws the Virtual Joystick's puck
  124978. */
  124979. private _drawPuck;
  124980. private _drawVirtualJoystick;
  124981. /**
  124982. * Release internal HTML canvas
  124983. */
  124984. releaseCanvas(): void;
  124985. }
  124986. }
  124987. declare module BABYLON {
  124988. interface FreeCameraInputsManager {
  124989. /**
  124990. * Add virtual joystick input support to the input manager.
  124991. * @returns the current input manager
  124992. */
  124993. addVirtualJoystick(): FreeCameraInputsManager;
  124994. }
  124995. /**
  124996. * Manage the Virtual Joystick inputs to control the movement of a free camera.
  124997. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124998. */
  124999. export class FreeCameraVirtualJoystickInput implements ICameraInput<FreeCamera> {
  125000. /**
  125001. * Defines the camera the input is attached to.
  125002. */
  125003. camera: FreeCamera;
  125004. private _leftjoystick;
  125005. private _rightjoystick;
  125006. /**
  125007. * Gets the left stick of the virtual joystick.
  125008. * @returns The virtual Joystick
  125009. */
  125010. getLeftJoystick(): VirtualJoystick;
  125011. /**
  125012. * Gets the right stick of the virtual joystick.
  125013. * @returns The virtual Joystick
  125014. */
  125015. getRightJoystick(): VirtualJoystick;
  125016. /**
  125017. * Update the current camera state depending on the inputs that have been used this frame.
  125018. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  125019. */
  125020. checkInputs(): void;
  125021. /**
  125022. * Attach the input controls to a specific dom element to get the input from.
  125023. * @param element Defines the element the controls should be listened from
  125024. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  125025. */
  125026. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  125027. /**
  125028. * Detach the current controls from the specified dom element.
  125029. * @param element Defines the element to stop listening the inputs from
  125030. */
  125031. detachControl(element: Nullable<HTMLElement>): void;
  125032. /**
  125033. * Gets the class name of the current intput.
  125034. * @returns the class name
  125035. */
  125036. getClassName(): string;
  125037. /**
  125038. * Get the friendly name associated with the input class.
  125039. * @returns the input friendly name
  125040. */
  125041. getSimpleName(): string;
  125042. }
  125043. }
  125044. declare module BABYLON {
  125045. /**
  125046. * This represents a FPS type of camera controlled by touch.
  125047. * This is like a universal camera minus the Gamepad controls.
  125048. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  125049. */
  125050. export class TouchCamera extends FreeCamera {
  125051. /**
  125052. * Defines the touch sensibility for rotation.
  125053. * The higher the faster.
  125054. */
  125055. get touchAngularSensibility(): number;
  125056. set touchAngularSensibility(value: number);
  125057. /**
  125058. * Defines the touch sensibility for move.
  125059. * The higher the faster.
  125060. */
  125061. get touchMoveSensibility(): number;
  125062. set touchMoveSensibility(value: number);
  125063. /**
  125064. * Instantiates a new touch camera.
  125065. * This represents a FPS type of camera controlled by touch.
  125066. * This is like a universal camera minus the Gamepad controls.
  125067. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  125068. * @param name Define the name of the camera in the scene
  125069. * @param position Define the start position of the camera in the scene
  125070. * @param scene Define the scene the camera belongs to
  125071. */
  125072. constructor(name: string, position: Vector3, scene: Scene);
  125073. /**
  125074. * Gets the current object class name.
  125075. * @return the class name
  125076. */
  125077. getClassName(): string;
  125078. /** @hidden */
  125079. _setupInputs(): void;
  125080. }
  125081. }
  125082. declare module BABYLON {
  125083. /**
  125084. * This is a camera specifically designed to react to device orientation events such as a modern mobile device
  125085. * being tilted forward or back and left or right.
  125086. */
  125087. export class DeviceOrientationCamera extends FreeCamera {
  125088. private _initialQuaternion;
  125089. private _quaternionCache;
  125090. private _tmpDragQuaternion;
  125091. private _disablePointerInputWhenUsingDeviceOrientation;
  125092. /**
  125093. * Creates a new device orientation camera
  125094. * @param name The name of the camera
  125095. * @param position The start position camera
  125096. * @param scene The scene the camera belongs to
  125097. */
  125098. constructor(name: string, position: Vector3, scene: Scene);
  125099. /**
  125100. * Gets or sets a boolean indicating that pointer input must be disabled on first orientation sensor update (Default: true)
  125101. */
  125102. get disablePointerInputWhenUsingDeviceOrientation(): boolean;
  125103. set disablePointerInputWhenUsingDeviceOrientation(value: boolean);
  125104. private _dragFactor;
  125105. /**
  125106. * Enabled turning on the y axis when the orientation sensor is active
  125107. * @param dragFactor the factor that controls the turn speed (default: 1/300)
  125108. */
  125109. enableHorizontalDragging(dragFactor?: number): void;
  125110. /**
  125111. * Gets the current instance class name ("DeviceOrientationCamera").
  125112. * This helps avoiding instanceof at run time.
  125113. * @returns the class name
  125114. */
  125115. getClassName(): string;
  125116. /**
  125117. * @hidden
  125118. * Checks and applies the current values of the inputs to the camera. (Internal use only)
  125119. */
  125120. _checkInputs(): void;
  125121. /**
  125122. * Reset the camera to its default orientation on the specified axis only.
  125123. * @param axis The axis to reset
  125124. */
  125125. resetToCurrentRotation(axis?: Axis): void;
  125126. }
  125127. }
  125128. declare module BABYLON {
  125129. /**
  125130. * Defines supported buttons for XBox360 compatible gamepads
  125131. */
  125132. export enum Xbox360Button {
  125133. /** A */
  125134. A = 0,
  125135. /** B */
  125136. B = 1,
  125137. /** X */
  125138. X = 2,
  125139. /** Y */
  125140. Y = 3,
  125141. /** Left button */
  125142. LB = 4,
  125143. /** Right button */
  125144. RB = 5,
  125145. /** Back */
  125146. Back = 8,
  125147. /** Start */
  125148. Start = 9,
  125149. /** Left stick */
  125150. LeftStick = 10,
  125151. /** Right stick */
  125152. RightStick = 11
  125153. }
  125154. /** Defines values for XBox360 DPad */
  125155. export enum Xbox360Dpad {
  125156. /** Up */
  125157. Up = 12,
  125158. /** Down */
  125159. Down = 13,
  125160. /** Left */
  125161. Left = 14,
  125162. /** Right */
  125163. Right = 15
  125164. }
  125165. /**
  125166. * Defines a XBox360 gamepad
  125167. */
  125168. export class Xbox360Pad extends Gamepad {
  125169. private _leftTrigger;
  125170. private _rightTrigger;
  125171. private _onlefttriggerchanged;
  125172. private _onrighttriggerchanged;
  125173. private _onbuttondown;
  125174. private _onbuttonup;
  125175. private _ondpaddown;
  125176. private _ondpadup;
  125177. /** Observable raised when a button is pressed */
  125178. onButtonDownObservable: Observable<Xbox360Button>;
  125179. /** Observable raised when a button is released */
  125180. onButtonUpObservable: Observable<Xbox360Button>;
  125181. /** Observable raised when a pad is pressed */
  125182. onPadDownObservable: Observable<Xbox360Dpad>;
  125183. /** Observable raised when a pad is released */
  125184. onPadUpObservable: Observable<Xbox360Dpad>;
  125185. private _buttonA;
  125186. private _buttonB;
  125187. private _buttonX;
  125188. private _buttonY;
  125189. private _buttonBack;
  125190. private _buttonStart;
  125191. private _buttonLB;
  125192. private _buttonRB;
  125193. private _buttonLeftStick;
  125194. private _buttonRightStick;
  125195. private _dPadUp;
  125196. private _dPadDown;
  125197. private _dPadLeft;
  125198. private _dPadRight;
  125199. private _isXboxOnePad;
  125200. /**
  125201. * Creates a new XBox360 gamepad object
  125202. * @param id defines the id of this gamepad
  125203. * @param index defines its index
  125204. * @param gamepad defines the internal HTML gamepad object
  125205. * @param xboxOne defines if it is a XBox One gamepad
  125206. */
  125207. constructor(id: string, index: number, gamepad: any, xboxOne?: boolean);
  125208. /**
  125209. * Defines the callback to call when left trigger is pressed
  125210. * @param callback defines the callback to use
  125211. */
  125212. onlefttriggerchanged(callback: (value: number) => void): void;
  125213. /**
  125214. * Defines the callback to call when right trigger is pressed
  125215. * @param callback defines the callback to use
  125216. */
  125217. onrighttriggerchanged(callback: (value: number) => void): void;
  125218. /**
  125219. * Gets the left trigger value
  125220. */
  125221. get leftTrigger(): number;
  125222. /**
  125223. * Sets the left trigger value
  125224. */
  125225. set leftTrigger(newValue: number);
  125226. /**
  125227. * Gets the right trigger value
  125228. */
  125229. get rightTrigger(): number;
  125230. /**
  125231. * Sets the right trigger value
  125232. */
  125233. set rightTrigger(newValue: number);
  125234. /**
  125235. * Defines the callback to call when a button is pressed
  125236. * @param callback defines the callback to use
  125237. */
  125238. onbuttondown(callback: (buttonPressed: Xbox360Button) => void): void;
  125239. /**
  125240. * Defines the callback to call when a button is released
  125241. * @param callback defines the callback to use
  125242. */
  125243. onbuttonup(callback: (buttonReleased: Xbox360Button) => void): void;
  125244. /**
  125245. * Defines the callback to call when a pad is pressed
  125246. * @param callback defines the callback to use
  125247. */
  125248. ondpaddown(callback: (dPadPressed: Xbox360Dpad) => void): void;
  125249. /**
  125250. * Defines the callback to call when a pad is released
  125251. * @param callback defines the callback to use
  125252. */
  125253. ondpadup(callback: (dPadReleased: Xbox360Dpad) => void): void;
  125254. private _setButtonValue;
  125255. private _setDPadValue;
  125256. /**
  125257. * Gets the value of the `A` button
  125258. */
  125259. get buttonA(): number;
  125260. /**
  125261. * Sets the value of the `A` button
  125262. */
  125263. set buttonA(value: number);
  125264. /**
  125265. * Gets the value of the `B` button
  125266. */
  125267. get buttonB(): number;
  125268. /**
  125269. * Sets the value of the `B` button
  125270. */
  125271. set buttonB(value: number);
  125272. /**
  125273. * Gets the value of the `X` button
  125274. */
  125275. get buttonX(): number;
  125276. /**
  125277. * Sets the value of the `X` button
  125278. */
  125279. set buttonX(value: number);
  125280. /**
  125281. * Gets the value of the `Y` button
  125282. */
  125283. get buttonY(): number;
  125284. /**
  125285. * Sets the value of the `Y` button
  125286. */
  125287. set buttonY(value: number);
  125288. /**
  125289. * Gets the value of the `Start` button
  125290. */
  125291. get buttonStart(): number;
  125292. /**
  125293. * Sets the value of the `Start` button
  125294. */
  125295. set buttonStart(value: number);
  125296. /**
  125297. * Gets the value of the `Back` button
  125298. */
  125299. get buttonBack(): number;
  125300. /**
  125301. * Sets the value of the `Back` button
  125302. */
  125303. set buttonBack(value: number);
  125304. /**
  125305. * Gets the value of the `Left` button
  125306. */
  125307. get buttonLB(): number;
  125308. /**
  125309. * Sets the value of the `Left` button
  125310. */
  125311. set buttonLB(value: number);
  125312. /**
  125313. * Gets the value of the `Right` button
  125314. */
  125315. get buttonRB(): number;
  125316. /**
  125317. * Sets the value of the `Right` button
  125318. */
  125319. set buttonRB(value: number);
  125320. /**
  125321. * Gets the value of the Left joystick
  125322. */
  125323. get buttonLeftStick(): number;
  125324. /**
  125325. * Sets the value of the Left joystick
  125326. */
  125327. set buttonLeftStick(value: number);
  125328. /**
  125329. * Gets the value of the Right joystick
  125330. */
  125331. get buttonRightStick(): number;
  125332. /**
  125333. * Sets the value of the Right joystick
  125334. */
  125335. set buttonRightStick(value: number);
  125336. /**
  125337. * Gets the value of D-pad up
  125338. */
  125339. get dPadUp(): number;
  125340. /**
  125341. * Sets the value of D-pad up
  125342. */
  125343. set dPadUp(value: number);
  125344. /**
  125345. * Gets the value of D-pad down
  125346. */
  125347. get dPadDown(): number;
  125348. /**
  125349. * Sets the value of D-pad down
  125350. */
  125351. set dPadDown(value: number);
  125352. /**
  125353. * Gets the value of D-pad left
  125354. */
  125355. get dPadLeft(): number;
  125356. /**
  125357. * Sets the value of D-pad left
  125358. */
  125359. set dPadLeft(value: number);
  125360. /**
  125361. * Gets the value of D-pad right
  125362. */
  125363. get dPadRight(): number;
  125364. /**
  125365. * Sets the value of D-pad right
  125366. */
  125367. set dPadRight(value: number);
  125368. /**
  125369. * Force the gamepad to synchronize with device values
  125370. */
  125371. update(): void;
  125372. /**
  125373. * Disposes the gamepad
  125374. */
  125375. dispose(): void;
  125376. }
  125377. }
  125378. declare module BABYLON {
  125379. /**
  125380. * Defines supported buttons for DualShock compatible gamepads
  125381. */
  125382. export enum DualShockButton {
  125383. /** Cross */
  125384. Cross = 0,
  125385. /** Circle */
  125386. Circle = 1,
  125387. /** Square */
  125388. Square = 2,
  125389. /** Triangle */
  125390. Triangle = 3,
  125391. /** L1 */
  125392. L1 = 4,
  125393. /** R1 */
  125394. R1 = 5,
  125395. /** Share */
  125396. Share = 8,
  125397. /** Options */
  125398. Options = 9,
  125399. /** Left stick */
  125400. LeftStick = 10,
  125401. /** Right stick */
  125402. RightStick = 11
  125403. }
  125404. /** Defines values for DualShock DPad */
  125405. export enum DualShockDpad {
  125406. /** Up */
  125407. Up = 12,
  125408. /** Down */
  125409. Down = 13,
  125410. /** Left */
  125411. Left = 14,
  125412. /** Right */
  125413. Right = 15
  125414. }
  125415. /**
  125416. * Defines a DualShock gamepad
  125417. */
  125418. export class DualShockPad extends Gamepad {
  125419. private _leftTrigger;
  125420. private _rightTrigger;
  125421. private _onlefttriggerchanged;
  125422. private _onrighttriggerchanged;
  125423. private _onbuttondown;
  125424. private _onbuttonup;
  125425. private _ondpaddown;
  125426. private _ondpadup;
  125427. /** Observable raised when a button is pressed */
  125428. onButtonDownObservable: Observable<DualShockButton>;
  125429. /** Observable raised when a button is released */
  125430. onButtonUpObservable: Observable<DualShockButton>;
  125431. /** Observable raised when a pad is pressed */
  125432. onPadDownObservable: Observable<DualShockDpad>;
  125433. /** Observable raised when a pad is released */
  125434. onPadUpObservable: Observable<DualShockDpad>;
  125435. private _buttonCross;
  125436. private _buttonCircle;
  125437. private _buttonSquare;
  125438. private _buttonTriangle;
  125439. private _buttonShare;
  125440. private _buttonOptions;
  125441. private _buttonL1;
  125442. private _buttonR1;
  125443. private _buttonLeftStick;
  125444. private _buttonRightStick;
  125445. private _dPadUp;
  125446. private _dPadDown;
  125447. private _dPadLeft;
  125448. private _dPadRight;
  125449. /**
  125450. * Creates a new DualShock gamepad object
  125451. * @param id defines the id of this gamepad
  125452. * @param index defines its index
  125453. * @param gamepad defines the internal HTML gamepad object
  125454. */
  125455. constructor(id: string, index: number, gamepad: any);
  125456. /**
  125457. * Defines the callback to call when left trigger is pressed
  125458. * @param callback defines the callback to use
  125459. */
  125460. onlefttriggerchanged(callback: (value: number) => void): void;
  125461. /**
  125462. * Defines the callback to call when right trigger is pressed
  125463. * @param callback defines the callback to use
  125464. */
  125465. onrighttriggerchanged(callback: (value: number) => void): void;
  125466. /**
  125467. * Gets the left trigger value
  125468. */
  125469. get leftTrigger(): number;
  125470. /**
  125471. * Sets the left trigger value
  125472. */
  125473. set leftTrigger(newValue: number);
  125474. /**
  125475. * Gets the right trigger value
  125476. */
  125477. get rightTrigger(): number;
  125478. /**
  125479. * Sets the right trigger value
  125480. */
  125481. set rightTrigger(newValue: number);
  125482. /**
  125483. * Defines the callback to call when a button is pressed
  125484. * @param callback defines the callback to use
  125485. */
  125486. onbuttondown(callback: (buttonPressed: DualShockButton) => void): void;
  125487. /**
  125488. * Defines the callback to call when a button is released
  125489. * @param callback defines the callback to use
  125490. */
  125491. onbuttonup(callback: (buttonReleased: DualShockButton) => void): void;
  125492. /**
  125493. * Defines the callback to call when a pad is pressed
  125494. * @param callback defines the callback to use
  125495. */
  125496. ondpaddown(callback: (dPadPressed: DualShockDpad) => void): void;
  125497. /**
  125498. * Defines the callback to call when a pad is released
  125499. * @param callback defines the callback to use
  125500. */
  125501. ondpadup(callback: (dPadReleased: DualShockDpad) => void): void;
  125502. private _setButtonValue;
  125503. private _setDPadValue;
  125504. /**
  125505. * Gets the value of the `Cross` button
  125506. */
  125507. get buttonCross(): number;
  125508. /**
  125509. * Sets the value of the `Cross` button
  125510. */
  125511. set buttonCross(value: number);
  125512. /**
  125513. * Gets the value of the `Circle` button
  125514. */
  125515. get buttonCircle(): number;
  125516. /**
  125517. * Sets the value of the `Circle` button
  125518. */
  125519. set buttonCircle(value: number);
  125520. /**
  125521. * Gets the value of the `Square` button
  125522. */
  125523. get buttonSquare(): number;
  125524. /**
  125525. * Sets the value of the `Square` button
  125526. */
  125527. set buttonSquare(value: number);
  125528. /**
  125529. * Gets the value of the `Triangle` button
  125530. */
  125531. get buttonTriangle(): number;
  125532. /**
  125533. * Sets the value of the `Triangle` button
  125534. */
  125535. set buttonTriangle(value: number);
  125536. /**
  125537. * Gets the value of the `Options` button
  125538. */
  125539. get buttonOptions(): number;
  125540. /**
  125541. * Sets the value of the `Options` button
  125542. */
  125543. set buttonOptions(value: number);
  125544. /**
  125545. * Gets the value of the `Share` button
  125546. */
  125547. get buttonShare(): number;
  125548. /**
  125549. * Sets the value of the `Share` button
  125550. */
  125551. set buttonShare(value: number);
  125552. /**
  125553. * Gets the value of the `L1` button
  125554. */
  125555. get buttonL1(): number;
  125556. /**
  125557. * Sets the value of the `L1` button
  125558. */
  125559. set buttonL1(value: number);
  125560. /**
  125561. * Gets the value of the `R1` button
  125562. */
  125563. get buttonR1(): number;
  125564. /**
  125565. * Sets the value of the `R1` button
  125566. */
  125567. set buttonR1(value: number);
  125568. /**
  125569. * Gets the value of the Left joystick
  125570. */
  125571. get buttonLeftStick(): number;
  125572. /**
  125573. * Sets the value of the Left joystick
  125574. */
  125575. set buttonLeftStick(value: number);
  125576. /**
  125577. * Gets the value of the Right joystick
  125578. */
  125579. get buttonRightStick(): number;
  125580. /**
  125581. * Sets the value of the Right joystick
  125582. */
  125583. set buttonRightStick(value: number);
  125584. /**
  125585. * Gets the value of D-pad up
  125586. */
  125587. get dPadUp(): number;
  125588. /**
  125589. * Sets the value of D-pad up
  125590. */
  125591. set dPadUp(value: number);
  125592. /**
  125593. * Gets the value of D-pad down
  125594. */
  125595. get dPadDown(): number;
  125596. /**
  125597. * Sets the value of D-pad down
  125598. */
  125599. set dPadDown(value: number);
  125600. /**
  125601. * Gets the value of D-pad left
  125602. */
  125603. get dPadLeft(): number;
  125604. /**
  125605. * Sets the value of D-pad left
  125606. */
  125607. set dPadLeft(value: number);
  125608. /**
  125609. * Gets the value of D-pad right
  125610. */
  125611. get dPadRight(): number;
  125612. /**
  125613. * Sets the value of D-pad right
  125614. */
  125615. set dPadRight(value: number);
  125616. /**
  125617. * Force the gamepad to synchronize with device values
  125618. */
  125619. update(): void;
  125620. /**
  125621. * Disposes the gamepad
  125622. */
  125623. dispose(): void;
  125624. }
  125625. }
  125626. declare module BABYLON {
  125627. /**
  125628. * Manager for handling gamepads
  125629. */
  125630. export class GamepadManager {
  125631. private _scene?;
  125632. private _babylonGamepads;
  125633. private _oneGamepadConnected;
  125634. /** @hidden */
  125635. _isMonitoring: boolean;
  125636. private _gamepadEventSupported;
  125637. private _gamepadSupport?;
  125638. /**
  125639. * observable to be triggered when the gamepad controller has been connected
  125640. */
  125641. onGamepadConnectedObservable: Observable<Gamepad>;
  125642. /**
  125643. * observable to be triggered when the gamepad controller has been disconnected
  125644. */
  125645. onGamepadDisconnectedObservable: Observable<Gamepad>;
  125646. private _onGamepadConnectedEvent;
  125647. private _onGamepadDisconnectedEvent;
  125648. /**
  125649. * Initializes the gamepad manager
  125650. * @param _scene BabylonJS scene
  125651. */
  125652. constructor(_scene?: Scene | undefined);
  125653. /**
  125654. * The gamepads in the game pad manager
  125655. */
  125656. get gamepads(): Gamepad[];
  125657. /**
  125658. * Get the gamepad controllers based on type
  125659. * @param type The type of gamepad controller
  125660. * @returns Nullable gamepad
  125661. */
  125662. getGamepadByType(type?: number): Nullable<Gamepad>;
  125663. /**
  125664. * Disposes the gamepad manager
  125665. */
  125666. dispose(): void;
  125667. private _addNewGamepad;
  125668. private _startMonitoringGamepads;
  125669. private _stopMonitoringGamepads;
  125670. /** @hidden */
  125671. _checkGamepadsStatus(): void;
  125672. private _updateGamepadObjects;
  125673. }
  125674. }
  125675. declare module BABYLON {
  125676. interface Scene {
  125677. /** @hidden */
  125678. _gamepadManager: Nullable<GamepadManager>;
  125679. /**
  125680. * Gets the gamepad manager associated with the scene
  125681. * @see https://doc.babylonjs.com/how_to/how_to_use_gamepads
  125682. */
  125683. gamepadManager: GamepadManager;
  125684. }
  125685. /**
  125686. * Interface representing a free camera inputs manager
  125687. */
  125688. interface FreeCameraInputsManager {
  125689. /**
  125690. * Adds gamepad input support to the FreeCameraInputsManager.
  125691. * @returns the FreeCameraInputsManager
  125692. */
  125693. addGamepad(): FreeCameraInputsManager;
  125694. }
  125695. /**
  125696. * Interface representing an arc rotate camera inputs manager
  125697. */
  125698. interface ArcRotateCameraInputsManager {
  125699. /**
  125700. * Adds gamepad input support to the ArcRotateCamera InputManager.
  125701. * @returns the camera inputs manager
  125702. */
  125703. addGamepad(): ArcRotateCameraInputsManager;
  125704. }
  125705. /**
  125706. * Defines the gamepad scene component responsible to manage gamepads in a given scene
  125707. */
  125708. export class GamepadSystemSceneComponent implements ISceneComponent {
  125709. /**
  125710. * The component name helpfull to identify the component in the list of scene components.
  125711. */
  125712. readonly name: string;
  125713. /**
  125714. * The scene the component belongs to.
  125715. */
  125716. scene: Scene;
  125717. /**
  125718. * Creates a new instance of the component for the given scene
  125719. * @param scene Defines the scene to register the component in
  125720. */
  125721. constructor(scene: Scene);
  125722. /**
  125723. * Registers the component in a given scene
  125724. */
  125725. register(): void;
  125726. /**
  125727. * Rebuilds the elements related to this component in case of
  125728. * context lost for instance.
  125729. */
  125730. rebuild(): void;
  125731. /**
  125732. * Disposes the component and the associated ressources
  125733. */
  125734. dispose(): void;
  125735. private _beforeCameraUpdate;
  125736. }
  125737. }
  125738. declare module BABYLON {
  125739. /**
  125740. * 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,
  125741. * which still works and will still be found in many Playgrounds.
  125742. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  125743. */
  125744. export class UniversalCamera extends TouchCamera {
  125745. /**
  125746. * Defines the gamepad rotation sensiblity.
  125747. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  125748. */
  125749. get gamepadAngularSensibility(): number;
  125750. set gamepadAngularSensibility(value: number);
  125751. /**
  125752. * Defines the gamepad move sensiblity.
  125753. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  125754. */
  125755. get gamepadMoveSensibility(): number;
  125756. set gamepadMoveSensibility(value: number);
  125757. /**
  125758. * 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,
  125759. * which still works and will still be found in many Playgrounds.
  125760. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  125761. * @param name Define the name of the camera in the scene
  125762. * @param position Define the start position of the camera in the scene
  125763. * @param scene Define the scene the camera belongs to
  125764. */
  125765. constructor(name: string, position: Vector3, scene: Scene);
  125766. /**
  125767. * Gets the current object class name.
  125768. * @return the class name
  125769. */
  125770. getClassName(): string;
  125771. }
  125772. }
  125773. declare module BABYLON {
  125774. /**
  125775. * This represents a FPS type of camera. This is only here for back compat purpose.
  125776. * Please use the UniversalCamera instead as both are identical.
  125777. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  125778. */
  125779. export class GamepadCamera extends UniversalCamera {
  125780. /**
  125781. * Instantiates a new Gamepad Camera
  125782. * This represents a FPS type of camera. This is only here for back compat purpose.
  125783. * Please use the UniversalCamera instead as both are identical.
  125784. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  125785. * @param name Define the name of the camera in the scene
  125786. * @param position Define the start position of the camera in the scene
  125787. * @param scene Define the scene the camera belongs to
  125788. */
  125789. constructor(name: string, position: Vector3, scene: Scene);
  125790. /**
  125791. * Gets the current object class name.
  125792. * @return the class name
  125793. */
  125794. getClassName(): string;
  125795. }
  125796. }
  125797. declare module BABYLON {
  125798. /** @hidden */
  125799. export var passPixelShader: {
  125800. name: string;
  125801. shader: string;
  125802. };
  125803. }
  125804. declare module BABYLON {
  125805. /** @hidden */
  125806. export var passCubePixelShader: {
  125807. name: string;
  125808. shader: string;
  125809. };
  125810. }
  125811. declare module BABYLON {
  125812. /**
  125813. * PassPostProcess which produces an output the same as it's input
  125814. */
  125815. export class PassPostProcess extends PostProcess {
  125816. /**
  125817. * Gets a string identifying the name of the class
  125818. * @returns "PassPostProcess" string
  125819. */
  125820. getClassName(): string;
  125821. /**
  125822. * Creates the PassPostProcess
  125823. * @param name The name of the effect.
  125824. * @param options The required width/height ratio to downsize to before computing the render pass.
  125825. * @param camera The camera to apply the render pass to.
  125826. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  125827. * @param engine The engine which the post process will be applied. (default: current engine)
  125828. * @param reusable If the post process can be reused on the same frame. (default: false)
  125829. * @param textureType The type of texture to be used when performing the post processing.
  125830. * @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)
  125831. */
  125832. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  125833. /** @hidden */
  125834. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): PassPostProcess;
  125835. }
  125836. /**
  125837. * PassCubePostProcess which produces an output the same as it's input (which must be a cube texture)
  125838. */
  125839. export class PassCubePostProcess extends PostProcess {
  125840. private _face;
  125841. /**
  125842. * Gets or sets the cube face to display.
  125843. * * 0 is +X
  125844. * * 1 is -X
  125845. * * 2 is +Y
  125846. * * 3 is -Y
  125847. * * 4 is +Z
  125848. * * 5 is -Z
  125849. */
  125850. get face(): number;
  125851. set face(value: number);
  125852. /**
  125853. * Gets a string identifying the name of the class
  125854. * @returns "PassCubePostProcess" string
  125855. */
  125856. getClassName(): string;
  125857. /**
  125858. * Creates the PassCubePostProcess
  125859. * @param name The name of the effect.
  125860. * @param options The required width/height ratio to downsize to before computing the render pass.
  125861. * @param camera The camera to apply the render pass to.
  125862. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  125863. * @param engine The engine which the post process will be applied. (default: current engine)
  125864. * @param reusable If the post process can be reused on the same frame. (default: false)
  125865. * @param textureType The type of texture to be used when performing the post processing.
  125866. * @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)
  125867. */
  125868. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  125869. /** @hidden */
  125870. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): PassCubePostProcess;
  125871. }
  125872. }
  125873. declare module BABYLON {
  125874. /** @hidden */
  125875. export var anaglyphPixelShader: {
  125876. name: string;
  125877. shader: string;
  125878. };
  125879. }
  125880. declare module BABYLON {
  125881. /**
  125882. * Postprocess used to generate anaglyphic rendering
  125883. */
  125884. export class AnaglyphPostProcess extends PostProcess {
  125885. private _passedProcess;
  125886. /**
  125887. * Gets a string identifying the name of the class
  125888. * @returns "AnaglyphPostProcess" string
  125889. */
  125890. getClassName(): string;
  125891. /**
  125892. * Creates a new AnaglyphPostProcess
  125893. * @param name defines postprocess name
  125894. * @param options defines creation options or target ratio scale
  125895. * @param rigCameras defines cameras using this postprocess
  125896. * @param samplingMode defines required sampling mode (BABYLON.Texture.NEAREST_SAMPLINGMODE by default)
  125897. * @param engine defines hosting engine
  125898. * @param reusable defines if the postprocess will be reused multiple times per frame
  125899. */
  125900. constructor(name: string, options: number | PostProcessOptions, rigCameras: Camera[], samplingMode?: number, engine?: Engine, reusable?: boolean);
  125901. }
  125902. }
  125903. declare module BABYLON {
  125904. /**
  125905. * Camera used to simulate anaglyphic rendering (based on ArcRotateCamera)
  125906. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  125907. */
  125908. export class AnaglyphArcRotateCamera extends ArcRotateCamera {
  125909. /**
  125910. * Creates a new AnaglyphArcRotateCamera
  125911. * @param name defines camera name
  125912. * @param alpha defines alpha angle (in radians)
  125913. * @param beta defines beta angle (in radians)
  125914. * @param radius defines radius
  125915. * @param target defines camera target
  125916. * @param interaxialDistance defines distance between each color axis
  125917. * @param scene defines the hosting scene
  125918. */
  125919. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, scene: Scene);
  125920. /**
  125921. * Gets camera class name
  125922. * @returns AnaglyphArcRotateCamera
  125923. */
  125924. getClassName(): string;
  125925. }
  125926. }
  125927. declare module BABYLON {
  125928. /**
  125929. * Camera used to simulate anaglyphic rendering (based on FreeCamera)
  125930. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  125931. */
  125932. export class AnaglyphFreeCamera extends FreeCamera {
  125933. /**
  125934. * Creates a new AnaglyphFreeCamera
  125935. * @param name defines camera name
  125936. * @param position defines initial position
  125937. * @param interaxialDistance defines distance between each color axis
  125938. * @param scene defines the hosting scene
  125939. */
  125940. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  125941. /**
  125942. * Gets camera class name
  125943. * @returns AnaglyphFreeCamera
  125944. */
  125945. getClassName(): string;
  125946. }
  125947. }
  125948. declare module BABYLON {
  125949. /**
  125950. * Camera used to simulate anaglyphic rendering (based on GamepadCamera)
  125951. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  125952. */
  125953. export class AnaglyphGamepadCamera extends GamepadCamera {
  125954. /**
  125955. * Creates a new AnaglyphGamepadCamera
  125956. * @param name defines camera name
  125957. * @param position defines initial position
  125958. * @param interaxialDistance defines distance between each color axis
  125959. * @param scene defines the hosting scene
  125960. */
  125961. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  125962. /**
  125963. * Gets camera class name
  125964. * @returns AnaglyphGamepadCamera
  125965. */
  125966. getClassName(): string;
  125967. }
  125968. }
  125969. declare module BABYLON {
  125970. /**
  125971. * Camera used to simulate anaglyphic rendering (based on UniversalCamera)
  125972. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  125973. */
  125974. export class AnaglyphUniversalCamera extends UniversalCamera {
  125975. /**
  125976. * Creates a new AnaglyphUniversalCamera
  125977. * @param name defines camera name
  125978. * @param position defines initial position
  125979. * @param interaxialDistance defines distance between each color axis
  125980. * @param scene defines the hosting scene
  125981. */
  125982. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  125983. /**
  125984. * Gets camera class name
  125985. * @returns AnaglyphUniversalCamera
  125986. */
  125987. getClassName(): string;
  125988. }
  125989. }
  125990. declare module BABYLON {
  125991. /**
  125992. * Camera used to simulate stereoscopic rendering (based on ArcRotateCamera)
  125993. * @see https://doc.babylonjs.com/features/cameras
  125994. */
  125995. export class StereoscopicArcRotateCamera extends ArcRotateCamera {
  125996. /**
  125997. * Creates a new StereoscopicArcRotateCamera
  125998. * @param name defines camera name
  125999. * @param alpha defines alpha angle (in radians)
  126000. * @param beta defines beta angle (in radians)
  126001. * @param radius defines radius
  126002. * @param target defines camera target
  126003. * @param interaxialDistance defines distance between each color axis
  126004. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  126005. * @param scene defines the hosting scene
  126006. */
  126007. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  126008. /**
  126009. * Gets camera class name
  126010. * @returns StereoscopicArcRotateCamera
  126011. */
  126012. getClassName(): string;
  126013. }
  126014. }
  126015. declare module BABYLON {
  126016. /**
  126017. * Camera used to simulate stereoscopic rendering (based on FreeCamera)
  126018. * @see https://doc.babylonjs.com/features/cameras
  126019. */
  126020. export class StereoscopicFreeCamera extends FreeCamera {
  126021. /**
  126022. * Creates a new StereoscopicFreeCamera
  126023. * @param name defines camera name
  126024. * @param position defines initial position
  126025. * @param interaxialDistance defines distance between each color axis
  126026. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  126027. * @param scene defines the hosting scene
  126028. */
  126029. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  126030. /**
  126031. * Gets camera class name
  126032. * @returns StereoscopicFreeCamera
  126033. */
  126034. getClassName(): string;
  126035. }
  126036. }
  126037. declare module BABYLON {
  126038. /**
  126039. * Camera used to simulate stereoscopic rendering (based on GamepadCamera)
  126040. * @see https://doc.babylonjs.com/features/cameras
  126041. */
  126042. export class StereoscopicGamepadCamera extends GamepadCamera {
  126043. /**
  126044. * Creates a new StereoscopicGamepadCamera
  126045. * @param name defines camera name
  126046. * @param position defines initial position
  126047. * @param interaxialDistance defines distance between each color axis
  126048. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  126049. * @param scene defines the hosting scene
  126050. */
  126051. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  126052. /**
  126053. * Gets camera class name
  126054. * @returns StereoscopicGamepadCamera
  126055. */
  126056. getClassName(): string;
  126057. }
  126058. }
  126059. declare module BABYLON {
  126060. /**
  126061. * Camera used to simulate stereoscopic rendering (based on UniversalCamera)
  126062. * @see https://doc.babylonjs.com/features/cameras
  126063. */
  126064. export class StereoscopicUniversalCamera extends UniversalCamera {
  126065. /**
  126066. * Creates a new StereoscopicUniversalCamera
  126067. * @param name defines camera name
  126068. * @param position defines initial position
  126069. * @param interaxialDistance defines distance between each color axis
  126070. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  126071. * @param scene defines the hosting scene
  126072. */
  126073. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  126074. /**
  126075. * Gets camera class name
  126076. * @returns StereoscopicUniversalCamera
  126077. */
  126078. getClassName(): string;
  126079. }
  126080. }
  126081. declare module BABYLON {
  126082. /**
  126083. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  126084. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  126085. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  126086. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  126087. */
  126088. export class VirtualJoysticksCamera extends FreeCamera {
  126089. /**
  126090. * Intantiates a VirtualJoysticksCamera. It can be useful in First Person Shooter game for instance.
  126091. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  126092. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  126093. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  126094. * @param name Define the name of the camera in the scene
  126095. * @param position Define the start position of the camera in the scene
  126096. * @param scene Define the scene the camera belongs to
  126097. */
  126098. constructor(name: string, position: Vector3, scene: Scene);
  126099. /**
  126100. * Gets the current object class name.
  126101. * @return the class name
  126102. */
  126103. getClassName(): string;
  126104. }
  126105. }
  126106. declare module BABYLON {
  126107. /**
  126108. * This represents all the required metrics to create a VR camera.
  126109. * @see https://doc.babylonjs.com/babylon101/cameras#device-orientation-camera
  126110. */
  126111. export class VRCameraMetrics {
  126112. /**
  126113. * Define the horizontal resolution off the screen.
  126114. */
  126115. hResolution: number;
  126116. /**
  126117. * Define the vertical resolution off the screen.
  126118. */
  126119. vResolution: number;
  126120. /**
  126121. * Define the horizontal screen size.
  126122. */
  126123. hScreenSize: number;
  126124. /**
  126125. * Define the vertical screen size.
  126126. */
  126127. vScreenSize: number;
  126128. /**
  126129. * Define the vertical screen center position.
  126130. */
  126131. vScreenCenter: number;
  126132. /**
  126133. * Define the distance of the eyes to the screen.
  126134. */
  126135. eyeToScreenDistance: number;
  126136. /**
  126137. * Define the distance between both lenses
  126138. */
  126139. lensSeparationDistance: number;
  126140. /**
  126141. * Define the distance between both viewer's eyes.
  126142. */
  126143. interpupillaryDistance: number;
  126144. /**
  126145. * Define the distortion factor of the VR postprocess.
  126146. * Please, touch with care.
  126147. */
  126148. distortionK: number[];
  126149. /**
  126150. * Define the chromatic aberration correction factors for the VR post process.
  126151. */
  126152. chromaAbCorrection: number[];
  126153. /**
  126154. * Define the scale factor of the post process.
  126155. * The smaller the better but the slower.
  126156. */
  126157. postProcessScaleFactor: number;
  126158. /**
  126159. * Define an offset for the lens center.
  126160. */
  126161. lensCenterOffset: number;
  126162. /**
  126163. * Define if the current vr camera should compensate the distortion of the lense or not.
  126164. */
  126165. compensateDistortion: boolean;
  126166. /**
  126167. * Defines if multiview should be enabled when rendering (Default: false)
  126168. */
  126169. multiviewEnabled: boolean;
  126170. /**
  126171. * Gets the rendering aspect ratio based on the provided resolutions.
  126172. */
  126173. get aspectRatio(): number;
  126174. /**
  126175. * Gets the aspect ratio based on the FOV, scale factors, and real screen sizes.
  126176. */
  126177. get aspectRatioFov(): number;
  126178. /**
  126179. * @hidden
  126180. */
  126181. get leftHMatrix(): Matrix;
  126182. /**
  126183. * @hidden
  126184. */
  126185. get rightHMatrix(): Matrix;
  126186. /**
  126187. * @hidden
  126188. */
  126189. get leftPreViewMatrix(): Matrix;
  126190. /**
  126191. * @hidden
  126192. */
  126193. get rightPreViewMatrix(): Matrix;
  126194. /**
  126195. * Get the default VRMetrics based on the most generic setup.
  126196. * @returns the default vr metrics
  126197. */
  126198. static GetDefault(): VRCameraMetrics;
  126199. }
  126200. }
  126201. declare module BABYLON {
  126202. /** @hidden */
  126203. export var vrDistortionCorrectionPixelShader: {
  126204. name: string;
  126205. shader: string;
  126206. };
  126207. }
  126208. declare module BABYLON {
  126209. /**
  126210. * VRDistortionCorrectionPostProcess used for mobile VR
  126211. */
  126212. export class VRDistortionCorrectionPostProcess extends PostProcess {
  126213. private _isRightEye;
  126214. private _distortionFactors;
  126215. private _postProcessScaleFactor;
  126216. private _lensCenterOffset;
  126217. private _scaleIn;
  126218. private _scaleFactor;
  126219. private _lensCenter;
  126220. /**
  126221. * Gets a string identifying the name of the class
  126222. * @returns "VRDistortionCorrectionPostProcess" string
  126223. */
  126224. getClassName(): string;
  126225. /**
  126226. * Initializes the VRDistortionCorrectionPostProcess
  126227. * @param name The name of the effect.
  126228. * @param camera The camera to apply the render pass to.
  126229. * @param isRightEye If this is for the right eye distortion
  126230. * @param vrMetrics All the required metrics for the VR camera
  126231. */
  126232. constructor(name: string, camera: Camera, isRightEye: boolean, vrMetrics: VRCameraMetrics);
  126233. }
  126234. }
  126235. declare module BABYLON {
  126236. /**
  126237. * Camera used to simulate VR rendering (based on ArcRotateCamera)
  126238. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  126239. */
  126240. export class VRDeviceOrientationArcRotateCamera extends ArcRotateCamera {
  126241. /**
  126242. * Creates a new VRDeviceOrientationArcRotateCamera
  126243. * @param name defines camera name
  126244. * @param alpha defines the camera rotation along the logitudinal axis
  126245. * @param beta defines the camera rotation along the latitudinal axis
  126246. * @param radius defines the camera distance from its target
  126247. * @param target defines the camera target
  126248. * @param scene defines the scene the camera belongs to
  126249. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  126250. * @param vrCameraMetrics defines the vr metrics associated to the camera
  126251. */
  126252. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  126253. /**
  126254. * Gets camera class name
  126255. * @returns VRDeviceOrientationArcRotateCamera
  126256. */
  126257. getClassName(): string;
  126258. }
  126259. }
  126260. declare module BABYLON {
  126261. /**
  126262. * Camera used to simulate VR rendering (based on FreeCamera)
  126263. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  126264. */
  126265. export class VRDeviceOrientationFreeCamera extends DeviceOrientationCamera {
  126266. /**
  126267. * Creates a new VRDeviceOrientationFreeCamera
  126268. * @param name defines camera name
  126269. * @param position defines the start position of the camera
  126270. * @param scene defines the scene the camera belongs to
  126271. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  126272. * @param vrCameraMetrics defines the vr metrics associated to the camera
  126273. */
  126274. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  126275. /**
  126276. * Gets camera class name
  126277. * @returns VRDeviceOrientationFreeCamera
  126278. */
  126279. getClassName(): string;
  126280. }
  126281. }
  126282. declare module BABYLON {
  126283. /**
  126284. * Camera used to simulate VR rendering (based on VRDeviceOrientationFreeCamera)
  126285. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  126286. */
  126287. export class VRDeviceOrientationGamepadCamera extends VRDeviceOrientationFreeCamera {
  126288. /**
  126289. * Creates a new VRDeviceOrientationGamepadCamera
  126290. * @param name defines camera name
  126291. * @param position defines the start position of the camera
  126292. * @param scene defines the scene the camera belongs to
  126293. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  126294. * @param vrCameraMetrics defines the vr metrics associated to the camera
  126295. */
  126296. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  126297. /**
  126298. * Gets camera class name
  126299. * @returns VRDeviceOrientationGamepadCamera
  126300. */
  126301. getClassName(): string;
  126302. }
  126303. }
  126304. declare module BABYLON {
  126305. /**
  126306. * A class extending Texture allowing drawing on a texture
  126307. * @see https://doc.babylonjs.com/how_to/dynamictexture
  126308. */
  126309. export class DynamicTexture extends Texture {
  126310. private _generateMipMaps;
  126311. private _canvas;
  126312. private _context;
  126313. /**
  126314. * Creates a DynamicTexture
  126315. * @param name defines the name of the texture
  126316. * @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
  126317. * @param scene defines the scene where you want the texture
  126318. * @param generateMipMaps defines the use of MinMaps or not (default is false)
  126319. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  126320. * @param format defines the texture format to use (default is Engine.TEXTUREFORMAT_RGBA)
  126321. */
  126322. constructor(name: string, options: any, scene: Scene | null | undefined, generateMipMaps: boolean, samplingMode?: number, format?: number);
  126323. /**
  126324. * Get the current class name of the texture useful for serialization or dynamic coding.
  126325. * @returns "DynamicTexture"
  126326. */
  126327. getClassName(): string;
  126328. /**
  126329. * Gets the current state of canRescale
  126330. */
  126331. get canRescale(): boolean;
  126332. private _recreate;
  126333. /**
  126334. * Scales the texture
  126335. * @param ratio the scale factor to apply to both width and height
  126336. */
  126337. scale(ratio: number): void;
  126338. /**
  126339. * Resizes the texture
  126340. * @param width the new width
  126341. * @param height the new height
  126342. */
  126343. scaleTo(width: number, height: number): void;
  126344. /**
  126345. * Gets the context of the canvas used by the texture
  126346. * @returns the canvas context of the dynamic texture
  126347. */
  126348. getContext(): CanvasRenderingContext2D;
  126349. /**
  126350. * Clears the texture
  126351. */
  126352. clear(): void;
  126353. /**
  126354. * Updates the texture
  126355. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  126356. * @param premulAlpha defines if alpha is stored as premultiplied (default is false)
  126357. */
  126358. update(invertY?: boolean, premulAlpha?: boolean): void;
  126359. /**
  126360. * Draws text onto the texture
  126361. * @param text defines the text to be drawn
  126362. * @param x defines the placement of the text from the left
  126363. * @param y defines the placement of the text from the top when invertY is true and from the bottom when false
  126364. * @param font defines the font to be used with font-style, font-size, font-name
  126365. * @param color defines the color used for the text
  126366. * @param clearColor defines the color for the canvas, use null to not overwrite canvas
  126367. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  126368. * @param update defines whether texture is immediately update (default is true)
  126369. */
  126370. drawText(text: string, x: number | null | undefined, y: number | null | undefined, font: string, color: string | null, clearColor: string, invertY?: boolean, update?: boolean): void;
  126371. /**
  126372. * Clones the texture
  126373. * @returns the clone of the texture.
  126374. */
  126375. clone(): DynamicTexture;
  126376. /**
  126377. * Serializes the dynamic texture. The scene should be ready before the dynamic texture is serialized
  126378. * @returns a serialized dynamic texture object
  126379. */
  126380. serialize(): any;
  126381. private _IsCanvasElement;
  126382. /** @hidden */
  126383. _rebuild(): void;
  126384. }
  126385. }
  126386. declare module BABYLON {
  126387. /**
  126388. * Class containing static functions to help procedurally build meshes
  126389. */
  126390. export class GroundBuilder {
  126391. /**
  126392. * Creates a ground mesh
  126393. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  126394. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  126395. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  126396. * @param name defines the name of the mesh
  126397. * @param options defines the options used to create the mesh
  126398. * @param scene defines the hosting scene
  126399. * @returns the ground mesh
  126400. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  126401. */
  126402. static CreateGround(name: string, options: {
  126403. width?: number;
  126404. height?: number;
  126405. subdivisions?: number;
  126406. subdivisionsX?: number;
  126407. subdivisionsY?: number;
  126408. updatable?: boolean;
  126409. }, scene: any): Mesh;
  126410. /**
  126411. * Creates a tiled ground mesh
  126412. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  126413. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  126414. * * 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
  126415. * * 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
  126416. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  126417. * @param name defines the name of the mesh
  126418. * @param options defines the options used to create the mesh
  126419. * @param scene defines the hosting scene
  126420. * @returns the tiled ground mesh
  126421. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  126422. */
  126423. static CreateTiledGround(name: string, options: {
  126424. xmin: number;
  126425. zmin: number;
  126426. xmax: number;
  126427. zmax: number;
  126428. subdivisions?: {
  126429. w: number;
  126430. h: number;
  126431. };
  126432. precision?: {
  126433. w: number;
  126434. h: number;
  126435. };
  126436. updatable?: boolean;
  126437. }, scene?: Nullable<Scene>): Mesh;
  126438. /**
  126439. * Creates a ground mesh from a height map
  126440. * * The parameter `url` sets the URL of the height map image resource.
  126441. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  126442. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  126443. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  126444. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  126445. * * 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.
  126446. * * 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).
  126447. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  126448. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  126449. * @param name defines the name of the mesh
  126450. * @param url defines the url to the height map
  126451. * @param options defines the options used to create the mesh
  126452. * @param scene defines the hosting scene
  126453. * @returns the ground mesh
  126454. * @see https://doc.babylonjs.com/babylon101/height_map
  126455. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  126456. */
  126457. static CreateGroundFromHeightMap(name: string, url: string, options: {
  126458. width?: number;
  126459. height?: number;
  126460. subdivisions?: number;
  126461. minHeight?: number;
  126462. maxHeight?: number;
  126463. colorFilter?: Color3;
  126464. alphaFilter?: number;
  126465. updatable?: boolean;
  126466. onReady?: (mesh: GroundMesh) => void;
  126467. }, scene?: Nullable<Scene>): GroundMesh;
  126468. }
  126469. }
  126470. declare module BABYLON {
  126471. /**
  126472. * Class containing static functions to help procedurally build meshes
  126473. */
  126474. export class TorusBuilder {
  126475. /**
  126476. * Creates a torus mesh
  126477. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  126478. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  126479. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  126480. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  126481. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  126482. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  126483. * @param name defines the name of the mesh
  126484. * @param options defines the options used to create the mesh
  126485. * @param scene defines the hosting scene
  126486. * @returns the torus mesh
  126487. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  126488. */
  126489. static CreateTorus(name: string, options: {
  126490. diameter?: number;
  126491. thickness?: number;
  126492. tessellation?: number;
  126493. updatable?: boolean;
  126494. sideOrientation?: number;
  126495. frontUVs?: Vector4;
  126496. backUVs?: Vector4;
  126497. }, scene: any): Mesh;
  126498. }
  126499. }
  126500. declare module BABYLON {
  126501. /**
  126502. * Class containing static functions to help procedurally build meshes
  126503. */
  126504. export class CylinderBuilder {
  126505. /**
  126506. * Creates a cylinder or a cone mesh
  126507. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  126508. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  126509. * * 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.
  126510. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  126511. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  126512. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  126513. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  126514. * * 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).
  126515. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  126516. * * 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).
  126517. * * 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
  126518. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  126519. * * 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
  126520. * * 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.
  126521. * * If `enclose` is false, a ring surface is one element.
  126522. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  126523. * * 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
  126524. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  126525. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  126526. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  126527. * @param name defines the name of the mesh
  126528. * @param options defines the options used to create the mesh
  126529. * @param scene defines the hosting scene
  126530. * @returns the cylinder mesh
  126531. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  126532. */
  126533. static CreateCylinder(name: string, options: {
  126534. height?: number;
  126535. diameterTop?: number;
  126536. diameterBottom?: number;
  126537. diameter?: number;
  126538. tessellation?: number;
  126539. subdivisions?: number;
  126540. arc?: number;
  126541. faceColors?: Color4[];
  126542. faceUV?: Vector4[];
  126543. updatable?: boolean;
  126544. hasRings?: boolean;
  126545. enclose?: boolean;
  126546. cap?: number;
  126547. sideOrientation?: number;
  126548. frontUVs?: Vector4;
  126549. backUVs?: Vector4;
  126550. }, scene: any): Mesh;
  126551. }
  126552. }
  126553. declare module BABYLON {
  126554. /**
  126555. * States of the webXR experience
  126556. */
  126557. export enum WebXRState {
  126558. /**
  126559. * Transitioning to being in XR mode
  126560. */
  126561. ENTERING_XR = 0,
  126562. /**
  126563. * Transitioning to non XR mode
  126564. */
  126565. EXITING_XR = 1,
  126566. /**
  126567. * In XR mode and presenting
  126568. */
  126569. IN_XR = 2,
  126570. /**
  126571. * Not entered XR mode
  126572. */
  126573. NOT_IN_XR = 3
  126574. }
  126575. /**
  126576. * Abstraction of the XR render target
  126577. */
  126578. export interface WebXRRenderTarget extends IDisposable {
  126579. /**
  126580. * xrpresent context of the canvas which can be used to display/mirror xr content
  126581. */
  126582. canvasContext: WebGLRenderingContext;
  126583. /**
  126584. * xr layer for the canvas
  126585. */
  126586. xrLayer: Nullable<XRWebGLLayer>;
  126587. /**
  126588. * Initializes the xr layer for the session
  126589. * @param xrSession xr session
  126590. * @returns a promise that will resolve once the XR Layer has been created
  126591. */
  126592. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  126593. }
  126594. }
  126595. declare module BABYLON {
  126596. /**
  126597. * COnfiguration object for WebXR output canvas
  126598. */
  126599. export class WebXRManagedOutputCanvasOptions {
  126600. /**
  126601. * An optional canvas in case you wish to create it yourself and provide it here.
  126602. * If not provided, a new canvas will be created
  126603. */
  126604. canvasElement?: HTMLCanvasElement;
  126605. /**
  126606. * Options for this XR Layer output
  126607. */
  126608. canvasOptions?: XRWebGLLayerOptions;
  126609. /**
  126610. * CSS styling for a newly created canvas (if not provided)
  126611. */
  126612. newCanvasCssStyle?: string;
  126613. /**
  126614. * Get the default values of the configuration object
  126615. * @param engine defines the engine to use (can be null)
  126616. * @returns default values of this configuration object
  126617. */
  126618. static GetDefaults(engine?: ThinEngine): WebXRManagedOutputCanvasOptions;
  126619. }
  126620. /**
  126621. * Creates a canvas that is added/removed from the webpage when entering/exiting XR
  126622. */
  126623. export class WebXRManagedOutputCanvas implements WebXRRenderTarget {
  126624. private _options;
  126625. private _canvas;
  126626. private _engine;
  126627. private _originalCanvasSize;
  126628. /**
  126629. * Rendering context of the canvas which can be used to display/mirror xr content
  126630. */
  126631. canvasContext: WebGLRenderingContext;
  126632. /**
  126633. * xr layer for the canvas
  126634. */
  126635. xrLayer: Nullable<XRWebGLLayer>;
  126636. /**
  126637. * Obseervers registered here will be triggered when the xr layer was initialized
  126638. */
  126639. onXRLayerInitObservable: Observable<XRWebGLLayer>;
  126640. /**
  126641. * Initializes the canvas to be added/removed upon entering/exiting xr
  126642. * @param _xrSessionManager The XR Session manager
  126643. * @param _options optional configuration for this canvas output. defaults will be used if not provided
  126644. */
  126645. constructor(_xrSessionManager: WebXRSessionManager, _options?: WebXRManagedOutputCanvasOptions);
  126646. /**
  126647. * Disposes of the object
  126648. */
  126649. dispose(): void;
  126650. /**
  126651. * Initializes the xr layer for the session
  126652. * @param xrSession xr session
  126653. * @returns a promise that will resolve once the XR Layer has been created
  126654. */
  126655. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  126656. private _addCanvas;
  126657. private _removeCanvas;
  126658. private _setCanvasSize;
  126659. private _setManagedOutputCanvas;
  126660. }
  126661. }
  126662. declare module BABYLON {
  126663. /**
  126664. * Manages an XRSession to work with Babylon's engine
  126665. * @see https://doc.babylonjs.com/how_to/webxr_session_manager
  126666. */
  126667. export class WebXRSessionManager implements IDisposable {
  126668. /** The scene which the session should be created for */
  126669. scene: Scene;
  126670. private _referenceSpace;
  126671. private _rttProvider;
  126672. private _sessionEnded;
  126673. private _xrNavigator;
  126674. private baseLayer;
  126675. /**
  126676. * The base reference space from which the session started. good if you want to reset your
  126677. * reference space
  126678. */
  126679. baseReferenceSpace: XRReferenceSpace;
  126680. /**
  126681. * Current XR frame
  126682. */
  126683. currentFrame: Nullable<XRFrame>;
  126684. /** WebXR timestamp updated every frame */
  126685. currentTimestamp: number;
  126686. /**
  126687. * Used just in case of a failure to initialize an immersive session.
  126688. * The viewer reference space is compensated using this height, creating a kind of "viewer-floor" reference space
  126689. */
  126690. defaultHeightCompensation: number;
  126691. /**
  126692. * Fires every time a new xrFrame arrives which can be used to update the camera
  126693. */
  126694. onXRFrameObservable: Observable<XRFrame>;
  126695. /**
  126696. * Fires when the reference space changed
  126697. */
  126698. onXRReferenceSpaceChanged: Observable<XRReferenceSpace>;
  126699. /**
  126700. * Fires when the xr session is ended either by the device or manually done
  126701. */
  126702. onXRSessionEnded: Observable<any>;
  126703. /**
  126704. * Fires when the xr session is ended either by the device or manually done
  126705. */
  126706. onXRSessionInit: Observable<XRSession>;
  126707. /**
  126708. * Underlying xr session
  126709. */
  126710. session: XRSession;
  126711. /**
  126712. * The viewer (head position) reference space. This can be used to get the XR world coordinates
  126713. * or get the offset the player is currently at.
  126714. */
  126715. viewerReferenceSpace: XRReferenceSpace;
  126716. /**
  126717. * Constructs a WebXRSessionManager, this must be initialized within a user action before usage
  126718. * @param scene The scene which the session should be created for
  126719. */
  126720. constructor(
  126721. /** The scene which the session should be created for */
  126722. scene: Scene);
  126723. /**
  126724. * The current reference space used in this session. This reference space can constantly change!
  126725. * It is mainly used to offset the camera's position.
  126726. */
  126727. get referenceSpace(): XRReferenceSpace;
  126728. /**
  126729. * Set a new reference space and triggers the observable
  126730. */
  126731. set referenceSpace(newReferenceSpace: XRReferenceSpace);
  126732. /**
  126733. * Disposes of the session manager
  126734. */
  126735. dispose(): void;
  126736. /**
  126737. * Stops the xrSession and restores the render loop
  126738. * @returns Promise which resolves after it exits XR
  126739. */
  126740. exitXRAsync(): Promise<void>;
  126741. /**
  126742. * Gets the correct render target texture to be rendered this frame for this eye
  126743. * @param eye the eye for which to get the render target
  126744. * @returns the render target for the specified eye
  126745. */
  126746. getRenderTargetTextureForEye(eye: XREye): RenderTargetTexture;
  126747. /**
  126748. * Creates a WebXRRenderTarget object for the XR session
  126749. * @param onStateChangedObservable optional, mechanism for enabling/disabling XR rendering canvas, used only on Web
  126750. * @param options optional options to provide when creating a new render target
  126751. * @returns a WebXR render target to which the session can render
  126752. */
  126753. getWebXRRenderTarget(options?: WebXRManagedOutputCanvasOptions): WebXRRenderTarget;
  126754. /**
  126755. * Initializes the manager
  126756. * After initialization enterXR can be called to start an XR session
  126757. * @returns Promise which resolves after it is initialized
  126758. */
  126759. initializeAsync(): Promise<void>;
  126760. /**
  126761. * Initializes an xr session
  126762. * @param xrSessionMode mode to initialize
  126763. * @param xrSessionInit defines optional and required values to pass to the session builder
  126764. * @returns a promise which will resolve once the session has been initialized
  126765. */
  126766. initializeSessionAsync(xrSessionMode?: XRSessionMode, xrSessionInit?: XRSessionInit): Promise<XRSession>;
  126767. /**
  126768. * Checks if a session would be supported for the creation options specified
  126769. * @param sessionMode session mode to check if supported eg. immersive-vr
  126770. * @returns A Promise that resolves to true if supported and false if not
  126771. */
  126772. isSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  126773. /**
  126774. * Resets the reference space to the one started the session
  126775. */
  126776. resetReferenceSpace(): void;
  126777. /**
  126778. * Starts rendering to the xr layer
  126779. */
  126780. runXRRenderLoop(): void;
  126781. /**
  126782. * Sets the reference space on the xr session
  126783. * @param referenceSpaceType space to set
  126784. * @returns a promise that will resolve once the reference space has been set
  126785. */
  126786. setReferenceSpaceTypeAsync(referenceSpaceType?: XRReferenceSpaceType): Promise<XRReferenceSpace>;
  126787. /**
  126788. * Updates the render state of the session
  126789. * @param state state to set
  126790. * @returns a promise that resolves once the render state has been updated
  126791. */
  126792. updateRenderStateAsync(state: XRRenderState): Promise<void>;
  126793. /**
  126794. * Returns a promise that resolves with a boolean indicating if the provided session mode is supported by this browser
  126795. * @param sessionMode defines the session to test
  126796. * @returns a promise with boolean as final value
  126797. */
  126798. static IsSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  126799. private _createRenderTargetTexture;
  126800. }
  126801. }
  126802. declare module BABYLON {
  126803. /**
  126804. * WebXR Camera which holds the views for the xrSession
  126805. * @see https://doc.babylonjs.com/how_to/webxr_camera
  126806. */
  126807. export class WebXRCamera extends FreeCamera {
  126808. private _xrSessionManager;
  126809. private _firstFrame;
  126810. private _referenceQuaternion;
  126811. private _referencedPosition;
  126812. private _xrInvPositionCache;
  126813. private _xrInvQuaternionCache;
  126814. /**
  126815. * Observable raised before camera teleportation
  126816. */
  126817. onBeforeCameraTeleport: Observable<Vector3>;
  126818. /**
  126819. * Observable raised after camera teleportation
  126820. */
  126821. onAfterCameraTeleport: Observable<Vector3>;
  126822. /**
  126823. * Should position compensation execute on first frame.
  126824. * This is used when copying the position from a native (non XR) camera
  126825. */
  126826. compensateOnFirstFrame: boolean;
  126827. /**
  126828. * Creates a new webXRCamera, this should only be set at the camera after it has been updated by the xrSessionManager
  126829. * @param name the name of the camera
  126830. * @param scene the scene to add the camera to
  126831. * @param _xrSessionManager a constructed xr session manager
  126832. */
  126833. constructor(name: string, scene: Scene, _xrSessionManager: WebXRSessionManager);
  126834. /**
  126835. * Return the user's height, unrelated to the current ground.
  126836. * This will be the y position of this camera, when ground level is 0.
  126837. */
  126838. get realWorldHeight(): number;
  126839. /** @hidden */
  126840. _updateForDualEyeDebugging(): void;
  126841. /**
  126842. * Sets this camera's transformation based on a non-vr camera
  126843. * @param otherCamera the non-vr camera to copy the transformation from
  126844. * @param resetToBaseReferenceSpace should XR reset to the base reference space
  126845. */
  126846. setTransformationFromNonVRCamera(otherCamera?: Camera, resetToBaseReferenceSpace?: boolean): void;
  126847. /**
  126848. * Gets the current instance class name ("WebXRCamera").
  126849. * @returns the class name
  126850. */
  126851. getClassName(): string;
  126852. private _rotate180;
  126853. private _updateFromXRSession;
  126854. private _updateNumberOfRigCameras;
  126855. private _updateReferenceSpace;
  126856. private _updateReferenceSpaceOffset;
  126857. }
  126858. }
  126859. declare module BABYLON {
  126860. /**
  126861. * Defining the interface required for a (webxr) feature
  126862. */
  126863. export interface IWebXRFeature extends IDisposable {
  126864. /**
  126865. * Is this feature attached
  126866. */
  126867. attached: boolean;
  126868. /**
  126869. * Should auto-attach be disabled?
  126870. */
  126871. disableAutoAttach: boolean;
  126872. /**
  126873. * Attach the feature to the session
  126874. * Will usually be called by the features manager
  126875. *
  126876. * @param force should attachment be forced (even when already attached)
  126877. * @returns true if successful.
  126878. */
  126879. attach(force?: boolean): boolean;
  126880. /**
  126881. * Detach the feature from the session
  126882. * Will usually be called by the features manager
  126883. *
  126884. * @returns true if successful.
  126885. */
  126886. detach(): boolean;
  126887. /**
  126888. * This function will be executed during before enabling the feature and can be used to not-allow enabling it.
  126889. * Note that at this point the session has NOT started, so this is purely checking if the browser supports it
  126890. *
  126891. * @returns whether or not the feature is compatible in this environment
  126892. */
  126893. isCompatible(): boolean;
  126894. /**
  126895. * The name of the native xr feature name, if applicable (like anchor, hit-test, or hand-tracking)
  126896. */
  126897. xrNativeFeatureName?: string;
  126898. /**
  126899. * A list of (Babylon WebXR) features this feature depends on
  126900. */
  126901. dependsOn?: string[];
  126902. }
  126903. /**
  126904. * A list of the currently available features without referencing them
  126905. */
  126906. export class WebXRFeatureName {
  126907. /**
  126908. * The name of the anchor system feature
  126909. */
  126910. static readonly ANCHOR_SYSTEM: string;
  126911. /**
  126912. * The name of the background remover feature
  126913. */
  126914. static readonly BACKGROUND_REMOVER: string;
  126915. /**
  126916. * The name of the hit test feature
  126917. */
  126918. static readonly HIT_TEST: string;
  126919. /**
  126920. * physics impostors for xr controllers feature
  126921. */
  126922. static readonly PHYSICS_CONTROLLERS: string;
  126923. /**
  126924. * The name of the plane detection feature
  126925. */
  126926. static readonly PLANE_DETECTION: string;
  126927. /**
  126928. * The name of the pointer selection feature
  126929. */
  126930. static readonly POINTER_SELECTION: string;
  126931. /**
  126932. * The name of the teleportation feature
  126933. */
  126934. static readonly TELEPORTATION: string;
  126935. /**
  126936. * The name of the feature points feature.
  126937. */
  126938. static readonly FEATURE_POINTS: string;
  126939. /**
  126940. * The name of the hand tracking feature.
  126941. */
  126942. static readonly HAND_TRACKING: string;
  126943. }
  126944. /**
  126945. * Defining the constructor of a feature. Used to register the modules.
  126946. */
  126947. export type WebXRFeatureConstructor = (xrSessionManager: WebXRSessionManager, options?: any) => () => IWebXRFeature;
  126948. /**
  126949. * The WebXR features manager is responsible of enabling or disabling features required for the current XR session.
  126950. * It is mainly used in AR sessions.
  126951. *
  126952. * A feature can have a version that is defined by Babylon (and does not correspond with the webxr version).
  126953. */
  126954. export class WebXRFeaturesManager implements IDisposable {
  126955. private _xrSessionManager;
  126956. private static readonly _AvailableFeatures;
  126957. private _features;
  126958. /**
  126959. * constructs a new features manages.
  126960. *
  126961. * @param _xrSessionManager an instance of WebXRSessionManager
  126962. */
  126963. constructor(_xrSessionManager: WebXRSessionManager);
  126964. /**
  126965. * Used to register a module. After calling this function a developer can use this feature in the scene.
  126966. * Mainly used internally.
  126967. *
  126968. * @param featureName the name of the feature to register
  126969. * @param constructorFunction the function used to construct the module
  126970. * @param version the (babylon) version of the module
  126971. * @param stable is that a stable version of this module
  126972. */
  126973. static AddWebXRFeature(featureName: string, constructorFunction: WebXRFeatureConstructor, version?: number, stable?: boolean): void;
  126974. /**
  126975. * Returns a constructor of a specific feature.
  126976. *
  126977. * @param featureName the name of the feature to construct
  126978. * @param version the version of the feature to load
  126979. * @param xrSessionManager the xrSessionManager. Used to construct the module
  126980. * @param options optional options provided to the module.
  126981. * @returns a function that, when called, will return a new instance of this feature
  126982. */
  126983. static ConstructFeature(featureName: string, version: number | undefined, xrSessionManager: WebXRSessionManager, options?: any): () => IWebXRFeature;
  126984. /**
  126985. * Can be used to return the list of features currently registered
  126986. *
  126987. * @returns an Array of available features
  126988. */
  126989. static GetAvailableFeatures(): string[];
  126990. /**
  126991. * Gets the versions available for a specific feature
  126992. * @param featureName the name of the feature
  126993. * @returns an array with the available versions
  126994. */
  126995. static GetAvailableVersions(featureName: string): string[];
  126996. /**
  126997. * Return the latest unstable version of this feature
  126998. * @param featureName the name of the feature to search
  126999. * @returns the version number. if not found will return -1
  127000. */
  127001. static GetLatestVersionOfFeature(featureName: string): number;
  127002. /**
  127003. * Return the latest stable version of this feature
  127004. * @param featureName the name of the feature to search
  127005. * @returns the version number. if not found will return -1
  127006. */
  127007. static GetStableVersionOfFeature(featureName: string): number;
  127008. /**
  127009. * Attach a feature to the current session. Mainly used when session started to start the feature effect.
  127010. * Can be used during a session to start a feature
  127011. * @param featureName the name of feature to attach
  127012. */
  127013. attachFeature(featureName: string): void;
  127014. /**
  127015. * Can be used inside a session or when the session ends to detach a specific feature
  127016. * @param featureName the name of the feature to detach
  127017. */
  127018. detachFeature(featureName: string): void;
  127019. /**
  127020. * Used to disable an already-enabled feature
  127021. * The feature will be disposed and will be recreated once enabled.
  127022. * @param featureName the feature to disable
  127023. * @returns true if disable was successful
  127024. */
  127025. disableFeature(featureName: string | {
  127026. Name: string;
  127027. }): boolean;
  127028. /**
  127029. * dispose this features manager
  127030. */
  127031. dispose(): void;
  127032. /**
  127033. * 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.
  127034. * 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.
  127035. *
  127036. * @param featureName the name of the feature to load or the class of the feature
  127037. * @param version optional version to load. if not provided the latest version will be enabled
  127038. * @param moduleOptions options provided to the module. Ses the module documentation / constructor
  127039. * @param attachIfPossible if set to true (default) the feature will be automatically attached, if it is currently possible
  127040. * @param required is this feature required to the app. If set to true the session init will fail if the feature is not available.
  127041. * @returns a new constructed feature or throws an error if feature not found.
  127042. */
  127043. enableFeature(featureName: string | {
  127044. Name: string;
  127045. }, version?: number | string, moduleOptions?: any, attachIfPossible?: boolean, required?: boolean): IWebXRFeature;
  127046. /**
  127047. * get the implementation of an enabled feature.
  127048. * @param featureName the name of the feature to load
  127049. * @returns the feature class, if found
  127050. */
  127051. getEnabledFeature(featureName: string): IWebXRFeature;
  127052. /**
  127053. * Get the list of enabled features
  127054. * @returns an array of enabled features
  127055. */
  127056. getEnabledFeatures(): string[];
  127057. /**
  127058. * This function will exten the session creation configuration object with enabled features.
  127059. * If, for example, the anchors feature is enabled, it will be automatically added to the optional or required features list,
  127060. * according to the defined "required" variable, provided during enableFeature call
  127061. * @param xrSessionInit the xr Session init object to extend
  127062. *
  127063. * @returns an extended XRSessionInit object
  127064. */
  127065. extendXRSessionInitObject(xrSessionInit: XRSessionInit): XRSessionInit;
  127066. }
  127067. }
  127068. declare module BABYLON {
  127069. /**
  127070. * Base set of functionality needed to create an XR experience (WebXRSessionManager, Camera, StateManagement, etc.)
  127071. * @see https://doc.babylonjs.com/how_to/webxr_experience_helpers
  127072. */
  127073. export class WebXRExperienceHelper implements IDisposable {
  127074. private scene;
  127075. private _nonVRCamera;
  127076. private _originalSceneAutoClear;
  127077. private _supported;
  127078. /**
  127079. * Camera used to render xr content
  127080. */
  127081. camera: WebXRCamera;
  127082. /** A features manager for this xr session */
  127083. featuresManager: WebXRFeaturesManager;
  127084. /**
  127085. * Observers registered here will be triggered after the camera's initial transformation is set
  127086. * This can be used to set a different ground level or an extra rotation.
  127087. *
  127088. * Note that ground level is considered to be at 0. The height defined by the XR camera will be added
  127089. * to the position set after this observable is done executing.
  127090. */
  127091. onInitialXRPoseSetObservable: Observable<WebXRCamera>;
  127092. /**
  127093. * Fires when the state of the experience helper has changed
  127094. */
  127095. onStateChangedObservable: Observable<WebXRState>;
  127096. /** Session manager used to keep track of xr session */
  127097. sessionManager: WebXRSessionManager;
  127098. /**
  127099. * The current state of the XR experience (eg. transitioning, in XR or not in XR)
  127100. */
  127101. state: WebXRState;
  127102. /**
  127103. * Creates a WebXRExperienceHelper
  127104. * @param scene The scene the helper should be created in
  127105. */
  127106. private constructor();
  127107. /**
  127108. * Creates the experience helper
  127109. * @param scene the scene to attach the experience helper to
  127110. * @returns a promise for the experience helper
  127111. */
  127112. static CreateAsync(scene: Scene): Promise<WebXRExperienceHelper>;
  127113. /**
  127114. * Disposes of the experience helper
  127115. */
  127116. dispose(): void;
  127117. /**
  127118. * Enters XR mode (This must be done within a user interaction in most browsers eg. button click)
  127119. * @param sessionMode options for the XR session
  127120. * @param referenceSpaceType frame of reference of the XR session
  127121. * @param renderTarget the output canvas that will be used to enter XR mode
  127122. * @param sessionCreationOptions optional XRSessionInit object to init the session with
  127123. * @returns promise that resolves after xr mode has entered
  127124. */
  127125. enterXRAsync(sessionMode: XRSessionMode, referenceSpaceType: XRReferenceSpaceType, renderTarget?: WebXRRenderTarget, sessionCreationOptions?: XRSessionInit): Promise<WebXRSessionManager>;
  127126. /**
  127127. * Exits XR mode and returns the scene to its original state
  127128. * @returns promise that resolves after xr mode has exited
  127129. */
  127130. exitXRAsync(): Promise<void>;
  127131. private _nonXRToXRCamera;
  127132. private _setState;
  127133. }
  127134. }
  127135. declare module BABYLON {
  127136. /**
  127137. * X-Y values for axes in WebXR
  127138. */
  127139. export interface IWebXRMotionControllerAxesValue {
  127140. /**
  127141. * The value of the x axis
  127142. */
  127143. x: number;
  127144. /**
  127145. * The value of the y-axis
  127146. */
  127147. y: number;
  127148. }
  127149. /**
  127150. * changed / previous values for the values of this component
  127151. */
  127152. export interface IWebXRMotionControllerComponentChangesValues<T> {
  127153. /**
  127154. * current (this frame) value
  127155. */
  127156. current: T;
  127157. /**
  127158. * previous (last change) value
  127159. */
  127160. previous: T;
  127161. }
  127162. /**
  127163. * Represents changes in the component between current frame and last values recorded
  127164. */
  127165. export interface IWebXRMotionControllerComponentChanges {
  127166. /**
  127167. * will be populated with previous and current values if axes changed
  127168. */
  127169. axes?: IWebXRMotionControllerComponentChangesValues<IWebXRMotionControllerAxesValue>;
  127170. /**
  127171. * will be populated with previous and current values if pressed changed
  127172. */
  127173. pressed?: IWebXRMotionControllerComponentChangesValues<boolean>;
  127174. /**
  127175. * will be populated with previous and current values if touched changed
  127176. */
  127177. touched?: IWebXRMotionControllerComponentChangesValues<boolean>;
  127178. /**
  127179. * will be populated with previous and current values if value changed
  127180. */
  127181. value?: IWebXRMotionControllerComponentChangesValues<number>;
  127182. }
  127183. /**
  127184. * This class represents a single component (for example button or thumbstick) of a motion controller
  127185. */
  127186. export class WebXRControllerComponent implements IDisposable {
  127187. /**
  127188. * the id of this component
  127189. */
  127190. id: string;
  127191. /**
  127192. * the type of the component
  127193. */
  127194. type: MotionControllerComponentType;
  127195. private _buttonIndex;
  127196. private _axesIndices;
  127197. private _axes;
  127198. private _changes;
  127199. private _currentValue;
  127200. private _hasChanges;
  127201. private _pressed;
  127202. private _touched;
  127203. /**
  127204. * button component type
  127205. */
  127206. static BUTTON_TYPE: MotionControllerComponentType;
  127207. /**
  127208. * squeeze component type
  127209. */
  127210. static SQUEEZE_TYPE: MotionControllerComponentType;
  127211. /**
  127212. * Thumbstick component type
  127213. */
  127214. static THUMBSTICK_TYPE: MotionControllerComponentType;
  127215. /**
  127216. * Touchpad component type
  127217. */
  127218. static TOUCHPAD_TYPE: MotionControllerComponentType;
  127219. /**
  127220. * trigger component type
  127221. */
  127222. static TRIGGER_TYPE: MotionControllerComponentType;
  127223. /**
  127224. * If axes are available for this component (like a touchpad or thumbstick) the observers will be notified when
  127225. * the axes data changes
  127226. */
  127227. onAxisValueChangedObservable: Observable<{
  127228. x: number;
  127229. y: number;
  127230. }>;
  127231. /**
  127232. * Observers registered here will be triggered when the state of a button changes
  127233. * State change is either pressed / touched / value
  127234. */
  127235. onButtonStateChangedObservable: Observable<WebXRControllerComponent>;
  127236. /**
  127237. * Creates a new component for a motion controller.
  127238. * It is created by the motion controller itself
  127239. *
  127240. * @param id the id of this component
  127241. * @param type the type of the component
  127242. * @param _buttonIndex index in the buttons array of the gamepad
  127243. * @param _axesIndices indices of the values in the axes array of the gamepad
  127244. */
  127245. constructor(
  127246. /**
  127247. * the id of this component
  127248. */
  127249. id: string,
  127250. /**
  127251. * the type of the component
  127252. */
  127253. type: MotionControllerComponentType, _buttonIndex?: number, _axesIndices?: number[]);
  127254. /**
  127255. * The current axes data. If this component has no axes it will still return an object { x: 0, y: 0 }
  127256. */
  127257. get axes(): IWebXRMotionControllerAxesValue;
  127258. /**
  127259. * Get the changes. Elements will be populated only if they changed with their previous and current value
  127260. */
  127261. get changes(): IWebXRMotionControllerComponentChanges;
  127262. /**
  127263. * Return whether or not the component changed the last frame
  127264. */
  127265. get hasChanges(): boolean;
  127266. /**
  127267. * is the button currently pressed
  127268. */
  127269. get pressed(): boolean;
  127270. /**
  127271. * is the button currently touched
  127272. */
  127273. get touched(): boolean;
  127274. /**
  127275. * Get the current value of this component
  127276. */
  127277. get value(): number;
  127278. /**
  127279. * Dispose this component
  127280. */
  127281. dispose(): void;
  127282. /**
  127283. * Are there axes correlating to this component
  127284. * @return true is axes data is available
  127285. */
  127286. isAxes(): boolean;
  127287. /**
  127288. * Is this component a button (hence - pressable)
  127289. * @returns true if can be pressed
  127290. */
  127291. isButton(): boolean;
  127292. /**
  127293. * update this component using the gamepad object it is in. Called on every frame
  127294. * @param nativeController the native gamepad controller object
  127295. */
  127296. update(nativeController: IMinimalMotionControllerObject): void;
  127297. }
  127298. }
  127299. declare module BABYLON {
  127300. /**
  127301. * Interface used to represent data loading progression
  127302. */
  127303. export interface ISceneLoaderProgressEvent {
  127304. /**
  127305. * Defines if data length to load can be evaluated
  127306. */
  127307. readonly lengthComputable: boolean;
  127308. /**
  127309. * Defines the loaded data length
  127310. */
  127311. readonly loaded: number;
  127312. /**
  127313. * Defines the data length to load
  127314. */
  127315. readonly total: number;
  127316. }
  127317. /**
  127318. * Interface used by SceneLoader plugins to define supported file extensions
  127319. */
  127320. export interface ISceneLoaderPluginExtensions {
  127321. /**
  127322. * Defines the list of supported extensions
  127323. */
  127324. [extension: string]: {
  127325. isBinary: boolean;
  127326. };
  127327. }
  127328. /**
  127329. * Interface used by SceneLoader plugin factory
  127330. */
  127331. export interface ISceneLoaderPluginFactory {
  127332. /**
  127333. * Defines the name of the factory
  127334. */
  127335. name: string;
  127336. /**
  127337. * Function called to create a new plugin
  127338. * @return the new plugin
  127339. */
  127340. createPlugin(): ISceneLoaderPlugin | ISceneLoaderPluginAsync;
  127341. /**
  127342. * The callback that returns true if the data can be directly loaded.
  127343. * @param data string containing the file data
  127344. * @returns if the data can be loaded directly
  127345. */
  127346. canDirectLoad?(data: string): boolean;
  127347. }
  127348. /**
  127349. * Interface used to define the base of ISceneLoaderPlugin and ISceneLoaderPluginAsync
  127350. */
  127351. export interface ISceneLoaderPluginBase {
  127352. /**
  127353. * The friendly name of this plugin.
  127354. */
  127355. name: string;
  127356. /**
  127357. * The file extensions supported by this plugin.
  127358. */
  127359. extensions: string | ISceneLoaderPluginExtensions;
  127360. /**
  127361. * The callback called when loading from a url.
  127362. * @param scene scene loading this url
  127363. * @param url url to load
  127364. * @param onSuccess callback called when the file successfully loads
  127365. * @param onProgress callback called while file is loading (if the server supports this mode)
  127366. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  127367. * @param onError callback called when the file fails to load
  127368. * @returns a file request object
  127369. */
  127370. requestFile?(scene: Scene, url: string, onSuccess: (data: any, request?: WebRequest) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => void, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  127371. /**
  127372. * The callback called when loading from a file object.
  127373. * @param scene scene loading this file
  127374. * @param file defines the file to load
  127375. * @param onSuccess defines the callback to call when data is loaded
  127376. * @param onProgress defines the callback to call during loading process
  127377. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  127378. * @param onError defines the callback to call when an error occurs
  127379. * @returns a file request object
  127380. */
  127381. readFile?(scene: Scene, file: File, onSuccess: (data: any) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  127382. /**
  127383. * The callback that returns true if the data can be directly loaded.
  127384. * @param data string containing the file data
  127385. * @returns if the data can be loaded directly
  127386. */
  127387. canDirectLoad?(data: string): boolean;
  127388. /**
  127389. * The callback that returns the data to pass to the plugin if the data can be directly loaded.
  127390. * @param scene scene loading this data
  127391. * @param data string containing the data
  127392. * @returns data to pass to the plugin
  127393. */
  127394. directLoad?(scene: Scene, data: string): any;
  127395. /**
  127396. * The callback that allows custom handling of the root url based on the response url.
  127397. * @param rootUrl the original root url
  127398. * @param responseURL the response url if available
  127399. * @returns the new root url
  127400. */
  127401. rewriteRootURL?(rootUrl: string, responseURL?: string): string;
  127402. }
  127403. /**
  127404. * Interface used to define a SceneLoader plugin
  127405. */
  127406. export interface ISceneLoaderPlugin extends ISceneLoaderPluginBase {
  127407. /**
  127408. * Import meshes into a scene.
  127409. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  127410. * @param scene The scene to import into
  127411. * @param data The data to import
  127412. * @param rootUrl The root url for scene and resources
  127413. * @param meshes The meshes array to import into
  127414. * @param particleSystems The particle systems array to import into
  127415. * @param skeletons The skeletons array to import into
  127416. * @param onError The callback when import fails
  127417. * @returns True if successful or false otherwise
  127418. */
  127419. importMesh(meshesNames: any, scene: Scene, data: any, rootUrl: string, meshes: AbstractMesh[], particleSystems: IParticleSystem[], skeletons: Skeleton[], onError?: (message: string, exception?: any) => void): boolean;
  127420. /**
  127421. * Load into a scene.
  127422. * @param scene The scene to load into
  127423. * @param data The data to import
  127424. * @param rootUrl The root url for scene and resources
  127425. * @param onError The callback when import fails
  127426. * @returns True if successful or false otherwise
  127427. */
  127428. load(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): boolean;
  127429. /**
  127430. * Load into an asset container.
  127431. * @param scene The scene to load into
  127432. * @param data The data to import
  127433. * @param rootUrl The root url for scene and resources
  127434. * @param onError The callback when import fails
  127435. * @returns The loaded asset container
  127436. */
  127437. loadAssetContainer(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): AssetContainer;
  127438. }
  127439. /**
  127440. * Interface used to define an async SceneLoader plugin
  127441. */
  127442. export interface ISceneLoaderPluginAsync extends ISceneLoaderPluginBase {
  127443. /**
  127444. * Import meshes into a scene.
  127445. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  127446. * @param scene The scene to import into
  127447. * @param data The data to import
  127448. * @param rootUrl The root url for scene and resources
  127449. * @param onProgress The callback when the load progresses
  127450. * @param fileName Defines the name of the file to load
  127451. * @returns The loaded meshes, particle systems, skeletons, and animation groups
  127452. */
  127453. importMeshAsync(meshesNames: any, scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<{
  127454. meshes: AbstractMesh[];
  127455. particleSystems: IParticleSystem[];
  127456. skeletons: Skeleton[];
  127457. animationGroups: AnimationGroup[];
  127458. }>;
  127459. /**
  127460. * Load into a scene.
  127461. * @param scene The scene to load into
  127462. * @param data The data to import
  127463. * @param rootUrl The root url for scene and resources
  127464. * @param onProgress The callback when the load progresses
  127465. * @param fileName Defines the name of the file to load
  127466. * @returns Nothing
  127467. */
  127468. loadAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<void>;
  127469. /**
  127470. * Load into an asset container.
  127471. * @param scene The scene to load into
  127472. * @param data The data to import
  127473. * @param rootUrl The root url for scene and resources
  127474. * @param onProgress The callback when the load progresses
  127475. * @param fileName Defines the name of the file to load
  127476. * @returns The loaded asset container
  127477. */
  127478. loadAssetContainerAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<AssetContainer>;
  127479. }
  127480. /**
  127481. * Mode that determines how to handle old animation groups before loading new ones.
  127482. */
  127483. export enum SceneLoaderAnimationGroupLoadingMode {
  127484. /**
  127485. * Reset all old animations to initial state then dispose them.
  127486. */
  127487. Clean = 0,
  127488. /**
  127489. * Stop all old animations.
  127490. */
  127491. Stop = 1,
  127492. /**
  127493. * Restart old animations from first frame.
  127494. */
  127495. Sync = 2,
  127496. /**
  127497. * Old animations remains untouched.
  127498. */
  127499. NoSync = 3
  127500. }
  127501. /**
  127502. * Defines a plugin registered by the SceneLoader
  127503. */
  127504. interface IRegisteredPlugin {
  127505. /**
  127506. * Defines the plugin to use
  127507. */
  127508. plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  127509. /**
  127510. * Defines if the plugin supports binary data
  127511. */
  127512. isBinary: boolean;
  127513. }
  127514. /**
  127515. * Class used to load scene from various file formats using registered plugins
  127516. * @see https://doc.babylonjs.com/how_to/load_from_any_file_type
  127517. */
  127518. export class SceneLoader {
  127519. /**
  127520. * No logging while loading
  127521. */
  127522. static readonly NO_LOGGING: number;
  127523. /**
  127524. * Minimal logging while loading
  127525. */
  127526. static readonly MINIMAL_LOGGING: number;
  127527. /**
  127528. * Summary logging while loading
  127529. */
  127530. static readonly SUMMARY_LOGGING: number;
  127531. /**
  127532. * Detailled logging while loading
  127533. */
  127534. static readonly DETAILED_LOGGING: number;
  127535. /**
  127536. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  127537. */
  127538. static get ForceFullSceneLoadingForIncremental(): boolean;
  127539. static set ForceFullSceneLoadingForIncremental(value: boolean);
  127540. /**
  127541. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  127542. */
  127543. static get ShowLoadingScreen(): boolean;
  127544. static set ShowLoadingScreen(value: boolean);
  127545. /**
  127546. * Defines the current logging level (while loading the scene)
  127547. * @ignorenaming
  127548. */
  127549. static get loggingLevel(): number;
  127550. static set loggingLevel(value: number);
  127551. /**
  127552. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  127553. */
  127554. static get CleanBoneMatrixWeights(): boolean;
  127555. static set CleanBoneMatrixWeights(value: boolean);
  127556. /**
  127557. * Event raised when a plugin is used to load a scene
  127558. */
  127559. static OnPluginActivatedObservable: Observable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  127560. private static _registeredPlugins;
  127561. private static _showingLoadingScreen;
  127562. /**
  127563. * Gets the default plugin (used to load Babylon files)
  127564. * @returns the .babylon plugin
  127565. */
  127566. static GetDefaultPlugin(): IRegisteredPlugin;
  127567. private static _GetPluginForExtension;
  127568. private static _GetPluginForDirectLoad;
  127569. private static _GetPluginForFilename;
  127570. private static _GetDirectLoad;
  127571. private static _LoadData;
  127572. private static _GetFileInfo;
  127573. /**
  127574. * Gets a plugin that can load the given extension
  127575. * @param extension defines the extension to load
  127576. * @returns a plugin or null if none works
  127577. */
  127578. static GetPluginForExtension(extension: string): ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  127579. /**
  127580. * Gets a boolean indicating that the given extension can be loaded
  127581. * @param extension defines the extension to load
  127582. * @returns true if the extension is supported
  127583. */
  127584. static IsPluginForExtensionAvailable(extension: string): boolean;
  127585. /**
  127586. * Adds a new plugin to the list of registered plugins
  127587. * @param plugin defines the plugin to add
  127588. */
  127589. static RegisterPlugin(plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync): void;
  127590. /**
  127591. * Import meshes into a scene
  127592. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  127593. * @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)
  127594. * @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)
  127595. * @param scene the instance of BABYLON.Scene to append to
  127596. * @param onSuccess a callback with a list of imported meshes, particleSystems, and skeletons when import succeeds
  127597. * @param onProgress a callback with a progress event for each file being loaded
  127598. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127599. * @param pluginExtension the extension used to determine the plugin
  127600. * @returns The loaded plugin
  127601. */
  127602. 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>;
  127603. /**
  127604. * Import meshes into a scene
  127605. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  127606. * @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)
  127607. * @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)
  127608. * @param scene the instance of BABYLON.Scene to append to
  127609. * @param onProgress a callback with a progress event for each file being loaded
  127610. * @param pluginExtension the extension used to determine the plugin
  127611. * @returns The loaded list of imported meshes, particle systems, skeletons, and animation groups
  127612. */
  127613. static ImportMeshAsync(meshNames: any, rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<{
  127614. meshes: AbstractMesh[];
  127615. particleSystems: IParticleSystem[];
  127616. skeletons: Skeleton[];
  127617. animationGroups: AnimationGroup[];
  127618. }>;
  127619. /**
  127620. * Load a scene
  127621. * @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)
  127622. * @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)
  127623. * @param engine is the instance of BABYLON.Engine to use to create the scene
  127624. * @param onSuccess a callback with the scene when import succeeds
  127625. * @param onProgress a callback with a progress event for each file being loaded
  127626. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127627. * @param pluginExtension the extension used to determine the plugin
  127628. * @returns The loaded plugin
  127629. */
  127630. 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>;
  127631. /**
  127632. * Load a scene
  127633. * @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)
  127634. * @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)
  127635. * @param engine is the instance of BABYLON.Engine to use to create the scene
  127636. * @param onProgress a callback with a progress event for each file being loaded
  127637. * @param pluginExtension the extension used to determine the plugin
  127638. * @returns The loaded scene
  127639. */
  127640. static LoadAsync(rootUrl: string, sceneFilename?: string | File, engine?: Nullable<Engine>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  127641. /**
  127642. * Append a scene
  127643. * @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)
  127644. * @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)
  127645. * @param scene is the instance of BABYLON.Scene to append to
  127646. * @param onSuccess a callback with the scene when import succeeds
  127647. * @param onProgress a callback with a progress event for each file being loaded
  127648. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127649. * @param pluginExtension the extension used to determine the plugin
  127650. * @returns The loaded plugin
  127651. */
  127652. 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>;
  127653. /**
  127654. * Append a scene
  127655. * @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)
  127656. * @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)
  127657. * @param scene is the instance of BABYLON.Scene to append to
  127658. * @param onProgress a callback with a progress event for each file being loaded
  127659. * @param pluginExtension the extension used to determine the plugin
  127660. * @returns The given scene
  127661. */
  127662. static AppendAsync(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  127663. /**
  127664. * Load a scene into an asset container
  127665. * @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)
  127666. * @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)
  127667. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  127668. * @param onSuccess a callback with the scene when import succeeds
  127669. * @param onProgress a callback with a progress event for each file being loaded
  127670. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127671. * @param pluginExtension the extension used to determine the plugin
  127672. * @returns The loaded plugin
  127673. */
  127674. 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>;
  127675. /**
  127676. * Load a scene into an asset container
  127677. * @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)
  127678. * @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)
  127679. * @param scene is the instance of Scene to append to
  127680. * @param onProgress a callback with a progress event for each file being loaded
  127681. * @param pluginExtension the extension used to determine the plugin
  127682. * @returns The loaded asset container
  127683. */
  127684. static LoadAssetContainerAsync(rootUrl: string, sceneFilename?: string, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<AssetContainer>;
  127685. /**
  127686. * Import animations from a file into a scene
  127687. * @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)
  127688. * @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)
  127689. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  127690. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  127691. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  127692. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  127693. * @param onSuccess a callback with the scene when import succeeds
  127694. * @param onProgress a callback with a progress event for each file being loaded
  127695. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127696. * @param pluginExtension the extension used to determine the plugin
  127697. */
  127698. 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;
  127699. /**
  127700. * Import animations from a file into a scene
  127701. * @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)
  127702. * @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)
  127703. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  127704. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  127705. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  127706. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  127707. * @param onSuccess a callback with the scene when import succeeds
  127708. * @param onProgress a callback with a progress event for each file being loaded
  127709. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127710. * @param pluginExtension the extension used to determine the plugin
  127711. * @returns the updated scene with imported animations
  127712. */
  127713. 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>;
  127714. }
  127715. }
  127716. declare module BABYLON {
  127717. /**
  127718. * Handedness type in xrInput profiles. These can be used to define layouts in the Layout Map.
  127719. */
  127720. export type MotionControllerHandedness = "none" | "left" | "right";
  127721. /**
  127722. * The type of components available in motion controllers.
  127723. * This is not the name of the component.
  127724. */
  127725. export type MotionControllerComponentType = "trigger" | "squeeze" | "touchpad" | "thumbstick" | "button";
  127726. /**
  127727. * The state of a controller component
  127728. */
  127729. export type MotionControllerComponentStateType = "default" | "touched" | "pressed";
  127730. /**
  127731. * The schema of motion controller layout.
  127732. * No object will be initialized using this interface
  127733. * This is used just to define the profile.
  127734. */
  127735. export interface IMotionControllerLayout {
  127736. /**
  127737. * Path to load the assets. Usually relative to the base path
  127738. */
  127739. assetPath: string;
  127740. /**
  127741. * Available components (unsorted)
  127742. */
  127743. components: {
  127744. /**
  127745. * A map of component Ids
  127746. */
  127747. [componentId: string]: {
  127748. /**
  127749. * The type of input the component outputs
  127750. */
  127751. type: MotionControllerComponentType;
  127752. /**
  127753. * The indices of this component in the gamepad object
  127754. */
  127755. gamepadIndices: {
  127756. /**
  127757. * Index of button
  127758. */
  127759. button?: number;
  127760. /**
  127761. * If available, index of x-axis
  127762. */
  127763. xAxis?: number;
  127764. /**
  127765. * If available, index of y-axis
  127766. */
  127767. yAxis?: number;
  127768. };
  127769. /**
  127770. * The mesh's root node name
  127771. */
  127772. rootNodeName: string;
  127773. /**
  127774. * Animation definitions for this model
  127775. */
  127776. visualResponses: {
  127777. [stateKey: string]: {
  127778. /**
  127779. * What property will be animated
  127780. */
  127781. componentProperty: "xAxis" | "yAxis" | "button" | "state";
  127782. /**
  127783. * What states influence this visual response
  127784. */
  127785. states: MotionControllerComponentStateType[];
  127786. /**
  127787. * Type of animation - movement or visibility
  127788. */
  127789. valueNodeProperty: "transform" | "visibility";
  127790. /**
  127791. * Base node name to move. Its position will be calculated according to the min and max nodes
  127792. */
  127793. valueNodeName?: string;
  127794. /**
  127795. * Minimum movement node
  127796. */
  127797. minNodeName?: string;
  127798. /**
  127799. * Max movement node
  127800. */
  127801. maxNodeName?: string;
  127802. };
  127803. };
  127804. /**
  127805. * If touch enabled, what is the name of node to display user feedback
  127806. */
  127807. touchPointNodeName?: string;
  127808. };
  127809. };
  127810. /**
  127811. * Is it xr standard mapping or not
  127812. */
  127813. gamepadMapping: "" | "xr-standard";
  127814. /**
  127815. * Base root node of this entire model
  127816. */
  127817. rootNodeName: string;
  127818. /**
  127819. * Defines the main button component id
  127820. */
  127821. selectComponentId: string;
  127822. }
  127823. /**
  127824. * A definition for the layout map in the input profile
  127825. */
  127826. export interface IMotionControllerLayoutMap {
  127827. /**
  127828. * Layouts with handedness type as a key
  127829. */
  127830. [handedness: string]: IMotionControllerLayout;
  127831. }
  127832. /**
  127833. * The XR Input profile schema
  127834. * Profiles can be found here:
  127835. * https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/registry/profiles
  127836. */
  127837. export interface IMotionControllerProfile {
  127838. /**
  127839. * fallback profiles for this profileId
  127840. */
  127841. fallbackProfileIds: string[];
  127842. /**
  127843. * The layout map, with handedness as key
  127844. */
  127845. layouts: IMotionControllerLayoutMap;
  127846. /**
  127847. * The id of this profile
  127848. * correlates to the profile(s) in the xrInput.profiles array
  127849. */
  127850. profileId: string;
  127851. }
  127852. /**
  127853. * A helper-interface for the 3 meshes needed for controller button animation
  127854. * The meshes are provided to the _lerpButtonTransform function to calculate the current position of the value mesh
  127855. */
  127856. export interface IMotionControllerButtonMeshMap {
  127857. /**
  127858. * the mesh that defines the pressed value mesh position.
  127859. * This is used to find the max-position of this button
  127860. */
  127861. pressedMesh: AbstractMesh;
  127862. /**
  127863. * the mesh that defines the unpressed value mesh position.
  127864. * This is used to find the min (or initial) position of this button
  127865. */
  127866. unpressedMesh: AbstractMesh;
  127867. /**
  127868. * The mesh that will be changed when value changes
  127869. */
  127870. valueMesh: AbstractMesh;
  127871. }
  127872. /**
  127873. * A helper-interface for the 3 meshes needed for controller axis animation.
  127874. * This will be expanded when touchpad animations are fully supported
  127875. * The meshes are provided to the _lerpAxisTransform function to calculate the current position of the value mesh
  127876. */
  127877. export interface IMotionControllerMeshMap {
  127878. /**
  127879. * the mesh that defines the maximum value mesh position.
  127880. */
  127881. maxMesh?: AbstractMesh;
  127882. /**
  127883. * the mesh that defines the minimum value mesh position.
  127884. */
  127885. minMesh?: AbstractMesh;
  127886. /**
  127887. * The mesh that will be changed when axis value changes
  127888. */
  127889. valueMesh?: AbstractMesh;
  127890. }
  127891. /**
  127892. * The elements needed for change-detection of the gamepad objects in motion controllers
  127893. */
  127894. export interface IMinimalMotionControllerObject {
  127895. /**
  127896. * Available axes of this controller
  127897. */
  127898. axes: number[];
  127899. /**
  127900. * An array of available buttons
  127901. */
  127902. buttons: Array<{
  127903. /**
  127904. * Value of the button/trigger
  127905. */
  127906. value: number;
  127907. /**
  127908. * If the button/trigger is currently touched
  127909. */
  127910. touched: boolean;
  127911. /**
  127912. * If the button/trigger is currently pressed
  127913. */
  127914. pressed: boolean;
  127915. }>;
  127916. /**
  127917. * EXPERIMENTAL haptic support.
  127918. */
  127919. hapticActuators?: Array<{
  127920. pulse: (value: number, duration: number) => Promise<boolean>;
  127921. }>;
  127922. }
  127923. /**
  127924. * An Abstract Motion controller
  127925. * This class receives an xrInput and a profile layout and uses those to initialize the components
  127926. * Each component has an observable to check for changes in value and state
  127927. */
  127928. export abstract class WebXRAbstractMotionController implements IDisposable {
  127929. protected scene: Scene;
  127930. protected layout: IMotionControllerLayout;
  127931. /**
  127932. * The gamepad object correlating to this controller
  127933. */
  127934. gamepadObject: IMinimalMotionControllerObject;
  127935. /**
  127936. * handedness (left/right/none) of this controller
  127937. */
  127938. handedness: MotionControllerHandedness;
  127939. private _initComponent;
  127940. private _modelReady;
  127941. /**
  127942. * A map of components (WebXRControllerComponent) in this motion controller
  127943. * Components have a ComponentType and can also have both button and axis definitions
  127944. */
  127945. readonly components: {
  127946. [id: string]: WebXRControllerComponent;
  127947. };
  127948. /**
  127949. * Disable the model's animation. Can be set at any time.
  127950. */
  127951. disableAnimation: boolean;
  127952. /**
  127953. * Observers registered here will be triggered when the model of this controller is done loading
  127954. */
  127955. onModelLoadedObservable: Observable<WebXRAbstractMotionController>;
  127956. /**
  127957. * The profile id of this motion controller
  127958. */
  127959. abstract profileId: string;
  127960. /**
  127961. * The root mesh of the model. It is null if the model was not yet initialized
  127962. */
  127963. rootMesh: Nullable<AbstractMesh>;
  127964. /**
  127965. * constructs a new abstract motion controller
  127966. * @param scene the scene to which the model of the controller will be added
  127967. * @param layout The profile layout to load
  127968. * @param gamepadObject The gamepad object correlating to this controller
  127969. * @param handedness handedness (left/right/none) of this controller
  127970. * @param _doNotLoadControllerMesh set this flag to ignore the mesh loading
  127971. */
  127972. constructor(scene: Scene, layout: IMotionControllerLayout,
  127973. /**
  127974. * The gamepad object correlating to this controller
  127975. */
  127976. gamepadObject: IMinimalMotionControllerObject,
  127977. /**
  127978. * handedness (left/right/none) of this controller
  127979. */
  127980. handedness: MotionControllerHandedness, _doNotLoadControllerMesh?: boolean);
  127981. /**
  127982. * Dispose this controller, the model mesh and all its components
  127983. */
  127984. dispose(): void;
  127985. /**
  127986. * Returns all components of specific type
  127987. * @param type the type to search for
  127988. * @return an array of components with this type
  127989. */
  127990. getAllComponentsOfType(type: MotionControllerComponentType): WebXRControllerComponent[];
  127991. /**
  127992. * get a component based an its component id as defined in layout.components
  127993. * @param id the id of the component
  127994. * @returns the component correlates to the id or undefined if not found
  127995. */
  127996. getComponent(id: string): WebXRControllerComponent;
  127997. /**
  127998. * Get the list of components available in this motion controller
  127999. * @returns an array of strings correlating to available components
  128000. */
  128001. getComponentIds(): string[];
  128002. /**
  128003. * Get the first component of specific type
  128004. * @param type type of component to find
  128005. * @return a controller component or null if not found
  128006. */
  128007. getComponentOfType(type: MotionControllerComponentType): Nullable<WebXRControllerComponent>;
  128008. /**
  128009. * Get the main (Select) component of this controller as defined in the layout
  128010. * @returns the main component of this controller
  128011. */
  128012. getMainComponent(): WebXRControllerComponent;
  128013. /**
  128014. * Loads the model correlating to this controller
  128015. * When the mesh is loaded, the onModelLoadedObservable will be triggered
  128016. * @returns A promise fulfilled with the result of the model loading
  128017. */
  128018. loadModel(): Promise<boolean>;
  128019. /**
  128020. * Update this model using the current XRFrame
  128021. * @param xrFrame the current xr frame to use and update the model
  128022. */
  128023. updateFromXRFrame(xrFrame: XRFrame): void;
  128024. /**
  128025. * Backwards compatibility due to a deeply-integrated typo
  128026. */
  128027. get handness(): XREye;
  128028. /**
  128029. * Pulse (vibrate) this controller
  128030. * If the controller does not support pulses, this function will fail silently and return Promise<false> directly after called
  128031. * Consecutive calls to this function will cancel the last pulse call
  128032. *
  128033. * @param value the strength of the pulse in 0.0...1.0 range
  128034. * @param duration Duration of the pulse in milliseconds
  128035. * @param hapticActuatorIndex optional index of actuator (will usually be 0)
  128036. * @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
  128037. */
  128038. pulse(value: number, duration: number, hapticActuatorIndex?: number): Promise<boolean>;
  128039. protected _getChildByName(node: AbstractMesh, name: string): AbstractMesh | undefined;
  128040. protected _getImmediateChildByName(node: AbstractMesh, name: string): AbstractMesh | undefined;
  128041. /**
  128042. * Moves the axis on the controller mesh based on its current state
  128043. * @param axis the index of the axis
  128044. * @param axisValue the value of the axis which determines the meshes new position
  128045. * @hidden
  128046. */
  128047. protected _lerpTransform(axisMap: IMotionControllerMeshMap, axisValue: number, fixValueCoordinates?: boolean): void;
  128048. /**
  128049. * Update the model itself with the current frame data
  128050. * @param xrFrame the frame to use for updating the model mesh
  128051. */
  128052. protected updateModel(xrFrame: XRFrame): void;
  128053. /**
  128054. * Get the filename and path for this controller's model
  128055. * @returns a map of filename and path
  128056. */
  128057. protected abstract _getFilenameAndPath(): {
  128058. filename: string;
  128059. path: string;
  128060. };
  128061. /**
  128062. * This function is called before the mesh is loaded. It checks for loading constraints.
  128063. * For example, this function can check if the GLB loader is available
  128064. * If this function returns false, the generic controller will be loaded instead
  128065. * @returns Is the client ready to load the mesh
  128066. */
  128067. protected abstract _getModelLoadingConstraints(): boolean;
  128068. /**
  128069. * This function will be called after the model was successfully loaded and can be used
  128070. * for mesh transformations before it is available for the user
  128071. * @param meshes the loaded meshes
  128072. */
  128073. protected abstract _processLoadedModel(meshes: AbstractMesh[]): void;
  128074. /**
  128075. * Set the root mesh for this controller. Important for the WebXR controller class
  128076. * @param meshes the loaded meshes
  128077. */
  128078. protected abstract _setRootMesh(meshes: AbstractMesh[]): void;
  128079. /**
  128080. * A function executed each frame that updates the mesh (if needed)
  128081. * @param xrFrame the current xrFrame
  128082. */
  128083. protected abstract _updateModel(xrFrame: XRFrame): void;
  128084. private _getGenericFilenameAndPath;
  128085. private _getGenericParentMesh;
  128086. }
  128087. }
  128088. declare module BABYLON {
  128089. /**
  128090. * A generic trigger-only motion controller for WebXR
  128091. */
  128092. export class WebXRGenericTriggerMotionController extends WebXRAbstractMotionController {
  128093. /**
  128094. * Static version of the profile id of this controller
  128095. */
  128096. static ProfileId: string;
  128097. profileId: string;
  128098. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  128099. protected _getFilenameAndPath(): {
  128100. filename: string;
  128101. path: string;
  128102. };
  128103. protected _getModelLoadingConstraints(): boolean;
  128104. protected _processLoadedModel(meshes: AbstractMesh[]): void;
  128105. protected _setRootMesh(meshes: AbstractMesh[]): void;
  128106. protected _updateModel(): void;
  128107. }
  128108. }
  128109. declare module BABYLON {
  128110. /**
  128111. * Class containing static functions to help procedurally build meshes
  128112. */
  128113. export class SphereBuilder {
  128114. /**
  128115. * Creates a sphere mesh
  128116. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  128117. * * 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`)
  128118. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  128119. * * 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
  128120. * * 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)
  128121. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  128122. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  128123. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  128124. * @param name defines the name of the mesh
  128125. * @param options defines the options used to create the mesh
  128126. * @param scene defines the hosting scene
  128127. * @returns the sphere mesh
  128128. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  128129. */
  128130. static CreateSphere(name: string, options: {
  128131. segments?: number;
  128132. diameter?: number;
  128133. diameterX?: number;
  128134. diameterY?: number;
  128135. diameterZ?: number;
  128136. arc?: number;
  128137. slice?: number;
  128138. sideOrientation?: number;
  128139. frontUVs?: Vector4;
  128140. backUVs?: Vector4;
  128141. updatable?: boolean;
  128142. }, scene?: Nullable<Scene>): Mesh;
  128143. }
  128144. }
  128145. declare module BABYLON {
  128146. /**
  128147. * A profiled motion controller has its profile loaded from an online repository.
  128148. * The class is responsible of loading the model, mapping the keys and enabling model-animations
  128149. */
  128150. export class WebXRProfiledMotionController extends WebXRAbstractMotionController {
  128151. private _repositoryUrl;
  128152. private _buttonMeshMapping;
  128153. private _touchDots;
  128154. /**
  128155. * The profile ID of this controller. Will be populated when the controller initializes.
  128156. */
  128157. profileId: string;
  128158. constructor(scene: Scene, xrInput: XRInputSource, _profile: IMotionControllerProfile, _repositoryUrl: string);
  128159. dispose(): void;
  128160. protected _getFilenameAndPath(): {
  128161. filename: string;
  128162. path: string;
  128163. };
  128164. protected _getModelLoadingConstraints(): boolean;
  128165. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  128166. protected _setRootMesh(meshes: AbstractMesh[]): void;
  128167. protected _updateModel(_xrFrame: XRFrame): void;
  128168. }
  128169. }
  128170. declare module BABYLON {
  128171. /**
  128172. * A construction function type to create a new controller based on an xrInput object
  128173. */
  128174. export type MotionControllerConstructor = (xrInput: XRInputSource, scene: Scene) => WebXRAbstractMotionController;
  128175. /**
  128176. * The MotionController Manager manages all registered motion controllers and loads the right one when needed.
  128177. *
  128178. * When this repository is complete: https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/assets
  128179. * it should be replaced with auto-loaded controllers.
  128180. *
  128181. * When using a model try to stay as generic as possible. Eventually there will be no need in any of the controller classes
  128182. */
  128183. export class WebXRMotionControllerManager {
  128184. private static _AvailableControllers;
  128185. private static _Fallbacks;
  128186. private static _ProfileLoadingPromises;
  128187. private static _ProfilesList;
  128188. /**
  128189. * The base URL of the online controller repository. Can be changed at any time.
  128190. */
  128191. static BaseRepositoryUrl: string;
  128192. /**
  128193. * Which repository gets priority - local or online
  128194. */
  128195. static PrioritizeOnlineRepository: boolean;
  128196. /**
  128197. * Use the online repository, or use only locally-defined controllers
  128198. */
  128199. static UseOnlineRepository: boolean;
  128200. /**
  128201. * Clear the cache used for profile loading and reload when requested again
  128202. */
  128203. static ClearProfilesCache(): void;
  128204. /**
  128205. * Register the default fallbacks.
  128206. * This function is called automatically when this file is imported.
  128207. */
  128208. static DefaultFallbacks(): void;
  128209. /**
  128210. * Find a fallback profile if the profile was not found. There are a few predefined generic profiles.
  128211. * @param profileId the profile to which a fallback needs to be found
  128212. * @return an array with corresponding fallback profiles
  128213. */
  128214. static FindFallbackWithProfileId(profileId: string): string[];
  128215. /**
  128216. * When acquiring a new xrInput object (usually by the WebXRInput class), match it with the correct profile.
  128217. * The order of search:
  128218. *
  128219. * 1) Iterate the profiles array of the xr input and try finding a corresponding motion controller
  128220. * 2) (If not found) search in the gamepad id and try using it (legacy versions only)
  128221. * 3) search for registered fallbacks (should be redundant, nonetheless it makes sense to check)
  128222. * 4) return the generic trigger controller if none were found
  128223. *
  128224. * @param xrInput the xrInput to which a new controller is initialized
  128225. * @param scene the scene to which the model will be added
  128226. * @param forceProfile force a certain profile for this controller
  128227. * @return A promise that fulfils with the motion controller class for this profile id or the generic standard class if none was found
  128228. */
  128229. static GetMotionControllerWithXRInput(xrInput: XRInputSource, scene: Scene, forceProfile?: string): Promise<WebXRAbstractMotionController>;
  128230. /**
  128231. * Register a new controller based on its profile. This function will be called by the controller classes themselves.
  128232. *
  128233. * If you are missing a profile, make sure it is imported in your source, otherwise it will not register.
  128234. *
  128235. * @param type the profile type to register
  128236. * @param constructFunction the function to be called when loading this profile
  128237. */
  128238. static RegisterController(type: string, constructFunction: MotionControllerConstructor): void;
  128239. /**
  128240. * Register a fallback to a specific profile.
  128241. * @param profileId the profileId that will receive the fallbacks
  128242. * @param fallbacks A list of fallback profiles
  128243. */
  128244. static RegisterFallbacksForProfileId(profileId: string, fallbacks: string[]): void;
  128245. /**
  128246. * Will update the list of profiles available in the repository
  128247. * @return a promise that resolves to a map of profiles available online
  128248. */
  128249. static UpdateProfilesList(): Promise<{
  128250. [profile: string]: string;
  128251. }>;
  128252. private static _LoadProfileFromRepository;
  128253. private static _LoadProfilesFromAvailableControllers;
  128254. }
  128255. }
  128256. declare module BABYLON {
  128257. /**
  128258. * Configuration options for the WebXR controller creation
  128259. */
  128260. export interface IWebXRControllerOptions {
  128261. /**
  128262. * Should the controller mesh be animated when a user interacts with it
  128263. * The pressed buttons / thumbstick and touchpad animations will be disabled
  128264. */
  128265. disableMotionControllerAnimation?: boolean;
  128266. /**
  128267. * Do not load the controller mesh, in case a different mesh needs to be loaded.
  128268. */
  128269. doNotLoadControllerMesh?: boolean;
  128270. /**
  128271. * Force a specific controller type for this controller.
  128272. * This can be used when creating your own profile or when testing different controllers
  128273. */
  128274. forceControllerProfile?: string;
  128275. /**
  128276. * Defines a rendering group ID for meshes that will be loaded.
  128277. * This is for the default controllers only.
  128278. */
  128279. renderingGroupId?: number;
  128280. }
  128281. /**
  128282. * Represents an XR controller
  128283. */
  128284. export class WebXRInputSource {
  128285. private _scene;
  128286. /** The underlying input source for the controller */
  128287. inputSource: XRInputSource;
  128288. private _options;
  128289. private _tmpVector;
  128290. private _uniqueId;
  128291. private _disposed;
  128292. /**
  128293. * 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
  128294. */
  128295. grip?: AbstractMesh;
  128296. /**
  128297. * If available, this is the gamepad object related to this controller.
  128298. * Using this object it is possible to get click events and trackpad changes of the
  128299. * webxr controller that is currently being used.
  128300. */
  128301. motionController?: WebXRAbstractMotionController;
  128302. /**
  128303. * Event that fires when the controller is removed/disposed.
  128304. * The object provided as event data is this controller, after associated assets were disposed.
  128305. * uniqueId is still available.
  128306. */
  128307. onDisposeObservable: Observable<WebXRInputSource>;
  128308. /**
  128309. * Will be triggered when the mesh associated with the motion controller is done loading.
  128310. * It is also possible that this will never trigger (!) if no mesh was loaded, or if the developer decides to load a different mesh
  128311. * A shortened version of controller -> motion controller -> on mesh loaded.
  128312. */
  128313. onMeshLoadedObservable: Observable<AbstractMesh>;
  128314. /**
  128315. * Observers registered here will trigger when a motion controller profile was assigned to this xr controller
  128316. */
  128317. onMotionControllerInitObservable: Observable<WebXRAbstractMotionController>;
  128318. /**
  128319. * Pointer which can be used to select objects or attach a visible laser to
  128320. */
  128321. pointer: AbstractMesh;
  128322. /**
  128323. * Creates the input source object
  128324. * @see https://doc.babylonjs.com/how_to/webxr_controllers_support
  128325. * @param _scene the scene which the controller should be associated to
  128326. * @param inputSource the underlying input source for the controller
  128327. * @param _options options for this controller creation
  128328. */
  128329. constructor(_scene: Scene,
  128330. /** The underlying input source for the controller */
  128331. inputSource: XRInputSource, _options?: IWebXRControllerOptions);
  128332. /**
  128333. * Get this controllers unique id
  128334. */
  128335. get uniqueId(): string;
  128336. /**
  128337. * Disposes of the object
  128338. */
  128339. dispose(): void;
  128340. /**
  128341. * Gets a world space ray coming from the pointer or grip
  128342. * @param result the resulting ray
  128343. * @param gripIfAvailable use the grip mesh instead of the pointer, if available
  128344. */
  128345. getWorldPointerRayToRef(result: Ray, gripIfAvailable?: boolean): void;
  128346. /**
  128347. * Updates the controller pose based on the given XRFrame
  128348. * @param xrFrame xr frame to update the pose with
  128349. * @param referenceSpace reference space to use
  128350. */
  128351. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace): void;
  128352. }
  128353. }
  128354. declare module BABYLON {
  128355. /**
  128356. * The schema for initialization options of the XR Input class
  128357. */
  128358. export interface IWebXRInputOptions {
  128359. /**
  128360. * If set to true no model will be automatically loaded
  128361. */
  128362. doNotLoadControllerMeshes?: boolean;
  128363. /**
  128364. * If set, this profile will be used for all controllers loaded (for example "microsoft-mixed-reality")
  128365. * If not found, the xr input profile data will be used.
  128366. * Profiles are defined here - https://github.com/immersive-web/webxr-input-profiles/
  128367. */
  128368. forceInputProfile?: string;
  128369. /**
  128370. * Do not send a request to the controller repository to load the profile.
  128371. *
  128372. * Instead, use the controllers available in babylon itself.
  128373. */
  128374. disableOnlineControllerRepository?: boolean;
  128375. /**
  128376. * A custom URL for the controllers repository
  128377. */
  128378. customControllersRepositoryURL?: string;
  128379. /**
  128380. * Should the controller model's components not move according to the user input
  128381. */
  128382. disableControllerAnimation?: boolean;
  128383. /**
  128384. * Optional options to pass to the controller. Will be overridden by the Input options where applicable
  128385. */
  128386. controllerOptions?: IWebXRControllerOptions;
  128387. }
  128388. /**
  128389. * XR input used to track XR inputs such as controllers/rays
  128390. */
  128391. export class WebXRInput implements IDisposable {
  128392. /**
  128393. * the xr session manager for this session
  128394. */
  128395. xrSessionManager: WebXRSessionManager;
  128396. /**
  128397. * the WebXR camera for this session. Mainly used for teleportation
  128398. */
  128399. xrCamera: WebXRCamera;
  128400. private readonly options;
  128401. /**
  128402. * XR controllers being tracked
  128403. */
  128404. controllers: Array<WebXRInputSource>;
  128405. private _frameObserver;
  128406. private _sessionEndedObserver;
  128407. private _sessionInitObserver;
  128408. /**
  128409. * Event when a controller has been connected/added
  128410. */
  128411. onControllerAddedObservable: Observable<WebXRInputSource>;
  128412. /**
  128413. * Event when a controller has been removed/disconnected
  128414. */
  128415. onControllerRemovedObservable: Observable<WebXRInputSource>;
  128416. /**
  128417. * Initializes the WebXRInput
  128418. * @param xrSessionManager the xr session manager for this session
  128419. * @param xrCamera the WebXR camera for this session. Mainly used for teleportation
  128420. * @param options = initialization options for this xr input
  128421. */
  128422. constructor(
  128423. /**
  128424. * the xr session manager for this session
  128425. */
  128426. xrSessionManager: WebXRSessionManager,
  128427. /**
  128428. * the WebXR camera for this session. Mainly used for teleportation
  128429. */
  128430. xrCamera: WebXRCamera, options?: IWebXRInputOptions);
  128431. private _onInputSourcesChange;
  128432. private _addAndRemoveControllers;
  128433. /**
  128434. * Disposes of the object
  128435. */
  128436. dispose(): void;
  128437. }
  128438. }
  128439. declare module BABYLON {
  128440. /**
  128441. * This is the base class for all WebXR features.
  128442. * Since most features require almost the same resources and callbacks, this class can be used to simplify the development
  128443. * Note that since the features manager is using the `IWebXRFeature` you are in no way obligated to use this class
  128444. */
  128445. export abstract class WebXRAbstractFeature implements IWebXRFeature {
  128446. protected _xrSessionManager: WebXRSessionManager;
  128447. private _attached;
  128448. private _removeOnDetach;
  128449. /**
  128450. * Should auto-attach be disabled?
  128451. */
  128452. disableAutoAttach: boolean;
  128453. /**
  128454. * The name of the native xr feature name (like anchor, hit-test, or hand-tracking)
  128455. */
  128456. xrNativeFeatureName: string;
  128457. /**
  128458. * Construct a new (abstract) WebXR feature
  128459. * @param _xrSessionManager the xr session manager for this feature
  128460. */
  128461. constructor(_xrSessionManager: WebXRSessionManager);
  128462. /**
  128463. * Is this feature attached
  128464. */
  128465. get attached(): boolean;
  128466. /**
  128467. * attach this feature
  128468. *
  128469. * @param force should attachment be forced (even when already attached)
  128470. * @returns true if successful, false is failed or already attached
  128471. */
  128472. attach(force?: boolean): boolean;
  128473. /**
  128474. * detach this feature.
  128475. *
  128476. * @returns true if successful, false if failed or already detached
  128477. */
  128478. detach(): boolean;
  128479. /**
  128480. * Dispose this feature and all of the resources attached
  128481. */
  128482. dispose(): void;
  128483. /**
  128484. * This function will be executed during before enabling the feature and can be used to not-allow enabling it.
  128485. * Note that at this point the session has NOT started, so this is purely checking if the browser supports it
  128486. *
  128487. * @returns whether or not the feature is compatible in this environment
  128488. */
  128489. isCompatible(): boolean;
  128490. /**
  128491. * This is used to register callbacks that will automatically be removed when detach is called.
  128492. * @param observable the observable to which the observer will be attached
  128493. * @param callback the callback to register
  128494. */
  128495. protected _addNewAttachObserver<T>(observable: Observable<T>, callback: (eventData: T, eventState: EventState) => void): void;
  128496. /**
  128497. * Code in this function will be executed on each xrFrame received from the browser.
  128498. * This function will not execute after the feature is detached.
  128499. * @param _xrFrame the current frame
  128500. */
  128501. protected abstract _onXRFrame(_xrFrame: XRFrame): void;
  128502. }
  128503. }
  128504. declare module BABYLON {
  128505. /**
  128506. * Renders a layer on top of an existing scene
  128507. */
  128508. export class UtilityLayerRenderer implements IDisposable {
  128509. /** the original scene that will be rendered on top of */
  128510. originalScene: Scene;
  128511. private _pointerCaptures;
  128512. private _lastPointerEvents;
  128513. private static _DefaultUtilityLayer;
  128514. private static _DefaultKeepDepthUtilityLayer;
  128515. private _sharedGizmoLight;
  128516. private _renderCamera;
  128517. /**
  128518. * Gets the camera that is used to render the utility layer (when not set, this will be the last active camera)
  128519. * @param getRigParentIfPossible if the current active camera is a rig camera, should its parent camera be returned
  128520. * @returns the camera that is used when rendering the utility layer
  128521. */
  128522. getRenderCamera(getRigParentIfPossible?: boolean): Camera;
  128523. /**
  128524. * Sets the camera that should be used when rendering the utility layer (If set to null the last active camera will be used)
  128525. * @param cam the camera that should be used when rendering the utility layer
  128526. */
  128527. setRenderCamera(cam: Nullable<Camera>): void;
  128528. /**
  128529. * @hidden
  128530. * Light which used by gizmos to get light shading
  128531. */
  128532. _getSharedGizmoLight(): HemisphericLight;
  128533. /**
  128534. * If the picking should be done on the utility layer prior to the actual scene (Default: true)
  128535. */
  128536. pickUtilitySceneFirst: boolean;
  128537. /**
  128538. * 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)
  128539. */
  128540. static get DefaultUtilityLayer(): UtilityLayerRenderer;
  128541. /**
  128542. * 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)
  128543. */
  128544. static get DefaultKeepDepthUtilityLayer(): UtilityLayerRenderer;
  128545. /**
  128546. * The scene that is rendered on top of the original scene
  128547. */
  128548. utilityLayerScene: Scene;
  128549. /**
  128550. * If the utility layer should automatically be rendered on top of existing scene
  128551. */
  128552. shouldRender: boolean;
  128553. /**
  128554. * If set to true, only pointer down onPointerObservable events will be blocked when picking is occluded by original scene
  128555. */
  128556. onlyCheckPointerDownEvents: boolean;
  128557. /**
  128558. * If set to false, only pointerUp, pointerDown and pointerMove will be sent to the utilityLayerScene (false by default)
  128559. */
  128560. processAllEvents: boolean;
  128561. /**
  128562. * Observable raised when the pointer move from the utility layer scene to the main scene
  128563. */
  128564. onPointerOutObservable: Observable<number>;
  128565. /** Gets or sets a predicate that will be used to indicate utility meshes present in the main scene */
  128566. mainSceneTrackerPredicate: (mesh: Nullable<AbstractMesh>) => boolean;
  128567. private _afterRenderObserver;
  128568. private _sceneDisposeObserver;
  128569. private _originalPointerObserver;
  128570. /**
  128571. * Instantiates a UtilityLayerRenderer
  128572. * @param originalScene the original scene that will be rendered on top of
  128573. * @param handleEvents boolean indicating if the utility layer should handle events
  128574. */
  128575. constructor(
  128576. /** the original scene that will be rendered on top of */
  128577. originalScene: Scene, handleEvents?: boolean);
  128578. private _notifyObservers;
  128579. /**
  128580. * Renders the utility layers scene on top of the original scene
  128581. */
  128582. render(): void;
  128583. /**
  128584. * Disposes of the renderer
  128585. */
  128586. dispose(): void;
  128587. private _updateCamera;
  128588. }
  128589. }
  128590. declare module BABYLON {
  128591. /**
  128592. * Options interface for the pointer selection module
  128593. */
  128594. export interface IWebXRControllerPointerSelectionOptions {
  128595. /**
  128596. * if provided, this scene will be used to render meshes.
  128597. */
  128598. customUtilityLayerScene?: Scene;
  128599. /**
  128600. * 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)
  128601. * If not disabled, the last picked point will be used to execute a pointer up event
  128602. * If disabled, pointer up event will be triggered right after the pointer down event.
  128603. * Used in screen and gaze target ray mode only
  128604. */
  128605. disablePointerUpOnTouchOut: boolean;
  128606. /**
  128607. * For gaze mode for tracked-pointer / controllers (time to select instead of button press)
  128608. */
  128609. forceGazeMode: boolean;
  128610. /**
  128611. * 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
  128612. * to start a new countdown to the pointer down event.
  128613. * Defaults to 1.
  128614. */
  128615. gazeModePointerMovedFactor?: number;
  128616. /**
  128617. * Different button type to use instead of the main component
  128618. */
  128619. overrideButtonId?: string;
  128620. /**
  128621. * use this rendering group id for the meshes (optional)
  128622. */
  128623. renderingGroupId?: number;
  128624. /**
  128625. * The amount of time in milliseconds it takes between pick found something to a pointer down event.
  128626. * Used in gaze modes. Tracked pointer uses the trigger, screen uses touch events
  128627. * 3000 means 3 seconds between pointing at something and selecting it
  128628. */
  128629. timeToSelect?: number;
  128630. /**
  128631. * Should meshes created here be added to a utility layer or the main scene
  128632. */
  128633. useUtilityLayer?: boolean;
  128634. /**
  128635. * Optional WebXR camera to be used for gaze selection
  128636. */
  128637. gazeCamera?: WebXRCamera;
  128638. /**
  128639. * the xr input to use with this pointer selection
  128640. */
  128641. xrInput: WebXRInput;
  128642. }
  128643. /**
  128644. * A module that will enable pointer selection for motion controllers of XR Input Sources
  128645. */
  128646. export class WebXRControllerPointerSelection extends WebXRAbstractFeature {
  128647. private readonly _options;
  128648. private static _idCounter;
  128649. private _attachController;
  128650. private _controllers;
  128651. private _scene;
  128652. private _tmpVectorForPickCompare;
  128653. /**
  128654. * The module's name
  128655. */
  128656. static readonly Name: string;
  128657. /**
  128658. * The (Babylon) version of this module.
  128659. * This is an integer representing the implementation version.
  128660. * This number does not correspond to the WebXR specs version
  128661. */
  128662. static readonly Version: number;
  128663. /**
  128664. * Disable lighting on the laser pointer (so it will always be visible)
  128665. */
  128666. disablePointerLighting: boolean;
  128667. /**
  128668. * Disable lighting on the selection mesh (so it will always be visible)
  128669. */
  128670. disableSelectionMeshLighting: boolean;
  128671. /**
  128672. * Should the laser pointer be displayed
  128673. */
  128674. displayLaserPointer: boolean;
  128675. /**
  128676. * Should the selection mesh be displayed (The ring at the end of the laser pointer)
  128677. */
  128678. displaySelectionMesh: boolean;
  128679. /**
  128680. * This color will be set to the laser pointer when selection is triggered
  128681. */
  128682. laserPointerPickedColor: Color3;
  128683. /**
  128684. * Default color of the laser pointer
  128685. */
  128686. laserPointerDefaultColor: Color3;
  128687. /**
  128688. * default color of the selection ring
  128689. */
  128690. selectionMeshDefaultColor: Color3;
  128691. /**
  128692. * This color will be applied to the selection ring when selection is triggered
  128693. */
  128694. selectionMeshPickedColor: Color3;
  128695. /**
  128696. * Optional filter to be used for ray selection. This predicate shares behavior with
  128697. * scene.pointerMovePredicate which takes priority if it is also assigned.
  128698. */
  128699. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  128700. /**
  128701. * constructs a new background remover module
  128702. * @param _xrSessionManager the session manager for this module
  128703. * @param _options read-only options to be used in this module
  128704. */
  128705. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPointerSelectionOptions);
  128706. /**
  128707. * attach this feature
  128708. * Will usually be called by the features manager
  128709. *
  128710. * @returns true if successful.
  128711. */
  128712. attach(): boolean;
  128713. /**
  128714. * detach this feature.
  128715. * Will usually be called by the features manager
  128716. *
  128717. * @returns true if successful.
  128718. */
  128719. detach(): boolean;
  128720. /**
  128721. * Will get the mesh under a specific pointer.
  128722. * `scene.meshUnderPointer` will only return one mesh - either left or right.
  128723. * @param controllerId the controllerId to check
  128724. * @returns The mesh under pointer or null if no mesh is under the pointer
  128725. */
  128726. getMeshUnderPointer(controllerId: string): Nullable<AbstractMesh>;
  128727. /**
  128728. * Get the xr controller that correlates to the pointer id in the pointer event
  128729. *
  128730. * @param id the pointer id to search for
  128731. * @returns the controller that correlates to this id or null if not found
  128732. */
  128733. getXRControllerByPointerId(id: number): Nullable<WebXRInputSource>;
  128734. protected _onXRFrame(_xrFrame: XRFrame): void;
  128735. private _attachGazeMode;
  128736. private _attachScreenRayMode;
  128737. private _attachTrackedPointerRayMode;
  128738. private _convertNormalToDirectionOfRay;
  128739. private _detachController;
  128740. private _generateNewMeshPair;
  128741. private _pickingMoved;
  128742. private _updatePointerDistance;
  128743. /** @hidden */
  128744. get lasterPointerDefaultColor(): Color3;
  128745. }
  128746. }
  128747. declare module BABYLON {
  128748. /**
  128749. * Button which can be used to enter a different mode of XR
  128750. */
  128751. export class WebXREnterExitUIButton {
  128752. /** button element */
  128753. element: HTMLElement;
  128754. /** XR initialization options for the button */
  128755. sessionMode: XRSessionMode;
  128756. /** Reference space type */
  128757. referenceSpaceType: XRReferenceSpaceType;
  128758. /**
  128759. * Creates a WebXREnterExitUIButton
  128760. * @param element button element
  128761. * @param sessionMode XR initialization session mode
  128762. * @param referenceSpaceType the type of reference space to be used
  128763. */
  128764. constructor(
  128765. /** button element */
  128766. element: HTMLElement,
  128767. /** XR initialization options for the button */
  128768. sessionMode: XRSessionMode,
  128769. /** Reference space type */
  128770. referenceSpaceType: XRReferenceSpaceType);
  128771. /**
  128772. * Extendable function which can be used to update the button's visuals when the state changes
  128773. * @param activeButton the current active button in the UI
  128774. */
  128775. update(activeButton: Nullable<WebXREnterExitUIButton>): void;
  128776. }
  128777. /**
  128778. * Options to create the webXR UI
  128779. */
  128780. export class WebXREnterExitUIOptions {
  128781. /**
  128782. * User provided buttons to enable/disable WebXR. The system will provide default if not set
  128783. */
  128784. customButtons?: Array<WebXREnterExitUIButton>;
  128785. /**
  128786. * A reference space type to use when creating the default button.
  128787. * Default is local-floor
  128788. */
  128789. referenceSpaceType?: XRReferenceSpaceType;
  128790. /**
  128791. * Context to enter xr with
  128792. */
  128793. renderTarget?: Nullable<WebXRRenderTarget>;
  128794. /**
  128795. * A session mode to use when creating the default button.
  128796. * Default is immersive-vr
  128797. */
  128798. sessionMode?: XRSessionMode;
  128799. /**
  128800. * A list of optional features to init the session with
  128801. */
  128802. optionalFeatures?: string[];
  128803. /**
  128804. * A list of optional features to init the session with
  128805. */
  128806. requiredFeatures?: string[];
  128807. }
  128808. /**
  128809. * UI to allow the user to enter/exit XR mode
  128810. */
  128811. export class WebXREnterExitUI implements IDisposable {
  128812. private scene;
  128813. /** version of the options passed to this UI */
  128814. options: WebXREnterExitUIOptions;
  128815. private _activeButton;
  128816. private _buttons;
  128817. /**
  128818. * The HTML Div Element to which buttons are added.
  128819. */
  128820. readonly overlay: HTMLDivElement;
  128821. /**
  128822. * Fired every time the active button is changed.
  128823. *
  128824. * When xr is entered via a button that launches xr that button will be the callback parameter
  128825. *
  128826. * When exiting xr the callback parameter will be null)
  128827. */
  128828. activeButtonChangedObservable: Observable<Nullable<WebXREnterExitUIButton>>;
  128829. /**
  128830. *
  128831. * @param scene babylon scene object to use
  128832. * @param options (read-only) version of the options passed to this UI
  128833. */
  128834. private constructor();
  128835. /**
  128836. * Creates UI to allow the user to enter/exit XR mode
  128837. * @param scene the scene to add the ui to
  128838. * @param helper the xr experience helper to enter/exit xr with
  128839. * @param options options to configure the UI
  128840. * @returns the created ui
  128841. */
  128842. static CreateAsync(scene: Scene, helper: WebXRExperienceHelper, options: WebXREnterExitUIOptions): Promise<WebXREnterExitUI>;
  128843. /**
  128844. * Disposes of the XR UI component
  128845. */
  128846. dispose(): void;
  128847. private _updateButtons;
  128848. }
  128849. }
  128850. declare module BABYLON {
  128851. /**
  128852. * Class containing static functions to help procedurally build meshes
  128853. */
  128854. export class LinesBuilder {
  128855. /**
  128856. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  128857. * * 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
  128858. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  128859. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  128860. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  128861. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  128862. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  128863. * * 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
  128864. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  128865. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  128866. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  128867. * @param name defines the name of the new line system
  128868. * @param options defines the options used to create the line system
  128869. * @param scene defines the hosting scene
  128870. * @returns a new line system mesh
  128871. */
  128872. static CreateLineSystem(name: string, options: {
  128873. lines: Vector3[][];
  128874. updatable?: boolean;
  128875. instance?: Nullable<LinesMesh>;
  128876. colors?: Nullable<Color4[][]>;
  128877. useVertexAlpha?: boolean;
  128878. }, scene: Nullable<Scene>): LinesMesh;
  128879. /**
  128880. * Creates a line mesh
  128881. * 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
  128882. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  128883. * * The parameter `points` is an array successive Vector3
  128884. * * 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
  128885. * * The optional parameter `colors` is an array of successive Color4, one per line point
  128886. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  128887. * * When updating an instance, remember that only point positions can change, not the number of points
  128888. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  128889. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  128890. * @param name defines the name of the new line system
  128891. * @param options defines the options used to create the line system
  128892. * @param scene defines the hosting scene
  128893. * @returns a new line mesh
  128894. */
  128895. static CreateLines(name: string, options: {
  128896. points: Vector3[];
  128897. updatable?: boolean;
  128898. instance?: Nullable<LinesMesh>;
  128899. colors?: Color4[];
  128900. useVertexAlpha?: boolean;
  128901. }, scene?: Nullable<Scene>): LinesMesh;
  128902. /**
  128903. * Creates a dashed line mesh
  128904. * * 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
  128905. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  128906. * * The parameter `points` is an array successive Vector3
  128907. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  128908. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  128909. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  128910. * * 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
  128911. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  128912. * * When updating an instance, remember that only point positions can change, not the number of points
  128913. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  128914. * @param name defines the name of the mesh
  128915. * @param options defines the options used to create the mesh
  128916. * @param scene defines the hosting scene
  128917. * @returns the dashed line mesh
  128918. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  128919. */
  128920. static CreateDashedLines(name: string, options: {
  128921. points: Vector3[];
  128922. dashSize?: number;
  128923. gapSize?: number;
  128924. dashNb?: number;
  128925. updatable?: boolean;
  128926. instance?: LinesMesh;
  128927. useVertexAlpha?: boolean;
  128928. }, scene?: Nullable<Scene>): LinesMesh;
  128929. }
  128930. }
  128931. declare module BABYLON {
  128932. /**
  128933. * Construction options for a timer
  128934. */
  128935. export interface ITimerOptions<T> {
  128936. /**
  128937. * Time-to-end
  128938. */
  128939. timeout: number;
  128940. /**
  128941. * The context observable is used to calculate time deltas and provides the context of the timer's callbacks. Will usually be OnBeforeRenderObservable.
  128942. * Countdown calculation is done ONLY when the observable is notifying its observers, meaning that if
  128943. * you choose an observable that doesn't trigger too often, the wait time might extend further than the requested max time
  128944. */
  128945. contextObservable: Observable<T>;
  128946. /**
  128947. * Optional parameters when adding an observer to the observable
  128948. */
  128949. observableParameters?: {
  128950. mask?: number;
  128951. insertFirst?: boolean;
  128952. scope?: any;
  128953. };
  128954. /**
  128955. * An optional break condition that will stop the times prematurely. In this case onEnded will not be triggered!
  128956. */
  128957. breakCondition?: (data?: ITimerData<T>) => boolean;
  128958. /**
  128959. * Will be triggered when the time condition has met
  128960. */
  128961. onEnded?: (data: ITimerData<any>) => void;
  128962. /**
  128963. * Will be triggered when the break condition has met (prematurely ended)
  128964. */
  128965. onAborted?: (data: ITimerData<any>) => void;
  128966. /**
  128967. * Optional function to execute on each tick (or count)
  128968. */
  128969. onTick?: (data: ITimerData<any>) => void;
  128970. }
  128971. /**
  128972. * An interface defining the data sent by the timer
  128973. */
  128974. export interface ITimerData<T> {
  128975. /**
  128976. * When did it start
  128977. */
  128978. startTime: number;
  128979. /**
  128980. * Time now
  128981. */
  128982. currentTime: number;
  128983. /**
  128984. * Time passed since started
  128985. */
  128986. deltaTime: number;
  128987. /**
  128988. * How much is completed, in [0.0...1.0].
  128989. * Note that this CAN be higher than 1 due to the fact that we don't actually measure time but delta between observable calls
  128990. */
  128991. completeRate: number;
  128992. /**
  128993. * What the registered observable sent in the last count
  128994. */
  128995. payload: T;
  128996. }
  128997. /**
  128998. * The current state of the timer
  128999. */
  129000. export enum TimerState {
  129001. /**
  129002. * Timer initialized, not yet started
  129003. */
  129004. INIT = 0,
  129005. /**
  129006. * Timer started and counting
  129007. */
  129008. STARTED = 1,
  129009. /**
  129010. * Timer ended (whether aborted or time reached)
  129011. */
  129012. ENDED = 2
  129013. }
  129014. /**
  129015. * A simple version of the timer. Will take options and start the timer immediately after calling it
  129016. *
  129017. * @param options options with which to initialize this timer
  129018. */
  129019. export function setAndStartTimer(options: ITimerOptions<any>): Nullable<Observer<any>>;
  129020. /**
  129021. * An advanced implementation of a timer class
  129022. */
  129023. export class AdvancedTimer<T = any> implements IDisposable {
  129024. /**
  129025. * Will notify each time the timer calculates the remaining time
  129026. */
  129027. onEachCountObservable: Observable<ITimerData<T>>;
  129028. /**
  129029. * Will trigger when the timer was aborted due to the break condition
  129030. */
  129031. onTimerAbortedObservable: Observable<ITimerData<T>>;
  129032. /**
  129033. * Will trigger when the timer ended successfully
  129034. */
  129035. onTimerEndedObservable: Observable<ITimerData<T>>;
  129036. /**
  129037. * Will trigger when the timer state has changed
  129038. */
  129039. onStateChangedObservable: Observable<TimerState>;
  129040. private _observer;
  129041. private _contextObservable;
  129042. private _observableParameters;
  129043. private _startTime;
  129044. private _timer;
  129045. private _state;
  129046. private _breakCondition;
  129047. private _timeToEnd;
  129048. private _breakOnNextTick;
  129049. /**
  129050. * Will construct a new advanced timer based on the options provided. Timer will not start until start() is called.
  129051. * @param options construction options for this advanced timer
  129052. */
  129053. constructor(options: ITimerOptions<T>);
  129054. /**
  129055. * set a breaking condition for this timer. Default is to never break during count
  129056. * @param predicate the new break condition. Returns true to break, false otherwise
  129057. */
  129058. set breakCondition(predicate: (data: ITimerData<T>) => boolean);
  129059. /**
  129060. * Reset ALL associated observables in this advanced timer
  129061. */
  129062. clearObservables(): void;
  129063. /**
  129064. * Will start a new iteration of this timer. Only one instance of this timer can run at a time.
  129065. *
  129066. * @param timeToEnd how much time to measure until timer ended
  129067. */
  129068. start(timeToEnd?: number): void;
  129069. /**
  129070. * Will force a stop on the next tick.
  129071. */
  129072. stop(): void;
  129073. /**
  129074. * Dispose this timer, clearing all resources
  129075. */
  129076. dispose(): void;
  129077. private _setState;
  129078. private _tick;
  129079. private _stop;
  129080. }
  129081. }
  129082. declare module BABYLON {
  129083. /**
  129084. * The options container for the teleportation module
  129085. */
  129086. export interface IWebXRTeleportationOptions {
  129087. /**
  129088. * if provided, this scene will be used to render meshes.
  129089. */
  129090. customUtilityLayerScene?: Scene;
  129091. /**
  129092. * Values to configure the default target mesh
  129093. */
  129094. defaultTargetMeshOptions?: {
  129095. /**
  129096. * Fill color of the teleportation area
  129097. */
  129098. teleportationFillColor?: string;
  129099. /**
  129100. * Border color for the teleportation area
  129101. */
  129102. teleportationBorderColor?: string;
  129103. /**
  129104. * Disable the mesh's animation sequence
  129105. */
  129106. disableAnimation?: boolean;
  129107. /**
  129108. * Disable lighting on the material or the ring and arrow
  129109. */
  129110. disableLighting?: boolean;
  129111. /**
  129112. * Override the default material of the torus and arrow
  129113. */
  129114. torusArrowMaterial?: Material;
  129115. };
  129116. /**
  129117. * A list of meshes to use as floor meshes.
  129118. * Meshes can be added and removed after initializing the feature using the
  129119. * addFloorMesh and removeFloorMesh functions
  129120. * If empty, rotation will still work
  129121. */
  129122. floorMeshes?: AbstractMesh[];
  129123. /**
  129124. * use this rendering group id for the meshes (optional)
  129125. */
  129126. renderingGroupId?: number;
  129127. /**
  129128. * Should teleportation move only to snap points
  129129. */
  129130. snapPointsOnly?: boolean;
  129131. /**
  129132. * An array of points to which the teleportation will snap to.
  129133. * If the teleportation ray is in the proximity of one of those points, it will be corrected to this point.
  129134. */
  129135. snapPositions?: Vector3[];
  129136. /**
  129137. * How close should the teleportation ray be in order to snap to position.
  129138. * Default to 0.8 units (meters)
  129139. */
  129140. snapToPositionRadius?: number;
  129141. /**
  129142. * Provide your own teleportation mesh instead of babylon's wonderful doughnut.
  129143. * If you want to support rotation, make sure your mesh has a direction indicator.
  129144. *
  129145. * When left untouched, the default mesh will be initialized.
  129146. */
  129147. teleportationTargetMesh?: AbstractMesh;
  129148. /**
  129149. * If main component is used (no thumbstick), how long should the "long press" take before teleport
  129150. */
  129151. timeToTeleport?: number;
  129152. /**
  129153. * Disable using the thumbstick and use the main component (usually trigger) on long press.
  129154. * This will be automatically true if the controller doesn't have a thumbstick or touchpad.
  129155. */
  129156. useMainComponentOnly?: boolean;
  129157. /**
  129158. * Should meshes created here be added to a utility layer or the main scene
  129159. */
  129160. useUtilityLayer?: boolean;
  129161. /**
  129162. * Babylon XR Input class for controller
  129163. */
  129164. xrInput: WebXRInput;
  129165. /**
  129166. * Meshes that the teleportation ray cannot go through
  129167. */
  129168. pickBlockerMeshes?: AbstractMesh[];
  129169. }
  129170. /**
  129171. * This is a teleportation feature to be used with WebXR-enabled motion controllers.
  129172. * When enabled and attached, the feature will allow a user to move around and rotate in the scene using
  129173. * the input of the attached controllers.
  129174. */
  129175. export class WebXRMotionControllerTeleportation extends WebXRAbstractFeature {
  129176. private _options;
  129177. private _controllers;
  129178. private _currentTeleportationControllerId;
  129179. private _floorMeshes;
  129180. private _quadraticBezierCurve;
  129181. private _selectionFeature;
  129182. private _snapToPositions;
  129183. private _snappedToPoint;
  129184. private _teleportationRingMaterial?;
  129185. private _tmpRay;
  129186. private _tmpVector;
  129187. private _tmpQuaternion;
  129188. /**
  129189. * The module's name
  129190. */
  129191. static readonly Name: string;
  129192. /**
  129193. * The (Babylon) version of this module.
  129194. * This is an integer representing the implementation version.
  129195. * This number does not correspond to the webxr specs version
  129196. */
  129197. static readonly Version: number;
  129198. /**
  129199. * Is movement backwards enabled
  129200. */
  129201. backwardsMovementEnabled: boolean;
  129202. /**
  129203. * Distance to travel when moving backwards
  129204. */
  129205. backwardsTeleportationDistance: number;
  129206. /**
  129207. * The distance from the user to the inspection point in the direction of the controller
  129208. * A higher number will allow the user to move further
  129209. * defaults to 5 (meters, in xr units)
  129210. */
  129211. parabolicCheckRadius: number;
  129212. /**
  129213. * Should the module support parabolic ray on top of direct ray
  129214. * If enabled, the user will be able to point "at the sky" and move according to predefined radius distance
  129215. * Very helpful when moving between floors / different heights
  129216. */
  129217. parabolicRayEnabled: boolean;
  129218. /**
  129219. * How much rotation should be applied when rotating right and left
  129220. */
  129221. rotationAngle: number;
  129222. /**
  129223. * Is rotation enabled when moving forward?
  129224. * Disabling this feature will prevent the user from deciding the direction when teleporting
  129225. */
  129226. rotationEnabled: boolean;
  129227. /**
  129228. * constructs a new anchor system
  129229. * @param _xrSessionManager an instance of WebXRSessionManager
  129230. * @param _options configuration object for this feature
  129231. */
  129232. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRTeleportationOptions);
  129233. /**
  129234. * Get the snapPointsOnly flag
  129235. */
  129236. get snapPointsOnly(): boolean;
  129237. /**
  129238. * Sets the snapPointsOnly flag
  129239. * @param snapToPoints should teleportation be exclusively to snap points
  129240. */
  129241. set snapPointsOnly(snapToPoints: boolean);
  129242. /**
  129243. * Add a new mesh to the floor meshes array
  129244. * @param mesh the mesh to use as floor mesh
  129245. */
  129246. addFloorMesh(mesh: AbstractMesh): void;
  129247. /**
  129248. * Add a new snap-to point to fix teleportation to this position
  129249. * @param newSnapPoint The new Snap-To point
  129250. */
  129251. addSnapPoint(newSnapPoint: Vector3): void;
  129252. attach(): boolean;
  129253. detach(): boolean;
  129254. dispose(): void;
  129255. /**
  129256. * Remove a mesh from the floor meshes array
  129257. * @param mesh the mesh to remove
  129258. */
  129259. removeFloorMesh(mesh: AbstractMesh): void;
  129260. /**
  129261. * Remove a mesh from the floor meshes array using its name
  129262. * @param name the mesh name to remove
  129263. */
  129264. removeFloorMeshByName(name: string): void;
  129265. /**
  129266. * 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
  129267. * @param snapPointToRemove the point (or a clone of it) to be removed from the array
  129268. * @returns was the point found and removed or not
  129269. */
  129270. removeSnapPoint(snapPointToRemove: Vector3): boolean;
  129271. /**
  129272. * This function sets a selection feature that will be disabled when
  129273. * the forward ray is shown and will be reattached when hidden.
  129274. * This is used to remove the selection rays when moving.
  129275. * @param selectionFeature the feature to disable when forward movement is enabled
  129276. */
  129277. setSelectionFeature(selectionFeature: IWebXRFeature): void;
  129278. protected _onXRFrame(_xrFrame: XRFrame): void;
  129279. private _attachController;
  129280. private _createDefaultTargetMesh;
  129281. private _detachController;
  129282. private _findClosestSnapPointWithRadius;
  129283. private _setTargetMeshPosition;
  129284. private _setTargetMeshVisibility;
  129285. private _showParabolicPath;
  129286. private _teleportForward;
  129287. }
  129288. }
  129289. declare module BABYLON {
  129290. /**
  129291. * Options for the default xr helper
  129292. */
  129293. export class WebXRDefaultExperienceOptions {
  129294. /**
  129295. * Enable or disable default UI to enter XR
  129296. */
  129297. disableDefaultUI?: boolean;
  129298. /**
  129299. * Should teleportation not initialize. defaults to false.
  129300. */
  129301. disableTeleportation?: boolean;
  129302. /**
  129303. * Floor meshes that will be used for teleport
  129304. */
  129305. floorMeshes?: Array<AbstractMesh>;
  129306. /**
  129307. * If set to true, the first frame will not be used to reset position
  129308. * The first frame is mainly used when copying transformation from the old camera
  129309. * Mainly used in AR
  129310. */
  129311. ignoreNativeCameraTransformation?: boolean;
  129312. /**
  129313. * Disable the controller mesh-loading. Can be used if you want to load your own meshes
  129314. */
  129315. inputOptions?: IWebXRInputOptions;
  129316. /**
  129317. * optional configuration for the output canvas
  129318. */
  129319. outputCanvasOptions?: WebXRManagedOutputCanvasOptions;
  129320. /**
  129321. * optional UI options. This can be used among other to change session mode and reference space type
  129322. */
  129323. uiOptions?: WebXREnterExitUIOptions;
  129324. /**
  129325. * When loading teleportation and pointer select, use stable versions instead of latest.
  129326. */
  129327. useStablePlugins?: boolean;
  129328. /**
  129329. * An optional rendering group id that will be set globally for teleportation, pointer selection and default controller meshes
  129330. */
  129331. renderingGroupId?: number;
  129332. /**
  129333. * A list of optional features to init the session with
  129334. * If set to true, all features we support will be added
  129335. */
  129336. optionalFeatures?: boolean | string[];
  129337. }
  129338. /**
  129339. * Default experience which provides a similar setup to the previous webVRExperience
  129340. */
  129341. export class WebXRDefaultExperience {
  129342. /**
  129343. * Base experience
  129344. */
  129345. baseExperience: WebXRExperienceHelper;
  129346. /**
  129347. * Enables ui for entering/exiting xr
  129348. */
  129349. enterExitUI: WebXREnterExitUI;
  129350. /**
  129351. * Input experience extension
  129352. */
  129353. input: WebXRInput;
  129354. /**
  129355. * Enables laser pointer and selection
  129356. */
  129357. pointerSelection: WebXRControllerPointerSelection;
  129358. /**
  129359. * Default target xr should render to
  129360. */
  129361. renderTarget: WebXRRenderTarget;
  129362. /**
  129363. * Enables teleportation
  129364. */
  129365. teleportation: WebXRMotionControllerTeleportation;
  129366. private constructor();
  129367. /**
  129368. * Creates the default xr experience
  129369. * @param scene scene
  129370. * @param options options for basic configuration
  129371. * @returns resulting WebXRDefaultExperience
  129372. */
  129373. static CreateAsync(scene: Scene, options?: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  129374. /**
  129375. * DIsposes of the experience helper
  129376. */
  129377. dispose(): void;
  129378. }
  129379. }
  129380. declare module BABYLON {
  129381. /**
  129382. * Options to modify the vr teleportation behavior.
  129383. */
  129384. export interface VRTeleportationOptions {
  129385. /**
  129386. * The name of the mesh which should be used as the teleportation floor. (default: null)
  129387. */
  129388. floorMeshName?: string;
  129389. /**
  129390. * A list of meshes to be used as the teleportation floor. (default: empty)
  129391. */
  129392. floorMeshes?: Mesh[];
  129393. /**
  129394. * The teleportation mode. (default: TELEPORTATIONMODE_CONSTANTTIME)
  129395. */
  129396. teleportationMode?: number;
  129397. /**
  129398. * The duration of the animation in ms, apply when animationMode is TELEPORTATIONMODE_CONSTANTTIME. (default 122ms)
  129399. */
  129400. teleportationTime?: number;
  129401. /**
  129402. * The speed of the animation in distance/sec, apply when animationMode is TELEPORTATIONMODE_CONSTANTSPEED. (default 20 units / sec)
  129403. */
  129404. teleportationSpeed?: number;
  129405. /**
  129406. * The easing function used in the animation or null for Linear. (default CircleEase)
  129407. */
  129408. easingFunction?: EasingFunction;
  129409. }
  129410. /**
  129411. * Options to modify the vr experience helper's behavior.
  129412. */
  129413. export interface VRExperienceHelperOptions extends WebVROptions {
  129414. /**
  129415. * Create a DeviceOrientationCamera to be used as your out of vr camera. (default: true)
  129416. */
  129417. createDeviceOrientationCamera?: boolean;
  129418. /**
  129419. * Create a VRDeviceOrientationFreeCamera to be used for VR when no external HMD is found. (default: true)
  129420. */
  129421. createFallbackVRDeviceOrientationFreeCamera?: boolean;
  129422. /**
  129423. * Uses the main button on the controller to toggle the laser casted. (default: true)
  129424. */
  129425. laserToggle?: boolean;
  129426. /**
  129427. * A list of meshes to be used as the teleportation floor. If specified, teleportation will be enabled (default: undefined)
  129428. */
  129429. floorMeshes?: Mesh[];
  129430. /**
  129431. * Distortion metrics for the fallback vrDeviceOrientationCamera (default: VRCameraMetrics.Default)
  129432. */
  129433. vrDeviceOrientationCameraMetrics?: VRCameraMetrics;
  129434. /**
  129435. * Defines if WebXR should be used instead of WebVR (if available)
  129436. */
  129437. useXR?: boolean;
  129438. }
  129439. /**
  129440. * Event containing information after VR has been entered
  129441. */
  129442. export class OnAfterEnteringVRObservableEvent {
  129443. /**
  129444. * If entering vr was successful
  129445. */
  129446. success: boolean;
  129447. }
  129448. /**
  129449. * Helps to quickly add VR support to an existing scene.
  129450. * See https://doc.babylonjs.com/how_to/webvr_helper
  129451. */
  129452. export class VRExperienceHelper {
  129453. /** Options to modify the vr experience helper's behavior. */
  129454. webVROptions: VRExperienceHelperOptions;
  129455. private _scene;
  129456. private _position;
  129457. private _btnVR;
  129458. private _btnVRDisplayed;
  129459. private _webVRsupported;
  129460. private _webVRready;
  129461. private _webVRrequesting;
  129462. private _webVRpresenting;
  129463. private _hasEnteredVR;
  129464. private _fullscreenVRpresenting;
  129465. private _inputElement;
  129466. private _webVRCamera;
  129467. private _vrDeviceOrientationCamera;
  129468. private _deviceOrientationCamera;
  129469. private _existingCamera;
  129470. private _onKeyDown;
  129471. private _onVrDisplayPresentChange;
  129472. private _onVRDisplayChanged;
  129473. private _onVRRequestPresentStart;
  129474. private _onVRRequestPresentComplete;
  129475. /**
  129476. * 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)
  129477. */
  129478. enableGazeEvenWhenNoPointerLock: boolean;
  129479. /**
  129480. * Gets or sets a boolean indicating that the VREXperienceHelper will exit VR if double tap is detected
  129481. */
  129482. exitVROnDoubleTap: boolean;
  129483. /**
  129484. * Observable raised right before entering VR.
  129485. */
  129486. onEnteringVRObservable: Observable<VRExperienceHelper>;
  129487. /**
  129488. * Observable raised when entering VR has completed.
  129489. */
  129490. onAfterEnteringVRObservable: Observable<OnAfterEnteringVRObservableEvent>;
  129491. /**
  129492. * Observable raised when exiting VR.
  129493. */
  129494. onExitingVRObservable: Observable<VRExperienceHelper>;
  129495. /**
  129496. * Observable raised when controller mesh is loaded.
  129497. */
  129498. onControllerMeshLoadedObservable: Observable<WebVRController>;
  129499. /** Return this.onEnteringVRObservable
  129500. * Note: This one is for backward compatibility. Please use onEnteringVRObservable directly
  129501. */
  129502. get onEnteringVR(): Observable<VRExperienceHelper>;
  129503. /** Return this.onExitingVRObservable
  129504. * Note: This one is for backward compatibility. Please use onExitingVRObservable directly
  129505. */
  129506. get onExitingVR(): Observable<VRExperienceHelper>;
  129507. /** Return this.onControllerMeshLoadedObservable
  129508. * Note: This one is for backward compatibility. Please use onControllerMeshLoadedObservable directly
  129509. */
  129510. get onControllerMeshLoaded(): Observable<WebVRController>;
  129511. private _rayLength;
  129512. private _useCustomVRButton;
  129513. private _teleportationRequested;
  129514. private _teleportActive;
  129515. private _floorMeshName;
  129516. private _floorMeshesCollection;
  129517. private _teleportationMode;
  129518. private _teleportationTime;
  129519. private _teleportationSpeed;
  129520. private _teleportationEasing;
  129521. private _rotationAllowed;
  129522. private _teleportBackwardsVector;
  129523. private _teleportationTarget;
  129524. private _isDefaultTeleportationTarget;
  129525. private _postProcessMove;
  129526. private _teleportationFillColor;
  129527. private _teleportationBorderColor;
  129528. private _rotationAngle;
  129529. private _haloCenter;
  129530. private _cameraGazer;
  129531. private _padSensibilityUp;
  129532. private _padSensibilityDown;
  129533. private _leftController;
  129534. private _rightController;
  129535. private _gazeColor;
  129536. private _laserColor;
  129537. private _pickedLaserColor;
  129538. private _pickedGazeColor;
  129539. /**
  129540. * Observable raised when a new mesh is selected based on meshSelectionPredicate
  129541. */
  129542. onNewMeshSelected: Observable<AbstractMesh>;
  129543. /**
  129544. * Observable raised when a new mesh is selected based on meshSelectionPredicate.
  129545. * This observable will provide the mesh and the controller used to select the mesh
  129546. */
  129547. onMeshSelectedWithController: Observable<{
  129548. mesh: AbstractMesh;
  129549. controller: WebVRController;
  129550. }>;
  129551. /**
  129552. * Observable raised when a new mesh is picked based on meshSelectionPredicate
  129553. */
  129554. onNewMeshPicked: Observable<PickingInfo>;
  129555. private _circleEase;
  129556. /**
  129557. * Observable raised before camera teleportation
  129558. */
  129559. onBeforeCameraTeleport: Observable<Vector3>;
  129560. /**
  129561. * Observable raised after camera teleportation
  129562. */
  129563. onAfterCameraTeleport: Observable<Vector3>;
  129564. /**
  129565. * Observable raised when current selected mesh gets unselected
  129566. */
  129567. onSelectedMeshUnselected: Observable<AbstractMesh>;
  129568. private _raySelectionPredicate;
  129569. /**
  129570. * To be optionaly changed by user to define custom ray selection
  129571. */
  129572. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  129573. /**
  129574. * To be optionaly changed by user to define custom selection logic (after ray selection)
  129575. */
  129576. meshSelectionPredicate: (mesh: AbstractMesh) => boolean;
  129577. /**
  129578. * Set teleportation enabled. If set to false camera teleportation will be disabled but camera rotation will be kept.
  129579. */
  129580. teleportationEnabled: boolean;
  129581. private _defaultHeight;
  129582. private _teleportationInitialized;
  129583. private _interactionsEnabled;
  129584. private _interactionsRequested;
  129585. private _displayGaze;
  129586. private _displayLaserPointer;
  129587. /**
  129588. * The mesh used to display where the user is going to teleport.
  129589. */
  129590. get teleportationTarget(): Mesh;
  129591. /**
  129592. * Sets the mesh to be used to display where the user is going to teleport.
  129593. */
  129594. set teleportationTarget(value: Mesh);
  129595. /**
  129596. * 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
  129597. * when set bakeCurrentTransformIntoVertices will be called on the mesh.
  129598. * See https://doc.babylonjs.com/resources/baking_transformations
  129599. */
  129600. get gazeTrackerMesh(): Mesh;
  129601. set gazeTrackerMesh(value: Mesh);
  129602. /**
  129603. * If the gaze trackers scale should be updated to be constant size when pointing at near/far meshes
  129604. */
  129605. updateGazeTrackerScale: boolean;
  129606. /**
  129607. * If the gaze trackers color should be updated when selecting meshes
  129608. */
  129609. updateGazeTrackerColor: boolean;
  129610. /**
  129611. * If the controller laser color should be updated when selecting meshes
  129612. */
  129613. updateControllerLaserColor: boolean;
  129614. /**
  129615. * The gaze tracking mesh corresponding to the left controller
  129616. */
  129617. get leftControllerGazeTrackerMesh(): Nullable<Mesh>;
  129618. /**
  129619. * The gaze tracking mesh corresponding to the right controller
  129620. */
  129621. get rightControllerGazeTrackerMesh(): Nullable<Mesh>;
  129622. /**
  129623. * If the ray of the gaze should be displayed.
  129624. */
  129625. get displayGaze(): boolean;
  129626. /**
  129627. * Sets if the ray of the gaze should be displayed.
  129628. */
  129629. set displayGaze(value: boolean);
  129630. /**
  129631. * If the ray of the LaserPointer should be displayed.
  129632. */
  129633. get displayLaserPointer(): boolean;
  129634. /**
  129635. * Sets if the ray of the LaserPointer should be displayed.
  129636. */
  129637. set displayLaserPointer(value: boolean);
  129638. /**
  129639. * The deviceOrientationCamera used as the camera when not in VR.
  129640. */
  129641. get deviceOrientationCamera(): Nullable<DeviceOrientationCamera>;
  129642. /**
  129643. * Based on the current WebVR support, returns the current VR camera used.
  129644. */
  129645. get currentVRCamera(): Nullable<Camera>;
  129646. /**
  129647. * The webVRCamera which is used when in VR.
  129648. */
  129649. get webVRCamera(): WebVRFreeCamera;
  129650. /**
  129651. * The deviceOrientationCamera that is used as a fallback when vr device is not connected.
  129652. */
  129653. get vrDeviceOrientationCamera(): Nullable<VRDeviceOrientationFreeCamera>;
  129654. /**
  129655. * The html button that is used to trigger entering into VR.
  129656. */
  129657. get vrButton(): Nullable<HTMLButtonElement>;
  129658. private get _teleportationRequestInitiated();
  129659. /**
  129660. * Defines whether or not Pointer lock should be requested when switching to
  129661. * full screen.
  129662. */
  129663. requestPointerLockOnFullScreen: boolean;
  129664. /**
  129665. * If asking to force XR, this will be populated with the default xr experience
  129666. */
  129667. xr: WebXRDefaultExperience;
  129668. /**
  129669. * Was the XR test done already. If this is true AND this.xr exists, xr is initialized.
  129670. * If this is true and no this.xr, xr exists but is not supported, using WebVR.
  129671. */
  129672. xrTestDone: boolean;
  129673. /**
  129674. * Instantiates a VRExperienceHelper.
  129675. * Helps to quickly add VR support to an existing scene.
  129676. * @param scene The scene the VRExperienceHelper belongs to.
  129677. * @param webVROptions Options to modify the vr experience helper's behavior.
  129678. */
  129679. constructor(scene: Scene,
  129680. /** Options to modify the vr experience helper's behavior. */
  129681. webVROptions?: VRExperienceHelperOptions);
  129682. private completeVRInit;
  129683. private _onDefaultMeshLoaded;
  129684. private _onResize;
  129685. private _onFullscreenChange;
  129686. /**
  129687. * Gets a value indicating if we are currently in VR mode.
  129688. */
  129689. get isInVRMode(): boolean;
  129690. private onVrDisplayPresentChange;
  129691. private onVRDisplayChanged;
  129692. private moveButtonToBottomRight;
  129693. private displayVRButton;
  129694. private updateButtonVisibility;
  129695. private _cachedAngularSensibility;
  129696. /**
  129697. * Attempt to enter VR. If a headset is connected and ready, will request present on that.
  129698. * Otherwise, will use the fullscreen API.
  129699. */
  129700. enterVR(): void;
  129701. /**
  129702. * Attempt to exit VR, or fullscreen.
  129703. */
  129704. exitVR(): void;
  129705. /**
  129706. * The position of the vr experience helper.
  129707. */
  129708. get position(): Vector3;
  129709. /**
  129710. * Sets the position of the vr experience helper.
  129711. */
  129712. set position(value: Vector3);
  129713. /**
  129714. * Enables controllers and user interactions such as selecting and object or clicking on an object.
  129715. */
  129716. enableInteractions(): void;
  129717. private get _noControllerIsActive();
  129718. private beforeRender;
  129719. private _isTeleportationFloor;
  129720. /**
  129721. * Adds a floor mesh to be used for teleportation.
  129722. * @param floorMesh the mesh to be used for teleportation.
  129723. */
  129724. addFloorMesh(floorMesh: Mesh): void;
  129725. /**
  129726. * Removes a floor mesh from being used for teleportation.
  129727. * @param floorMesh the mesh to be removed.
  129728. */
  129729. removeFloorMesh(floorMesh: Mesh): void;
  129730. /**
  129731. * Enables interactions and teleportation using the VR controllers and gaze.
  129732. * @param vrTeleportationOptions options to modify teleportation behavior.
  129733. */
  129734. enableTeleportation(vrTeleportationOptions?: VRTeleportationOptions): void;
  129735. private _onNewGamepadConnected;
  129736. private _tryEnableInteractionOnController;
  129737. private _onNewGamepadDisconnected;
  129738. private _enableInteractionOnController;
  129739. private _checkTeleportWithRay;
  129740. private _checkRotate;
  129741. private _checkTeleportBackwards;
  129742. private _enableTeleportationOnController;
  129743. private _createTeleportationCircles;
  129744. private _displayTeleportationTarget;
  129745. private _hideTeleportationTarget;
  129746. private _rotateCamera;
  129747. private _moveTeleportationSelectorTo;
  129748. private _workingVector;
  129749. private _workingQuaternion;
  129750. private _workingMatrix;
  129751. /**
  129752. * Time Constant Teleportation Mode
  129753. */
  129754. static readonly TELEPORTATIONMODE_CONSTANTTIME: number;
  129755. /**
  129756. * Speed Constant Teleportation Mode
  129757. */
  129758. static readonly TELEPORTATIONMODE_CONSTANTSPEED: number;
  129759. /**
  129760. * Teleports the users feet to the desired location
  129761. * @param location The location where the user's feet should be placed
  129762. */
  129763. teleportCamera(location: Vector3): void;
  129764. private _convertNormalToDirectionOfRay;
  129765. private _castRayAndSelectObject;
  129766. private _notifySelectedMeshUnselected;
  129767. /**
  129768. * Permanently set new colors for the laser pointer
  129769. * @param color the new laser color
  129770. * @param pickedColor the new laser color when picked mesh detected
  129771. */
  129772. setLaserColor(color: Color3, pickedColor?: Color3): void;
  129773. /**
  129774. * Set lighting enabled / disabled on the laser pointer of both controllers
  129775. * @param enabled should the lighting be enabled on the laser pointer
  129776. */
  129777. setLaserLightingState(enabled?: boolean): void;
  129778. /**
  129779. * Permanently set new colors for the gaze pointer
  129780. * @param color the new gaze color
  129781. * @param pickedColor the new gaze color when picked mesh detected
  129782. */
  129783. setGazeColor(color: Color3, pickedColor?: Color3): void;
  129784. /**
  129785. * Sets the color of the laser ray from the vr controllers.
  129786. * @param color new color for the ray.
  129787. */
  129788. changeLaserColor(color: Color3): void;
  129789. /**
  129790. * Sets the color of the ray from the vr headsets gaze.
  129791. * @param color new color for the ray.
  129792. */
  129793. changeGazeColor(color: Color3): void;
  129794. /**
  129795. * Exits VR and disposes of the vr experience helper
  129796. */
  129797. dispose(): void;
  129798. /**
  129799. * Gets the name of the VRExperienceHelper class
  129800. * @returns "VRExperienceHelper"
  129801. */
  129802. getClassName(): string;
  129803. }
  129804. }
  129805. declare module BABYLON {
  129806. /**
  129807. * Contains an array of blocks representing the octree
  129808. */
  129809. export interface IOctreeContainer<T> {
  129810. /**
  129811. * Blocks within the octree
  129812. */
  129813. blocks: Array<OctreeBlock<T>>;
  129814. }
  129815. /**
  129816. * Class used to store a cell in an octree
  129817. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129818. */
  129819. export class OctreeBlock<T> {
  129820. /**
  129821. * Gets the content of the current block
  129822. */
  129823. entries: T[];
  129824. /**
  129825. * Gets the list of block children
  129826. */
  129827. blocks: Array<OctreeBlock<T>>;
  129828. private _depth;
  129829. private _maxDepth;
  129830. private _capacity;
  129831. private _minPoint;
  129832. private _maxPoint;
  129833. private _boundingVectors;
  129834. private _creationFunc;
  129835. /**
  129836. * Creates a new block
  129837. * @param minPoint defines the minimum vector (in world space) of the block's bounding box
  129838. * @param maxPoint defines the maximum vector (in world space) of the block's bounding box
  129839. * @param capacity defines the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  129840. * @param depth defines the current depth of this block in the octree
  129841. * @param maxDepth defines the maximal depth allowed (beyond this value, the capacity is ignored)
  129842. * @param creationFunc defines a callback to call when an element is added to the block
  129843. */
  129844. constructor(minPoint: Vector3, maxPoint: Vector3, capacity: number, depth: number, maxDepth: number, creationFunc: (entry: T, block: OctreeBlock<T>) => void);
  129845. /**
  129846. * Gets the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  129847. */
  129848. get capacity(): number;
  129849. /**
  129850. * Gets the minimum vector (in world space) of the block's bounding box
  129851. */
  129852. get minPoint(): Vector3;
  129853. /**
  129854. * Gets the maximum vector (in world space) of the block's bounding box
  129855. */
  129856. get maxPoint(): Vector3;
  129857. /**
  129858. * Add a new element to this block
  129859. * @param entry defines the element to add
  129860. */
  129861. addEntry(entry: T): void;
  129862. /**
  129863. * Remove an element from this block
  129864. * @param entry defines the element to remove
  129865. */
  129866. removeEntry(entry: T): void;
  129867. /**
  129868. * Add an array of elements to this block
  129869. * @param entries defines the array of elements to add
  129870. */
  129871. addEntries(entries: T[]): void;
  129872. /**
  129873. * Test if the current block intersects the furstum planes and if yes, then add its content to the selection array
  129874. * @param frustumPlanes defines the frustum planes to test
  129875. * @param selection defines the array to store current content if selection is positive
  129876. * @param allowDuplicate defines if the selection array can contains duplicated entries
  129877. */
  129878. select(frustumPlanes: Plane[], selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  129879. /**
  129880. * Test if the current block intersect with the given bounding sphere and if yes, then add its content to the selection array
  129881. * @param sphereCenter defines the bounding sphere center
  129882. * @param sphereRadius defines the bounding sphere radius
  129883. * @param selection defines the array to store current content if selection is positive
  129884. * @param allowDuplicate defines if the selection array can contains duplicated entries
  129885. */
  129886. intersects(sphereCenter: Vector3, sphereRadius: number, selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  129887. /**
  129888. * Test if the current block intersect with the given ray and if yes, then add its content to the selection array
  129889. * @param ray defines the ray to test with
  129890. * @param selection defines the array to store current content if selection is positive
  129891. */
  129892. intersectsRay(ray: Ray, selection: SmartArrayNoDuplicate<T>): void;
  129893. /**
  129894. * Subdivide the content into child blocks (this block will then be empty)
  129895. */
  129896. createInnerBlocks(): void;
  129897. /**
  129898. * @hidden
  129899. */
  129900. 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;
  129901. }
  129902. }
  129903. declare module BABYLON {
  129904. /**
  129905. * Octrees are a really powerful data structure that can quickly select entities based on space coordinates.
  129906. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129907. */
  129908. export class Octree<T> {
  129909. /** 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.) */
  129910. maxDepth: number;
  129911. /**
  129912. * Blocks within the octree containing objects
  129913. */
  129914. blocks: Array<OctreeBlock<T>>;
  129915. /**
  129916. * Content stored in the octree
  129917. */
  129918. dynamicContent: T[];
  129919. private _maxBlockCapacity;
  129920. private _selectionContent;
  129921. private _creationFunc;
  129922. /**
  129923. * Creates a octree
  129924. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129925. * @param creationFunc function to be used to instatiate the octree
  129926. * @param maxBlockCapacity defines the maximum number of meshes you want on your octree's leaves (default: 64)
  129927. * @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.)
  129928. */
  129929. constructor(creationFunc: (entry: T, block: OctreeBlock<T>) => void, maxBlockCapacity?: number,
  129930. /** 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.) */
  129931. maxDepth?: number);
  129932. /**
  129933. * Updates the octree by adding blocks for the passed in meshes within the min and max world parameters
  129934. * @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);
  129935. * @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);
  129936. * @param entries meshes to be added to the octree blocks
  129937. */
  129938. update(worldMin: Vector3, worldMax: Vector3, entries: T[]): void;
  129939. /**
  129940. * Adds a mesh to the octree
  129941. * @param entry Mesh to add to the octree
  129942. */
  129943. addMesh(entry: T): void;
  129944. /**
  129945. * Remove an element from the octree
  129946. * @param entry defines the element to remove
  129947. */
  129948. removeMesh(entry: T): void;
  129949. /**
  129950. * Selects an array of meshes within the frustum
  129951. * @param frustumPlanes The frustum planes to use which will select all meshes within it
  129952. * @param allowDuplicate If duplicate objects are allowed in the resulting object array
  129953. * @returns array of meshes within the frustum
  129954. */
  129955. select(frustumPlanes: Plane[], allowDuplicate?: boolean): SmartArray<T>;
  129956. /**
  129957. * Test if the octree intersect with the given bounding sphere and if yes, then add its content to the selection array
  129958. * @param sphereCenter defines the bounding sphere center
  129959. * @param sphereRadius defines the bounding sphere radius
  129960. * @param allowDuplicate defines if the selection array can contains duplicated entries
  129961. * @returns an array of objects that intersect the sphere
  129962. */
  129963. intersects(sphereCenter: Vector3, sphereRadius: number, allowDuplicate?: boolean): SmartArray<T>;
  129964. /**
  129965. * Test if the octree intersect with the given ray and if yes, then add its content to resulting array
  129966. * @param ray defines the ray to test with
  129967. * @returns array of intersected objects
  129968. */
  129969. intersectsRay(ray: Ray): SmartArray<T>;
  129970. /**
  129971. * Adds a mesh into the octree block if it intersects the block
  129972. */
  129973. static CreationFuncForMeshes: (entry: AbstractMesh, block: OctreeBlock<AbstractMesh>) => void;
  129974. /**
  129975. * Adds a submesh into the octree block if it intersects the block
  129976. */
  129977. static CreationFuncForSubMeshes: (entry: SubMesh, block: OctreeBlock<SubMesh>) => void;
  129978. }
  129979. }
  129980. declare module BABYLON {
  129981. interface Scene {
  129982. /**
  129983. * @hidden
  129984. * Backing Filed
  129985. */
  129986. _selectionOctree: Octree<AbstractMesh>;
  129987. /**
  129988. * Gets the octree used to boost mesh selection (picking)
  129989. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129990. */
  129991. selectionOctree: Octree<AbstractMesh>;
  129992. /**
  129993. * Creates or updates the octree used to boost selection (picking)
  129994. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129995. * @param maxCapacity defines the maximum capacity per leaf
  129996. * @param maxDepth defines the maximum depth of the octree
  129997. * @returns an octree of AbstractMesh
  129998. */
  129999. createOrUpdateSelectionOctree(maxCapacity?: number, maxDepth?: number): Octree<AbstractMesh>;
  130000. }
  130001. interface AbstractMesh {
  130002. /**
  130003. * @hidden
  130004. * Backing Field
  130005. */
  130006. _submeshesOctree: Octree<SubMesh>;
  130007. /**
  130008. * This function will create an octree to help to select the right submeshes for rendering, picking and collision computations.
  130009. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  130010. * @param maxCapacity defines the maximum size of each block (64 by default)
  130011. * @param maxDepth defines the maximum depth to use (no more than 2 levels by default)
  130012. * @returns the new octree
  130013. * @see https://www.babylonjs-playground.com/#NA4OQ#12
  130014. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  130015. */
  130016. createOrUpdateSubmeshesOctree(maxCapacity?: number, maxDepth?: number): Octree<SubMesh>;
  130017. }
  130018. /**
  130019. * Defines the octree scene component responsible to manage any octrees
  130020. * in a given scene.
  130021. */
  130022. export class OctreeSceneComponent {
  130023. /**
  130024. * The component name help to identify the component in the list of scene components.
  130025. */
  130026. readonly name: string;
  130027. /**
  130028. * The scene the component belongs to.
  130029. */
  130030. scene: Scene;
  130031. /**
  130032. * Indicates if the meshes have been checked to make sure they are isEnabled()
  130033. */
  130034. readonly checksIsEnabled: boolean;
  130035. /**
  130036. * Creates a new instance of the component for the given scene
  130037. * @param scene Defines the scene to register the component in
  130038. */
  130039. constructor(scene: Scene);
  130040. /**
  130041. * Registers the component in a given scene
  130042. */
  130043. register(): void;
  130044. /**
  130045. * Return the list of active meshes
  130046. * @returns the list of active meshes
  130047. */
  130048. getActiveMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  130049. /**
  130050. * Return the list of active sub meshes
  130051. * @param mesh The mesh to get the candidates sub meshes from
  130052. * @returns the list of active sub meshes
  130053. */
  130054. getActiveSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  130055. private _tempRay;
  130056. /**
  130057. * Return the list of sub meshes intersecting with a given local ray
  130058. * @param mesh defines the mesh to find the submesh for
  130059. * @param localRay defines the ray in local space
  130060. * @returns the list of intersecting sub meshes
  130061. */
  130062. getIntersectingSubMeshCandidates(mesh: AbstractMesh, localRay: Ray): ISmartArrayLike<SubMesh>;
  130063. /**
  130064. * Return the list of sub meshes colliding with a collider
  130065. * @param mesh defines the mesh to find the submesh for
  130066. * @param collider defines the collider to evaluate the collision against
  130067. * @returns the list of colliding sub meshes
  130068. */
  130069. getCollidingSubMeshCandidates(mesh: AbstractMesh, collider: Collider): ISmartArrayLike<SubMesh>;
  130070. /**
  130071. * Rebuilds the elements related to this component in case of
  130072. * context lost for instance.
  130073. */
  130074. rebuild(): void;
  130075. /**
  130076. * Disposes the component and the associated ressources.
  130077. */
  130078. dispose(): void;
  130079. }
  130080. }
  130081. declare module BABYLON {
  130082. /**
  130083. * Renders gizmos on top of an existing scene which provide controls for position, rotation, etc.
  130084. */
  130085. export class Gizmo implements IDisposable {
  130086. /** The utility layer the gizmo will be added to */
  130087. gizmoLayer: UtilityLayerRenderer;
  130088. /**
  130089. * The root mesh of the gizmo
  130090. */
  130091. _rootMesh: Mesh;
  130092. private _attachedMesh;
  130093. private _attachedNode;
  130094. /**
  130095. * Ratio for the scale of the gizmo (Default: 1)
  130096. */
  130097. protected _scaleRatio: number;
  130098. /**
  130099. * Ratio for the scale of the gizmo (Default: 1)
  130100. */
  130101. set scaleRatio(value: number);
  130102. get scaleRatio(): number;
  130103. /**
  130104. * If a custom mesh has been set (Default: false)
  130105. */
  130106. protected _customMeshSet: boolean;
  130107. /**
  130108. * Mesh that the gizmo will be attached to. (eg. on a drag gizmo the mesh that will be dragged)
  130109. * * When set, interactions will be enabled
  130110. */
  130111. get attachedMesh(): Nullable<AbstractMesh>;
  130112. set attachedMesh(value: Nullable<AbstractMesh>);
  130113. /**
  130114. * Node that the gizmo will be attached to. (eg. on a drag gizmo the mesh, bone or NodeTransform that will be dragged)
  130115. * * When set, interactions will be enabled
  130116. */
  130117. get attachedNode(): Nullable<Node>;
  130118. set attachedNode(value: Nullable<Node>);
  130119. /**
  130120. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  130121. * @param mesh The mesh to replace the default mesh of the gizmo
  130122. */
  130123. setCustomMesh(mesh: Mesh): void;
  130124. protected _updateGizmoRotationToMatchAttachedMesh: boolean;
  130125. /**
  130126. * If set the gizmo's rotation will be updated to match the attached mesh each frame (Default: true)
  130127. */
  130128. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  130129. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  130130. /**
  130131. * If set the gizmo's position will be updated to match the attached mesh each frame (Default: true)
  130132. */
  130133. updateGizmoPositionToMatchAttachedMesh: boolean;
  130134. /**
  130135. * When set, the gizmo will always appear the same size no matter where the camera is (default: true)
  130136. */
  130137. updateScale: boolean;
  130138. protected _interactionsEnabled: boolean;
  130139. protected _attachedNodeChanged(value: Nullable<Node>): void;
  130140. private _beforeRenderObserver;
  130141. private _tempQuaternion;
  130142. private _tempVector;
  130143. private _tempVector2;
  130144. private _tempMatrix1;
  130145. private _tempMatrix2;
  130146. private _rightHandtoLeftHandMatrix;
  130147. /**
  130148. * Creates a gizmo
  130149. * @param gizmoLayer The utility layer the gizmo will be added to
  130150. */
  130151. constructor(
  130152. /** The utility layer the gizmo will be added to */
  130153. gizmoLayer?: UtilityLayerRenderer);
  130154. /**
  130155. * Updates the gizmo to match the attached mesh's position/rotation
  130156. */
  130157. protected _update(): void;
  130158. /**
  130159. * computes the rotation/scaling/position of the transform once the Node world matrix has changed.
  130160. * @param value Node, TransformNode or mesh
  130161. */
  130162. protected _matrixChanged(): void;
  130163. /**
  130164. * Disposes of the gizmo
  130165. */
  130166. dispose(): void;
  130167. }
  130168. }
  130169. declare module BABYLON {
  130170. /**
  130171. * Single plane drag gizmo
  130172. */
  130173. export class PlaneDragGizmo extends Gizmo {
  130174. /**
  130175. * Drag behavior responsible for the gizmos dragging interactions
  130176. */
  130177. dragBehavior: PointerDragBehavior;
  130178. private _pointerObserver;
  130179. /**
  130180. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  130181. */
  130182. snapDistance: number;
  130183. /**
  130184. * Event that fires each time the gizmo snaps to a new location.
  130185. * * snapDistance is the the change in distance
  130186. */
  130187. onSnapObservable: Observable<{
  130188. snapDistance: number;
  130189. }>;
  130190. private _plane;
  130191. private _coloredMaterial;
  130192. private _hoverMaterial;
  130193. private _isEnabled;
  130194. private _parent;
  130195. /** @hidden */
  130196. static _CreatePlane(scene: Scene, material: StandardMaterial): TransformNode;
  130197. /** @hidden */
  130198. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  130199. /**
  130200. * Creates a PlaneDragGizmo
  130201. * @param gizmoLayer The utility layer the gizmo will be added to
  130202. * @param dragPlaneNormal The axis normal to which the gizmo will be able to drag on
  130203. * @param color The color of the gizmo
  130204. */
  130205. constructor(dragPlaneNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  130206. protected _attachedNodeChanged(value: Nullable<Node>): void;
  130207. /**
  130208. * If the gizmo is enabled
  130209. */
  130210. set isEnabled(value: boolean);
  130211. get isEnabled(): boolean;
  130212. /**
  130213. * Disposes of the gizmo
  130214. */
  130215. dispose(): void;
  130216. }
  130217. }
  130218. declare module BABYLON {
  130219. /**
  130220. * Gizmo that enables dragging a mesh along 3 axis
  130221. */
  130222. export class PositionGizmo extends Gizmo {
  130223. /**
  130224. * Internal gizmo used for interactions on the x axis
  130225. */
  130226. xGizmo: AxisDragGizmo;
  130227. /**
  130228. * Internal gizmo used for interactions on the y axis
  130229. */
  130230. yGizmo: AxisDragGizmo;
  130231. /**
  130232. * Internal gizmo used for interactions on the z axis
  130233. */
  130234. zGizmo: AxisDragGizmo;
  130235. /**
  130236. * Internal gizmo used for interactions on the yz plane
  130237. */
  130238. xPlaneGizmo: PlaneDragGizmo;
  130239. /**
  130240. * Internal gizmo used for interactions on the xz plane
  130241. */
  130242. yPlaneGizmo: PlaneDragGizmo;
  130243. /**
  130244. * Internal gizmo used for interactions on the xy plane
  130245. */
  130246. zPlaneGizmo: PlaneDragGizmo;
  130247. /**
  130248. * private variables
  130249. */
  130250. private _meshAttached;
  130251. private _nodeAttached;
  130252. private _snapDistance;
  130253. /** Fires an event when any of it's sub gizmos are dragged */
  130254. onDragStartObservable: Observable<unknown>;
  130255. /** Fires an event when any of it's sub gizmos are released from dragging */
  130256. onDragEndObservable: Observable<unknown>;
  130257. /**
  130258. * If set to true, planar drag is enabled
  130259. */
  130260. private _planarGizmoEnabled;
  130261. get attachedMesh(): Nullable<AbstractMesh>;
  130262. set attachedMesh(mesh: Nullable<AbstractMesh>);
  130263. get attachedNode(): Nullable<Node>;
  130264. set attachedNode(node: Nullable<Node>);
  130265. /**
  130266. * Creates a PositionGizmo
  130267. * @param gizmoLayer The utility layer the gizmo will be added to
  130268. @param thickness display gizmo axis thickness
  130269. */
  130270. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number);
  130271. /**
  130272. * If the planar drag gizmo is enabled
  130273. * setting this will enable/disable XY, XZ and YZ planes regardless of individual gizmo settings.
  130274. */
  130275. set planarGizmoEnabled(value: boolean);
  130276. get planarGizmoEnabled(): boolean;
  130277. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  130278. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  130279. /**
  130280. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  130281. */
  130282. set snapDistance(value: number);
  130283. get snapDistance(): number;
  130284. /**
  130285. * Ratio for the scale of the gizmo (Default: 1)
  130286. */
  130287. set scaleRatio(value: number);
  130288. get scaleRatio(): number;
  130289. /**
  130290. * Disposes of the gizmo
  130291. */
  130292. dispose(): void;
  130293. /**
  130294. * CustomMeshes are not supported by this gizmo
  130295. * @param mesh The mesh to replace the default mesh of the gizmo
  130296. */
  130297. setCustomMesh(mesh: Mesh): void;
  130298. }
  130299. }
  130300. declare module BABYLON {
  130301. /**
  130302. * Single axis drag gizmo
  130303. */
  130304. export class AxisDragGizmo extends Gizmo {
  130305. /**
  130306. * Drag behavior responsible for the gizmos dragging interactions
  130307. */
  130308. dragBehavior: PointerDragBehavior;
  130309. private _pointerObserver;
  130310. /**
  130311. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  130312. */
  130313. snapDistance: number;
  130314. /**
  130315. * Event that fires each time the gizmo snaps to a new location.
  130316. * * snapDistance is the the change in distance
  130317. */
  130318. onSnapObservable: Observable<{
  130319. snapDistance: number;
  130320. }>;
  130321. private _isEnabled;
  130322. private _parent;
  130323. private _arrow;
  130324. private _coloredMaterial;
  130325. private _hoverMaterial;
  130326. /** @hidden */
  130327. static _CreateArrow(scene: Scene, material: StandardMaterial, thickness?: number): TransformNode;
  130328. /** @hidden */
  130329. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  130330. /**
  130331. * Creates an AxisDragGizmo
  130332. * @param gizmoLayer The utility layer the gizmo will be added to
  130333. * @param dragAxis The axis which the gizmo will be able to drag on
  130334. * @param color The color of the gizmo
  130335. * @param thickness display gizmo axis thickness
  130336. */
  130337. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>, thickness?: number);
  130338. protected _attachedNodeChanged(value: Nullable<Node>): void;
  130339. /**
  130340. * If the gizmo is enabled
  130341. */
  130342. set isEnabled(value: boolean);
  130343. get isEnabled(): boolean;
  130344. /**
  130345. * Disposes of the gizmo
  130346. */
  130347. dispose(): void;
  130348. }
  130349. }
  130350. declare module BABYLON.Debug {
  130351. /**
  130352. * The Axes viewer will show 3 axes in a specific point in space
  130353. */
  130354. export class AxesViewer {
  130355. private _xAxis;
  130356. private _yAxis;
  130357. private _zAxis;
  130358. private _scaleLinesFactor;
  130359. private _instanced;
  130360. /**
  130361. * Gets the hosting scene
  130362. */
  130363. scene: Nullable<Scene>;
  130364. /**
  130365. * Gets or sets a number used to scale line length
  130366. */
  130367. scaleLines: number;
  130368. /** Gets the node hierarchy used to render x-axis */
  130369. get xAxis(): TransformNode;
  130370. /** Gets the node hierarchy used to render y-axis */
  130371. get yAxis(): TransformNode;
  130372. /** Gets the node hierarchy used to render z-axis */
  130373. get zAxis(): TransformNode;
  130374. /**
  130375. * Creates a new AxesViewer
  130376. * @param scene defines the hosting scene
  130377. * @param scaleLines defines a number used to scale line length (1 by default)
  130378. * @param renderingGroupId defines a number used to set the renderingGroupId of the meshes (2 by default)
  130379. * @param xAxis defines the node hierarchy used to render the x-axis
  130380. * @param yAxis defines the node hierarchy used to render the y-axis
  130381. * @param zAxis defines the node hierarchy used to render the z-axis
  130382. */
  130383. constructor(scene: Scene, scaleLines?: number, renderingGroupId?: Nullable<number>, xAxis?: TransformNode, yAxis?: TransformNode, zAxis?: TransformNode);
  130384. /**
  130385. * Force the viewer to update
  130386. * @param position defines the position of the viewer
  130387. * @param xaxis defines the x axis of the viewer
  130388. * @param yaxis defines the y axis of the viewer
  130389. * @param zaxis defines the z axis of the viewer
  130390. */
  130391. update(position: Vector3, xaxis: Vector3, yaxis: Vector3, zaxis: Vector3): void;
  130392. /**
  130393. * Creates an instance of this axes viewer.
  130394. * @returns a new axes viewer with instanced meshes
  130395. */
  130396. createInstance(): AxesViewer;
  130397. /** Releases resources */
  130398. dispose(): void;
  130399. private static _SetRenderingGroupId;
  130400. }
  130401. }
  130402. declare module BABYLON.Debug {
  130403. /**
  130404. * The BoneAxesViewer will attach 3 axes to a specific bone of a specific mesh
  130405. * @see demo here: https://www.babylonjs-playground.com/#0DE8F4#8
  130406. */
  130407. export class BoneAxesViewer extends AxesViewer {
  130408. /**
  130409. * Gets or sets the target mesh where to display the axes viewer
  130410. */
  130411. mesh: Nullable<Mesh>;
  130412. /**
  130413. * Gets or sets the target bone where to display the axes viewer
  130414. */
  130415. bone: Nullable<Bone>;
  130416. /** Gets current position */
  130417. pos: Vector3;
  130418. /** Gets direction of X axis */
  130419. xaxis: Vector3;
  130420. /** Gets direction of Y axis */
  130421. yaxis: Vector3;
  130422. /** Gets direction of Z axis */
  130423. zaxis: Vector3;
  130424. /**
  130425. * Creates a new BoneAxesViewer
  130426. * @param scene defines the hosting scene
  130427. * @param bone defines the target bone
  130428. * @param mesh defines the target mesh
  130429. * @param scaleLines defines a scaling factor for line length (1 by default)
  130430. */
  130431. constructor(scene: Scene, bone: Bone, mesh: Mesh, scaleLines?: number);
  130432. /**
  130433. * Force the viewer to update
  130434. */
  130435. update(): void;
  130436. /** Releases resources */
  130437. dispose(): void;
  130438. }
  130439. }
  130440. declare module BABYLON {
  130441. /**
  130442. * Interface used to define scene explorer extensibility option
  130443. */
  130444. export interface IExplorerExtensibilityOption {
  130445. /**
  130446. * Define the option label
  130447. */
  130448. label: string;
  130449. /**
  130450. * Defines the action to execute on click
  130451. */
  130452. action: (entity: any) => void;
  130453. }
  130454. /**
  130455. * Defines a group of actions associated with a predicate to use when extending the Inspector scene explorer
  130456. */
  130457. export interface IExplorerExtensibilityGroup {
  130458. /**
  130459. * Defines a predicate to test if a given type mut be extended
  130460. */
  130461. predicate: (entity: any) => boolean;
  130462. /**
  130463. * Gets the list of options added to a type
  130464. */
  130465. entries: IExplorerExtensibilityOption[];
  130466. }
  130467. /**
  130468. * Interface used to define the options to use to create the Inspector
  130469. */
  130470. export interface IInspectorOptions {
  130471. /**
  130472. * Display in overlay mode (default: false)
  130473. */
  130474. overlay?: boolean;
  130475. /**
  130476. * HTML element to use as root (the parent of the rendering canvas will be used as default value)
  130477. */
  130478. globalRoot?: HTMLElement;
  130479. /**
  130480. * Display the Scene explorer
  130481. */
  130482. showExplorer?: boolean;
  130483. /**
  130484. * Display the property inspector
  130485. */
  130486. showInspector?: boolean;
  130487. /**
  130488. * Display in embed mode (both panes on the right)
  130489. */
  130490. embedMode?: boolean;
  130491. /**
  130492. * let the Inspector handles resize of the canvas when panes are resized (default to true)
  130493. */
  130494. handleResize?: boolean;
  130495. /**
  130496. * Allow the panes to popup (default: true)
  130497. */
  130498. enablePopup?: boolean;
  130499. /**
  130500. * Allow the panes to be closed by users (default: true)
  130501. */
  130502. enableClose?: boolean;
  130503. /**
  130504. * Optional list of extensibility entries
  130505. */
  130506. explorerExtensibility?: IExplorerExtensibilityGroup[];
  130507. /**
  130508. * Optional URL to get the inspector script from (by default it uses the babylonjs CDN).
  130509. */
  130510. inspectorURL?: string;
  130511. /**
  130512. * Optional initial tab (default to DebugLayerTab.Properties)
  130513. */
  130514. initialTab?: DebugLayerTab;
  130515. }
  130516. interface Scene {
  130517. /**
  130518. * @hidden
  130519. * Backing field
  130520. */
  130521. _debugLayer: DebugLayer;
  130522. /**
  130523. * Gets the debug layer (aka Inspector) associated with the scene
  130524. * @see https://doc.babylonjs.com/features/playground_debuglayer
  130525. */
  130526. debugLayer: DebugLayer;
  130527. }
  130528. /**
  130529. * Enum of inspector action tab
  130530. */
  130531. export enum DebugLayerTab {
  130532. /**
  130533. * Properties tag (default)
  130534. */
  130535. Properties = 0,
  130536. /**
  130537. * Debug tab
  130538. */
  130539. Debug = 1,
  130540. /**
  130541. * Statistics tab
  130542. */
  130543. Statistics = 2,
  130544. /**
  130545. * Tools tab
  130546. */
  130547. Tools = 3,
  130548. /**
  130549. * Settings tab
  130550. */
  130551. Settings = 4
  130552. }
  130553. /**
  130554. * The debug layer (aka Inspector) is the go to tool in order to better understand
  130555. * what is happening in your scene
  130556. * @see https://doc.babylonjs.com/features/playground_debuglayer
  130557. */
  130558. export class DebugLayer {
  130559. /**
  130560. * Define the url to get the inspector script from.
  130561. * By default it uses the babylonjs CDN.
  130562. * @ignoreNaming
  130563. */
  130564. static InspectorURL: string;
  130565. private _scene;
  130566. private BJSINSPECTOR;
  130567. private _onPropertyChangedObservable?;
  130568. /**
  130569. * Observable triggered when a property is changed through the inspector.
  130570. */
  130571. get onPropertyChangedObservable(): any;
  130572. /**
  130573. * Instantiates a new debug layer.
  130574. * The debug layer (aka Inspector) is the go to tool in order to better understand
  130575. * what is happening in your scene
  130576. * @see https://doc.babylonjs.com/features/playground_debuglayer
  130577. * @param scene Defines the scene to inspect
  130578. */
  130579. constructor(scene: Scene);
  130580. /** Creates the inspector window. */
  130581. private _createInspector;
  130582. /**
  130583. * Select a specific entity in the scene explorer and highlight a specific block in that entity property grid
  130584. * @param entity defines the entity to select
  130585. * @param lineContainerTitles defines the specific blocks to highlight (could be a string or an array of strings)
  130586. */
  130587. select(entity: any, lineContainerTitles?: string | string[]): void;
  130588. /** Get the inspector from bundle or global */
  130589. private _getGlobalInspector;
  130590. /**
  130591. * Get if the inspector is visible or not.
  130592. * @returns true if visible otherwise, false
  130593. */
  130594. isVisible(): boolean;
  130595. /**
  130596. * Hide the inspector and close its window.
  130597. */
  130598. hide(): void;
  130599. /**
  130600. * Update the scene in the inspector
  130601. */
  130602. setAsActiveScene(): void;
  130603. /**
  130604. * Launch the debugLayer.
  130605. * @param config Define the configuration of the inspector
  130606. * @return a promise fulfilled when the debug layer is visible
  130607. */
  130608. show(config?: IInspectorOptions): Promise<DebugLayer>;
  130609. }
  130610. }
  130611. declare module BABYLON {
  130612. /**
  130613. * Class containing static functions to help procedurally build meshes
  130614. */
  130615. export class BoxBuilder {
  130616. /**
  130617. * Creates a box mesh
  130618. * * The parameter `size` sets the size (float) of each box side (default 1)
  130619. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  130620. * * 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)
  130621. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  130622. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  130623. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  130624. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  130625. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  130626. * @param name defines the name of the mesh
  130627. * @param options defines the options used to create the mesh
  130628. * @param scene defines the hosting scene
  130629. * @returns the box mesh
  130630. */
  130631. static CreateBox(name: string, options: {
  130632. size?: number;
  130633. width?: number;
  130634. height?: number;
  130635. depth?: number;
  130636. faceUV?: Vector4[];
  130637. faceColors?: Color4[];
  130638. sideOrientation?: number;
  130639. frontUVs?: Vector4;
  130640. backUVs?: Vector4;
  130641. wrap?: boolean;
  130642. topBaseAt?: number;
  130643. bottomBaseAt?: number;
  130644. updatable?: boolean;
  130645. }, scene?: Nullable<Scene>): Mesh;
  130646. }
  130647. }
  130648. declare module BABYLON.Debug {
  130649. /**
  130650. * Used to show the physics impostor around the specific mesh
  130651. */
  130652. export class PhysicsViewer {
  130653. /** @hidden */
  130654. protected _impostors: Array<Nullable<PhysicsImpostor>>;
  130655. /** @hidden */
  130656. protected _meshes: Array<Nullable<AbstractMesh>>;
  130657. /** @hidden */
  130658. protected _scene: Nullable<Scene>;
  130659. /** @hidden */
  130660. protected _numMeshes: number;
  130661. /** @hidden */
  130662. protected _physicsEnginePlugin: Nullable<IPhysicsEnginePlugin>;
  130663. private _renderFunction;
  130664. private _utilityLayer;
  130665. private _debugBoxMesh;
  130666. private _debugSphereMesh;
  130667. private _debugCylinderMesh;
  130668. private _debugMaterial;
  130669. private _debugMeshMeshes;
  130670. /**
  130671. * Creates a new PhysicsViewer
  130672. * @param scene defines the hosting scene
  130673. */
  130674. constructor(scene: Scene);
  130675. /** @hidden */
  130676. protected _updateDebugMeshes(): void;
  130677. /**
  130678. * Renders a specified physic impostor
  130679. * @param impostor defines the impostor to render
  130680. * @param targetMesh defines the mesh represented by the impostor
  130681. * @returns the new debug mesh used to render the impostor
  130682. */
  130683. showImpostor(impostor: PhysicsImpostor, targetMesh?: Mesh): Nullable<AbstractMesh>;
  130684. /**
  130685. * Hides a specified physic impostor
  130686. * @param impostor defines the impostor to hide
  130687. */
  130688. hideImpostor(impostor: Nullable<PhysicsImpostor>): void;
  130689. private _getDebugMaterial;
  130690. private _getDebugBoxMesh;
  130691. private _getDebugSphereMesh;
  130692. private _getDebugCylinderMesh;
  130693. private _getDebugMeshMesh;
  130694. private _getDebugMesh;
  130695. /** Releases all resources */
  130696. dispose(): void;
  130697. }
  130698. }
  130699. declare module BABYLON {
  130700. /**
  130701. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  130702. * in order to better appreciate the issue one might have.
  130703. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  130704. */
  130705. export class RayHelper {
  130706. /**
  130707. * Defines the ray we are currently tryin to visualize.
  130708. */
  130709. ray: Nullable<Ray>;
  130710. private _renderPoints;
  130711. private _renderLine;
  130712. private _renderFunction;
  130713. private _scene;
  130714. private _onAfterRenderObserver;
  130715. private _onAfterStepObserver;
  130716. private _attachedToMesh;
  130717. private _meshSpaceDirection;
  130718. private _meshSpaceOrigin;
  130719. /**
  130720. * Helper function to create a colored helper in a scene in one line.
  130721. * @param ray Defines the ray we are currently tryin to visualize
  130722. * @param scene Defines the scene the ray is used in
  130723. * @param color Defines the color we want to see the ray in
  130724. * @returns The newly created ray helper.
  130725. */
  130726. static CreateAndShow(ray: Ray, scene: Scene, color: Color3): RayHelper;
  130727. /**
  130728. * Instantiate a new ray helper.
  130729. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  130730. * in order to better appreciate the issue one might have.
  130731. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  130732. * @param ray Defines the ray we are currently tryin to visualize
  130733. */
  130734. constructor(ray: Ray);
  130735. /**
  130736. * Shows the ray we are willing to debug.
  130737. * @param scene Defines the scene the ray needs to be rendered in
  130738. * @param color Defines the color the ray needs to be rendered in
  130739. */
  130740. show(scene: Scene, color?: Color3): void;
  130741. /**
  130742. * Hides the ray we are debugging.
  130743. */
  130744. hide(): void;
  130745. private _render;
  130746. /**
  130747. * Attach a ray helper to a mesh so that we can easily see its orientation for instance or information like its normals.
  130748. * @param mesh Defines the mesh we want the helper attached to
  130749. * @param meshSpaceDirection Defines the direction of the Ray in mesh space (local space of the mesh node)
  130750. * @param meshSpaceOrigin Defines the origin of the Ray in mesh space (local space of the mesh node)
  130751. * @param length Defines the length of the ray
  130752. */
  130753. attachToMesh(mesh: AbstractMesh, meshSpaceDirection?: Vector3, meshSpaceOrigin?: Vector3, length?: number): void;
  130754. /**
  130755. * Detach the ray helper from the mesh it has previously been attached to.
  130756. */
  130757. detachFromMesh(): void;
  130758. private _updateToMesh;
  130759. /**
  130760. * Dispose the helper and release its associated resources.
  130761. */
  130762. dispose(): void;
  130763. }
  130764. }
  130765. declare module BABYLON {
  130766. /**
  130767. * Defines the options associated with the creation of a SkeletonViewer.
  130768. */
  130769. export interface ISkeletonViewerOptions {
  130770. /** Should the system pause animations before building the Viewer? */
  130771. pauseAnimations: boolean;
  130772. /** Should the system return the skeleton to rest before building? */
  130773. returnToRest: boolean;
  130774. /** public Display Mode of the Viewer */
  130775. displayMode: number;
  130776. /** Flag to toggle if the Viewer should use the CPU for animations or not? */
  130777. displayOptions: ISkeletonViewerDisplayOptions;
  130778. /** Flag to toggle if the Viewer should use the CPU for animations or not? */
  130779. computeBonesUsingShaders: boolean;
  130780. /** Flag ignore non weighted bones */
  130781. useAllBones: boolean;
  130782. }
  130783. /**
  130784. * Defines how to display the various bone meshes for the viewer.
  130785. */
  130786. export interface ISkeletonViewerDisplayOptions {
  130787. /** How far down to start tapering the bone spurs */
  130788. midStep?: number;
  130789. /** How big is the midStep? */
  130790. midStepFactor?: number;
  130791. /** Base for the Sphere Size */
  130792. sphereBaseSize?: number;
  130793. /** The ratio of the sphere to the longest bone in units */
  130794. sphereScaleUnit?: number;
  130795. /** Ratio for the Sphere Size */
  130796. sphereFactor?: number;
  130797. }
  130798. /**
  130799. * Defines the constructor options for the BoneWeight Shader.
  130800. */
  130801. export interface IBoneWeightShaderOptions {
  130802. /** Skeleton to Map */
  130803. skeleton: Skeleton;
  130804. /** Colors for Uninfluenced bones */
  130805. colorBase?: Color3;
  130806. /** Colors for 0.0-0.25 Weight bones */
  130807. colorZero?: Color3;
  130808. /** Color for 0.25-0.5 Weight Influence */
  130809. colorQuarter?: Color3;
  130810. /** Color for 0.5-0.75 Weight Influence */
  130811. colorHalf?: Color3;
  130812. /** Color for 0.75-1 Weight Influence */
  130813. colorFull?: Color3;
  130814. /** Color for Zero Weight Influence */
  130815. targetBoneIndex?: number;
  130816. }
  130817. /**
  130818. * Simple structure of the gradient steps for the Color Map.
  130819. */
  130820. export interface ISkeletonMapShaderColorMapKnot {
  130821. /** Color of the Knot */
  130822. color: Color3;
  130823. /** Location of the Knot */
  130824. location: number;
  130825. }
  130826. /**
  130827. * Defines the constructor options for the SkeletonMap Shader.
  130828. */
  130829. export interface ISkeletonMapShaderOptions {
  130830. /** Skeleton to Map */
  130831. skeleton: Skeleton;
  130832. /** Array of ColorMapKnots that make the gradient must be ordered with knot[i].location < knot[i+1].location*/
  130833. colorMap?: ISkeletonMapShaderColorMapKnot[];
  130834. }
  130835. }
  130836. declare module BABYLON {
  130837. /**
  130838. * Class containing static functions to help procedurally build meshes
  130839. */
  130840. export class RibbonBuilder {
  130841. /**
  130842. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  130843. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  130844. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  130845. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  130846. * * 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
  130847. * * 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
  130848. * * 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
  130849. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  130850. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  130851. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  130852. * * 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
  130853. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  130854. * * 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
  130855. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  130856. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  130857. * @param name defines the name of the mesh
  130858. * @param options defines the options used to create the mesh
  130859. * @param scene defines the hosting scene
  130860. * @returns the ribbon mesh
  130861. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  130862. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  130863. */
  130864. static CreateRibbon(name: string, options: {
  130865. pathArray: Vector3[][];
  130866. closeArray?: boolean;
  130867. closePath?: boolean;
  130868. offset?: number;
  130869. updatable?: boolean;
  130870. sideOrientation?: number;
  130871. frontUVs?: Vector4;
  130872. backUVs?: Vector4;
  130873. instance?: Mesh;
  130874. invertUV?: boolean;
  130875. uvs?: Vector2[];
  130876. colors?: Color4[];
  130877. }, scene?: Nullable<Scene>): Mesh;
  130878. }
  130879. }
  130880. declare module BABYLON {
  130881. /**
  130882. * Class containing static functions to help procedurally build meshes
  130883. */
  130884. export class ShapeBuilder {
  130885. /**
  130886. * 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.
  130887. * * 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.
  130888. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  130889. * * 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.
  130890. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  130891. * * 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
  130892. * * 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
  130893. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  130894. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  130895. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  130896. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  130897. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  130898. * @param name defines the name of the mesh
  130899. * @param options defines the options used to create the mesh
  130900. * @param scene defines the hosting scene
  130901. * @returns the extruded shape mesh
  130902. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  130903. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  130904. */
  130905. static ExtrudeShape(name: string, options: {
  130906. shape: Vector3[];
  130907. path: Vector3[];
  130908. scale?: number;
  130909. rotation?: number;
  130910. cap?: number;
  130911. updatable?: boolean;
  130912. sideOrientation?: number;
  130913. frontUVs?: Vector4;
  130914. backUVs?: Vector4;
  130915. instance?: Mesh;
  130916. invertUV?: boolean;
  130917. }, scene?: Nullable<Scene>): Mesh;
  130918. /**
  130919. * Creates an custom extruded shape mesh.
  130920. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  130921. * * 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.
  130922. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  130923. * * 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
  130924. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  130925. * * 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
  130926. * * It must returns a float value that will be the scale value applied to the shape on each path point
  130927. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  130928. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  130929. * * 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
  130930. * * 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
  130931. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  130932. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  130933. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  130934. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  130935. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  130936. * @param name defines the name of the mesh
  130937. * @param options defines the options used to create the mesh
  130938. * @param scene defines the hosting scene
  130939. * @returns the custom extruded shape mesh
  130940. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  130941. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  130942. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  130943. */
  130944. static ExtrudeShapeCustom(name: string, options: {
  130945. shape: Vector3[];
  130946. path: Vector3[];
  130947. scaleFunction?: any;
  130948. rotationFunction?: any;
  130949. ribbonCloseArray?: boolean;
  130950. ribbonClosePath?: boolean;
  130951. cap?: number;
  130952. updatable?: boolean;
  130953. sideOrientation?: number;
  130954. frontUVs?: Vector4;
  130955. backUVs?: Vector4;
  130956. instance?: Mesh;
  130957. invertUV?: boolean;
  130958. }, scene?: Nullable<Scene>): Mesh;
  130959. private static _ExtrudeShapeGeneric;
  130960. }
  130961. }
  130962. declare module BABYLON.Debug {
  130963. /**
  130964. * Class used to render a debug view of a given skeleton
  130965. * @see http://www.babylonjs-playground.com/#1BZJVJ#8
  130966. */
  130967. export class SkeletonViewer {
  130968. /** defines the skeleton to render */
  130969. skeleton: Skeleton;
  130970. /** defines the mesh attached to the skeleton */
  130971. mesh: AbstractMesh;
  130972. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  130973. autoUpdateBonesMatrices: boolean;
  130974. /** defines the rendering group id to use with the viewer */
  130975. renderingGroupId: number;
  130976. /** is the options for the viewer */
  130977. options: Partial<ISkeletonViewerOptions>;
  130978. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_LINES */
  130979. static readonly DISPLAY_LINES: number;
  130980. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_SPHERES */
  130981. static readonly DISPLAY_SPHERES: number;
  130982. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_SPHERE_AND_SPURS */
  130983. static readonly DISPLAY_SPHERE_AND_SPURS: number;
  130984. /** public static method to create a BoneWeight Shader
  130985. * @param options The constructor options
  130986. * @param scene The scene that the shader is scoped to
  130987. * @returns The created ShaderMaterial
  130988. * @see http://www.babylonjs-playground.com/#1BZJVJ#395
  130989. */
  130990. static CreateBoneWeightShader(options: IBoneWeightShaderOptions, scene: Scene): ShaderMaterial;
  130991. /** public static method to create a BoneWeight Shader
  130992. * @param options The constructor options
  130993. * @param scene The scene that the shader is scoped to
  130994. * @returns The created ShaderMaterial
  130995. */
  130996. static CreateSkeletonMapShader(options: ISkeletonMapShaderOptions, scene: Scene): ShaderMaterial;
  130997. /** private static method to create a BoneWeight Shader
  130998. * @param size The size of the buffer to create (usually the bone count)
  130999. * @param colorMap The gradient data to generate
  131000. * @param scene The scene that the shader is scoped to
  131001. * @returns an Array of floats from the color gradient values
  131002. */
  131003. private static _CreateBoneMapColorBuffer;
  131004. /** If SkeletonViewer scene scope. */
  131005. private _scene;
  131006. /** Gets or sets the color used to render the skeleton */
  131007. color: Color3;
  131008. /** Array of the points of the skeleton fo the line view. */
  131009. private _debugLines;
  131010. /** The SkeletonViewers Mesh. */
  131011. private _debugMesh;
  131012. /** If SkeletonViewer is enabled. */
  131013. private _isEnabled;
  131014. /** If SkeletonViewer is ready. */
  131015. private _ready;
  131016. /** SkeletonViewer render observable. */
  131017. private _obs;
  131018. /** The Utility Layer to render the gizmos in. */
  131019. private _utilityLayer;
  131020. private _boneIndices;
  131021. /** Gets the Scene. */
  131022. get scene(): Scene;
  131023. /** Gets the utilityLayer. */
  131024. get utilityLayer(): Nullable<UtilityLayerRenderer>;
  131025. /** Checks Ready Status. */
  131026. get isReady(): Boolean;
  131027. /** Sets Ready Status. */
  131028. set ready(value: boolean);
  131029. /** Gets the debugMesh */
  131030. get debugMesh(): Nullable<AbstractMesh> | Nullable<LinesMesh>;
  131031. /** Sets the debugMesh */
  131032. set debugMesh(value: Nullable<AbstractMesh> | Nullable<LinesMesh>);
  131033. /** Gets the material */
  131034. get material(): StandardMaterial;
  131035. /** Sets the material */
  131036. set material(value: StandardMaterial);
  131037. /** Gets the material */
  131038. get displayMode(): number;
  131039. /** Sets the material */
  131040. set displayMode(value: number);
  131041. /**
  131042. * Creates a new SkeletonViewer
  131043. * @param skeleton defines the skeleton to render
  131044. * @param mesh defines the mesh attached to the skeleton
  131045. * @param scene defines the hosting scene
  131046. * @param autoUpdateBonesMatrices defines a boolean indicating if bones matrices must be forced to update before rendering (true by default)
  131047. * @param renderingGroupId defines the rendering group id to use with the viewer
  131048. * @param options All of the extra constructor options for the SkeletonViewer
  131049. */
  131050. constructor(
  131051. /** defines the skeleton to render */
  131052. skeleton: Skeleton,
  131053. /** defines the mesh attached to the skeleton */
  131054. mesh: AbstractMesh,
  131055. /** The Scene scope*/
  131056. scene: Scene,
  131057. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  131058. autoUpdateBonesMatrices?: boolean,
  131059. /** defines the rendering group id to use with the viewer */
  131060. renderingGroupId?: number,
  131061. /** is the options for the viewer */
  131062. options?: Partial<ISkeletonViewerOptions>);
  131063. /** The Dynamic bindings for the update functions */
  131064. private _bindObs;
  131065. /** Update the viewer to sync with current skeleton state, only used to manually update. */
  131066. update(): void;
  131067. /** Gets or sets a boolean indicating if the viewer is enabled */
  131068. set isEnabled(value: boolean);
  131069. get isEnabled(): boolean;
  131070. private _getBonePosition;
  131071. private _getLinesForBonesWithLength;
  131072. private _getLinesForBonesNoLength;
  131073. /** function to revert the mesh and scene back to the initial state. */
  131074. private _revert;
  131075. /** function to build and bind sphere joint points and spur bone representations. */
  131076. private _buildSpheresAndSpurs;
  131077. /** Update the viewer to sync with current skeleton state, only used for the line display. */
  131078. private _displayLinesUpdate;
  131079. /** Changes the displayMode of the skeleton viewer
  131080. * @param mode The displayMode numerical value
  131081. */
  131082. changeDisplayMode(mode: number): void;
  131083. /** Changes the displayMode of the skeleton viewer
  131084. * @param option String of the option name
  131085. * @param value The numerical option value
  131086. */
  131087. changeDisplayOptions(option: string, value: number): void;
  131088. /** Release associated resources */
  131089. dispose(): void;
  131090. }
  131091. }
  131092. declare module BABYLON {
  131093. /**
  131094. * Enum for Device Types
  131095. */
  131096. export enum DeviceType {
  131097. /** Generic */
  131098. Generic = 0,
  131099. /** Keyboard */
  131100. Keyboard = 1,
  131101. /** Mouse */
  131102. Mouse = 2,
  131103. /** Touch Pointers */
  131104. Touch = 3,
  131105. /** PS4 Dual Shock */
  131106. DualShock = 4,
  131107. /** Xbox */
  131108. Xbox = 5,
  131109. /** Switch Controller */
  131110. Switch = 6
  131111. }
  131112. /**
  131113. * Enum for All Pointers (Touch/Mouse)
  131114. */
  131115. export enum PointerInput {
  131116. /** Horizontal Axis */
  131117. Horizontal = 0,
  131118. /** Vertical Axis */
  131119. Vertical = 1,
  131120. /** Left Click or Touch */
  131121. LeftClick = 2,
  131122. /** Middle Click */
  131123. MiddleClick = 3,
  131124. /** Right Click */
  131125. RightClick = 4,
  131126. /** Browser Back */
  131127. BrowserBack = 5,
  131128. /** Browser Forward */
  131129. BrowserForward = 6
  131130. }
  131131. /**
  131132. * Enum for Dual Shock Gamepad
  131133. */
  131134. export enum DualShockInput {
  131135. /** Cross */
  131136. Cross = 0,
  131137. /** Circle */
  131138. Circle = 1,
  131139. /** Square */
  131140. Square = 2,
  131141. /** Triangle */
  131142. Triangle = 3,
  131143. /** L1 */
  131144. L1 = 4,
  131145. /** R1 */
  131146. R1 = 5,
  131147. /** L2 */
  131148. L2 = 6,
  131149. /** R2 */
  131150. R2 = 7,
  131151. /** Share */
  131152. Share = 8,
  131153. /** Options */
  131154. Options = 9,
  131155. /** L3 */
  131156. L3 = 10,
  131157. /** R3 */
  131158. R3 = 11,
  131159. /** DPadUp */
  131160. DPadUp = 12,
  131161. /** DPadDown */
  131162. DPadDown = 13,
  131163. /** DPadLeft */
  131164. DPadLeft = 14,
  131165. /** DRight */
  131166. DPadRight = 15,
  131167. /** Home */
  131168. Home = 16,
  131169. /** TouchPad */
  131170. TouchPad = 17,
  131171. /** LStickXAxis */
  131172. LStickXAxis = 18,
  131173. /** LStickYAxis */
  131174. LStickYAxis = 19,
  131175. /** RStickXAxis */
  131176. RStickXAxis = 20,
  131177. /** RStickYAxis */
  131178. RStickYAxis = 21
  131179. }
  131180. /**
  131181. * Enum for Xbox Gamepad
  131182. */
  131183. export enum XboxInput {
  131184. /** A */
  131185. A = 0,
  131186. /** B */
  131187. B = 1,
  131188. /** X */
  131189. X = 2,
  131190. /** Y */
  131191. Y = 3,
  131192. /** LB */
  131193. LB = 4,
  131194. /** RB */
  131195. RB = 5,
  131196. /** LT */
  131197. LT = 6,
  131198. /** RT */
  131199. RT = 7,
  131200. /** Back */
  131201. Back = 8,
  131202. /** Start */
  131203. Start = 9,
  131204. /** LS */
  131205. LS = 10,
  131206. /** RS */
  131207. RS = 11,
  131208. /** DPadUp */
  131209. DPadUp = 12,
  131210. /** DPadDown */
  131211. DPadDown = 13,
  131212. /** DPadLeft */
  131213. DPadLeft = 14,
  131214. /** DRight */
  131215. DPadRight = 15,
  131216. /** Home */
  131217. Home = 16,
  131218. /** LStickXAxis */
  131219. LStickXAxis = 17,
  131220. /** LStickYAxis */
  131221. LStickYAxis = 18,
  131222. /** RStickXAxis */
  131223. RStickXAxis = 19,
  131224. /** RStickYAxis */
  131225. RStickYAxis = 20
  131226. }
  131227. /**
  131228. * Enum for Switch (Pro/JoyCon L+R) Gamepad
  131229. */
  131230. export enum SwitchInput {
  131231. /** B */
  131232. B = 0,
  131233. /** A */
  131234. A = 1,
  131235. /** Y */
  131236. Y = 2,
  131237. /** X */
  131238. X = 3,
  131239. /** L */
  131240. L = 4,
  131241. /** R */
  131242. R = 5,
  131243. /** ZL */
  131244. ZL = 6,
  131245. /** ZR */
  131246. ZR = 7,
  131247. /** Minus */
  131248. Minus = 8,
  131249. /** Plus */
  131250. Plus = 9,
  131251. /** LS */
  131252. LS = 10,
  131253. /** RS */
  131254. RS = 11,
  131255. /** DPadUp */
  131256. DPadUp = 12,
  131257. /** DPadDown */
  131258. DPadDown = 13,
  131259. /** DPadLeft */
  131260. DPadLeft = 14,
  131261. /** DRight */
  131262. DPadRight = 15,
  131263. /** Home */
  131264. Home = 16,
  131265. /** Capture */
  131266. Capture = 17,
  131267. /** LStickXAxis */
  131268. LStickXAxis = 18,
  131269. /** LStickYAxis */
  131270. LStickYAxis = 19,
  131271. /** RStickXAxis */
  131272. RStickXAxis = 20,
  131273. /** RStickYAxis */
  131274. RStickYAxis = 21
  131275. }
  131276. }
  131277. declare module BABYLON {
  131278. /**
  131279. * This class will take all inputs from Keyboard, Pointer, and
  131280. * any Gamepads and provide a polling system that all devices
  131281. * will use. This class assumes that there will only be one
  131282. * pointer device and one keyboard.
  131283. */
  131284. export class DeviceInputSystem implements IDisposable {
  131285. /**
  131286. * Callback to be triggered when a device is connected
  131287. */
  131288. onDeviceConnected: (deviceType: DeviceType, deviceSlot: number) => void;
  131289. /**
  131290. * Callback to be triggered when a device is disconnected
  131291. */
  131292. onDeviceDisconnected: (deviceType: DeviceType, deviceSlot: number) => void;
  131293. /**
  131294. * Callback to be triggered when event driven input is updated
  131295. */
  131296. onInputChanged: (deviceType: DeviceType, deviceSlot: number, inputIndex: number, previousState: Nullable<number>, currentState: Nullable<number>) => void;
  131297. private _inputs;
  131298. private _gamepads;
  131299. private _keyboardActive;
  131300. private _pointerActive;
  131301. private _elementToAttachTo;
  131302. private _keyboardDownEvent;
  131303. private _keyboardUpEvent;
  131304. private _pointerMoveEvent;
  131305. private _pointerDownEvent;
  131306. private _pointerUpEvent;
  131307. private _gamepadConnectedEvent;
  131308. private _gamepadDisconnectedEvent;
  131309. private static _MAX_KEYCODES;
  131310. private static _MAX_POINTER_INPUTS;
  131311. private constructor();
  131312. /**
  131313. * Creates a new DeviceInputSystem instance
  131314. * @param engine Engine to pull input element from
  131315. * @returns The new instance
  131316. */
  131317. static Create(engine: Engine): DeviceInputSystem;
  131318. /**
  131319. * Checks for current device input value, given an id and input index
  131320. * @param deviceName Id of connected device
  131321. * @param inputIndex Index of device input
  131322. * @returns Current value of input
  131323. */
  131324. /**
  131325. * Checks for current device input value, given an id and input index. Throws exception if requested device not initialized.
  131326. * @param deviceType Enum specifiying device type
  131327. * @param deviceSlot "Slot" or index that device is referenced in
  131328. * @param inputIndex Id of input to be checked
  131329. * @returns Current value of input
  131330. */
  131331. pollInput(deviceType: DeviceType, deviceSlot: number, inputIndex: number): number;
  131332. /**
  131333. * Dispose of all the eventlisteners
  131334. */
  131335. dispose(): void;
  131336. /**
  131337. * Add device and inputs to device array
  131338. * @param deviceType Enum specifiying device type
  131339. * @param deviceSlot "Slot" or index that device is referenced in
  131340. * @param numberOfInputs Number of input entries to create for given device
  131341. */
  131342. private _registerDevice;
  131343. /**
  131344. * Given a specific device name, remove that device from the device map
  131345. * @param deviceType Enum specifiying device type
  131346. * @param deviceSlot "Slot" or index that device is referenced in
  131347. */
  131348. private _unregisterDevice;
  131349. /**
  131350. * Handle all actions that come from keyboard interaction
  131351. */
  131352. private _handleKeyActions;
  131353. /**
  131354. * Handle all actions that come from pointer interaction
  131355. */
  131356. private _handlePointerActions;
  131357. /**
  131358. * Handle all actions that come from gamepad interaction
  131359. */
  131360. private _handleGamepadActions;
  131361. /**
  131362. * Update all non-event based devices with each frame
  131363. * @param deviceType Enum specifiying device type
  131364. * @param deviceSlot "Slot" or index that device is referenced in
  131365. * @param inputIndex Id of input to be checked
  131366. */
  131367. private _updateDevice;
  131368. /**
  131369. * Gets DeviceType from the device name
  131370. * @param deviceName Name of Device from DeviceInputSystem
  131371. * @returns DeviceType enum value
  131372. */
  131373. private _getGamepadDeviceType;
  131374. }
  131375. }
  131376. declare module BABYLON {
  131377. /**
  131378. * Type to handle enforcement of inputs
  131379. */
  131380. 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;
  131381. }
  131382. declare module BABYLON {
  131383. /**
  131384. * Class that handles all input for a specific device
  131385. */
  131386. export class DeviceSource<T extends DeviceType> {
  131387. /** Type of device */
  131388. readonly deviceType: DeviceType;
  131389. /** "Slot" or index that device is referenced in */
  131390. readonly deviceSlot: number;
  131391. /**
  131392. * Observable to handle device input changes per device
  131393. */
  131394. readonly onInputChangedObservable: Observable<{
  131395. inputIndex: DeviceInput<T>;
  131396. previousState: Nullable<number>;
  131397. currentState: Nullable<number>;
  131398. }>;
  131399. private readonly _deviceInputSystem;
  131400. /**
  131401. * Default Constructor
  131402. * @param deviceInputSystem Reference to DeviceInputSystem
  131403. * @param deviceType Type of device
  131404. * @param deviceSlot "Slot" or index that device is referenced in
  131405. */
  131406. constructor(deviceInputSystem: DeviceInputSystem,
  131407. /** Type of device */
  131408. deviceType: DeviceType,
  131409. /** "Slot" or index that device is referenced in */
  131410. deviceSlot?: number);
  131411. /**
  131412. * Get input for specific input
  131413. * @param inputIndex index of specific input on device
  131414. * @returns Input value from DeviceInputSystem
  131415. */
  131416. getInput(inputIndex: DeviceInput<T>): number;
  131417. }
  131418. /**
  131419. * Class to keep track of devices
  131420. */
  131421. export class DeviceSourceManager implements IDisposable {
  131422. /**
  131423. * Observable to be triggered when before a device is connected
  131424. */
  131425. readonly onBeforeDeviceConnectedObservable: Observable<{
  131426. deviceType: DeviceType;
  131427. deviceSlot: number;
  131428. }>;
  131429. /**
  131430. * Observable to be triggered when before a device is disconnected
  131431. */
  131432. readonly onBeforeDeviceDisconnectedObservable: Observable<{
  131433. deviceType: DeviceType;
  131434. deviceSlot: number;
  131435. }>;
  131436. /**
  131437. * Observable to be triggered when after a device is connected
  131438. */
  131439. readonly onAfterDeviceConnectedObservable: Observable<{
  131440. deviceType: DeviceType;
  131441. deviceSlot: number;
  131442. }>;
  131443. /**
  131444. * Observable to be triggered when after a device is disconnected
  131445. */
  131446. readonly onAfterDeviceDisconnectedObservable: Observable<{
  131447. deviceType: DeviceType;
  131448. deviceSlot: number;
  131449. }>;
  131450. private readonly _devices;
  131451. private readonly _firstDevice;
  131452. private readonly _deviceInputSystem;
  131453. /**
  131454. * Default Constructor
  131455. * @param engine engine to pull input element from
  131456. */
  131457. constructor(engine: Engine);
  131458. /**
  131459. * Gets a DeviceSource, given a type and slot
  131460. * @param deviceType Enum specifying device type
  131461. * @param deviceSlot "Slot" or index that device is referenced in
  131462. * @returns DeviceSource object
  131463. */
  131464. getDeviceSource<T extends DeviceType>(deviceType: T, deviceSlot?: number): Nullable<DeviceSource<T>>;
  131465. /**
  131466. * Gets an array of DeviceSource objects for a given device type
  131467. * @param deviceType Enum specifying device type
  131468. * @returns Array of DeviceSource objects
  131469. */
  131470. getDeviceSources<T extends DeviceType>(deviceType: T): ReadonlyArray<DeviceSource<T>>;
  131471. /**
  131472. * Dispose of DeviceInputSystem and other parts
  131473. */
  131474. dispose(): void;
  131475. /**
  131476. * Function to add device name to device list
  131477. * @param deviceType Enum specifying device type
  131478. * @param deviceSlot "Slot" or index that device is referenced in
  131479. */
  131480. private _addDevice;
  131481. /**
  131482. * Function to remove device name to device list
  131483. * @param deviceType Enum specifying device type
  131484. * @param deviceSlot "Slot" or index that device is referenced in
  131485. */
  131486. private _removeDevice;
  131487. /**
  131488. * Updates array storing first connected device of each type
  131489. * @param type Type of Device
  131490. */
  131491. private _updateFirstDevices;
  131492. }
  131493. }
  131494. declare module BABYLON {
  131495. /**
  131496. * Options to create the null engine
  131497. */
  131498. export class NullEngineOptions {
  131499. /**
  131500. * Render width (Default: 512)
  131501. */
  131502. renderWidth: number;
  131503. /**
  131504. * Render height (Default: 256)
  131505. */
  131506. renderHeight: number;
  131507. /**
  131508. * Texture size (Default: 512)
  131509. */
  131510. textureSize: number;
  131511. /**
  131512. * If delta time between frames should be constant
  131513. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  131514. */
  131515. deterministicLockstep: boolean;
  131516. /**
  131517. * Maximum about of steps between frames (Default: 4)
  131518. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  131519. */
  131520. lockstepMaxSteps: number;
  131521. /**
  131522. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  131523. */
  131524. useHighPrecisionMatrix?: boolean;
  131525. }
  131526. /**
  131527. * The null engine class provides support for headless version of babylon.js.
  131528. * This can be used in server side scenario or for testing purposes
  131529. */
  131530. export class NullEngine extends Engine {
  131531. private _options;
  131532. /**
  131533. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  131534. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  131535. * @returns true if engine is in deterministic lock step mode
  131536. */
  131537. isDeterministicLockStep(): boolean;
  131538. /**
  131539. * Gets the max steps when engine is running in deterministic lock step
  131540. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  131541. * @returns the max steps
  131542. */
  131543. getLockstepMaxSteps(): number;
  131544. /**
  131545. * Gets the current hardware scaling level.
  131546. * By default the hardware scaling level is computed from the window device ratio.
  131547. * 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.
  131548. * @returns a number indicating the current hardware scaling level
  131549. */
  131550. getHardwareScalingLevel(): number;
  131551. constructor(options?: NullEngineOptions);
  131552. /**
  131553. * Creates a vertex buffer
  131554. * @param vertices the data for the vertex buffer
  131555. * @returns the new WebGL static buffer
  131556. */
  131557. createVertexBuffer(vertices: FloatArray): DataBuffer;
  131558. /**
  131559. * Creates a new index buffer
  131560. * @param indices defines the content of the index buffer
  131561. * @param updatable defines if the index buffer must be updatable
  131562. * @returns a new webGL buffer
  131563. */
  131564. createIndexBuffer(indices: IndicesArray): DataBuffer;
  131565. /**
  131566. * Clear the current render buffer or the current render target (if any is set up)
  131567. * @param color defines the color to use
  131568. * @param backBuffer defines if the back buffer must be cleared
  131569. * @param depth defines if the depth buffer must be cleared
  131570. * @param stencil defines if the stencil buffer must be cleared
  131571. */
  131572. clear(color: IColor4Like, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  131573. /**
  131574. * Gets the current render width
  131575. * @param useScreen defines if screen size must be used (or the current render target if any)
  131576. * @returns a number defining the current render width
  131577. */
  131578. getRenderWidth(useScreen?: boolean): number;
  131579. /**
  131580. * Gets the current render height
  131581. * @param useScreen defines if screen size must be used (or the current render target if any)
  131582. * @returns a number defining the current render height
  131583. */
  131584. getRenderHeight(useScreen?: boolean): number;
  131585. /**
  131586. * Set the WebGL's viewport
  131587. * @param viewport defines the viewport element to be used
  131588. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  131589. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  131590. */
  131591. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  131592. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: string, context?: WebGLRenderingContext): WebGLProgram;
  131593. /**
  131594. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  131595. * @param pipelineContext defines the pipeline context to use
  131596. * @param uniformsNames defines the list of uniform names
  131597. * @returns an array of webGL uniform locations
  131598. */
  131599. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  131600. /**
  131601. * Gets the lsit of active attributes for a given webGL program
  131602. * @param pipelineContext defines the pipeline context to use
  131603. * @param attributesNames defines the list of attribute names to get
  131604. * @returns an array of indices indicating the offset of each attribute
  131605. */
  131606. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  131607. /**
  131608. * Binds an effect to the webGL context
  131609. * @param effect defines the effect to bind
  131610. */
  131611. bindSamplers(effect: Effect): void;
  131612. /**
  131613. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  131614. * @param effect defines the effect to activate
  131615. */
  131616. enableEffect(effect: Effect): void;
  131617. /**
  131618. * Set various states to the webGL context
  131619. * @param culling defines backface culling state
  131620. * @param zOffset defines the value to apply to zOffset (0 by default)
  131621. * @param force defines if states must be applied even if cache is up to date
  131622. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  131623. */
  131624. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  131625. /**
  131626. * Set the value of an uniform to an array of int32
  131627. * @param uniform defines the webGL uniform location where to store the value
  131628. * @param array defines the array of int32 to store
  131629. */
  131630. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  131631. /**
  131632. * Set the value of an uniform to an array of int32 (stored as vec2)
  131633. * @param uniform defines the webGL uniform location where to store the value
  131634. * @param array defines the array of int32 to store
  131635. */
  131636. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  131637. /**
  131638. * Set the value of an uniform to an array of int32 (stored as vec3)
  131639. * @param uniform defines the webGL uniform location where to store the value
  131640. * @param array defines the array of int32 to store
  131641. */
  131642. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  131643. /**
  131644. * Set the value of an uniform to an array of int32 (stored as vec4)
  131645. * @param uniform defines the webGL uniform location where to store the value
  131646. * @param array defines the array of int32 to store
  131647. */
  131648. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  131649. /**
  131650. * Set the value of an uniform to an array of float32
  131651. * @param uniform defines the webGL uniform location where to store the value
  131652. * @param array defines the array of float32 to store
  131653. */
  131654. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  131655. /**
  131656. * Set the value of an uniform to an array of float32 (stored as vec2)
  131657. * @param uniform defines the webGL uniform location where to store the value
  131658. * @param array defines the array of float32 to store
  131659. */
  131660. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  131661. /**
  131662. * Set the value of an uniform to an array of float32 (stored as vec3)
  131663. * @param uniform defines the webGL uniform location where to store the value
  131664. * @param array defines the array of float32 to store
  131665. */
  131666. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  131667. /**
  131668. * Set the value of an uniform to an array of float32 (stored as vec4)
  131669. * @param uniform defines the webGL uniform location where to store the value
  131670. * @param array defines the array of float32 to store
  131671. */
  131672. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  131673. /**
  131674. * Set the value of an uniform to an array of number
  131675. * @param uniform defines the webGL uniform location where to store the value
  131676. * @param array defines the array of number to store
  131677. */
  131678. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  131679. /**
  131680. * Set the value of an uniform to an array of number (stored as vec2)
  131681. * @param uniform defines the webGL uniform location where to store the value
  131682. * @param array defines the array of number to store
  131683. */
  131684. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  131685. /**
  131686. * Set the value of an uniform to an array of number (stored as vec3)
  131687. * @param uniform defines the webGL uniform location where to store the value
  131688. * @param array defines the array of number to store
  131689. */
  131690. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  131691. /**
  131692. * Set the value of an uniform to an array of number (stored as vec4)
  131693. * @param uniform defines the webGL uniform location where to store the value
  131694. * @param array defines the array of number to store
  131695. */
  131696. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  131697. /**
  131698. * Set the value of an uniform to an array of float32 (stored as matrices)
  131699. * @param uniform defines the webGL uniform location where to store the value
  131700. * @param matrices defines the array of float32 to store
  131701. */
  131702. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  131703. /**
  131704. * Set the value of an uniform to a matrix (3x3)
  131705. * @param uniform defines the webGL uniform location where to store the value
  131706. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  131707. */
  131708. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  131709. /**
  131710. * Set the value of an uniform to a matrix (2x2)
  131711. * @param uniform defines the webGL uniform location where to store the value
  131712. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  131713. */
  131714. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  131715. /**
  131716. * Set the value of an uniform to a number (float)
  131717. * @param uniform defines the webGL uniform location where to store the value
  131718. * @param value defines the float number to store
  131719. */
  131720. setFloat(uniform: WebGLUniformLocation, value: number): void;
  131721. /**
  131722. * Set the value of an uniform to a vec2
  131723. * @param uniform defines the webGL uniform location where to store the value
  131724. * @param x defines the 1st component of the value
  131725. * @param y defines the 2nd component of the value
  131726. */
  131727. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  131728. /**
  131729. * Set the value of an uniform to a vec3
  131730. * @param uniform defines the webGL uniform location where to store the value
  131731. * @param x defines the 1st component of the value
  131732. * @param y defines the 2nd component of the value
  131733. * @param z defines the 3rd component of the value
  131734. */
  131735. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  131736. /**
  131737. * Set the value of an uniform to a boolean
  131738. * @param uniform defines the webGL uniform location where to store the value
  131739. * @param bool defines the boolean to store
  131740. */
  131741. setBool(uniform: WebGLUniformLocation, bool: number): void;
  131742. /**
  131743. * Set the value of an uniform to a vec4
  131744. * @param uniform defines the webGL uniform location where to store the value
  131745. * @param x defines the 1st component of the value
  131746. * @param y defines the 2nd component of the value
  131747. * @param z defines the 3rd component of the value
  131748. * @param w defines the 4th component of the value
  131749. */
  131750. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  131751. /**
  131752. * Sets the current alpha mode
  131753. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  131754. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  131755. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  131756. */
  131757. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  131758. /**
  131759. * Bind webGl buffers directly to the webGL context
  131760. * @param vertexBuffers defines the vertex buffer to bind
  131761. * @param indexBuffer defines the index buffer to bind
  131762. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  131763. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  131764. * @param effect defines the effect associated with the vertex buffer
  131765. */
  131766. bindBuffers(vertexBuffers: {
  131767. [key: string]: VertexBuffer;
  131768. }, indexBuffer: DataBuffer, effect: Effect): void;
  131769. /**
  131770. * Force the entire cache to be cleared
  131771. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  131772. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  131773. */
  131774. wipeCaches(bruteForce?: boolean): void;
  131775. /**
  131776. * Send a draw order
  131777. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  131778. * @param indexStart defines the starting index
  131779. * @param indexCount defines the number of index to draw
  131780. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  131781. */
  131782. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  131783. /**
  131784. * Draw a list of indexed primitives
  131785. * @param fillMode defines the primitive to use
  131786. * @param indexStart defines the starting index
  131787. * @param indexCount defines the number of index to draw
  131788. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  131789. */
  131790. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  131791. /**
  131792. * Draw a list of unindexed primitives
  131793. * @param fillMode defines the primitive to use
  131794. * @param verticesStart defines the index of first vertex to draw
  131795. * @param verticesCount defines the count of vertices to draw
  131796. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  131797. */
  131798. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  131799. /** @hidden */
  131800. _createTexture(): WebGLTexture;
  131801. /** @hidden */
  131802. _releaseTexture(texture: InternalTexture): void;
  131803. /**
  131804. * Usually called from Texture.ts.
  131805. * Passed information to create a WebGLTexture
  131806. * @param urlArg defines a value which contains one of the following:
  131807. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  131808. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  131809. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  131810. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  131811. * @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)
  131812. * @param scene needed for loading to the correct scene
  131813. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  131814. * @param onLoad optional callback to be called upon successful completion
  131815. * @param onError optional callback to be called upon failure
  131816. * @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
  131817. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  131818. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  131819. * @param forcedExtension defines the extension to use to pick the right loader
  131820. * @param mimeType defines an optional mime type
  131821. * @returns a InternalTexture for assignment back into BABYLON.Texture
  131822. */
  131823. 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;
  131824. /**
  131825. * Creates a new render target texture
  131826. * @param size defines the size of the texture
  131827. * @param options defines the options used to create the texture
  131828. * @returns a new render target texture stored in an InternalTexture
  131829. */
  131830. createRenderTargetTexture(size: any, options: boolean | RenderTargetCreationOptions): InternalTexture;
  131831. /**
  131832. * Update the sampling mode of a given texture
  131833. * @param samplingMode defines the required sampling mode
  131834. * @param texture defines the texture to update
  131835. */
  131836. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  131837. /**
  131838. * Binds the frame buffer to the specified texture.
  131839. * @param texture The texture to render to or null for the default canvas
  131840. * @param faceIndex The face of the texture to render to in case of cube texture
  131841. * @param requiredWidth The width of the target to render to
  131842. * @param requiredHeight The height of the target to render to
  131843. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  131844. * @param lodLevel defines le lod level to bind to the frame buffer
  131845. */
  131846. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  131847. /**
  131848. * Unbind the current render target texture from the webGL context
  131849. * @param texture defines the render target texture to unbind
  131850. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  131851. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  131852. */
  131853. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  131854. /**
  131855. * Creates a dynamic vertex buffer
  131856. * @param vertices the data for the dynamic vertex buffer
  131857. * @returns the new WebGL dynamic buffer
  131858. */
  131859. createDynamicVertexBuffer(vertices: FloatArray): DataBuffer;
  131860. /**
  131861. * Update the content of a dynamic texture
  131862. * @param texture defines the texture to update
  131863. * @param canvas defines the canvas containing the source
  131864. * @param invertY defines if data must be stored with Y axis inverted
  131865. * @param premulAlpha defines if alpha is stored as premultiplied
  131866. * @param format defines the format of the data
  131867. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  131868. */
  131869. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement, invertY: boolean, premulAlpha?: boolean, format?: number): void;
  131870. /**
  131871. * Gets a boolean indicating if all created effects are ready
  131872. * @returns true if all effects are ready
  131873. */
  131874. areAllEffectsReady(): boolean;
  131875. /**
  131876. * @hidden
  131877. * Get the current error code of the webGL context
  131878. * @returns the error code
  131879. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  131880. */
  131881. getError(): number;
  131882. /** @hidden */
  131883. _getUnpackAlignement(): number;
  131884. /** @hidden */
  131885. _unpackFlipY(value: boolean): void;
  131886. /**
  131887. * Update a dynamic index buffer
  131888. * @param indexBuffer defines the target index buffer
  131889. * @param indices defines the data to update
  131890. * @param offset defines the offset in the target index buffer where update should start
  131891. */
  131892. updateDynamicIndexBuffer(indexBuffer: WebGLBuffer, indices: IndicesArray, offset?: number): void;
  131893. /**
  131894. * Updates a dynamic vertex buffer.
  131895. * @param vertexBuffer the vertex buffer to update
  131896. * @param vertices the data used to update the vertex buffer
  131897. * @param byteOffset the byte offset of the data (optional)
  131898. * @param byteLength the byte length of the data (optional)
  131899. */
  131900. updateDynamicVertexBuffer(vertexBuffer: WebGLBuffer, vertices: FloatArray, byteOffset?: number, byteLength?: number): void;
  131901. /** @hidden */
  131902. _bindTextureDirectly(target: number, texture: InternalTexture): boolean;
  131903. /** @hidden */
  131904. _bindTexture(channel: number, texture: InternalTexture): void;
  131905. protected _deleteBuffer(buffer: WebGLBuffer): void;
  131906. /**
  131907. * 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
  131908. */
  131909. releaseEffects(): void;
  131910. displayLoadingUI(): void;
  131911. hideLoadingUI(): void;
  131912. /** @hidden */
  131913. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  131914. /** @hidden */
  131915. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  131916. /** @hidden */
  131917. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  131918. /** @hidden */
  131919. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  131920. }
  131921. }
  131922. declare module BABYLON {
  131923. /**
  131924. * @hidden
  131925. **/
  131926. export class _TimeToken {
  131927. _startTimeQuery: Nullable<WebGLQuery>;
  131928. _endTimeQuery: Nullable<WebGLQuery>;
  131929. _timeElapsedQuery: Nullable<WebGLQuery>;
  131930. _timeElapsedQueryEnded: boolean;
  131931. }
  131932. }
  131933. declare module BABYLON {
  131934. /** @hidden */
  131935. export class _OcclusionDataStorage {
  131936. /** @hidden */
  131937. occlusionInternalRetryCounter: number;
  131938. /** @hidden */
  131939. isOcclusionQueryInProgress: boolean;
  131940. /** @hidden */
  131941. isOccluded: boolean;
  131942. /** @hidden */
  131943. occlusionRetryCount: number;
  131944. /** @hidden */
  131945. occlusionType: number;
  131946. /** @hidden */
  131947. occlusionQueryAlgorithmType: number;
  131948. }
  131949. interface Engine {
  131950. /**
  131951. * Create a new webGL query (you must be sure that queries are supported by checking getCaps() function)
  131952. * @return the new query
  131953. */
  131954. createQuery(): WebGLQuery;
  131955. /**
  131956. * Delete and release a webGL query
  131957. * @param query defines the query to delete
  131958. * @return the current engine
  131959. */
  131960. deleteQuery(query: WebGLQuery): Engine;
  131961. /**
  131962. * Check if a given query has resolved and got its value
  131963. * @param query defines the query to check
  131964. * @returns true if the query got its value
  131965. */
  131966. isQueryResultAvailable(query: WebGLQuery): boolean;
  131967. /**
  131968. * Gets the value of a given query
  131969. * @param query defines the query to check
  131970. * @returns the value of the query
  131971. */
  131972. getQueryResult(query: WebGLQuery): number;
  131973. /**
  131974. * Initiates an occlusion query
  131975. * @param algorithmType defines the algorithm to use
  131976. * @param query defines the query to use
  131977. * @returns the current engine
  131978. * @see https://doc.babylonjs.com/features/occlusionquery
  131979. */
  131980. beginOcclusionQuery(algorithmType: number, query: WebGLQuery): Engine;
  131981. /**
  131982. * Ends an occlusion query
  131983. * @see https://doc.babylonjs.com/features/occlusionquery
  131984. * @param algorithmType defines the algorithm to use
  131985. * @returns the current engine
  131986. */
  131987. endOcclusionQuery(algorithmType: number): Engine;
  131988. /**
  131989. * Starts a time query (used to measure time spent by the GPU on a specific frame)
  131990. * Please note that only one query can be issued at a time
  131991. * @returns a time token used to track the time span
  131992. */
  131993. startTimeQuery(): Nullable<_TimeToken>;
  131994. /**
  131995. * Ends a time query
  131996. * @param token defines the token used to measure the time span
  131997. * @returns the time spent (in ns)
  131998. */
  131999. endTimeQuery(token: _TimeToken): int;
  132000. /** @hidden */
  132001. _currentNonTimestampToken: Nullable<_TimeToken>;
  132002. /** @hidden */
  132003. _createTimeQuery(): WebGLQuery;
  132004. /** @hidden */
  132005. _deleteTimeQuery(query: WebGLQuery): void;
  132006. /** @hidden */
  132007. _getGlAlgorithmType(algorithmType: number): number;
  132008. /** @hidden */
  132009. _getTimeQueryResult(query: WebGLQuery): any;
  132010. /** @hidden */
  132011. _getTimeQueryAvailability(query: WebGLQuery): any;
  132012. }
  132013. interface AbstractMesh {
  132014. /**
  132015. * Backing filed
  132016. * @hidden
  132017. */
  132018. __occlusionDataStorage: _OcclusionDataStorage;
  132019. /**
  132020. * Access property
  132021. * @hidden
  132022. */
  132023. _occlusionDataStorage: _OcclusionDataStorage;
  132024. /**
  132025. * 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.
  132026. * The default value is -1 which means don't break the query and wait till the result
  132027. * @see https://doc.babylonjs.com/features/occlusionquery
  132028. */
  132029. occlusionRetryCount: number;
  132030. /**
  132031. * 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:
  132032. * * OCCLUSION_TYPE_NONE (Default Value): this option means no occlusion query whith the Mesh.
  132033. * * OCCLUSION_TYPE_OPTIMISTIC: this option is means use occlusion query and if occlusionRetryCount is reached and the query is broken show the mesh.
  132034. * * 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.
  132035. * @see https://doc.babylonjs.com/features/occlusionquery
  132036. */
  132037. occlusionType: number;
  132038. /**
  132039. * This property determines the type of occlusion query algorithm to run in WebGl, you can use:
  132040. * * AbstractMesh.OCCLUSION_ALGORITHM_TYPE_ACCURATE which is mapped to GL_ANY_SAMPLES_PASSED.
  132041. * * 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.
  132042. * @see https://doc.babylonjs.com/features/occlusionquery
  132043. */
  132044. occlusionQueryAlgorithmType: number;
  132045. /**
  132046. * 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
  132047. * @see https://doc.babylonjs.com/features/occlusionquery
  132048. */
  132049. isOccluded: boolean;
  132050. /**
  132051. * Flag to check the progress status of the query
  132052. * @see https://doc.babylonjs.com/features/occlusionquery
  132053. */
  132054. isOcclusionQueryInProgress: boolean;
  132055. }
  132056. }
  132057. declare module BABYLON {
  132058. /** @hidden */
  132059. export var _forceTransformFeedbackToBundle: boolean;
  132060. interface Engine {
  132061. /**
  132062. * Creates a webGL transform feedback object
  132063. * Please makes sure to check webGLVersion property to check if you are running webGL 2+
  132064. * @returns the webGL transform feedback object
  132065. */
  132066. createTransformFeedback(): WebGLTransformFeedback;
  132067. /**
  132068. * Delete a webGL transform feedback object
  132069. * @param value defines the webGL transform feedback object to delete
  132070. */
  132071. deleteTransformFeedback(value: WebGLTransformFeedback): void;
  132072. /**
  132073. * Bind a webGL transform feedback object to the webgl context
  132074. * @param value defines the webGL transform feedback object to bind
  132075. */
  132076. bindTransformFeedback(value: Nullable<WebGLTransformFeedback>): void;
  132077. /**
  132078. * Begins a transform feedback operation
  132079. * @param usePoints defines if points or triangles must be used
  132080. */
  132081. beginTransformFeedback(usePoints: boolean): void;
  132082. /**
  132083. * Ends a transform feedback operation
  132084. */
  132085. endTransformFeedback(): void;
  132086. /**
  132087. * Specify the varyings to use with transform feedback
  132088. * @param program defines the associated webGL program
  132089. * @param value defines the list of strings representing the varying names
  132090. */
  132091. setTranformFeedbackVaryings(program: WebGLProgram, value: string[]): void;
  132092. /**
  132093. * Bind a webGL buffer for a transform feedback operation
  132094. * @param value defines the webGL buffer to bind
  132095. */
  132096. bindTransformFeedbackBuffer(value: Nullable<DataBuffer>): void;
  132097. }
  132098. }
  132099. declare module BABYLON {
  132100. /**
  132101. * Class used to define an additional view for the engine
  132102. * @see https://doc.babylonjs.com/how_to/multi_canvases
  132103. */
  132104. export class EngineView {
  132105. /** Defines the canvas where to render the view */
  132106. target: HTMLCanvasElement;
  132107. /** Defines an optional camera used to render the view (will use active camera else) */
  132108. camera?: Camera;
  132109. }
  132110. interface Engine {
  132111. /**
  132112. * Gets or sets the HTML element to use for attaching events
  132113. */
  132114. inputElement: Nullable<HTMLElement>;
  132115. /**
  132116. * Gets the current engine view
  132117. * @see https://doc.babylonjs.com/how_to/multi_canvases
  132118. */
  132119. activeView: Nullable<EngineView>;
  132120. /** Gets or sets the list of views */
  132121. views: EngineView[];
  132122. /**
  132123. * Register a new child canvas
  132124. * @param canvas defines the canvas to register
  132125. * @param camera defines an optional camera to use with this canvas (it will overwrite the scene.camera for this view)
  132126. * @returns the associated view
  132127. */
  132128. registerView(canvas: HTMLCanvasElement, camera?: Camera): EngineView;
  132129. /**
  132130. * Remove a registered child canvas
  132131. * @param canvas defines the canvas to remove
  132132. * @returns the current engine
  132133. */
  132134. unRegisterView(canvas: HTMLCanvasElement): Engine;
  132135. }
  132136. }
  132137. declare module BABYLON {
  132138. interface Engine {
  132139. /** @hidden */
  132140. _excludedCompressedTextures: string[];
  132141. /** @hidden */
  132142. _textureFormatInUse: string;
  132143. /**
  132144. * Gets the list of texture formats supported
  132145. */
  132146. readonly texturesSupported: Array<string>;
  132147. /**
  132148. * Gets the texture format in use
  132149. */
  132150. readonly textureFormatInUse: Nullable<string>;
  132151. /**
  132152. * Set the compressed texture extensions or file names to skip.
  132153. *
  132154. * @param skippedFiles defines the list of those texture files you want to skip
  132155. * Example: [".dds", ".env", "myfile.png"]
  132156. */
  132157. setCompressedTextureExclusions(skippedFiles: Array<string>): void;
  132158. /**
  132159. * Set the compressed texture format to use, based on the formats you have, and the formats
  132160. * supported by the hardware / browser.
  132161. *
  132162. * Khronos Texture Container (.ktx) files are used to support this. This format has the
  132163. * advantage of being specifically designed for OpenGL. Header elements directly correspond
  132164. * to API arguments needed to compressed textures. This puts the burden on the container
  132165. * generator to house the arcane code for determining these for current & future formats.
  132166. *
  132167. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  132168. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  132169. *
  132170. * Note: The result of this call is not taken into account when a texture is base64.
  132171. *
  132172. * @param formatsAvailable defines the list of those format families you have created
  132173. * on your server. Syntax: '-' + format family + '.ktx'. (Case and order do not matter.)
  132174. *
  132175. * Current families are astc, dxt, pvrtc, etc2, & etc1.
  132176. * @returns The extension selected.
  132177. */
  132178. setTextureFormatToUse(formatsAvailable: Array<string>): Nullable<string>;
  132179. }
  132180. }
  132181. declare module BABYLON {
  132182. /**
  132183. * CubeMap information grouping all the data for each faces as well as the cubemap size.
  132184. */
  132185. export interface CubeMapInfo {
  132186. /**
  132187. * The pixel array for the front face.
  132188. * This is stored in format, left to right, up to down format.
  132189. */
  132190. front: Nullable<ArrayBufferView>;
  132191. /**
  132192. * The pixel array for the back face.
  132193. * This is stored in format, left to right, up to down format.
  132194. */
  132195. back: Nullable<ArrayBufferView>;
  132196. /**
  132197. * The pixel array for the left face.
  132198. * This is stored in format, left to right, up to down format.
  132199. */
  132200. left: Nullable<ArrayBufferView>;
  132201. /**
  132202. * The pixel array for the right face.
  132203. * This is stored in format, left to right, up to down format.
  132204. */
  132205. right: Nullable<ArrayBufferView>;
  132206. /**
  132207. * The pixel array for the up face.
  132208. * This is stored in format, left to right, up to down format.
  132209. */
  132210. up: Nullable<ArrayBufferView>;
  132211. /**
  132212. * The pixel array for the down face.
  132213. * This is stored in format, left to right, up to down format.
  132214. */
  132215. down: Nullable<ArrayBufferView>;
  132216. /**
  132217. * The size of the cubemap stored.
  132218. *
  132219. * Each faces will be size * size pixels.
  132220. */
  132221. size: number;
  132222. /**
  132223. * The format of the texture.
  132224. *
  132225. * RGBA, RGB.
  132226. */
  132227. format: number;
  132228. /**
  132229. * The type of the texture data.
  132230. *
  132231. * UNSIGNED_INT, FLOAT.
  132232. */
  132233. type: number;
  132234. /**
  132235. * Specifies whether the texture is in gamma space.
  132236. */
  132237. gammaSpace: boolean;
  132238. }
  132239. /**
  132240. * Helper class useful to convert panorama picture to their cubemap representation in 6 faces.
  132241. */
  132242. export class PanoramaToCubeMapTools {
  132243. private static FACE_LEFT;
  132244. private static FACE_RIGHT;
  132245. private static FACE_FRONT;
  132246. private static FACE_BACK;
  132247. private static FACE_DOWN;
  132248. private static FACE_UP;
  132249. /**
  132250. * Converts a panorma stored in RGB right to left up to down format into a cubemap (6 faces).
  132251. *
  132252. * @param float32Array The source data.
  132253. * @param inputWidth The width of the input panorama.
  132254. * @param inputHeight The height of the input panorama.
  132255. * @param size The willing size of the generated cubemap (each faces will be size * size pixels)
  132256. * @return The cubemap data
  132257. */
  132258. static ConvertPanoramaToCubemap(float32Array: Float32Array, inputWidth: number, inputHeight: number, size: number): CubeMapInfo;
  132259. private static CreateCubemapTexture;
  132260. private static CalcProjectionSpherical;
  132261. }
  132262. }
  132263. declare module BABYLON {
  132264. /**
  132265. * Helper class dealing with the extraction of spherical polynomial dataArray
  132266. * from a cube map.
  132267. */
  132268. export class CubeMapToSphericalPolynomialTools {
  132269. private static FileFaces;
  132270. /**
  132271. * Converts a texture to the according Spherical Polynomial data.
  132272. * This extracts the first 3 orders only as they are the only one used in the lighting.
  132273. *
  132274. * @param texture The texture to extract the information from.
  132275. * @return The Spherical Polynomial data.
  132276. */
  132277. static ConvertCubeMapTextureToSphericalPolynomial(texture: BaseTexture): Nullable<SphericalPolynomial>;
  132278. /**
  132279. * Converts a cubemap to the according Spherical Polynomial data.
  132280. * This extracts the first 3 orders only as they are the only one used in the lighting.
  132281. *
  132282. * @param cubeInfo The Cube map to extract the information from.
  132283. * @return The Spherical Polynomial data.
  132284. */
  132285. static ConvertCubeMapToSphericalPolynomial(cubeInfo: CubeMapInfo): SphericalPolynomial;
  132286. }
  132287. }
  132288. declare module BABYLON {
  132289. interface BaseTexture {
  132290. /**
  132291. * Get the polynomial representation of the texture data.
  132292. * This is mainly use as a fast way to recover IBL Diffuse irradiance data.
  132293. * @see https://learnopengl.com/PBR/IBL/Diffuse-irradiance
  132294. */
  132295. sphericalPolynomial: Nullable<SphericalPolynomial>;
  132296. }
  132297. }
  132298. declare module BABYLON {
  132299. /** @hidden */
  132300. export var rgbdEncodePixelShader: {
  132301. name: string;
  132302. shader: string;
  132303. };
  132304. }
  132305. declare module BABYLON {
  132306. /** @hidden */
  132307. export var rgbdDecodePixelShader: {
  132308. name: string;
  132309. shader: string;
  132310. };
  132311. }
  132312. declare module BABYLON {
  132313. /**
  132314. * Raw texture data and descriptor sufficient for WebGL texture upload
  132315. */
  132316. export interface EnvironmentTextureInfo {
  132317. /**
  132318. * Version of the environment map
  132319. */
  132320. version: number;
  132321. /**
  132322. * Width of image
  132323. */
  132324. width: number;
  132325. /**
  132326. * Irradiance information stored in the file.
  132327. */
  132328. irradiance: any;
  132329. /**
  132330. * Specular information stored in the file.
  132331. */
  132332. specular: any;
  132333. }
  132334. /**
  132335. * Defines One Image in the file. It requires only the position in the file
  132336. * as well as the length.
  132337. */
  132338. interface BufferImageData {
  132339. /**
  132340. * Length of the image data.
  132341. */
  132342. length: number;
  132343. /**
  132344. * Position of the data from the null terminator delimiting the end of the JSON.
  132345. */
  132346. position: number;
  132347. }
  132348. /**
  132349. * Defines the specular data enclosed in the file.
  132350. * This corresponds to the version 1 of the data.
  132351. */
  132352. export interface EnvironmentTextureSpecularInfoV1 {
  132353. /**
  132354. * Defines where the specular Payload is located. It is a runtime value only not stored in the file.
  132355. */
  132356. specularDataPosition?: number;
  132357. /**
  132358. * This contains all the images data needed to reconstruct the cubemap.
  132359. */
  132360. mipmaps: Array<BufferImageData>;
  132361. /**
  132362. * Defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness.
  132363. */
  132364. lodGenerationScale: number;
  132365. }
  132366. /**
  132367. * Sets of helpers addressing the serialization and deserialization of environment texture
  132368. * stored in a BabylonJS env file.
  132369. * Those files are usually stored as .env files.
  132370. */
  132371. export class EnvironmentTextureTools {
  132372. /**
  132373. * Magic number identifying the env file.
  132374. */
  132375. private static _MagicBytes;
  132376. /**
  132377. * Gets the environment info from an env file.
  132378. * @param data The array buffer containing the .env bytes.
  132379. * @returns the environment file info (the json header) if successfully parsed.
  132380. */
  132381. static GetEnvInfo(data: ArrayBufferView): Nullable<EnvironmentTextureInfo>;
  132382. /**
  132383. * Creates an environment texture from a loaded cube texture.
  132384. * @param texture defines the cube texture to convert in env file
  132385. * @return a promise containing the environment data if succesfull.
  132386. */
  132387. static CreateEnvTextureAsync(texture: BaseTexture): Promise<ArrayBuffer>;
  132388. /**
  132389. * Creates a JSON representation of the spherical data.
  132390. * @param texture defines the texture containing the polynomials
  132391. * @return the JSON representation of the spherical info
  132392. */
  132393. private static _CreateEnvTextureIrradiance;
  132394. /**
  132395. * Creates the ArrayBufferViews used for initializing environment texture image data.
  132396. * @param data the image data
  132397. * @param info parameters that determine what views will be created for accessing the underlying buffer
  132398. * @return the views described by info providing access to the underlying buffer
  132399. */
  132400. static CreateImageDataArrayBufferViews(data: ArrayBufferView, info: EnvironmentTextureInfo): Array<Array<ArrayBufferView>>;
  132401. /**
  132402. * Uploads the texture info contained in the env file to the GPU.
  132403. * @param texture defines the internal texture to upload to
  132404. * @param data defines the data to load
  132405. * @param info defines the texture info retrieved through the GetEnvInfo method
  132406. * @returns a promise
  132407. */
  132408. static UploadEnvLevelsAsync(texture: InternalTexture, data: ArrayBufferView, info: EnvironmentTextureInfo): Promise<void>;
  132409. private static _OnImageReadyAsync;
  132410. /**
  132411. * Uploads the levels of image data to the GPU.
  132412. * @param texture defines the internal texture to upload to
  132413. * @param imageData defines the array buffer views of image data [mipmap][face]
  132414. * @returns a promise
  132415. */
  132416. static UploadLevelsAsync(texture: InternalTexture, imageData: ArrayBufferView[][]): Promise<void>;
  132417. /**
  132418. * Uploads spherical polynomials information to the texture.
  132419. * @param texture defines the texture we are trying to upload the information to
  132420. * @param info defines the environment texture info retrieved through the GetEnvInfo method
  132421. */
  132422. static UploadEnvSpherical(texture: InternalTexture, info: EnvironmentTextureInfo): void;
  132423. /** @hidden */
  132424. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  132425. }
  132426. }
  132427. declare module BABYLON {
  132428. /**
  132429. * Class used to inline functions in shader code
  132430. */
  132431. export class ShaderCodeInliner {
  132432. private static readonly _RegexpFindFunctionNameAndType;
  132433. private _sourceCode;
  132434. private _functionDescr;
  132435. private _numMaxIterations;
  132436. /** Gets or sets the token used to mark the functions to inline */
  132437. inlineToken: string;
  132438. /** Gets or sets the debug mode */
  132439. debug: boolean;
  132440. /** Gets the code after the inlining process */
  132441. get code(): string;
  132442. /**
  132443. * Initializes the inliner
  132444. * @param sourceCode shader code source to inline
  132445. * @param numMaxIterations maximum number of iterations (used to detect recursive calls)
  132446. */
  132447. constructor(sourceCode: string, numMaxIterations?: number);
  132448. /**
  132449. * Start the processing of the shader code
  132450. */
  132451. processCode(): void;
  132452. private _collectFunctions;
  132453. private _processInlining;
  132454. private _extractBetweenMarkers;
  132455. private _skipWhitespaces;
  132456. private _removeComments;
  132457. private _replaceFunctionCallsByCode;
  132458. private _findBackward;
  132459. private _escapeRegExp;
  132460. private _replaceNames;
  132461. }
  132462. }
  132463. declare module BABYLON {
  132464. /**
  132465. * Container for accessors for natively-stored mesh data buffers.
  132466. */
  132467. class NativeDataBuffer extends DataBuffer {
  132468. /**
  132469. * Accessor value used to identify/retrieve a natively-stored index buffer.
  132470. */
  132471. nativeIndexBuffer?: any;
  132472. /**
  132473. * Accessor value used to identify/retrieve a natively-stored vertex buffer.
  132474. */
  132475. nativeVertexBuffer?: any;
  132476. }
  132477. /** @hidden */
  132478. class NativeTexture extends InternalTexture {
  132479. getInternalTexture(): InternalTexture;
  132480. getViewCount(): number;
  132481. }
  132482. /** @hidden */
  132483. export class NativeEngine extends Engine {
  132484. private readonly _native;
  132485. /** Defines the invalid handle returned by bgfx when resource creation goes wrong */
  132486. private readonly INVALID_HANDLE;
  132487. private _boundBuffersVertexArray;
  132488. getHardwareScalingLevel(): number;
  132489. constructor();
  132490. dispose(): void;
  132491. /**
  132492. * Can be used to override the current requestAnimationFrame requester.
  132493. * @hidden
  132494. */
  132495. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  132496. /**
  132497. * Override default engine behavior.
  132498. * @param color
  132499. * @param backBuffer
  132500. * @param depth
  132501. * @param stencil
  132502. */
  132503. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  132504. /**
  132505. * Gets host document
  132506. * @returns the host document object
  132507. */
  132508. getHostDocument(): Nullable<Document>;
  132509. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  132510. createIndexBuffer(indices: IndicesArray, updateable?: boolean): NativeDataBuffer;
  132511. createVertexBuffer(data: DataArray, updateable?: boolean): NativeDataBuffer;
  132512. protected _recordVertexArrayObject(vertexArray: any, vertexBuffers: {
  132513. [key: string]: VertexBuffer;
  132514. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): void;
  132515. bindBuffers(vertexBuffers: {
  132516. [key: string]: VertexBuffer;
  132517. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): void;
  132518. recordVertexArrayObject(vertexBuffers: {
  132519. [key: string]: VertexBuffer;
  132520. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): WebGLVertexArrayObject;
  132521. bindVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  132522. releaseVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  132523. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  132524. /**
  132525. * Draw a list of indexed primitives
  132526. * @param fillMode defines the primitive to use
  132527. * @param indexStart defines the starting index
  132528. * @param indexCount defines the number of index to draw
  132529. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  132530. */
  132531. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  132532. /**
  132533. * Draw a list of unindexed primitives
  132534. * @param fillMode defines the primitive to use
  132535. * @param verticesStart defines the index of first vertex to draw
  132536. * @param verticesCount defines the count of vertices to draw
  132537. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  132538. */
  132539. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  132540. createPipelineContext(): IPipelineContext;
  132541. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  132542. /** @hidden */
  132543. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  132544. /** @hidden */
  132545. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  132546. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  132547. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  132548. protected _setProgram(program: WebGLProgram): void;
  132549. _releaseEffect(effect: Effect): void;
  132550. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  132551. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): WebGLUniformLocation[];
  132552. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  132553. bindSamplers(effect: Effect): void;
  132554. setMatrix(uniform: WebGLUniformLocation, matrix: Matrix): void;
  132555. getRenderWidth(useScreen?: boolean): number;
  132556. getRenderHeight(useScreen?: boolean): number;
  132557. setViewport(viewport: Viewport, requiredWidth?: number, requiredHeight?: number): void;
  132558. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  132559. /**
  132560. * Set the z offset to apply to current rendering
  132561. * @param value defines the offset to apply
  132562. */
  132563. setZOffset(value: number): void;
  132564. /**
  132565. * Gets the current value of the zOffset
  132566. * @returns the current zOffset state
  132567. */
  132568. getZOffset(): number;
  132569. /**
  132570. * Enable or disable depth buffering
  132571. * @param enable defines the state to set
  132572. */
  132573. setDepthBuffer(enable: boolean): void;
  132574. /**
  132575. * Gets a boolean indicating if depth writing is enabled
  132576. * @returns the current depth writing state
  132577. */
  132578. getDepthWrite(): boolean;
  132579. /**
  132580. * Enable or disable depth writing
  132581. * @param enable defines the state to set
  132582. */
  132583. setDepthWrite(enable: boolean): void;
  132584. /**
  132585. * Enable or disable color writing
  132586. * @param enable defines the state to set
  132587. */
  132588. setColorWrite(enable: boolean): void;
  132589. /**
  132590. * Gets a boolean indicating if color writing is enabled
  132591. * @returns the current color writing state
  132592. */
  132593. getColorWrite(): boolean;
  132594. /**
  132595. * Sets alpha constants used by some alpha blending modes
  132596. * @param r defines the red component
  132597. * @param g defines the green component
  132598. * @param b defines the blue component
  132599. * @param a defines the alpha component
  132600. */
  132601. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  132602. /**
  132603. * Sets the current alpha mode
  132604. * @param mode defines the mode to use (one of the BABYLON.Constants.ALPHA_XXX)
  132605. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  132606. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  132607. */
  132608. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  132609. /**
  132610. * Gets the current alpha mode
  132611. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  132612. * @returns the current alpha mode
  132613. */
  132614. getAlphaMode(): number;
  132615. setInt(uniform: WebGLUniformLocation, int: number): void;
  132616. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  132617. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  132618. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  132619. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  132620. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  132621. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  132622. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  132623. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  132624. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  132625. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  132626. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  132627. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  132628. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  132629. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  132630. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  132631. setFloat(uniform: WebGLUniformLocation, value: number): void;
  132632. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  132633. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  132634. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  132635. setColor3(uniform: WebGLUniformLocation, color3: Color3): void;
  132636. setColor4(uniform: WebGLUniformLocation, color3: Color3, alpha: number): void;
  132637. wipeCaches(bruteForce?: boolean): void;
  132638. _createTexture(): WebGLTexture;
  132639. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  132640. /**
  132641. * Usually called from Texture.ts.
  132642. * Passed information to create a WebGLTexture
  132643. * @param url defines a value which contains one of the following:
  132644. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  132645. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  132646. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  132647. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  132648. * @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)
  132649. * @param scene needed for loading to the correct scene
  132650. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  132651. * @param onLoad optional callback to be called upon successful completion
  132652. * @param onError optional callback to be called upon failure
  132653. * @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
  132654. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  132655. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  132656. * @param forcedExtension defines the extension to use to pick the right loader
  132657. * @param mimeType defines an optional mime type
  132658. * @returns a InternalTexture for assignment back into BABYLON.Texture
  132659. */
  132660. 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;
  132661. /**
  132662. * Creates a cube texture
  132663. * @param rootUrl defines the url where the files to load is located
  132664. * @param scene defines the current scene
  132665. * @param files defines the list of files to load (1 per face)
  132666. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  132667. * @param onLoad defines an optional callback raised when the texture is loaded
  132668. * @param onError defines an optional callback raised if there is an issue to load the texture
  132669. * @param format defines the format of the data
  132670. * @param forcedExtension defines the extension to use to pick the right loader
  132671. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  132672. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  132673. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  132674. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  132675. * @returns the cube texture as an InternalTexture
  132676. */
  132677. 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;
  132678. private _getSamplingFilter;
  132679. private static _GetNativeTextureFormat;
  132680. createRenderTargetTexture(size: number | {
  132681. width: number;
  132682. height: number;
  132683. }, options: boolean | RenderTargetCreationOptions): NativeTexture;
  132684. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  132685. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  132686. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  132687. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  132688. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  132689. /**
  132690. * Updates a dynamic vertex buffer.
  132691. * @param vertexBuffer the vertex buffer to update
  132692. * @param data the data used to update the vertex buffer
  132693. * @param byteOffset the byte offset of the data (optional)
  132694. * @param byteLength the byte length of the data (optional)
  132695. */
  132696. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  132697. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  132698. private _updateAnisotropicLevel;
  132699. private _getAddressMode;
  132700. /** @hidden */
  132701. _bindTexture(channel: number, texture: InternalTexture): void;
  132702. protected _deleteBuffer(buffer: NativeDataBuffer): void;
  132703. releaseEffects(): void;
  132704. /** @hidden */
  132705. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  132706. /** @hidden */
  132707. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  132708. /** @hidden */
  132709. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  132710. /** @hidden */
  132711. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  132712. }
  132713. }
  132714. declare module BABYLON {
  132715. /**
  132716. * Gather the list of clipboard event types as constants.
  132717. */
  132718. export class ClipboardEventTypes {
  132719. /**
  132720. * The clipboard event is fired when a copy command is active (pressed).
  132721. */
  132722. static readonly COPY: number;
  132723. /**
  132724. * The clipboard event is fired when a cut command is active (pressed).
  132725. */
  132726. static readonly CUT: number;
  132727. /**
  132728. * The clipboard event is fired when a paste command is active (pressed).
  132729. */
  132730. static readonly PASTE: number;
  132731. }
  132732. /**
  132733. * This class is used to store clipboard related info for the onClipboardObservable event.
  132734. */
  132735. export class ClipboardInfo {
  132736. /**
  132737. * Defines the type of event (BABYLON.ClipboardEventTypes)
  132738. */
  132739. type: number;
  132740. /**
  132741. * Defines the related dom event
  132742. */
  132743. event: ClipboardEvent;
  132744. /**
  132745. *Creates an instance of ClipboardInfo.
  132746. * @param type Defines the type of event (BABYLON.ClipboardEventTypes)
  132747. * @param event Defines the related dom event
  132748. */
  132749. constructor(
  132750. /**
  132751. * Defines the type of event (BABYLON.ClipboardEventTypes)
  132752. */
  132753. type: number,
  132754. /**
  132755. * Defines the related dom event
  132756. */
  132757. event: ClipboardEvent);
  132758. /**
  132759. * Get the clipboard event's type from the keycode.
  132760. * @param keyCode Defines the keyCode for the current keyboard event.
  132761. * @return {number}
  132762. */
  132763. static GetTypeFromCharacter(keyCode: number): number;
  132764. }
  132765. }
  132766. declare module BABYLON {
  132767. /**
  132768. * Google Daydream controller
  132769. */
  132770. export class DaydreamController extends WebVRController {
  132771. /**
  132772. * Base Url for the controller model.
  132773. */
  132774. static MODEL_BASE_URL: string;
  132775. /**
  132776. * File name for the controller model.
  132777. */
  132778. static MODEL_FILENAME: string;
  132779. /**
  132780. * Gamepad Id prefix used to identify Daydream Controller.
  132781. */
  132782. static readonly GAMEPAD_ID_PREFIX: string;
  132783. /**
  132784. * Creates a new DaydreamController from a gamepad
  132785. * @param vrGamepad the gamepad that the controller should be created from
  132786. */
  132787. constructor(vrGamepad: any);
  132788. /**
  132789. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  132790. * @param scene scene in which to add meshes
  132791. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  132792. */
  132793. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  132794. /**
  132795. * Called once for each button that changed state since the last frame
  132796. * @param buttonIdx Which button index changed
  132797. * @param state New state of the button
  132798. * @param changes Which properties on the state changed since last frame
  132799. */
  132800. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  132801. }
  132802. }
  132803. declare module BABYLON {
  132804. /**
  132805. * Gear VR Controller
  132806. */
  132807. export class GearVRController extends WebVRController {
  132808. /**
  132809. * Base Url for the controller model.
  132810. */
  132811. static MODEL_BASE_URL: string;
  132812. /**
  132813. * File name for the controller model.
  132814. */
  132815. static MODEL_FILENAME: string;
  132816. /**
  132817. * Gamepad Id prefix used to identify this controller.
  132818. */
  132819. static readonly GAMEPAD_ID_PREFIX: string;
  132820. private readonly _buttonIndexToObservableNameMap;
  132821. /**
  132822. * Creates a new GearVRController from a gamepad
  132823. * @param vrGamepad the gamepad that the controller should be created from
  132824. */
  132825. constructor(vrGamepad: any);
  132826. /**
  132827. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  132828. * @param scene scene in which to add meshes
  132829. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  132830. */
  132831. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  132832. /**
  132833. * Called once for each button that changed state since the last frame
  132834. * @param buttonIdx Which button index changed
  132835. * @param state New state of the button
  132836. * @param changes Which properties on the state changed since last frame
  132837. */
  132838. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  132839. }
  132840. }
  132841. declare module BABYLON {
  132842. /**
  132843. * Generic Controller
  132844. */
  132845. export class GenericController extends WebVRController {
  132846. /**
  132847. * Base Url for the controller model.
  132848. */
  132849. static readonly MODEL_BASE_URL: string;
  132850. /**
  132851. * File name for the controller model.
  132852. */
  132853. static readonly MODEL_FILENAME: string;
  132854. /**
  132855. * Creates a new GenericController from a gamepad
  132856. * @param vrGamepad the gamepad that the controller should be created from
  132857. */
  132858. constructor(vrGamepad: any);
  132859. /**
  132860. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  132861. * @param scene scene in which to add meshes
  132862. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  132863. */
  132864. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  132865. /**
  132866. * Called once for each button that changed state since the last frame
  132867. * @param buttonIdx Which button index changed
  132868. * @param state New state of the button
  132869. * @param changes Which properties on the state changed since last frame
  132870. */
  132871. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  132872. }
  132873. }
  132874. declare module BABYLON {
  132875. /**
  132876. * Oculus Touch Controller
  132877. */
  132878. export class OculusTouchController extends WebVRController {
  132879. /**
  132880. * Base Url for the controller model.
  132881. */
  132882. static MODEL_BASE_URL: string;
  132883. /**
  132884. * File name for the left controller model.
  132885. */
  132886. static MODEL_LEFT_FILENAME: string;
  132887. /**
  132888. * File name for the right controller model.
  132889. */
  132890. static MODEL_RIGHT_FILENAME: string;
  132891. /**
  132892. * Base Url for the Quest controller model.
  132893. */
  132894. static QUEST_MODEL_BASE_URL: string;
  132895. /**
  132896. * @hidden
  132897. * If the controllers are running on a device that needs the updated Quest controller models
  132898. */
  132899. static _IsQuest: boolean;
  132900. /**
  132901. * Fired when the secondary trigger on this controller is modified
  132902. */
  132903. onSecondaryTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  132904. /**
  132905. * Fired when the thumb rest on this controller is modified
  132906. */
  132907. onThumbRestChangedObservable: Observable<ExtendedGamepadButton>;
  132908. /**
  132909. * Creates a new OculusTouchController from a gamepad
  132910. * @param vrGamepad the gamepad that the controller should be created from
  132911. */
  132912. constructor(vrGamepad: any);
  132913. /**
  132914. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  132915. * @param scene scene in which to add meshes
  132916. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  132917. */
  132918. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  132919. /**
  132920. * Fired when the A button on this controller is modified
  132921. */
  132922. get onAButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132923. /**
  132924. * Fired when the B button on this controller is modified
  132925. */
  132926. get onBButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132927. /**
  132928. * Fired when the X button on this controller is modified
  132929. */
  132930. get onXButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132931. /**
  132932. * Fired when the Y button on this controller is modified
  132933. */
  132934. get onYButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132935. /**
  132936. * Called once for each button that changed state since the last frame
  132937. * 0) thumb stick (touch, press, value = pressed (0,1)). value is in this.leftStick
  132938. * 1) index trigger (touch (?), press (only when value > 0.1), value 0 to 1)
  132939. * 2) secondary trigger (same)
  132940. * 3) A (right) X (left), touch, pressed = value
  132941. * 4) B / Y
  132942. * 5) thumb rest
  132943. * @param buttonIdx Which button index changed
  132944. * @param state New state of the button
  132945. * @param changes Which properties on the state changed since last frame
  132946. */
  132947. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  132948. }
  132949. }
  132950. declare module BABYLON {
  132951. /**
  132952. * Vive Controller
  132953. */
  132954. export class ViveController extends WebVRController {
  132955. /**
  132956. * Base Url for the controller model.
  132957. */
  132958. static MODEL_BASE_URL: string;
  132959. /**
  132960. * File name for the controller model.
  132961. */
  132962. static MODEL_FILENAME: string;
  132963. /**
  132964. * Creates a new ViveController from a gamepad
  132965. * @param vrGamepad the gamepad that the controller should be created from
  132966. */
  132967. constructor(vrGamepad: any);
  132968. /**
  132969. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  132970. * @param scene scene in which to add meshes
  132971. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  132972. */
  132973. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  132974. /**
  132975. * Fired when the left button on this controller is modified
  132976. */
  132977. get onLeftButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132978. /**
  132979. * Fired when the right button on this controller is modified
  132980. */
  132981. get onRightButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132982. /**
  132983. * Fired when the menu button on this controller is modified
  132984. */
  132985. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132986. /**
  132987. * Called once for each button that changed state since the last frame
  132988. * Vive mapping:
  132989. * 0: touchpad
  132990. * 1: trigger
  132991. * 2: left AND right buttons
  132992. * 3: menu button
  132993. * @param buttonIdx Which button index changed
  132994. * @param state New state of the button
  132995. * @param changes Which properties on the state changed since last frame
  132996. */
  132997. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  132998. }
  132999. }
  133000. declare module BABYLON {
  133001. /**
  133002. * Defines the WindowsMotionController object that the state of the windows motion controller
  133003. */
  133004. export class WindowsMotionController extends WebVRController {
  133005. /**
  133006. * The base url used to load the left and right controller models
  133007. */
  133008. static MODEL_BASE_URL: string;
  133009. /**
  133010. * The name of the left controller model file
  133011. */
  133012. static MODEL_LEFT_FILENAME: string;
  133013. /**
  133014. * The name of the right controller model file
  133015. */
  133016. static MODEL_RIGHT_FILENAME: string;
  133017. /**
  133018. * The controller name prefix for this controller type
  133019. */
  133020. static readonly GAMEPAD_ID_PREFIX: string;
  133021. /**
  133022. * The controller id pattern for this controller type
  133023. */
  133024. private static readonly GAMEPAD_ID_PATTERN;
  133025. private _loadedMeshInfo;
  133026. protected readonly _mapping: {
  133027. buttons: string[];
  133028. buttonMeshNames: {
  133029. trigger: string;
  133030. menu: string;
  133031. grip: string;
  133032. thumbstick: string;
  133033. trackpad: string;
  133034. };
  133035. buttonObservableNames: {
  133036. trigger: string;
  133037. menu: string;
  133038. grip: string;
  133039. thumbstick: string;
  133040. trackpad: string;
  133041. };
  133042. axisMeshNames: string[];
  133043. pointingPoseMeshName: string;
  133044. };
  133045. /**
  133046. * Fired when the trackpad on this controller is clicked
  133047. */
  133048. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  133049. /**
  133050. * Fired when the trackpad on this controller is modified
  133051. */
  133052. onTrackpadValuesChangedObservable: Observable<StickValues>;
  133053. /**
  133054. * The current x and y values of this controller's trackpad
  133055. */
  133056. trackpad: StickValues;
  133057. /**
  133058. * Creates a new WindowsMotionController from a gamepad
  133059. * @param vrGamepad the gamepad that the controller should be created from
  133060. */
  133061. constructor(vrGamepad: any);
  133062. /**
  133063. * Fired when the trigger on this controller is modified
  133064. */
  133065. get onTriggerButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  133066. /**
  133067. * Fired when the menu button on this controller is modified
  133068. */
  133069. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  133070. /**
  133071. * Fired when the grip button on this controller is modified
  133072. */
  133073. get onGripButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  133074. /**
  133075. * Fired when the thumbstick button on this controller is modified
  133076. */
  133077. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  133078. /**
  133079. * Fired when the touchpad button on this controller is modified
  133080. */
  133081. get onTouchpadButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  133082. /**
  133083. * Fired when the touchpad values on this controller are modified
  133084. */
  133085. get onTouchpadValuesChangedObservable(): Observable<StickValues>;
  133086. protected _updateTrackpad(): void;
  133087. /**
  133088. * Called once per frame by the engine.
  133089. */
  133090. update(): void;
  133091. /**
  133092. * Called once for each button that changed state since the last frame
  133093. * @param buttonIdx Which button index changed
  133094. * @param state New state of the button
  133095. * @param changes Which properties on the state changed since last frame
  133096. */
  133097. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  133098. /**
  133099. * Moves the buttons on the controller mesh based on their current state
  133100. * @param buttonName the name of the button to move
  133101. * @param buttonValue the value of the button which determines the buttons new position
  133102. */
  133103. protected _lerpButtonTransform(buttonName: string, buttonValue: number): void;
  133104. /**
  133105. * Moves the axis on the controller mesh based on its current state
  133106. * @param axis the index of the axis
  133107. * @param axisValue the value of the axis which determines the meshes new position
  133108. * @hidden
  133109. */
  133110. protected _lerpAxisTransform(axis: number, axisValue: number): void;
  133111. /**
  133112. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  133113. * @param scene scene in which to add meshes
  133114. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  133115. */
  133116. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void, forceDefault?: boolean): void;
  133117. /**
  133118. * Takes a list of meshes (as loaded from the glTF file) and finds the root node, as well as nodes that
  133119. * can be transformed by button presses and axes values, based on this._mapping.
  133120. *
  133121. * @param scene scene in which the meshes exist
  133122. * @param meshes list of meshes that make up the controller model to process
  133123. * @return structured view of the given meshes, with mapping of buttons and axes to meshes that can be transformed.
  133124. */
  133125. private processModel;
  133126. private createMeshInfo;
  133127. /**
  133128. * Gets the ray of the controller in the direction the controller is pointing
  133129. * @param length the length the resulting ray should be
  133130. * @returns a ray in the direction the controller is pointing
  133131. */
  133132. getForwardRay(length?: number): Ray;
  133133. /**
  133134. * Disposes of the controller
  133135. */
  133136. dispose(): void;
  133137. }
  133138. /**
  133139. * This class represents a new windows motion controller in XR.
  133140. */
  133141. export class XRWindowsMotionController extends WindowsMotionController {
  133142. /**
  133143. * Changing the original WIndowsMotionController mapping to fir the new mapping
  133144. */
  133145. protected readonly _mapping: {
  133146. buttons: string[];
  133147. buttonMeshNames: {
  133148. trigger: string;
  133149. menu: string;
  133150. grip: string;
  133151. thumbstick: string;
  133152. trackpad: string;
  133153. };
  133154. buttonObservableNames: {
  133155. trigger: string;
  133156. menu: string;
  133157. grip: string;
  133158. thumbstick: string;
  133159. trackpad: string;
  133160. };
  133161. axisMeshNames: string[];
  133162. pointingPoseMeshName: string;
  133163. };
  133164. /**
  133165. * Construct a new XR-Based windows motion controller
  133166. *
  133167. * @param gamepadInfo the gamepad object from the browser
  133168. */
  133169. constructor(gamepadInfo: any);
  133170. /**
  133171. * holds the thumbstick values (X,Y)
  133172. */
  133173. thumbstickValues: StickValues;
  133174. /**
  133175. * Fired when the thumbstick on this controller is clicked
  133176. */
  133177. onThumbstickStateChangedObservable: Observable<ExtendedGamepadButton>;
  133178. /**
  133179. * Fired when the thumbstick on this controller is modified
  133180. */
  133181. onThumbstickValuesChangedObservable: Observable<StickValues>;
  133182. /**
  133183. * Fired when the touchpad button on this controller is modified
  133184. */
  133185. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  133186. /**
  133187. * Fired when the touchpad values on this controller are modified
  133188. */
  133189. onTrackpadValuesChangedObservable: Observable<StickValues>;
  133190. /**
  133191. * Fired when the thumbstick button on this controller is modified
  133192. * here to prevent breaking changes
  133193. */
  133194. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  133195. /**
  133196. * updating the thumbstick(!) and not the trackpad.
  133197. * This is named this way due to the difference between WebVR and XR and to avoid
  133198. * changing the parent class.
  133199. */
  133200. protected _updateTrackpad(): void;
  133201. /**
  133202. * Disposes the class with joy
  133203. */
  133204. dispose(): void;
  133205. }
  133206. }
  133207. declare module BABYLON {
  133208. /**
  133209. * Class containing static functions to help procedurally build meshes
  133210. */
  133211. export class PolyhedronBuilder {
  133212. /**
  133213. * Creates a polyhedron mesh
  133214. * * 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
  133215. * * The parameter `size` (positive float, default 1) sets the polygon size
  133216. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  133217. * * 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`
  133218. * * 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
  133219. * * 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)`)
  133220. * * 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
  133221. * * 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
  133222. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  133223. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  133224. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  133225. * @param name defines the name of the mesh
  133226. * @param options defines the options used to create the mesh
  133227. * @param scene defines the hosting scene
  133228. * @returns the polyhedron mesh
  133229. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  133230. */
  133231. static CreatePolyhedron(name: string, options: {
  133232. type?: number;
  133233. size?: number;
  133234. sizeX?: number;
  133235. sizeY?: number;
  133236. sizeZ?: number;
  133237. custom?: any;
  133238. faceUV?: Vector4[];
  133239. faceColors?: Color4[];
  133240. flat?: boolean;
  133241. updatable?: boolean;
  133242. sideOrientation?: number;
  133243. frontUVs?: Vector4;
  133244. backUVs?: Vector4;
  133245. }, scene?: Nullable<Scene>): Mesh;
  133246. }
  133247. }
  133248. declare module BABYLON {
  133249. /**
  133250. * Gizmo that enables scaling a mesh along 3 axis
  133251. */
  133252. export class ScaleGizmo extends Gizmo {
  133253. /**
  133254. * Internal gizmo used for interactions on the x axis
  133255. */
  133256. xGizmo: AxisScaleGizmo;
  133257. /**
  133258. * Internal gizmo used for interactions on the y axis
  133259. */
  133260. yGizmo: AxisScaleGizmo;
  133261. /**
  133262. * Internal gizmo used for interactions on the z axis
  133263. */
  133264. zGizmo: AxisScaleGizmo;
  133265. /**
  133266. * Internal gizmo used to scale all axis equally
  133267. */
  133268. uniformScaleGizmo: AxisScaleGizmo;
  133269. private _meshAttached;
  133270. private _nodeAttached;
  133271. private _snapDistance;
  133272. private _uniformScalingMesh;
  133273. private _octahedron;
  133274. private _sensitivity;
  133275. /** Fires an event when any of it's sub gizmos are dragged */
  133276. onDragStartObservable: Observable<unknown>;
  133277. /** Fires an event when any of it's sub gizmos are released from dragging */
  133278. onDragEndObservable: Observable<unknown>;
  133279. get attachedMesh(): Nullable<AbstractMesh>;
  133280. set attachedMesh(mesh: Nullable<AbstractMesh>);
  133281. get attachedNode(): Nullable<Node>;
  133282. set attachedNode(node: Nullable<Node>);
  133283. /**
  133284. * Creates a ScaleGizmo
  133285. * @param gizmoLayer The utility layer the gizmo will be added to
  133286. * @param thickness display gizmo axis thickness
  133287. */
  133288. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number);
  133289. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  133290. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  133291. /**
  133292. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  133293. */
  133294. set snapDistance(value: number);
  133295. get snapDistance(): number;
  133296. /**
  133297. * Ratio for the scale of the gizmo (Default: 1)
  133298. */
  133299. set scaleRatio(value: number);
  133300. get scaleRatio(): number;
  133301. /**
  133302. * Sensitivity factor for dragging (Default: 1)
  133303. */
  133304. set sensitivity(value: number);
  133305. get sensitivity(): number;
  133306. /**
  133307. * Disposes of the gizmo
  133308. */
  133309. dispose(): void;
  133310. }
  133311. }
  133312. declare module BABYLON {
  133313. /**
  133314. * Single axis scale gizmo
  133315. */
  133316. export class AxisScaleGizmo extends Gizmo {
  133317. /**
  133318. * Drag behavior responsible for the gizmos dragging interactions
  133319. */
  133320. dragBehavior: PointerDragBehavior;
  133321. private _pointerObserver;
  133322. /**
  133323. * Scale distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  133324. */
  133325. snapDistance: number;
  133326. /**
  133327. * Event that fires each time the gizmo snaps to a new location.
  133328. * * snapDistance is the the change in distance
  133329. */
  133330. onSnapObservable: Observable<{
  133331. snapDistance: number;
  133332. }>;
  133333. /**
  133334. * If the scaling operation should be done on all axis (default: false)
  133335. */
  133336. uniformScaling: boolean;
  133337. /**
  133338. * Custom sensitivity value for the drag strength
  133339. */
  133340. sensitivity: number;
  133341. private _isEnabled;
  133342. private _parent;
  133343. private _arrow;
  133344. private _coloredMaterial;
  133345. private _hoverMaterial;
  133346. /**
  133347. * Creates an AxisScaleGizmo
  133348. * @param gizmoLayer The utility layer the gizmo will be added to
  133349. * @param dragAxis The axis which the gizmo will be able to scale on
  133350. * @param color The color of the gizmo
  133351. * @param thickness display gizmo axis thickness
  133352. */
  133353. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<ScaleGizmo>, thickness?: number);
  133354. protected _attachedNodeChanged(value: Nullable<Node>): void;
  133355. /**
  133356. * If the gizmo is enabled
  133357. */
  133358. set isEnabled(value: boolean);
  133359. get isEnabled(): boolean;
  133360. /**
  133361. * Disposes of the gizmo
  133362. */
  133363. dispose(): void;
  133364. /**
  133365. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  133366. * @param mesh The mesh to replace the default mesh of the gizmo
  133367. * @param useGizmoMaterial If the gizmo's default material should be used (default: false)
  133368. */
  133369. setCustomMesh(mesh: Mesh, useGizmoMaterial?: boolean): void;
  133370. }
  133371. }
  133372. declare module BABYLON {
  133373. /**
  133374. * Bounding box gizmo
  133375. */
  133376. export class BoundingBoxGizmo extends Gizmo {
  133377. private _lineBoundingBox;
  133378. private _rotateSpheresParent;
  133379. private _scaleBoxesParent;
  133380. private _boundingDimensions;
  133381. private _renderObserver;
  133382. private _pointerObserver;
  133383. private _scaleDragSpeed;
  133384. private _tmpQuaternion;
  133385. private _tmpVector;
  133386. private _tmpRotationMatrix;
  133387. /**
  133388. * 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)
  133389. */
  133390. ignoreChildren: boolean;
  133391. /**
  133392. * 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)
  133393. */
  133394. includeChildPredicate: Nullable<(abstractMesh: AbstractMesh) => boolean>;
  133395. /**
  133396. * The size of the rotation spheres attached to the bounding box (Default: 0.1)
  133397. */
  133398. rotationSphereSize: number;
  133399. /**
  133400. * The size of the scale boxes attached to the bounding box (Default: 0.1)
  133401. */
  133402. scaleBoxSize: number;
  133403. /**
  133404. * 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)
  133405. */
  133406. fixedDragMeshScreenSize: boolean;
  133407. /**
  133408. * The distance away from the object which the draggable meshes should appear world sized when fixedDragMeshScreenSize is set to true (default: 10)
  133409. */
  133410. fixedDragMeshScreenSizeDistanceFactor: number;
  133411. /**
  133412. * Fired when a rotation sphere or scale box is dragged
  133413. */
  133414. onDragStartObservable: Observable<{}>;
  133415. /**
  133416. * Fired when a scale box is dragged
  133417. */
  133418. onScaleBoxDragObservable: Observable<{}>;
  133419. /**
  133420. * Fired when a scale box drag is ended
  133421. */
  133422. onScaleBoxDragEndObservable: Observable<{}>;
  133423. /**
  133424. * Fired when a rotation sphere is dragged
  133425. */
  133426. onRotationSphereDragObservable: Observable<{}>;
  133427. /**
  133428. * Fired when a rotation sphere drag is ended
  133429. */
  133430. onRotationSphereDragEndObservable: Observable<{}>;
  133431. /**
  133432. * 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)
  133433. */
  133434. scalePivot: Nullable<Vector3>;
  133435. /**
  133436. * Mesh used as a pivot to rotate the attached node
  133437. */
  133438. private _anchorMesh;
  133439. private _existingMeshScale;
  133440. private _dragMesh;
  133441. private pointerDragBehavior;
  133442. private coloredMaterial;
  133443. private hoverColoredMaterial;
  133444. /**
  133445. * Sets the color of the bounding box gizmo
  133446. * @param color the color to set
  133447. */
  133448. setColor(color: Color3): void;
  133449. /**
  133450. * Creates an BoundingBoxGizmo
  133451. * @param gizmoLayer The utility layer the gizmo will be added to
  133452. * @param color The color of the gizmo
  133453. */
  133454. constructor(color?: Color3, gizmoLayer?: UtilityLayerRenderer);
  133455. protected _attachedNodeChanged(value: Nullable<AbstractMesh>): void;
  133456. private _selectNode;
  133457. /**
  133458. * Updates the bounding box information for the Gizmo
  133459. */
  133460. updateBoundingBox(): void;
  133461. private _updateRotationSpheres;
  133462. private _updateScaleBoxes;
  133463. /**
  133464. * Enables rotation on the specified axis and disables rotation on the others
  133465. * @param axis The list of axis that should be enabled (eg. "xy" or "xyz")
  133466. */
  133467. setEnabledRotationAxis(axis: string): void;
  133468. /**
  133469. * Enables/disables scaling
  133470. * @param enable if scaling should be enabled
  133471. * @param homogeneousScaling defines if scaling should only be homogeneous
  133472. */
  133473. setEnabledScaling(enable: boolean, homogeneousScaling?: boolean): void;
  133474. private _updateDummy;
  133475. /**
  133476. * Enables a pointer drag behavior on the bounding box of the gizmo
  133477. */
  133478. enableDragBehavior(): void;
  133479. /**
  133480. * Disposes of the gizmo
  133481. */
  133482. dispose(): void;
  133483. /**
  133484. * 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)
  133485. * @param mesh the mesh to wrap in the bounding box mesh and make not pickable
  133486. * @returns the bounding box mesh with the passed in mesh as a child
  133487. */
  133488. static MakeNotPickableAndWrapInBoundingBox(mesh: Mesh): Mesh;
  133489. /**
  133490. * CustomMeshes are not supported by this gizmo
  133491. * @param mesh The mesh to replace the default mesh of the gizmo
  133492. */
  133493. setCustomMesh(mesh: Mesh): void;
  133494. }
  133495. }
  133496. declare module BABYLON {
  133497. /**
  133498. * Single plane rotation gizmo
  133499. */
  133500. export class PlaneRotationGizmo extends Gizmo {
  133501. /**
  133502. * Drag behavior responsible for the gizmos dragging interactions
  133503. */
  133504. dragBehavior: PointerDragBehavior;
  133505. private _pointerObserver;
  133506. /**
  133507. * Rotation distance in radians that the gizmo will snap to (Default: 0)
  133508. */
  133509. snapDistance: number;
  133510. /**
  133511. * Event that fires each time the gizmo snaps to a new location.
  133512. * * snapDistance is the the change in distance
  133513. */
  133514. onSnapObservable: Observable<{
  133515. snapDistance: number;
  133516. }>;
  133517. private _isEnabled;
  133518. private _parent;
  133519. /**
  133520. * Creates a PlaneRotationGizmo
  133521. * @param gizmoLayer The utility layer the gizmo will be added to
  133522. * @param planeNormal The normal of the plane which the gizmo will be able to rotate on
  133523. * @param color The color of the gizmo
  133524. * @param tessellation Amount of tessellation to be used when creating rotation circles
  133525. * @param useEulerRotation Use and update Euler angle instead of quaternion
  133526. * @param thickness display gizmo axis thickness
  133527. */
  133528. constructor(planeNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, tessellation?: number, parent?: Nullable<RotationGizmo>, useEulerRotation?: boolean, thickness?: number);
  133529. protected _attachedNodeChanged(value: Nullable<Node>): void;
  133530. /**
  133531. * If the gizmo is enabled
  133532. */
  133533. set isEnabled(value: boolean);
  133534. get isEnabled(): boolean;
  133535. /**
  133536. * Disposes of the gizmo
  133537. */
  133538. dispose(): void;
  133539. }
  133540. }
  133541. declare module BABYLON {
  133542. /**
  133543. * Gizmo that enables rotating a mesh along 3 axis
  133544. */
  133545. export class RotationGizmo extends Gizmo {
  133546. /**
  133547. * Internal gizmo used for interactions on the x axis
  133548. */
  133549. xGizmo: PlaneRotationGizmo;
  133550. /**
  133551. * Internal gizmo used for interactions on the y axis
  133552. */
  133553. yGizmo: PlaneRotationGizmo;
  133554. /**
  133555. * Internal gizmo used for interactions on the z axis
  133556. */
  133557. zGizmo: PlaneRotationGizmo;
  133558. /** Fires an event when any of it's sub gizmos are dragged */
  133559. onDragStartObservable: Observable<unknown>;
  133560. /** Fires an event when any of it's sub gizmos are released from dragging */
  133561. onDragEndObservable: Observable<unknown>;
  133562. private _meshAttached;
  133563. private _nodeAttached;
  133564. get attachedMesh(): Nullable<AbstractMesh>;
  133565. set attachedMesh(mesh: Nullable<AbstractMesh>);
  133566. get attachedNode(): Nullable<Node>;
  133567. set attachedNode(node: Nullable<Node>);
  133568. /**
  133569. * Creates a RotationGizmo
  133570. * @param gizmoLayer The utility layer the gizmo will be added to
  133571. * @param tessellation Amount of tessellation to be used when creating rotation circles
  133572. * @param useEulerRotation Use and update Euler angle instead of quaternion
  133573. * @param thickness display gizmo axis thickness
  133574. */
  133575. constructor(gizmoLayer?: UtilityLayerRenderer, tessellation?: number, useEulerRotation?: boolean, thickness?: number);
  133576. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  133577. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  133578. /**
  133579. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  133580. */
  133581. set snapDistance(value: number);
  133582. get snapDistance(): number;
  133583. /**
  133584. * Ratio for the scale of the gizmo (Default: 1)
  133585. */
  133586. set scaleRatio(value: number);
  133587. get scaleRatio(): number;
  133588. /**
  133589. * Disposes of the gizmo
  133590. */
  133591. dispose(): void;
  133592. /**
  133593. * CustomMeshes are not supported by this gizmo
  133594. * @param mesh The mesh to replace the default mesh of the gizmo
  133595. */
  133596. setCustomMesh(mesh: Mesh): void;
  133597. }
  133598. }
  133599. declare module BABYLON {
  133600. /**
  133601. * Helps setup gizmo's in the scene to rotate/scale/position nodes
  133602. */
  133603. export class GizmoManager implements IDisposable {
  133604. private scene;
  133605. /**
  133606. * Gizmo's created by the gizmo manager, gizmo will be null until gizmo has been enabled for the first time
  133607. */
  133608. gizmos: {
  133609. positionGizmo: Nullable<PositionGizmo>;
  133610. rotationGizmo: Nullable<RotationGizmo>;
  133611. scaleGizmo: Nullable<ScaleGizmo>;
  133612. boundingBoxGizmo: Nullable<BoundingBoxGizmo>;
  133613. };
  133614. /** When true, the gizmo will be detached from the current object when a pointer down occurs with an empty picked mesh */
  133615. clearGizmoOnEmptyPointerEvent: boolean;
  133616. /** Fires an event when the manager is attached to a mesh */
  133617. onAttachedToMeshObservable: Observable<Nullable<AbstractMesh>>;
  133618. /** Fires an event when the manager is attached to a node */
  133619. onAttachedToNodeObservable: Observable<Nullable<Node>>;
  133620. private _gizmosEnabled;
  133621. private _pointerObserver;
  133622. private _attachedMesh;
  133623. private _attachedNode;
  133624. private _boundingBoxColor;
  133625. private _defaultUtilityLayer;
  133626. private _defaultKeepDepthUtilityLayer;
  133627. private _thickness;
  133628. /**
  133629. * When bounding box gizmo is enabled, this can be used to track drag/end events
  133630. */
  133631. boundingBoxDragBehavior: SixDofDragBehavior;
  133632. /**
  133633. * Array of meshes which will have the gizmo attached when a pointer selected them. If null, all meshes are attachable. (Default: null)
  133634. */
  133635. attachableMeshes: Nullable<Array<AbstractMesh>>;
  133636. /**
  133637. * Array of nodes which will have the gizmo attached when a pointer selected them. If null, all nodes are attachable. (Default: null)
  133638. */
  133639. attachableNodes: Nullable<Array<Node>>;
  133640. /**
  133641. * If pointer events should perform attaching/detaching a gizmo, if false this can be done manually via attachToMesh/attachToNode. (Default: true)
  133642. */
  133643. usePointerToAttachGizmos: boolean;
  133644. /**
  133645. * Utility layer that the bounding box gizmo belongs to
  133646. */
  133647. get keepDepthUtilityLayer(): UtilityLayerRenderer;
  133648. /**
  133649. * Utility layer that all gizmos besides bounding box belong to
  133650. */
  133651. get utilityLayer(): UtilityLayerRenderer;
  133652. /**
  133653. * Instatiates a gizmo manager
  133654. * @param scene the scene to overlay the gizmos on top of
  133655. * @param thickness display gizmo axis thickness
  133656. */
  133657. constructor(scene: Scene, thickness?: number);
  133658. /**
  133659. * Attaches a set of gizmos to the specified mesh
  133660. * @param mesh The mesh the gizmo's should be attached to
  133661. */
  133662. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  133663. /**
  133664. * Attaches a set of gizmos to the specified node
  133665. * @param node The node the gizmo's should be attached to
  133666. */
  133667. attachToNode(node: Nullable<Node>): void;
  133668. /**
  133669. * If the position gizmo is enabled
  133670. */
  133671. set positionGizmoEnabled(value: boolean);
  133672. get positionGizmoEnabled(): boolean;
  133673. /**
  133674. * If the rotation gizmo is enabled
  133675. */
  133676. set rotationGizmoEnabled(value: boolean);
  133677. get rotationGizmoEnabled(): boolean;
  133678. /**
  133679. * If the scale gizmo is enabled
  133680. */
  133681. set scaleGizmoEnabled(value: boolean);
  133682. get scaleGizmoEnabled(): boolean;
  133683. /**
  133684. * If the boundingBox gizmo is enabled
  133685. */
  133686. set boundingBoxGizmoEnabled(value: boolean);
  133687. get boundingBoxGizmoEnabled(): boolean;
  133688. /**
  133689. * Disposes of the gizmo manager
  133690. */
  133691. dispose(): void;
  133692. }
  133693. }
  133694. declare module BABYLON {
  133695. /**
  133696. * A directional light is defined by a direction (what a surprise!).
  133697. * The light is emitted from everywhere in the specified direction, and has an infinite range.
  133698. * 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.
  133699. * Documentation: https://doc.babylonjs.com/babylon101/lights
  133700. */
  133701. export class DirectionalLight extends ShadowLight {
  133702. private _shadowFrustumSize;
  133703. /**
  133704. * Fix frustum size for the shadow generation. This is disabled if the value is 0.
  133705. */
  133706. get shadowFrustumSize(): number;
  133707. /**
  133708. * Specifies a fix frustum size for the shadow generation.
  133709. */
  133710. set shadowFrustumSize(value: number);
  133711. private _shadowOrthoScale;
  133712. /**
  133713. * Gets the shadow projection scale against the optimal computed one.
  133714. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  133715. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  133716. */
  133717. get shadowOrthoScale(): number;
  133718. /**
  133719. * Sets the shadow projection scale against the optimal computed one.
  133720. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  133721. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  133722. */
  133723. set shadowOrthoScale(value: number);
  133724. /**
  133725. * Automatically compute the projection matrix to best fit (including all the casters)
  133726. * on each frame.
  133727. */
  133728. autoUpdateExtends: boolean;
  133729. /**
  133730. * Automatically compute the shadowMinZ and shadowMaxZ for the projection matrix to best fit (including all the casters)
  133731. * on each frame. autoUpdateExtends must be set to true for this to work
  133732. */
  133733. autoCalcShadowZBounds: boolean;
  133734. private _orthoLeft;
  133735. private _orthoRight;
  133736. private _orthoTop;
  133737. private _orthoBottom;
  133738. /**
  133739. * Creates a DirectionalLight object in the scene, oriented towards the passed direction (Vector3).
  133740. * The directional light is emitted from everywhere in the given direction.
  133741. * It can cast shadows.
  133742. * Documentation : https://doc.babylonjs.com/babylon101/lights
  133743. * @param name The friendly name of the light
  133744. * @param direction The direction of the light
  133745. * @param scene The scene the light belongs to
  133746. */
  133747. constructor(name: string, direction: Vector3, scene: Scene);
  133748. /**
  133749. * Returns the string "DirectionalLight".
  133750. * @return The class name
  133751. */
  133752. getClassName(): string;
  133753. /**
  133754. * Returns the integer 1.
  133755. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  133756. */
  133757. getTypeID(): number;
  133758. /**
  133759. * Sets the passed matrix "matrix" as projection matrix for the shadows cast by the light according to the passed view matrix.
  133760. * Returns the DirectionalLight Shadow projection matrix.
  133761. */
  133762. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  133763. /**
  133764. * Sets the passed matrix "matrix" as fixed frustum projection matrix for the shadows cast by the light according to the passed view matrix.
  133765. * Returns the DirectionalLight Shadow projection matrix.
  133766. */
  133767. protected _setDefaultFixedFrustumShadowProjectionMatrix(matrix: Matrix): void;
  133768. /**
  133769. * Sets the passed matrix "matrix" as auto extend projection matrix for the shadows cast by the light according to the passed view matrix.
  133770. * Returns the DirectionalLight Shadow projection matrix.
  133771. */
  133772. protected _setDefaultAutoExtendShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  133773. protected _buildUniformLayout(): void;
  133774. /**
  133775. * Sets the passed Effect object with the DirectionalLight transformed position (or position if not parented) and the passed name.
  133776. * @param effect The effect to update
  133777. * @param lightIndex The index of the light in the effect to update
  133778. * @returns The directional light
  133779. */
  133780. transferToEffect(effect: Effect, lightIndex: string): DirectionalLight;
  133781. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  133782. /**
  133783. * Gets the minZ used for shadow according to both the scene and the light.
  133784. *
  133785. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  133786. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  133787. * @param activeCamera The camera we are returning the min for
  133788. * @returns the depth min z
  133789. */
  133790. getDepthMinZ(activeCamera: Camera): number;
  133791. /**
  133792. * Gets the maxZ used for shadow according to both the scene and the light.
  133793. *
  133794. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  133795. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  133796. * @param activeCamera The camera we are returning the max for
  133797. * @returns the depth max z
  133798. */
  133799. getDepthMaxZ(activeCamera: Camera): number;
  133800. /**
  133801. * Prepares the list of defines specific to the light type.
  133802. * @param defines the list of defines
  133803. * @param lightIndex defines the index of the light for the effect
  133804. */
  133805. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  133806. }
  133807. }
  133808. declare module BABYLON {
  133809. /**
  133810. * Class containing static functions to help procedurally build meshes
  133811. */
  133812. export class HemisphereBuilder {
  133813. /**
  133814. * Creates a hemisphere mesh
  133815. * @param name defines the name of the mesh
  133816. * @param options defines the options used to create the mesh
  133817. * @param scene defines the hosting scene
  133818. * @returns the hemisphere mesh
  133819. */
  133820. static CreateHemisphere(name: string, options: {
  133821. segments?: number;
  133822. diameter?: number;
  133823. sideOrientation?: number;
  133824. }, scene: any): Mesh;
  133825. }
  133826. }
  133827. declare module BABYLON {
  133828. /**
  133829. * A spot light is defined by a position, a direction, an angle, and an exponent.
  133830. * These values define a cone of light starting from the position, emitting toward the direction.
  133831. * The angle, in radians, defines the size (field of illumination) of the spotlight's conical beam,
  133832. * and the exponent defines the speed of the decay of the light with distance (reach).
  133833. * Documentation: https://doc.babylonjs.com/babylon101/lights
  133834. */
  133835. export class SpotLight extends ShadowLight {
  133836. private _angle;
  133837. private _innerAngle;
  133838. private _cosHalfAngle;
  133839. private _lightAngleScale;
  133840. private _lightAngleOffset;
  133841. /**
  133842. * Gets the cone angle of the spot light in Radians.
  133843. */
  133844. get angle(): number;
  133845. /**
  133846. * Sets the cone angle of the spot light in Radians.
  133847. */
  133848. set angle(value: number);
  133849. /**
  133850. * Only used in gltf falloff mode, this defines the angle where
  133851. * the directional falloff will start before cutting at angle which could be seen
  133852. * as outer angle.
  133853. */
  133854. get innerAngle(): number;
  133855. /**
  133856. * Only used in gltf falloff mode, this defines the angle where
  133857. * the directional falloff will start before cutting at angle which could be seen
  133858. * as outer angle.
  133859. */
  133860. set innerAngle(value: number);
  133861. private _shadowAngleScale;
  133862. /**
  133863. * Allows scaling the angle of the light for shadow generation only.
  133864. */
  133865. get shadowAngleScale(): number;
  133866. /**
  133867. * Allows scaling the angle of the light for shadow generation only.
  133868. */
  133869. set shadowAngleScale(value: number);
  133870. /**
  133871. * The light decay speed with the distance from the emission spot.
  133872. */
  133873. exponent: number;
  133874. private _projectionTextureMatrix;
  133875. /**
  133876. * Allows reading the projecton texture
  133877. */
  133878. get projectionTextureMatrix(): Matrix;
  133879. protected _projectionTextureLightNear: number;
  133880. /**
  133881. * Gets the near clip of the Spotlight for texture projection.
  133882. */
  133883. get projectionTextureLightNear(): number;
  133884. /**
  133885. * Sets the near clip of the Spotlight for texture projection.
  133886. */
  133887. set projectionTextureLightNear(value: number);
  133888. protected _projectionTextureLightFar: number;
  133889. /**
  133890. * Gets the far clip of the Spotlight for texture projection.
  133891. */
  133892. get projectionTextureLightFar(): number;
  133893. /**
  133894. * Sets the far clip of the Spotlight for texture projection.
  133895. */
  133896. set projectionTextureLightFar(value: number);
  133897. protected _projectionTextureUpDirection: Vector3;
  133898. /**
  133899. * Gets the Up vector of the Spotlight for texture projection.
  133900. */
  133901. get projectionTextureUpDirection(): Vector3;
  133902. /**
  133903. * Sets the Up vector of the Spotlight for texture projection.
  133904. */
  133905. set projectionTextureUpDirection(value: Vector3);
  133906. private _projectionTexture;
  133907. /**
  133908. * Gets the projection texture of the light.
  133909. */
  133910. get projectionTexture(): Nullable<BaseTexture>;
  133911. /**
  133912. * Sets the projection texture of the light.
  133913. */
  133914. set projectionTexture(value: Nullable<BaseTexture>);
  133915. private _projectionTextureViewLightDirty;
  133916. private _projectionTextureProjectionLightDirty;
  133917. private _projectionTextureDirty;
  133918. private _projectionTextureViewTargetVector;
  133919. private _projectionTextureViewLightMatrix;
  133920. private _projectionTextureProjectionLightMatrix;
  133921. private _projectionTextureScalingMatrix;
  133922. /**
  133923. * Creates a SpotLight object in the scene. A spot light is a simply light oriented cone.
  133924. * It can cast shadows.
  133925. * Documentation : https://doc.babylonjs.com/babylon101/lights
  133926. * @param name The light friendly name
  133927. * @param position The position of the spot light in the scene
  133928. * @param direction The direction of the light in the scene
  133929. * @param angle The cone angle of the light in Radians
  133930. * @param exponent The light decay speed with the distance from the emission spot
  133931. * @param scene The scene the lights belongs to
  133932. */
  133933. constructor(name: string, position: Vector3, direction: Vector3, angle: number, exponent: number, scene: Scene);
  133934. /**
  133935. * Returns the string "SpotLight".
  133936. * @returns the class name
  133937. */
  133938. getClassName(): string;
  133939. /**
  133940. * Returns the integer 2.
  133941. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  133942. */
  133943. getTypeID(): number;
  133944. /**
  133945. * Overrides the direction setter to recompute the projection texture view light Matrix.
  133946. */
  133947. protected _setDirection(value: Vector3): void;
  133948. /**
  133949. * Overrides the position setter to recompute the projection texture view light Matrix.
  133950. */
  133951. protected _setPosition(value: Vector3): void;
  133952. /**
  133953. * 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.
  133954. * Returns the SpotLight.
  133955. */
  133956. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  133957. protected _computeProjectionTextureViewLightMatrix(): void;
  133958. protected _computeProjectionTextureProjectionLightMatrix(): void;
  133959. /**
  133960. * Main function for light texture projection matrix computing.
  133961. */
  133962. protected _computeProjectionTextureMatrix(): void;
  133963. protected _buildUniformLayout(): void;
  133964. private _computeAngleValues;
  133965. /**
  133966. * Sets the passed Effect "effect" with the Light textures.
  133967. * @param effect The effect to update
  133968. * @param lightIndex The index of the light in the effect to update
  133969. * @returns The light
  133970. */
  133971. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  133972. /**
  133973. * Sets the passed Effect object with the SpotLight transfomed position (or position if not parented) and normalized direction.
  133974. * @param effect The effect to update
  133975. * @param lightIndex The index of the light in the effect to update
  133976. * @returns The spot light
  133977. */
  133978. transferToEffect(effect: Effect, lightIndex: string): SpotLight;
  133979. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  133980. /**
  133981. * Disposes the light and the associated resources.
  133982. */
  133983. dispose(): void;
  133984. /**
  133985. * Prepares the list of defines specific to the light type.
  133986. * @param defines the list of defines
  133987. * @param lightIndex defines the index of the light for the effect
  133988. */
  133989. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  133990. }
  133991. }
  133992. declare module BABYLON {
  133993. /**
  133994. * Gizmo that enables viewing a light
  133995. */
  133996. export class LightGizmo extends Gizmo {
  133997. private _lightMesh;
  133998. private _material;
  133999. private _cachedPosition;
  134000. private _cachedForward;
  134001. private _attachedMeshParent;
  134002. private _pointerObserver;
  134003. /**
  134004. * Event that fires each time the gizmo is clicked
  134005. */
  134006. onClickedObservable: Observable<Light>;
  134007. /**
  134008. * Creates a LightGizmo
  134009. * @param gizmoLayer The utility layer the gizmo will be added to
  134010. */
  134011. constructor(gizmoLayer?: UtilityLayerRenderer);
  134012. private _light;
  134013. /**
  134014. * The light that the gizmo is attached to
  134015. */
  134016. set light(light: Nullable<Light>);
  134017. get light(): Nullable<Light>;
  134018. /**
  134019. * Gets the material used to render the light gizmo
  134020. */
  134021. get material(): StandardMaterial;
  134022. /**
  134023. * @hidden
  134024. * Updates the gizmo to match the attached mesh's position/rotation
  134025. */
  134026. protected _update(): void;
  134027. private static _Scale;
  134028. /**
  134029. * Creates the lines for a light mesh
  134030. */
  134031. private static _CreateLightLines;
  134032. /**
  134033. * Disposes of the light gizmo
  134034. */
  134035. dispose(): void;
  134036. private static _CreateHemisphericLightMesh;
  134037. private static _CreatePointLightMesh;
  134038. private static _CreateSpotLightMesh;
  134039. private static _CreateDirectionalLightMesh;
  134040. }
  134041. }
  134042. declare module BABYLON {
  134043. /**
  134044. * Gizmo that enables viewing a camera
  134045. */
  134046. export class CameraGizmo extends Gizmo {
  134047. private _cameraMesh;
  134048. private _cameraLinesMesh;
  134049. private _material;
  134050. private _pointerObserver;
  134051. /**
  134052. * Event that fires each time the gizmo is clicked
  134053. */
  134054. onClickedObservable: Observable<Camera>;
  134055. /**
  134056. * Creates a CameraGizmo
  134057. * @param gizmoLayer The utility layer the gizmo will be added to
  134058. */
  134059. constructor(gizmoLayer?: UtilityLayerRenderer);
  134060. private _camera;
  134061. /** Gets or sets a boolean indicating if frustum lines must be rendered (true by default)) */
  134062. get displayFrustum(): boolean;
  134063. set displayFrustum(value: boolean);
  134064. /**
  134065. * The camera that the gizmo is attached to
  134066. */
  134067. set camera(camera: Nullable<Camera>);
  134068. get camera(): Nullable<Camera>;
  134069. /**
  134070. * Gets the material used to render the camera gizmo
  134071. */
  134072. get material(): StandardMaterial;
  134073. /**
  134074. * @hidden
  134075. * Updates the gizmo to match the attached mesh's position/rotation
  134076. */
  134077. protected _update(): void;
  134078. private static _Scale;
  134079. private _invProjection;
  134080. /**
  134081. * Disposes of the camera gizmo
  134082. */
  134083. dispose(): void;
  134084. private static _CreateCameraMesh;
  134085. private static _CreateCameraFrustum;
  134086. }
  134087. }
  134088. declare module BABYLON {
  134089. /** @hidden */
  134090. export var backgroundFragmentDeclaration: {
  134091. name: string;
  134092. shader: string;
  134093. };
  134094. }
  134095. declare module BABYLON {
  134096. /** @hidden */
  134097. export var backgroundUboDeclaration: {
  134098. name: string;
  134099. shader: string;
  134100. };
  134101. }
  134102. declare module BABYLON {
  134103. /** @hidden */
  134104. export var backgroundPixelShader: {
  134105. name: string;
  134106. shader: string;
  134107. };
  134108. }
  134109. declare module BABYLON {
  134110. /** @hidden */
  134111. export var backgroundVertexDeclaration: {
  134112. name: string;
  134113. shader: string;
  134114. };
  134115. }
  134116. declare module BABYLON {
  134117. /** @hidden */
  134118. export var backgroundVertexShader: {
  134119. name: string;
  134120. shader: string;
  134121. };
  134122. }
  134123. declare module BABYLON {
  134124. /**
  134125. * Background material used to create an efficient environement around your scene.
  134126. */
  134127. export class BackgroundMaterial extends PushMaterial {
  134128. /**
  134129. * Standard reflectance value at parallel view angle.
  134130. */
  134131. static StandardReflectance0: number;
  134132. /**
  134133. * Standard reflectance value at grazing angle.
  134134. */
  134135. static StandardReflectance90: number;
  134136. protected _primaryColor: Color3;
  134137. /**
  134138. * Key light Color (multiply against the environement texture)
  134139. */
  134140. primaryColor: Color3;
  134141. protected __perceptualColor: Nullable<Color3>;
  134142. /**
  134143. * Experimental Internal Use Only.
  134144. *
  134145. * Key light Color in "perceptual value" meaning the color you would like to see on screen.
  134146. * This acts as a helper to set the primary color to a more "human friendly" value.
  134147. * Conversion to linear space as well as exposure and tone mapping correction will be applied to keep the
  134148. * output color as close as possible from the chosen value.
  134149. * (This does not account for contrast color grading and color curves as they are considered post effect and not directly
  134150. * part of lighting setup.)
  134151. */
  134152. get _perceptualColor(): Nullable<Color3>;
  134153. set _perceptualColor(value: Nullable<Color3>);
  134154. protected _primaryColorShadowLevel: float;
  134155. /**
  134156. * Defines the level of the shadows (dark area of the reflection map) in order to help scaling the colors.
  134157. * The color opposite to the primary color is used at the level chosen to define what the black area would look.
  134158. */
  134159. get primaryColorShadowLevel(): float;
  134160. set primaryColorShadowLevel(value: float);
  134161. protected _primaryColorHighlightLevel: float;
  134162. /**
  134163. * Defines the level of the highliights (highlight area of the reflection map) in order to help scaling the colors.
  134164. * The primary color is used at the level chosen to define what the white area would look.
  134165. */
  134166. get primaryColorHighlightLevel(): float;
  134167. set primaryColorHighlightLevel(value: float);
  134168. protected _reflectionTexture: Nullable<BaseTexture>;
  134169. /**
  134170. * Reflection Texture used in the material.
  134171. * Should be author in a specific way for the best result (refer to the documentation).
  134172. */
  134173. reflectionTexture: Nullable<BaseTexture>;
  134174. protected _reflectionBlur: float;
  134175. /**
  134176. * Reflection Texture level of blur.
  134177. *
  134178. * Can be use to reuse an existing HDR Texture and target a specific LOD to prevent authoring the
  134179. * texture twice.
  134180. */
  134181. reflectionBlur: float;
  134182. protected _diffuseTexture: Nullable<BaseTexture>;
  134183. /**
  134184. * Diffuse Texture used in the material.
  134185. * Should be author in a specific way for the best result (refer to the documentation).
  134186. */
  134187. diffuseTexture: Nullable<BaseTexture>;
  134188. protected _shadowLights: Nullable<IShadowLight[]>;
  134189. /**
  134190. * Specify the list of lights casting shadow on the material.
  134191. * All scene shadow lights will be included if null.
  134192. */
  134193. shadowLights: Nullable<IShadowLight[]>;
  134194. protected _shadowLevel: float;
  134195. /**
  134196. * Helps adjusting the shadow to a softer level if required.
  134197. * 0 means black shadows and 1 means no shadows.
  134198. */
  134199. shadowLevel: float;
  134200. protected _sceneCenter: Vector3;
  134201. /**
  134202. * In case of opacity Fresnel or reflection falloff, this is use as a scene center.
  134203. * It is usually zero but might be interesting to modify according to your setup.
  134204. */
  134205. sceneCenter: Vector3;
  134206. protected _opacityFresnel: boolean;
  134207. /**
  134208. * This helps specifying that the material is falling off to the sky box at grazing angle.
  134209. * This helps ensuring a nice transition when the camera goes under the ground.
  134210. */
  134211. opacityFresnel: boolean;
  134212. protected _reflectionFresnel: boolean;
  134213. /**
  134214. * This helps specifying that the material is falling off from diffuse to the reflection texture at grazing angle.
  134215. * This helps adding a mirror texture on the ground.
  134216. */
  134217. reflectionFresnel: boolean;
  134218. protected _reflectionFalloffDistance: number;
  134219. /**
  134220. * This helps specifying the falloff radius off the reflection texture from the sceneCenter.
  134221. * This helps adding a nice falloff effect to the reflection if used as a mirror for instance.
  134222. */
  134223. reflectionFalloffDistance: number;
  134224. protected _reflectionAmount: number;
  134225. /**
  134226. * This specifies the weight of the reflection against the background in case of reflection Fresnel.
  134227. */
  134228. reflectionAmount: number;
  134229. protected _reflectionReflectance0: number;
  134230. /**
  134231. * This specifies the weight of the reflection at grazing angle.
  134232. */
  134233. reflectionReflectance0: number;
  134234. protected _reflectionReflectance90: number;
  134235. /**
  134236. * This specifies the weight of the reflection at a perpendicular point of view.
  134237. */
  134238. reflectionReflectance90: number;
  134239. /**
  134240. * Sets the reflection reflectance fresnel values according to the default standard
  134241. * empirically know to work well :-)
  134242. */
  134243. set reflectionStandardFresnelWeight(value: number);
  134244. protected _useRGBColor: boolean;
  134245. /**
  134246. * Helps to directly use the maps channels instead of their level.
  134247. */
  134248. useRGBColor: boolean;
  134249. protected _enableNoise: boolean;
  134250. /**
  134251. * This helps reducing the banding effect that could occur on the background.
  134252. */
  134253. enableNoise: boolean;
  134254. /**
  134255. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  134256. * Best used when trying to implement visual zoom effects like fish-eye or binoculars while not adjusting camera fov.
  134257. * Recommended to be keep at 1.0 except for special cases.
  134258. */
  134259. get fovMultiplier(): number;
  134260. set fovMultiplier(value: number);
  134261. private _fovMultiplier;
  134262. /**
  134263. * Enable the FOV adjustment feature controlled by fovMultiplier.
  134264. */
  134265. useEquirectangularFOV: boolean;
  134266. private _maxSimultaneousLights;
  134267. /**
  134268. * Number of Simultaneous lights allowed on the material.
  134269. */
  134270. maxSimultaneousLights: int;
  134271. private _shadowOnly;
  134272. /**
  134273. * Make the material only render shadows
  134274. */
  134275. shadowOnly: boolean;
  134276. /**
  134277. * Default configuration related to image processing available in the Background Material.
  134278. */
  134279. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  134280. /**
  134281. * Keep track of the image processing observer to allow dispose and replace.
  134282. */
  134283. private _imageProcessingObserver;
  134284. /**
  134285. * Attaches a new image processing configuration to the PBR Material.
  134286. * @param configuration (if null the scene configuration will be use)
  134287. */
  134288. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  134289. /**
  134290. * Gets the image processing configuration used either in this material.
  134291. */
  134292. get imageProcessingConfiguration(): Nullable<ImageProcessingConfiguration>;
  134293. /**
  134294. * Sets the Default image processing configuration used either in the this material.
  134295. *
  134296. * If sets to null, the scene one is in use.
  134297. */
  134298. set imageProcessingConfiguration(value: Nullable<ImageProcessingConfiguration>);
  134299. /**
  134300. * Gets wether the color curves effect is enabled.
  134301. */
  134302. get cameraColorCurvesEnabled(): boolean;
  134303. /**
  134304. * Sets wether the color curves effect is enabled.
  134305. */
  134306. set cameraColorCurvesEnabled(value: boolean);
  134307. /**
  134308. * Gets wether the color grading effect is enabled.
  134309. */
  134310. get cameraColorGradingEnabled(): boolean;
  134311. /**
  134312. * Gets wether the color grading effect is enabled.
  134313. */
  134314. set cameraColorGradingEnabled(value: boolean);
  134315. /**
  134316. * Gets wether tonemapping is enabled or not.
  134317. */
  134318. get cameraToneMappingEnabled(): boolean;
  134319. /**
  134320. * Sets wether tonemapping is enabled or not
  134321. */
  134322. set cameraToneMappingEnabled(value: boolean);
  134323. /**
  134324. * The camera exposure used on this material.
  134325. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  134326. * This corresponds to a photographic exposure.
  134327. */
  134328. get cameraExposure(): float;
  134329. /**
  134330. * The camera exposure used on this material.
  134331. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  134332. * This corresponds to a photographic exposure.
  134333. */
  134334. set cameraExposure(value: float);
  134335. /**
  134336. * Gets The camera contrast used on this material.
  134337. */
  134338. get cameraContrast(): float;
  134339. /**
  134340. * Sets The camera contrast used on this material.
  134341. */
  134342. set cameraContrast(value: float);
  134343. /**
  134344. * Gets the Color Grading 2D Lookup Texture.
  134345. */
  134346. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  134347. /**
  134348. * Sets the Color Grading 2D Lookup Texture.
  134349. */
  134350. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  134351. /**
  134352. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  134353. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  134354. * 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;
  134355. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  134356. */
  134357. get cameraColorCurves(): Nullable<ColorCurves>;
  134358. /**
  134359. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  134360. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  134361. * 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;
  134362. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  134363. */
  134364. set cameraColorCurves(value: Nullable<ColorCurves>);
  134365. /**
  134366. * Due to a bug in iOS10, video tags (which are using the background material) are in BGR and not RGB.
  134367. * Setting this flag to true (not done automatically!) will convert it back to RGB.
  134368. */
  134369. switchToBGR: boolean;
  134370. private _renderTargets;
  134371. private _reflectionControls;
  134372. private _white;
  134373. private _primaryShadowColor;
  134374. private _primaryHighlightColor;
  134375. /**
  134376. * Instantiates a Background Material in the given scene
  134377. * @param name The friendly name of the material
  134378. * @param scene The scene to add the material to
  134379. */
  134380. constructor(name: string, scene: Scene);
  134381. /**
  134382. * Gets a boolean indicating that current material needs to register RTT
  134383. */
  134384. get hasRenderTargetTextures(): boolean;
  134385. /**
  134386. * The entire material has been created in order to prevent overdraw.
  134387. * @returns false
  134388. */
  134389. needAlphaTesting(): boolean;
  134390. /**
  134391. * The entire material has been created in order to prevent overdraw.
  134392. * @returns true if blending is enable
  134393. */
  134394. needAlphaBlending(): boolean;
  134395. /**
  134396. * Checks wether the material is ready to be rendered for a given mesh.
  134397. * @param mesh The mesh to render
  134398. * @param subMesh The submesh to check against
  134399. * @param useInstances Specify wether or not the material is used with instances
  134400. * @returns true if all the dependencies are ready (Textures, Effects...)
  134401. */
  134402. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  134403. /**
  134404. * Compute the primary color according to the chosen perceptual color.
  134405. */
  134406. private _computePrimaryColorFromPerceptualColor;
  134407. /**
  134408. * Compute the highlights and shadow colors according to their chosen levels.
  134409. */
  134410. private _computePrimaryColors;
  134411. /**
  134412. * Build the uniform buffer used in the material.
  134413. */
  134414. buildUniformLayout(): void;
  134415. /**
  134416. * Unbind the material.
  134417. */
  134418. unbind(): void;
  134419. /**
  134420. * Bind only the world matrix to the material.
  134421. * @param world The world matrix to bind.
  134422. */
  134423. bindOnlyWorldMatrix(world: Matrix): void;
  134424. /**
  134425. * Bind the material for a dedicated submeh (every used meshes will be considered opaque).
  134426. * @param world The world matrix to bind.
  134427. * @param subMesh The submesh to bind for.
  134428. */
  134429. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  134430. /**
  134431. * Checks to see if a texture is used in the material.
  134432. * @param texture - Base texture to use.
  134433. * @returns - Boolean specifying if a texture is used in the material.
  134434. */
  134435. hasTexture(texture: BaseTexture): boolean;
  134436. /**
  134437. * Dispose the material.
  134438. * @param forceDisposeEffect Force disposal of the associated effect.
  134439. * @param forceDisposeTextures Force disposal of the associated textures.
  134440. */
  134441. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  134442. /**
  134443. * Clones the material.
  134444. * @param name The cloned name.
  134445. * @returns The cloned material.
  134446. */
  134447. clone(name: string): BackgroundMaterial;
  134448. /**
  134449. * Serializes the current material to its JSON representation.
  134450. * @returns The JSON representation.
  134451. */
  134452. serialize(): any;
  134453. /**
  134454. * Gets the class name of the material
  134455. * @returns "BackgroundMaterial"
  134456. */
  134457. getClassName(): string;
  134458. /**
  134459. * Parse a JSON input to create back a background material.
  134460. * @param source The JSON data to parse
  134461. * @param scene The scene to create the parsed material in
  134462. * @param rootUrl The root url of the assets the material depends upon
  134463. * @returns the instantiated BackgroundMaterial.
  134464. */
  134465. static Parse(source: any, scene: Scene, rootUrl: string): BackgroundMaterial;
  134466. }
  134467. }
  134468. declare module BABYLON {
  134469. /**
  134470. * Represents the different options available during the creation of
  134471. * a Environment helper.
  134472. *
  134473. * This can control the default ground, skybox and image processing setup of your scene.
  134474. */
  134475. export interface IEnvironmentHelperOptions {
  134476. /**
  134477. * Specifies whether or not to create a ground.
  134478. * True by default.
  134479. */
  134480. createGround: boolean;
  134481. /**
  134482. * Specifies the ground size.
  134483. * 15 by default.
  134484. */
  134485. groundSize: number;
  134486. /**
  134487. * The texture used on the ground for the main color.
  134488. * Comes from the BabylonJS CDN by default.
  134489. *
  134490. * Remarks: Can be either a texture or a url.
  134491. */
  134492. groundTexture: string | BaseTexture;
  134493. /**
  134494. * The color mixed in the ground texture by default.
  134495. * BabylonJS clearColor by default.
  134496. */
  134497. groundColor: Color3;
  134498. /**
  134499. * Specifies the ground opacity.
  134500. * 1 by default.
  134501. */
  134502. groundOpacity: number;
  134503. /**
  134504. * Enables the ground to receive shadows.
  134505. * True by default.
  134506. */
  134507. enableGroundShadow: boolean;
  134508. /**
  134509. * Helps preventing the shadow to be fully black on the ground.
  134510. * 0.5 by default.
  134511. */
  134512. groundShadowLevel: number;
  134513. /**
  134514. * Creates a mirror texture attach to the ground.
  134515. * false by default.
  134516. */
  134517. enableGroundMirror: boolean;
  134518. /**
  134519. * Specifies the ground mirror size ratio.
  134520. * 0.3 by default as the default kernel is 64.
  134521. */
  134522. groundMirrorSizeRatio: number;
  134523. /**
  134524. * Specifies the ground mirror blur kernel size.
  134525. * 64 by default.
  134526. */
  134527. groundMirrorBlurKernel: number;
  134528. /**
  134529. * Specifies the ground mirror visibility amount.
  134530. * 1 by default
  134531. */
  134532. groundMirrorAmount: number;
  134533. /**
  134534. * Specifies the ground mirror reflectance weight.
  134535. * This uses the standard weight of the background material to setup the fresnel effect
  134536. * of the mirror.
  134537. * 1 by default.
  134538. */
  134539. groundMirrorFresnelWeight: number;
  134540. /**
  134541. * Specifies the ground mirror Falloff distance.
  134542. * This can helps reducing the size of the reflection.
  134543. * 0 by Default.
  134544. */
  134545. groundMirrorFallOffDistance: number;
  134546. /**
  134547. * Specifies the ground mirror texture type.
  134548. * Unsigned Int by Default.
  134549. */
  134550. groundMirrorTextureType: number;
  134551. /**
  134552. * Specifies a bias applied to the ground vertical position to prevent z-fighting with
  134553. * the shown objects.
  134554. */
  134555. groundYBias: number;
  134556. /**
  134557. * Specifies whether or not to create a skybox.
  134558. * True by default.
  134559. */
  134560. createSkybox: boolean;
  134561. /**
  134562. * Specifies the skybox size.
  134563. * 20 by default.
  134564. */
  134565. skyboxSize: number;
  134566. /**
  134567. * The texture used on the skybox for the main color.
  134568. * Comes from the BabylonJS CDN by default.
  134569. *
  134570. * Remarks: Can be either a texture or a url.
  134571. */
  134572. skyboxTexture: string | BaseTexture;
  134573. /**
  134574. * The color mixed in the skybox texture by default.
  134575. * BabylonJS clearColor by default.
  134576. */
  134577. skyboxColor: Color3;
  134578. /**
  134579. * The background rotation around the Y axis of the scene.
  134580. * This helps aligning the key lights of your scene with the background.
  134581. * 0 by default.
  134582. */
  134583. backgroundYRotation: number;
  134584. /**
  134585. * Compute automatically the size of the elements to best fit with the scene.
  134586. */
  134587. sizeAuto: boolean;
  134588. /**
  134589. * Default position of the rootMesh if autoSize is not true.
  134590. */
  134591. rootPosition: Vector3;
  134592. /**
  134593. * Sets up the image processing in the scene.
  134594. * true by default.
  134595. */
  134596. setupImageProcessing: boolean;
  134597. /**
  134598. * The texture used as your environment texture in the scene.
  134599. * Comes from the BabylonJS CDN by default and in use if setupImageProcessing is true.
  134600. *
  134601. * Remarks: Can be either a texture or a url.
  134602. */
  134603. environmentTexture: string | BaseTexture;
  134604. /**
  134605. * The value of the exposure to apply to the scene.
  134606. * 0.6 by default if setupImageProcessing is true.
  134607. */
  134608. cameraExposure: number;
  134609. /**
  134610. * The value of the contrast to apply to the scene.
  134611. * 1.6 by default if setupImageProcessing is true.
  134612. */
  134613. cameraContrast: number;
  134614. /**
  134615. * Specifies whether or not tonemapping should be enabled in the scene.
  134616. * true by default if setupImageProcessing is true.
  134617. */
  134618. toneMappingEnabled: boolean;
  134619. }
  134620. /**
  134621. * The Environment helper class can be used to add a fully featuread none expensive background to your scene.
  134622. * It includes by default a skybox and a ground relying on the BackgroundMaterial.
  134623. * It also helps with the default setup of your imageProcessing configuration.
  134624. */
  134625. export class EnvironmentHelper {
  134626. /**
  134627. * Default ground texture URL.
  134628. */
  134629. private static _groundTextureCDNUrl;
  134630. /**
  134631. * Default skybox texture URL.
  134632. */
  134633. private static _skyboxTextureCDNUrl;
  134634. /**
  134635. * Default environment texture URL.
  134636. */
  134637. private static _environmentTextureCDNUrl;
  134638. /**
  134639. * Creates the default options for the helper.
  134640. */
  134641. private static _getDefaultOptions;
  134642. private _rootMesh;
  134643. /**
  134644. * Gets the root mesh created by the helper.
  134645. */
  134646. get rootMesh(): Mesh;
  134647. private _skybox;
  134648. /**
  134649. * Gets the skybox created by the helper.
  134650. */
  134651. get skybox(): Nullable<Mesh>;
  134652. private _skyboxTexture;
  134653. /**
  134654. * Gets the skybox texture created by the helper.
  134655. */
  134656. get skyboxTexture(): Nullable<BaseTexture>;
  134657. private _skyboxMaterial;
  134658. /**
  134659. * Gets the skybox material created by the helper.
  134660. */
  134661. get skyboxMaterial(): Nullable<BackgroundMaterial>;
  134662. private _ground;
  134663. /**
  134664. * Gets the ground mesh created by the helper.
  134665. */
  134666. get ground(): Nullable<Mesh>;
  134667. private _groundTexture;
  134668. /**
  134669. * Gets the ground texture created by the helper.
  134670. */
  134671. get groundTexture(): Nullable<BaseTexture>;
  134672. private _groundMirror;
  134673. /**
  134674. * Gets the ground mirror created by the helper.
  134675. */
  134676. get groundMirror(): Nullable<MirrorTexture>;
  134677. /**
  134678. * Gets the ground mirror render list to helps pushing the meshes
  134679. * you wish in the ground reflection.
  134680. */
  134681. get groundMirrorRenderList(): Nullable<AbstractMesh[]>;
  134682. private _groundMaterial;
  134683. /**
  134684. * Gets the ground material created by the helper.
  134685. */
  134686. get groundMaterial(): Nullable<BackgroundMaterial>;
  134687. /**
  134688. * Stores the creation options.
  134689. */
  134690. private readonly _scene;
  134691. private _options;
  134692. /**
  134693. * This observable will be notified with any error during the creation of the environment,
  134694. * mainly texture creation errors.
  134695. */
  134696. onErrorObservable: Observable<{
  134697. message?: string;
  134698. exception?: any;
  134699. }>;
  134700. /**
  134701. * constructor
  134702. * @param options Defines the options we want to customize the helper
  134703. * @param scene The scene to add the material to
  134704. */
  134705. constructor(options: Partial<IEnvironmentHelperOptions>, scene: Scene);
  134706. /**
  134707. * Updates the background according to the new options
  134708. * @param options
  134709. */
  134710. updateOptions(options: Partial<IEnvironmentHelperOptions>): void;
  134711. /**
  134712. * Sets the primary color of all the available elements.
  134713. * @param color the main color to affect to the ground and the background
  134714. */
  134715. setMainColor(color: Color3): void;
  134716. /**
  134717. * Setup the image processing according to the specified options.
  134718. */
  134719. private _setupImageProcessing;
  134720. /**
  134721. * Setup the environment texture according to the specified options.
  134722. */
  134723. private _setupEnvironmentTexture;
  134724. /**
  134725. * Setup the background according to the specified options.
  134726. */
  134727. private _setupBackground;
  134728. /**
  134729. * Get the scene sizes according to the setup.
  134730. */
  134731. private _getSceneSize;
  134732. /**
  134733. * Setup the ground according to the specified options.
  134734. */
  134735. private _setupGround;
  134736. /**
  134737. * Setup the ground material according to the specified options.
  134738. */
  134739. private _setupGroundMaterial;
  134740. /**
  134741. * Setup the ground diffuse texture according to the specified options.
  134742. */
  134743. private _setupGroundDiffuseTexture;
  134744. /**
  134745. * Setup the ground mirror texture according to the specified options.
  134746. */
  134747. private _setupGroundMirrorTexture;
  134748. /**
  134749. * Setup the ground to receive the mirror texture.
  134750. */
  134751. private _setupMirrorInGroundMaterial;
  134752. /**
  134753. * Setup the skybox according to the specified options.
  134754. */
  134755. private _setupSkybox;
  134756. /**
  134757. * Setup the skybox material according to the specified options.
  134758. */
  134759. private _setupSkyboxMaterial;
  134760. /**
  134761. * Setup the skybox reflection texture according to the specified options.
  134762. */
  134763. private _setupSkyboxReflectionTexture;
  134764. private _errorHandler;
  134765. /**
  134766. * Dispose all the elements created by the Helper.
  134767. */
  134768. dispose(): void;
  134769. }
  134770. }
  134771. declare module BABYLON {
  134772. /**
  134773. * Display a 360/180 degree texture on an approximately spherical surface, useful for VR applications or skyboxes.
  134774. * As a subclass of TransformNode, this allow parenting to the camera or multiple textures with different locations in the scene.
  134775. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  134776. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  134777. */
  134778. export abstract class TextureDome<T extends Texture> extends TransformNode {
  134779. protected onError: Nullable<(message?: string, exception?: any) => void>;
  134780. /**
  134781. * Define the source as a Monoscopic panoramic 360/180.
  134782. */
  134783. static readonly MODE_MONOSCOPIC: number;
  134784. /**
  134785. * Define the source as a Stereoscopic TopBottom/OverUnder panoramic 360/180.
  134786. */
  134787. static readonly MODE_TOPBOTTOM: number;
  134788. /**
  134789. * Define the source as a Stereoscopic Side by Side panoramic 360/180.
  134790. */
  134791. static readonly MODE_SIDEBYSIDE: number;
  134792. private _halfDome;
  134793. protected _useDirectMapping: boolean;
  134794. /**
  134795. * The texture being displayed on the sphere
  134796. */
  134797. protected _texture: T;
  134798. /**
  134799. * Gets the texture being displayed on the sphere
  134800. */
  134801. get texture(): T;
  134802. /**
  134803. * Sets the texture being displayed on the sphere
  134804. */
  134805. set texture(newTexture: T);
  134806. /**
  134807. * The skybox material
  134808. */
  134809. protected _material: BackgroundMaterial;
  134810. /**
  134811. * The surface used for the dome
  134812. */
  134813. protected _mesh: Mesh;
  134814. /**
  134815. * Gets the mesh used for the dome.
  134816. */
  134817. get mesh(): Mesh;
  134818. /**
  134819. * A mesh that will be used to mask the back of the dome in case it is a 180 degree movie.
  134820. */
  134821. private _halfDomeMask;
  134822. /**
  134823. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  134824. * Also see the options.resolution property.
  134825. */
  134826. get fovMultiplier(): number;
  134827. set fovMultiplier(value: number);
  134828. protected _textureMode: number;
  134829. /**
  134830. * Gets or set the current texture mode for the texture. It can be:
  134831. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  134832. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  134833. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  134834. */
  134835. get textureMode(): number;
  134836. /**
  134837. * Sets the current texture mode for the texture. It can be:
  134838. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  134839. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  134840. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  134841. */
  134842. set textureMode(value: number);
  134843. /**
  134844. * Is it a 180 degrees dome (half dome) or 360 texture (full dome)
  134845. */
  134846. get halfDome(): boolean;
  134847. /**
  134848. * Set the halfDome mode. If set, only the front (180 degrees) will be displayed and the back will be blacked out.
  134849. */
  134850. set halfDome(enabled: boolean);
  134851. /**
  134852. * Oberserver used in Stereoscopic VR Mode.
  134853. */
  134854. private _onBeforeCameraRenderObserver;
  134855. /**
  134856. * Observable raised when an error occured while loading the 360 image
  134857. */
  134858. onLoadErrorObservable: Observable<string>;
  134859. /**
  134860. * Create an instance of this class and pass through the parameters to the relevant classes- Texture, StandardMaterial, and Mesh.
  134861. * @param name Element's name, child elements will append suffixes for their own names.
  134862. * @param textureUrlOrElement defines the url(s) or the (video) HTML element to use
  134863. * @param options An object containing optional or exposed sub element properties
  134864. */
  134865. constructor(name: string, textureUrlOrElement: string | string[] | HTMLVideoElement, options: {
  134866. resolution?: number;
  134867. clickToPlay?: boolean;
  134868. autoPlay?: boolean;
  134869. loop?: boolean;
  134870. size?: number;
  134871. poster?: string;
  134872. faceForward?: boolean;
  134873. useDirectMapping?: boolean;
  134874. halfDomeMode?: boolean;
  134875. }, scene: Scene, onError?: Nullable<(message?: string, exception?: any) => void>);
  134876. protected abstract _initTexture(urlsOrElement: string | string[] | HTMLElement, scene: Scene, options: any): T;
  134877. protected _changeTextureMode(value: number): void;
  134878. /**
  134879. * Releases resources associated with this node.
  134880. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  134881. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  134882. */
  134883. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  134884. }
  134885. }
  134886. declare module BABYLON {
  134887. /**
  134888. * Display a 360 degree photo on an approximately spherical surface, useful for VR applications or skyboxes.
  134889. * As a subclass of TransformNode, this allow parenting to the camera with different locations in the scene.
  134890. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  134891. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  134892. */
  134893. export class PhotoDome extends TextureDome<Texture> {
  134894. /**
  134895. * Define the image as a Monoscopic panoramic 360 image.
  134896. */
  134897. static readonly MODE_MONOSCOPIC: number;
  134898. /**
  134899. * Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  134900. */
  134901. static readonly MODE_TOPBOTTOM: number;
  134902. /**
  134903. * Define the image as a Stereoscopic Side by Side panoramic 360 image.
  134904. */
  134905. static readonly MODE_SIDEBYSIDE: number;
  134906. /**
  134907. * Gets or sets the texture being displayed on the sphere
  134908. */
  134909. get photoTexture(): Texture;
  134910. /**
  134911. * sets the texture being displayed on the sphere
  134912. */
  134913. set photoTexture(value: Texture);
  134914. /**
  134915. * Gets the current video mode for the video. It can be:
  134916. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  134917. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  134918. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  134919. */
  134920. get imageMode(): number;
  134921. /**
  134922. * Sets the current video mode for the video. It can be:
  134923. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  134924. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  134925. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  134926. */
  134927. set imageMode(value: number);
  134928. protected _initTexture(urlsOrElement: string, scene: Scene, options: any): Texture;
  134929. }
  134930. }
  134931. declare module BABYLON {
  134932. /**
  134933. * Class used to host RGBD texture specific utilities
  134934. */
  134935. export class RGBDTextureTools {
  134936. /**
  134937. * Expand the RGBD Texture from RGBD to Half Float if possible.
  134938. * @param texture the texture to expand.
  134939. */
  134940. static ExpandRGBDTexture(texture: Texture): void;
  134941. }
  134942. }
  134943. declare module BABYLON {
  134944. /**
  134945. * Class used to host texture specific utilities
  134946. */
  134947. export class BRDFTextureTools {
  134948. /**
  134949. * Prevents texture cache collision
  134950. */
  134951. private static _instanceNumber;
  134952. /**
  134953. * Gets a default environment BRDF for MS-BRDF Height Correlated BRDF
  134954. * @param scene defines the hosting scene
  134955. * @returns the environment BRDF texture
  134956. */
  134957. static GetEnvironmentBRDFTexture(scene: Scene): BaseTexture;
  134958. private static _environmentBRDFBase64Texture;
  134959. }
  134960. }
  134961. declare module BABYLON {
  134962. /**
  134963. * @hidden
  134964. */
  134965. export interface IMaterialClearCoatDefines {
  134966. CLEARCOAT: boolean;
  134967. CLEARCOAT_DEFAULTIOR: boolean;
  134968. CLEARCOAT_TEXTURE: boolean;
  134969. CLEARCOAT_TEXTUREDIRECTUV: number;
  134970. CLEARCOAT_BUMP: boolean;
  134971. CLEARCOAT_BUMPDIRECTUV: number;
  134972. CLEARCOAT_TINT: boolean;
  134973. CLEARCOAT_TINT_TEXTURE: boolean;
  134974. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  134975. /** @hidden */
  134976. _areTexturesDirty: boolean;
  134977. }
  134978. /**
  134979. * Define the code related to the clear coat parameters of the pbr material.
  134980. */
  134981. export class PBRClearCoatConfiguration {
  134982. /**
  134983. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  134984. * The default fits with a polyurethane material.
  134985. */
  134986. private static readonly _DefaultIndexOfRefraction;
  134987. private _isEnabled;
  134988. /**
  134989. * Defines if the clear coat is enabled in the material.
  134990. */
  134991. isEnabled: boolean;
  134992. /**
  134993. * Defines the clear coat layer strength (between 0 and 1) it defaults to 1.
  134994. */
  134995. intensity: number;
  134996. /**
  134997. * Defines the clear coat layer roughness.
  134998. */
  134999. roughness: number;
  135000. private _indexOfRefraction;
  135001. /**
  135002. * Defines the index of refraction of the clear coat.
  135003. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  135004. * The default fits with a polyurethane material.
  135005. * Changing the default value is more performance intensive.
  135006. */
  135007. indexOfRefraction: number;
  135008. private _texture;
  135009. /**
  135010. * Stores the clear coat values in a texture.
  135011. */
  135012. texture: Nullable<BaseTexture>;
  135013. private _bumpTexture;
  135014. /**
  135015. * Define the clear coat specific bump texture.
  135016. */
  135017. bumpTexture: Nullable<BaseTexture>;
  135018. private _isTintEnabled;
  135019. /**
  135020. * Defines if the clear coat tint is enabled in the material.
  135021. */
  135022. isTintEnabled: boolean;
  135023. /**
  135024. * Defines the clear coat tint of the material.
  135025. * This is only use if tint is enabled
  135026. */
  135027. tintColor: Color3;
  135028. /**
  135029. * Defines the distance at which the tint color should be found in the
  135030. * clear coat media.
  135031. * This is only use if tint is enabled
  135032. */
  135033. tintColorAtDistance: number;
  135034. /**
  135035. * Defines the clear coat layer thickness.
  135036. * This is only use if tint is enabled
  135037. */
  135038. tintThickness: number;
  135039. private _tintTexture;
  135040. /**
  135041. * Stores the clear tint values in a texture.
  135042. * rgb is tint
  135043. * a is a thickness factor
  135044. */
  135045. tintTexture: Nullable<BaseTexture>;
  135046. /** @hidden */
  135047. private _internalMarkAllSubMeshesAsTexturesDirty;
  135048. /** @hidden */
  135049. _markAllSubMeshesAsTexturesDirty(): void;
  135050. /**
  135051. * Instantiate a new istance of clear coat configuration.
  135052. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  135053. */
  135054. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  135055. /**
  135056. * Gets wehter the submesh is ready to be used or not.
  135057. * @param defines the list of "defines" to update.
  135058. * @param scene defines the scene the material belongs to.
  135059. * @param engine defines the engine the material belongs to.
  135060. * @param disableBumpMap defines wether the material disables bump or not.
  135061. * @returns - boolean indicating that the submesh is ready or not.
  135062. */
  135063. isReadyForSubMesh(defines: IMaterialClearCoatDefines, scene: Scene, engine: Engine, disableBumpMap: boolean): boolean;
  135064. /**
  135065. * Checks to see if a texture is used in the material.
  135066. * @param defines the list of "defines" to update.
  135067. * @param scene defines the scene to the material belongs to.
  135068. */
  135069. prepareDefines(defines: IMaterialClearCoatDefines, scene: Scene): void;
  135070. /**
  135071. * Binds the material data.
  135072. * @param uniformBuffer defines the Uniform buffer to fill in.
  135073. * @param scene defines the scene the material belongs to.
  135074. * @param engine defines the engine the material belongs to.
  135075. * @param disableBumpMap defines wether the material disables bump or not.
  135076. * @param isFrozen defines wether the material is frozen or not.
  135077. * @param invertNormalMapX If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  135078. * @param invertNormalMapY If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  135079. */
  135080. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, disableBumpMap: boolean, isFrozen: boolean, invertNormalMapX: boolean, invertNormalMapY: boolean): void;
  135081. /**
  135082. * Checks to see if a texture is used in the material.
  135083. * @param texture - Base texture to use.
  135084. * @returns - Boolean specifying if a texture is used in the material.
  135085. */
  135086. hasTexture(texture: BaseTexture): boolean;
  135087. /**
  135088. * Returns an array of the actively used textures.
  135089. * @param activeTextures Array of BaseTextures
  135090. */
  135091. getActiveTextures(activeTextures: BaseTexture[]): void;
  135092. /**
  135093. * Returns the animatable textures.
  135094. * @param animatables Array of animatable textures.
  135095. */
  135096. getAnimatables(animatables: IAnimatable[]): void;
  135097. /**
  135098. * Disposes the resources of the material.
  135099. * @param forceDisposeTextures - Forces the disposal of all textures.
  135100. */
  135101. dispose(forceDisposeTextures?: boolean): void;
  135102. /**
  135103. * Get the current class name of the texture useful for serialization or dynamic coding.
  135104. * @returns "PBRClearCoatConfiguration"
  135105. */
  135106. getClassName(): string;
  135107. /**
  135108. * Add fallbacks to the effect fallbacks list.
  135109. * @param defines defines the Base texture to use.
  135110. * @param fallbacks defines the current fallback list.
  135111. * @param currentRank defines the current fallback rank.
  135112. * @returns the new fallback rank.
  135113. */
  135114. static AddFallbacks(defines: IMaterialClearCoatDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  135115. /**
  135116. * Add the required uniforms to the current list.
  135117. * @param uniforms defines the current uniform list.
  135118. */
  135119. static AddUniforms(uniforms: string[]): void;
  135120. /**
  135121. * Add the required samplers to the current list.
  135122. * @param samplers defines the current sampler list.
  135123. */
  135124. static AddSamplers(samplers: string[]): void;
  135125. /**
  135126. * Add the required uniforms to the current buffer.
  135127. * @param uniformBuffer defines the current uniform buffer.
  135128. */
  135129. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  135130. /**
  135131. * Makes a duplicate of the current configuration into another one.
  135132. * @param clearCoatConfiguration define the config where to copy the info
  135133. */
  135134. copyTo(clearCoatConfiguration: PBRClearCoatConfiguration): void;
  135135. /**
  135136. * Serializes this clear coat configuration.
  135137. * @returns - An object with the serialized config.
  135138. */
  135139. serialize(): any;
  135140. /**
  135141. * Parses a anisotropy Configuration from a serialized object.
  135142. * @param source - Serialized object.
  135143. * @param scene Defines the scene we are parsing for
  135144. * @param rootUrl Defines the rootUrl to load from
  135145. */
  135146. parse(source: any, scene: Scene, rootUrl: string): void;
  135147. }
  135148. }
  135149. declare module BABYLON {
  135150. /**
  135151. * @hidden
  135152. */
  135153. export interface IMaterialAnisotropicDefines {
  135154. ANISOTROPIC: boolean;
  135155. ANISOTROPIC_TEXTURE: boolean;
  135156. ANISOTROPIC_TEXTUREDIRECTUV: number;
  135157. MAINUV1: boolean;
  135158. _areTexturesDirty: boolean;
  135159. _needUVs: boolean;
  135160. }
  135161. /**
  135162. * Define the code related to the anisotropic parameters of the pbr material.
  135163. */
  135164. export class PBRAnisotropicConfiguration {
  135165. private _isEnabled;
  135166. /**
  135167. * Defines if the anisotropy is enabled in the material.
  135168. */
  135169. isEnabled: boolean;
  135170. /**
  135171. * Defines the anisotropy strength (between 0 and 1) it defaults to 1.
  135172. */
  135173. intensity: number;
  135174. /**
  135175. * Defines if the effect is along the tangents, bitangents or in between.
  135176. * By default, the effect is "strectching" the highlights along the tangents.
  135177. */
  135178. direction: Vector2;
  135179. private _texture;
  135180. /**
  135181. * Stores the anisotropy values in a texture.
  135182. * rg is direction (like normal from -1 to 1)
  135183. * b is a intensity
  135184. */
  135185. texture: Nullable<BaseTexture>;
  135186. /** @hidden */
  135187. private _internalMarkAllSubMeshesAsTexturesDirty;
  135188. /** @hidden */
  135189. _markAllSubMeshesAsTexturesDirty(): void;
  135190. /**
  135191. * Instantiate a new istance of anisotropy configuration.
  135192. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  135193. */
  135194. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  135195. /**
  135196. * Specifies that the submesh is ready to be used.
  135197. * @param defines the list of "defines" to update.
  135198. * @param scene defines the scene the material belongs to.
  135199. * @returns - boolean indicating that the submesh is ready or not.
  135200. */
  135201. isReadyForSubMesh(defines: IMaterialAnisotropicDefines, scene: Scene): boolean;
  135202. /**
  135203. * Checks to see if a texture is used in the material.
  135204. * @param defines the list of "defines" to update.
  135205. * @param mesh the mesh we are preparing the defines for.
  135206. * @param scene defines the scene the material belongs to.
  135207. */
  135208. prepareDefines(defines: IMaterialAnisotropicDefines, mesh: AbstractMesh, scene: Scene): void;
  135209. /**
  135210. * Binds the material data.
  135211. * @param uniformBuffer defines the Uniform buffer to fill in.
  135212. * @param scene defines the scene the material belongs to.
  135213. * @param isFrozen defines wether the material is frozen or not.
  135214. */
  135215. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  135216. /**
  135217. * Checks to see if a texture is used in the material.
  135218. * @param texture - Base texture to use.
  135219. * @returns - Boolean specifying if a texture is used in the material.
  135220. */
  135221. hasTexture(texture: BaseTexture): boolean;
  135222. /**
  135223. * Returns an array of the actively used textures.
  135224. * @param activeTextures Array of BaseTextures
  135225. */
  135226. getActiveTextures(activeTextures: BaseTexture[]): void;
  135227. /**
  135228. * Returns the animatable textures.
  135229. * @param animatables Array of animatable textures.
  135230. */
  135231. getAnimatables(animatables: IAnimatable[]): void;
  135232. /**
  135233. * Disposes the resources of the material.
  135234. * @param forceDisposeTextures - Forces the disposal of all textures.
  135235. */
  135236. dispose(forceDisposeTextures?: boolean): void;
  135237. /**
  135238. * Get the current class name of the texture useful for serialization or dynamic coding.
  135239. * @returns "PBRAnisotropicConfiguration"
  135240. */
  135241. getClassName(): string;
  135242. /**
  135243. * Add fallbacks to the effect fallbacks list.
  135244. * @param defines defines the Base texture to use.
  135245. * @param fallbacks defines the current fallback list.
  135246. * @param currentRank defines the current fallback rank.
  135247. * @returns the new fallback rank.
  135248. */
  135249. static AddFallbacks(defines: IMaterialAnisotropicDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  135250. /**
  135251. * Add the required uniforms to the current list.
  135252. * @param uniforms defines the current uniform list.
  135253. */
  135254. static AddUniforms(uniforms: string[]): void;
  135255. /**
  135256. * Add the required uniforms to the current buffer.
  135257. * @param uniformBuffer defines the current uniform buffer.
  135258. */
  135259. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  135260. /**
  135261. * Add the required samplers to the current list.
  135262. * @param samplers defines the current sampler list.
  135263. */
  135264. static AddSamplers(samplers: string[]): void;
  135265. /**
  135266. * Makes a duplicate of the current configuration into another one.
  135267. * @param anisotropicConfiguration define the config where to copy the info
  135268. */
  135269. copyTo(anisotropicConfiguration: PBRAnisotropicConfiguration): void;
  135270. /**
  135271. * Serializes this anisotropy configuration.
  135272. * @returns - An object with the serialized config.
  135273. */
  135274. serialize(): any;
  135275. /**
  135276. * Parses a anisotropy Configuration from a serialized object.
  135277. * @param source - Serialized object.
  135278. * @param scene Defines the scene we are parsing for
  135279. * @param rootUrl Defines the rootUrl to load from
  135280. */
  135281. parse(source: any, scene: Scene, rootUrl: string): void;
  135282. }
  135283. }
  135284. declare module BABYLON {
  135285. /**
  135286. * @hidden
  135287. */
  135288. export interface IMaterialBRDFDefines {
  135289. BRDF_V_HEIGHT_CORRELATED: boolean;
  135290. MS_BRDF_ENERGY_CONSERVATION: boolean;
  135291. SPHERICAL_HARMONICS: boolean;
  135292. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  135293. /** @hidden */
  135294. _areMiscDirty: boolean;
  135295. }
  135296. /**
  135297. * Define the code related to the BRDF parameters of the pbr material.
  135298. */
  135299. export class PBRBRDFConfiguration {
  135300. /**
  135301. * Default value used for the energy conservation.
  135302. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  135303. */
  135304. static DEFAULT_USE_ENERGY_CONSERVATION: boolean;
  135305. /**
  135306. * Default value used for the Smith Visibility Height Correlated mode.
  135307. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  135308. */
  135309. static DEFAULT_USE_SMITH_VISIBILITY_HEIGHT_CORRELATED: boolean;
  135310. /**
  135311. * Default value used for the IBL diffuse part.
  135312. * This can help switching back to the polynomials mode globally which is a tiny bit
  135313. * less GPU intensive at the drawback of a lower quality.
  135314. */
  135315. static DEFAULT_USE_SPHERICAL_HARMONICS: boolean;
  135316. /**
  135317. * Default value used for activating energy conservation for the specular workflow.
  135318. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  135319. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  135320. */
  135321. static DEFAULT_USE_SPECULAR_GLOSSINESS_INPUT_ENERGY_CONSERVATION: boolean;
  135322. private _useEnergyConservation;
  135323. /**
  135324. * Defines if the material uses energy conservation.
  135325. */
  135326. useEnergyConservation: boolean;
  135327. private _useSmithVisibilityHeightCorrelated;
  135328. /**
  135329. * LEGACY Mode set to false
  135330. * Defines if the material uses height smith correlated visibility term.
  135331. * If you intent to not use our default BRDF, you need to load a separate BRDF Texture for the PBR
  135332. * You can either load https://assets.babylonjs.com/environments/uncorrelatedBRDF.png
  135333. * or https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds to have more precision
  135334. * Not relying on height correlated will also disable energy conservation.
  135335. */
  135336. useSmithVisibilityHeightCorrelated: boolean;
  135337. private _useSphericalHarmonics;
  135338. /**
  135339. * LEGACY Mode set to false
  135340. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  135341. * diffuse part of the IBL.
  135342. * The harmonics despite a tiny bigger cost has been proven to provide closer results
  135343. * to the ground truth.
  135344. */
  135345. useSphericalHarmonics: boolean;
  135346. private _useSpecularGlossinessInputEnergyConservation;
  135347. /**
  135348. * Defines if the material uses energy conservation, when the specular workflow is active.
  135349. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  135350. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  135351. * In the deactivated case, the material author has to ensure energy conservation, for a physically plausible rendering.
  135352. */
  135353. useSpecularGlossinessInputEnergyConservation: boolean;
  135354. /** @hidden */
  135355. private _internalMarkAllSubMeshesAsMiscDirty;
  135356. /** @hidden */
  135357. _markAllSubMeshesAsMiscDirty(): void;
  135358. /**
  135359. * Instantiate a new istance of clear coat configuration.
  135360. * @param markAllSubMeshesAsMiscDirty Callback to flag the material to dirty
  135361. */
  135362. constructor(markAllSubMeshesAsMiscDirty: () => void);
  135363. /**
  135364. * Checks to see if a texture is used in the material.
  135365. * @param defines the list of "defines" to update.
  135366. */
  135367. prepareDefines(defines: IMaterialBRDFDefines): void;
  135368. /**
  135369. * Get the current class name of the texture useful for serialization or dynamic coding.
  135370. * @returns "PBRClearCoatConfiguration"
  135371. */
  135372. getClassName(): string;
  135373. /**
  135374. * Makes a duplicate of the current configuration into another one.
  135375. * @param brdfConfiguration define the config where to copy the info
  135376. */
  135377. copyTo(brdfConfiguration: PBRBRDFConfiguration): void;
  135378. /**
  135379. * Serializes this BRDF configuration.
  135380. * @returns - An object with the serialized config.
  135381. */
  135382. serialize(): any;
  135383. /**
  135384. * Parses a anisotropy Configuration from a serialized object.
  135385. * @param source - Serialized object.
  135386. * @param scene Defines the scene we are parsing for
  135387. * @param rootUrl Defines the rootUrl to load from
  135388. */
  135389. parse(source: any, scene: Scene, rootUrl: string): void;
  135390. }
  135391. }
  135392. declare module BABYLON {
  135393. /**
  135394. * @hidden
  135395. */
  135396. export interface IMaterialSheenDefines {
  135397. SHEEN: boolean;
  135398. SHEEN_TEXTURE: boolean;
  135399. SHEEN_TEXTUREDIRECTUV: number;
  135400. SHEEN_LINKWITHALBEDO: boolean;
  135401. SHEEN_ROUGHNESS: boolean;
  135402. SHEEN_ALBEDOSCALING: boolean;
  135403. /** @hidden */
  135404. _areTexturesDirty: boolean;
  135405. }
  135406. /**
  135407. * Define the code related to the Sheen parameters of the pbr material.
  135408. */
  135409. export class PBRSheenConfiguration {
  135410. private _isEnabled;
  135411. /**
  135412. * Defines if the material uses sheen.
  135413. */
  135414. isEnabled: boolean;
  135415. private _linkSheenWithAlbedo;
  135416. /**
  135417. * Defines if the sheen is linked to the sheen color.
  135418. */
  135419. linkSheenWithAlbedo: boolean;
  135420. /**
  135421. * Defines the sheen intensity.
  135422. */
  135423. intensity: number;
  135424. /**
  135425. * Defines the sheen color.
  135426. */
  135427. color: Color3;
  135428. private _texture;
  135429. /**
  135430. * Stores the sheen tint values in a texture.
  135431. * rgb is tint
  135432. * a is a intensity or roughness if roughness has been defined
  135433. */
  135434. texture: Nullable<BaseTexture>;
  135435. private _roughness;
  135436. /**
  135437. * Defines the sheen roughness.
  135438. * It is not taken into account if linkSheenWithAlbedo is true.
  135439. * To stay backward compatible, material roughness is used instead if sheen roughness = null
  135440. */
  135441. roughness: Nullable<number>;
  135442. private _albedoScaling;
  135443. /**
  135444. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  135445. * It allows the strength of the sheen effect to not depend on the base color of the material,
  135446. * making it easier to setup and tweak the effect
  135447. */
  135448. albedoScaling: boolean;
  135449. /** @hidden */
  135450. private _internalMarkAllSubMeshesAsTexturesDirty;
  135451. /** @hidden */
  135452. _markAllSubMeshesAsTexturesDirty(): void;
  135453. /**
  135454. * Instantiate a new istance of clear coat configuration.
  135455. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  135456. */
  135457. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  135458. /**
  135459. * Specifies that the submesh is ready to be used.
  135460. * @param defines the list of "defines" to update.
  135461. * @param scene defines the scene the material belongs to.
  135462. * @returns - boolean indicating that the submesh is ready or not.
  135463. */
  135464. isReadyForSubMesh(defines: IMaterialSheenDefines, scene: Scene): boolean;
  135465. /**
  135466. * Checks to see if a texture is used in the material.
  135467. * @param defines the list of "defines" to update.
  135468. * @param scene defines the scene the material belongs to.
  135469. */
  135470. prepareDefines(defines: IMaterialSheenDefines, scene: Scene): void;
  135471. /**
  135472. * Binds the material data.
  135473. * @param uniformBuffer defines the Uniform buffer to fill in.
  135474. * @param scene defines the scene the material belongs to.
  135475. * @param isFrozen defines wether the material is frozen or not.
  135476. */
  135477. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  135478. /**
  135479. * Checks to see if a texture is used in the material.
  135480. * @param texture - Base texture to use.
  135481. * @returns - Boolean specifying if a texture is used in the material.
  135482. */
  135483. hasTexture(texture: BaseTexture): boolean;
  135484. /**
  135485. * Returns an array of the actively used textures.
  135486. * @param activeTextures Array of BaseTextures
  135487. */
  135488. getActiveTextures(activeTextures: BaseTexture[]): void;
  135489. /**
  135490. * Returns the animatable textures.
  135491. * @param animatables Array of animatable textures.
  135492. */
  135493. getAnimatables(animatables: IAnimatable[]): void;
  135494. /**
  135495. * Disposes the resources of the material.
  135496. * @param forceDisposeTextures - Forces the disposal of all textures.
  135497. */
  135498. dispose(forceDisposeTextures?: boolean): void;
  135499. /**
  135500. * Get the current class name of the texture useful for serialization or dynamic coding.
  135501. * @returns "PBRSheenConfiguration"
  135502. */
  135503. getClassName(): string;
  135504. /**
  135505. * Add fallbacks to the effect fallbacks list.
  135506. * @param defines defines the Base texture to use.
  135507. * @param fallbacks defines the current fallback list.
  135508. * @param currentRank defines the current fallback rank.
  135509. * @returns the new fallback rank.
  135510. */
  135511. static AddFallbacks(defines: IMaterialSheenDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  135512. /**
  135513. * Add the required uniforms to the current list.
  135514. * @param uniforms defines the current uniform list.
  135515. */
  135516. static AddUniforms(uniforms: string[]): void;
  135517. /**
  135518. * Add the required uniforms to the current buffer.
  135519. * @param uniformBuffer defines the current uniform buffer.
  135520. */
  135521. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  135522. /**
  135523. * Add the required samplers to the current list.
  135524. * @param samplers defines the current sampler list.
  135525. */
  135526. static AddSamplers(samplers: string[]): void;
  135527. /**
  135528. * Makes a duplicate of the current configuration into another one.
  135529. * @param sheenConfiguration define the config where to copy the info
  135530. */
  135531. copyTo(sheenConfiguration: PBRSheenConfiguration): void;
  135532. /**
  135533. * Serializes this BRDF configuration.
  135534. * @returns - An object with the serialized config.
  135535. */
  135536. serialize(): any;
  135537. /**
  135538. * Parses a anisotropy Configuration from a serialized object.
  135539. * @param source - Serialized object.
  135540. * @param scene Defines the scene we are parsing for
  135541. * @param rootUrl Defines the rootUrl to load from
  135542. */
  135543. parse(source: any, scene: Scene, rootUrl: string): void;
  135544. }
  135545. }
  135546. declare module BABYLON {
  135547. /**
  135548. * @hidden
  135549. */
  135550. export interface IMaterialSubSurfaceDefines {
  135551. SUBSURFACE: boolean;
  135552. SS_REFRACTION: boolean;
  135553. SS_TRANSLUCENCY: boolean;
  135554. SS_SCATTERING: boolean;
  135555. SS_THICKNESSANDMASK_TEXTURE: boolean;
  135556. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  135557. SS_REFRACTIONMAP_3D: boolean;
  135558. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  135559. SS_LODINREFRACTIONALPHA: boolean;
  135560. SS_GAMMAREFRACTION: boolean;
  135561. SS_RGBDREFRACTION: boolean;
  135562. SS_LINEARSPECULARREFRACTION: boolean;
  135563. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  135564. SS_ALBEDOFORREFRACTIONTINT: boolean;
  135565. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  135566. /** @hidden */
  135567. _areTexturesDirty: boolean;
  135568. }
  135569. /**
  135570. * Define the code related to the sub surface parameters of the pbr material.
  135571. */
  135572. export class PBRSubSurfaceConfiguration {
  135573. private _isRefractionEnabled;
  135574. /**
  135575. * Defines if the refraction is enabled in the material.
  135576. */
  135577. isRefractionEnabled: boolean;
  135578. private _isTranslucencyEnabled;
  135579. /**
  135580. * Defines if the translucency is enabled in the material.
  135581. */
  135582. isTranslucencyEnabled: boolean;
  135583. private _isScatteringEnabled;
  135584. /**
  135585. * Defines if the sub surface scattering is enabled in the material.
  135586. */
  135587. isScatteringEnabled: boolean;
  135588. private _scatteringDiffusionProfileIndex;
  135589. /**
  135590. * Diffusion profile for subsurface scattering.
  135591. * Useful for better scattering in the skins or foliages.
  135592. */
  135593. get scatteringDiffusionProfile(): Nullable<Color3>;
  135594. set scatteringDiffusionProfile(c: Nullable<Color3>);
  135595. /**
  135596. * Defines the refraction intensity of the material.
  135597. * The refraction when enabled replaces the Diffuse part of the material.
  135598. * The intensity helps transitionning between diffuse and refraction.
  135599. */
  135600. refractionIntensity: number;
  135601. /**
  135602. * Defines the translucency intensity of the material.
  135603. * When translucency has been enabled, this defines how much of the "translucency"
  135604. * is addded to the diffuse part of the material.
  135605. */
  135606. translucencyIntensity: number;
  135607. /**
  135608. * When enabled, transparent surfaces will be tinted with the albedo colour (independent of thickness)
  135609. */
  135610. useAlbedoToTintRefraction: boolean;
  135611. private _thicknessTexture;
  135612. /**
  135613. * Stores the average thickness of a mesh in a texture (The texture is holding the values linearly).
  135614. * The red channel of the texture should contain the thickness remapped between 0 and 1.
  135615. * 0 would mean minimumThickness
  135616. * 1 would mean maximumThickness
  135617. * The other channels might be use as a mask to vary the different effects intensity.
  135618. */
  135619. thicknessTexture: Nullable<BaseTexture>;
  135620. private _refractionTexture;
  135621. /**
  135622. * Defines the texture to use for refraction.
  135623. */
  135624. refractionTexture: Nullable<BaseTexture>;
  135625. private _indexOfRefraction;
  135626. /**
  135627. * Index of refraction of the material base layer.
  135628. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  135629. *
  135630. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  135631. *
  135632. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  135633. */
  135634. indexOfRefraction: number;
  135635. private _volumeIndexOfRefraction;
  135636. /**
  135637. * Index of refraction of the material's volume.
  135638. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  135639. *
  135640. * This ONLY impacts refraction. If not provided or given a non-valid value,
  135641. * the volume will use the same IOR as the surface.
  135642. */
  135643. get volumeIndexOfRefraction(): number;
  135644. set volumeIndexOfRefraction(value: number);
  135645. private _invertRefractionY;
  135646. /**
  135647. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  135648. */
  135649. invertRefractionY: boolean;
  135650. private _linkRefractionWithTransparency;
  135651. /**
  135652. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  135653. * Materials half opaque for instance using refraction could benefit from this control.
  135654. */
  135655. linkRefractionWithTransparency: boolean;
  135656. /**
  135657. * Defines the minimum thickness stored in the thickness map.
  135658. * If no thickness map is defined, this value will be used to simulate thickness.
  135659. */
  135660. minimumThickness: number;
  135661. /**
  135662. * Defines the maximum thickness stored in the thickness map.
  135663. */
  135664. maximumThickness: number;
  135665. /**
  135666. * Defines the volume tint of the material.
  135667. * This is used for both translucency and scattering.
  135668. */
  135669. tintColor: Color3;
  135670. /**
  135671. * Defines the distance at which the tint color should be found in the media.
  135672. * This is used for refraction only.
  135673. */
  135674. tintColorAtDistance: number;
  135675. /**
  135676. * Defines how far each channel transmit through the media.
  135677. * It is defined as a color to simplify it selection.
  135678. */
  135679. diffusionDistance: Color3;
  135680. private _useMaskFromThicknessTexture;
  135681. /**
  135682. * Stores the intensity of the different subsurface effects in the thickness texture.
  135683. * * the green channel is the translucency intensity.
  135684. * * the blue channel is the scattering intensity.
  135685. * * the alpha channel is the refraction intensity.
  135686. */
  135687. useMaskFromThicknessTexture: boolean;
  135688. private _scene;
  135689. /** @hidden */
  135690. private _internalMarkAllSubMeshesAsTexturesDirty;
  135691. private _internalMarkScenePrePassDirty;
  135692. /** @hidden */
  135693. _markAllSubMeshesAsTexturesDirty(): void;
  135694. /** @hidden */
  135695. _markScenePrePassDirty(): void;
  135696. /**
  135697. * Instantiate a new istance of sub surface configuration.
  135698. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  135699. * @param markScenePrePassDirty Callback to flag the scene as prepass dirty
  135700. * @param scene The scene
  135701. */
  135702. constructor(markAllSubMeshesAsTexturesDirty: () => void, markScenePrePassDirty: () => void, scene: Scene);
  135703. /**
  135704. * Gets wehter the submesh is ready to be used or not.
  135705. * @param defines the list of "defines" to update.
  135706. * @param scene defines the scene the material belongs to.
  135707. * @returns - boolean indicating that the submesh is ready or not.
  135708. */
  135709. isReadyForSubMesh(defines: IMaterialSubSurfaceDefines, scene: Scene): boolean;
  135710. /**
  135711. * Checks to see if a texture is used in the material.
  135712. * @param defines the list of "defines" to update.
  135713. * @param scene defines the scene to the material belongs to.
  135714. */
  135715. prepareDefines(defines: IMaterialSubSurfaceDefines, scene: Scene): void;
  135716. /**
  135717. * Binds the material data.
  135718. * @param uniformBuffer defines the Uniform buffer to fill in.
  135719. * @param scene defines the scene the material belongs to.
  135720. * @param engine defines the engine the material belongs to.
  135721. * @param isFrozen defines whether the material is frozen or not.
  135722. * @param lodBasedMicrosurface defines whether the material relies on lod based microsurface or not.
  135723. * @param realTimeFiltering defines whether the textures should be filtered on the fly.
  135724. */
  135725. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, isFrozen: boolean, lodBasedMicrosurface: boolean, realTimeFiltering: boolean): void;
  135726. /**
  135727. * Unbinds the material from the mesh.
  135728. * @param activeEffect defines the effect that should be unbound from.
  135729. * @returns true if unbound, otherwise false
  135730. */
  135731. unbind(activeEffect: Effect): boolean;
  135732. /**
  135733. * Returns the texture used for refraction or null if none is used.
  135734. * @param scene defines the scene the material belongs to.
  135735. * @returns - Refraction texture if present. If no refraction texture and refraction
  135736. * is linked with transparency, returns environment texture. Otherwise, returns null.
  135737. */
  135738. private _getRefractionTexture;
  135739. /**
  135740. * Returns true if alpha blending should be disabled.
  135741. */
  135742. get disableAlphaBlending(): boolean;
  135743. /**
  135744. * Fills the list of render target textures.
  135745. * @param renderTargets the list of render targets to update
  135746. */
  135747. fillRenderTargetTextures(renderTargets: SmartArray<RenderTargetTexture>): void;
  135748. /**
  135749. * Checks to see if a texture is used in the material.
  135750. * @param texture - Base texture to use.
  135751. * @returns - Boolean specifying if a texture is used in the material.
  135752. */
  135753. hasTexture(texture: BaseTexture): boolean;
  135754. /**
  135755. * Gets a boolean indicating that current material needs to register RTT
  135756. * @returns true if this uses a render target otherwise false.
  135757. */
  135758. hasRenderTargetTextures(): boolean;
  135759. /**
  135760. * Returns an array of the actively used textures.
  135761. * @param activeTextures Array of BaseTextures
  135762. */
  135763. getActiveTextures(activeTextures: BaseTexture[]): void;
  135764. /**
  135765. * Returns the animatable textures.
  135766. * @param animatables Array of animatable textures.
  135767. */
  135768. getAnimatables(animatables: IAnimatable[]): void;
  135769. /**
  135770. * Disposes the resources of the material.
  135771. * @param forceDisposeTextures - Forces the disposal of all textures.
  135772. */
  135773. dispose(forceDisposeTextures?: boolean): void;
  135774. /**
  135775. * Get the current class name of the texture useful for serialization or dynamic coding.
  135776. * @returns "PBRSubSurfaceConfiguration"
  135777. */
  135778. getClassName(): string;
  135779. /**
  135780. * Add fallbacks to the effect fallbacks list.
  135781. * @param defines defines the Base texture to use.
  135782. * @param fallbacks defines the current fallback list.
  135783. * @param currentRank defines the current fallback rank.
  135784. * @returns the new fallback rank.
  135785. */
  135786. static AddFallbacks(defines: IMaterialSubSurfaceDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  135787. /**
  135788. * Add the required uniforms to the current list.
  135789. * @param uniforms defines the current uniform list.
  135790. */
  135791. static AddUniforms(uniforms: string[]): void;
  135792. /**
  135793. * Add the required samplers to the current list.
  135794. * @param samplers defines the current sampler list.
  135795. */
  135796. static AddSamplers(samplers: string[]): void;
  135797. /**
  135798. * Add the required uniforms to the current buffer.
  135799. * @param uniformBuffer defines the current uniform buffer.
  135800. */
  135801. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  135802. /**
  135803. * Makes a duplicate of the current configuration into another one.
  135804. * @param configuration define the config where to copy the info
  135805. */
  135806. copyTo(configuration: PBRSubSurfaceConfiguration): void;
  135807. /**
  135808. * Serializes this Sub Surface configuration.
  135809. * @returns - An object with the serialized config.
  135810. */
  135811. serialize(): any;
  135812. /**
  135813. * Parses a anisotropy Configuration from a serialized object.
  135814. * @param source - Serialized object.
  135815. * @param scene Defines the scene we are parsing for
  135816. * @param rootUrl Defines the rootUrl to load from
  135817. */
  135818. parse(source: any, scene: Scene, rootUrl: string): void;
  135819. }
  135820. }
  135821. declare module BABYLON {
  135822. /** @hidden */
  135823. export var pbrFragmentDeclaration: {
  135824. name: string;
  135825. shader: string;
  135826. };
  135827. }
  135828. declare module BABYLON {
  135829. /** @hidden */
  135830. export var pbrUboDeclaration: {
  135831. name: string;
  135832. shader: string;
  135833. };
  135834. }
  135835. declare module BABYLON {
  135836. /** @hidden */
  135837. export var pbrFragmentExtraDeclaration: {
  135838. name: string;
  135839. shader: string;
  135840. };
  135841. }
  135842. declare module BABYLON {
  135843. /** @hidden */
  135844. export var pbrFragmentSamplersDeclaration: {
  135845. name: string;
  135846. shader: string;
  135847. };
  135848. }
  135849. declare module BABYLON {
  135850. /** @hidden */
  135851. export var importanceSampling: {
  135852. name: string;
  135853. shader: string;
  135854. };
  135855. }
  135856. declare module BABYLON {
  135857. /** @hidden */
  135858. export var pbrHelperFunctions: {
  135859. name: string;
  135860. shader: string;
  135861. };
  135862. }
  135863. declare module BABYLON {
  135864. /** @hidden */
  135865. export var harmonicsFunctions: {
  135866. name: string;
  135867. shader: string;
  135868. };
  135869. }
  135870. declare module BABYLON {
  135871. /** @hidden */
  135872. export var pbrDirectLightingSetupFunctions: {
  135873. name: string;
  135874. shader: string;
  135875. };
  135876. }
  135877. declare module BABYLON {
  135878. /** @hidden */
  135879. export var pbrDirectLightingFalloffFunctions: {
  135880. name: string;
  135881. shader: string;
  135882. };
  135883. }
  135884. declare module BABYLON {
  135885. /** @hidden */
  135886. export var pbrBRDFFunctions: {
  135887. name: string;
  135888. shader: string;
  135889. };
  135890. }
  135891. declare module BABYLON {
  135892. /** @hidden */
  135893. export var hdrFilteringFunctions: {
  135894. name: string;
  135895. shader: string;
  135896. };
  135897. }
  135898. declare module BABYLON {
  135899. /** @hidden */
  135900. export var pbrDirectLightingFunctions: {
  135901. name: string;
  135902. shader: string;
  135903. };
  135904. }
  135905. declare module BABYLON {
  135906. /** @hidden */
  135907. export var pbrIBLFunctions: {
  135908. name: string;
  135909. shader: string;
  135910. };
  135911. }
  135912. declare module BABYLON {
  135913. /** @hidden */
  135914. export var pbrBlockAlbedoOpacity: {
  135915. name: string;
  135916. shader: string;
  135917. };
  135918. }
  135919. declare module BABYLON {
  135920. /** @hidden */
  135921. export var pbrBlockReflectivity: {
  135922. name: string;
  135923. shader: string;
  135924. };
  135925. }
  135926. declare module BABYLON {
  135927. /** @hidden */
  135928. export var pbrBlockAmbientOcclusion: {
  135929. name: string;
  135930. shader: string;
  135931. };
  135932. }
  135933. declare module BABYLON {
  135934. /** @hidden */
  135935. export var pbrBlockAlphaFresnel: {
  135936. name: string;
  135937. shader: string;
  135938. };
  135939. }
  135940. declare module BABYLON {
  135941. /** @hidden */
  135942. export var pbrBlockAnisotropic: {
  135943. name: string;
  135944. shader: string;
  135945. };
  135946. }
  135947. declare module BABYLON {
  135948. /** @hidden */
  135949. export var pbrBlockReflection: {
  135950. name: string;
  135951. shader: string;
  135952. };
  135953. }
  135954. declare module BABYLON {
  135955. /** @hidden */
  135956. export var pbrBlockSheen: {
  135957. name: string;
  135958. shader: string;
  135959. };
  135960. }
  135961. declare module BABYLON {
  135962. /** @hidden */
  135963. export var pbrBlockClearcoat: {
  135964. name: string;
  135965. shader: string;
  135966. };
  135967. }
  135968. declare module BABYLON {
  135969. /** @hidden */
  135970. export var pbrBlockSubSurface: {
  135971. name: string;
  135972. shader: string;
  135973. };
  135974. }
  135975. declare module BABYLON {
  135976. /** @hidden */
  135977. export var pbrBlockNormalGeometric: {
  135978. name: string;
  135979. shader: string;
  135980. };
  135981. }
  135982. declare module BABYLON {
  135983. /** @hidden */
  135984. export var pbrBlockNormalFinal: {
  135985. name: string;
  135986. shader: string;
  135987. };
  135988. }
  135989. declare module BABYLON {
  135990. /** @hidden */
  135991. export var pbrBlockLightmapInit: {
  135992. name: string;
  135993. shader: string;
  135994. };
  135995. }
  135996. declare module BABYLON {
  135997. /** @hidden */
  135998. export var pbrBlockGeometryInfo: {
  135999. name: string;
  136000. shader: string;
  136001. };
  136002. }
  136003. declare module BABYLON {
  136004. /** @hidden */
  136005. export var pbrBlockReflectance0: {
  136006. name: string;
  136007. shader: string;
  136008. };
  136009. }
  136010. declare module BABYLON {
  136011. /** @hidden */
  136012. export var pbrBlockReflectance: {
  136013. name: string;
  136014. shader: string;
  136015. };
  136016. }
  136017. declare module BABYLON {
  136018. /** @hidden */
  136019. export var pbrBlockDirectLighting: {
  136020. name: string;
  136021. shader: string;
  136022. };
  136023. }
  136024. declare module BABYLON {
  136025. /** @hidden */
  136026. export var pbrBlockFinalLitComponents: {
  136027. name: string;
  136028. shader: string;
  136029. };
  136030. }
  136031. declare module BABYLON {
  136032. /** @hidden */
  136033. export var pbrBlockFinalUnlitComponents: {
  136034. name: string;
  136035. shader: string;
  136036. };
  136037. }
  136038. declare module BABYLON {
  136039. /** @hidden */
  136040. export var pbrBlockFinalColorComposition: {
  136041. name: string;
  136042. shader: string;
  136043. };
  136044. }
  136045. declare module BABYLON {
  136046. /** @hidden */
  136047. export var pbrBlockImageProcessing: {
  136048. name: string;
  136049. shader: string;
  136050. };
  136051. }
  136052. declare module BABYLON {
  136053. /** @hidden */
  136054. export var pbrDebug: {
  136055. name: string;
  136056. shader: string;
  136057. };
  136058. }
  136059. declare module BABYLON {
  136060. /** @hidden */
  136061. export var pbrPixelShader: {
  136062. name: string;
  136063. shader: string;
  136064. };
  136065. }
  136066. declare module BABYLON {
  136067. /** @hidden */
  136068. export var pbrVertexDeclaration: {
  136069. name: string;
  136070. shader: string;
  136071. };
  136072. }
  136073. declare module BABYLON {
  136074. /** @hidden */
  136075. export var pbrVertexShader: {
  136076. name: string;
  136077. shader: string;
  136078. };
  136079. }
  136080. declare module BABYLON {
  136081. /**
  136082. * Manages the defines for the PBR Material.
  136083. * @hidden
  136084. */
  136085. export class PBRMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialClearCoatDefines, IMaterialAnisotropicDefines, IMaterialBRDFDefines, IMaterialSheenDefines, IMaterialSubSurfaceDefines, IMaterialDetailMapDefines {
  136086. PBR: boolean;
  136087. NUM_SAMPLES: string;
  136088. REALTIME_FILTERING: boolean;
  136089. MAINUV1: boolean;
  136090. MAINUV2: boolean;
  136091. UV1: boolean;
  136092. UV2: boolean;
  136093. ALBEDO: boolean;
  136094. GAMMAALBEDO: boolean;
  136095. ALBEDODIRECTUV: number;
  136096. VERTEXCOLOR: boolean;
  136097. DETAIL: boolean;
  136098. DETAILDIRECTUV: number;
  136099. DETAIL_NORMALBLENDMETHOD: number;
  136100. AMBIENT: boolean;
  136101. AMBIENTDIRECTUV: number;
  136102. AMBIENTINGRAYSCALE: boolean;
  136103. OPACITY: boolean;
  136104. VERTEXALPHA: boolean;
  136105. OPACITYDIRECTUV: number;
  136106. OPACITYRGB: boolean;
  136107. ALPHATEST: boolean;
  136108. DEPTHPREPASS: boolean;
  136109. ALPHABLEND: boolean;
  136110. ALPHAFROMALBEDO: boolean;
  136111. ALPHATESTVALUE: string;
  136112. SPECULAROVERALPHA: boolean;
  136113. RADIANCEOVERALPHA: boolean;
  136114. ALPHAFRESNEL: boolean;
  136115. LINEARALPHAFRESNEL: boolean;
  136116. PREMULTIPLYALPHA: boolean;
  136117. EMISSIVE: boolean;
  136118. EMISSIVEDIRECTUV: number;
  136119. REFLECTIVITY: boolean;
  136120. REFLECTIVITYDIRECTUV: number;
  136121. SPECULARTERM: boolean;
  136122. MICROSURFACEFROMREFLECTIVITYMAP: boolean;
  136123. MICROSURFACEAUTOMATIC: boolean;
  136124. LODBASEDMICROSFURACE: boolean;
  136125. MICROSURFACEMAP: boolean;
  136126. MICROSURFACEMAPDIRECTUV: number;
  136127. METALLICWORKFLOW: boolean;
  136128. ROUGHNESSSTOREINMETALMAPALPHA: boolean;
  136129. ROUGHNESSSTOREINMETALMAPGREEN: boolean;
  136130. METALLNESSSTOREINMETALMAPBLUE: boolean;
  136131. AOSTOREINMETALMAPRED: boolean;
  136132. METALLIC_REFLECTANCE: boolean;
  136133. METALLIC_REFLECTANCEDIRECTUV: number;
  136134. ENVIRONMENTBRDF: boolean;
  136135. ENVIRONMENTBRDF_RGBD: boolean;
  136136. NORMAL: boolean;
  136137. TANGENT: boolean;
  136138. BUMP: boolean;
  136139. BUMPDIRECTUV: number;
  136140. OBJECTSPACE_NORMALMAP: boolean;
  136141. PARALLAX: boolean;
  136142. PARALLAXOCCLUSION: boolean;
  136143. NORMALXYSCALE: boolean;
  136144. LIGHTMAP: boolean;
  136145. LIGHTMAPDIRECTUV: number;
  136146. USELIGHTMAPASSHADOWMAP: boolean;
  136147. GAMMALIGHTMAP: boolean;
  136148. RGBDLIGHTMAP: boolean;
  136149. REFLECTION: boolean;
  136150. REFLECTIONMAP_3D: boolean;
  136151. REFLECTIONMAP_SPHERICAL: boolean;
  136152. REFLECTIONMAP_PLANAR: boolean;
  136153. REFLECTIONMAP_CUBIC: boolean;
  136154. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  136155. REFLECTIONMAP_PROJECTION: boolean;
  136156. REFLECTIONMAP_SKYBOX: boolean;
  136157. REFLECTIONMAP_EXPLICIT: boolean;
  136158. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  136159. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  136160. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  136161. INVERTCUBICMAP: boolean;
  136162. USESPHERICALFROMREFLECTIONMAP: boolean;
  136163. USEIRRADIANCEMAP: boolean;
  136164. SPHERICAL_HARMONICS: boolean;
  136165. USESPHERICALINVERTEX: boolean;
  136166. REFLECTIONMAP_OPPOSITEZ: boolean;
  136167. LODINREFLECTIONALPHA: boolean;
  136168. GAMMAREFLECTION: boolean;
  136169. RGBDREFLECTION: boolean;
  136170. LINEARSPECULARREFLECTION: boolean;
  136171. RADIANCEOCCLUSION: boolean;
  136172. HORIZONOCCLUSION: boolean;
  136173. INSTANCES: boolean;
  136174. THIN_INSTANCES: boolean;
  136175. PREPASS: boolean;
  136176. SCENE_MRT_COUNT: number;
  136177. NUM_BONE_INFLUENCERS: number;
  136178. BonesPerMesh: number;
  136179. BONETEXTURE: boolean;
  136180. NONUNIFORMSCALING: boolean;
  136181. MORPHTARGETS: boolean;
  136182. MORPHTARGETS_NORMAL: boolean;
  136183. MORPHTARGETS_TANGENT: boolean;
  136184. MORPHTARGETS_UV: boolean;
  136185. NUM_MORPH_INFLUENCERS: number;
  136186. IMAGEPROCESSING: boolean;
  136187. VIGNETTE: boolean;
  136188. VIGNETTEBLENDMODEMULTIPLY: boolean;
  136189. VIGNETTEBLENDMODEOPAQUE: boolean;
  136190. TONEMAPPING: boolean;
  136191. TONEMAPPING_ACES: boolean;
  136192. CONTRAST: boolean;
  136193. COLORCURVES: boolean;
  136194. COLORGRADING: boolean;
  136195. COLORGRADING3D: boolean;
  136196. SAMPLER3DGREENDEPTH: boolean;
  136197. SAMPLER3DBGRMAP: boolean;
  136198. IMAGEPROCESSINGPOSTPROCESS: boolean;
  136199. EXPOSURE: boolean;
  136200. MULTIVIEW: boolean;
  136201. USEPHYSICALLIGHTFALLOFF: boolean;
  136202. USEGLTFLIGHTFALLOFF: boolean;
  136203. TWOSIDEDLIGHTING: boolean;
  136204. SHADOWFLOAT: boolean;
  136205. CLIPPLANE: boolean;
  136206. CLIPPLANE2: boolean;
  136207. CLIPPLANE3: boolean;
  136208. CLIPPLANE4: boolean;
  136209. CLIPPLANE5: boolean;
  136210. CLIPPLANE6: boolean;
  136211. POINTSIZE: boolean;
  136212. FOG: boolean;
  136213. LOGARITHMICDEPTH: boolean;
  136214. FORCENORMALFORWARD: boolean;
  136215. SPECULARAA: boolean;
  136216. CLEARCOAT: boolean;
  136217. CLEARCOAT_DEFAULTIOR: boolean;
  136218. CLEARCOAT_TEXTURE: boolean;
  136219. CLEARCOAT_TEXTUREDIRECTUV: number;
  136220. CLEARCOAT_BUMP: boolean;
  136221. CLEARCOAT_BUMPDIRECTUV: number;
  136222. CLEARCOAT_TINT: boolean;
  136223. CLEARCOAT_TINT_TEXTURE: boolean;
  136224. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  136225. ANISOTROPIC: boolean;
  136226. ANISOTROPIC_TEXTURE: boolean;
  136227. ANISOTROPIC_TEXTUREDIRECTUV: number;
  136228. BRDF_V_HEIGHT_CORRELATED: boolean;
  136229. MS_BRDF_ENERGY_CONSERVATION: boolean;
  136230. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  136231. SHEEN: boolean;
  136232. SHEEN_TEXTURE: boolean;
  136233. SHEEN_TEXTUREDIRECTUV: number;
  136234. SHEEN_LINKWITHALBEDO: boolean;
  136235. SHEEN_ROUGHNESS: boolean;
  136236. SHEEN_ALBEDOSCALING: boolean;
  136237. SUBSURFACE: boolean;
  136238. SS_REFRACTION: boolean;
  136239. SS_TRANSLUCENCY: boolean;
  136240. SS_SCATTERING: boolean;
  136241. SS_THICKNESSANDMASK_TEXTURE: boolean;
  136242. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  136243. SS_REFRACTIONMAP_3D: boolean;
  136244. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  136245. SS_LODINREFRACTIONALPHA: boolean;
  136246. SS_GAMMAREFRACTION: boolean;
  136247. SS_RGBDREFRACTION: boolean;
  136248. SS_LINEARSPECULARREFRACTION: boolean;
  136249. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  136250. SS_ALBEDOFORREFRACTIONTINT: boolean;
  136251. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  136252. UNLIT: boolean;
  136253. DEBUGMODE: number;
  136254. /**
  136255. * Initializes the PBR Material defines.
  136256. */
  136257. constructor();
  136258. /**
  136259. * Resets the PBR Material defines.
  136260. */
  136261. reset(): void;
  136262. }
  136263. /**
  136264. * The Physically based material base class of BJS.
  136265. *
  136266. * This offers the main features of a standard PBR material.
  136267. * For more information, please refer to the documentation :
  136268. * https://doc.babylonjs.com/how_to/physically_based_rendering
  136269. */
  136270. export abstract class PBRBaseMaterial extends PushMaterial {
  136271. /**
  136272. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  136273. */
  136274. static readonly PBRMATERIAL_OPAQUE: number;
  136275. /**
  136276. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  136277. */
  136278. static readonly PBRMATERIAL_ALPHATEST: number;
  136279. /**
  136280. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  136281. */
  136282. static readonly PBRMATERIAL_ALPHABLEND: number;
  136283. /**
  136284. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  136285. * They are also discarded below the alpha cutoff threshold to improve performances.
  136286. */
  136287. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  136288. /**
  136289. * Defines the default value of how much AO map is occluding the analytical lights
  136290. * (point spot...).
  136291. */
  136292. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  136293. /**
  136294. * PBRMaterialLightFalloff Physical: light is falling off following the inverse squared distance law.
  136295. */
  136296. static readonly LIGHTFALLOFF_PHYSICAL: number;
  136297. /**
  136298. * PBRMaterialLightFalloff gltf: light is falling off as described in the gltf moving to PBR document
  136299. * to enhance interoperability with other engines.
  136300. */
  136301. static readonly LIGHTFALLOFF_GLTF: number;
  136302. /**
  136303. * PBRMaterialLightFalloff Standard: light is falling off like in the standard material
  136304. * to enhance interoperability with other materials.
  136305. */
  136306. static readonly LIGHTFALLOFF_STANDARD: number;
  136307. /**
  136308. * Intensity of the direct lights e.g. the four lights available in your scene.
  136309. * This impacts both the direct diffuse and specular highlights.
  136310. */
  136311. protected _directIntensity: number;
  136312. /**
  136313. * Intensity of the emissive part of the material.
  136314. * This helps controlling the emissive effect without modifying the emissive color.
  136315. */
  136316. protected _emissiveIntensity: number;
  136317. /**
  136318. * Intensity of the environment e.g. how much the environment will light the object
  136319. * either through harmonics for rough material or through the refelction for shiny ones.
  136320. */
  136321. protected _environmentIntensity: number;
  136322. /**
  136323. * This is a special control allowing the reduction of the specular highlights coming from the
  136324. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  136325. */
  136326. protected _specularIntensity: number;
  136327. /**
  136328. * This stores the direct, emissive, environment, and specular light intensities into a Vector4.
  136329. */
  136330. private _lightingInfos;
  136331. /**
  136332. * Debug Control allowing disabling the bump map on this material.
  136333. */
  136334. protected _disableBumpMap: boolean;
  136335. /**
  136336. * AKA Diffuse Texture in standard nomenclature.
  136337. */
  136338. protected _albedoTexture: Nullable<BaseTexture>;
  136339. /**
  136340. * AKA Occlusion Texture in other nomenclature.
  136341. */
  136342. protected _ambientTexture: Nullable<BaseTexture>;
  136343. /**
  136344. * AKA Occlusion Texture Intensity in other nomenclature.
  136345. */
  136346. protected _ambientTextureStrength: number;
  136347. /**
  136348. * Defines how much the AO map is occluding the analytical lights (point spot...).
  136349. * 1 means it completely occludes it
  136350. * 0 mean it has no impact
  136351. */
  136352. protected _ambientTextureImpactOnAnalyticalLights: number;
  136353. /**
  136354. * Stores the alpha values in a texture.
  136355. */
  136356. protected _opacityTexture: Nullable<BaseTexture>;
  136357. /**
  136358. * Stores the reflection values in a texture.
  136359. */
  136360. protected _reflectionTexture: Nullable<BaseTexture>;
  136361. /**
  136362. * Stores the emissive values in a texture.
  136363. */
  136364. protected _emissiveTexture: Nullable<BaseTexture>;
  136365. /**
  136366. * AKA Specular texture in other nomenclature.
  136367. */
  136368. protected _reflectivityTexture: Nullable<BaseTexture>;
  136369. /**
  136370. * Used to switch from specular/glossiness to metallic/roughness workflow.
  136371. */
  136372. protected _metallicTexture: Nullable<BaseTexture>;
  136373. /**
  136374. * Specifies the metallic scalar of the metallic/roughness workflow.
  136375. * Can also be used to scale the metalness values of the metallic texture.
  136376. */
  136377. protected _metallic: Nullable<number>;
  136378. /**
  136379. * Specifies the roughness scalar of the metallic/roughness workflow.
  136380. * Can also be used to scale the roughness values of the metallic texture.
  136381. */
  136382. protected _roughness: Nullable<number>;
  136383. /**
  136384. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  136385. * By default the indexOfrefraction is used to compute F0;
  136386. *
  136387. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  136388. *
  136389. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  136390. * F90 = metallicReflectanceColor;
  136391. */
  136392. protected _metallicF0Factor: number;
  136393. /**
  136394. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  136395. * By default the F90 is always 1;
  136396. *
  136397. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  136398. *
  136399. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  136400. * F90 = metallicReflectanceColor;
  136401. */
  136402. protected _metallicReflectanceColor: Color3;
  136403. /**
  136404. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  136405. * This is multiply against the scalar values defined in the material.
  136406. */
  136407. protected _metallicReflectanceTexture: Nullable<BaseTexture>;
  136408. /**
  136409. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  136410. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  136411. */
  136412. protected _microSurfaceTexture: Nullable<BaseTexture>;
  136413. /**
  136414. * Stores surface normal data used to displace a mesh in a texture.
  136415. */
  136416. protected _bumpTexture: Nullable<BaseTexture>;
  136417. /**
  136418. * Stores the pre-calculated light information of a mesh in a texture.
  136419. */
  136420. protected _lightmapTexture: Nullable<BaseTexture>;
  136421. /**
  136422. * The color of a material in ambient lighting.
  136423. */
  136424. protected _ambientColor: Color3;
  136425. /**
  136426. * AKA Diffuse Color in other nomenclature.
  136427. */
  136428. protected _albedoColor: Color3;
  136429. /**
  136430. * AKA Specular Color in other nomenclature.
  136431. */
  136432. protected _reflectivityColor: Color3;
  136433. /**
  136434. * The color applied when light is reflected from a material.
  136435. */
  136436. protected _reflectionColor: Color3;
  136437. /**
  136438. * The color applied when light is emitted from a material.
  136439. */
  136440. protected _emissiveColor: Color3;
  136441. /**
  136442. * AKA Glossiness in other nomenclature.
  136443. */
  136444. protected _microSurface: number;
  136445. /**
  136446. * Specifies that the material will use the light map as a show map.
  136447. */
  136448. protected _useLightmapAsShadowmap: boolean;
  136449. /**
  136450. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  136451. * makes the reflect vector face the model (under horizon).
  136452. */
  136453. protected _useHorizonOcclusion: boolean;
  136454. /**
  136455. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  136456. * too much the area relying on ambient texture to define their ambient occlusion.
  136457. */
  136458. protected _useRadianceOcclusion: boolean;
  136459. /**
  136460. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  136461. */
  136462. protected _useAlphaFromAlbedoTexture: boolean;
  136463. /**
  136464. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most limunous ones).
  136465. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  136466. */
  136467. protected _useSpecularOverAlpha: boolean;
  136468. /**
  136469. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  136470. */
  136471. protected _useMicroSurfaceFromReflectivityMapAlpha: boolean;
  136472. /**
  136473. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  136474. */
  136475. protected _useRoughnessFromMetallicTextureAlpha: boolean;
  136476. /**
  136477. * Specifies if the metallic texture contains the roughness information in its green channel.
  136478. */
  136479. protected _useRoughnessFromMetallicTextureGreen: boolean;
  136480. /**
  136481. * Specifies if the metallic texture contains the metallness information in its blue channel.
  136482. */
  136483. protected _useMetallnessFromMetallicTextureBlue: boolean;
  136484. /**
  136485. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  136486. */
  136487. protected _useAmbientOcclusionFromMetallicTextureRed: boolean;
  136488. /**
  136489. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  136490. */
  136491. protected _useAmbientInGrayScale: boolean;
  136492. /**
  136493. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  136494. * The material will try to infer what glossiness each pixel should be.
  136495. */
  136496. protected _useAutoMicroSurfaceFromReflectivityMap: boolean;
  136497. /**
  136498. * Defines the falloff type used in this material.
  136499. * It by default is Physical.
  136500. */
  136501. protected _lightFalloff: number;
  136502. /**
  136503. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  136504. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  136505. */
  136506. protected _useRadianceOverAlpha: boolean;
  136507. /**
  136508. * Allows using an object space normal map (instead of tangent space).
  136509. */
  136510. protected _useObjectSpaceNormalMap: boolean;
  136511. /**
  136512. * Allows using the bump map in parallax mode.
  136513. */
  136514. protected _useParallax: boolean;
  136515. /**
  136516. * Allows using the bump map in parallax occlusion mode.
  136517. */
  136518. protected _useParallaxOcclusion: boolean;
  136519. /**
  136520. * Controls the scale bias of the parallax mode.
  136521. */
  136522. protected _parallaxScaleBias: number;
  136523. /**
  136524. * If sets to true, disables all the lights affecting the material.
  136525. */
  136526. protected _disableLighting: boolean;
  136527. /**
  136528. * Number of Simultaneous lights allowed on the material.
  136529. */
  136530. protected _maxSimultaneousLights: number;
  136531. /**
  136532. * If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  136533. */
  136534. protected _invertNormalMapX: boolean;
  136535. /**
  136536. * If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  136537. */
  136538. protected _invertNormalMapY: boolean;
  136539. /**
  136540. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  136541. */
  136542. protected _twoSidedLighting: boolean;
  136543. /**
  136544. * Defines the alpha limits in alpha test mode.
  136545. */
  136546. protected _alphaCutOff: number;
  136547. /**
  136548. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  136549. */
  136550. protected _forceAlphaTest: boolean;
  136551. /**
  136552. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  136553. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  136554. */
  136555. protected _useAlphaFresnel: boolean;
  136556. /**
  136557. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  136558. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  136559. */
  136560. protected _useLinearAlphaFresnel: boolean;
  136561. /**
  136562. * Specifies the environment BRDF texture used to comput the scale and offset roughness values
  136563. * from cos thetav and roughness:
  136564. * http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf
  136565. */
  136566. protected _environmentBRDFTexture: Nullable<BaseTexture>;
  136567. /**
  136568. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  136569. */
  136570. protected _forceIrradianceInFragment: boolean;
  136571. private _realTimeFiltering;
  136572. /**
  136573. * Enables realtime filtering on the texture.
  136574. */
  136575. get realTimeFiltering(): boolean;
  136576. set realTimeFiltering(b: boolean);
  136577. private _realTimeFilteringQuality;
  136578. /**
  136579. * Quality switch for realtime filtering
  136580. */
  136581. get realTimeFilteringQuality(): number;
  136582. set realTimeFilteringQuality(n: number);
  136583. /**
  136584. * Can this material render to several textures at once
  136585. */
  136586. get canRenderToMRT(): boolean;
  136587. /**
  136588. * Force normal to face away from face.
  136589. */
  136590. protected _forceNormalForward: boolean;
  136591. /**
  136592. * Enables specular anti aliasing in the PBR shader.
  136593. * It will both interacts on the Geometry for analytical and IBL lighting.
  136594. * It also prefilter the roughness map based on the bump values.
  136595. */
  136596. protected _enableSpecularAntiAliasing: boolean;
  136597. /**
  136598. * Default configuration related to image processing available in the PBR Material.
  136599. */
  136600. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  136601. /**
  136602. * Keep track of the image processing observer to allow dispose and replace.
  136603. */
  136604. private _imageProcessingObserver;
  136605. /**
  136606. * Attaches a new image processing configuration to the PBR Material.
  136607. * @param configuration
  136608. */
  136609. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  136610. /**
  136611. * Stores the available render targets.
  136612. */
  136613. private _renderTargets;
  136614. /**
  136615. * Sets the global ambient color for the material used in lighting calculations.
  136616. */
  136617. private _globalAmbientColor;
  136618. /**
  136619. * Enables the use of logarithmic depth buffers, which is good for wide depth buffers.
  136620. */
  136621. private _useLogarithmicDepth;
  136622. /**
  136623. * If set to true, no lighting calculations will be applied.
  136624. */
  136625. private _unlit;
  136626. private _debugMode;
  136627. /**
  136628. * @hidden
  136629. * This is reserved for the inspector.
  136630. * Defines the material debug mode.
  136631. * It helps seeing only some components of the material while troubleshooting.
  136632. */
  136633. debugMode: number;
  136634. /**
  136635. * @hidden
  136636. * This is reserved for the inspector.
  136637. * Specify from where on screen the debug mode should start.
  136638. * The value goes from -1 (full screen) to 1 (not visible)
  136639. * It helps with side by side comparison against the final render
  136640. * This defaults to -1
  136641. */
  136642. private debugLimit;
  136643. /**
  136644. * @hidden
  136645. * This is reserved for the inspector.
  136646. * As the default viewing range might not be enough (if the ambient is really small for instance)
  136647. * You can use the factor to better multiply the final value.
  136648. */
  136649. private debugFactor;
  136650. /**
  136651. * Defines the clear coat layer parameters for the material.
  136652. */
  136653. readonly clearCoat: PBRClearCoatConfiguration;
  136654. /**
  136655. * Defines the anisotropic parameters for the material.
  136656. */
  136657. readonly anisotropy: PBRAnisotropicConfiguration;
  136658. /**
  136659. * Defines the BRDF parameters for the material.
  136660. */
  136661. readonly brdf: PBRBRDFConfiguration;
  136662. /**
  136663. * Defines the Sheen parameters for the material.
  136664. */
  136665. readonly sheen: PBRSheenConfiguration;
  136666. /**
  136667. * Defines the SubSurface parameters for the material.
  136668. */
  136669. readonly subSurface: PBRSubSurfaceConfiguration;
  136670. /**
  136671. * Defines the detail map parameters for the material.
  136672. */
  136673. readonly detailMap: DetailMapConfiguration;
  136674. protected _rebuildInParallel: boolean;
  136675. /**
  136676. * Instantiates a new PBRMaterial instance.
  136677. *
  136678. * @param name The material name
  136679. * @param scene The scene the material will be use in.
  136680. */
  136681. constructor(name: string, scene: Scene);
  136682. /**
  136683. * Gets a boolean indicating that current material needs to register RTT
  136684. */
  136685. get hasRenderTargetTextures(): boolean;
  136686. /**
  136687. * Gets the name of the material class.
  136688. */
  136689. getClassName(): string;
  136690. /**
  136691. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  136692. */
  136693. get useLogarithmicDepth(): boolean;
  136694. /**
  136695. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  136696. */
  136697. set useLogarithmicDepth(value: boolean);
  136698. /**
  136699. * Returns true if alpha blending should be disabled.
  136700. */
  136701. protected get _disableAlphaBlending(): boolean;
  136702. /**
  136703. * Specifies whether or not this material should be rendered in alpha blend mode.
  136704. */
  136705. needAlphaBlending(): boolean;
  136706. /**
  136707. * Specifies whether or not this material should be rendered in alpha test mode.
  136708. */
  136709. needAlphaTesting(): boolean;
  136710. /**
  136711. * Specifies whether or not the alpha value of the albedo texture should be used for alpha blending.
  136712. */
  136713. protected _shouldUseAlphaFromAlbedoTexture(): boolean;
  136714. /**
  136715. * Gets the texture used for the alpha test.
  136716. */
  136717. getAlphaTestTexture(): Nullable<BaseTexture>;
  136718. /**
  136719. * Specifies that the submesh is ready to be used.
  136720. * @param mesh - BJS mesh.
  136721. * @param subMesh - A submesh of the BJS mesh. Used to check if it is ready.
  136722. * @param useInstances - Specifies that instances should be used.
  136723. * @returns - boolean indicating that the submesh is ready or not.
  136724. */
  136725. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  136726. /**
  136727. * Specifies if the material uses metallic roughness workflow.
  136728. * @returns boolean specifiying if the material uses metallic roughness workflow.
  136729. */
  136730. isMetallicWorkflow(): boolean;
  136731. private _prepareEffect;
  136732. private _prepareDefines;
  136733. /**
  136734. * Force shader compilation
  136735. */
  136736. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>): void;
  136737. /**
  136738. * Initializes the uniform buffer layout for the shader.
  136739. */
  136740. buildUniformLayout(): void;
  136741. /**
  136742. * Unbinds the material from the mesh
  136743. */
  136744. unbind(): void;
  136745. /**
  136746. * Binds the submesh data.
  136747. * @param world - The world matrix.
  136748. * @param mesh - The BJS mesh.
  136749. * @param subMesh - A submesh of the BJS mesh.
  136750. */
  136751. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  136752. /**
  136753. * Returns the animatable textures.
  136754. * @returns - Array of animatable textures.
  136755. */
  136756. getAnimatables(): IAnimatable[];
  136757. /**
  136758. * Returns the texture used for reflections.
  136759. * @returns - Reflection texture if present. Otherwise, returns the environment texture.
  136760. */
  136761. private _getReflectionTexture;
  136762. /**
  136763. * Returns an array of the actively used textures.
  136764. * @returns - Array of BaseTextures
  136765. */
  136766. getActiveTextures(): BaseTexture[];
  136767. /**
  136768. * Checks to see if a texture is used in the material.
  136769. * @param texture - Base texture to use.
  136770. * @returns - Boolean specifying if a texture is used in the material.
  136771. */
  136772. hasTexture(texture: BaseTexture): boolean;
  136773. /**
  136774. * Sets the required values to the prepass renderer.
  136775. * @param prePassRenderer defines the prepass renderer to setup
  136776. */
  136777. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  136778. /**
  136779. * Disposes the resources of the material.
  136780. * @param forceDisposeEffect - Forces the disposal of effects.
  136781. * @param forceDisposeTextures - Forces the disposal of all textures.
  136782. */
  136783. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  136784. }
  136785. }
  136786. declare module BABYLON {
  136787. /**
  136788. * The Physically based material of BJS.
  136789. *
  136790. * This offers the main features of a standard PBR material.
  136791. * For more information, please refer to the documentation :
  136792. * https://doc.babylonjs.com/how_to/physically_based_rendering
  136793. */
  136794. export class PBRMaterial extends PBRBaseMaterial {
  136795. /**
  136796. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  136797. */
  136798. static readonly PBRMATERIAL_OPAQUE: number;
  136799. /**
  136800. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  136801. */
  136802. static readonly PBRMATERIAL_ALPHATEST: number;
  136803. /**
  136804. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  136805. */
  136806. static readonly PBRMATERIAL_ALPHABLEND: number;
  136807. /**
  136808. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  136809. * They are also discarded below the alpha cutoff threshold to improve performances.
  136810. */
  136811. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  136812. /**
  136813. * Defines the default value of how much AO map is occluding the analytical lights
  136814. * (point spot...).
  136815. */
  136816. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  136817. /**
  136818. * Intensity of the direct lights e.g. the four lights available in your scene.
  136819. * This impacts both the direct diffuse and specular highlights.
  136820. */
  136821. directIntensity: number;
  136822. /**
  136823. * Intensity of the emissive part of the material.
  136824. * This helps controlling the emissive effect without modifying the emissive color.
  136825. */
  136826. emissiveIntensity: number;
  136827. /**
  136828. * Intensity of the environment e.g. how much the environment will light the object
  136829. * either through harmonics for rough material or through the refelction for shiny ones.
  136830. */
  136831. environmentIntensity: number;
  136832. /**
  136833. * This is a special control allowing the reduction of the specular highlights coming from the
  136834. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  136835. */
  136836. specularIntensity: number;
  136837. /**
  136838. * Debug Control allowing disabling the bump map on this material.
  136839. */
  136840. disableBumpMap: boolean;
  136841. /**
  136842. * AKA Diffuse Texture in standard nomenclature.
  136843. */
  136844. albedoTexture: BaseTexture;
  136845. /**
  136846. * AKA Occlusion Texture in other nomenclature.
  136847. */
  136848. ambientTexture: BaseTexture;
  136849. /**
  136850. * AKA Occlusion Texture Intensity in other nomenclature.
  136851. */
  136852. ambientTextureStrength: number;
  136853. /**
  136854. * Defines how much the AO map is occluding the analytical lights (point spot...).
  136855. * 1 means it completely occludes it
  136856. * 0 mean it has no impact
  136857. */
  136858. ambientTextureImpactOnAnalyticalLights: number;
  136859. /**
  136860. * Stores the alpha values in a texture. Use luminance if texture.getAlphaFromRGB is true.
  136861. */
  136862. opacityTexture: BaseTexture;
  136863. /**
  136864. * Stores the reflection values in a texture.
  136865. */
  136866. reflectionTexture: Nullable<BaseTexture>;
  136867. /**
  136868. * Stores the emissive values in a texture.
  136869. */
  136870. emissiveTexture: BaseTexture;
  136871. /**
  136872. * AKA Specular texture in other nomenclature.
  136873. */
  136874. reflectivityTexture: BaseTexture;
  136875. /**
  136876. * Used to switch from specular/glossiness to metallic/roughness workflow.
  136877. */
  136878. metallicTexture: BaseTexture;
  136879. /**
  136880. * Specifies the metallic scalar of the metallic/roughness workflow.
  136881. * Can also be used to scale the metalness values of the metallic texture.
  136882. */
  136883. metallic: Nullable<number>;
  136884. /**
  136885. * Specifies the roughness scalar of the metallic/roughness workflow.
  136886. * Can also be used to scale the roughness values of the metallic texture.
  136887. */
  136888. roughness: Nullable<number>;
  136889. /**
  136890. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  136891. * By default the indexOfrefraction is used to compute F0;
  136892. *
  136893. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  136894. *
  136895. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  136896. * F90 = metallicReflectanceColor;
  136897. */
  136898. metallicF0Factor: number;
  136899. /**
  136900. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  136901. * By default the F90 is always 1;
  136902. *
  136903. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  136904. *
  136905. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  136906. * F90 = metallicReflectanceColor;
  136907. */
  136908. metallicReflectanceColor: Color3;
  136909. /**
  136910. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  136911. * This is multiply against the scalar values defined in the material.
  136912. */
  136913. metallicReflectanceTexture: Nullable<BaseTexture>;
  136914. /**
  136915. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  136916. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  136917. */
  136918. microSurfaceTexture: BaseTexture;
  136919. /**
  136920. * Stores surface normal data used to displace a mesh in a texture.
  136921. */
  136922. bumpTexture: BaseTexture;
  136923. /**
  136924. * Stores the pre-calculated light information of a mesh in a texture.
  136925. */
  136926. lightmapTexture: BaseTexture;
  136927. /**
  136928. * Stores the refracted light information in a texture.
  136929. */
  136930. get refractionTexture(): Nullable<BaseTexture>;
  136931. set refractionTexture(value: Nullable<BaseTexture>);
  136932. /**
  136933. * The color of a material in ambient lighting.
  136934. */
  136935. ambientColor: Color3;
  136936. /**
  136937. * AKA Diffuse Color in other nomenclature.
  136938. */
  136939. albedoColor: Color3;
  136940. /**
  136941. * AKA Specular Color in other nomenclature.
  136942. */
  136943. reflectivityColor: Color3;
  136944. /**
  136945. * The color reflected from the material.
  136946. */
  136947. reflectionColor: Color3;
  136948. /**
  136949. * The color emitted from the material.
  136950. */
  136951. emissiveColor: Color3;
  136952. /**
  136953. * AKA Glossiness in other nomenclature.
  136954. */
  136955. microSurface: number;
  136956. /**
  136957. * Index of refraction of the material base layer.
  136958. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  136959. *
  136960. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  136961. *
  136962. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  136963. */
  136964. get indexOfRefraction(): number;
  136965. set indexOfRefraction(value: number);
  136966. /**
  136967. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  136968. */
  136969. get invertRefractionY(): boolean;
  136970. set invertRefractionY(value: boolean);
  136971. /**
  136972. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  136973. * Materials half opaque for instance using refraction could benefit from this control.
  136974. */
  136975. get linkRefractionWithTransparency(): boolean;
  136976. set linkRefractionWithTransparency(value: boolean);
  136977. /**
  136978. * If true, the light map contains occlusion information instead of lighting info.
  136979. */
  136980. useLightmapAsShadowmap: boolean;
  136981. /**
  136982. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  136983. */
  136984. useAlphaFromAlbedoTexture: boolean;
  136985. /**
  136986. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  136987. */
  136988. forceAlphaTest: boolean;
  136989. /**
  136990. * Defines the alpha limits in alpha test mode.
  136991. */
  136992. alphaCutOff: number;
  136993. /**
  136994. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  136995. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  136996. */
  136997. useSpecularOverAlpha: boolean;
  136998. /**
  136999. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  137000. */
  137001. useMicroSurfaceFromReflectivityMapAlpha: boolean;
  137002. /**
  137003. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  137004. */
  137005. useRoughnessFromMetallicTextureAlpha: boolean;
  137006. /**
  137007. * Specifies if the metallic texture contains the roughness information in its green channel.
  137008. */
  137009. useRoughnessFromMetallicTextureGreen: boolean;
  137010. /**
  137011. * Specifies if the metallic texture contains the metallness information in its blue channel.
  137012. */
  137013. useMetallnessFromMetallicTextureBlue: boolean;
  137014. /**
  137015. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  137016. */
  137017. useAmbientOcclusionFromMetallicTextureRed: boolean;
  137018. /**
  137019. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  137020. */
  137021. useAmbientInGrayScale: boolean;
  137022. /**
  137023. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  137024. * The material will try to infer what glossiness each pixel should be.
  137025. */
  137026. useAutoMicroSurfaceFromReflectivityMap: boolean;
  137027. /**
  137028. * BJS is using an harcoded light falloff based on a manually sets up range.
  137029. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  137030. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  137031. */
  137032. get usePhysicalLightFalloff(): boolean;
  137033. /**
  137034. * BJS is using an harcoded light falloff based on a manually sets up range.
  137035. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  137036. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  137037. */
  137038. set usePhysicalLightFalloff(value: boolean);
  137039. /**
  137040. * In order to support the falloff compatibility with gltf, a special mode has been added
  137041. * to reproduce the gltf light falloff.
  137042. */
  137043. get useGLTFLightFalloff(): boolean;
  137044. /**
  137045. * In order to support the falloff compatibility with gltf, a special mode has been added
  137046. * to reproduce the gltf light falloff.
  137047. */
  137048. set useGLTFLightFalloff(value: boolean);
  137049. /**
  137050. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  137051. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  137052. */
  137053. useRadianceOverAlpha: boolean;
  137054. /**
  137055. * Allows using an object space normal map (instead of tangent space).
  137056. */
  137057. useObjectSpaceNormalMap: boolean;
  137058. /**
  137059. * Allows using the bump map in parallax mode.
  137060. */
  137061. useParallax: boolean;
  137062. /**
  137063. * Allows using the bump map in parallax occlusion mode.
  137064. */
  137065. useParallaxOcclusion: boolean;
  137066. /**
  137067. * Controls the scale bias of the parallax mode.
  137068. */
  137069. parallaxScaleBias: number;
  137070. /**
  137071. * If sets to true, disables all the lights affecting the material.
  137072. */
  137073. disableLighting: boolean;
  137074. /**
  137075. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  137076. */
  137077. forceIrradianceInFragment: boolean;
  137078. /**
  137079. * Number of Simultaneous lights allowed on the material.
  137080. */
  137081. maxSimultaneousLights: number;
  137082. /**
  137083. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  137084. */
  137085. invertNormalMapX: boolean;
  137086. /**
  137087. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  137088. */
  137089. invertNormalMapY: boolean;
  137090. /**
  137091. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  137092. */
  137093. twoSidedLighting: boolean;
  137094. /**
  137095. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  137096. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  137097. */
  137098. useAlphaFresnel: boolean;
  137099. /**
  137100. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  137101. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  137102. */
  137103. useLinearAlphaFresnel: boolean;
  137104. /**
  137105. * Let user defines the brdf lookup texture used for IBL.
  137106. * A default 8bit version is embedded but you could point at :
  137107. * * Default texture: https://assets.babylonjs.com/environments/correlatedMSBRDF_RGBD.png
  137108. * * Default 16bit pixel depth texture: https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  137109. * * LEGACY Default None correlated https://assets.babylonjs.com/environments/uncorrelatedBRDF_RGBD.png
  137110. * * LEGACY Default None correlated 16bit pixel depth https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  137111. */
  137112. environmentBRDFTexture: Nullable<BaseTexture>;
  137113. /**
  137114. * Force normal to face away from face.
  137115. */
  137116. forceNormalForward: boolean;
  137117. /**
  137118. * Enables specular anti aliasing in the PBR shader.
  137119. * It will both interacts on the Geometry for analytical and IBL lighting.
  137120. * It also prefilter the roughness map based on the bump values.
  137121. */
  137122. enableSpecularAntiAliasing: boolean;
  137123. /**
  137124. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  137125. * makes the reflect vector face the model (under horizon).
  137126. */
  137127. useHorizonOcclusion: boolean;
  137128. /**
  137129. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  137130. * too much the area relying on ambient texture to define their ambient occlusion.
  137131. */
  137132. useRadianceOcclusion: boolean;
  137133. /**
  137134. * If set to true, no lighting calculations will be applied.
  137135. */
  137136. unlit: boolean;
  137137. /**
  137138. * Gets the image processing configuration used either in this material.
  137139. */
  137140. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  137141. /**
  137142. * Sets the Default image processing configuration used either in the this material.
  137143. *
  137144. * If sets to null, the scene one is in use.
  137145. */
  137146. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  137147. /**
  137148. * Gets wether the color curves effect is enabled.
  137149. */
  137150. get cameraColorCurvesEnabled(): boolean;
  137151. /**
  137152. * Sets wether the color curves effect is enabled.
  137153. */
  137154. set cameraColorCurvesEnabled(value: boolean);
  137155. /**
  137156. * Gets wether the color grading effect is enabled.
  137157. */
  137158. get cameraColorGradingEnabled(): boolean;
  137159. /**
  137160. * Gets wether the color grading effect is enabled.
  137161. */
  137162. set cameraColorGradingEnabled(value: boolean);
  137163. /**
  137164. * Gets wether tonemapping is enabled or not.
  137165. */
  137166. get cameraToneMappingEnabled(): boolean;
  137167. /**
  137168. * Sets wether tonemapping is enabled or not
  137169. */
  137170. set cameraToneMappingEnabled(value: boolean);
  137171. /**
  137172. * The camera exposure used on this material.
  137173. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  137174. * This corresponds to a photographic exposure.
  137175. */
  137176. get cameraExposure(): number;
  137177. /**
  137178. * The camera exposure used on this material.
  137179. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  137180. * This corresponds to a photographic exposure.
  137181. */
  137182. set cameraExposure(value: number);
  137183. /**
  137184. * Gets The camera contrast used on this material.
  137185. */
  137186. get cameraContrast(): number;
  137187. /**
  137188. * Sets The camera contrast used on this material.
  137189. */
  137190. set cameraContrast(value: number);
  137191. /**
  137192. * Gets the Color Grading 2D Lookup Texture.
  137193. */
  137194. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  137195. /**
  137196. * Sets the Color Grading 2D Lookup Texture.
  137197. */
  137198. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  137199. /**
  137200. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  137201. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  137202. * 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;
  137203. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  137204. */
  137205. get cameraColorCurves(): Nullable<ColorCurves>;
  137206. /**
  137207. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  137208. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  137209. * 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;
  137210. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  137211. */
  137212. set cameraColorCurves(value: Nullable<ColorCurves>);
  137213. /**
  137214. * Instantiates a new PBRMaterial instance.
  137215. *
  137216. * @param name The material name
  137217. * @param scene The scene the material will be use in.
  137218. */
  137219. constructor(name: string, scene: Scene);
  137220. /**
  137221. * Returns the name of this material class.
  137222. */
  137223. getClassName(): string;
  137224. /**
  137225. * Makes a duplicate of the current material.
  137226. * @param name - name to use for the new material.
  137227. */
  137228. clone(name: string): PBRMaterial;
  137229. /**
  137230. * Serializes this PBR Material.
  137231. * @returns - An object with the serialized material.
  137232. */
  137233. serialize(): any;
  137234. /**
  137235. * Parses a PBR Material from a serialized object.
  137236. * @param source - Serialized object.
  137237. * @param scene - BJS scene instance.
  137238. * @param rootUrl - url for the scene object
  137239. * @returns - PBRMaterial
  137240. */
  137241. static Parse(source: any, scene: Scene, rootUrl: string): PBRMaterial;
  137242. }
  137243. }
  137244. declare module BABYLON {
  137245. /**
  137246. * Direct draw surface info
  137247. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dx-graphics-dds-pguide
  137248. */
  137249. export interface DDSInfo {
  137250. /**
  137251. * Width of the texture
  137252. */
  137253. width: number;
  137254. /**
  137255. * Width of the texture
  137256. */
  137257. height: number;
  137258. /**
  137259. * Number of Mipmaps for the texture
  137260. * @see https://en.wikipedia.org/wiki/Mipmap
  137261. */
  137262. mipmapCount: number;
  137263. /**
  137264. * If the textures format is a known fourCC format
  137265. * @see https://www.fourcc.org/
  137266. */
  137267. isFourCC: boolean;
  137268. /**
  137269. * If the texture is an RGB format eg. DXGI_FORMAT_B8G8R8X8_UNORM format
  137270. */
  137271. isRGB: boolean;
  137272. /**
  137273. * If the texture is a lumincance format
  137274. */
  137275. isLuminance: boolean;
  137276. /**
  137277. * If this is a cube texture
  137278. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dds-file-layout-for-cubic-environment-maps
  137279. */
  137280. isCube: boolean;
  137281. /**
  137282. * If the texture is a compressed format eg. FOURCC_DXT1
  137283. */
  137284. isCompressed: boolean;
  137285. /**
  137286. * The dxgiFormat of the texture
  137287. * @see https://docs.microsoft.com/en-us/windows/desktop/api/dxgiformat/ne-dxgiformat-dxgi_format
  137288. */
  137289. dxgiFormat: number;
  137290. /**
  137291. * Texture type eg. Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT
  137292. */
  137293. textureType: number;
  137294. /**
  137295. * Sphericle polynomial created for the dds texture
  137296. */
  137297. sphericalPolynomial?: SphericalPolynomial;
  137298. }
  137299. /**
  137300. * Class used to provide DDS decompression tools
  137301. */
  137302. export class DDSTools {
  137303. /**
  137304. * Gets or sets a boolean indicating that LOD info is stored in alpha channel (false by default)
  137305. */
  137306. static StoreLODInAlphaChannel: boolean;
  137307. /**
  137308. * Gets DDS information from an array buffer
  137309. * @param data defines the array buffer view to read data from
  137310. * @returns the DDS information
  137311. */
  137312. static GetDDSInfo(data: ArrayBufferView): DDSInfo;
  137313. private static _FloatView;
  137314. private static _Int32View;
  137315. private static _ToHalfFloat;
  137316. private static _FromHalfFloat;
  137317. private static _GetHalfFloatAsFloatRGBAArrayBuffer;
  137318. private static _GetHalfFloatRGBAArrayBuffer;
  137319. private static _GetFloatRGBAArrayBuffer;
  137320. private static _GetFloatAsUIntRGBAArrayBuffer;
  137321. private static _GetHalfFloatAsUIntRGBAArrayBuffer;
  137322. private static _GetRGBAArrayBuffer;
  137323. private static _ExtractLongWordOrder;
  137324. private static _GetRGBArrayBuffer;
  137325. private static _GetLuminanceArrayBuffer;
  137326. /**
  137327. * Uploads DDS Levels to a Babylon Texture
  137328. * @hidden
  137329. */
  137330. static UploadDDSLevels(engine: ThinEngine, texture: InternalTexture, data: ArrayBufferView, info: DDSInfo, loadMipmaps: boolean, faces: number, lodIndex?: number, currentFace?: number): void;
  137331. }
  137332. interface ThinEngine {
  137333. /**
  137334. * Create a cube texture from prefiltered data (ie. the mipmaps contain ready to use data for PBR reflection)
  137335. * @param rootUrl defines the url where the file to load is located
  137336. * @param scene defines the current scene
  137337. * @param lodScale defines scale to apply to the mip map selection
  137338. * @param lodOffset defines offset to apply to the mip map selection
  137339. * @param onLoad defines an optional callback raised when the texture is loaded
  137340. * @param onError defines an optional callback raised if there is an issue to load the texture
  137341. * @param format defines the format of the data
  137342. * @param forcedExtension defines the extension to use to pick the right loader
  137343. * @param createPolynomials defines wheter or not to create polynomails harmonics for the texture
  137344. * @returns the cube texture as an InternalTexture
  137345. */
  137346. 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;
  137347. }
  137348. }
  137349. declare module BABYLON {
  137350. /**
  137351. * Implementation of the DDS Texture Loader.
  137352. * @hidden
  137353. */
  137354. export class _DDSTextureLoader implements IInternalTextureLoader {
  137355. /**
  137356. * Defines wether the loader supports cascade loading the different faces.
  137357. */
  137358. readonly supportCascades: boolean;
  137359. /**
  137360. * This returns if the loader support the current file information.
  137361. * @param extension defines the file extension of the file being loaded
  137362. * @returns true if the loader can load the specified file
  137363. */
  137364. canLoad(extension: string): boolean;
  137365. /**
  137366. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  137367. * @param data contains the texture data
  137368. * @param texture defines the BabylonJS internal texture
  137369. * @param createPolynomials will be true if polynomials have been requested
  137370. * @param onLoad defines the callback to trigger once the texture is ready
  137371. * @param onError defines the callback to trigger in case of error
  137372. */
  137373. loadCubeData(imgs: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  137374. /**
  137375. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  137376. * @param data contains the texture data
  137377. * @param texture defines the BabylonJS internal texture
  137378. * @param callback defines the method to call once ready to upload
  137379. */
  137380. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  137381. }
  137382. }
  137383. declare module BABYLON {
  137384. /**
  137385. * Implementation of the ENV Texture Loader.
  137386. * @hidden
  137387. */
  137388. export class _ENVTextureLoader implements IInternalTextureLoader {
  137389. /**
  137390. * Defines wether the loader supports cascade loading the different faces.
  137391. */
  137392. readonly supportCascades: boolean;
  137393. /**
  137394. * This returns if the loader support the current file information.
  137395. * @param extension defines the file extension of the file being loaded
  137396. * @returns true if the loader can load the specified file
  137397. */
  137398. canLoad(extension: string): boolean;
  137399. /**
  137400. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  137401. * @param data contains the texture data
  137402. * @param texture defines the BabylonJS internal texture
  137403. * @param createPolynomials will be true if polynomials have been requested
  137404. * @param onLoad defines the callback to trigger once the texture is ready
  137405. * @param onError defines the callback to trigger in case of error
  137406. */
  137407. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  137408. /**
  137409. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  137410. * @param data contains the texture data
  137411. * @param texture defines the BabylonJS internal texture
  137412. * @param callback defines the method to call once ready to upload
  137413. */
  137414. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  137415. }
  137416. }
  137417. declare module BABYLON {
  137418. /**
  137419. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  137420. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  137421. */
  137422. export class KhronosTextureContainer {
  137423. /** contents of the KTX container file */
  137424. data: ArrayBufferView;
  137425. private static HEADER_LEN;
  137426. private static COMPRESSED_2D;
  137427. private static COMPRESSED_3D;
  137428. private static TEX_2D;
  137429. private static TEX_3D;
  137430. /**
  137431. * Gets the openGL type
  137432. */
  137433. glType: number;
  137434. /**
  137435. * Gets the openGL type size
  137436. */
  137437. glTypeSize: number;
  137438. /**
  137439. * Gets the openGL format
  137440. */
  137441. glFormat: number;
  137442. /**
  137443. * Gets the openGL internal format
  137444. */
  137445. glInternalFormat: number;
  137446. /**
  137447. * Gets the base internal format
  137448. */
  137449. glBaseInternalFormat: number;
  137450. /**
  137451. * Gets image width in pixel
  137452. */
  137453. pixelWidth: number;
  137454. /**
  137455. * Gets image height in pixel
  137456. */
  137457. pixelHeight: number;
  137458. /**
  137459. * Gets image depth in pixels
  137460. */
  137461. pixelDepth: number;
  137462. /**
  137463. * Gets the number of array elements
  137464. */
  137465. numberOfArrayElements: number;
  137466. /**
  137467. * Gets the number of faces
  137468. */
  137469. numberOfFaces: number;
  137470. /**
  137471. * Gets the number of mipmap levels
  137472. */
  137473. numberOfMipmapLevels: number;
  137474. /**
  137475. * Gets the bytes of key value data
  137476. */
  137477. bytesOfKeyValueData: number;
  137478. /**
  137479. * Gets the load type
  137480. */
  137481. loadType: number;
  137482. /**
  137483. * If the container has been made invalid (eg. constructor failed to correctly load array buffer)
  137484. */
  137485. isInvalid: boolean;
  137486. /**
  137487. * Creates a new KhronosTextureContainer
  137488. * @param data contents of the KTX container file
  137489. * @param facesExpected should be either 1 or 6, based whether a cube texture or or
  137490. * @param threeDExpected provision for indicating that data should be a 3D texture, not implemented
  137491. * @param textureArrayExpected provision for indicating that data should be a texture array, not implemented
  137492. */
  137493. constructor(
  137494. /** contents of the KTX container file */
  137495. data: ArrayBufferView, facesExpected: number, threeDExpected?: boolean, textureArrayExpected?: boolean);
  137496. /**
  137497. * Uploads KTX content to a Babylon Texture.
  137498. * It is assumed that the texture has already been created & is currently bound
  137499. * @hidden
  137500. */
  137501. uploadLevels(texture: InternalTexture, loadMipmaps: boolean): void;
  137502. private _upload2DCompressedLevels;
  137503. /**
  137504. * Checks if the given data starts with a KTX file identifier.
  137505. * @param data the data to check
  137506. * @returns true if the data is a KTX file or false otherwise
  137507. */
  137508. static IsValid(data: ArrayBufferView): boolean;
  137509. }
  137510. }
  137511. declare module BABYLON {
  137512. /**
  137513. * Helper class to push actions to a pool of workers.
  137514. */
  137515. export class WorkerPool implements IDisposable {
  137516. private _workerInfos;
  137517. private _pendingActions;
  137518. /**
  137519. * Constructor
  137520. * @param workers Array of workers to use for actions
  137521. */
  137522. constructor(workers: Array<Worker>);
  137523. /**
  137524. * Terminates all workers and clears any pending actions.
  137525. */
  137526. dispose(): void;
  137527. /**
  137528. * Pushes an action to the worker pool. If all the workers are active, the action will be
  137529. * pended until a worker has completed its action.
  137530. * @param action The action to perform. Call onComplete when the action is complete.
  137531. */
  137532. push(action: (worker: Worker, onComplete: () => void) => void): void;
  137533. private _execute;
  137534. }
  137535. }
  137536. declare module BABYLON {
  137537. /**
  137538. * Class for loading KTX2 files
  137539. * @hidden
  137540. */
  137541. export class KhronosTextureContainer2 {
  137542. private static _WorkerPoolPromise?;
  137543. private static _Initialized;
  137544. private static _Ktx2Decoder;
  137545. /**
  137546. * URL to use when loading the KTX2 decoder module
  137547. */
  137548. static JSModuleURL: string;
  137549. /**
  137550. * Default number of workers used to handle data decoding
  137551. */
  137552. static DefaultNumWorkers: number;
  137553. private static GetDefaultNumWorkers;
  137554. private _engine;
  137555. private static _CreateWorkerPool;
  137556. /**
  137557. * Constructor
  137558. * @param numWorkers The number of workers for async operations. Specify `0` to disable web workers and run synchronously in the current context.
  137559. */
  137560. constructor(engine: ThinEngine, numWorkers?: number);
  137561. uploadAsync(data: ArrayBufferView, internalTexture: InternalTexture): Promise<void>;
  137562. /**
  137563. * Stop all async operations and release resources.
  137564. */
  137565. dispose(): void;
  137566. protected _createTexture(data: any, internalTexture: InternalTexture): void;
  137567. /**
  137568. * Checks if the given data starts with a KTX2 file identifier.
  137569. * @param data the data to check
  137570. * @returns true if the data is a KTX2 file or false otherwise
  137571. */
  137572. static IsValid(data: ArrayBufferView): boolean;
  137573. }
  137574. export function workerFunc(): void;
  137575. }
  137576. declare module BABYLON {
  137577. /**
  137578. * Implementation of the KTX Texture Loader.
  137579. * @hidden
  137580. */
  137581. export class _KTXTextureLoader implements IInternalTextureLoader {
  137582. /**
  137583. * Defines wether the loader supports cascade loading the different faces.
  137584. */
  137585. readonly supportCascades: boolean;
  137586. /**
  137587. * This returns if the loader support the current file information.
  137588. * @param extension defines the file extension of the file being loaded
  137589. * @param mimeType defines the optional mime type of the file being loaded
  137590. * @returns true if the loader can load the specified file
  137591. */
  137592. canLoad(extension: string, mimeType?: string): boolean;
  137593. /**
  137594. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  137595. * @param data contains the texture data
  137596. * @param texture defines the BabylonJS internal texture
  137597. * @param createPolynomials will be true if polynomials have been requested
  137598. * @param onLoad defines the callback to trigger once the texture is ready
  137599. * @param onError defines the callback to trigger in case of error
  137600. */
  137601. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  137602. /**
  137603. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  137604. * @param data contains the texture data
  137605. * @param texture defines the BabylonJS internal texture
  137606. * @param callback defines the method to call once ready to upload
  137607. */
  137608. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed: boolean) => void): void;
  137609. }
  137610. }
  137611. declare module BABYLON {
  137612. /** @hidden */
  137613. export var _forceSceneHelpersToBundle: boolean;
  137614. interface Scene {
  137615. /**
  137616. * Creates a default light for the scene.
  137617. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-light
  137618. * @param replace has the default false, when true replaces the existing lights in the scene with a hemispheric light
  137619. */
  137620. createDefaultLight(replace?: boolean): void;
  137621. /**
  137622. * Creates a default camera for the scene.
  137623. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-camera
  137624. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  137625. * @param replace has default false, when true replaces the active camera in the scene
  137626. * @param attachCameraControls has default false, when true attaches camera controls to the canvas.
  137627. */
  137628. createDefaultCamera(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  137629. /**
  137630. * Creates a default camera and a default light.
  137631. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-camera-or-light
  137632. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  137633. * @param replace has the default false, when true replaces the active camera/light in the scene
  137634. * @param attachCameraControls has the default false, when true attaches camera controls to the canvas.
  137635. */
  137636. createDefaultCameraOrLight(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  137637. /**
  137638. * Creates a new sky box
  137639. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-skybox
  137640. * @param environmentTexture defines the texture to use as environment texture
  137641. * @param pbr has default false which requires the StandardMaterial to be used, when true PBRMaterial must be used
  137642. * @param scale defines the overall scale of the skybox
  137643. * @param blur is only available when pbr is true, default is 0, no blur, maximum value is 1
  137644. * @param setGlobalEnvTexture has default true indicating that scene.environmentTexture must match the current skybox texture
  137645. * @returns a new mesh holding the sky box
  137646. */
  137647. createDefaultSkybox(environmentTexture?: BaseTexture, pbr?: boolean, scale?: number, blur?: number, setGlobalEnvTexture?: boolean): Nullable<Mesh>;
  137648. /**
  137649. * Creates a new environment
  137650. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-environment
  137651. * @param options defines the options you can use to configure the environment
  137652. * @returns the new EnvironmentHelper
  137653. */
  137654. createDefaultEnvironment(options?: Partial<IEnvironmentHelperOptions>): Nullable<EnvironmentHelper>;
  137655. /**
  137656. * Creates a new VREXperienceHelper
  137657. * @see https://doc.babylonjs.com/how_to/webvr_helper
  137658. * @param webVROptions defines the options used to create the new VREXperienceHelper
  137659. * @returns a new VREXperienceHelper
  137660. */
  137661. createDefaultVRExperience(webVROptions?: VRExperienceHelperOptions): VRExperienceHelper;
  137662. /**
  137663. * Creates a new WebXRDefaultExperience
  137664. * @see https://doc.babylonjs.com/how_to/introduction_to_webxr
  137665. * @param options experience options
  137666. * @returns a promise for a new WebXRDefaultExperience
  137667. */
  137668. createDefaultXRExperienceAsync(options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  137669. }
  137670. }
  137671. declare module BABYLON {
  137672. /**
  137673. * Display a 360/180 degree video on an approximately spherical surface, useful for VR applications or skyboxes.
  137674. * As a subclass of TransformNode, this allow parenting to the camera or multiple videos with different locations in the scene.
  137675. * This class achieves its effect with a VideoTexture and a correctly configured BackgroundMaterial on an inverted sphere.
  137676. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  137677. */
  137678. export class VideoDome extends TextureDome<VideoTexture> {
  137679. /**
  137680. * Define the video source as a Monoscopic panoramic 360 video.
  137681. */
  137682. static readonly MODE_MONOSCOPIC: number;
  137683. /**
  137684. * Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  137685. */
  137686. static readonly MODE_TOPBOTTOM: number;
  137687. /**
  137688. * Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  137689. */
  137690. static readonly MODE_SIDEBYSIDE: number;
  137691. /**
  137692. * Get the video texture associated with this video dome
  137693. */
  137694. get videoTexture(): VideoTexture;
  137695. /**
  137696. * Get the video mode of this dome
  137697. */
  137698. get videoMode(): number;
  137699. /**
  137700. * Set the video mode of this dome.
  137701. * @see textureMode
  137702. */
  137703. set videoMode(value: number);
  137704. protected _initTexture(urlsOrElement: string | string[] | HTMLVideoElement, scene: Scene, options: any): VideoTexture;
  137705. }
  137706. }
  137707. declare module BABYLON {
  137708. /**
  137709. * This class can be used to get instrumentation data from a Babylon engine
  137710. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  137711. */
  137712. export class EngineInstrumentation implements IDisposable {
  137713. /**
  137714. * Define the instrumented engine.
  137715. */
  137716. engine: Engine;
  137717. private _captureGPUFrameTime;
  137718. private _gpuFrameTimeToken;
  137719. private _gpuFrameTime;
  137720. private _captureShaderCompilationTime;
  137721. private _shaderCompilationTime;
  137722. private _onBeginFrameObserver;
  137723. private _onEndFrameObserver;
  137724. private _onBeforeShaderCompilationObserver;
  137725. private _onAfterShaderCompilationObserver;
  137726. /**
  137727. * Gets the perf counter used for GPU frame time
  137728. */
  137729. get gpuFrameTimeCounter(): PerfCounter;
  137730. /**
  137731. * Gets the GPU frame time capture status
  137732. */
  137733. get captureGPUFrameTime(): boolean;
  137734. /**
  137735. * Enable or disable the GPU frame time capture
  137736. */
  137737. set captureGPUFrameTime(value: boolean);
  137738. /**
  137739. * Gets the perf counter used for shader compilation time
  137740. */
  137741. get shaderCompilationTimeCounter(): PerfCounter;
  137742. /**
  137743. * Gets the shader compilation time capture status
  137744. */
  137745. get captureShaderCompilationTime(): boolean;
  137746. /**
  137747. * Enable or disable the shader compilation time capture
  137748. */
  137749. set captureShaderCompilationTime(value: boolean);
  137750. /**
  137751. * Instantiates a new engine instrumentation.
  137752. * This class can be used to get instrumentation data from a Babylon engine
  137753. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  137754. * @param engine Defines the engine to instrument
  137755. */
  137756. constructor(
  137757. /**
  137758. * Define the instrumented engine.
  137759. */
  137760. engine: Engine);
  137761. /**
  137762. * Dispose and release associated resources.
  137763. */
  137764. dispose(): void;
  137765. }
  137766. }
  137767. declare module BABYLON {
  137768. /**
  137769. * This class can be used to get instrumentation data from a Babylon engine
  137770. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  137771. */
  137772. export class SceneInstrumentation implements IDisposable {
  137773. /**
  137774. * Defines the scene to instrument
  137775. */
  137776. scene: Scene;
  137777. private _captureActiveMeshesEvaluationTime;
  137778. private _activeMeshesEvaluationTime;
  137779. private _captureRenderTargetsRenderTime;
  137780. private _renderTargetsRenderTime;
  137781. private _captureFrameTime;
  137782. private _frameTime;
  137783. private _captureRenderTime;
  137784. private _renderTime;
  137785. private _captureInterFrameTime;
  137786. private _interFrameTime;
  137787. private _captureParticlesRenderTime;
  137788. private _particlesRenderTime;
  137789. private _captureSpritesRenderTime;
  137790. private _spritesRenderTime;
  137791. private _capturePhysicsTime;
  137792. private _physicsTime;
  137793. private _captureAnimationsTime;
  137794. private _animationsTime;
  137795. private _captureCameraRenderTime;
  137796. private _cameraRenderTime;
  137797. private _onBeforeActiveMeshesEvaluationObserver;
  137798. private _onAfterActiveMeshesEvaluationObserver;
  137799. private _onBeforeRenderTargetsRenderObserver;
  137800. private _onAfterRenderTargetsRenderObserver;
  137801. private _onAfterRenderObserver;
  137802. private _onBeforeDrawPhaseObserver;
  137803. private _onAfterDrawPhaseObserver;
  137804. private _onBeforeAnimationsObserver;
  137805. private _onBeforeParticlesRenderingObserver;
  137806. private _onAfterParticlesRenderingObserver;
  137807. private _onBeforeSpritesRenderingObserver;
  137808. private _onAfterSpritesRenderingObserver;
  137809. private _onBeforePhysicsObserver;
  137810. private _onAfterPhysicsObserver;
  137811. private _onAfterAnimationsObserver;
  137812. private _onBeforeCameraRenderObserver;
  137813. private _onAfterCameraRenderObserver;
  137814. /**
  137815. * Gets the perf counter used for active meshes evaluation time
  137816. */
  137817. get activeMeshesEvaluationTimeCounter(): PerfCounter;
  137818. /**
  137819. * Gets the active meshes evaluation time capture status
  137820. */
  137821. get captureActiveMeshesEvaluationTime(): boolean;
  137822. /**
  137823. * Enable or disable the active meshes evaluation time capture
  137824. */
  137825. set captureActiveMeshesEvaluationTime(value: boolean);
  137826. /**
  137827. * Gets the perf counter used for render targets render time
  137828. */
  137829. get renderTargetsRenderTimeCounter(): PerfCounter;
  137830. /**
  137831. * Gets the render targets render time capture status
  137832. */
  137833. get captureRenderTargetsRenderTime(): boolean;
  137834. /**
  137835. * Enable or disable the render targets render time capture
  137836. */
  137837. set captureRenderTargetsRenderTime(value: boolean);
  137838. /**
  137839. * Gets the perf counter used for particles render time
  137840. */
  137841. get particlesRenderTimeCounter(): PerfCounter;
  137842. /**
  137843. * Gets the particles render time capture status
  137844. */
  137845. get captureParticlesRenderTime(): boolean;
  137846. /**
  137847. * Enable or disable the particles render time capture
  137848. */
  137849. set captureParticlesRenderTime(value: boolean);
  137850. /**
  137851. * Gets the perf counter used for sprites render time
  137852. */
  137853. get spritesRenderTimeCounter(): PerfCounter;
  137854. /**
  137855. * Gets the sprites render time capture status
  137856. */
  137857. get captureSpritesRenderTime(): boolean;
  137858. /**
  137859. * Enable or disable the sprites render time capture
  137860. */
  137861. set captureSpritesRenderTime(value: boolean);
  137862. /**
  137863. * Gets the perf counter used for physics time
  137864. */
  137865. get physicsTimeCounter(): PerfCounter;
  137866. /**
  137867. * Gets the physics time capture status
  137868. */
  137869. get capturePhysicsTime(): boolean;
  137870. /**
  137871. * Enable or disable the physics time capture
  137872. */
  137873. set capturePhysicsTime(value: boolean);
  137874. /**
  137875. * Gets the perf counter used for animations time
  137876. */
  137877. get animationsTimeCounter(): PerfCounter;
  137878. /**
  137879. * Gets the animations time capture status
  137880. */
  137881. get captureAnimationsTime(): boolean;
  137882. /**
  137883. * Enable or disable the animations time capture
  137884. */
  137885. set captureAnimationsTime(value: boolean);
  137886. /**
  137887. * Gets the perf counter used for frame time capture
  137888. */
  137889. get frameTimeCounter(): PerfCounter;
  137890. /**
  137891. * Gets the frame time capture status
  137892. */
  137893. get captureFrameTime(): boolean;
  137894. /**
  137895. * Enable or disable the frame time capture
  137896. */
  137897. set captureFrameTime(value: boolean);
  137898. /**
  137899. * Gets the perf counter used for inter-frames time capture
  137900. */
  137901. get interFrameTimeCounter(): PerfCounter;
  137902. /**
  137903. * Gets the inter-frames time capture status
  137904. */
  137905. get captureInterFrameTime(): boolean;
  137906. /**
  137907. * Enable or disable the inter-frames time capture
  137908. */
  137909. set captureInterFrameTime(value: boolean);
  137910. /**
  137911. * Gets the perf counter used for render time capture
  137912. */
  137913. get renderTimeCounter(): PerfCounter;
  137914. /**
  137915. * Gets the render time capture status
  137916. */
  137917. get captureRenderTime(): boolean;
  137918. /**
  137919. * Enable or disable the render time capture
  137920. */
  137921. set captureRenderTime(value: boolean);
  137922. /**
  137923. * Gets the perf counter used for camera render time capture
  137924. */
  137925. get cameraRenderTimeCounter(): PerfCounter;
  137926. /**
  137927. * Gets the camera render time capture status
  137928. */
  137929. get captureCameraRenderTime(): boolean;
  137930. /**
  137931. * Enable or disable the camera render time capture
  137932. */
  137933. set captureCameraRenderTime(value: boolean);
  137934. /**
  137935. * Gets the perf counter used for draw calls
  137936. */
  137937. get drawCallsCounter(): PerfCounter;
  137938. /**
  137939. * Instantiates a new scene instrumentation.
  137940. * This class can be used to get instrumentation data from a Babylon engine
  137941. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  137942. * @param scene Defines the scene to instrument
  137943. */
  137944. constructor(
  137945. /**
  137946. * Defines the scene to instrument
  137947. */
  137948. scene: Scene);
  137949. /**
  137950. * Dispose and release associated resources.
  137951. */
  137952. dispose(): void;
  137953. }
  137954. }
  137955. declare module BABYLON {
  137956. /** @hidden */
  137957. export var glowMapGenerationPixelShader: {
  137958. name: string;
  137959. shader: string;
  137960. };
  137961. }
  137962. declare module BABYLON {
  137963. /** @hidden */
  137964. export var glowMapGenerationVertexShader: {
  137965. name: string;
  137966. shader: string;
  137967. };
  137968. }
  137969. declare module BABYLON {
  137970. /**
  137971. * Effect layer options. This helps customizing the behaviour
  137972. * of the effect layer.
  137973. */
  137974. export interface IEffectLayerOptions {
  137975. /**
  137976. * Multiplication factor apply to the canvas size to compute the render target size
  137977. * used to generated the objects (the smaller the faster).
  137978. */
  137979. mainTextureRatio: number;
  137980. /**
  137981. * Enforces a fixed size texture to ensure effect stability across devices.
  137982. */
  137983. mainTextureFixedSize?: number;
  137984. /**
  137985. * Alpha blending mode used to apply the blur. Default depends of the implementation.
  137986. */
  137987. alphaBlendingMode: number;
  137988. /**
  137989. * The camera attached to the layer.
  137990. */
  137991. camera: Nullable<Camera>;
  137992. /**
  137993. * The rendering group to draw the layer in.
  137994. */
  137995. renderingGroupId: number;
  137996. }
  137997. /**
  137998. * The effect layer Helps adding post process effect blended with the main pass.
  137999. *
  138000. * This can be for instance use to generate glow or higlight effects on the scene.
  138001. *
  138002. * The effect layer class can not be used directly and is intented to inherited from to be
  138003. * customized per effects.
  138004. */
  138005. export abstract class EffectLayer {
  138006. private _vertexBuffers;
  138007. private _indexBuffer;
  138008. private _cachedDefines;
  138009. private _effectLayerMapGenerationEffect;
  138010. private _effectLayerOptions;
  138011. private _mergeEffect;
  138012. protected _scene: Scene;
  138013. protected _engine: Engine;
  138014. protected _maxSize: number;
  138015. protected _mainTextureDesiredSize: ISize;
  138016. protected _mainTexture: RenderTargetTexture;
  138017. protected _shouldRender: boolean;
  138018. protected _postProcesses: PostProcess[];
  138019. protected _textures: BaseTexture[];
  138020. protected _emissiveTextureAndColor: {
  138021. texture: Nullable<BaseTexture>;
  138022. color: Color4;
  138023. };
  138024. /**
  138025. * The name of the layer
  138026. */
  138027. name: string;
  138028. /**
  138029. * The clear color of the texture used to generate the glow map.
  138030. */
  138031. neutralColor: Color4;
  138032. /**
  138033. * Specifies whether the highlight layer is enabled or not.
  138034. */
  138035. isEnabled: boolean;
  138036. /**
  138037. * Gets the camera attached to the layer.
  138038. */
  138039. get camera(): Nullable<Camera>;
  138040. /**
  138041. * Gets the rendering group id the layer should render in.
  138042. */
  138043. get renderingGroupId(): number;
  138044. set renderingGroupId(renderingGroupId: number);
  138045. /**
  138046. * An event triggered when the effect layer has been disposed.
  138047. */
  138048. onDisposeObservable: Observable<EffectLayer>;
  138049. /**
  138050. * An event triggered when the effect layer is about rendering the main texture with the glowy parts.
  138051. */
  138052. onBeforeRenderMainTextureObservable: Observable<EffectLayer>;
  138053. /**
  138054. * An event triggered when the generated texture is being merged in the scene.
  138055. */
  138056. onBeforeComposeObservable: Observable<EffectLayer>;
  138057. /**
  138058. * An event triggered when the mesh is rendered into the effect render target.
  138059. */
  138060. onBeforeRenderMeshToEffect: Observable<AbstractMesh>;
  138061. /**
  138062. * An event triggered after the mesh has been rendered into the effect render target.
  138063. */
  138064. onAfterRenderMeshToEffect: Observable<AbstractMesh>;
  138065. /**
  138066. * An event triggered when the generated texture has been merged in the scene.
  138067. */
  138068. onAfterComposeObservable: Observable<EffectLayer>;
  138069. /**
  138070. * An event triggered when the efffect layer changes its size.
  138071. */
  138072. onSizeChangedObservable: Observable<EffectLayer>;
  138073. /** @hidden */
  138074. static _SceneComponentInitialization: (scene: Scene) => void;
  138075. /**
  138076. * Instantiates a new effect Layer and references it in the scene.
  138077. * @param name The name of the layer
  138078. * @param scene The scene to use the layer in
  138079. */
  138080. constructor(
  138081. /** The Friendly of the effect in the scene */
  138082. name: string, scene: Scene);
  138083. /**
  138084. * Get the effect name of the layer.
  138085. * @return The effect name
  138086. */
  138087. abstract getEffectName(): string;
  138088. /**
  138089. * Checks for the readiness of the element composing the layer.
  138090. * @param subMesh the mesh to check for
  138091. * @param useInstances specify whether or not to use instances to render the mesh
  138092. * @return true if ready otherwise, false
  138093. */
  138094. abstract isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  138095. /**
  138096. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  138097. * @returns true if the effect requires stencil during the main canvas render pass.
  138098. */
  138099. abstract needStencil(): boolean;
  138100. /**
  138101. * Create the merge effect. This is the shader use to blit the information back
  138102. * to the main canvas at the end of the scene rendering.
  138103. * @returns The effect containing the shader used to merge the effect on the main canvas
  138104. */
  138105. protected abstract _createMergeEffect(): Effect;
  138106. /**
  138107. * Creates the render target textures and post processes used in the effect layer.
  138108. */
  138109. protected abstract _createTextureAndPostProcesses(): void;
  138110. /**
  138111. * Implementation specific of rendering the generating effect on the main canvas.
  138112. * @param effect The effect used to render through
  138113. */
  138114. protected abstract _internalRender(effect: Effect): void;
  138115. /**
  138116. * Sets the required values for both the emissive texture and and the main color.
  138117. */
  138118. protected abstract _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  138119. /**
  138120. * Free any resources and references associated to a mesh.
  138121. * Internal use
  138122. * @param mesh The mesh to free.
  138123. */
  138124. abstract _disposeMesh(mesh: Mesh): void;
  138125. /**
  138126. * Serializes this layer (Glow or Highlight for example)
  138127. * @returns a serialized layer object
  138128. */
  138129. abstract serialize?(): any;
  138130. /**
  138131. * Initializes the effect layer with the required options.
  138132. * @param options Sets of none mandatory options to use with the layer (see IEffectLayerOptions for more information)
  138133. */
  138134. protected _init(options: Partial<IEffectLayerOptions>): void;
  138135. /**
  138136. * Generates the index buffer of the full screen quad blending to the main canvas.
  138137. */
  138138. private _generateIndexBuffer;
  138139. /**
  138140. * Generates the vertex buffer of the full screen quad blending to the main canvas.
  138141. */
  138142. private _generateVertexBuffer;
  138143. /**
  138144. * Sets the main texture desired size which is the closest power of two
  138145. * of the engine canvas size.
  138146. */
  138147. private _setMainTextureSize;
  138148. /**
  138149. * Creates the main texture for the effect layer.
  138150. */
  138151. protected _createMainTexture(): void;
  138152. /**
  138153. * Adds specific effects defines.
  138154. * @param defines The defines to add specifics to.
  138155. */
  138156. protected _addCustomEffectDefines(defines: string[]): void;
  138157. /**
  138158. * Checks for the readiness of the element composing the layer.
  138159. * @param subMesh the mesh to check for
  138160. * @param useInstances specify whether or not to use instances to render the mesh
  138161. * @param emissiveTexture the associated emissive texture used to generate the glow
  138162. * @return true if ready otherwise, false
  138163. */
  138164. protected _isReady(subMesh: SubMesh, useInstances: boolean, emissiveTexture: Nullable<BaseTexture>): boolean;
  138165. /**
  138166. * Renders the glowing part of the scene by blending the blurred glowing meshes on top of the rendered scene.
  138167. */
  138168. render(): void;
  138169. /**
  138170. * Determine if a given mesh will be used in the current effect.
  138171. * @param mesh mesh to test
  138172. * @returns true if the mesh will be used
  138173. */
  138174. hasMesh(mesh: AbstractMesh): boolean;
  138175. /**
  138176. * Returns true if the layer contains information to display, otherwise false.
  138177. * @returns true if the glow layer should be rendered
  138178. */
  138179. shouldRender(): boolean;
  138180. /**
  138181. * Returns true if the mesh should render, otherwise false.
  138182. * @param mesh The mesh to render
  138183. * @returns true if it should render otherwise false
  138184. */
  138185. protected _shouldRenderMesh(mesh: AbstractMesh): boolean;
  138186. /**
  138187. * Returns true if the mesh can be rendered, otherwise false.
  138188. * @param mesh The mesh to render
  138189. * @param material The material used on the mesh
  138190. * @returns true if it can be rendered otherwise false
  138191. */
  138192. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  138193. /**
  138194. * Returns true if the mesh should render, otherwise false.
  138195. * @param mesh The mesh to render
  138196. * @returns true if it should render otherwise false
  138197. */
  138198. protected _shouldRenderEmissiveTextureForMesh(): boolean;
  138199. /**
  138200. * Renders the submesh passed in parameter to the generation map.
  138201. */
  138202. protected _renderSubMesh(subMesh: SubMesh, enableAlphaMode?: boolean): void;
  138203. /**
  138204. * Defines whether the current material of the mesh should be use to render the effect.
  138205. * @param mesh defines the current mesh to render
  138206. */
  138207. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  138208. /**
  138209. * Rebuild the required buffers.
  138210. * @hidden Internal use only.
  138211. */
  138212. _rebuild(): void;
  138213. /**
  138214. * Dispose only the render target textures and post process.
  138215. */
  138216. private _disposeTextureAndPostProcesses;
  138217. /**
  138218. * Dispose the highlight layer and free resources.
  138219. */
  138220. dispose(): void;
  138221. /**
  138222. * Gets the class name of the effect layer
  138223. * @returns the string with the class name of the effect layer
  138224. */
  138225. getClassName(): string;
  138226. /**
  138227. * Creates an effect layer from parsed effect layer data
  138228. * @param parsedEffectLayer defines effect layer data
  138229. * @param scene defines the current scene
  138230. * @param rootUrl defines the root URL containing the effect layer information
  138231. * @returns a parsed effect Layer
  138232. */
  138233. static Parse(parsedEffectLayer: any, scene: Scene, rootUrl: string): EffectLayer;
  138234. }
  138235. }
  138236. declare module BABYLON {
  138237. interface AbstractScene {
  138238. /**
  138239. * The list of effect layers (highlights/glow) added to the scene
  138240. * @see https://doc.babylonjs.com/how_to/highlight_layer
  138241. * @see https://doc.babylonjs.com/how_to/glow_layer
  138242. */
  138243. effectLayers: Array<EffectLayer>;
  138244. /**
  138245. * Removes the given effect layer from this scene.
  138246. * @param toRemove defines the effect layer to remove
  138247. * @returns the index of the removed effect layer
  138248. */
  138249. removeEffectLayer(toRemove: EffectLayer): number;
  138250. /**
  138251. * Adds the given effect layer to this scene
  138252. * @param newEffectLayer defines the effect layer to add
  138253. */
  138254. addEffectLayer(newEffectLayer: EffectLayer): void;
  138255. }
  138256. /**
  138257. * Defines the layer scene component responsible to manage any effect layers
  138258. * in a given scene.
  138259. */
  138260. export class EffectLayerSceneComponent implements ISceneSerializableComponent {
  138261. /**
  138262. * The component name helpfull to identify the component in the list of scene components.
  138263. */
  138264. readonly name: string;
  138265. /**
  138266. * The scene the component belongs to.
  138267. */
  138268. scene: Scene;
  138269. private _engine;
  138270. private _renderEffects;
  138271. private _needStencil;
  138272. private _previousStencilState;
  138273. /**
  138274. * Creates a new instance of the component for the given scene
  138275. * @param scene Defines the scene to register the component in
  138276. */
  138277. constructor(scene: Scene);
  138278. /**
  138279. * Registers the component in a given scene
  138280. */
  138281. register(): void;
  138282. /**
  138283. * Rebuilds the elements related to this component in case of
  138284. * context lost for instance.
  138285. */
  138286. rebuild(): void;
  138287. /**
  138288. * Serializes the component data to the specified json object
  138289. * @param serializationObject The object to serialize to
  138290. */
  138291. serialize(serializationObject: any): void;
  138292. /**
  138293. * Adds all the elements from the container to the scene
  138294. * @param container the container holding the elements
  138295. */
  138296. addFromContainer(container: AbstractScene): void;
  138297. /**
  138298. * Removes all the elements in the container from the scene
  138299. * @param container contains the elements to remove
  138300. * @param dispose if the removed element should be disposed (default: false)
  138301. */
  138302. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  138303. /**
  138304. * Disposes the component and the associated ressources.
  138305. */
  138306. dispose(): void;
  138307. private _isReadyForMesh;
  138308. private _renderMainTexture;
  138309. private _setStencil;
  138310. private _setStencilBack;
  138311. private _draw;
  138312. private _drawCamera;
  138313. private _drawRenderingGroup;
  138314. }
  138315. }
  138316. declare module BABYLON {
  138317. /** @hidden */
  138318. export var glowMapMergePixelShader: {
  138319. name: string;
  138320. shader: string;
  138321. };
  138322. }
  138323. declare module BABYLON {
  138324. /** @hidden */
  138325. export var glowMapMergeVertexShader: {
  138326. name: string;
  138327. shader: string;
  138328. };
  138329. }
  138330. declare module BABYLON {
  138331. interface AbstractScene {
  138332. /**
  138333. * Return a the first highlight layer of the scene with a given name.
  138334. * @param name The name of the highlight layer to look for.
  138335. * @return The highlight layer if found otherwise null.
  138336. */
  138337. getGlowLayerByName(name: string): Nullable<GlowLayer>;
  138338. }
  138339. /**
  138340. * Glow layer options. This helps customizing the behaviour
  138341. * of the glow layer.
  138342. */
  138343. export interface IGlowLayerOptions {
  138344. /**
  138345. * Multiplication factor apply to the canvas size to compute the render target size
  138346. * used to generated the glowing objects (the smaller the faster).
  138347. */
  138348. mainTextureRatio: number;
  138349. /**
  138350. * Enforces a fixed size texture to ensure resize independant blur.
  138351. */
  138352. mainTextureFixedSize?: number;
  138353. /**
  138354. * How big is the kernel of the blur texture.
  138355. */
  138356. blurKernelSize: number;
  138357. /**
  138358. * The camera attached to the layer.
  138359. */
  138360. camera: Nullable<Camera>;
  138361. /**
  138362. * Enable MSAA by chosing the number of samples.
  138363. */
  138364. mainTextureSamples?: number;
  138365. /**
  138366. * The rendering group to draw the layer in.
  138367. */
  138368. renderingGroupId: number;
  138369. }
  138370. /**
  138371. * The glow layer Helps adding a glow effect around the emissive parts of a mesh.
  138372. *
  138373. * Once instantiated in a scene, by default, all the emissive meshes will glow.
  138374. *
  138375. * Documentation: https://doc.babylonjs.com/how_to/glow_layer
  138376. */
  138377. export class GlowLayer extends EffectLayer {
  138378. /**
  138379. * Effect Name of the layer.
  138380. */
  138381. static readonly EffectName: string;
  138382. /**
  138383. * The default blur kernel size used for the glow.
  138384. */
  138385. static DefaultBlurKernelSize: number;
  138386. /**
  138387. * The default texture size ratio used for the glow.
  138388. */
  138389. static DefaultTextureRatio: number;
  138390. /**
  138391. * Sets the kernel size of the blur.
  138392. */
  138393. set blurKernelSize(value: number);
  138394. /**
  138395. * Gets the kernel size of the blur.
  138396. */
  138397. get blurKernelSize(): number;
  138398. /**
  138399. * Sets the glow intensity.
  138400. */
  138401. set intensity(value: number);
  138402. /**
  138403. * Gets the glow intensity.
  138404. */
  138405. get intensity(): number;
  138406. private _options;
  138407. private _intensity;
  138408. private _horizontalBlurPostprocess1;
  138409. private _verticalBlurPostprocess1;
  138410. private _horizontalBlurPostprocess2;
  138411. private _verticalBlurPostprocess2;
  138412. private _blurTexture1;
  138413. private _blurTexture2;
  138414. private _postProcesses1;
  138415. private _postProcesses2;
  138416. private _includedOnlyMeshes;
  138417. private _excludedMeshes;
  138418. private _meshesUsingTheirOwnMaterials;
  138419. /**
  138420. * Callback used to let the user override the color selection on a per mesh basis
  138421. */
  138422. customEmissiveColorSelector: (mesh: Mesh, subMesh: SubMesh, material: Material, result: Color4) => void;
  138423. /**
  138424. * Callback used to let the user override the texture selection on a per mesh basis
  138425. */
  138426. customEmissiveTextureSelector: (mesh: Mesh, subMesh: SubMesh, material: Material) => Texture;
  138427. /**
  138428. * Instantiates a new glow Layer and references it to the scene.
  138429. * @param name The name of the layer
  138430. * @param scene The scene to use the layer in
  138431. * @param options Sets of none mandatory options to use with the layer (see IGlowLayerOptions for more information)
  138432. */
  138433. constructor(name: string, scene: Scene, options?: Partial<IGlowLayerOptions>);
  138434. /**
  138435. * Get the effect name of the layer.
  138436. * @return The effect name
  138437. */
  138438. getEffectName(): string;
  138439. /**
  138440. * Create the merge effect. This is the shader use to blit the information back
  138441. * to the main canvas at the end of the scene rendering.
  138442. */
  138443. protected _createMergeEffect(): Effect;
  138444. /**
  138445. * Creates the render target textures and post processes used in the glow layer.
  138446. */
  138447. protected _createTextureAndPostProcesses(): void;
  138448. /**
  138449. * Checks for the readiness of the element composing the layer.
  138450. * @param subMesh the mesh to check for
  138451. * @param useInstances specify wether or not to use instances to render the mesh
  138452. * @param emissiveTexture the associated emissive texture used to generate the glow
  138453. * @return true if ready otherwise, false
  138454. */
  138455. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  138456. /**
  138457. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  138458. */
  138459. needStencil(): boolean;
  138460. /**
  138461. * Returns true if the mesh can be rendered, otherwise false.
  138462. * @param mesh The mesh to render
  138463. * @param material The material used on the mesh
  138464. * @returns true if it can be rendered otherwise false
  138465. */
  138466. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  138467. /**
  138468. * Implementation specific of rendering the generating effect on the main canvas.
  138469. * @param effect The effect used to render through
  138470. */
  138471. protected _internalRender(effect: Effect): void;
  138472. /**
  138473. * Sets the required values for both the emissive texture and and the main color.
  138474. */
  138475. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  138476. /**
  138477. * Returns true if the mesh should render, otherwise false.
  138478. * @param mesh The mesh to render
  138479. * @returns true if it should render otherwise false
  138480. */
  138481. protected _shouldRenderMesh(mesh: Mesh): boolean;
  138482. /**
  138483. * Adds specific effects defines.
  138484. * @param defines The defines to add specifics to.
  138485. */
  138486. protected _addCustomEffectDefines(defines: string[]): void;
  138487. /**
  138488. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the glow layer.
  138489. * @param mesh The mesh to exclude from the glow layer
  138490. */
  138491. addExcludedMesh(mesh: Mesh): void;
  138492. /**
  138493. * Remove a mesh from the exclusion list to let it impact or being impacted by the glow layer.
  138494. * @param mesh The mesh to remove
  138495. */
  138496. removeExcludedMesh(mesh: Mesh): void;
  138497. /**
  138498. * Add a mesh in the inclusion list to impact or being impacted by the glow layer.
  138499. * @param mesh The mesh to include in the glow layer
  138500. */
  138501. addIncludedOnlyMesh(mesh: Mesh): void;
  138502. /**
  138503. * Remove a mesh from the Inclusion list to prevent it to impact or being impacted by the glow layer.
  138504. * @param mesh The mesh to remove
  138505. */
  138506. removeIncludedOnlyMesh(mesh: Mesh): void;
  138507. /**
  138508. * Determine if a given mesh will be used in the glow layer
  138509. * @param mesh The mesh to test
  138510. * @returns true if the mesh will be highlighted by the current glow layer
  138511. */
  138512. hasMesh(mesh: AbstractMesh): boolean;
  138513. /**
  138514. * Defines whether the current material of the mesh should be use to render the effect.
  138515. * @param mesh defines the current mesh to render
  138516. */
  138517. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  138518. /**
  138519. * Add a mesh to be rendered through its own material and not with emissive only.
  138520. * @param mesh The mesh for which we need to use its material
  138521. */
  138522. referenceMeshToUseItsOwnMaterial(mesh: AbstractMesh): void;
  138523. /**
  138524. * Remove a mesh from being rendered through its own material and not with emissive only.
  138525. * @param mesh The mesh for which we need to not use its material
  138526. */
  138527. unReferenceMeshFromUsingItsOwnMaterial(mesh: AbstractMesh): void;
  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. * Gets the class name of the effect layer
  138537. * @returns the string with the class name of the effect layer
  138538. */
  138539. getClassName(): string;
  138540. /**
  138541. * Serializes this glow layer
  138542. * @returns a serialized glow layer object
  138543. */
  138544. serialize(): any;
  138545. /**
  138546. * Creates a Glow Layer from parsed glow layer data
  138547. * @param parsedGlowLayer defines glow layer data
  138548. * @param scene defines the current scene
  138549. * @param rootUrl defines the root URL containing the glow layer information
  138550. * @returns a parsed Glow Layer
  138551. */
  138552. static Parse(parsedGlowLayer: any, scene: Scene, rootUrl: string): GlowLayer;
  138553. }
  138554. }
  138555. declare module BABYLON {
  138556. /** @hidden */
  138557. export var glowBlurPostProcessPixelShader: {
  138558. name: string;
  138559. shader: string;
  138560. };
  138561. }
  138562. declare module BABYLON {
  138563. interface AbstractScene {
  138564. /**
  138565. * Return a the first highlight layer of the scene with a given name.
  138566. * @param name The name of the highlight layer to look for.
  138567. * @return The highlight layer if found otherwise null.
  138568. */
  138569. getHighlightLayerByName(name: string): Nullable<HighlightLayer>;
  138570. }
  138571. /**
  138572. * Highlight layer options. This helps customizing the behaviour
  138573. * of the highlight layer.
  138574. */
  138575. export interface IHighlightLayerOptions {
  138576. /**
  138577. * Multiplication factor apply to the canvas size to compute the render target size
  138578. * used to generated the glowing objects (the smaller the faster).
  138579. */
  138580. mainTextureRatio: number;
  138581. /**
  138582. * Enforces a fixed size texture to ensure resize independant blur.
  138583. */
  138584. mainTextureFixedSize?: number;
  138585. /**
  138586. * Multiplication factor apply to the main texture size in the first step of the blur to reduce the size
  138587. * of the picture to blur (the smaller the faster).
  138588. */
  138589. blurTextureSizeRatio: number;
  138590. /**
  138591. * How big in texel of the blur texture is the vertical blur.
  138592. */
  138593. blurVerticalSize: number;
  138594. /**
  138595. * How big in texel of the blur texture is the horizontal blur.
  138596. */
  138597. blurHorizontalSize: number;
  138598. /**
  138599. * Alpha blending mode used to apply the blur. Default is combine.
  138600. */
  138601. alphaBlendingMode: number;
  138602. /**
  138603. * The camera attached to the layer.
  138604. */
  138605. camera: Nullable<Camera>;
  138606. /**
  138607. * Should we display highlight as a solid stroke?
  138608. */
  138609. isStroke?: boolean;
  138610. /**
  138611. * The rendering group to draw the layer in.
  138612. */
  138613. renderingGroupId: number;
  138614. }
  138615. /**
  138616. * The highlight layer Helps adding a glow effect around a mesh.
  138617. *
  138618. * Once instantiated in a scene, simply use the addMesh or removeMesh method to add or remove
  138619. * glowy meshes to your scene.
  138620. *
  138621. * !!! THIS REQUIRES AN ACTIVE STENCIL BUFFER ON THE CANVAS !!!
  138622. */
  138623. export class HighlightLayer extends EffectLayer {
  138624. name: string;
  138625. /**
  138626. * Effect Name of the highlight layer.
  138627. */
  138628. static readonly EffectName: string;
  138629. /**
  138630. * The neutral color used during the preparation of the glow effect.
  138631. * This is black by default as the blend operation is a blend operation.
  138632. */
  138633. static NeutralColor: Color4;
  138634. /**
  138635. * Stencil value used for glowing meshes.
  138636. */
  138637. static GlowingMeshStencilReference: number;
  138638. /**
  138639. * Stencil value used for the other meshes in the scene.
  138640. */
  138641. static NormalMeshStencilReference: number;
  138642. /**
  138643. * Specifies whether or not the inner glow is ACTIVE in the layer.
  138644. */
  138645. innerGlow: boolean;
  138646. /**
  138647. * Specifies whether or not the outer glow is ACTIVE in the layer.
  138648. */
  138649. outerGlow: boolean;
  138650. /**
  138651. * Specifies the horizontal size of the blur.
  138652. */
  138653. set blurHorizontalSize(value: number);
  138654. /**
  138655. * Specifies the vertical size of the blur.
  138656. */
  138657. set blurVerticalSize(value: number);
  138658. /**
  138659. * Gets the horizontal size of the blur.
  138660. */
  138661. get blurHorizontalSize(): number;
  138662. /**
  138663. * Gets the vertical size of the blur.
  138664. */
  138665. get blurVerticalSize(): number;
  138666. /**
  138667. * An event triggered when the highlight layer is being blurred.
  138668. */
  138669. onBeforeBlurObservable: Observable<HighlightLayer>;
  138670. /**
  138671. * An event triggered when the highlight layer has been blurred.
  138672. */
  138673. onAfterBlurObservable: Observable<HighlightLayer>;
  138674. private _instanceGlowingMeshStencilReference;
  138675. private _options;
  138676. private _downSamplePostprocess;
  138677. private _horizontalBlurPostprocess;
  138678. private _verticalBlurPostprocess;
  138679. private _blurTexture;
  138680. private _meshes;
  138681. private _excludedMeshes;
  138682. /**
  138683. * Instantiates a new highlight Layer and references it to the scene..
  138684. * @param name The name of the layer
  138685. * @param scene The scene to use the layer in
  138686. * @param options Sets of none mandatory options to use with the layer (see IHighlightLayerOptions for more information)
  138687. */
  138688. constructor(name: string, scene: Scene, options?: Partial<IHighlightLayerOptions>);
  138689. /**
  138690. * Get the effect name of the layer.
  138691. * @return The effect name
  138692. */
  138693. getEffectName(): string;
  138694. /**
  138695. * Create the merge effect. This is the shader use to blit the information back
  138696. * to the main canvas at the end of the scene rendering.
  138697. */
  138698. protected _createMergeEffect(): Effect;
  138699. /**
  138700. * Creates the render target textures and post processes used in the highlight layer.
  138701. */
  138702. protected _createTextureAndPostProcesses(): void;
  138703. /**
  138704. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  138705. */
  138706. needStencil(): boolean;
  138707. /**
  138708. * Checks for the readiness of the element composing the layer.
  138709. * @param subMesh the mesh to check for
  138710. * @param useInstances specify wether or not to use instances to render the mesh
  138711. * @param emissiveTexture the associated emissive texture used to generate the glow
  138712. * @return true if ready otherwise, false
  138713. */
  138714. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  138715. /**
  138716. * Implementation specific of rendering the generating effect on the main canvas.
  138717. * @param effect The effect used to render through
  138718. */
  138719. protected _internalRender(effect: Effect): void;
  138720. /**
  138721. * Returns true if the layer contains information to display, otherwise false.
  138722. */
  138723. shouldRender(): boolean;
  138724. /**
  138725. * Returns true if the mesh should render, otherwise false.
  138726. * @param mesh The mesh to render
  138727. * @returns true if it should render otherwise false
  138728. */
  138729. protected _shouldRenderMesh(mesh: Mesh): boolean;
  138730. /**
  138731. * Returns true if the mesh can be rendered, otherwise false.
  138732. * @param mesh The mesh to render
  138733. * @param material The material used on the mesh
  138734. * @returns true if it can be rendered otherwise false
  138735. */
  138736. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  138737. /**
  138738. * Adds specific effects defines.
  138739. * @param defines The defines to add specifics to.
  138740. */
  138741. protected _addCustomEffectDefines(defines: string[]): void;
  138742. /**
  138743. * Sets the required values for both the emissive texture and and the main color.
  138744. */
  138745. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  138746. /**
  138747. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the highlight layer.
  138748. * @param mesh The mesh to exclude from the highlight layer
  138749. */
  138750. addExcludedMesh(mesh: Mesh): void;
  138751. /**
  138752. * Remove a mesh from the exclusion list to let it impact or being impacted by the highlight layer.
  138753. * @param mesh The mesh to highlight
  138754. */
  138755. removeExcludedMesh(mesh: Mesh): void;
  138756. /**
  138757. * Determine if a given mesh will be highlighted by the current HighlightLayer
  138758. * @param mesh mesh to test
  138759. * @returns true if the mesh will be highlighted by the current HighlightLayer
  138760. */
  138761. hasMesh(mesh: AbstractMesh): boolean;
  138762. /**
  138763. * Add a mesh in the highlight layer in order to make it glow with the chosen color.
  138764. * @param mesh The mesh to highlight
  138765. * @param color The color of the highlight
  138766. * @param glowEmissiveOnly Extract the glow from the emissive texture
  138767. */
  138768. addMesh(mesh: Mesh, color: Color3, glowEmissiveOnly?: boolean): void;
  138769. /**
  138770. * Remove a mesh from the highlight layer in order to make it stop glowing.
  138771. * @param mesh The mesh to highlight
  138772. */
  138773. removeMesh(mesh: Mesh): void;
  138774. /**
  138775. * Remove all the meshes currently referenced in the highlight layer
  138776. */
  138777. removeAllMeshes(): void;
  138778. /**
  138779. * Force the stencil to the normal expected value for none glowing parts
  138780. */
  138781. private _defaultStencilReference;
  138782. /**
  138783. * Free any resources and references associated to a mesh.
  138784. * Internal use
  138785. * @param mesh The mesh to free.
  138786. * @hidden
  138787. */
  138788. _disposeMesh(mesh: Mesh): void;
  138789. /**
  138790. * Dispose the highlight layer and free resources.
  138791. */
  138792. dispose(): void;
  138793. /**
  138794. * Gets the class name of the effect layer
  138795. * @returns the string with the class name of the effect layer
  138796. */
  138797. getClassName(): string;
  138798. /**
  138799. * Serializes this Highlight layer
  138800. * @returns a serialized Highlight layer object
  138801. */
  138802. serialize(): any;
  138803. /**
  138804. * Creates a Highlight layer from parsed Highlight layer data
  138805. * @param parsedHightlightLayer defines the Highlight layer data
  138806. * @param scene defines the current scene
  138807. * @param rootUrl defines the root URL containing the Highlight layer information
  138808. * @returns a parsed Highlight layer
  138809. */
  138810. static Parse(parsedHightlightLayer: any, scene: Scene, rootUrl: string): HighlightLayer;
  138811. }
  138812. }
  138813. declare module BABYLON {
  138814. interface AbstractScene {
  138815. /**
  138816. * The list of layers (background and foreground) of the scene
  138817. */
  138818. layers: Array<Layer>;
  138819. }
  138820. /**
  138821. * Defines the layer scene component responsible to manage any layers
  138822. * in a given scene.
  138823. */
  138824. export class LayerSceneComponent implements ISceneComponent {
  138825. /**
  138826. * The component name helpfull to identify the component in the list of scene components.
  138827. */
  138828. readonly name: string;
  138829. /**
  138830. * The scene the component belongs to.
  138831. */
  138832. scene: Scene;
  138833. private _engine;
  138834. /**
  138835. * Creates a new instance of the component for the given scene
  138836. * @param scene Defines the scene to register the component in
  138837. */
  138838. constructor(scene: Scene);
  138839. /**
  138840. * Registers the component in a given scene
  138841. */
  138842. register(): void;
  138843. /**
  138844. * Rebuilds the elements related to this component in case of
  138845. * context lost for instance.
  138846. */
  138847. rebuild(): void;
  138848. /**
  138849. * Disposes the component and the associated ressources.
  138850. */
  138851. dispose(): void;
  138852. private _draw;
  138853. private _drawCameraPredicate;
  138854. private _drawCameraBackground;
  138855. private _drawCameraForeground;
  138856. private _drawRenderTargetPredicate;
  138857. private _drawRenderTargetBackground;
  138858. private _drawRenderTargetForeground;
  138859. /**
  138860. * Adds all the elements from the container to the scene
  138861. * @param container the container holding the elements
  138862. */
  138863. addFromContainer(container: AbstractScene): void;
  138864. /**
  138865. * Removes all the elements in the container from the scene
  138866. * @param container contains the elements to remove
  138867. * @param dispose if the removed element should be disposed (default: false)
  138868. */
  138869. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  138870. }
  138871. }
  138872. declare module BABYLON {
  138873. /** @hidden */
  138874. export var layerPixelShader: {
  138875. name: string;
  138876. shader: string;
  138877. };
  138878. }
  138879. declare module BABYLON {
  138880. /** @hidden */
  138881. export var layerVertexShader: {
  138882. name: string;
  138883. shader: string;
  138884. };
  138885. }
  138886. declare module BABYLON {
  138887. /**
  138888. * This represents a full screen 2d layer.
  138889. * This can be useful to display a picture in the background of your scene for instance.
  138890. * @see https://www.babylonjs-playground.com/#08A2BS#1
  138891. */
  138892. export class Layer {
  138893. /**
  138894. * Define the name of the layer.
  138895. */
  138896. name: string;
  138897. /**
  138898. * Define the texture the layer should display.
  138899. */
  138900. texture: Nullable<Texture>;
  138901. /**
  138902. * Is the layer in background or foreground.
  138903. */
  138904. isBackground: boolean;
  138905. /**
  138906. * Define the color of the layer (instead of texture).
  138907. */
  138908. color: Color4;
  138909. /**
  138910. * Define the scale of the layer in order to zoom in out of the texture.
  138911. */
  138912. scale: Vector2;
  138913. /**
  138914. * Define an offset for the layer in order to shift the texture.
  138915. */
  138916. offset: Vector2;
  138917. /**
  138918. * Define the alpha blending mode used in the layer in case the texture or color has an alpha.
  138919. */
  138920. alphaBlendingMode: number;
  138921. /**
  138922. * Define if the layer should alpha test or alpha blend with the rest of the scene.
  138923. * Alpha test will not mix with the background color in case of transparency.
  138924. * It will either use the texture color or the background depending on the alpha value of the current pixel.
  138925. */
  138926. alphaTest: boolean;
  138927. /**
  138928. * Define a mask to restrict the layer to only some of the scene cameras.
  138929. */
  138930. layerMask: number;
  138931. /**
  138932. * Define the list of render target the layer is visible into.
  138933. */
  138934. renderTargetTextures: RenderTargetTexture[];
  138935. /**
  138936. * Define if the layer is only used in renderTarget or if it also
  138937. * renders in the main frame buffer of the canvas.
  138938. */
  138939. renderOnlyInRenderTargetTextures: boolean;
  138940. private _scene;
  138941. private _vertexBuffers;
  138942. private _indexBuffer;
  138943. private _effect;
  138944. private _previousDefines;
  138945. /**
  138946. * An event triggered when the layer is disposed.
  138947. */
  138948. onDisposeObservable: Observable<Layer>;
  138949. private _onDisposeObserver;
  138950. /**
  138951. * Back compatibility with callback before the onDisposeObservable existed.
  138952. * The set callback will be triggered when the layer has been disposed.
  138953. */
  138954. set onDispose(callback: () => void);
  138955. /**
  138956. * An event triggered before rendering the scene
  138957. */
  138958. onBeforeRenderObservable: Observable<Layer>;
  138959. private _onBeforeRenderObserver;
  138960. /**
  138961. * Back compatibility with callback before the onBeforeRenderObservable existed.
  138962. * The set callback will be triggered just before rendering the layer.
  138963. */
  138964. set onBeforeRender(callback: () => void);
  138965. /**
  138966. * An event triggered after rendering the scene
  138967. */
  138968. onAfterRenderObservable: Observable<Layer>;
  138969. private _onAfterRenderObserver;
  138970. /**
  138971. * Back compatibility with callback before the onAfterRenderObservable existed.
  138972. * The set callback will be triggered just after rendering the layer.
  138973. */
  138974. set onAfterRender(callback: () => void);
  138975. /**
  138976. * Instantiates a new layer.
  138977. * This represents a full screen 2d layer.
  138978. * This can be useful to display a picture in the background of your scene for instance.
  138979. * @see https://www.babylonjs-playground.com/#08A2BS#1
  138980. * @param name Define the name of the layer in the scene
  138981. * @param imgUrl Define the url of the texture to display in the layer
  138982. * @param scene Define the scene the layer belongs to
  138983. * @param isBackground Defines whether the layer is displayed in front or behind the scene
  138984. * @param color Defines a color for the layer
  138985. */
  138986. constructor(
  138987. /**
  138988. * Define the name of the layer.
  138989. */
  138990. name: string, imgUrl: Nullable<string>, scene: Nullable<Scene>, isBackground?: boolean, color?: Color4);
  138991. private _createIndexBuffer;
  138992. /** @hidden */
  138993. _rebuild(): void;
  138994. /**
  138995. * Renders the layer in the scene.
  138996. */
  138997. render(): void;
  138998. /**
  138999. * Disposes and releases the associated ressources.
  139000. */
  139001. dispose(): void;
  139002. }
  139003. }
  139004. declare module BABYLON {
  139005. /** @hidden */
  139006. export var lensFlarePixelShader: {
  139007. name: string;
  139008. shader: string;
  139009. };
  139010. }
  139011. declare module BABYLON {
  139012. /** @hidden */
  139013. export var lensFlareVertexShader: {
  139014. name: string;
  139015. shader: string;
  139016. };
  139017. }
  139018. declare module BABYLON {
  139019. /**
  139020. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  139021. * It is usually composed of several `lensFlare`.
  139022. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  139023. */
  139024. export class LensFlareSystem {
  139025. /**
  139026. * Define the name of the lens flare system
  139027. */
  139028. name: string;
  139029. /**
  139030. * List of lens flares used in this system.
  139031. */
  139032. lensFlares: LensFlare[];
  139033. /**
  139034. * Define a limit from the border the lens flare can be visible.
  139035. */
  139036. borderLimit: number;
  139037. /**
  139038. * Define a viewport border we do not want to see the lens flare in.
  139039. */
  139040. viewportBorder: number;
  139041. /**
  139042. * Define a predicate which could limit the list of meshes able to occlude the effect.
  139043. */
  139044. meshesSelectionPredicate: (mesh: AbstractMesh) => boolean;
  139045. /**
  139046. * Restricts the rendering of the effect to only the camera rendering this layer mask.
  139047. */
  139048. layerMask: number;
  139049. /**
  139050. * Define the id of the lens flare system in the scene.
  139051. * (equal to name by default)
  139052. */
  139053. id: string;
  139054. private _scene;
  139055. private _emitter;
  139056. private _vertexBuffers;
  139057. private _indexBuffer;
  139058. private _effect;
  139059. private _positionX;
  139060. private _positionY;
  139061. private _isEnabled;
  139062. /** @hidden */
  139063. static _SceneComponentInitialization: (scene: Scene) => void;
  139064. /**
  139065. * Instantiates a lens flare system.
  139066. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  139067. * It is usually composed of several `lensFlare`.
  139068. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  139069. * @param name Define the name of the lens flare system in the scene
  139070. * @param emitter Define the source (the emitter) of the lens flares (it can be a camera, a light or a mesh).
  139071. * @param scene Define the scene the lens flare system belongs to
  139072. */
  139073. constructor(
  139074. /**
  139075. * Define the name of the lens flare system
  139076. */
  139077. name: string, emitter: any, scene: Scene);
  139078. /**
  139079. * Define if the lens flare system is enabled.
  139080. */
  139081. get isEnabled(): boolean;
  139082. set isEnabled(value: boolean);
  139083. /**
  139084. * Get the scene the effects belongs to.
  139085. * @returns the scene holding the lens flare system
  139086. */
  139087. getScene(): Scene;
  139088. /**
  139089. * Get the emitter of the lens flare system.
  139090. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  139091. * @returns the emitter of the lens flare system
  139092. */
  139093. getEmitter(): any;
  139094. /**
  139095. * Set the emitter of the lens flare system.
  139096. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  139097. * @param newEmitter Define the new emitter of the system
  139098. */
  139099. setEmitter(newEmitter: any): void;
  139100. /**
  139101. * Get the lens flare system emitter position.
  139102. * The emitter defines the source of the lens flares (it can be a camera, a light or a mesh).
  139103. * @returns the position
  139104. */
  139105. getEmitterPosition(): Vector3;
  139106. /**
  139107. * @hidden
  139108. */
  139109. computeEffectivePosition(globalViewport: Viewport): boolean;
  139110. /** @hidden */
  139111. _isVisible(): boolean;
  139112. /**
  139113. * @hidden
  139114. */
  139115. render(): boolean;
  139116. /**
  139117. * Dispose and release the lens flare with its associated resources.
  139118. */
  139119. dispose(): void;
  139120. /**
  139121. * Parse a lens flare system from a JSON repressentation
  139122. * @param parsedLensFlareSystem Define the JSON to parse
  139123. * @param scene Define the scene the parsed system should be instantiated in
  139124. * @param rootUrl Define the rootUrl of the load sequence to easily find a load relative dependencies such as textures
  139125. * @returns the parsed system
  139126. */
  139127. static Parse(parsedLensFlareSystem: any, scene: Scene, rootUrl: string): LensFlareSystem;
  139128. /**
  139129. * Serialize the current Lens Flare System into a JSON representation.
  139130. * @returns the serialized JSON
  139131. */
  139132. serialize(): any;
  139133. }
  139134. }
  139135. declare module BABYLON {
  139136. /**
  139137. * This represents one of the lens effect in a `lensFlareSystem`.
  139138. * It controls one of the indiviual texture used in the effect.
  139139. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  139140. */
  139141. export class LensFlare {
  139142. /**
  139143. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  139144. */
  139145. size: number;
  139146. /**
  139147. * 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.
  139148. */
  139149. position: number;
  139150. /**
  139151. * Define the lens color.
  139152. */
  139153. color: Color3;
  139154. /**
  139155. * Define the lens texture.
  139156. */
  139157. texture: Nullable<Texture>;
  139158. /**
  139159. * Define the alpha mode to render this particular lens.
  139160. */
  139161. alphaMode: number;
  139162. private _system;
  139163. /**
  139164. * Creates a new Lens Flare.
  139165. * This represents one of the lens effect in a `lensFlareSystem`.
  139166. * It controls one of the indiviual texture used in the effect.
  139167. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  139168. * @param size Define the size of the lens flare (a floating value between 0 and 1)
  139169. * @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.
  139170. * @param color Define the lens color
  139171. * @param imgUrl Define the lens texture url
  139172. * @param system Define the `lensFlareSystem` this flare is part of
  139173. * @returns The newly created Lens Flare
  139174. */
  139175. static AddFlare(size: number, position: number, color: Color3, imgUrl: string, system: LensFlareSystem): LensFlare;
  139176. /**
  139177. * Instantiates a new Lens Flare.
  139178. * This represents one of the lens effect in a `lensFlareSystem`.
  139179. * It controls one of the indiviual texture used in the effect.
  139180. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  139181. * @param size Define the size of the lens flare in the system (a floating value between 0 and 1)
  139182. * @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.
  139183. * @param color Define the lens color
  139184. * @param imgUrl Define the lens texture url
  139185. * @param system Define the `lensFlareSystem` this flare is part of
  139186. */
  139187. constructor(
  139188. /**
  139189. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  139190. */
  139191. size: number,
  139192. /**
  139193. * 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.
  139194. */
  139195. position: number, color: Color3, imgUrl: string, system: LensFlareSystem);
  139196. /**
  139197. * Dispose and release the lens flare with its associated resources.
  139198. */
  139199. dispose(): void;
  139200. }
  139201. }
  139202. declare module BABYLON {
  139203. interface AbstractScene {
  139204. /**
  139205. * The list of lens flare system added to the scene
  139206. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  139207. */
  139208. lensFlareSystems: Array<LensFlareSystem>;
  139209. /**
  139210. * Removes the given lens flare system from this scene.
  139211. * @param toRemove The lens flare system to remove
  139212. * @returns The index of the removed lens flare system
  139213. */
  139214. removeLensFlareSystem(toRemove: LensFlareSystem): number;
  139215. /**
  139216. * Adds the given lens flare system to this scene
  139217. * @param newLensFlareSystem The lens flare system to add
  139218. */
  139219. addLensFlareSystem(newLensFlareSystem: LensFlareSystem): void;
  139220. /**
  139221. * Gets a lens flare system using its name
  139222. * @param name defines the name to look for
  139223. * @returns the lens flare system or null if not found
  139224. */
  139225. getLensFlareSystemByName(name: string): Nullable<LensFlareSystem>;
  139226. /**
  139227. * Gets a lens flare system using its id
  139228. * @param id defines the id to look for
  139229. * @returns the lens flare system or null if not found
  139230. */
  139231. getLensFlareSystemByID(id: string): Nullable<LensFlareSystem>;
  139232. }
  139233. /**
  139234. * Defines the lens flare scene component responsible to manage any lens flares
  139235. * in a given scene.
  139236. */
  139237. export class LensFlareSystemSceneComponent implements ISceneSerializableComponent {
  139238. /**
  139239. * The component name helpfull to identify the component in the list of scene components.
  139240. */
  139241. readonly name: string;
  139242. /**
  139243. * The scene the component belongs to.
  139244. */
  139245. scene: Scene;
  139246. /**
  139247. * Creates a new instance of the component for the given scene
  139248. * @param scene Defines the scene to register the component in
  139249. */
  139250. constructor(scene: Scene);
  139251. /**
  139252. * Registers the component in a given scene
  139253. */
  139254. register(): void;
  139255. /**
  139256. * Rebuilds the elements related to this component in case of
  139257. * context lost for instance.
  139258. */
  139259. rebuild(): void;
  139260. /**
  139261. * Adds all the elements from the container to the scene
  139262. * @param container the container holding the elements
  139263. */
  139264. addFromContainer(container: AbstractScene): void;
  139265. /**
  139266. * Removes all the elements in the container from the scene
  139267. * @param container contains the elements to remove
  139268. * @param dispose if the removed element should be disposed (default: false)
  139269. */
  139270. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  139271. /**
  139272. * Serializes the component data to the specified json object
  139273. * @param serializationObject The object to serialize to
  139274. */
  139275. serialize(serializationObject: any): void;
  139276. /**
  139277. * Disposes the component and the associated ressources.
  139278. */
  139279. dispose(): void;
  139280. private _draw;
  139281. }
  139282. }
  139283. declare module BABYLON {
  139284. /** @hidden */
  139285. export var depthPixelShader: {
  139286. name: string;
  139287. shader: string;
  139288. };
  139289. }
  139290. declare module BABYLON {
  139291. /** @hidden */
  139292. export var depthVertexShader: {
  139293. name: string;
  139294. shader: string;
  139295. };
  139296. }
  139297. declare module BABYLON {
  139298. /**
  139299. * This represents a depth renderer in Babylon.
  139300. * A depth renderer will render to it's depth map every frame which can be displayed or used in post processing
  139301. */
  139302. export class DepthRenderer {
  139303. private _scene;
  139304. private _depthMap;
  139305. private _effect;
  139306. private readonly _storeNonLinearDepth;
  139307. private readonly _clearColor;
  139308. /** Get if the depth renderer is using packed depth or not */
  139309. readonly isPacked: boolean;
  139310. private _cachedDefines;
  139311. private _camera;
  139312. /** Enable or disable the depth renderer. When disabled, the depth texture is not updated */
  139313. enabled: boolean;
  139314. /**
  139315. * Specifiess that the depth renderer will only be used within
  139316. * the camera it is created for.
  139317. * This can help forcing its rendering during the camera processing.
  139318. */
  139319. useOnlyInActiveCamera: boolean;
  139320. /** @hidden */
  139321. static _SceneComponentInitialization: (scene: Scene) => void;
  139322. /**
  139323. * Instantiates a depth renderer
  139324. * @param scene The scene the renderer belongs to
  139325. * @param type The texture type of the depth map (default: Engine.TEXTURETYPE_FLOAT)
  139326. * @param camera The camera to be used to render the depth map (default: scene's active camera)
  139327. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  139328. */
  139329. constructor(scene: Scene, type?: number, camera?: Nullable<Camera>, storeNonLinearDepth?: boolean);
  139330. /**
  139331. * Creates the depth rendering effect and checks if the effect is ready.
  139332. * @param subMesh The submesh to be used to render the depth map of
  139333. * @param useInstances If multiple world instances should be used
  139334. * @returns if the depth renderer is ready to render the depth map
  139335. */
  139336. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  139337. /**
  139338. * Gets the texture which the depth map will be written to.
  139339. * @returns The depth map texture
  139340. */
  139341. getDepthMap(): RenderTargetTexture;
  139342. /**
  139343. * Disposes of the depth renderer.
  139344. */
  139345. dispose(): void;
  139346. }
  139347. }
  139348. declare module BABYLON {
  139349. /** @hidden */
  139350. export var minmaxReduxPixelShader: {
  139351. name: string;
  139352. shader: string;
  139353. };
  139354. }
  139355. declare module BABYLON {
  139356. /**
  139357. * This class computes a min/max reduction from a texture: it means it computes the minimum
  139358. * and maximum values from all values of the texture.
  139359. * It is performed on the GPU for better performances, thanks to a succession of post processes.
  139360. * The source values are read from the red channel of the texture.
  139361. */
  139362. export class MinMaxReducer {
  139363. /**
  139364. * Observable triggered when the computation has been performed
  139365. */
  139366. onAfterReductionPerformed: Observable<{
  139367. min: number;
  139368. max: number;
  139369. }>;
  139370. protected _camera: Camera;
  139371. protected _sourceTexture: Nullable<RenderTargetTexture>;
  139372. protected _reductionSteps: Nullable<Array<PostProcess>>;
  139373. protected _postProcessManager: PostProcessManager;
  139374. protected _onAfterUnbindObserver: Nullable<Observer<RenderTargetTexture>>;
  139375. protected _forceFullscreenViewport: boolean;
  139376. /**
  139377. * Creates a min/max reducer
  139378. * @param camera The camera to use for the post processes
  139379. */
  139380. constructor(camera: Camera);
  139381. /**
  139382. * Gets the texture used to read the values from.
  139383. */
  139384. get sourceTexture(): Nullable<RenderTargetTexture>;
  139385. /**
  139386. * Sets the source texture to read the values from.
  139387. * One must indicate if the texture is a depth texture or not through the depthRedux parameter
  139388. * because in such textures '1' value must not be taken into account to compute the maximum
  139389. * as this value is used to clear the texture.
  139390. * Note that the computation is not activated by calling this function, you must call activate() for that!
  139391. * @param sourceTexture The texture to read the values from. The values should be in the red channel.
  139392. * @param depthRedux Indicates if the texture is a depth texture or not
  139393. * @param type The type of the textures created for the reduction (defaults to TEXTURETYPE_HALF_FLOAT)
  139394. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  139395. */
  139396. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  139397. /**
  139398. * Defines the refresh rate of the computation.
  139399. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  139400. */
  139401. get refreshRate(): number;
  139402. set refreshRate(value: number);
  139403. protected _activated: boolean;
  139404. /**
  139405. * Gets the activation status of the reducer
  139406. */
  139407. get activated(): boolean;
  139408. /**
  139409. * Activates the reduction computation.
  139410. * When activated, the observers registered in onAfterReductionPerformed are
  139411. * called after the compuation is performed
  139412. */
  139413. activate(): void;
  139414. /**
  139415. * Deactivates the reduction computation.
  139416. */
  139417. deactivate(): void;
  139418. /**
  139419. * Disposes the min/max reducer
  139420. * @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.
  139421. */
  139422. dispose(disposeAll?: boolean): void;
  139423. }
  139424. }
  139425. declare module BABYLON {
  139426. /**
  139427. * This class is a small wrapper around the MinMaxReducer class to compute the min/max values of a depth texture
  139428. */
  139429. export class DepthReducer extends MinMaxReducer {
  139430. private _depthRenderer;
  139431. private _depthRendererId;
  139432. /**
  139433. * Gets the depth renderer used for the computation.
  139434. * Note that the result is null if you provide your own renderer when calling setDepthRenderer.
  139435. */
  139436. get depthRenderer(): Nullable<DepthRenderer>;
  139437. /**
  139438. * Creates a depth reducer
  139439. * @param camera The camera used to render the depth texture
  139440. */
  139441. constructor(camera: Camera);
  139442. /**
  139443. * Sets the depth renderer to use to generate the depth map
  139444. * @param depthRenderer The depth renderer to use. If not provided, a new one will be created automatically
  139445. * @param type The texture type of the depth map (default: TEXTURETYPE_HALF_FLOAT)
  139446. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  139447. */
  139448. setDepthRenderer(depthRenderer?: Nullable<DepthRenderer>, type?: number, forceFullscreenViewport?: boolean): void;
  139449. /** @hidden */
  139450. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  139451. /**
  139452. * Activates the reduction computation.
  139453. * When activated, the observers registered in onAfterReductionPerformed are
  139454. * called after the compuation is performed
  139455. */
  139456. activate(): void;
  139457. /**
  139458. * Deactivates the reduction computation.
  139459. */
  139460. deactivate(): void;
  139461. /**
  139462. * Disposes the depth reducer
  139463. * @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.
  139464. */
  139465. dispose(disposeAll?: boolean): void;
  139466. }
  139467. }
  139468. declare module BABYLON {
  139469. /**
  139470. * A CSM implementation allowing casting shadows on large scenes.
  139471. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  139472. * Based on: https://github.com/TheRealMJP/Shadows and https://johanmedestrom.wordpress.com/2016/03/18/opengl-cascaded-shadow-maps/
  139473. */
  139474. export class CascadedShadowGenerator extends ShadowGenerator {
  139475. private static readonly frustumCornersNDCSpace;
  139476. /**
  139477. * Name of the CSM class
  139478. */
  139479. static CLASSNAME: string;
  139480. /**
  139481. * Defines the default number of cascades used by the CSM.
  139482. */
  139483. static readonly DEFAULT_CASCADES_COUNT: number;
  139484. /**
  139485. * Defines the minimum number of cascades used by the CSM.
  139486. */
  139487. static readonly MIN_CASCADES_COUNT: number;
  139488. /**
  139489. * Defines the maximum number of cascades used by the CSM.
  139490. */
  139491. static readonly MAX_CASCADES_COUNT: number;
  139492. protected _validateFilter(filter: number): number;
  139493. /**
  139494. * Gets or sets the actual darkness of the soft shadows while using PCSS filtering (value between 0. and 1.)
  139495. */
  139496. penumbraDarkness: number;
  139497. private _numCascades;
  139498. /**
  139499. * Gets or set the number of cascades used by the CSM.
  139500. */
  139501. get numCascades(): number;
  139502. set numCascades(value: number);
  139503. /**
  139504. * Sets this to true if you want that the edges of the shadows don't "swimm" / "shimmer" when rotating the camera.
  139505. * The trade off is that you lose some precision in the shadow rendering when enabling this setting.
  139506. */
  139507. stabilizeCascades: boolean;
  139508. private _freezeShadowCastersBoundingInfo;
  139509. private _freezeShadowCastersBoundingInfoObservable;
  139510. /**
  139511. * Enables or disables the shadow casters bounding info computation.
  139512. * If your shadow casters don't move, you can disable this feature.
  139513. * If it is enabled, the bounding box computation is done every frame.
  139514. */
  139515. get freezeShadowCastersBoundingInfo(): boolean;
  139516. set freezeShadowCastersBoundingInfo(freeze: boolean);
  139517. private _scbiMin;
  139518. private _scbiMax;
  139519. protected _computeShadowCastersBoundingInfo(): void;
  139520. protected _shadowCastersBoundingInfo: BoundingInfo;
  139521. /**
  139522. * Gets or sets the shadow casters bounding info.
  139523. * If you provide your own shadow casters bounding info, first enable freezeShadowCastersBoundingInfo
  139524. * so that the system won't overwrite the bounds you provide
  139525. */
  139526. get shadowCastersBoundingInfo(): BoundingInfo;
  139527. set shadowCastersBoundingInfo(boundingInfo: BoundingInfo);
  139528. protected _breaksAreDirty: boolean;
  139529. protected _minDistance: number;
  139530. protected _maxDistance: number;
  139531. /**
  139532. * Sets the minimal and maximal distances to use when computing the cascade breaks.
  139533. *
  139534. * The values of min / max are typically the depth zmin and zmax values of your scene, for a given frame.
  139535. * If you don't know these values, simply leave them to their defaults and don't call this function.
  139536. * @param min minimal distance for the breaks (default to 0.)
  139537. * @param max maximal distance for the breaks (default to 1.)
  139538. */
  139539. setMinMaxDistance(min: number, max: number): void;
  139540. /** Gets the minimal distance used in the cascade break computation */
  139541. get minDistance(): number;
  139542. /** Gets the maximal distance used in the cascade break computation */
  139543. get maxDistance(): number;
  139544. /**
  139545. * Gets the class name of that object
  139546. * @returns "CascadedShadowGenerator"
  139547. */
  139548. getClassName(): string;
  139549. private _cascadeMinExtents;
  139550. private _cascadeMaxExtents;
  139551. /**
  139552. * Gets a cascade minimum extents
  139553. * @param cascadeIndex index of the cascade
  139554. * @returns the minimum cascade extents
  139555. */
  139556. getCascadeMinExtents(cascadeIndex: number): Nullable<Vector3>;
  139557. /**
  139558. * Gets a cascade maximum extents
  139559. * @param cascadeIndex index of the cascade
  139560. * @returns the maximum cascade extents
  139561. */
  139562. getCascadeMaxExtents(cascadeIndex: number): Nullable<Vector3>;
  139563. private _cascades;
  139564. private _currentLayer;
  139565. private _viewSpaceFrustumsZ;
  139566. private _viewMatrices;
  139567. private _projectionMatrices;
  139568. private _transformMatrices;
  139569. private _transformMatricesAsArray;
  139570. private _frustumLengths;
  139571. private _lightSizeUVCorrection;
  139572. private _depthCorrection;
  139573. private _frustumCornersWorldSpace;
  139574. private _frustumCenter;
  139575. private _shadowCameraPos;
  139576. private _shadowMaxZ;
  139577. /**
  139578. * Gets the shadow max z distance. It's the limit beyond which shadows are not displayed.
  139579. * It defaults to camera.maxZ
  139580. */
  139581. get shadowMaxZ(): number;
  139582. /**
  139583. * Sets the shadow max z distance.
  139584. */
  139585. set shadowMaxZ(value: number);
  139586. protected _debug: boolean;
  139587. /**
  139588. * Gets or sets the debug flag.
  139589. * When enabled, the cascades are materialized by different colors on the screen.
  139590. */
  139591. get debug(): boolean;
  139592. set debug(dbg: boolean);
  139593. private _depthClamp;
  139594. /**
  139595. * Gets or sets the depth clamping value.
  139596. *
  139597. * When enabled, it improves the shadow quality because the near z plane of the light frustum don't need to be adjusted
  139598. * to account for the shadow casters far away.
  139599. *
  139600. * Note that this property is incompatible with PCSS filtering, so it won't be used in that case.
  139601. */
  139602. get depthClamp(): boolean;
  139603. set depthClamp(value: boolean);
  139604. private _cascadeBlendPercentage;
  139605. /**
  139606. * Gets or sets the percentage of blending between two cascades (value between 0. and 1.).
  139607. * It defaults to 0.1 (10% blending).
  139608. */
  139609. get cascadeBlendPercentage(): number;
  139610. set cascadeBlendPercentage(value: number);
  139611. private _lambda;
  139612. /**
  139613. * Gets or set the lambda parameter.
  139614. * This parameter is used to split the camera frustum and create the cascades.
  139615. * 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.
  139616. * For all values in-between, it's a linear combination of the uniform and logarithm split algorithm.
  139617. */
  139618. get lambda(): number;
  139619. set lambda(value: number);
  139620. /**
  139621. * Gets the view matrix corresponding to a given cascade
  139622. * @param cascadeNum cascade to retrieve the view matrix from
  139623. * @returns the cascade view matrix
  139624. */
  139625. getCascadeViewMatrix(cascadeNum: number): Nullable<Matrix>;
  139626. /**
  139627. * Gets the projection matrix corresponding to a given cascade
  139628. * @param cascadeNum cascade to retrieve the projection matrix from
  139629. * @returns the cascade projection matrix
  139630. */
  139631. getCascadeProjectionMatrix(cascadeNum: number): Nullable<Matrix>;
  139632. /**
  139633. * Gets the transformation matrix corresponding to a given cascade
  139634. * @param cascadeNum cascade to retrieve the transformation matrix from
  139635. * @returns the cascade transformation matrix
  139636. */
  139637. getCascadeTransformMatrix(cascadeNum: number): Nullable<Matrix>;
  139638. private _depthRenderer;
  139639. /**
  139640. * Sets the depth renderer to use when autoCalcDepthBounds is enabled.
  139641. *
  139642. * Note that if no depth renderer is set, a new one will be automatically created internally when necessary.
  139643. *
  139644. * You should call this function if you already have a depth renderer enabled in your scene, to avoid
  139645. * doing multiple depth rendering each frame. If you provide your own depth renderer, make sure it stores linear depth!
  139646. * @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
  139647. */
  139648. setDepthRenderer(depthRenderer: Nullable<DepthRenderer>): void;
  139649. private _depthReducer;
  139650. private _autoCalcDepthBounds;
  139651. /**
  139652. * Gets or sets the autoCalcDepthBounds property.
  139653. *
  139654. * When enabled, a depth rendering pass is first performed (with an internally created depth renderer or with the one
  139655. * you provide by calling setDepthRenderer). Then, a min/max reducing is applied on the depth map to compute the
  139656. * minimal and maximal depth of the map and those values are used as inputs for the setMinMaxDistance() function.
  139657. * It can greatly enhance the shadow quality, at the expense of more GPU works.
  139658. * When using this option, you should increase the value of the lambda parameter, and even set it to 1 for best results.
  139659. */
  139660. get autoCalcDepthBounds(): boolean;
  139661. set autoCalcDepthBounds(value: boolean);
  139662. /**
  139663. * Defines the refresh rate of the min/max computation used when autoCalcDepthBounds is set to true
  139664. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  139665. * Note that if you provided your own depth renderer through a call to setDepthRenderer, you are responsible
  139666. * for setting the refresh rate on the renderer yourself!
  139667. */
  139668. get autoCalcDepthBoundsRefreshRate(): number;
  139669. set autoCalcDepthBoundsRefreshRate(value: number);
  139670. /**
  139671. * Create the cascade breaks according to the lambda, shadowMaxZ and min/max distance properties, as well as the camera near and far planes.
  139672. * This function is automatically called when updating lambda, shadowMaxZ and min/max distances, however you should call it yourself if
  139673. * you change the camera near/far planes!
  139674. */
  139675. splitFrustum(): void;
  139676. private _splitFrustum;
  139677. private _computeMatrices;
  139678. private _computeFrustumInWorldSpace;
  139679. private _computeCascadeFrustum;
  139680. /**
  139681. * Support test.
  139682. */
  139683. static get IsSupported(): boolean;
  139684. /** @hidden */
  139685. static _SceneComponentInitialization: (scene: Scene) => void;
  139686. /**
  139687. * Creates a Cascaded Shadow Generator object.
  139688. * A ShadowGenerator is the required tool to use the shadows.
  139689. * Each directional light casting shadows needs to use its own ShadowGenerator.
  139690. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  139691. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  139692. * @param light The directional light object generating the shadows.
  139693. * @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.
  139694. */
  139695. constructor(mapSize: number, light: DirectionalLight, usefulFloatFirst?: boolean);
  139696. protected _initializeGenerator(): void;
  139697. protected _createTargetRenderTexture(): void;
  139698. protected _initializeShadowMap(): void;
  139699. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  139700. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  139701. /**
  139702. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  139703. * @param defines Defines of the material we want to update
  139704. * @param lightIndex Index of the light in the enabled light list of the material
  139705. */
  139706. prepareDefines(defines: any, lightIndex: number): void;
  139707. /**
  139708. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  139709. * defined in the generator but impacting the effect).
  139710. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  139711. * @param effect The effect we are binfing the information for
  139712. */
  139713. bindShadowLight(lightIndex: string, effect: Effect): void;
  139714. /**
  139715. * Gets the transformation matrix of the first cascade used to project the meshes into the map from the light point of view.
  139716. * (eq to view projection * shadow projection matrices)
  139717. * @returns The transform matrix used to create the shadow map
  139718. */
  139719. getTransformMatrix(): Matrix;
  139720. /**
  139721. * Disposes the ShadowGenerator.
  139722. * Returns nothing.
  139723. */
  139724. dispose(): void;
  139725. /**
  139726. * Serializes the shadow generator setup to a json object.
  139727. * @returns The serialized JSON object
  139728. */
  139729. serialize(): any;
  139730. /**
  139731. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  139732. * @param parsedShadowGenerator The JSON object to parse
  139733. * @param scene The scene to create the shadow map for
  139734. * @returns The parsed shadow generator
  139735. */
  139736. static Parse(parsedShadowGenerator: any, scene: Scene): ShadowGenerator;
  139737. }
  139738. }
  139739. declare module BABYLON {
  139740. /**
  139741. * Defines the shadow generator component responsible to manage any shadow generators
  139742. * in a given scene.
  139743. */
  139744. export class ShadowGeneratorSceneComponent implements ISceneSerializableComponent {
  139745. /**
  139746. * The component name helpfull to identify the component in the list of scene components.
  139747. */
  139748. readonly name: string;
  139749. /**
  139750. * The scene the component belongs to.
  139751. */
  139752. scene: Scene;
  139753. /**
  139754. * Creates a new instance of the component for the given scene
  139755. * @param scene Defines the scene to register the component in
  139756. */
  139757. constructor(scene: Scene);
  139758. /**
  139759. * Registers the component in a given scene
  139760. */
  139761. register(): void;
  139762. /**
  139763. * Rebuilds the elements related to this component in case of
  139764. * context lost for instance.
  139765. */
  139766. rebuild(): void;
  139767. /**
  139768. * Serializes the component data to the specified json object
  139769. * @param serializationObject The object to serialize to
  139770. */
  139771. serialize(serializationObject: any): void;
  139772. /**
  139773. * Adds all the elements from the container to the scene
  139774. * @param container the container holding the elements
  139775. */
  139776. addFromContainer(container: AbstractScene): void;
  139777. /**
  139778. * Removes all the elements in the container from the scene
  139779. * @param container contains the elements to remove
  139780. * @param dispose if the removed element should be disposed (default: false)
  139781. */
  139782. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  139783. /**
  139784. * Rebuilds the elements related to this component in case of
  139785. * context lost for instance.
  139786. */
  139787. dispose(): void;
  139788. private _gatherRenderTargets;
  139789. }
  139790. }
  139791. declare module BABYLON {
  139792. /**
  139793. * A point light is a light defined by an unique point in world space.
  139794. * The light is emitted in every direction from this point.
  139795. * A good example of a point light is a standard light bulb.
  139796. * Documentation: https://doc.babylonjs.com/babylon101/lights
  139797. */
  139798. export class PointLight extends ShadowLight {
  139799. private _shadowAngle;
  139800. /**
  139801. * Getter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  139802. * This specifies what angle the shadow will use to be created.
  139803. *
  139804. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  139805. */
  139806. get shadowAngle(): number;
  139807. /**
  139808. * Setter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  139809. * This specifies what angle the shadow will use to be created.
  139810. *
  139811. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  139812. */
  139813. set shadowAngle(value: number);
  139814. /**
  139815. * Gets the direction if it has been set.
  139816. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  139817. */
  139818. get direction(): Vector3;
  139819. /**
  139820. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  139821. */
  139822. set direction(value: Vector3);
  139823. /**
  139824. * Creates a PointLight object from the passed name and position (Vector3) and adds it in the scene.
  139825. * A PointLight emits the light in every direction.
  139826. * It can cast shadows.
  139827. * If the scene camera is already defined and you want to set your PointLight at the camera position, just set it :
  139828. * ```javascript
  139829. * var pointLight = new PointLight("pl", camera.position, scene);
  139830. * ```
  139831. * Documentation : https://doc.babylonjs.com/babylon101/lights
  139832. * @param name The light friendly name
  139833. * @param position The position of the point light in the scene
  139834. * @param scene The scene the lights belongs to
  139835. */
  139836. constructor(name: string, position: Vector3, scene: Scene);
  139837. /**
  139838. * Returns the string "PointLight"
  139839. * @returns the class name
  139840. */
  139841. getClassName(): string;
  139842. /**
  139843. * Returns the integer 0.
  139844. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  139845. */
  139846. getTypeID(): number;
  139847. /**
  139848. * Specifies wether or not the shadowmap should be a cube texture.
  139849. * @returns true if the shadowmap needs to be a cube texture.
  139850. */
  139851. needCube(): boolean;
  139852. /**
  139853. * Returns a new Vector3 aligned with the PointLight cube system according to the passed cube face index (integer).
  139854. * @param faceIndex The index of the face we are computed the direction to generate shadow
  139855. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  139856. */
  139857. getShadowDirection(faceIndex?: number): Vector3;
  139858. /**
  139859. * Sets the passed matrix "matrix" as a left-handed perspective projection matrix with the following settings :
  139860. * - fov = PI / 2
  139861. * - aspect ratio : 1.0
  139862. * - z-near and far equal to the active camera minZ and maxZ.
  139863. * Returns the PointLight.
  139864. */
  139865. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  139866. protected _buildUniformLayout(): void;
  139867. /**
  139868. * Sets the passed Effect "effect" with the PointLight transformed position (or position, if none) and passed name (string).
  139869. * @param effect The effect to update
  139870. * @param lightIndex The index of the light in the effect to update
  139871. * @returns The point light
  139872. */
  139873. transferToEffect(effect: Effect, lightIndex: string): PointLight;
  139874. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  139875. /**
  139876. * Prepares the list of defines specific to the light type.
  139877. * @param defines the list of defines
  139878. * @param lightIndex defines the index of the light for the effect
  139879. */
  139880. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  139881. }
  139882. }
  139883. declare module BABYLON {
  139884. /**
  139885. * Header information of HDR texture files.
  139886. */
  139887. export interface HDRInfo {
  139888. /**
  139889. * The height of the texture in pixels.
  139890. */
  139891. height: number;
  139892. /**
  139893. * The width of the texture in pixels.
  139894. */
  139895. width: number;
  139896. /**
  139897. * The index of the beginning of the data in the binary file.
  139898. */
  139899. dataPosition: number;
  139900. }
  139901. /**
  139902. * This groups tools to convert HDR texture to native colors array.
  139903. */
  139904. export class HDRTools {
  139905. private static Ldexp;
  139906. private static Rgbe2float;
  139907. private static readStringLine;
  139908. /**
  139909. * Reads header information from an RGBE texture stored in a native array.
  139910. * More information on this format are available here:
  139911. * https://en.wikipedia.org/wiki/RGBE_image_format
  139912. *
  139913. * @param uint8array The binary file stored in native array.
  139914. * @return The header information.
  139915. */
  139916. static RGBE_ReadHeader(uint8array: Uint8Array): HDRInfo;
  139917. /**
  139918. * Returns the cubemap information (each faces texture data) extracted from an RGBE texture.
  139919. * This RGBE texture needs to store the information as a panorama.
  139920. *
  139921. * More information on this format are available here:
  139922. * https://en.wikipedia.org/wiki/RGBE_image_format
  139923. *
  139924. * @param buffer The binary file stored in an array buffer.
  139925. * @param size The expected size of the extracted cubemap.
  139926. * @return The Cube Map information.
  139927. */
  139928. static GetCubeMapTextureData(buffer: ArrayBuffer, size: number): CubeMapInfo;
  139929. /**
  139930. * Returns the pixels data extracted from an RGBE texture.
  139931. * This pixels will be stored left to right up to down in the R G B order in one array.
  139932. *
  139933. * More information on this format are available here:
  139934. * https://en.wikipedia.org/wiki/RGBE_image_format
  139935. *
  139936. * @param uint8array The binary file stored in an array buffer.
  139937. * @param hdrInfo The header information of the file.
  139938. * @return The pixels data in RGB right to left up to down order.
  139939. */
  139940. static RGBE_ReadPixels(uint8array: Uint8Array, hdrInfo: HDRInfo): Float32Array;
  139941. private static RGBE_ReadPixels_RLE;
  139942. private static RGBE_ReadPixels_NOT_RLE;
  139943. }
  139944. }
  139945. declare module BABYLON {
  139946. /**
  139947. * Effect Render Options
  139948. */
  139949. export interface IEffectRendererOptions {
  139950. /**
  139951. * Defines the vertices positions.
  139952. */
  139953. positions?: number[];
  139954. /**
  139955. * Defines the indices.
  139956. */
  139957. indices?: number[];
  139958. }
  139959. /**
  139960. * Helper class to render one or more effects.
  139961. * You can access the previous rendering in your shader by declaring a sampler named textureSampler
  139962. */
  139963. export class EffectRenderer {
  139964. private engine;
  139965. private static _DefaultOptions;
  139966. private _vertexBuffers;
  139967. private _indexBuffer;
  139968. private _fullscreenViewport;
  139969. /**
  139970. * Creates an effect renderer
  139971. * @param engine the engine to use for rendering
  139972. * @param options defines the options of the effect renderer
  139973. */
  139974. constructor(engine: ThinEngine, options?: IEffectRendererOptions);
  139975. /**
  139976. * Sets the current viewport in normalized coordinates 0-1
  139977. * @param viewport Defines the viewport to set (defaults to 0 0 1 1)
  139978. */
  139979. setViewport(viewport?: Viewport): void;
  139980. /**
  139981. * Binds the embedded attributes buffer to the effect.
  139982. * @param effect Defines the effect to bind the attributes for
  139983. */
  139984. bindBuffers(effect: Effect): void;
  139985. /**
  139986. * Sets the current effect wrapper to use during draw.
  139987. * The effect needs to be ready before calling this api.
  139988. * This also sets the default full screen position attribute.
  139989. * @param effectWrapper Defines the effect to draw with
  139990. */
  139991. applyEffectWrapper(effectWrapper: EffectWrapper): void;
  139992. /**
  139993. * Restores engine states
  139994. */
  139995. restoreStates(): void;
  139996. /**
  139997. * Draws a full screen quad.
  139998. */
  139999. draw(): void;
  140000. private isRenderTargetTexture;
  140001. /**
  140002. * renders one or more effects to a specified texture
  140003. * @param effectWrapper the effect to renderer
  140004. * @param outputTexture texture to draw to, if null it will render to the screen.
  140005. */
  140006. render(effectWrapper: EffectWrapper, outputTexture?: Nullable<InternalTexture | RenderTargetTexture>): void;
  140007. /**
  140008. * Disposes of the effect renderer
  140009. */
  140010. dispose(): void;
  140011. }
  140012. /**
  140013. * Options to create an EffectWrapper
  140014. */
  140015. interface EffectWrapperCreationOptions {
  140016. /**
  140017. * Engine to use to create the effect
  140018. */
  140019. engine: ThinEngine;
  140020. /**
  140021. * Fragment shader for the effect
  140022. */
  140023. fragmentShader: string;
  140024. /**
  140025. * Use the shader store instead of direct source code
  140026. */
  140027. useShaderStore?: boolean;
  140028. /**
  140029. * Vertex shader for the effect
  140030. */
  140031. vertexShader?: string;
  140032. /**
  140033. * Attributes to use in the shader
  140034. */
  140035. attributeNames?: Array<string>;
  140036. /**
  140037. * Uniforms to use in the shader
  140038. */
  140039. uniformNames?: Array<string>;
  140040. /**
  140041. * Texture sampler names to use in the shader
  140042. */
  140043. samplerNames?: Array<string>;
  140044. /**
  140045. * Defines to use in the shader
  140046. */
  140047. defines?: Array<string>;
  140048. /**
  140049. * Callback when effect is compiled
  140050. */
  140051. onCompiled?: Nullable<(effect: Effect) => void>;
  140052. /**
  140053. * The friendly name of the effect displayed in Spector.
  140054. */
  140055. name?: string;
  140056. }
  140057. /**
  140058. * Wraps an effect to be used for rendering
  140059. */
  140060. export class EffectWrapper {
  140061. /**
  140062. * Event that is fired right before the effect is drawn (should be used to update uniforms)
  140063. */
  140064. onApplyObservable: Observable<{}>;
  140065. /**
  140066. * The underlying effect
  140067. */
  140068. effect: Effect;
  140069. /**
  140070. * Creates an effect to be renderer
  140071. * @param creationOptions options to create the effect
  140072. */
  140073. constructor(creationOptions: EffectWrapperCreationOptions);
  140074. /**
  140075. * Disposes of the effect wrapper
  140076. */
  140077. dispose(): void;
  140078. }
  140079. }
  140080. declare module BABYLON {
  140081. /** @hidden */
  140082. export var hdrFilteringVertexShader: {
  140083. name: string;
  140084. shader: string;
  140085. };
  140086. }
  140087. declare module BABYLON {
  140088. /** @hidden */
  140089. export var hdrFilteringPixelShader: {
  140090. name: string;
  140091. shader: string;
  140092. };
  140093. }
  140094. declare module BABYLON {
  140095. /**
  140096. * Options for texture filtering
  140097. */
  140098. interface IHDRFilteringOptions {
  140099. /**
  140100. * Scales pixel intensity for the input HDR map.
  140101. */
  140102. hdrScale?: number;
  140103. /**
  140104. * Quality of the filter. Should be `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` for prefiltering
  140105. */
  140106. quality?: number;
  140107. }
  140108. /**
  140109. * Filters HDR maps to get correct renderings of PBR reflections
  140110. */
  140111. export class HDRFiltering {
  140112. private _engine;
  140113. private _effectRenderer;
  140114. private _effectWrapper;
  140115. private _lodGenerationOffset;
  140116. private _lodGenerationScale;
  140117. /**
  140118. * Quality switch for prefiltering. Should be set to `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` unless
  140119. * you care about baking speed.
  140120. */
  140121. quality: number;
  140122. /**
  140123. * Scales pixel intensity for the input HDR map.
  140124. */
  140125. hdrScale: number;
  140126. /**
  140127. * Instantiates HDR filter for reflection maps
  140128. *
  140129. * @param engine Thin engine
  140130. * @param options Options
  140131. */
  140132. constructor(engine: ThinEngine, options?: IHDRFilteringOptions);
  140133. private _createRenderTarget;
  140134. private _prefilterInternal;
  140135. private _createEffect;
  140136. /**
  140137. * Get a value indicating if the filter is ready to be used
  140138. * @param texture Texture to filter
  140139. * @returns true if the filter is ready
  140140. */
  140141. isReady(texture: BaseTexture): boolean;
  140142. /**
  140143. * Prefilters a cube texture to have mipmap levels representing roughness values.
  140144. * Prefiltering will be invoked at the end of next rendering pass.
  140145. * This has to be done once the map is loaded, and has not been prefiltered by a third party software.
  140146. * See http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf for more information
  140147. * @param texture Texture to filter
  140148. * @param onFinished Callback when filtering is done
  140149. * @return Promise called when prefiltering is done
  140150. */
  140151. prefilter(texture: BaseTexture, onFinished?: Nullable<() => void>): Promise<unknown> | undefined;
  140152. }
  140153. }
  140154. declare module BABYLON {
  140155. /**
  140156. * This represents a texture coming from an HDR input.
  140157. *
  140158. * The only supported format is currently panorama picture stored in RGBE format.
  140159. * Example of such files can be found on HDRLib: http://hdrlib.com/
  140160. */
  140161. export class HDRCubeTexture extends BaseTexture {
  140162. private static _facesMapping;
  140163. private _generateHarmonics;
  140164. private _noMipmap;
  140165. private _prefilterOnLoad;
  140166. private _textureMatrix;
  140167. private _size;
  140168. private _onLoad;
  140169. private _onError;
  140170. /**
  140171. * The texture URL.
  140172. */
  140173. url: string;
  140174. protected _isBlocking: boolean;
  140175. /**
  140176. * Sets wether or not the texture is blocking during loading.
  140177. */
  140178. set isBlocking(value: boolean);
  140179. /**
  140180. * Gets wether or not the texture is blocking during loading.
  140181. */
  140182. get isBlocking(): boolean;
  140183. protected _rotationY: number;
  140184. /**
  140185. * Sets texture matrix rotation angle around Y axis in radians.
  140186. */
  140187. set rotationY(value: number);
  140188. /**
  140189. * Gets texture matrix rotation angle around Y axis radians.
  140190. */
  140191. get rotationY(): number;
  140192. /**
  140193. * Gets or sets the center of the bounding box associated with the cube texture
  140194. * It must define where the camera used to render the texture was set
  140195. */
  140196. boundingBoxPosition: Vector3;
  140197. private _boundingBoxSize;
  140198. /**
  140199. * Gets or sets the size of the bounding box associated with the cube texture
  140200. * When defined, the cubemap will switch to local mode
  140201. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  140202. * @example https://www.babylonjs-playground.com/#RNASML
  140203. */
  140204. set boundingBoxSize(value: Vector3);
  140205. get boundingBoxSize(): Vector3;
  140206. /**
  140207. * Instantiates an HDRTexture from the following parameters.
  140208. *
  140209. * @param url The location of the HDR raw data (Panorama stored in RGBE format)
  140210. * @param sceneOrEngine The scene or engine the texture will be used in
  140211. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  140212. * @param noMipmap Forces to not generate the mipmap if true
  140213. * @param generateHarmonics Specifies whether you want to extract the polynomial harmonics during the generation process
  140214. * @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)
  140215. * @param prefilterOnLoad Prefilters HDR texture to allow use of this texture as a PBR reflection texture.
  140216. */
  140217. 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>);
  140218. /**
  140219. * Get the current class name of the texture useful for serialization or dynamic coding.
  140220. * @returns "HDRCubeTexture"
  140221. */
  140222. getClassName(): string;
  140223. /**
  140224. * Occurs when the file is raw .hdr file.
  140225. */
  140226. private loadTexture;
  140227. clone(): HDRCubeTexture;
  140228. delayLoad(): void;
  140229. /**
  140230. * Get the texture reflection matrix used to rotate/transform the reflection.
  140231. * @returns the reflection matrix
  140232. */
  140233. getReflectionTextureMatrix(): Matrix;
  140234. /**
  140235. * Set the texture reflection matrix used to rotate/transform the reflection.
  140236. * @param value Define the reflection matrix to set
  140237. */
  140238. setReflectionTextureMatrix(value: Matrix): void;
  140239. /**
  140240. * Parses a JSON representation of an HDR Texture in order to create the texture
  140241. * @param parsedTexture Define the JSON representation
  140242. * @param scene Define the scene the texture should be created in
  140243. * @param rootUrl Define the root url in case we need to load relative dependencies
  140244. * @returns the newly created texture after parsing
  140245. */
  140246. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<HDRCubeTexture>;
  140247. serialize(): any;
  140248. }
  140249. }
  140250. declare module BABYLON {
  140251. /**
  140252. * Class used to control physics engine
  140253. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  140254. */
  140255. export class PhysicsEngine implements IPhysicsEngine {
  140256. private _physicsPlugin;
  140257. /**
  140258. * Global value used to control the smallest number supported by the simulation
  140259. */
  140260. static Epsilon: number;
  140261. private _impostors;
  140262. private _joints;
  140263. private _subTimeStep;
  140264. /**
  140265. * Gets the gravity vector used by the simulation
  140266. */
  140267. gravity: Vector3;
  140268. /**
  140269. * Factory used to create the default physics plugin.
  140270. * @returns The default physics plugin
  140271. */
  140272. static DefaultPluginFactory(): IPhysicsEnginePlugin;
  140273. /**
  140274. * Creates a new Physics Engine
  140275. * @param gravity defines the gravity vector used by the simulation
  140276. * @param _physicsPlugin defines the plugin to use (CannonJS by default)
  140277. */
  140278. constructor(gravity: Nullable<Vector3>, _physicsPlugin?: IPhysicsEnginePlugin);
  140279. /**
  140280. * Sets the gravity vector used by the simulation
  140281. * @param gravity defines the gravity vector to use
  140282. */
  140283. setGravity(gravity: Vector3): void;
  140284. /**
  140285. * Set the time step of the physics engine.
  140286. * Default is 1/60.
  140287. * To slow it down, enter 1/600 for example.
  140288. * To speed it up, 1/30
  140289. * @param newTimeStep defines the new timestep to apply to this world.
  140290. */
  140291. setTimeStep(newTimeStep?: number): void;
  140292. /**
  140293. * Get the time step of the physics engine.
  140294. * @returns the current time step
  140295. */
  140296. getTimeStep(): number;
  140297. /**
  140298. * Set the sub time step of the physics engine.
  140299. * Default is 0 meaning there is no sub steps
  140300. * To increase physics resolution precision, set a small value (like 1 ms)
  140301. * @param subTimeStep defines the new sub timestep used for physics resolution.
  140302. */
  140303. setSubTimeStep(subTimeStep?: number): void;
  140304. /**
  140305. * Get the sub time step of the physics engine.
  140306. * @returns the current sub time step
  140307. */
  140308. getSubTimeStep(): number;
  140309. /**
  140310. * Release all resources
  140311. */
  140312. dispose(): void;
  140313. /**
  140314. * Gets the name of the current physics plugin
  140315. * @returns the name of the plugin
  140316. */
  140317. getPhysicsPluginName(): string;
  140318. /**
  140319. * Adding a new impostor for the impostor tracking.
  140320. * This will be done by the impostor itself.
  140321. * @param impostor the impostor to add
  140322. */
  140323. addImpostor(impostor: PhysicsImpostor): void;
  140324. /**
  140325. * Remove an impostor from the engine.
  140326. * This impostor and its mesh will not longer be updated by the physics engine.
  140327. * @param impostor the impostor to remove
  140328. */
  140329. removeImpostor(impostor: PhysicsImpostor): void;
  140330. /**
  140331. * Add a joint to the physics engine
  140332. * @param mainImpostor defines the main impostor to which the joint is added.
  140333. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  140334. * @param joint defines the joint that will connect both impostors.
  140335. */
  140336. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  140337. /**
  140338. * Removes a joint from the simulation
  140339. * @param mainImpostor defines the impostor used with the joint
  140340. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  140341. * @param joint defines the joint to remove
  140342. */
  140343. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  140344. /**
  140345. * Called by the scene. No need to call it.
  140346. * @param delta defines the timespam between frames
  140347. */
  140348. _step(delta: number): void;
  140349. /**
  140350. * Gets the current plugin used to run the simulation
  140351. * @returns current plugin
  140352. */
  140353. getPhysicsPlugin(): IPhysicsEnginePlugin;
  140354. /**
  140355. * Gets the list of physic impostors
  140356. * @returns an array of PhysicsImpostor
  140357. */
  140358. getImpostors(): Array<PhysicsImpostor>;
  140359. /**
  140360. * Gets the impostor for a physics enabled object
  140361. * @param object defines the object impersonated by the impostor
  140362. * @returns the PhysicsImpostor or null if not found
  140363. */
  140364. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  140365. /**
  140366. * Gets the impostor for a physics body object
  140367. * @param body defines physics body used by the impostor
  140368. * @returns the PhysicsImpostor or null if not found
  140369. */
  140370. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  140371. /**
  140372. * Does a raycast in the physics world
  140373. * @param from when should the ray start?
  140374. * @param to when should the ray end?
  140375. * @returns PhysicsRaycastResult
  140376. */
  140377. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  140378. }
  140379. }
  140380. declare module BABYLON {
  140381. /** @hidden */
  140382. export class CannonJSPlugin implements IPhysicsEnginePlugin {
  140383. private _useDeltaForWorldStep;
  140384. world: any;
  140385. name: string;
  140386. private _physicsMaterials;
  140387. private _fixedTimeStep;
  140388. private _cannonRaycastResult;
  140389. private _raycastResult;
  140390. private _physicsBodysToRemoveAfterStep;
  140391. private _firstFrame;
  140392. BJSCANNON: any;
  140393. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, cannonInjection?: any);
  140394. setGravity(gravity: Vector3): void;
  140395. setTimeStep(timeStep: number): void;
  140396. getTimeStep(): number;
  140397. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  140398. private _removeMarkedPhysicsBodiesFromWorld;
  140399. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  140400. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  140401. generatePhysicsBody(impostor: PhysicsImpostor): void;
  140402. private _processChildMeshes;
  140403. removePhysicsBody(impostor: PhysicsImpostor): void;
  140404. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  140405. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  140406. private _addMaterial;
  140407. private _checkWithEpsilon;
  140408. private _createShape;
  140409. private _createHeightmap;
  140410. private _minus90X;
  140411. private _plus90X;
  140412. private _tmpPosition;
  140413. private _tmpDeltaPosition;
  140414. private _tmpUnityRotation;
  140415. private _updatePhysicsBodyTransformation;
  140416. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  140417. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  140418. isSupported(): boolean;
  140419. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  140420. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  140421. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  140422. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  140423. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  140424. getBodyMass(impostor: PhysicsImpostor): number;
  140425. getBodyFriction(impostor: PhysicsImpostor): number;
  140426. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  140427. getBodyRestitution(impostor: PhysicsImpostor): number;
  140428. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  140429. sleepBody(impostor: PhysicsImpostor): void;
  140430. wakeUpBody(impostor: PhysicsImpostor): void;
  140431. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number): void;
  140432. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  140433. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  140434. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  140435. getRadius(impostor: PhysicsImpostor): number;
  140436. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  140437. dispose(): void;
  140438. private _extendNamespace;
  140439. /**
  140440. * Does a raycast in the physics world
  140441. * @param from when should the ray start?
  140442. * @param to when should the ray end?
  140443. * @returns PhysicsRaycastResult
  140444. */
  140445. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  140446. }
  140447. }
  140448. declare module BABYLON {
  140449. /** @hidden */
  140450. export class OimoJSPlugin implements IPhysicsEnginePlugin {
  140451. private _useDeltaForWorldStep;
  140452. world: any;
  140453. name: string;
  140454. BJSOIMO: any;
  140455. private _raycastResult;
  140456. private _fixedTimeStep;
  140457. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, oimoInjection?: any);
  140458. setGravity(gravity: Vector3): void;
  140459. setTimeStep(timeStep: number): void;
  140460. getTimeStep(): number;
  140461. private _tmpImpostorsArray;
  140462. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  140463. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  140464. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  140465. generatePhysicsBody(impostor: PhysicsImpostor): void;
  140466. private _tmpPositionVector;
  140467. removePhysicsBody(impostor: PhysicsImpostor): void;
  140468. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  140469. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  140470. isSupported(): boolean;
  140471. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  140472. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  140473. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  140474. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  140475. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  140476. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  140477. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  140478. getBodyMass(impostor: PhysicsImpostor): number;
  140479. getBodyFriction(impostor: PhysicsImpostor): number;
  140480. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  140481. getBodyRestitution(impostor: PhysicsImpostor): number;
  140482. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  140483. sleepBody(impostor: PhysicsImpostor): void;
  140484. wakeUpBody(impostor: PhysicsImpostor): void;
  140485. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  140486. setMotor(joint: IMotorEnabledJoint, speed: number, force?: number, motorIndex?: number): void;
  140487. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  140488. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  140489. getRadius(impostor: PhysicsImpostor): number;
  140490. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  140491. dispose(): void;
  140492. /**
  140493. * Does a raycast in the physics world
  140494. * @param from when should the ray start?
  140495. * @param to when should the ray end?
  140496. * @returns PhysicsRaycastResult
  140497. */
  140498. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  140499. }
  140500. }
  140501. declare module BABYLON {
  140502. /**
  140503. * AmmoJS Physics plugin
  140504. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  140505. * @see https://github.com/kripken/ammo.js/
  140506. */
  140507. export class AmmoJSPlugin implements IPhysicsEnginePlugin {
  140508. private _useDeltaForWorldStep;
  140509. /**
  140510. * Reference to the Ammo library
  140511. */
  140512. bjsAMMO: any;
  140513. /**
  140514. * Created ammoJS world which physics bodies are added to
  140515. */
  140516. world: any;
  140517. /**
  140518. * Name of the plugin
  140519. */
  140520. name: string;
  140521. private _timeStep;
  140522. private _fixedTimeStep;
  140523. private _maxSteps;
  140524. private _tmpQuaternion;
  140525. private _tmpAmmoTransform;
  140526. private _tmpAmmoQuaternion;
  140527. private _tmpAmmoConcreteContactResultCallback;
  140528. private _collisionConfiguration;
  140529. private _dispatcher;
  140530. private _overlappingPairCache;
  140531. private _solver;
  140532. private _softBodySolver;
  140533. private _tmpAmmoVectorA;
  140534. private _tmpAmmoVectorB;
  140535. private _tmpAmmoVectorC;
  140536. private _tmpAmmoVectorD;
  140537. private _tmpContactCallbackResult;
  140538. private _tmpAmmoVectorRCA;
  140539. private _tmpAmmoVectorRCB;
  140540. private _raycastResult;
  140541. private static readonly DISABLE_COLLISION_FLAG;
  140542. private static readonly KINEMATIC_FLAG;
  140543. private static readonly DISABLE_DEACTIVATION_FLAG;
  140544. /**
  140545. * Initializes the ammoJS plugin
  140546. * @param _useDeltaForWorldStep if the time between frames should be used when calculating physics steps (Default: true)
  140547. * @param ammoInjection can be used to inject your own ammo reference
  140548. * @param overlappingPairCache can be used to specify your own overlapping pair cache
  140549. */
  140550. constructor(_useDeltaForWorldStep?: boolean, ammoInjection?: any, overlappingPairCache?: any);
  140551. /**
  140552. * Sets the gravity of the physics world (m/(s^2))
  140553. * @param gravity Gravity to set
  140554. */
  140555. setGravity(gravity: Vector3): void;
  140556. /**
  140557. * Amount of time to step forward on each frame (only used if useDeltaForWorldStep is false in the constructor)
  140558. * @param timeStep timestep to use in seconds
  140559. */
  140560. setTimeStep(timeStep: number): void;
  140561. /**
  140562. * 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)
  140563. * @param fixedTimeStep fixedTimeStep to use in seconds
  140564. */
  140565. setFixedTimeStep(fixedTimeStep: number): void;
  140566. /**
  140567. * Sets the maximum number of steps by the physics engine per frame (Default: 5)
  140568. * @param maxSteps the maximum number of steps by the physics engine per frame
  140569. */
  140570. setMaxSteps(maxSteps: number): void;
  140571. /**
  140572. * Gets the current timestep (only used if useDeltaForWorldStep is false in the constructor)
  140573. * @returns the current timestep in seconds
  140574. */
  140575. getTimeStep(): number;
  140576. /**
  140577. * The create custom shape handler function to be called when using BABYLON.PhysicsImposter.CustomImpostor
  140578. */
  140579. onCreateCustomShape: (impostor: PhysicsImpostor) => any;
  140580. private _isImpostorInContact;
  140581. private _isImpostorPairInContact;
  140582. private _stepSimulation;
  140583. /**
  140584. * Moves the physics simulation forward delta seconds and updates the given physics imposters
  140585. * Prior to the step the imposters physics location is set to the position of the babylon meshes
  140586. * After the step the babylon meshes are set to the position of the physics imposters
  140587. * @param delta amount of time to step forward
  140588. * @param impostors array of imposters to update before/after the step
  140589. */
  140590. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  140591. /**
  140592. * Update babylon mesh to match physics world object
  140593. * @param impostor imposter to match
  140594. */
  140595. private _afterSoftStep;
  140596. /**
  140597. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  140598. * @param impostor imposter to match
  140599. */
  140600. private _ropeStep;
  140601. /**
  140602. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  140603. * @param impostor imposter to match
  140604. */
  140605. private _softbodyOrClothStep;
  140606. private _tmpMatrix;
  140607. /**
  140608. * Applies an impulse on the imposter
  140609. * @param impostor imposter to apply impulse to
  140610. * @param force amount of force to be applied to the imposter
  140611. * @param contactPoint the location to apply the impulse on the imposter
  140612. */
  140613. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  140614. /**
  140615. * Applies a force on the imposter
  140616. * @param impostor imposter to apply force
  140617. * @param force amount of force to be applied to the imposter
  140618. * @param contactPoint the location to apply the force on the imposter
  140619. */
  140620. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  140621. /**
  140622. * Creates a physics body using the plugin
  140623. * @param impostor the imposter to create the physics body on
  140624. */
  140625. generatePhysicsBody(impostor: PhysicsImpostor): void;
  140626. /**
  140627. * Removes the physics body from the imposter and disposes of the body's memory
  140628. * @param impostor imposter to remove the physics body from
  140629. */
  140630. removePhysicsBody(impostor: PhysicsImpostor): void;
  140631. /**
  140632. * Generates a joint
  140633. * @param impostorJoint the imposter joint to create the joint with
  140634. */
  140635. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  140636. /**
  140637. * Removes a joint
  140638. * @param impostorJoint the imposter joint to remove the joint from
  140639. */
  140640. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  140641. private _addMeshVerts;
  140642. /**
  140643. * Initialise the soft body vertices to match its object's (mesh) vertices
  140644. * Softbody vertices (nodes) are in world space and to match this
  140645. * The object's position and rotation is set to zero and so its vertices are also then set in world space
  140646. * @param impostor to create the softbody for
  140647. */
  140648. private _softVertexData;
  140649. /**
  140650. * Create an impostor's soft body
  140651. * @param impostor to create the softbody for
  140652. */
  140653. private _createSoftbody;
  140654. /**
  140655. * Create cloth for an impostor
  140656. * @param impostor to create the softbody for
  140657. */
  140658. private _createCloth;
  140659. /**
  140660. * Create rope for an impostor
  140661. * @param impostor to create the softbody for
  140662. */
  140663. private _createRope;
  140664. /**
  140665. * Create a custom physics impostor shape using the plugin's onCreateCustomShape handler
  140666. * @param impostor to create the custom physics shape for
  140667. */
  140668. private _createCustom;
  140669. private _addHullVerts;
  140670. private _createShape;
  140671. /**
  140672. * Sets the physics body position/rotation from the babylon mesh's position/rotation
  140673. * @param impostor imposter containing the physics body and babylon object
  140674. */
  140675. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  140676. /**
  140677. * Sets the babylon object's position/rotation from the physics body's position/rotation
  140678. * @param impostor imposter containing the physics body and babylon object
  140679. * @param newPosition new position
  140680. * @param newRotation new rotation
  140681. */
  140682. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  140683. /**
  140684. * If this plugin is supported
  140685. * @returns true if its supported
  140686. */
  140687. isSupported(): boolean;
  140688. /**
  140689. * Sets the linear velocity of the physics body
  140690. * @param impostor imposter to set the velocity on
  140691. * @param velocity velocity to set
  140692. */
  140693. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  140694. /**
  140695. * Sets the angular velocity of the physics body
  140696. * @param impostor imposter to set the velocity on
  140697. * @param velocity velocity to set
  140698. */
  140699. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  140700. /**
  140701. * gets the linear velocity
  140702. * @param impostor imposter to get linear velocity from
  140703. * @returns linear velocity
  140704. */
  140705. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  140706. /**
  140707. * gets the angular velocity
  140708. * @param impostor imposter to get angular velocity from
  140709. * @returns angular velocity
  140710. */
  140711. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  140712. /**
  140713. * Sets the mass of physics body
  140714. * @param impostor imposter to set the mass on
  140715. * @param mass mass to set
  140716. */
  140717. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  140718. /**
  140719. * Gets the mass of the physics body
  140720. * @param impostor imposter to get the mass from
  140721. * @returns mass
  140722. */
  140723. getBodyMass(impostor: PhysicsImpostor): number;
  140724. /**
  140725. * Gets friction of the impostor
  140726. * @param impostor impostor to get friction from
  140727. * @returns friction value
  140728. */
  140729. getBodyFriction(impostor: PhysicsImpostor): number;
  140730. /**
  140731. * Sets friction of the impostor
  140732. * @param impostor impostor to set friction on
  140733. * @param friction friction value
  140734. */
  140735. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  140736. /**
  140737. * Gets restitution of the impostor
  140738. * @param impostor impostor to get restitution from
  140739. * @returns restitution value
  140740. */
  140741. getBodyRestitution(impostor: PhysicsImpostor): number;
  140742. /**
  140743. * Sets resitution of the impostor
  140744. * @param impostor impostor to set resitution on
  140745. * @param restitution resitution value
  140746. */
  140747. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  140748. /**
  140749. * Gets pressure inside the impostor
  140750. * @param impostor impostor to get pressure from
  140751. * @returns pressure value
  140752. */
  140753. getBodyPressure(impostor: PhysicsImpostor): number;
  140754. /**
  140755. * Sets pressure inside a soft body impostor
  140756. * Cloth and rope must remain 0 pressure
  140757. * @param impostor impostor to set pressure on
  140758. * @param pressure pressure value
  140759. */
  140760. setBodyPressure(impostor: PhysicsImpostor, pressure: number): void;
  140761. /**
  140762. * Gets stiffness of the impostor
  140763. * @param impostor impostor to get stiffness from
  140764. * @returns pressure value
  140765. */
  140766. getBodyStiffness(impostor: PhysicsImpostor): number;
  140767. /**
  140768. * Sets stiffness of the impostor
  140769. * @param impostor impostor to set stiffness on
  140770. * @param stiffness stiffness value from 0 to 1
  140771. */
  140772. setBodyStiffness(impostor: PhysicsImpostor, stiffness: number): void;
  140773. /**
  140774. * Gets velocityIterations of the impostor
  140775. * @param impostor impostor to get velocity iterations from
  140776. * @returns velocityIterations value
  140777. */
  140778. getBodyVelocityIterations(impostor: PhysicsImpostor): number;
  140779. /**
  140780. * Sets velocityIterations of the impostor
  140781. * @param impostor impostor to set velocity iterations on
  140782. * @param velocityIterations velocityIterations value
  140783. */
  140784. setBodyVelocityIterations(impostor: PhysicsImpostor, velocityIterations: number): void;
  140785. /**
  140786. * Gets positionIterations of the impostor
  140787. * @param impostor impostor to get position iterations from
  140788. * @returns positionIterations value
  140789. */
  140790. getBodyPositionIterations(impostor: PhysicsImpostor): number;
  140791. /**
  140792. * Sets positionIterations of the impostor
  140793. * @param impostor impostor to set position on
  140794. * @param positionIterations positionIterations value
  140795. */
  140796. setBodyPositionIterations(impostor: PhysicsImpostor, positionIterations: number): void;
  140797. /**
  140798. * Append an anchor to a cloth object
  140799. * @param impostor is the cloth impostor to add anchor to
  140800. * @param otherImpostor is the rigid impostor to anchor to
  140801. * @param width ratio across width from 0 to 1
  140802. * @param height ratio up height from 0 to 1
  140803. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  140804. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  140805. */
  140806. appendAnchor(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  140807. /**
  140808. * Append an hook to a rope object
  140809. * @param impostor is the rope impostor to add hook to
  140810. * @param otherImpostor is the rigid impostor to hook to
  140811. * @param length ratio along the rope from 0 to 1
  140812. * @param influence the elasticity between soft impostor and anchor from 0, very stretchy to 1, little strech
  140813. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  140814. */
  140815. appendHook(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  140816. /**
  140817. * Sleeps the physics body and stops it from being active
  140818. * @param impostor impostor to sleep
  140819. */
  140820. sleepBody(impostor: PhysicsImpostor): void;
  140821. /**
  140822. * Activates the physics body
  140823. * @param impostor impostor to activate
  140824. */
  140825. wakeUpBody(impostor: PhysicsImpostor): void;
  140826. /**
  140827. * Updates the distance parameters of the joint
  140828. * @param joint joint to update
  140829. * @param maxDistance maximum distance of the joint
  140830. * @param minDistance minimum distance of the joint
  140831. */
  140832. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  140833. /**
  140834. * Sets a motor on the joint
  140835. * @param joint joint to set motor on
  140836. * @param speed speed of the motor
  140837. * @param maxForce maximum force of the motor
  140838. * @param motorIndex index of the motor
  140839. */
  140840. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  140841. /**
  140842. * Sets the motors limit
  140843. * @param joint joint to set limit on
  140844. * @param upperLimit upper limit
  140845. * @param lowerLimit lower limit
  140846. */
  140847. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  140848. /**
  140849. * Syncs the position and rotation of a mesh with the impostor
  140850. * @param mesh mesh to sync
  140851. * @param impostor impostor to update the mesh with
  140852. */
  140853. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  140854. /**
  140855. * Gets the radius of the impostor
  140856. * @param impostor impostor to get radius from
  140857. * @returns the radius
  140858. */
  140859. getRadius(impostor: PhysicsImpostor): number;
  140860. /**
  140861. * Gets the box size of the impostor
  140862. * @param impostor impostor to get box size from
  140863. * @param result the resulting box size
  140864. */
  140865. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  140866. /**
  140867. * Disposes of the impostor
  140868. */
  140869. dispose(): void;
  140870. /**
  140871. * Does a raycast in the physics world
  140872. * @param from when should the ray start?
  140873. * @param to when should the ray end?
  140874. * @returns PhysicsRaycastResult
  140875. */
  140876. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  140877. }
  140878. }
  140879. declare module BABYLON {
  140880. interface AbstractScene {
  140881. /**
  140882. * The list of reflection probes added to the scene
  140883. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  140884. */
  140885. reflectionProbes: Array<ReflectionProbe>;
  140886. /**
  140887. * Removes the given reflection probe from this scene.
  140888. * @param toRemove The reflection probe to remove
  140889. * @returns The index of the removed reflection probe
  140890. */
  140891. removeReflectionProbe(toRemove: ReflectionProbe): number;
  140892. /**
  140893. * Adds the given reflection probe to this scene.
  140894. * @param newReflectionProbe The reflection probe to add
  140895. */
  140896. addReflectionProbe(newReflectionProbe: ReflectionProbe): void;
  140897. }
  140898. /**
  140899. * Class used to generate realtime reflection / refraction cube textures
  140900. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  140901. */
  140902. export class ReflectionProbe {
  140903. /** defines the name of the probe */
  140904. name: string;
  140905. private _scene;
  140906. private _renderTargetTexture;
  140907. private _projectionMatrix;
  140908. private _viewMatrix;
  140909. private _target;
  140910. private _add;
  140911. private _attachedMesh;
  140912. private _invertYAxis;
  140913. /** Gets or sets probe position (center of the cube map) */
  140914. position: Vector3;
  140915. /**
  140916. * Creates a new reflection probe
  140917. * @param name defines the name of the probe
  140918. * @param size defines the texture resolution (for each face)
  140919. * @param scene defines the hosting scene
  140920. * @param generateMipMaps defines if mip maps should be generated automatically (true by default)
  140921. * @param useFloat defines if HDR data (flaot data) should be used to store colors (false by default)
  140922. */
  140923. constructor(
  140924. /** defines the name of the probe */
  140925. name: string, size: number, scene: Scene, generateMipMaps?: boolean, useFloat?: boolean);
  140926. /** Gets or sets the number of samples to use for multi-sampling (0 by default). Required WebGL2 */
  140927. get samples(): number;
  140928. set samples(value: number);
  140929. /** Gets or sets the refresh rate to use (on every frame by default) */
  140930. get refreshRate(): number;
  140931. set refreshRate(value: number);
  140932. /**
  140933. * Gets the hosting scene
  140934. * @returns a Scene
  140935. */
  140936. getScene(): Scene;
  140937. /** Gets the internal CubeTexture used to render to */
  140938. get cubeTexture(): RenderTargetTexture;
  140939. /** Gets the list of meshes to render */
  140940. get renderList(): Nullable<AbstractMesh[]>;
  140941. /**
  140942. * Attach the probe to a specific mesh (Rendering will be done from attached mesh's position)
  140943. * @param mesh defines the mesh to attach to
  140944. */
  140945. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  140946. /**
  140947. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups
  140948. * @param renderingGroupId The rendering group id corresponding to its index
  140949. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  140950. */
  140951. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  140952. /**
  140953. * Clean all associated resources
  140954. */
  140955. dispose(): void;
  140956. /**
  140957. * Converts the reflection probe information to a readable string for debug purpose.
  140958. * @param fullDetails Supports for multiple levels of logging within scene loading
  140959. * @returns the human readable reflection probe info
  140960. */
  140961. toString(fullDetails?: boolean): string;
  140962. /**
  140963. * Get the class name of the relfection probe.
  140964. * @returns "ReflectionProbe"
  140965. */
  140966. getClassName(): string;
  140967. /**
  140968. * Serialize the reflection probe to a JSON representation we can easily use in the resepective Parse function.
  140969. * @returns The JSON representation of the texture
  140970. */
  140971. serialize(): any;
  140972. /**
  140973. * Parse the JSON representation of a reflection probe in order to recreate the reflection probe in the given scene.
  140974. * @param parsedReflectionProbe Define the JSON representation of the reflection probe
  140975. * @param scene Define the scene the parsed reflection probe should be instantiated in
  140976. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  140977. * @returns The parsed reflection probe if successful
  140978. */
  140979. static Parse(parsedReflectionProbe: any, scene: Scene, rootUrl: string): Nullable<ReflectionProbe>;
  140980. }
  140981. }
  140982. declare module BABYLON {
  140983. /** @hidden */
  140984. export var _BabylonLoaderRegistered: boolean;
  140985. /**
  140986. * Helps setting up some configuration for the babylon file loader.
  140987. */
  140988. export class BabylonFileLoaderConfiguration {
  140989. /**
  140990. * The loader does not allow injecting custom physix engine into the plugins.
  140991. * Unfortunately in ES6, we need to manually inject them into the plugin.
  140992. * So you could set this variable to your engine import to make it work.
  140993. */
  140994. static LoaderInjectedPhysicsEngine: any;
  140995. }
  140996. }
  140997. declare module BABYLON {
  140998. /**
  140999. * The Physically based simple base material of BJS.
  141000. *
  141001. * This enables better naming and convention enforcements on top of the pbrMaterial.
  141002. * It is used as the base class for both the specGloss and metalRough conventions.
  141003. */
  141004. export abstract class PBRBaseSimpleMaterial extends PBRBaseMaterial {
  141005. /**
  141006. * Number of Simultaneous lights allowed on the material.
  141007. */
  141008. maxSimultaneousLights: number;
  141009. /**
  141010. * If sets to true, disables all the lights affecting the material.
  141011. */
  141012. disableLighting: boolean;
  141013. /**
  141014. * Environment Texture used in the material (this is use for both reflection and environment lighting).
  141015. */
  141016. environmentTexture: BaseTexture;
  141017. /**
  141018. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  141019. */
  141020. invertNormalMapX: boolean;
  141021. /**
  141022. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  141023. */
  141024. invertNormalMapY: boolean;
  141025. /**
  141026. * Normal map used in the model.
  141027. */
  141028. normalTexture: BaseTexture;
  141029. /**
  141030. * Emissivie color used to self-illuminate the model.
  141031. */
  141032. emissiveColor: Color3;
  141033. /**
  141034. * Emissivie texture used to self-illuminate the model.
  141035. */
  141036. emissiveTexture: BaseTexture;
  141037. /**
  141038. * Occlusion Channel Strenght.
  141039. */
  141040. occlusionStrength: number;
  141041. /**
  141042. * Occlusion Texture of the material (adding extra occlusion effects).
  141043. */
  141044. occlusionTexture: BaseTexture;
  141045. /**
  141046. * Defines the alpha limits in alpha test mode.
  141047. */
  141048. alphaCutOff: number;
  141049. /**
  141050. * Gets the current double sided mode.
  141051. */
  141052. get doubleSided(): boolean;
  141053. /**
  141054. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  141055. */
  141056. set doubleSided(value: boolean);
  141057. /**
  141058. * Stores the pre-calculated light information of a mesh in a texture.
  141059. */
  141060. lightmapTexture: BaseTexture;
  141061. /**
  141062. * If true, the light map contains occlusion information instead of lighting info.
  141063. */
  141064. useLightmapAsShadowmap: boolean;
  141065. /**
  141066. * Instantiates a new PBRMaterial instance.
  141067. *
  141068. * @param name The material name
  141069. * @param scene The scene the material will be use in.
  141070. */
  141071. constructor(name: string, scene: Scene);
  141072. getClassName(): string;
  141073. }
  141074. }
  141075. declare module BABYLON {
  141076. /**
  141077. * The PBR material of BJS following the metal roughness convention.
  141078. *
  141079. * This fits to the PBR convention in the GLTF definition:
  141080. * https://github.com/KhronosGroup/glTF/tree/2.0/specification/2.0
  141081. */
  141082. export class PBRMetallicRoughnessMaterial extends PBRBaseSimpleMaterial {
  141083. /**
  141084. * The base color has two different interpretations depending on the value of metalness.
  141085. * When the material is a metal, the base color is the specific measured reflectance value
  141086. * at normal incidence (F0). For a non-metal the base color represents the reflected diffuse color
  141087. * of the material.
  141088. */
  141089. baseColor: Color3;
  141090. /**
  141091. * Base texture of the metallic workflow. It contains both the baseColor information in RGB as
  141092. * well as opacity information in the alpha channel.
  141093. */
  141094. baseTexture: BaseTexture;
  141095. /**
  141096. * Specifies the metallic scalar value of the material.
  141097. * Can also be used to scale the metalness values of the metallic texture.
  141098. */
  141099. metallic: number;
  141100. /**
  141101. * Specifies the roughness scalar value of the material.
  141102. * Can also be used to scale the roughness values of the metallic texture.
  141103. */
  141104. roughness: number;
  141105. /**
  141106. * Texture containing both the metallic value in the B channel and the
  141107. * roughness value in the G channel to keep better precision.
  141108. */
  141109. metallicRoughnessTexture: BaseTexture;
  141110. /**
  141111. * Instantiates a new PBRMetalRoughnessMaterial instance.
  141112. *
  141113. * @param name The material name
  141114. * @param scene The scene the material will be use in.
  141115. */
  141116. constructor(name: string, scene: Scene);
  141117. /**
  141118. * Return the currrent class name of the material.
  141119. */
  141120. getClassName(): string;
  141121. /**
  141122. * Makes a duplicate of the current material.
  141123. * @param name - name to use for the new material.
  141124. */
  141125. clone(name: string): PBRMetallicRoughnessMaterial;
  141126. /**
  141127. * Serialize the material to a parsable JSON object.
  141128. */
  141129. serialize(): any;
  141130. /**
  141131. * Parses a JSON object correponding to the serialize function.
  141132. */
  141133. static Parse(source: any, scene: Scene, rootUrl: string): PBRMetallicRoughnessMaterial;
  141134. }
  141135. }
  141136. declare module BABYLON {
  141137. /**
  141138. * The PBR material of BJS following the specular glossiness convention.
  141139. *
  141140. * This fits to the PBR convention in the GLTF definition:
  141141. * https://github.com/KhronosGroup/glTF/tree/2.0/extensions/Khronos/KHR_materials_pbrSpecularGlossiness
  141142. */
  141143. export class PBRSpecularGlossinessMaterial extends PBRBaseSimpleMaterial {
  141144. /**
  141145. * Specifies the diffuse color of the material.
  141146. */
  141147. diffuseColor: Color3;
  141148. /**
  141149. * Specifies the diffuse texture of the material. This can also contains the opcity value in its alpha
  141150. * channel.
  141151. */
  141152. diffuseTexture: BaseTexture;
  141153. /**
  141154. * Specifies the specular color of the material. This indicates how reflective is the material (none to mirror).
  141155. */
  141156. specularColor: Color3;
  141157. /**
  141158. * Specifies the glossiness of the material. This indicates "how sharp is the reflection".
  141159. */
  141160. glossiness: number;
  141161. /**
  141162. * Specifies both the specular color RGB and the glossiness A of the material per pixels.
  141163. */
  141164. specularGlossinessTexture: BaseTexture;
  141165. /**
  141166. * Instantiates a new PBRSpecularGlossinessMaterial instance.
  141167. *
  141168. * @param name The material name
  141169. * @param scene The scene the material will be use in.
  141170. */
  141171. constructor(name: string, scene: Scene);
  141172. /**
  141173. * Return the currrent class name of the material.
  141174. */
  141175. getClassName(): string;
  141176. /**
  141177. * Makes a duplicate of the current material.
  141178. * @param name - name to use for the new material.
  141179. */
  141180. clone(name: string): PBRSpecularGlossinessMaterial;
  141181. /**
  141182. * Serialize the material to a parsable JSON object.
  141183. */
  141184. serialize(): any;
  141185. /**
  141186. * Parses a JSON object correponding to the serialize function.
  141187. */
  141188. static Parse(source: any, scene: Scene, rootUrl: string): PBRSpecularGlossinessMaterial;
  141189. }
  141190. }
  141191. declare module BABYLON {
  141192. /**
  141193. * This represents a color grading texture. This acts as a lookup table LUT, useful during post process
  141194. * It can help converting any input color in a desired output one. This can then be used to create effects
  141195. * from sepia, black and white to sixties or futuristic rendering...
  141196. *
  141197. * The only supported format is currently 3dl.
  141198. * More information on LUT: https://en.wikipedia.org/wiki/3D_lookup_table
  141199. */
  141200. export class ColorGradingTexture extends BaseTexture {
  141201. /**
  141202. * The texture URL.
  141203. */
  141204. url: string;
  141205. /**
  141206. * Empty line regex stored for GC.
  141207. */
  141208. private static _noneEmptyLineRegex;
  141209. private _textureMatrix;
  141210. private _onLoad;
  141211. /**
  141212. * Instantiates a ColorGradingTexture from the following parameters.
  141213. *
  141214. * @param url The location of the color gradind data (currently only supporting 3dl)
  141215. * @param sceneOrEngine The scene or engine the texture will be used in
  141216. * @param onLoad defines a callback triggered when the texture has been loaded
  141217. */
  141218. constructor(url: string, sceneOrEngine: Scene | ThinEngine, onLoad?: Nullable<() => void>);
  141219. /**
  141220. * Fires the onload event from the constructor if requested.
  141221. */
  141222. private _triggerOnLoad;
  141223. /**
  141224. * Returns the texture matrix used in most of the material.
  141225. * This is not used in color grading but keep for troubleshooting purpose (easily swap diffuse by colorgrading to look in).
  141226. */
  141227. getTextureMatrix(): Matrix;
  141228. /**
  141229. * Occurs when the file being loaded is a .3dl LUT file.
  141230. */
  141231. private load3dlTexture;
  141232. /**
  141233. * Starts the loading process of the texture.
  141234. */
  141235. private loadTexture;
  141236. /**
  141237. * Clones the color gradind texture.
  141238. */
  141239. clone(): ColorGradingTexture;
  141240. /**
  141241. * Called during delayed load for textures.
  141242. */
  141243. delayLoad(): void;
  141244. /**
  141245. * Parses a color grading texture serialized by Babylon.
  141246. * @param parsedTexture The texture information being parsedTexture
  141247. * @param scene The scene to load the texture in
  141248. * @param rootUrl The root url of the data assets to load
  141249. * @return A color gradind texture
  141250. */
  141251. static Parse(parsedTexture: any, scene: Scene): Nullable<ColorGradingTexture>;
  141252. /**
  141253. * Serializes the LUT texture to json format.
  141254. */
  141255. serialize(): any;
  141256. }
  141257. }
  141258. declare module BABYLON {
  141259. /**
  141260. * This represents a texture coming from an equirectangular image supported by the web browser canvas.
  141261. */
  141262. export class EquiRectangularCubeTexture extends BaseTexture {
  141263. /** The six faces of the cube. */
  141264. private static _FacesMapping;
  141265. private _noMipmap;
  141266. private _onLoad;
  141267. private _onError;
  141268. /** The size of the cubemap. */
  141269. private _size;
  141270. /** The buffer of the image. */
  141271. private _buffer;
  141272. /** The width of the input image. */
  141273. private _width;
  141274. /** The height of the input image. */
  141275. private _height;
  141276. /** The URL to the image. */
  141277. url: string;
  141278. /**
  141279. * Instantiates an EquiRectangularCubeTexture from the following parameters.
  141280. * @param url The location of the image
  141281. * @param scene The scene the texture will be used in
  141282. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  141283. * @param noMipmap Forces to not generate the mipmap if true
  141284. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  141285. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  141286. * @param onLoad — defines a callback called when texture is loaded
  141287. * @param onError — defines a callback called if there is an error
  141288. */
  141289. constructor(url: string, scene: Scene, size: number, noMipmap?: boolean, gammaSpace?: boolean, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>);
  141290. /**
  141291. * Load the image data, by putting the image on a canvas and extracting its buffer.
  141292. */
  141293. private loadImage;
  141294. /**
  141295. * Convert the image buffer into a cubemap and create a CubeTexture.
  141296. */
  141297. private loadTexture;
  141298. /**
  141299. * Convert the ArrayBuffer into a Float32Array and drop the transparency channel.
  141300. * @param buffer The ArrayBuffer that should be converted.
  141301. * @returns The buffer as Float32Array.
  141302. */
  141303. private getFloat32ArrayFromArrayBuffer;
  141304. /**
  141305. * Get the current class name of the texture useful for serialization or dynamic coding.
  141306. * @returns "EquiRectangularCubeTexture"
  141307. */
  141308. getClassName(): string;
  141309. /**
  141310. * Create a clone of the current EquiRectangularCubeTexture and return it.
  141311. * @returns A clone of the current EquiRectangularCubeTexture.
  141312. */
  141313. clone(): EquiRectangularCubeTexture;
  141314. }
  141315. }
  141316. declare module BABYLON {
  141317. /**
  141318. * Defines the options related to the creation of an HtmlElementTexture
  141319. */
  141320. export interface IHtmlElementTextureOptions {
  141321. /**
  141322. * Defines wether mip maps should be created or not.
  141323. */
  141324. generateMipMaps?: boolean;
  141325. /**
  141326. * Defines the sampling mode of the texture.
  141327. */
  141328. samplingMode?: number;
  141329. /**
  141330. * Defines the engine instance to use the texture with. It is not mandatory if you define a scene.
  141331. */
  141332. engine: Nullable<ThinEngine>;
  141333. /**
  141334. * Defines the scene the texture belongs to. It is not mandatory if you define an engine.
  141335. */
  141336. scene: Nullable<Scene>;
  141337. }
  141338. /**
  141339. * This represents the smallest workload to use an already existing element (Canvas or Video) as a texture.
  141340. * To be as efficient as possible depending on your constraints nothing aside the first upload
  141341. * is automatically managed.
  141342. * It is a cheap VideoTexture or DynamicTexture if you prefer to keep full control of the elements
  141343. * in your application.
  141344. *
  141345. * As the update is not automatic, you need to call them manually.
  141346. */
  141347. export class HtmlElementTexture extends BaseTexture {
  141348. /**
  141349. * The texture URL.
  141350. */
  141351. element: HTMLVideoElement | HTMLCanvasElement;
  141352. private static readonly DefaultOptions;
  141353. private _textureMatrix;
  141354. private _isVideo;
  141355. private _generateMipMaps;
  141356. private _samplingMode;
  141357. /**
  141358. * Instantiates a HtmlElementTexture from the following parameters.
  141359. *
  141360. * @param name Defines the name of the texture
  141361. * @param element Defines the video or canvas the texture is filled with
  141362. * @param options Defines the other none mandatory texture creation options
  141363. */
  141364. constructor(name: string, element: HTMLVideoElement | HTMLCanvasElement, options: IHtmlElementTextureOptions);
  141365. private _createInternalTexture;
  141366. /**
  141367. * Returns the texture matrix used in most of the material.
  141368. */
  141369. getTextureMatrix(): Matrix;
  141370. /**
  141371. * Updates the content of the texture.
  141372. * @param invertY Defines wether the texture should be inverted on Y (false by default on video and true on canvas)
  141373. */
  141374. update(invertY?: Nullable<boolean>): void;
  141375. }
  141376. }
  141377. declare module BABYLON {
  141378. /**
  141379. * Based on jsTGALoader - Javascript loader for TGA file
  141380. * By Vincent Thibault
  141381. * @see http://blog.robrowser.com/javascript-tga-loader.html
  141382. */
  141383. export class TGATools {
  141384. private static _TYPE_INDEXED;
  141385. private static _TYPE_RGB;
  141386. private static _TYPE_GREY;
  141387. private static _TYPE_RLE_INDEXED;
  141388. private static _TYPE_RLE_RGB;
  141389. private static _TYPE_RLE_GREY;
  141390. private static _ORIGIN_MASK;
  141391. private static _ORIGIN_SHIFT;
  141392. private static _ORIGIN_BL;
  141393. private static _ORIGIN_BR;
  141394. private static _ORIGIN_UL;
  141395. private static _ORIGIN_UR;
  141396. /**
  141397. * Gets the header of a TGA file
  141398. * @param data defines the TGA data
  141399. * @returns the header
  141400. */
  141401. static GetTGAHeader(data: Uint8Array): any;
  141402. /**
  141403. * Uploads TGA content to a Babylon Texture
  141404. * @hidden
  141405. */
  141406. static UploadContent(texture: InternalTexture, data: Uint8Array): void;
  141407. /** @hidden */
  141408. 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;
  141409. /** @hidden */
  141410. 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;
  141411. /** @hidden */
  141412. 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;
  141413. /** @hidden */
  141414. 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;
  141415. /** @hidden */
  141416. 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;
  141417. /** @hidden */
  141418. 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;
  141419. }
  141420. }
  141421. declare module BABYLON {
  141422. /**
  141423. * Implementation of the TGA Texture Loader.
  141424. * @hidden
  141425. */
  141426. export class _TGATextureLoader implements IInternalTextureLoader {
  141427. /**
  141428. * Defines wether the loader supports cascade loading the different faces.
  141429. */
  141430. readonly supportCascades: boolean;
  141431. /**
  141432. * This returns if the loader support the current file information.
  141433. * @param extension defines the file extension of the file being loaded
  141434. * @returns true if the loader can load the specified file
  141435. */
  141436. canLoad(extension: string): boolean;
  141437. /**
  141438. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  141439. * @param data contains the texture data
  141440. * @param texture defines the BabylonJS internal texture
  141441. * @param createPolynomials will be true if polynomials have been requested
  141442. * @param onLoad defines the callback to trigger once the texture is ready
  141443. * @param onError defines the callback to trigger in case of error
  141444. */
  141445. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  141446. /**
  141447. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  141448. * @param data contains the texture data
  141449. * @param texture defines the BabylonJS internal texture
  141450. * @param callback defines the method to call once ready to upload
  141451. */
  141452. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  141453. }
  141454. }
  141455. declare module BABYLON {
  141456. /**
  141457. * Info about the .basis files
  141458. */
  141459. class BasisFileInfo {
  141460. /**
  141461. * If the file has alpha
  141462. */
  141463. hasAlpha: boolean;
  141464. /**
  141465. * Info about each image of the basis file
  141466. */
  141467. images: Array<{
  141468. levels: Array<{
  141469. width: number;
  141470. height: number;
  141471. transcodedPixels: ArrayBufferView;
  141472. }>;
  141473. }>;
  141474. }
  141475. /**
  141476. * Result of transcoding a basis file
  141477. */
  141478. class TranscodeResult {
  141479. /**
  141480. * Info about the .basis file
  141481. */
  141482. fileInfo: BasisFileInfo;
  141483. /**
  141484. * Format to use when loading the file
  141485. */
  141486. format: number;
  141487. }
  141488. /**
  141489. * Configuration options for the Basis transcoder
  141490. */
  141491. export class BasisTranscodeConfiguration {
  141492. /**
  141493. * Supported compression formats used to determine the supported output format of the transcoder
  141494. */
  141495. supportedCompressionFormats?: {
  141496. /**
  141497. * etc1 compression format
  141498. */
  141499. etc1?: boolean;
  141500. /**
  141501. * s3tc compression format
  141502. */
  141503. s3tc?: boolean;
  141504. /**
  141505. * pvrtc compression format
  141506. */
  141507. pvrtc?: boolean;
  141508. /**
  141509. * etc2 compression format
  141510. */
  141511. etc2?: boolean;
  141512. };
  141513. /**
  141514. * If mipmap levels should be loaded for transcoded images (Default: true)
  141515. */
  141516. loadMipmapLevels?: boolean;
  141517. /**
  141518. * Index of a single image to load (Default: all images)
  141519. */
  141520. loadSingleImage?: number;
  141521. }
  141522. /**
  141523. * Used to load .Basis files
  141524. * See https://github.com/BinomialLLC/basis_universal/tree/master/webgl
  141525. */
  141526. export class BasisTools {
  141527. private static _IgnoreSupportedFormats;
  141528. /**
  141529. * URL to use when loading the basis transcoder
  141530. */
  141531. static JSModuleURL: string;
  141532. /**
  141533. * URL to use when loading the wasm module for the transcoder
  141534. */
  141535. static WasmModuleURL: string;
  141536. /**
  141537. * Get the internal format to be passed to texImage2D corresponding to the .basis format value
  141538. * @param basisFormat format chosen from GetSupportedTranscodeFormat
  141539. * @returns internal format corresponding to the Basis format
  141540. */
  141541. static GetInternalFormatFromBasisFormat(basisFormat: number): number;
  141542. private static _WorkerPromise;
  141543. private static _Worker;
  141544. private static _actionId;
  141545. private static _CreateWorkerAsync;
  141546. /**
  141547. * Transcodes a loaded image file to compressed pixel data
  141548. * @param data image data to transcode
  141549. * @param config configuration options for the transcoding
  141550. * @returns a promise resulting in the transcoded image
  141551. */
  141552. static TranscodeAsync(data: ArrayBuffer | ArrayBufferView, config: BasisTranscodeConfiguration): Promise<TranscodeResult>;
  141553. /**
  141554. * Loads a texture from the transcode result
  141555. * @param texture texture load to
  141556. * @param transcodeResult the result of transcoding the basis file to load from
  141557. */
  141558. static LoadTextureFromTranscodeResult(texture: InternalTexture, transcodeResult: TranscodeResult): void;
  141559. }
  141560. }
  141561. declare module BABYLON {
  141562. /**
  141563. * Loader for .basis file format
  141564. */
  141565. export class _BasisTextureLoader implements IInternalTextureLoader {
  141566. /**
  141567. * Defines whether the loader supports cascade loading the different faces.
  141568. */
  141569. readonly supportCascades: boolean;
  141570. /**
  141571. * This returns if the loader support the current file information.
  141572. * @param extension defines the file extension of the file being loaded
  141573. * @returns true if the loader can load the specified file
  141574. */
  141575. canLoad(extension: string): boolean;
  141576. /**
  141577. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  141578. * @param data contains the texture data
  141579. * @param texture defines the BabylonJS internal texture
  141580. * @param createPolynomials will be true if polynomials have been requested
  141581. * @param onLoad defines the callback to trigger once the texture is ready
  141582. * @param onError defines the callback to trigger in case of error
  141583. */
  141584. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  141585. /**
  141586. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  141587. * @param data contains the texture data
  141588. * @param texture defines the BabylonJS internal texture
  141589. * @param callback defines the method to call once ready to upload
  141590. */
  141591. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  141592. }
  141593. }
  141594. declare module BABYLON {
  141595. /**
  141596. * Defines the basic options interface of a TexturePacker Frame
  141597. */
  141598. export interface ITexturePackerFrame {
  141599. /**
  141600. * The frame ID
  141601. */
  141602. id: number;
  141603. /**
  141604. * The frames Scale
  141605. */
  141606. scale: Vector2;
  141607. /**
  141608. * The Frames offset
  141609. */
  141610. offset: Vector2;
  141611. }
  141612. /**
  141613. * This is a support class for frame Data on texture packer sets.
  141614. */
  141615. export class TexturePackerFrame implements ITexturePackerFrame {
  141616. /**
  141617. * The frame ID
  141618. */
  141619. id: number;
  141620. /**
  141621. * The frames Scale
  141622. */
  141623. scale: Vector2;
  141624. /**
  141625. * The Frames offset
  141626. */
  141627. offset: Vector2;
  141628. /**
  141629. * Initializes a texture package frame.
  141630. * @param id The numerical frame identifier
  141631. * @param scale Scalar Vector2 for UV frame
  141632. * @param offset Vector2 for the frame position in UV units.
  141633. * @returns TexturePackerFrame
  141634. */
  141635. constructor(id: number, scale: Vector2, offset: Vector2);
  141636. }
  141637. }
  141638. declare module BABYLON {
  141639. /**
  141640. * Defines the basic options interface of a TexturePacker
  141641. */
  141642. export interface ITexturePackerOptions {
  141643. /**
  141644. * Custom targets for the channels of a texture packer. Default is all the channels of the Standard Material
  141645. */
  141646. map?: string[];
  141647. /**
  141648. * the UV input targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  141649. */
  141650. uvsIn?: string;
  141651. /**
  141652. * the UV output targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  141653. */
  141654. uvsOut?: string;
  141655. /**
  141656. * number representing the layout style. Defaults to LAYOUT_STRIP
  141657. */
  141658. layout?: number;
  141659. /**
  141660. * number of columns if using custom column count layout(2). This defaults to 4.
  141661. */
  141662. colnum?: number;
  141663. /**
  141664. * flag to update the input meshes to the new packed texture after compilation. Defaults to true.
  141665. */
  141666. updateInputMeshes?: boolean;
  141667. /**
  141668. * boolean flag to dispose all the source textures. Defaults to true.
  141669. */
  141670. disposeSources?: boolean;
  141671. /**
  141672. * Fills the blank cells in a set to the customFillColor. Defaults to true.
  141673. */
  141674. fillBlanks?: boolean;
  141675. /**
  141676. * string value representing the context fill style color. Defaults to 'black'.
  141677. */
  141678. customFillColor?: string;
  141679. /**
  141680. * Width and Height Value of each Frame in the TexturePacker Sets
  141681. */
  141682. frameSize?: number;
  141683. /**
  141684. * Ratio of the value to add padding wise to each cell. Defaults to 0.0115
  141685. */
  141686. paddingRatio?: number;
  141687. /**
  141688. * Number that declares the fill method for the padding gutter.
  141689. */
  141690. paddingMode?: number;
  141691. /**
  141692. * If in SUBUV_COLOR padding mode what color to use.
  141693. */
  141694. paddingColor?: Color3 | Color4;
  141695. }
  141696. /**
  141697. * Defines the basic interface of a TexturePacker JSON File
  141698. */
  141699. export interface ITexturePackerJSON {
  141700. /**
  141701. * The frame ID
  141702. */
  141703. name: string;
  141704. /**
  141705. * The base64 channel data
  141706. */
  141707. sets: any;
  141708. /**
  141709. * The options of the Packer
  141710. */
  141711. options: ITexturePackerOptions;
  141712. /**
  141713. * The frame data of the Packer
  141714. */
  141715. frames: Array<number>;
  141716. }
  141717. /**
  141718. * This is a support class that generates a series of packed texture sets.
  141719. * @see https://doc.babylonjs.com/babylon101/materials
  141720. */
  141721. export class TexturePacker {
  141722. /** Packer Layout Constant 0 */
  141723. static readonly LAYOUT_STRIP: number;
  141724. /** Packer Layout Constant 1 */
  141725. static readonly LAYOUT_POWER2: number;
  141726. /** Packer Layout Constant 2 */
  141727. static readonly LAYOUT_COLNUM: number;
  141728. /** Packer Layout Constant 0 */
  141729. static readonly SUBUV_WRAP: number;
  141730. /** Packer Layout Constant 1 */
  141731. static readonly SUBUV_EXTEND: number;
  141732. /** Packer Layout Constant 2 */
  141733. static readonly SUBUV_COLOR: number;
  141734. /** The Name of the Texture Package */
  141735. name: string;
  141736. /** The scene scope of the TexturePacker */
  141737. scene: Scene;
  141738. /** The Meshes to target */
  141739. meshes: AbstractMesh[];
  141740. /** Arguments passed with the Constructor */
  141741. options: ITexturePackerOptions;
  141742. /** The promise that is started upon initialization */
  141743. promise: Nullable<Promise<TexturePacker | string>>;
  141744. /** The Container object for the channel sets that are generated */
  141745. sets: object;
  141746. /** The Container array for the frames that are generated */
  141747. frames: TexturePackerFrame[];
  141748. /** The expected number of textures the system is parsing. */
  141749. private _expecting;
  141750. /** The padding value from Math.ceil(frameSize * paddingRatio) */
  141751. private _paddingValue;
  141752. /**
  141753. * Initializes a texture package series from an array of meshes or a single mesh.
  141754. * @param name The name of the package
  141755. * @param meshes The target meshes to compose the package from
  141756. * @param options The arguments that texture packer should follow while building.
  141757. * @param scene The scene which the textures are scoped to.
  141758. * @returns TexturePacker
  141759. */
  141760. constructor(name: string, meshes: AbstractMesh[], options: ITexturePackerOptions, scene: Scene);
  141761. /**
  141762. * Starts the package process
  141763. * @param resolve The promises resolution function
  141764. * @returns TexturePacker
  141765. */
  141766. private _createFrames;
  141767. /**
  141768. * Calculates the Size of the Channel Sets
  141769. * @returns Vector2
  141770. */
  141771. private _calculateSize;
  141772. /**
  141773. * Calculates the UV data for the frames.
  141774. * @param baseSize the base frameSize
  141775. * @param padding the base frame padding
  141776. * @param dtSize size of the Dynamic Texture for that channel
  141777. * @param dtUnits is 1/dtSize
  141778. * @param update flag to update the input meshes
  141779. */
  141780. private _calculateMeshUVFrames;
  141781. /**
  141782. * Calculates the frames Offset.
  141783. * @param index of the frame
  141784. * @returns Vector2
  141785. */
  141786. private _getFrameOffset;
  141787. /**
  141788. * Updates a Mesh to the frame data
  141789. * @param mesh that is the target
  141790. * @param frameID or the frame index
  141791. */
  141792. private _updateMeshUV;
  141793. /**
  141794. * Updates a Meshes materials to use the texture packer channels
  141795. * @param m is the mesh to target
  141796. * @param force all channels on the packer to be set.
  141797. */
  141798. private _updateTextureReferences;
  141799. /**
  141800. * Public method to set a Mesh to a frame
  141801. * @param m that is the target
  141802. * @param frameID or the frame index
  141803. * @param updateMaterial trigger for if the Meshes attached Material be updated?
  141804. */
  141805. setMeshToFrame(m: AbstractMesh, frameID: number, updateMaterial?: boolean): void;
  141806. /**
  141807. * Starts the async promise to compile the texture packer.
  141808. * @returns Promise<void>
  141809. */
  141810. processAsync(): Promise<void>;
  141811. /**
  141812. * Disposes all textures associated with this packer
  141813. */
  141814. dispose(): void;
  141815. /**
  141816. * Starts the download process for all the channels converting them to base64 data and embedding it all in a JSON file.
  141817. * @param imageType is the image type to use.
  141818. * @param quality of the image if downloading as jpeg, Ranges from >0 to 1.
  141819. */
  141820. download(imageType?: string, quality?: number): void;
  141821. /**
  141822. * Public method to load a texturePacker JSON file.
  141823. * @param data of the JSON file in string format.
  141824. */
  141825. updateFromJSON(data: string): void;
  141826. }
  141827. }
  141828. declare module BABYLON {
  141829. /**
  141830. * 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.
  141831. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  141832. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  141833. */
  141834. export class CustomProceduralTexture extends ProceduralTexture {
  141835. private _animate;
  141836. private _time;
  141837. private _config;
  141838. private _texturePath;
  141839. /**
  141840. * Instantiates a new Custom Procedural Texture.
  141841. * 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.
  141842. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  141843. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  141844. * @param name Define the name of the texture
  141845. * @param texturePath Define the folder path containing all the cutom texture related files (config, shaders...)
  141846. * @param size Define the size of the texture to create
  141847. * @param scene Define the scene the texture belongs to
  141848. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  141849. * @param generateMipMaps Define if the texture should creates mip maps or not
  141850. */
  141851. constructor(name: string, texturePath: string, size: number, scene: Scene, fallbackTexture?: Texture, generateMipMaps?: boolean);
  141852. private _loadJson;
  141853. /**
  141854. * Is the texture ready to be used ? (rendered at least once)
  141855. * @returns true if ready, otherwise, false.
  141856. */
  141857. isReady(): boolean;
  141858. /**
  141859. * Render the texture to its associated render target.
  141860. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  141861. */
  141862. render(useCameraPostProcess?: boolean): void;
  141863. /**
  141864. * Update the list of dependant textures samplers in the shader.
  141865. */
  141866. updateTextures(): void;
  141867. /**
  141868. * Update the uniform values of the procedural texture in the shader.
  141869. */
  141870. updateShaderUniforms(): void;
  141871. /**
  141872. * Define if the texture animates or not.
  141873. */
  141874. get animate(): boolean;
  141875. set animate(value: boolean);
  141876. }
  141877. }
  141878. declare module BABYLON {
  141879. /** @hidden */
  141880. export var noisePixelShader: {
  141881. name: string;
  141882. shader: string;
  141883. };
  141884. }
  141885. declare module BABYLON {
  141886. /**
  141887. * Class used to generate noise procedural textures
  141888. */
  141889. export class NoiseProceduralTexture extends ProceduralTexture {
  141890. /** Gets or sets the start time (default is 0) */
  141891. time: number;
  141892. /** Gets or sets a value between 0 and 1 indicating the overall brightness of the texture (default is 0.2) */
  141893. brightness: number;
  141894. /** Defines the number of octaves to process */
  141895. octaves: number;
  141896. /** Defines the level of persistence (0.8 by default) */
  141897. persistence: number;
  141898. /** Gets or sets animation speed factor (default is 1) */
  141899. animationSpeedFactor: number;
  141900. /**
  141901. * Creates a new NoiseProceduralTexture
  141902. * @param name defines the name fo the texture
  141903. * @param size defines the size of the texture (default is 256)
  141904. * @param scene defines the hosting scene
  141905. * @param fallbackTexture defines the texture to use if the NoiseProceduralTexture can't be created
  141906. * @param generateMipMaps defines if mipmaps must be generated (true by default)
  141907. */
  141908. constructor(name: string, size?: number, scene?: Nullable<Scene>, fallbackTexture?: Texture, generateMipMaps?: boolean);
  141909. private _updateShaderUniforms;
  141910. protected _getDefines(): string;
  141911. /** Generate the current state of the procedural texture */
  141912. render(useCameraPostProcess?: boolean): void;
  141913. /**
  141914. * Serializes this noise procedural texture
  141915. * @returns a serialized noise procedural texture object
  141916. */
  141917. serialize(): any;
  141918. /**
  141919. * Clone the texture.
  141920. * @returns the cloned texture
  141921. */
  141922. clone(): NoiseProceduralTexture;
  141923. /**
  141924. * Creates a NoiseProceduralTexture from parsed noise procedural texture data
  141925. * @param parsedTexture defines parsed texture data
  141926. * @param scene defines the current scene
  141927. * @param rootUrl defines the root URL containing noise procedural texture information
  141928. * @returns a parsed NoiseProceduralTexture
  141929. */
  141930. static Parse(parsedTexture: any, scene: Scene): NoiseProceduralTexture;
  141931. }
  141932. }
  141933. declare module BABYLON {
  141934. /**
  141935. * Raw cube texture where the raw buffers are passed in
  141936. */
  141937. export class RawCubeTexture extends CubeTexture {
  141938. /**
  141939. * Creates a cube texture where the raw buffers are passed in.
  141940. * @param scene defines the scene the texture is attached to
  141941. * @param data defines the array of data to use to create each face
  141942. * @param size defines the size of the textures
  141943. * @param format defines the format of the data
  141944. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  141945. * @param generateMipMaps defines if the engine should generate the mip levels
  141946. * @param invertY defines if data must be stored with Y axis inverted
  141947. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  141948. * @param compression defines the compression used (null by default)
  141949. */
  141950. constructor(scene: Scene, data: Nullable<ArrayBufferView[]>, size: number, format?: number, type?: number, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, compression?: Nullable<string>);
  141951. /**
  141952. * Updates the raw cube texture.
  141953. * @param data defines the data to store
  141954. * @param format defines the data format
  141955. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  141956. * @param invertY defines if data must be stored with Y axis inverted
  141957. * @param compression defines the compression used (null by default)
  141958. * @param level defines which level of the texture to update
  141959. */
  141960. update(data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression?: Nullable<string>): void;
  141961. /**
  141962. * Updates a raw cube texture with RGBD encoded data.
  141963. * @param data defines the array of data [mipmap][face] to use to create each face
  141964. * @param sphericalPolynomial defines the spherical polynomial for irradiance
  141965. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  141966. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  141967. * @returns a promsie that resolves when the operation is complete
  141968. */
  141969. updateRGBDAsync(data: ArrayBufferView[][], sphericalPolynomial?: Nullable<SphericalPolynomial>, lodScale?: number, lodOffset?: number): Promise<void>;
  141970. /**
  141971. * Clones the raw cube texture.
  141972. * @return a new cube texture
  141973. */
  141974. clone(): CubeTexture;
  141975. /** @hidden */
  141976. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  141977. }
  141978. }
  141979. declare module BABYLON {
  141980. /**
  141981. * Class used to store 2D array textures containing user data
  141982. */
  141983. export class RawTexture2DArray extends Texture {
  141984. /** Gets or sets the texture format to use */
  141985. format: number;
  141986. /**
  141987. * Create a new RawTexture2DArray
  141988. * @param data defines the data of the texture
  141989. * @param width defines the width of the texture
  141990. * @param height defines the height of the texture
  141991. * @param depth defines the number of layers of the texture
  141992. * @param format defines the texture format to use
  141993. * @param scene defines the hosting scene
  141994. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  141995. * @param invertY defines if texture must be stored with Y axis inverted
  141996. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  141997. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  141998. */
  141999. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  142000. /** Gets or sets the texture format to use */
  142001. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  142002. /**
  142003. * Update the texture with new data
  142004. * @param data defines the data to store in the texture
  142005. */
  142006. update(data: ArrayBufferView): void;
  142007. }
  142008. }
  142009. declare module BABYLON {
  142010. /**
  142011. * Class used to store 3D textures containing user data
  142012. */
  142013. export class RawTexture3D extends Texture {
  142014. /** Gets or sets the texture format to use */
  142015. format: number;
  142016. /**
  142017. * Create a new RawTexture3D
  142018. * @param data defines the data of the texture
  142019. * @param width defines the width of the texture
  142020. * @param height defines the height of the texture
  142021. * @param depth defines the depth of the texture
  142022. * @param format defines the texture format to use
  142023. * @param scene defines the hosting scene
  142024. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  142025. * @param invertY defines if texture must be stored with Y axis inverted
  142026. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  142027. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  142028. */
  142029. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  142030. /** Gets or sets the texture format to use */
  142031. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  142032. /**
  142033. * Update the texture with new data
  142034. * @param data defines the data to store in the texture
  142035. */
  142036. update(data: ArrayBufferView): void;
  142037. }
  142038. }
  142039. declare module BABYLON {
  142040. /**
  142041. * Creates a refraction texture used by refraction channel of the standard material.
  142042. * It is like a mirror but to see through a material.
  142043. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  142044. */
  142045. export class RefractionTexture extends RenderTargetTexture {
  142046. /**
  142047. * Define the reflection plane we want to use. The refractionPlane is usually set to the constructed refractor.
  142048. * 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.
  142049. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  142050. */
  142051. refractionPlane: Plane;
  142052. /**
  142053. * Define how deep under the surface we should see.
  142054. */
  142055. depth: number;
  142056. /**
  142057. * Creates a refraction texture used by refraction channel of the standard material.
  142058. * It is like a mirror but to see through a material.
  142059. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  142060. * @param name Define the texture name
  142061. * @param size Define the size of the underlying texture
  142062. * @param scene Define the scene the refraction belongs to
  142063. * @param generateMipMaps Define if we need to generate mips level for the refraction
  142064. */
  142065. constructor(name: string, size: number, scene: Scene, generateMipMaps?: boolean);
  142066. /**
  142067. * Clone the refraction texture.
  142068. * @returns the cloned texture
  142069. */
  142070. clone(): RefractionTexture;
  142071. /**
  142072. * Serialize the texture to a JSON representation you could use in Parse later on
  142073. * @returns the serialized JSON representation
  142074. */
  142075. serialize(): any;
  142076. }
  142077. }
  142078. declare module BABYLON {
  142079. /**
  142080. * Block used to add support for vertex skinning (bones)
  142081. */
  142082. export class BonesBlock extends NodeMaterialBlock {
  142083. /**
  142084. * Creates a new BonesBlock
  142085. * @param name defines the block name
  142086. */
  142087. constructor(name: string);
  142088. /**
  142089. * Initialize the block and prepare the context for build
  142090. * @param state defines the state that will be used for the build
  142091. */
  142092. initialize(state: NodeMaterialBuildState): void;
  142093. /**
  142094. * Gets the current class name
  142095. * @returns the class name
  142096. */
  142097. getClassName(): string;
  142098. /**
  142099. * Gets the matrix indices input component
  142100. */
  142101. get matricesIndices(): NodeMaterialConnectionPoint;
  142102. /**
  142103. * Gets the matrix weights input component
  142104. */
  142105. get matricesWeights(): NodeMaterialConnectionPoint;
  142106. /**
  142107. * Gets the extra matrix indices input component
  142108. */
  142109. get matricesIndicesExtra(): NodeMaterialConnectionPoint;
  142110. /**
  142111. * Gets the extra matrix weights input component
  142112. */
  142113. get matricesWeightsExtra(): NodeMaterialConnectionPoint;
  142114. /**
  142115. * Gets the world input component
  142116. */
  142117. get world(): NodeMaterialConnectionPoint;
  142118. /**
  142119. * Gets the output component
  142120. */
  142121. get output(): NodeMaterialConnectionPoint;
  142122. autoConfigure(material: NodeMaterial): void;
  142123. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  142124. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  142125. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142126. protected _buildBlock(state: NodeMaterialBuildState): this;
  142127. }
  142128. }
  142129. declare module BABYLON {
  142130. /**
  142131. * Block used to add support for instances
  142132. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  142133. */
  142134. export class InstancesBlock extends NodeMaterialBlock {
  142135. /**
  142136. * Creates a new InstancesBlock
  142137. * @param name defines the block name
  142138. */
  142139. constructor(name: string);
  142140. /**
  142141. * Gets the current class name
  142142. * @returns the class name
  142143. */
  142144. getClassName(): string;
  142145. /**
  142146. * Gets the first world row input component
  142147. */
  142148. get world0(): NodeMaterialConnectionPoint;
  142149. /**
  142150. * Gets the second world row input component
  142151. */
  142152. get world1(): NodeMaterialConnectionPoint;
  142153. /**
  142154. * Gets the third world row input component
  142155. */
  142156. get world2(): NodeMaterialConnectionPoint;
  142157. /**
  142158. * Gets the forth world row input component
  142159. */
  142160. get world3(): NodeMaterialConnectionPoint;
  142161. /**
  142162. * Gets the world input component
  142163. */
  142164. get world(): NodeMaterialConnectionPoint;
  142165. /**
  142166. * Gets the output component
  142167. */
  142168. get output(): NodeMaterialConnectionPoint;
  142169. /**
  142170. * Gets the isntanceID component
  142171. */
  142172. get instanceID(): NodeMaterialConnectionPoint;
  142173. autoConfigure(material: NodeMaterial): void;
  142174. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  142175. protected _buildBlock(state: NodeMaterialBuildState): this;
  142176. }
  142177. }
  142178. declare module BABYLON {
  142179. /**
  142180. * Block used to add morph targets support to vertex shader
  142181. */
  142182. export class MorphTargetsBlock extends NodeMaterialBlock {
  142183. private _repeatableContentAnchor;
  142184. /**
  142185. * Create a new MorphTargetsBlock
  142186. * @param name defines the block name
  142187. */
  142188. constructor(name: string);
  142189. /**
  142190. * Gets the current class name
  142191. * @returns the class name
  142192. */
  142193. getClassName(): string;
  142194. /**
  142195. * Gets the position input component
  142196. */
  142197. get position(): NodeMaterialConnectionPoint;
  142198. /**
  142199. * Gets the normal input component
  142200. */
  142201. get normal(): NodeMaterialConnectionPoint;
  142202. /**
  142203. * Gets the tangent input component
  142204. */
  142205. get tangent(): NodeMaterialConnectionPoint;
  142206. /**
  142207. * Gets the tangent input component
  142208. */
  142209. get uv(): NodeMaterialConnectionPoint;
  142210. /**
  142211. * Gets the position output component
  142212. */
  142213. get positionOutput(): NodeMaterialConnectionPoint;
  142214. /**
  142215. * Gets the normal output component
  142216. */
  142217. get normalOutput(): NodeMaterialConnectionPoint;
  142218. /**
  142219. * Gets the tangent output component
  142220. */
  142221. get tangentOutput(): NodeMaterialConnectionPoint;
  142222. /**
  142223. * Gets the tangent output component
  142224. */
  142225. get uvOutput(): NodeMaterialConnectionPoint;
  142226. initialize(state: NodeMaterialBuildState): void;
  142227. autoConfigure(material: NodeMaterial): void;
  142228. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142229. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  142230. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  142231. protected _buildBlock(state: NodeMaterialBuildState): this;
  142232. }
  142233. }
  142234. declare module BABYLON {
  142235. /**
  142236. * Block used to get data information from a light
  142237. */
  142238. export class LightInformationBlock extends NodeMaterialBlock {
  142239. private _lightDataUniformName;
  142240. private _lightColorUniformName;
  142241. private _lightTypeDefineName;
  142242. /**
  142243. * Gets or sets the light associated with this block
  142244. */
  142245. light: Nullable<Light>;
  142246. /**
  142247. * Creates a new LightInformationBlock
  142248. * @param name defines the block name
  142249. */
  142250. constructor(name: string);
  142251. /**
  142252. * Gets the current class name
  142253. * @returns the class name
  142254. */
  142255. getClassName(): string;
  142256. /**
  142257. * Gets the world position input component
  142258. */
  142259. get worldPosition(): NodeMaterialConnectionPoint;
  142260. /**
  142261. * Gets the direction output component
  142262. */
  142263. get direction(): NodeMaterialConnectionPoint;
  142264. /**
  142265. * Gets the direction output component
  142266. */
  142267. get color(): NodeMaterialConnectionPoint;
  142268. /**
  142269. * Gets the direction output component
  142270. */
  142271. get intensity(): NodeMaterialConnectionPoint;
  142272. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  142273. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142274. protected _buildBlock(state: NodeMaterialBuildState): this;
  142275. serialize(): any;
  142276. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  142277. }
  142278. }
  142279. declare module BABYLON {
  142280. /**
  142281. * Block used to add image processing support to fragment shader
  142282. */
  142283. export class ImageProcessingBlock extends NodeMaterialBlock {
  142284. /**
  142285. * Create a new ImageProcessingBlock
  142286. * @param name defines the block name
  142287. */
  142288. constructor(name: string);
  142289. /**
  142290. * Gets the current class name
  142291. * @returns the class name
  142292. */
  142293. getClassName(): string;
  142294. /**
  142295. * Gets the color input component
  142296. */
  142297. get color(): NodeMaterialConnectionPoint;
  142298. /**
  142299. * Gets the output component
  142300. */
  142301. get output(): NodeMaterialConnectionPoint;
  142302. /**
  142303. * Initialize the block and prepare the context for build
  142304. * @param state defines the state that will be used for the build
  142305. */
  142306. initialize(state: NodeMaterialBuildState): void;
  142307. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): boolean;
  142308. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142309. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  142310. protected _buildBlock(state: NodeMaterialBuildState): this;
  142311. }
  142312. }
  142313. declare module BABYLON {
  142314. /**
  142315. * Block used to pertub normals based on a normal map
  142316. */
  142317. export class PerturbNormalBlock extends NodeMaterialBlock {
  142318. private _tangentSpaceParameterName;
  142319. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  142320. invertX: boolean;
  142321. /** Gets or sets a boolean indicating that normal should be inverted on Y axis */
  142322. invertY: boolean;
  142323. /**
  142324. * Create a new PerturbNormalBlock
  142325. * @param name defines the block name
  142326. */
  142327. constructor(name: string);
  142328. /**
  142329. * Gets the current class name
  142330. * @returns the class name
  142331. */
  142332. getClassName(): string;
  142333. /**
  142334. * Gets the world position input component
  142335. */
  142336. get worldPosition(): NodeMaterialConnectionPoint;
  142337. /**
  142338. * Gets the world normal input component
  142339. */
  142340. get worldNormal(): NodeMaterialConnectionPoint;
  142341. /**
  142342. * Gets the world tangent input component
  142343. */
  142344. get worldTangent(): NodeMaterialConnectionPoint;
  142345. /**
  142346. * Gets the uv input component
  142347. */
  142348. get uv(): NodeMaterialConnectionPoint;
  142349. /**
  142350. * Gets the normal map color input component
  142351. */
  142352. get normalMapColor(): NodeMaterialConnectionPoint;
  142353. /**
  142354. * Gets the strength input component
  142355. */
  142356. get strength(): NodeMaterialConnectionPoint;
  142357. /**
  142358. * Gets the output component
  142359. */
  142360. get output(): NodeMaterialConnectionPoint;
  142361. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142362. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  142363. autoConfigure(material: NodeMaterial): void;
  142364. protected _buildBlock(state: NodeMaterialBuildState): this;
  142365. protected _dumpPropertiesCode(): string;
  142366. serialize(): any;
  142367. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  142368. }
  142369. }
  142370. declare module BABYLON {
  142371. /**
  142372. * Block used to discard a pixel if a value is smaller than a cutoff
  142373. */
  142374. export class DiscardBlock extends NodeMaterialBlock {
  142375. /**
  142376. * Create a new DiscardBlock
  142377. * @param name defines the block name
  142378. */
  142379. constructor(name: string);
  142380. /**
  142381. * Gets the current class name
  142382. * @returns the class name
  142383. */
  142384. getClassName(): string;
  142385. /**
  142386. * Gets the color input component
  142387. */
  142388. get value(): NodeMaterialConnectionPoint;
  142389. /**
  142390. * Gets the cutoff input component
  142391. */
  142392. get cutoff(): NodeMaterialConnectionPoint;
  142393. protected _buildBlock(state: NodeMaterialBuildState): this;
  142394. }
  142395. }
  142396. declare module BABYLON {
  142397. /**
  142398. * Block used to test if the fragment shader is front facing
  142399. */
  142400. export class FrontFacingBlock extends NodeMaterialBlock {
  142401. /**
  142402. * Creates a new FrontFacingBlock
  142403. * @param name defines the block name
  142404. */
  142405. constructor(name: string);
  142406. /**
  142407. * Gets the current class name
  142408. * @returns the class name
  142409. */
  142410. getClassName(): string;
  142411. /**
  142412. * Gets the output component
  142413. */
  142414. get output(): NodeMaterialConnectionPoint;
  142415. protected _buildBlock(state: NodeMaterialBuildState): this;
  142416. }
  142417. }
  142418. declare module BABYLON {
  142419. /**
  142420. * Block used to get the derivative value on x and y of a given input
  142421. */
  142422. export class DerivativeBlock extends NodeMaterialBlock {
  142423. /**
  142424. * Create a new DerivativeBlock
  142425. * @param name defines the block name
  142426. */
  142427. constructor(name: string);
  142428. /**
  142429. * Gets the current class name
  142430. * @returns the class name
  142431. */
  142432. getClassName(): string;
  142433. /**
  142434. * Gets the input component
  142435. */
  142436. get input(): NodeMaterialConnectionPoint;
  142437. /**
  142438. * Gets the derivative output on x
  142439. */
  142440. get dx(): NodeMaterialConnectionPoint;
  142441. /**
  142442. * Gets the derivative output on y
  142443. */
  142444. get dy(): NodeMaterialConnectionPoint;
  142445. protected _buildBlock(state: NodeMaterialBuildState): this;
  142446. }
  142447. }
  142448. declare module BABYLON {
  142449. /**
  142450. * Block used to make gl_FragCoord available
  142451. */
  142452. export class FragCoordBlock extends NodeMaterialBlock {
  142453. /**
  142454. * Creates a new FragCoordBlock
  142455. * @param name defines the block name
  142456. */
  142457. constructor(name: string);
  142458. /**
  142459. * Gets the current class name
  142460. * @returns the class name
  142461. */
  142462. getClassName(): string;
  142463. /**
  142464. * Gets the xy component
  142465. */
  142466. get xy(): NodeMaterialConnectionPoint;
  142467. /**
  142468. * Gets the xyz component
  142469. */
  142470. get xyz(): NodeMaterialConnectionPoint;
  142471. /**
  142472. * Gets the xyzw component
  142473. */
  142474. get xyzw(): NodeMaterialConnectionPoint;
  142475. /**
  142476. * Gets the x component
  142477. */
  142478. get x(): NodeMaterialConnectionPoint;
  142479. /**
  142480. * Gets the y component
  142481. */
  142482. get y(): NodeMaterialConnectionPoint;
  142483. /**
  142484. * Gets the z component
  142485. */
  142486. get z(): NodeMaterialConnectionPoint;
  142487. /**
  142488. * Gets the w component
  142489. */
  142490. get output(): NodeMaterialConnectionPoint;
  142491. protected writeOutputs(state: NodeMaterialBuildState): string;
  142492. protected _buildBlock(state: NodeMaterialBuildState): this;
  142493. }
  142494. }
  142495. declare module BABYLON {
  142496. /**
  142497. * Block used to get the screen sizes
  142498. */
  142499. export class ScreenSizeBlock extends NodeMaterialBlock {
  142500. private _varName;
  142501. private _scene;
  142502. /**
  142503. * Creates a new ScreenSizeBlock
  142504. * @param name defines the block name
  142505. */
  142506. constructor(name: string);
  142507. /**
  142508. * Gets the current class name
  142509. * @returns the class name
  142510. */
  142511. getClassName(): string;
  142512. /**
  142513. * Gets the xy component
  142514. */
  142515. get xy(): NodeMaterialConnectionPoint;
  142516. /**
  142517. * Gets the x component
  142518. */
  142519. get x(): NodeMaterialConnectionPoint;
  142520. /**
  142521. * Gets the y component
  142522. */
  142523. get y(): NodeMaterialConnectionPoint;
  142524. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  142525. protected writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  142526. protected _buildBlock(state: NodeMaterialBuildState): this;
  142527. }
  142528. }
  142529. declare module BABYLON {
  142530. /**
  142531. * Block used to add support for scene fog
  142532. */
  142533. export class FogBlock extends NodeMaterialBlock {
  142534. private _fogDistanceName;
  142535. private _fogParameters;
  142536. /**
  142537. * Create a new FogBlock
  142538. * @param name defines the block name
  142539. */
  142540. constructor(name: string);
  142541. /**
  142542. * Gets the current class name
  142543. * @returns the class name
  142544. */
  142545. getClassName(): string;
  142546. /**
  142547. * Gets the world position input component
  142548. */
  142549. get worldPosition(): NodeMaterialConnectionPoint;
  142550. /**
  142551. * Gets the view input component
  142552. */
  142553. get view(): NodeMaterialConnectionPoint;
  142554. /**
  142555. * Gets the color input component
  142556. */
  142557. get input(): NodeMaterialConnectionPoint;
  142558. /**
  142559. * Gets the fog color input component
  142560. */
  142561. get fogColor(): NodeMaterialConnectionPoint;
  142562. /**
  142563. * Gets the output component
  142564. */
  142565. get output(): NodeMaterialConnectionPoint;
  142566. autoConfigure(material: NodeMaterial): void;
  142567. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142568. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  142569. protected _buildBlock(state: NodeMaterialBuildState): this;
  142570. }
  142571. }
  142572. declare module BABYLON {
  142573. /**
  142574. * Block used to add light in the fragment shader
  142575. */
  142576. export class LightBlock extends NodeMaterialBlock {
  142577. private _lightId;
  142578. /**
  142579. * Gets or sets the light associated with this block
  142580. */
  142581. light: Nullable<Light>;
  142582. /**
  142583. * Create a new LightBlock
  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 world position input component
  142594. */
  142595. get worldPosition(): NodeMaterialConnectionPoint;
  142596. /**
  142597. * Gets the world normal input component
  142598. */
  142599. get worldNormal(): NodeMaterialConnectionPoint;
  142600. /**
  142601. * Gets the camera (or eye) position component
  142602. */
  142603. get cameraPosition(): NodeMaterialConnectionPoint;
  142604. /**
  142605. * Gets the glossiness component
  142606. */
  142607. get glossiness(): NodeMaterialConnectionPoint;
  142608. /**
  142609. * Gets the glossinness power component
  142610. */
  142611. get glossPower(): NodeMaterialConnectionPoint;
  142612. /**
  142613. * Gets the diffuse color component
  142614. */
  142615. get diffuseColor(): NodeMaterialConnectionPoint;
  142616. /**
  142617. * Gets the specular color component
  142618. */
  142619. get specularColor(): NodeMaterialConnectionPoint;
  142620. /**
  142621. * Gets the diffuse output component
  142622. */
  142623. get diffuseOutput(): NodeMaterialConnectionPoint;
  142624. /**
  142625. * Gets the specular output component
  142626. */
  142627. get specularOutput(): NodeMaterialConnectionPoint;
  142628. /**
  142629. * Gets the shadow output component
  142630. */
  142631. get shadow(): NodeMaterialConnectionPoint;
  142632. autoConfigure(material: NodeMaterial): void;
  142633. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142634. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  142635. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  142636. private _injectVertexCode;
  142637. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  142638. serialize(): any;
  142639. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  142640. }
  142641. }
  142642. declare module BABYLON {
  142643. /**
  142644. * Block used to read a reflection texture from a sampler
  142645. */
  142646. export class ReflectionTextureBlock extends ReflectionTextureBaseBlock {
  142647. /**
  142648. * Create a new ReflectionTextureBlock
  142649. * @param name defines the block name
  142650. */
  142651. constructor(name: string);
  142652. /**
  142653. * Gets the current class name
  142654. * @returns the class name
  142655. */
  142656. getClassName(): string;
  142657. /**
  142658. * Gets the world position input component
  142659. */
  142660. get position(): NodeMaterialConnectionPoint;
  142661. /**
  142662. * Gets the world position input component
  142663. */
  142664. get worldPosition(): NodeMaterialConnectionPoint;
  142665. /**
  142666. * Gets the world normal input component
  142667. */
  142668. get worldNormal(): NodeMaterialConnectionPoint;
  142669. /**
  142670. * Gets the world input component
  142671. */
  142672. get world(): NodeMaterialConnectionPoint;
  142673. /**
  142674. * Gets the camera (or eye) position component
  142675. */
  142676. get cameraPosition(): NodeMaterialConnectionPoint;
  142677. /**
  142678. * Gets the view input component
  142679. */
  142680. get view(): NodeMaterialConnectionPoint;
  142681. /**
  142682. * Gets the rgb output component
  142683. */
  142684. get rgb(): NodeMaterialConnectionPoint;
  142685. /**
  142686. * Gets the rgba output component
  142687. */
  142688. get rgba(): NodeMaterialConnectionPoint;
  142689. /**
  142690. * Gets the r output component
  142691. */
  142692. get r(): NodeMaterialConnectionPoint;
  142693. /**
  142694. * Gets the g output component
  142695. */
  142696. get g(): NodeMaterialConnectionPoint;
  142697. /**
  142698. * Gets the b output component
  142699. */
  142700. get b(): NodeMaterialConnectionPoint;
  142701. /**
  142702. * Gets the a output component
  142703. */
  142704. get a(): NodeMaterialConnectionPoint;
  142705. autoConfigure(material: NodeMaterial): void;
  142706. protected _buildBlock(state: NodeMaterialBuildState): this;
  142707. }
  142708. }
  142709. declare module BABYLON {
  142710. /**
  142711. * Block used to add 2 vectors
  142712. */
  142713. export class AddBlock extends NodeMaterialBlock {
  142714. /**
  142715. * Creates a new AddBlock
  142716. * @param name defines the block name
  142717. */
  142718. constructor(name: string);
  142719. /**
  142720. * Gets the current class name
  142721. * @returns the class name
  142722. */
  142723. getClassName(): string;
  142724. /**
  142725. * Gets the left operand input component
  142726. */
  142727. get left(): NodeMaterialConnectionPoint;
  142728. /**
  142729. * Gets the right operand input component
  142730. */
  142731. get right(): NodeMaterialConnectionPoint;
  142732. /**
  142733. * Gets the output component
  142734. */
  142735. get output(): NodeMaterialConnectionPoint;
  142736. protected _buildBlock(state: NodeMaterialBuildState): this;
  142737. }
  142738. }
  142739. declare module BABYLON {
  142740. /**
  142741. * Block used to scale a vector by a float
  142742. */
  142743. export class ScaleBlock extends NodeMaterialBlock {
  142744. /**
  142745. * Creates a new ScaleBlock
  142746. * @param name defines the block name
  142747. */
  142748. constructor(name: string);
  142749. /**
  142750. * Gets the current class name
  142751. * @returns the class name
  142752. */
  142753. getClassName(): string;
  142754. /**
  142755. * Gets the input component
  142756. */
  142757. get input(): NodeMaterialConnectionPoint;
  142758. /**
  142759. * Gets the factor input component
  142760. */
  142761. get factor(): NodeMaterialConnectionPoint;
  142762. /**
  142763. * Gets the output component
  142764. */
  142765. get output(): NodeMaterialConnectionPoint;
  142766. protected _buildBlock(state: NodeMaterialBuildState): this;
  142767. }
  142768. }
  142769. declare module BABYLON {
  142770. /**
  142771. * Block used to clamp a float
  142772. */
  142773. export class ClampBlock extends NodeMaterialBlock {
  142774. /** Gets or sets the minimum range */
  142775. minimum: number;
  142776. /** Gets or sets the maximum range */
  142777. maximum: number;
  142778. /**
  142779. * Creates a new ClampBlock
  142780. * @param name defines the block name
  142781. */
  142782. constructor(name: string);
  142783. /**
  142784. * Gets the current class name
  142785. * @returns the class name
  142786. */
  142787. getClassName(): string;
  142788. /**
  142789. * Gets the value input component
  142790. */
  142791. get value(): NodeMaterialConnectionPoint;
  142792. /**
  142793. * Gets the output component
  142794. */
  142795. get output(): NodeMaterialConnectionPoint;
  142796. protected _buildBlock(state: NodeMaterialBuildState): this;
  142797. protected _dumpPropertiesCode(): string;
  142798. serialize(): any;
  142799. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  142800. }
  142801. }
  142802. declare module BABYLON {
  142803. /**
  142804. * Block used to apply a cross product between 2 vectors
  142805. */
  142806. export class CrossBlock extends NodeMaterialBlock {
  142807. /**
  142808. * Creates a new CrossBlock
  142809. * @param name defines the block name
  142810. */
  142811. constructor(name: string);
  142812. /**
  142813. * Gets the current class name
  142814. * @returns the class name
  142815. */
  142816. getClassName(): string;
  142817. /**
  142818. * Gets the left operand input component
  142819. */
  142820. get left(): NodeMaterialConnectionPoint;
  142821. /**
  142822. * Gets the right operand input component
  142823. */
  142824. get right(): NodeMaterialConnectionPoint;
  142825. /**
  142826. * Gets the output component
  142827. */
  142828. get output(): NodeMaterialConnectionPoint;
  142829. protected _buildBlock(state: NodeMaterialBuildState): this;
  142830. }
  142831. }
  142832. declare module BABYLON {
  142833. /**
  142834. * Block used to apply a dot product between 2 vectors
  142835. */
  142836. export class DotBlock extends NodeMaterialBlock {
  142837. /**
  142838. * Creates a new DotBlock
  142839. * @param name defines the block name
  142840. */
  142841. constructor(name: string);
  142842. /**
  142843. * Gets the current class name
  142844. * @returns the class name
  142845. */
  142846. getClassName(): string;
  142847. /**
  142848. * Gets the left operand input component
  142849. */
  142850. get left(): NodeMaterialConnectionPoint;
  142851. /**
  142852. * Gets the right operand input component
  142853. */
  142854. get right(): NodeMaterialConnectionPoint;
  142855. /**
  142856. * Gets the output component
  142857. */
  142858. get output(): NodeMaterialConnectionPoint;
  142859. protected _buildBlock(state: NodeMaterialBuildState): this;
  142860. }
  142861. }
  142862. declare module BABYLON {
  142863. /**
  142864. * Block used to normalize a vector
  142865. */
  142866. export class NormalizeBlock extends NodeMaterialBlock {
  142867. /**
  142868. * Creates a new NormalizeBlock
  142869. * @param name defines the block name
  142870. */
  142871. constructor(name: string);
  142872. /**
  142873. * Gets the current class name
  142874. * @returns the class name
  142875. */
  142876. getClassName(): string;
  142877. /**
  142878. * Gets the input component
  142879. */
  142880. get input(): NodeMaterialConnectionPoint;
  142881. /**
  142882. * Gets the output component
  142883. */
  142884. get output(): NodeMaterialConnectionPoint;
  142885. protected _buildBlock(state: NodeMaterialBuildState): this;
  142886. }
  142887. }
  142888. declare module BABYLON {
  142889. /**
  142890. * Operations supported by the Trigonometry block
  142891. */
  142892. export enum TrigonometryBlockOperations {
  142893. /** Cos */
  142894. Cos = 0,
  142895. /** Sin */
  142896. Sin = 1,
  142897. /** Abs */
  142898. Abs = 2,
  142899. /** Exp */
  142900. Exp = 3,
  142901. /** Exp2 */
  142902. Exp2 = 4,
  142903. /** Round */
  142904. Round = 5,
  142905. /** Floor */
  142906. Floor = 6,
  142907. /** Ceiling */
  142908. Ceiling = 7,
  142909. /** Square root */
  142910. Sqrt = 8,
  142911. /** Log */
  142912. Log = 9,
  142913. /** Tangent */
  142914. Tan = 10,
  142915. /** Arc tangent */
  142916. ArcTan = 11,
  142917. /** Arc cosinus */
  142918. ArcCos = 12,
  142919. /** Arc sinus */
  142920. ArcSin = 13,
  142921. /** Fraction */
  142922. Fract = 14,
  142923. /** Sign */
  142924. Sign = 15,
  142925. /** To radians (from degrees) */
  142926. Radians = 16,
  142927. /** To degrees (from radians) */
  142928. Degrees = 17
  142929. }
  142930. /**
  142931. * Block used to apply trigonometry operation to floats
  142932. */
  142933. export class TrigonometryBlock extends NodeMaterialBlock {
  142934. /**
  142935. * Gets or sets the operation applied by the block
  142936. */
  142937. operation: TrigonometryBlockOperations;
  142938. /**
  142939. * Creates a new TrigonometryBlock
  142940. * @param name defines the block name
  142941. */
  142942. constructor(name: string);
  142943. /**
  142944. * Gets the current class name
  142945. * @returns the class name
  142946. */
  142947. getClassName(): string;
  142948. /**
  142949. * Gets the input component
  142950. */
  142951. get input(): NodeMaterialConnectionPoint;
  142952. /**
  142953. * Gets the output component
  142954. */
  142955. get output(): NodeMaterialConnectionPoint;
  142956. protected _buildBlock(state: NodeMaterialBuildState): this;
  142957. serialize(): any;
  142958. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  142959. protected _dumpPropertiesCode(): string;
  142960. }
  142961. }
  142962. declare module BABYLON {
  142963. /**
  142964. * Block used to create a Color3/4 out of individual inputs (one for each component)
  142965. */
  142966. export class ColorMergerBlock extends NodeMaterialBlock {
  142967. /**
  142968. * Create a new ColorMergerBlock
  142969. * @param name defines the block name
  142970. */
  142971. constructor(name: string);
  142972. /**
  142973. * Gets the current class name
  142974. * @returns the class name
  142975. */
  142976. getClassName(): string;
  142977. /**
  142978. * Gets the rgb component (input)
  142979. */
  142980. get rgbIn(): NodeMaterialConnectionPoint;
  142981. /**
  142982. * Gets the r component (input)
  142983. */
  142984. get r(): NodeMaterialConnectionPoint;
  142985. /**
  142986. * Gets the g component (input)
  142987. */
  142988. get g(): NodeMaterialConnectionPoint;
  142989. /**
  142990. * Gets the b component (input)
  142991. */
  142992. get b(): NodeMaterialConnectionPoint;
  142993. /**
  142994. * Gets the a component (input)
  142995. */
  142996. get a(): NodeMaterialConnectionPoint;
  142997. /**
  142998. * Gets the rgba component (output)
  142999. */
  143000. get rgba(): NodeMaterialConnectionPoint;
  143001. /**
  143002. * Gets the rgb component (output)
  143003. */
  143004. get rgbOut(): NodeMaterialConnectionPoint;
  143005. /**
  143006. * Gets the rgb component (output)
  143007. * @deprecated Please use rgbOut instead.
  143008. */
  143009. get rgb(): NodeMaterialConnectionPoint;
  143010. protected _buildBlock(state: NodeMaterialBuildState): this;
  143011. }
  143012. }
  143013. declare module BABYLON {
  143014. /**
  143015. * Block used to expand a Vector3/4 into 4 outputs (one for each component)
  143016. */
  143017. export class VectorSplitterBlock extends NodeMaterialBlock {
  143018. /**
  143019. * Create a new VectorSplitterBlock
  143020. * @param name defines the block name
  143021. */
  143022. constructor(name: string);
  143023. /**
  143024. * Gets the current class name
  143025. * @returns the class name
  143026. */
  143027. getClassName(): string;
  143028. /**
  143029. * Gets the xyzw component (input)
  143030. */
  143031. get xyzw(): NodeMaterialConnectionPoint;
  143032. /**
  143033. * Gets the xyz component (input)
  143034. */
  143035. get xyzIn(): NodeMaterialConnectionPoint;
  143036. /**
  143037. * Gets the xy component (input)
  143038. */
  143039. get xyIn(): NodeMaterialConnectionPoint;
  143040. /**
  143041. * Gets the xyz component (output)
  143042. */
  143043. get xyzOut(): NodeMaterialConnectionPoint;
  143044. /**
  143045. * Gets the xy component (output)
  143046. */
  143047. get xyOut(): NodeMaterialConnectionPoint;
  143048. /**
  143049. * Gets the x component (output)
  143050. */
  143051. get x(): NodeMaterialConnectionPoint;
  143052. /**
  143053. * Gets the y component (output)
  143054. */
  143055. get y(): NodeMaterialConnectionPoint;
  143056. /**
  143057. * Gets the z component (output)
  143058. */
  143059. get z(): NodeMaterialConnectionPoint;
  143060. /**
  143061. * Gets the w component (output)
  143062. */
  143063. get w(): NodeMaterialConnectionPoint;
  143064. protected _inputRename(name: string): string;
  143065. protected _outputRename(name: string): string;
  143066. protected _buildBlock(state: NodeMaterialBuildState): this;
  143067. }
  143068. }
  143069. declare module BABYLON {
  143070. /**
  143071. * Block used to lerp between 2 values
  143072. */
  143073. export class LerpBlock extends NodeMaterialBlock {
  143074. /**
  143075. * Creates a new LerpBlock
  143076. * @param name defines the block name
  143077. */
  143078. constructor(name: string);
  143079. /**
  143080. * Gets the current class name
  143081. * @returns the class name
  143082. */
  143083. getClassName(): string;
  143084. /**
  143085. * Gets the left operand input component
  143086. */
  143087. get left(): NodeMaterialConnectionPoint;
  143088. /**
  143089. * Gets the right operand input component
  143090. */
  143091. get right(): NodeMaterialConnectionPoint;
  143092. /**
  143093. * Gets the gradient operand input component
  143094. */
  143095. get gradient(): NodeMaterialConnectionPoint;
  143096. /**
  143097. * Gets the output component
  143098. */
  143099. get output(): NodeMaterialConnectionPoint;
  143100. protected _buildBlock(state: NodeMaterialBuildState): this;
  143101. }
  143102. }
  143103. declare module BABYLON {
  143104. /**
  143105. * Block used to divide 2 vectors
  143106. */
  143107. export class DivideBlock extends NodeMaterialBlock {
  143108. /**
  143109. * Creates a new DivideBlock
  143110. * @param name defines the block name
  143111. */
  143112. constructor(name: string);
  143113. /**
  143114. * Gets the current class name
  143115. * @returns the class name
  143116. */
  143117. getClassName(): string;
  143118. /**
  143119. * Gets the left operand input component
  143120. */
  143121. get left(): NodeMaterialConnectionPoint;
  143122. /**
  143123. * Gets the right operand input component
  143124. */
  143125. get right(): NodeMaterialConnectionPoint;
  143126. /**
  143127. * Gets the output component
  143128. */
  143129. get output(): NodeMaterialConnectionPoint;
  143130. protected _buildBlock(state: NodeMaterialBuildState): this;
  143131. }
  143132. }
  143133. declare module BABYLON {
  143134. /**
  143135. * Block used to subtract 2 vectors
  143136. */
  143137. export class SubtractBlock extends NodeMaterialBlock {
  143138. /**
  143139. * Creates a new SubtractBlock
  143140. * @param name defines the block name
  143141. */
  143142. constructor(name: string);
  143143. /**
  143144. * Gets the current class name
  143145. * @returns the class name
  143146. */
  143147. getClassName(): string;
  143148. /**
  143149. * Gets the left operand input component
  143150. */
  143151. get left(): NodeMaterialConnectionPoint;
  143152. /**
  143153. * Gets the right operand input component
  143154. */
  143155. get right(): NodeMaterialConnectionPoint;
  143156. /**
  143157. * Gets the output component
  143158. */
  143159. get output(): NodeMaterialConnectionPoint;
  143160. protected _buildBlock(state: NodeMaterialBuildState): this;
  143161. }
  143162. }
  143163. declare module BABYLON {
  143164. /**
  143165. * Block used to step a value
  143166. */
  143167. export class StepBlock extends NodeMaterialBlock {
  143168. /**
  143169. * Creates a new StepBlock
  143170. * @param name defines the block name
  143171. */
  143172. constructor(name: string);
  143173. /**
  143174. * Gets the current class name
  143175. * @returns the class name
  143176. */
  143177. getClassName(): string;
  143178. /**
  143179. * Gets the value operand input component
  143180. */
  143181. get value(): NodeMaterialConnectionPoint;
  143182. /**
  143183. * Gets the edge operand input component
  143184. */
  143185. get edge(): NodeMaterialConnectionPoint;
  143186. /**
  143187. * Gets the output component
  143188. */
  143189. get output(): NodeMaterialConnectionPoint;
  143190. protected _buildBlock(state: NodeMaterialBuildState): this;
  143191. }
  143192. }
  143193. declare module BABYLON {
  143194. /**
  143195. * Block used to get the opposite (1 - x) of a value
  143196. */
  143197. export class OneMinusBlock extends NodeMaterialBlock {
  143198. /**
  143199. * Creates a new OneMinusBlock
  143200. * @param name defines the block name
  143201. */
  143202. constructor(name: string);
  143203. /**
  143204. * Gets the current class name
  143205. * @returns the class name
  143206. */
  143207. getClassName(): string;
  143208. /**
  143209. * Gets the input component
  143210. */
  143211. get input(): NodeMaterialConnectionPoint;
  143212. /**
  143213. * Gets the output component
  143214. */
  143215. get output(): NodeMaterialConnectionPoint;
  143216. protected _buildBlock(state: NodeMaterialBuildState): this;
  143217. }
  143218. }
  143219. declare module BABYLON {
  143220. /**
  143221. * Block used to get the view direction
  143222. */
  143223. export class ViewDirectionBlock extends NodeMaterialBlock {
  143224. /**
  143225. * Creates a new ViewDirectionBlock
  143226. * @param name defines the block name
  143227. */
  143228. constructor(name: string);
  143229. /**
  143230. * Gets the current class name
  143231. * @returns the class name
  143232. */
  143233. getClassName(): string;
  143234. /**
  143235. * Gets the world position component
  143236. */
  143237. get worldPosition(): NodeMaterialConnectionPoint;
  143238. /**
  143239. * Gets the camera position component
  143240. */
  143241. get cameraPosition(): NodeMaterialConnectionPoint;
  143242. /**
  143243. * Gets the output component
  143244. */
  143245. get output(): NodeMaterialConnectionPoint;
  143246. autoConfigure(material: NodeMaterial): void;
  143247. protected _buildBlock(state: NodeMaterialBuildState): this;
  143248. }
  143249. }
  143250. declare module BABYLON {
  143251. /**
  143252. * Block used to compute fresnel value
  143253. */
  143254. export class FresnelBlock extends NodeMaterialBlock {
  143255. /**
  143256. * Create a new FresnelBlock
  143257. * @param name defines the block name
  143258. */
  143259. constructor(name: string);
  143260. /**
  143261. * Gets the current class name
  143262. * @returns the class name
  143263. */
  143264. getClassName(): string;
  143265. /**
  143266. * Gets the world normal input component
  143267. */
  143268. get worldNormal(): NodeMaterialConnectionPoint;
  143269. /**
  143270. * Gets the view direction input component
  143271. */
  143272. get viewDirection(): NodeMaterialConnectionPoint;
  143273. /**
  143274. * Gets the bias input component
  143275. */
  143276. get bias(): NodeMaterialConnectionPoint;
  143277. /**
  143278. * Gets the camera (or eye) position component
  143279. */
  143280. get power(): NodeMaterialConnectionPoint;
  143281. /**
  143282. * Gets the fresnel output component
  143283. */
  143284. get fresnel(): NodeMaterialConnectionPoint;
  143285. autoConfigure(material: NodeMaterial): void;
  143286. protected _buildBlock(state: NodeMaterialBuildState): this;
  143287. }
  143288. }
  143289. declare module BABYLON {
  143290. /**
  143291. * Block used to get the max of 2 values
  143292. */
  143293. export class MaxBlock extends NodeMaterialBlock {
  143294. /**
  143295. * Creates a new MaxBlock
  143296. * @param name defines the block name
  143297. */
  143298. constructor(name: string);
  143299. /**
  143300. * Gets the current class name
  143301. * @returns the class name
  143302. */
  143303. getClassName(): string;
  143304. /**
  143305. * Gets the left operand input component
  143306. */
  143307. get left(): NodeMaterialConnectionPoint;
  143308. /**
  143309. * Gets the right operand input component
  143310. */
  143311. get right(): NodeMaterialConnectionPoint;
  143312. /**
  143313. * Gets the output component
  143314. */
  143315. get output(): NodeMaterialConnectionPoint;
  143316. protected _buildBlock(state: NodeMaterialBuildState): this;
  143317. }
  143318. }
  143319. declare module BABYLON {
  143320. /**
  143321. * Block used to get the min of 2 values
  143322. */
  143323. export class MinBlock extends NodeMaterialBlock {
  143324. /**
  143325. * Creates a new MinBlock
  143326. * @param name defines the block name
  143327. */
  143328. constructor(name: string);
  143329. /**
  143330. * Gets the current class name
  143331. * @returns the class name
  143332. */
  143333. getClassName(): string;
  143334. /**
  143335. * Gets the left operand input component
  143336. */
  143337. get left(): NodeMaterialConnectionPoint;
  143338. /**
  143339. * Gets the right operand input component
  143340. */
  143341. get right(): NodeMaterialConnectionPoint;
  143342. /**
  143343. * Gets the output component
  143344. */
  143345. get output(): NodeMaterialConnectionPoint;
  143346. protected _buildBlock(state: NodeMaterialBuildState): this;
  143347. }
  143348. }
  143349. declare module BABYLON {
  143350. /**
  143351. * Block used to get the distance between 2 values
  143352. */
  143353. export class DistanceBlock extends NodeMaterialBlock {
  143354. /**
  143355. * Creates a new DistanceBlock
  143356. * @param name defines the block name
  143357. */
  143358. constructor(name: string);
  143359. /**
  143360. * Gets the current class name
  143361. * @returns the class name
  143362. */
  143363. getClassName(): string;
  143364. /**
  143365. * Gets the left operand input component
  143366. */
  143367. get left(): NodeMaterialConnectionPoint;
  143368. /**
  143369. * Gets the right operand input component
  143370. */
  143371. get right(): NodeMaterialConnectionPoint;
  143372. /**
  143373. * Gets the output component
  143374. */
  143375. get output(): NodeMaterialConnectionPoint;
  143376. protected _buildBlock(state: NodeMaterialBuildState): this;
  143377. }
  143378. }
  143379. declare module BABYLON {
  143380. /**
  143381. * Block used to get the length of a vector
  143382. */
  143383. export class LengthBlock extends NodeMaterialBlock {
  143384. /**
  143385. * Creates a new LengthBlock
  143386. * @param name defines the block name
  143387. */
  143388. constructor(name: string);
  143389. /**
  143390. * Gets the current class name
  143391. * @returns the class name
  143392. */
  143393. getClassName(): string;
  143394. /**
  143395. * Gets the value input component
  143396. */
  143397. get value(): NodeMaterialConnectionPoint;
  143398. /**
  143399. * Gets the output component
  143400. */
  143401. get output(): NodeMaterialConnectionPoint;
  143402. protected _buildBlock(state: NodeMaterialBuildState): this;
  143403. }
  143404. }
  143405. declare module BABYLON {
  143406. /**
  143407. * Block used to get negative version of a value (i.e. x * -1)
  143408. */
  143409. export class NegateBlock extends NodeMaterialBlock {
  143410. /**
  143411. * Creates a new NegateBlock
  143412. * @param name defines the block name
  143413. */
  143414. constructor(name: string);
  143415. /**
  143416. * Gets the current class name
  143417. * @returns the class name
  143418. */
  143419. getClassName(): string;
  143420. /**
  143421. * Gets the value input component
  143422. */
  143423. get value(): NodeMaterialConnectionPoint;
  143424. /**
  143425. * Gets the output component
  143426. */
  143427. get output(): NodeMaterialConnectionPoint;
  143428. protected _buildBlock(state: NodeMaterialBuildState): this;
  143429. }
  143430. }
  143431. declare module BABYLON {
  143432. /**
  143433. * Block used to get the value of the first parameter raised to the power of the second
  143434. */
  143435. export class PowBlock extends NodeMaterialBlock {
  143436. /**
  143437. * Creates a new PowBlock
  143438. * @param name defines the block name
  143439. */
  143440. constructor(name: string);
  143441. /**
  143442. * Gets the current class name
  143443. * @returns the class name
  143444. */
  143445. getClassName(): string;
  143446. /**
  143447. * Gets the value operand input component
  143448. */
  143449. get value(): NodeMaterialConnectionPoint;
  143450. /**
  143451. * Gets the power operand input component
  143452. */
  143453. get power(): NodeMaterialConnectionPoint;
  143454. /**
  143455. * Gets the output component
  143456. */
  143457. get output(): NodeMaterialConnectionPoint;
  143458. protected _buildBlock(state: NodeMaterialBuildState): this;
  143459. }
  143460. }
  143461. declare module BABYLON {
  143462. /**
  143463. * Block used to get a random number
  143464. */
  143465. export class RandomNumberBlock extends NodeMaterialBlock {
  143466. /**
  143467. * Creates a new RandomNumberBlock
  143468. * @param name defines the block name
  143469. */
  143470. constructor(name: string);
  143471. /**
  143472. * Gets the current class name
  143473. * @returns the class name
  143474. */
  143475. getClassName(): string;
  143476. /**
  143477. * Gets the seed input component
  143478. */
  143479. get seed(): NodeMaterialConnectionPoint;
  143480. /**
  143481. * Gets the output component
  143482. */
  143483. get output(): NodeMaterialConnectionPoint;
  143484. protected _buildBlock(state: NodeMaterialBuildState): this;
  143485. }
  143486. }
  143487. declare module BABYLON {
  143488. /**
  143489. * Block used to compute arc tangent of 2 values
  143490. */
  143491. export class ArcTan2Block extends NodeMaterialBlock {
  143492. /**
  143493. * Creates a new ArcTan2Block
  143494. * @param name defines the block name
  143495. */
  143496. constructor(name: string);
  143497. /**
  143498. * Gets the current class name
  143499. * @returns the class name
  143500. */
  143501. getClassName(): string;
  143502. /**
  143503. * Gets the x operand input component
  143504. */
  143505. get x(): NodeMaterialConnectionPoint;
  143506. /**
  143507. * Gets the y operand input component
  143508. */
  143509. get y(): NodeMaterialConnectionPoint;
  143510. /**
  143511. * Gets the output component
  143512. */
  143513. get output(): NodeMaterialConnectionPoint;
  143514. protected _buildBlock(state: NodeMaterialBuildState): this;
  143515. }
  143516. }
  143517. declare module BABYLON {
  143518. /**
  143519. * Block used to smooth step a value
  143520. */
  143521. export class SmoothStepBlock extends NodeMaterialBlock {
  143522. /**
  143523. * Creates a new SmoothStepBlock
  143524. * @param name defines the block name
  143525. */
  143526. constructor(name: string);
  143527. /**
  143528. * Gets the current class name
  143529. * @returns the class name
  143530. */
  143531. getClassName(): string;
  143532. /**
  143533. * Gets the value operand input component
  143534. */
  143535. get value(): NodeMaterialConnectionPoint;
  143536. /**
  143537. * Gets the first edge operand input component
  143538. */
  143539. get edge0(): NodeMaterialConnectionPoint;
  143540. /**
  143541. * Gets the second edge operand input component
  143542. */
  143543. get edge1(): NodeMaterialConnectionPoint;
  143544. /**
  143545. * Gets the output component
  143546. */
  143547. get output(): NodeMaterialConnectionPoint;
  143548. protected _buildBlock(state: NodeMaterialBuildState): this;
  143549. }
  143550. }
  143551. declare module BABYLON {
  143552. /**
  143553. * Block used to get the reciprocal (1 / x) of a value
  143554. */
  143555. export class ReciprocalBlock extends NodeMaterialBlock {
  143556. /**
  143557. * Creates a new ReciprocalBlock
  143558. * @param name defines the block name
  143559. */
  143560. constructor(name: string);
  143561. /**
  143562. * Gets the current class name
  143563. * @returns the class name
  143564. */
  143565. getClassName(): string;
  143566. /**
  143567. * Gets the input component
  143568. */
  143569. get input(): NodeMaterialConnectionPoint;
  143570. /**
  143571. * Gets the output component
  143572. */
  143573. get output(): NodeMaterialConnectionPoint;
  143574. protected _buildBlock(state: NodeMaterialBuildState): this;
  143575. }
  143576. }
  143577. declare module BABYLON {
  143578. /**
  143579. * Block used to replace a color by another one
  143580. */
  143581. export class ReplaceColorBlock extends NodeMaterialBlock {
  143582. /**
  143583. * Creates a new ReplaceColorBlock
  143584. * @param name defines the block name
  143585. */
  143586. constructor(name: string);
  143587. /**
  143588. * Gets the current class name
  143589. * @returns the class name
  143590. */
  143591. getClassName(): string;
  143592. /**
  143593. * Gets the value input component
  143594. */
  143595. get value(): NodeMaterialConnectionPoint;
  143596. /**
  143597. * Gets the reference input component
  143598. */
  143599. get reference(): NodeMaterialConnectionPoint;
  143600. /**
  143601. * Gets the distance input component
  143602. */
  143603. get distance(): NodeMaterialConnectionPoint;
  143604. /**
  143605. * Gets the replacement input component
  143606. */
  143607. get replacement(): NodeMaterialConnectionPoint;
  143608. /**
  143609. * Gets the output component
  143610. */
  143611. get output(): NodeMaterialConnectionPoint;
  143612. protected _buildBlock(state: NodeMaterialBuildState): this;
  143613. }
  143614. }
  143615. declare module BABYLON {
  143616. /**
  143617. * Block used to posterize a value
  143618. * @see https://en.wikipedia.org/wiki/Posterization
  143619. */
  143620. export class PosterizeBlock extends NodeMaterialBlock {
  143621. /**
  143622. * Creates a new PosterizeBlock
  143623. * @param name defines the block name
  143624. */
  143625. constructor(name: string);
  143626. /**
  143627. * Gets the current class name
  143628. * @returns the class name
  143629. */
  143630. getClassName(): string;
  143631. /**
  143632. * Gets the value input component
  143633. */
  143634. get value(): NodeMaterialConnectionPoint;
  143635. /**
  143636. * Gets the steps input component
  143637. */
  143638. get steps(): NodeMaterialConnectionPoint;
  143639. /**
  143640. * Gets the output component
  143641. */
  143642. get output(): NodeMaterialConnectionPoint;
  143643. protected _buildBlock(state: NodeMaterialBuildState): this;
  143644. }
  143645. }
  143646. declare module BABYLON {
  143647. /**
  143648. * Operations supported by the Wave block
  143649. */
  143650. export enum WaveBlockKind {
  143651. /** SawTooth */
  143652. SawTooth = 0,
  143653. /** Square */
  143654. Square = 1,
  143655. /** Triangle */
  143656. Triangle = 2
  143657. }
  143658. /**
  143659. * Block used to apply wave operation to floats
  143660. */
  143661. export class WaveBlock extends NodeMaterialBlock {
  143662. /**
  143663. * Gets or sets the kibnd of wave to be applied by the block
  143664. */
  143665. kind: WaveBlockKind;
  143666. /**
  143667. * Creates a new WaveBlock
  143668. * @param name defines the block name
  143669. */
  143670. constructor(name: string);
  143671. /**
  143672. * Gets the current class name
  143673. * @returns the class name
  143674. */
  143675. getClassName(): string;
  143676. /**
  143677. * Gets the input component
  143678. */
  143679. get input(): NodeMaterialConnectionPoint;
  143680. /**
  143681. * Gets the output component
  143682. */
  143683. get output(): NodeMaterialConnectionPoint;
  143684. protected _buildBlock(state: NodeMaterialBuildState): this;
  143685. serialize(): any;
  143686. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143687. }
  143688. }
  143689. declare module BABYLON {
  143690. /**
  143691. * Class used to store a color step for the GradientBlock
  143692. */
  143693. export class GradientBlockColorStep {
  143694. /**
  143695. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  143696. */
  143697. step: number;
  143698. /**
  143699. * Gets or sets the color associated with this step
  143700. */
  143701. color: Color3;
  143702. /**
  143703. * Creates a new GradientBlockColorStep
  143704. * @param step defines a value indicating which step this color is associated with (between 0 and 1)
  143705. * @param color defines the color associated with this step
  143706. */
  143707. constructor(
  143708. /**
  143709. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  143710. */
  143711. step: number,
  143712. /**
  143713. * Gets or sets the color associated with this step
  143714. */
  143715. color: Color3);
  143716. }
  143717. /**
  143718. * Block used to return a color from a gradient based on an input value between 0 and 1
  143719. */
  143720. export class GradientBlock extends NodeMaterialBlock {
  143721. /**
  143722. * Gets or sets the list of color steps
  143723. */
  143724. colorSteps: GradientBlockColorStep[];
  143725. /**
  143726. * Creates a new GradientBlock
  143727. * @param name defines the block name
  143728. */
  143729. constructor(name: string);
  143730. /**
  143731. * Gets the current class name
  143732. * @returns the class name
  143733. */
  143734. getClassName(): string;
  143735. /**
  143736. * Gets the gradient input component
  143737. */
  143738. get gradient(): NodeMaterialConnectionPoint;
  143739. /**
  143740. * Gets the output component
  143741. */
  143742. get output(): NodeMaterialConnectionPoint;
  143743. private _writeColorConstant;
  143744. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  143745. serialize(): any;
  143746. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143747. protected _dumpPropertiesCode(): string;
  143748. }
  143749. }
  143750. declare module BABYLON {
  143751. /**
  143752. * Block used to normalize lerp between 2 values
  143753. */
  143754. export class NLerpBlock extends NodeMaterialBlock {
  143755. /**
  143756. * Creates a new NLerpBlock
  143757. * @param name defines the block name
  143758. */
  143759. constructor(name: string);
  143760. /**
  143761. * Gets the current class name
  143762. * @returns the class name
  143763. */
  143764. getClassName(): string;
  143765. /**
  143766. * Gets the left operand input component
  143767. */
  143768. get left(): NodeMaterialConnectionPoint;
  143769. /**
  143770. * Gets the right operand input component
  143771. */
  143772. get right(): NodeMaterialConnectionPoint;
  143773. /**
  143774. * Gets the gradient operand input component
  143775. */
  143776. get gradient(): NodeMaterialConnectionPoint;
  143777. /**
  143778. * Gets the output component
  143779. */
  143780. get output(): NodeMaterialConnectionPoint;
  143781. protected _buildBlock(state: NodeMaterialBuildState): this;
  143782. }
  143783. }
  143784. declare module BABYLON {
  143785. /**
  143786. * block used to Generate a Worley Noise 3D Noise Pattern
  143787. */
  143788. export class WorleyNoise3DBlock extends NodeMaterialBlock {
  143789. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  143790. manhattanDistance: boolean;
  143791. /**
  143792. * Creates a new WorleyNoise3DBlock
  143793. * @param name defines the block name
  143794. */
  143795. constructor(name: string);
  143796. /**
  143797. * Gets the current class name
  143798. * @returns the class name
  143799. */
  143800. getClassName(): string;
  143801. /**
  143802. * Gets the seed input component
  143803. */
  143804. get seed(): NodeMaterialConnectionPoint;
  143805. /**
  143806. * Gets the jitter input component
  143807. */
  143808. get jitter(): NodeMaterialConnectionPoint;
  143809. /**
  143810. * Gets the output component
  143811. */
  143812. get output(): NodeMaterialConnectionPoint;
  143813. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  143814. /**
  143815. * Exposes the properties to the UI?
  143816. */
  143817. protected _dumpPropertiesCode(): string;
  143818. /**
  143819. * Exposes the properties to the Seralize?
  143820. */
  143821. serialize(): any;
  143822. /**
  143823. * Exposes the properties to the deseralize?
  143824. */
  143825. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143826. }
  143827. }
  143828. declare module BABYLON {
  143829. /**
  143830. * block used to Generate a Simplex Perlin 3d Noise Pattern
  143831. */
  143832. export class SimplexPerlin3DBlock extends NodeMaterialBlock {
  143833. /**
  143834. * Creates a new SimplexPerlin3DBlock
  143835. * @param name defines the block name
  143836. */
  143837. constructor(name: string);
  143838. /**
  143839. * Gets the current class name
  143840. * @returns the class name
  143841. */
  143842. getClassName(): string;
  143843. /**
  143844. * Gets the seed operand input component
  143845. */
  143846. get seed(): NodeMaterialConnectionPoint;
  143847. /**
  143848. * Gets the output component
  143849. */
  143850. get output(): NodeMaterialConnectionPoint;
  143851. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  143852. }
  143853. }
  143854. declare module BABYLON {
  143855. /**
  143856. * Block used to blend normals
  143857. */
  143858. export class NormalBlendBlock extends NodeMaterialBlock {
  143859. /**
  143860. * Creates a new NormalBlendBlock
  143861. * @param name defines the block name
  143862. */
  143863. constructor(name: string);
  143864. /**
  143865. * Gets the current class name
  143866. * @returns the class name
  143867. */
  143868. getClassName(): string;
  143869. /**
  143870. * Gets the first input component
  143871. */
  143872. get normalMap0(): NodeMaterialConnectionPoint;
  143873. /**
  143874. * Gets the second input component
  143875. */
  143876. get normalMap1(): NodeMaterialConnectionPoint;
  143877. /**
  143878. * Gets the output component
  143879. */
  143880. get output(): NodeMaterialConnectionPoint;
  143881. protected _buildBlock(state: NodeMaterialBuildState): this;
  143882. }
  143883. }
  143884. declare module BABYLON {
  143885. /**
  143886. * Block used to rotate a 2d vector by a given angle
  143887. */
  143888. export class Rotate2dBlock extends NodeMaterialBlock {
  143889. /**
  143890. * Creates a new Rotate2dBlock
  143891. * @param name defines the block name
  143892. */
  143893. constructor(name: string);
  143894. /**
  143895. * Gets the current class name
  143896. * @returns the class name
  143897. */
  143898. getClassName(): string;
  143899. /**
  143900. * Gets the input vector
  143901. */
  143902. get input(): NodeMaterialConnectionPoint;
  143903. /**
  143904. * Gets the input angle
  143905. */
  143906. get angle(): NodeMaterialConnectionPoint;
  143907. /**
  143908. * Gets the output component
  143909. */
  143910. get output(): NodeMaterialConnectionPoint;
  143911. autoConfigure(material: NodeMaterial): void;
  143912. protected _buildBlock(state: NodeMaterialBuildState): this;
  143913. }
  143914. }
  143915. declare module BABYLON {
  143916. /**
  143917. * Block used to get the reflected vector from a direction and a normal
  143918. */
  143919. export class ReflectBlock extends NodeMaterialBlock {
  143920. /**
  143921. * Creates a new ReflectBlock
  143922. * @param name defines the block name
  143923. */
  143924. constructor(name: string);
  143925. /**
  143926. * Gets the current class name
  143927. * @returns the class name
  143928. */
  143929. getClassName(): string;
  143930. /**
  143931. * Gets the incident component
  143932. */
  143933. get incident(): NodeMaterialConnectionPoint;
  143934. /**
  143935. * Gets the normal component
  143936. */
  143937. get normal(): NodeMaterialConnectionPoint;
  143938. /**
  143939. * Gets the output component
  143940. */
  143941. get output(): NodeMaterialConnectionPoint;
  143942. protected _buildBlock(state: NodeMaterialBuildState): this;
  143943. }
  143944. }
  143945. declare module BABYLON {
  143946. /**
  143947. * Block used to get the refracted vector from a direction and a normal
  143948. */
  143949. export class RefractBlock extends NodeMaterialBlock {
  143950. /**
  143951. * Creates a new RefractBlock
  143952. * @param name defines the block name
  143953. */
  143954. constructor(name: string);
  143955. /**
  143956. * Gets the current class name
  143957. * @returns the class name
  143958. */
  143959. getClassName(): string;
  143960. /**
  143961. * Gets the incident component
  143962. */
  143963. get incident(): NodeMaterialConnectionPoint;
  143964. /**
  143965. * Gets the normal component
  143966. */
  143967. get normal(): NodeMaterialConnectionPoint;
  143968. /**
  143969. * Gets the index of refraction component
  143970. */
  143971. get ior(): NodeMaterialConnectionPoint;
  143972. /**
  143973. * Gets the output component
  143974. */
  143975. get output(): NodeMaterialConnectionPoint;
  143976. protected _buildBlock(state: NodeMaterialBuildState): this;
  143977. }
  143978. }
  143979. declare module BABYLON {
  143980. /**
  143981. * Block used to desaturate a color
  143982. */
  143983. export class DesaturateBlock extends NodeMaterialBlock {
  143984. /**
  143985. * Creates a new DesaturateBlock
  143986. * @param name defines the block name
  143987. */
  143988. constructor(name: string);
  143989. /**
  143990. * Gets the current class name
  143991. * @returns the class name
  143992. */
  143993. getClassName(): string;
  143994. /**
  143995. * Gets the color operand input component
  143996. */
  143997. get color(): NodeMaterialConnectionPoint;
  143998. /**
  143999. * Gets the level operand input component
  144000. */
  144001. get level(): NodeMaterialConnectionPoint;
  144002. /**
  144003. * Gets the output component
  144004. */
  144005. get output(): NodeMaterialConnectionPoint;
  144006. protected _buildBlock(state: NodeMaterialBuildState): this;
  144007. }
  144008. }
  144009. declare module BABYLON {
  144010. /**
  144011. * Block used to implement the ambient occlusion module of the PBR material
  144012. */
  144013. export class AmbientOcclusionBlock extends NodeMaterialBlock {
  144014. /**
  144015. * Create a new AmbientOcclusionBlock
  144016. * @param name defines the block name
  144017. */
  144018. constructor(name: string);
  144019. /**
  144020. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  144021. */
  144022. useAmbientInGrayScale: boolean;
  144023. /**
  144024. * Initialize the block and prepare the context for build
  144025. * @param state defines the state that will be used for the build
  144026. */
  144027. initialize(state: NodeMaterialBuildState): void;
  144028. /**
  144029. * Gets the current class name
  144030. * @returns the class name
  144031. */
  144032. getClassName(): string;
  144033. /**
  144034. * Gets the texture input component
  144035. */
  144036. get texture(): NodeMaterialConnectionPoint;
  144037. /**
  144038. * Gets the texture intensity component
  144039. */
  144040. get intensity(): NodeMaterialConnectionPoint;
  144041. /**
  144042. * Gets the direct light intensity input component
  144043. */
  144044. get directLightIntensity(): NodeMaterialConnectionPoint;
  144045. /**
  144046. * Gets the ambient occlusion object output component
  144047. */
  144048. get ambientOcclusion(): NodeMaterialConnectionPoint;
  144049. /**
  144050. * Gets the main code of the block (fragment side)
  144051. * @param block instance of an AmbientOcclusionBlock or null if the code must be generated without an active ambient occlusion module
  144052. * @returns the shader code
  144053. */
  144054. static GetCode(block: Nullable<AmbientOcclusionBlock>): string;
  144055. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144056. protected _buildBlock(state: NodeMaterialBuildState): this;
  144057. protected _dumpPropertiesCode(): string;
  144058. serialize(): any;
  144059. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  144060. }
  144061. }
  144062. declare module BABYLON {
  144063. /**
  144064. * Block used to implement the reflection module of the PBR material
  144065. */
  144066. export class ReflectionBlock extends ReflectionTextureBaseBlock {
  144067. /** @hidden */
  144068. _defineLODReflectionAlpha: string;
  144069. /** @hidden */
  144070. _defineLinearSpecularReflection: string;
  144071. private _vEnvironmentIrradianceName;
  144072. /** @hidden */
  144073. _vReflectionMicrosurfaceInfosName: string;
  144074. /** @hidden */
  144075. _vReflectionInfosName: string;
  144076. /** @hidden */
  144077. _vReflectionFilteringInfoName: string;
  144078. private _scene;
  144079. /**
  144080. * The three properties below are set by the main PBR block prior to calling methods of this class.
  144081. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  144082. * It's less burden on the user side in the editor part.
  144083. */
  144084. /** @hidden */
  144085. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  144086. /** @hidden */
  144087. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  144088. /** @hidden */
  144089. cameraPositionConnectionPoint: NodeMaterialConnectionPoint;
  144090. /**
  144091. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  144092. * diffuse part of the IBL.
  144093. */
  144094. useSphericalHarmonics: boolean;
  144095. /**
  144096. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  144097. */
  144098. forceIrradianceInFragment: boolean;
  144099. /**
  144100. * Create a new ReflectionBlock
  144101. * @param name defines the block name
  144102. */
  144103. constructor(name: string);
  144104. /**
  144105. * Gets the current class name
  144106. * @returns the class name
  144107. */
  144108. getClassName(): string;
  144109. /**
  144110. * Gets the position input component
  144111. */
  144112. get position(): NodeMaterialConnectionPoint;
  144113. /**
  144114. * Gets the world position input component
  144115. */
  144116. get worldPosition(): NodeMaterialConnectionPoint;
  144117. /**
  144118. * Gets the world normal input component
  144119. */
  144120. get worldNormal(): NodeMaterialConnectionPoint;
  144121. /**
  144122. * Gets the world input component
  144123. */
  144124. get world(): NodeMaterialConnectionPoint;
  144125. /**
  144126. * Gets the camera (or eye) position component
  144127. */
  144128. get cameraPosition(): NodeMaterialConnectionPoint;
  144129. /**
  144130. * Gets the view input component
  144131. */
  144132. get view(): NodeMaterialConnectionPoint;
  144133. /**
  144134. * Gets the color input component
  144135. */
  144136. get color(): NodeMaterialConnectionPoint;
  144137. /**
  144138. * Gets the reflection object output component
  144139. */
  144140. get reflection(): NodeMaterialConnectionPoint;
  144141. /**
  144142. * Returns true if the block has a texture (either its own texture or the environment texture from the scene, if set)
  144143. */
  144144. get hasTexture(): boolean;
  144145. /**
  144146. * Gets the reflection color (either the name of the variable if the color input is connected, else a default value)
  144147. */
  144148. get reflectionColor(): string;
  144149. protected _getTexture(): Nullable<BaseTexture>;
  144150. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144151. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  144152. /**
  144153. * Gets the code to inject in the vertex shader
  144154. * @param state current state of the node material building
  144155. * @returns the shader code
  144156. */
  144157. handleVertexSide(state: NodeMaterialBuildState): string;
  144158. /**
  144159. * Gets the main code of the block (fragment side)
  144160. * @param state current state of the node material building
  144161. * @param normalVarName name of the existing variable corresponding to the normal
  144162. * @returns the shader code
  144163. */
  144164. getCode(state: NodeMaterialBuildState, normalVarName: string): string;
  144165. protected _buildBlock(state: NodeMaterialBuildState): this;
  144166. protected _dumpPropertiesCode(): string;
  144167. serialize(): any;
  144168. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  144169. }
  144170. }
  144171. declare module BABYLON {
  144172. /**
  144173. * Block used to implement the sheen module of the PBR material
  144174. */
  144175. export class SheenBlock extends NodeMaterialBlock {
  144176. /**
  144177. * Create a new SheenBlock
  144178. * @param name defines the block name
  144179. */
  144180. constructor(name: string);
  144181. /**
  144182. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  144183. * It allows the strength of the sheen effect to not depend on the base color of the material,
  144184. * making it easier to setup and tweak the effect
  144185. */
  144186. albedoScaling: boolean;
  144187. /**
  144188. * Defines if the sheen is linked to the sheen color.
  144189. */
  144190. linkSheenWithAlbedo: boolean;
  144191. /**
  144192. * Initialize the block and prepare the context for build
  144193. * @param state defines the state that will be used for the build
  144194. */
  144195. initialize(state: NodeMaterialBuildState): void;
  144196. /**
  144197. * Gets the current class name
  144198. * @returns the class name
  144199. */
  144200. getClassName(): string;
  144201. /**
  144202. * Gets the intensity input component
  144203. */
  144204. get intensity(): NodeMaterialConnectionPoint;
  144205. /**
  144206. * Gets the color input component
  144207. */
  144208. get color(): NodeMaterialConnectionPoint;
  144209. /**
  144210. * Gets the roughness input component
  144211. */
  144212. get roughness(): NodeMaterialConnectionPoint;
  144213. /**
  144214. * Gets the sheen object output component
  144215. */
  144216. get sheen(): NodeMaterialConnectionPoint;
  144217. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144218. /**
  144219. * Gets the main code of the block (fragment side)
  144220. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  144221. * @returns the shader code
  144222. */
  144223. getCode(reflectionBlock: Nullable<ReflectionBlock>): string;
  144224. protected _buildBlock(state: NodeMaterialBuildState): this;
  144225. protected _dumpPropertiesCode(): string;
  144226. serialize(): any;
  144227. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  144228. }
  144229. }
  144230. declare module BABYLON {
  144231. /**
  144232. * Block used to implement the reflectivity module of the PBR material
  144233. */
  144234. export class ReflectivityBlock extends NodeMaterialBlock {
  144235. private _metallicReflectanceColor;
  144236. private _metallicF0Factor;
  144237. /** @hidden */
  144238. _vMetallicReflectanceFactorsName: string;
  144239. /**
  144240. * The property below is set by the main PBR block prior to calling methods of this class.
  144241. */
  144242. /** @hidden */
  144243. indexOfRefractionConnectionPoint: Nullable<NodeMaterialConnectionPoint>;
  144244. /**
  144245. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  144246. */
  144247. useAmbientOcclusionFromMetallicTextureRed: boolean;
  144248. /**
  144249. * Specifies if the metallic texture contains the metallness information in its blue channel.
  144250. */
  144251. useMetallnessFromMetallicTextureBlue: boolean;
  144252. /**
  144253. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  144254. */
  144255. useRoughnessFromMetallicTextureAlpha: boolean;
  144256. /**
  144257. * Specifies if the metallic texture contains the roughness information in its green channel.
  144258. */
  144259. useRoughnessFromMetallicTextureGreen: boolean;
  144260. /**
  144261. * Create a new ReflectivityBlock
  144262. * @param name defines the block name
  144263. */
  144264. constructor(name: string);
  144265. /**
  144266. * Initialize the block and prepare the context for build
  144267. * @param state defines the state that will be used for the build
  144268. */
  144269. initialize(state: NodeMaterialBuildState): void;
  144270. /**
  144271. * Gets the current class name
  144272. * @returns the class name
  144273. */
  144274. getClassName(): string;
  144275. /**
  144276. * Gets the metallic input component
  144277. */
  144278. get metallic(): NodeMaterialConnectionPoint;
  144279. /**
  144280. * Gets the roughness input component
  144281. */
  144282. get roughness(): NodeMaterialConnectionPoint;
  144283. /**
  144284. * Gets the texture input component
  144285. */
  144286. get texture(): NodeMaterialConnectionPoint;
  144287. /**
  144288. * Gets the reflectivity object output component
  144289. */
  144290. get reflectivity(): NodeMaterialConnectionPoint;
  144291. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  144292. /**
  144293. * Gets the main code of the block (fragment side)
  144294. * @param state current state of the node material building
  144295. * @param aoIntensityVarName name of the variable with the ambient occlusion intensity
  144296. * @returns the shader code
  144297. */
  144298. getCode(state: NodeMaterialBuildState, aoIntensityVarName: string): string;
  144299. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144300. protected _buildBlock(state: NodeMaterialBuildState): this;
  144301. protected _dumpPropertiesCode(): string;
  144302. serialize(): any;
  144303. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  144304. }
  144305. }
  144306. declare module BABYLON {
  144307. /**
  144308. * Block used to implement the anisotropy module of the PBR material
  144309. */
  144310. export class AnisotropyBlock extends NodeMaterialBlock {
  144311. /**
  144312. * The two properties below are set by the main PBR block prior to calling methods of this class.
  144313. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  144314. * It's less burden on the user side in the editor part.
  144315. */
  144316. /** @hidden */
  144317. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  144318. /** @hidden */
  144319. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  144320. /**
  144321. * Create a new AnisotropyBlock
  144322. * @param name defines the block name
  144323. */
  144324. constructor(name: string);
  144325. /**
  144326. * Initialize the block and prepare the context for build
  144327. * @param state defines the state that will be used for the build
  144328. */
  144329. initialize(state: NodeMaterialBuildState): void;
  144330. /**
  144331. * Gets the current class name
  144332. * @returns the class name
  144333. */
  144334. getClassName(): string;
  144335. /**
  144336. * Gets the intensity input component
  144337. */
  144338. get intensity(): NodeMaterialConnectionPoint;
  144339. /**
  144340. * Gets the direction input component
  144341. */
  144342. get direction(): NodeMaterialConnectionPoint;
  144343. /**
  144344. * Gets the texture input component
  144345. */
  144346. get texture(): NodeMaterialConnectionPoint;
  144347. /**
  144348. * Gets the uv input component
  144349. */
  144350. get uv(): NodeMaterialConnectionPoint;
  144351. /**
  144352. * Gets the worldTangent input component
  144353. */
  144354. get worldTangent(): NodeMaterialConnectionPoint;
  144355. /**
  144356. * Gets the anisotropy object output component
  144357. */
  144358. get anisotropy(): NodeMaterialConnectionPoint;
  144359. private _generateTBNSpace;
  144360. /**
  144361. * Gets the main code of the block (fragment side)
  144362. * @param state current state of the node material building
  144363. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  144364. * @returns the shader code
  144365. */
  144366. getCode(state: NodeMaterialBuildState, generateTBNSpace?: boolean): string;
  144367. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144368. protected _buildBlock(state: NodeMaterialBuildState): this;
  144369. }
  144370. }
  144371. declare module BABYLON {
  144372. /**
  144373. * Block used to implement the clear coat module of the PBR material
  144374. */
  144375. export class ClearCoatBlock extends NodeMaterialBlock {
  144376. private _scene;
  144377. /**
  144378. * Create a new ClearCoatBlock
  144379. * @param name defines the block name
  144380. */
  144381. constructor(name: string);
  144382. /**
  144383. * Initialize the block and prepare the context for build
  144384. * @param state defines the state that will be used for the build
  144385. */
  144386. initialize(state: NodeMaterialBuildState): void;
  144387. /**
  144388. * Gets the current class name
  144389. * @returns the class name
  144390. */
  144391. getClassName(): string;
  144392. /**
  144393. * Gets the intensity input component
  144394. */
  144395. get intensity(): NodeMaterialConnectionPoint;
  144396. /**
  144397. * Gets the roughness input component
  144398. */
  144399. get roughness(): NodeMaterialConnectionPoint;
  144400. /**
  144401. * Gets the ior input component
  144402. */
  144403. get ior(): NodeMaterialConnectionPoint;
  144404. /**
  144405. * Gets the texture input component
  144406. */
  144407. get texture(): NodeMaterialConnectionPoint;
  144408. /**
  144409. * Gets the bump texture input component
  144410. */
  144411. get bumpTexture(): NodeMaterialConnectionPoint;
  144412. /**
  144413. * Gets the uv input component
  144414. */
  144415. get uv(): NodeMaterialConnectionPoint;
  144416. /**
  144417. * Gets the tint color input component
  144418. */
  144419. get tintColor(): NodeMaterialConnectionPoint;
  144420. /**
  144421. * Gets the tint "at distance" input component
  144422. */
  144423. get tintAtDistance(): NodeMaterialConnectionPoint;
  144424. /**
  144425. * Gets the tint thickness input component
  144426. */
  144427. get tintThickness(): NodeMaterialConnectionPoint;
  144428. /**
  144429. * Gets the world tangent input component
  144430. */
  144431. get worldTangent(): NodeMaterialConnectionPoint;
  144432. /**
  144433. * Gets the clear coat object output component
  144434. */
  144435. get clearcoat(): NodeMaterialConnectionPoint;
  144436. autoConfigure(material: NodeMaterial): void;
  144437. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144438. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  144439. private _generateTBNSpace;
  144440. /**
  144441. * Gets the main code of the block (fragment side)
  144442. * @param state current state of the node material building
  144443. * @param ccBlock instance of a ClearCoatBlock or null if the code must be generated without an active clear coat module
  144444. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  144445. * @param worldPosVarName name of the variable holding the world position
  144446. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  144447. * @param vTBNAvailable indicate that the vTBN variable is already existing because it has already been generated by another block (PerturbNormal or Anisotropy)
  144448. * @param worldNormalVarName name of the variable holding the world normal
  144449. * @returns the shader code
  144450. */
  144451. static GetCode(state: NodeMaterialBuildState, ccBlock: Nullable<ClearCoatBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string, generateTBNSpace: boolean, vTBNAvailable: boolean, worldNormalVarName: string): string;
  144452. protected _buildBlock(state: NodeMaterialBuildState): this;
  144453. }
  144454. }
  144455. declare module BABYLON {
  144456. /**
  144457. * Block used to implement the sub surface module of the PBR material
  144458. */
  144459. export class SubSurfaceBlock extends NodeMaterialBlock {
  144460. /**
  144461. * Create a new SubSurfaceBlock
  144462. * @param name defines the block name
  144463. */
  144464. constructor(name: string);
  144465. /**
  144466. * Stores the intensity of the different subsurface effects in the thickness texture.
  144467. * * the green channel is the translucency intensity.
  144468. * * the blue channel is the scattering intensity.
  144469. * * the alpha channel is the refraction intensity.
  144470. */
  144471. useMaskFromThicknessTexture: boolean;
  144472. /**
  144473. * Initialize the block and prepare the context for build
  144474. * @param state defines the state that will be used for the build
  144475. */
  144476. initialize(state: NodeMaterialBuildState): void;
  144477. /**
  144478. * Gets the current class name
  144479. * @returns the class name
  144480. */
  144481. getClassName(): string;
  144482. /**
  144483. * Gets the min thickness input component
  144484. */
  144485. get minThickness(): NodeMaterialConnectionPoint;
  144486. /**
  144487. * Gets the max thickness input component
  144488. */
  144489. get maxThickness(): NodeMaterialConnectionPoint;
  144490. /**
  144491. * Gets the thickness texture component
  144492. */
  144493. get thicknessTexture(): NodeMaterialConnectionPoint;
  144494. /**
  144495. * Gets the tint color input component
  144496. */
  144497. get tintColor(): NodeMaterialConnectionPoint;
  144498. /**
  144499. * Gets the translucency intensity input component
  144500. */
  144501. get translucencyIntensity(): NodeMaterialConnectionPoint;
  144502. /**
  144503. * Gets the translucency diffusion distance input component
  144504. */
  144505. get translucencyDiffusionDistance(): NodeMaterialConnectionPoint;
  144506. /**
  144507. * Gets the refraction object parameters
  144508. */
  144509. get refraction(): NodeMaterialConnectionPoint;
  144510. /**
  144511. * Gets the sub surface object output component
  144512. */
  144513. get subsurface(): NodeMaterialConnectionPoint;
  144514. autoConfigure(material: NodeMaterial): void;
  144515. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144516. /**
  144517. * Gets the main code of the block (fragment side)
  144518. * @param state current state of the node material building
  144519. * @param ssBlock instance of a SubSurfaceBlock or null if the code must be generated without an active sub surface module
  144520. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  144521. * @param worldPosVarName name of the variable holding the world position
  144522. * @returns the shader code
  144523. */
  144524. static GetCode(state: NodeMaterialBuildState, ssBlock: Nullable<SubSurfaceBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string): string;
  144525. protected _buildBlock(state: NodeMaterialBuildState): this;
  144526. }
  144527. }
  144528. declare module BABYLON {
  144529. /**
  144530. * Block used to implement the PBR metallic/roughness model
  144531. */
  144532. export class PBRMetallicRoughnessBlock extends NodeMaterialBlock {
  144533. /**
  144534. * Gets or sets the light associated with this block
  144535. */
  144536. light: Nullable<Light>;
  144537. private _lightId;
  144538. private _scene;
  144539. private _environmentBRDFTexture;
  144540. private _environmentBrdfSamplerName;
  144541. private _vNormalWName;
  144542. private _invertNormalName;
  144543. /**
  144544. * Create a new ReflectionBlock
  144545. * @param name defines the block name
  144546. */
  144547. constructor(name: string);
  144548. /**
  144549. * Intensity of the direct lights e.g. the four lights available in your scene.
  144550. * This impacts both the direct diffuse and specular highlights.
  144551. */
  144552. directIntensity: number;
  144553. /**
  144554. * Intensity of the environment e.g. how much the environment will light the object
  144555. * either through harmonics for rough material or through the refelction for shiny ones.
  144556. */
  144557. environmentIntensity: number;
  144558. /**
  144559. * This is a special control allowing the reduction of the specular highlights coming from the
  144560. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  144561. */
  144562. specularIntensity: number;
  144563. /**
  144564. * Defines the falloff type used in this material.
  144565. * It by default is Physical.
  144566. */
  144567. lightFalloff: number;
  144568. /**
  144569. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  144570. */
  144571. useAlphaFromAlbedoTexture: boolean;
  144572. /**
  144573. * Specifies that alpha test should be used
  144574. */
  144575. useAlphaTest: boolean;
  144576. /**
  144577. * Defines the alpha limits in alpha test mode.
  144578. */
  144579. alphaTestCutoff: number;
  144580. /**
  144581. * Specifies that alpha blending should be used
  144582. */
  144583. useAlphaBlending: boolean;
  144584. /**
  144585. * Defines if the alpha value should be determined via the rgb values.
  144586. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  144587. */
  144588. opacityRGB: boolean;
  144589. /**
  144590. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most luminous ones).
  144591. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  144592. */
  144593. useRadianceOverAlpha: boolean;
  144594. /**
  144595. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most luminous ones).
  144596. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  144597. */
  144598. useSpecularOverAlpha: boolean;
  144599. /**
  144600. * Enables specular anti aliasing in the PBR shader.
  144601. * It will both interacts on the Geometry for analytical and IBL lighting.
  144602. * It also prefilter the roughness map based on the bump values.
  144603. */
  144604. enableSpecularAntiAliasing: boolean;
  144605. /**
  144606. * Enables realtime filtering on the texture.
  144607. */
  144608. realTimeFiltering: boolean;
  144609. /**
  144610. * Quality switch for realtime filtering
  144611. */
  144612. realTimeFilteringQuality: number;
  144613. /**
  144614. * Defines if the material uses energy conservation.
  144615. */
  144616. useEnergyConservation: boolean;
  144617. /**
  144618. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  144619. * too much the area relying on ambient texture to define their ambient occlusion.
  144620. */
  144621. useRadianceOcclusion: boolean;
  144622. /**
  144623. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  144624. * makes the reflect vector face the model (under horizon).
  144625. */
  144626. useHorizonOcclusion: boolean;
  144627. /**
  144628. * If set to true, no lighting calculations will be applied.
  144629. */
  144630. unlit: boolean;
  144631. /**
  144632. * Force normal to face away from face.
  144633. */
  144634. forceNormalForward: boolean;
  144635. /**
  144636. * Defines the material debug mode.
  144637. * It helps seeing only some components of the material while troubleshooting.
  144638. */
  144639. debugMode: number;
  144640. /**
  144641. * Specify from where on screen the debug mode should start.
  144642. * The value goes from -1 (full screen) to 1 (not visible)
  144643. * It helps with side by side comparison against the final render
  144644. * This defaults to 0
  144645. */
  144646. debugLimit: number;
  144647. /**
  144648. * As the default viewing range might not be enough (if the ambient is really small for instance)
  144649. * You can use the factor to better multiply the final value.
  144650. */
  144651. debugFactor: number;
  144652. /**
  144653. * Initialize the block and prepare the context for build
  144654. * @param state defines the state that will be used for the build
  144655. */
  144656. initialize(state: NodeMaterialBuildState): void;
  144657. /**
  144658. * Gets the current class name
  144659. * @returns the class name
  144660. */
  144661. getClassName(): string;
  144662. /**
  144663. * Gets the world position input component
  144664. */
  144665. get worldPosition(): NodeMaterialConnectionPoint;
  144666. /**
  144667. * Gets the world normal input component
  144668. */
  144669. get worldNormal(): NodeMaterialConnectionPoint;
  144670. /**
  144671. * Gets the perturbed normal input component
  144672. */
  144673. get perturbedNormal(): NodeMaterialConnectionPoint;
  144674. /**
  144675. * Gets the camera position input component
  144676. */
  144677. get cameraPosition(): NodeMaterialConnectionPoint;
  144678. /**
  144679. * Gets the base color input component
  144680. */
  144681. get baseColor(): NodeMaterialConnectionPoint;
  144682. /**
  144683. * Gets the opacity texture input component
  144684. */
  144685. get opacityTexture(): NodeMaterialConnectionPoint;
  144686. /**
  144687. * Gets the ambient color input component
  144688. */
  144689. get ambientColor(): NodeMaterialConnectionPoint;
  144690. /**
  144691. * Gets the reflectivity object parameters
  144692. */
  144693. get reflectivity(): NodeMaterialConnectionPoint;
  144694. /**
  144695. * Gets the ambient occlusion object parameters
  144696. */
  144697. get ambientOcclusion(): NodeMaterialConnectionPoint;
  144698. /**
  144699. * Gets the reflection object parameters
  144700. */
  144701. get reflection(): NodeMaterialConnectionPoint;
  144702. /**
  144703. * Gets the sheen object parameters
  144704. */
  144705. get sheen(): NodeMaterialConnectionPoint;
  144706. /**
  144707. * Gets the clear coat object parameters
  144708. */
  144709. get clearcoat(): NodeMaterialConnectionPoint;
  144710. /**
  144711. * Gets the sub surface object parameters
  144712. */
  144713. get subsurface(): NodeMaterialConnectionPoint;
  144714. /**
  144715. * Gets the anisotropy object parameters
  144716. */
  144717. get anisotropy(): NodeMaterialConnectionPoint;
  144718. /**
  144719. * Gets the ambient output component
  144720. */
  144721. get ambient(): NodeMaterialConnectionPoint;
  144722. /**
  144723. * Gets the diffuse output component
  144724. */
  144725. get diffuse(): NodeMaterialConnectionPoint;
  144726. /**
  144727. * Gets the specular output component
  144728. */
  144729. get specular(): NodeMaterialConnectionPoint;
  144730. /**
  144731. * Gets the sheen output component
  144732. */
  144733. get sheenDir(): NodeMaterialConnectionPoint;
  144734. /**
  144735. * Gets the clear coat output component
  144736. */
  144737. get clearcoatDir(): NodeMaterialConnectionPoint;
  144738. /**
  144739. * Gets the indirect diffuse output component
  144740. */
  144741. get diffuseIndirect(): NodeMaterialConnectionPoint;
  144742. /**
  144743. * Gets the indirect specular output component
  144744. */
  144745. get specularIndirect(): NodeMaterialConnectionPoint;
  144746. /**
  144747. * Gets the indirect sheen output component
  144748. */
  144749. get sheenIndirect(): NodeMaterialConnectionPoint;
  144750. /**
  144751. * Gets the indirect clear coat output component
  144752. */
  144753. get clearcoatIndirect(): NodeMaterialConnectionPoint;
  144754. /**
  144755. * Gets the refraction output component
  144756. */
  144757. get refraction(): NodeMaterialConnectionPoint;
  144758. /**
  144759. * Gets the global lighting output component
  144760. */
  144761. get lighting(): NodeMaterialConnectionPoint;
  144762. /**
  144763. * Gets the shadow output component
  144764. */
  144765. get shadow(): NodeMaterialConnectionPoint;
  144766. /**
  144767. * Gets the alpha output component
  144768. */
  144769. get alpha(): NodeMaterialConnectionPoint;
  144770. autoConfigure(material: NodeMaterial): void;
  144771. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144772. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  144773. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  144774. private _injectVertexCode;
  144775. /**
  144776. * Gets the code corresponding to the albedo/opacity module
  144777. * @returns the shader code
  144778. */
  144779. getAlbedoOpacityCode(): string;
  144780. protected _buildBlock(state: NodeMaterialBuildState): this;
  144781. protected _dumpPropertiesCode(): string;
  144782. serialize(): any;
  144783. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  144784. }
  144785. }
  144786. declare module BABYLON {
  144787. /**
  144788. * Block used to compute value of one parameter modulo another
  144789. */
  144790. export class ModBlock extends NodeMaterialBlock {
  144791. /**
  144792. * Creates a new ModBlock
  144793. * @param name defines the block name
  144794. */
  144795. constructor(name: string);
  144796. /**
  144797. * Gets the current class name
  144798. * @returns the class name
  144799. */
  144800. getClassName(): string;
  144801. /**
  144802. * Gets the left operand input component
  144803. */
  144804. get left(): NodeMaterialConnectionPoint;
  144805. /**
  144806. * Gets the right operand input component
  144807. */
  144808. get right(): NodeMaterialConnectionPoint;
  144809. /**
  144810. * Gets the output component
  144811. */
  144812. get output(): NodeMaterialConnectionPoint;
  144813. protected _buildBlock(state: NodeMaterialBuildState): this;
  144814. }
  144815. }
  144816. declare module BABYLON {
  144817. /**
  144818. * Configuration for Draco compression
  144819. */
  144820. export interface IDracoCompressionConfiguration {
  144821. /**
  144822. * Configuration for the decoder.
  144823. */
  144824. decoder: {
  144825. /**
  144826. * The url to the WebAssembly module.
  144827. */
  144828. wasmUrl?: string;
  144829. /**
  144830. * The url to the WebAssembly binary.
  144831. */
  144832. wasmBinaryUrl?: string;
  144833. /**
  144834. * The url to the fallback JavaScript module.
  144835. */
  144836. fallbackUrl?: string;
  144837. };
  144838. }
  144839. /**
  144840. * Draco compression (https://google.github.io/draco/)
  144841. *
  144842. * This class wraps the Draco module.
  144843. *
  144844. * **Encoder**
  144845. *
  144846. * The encoder is not currently implemented.
  144847. *
  144848. * **Decoder**
  144849. *
  144850. * 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.
  144851. *
  144852. * To update the configuration, use the following code:
  144853. * ```javascript
  144854. * DracoCompression.Configuration = {
  144855. * decoder: {
  144856. * wasmUrl: "<url to the WebAssembly library>",
  144857. * wasmBinaryUrl: "<url to the WebAssembly binary>",
  144858. * fallbackUrl: "<url to the fallback JavaScript library>",
  144859. * }
  144860. * };
  144861. * ```
  144862. *
  144863. * 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.
  144864. * Decoding will automatically fallback to the JavaScript version if WebAssembly version is not configured or if WebAssembly is not supported by the browser.
  144865. * Use `DracoCompression.DecoderAvailable` to determine if the decoder configuration is available for the current context.
  144866. *
  144867. * To decode Draco compressed data, get the default DracoCompression object and call decodeMeshAsync:
  144868. * ```javascript
  144869. * var vertexData = await DracoCompression.Default.decodeMeshAsync(data);
  144870. * ```
  144871. *
  144872. * @see https://www.babylonjs-playground.com/#N3EK4B#0
  144873. */
  144874. export class DracoCompression implements IDisposable {
  144875. private _workerPoolPromise?;
  144876. private _decoderModulePromise?;
  144877. /**
  144878. * The configuration. Defaults to the following urls:
  144879. * - wasmUrl: "https://preview.babylonjs.com/draco_wasm_wrapper_gltf.js"
  144880. * - wasmBinaryUrl: "https://preview.babylonjs.com/draco_decoder_gltf.wasm"
  144881. * - fallbackUrl: "https://preview.babylonjs.com/draco_decoder_gltf.js"
  144882. */
  144883. static Configuration: IDracoCompressionConfiguration;
  144884. /**
  144885. * Returns true if the decoder configuration is available.
  144886. */
  144887. static get DecoderAvailable(): boolean;
  144888. /**
  144889. * Default number of workers to create when creating the draco compression object.
  144890. */
  144891. static DefaultNumWorkers: number;
  144892. private static GetDefaultNumWorkers;
  144893. private static _Default;
  144894. /**
  144895. * Default instance for the draco compression object.
  144896. */
  144897. static get Default(): DracoCompression;
  144898. /**
  144899. * Constructor
  144900. * @param numWorkers The number of workers for async operations. Specify `0` to disable web workers and run synchronously in the current context.
  144901. */
  144902. constructor(numWorkers?: number);
  144903. /**
  144904. * Stop all async operations and release resources.
  144905. */
  144906. dispose(): void;
  144907. /**
  144908. * Returns a promise that resolves when ready. Call this manually to ensure draco compression is ready before use.
  144909. * @returns a promise that resolves when ready
  144910. */
  144911. whenReadyAsync(): Promise<void>;
  144912. /**
  144913. * Decode Draco compressed mesh data to vertex data.
  144914. * @param data The ArrayBuffer or ArrayBufferView for the Draco compression data
  144915. * @param attributes A map of attributes from vertex buffer kinds to Draco unique ids
  144916. * @returns A promise that resolves with the decoded vertex data
  144917. */
  144918. decodeMeshAsync(data: ArrayBuffer | ArrayBufferView, attributes?: {
  144919. [kind: string]: number;
  144920. }): Promise<VertexData>;
  144921. }
  144922. }
  144923. declare module BABYLON {
  144924. /**
  144925. * Class for building Constructive Solid Geometry
  144926. */
  144927. export class CSG {
  144928. private polygons;
  144929. /**
  144930. * The world matrix
  144931. */
  144932. matrix: Matrix;
  144933. /**
  144934. * Stores the position
  144935. */
  144936. position: Vector3;
  144937. /**
  144938. * Stores the rotation
  144939. */
  144940. rotation: Vector3;
  144941. /**
  144942. * Stores the rotation quaternion
  144943. */
  144944. rotationQuaternion: Nullable<Quaternion>;
  144945. /**
  144946. * Stores the scaling vector
  144947. */
  144948. scaling: Vector3;
  144949. /**
  144950. * Convert the Mesh to CSG
  144951. * @param mesh The Mesh to convert to CSG
  144952. * @returns A new CSG from the Mesh
  144953. */
  144954. static FromMesh(mesh: Mesh): CSG;
  144955. /**
  144956. * Construct a CSG solid from a list of `CSG.Polygon` instances.
  144957. * @param polygons Polygons used to construct a CSG solid
  144958. */
  144959. private static FromPolygons;
  144960. /**
  144961. * Clones, or makes a deep copy, of the CSG
  144962. * @returns A new CSG
  144963. */
  144964. clone(): CSG;
  144965. /**
  144966. * Unions this CSG with another CSG
  144967. * @param csg The CSG to union against this CSG
  144968. * @returns The unioned CSG
  144969. */
  144970. union(csg: CSG): CSG;
  144971. /**
  144972. * Unions this CSG with another CSG in place
  144973. * @param csg The CSG to union against this CSG
  144974. */
  144975. unionInPlace(csg: CSG): void;
  144976. /**
  144977. * Subtracts this CSG with another CSG
  144978. * @param csg The CSG to subtract against this CSG
  144979. * @returns A new CSG
  144980. */
  144981. subtract(csg: CSG): CSG;
  144982. /**
  144983. * Subtracts this CSG with another CSG in place
  144984. * @param csg The CSG to subtact against this CSG
  144985. */
  144986. subtractInPlace(csg: CSG): void;
  144987. /**
  144988. * Intersect this CSG with another CSG
  144989. * @param csg The CSG to intersect against this CSG
  144990. * @returns A new CSG
  144991. */
  144992. intersect(csg: CSG): CSG;
  144993. /**
  144994. * Intersects this CSG with another CSG in place
  144995. * @param csg The CSG to intersect against this CSG
  144996. */
  144997. intersectInPlace(csg: CSG): void;
  144998. /**
  144999. * Return a new CSG solid with solid and empty space switched. This solid is
  145000. * not modified.
  145001. * @returns A new CSG solid with solid and empty space switched
  145002. */
  145003. inverse(): CSG;
  145004. /**
  145005. * Inverses the CSG in place
  145006. */
  145007. inverseInPlace(): void;
  145008. /**
  145009. * This is used to keep meshes transformations so they can be restored
  145010. * when we build back a Babylon Mesh
  145011. * NB : All CSG operations are performed in world coordinates
  145012. * @param csg The CSG to copy the transform attributes from
  145013. * @returns This CSG
  145014. */
  145015. copyTransformAttributes(csg: CSG): CSG;
  145016. /**
  145017. * Build Raw mesh from CSG
  145018. * Coordinates here are in world space
  145019. * @param name The name of the mesh geometry
  145020. * @param scene The Scene
  145021. * @param keepSubMeshes Specifies if the submeshes should be kept
  145022. * @returns A new Mesh
  145023. */
  145024. buildMeshGeometry(name: string, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  145025. /**
  145026. * Build Mesh from CSG taking material and transforms into account
  145027. * @param name The name of the Mesh
  145028. * @param material The material of the Mesh
  145029. * @param scene The Scene
  145030. * @param keepSubMeshes Specifies if submeshes should be kept
  145031. * @returns The new Mesh
  145032. */
  145033. toMesh(name: string, material?: Nullable<Material>, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  145034. }
  145035. }
  145036. declare module BABYLON {
  145037. /**
  145038. * Class used to create a trail following a mesh
  145039. */
  145040. export class TrailMesh extends Mesh {
  145041. private _generator;
  145042. private _autoStart;
  145043. private _running;
  145044. private _diameter;
  145045. private _length;
  145046. private _sectionPolygonPointsCount;
  145047. private _sectionVectors;
  145048. private _sectionNormalVectors;
  145049. private _beforeRenderObserver;
  145050. /**
  145051. * @constructor
  145052. * @param name The value used by scene.getMeshByName() to do a lookup.
  145053. * @param generator The mesh or transform node to generate a trail.
  145054. * @param scene The scene to add this mesh to.
  145055. * @param diameter Diameter of trailing mesh. Default is 1.
  145056. * @param length Length of trailing mesh. Default is 60.
  145057. * @param autoStart Automatically start trailing mesh. Default true.
  145058. */
  145059. constructor(name: string, generator: TransformNode, scene: Scene, diameter?: number, length?: number, autoStart?: boolean);
  145060. /**
  145061. * "TrailMesh"
  145062. * @returns "TrailMesh"
  145063. */
  145064. getClassName(): string;
  145065. private _createMesh;
  145066. /**
  145067. * Start trailing mesh.
  145068. */
  145069. start(): void;
  145070. /**
  145071. * Stop trailing mesh.
  145072. */
  145073. stop(): void;
  145074. /**
  145075. * Update trailing mesh geometry.
  145076. */
  145077. update(): void;
  145078. /**
  145079. * Returns a new TrailMesh object.
  145080. * @param name is a string, the name given to the new mesh
  145081. * @param newGenerator use new generator object for cloned trail mesh
  145082. * @returns a new mesh
  145083. */
  145084. clone(name: string | undefined, newGenerator: TransformNode): TrailMesh;
  145085. /**
  145086. * Serializes this trail mesh
  145087. * @param serializationObject object to write serialization to
  145088. */
  145089. serialize(serializationObject: any): void;
  145090. /**
  145091. * Parses a serialized trail mesh
  145092. * @param parsedMesh the serialized mesh
  145093. * @param scene the scene to create the trail mesh in
  145094. * @returns the created trail mesh
  145095. */
  145096. static Parse(parsedMesh: any, scene: Scene): TrailMesh;
  145097. }
  145098. }
  145099. declare module BABYLON {
  145100. /**
  145101. * Class containing static functions to help procedurally build meshes
  145102. */
  145103. export class TiledBoxBuilder {
  145104. /**
  145105. * Creates a box mesh
  145106. * 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)
  145107. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  145108. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145109. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145110. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145111. * @param name defines the name of the mesh
  145112. * @param options defines the options used to create the mesh
  145113. * @param scene defines the hosting scene
  145114. * @returns the box mesh
  145115. */
  145116. static CreateTiledBox(name: string, options: {
  145117. pattern?: number;
  145118. width?: number;
  145119. height?: number;
  145120. depth?: number;
  145121. tileSize?: number;
  145122. tileWidth?: number;
  145123. tileHeight?: number;
  145124. alignHorizontal?: number;
  145125. alignVertical?: number;
  145126. faceUV?: Vector4[];
  145127. faceColors?: Color4[];
  145128. sideOrientation?: number;
  145129. updatable?: boolean;
  145130. }, scene?: Nullable<Scene>): Mesh;
  145131. }
  145132. }
  145133. declare module BABYLON {
  145134. /**
  145135. * Class containing static functions to help procedurally build meshes
  145136. */
  145137. export class TorusKnotBuilder {
  145138. /**
  145139. * Creates a torus knot mesh
  145140. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  145141. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  145142. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  145143. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  145144. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  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. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145147. * @param name defines the name of the mesh
  145148. * @param options defines the options used to create the mesh
  145149. * @param scene defines the hosting scene
  145150. * @returns the torus knot mesh
  145151. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  145152. */
  145153. static CreateTorusKnot(name: string, options: {
  145154. radius?: number;
  145155. tube?: number;
  145156. radialSegments?: number;
  145157. tubularSegments?: number;
  145158. p?: number;
  145159. q?: number;
  145160. updatable?: boolean;
  145161. sideOrientation?: number;
  145162. frontUVs?: Vector4;
  145163. backUVs?: Vector4;
  145164. }, scene: any): Mesh;
  145165. }
  145166. }
  145167. declare module BABYLON {
  145168. /**
  145169. * Polygon
  145170. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  145171. */
  145172. export class Polygon {
  145173. /**
  145174. * Creates a rectangle
  145175. * @param xmin bottom X coord
  145176. * @param ymin bottom Y coord
  145177. * @param xmax top X coord
  145178. * @param ymax top Y coord
  145179. * @returns points that make the resulting rectation
  145180. */
  145181. static Rectangle(xmin: number, ymin: number, xmax: number, ymax: number): Vector2[];
  145182. /**
  145183. * Creates a circle
  145184. * @param radius radius of circle
  145185. * @param cx scale in x
  145186. * @param cy scale in y
  145187. * @param numberOfSides number of sides that make up the circle
  145188. * @returns points that make the resulting circle
  145189. */
  145190. static Circle(radius: number, cx?: number, cy?: number, numberOfSides?: number): Vector2[];
  145191. /**
  145192. * Creates a polygon from input string
  145193. * @param input Input polygon data
  145194. * @returns the parsed points
  145195. */
  145196. static Parse(input: string): Vector2[];
  145197. /**
  145198. * Starts building a polygon from x and y coordinates
  145199. * @param x x coordinate
  145200. * @param y y coordinate
  145201. * @returns the started path2
  145202. */
  145203. static StartingAt(x: number, y: number): Path2;
  145204. }
  145205. /**
  145206. * Builds a polygon
  145207. * @see https://doc.babylonjs.com/how_to/polygonmeshbuilder
  145208. */
  145209. export class PolygonMeshBuilder {
  145210. private _points;
  145211. private _outlinepoints;
  145212. private _holes;
  145213. private _name;
  145214. private _scene;
  145215. private _epoints;
  145216. private _eholes;
  145217. private _addToepoint;
  145218. /**
  145219. * Babylon reference to the earcut plugin.
  145220. */
  145221. bjsEarcut: any;
  145222. /**
  145223. * Creates a PolygonMeshBuilder
  145224. * @param name name of the builder
  145225. * @param contours Path of the polygon
  145226. * @param scene scene to add to when creating the mesh
  145227. * @param earcutInjection can be used to inject your own earcut reference
  145228. */
  145229. constructor(name: string, contours: Path2 | Vector2[] | any, scene?: Scene, earcutInjection?: any);
  145230. /**
  145231. * Adds a whole within the polygon
  145232. * @param hole Array of points defining the hole
  145233. * @returns this
  145234. */
  145235. addHole(hole: Vector2[]): PolygonMeshBuilder;
  145236. /**
  145237. * Creates the polygon
  145238. * @param updatable If the mesh should be updatable
  145239. * @param depth The depth of the mesh created
  145240. * @returns the created mesh
  145241. */
  145242. build(updatable?: boolean, depth?: number): Mesh;
  145243. /**
  145244. * Creates the polygon
  145245. * @param depth The depth of the mesh created
  145246. * @returns the created VertexData
  145247. */
  145248. buildVertexData(depth?: number): VertexData;
  145249. /**
  145250. * Adds a side to the polygon
  145251. * @param positions points that make the polygon
  145252. * @param normals normals of the polygon
  145253. * @param uvs uvs of the polygon
  145254. * @param indices indices of the polygon
  145255. * @param bounds bounds of the polygon
  145256. * @param points points of the polygon
  145257. * @param depth depth of the polygon
  145258. * @param flip flip of the polygon
  145259. */
  145260. private addSide;
  145261. }
  145262. }
  145263. declare module BABYLON {
  145264. /**
  145265. * Class containing static functions to help procedurally build meshes
  145266. */
  145267. export class PolygonBuilder {
  145268. /**
  145269. * Creates a polygon mesh
  145270. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  145271. * * 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
  145272. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  145273. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145274. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  145275. * * Remember you can only change the shape positions, not their number when updating a polygon
  145276. * @param name defines the name of the mesh
  145277. * @param options defines the options used to create the mesh
  145278. * @param scene defines the hosting scene
  145279. * @param earcutInjection can be used to inject your own earcut reference
  145280. * @returns the polygon mesh
  145281. */
  145282. static CreatePolygon(name: string, options: {
  145283. shape: Vector3[];
  145284. holes?: Vector3[][];
  145285. depth?: number;
  145286. faceUV?: Vector4[];
  145287. faceColors?: Color4[];
  145288. updatable?: boolean;
  145289. sideOrientation?: number;
  145290. frontUVs?: Vector4;
  145291. backUVs?: Vector4;
  145292. wrap?: boolean;
  145293. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  145294. /**
  145295. * Creates an extruded polygon mesh, with depth in the Y direction.
  145296. * * 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)
  145297. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  145298. * @param name defines the name of the mesh
  145299. * @param options defines the options used to create the mesh
  145300. * @param scene defines the hosting scene
  145301. * @param earcutInjection can be used to inject your own earcut reference
  145302. * @returns the polygon mesh
  145303. */
  145304. static ExtrudePolygon(name: string, options: {
  145305. shape: Vector3[];
  145306. holes?: Vector3[][];
  145307. depth?: number;
  145308. faceUV?: Vector4[];
  145309. faceColors?: Color4[];
  145310. updatable?: boolean;
  145311. sideOrientation?: number;
  145312. frontUVs?: Vector4;
  145313. backUVs?: Vector4;
  145314. wrap?: boolean;
  145315. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  145316. }
  145317. }
  145318. declare module BABYLON {
  145319. /**
  145320. * Class containing static functions to help procedurally build meshes
  145321. */
  145322. export class LatheBuilder {
  145323. /**
  145324. * Creates lathe mesh.
  145325. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  145326. * * 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
  145327. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  145328. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  145329. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  145330. * * 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
  145331. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  145332. * * 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
  145333. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145334. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145335. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  145336. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145337. * @param name defines the name of the mesh
  145338. * @param options defines the options used to create the mesh
  145339. * @param scene defines the hosting scene
  145340. * @returns the lathe mesh
  145341. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  145342. */
  145343. static CreateLathe(name: string, options: {
  145344. shape: Vector3[];
  145345. radius?: number;
  145346. tessellation?: number;
  145347. clip?: number;
  145348. arc?: number;
  145349. closed?: boolean;
  145350. updatable?: boolean;
  145351. sideOrientation?: number;
  145352. frontUVs?: Vector4;
  145353. backUVs?: Vector4;
  145354. cap?: number;
  145355. invertUV?: boolean;
  145356. }, scene?: Nullable<Scene>): Mesh;
  145357. }
  145358. }
  145359. declare module BABYLON {
  145360. /**
  145361. * Class containing static functions to help procedurally build meshes
  145362. */
  145363. export class TiledPlaneBuilder {
  145364. /**
  145365. * Creates a tiled plane mesh
  145366. * * The parameter `pattern` will, depending on value, do nothing or
  145367. * * * flip (reflect about central vertical) alternate tiles across and up
  145368. * * * flip every tile on alternate rows
  145369. * * * rotate (180 degs) alternate tiles across and up
  145370. * * * rotate every tile on alternate rows
  145371. * * * flip and rotate alternate tiles across and up
  145372. * * * flip and rotate every tile on alternate rows
  145373. * * The parameter `tileSize` sets the size (float) of each tile side (default 1)
  145374. * * You can set some different tile dimensions by using the parameters `tileWidth` and `tileHeight` (both by default have the same value of `tileSize`)
  145375. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145376. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  145377. * * 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)
  145378. * * 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)
  145379. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  145380. * @param name defines the name of the mesh
  145381. * @param options defines the options used to create the mesh
  145382. * @param scene defines the hosting scene
  145383. * @returns the box mesh
  145384. */
  145385. static CreateTiledPlane(name: string, options: {
  145386. pattern?: number;
  145387. tileSize?: number;
  145388. tileWidth?: number;
  145389. tileHeight?: number;
  145390. size?: number;
  145391. width?: number;
  145392. height?: number;
  145393. alignHorizontal?: number;
  145394. alignVertical?: number;
  145395. sideOrientation?: number;
  145396. frontUVs?: Vector4;
  145397. backUVs?: Vector4;
  145398. updatable?: boolean;
  145399. }, scene?: Nullable<Scene>): Mesh;
  145400. }
  145401. }
  145402. declare module BABYLON {
  145403. /**
  145404. * Class containing static functions to help procedurally build meshes
  145405. */
  145406. export class TubeBuilder {
  145407. /**
  145408. * Creates a tube mesh.
  145409. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  145410. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  145411. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  145412. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  145413. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  145414. * * 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)
  145415. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  145416. * * 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
  145417. * * 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
  145418. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145419. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145420. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  145421. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145422. * @param name defines the name of the mesh
  145423. * @param options defines the options used to create the mesh
  145424. * @param scene defines the hosting scene
  145425. * @returns the tube mesh
  145426. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  145427. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  145428. */
  145429. static CreateTube(name: string, options: {
  145430. path: Vector3[];
  145431. radius?: number;
  145432. tessellation?: number;
  145433. radiusFunction?: {
  145434. (i: number, distance: number): number;
  145435. };
  145436. cap?: number;
  145437. arc?: number;
  145438. updatable?: boolean;
  145439. sideOrientation?: number;
  145440. frontUVs?: Vector4;
  145441. backUVs?: Vector4;
  145442. instance?: Mesh;
  145443. invertUV?: boolean;
  145444. }, scene?: Nullable<Scene>): Mesh;
  145445. }
  145446. }
  145447. declare module BABYLON {
  145448. /**
  145449. * Class containing static functions to help procedurally build meshes
  145450. */
  145451. export class IcoSphereBuilder {
  145452. /**
  145453. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  145454. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  145455. * * 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`)
  145456. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  145457. * * 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
  145458. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145459. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145460. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145461. * @param name defines the name of the mesh
  145462. * @param options defines the options used to create the mesh
  145463. * @param scene defines the hosting scene
  145464. * @returns the icosahedron mesh
  145465. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  145466. */
  145467. static CreateIcoSphere(name: string, options: {
  145468. radius?: number;
  145469. radiusX?: number;
  145470. radiusY?: number;
  145471. radiusZ?: number;
  145472. flat?: boolean;
  145473. subdivisions?: number;
  145474. sideOrientation?: number;
  145475. frontUVs?: Vector4;
  145476. backUVs?: Vector4;
  145477. updatable?: boolean;
  145478. }, scene?: Nullable<Scene>): Mesh;
  145479. }
  145480. }
  145481. declare module BABYLON {
  145482. /**
  145483. * Class containing static functions to help procedurally build meshes
  145484. */
  145485. export class DecalBuilder {
  145486. /**
  145487. * Creates a decal mesh.
  145488. * 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
  145489. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  145490. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  145491. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  145492. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  145493. * @param name defines the name of the mesh
  145494. * @param sourceMesh defines the mesh where the decal must be applied
  145495. * @param options defines the options used to create the mesh
  145496. * @param scene defines the hosting scene
  145497. * @returns the decal mesh
  145498. * @see https://doc.babylonjs.com/how_to/decals
  145499. */
  145500. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  145501. position?: Vector3;
  145502. normal?: Vector3;
  145503. size?: Vector3;
  145504. angle?: number;
  145505. }): Mesh;
  145506. }
  145507. }
  145508. declare module BABYLON {
  145509. /**
  145510. * Class containing static functions to help procedurally build meshes
  145511. */
  145512. export class MeshBuilder {
  145513. /**
  145514. * Creates a box mesh
  145515. * * The parameter `size` sets the size (float) of each box side (default 1)
  145516. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  145517. * * 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)
  145518. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  145519. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145520. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145521. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145522. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  145523. * @param name defines the name of the mesh
  145524. * @param options defines the options used to create the mesh
  145525. * @param scene defines the hosting scene
  145526. * @returns the box mesh
  145527. */
  145528. static CreateBox(name: string, options: {
  145529. size?: number;
  145530. width?: number;
  145531. height?: number;
  145532. depth?: number;
  145533. faceUV?: Vector4[];
  145534. faceColors?: Color4[];
  145535. sideOrientation?: number;
  145536. frontUVs?: Vector4;
  145537. backUVs?: Vector4;
  145538. wrap?: boolean;
  145539. topBaseAt?: number;
  145540. bottomBaseAt?: number;
  145541. updatable?: boolean;
  145542. }, scene?: Nullable<Scene>): Mesh;
  145543. /**
  145544. * Creates a tiled box mesh
  145545. * * faceTiles sets the pattern, tile size and number of tiles for a face
  145546. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145547. * @param name defines the name of the mesh
  145548. * @param options defines the options used to create the mesh
  145549. * @param scene defines the hosting scene
  145550. * @returns the tiled box mesh
  145551. */
  145552. static CreateTiledBox(name: string, options: {
  145553. pattern?: number;
  145554. size?: number;
  145555. width?: number;
  145556. height?: number;
  145557. depth: number;
  145558. tileSize?: number;
  145559. tileWidth?: number;
  145560. tileHeight?: number;
  145561. faceUV?: Vector4[];
  145562. faceColors?: Color4[];
  145563. alignHorizontal?: number;
  145564. alignVertical?: number;
  145565. sideOrientation?: number;
  145566. updatable?: boolean;
  145567. }, scene?: Nullable<Scene>): Mesh;
  145568. /**
  145569. * Creates a sphere mesh
  145570. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  145571. * * 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`)
  145572. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  145573. * * 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
  145574. * * 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)
  145575. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145576. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145577. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145578. * @param name defines the name of the mesh
  145579. * @param options defines the options used to create the mesh
  145580. * @param scene defines the hosting scene
  145581. * @returns the sphere mesh
  145582. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  145583. */
  145584. static CreateSphere(name: string, options: {
  145585. segments?: number;
  145586. diameter?: number;
  145587. diameterX?: number;
  145588. diameterY?: number;
  145589. diameterZ?: number;
  145590. arc?: number;
  145591. slice?: number;
  145592. sideOrientation?: number;
  145593. frontUVs?: Vector4;
  145594. backUVs?: Vector4;
  145595. updatable?: boolean;
  145596. }, scene?: Nullable<Scene>): Mesh;
  145597. /**
  145598. * Creates a plane polygonal mesh. By default, this is a disc
  145599. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  145600. * * 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
  145601. * * 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
  145602. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145603. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145604. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145605. * @param name defines the name of the mesh
  145606. * @param options defines the options used to create the mesh
  145607. * @param scene defines the hosting scene
  145608. * @returns the plane polygonal mesh
  145609. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  145610. */
  145611. static CreateDisc(name: string, options: {
  145612. radius?: number;
  145613. tessellation?: number;
  145614. arc?: number;
  145615. updatable?: boolean;
  145616. sideOrientation?: number;
  145617. frontUVs?: Vector4;
  145618. backUVs?: Vector4;
  145619. }, scene?: Nullable<Scene>): Mesh;
  145620. /**
  145621. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  145622. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  145623. * * 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`)
  145624. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  145625. * * 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
  145626. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145627. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145628. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145629. * @param name defines the name of the mesh
  145630. * @param options defines the options used to create the mesh
  145631. * @param scene defines the hosting scene
  145632. * @returns the icosahedron mesh
  145633. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  145634. */
  145635. static CreateIcoSphere(name: string, options: {
  145636. radius?: number;
  145637. radiusX?: number;
  145638. radiusY?: number;
  145639. radiusZ?: number;
  145640. flat?: boolean;
  145641. subdivisions?: number;
  145642. sideOrientation?: number;
  145643. frontUVs?: Vector4;
  145644. backUVs?: Vector4;
  145645. updatable?: boolean;
  145646. }, scene?: Nullable<Scene>): Mesh;
  145647. /**
  145648. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  145649. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  145650. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  145651. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  145652. * * 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
  145653. * * 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
  145654. * * 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
  145655. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145656. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145657. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  145658. * * 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
  145659. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  145660. * * 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
  145661. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  145662. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145663. * @param name defines the name of the mesh
  145664. * @param options defines the options used to create the mesh
  145665. * @param scene defines the hosting scene
  145666. * @returns the ribbon mesh
  145667. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  145668. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  145669. */
  145670. static CreateRibbon(name: string, options: {
  145671. pathArray: Vector3[][];
  145672. closeArray?: boolean;
  145673. closePath?: boolean;
  145674. offset?: number;
  145675. updatable?: boolean;
  145676. sideOrientation?: number;
  145677. frontUVs?: Vector4;
  145678. backUVs?: Vector4;
  145679. instance?: Mesh;
  145680. invertUV?: boolean;
  145681. uvs?: Vector2[];
  145682. colors?: Color4[];
  145683. }, scene?: Nullable<Scene>): Mesh;
  145684. /**
  145685. * Creates a cylinder or a cone mesh
  145686. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  145687. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  145688. * * 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.
  145689. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  145690. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  145691. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  145692. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  145693. * * 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).
  145694. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  145695. * * 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).
  145696. * * 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
  145697. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  145698. * * 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
  145699. * * 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.
  145700. * * If `enclose` is false, a ring surface is one element.
  145701. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  145702. * * 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
  145703. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145704. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145705. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145706. * @param name defines the name of the mesh
  145707. * @param options defines the options used to create the mesh
  145708. * @param scene defines the hosting scene
  145709. * @returns the cylinder mesh
  145710. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  145711. */
  145712. static CreateCylinder(name: string, options: {
  145713. height?: number;
  145714. diameterTop?: number;
  145715. diameterBottom?: number;
  145716. diameter?: number;
  145717. tessellation?: number;
  145718. subdivisions?: number;
  145719. arc?: number;
  145720. faceColors?: Color4[];
  145721. faceUV?: Vector4[];
  145722. updatable?: boolean;
  145723. hasRings?: boolean;
  145724. enclose?: boolean;
  145725. cap?: number;
  145726. sideOrientation?: number;
  145727. frontUVs?: Vector4;
  145728. backUVs?: Vector4;
  145729. }, scene?: Nullable<Scene>): Mesh;
  145730. /**
  145731. * Creates a torus mesh
  145732. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  145733. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  145734. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  145735. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145736. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145737. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145738. * @param name defines the name of the mesh
  145739. * @param options defines the options used to create the mesh
  145740. * @param scene defines the hosting scene
  145741. * @returns the torus mesh
  145742. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  145743. */
  145744. static CreateTorus(name: string, options: {
  145745. diameter?: number;
  145746. thickness?: number;
  145747. tessellation?: number;
  145748. updatable?: boolean;
  145749. sideOrientation?: number;
  145750. frontUVs?: Vector4;
  145751. backUVs?: Vector4;
  145752. }, scene?: Nullable<Scene>): Mesh;
  145753. /**
  145754. * Creates a torus knot mesh
  145755. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  145756. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  145757. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  145758. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  145759. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145760. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145761. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145762. * @param name defines the name of the mesh
  145763. * @param options defines the options used to create the mesh
  145764. * @param scene defines the hosting scene
  145765. * @returns the torus knot mesh
  145766. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  145767. */
  145768. static CreateTorusKnot(name: string, options: {
  145769. radius?: number;
  145770. tube?: number;
  145771. radialSegments?: number;
  145772. tubularSegments?: number;
  145773. p?: number;
  145774. q?: number;
  145775. updatable?: boolean;
  145776. sideOrientation?: number;
  145777. frontUVs?: Vector4;
  145778. backUVs?: Vector4;
  145779. }, scene?: Nullable<Scene>): Mesh;
  145780. /**
  145781. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  145782. * * 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
  145783. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  145784. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  145785. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  145786. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  145787. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  145788. * * 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
  145789. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  145790. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145791. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  145792. * @param name defines the name of the new line system
  145793. * @param options defines the options used to create the line system
  145794. * @param scene defines the hosting scene
  145795. * @returns a new line system mesh
  145796. */
  145797. static CreateLineSystem(name: string, options: {
  145798. lines: Vector3[][];
  145799. updatable?: boolean;
  145800. instance?: Nullable<LinesMesh>;
  145801. colors?: Nullable<Color4[][]>;
  145802. useVertexAlpha?: boolean;
  145803. }, scene: Nullable<Scene>): LinesMesh;
  145804. /**
  145805. * Creates a line mesh
  145806. * 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
  145807. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  145808. * * The parameter `points` is an array successive Vector3
  145809. * * 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
  145810. * * The optional parameter `colors` is an array of successive Color4, one per line point
  145811. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  145812. * * When updating an instance, remember that only point positions can change, not the number of points
  145813. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145814. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  145815. * @param name defines the name of the new line system
  145816. * @param options defines the options used to create the line system
  145817. * @param scene defines the hosting scene
  145818. * @returns a new line mesh
  145819. */
  145820. static CreateLines(name: string, options: {
  145821. points: Vector3[];
  145822. updatable?: boolean;
  145823. instance?: Nullable<LinesMesh>;
  145824. colors?: Color4[];
  145825. useVertexAlpha?: boolean;
  145826. }, scene?: Nullable<Scene>): LinesMesh;
  145827. /**
  145828. * Creates a dashed line mesh
  145829. * * 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
  145830. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  145831. * * The parameter `points` is an array successive Vector3
  145832. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  145833. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  145834. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  145835. * * 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
  145836. * * When updating an instance, remember that only point positions can change, not the number of points
  145837. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145838. * @param name defines the name of the mesh
  145839. * @param options defines the options used to create the mesh
  145840. * @param scene defines the hosting scene
  145841. * @returns the dashed line mesh
  145842. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  145843. */
  145844. static CreateDashedLines(name: string, options: {
  145845. points: Vector3[];
  145846. dashSize?: number;
  145847. gapSize?: number;
  145848. dashNb?: number;
  145849. updatable?: boolean;
  145850. instance?: LinesMesh;
  145851. }, scene?: Nullable<Scene>): LinesMesh;
  145852. /**
  145853. * 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.
  145854. * * 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.
  145855. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  145856. * * 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.
  145857. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  145858. * * 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
  145859. * * 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
  145860. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  145861. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145862. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145863. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  145864. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145865. * @param name defines the name of the mesh
  145866. * @param options defines the options used to create the mesh
  145867. * @param scene defines the hosting scene
  145868. * @returns the extruded shape mesh
  145869. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  145870. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  145871. */
  145872. static ExtrudeShape(name: string, options: {
  145873. shape: Vector3[];
  145874. path: Vector3[];
  145875. scale?: number;
  145876. rotation?: number;
  145877. cap?: number;
  145878. updatable?: boolean;
  145879. sideOrientation?: number;
  145880. frontUVs?: Vector4;
  145881. backUVs?: Vector4;
  145882. instance?: Mesh;
  145883. invertUV?: boolean;
  145884. }, scene?: Nullable<Scene>): Mesh;
  145885. /**
  145886. * Creates an custom extruded shape mesh.
  145887. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  145888. * * 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.
  145889. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  145890. * * 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
  145891. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  145892. * * 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
  145893. * * It must returns a float value that will be the scale value applied to the shape on each path point
  145894. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  145895. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  145896. * * 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
  145897. * * 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
  145898. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  145899. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145900. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145901. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  145902. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145903. * @param name defines the name of the mesh
  145904. * @param options defines the options used to create the mesh
  145905. * @param scene defines the hosting scene
  145906. * @returns the custom extruded shape mesh
  145907. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  145908. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  145909. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  145910. */
  145911. static ExtrudeShapeCustom(name: string, options: {
  145912. shape: Vector3[];
  145913. path: Vector3[];
  145914. scaleFunction?: any;
  145915. rotationFunction?: any;
  145916. ribbonCloseArray?: boolean;
  145917. ribbonClosePath?: boolean;
  145918. cap?: number;
  145919. updatable?: boolean;
  145920. sideOrientation?: number;
  145921. frontUVs?: Vector4;
  145922. backUVs?: Vector4;
  145923. instance?: Mesh;
  145924. invertUV?: boolean;
  145925. }, scene?: Nullable<Scene>): Mesh;
  145926. /**
  145927. * Creates lathe mesh.
  145928. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  145929. * * 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
  145930. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  145931. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  145932. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  145933. * * 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
  145934. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  145935. * * 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
  145936. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145937. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145938. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  145939. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145940. * @param name defines the name of the mesh
  145941. * @param options defines the options used to create the mesh
  145942. * @param scene defines the hosting scene
  145943. * @returns the lathe mesh
  145944. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  145945. */
  145946. static CreateLathe(name: string, options: {
  145947. shape: Vector3[];
  145948. radius?: number;
  145949. tessellation?: number;
  145950. clip?: number;
  145951. arc?: number;
  145952. closed?: boolean;
  145953. updatable?: boolean;
  145954. sideOrientation?: number;
  145955. frontUVs?: Vector4;
  145956. backUVs?: Vector4;
  145957. cap?: number;
  145958. invertUV?: boolean;
  145959. }, scene?: Nullable<Scene>): Mesh;
  145960. /**
  145961. * Creates a tiled plane mesh
  145962. * * You can set a limited pattern arrangement with the tiles
  145963. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145964. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145965. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145966. * @param name defines the name of the mesh
  145967. * @param options defines the options used to create the mesh
  145968. * @param scene defines the hosting scene
  145969. * @returns the plane mesh
  145970. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  145971. */
  145972. static CreateTiledPlane(name: string, options: {
  145973. pattern?: number;
  145974. tileSize?: number;
  145975. tileWidth?: number;
  145976. tileHeight?: number;
  145977. size?: number;
  145978. width?: number;
  145979. height?: number;
  145980. alignHorizontal?: number;
  145981. alignVertical?: number;
  145982. sideOrientation?: number;
  145983. frontUVs?: Vector4;
  145984. backUVs?: Vector4;
  145985. updatable?: boolean;
  145986. }, scene?: Nullable<Scene>): Mesh;
  145987. /**
  145988. * Creates a plane mesh
  145989. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  145990. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  145991. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  145992. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145993. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145994. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145995. * @param name defines the name of the mesh
  145996. * @param options defines the options used to create the mesh
  145997. * @param scene defines the hosting scene
  145998. * @returns the plane mesh
  145999. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  146000. */
  146001. static CreatePlane(name: string, options: {
  146002. size?: number;
  146003. width?: number;
  146004. height?: number;
  146005. sideOrientation?: number;
  146006. frontUVs?: Vector4;
  146007. backUVs?: Vector4;
  146008. updatable?: boolean;
  146009. sourcePlane?: Plane;
  146010. }, scene?: Nullable<Scene>): Mesh;
  146011. /**
  146012. * Creates a ground mesh
  146013. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  146014. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  146015. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  146016. * @param name defines the name of the mesh
  146017. * @param options defines the options used to create the mesh
  146018. * @param scene defines the hosting scene
  146019. * @returns the ground mesh
  146020. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  146021. */
  146022. static CreateGround(name: string, options: {
  146023. width?: number;
  146024. height?: number;
  146025. subdivisions?: number;
  146026. subdivisionsX?: number;
  146027. subdivisionsY?: number;
  146028. updatable?: boolean;
  146029. }, scene?: Nullable<Scene>): Mesh;
  146030. /**
  146031. * Creates a tiled ground mesh
  146032. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  146033. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  146034. * * 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
  146035. * * 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
  146036. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  146037. * @param name defines the name of the mesh
  146038. * @param options defines the options used to create the mesh
  146039. * @param scene defines the hosting scene
  146040. * @returns the tiled ground mesh
  146041. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  146042. */
  146043. static CreateTiledGround(name: string, options: {
  146044. xmin: number;
  146045. zmin: number;
  146046. xmax: number;
  146047. zmax: number;
  146048. subdivisions?: {
  146049. w: number;
  146050. h: number;
  146051. };
  146052. precision?: {
  146053. w: number;
  146054. h: number;
  146055. };
  146056. updatable?: boolean;
  146057. }, scene?: Nullable<Scene>): Mesh;
  146058. /**
  146059. * Creates a ground mesh from a height map
  146060. * * The parameter `url` sets the URL of the height map image resource.
  146061. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  146062. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  146063. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  146064. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  146065. * * 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.
  146066. * * 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).
  146067. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  146068. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  146069. * @param name defines the name of the mesh
  146070. * @param url defines the url to the height map
  146071. * @param options defines the options used to create the mesh
  146072. * @param scene defines the hosting scene
  146073. * @returns the ground mesh
  146074. * @see https://doc.babylonjs.com/babylon101/height_map
  146075. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  146076. */
  146077. static CreateGroundFromHeightMap(name: string, url: string, options: {
  146078. width?: number;
  146079. height?: number;
  146080. subdivisions?: number;
  146081. minHeight?: number;
  146082. maxHeight?: number;
  146083. colorFilter?: Color3;
  146084. alphaFilter?: number;
  146085. updatable?: boolean;
  146086. onReady?: (mesh: GroundMesh) => void;
  146087. }, scene?: Nullable<Scene>): GroundMesh;
  146088. /**
  146089. * Creates a polygon mesh
  146090. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  146091. * * 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
  146092. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  146093. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  146094. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  146095. * * Remember you can only change the shape positions, not their number when updating a polygon
  146096. * @param name defines the name of the mesh
  146097. * @param options defines the options used to create the mesh
  146098. * @param scene defines the hosting scene
  146099. * @param earcutInjection can be used to inject your own earcut reference
  146100. * @returns the polygon mesh
  146101. */
  146102. static CreatePolygon(name: string, options: {
  146103. shape: Vector3[];
  146104. holes?: Vector3[][];
  146105. depth?: number;
  146106. faceUV?: Vector4[];
  146107. faceColors?: Color4[];
  146108. updatable?: boolean;
  146109. sideOrientation?: number;
  146110. frontUVs?: Vector4;
  146111. backUVs?: Vector4;
  146112. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  146113. /**
  146114. * Creates an extruded polygon mesh, with depth in the Y direction.
  146115. * * 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)
  146116. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  146117. * @param name defines the name of the mesh
  146118. * @param options defines the options used to create the mesh
  146119. * @param scene defines the hosting scene
  146120. * @param earcutInjection can be used to inject your own earcut reference
  146121. * @returns the polygon mesh
  146122. */
  146123. static ExtrudePolygon(name: string, options: {
  146124. shape: Vector3[];
  146125. holes?: Vector3[][];
  146126. depth?: number;
  146127. faceUV?: Vector4[];
  146128. faceColors?: Color4[];
  146129. updatable?: boolean;
  146130. sideOrientation?: number;
  146131. frontUVs?: Vector4;
  146132. backUVs?: Vector4;
  146133. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  146134. /**
  146135. * Creates a tube mesh.
  146136. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  146137. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  146138. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  146139. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  146140. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  146141. * * 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)
  146142. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  146143. * * 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
  146144. * * 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
  146145. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  146146. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  146147. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  146148. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  146149. * @param name defines the name of the mesh
  146150. * @param options defines the options used to create the mesh
  146151. * @param scene defines the hosting scene
  146152. * @returns the tube mesh
  146153. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  146154. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  146155. */
  146156. static CreateTube(name: string, options: {
  146157. path: Vector3[];
  146158. radius?: number;
  146159. tessellation?: number;
  146160. radiusFunction?: {
  146161. (i: number, distance: number): number;
  146162. };
  146163. cap?: number;
  146164. arc?: number;
  146165. updatable?: boolean;
  146166. sideOrientation?: number;
  146167. frontUVs?: Vector4;
  146168. backUVs?: Vector4;
  146169. instance?: Mesh;
  146170. invertUV?: boolean;
  146171. }, scene?: Nullable<Scene>): Mesh;
  146172. /**
  146173. * Creates a polyhedron mesh
  146174. * * 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
  146175. * * The parameter `size` (positive float, default 1) sets the polygon size
  146176. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  146177. * * 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`
  146178. * * 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
  146179. * * 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)`)
  146180. * * 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
  146181. * * 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
  146182. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  146183. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  146184. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  146185. * @param name defines the name of the mesh
  146186. * @param options defines the options used to create the mesh
  146187. * @param scene defines the hosting scene
  146188. * @returns the polyhedron mesh
  146189. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  146190. */
  146191. static CreatePolyhedron(name: string, options: {
  146192. type?: number;
  146193. size?: number;
  146194. sizeX?: number;
  146195. sizeY?: number;
  146196. sizeZ?: number;
  146197. custom?: any;
  146198. faceUV?: Vector4[];
  146199. faceColors?: Color4[];
  146200. flat?: boolean;
  146201. updatable?: boolean;
  146202. sideOrientation?: number;
  146203. frontUVs?: Vector4;
  146204. backUVs?: Vector4;
  146205. }, scene?: Nullable<Scene>): Mesh;
  146206. /**
  146207. * Creates a decal mesh.
  146208. * 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
  146209. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  146210. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  146211. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  146212. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  146213. * @param name defines the name of the mesh
  146214. * @param sourceMesh defines the mesh where the decal must be applied
  146215. * @param options defines the options used to create the mesh
  146216. * @param scene defines the hosting scene
  146217. * @returns the decal mesh
  146218. * @see https://doc.babylonjs.com/how_to/decals
  146219. */
  146220. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  146221. position?: Vector3;
  146222. normal?: Vector3;
  146223. size?: Vector3;
  146224. angle?: number;
  146225. }): Mesh;
  146226. }
  146227. }
  146228. declare module BABYLON {
  146229. /**
  146230. * A simplifier interface for future simplification implementations
  146231. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146232. */
  146233. export interface ISimplifier {
  146234. /**
  146235. * Simplification of a given mesh according to the given settings.
  146236. * Since this requires computation, it is assumed that the function runs async.
  146237. * @param settings The settings of the simplification, including quality and distance
  146238. * @param successCallback A callback that will be called after the mesh was simplified.
  146239. * @param errorCallback in case of an error, this callback will be called. optional.
  146240. */
  146241. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMeshes: Mesh) => void, errorCallback?: () => void): void;
  146242. }
  146243. /**
  146244. * Expected simplification settings.
  146245. * Quality should be between 0 and 1 (1 being 100%, 0 being 0%)
  146246. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146247. */
  146248. export interface ISimplificationSettings {
  146249. /**
  146250. * Gets or sets the expected quality
  146251. */
  146252. quality: number;
  146253. /**
  146254. * Gets or sets the distance when this optimized version should be used
  146255. */
  146256. distance: number;
  146257. /**
  146258. * Gets an already optimized mesh
  146259. */
  146260. optimizeMesh?: boolean;
  146261. }
  146262. /**
  146263. * Class used to specify simplification options
  146264. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146265. */
  146266. export class SimplificationSettings implements ISimplificationSettings {
  146267. /** expected quality */
  146268. quality: number;
  146269. /** distance when this optimized version should be used */
  146270. distance: number;
  146271. /** already optimized mesh */
  146272. optimizeMesh?: boolean | undefined;
  146273. /**
  146274. * Creates a SimplificationSettings
  146275. * @param quality expected quality
  146276. * @param distance distance when this optimized version should be used
  146277. * @param optimizeMesh already optimized mesh
  146278. */
  146279. constructor(
  146280. /** expected quality */
  146281. quality: number,
  146282. /** distance when this optimized version should be used */
  146283. distance: number,
  146284. /** already optimized mesh */
  146285. optimizeMesh?: boolean | undefined);
  146286. }
  146287. /**
  146288. * Interface used to define a simplification task
  146289. */
  146290. export interface ISimplificationTask {
  146291. /**
  146292. * Array of settings
  146293. */
  146294. settings: Array<ISimplificationSettings>;
  146295. /**
  146296. * Simplification type
  146297. */
  146298. simplificationType: SimplificationType;
  146299. /**
  146300. * Mesh to simplify
  146301. */
  146302. mesh: Mesh;
  146303. /**
  146304. * Callback called on success
  146305. */
  146306. successCallback?: () => void;
  146307. /**
  146308. * Defines if parallel processing can be used
  146309. */
  146310. parallelProcessing: boolean;
  146311. }
  146312. /**
  146313. * Queue used to order the simplification tasks
  146314. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146315. */
  146316. export class SimplificationQueue {
  146317. private _simplificationArray;
  146318. /**
  146319. * Gets a boolean indicating that the process is still running
  146320. */
  146321. running: boolean;
  146322. /**
  146323. * Creates a new queue
  146324. */
  146325. constructor();
  146326. /**
  146327. * Adds a new simplification task
  146328. * @param task defines a task to add
  146329. */
  146330. addTask(task: ISimplificationTask): void;
  146331. /**
  146332. * Execute next task
  146333. */
  146334. executeNext(): void;
  146335. /**
  146336. * Execute a simplification task
  146337. * @param task defines the task to run
  146338. */
  146339. runSimplification(task: ISimplificationTask): void;
  146340. private getSimplifier;
  146341. }
  146342. /**
  146343. * The implemented types of simplification
  146344. * At the moment only Quadratic Error Decimation is implemented
  146345. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146346. */
  146347. export enum SimplificationType {
  146348. /** Quadratic error decimation */
  146349. QUADRATIC = 0
  146350. }
  146351. /**
  146352. * An implementation of the Quadratic Error simplification algorithm.
  146353. * Original paper : http://www1.cs.columbia.edu/~cs4162/html05s/garland97.pdf
  146354. * Ported mostly from QSlim and http://voxels.blogspot.de/2014/05/quadric-mesh-simplification-with-source.html to babylon JS
  146355. * @author RaananW
  146356. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146357. */
  146358. export class QuadraticErrorSimplification implements ISimplifier {
  146359. private _mesh;
  146360. private triangles;
  146361. private vertices;
  146362. private references;
  146363. private _reconstructedMesh;
  146364. /** Gets or sets the number pf sync interations */
  146365. syncIterations: number;
  146366. /** Gets or sets the aggressiveness of the simplifier */
  146367. aggressiveness: number;
  146368. /** Gets or sets the number of allowed iterations for decimation */
  146369. decimationIterations: number;
  146370. /** Gets or sets the espilon to use for bounding box computation */
  146371. boundingBoxEpsilon: number;
  146372. /**
  146373. * Creates a new QuadraticErrorSimplification
  146374. * @param _mesh defines the target mesh
  146375. */
  146376. constructor(_mesh: Mesh);
  146377. /**
  146378. * Simplification of a given mesh according to the given settings.
  146379. * Since this requires computation, it is assumed that the function runs async.
  146380. * @param settings The settings of the simplification, including quality and distance
  146381. * @param successCallback A callback that will be called after the mesh was simplified.
  146382. */
  146383. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMesh: Mesh) => void): void;
  146384. private runDecimation;
  146385. private initWithMesh;
  146386. private init;
  146387. private reconstructMesh;
  146388. private initDecimatedMesh;
  146389. private isFlipped;
  146390. private updateTriangles;
  146391. private identifyBorder;
  146392. private updateMesh;
  146393. private vertexError;
  146394. private calculateError;
  146395. }
  146396. }
  146397. declare module BABYLON {
  146398. interface Scene {
  146399. /** @hidden (Backing field) */
  146400. _simplificationQueue: SimplificationQueue;
  146401. /**
  146402. * Gets or sets the simplification queue attached to the scene
  146403. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146404. */
  146405. simplificationQueue: SimplificationQueue;
  146406. }
  146407. interface Mesh {
  146408. /**
  146409. * Simplify the mesh according to the given array of settings.
  146410. * Function will return immediately and will simplify async
  146411. * @param settings a collection of simplification settings
  146412. * @param parallelProcessing should all levels calculate parallel or one after the other
  146413. * @param simplificationType the type of simplification to run
  146414. * @param successCallback optional success callback to be called after the simplification finished processing all settings
  146415. * @returns the current mesh
  146416. */
  146417. simplify(settings: Array<ISimplificationSettings>, parallelProcessing?: boolean, simplificationType?: SimplificationType, successCallback?: (mesh?: Mesh, submeshIndex?: number) => void): Mesh;
  146418. }
  146419. /**
  146420. * Defines the simplification queue scene component responsible to help scheduling the various simplification task
  146421. * created in a scene
  146422. */
  146423. export class SimplicationQueueSceneComponent implements ISceneComponent {
  146424. /**
  146425. * The component name helpfull to identify the component in the list of scene components.
  146426. */
  146427. readonly name: string;
  146428. /**
  146429. * The scene the component belongs to.
  146430. */
  146431. scene: Scene;
  146432. /**
  146433. * Creates a new instance of the component for the given scene
  146434. * @param scene Defines the scene to register the component in
  146435. */
  146436. constructor(scene: Scene);
  146437. /**
  146438. * Registers the component in a given scene
  146439. */
  146440. register(): void;
  146441. /**
  146442. * Rebuilds the elements related to this component in case of
  146443. * context lost for instance.
  146444. */
  146445. rebuild(): void;
  146446. /**
  146447. * Disposes the component and the associated ressources
  146448. */
  146449. dispose(): void;
  146450. private _beforeCameraUpdate;
  146451. }
  146452. }
  146453. declare module BABYLON {
  146454. interface Mesh {
  146455. /**
  146456. * Gets or sets a boolean defining if we want picking to pick thin instances as well
  146457. */
  146458. thinInstanceEnablePicking: boolean;
  146459. /**
  146460. * Creates a new thin instance
  146461. * @param matrix the matrix or array of matrices (position, rotation, scale) of the thin instance(s) to create
  146462. * @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
  146463. * @returns the thin instance index number. If you pass an array of matrices, other instance indexes are index+1, index+2, etc
  146464. */
  146465. thinInstanceAdd(matrix: DeepImmutableObject<Matrix> | Array<DeepImmutableObject<Matrix>>, refresh: boolean): number;
  146466. /**
  146467. * Adds the transformation (matrix) of the current mesh as a thin instance
  146468. * @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
  146469. * @returns the thin instance index number
  146470. */
  146471. thinInstanceAddSelf(refresh: boolean): number;
  146472. /**
  146473. * Registers a custom attribute to be used with thin instances
  146474. * @param kind name of the attribute
  146475. * @param stride size in floats of the attribute
  146476. */
  146477. thinInstanceRegisterAttribute(kind: string, stride: number): void;
  146478. /**
  146479. * Sets the matrix of a thin instance
  146480. * @param index index of the thin instance
  146481. * @param matrix matrix to set
  146482. * @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
  146483. */
  146484. thinInstanceSetMatrixAt(index: number, matrix: DeepImmutableObject<Matrix>, refresh: boolean): void;
  146485. /**
  146486. * Sets the value of a custom attribute for a thin instance
  146487. * @param kind name of the attribute
  146488. * @param index index of the thin instance
  146489. * @param value value to set
  146490. * @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
  146491. */
  146492. thinInstanceSetAttributeAt(kind: string, index: number, value: Array<number>, refresh: boolean): void;
  146493. /**
  146494. * 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.
  146495. */
  146496. thinInstanceCount: number;
  146497. /**
  146498. * Sets a buffer to be used with thin instances. This method is a faster way to setup multiple instances than calling thinInstanceAdd repeatedly
  146499. * @param kind name of the attribute. Use "matrix" to setup the buffer of matrices
  146500. * @param buffer buffer to set
  146501. * @param stride size in floats of each value of the buffer
  146502. * @param staticBuffer indicates that the buffer is static, so that you won't change it after it is set (better performances - false by default)
  146503. */
  146504. thinInstanceSetBuffer(kind: string, buffer: Nullable<Float32Array>, stride: number, staticBuffer: boolean): void;
  146505. /**
  146506. * Gets the list of world matrices
  146507. * @return an array containing all the world matrices from the thin instances
  146508. */
  146509. thinInstanceGetWorldMatrices(): Matrix[];
  146510. /**
  146511. * Synchronize the gpu buffers with a thin instance buffer. Call this method if you update later on the buffers passed to thinInstanceSetBuffer
  146512. * @param kind name of the attribute to update. Use "matrix" to update the buffer of matrices
  146513. */
  146514. thinInstanceBufferUpdated(kind: string): void;
  146515. /**
  146516. * Applies a partial update to a buffer directly on the GPU
  146517. * Note that the buffer located on the CPU is NOT updated! It's up to you to update it (or not) with the same data you pass to this method
  146518. * @param kind name of the attribute to update. Use "matrix" to update the buffer of matrices
  146519. * @param data the data to set in the GPU buffer
  146520. * @param offset the offset in the GPU buffer where to update the data
  146521. */
  146522. thinInstancePartialBufferUpdate(kind: string, data: Float32Array, offset: number): void;
  146523. /**
  146524. * Refreshes the bounding info, taking into account all the thin instances defined
  146525. * @param forceRefreshParentInfo true to force recomputing the mesh bounding info and use it to compute the aggregated bounding info
  146526. */
  146527. thinInstanceRefreshBoundingInfo(forceRefreshParentInfo: boolean): void;
  146528. /** @hidden */
  146529. _thinInstanceInitializeUserStorage(): void;
  146530. /** @hidden */
  146531. _thinInstanceUpdateBufferSize(kind: string, numInstances: number): void;
  146532. /** @hidden */
  146533. _userThinInstanceBuffersStorage: {
  146534. data: {
  146535. [key: string]: Float32Array;
  146536. };
  146537. sizes: {
  146538. [key: string]: number;
  146539. };
  146540. vertexBuffers: {
  146541. [key: string]: Nullable<VertexBuffer>;
  146542. };
  146543. strides: {
  146544. [key: string]: number;
  146545. };
  146546. };
  146547. }
  146548. }
  146549. declare module BABYLON {
  146550. /**
  146551. * Navigation plugin interface to add navigation constrained by a navigation mesh
  146552. */
  146553. export interface INavigationEnginePlugin {
  146554. /**
  146555. * plugin name
  146556. */
  146557. name: string;
  146558. /**
  146559. * Creates a navigation mesh
  146560. * @param meshes array of all the geometry used to compute the navigatio mesh
  146561. * @param parameters bunch of parameters used to filter geometry
  146562. */
  146563. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  146564. /**
  146565. * Create a navigation mesh debug mesh
  146566. * @param scene is where the mesh will be added
  146567. * @returns debug display mesh
  146568. */
  146569. createDebugNavMesh(scene: Scene): Mesh;
  146570. /**
  146571. * Get a navigation mesh constrained position, closest to the parameter position
  146572. * @param position world position
  146573. * @returns the closest point to position constrained by the navigation mesh
  146574. */
  146575. getClosestPoint(position: Vector3): Vector3;
  146576. /**
  146577. * Get a navigation mesh constrained position, closest to the parameter position
  146578. * @param position world position
  146579. * @param result output the closest point to position constrained by the navigation mesh
  146580. */
  146581. getClosestPointToRef(position: Vector3, result: Vector3): void;
  146582. /**
  146583. * Get a navigation mesh constrained position, within a particular radius
  146584. * @param position world position
  146585. * @param maxRadius the maximum distance to the constrained world position
  146586. * @returns the closest point to position constrained by the navigation mesh
  146587. */
  146588. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  146589. /**
  146590. * Get a navigation mesh constrained position, within a particular radius
  146591. * @param position world position
  146592. * @param maxRadius the maximum distance to the constrained world position
  146593. * @param result output the closest point to position constrained by the navigation mesh
  146594. */
  146595. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  146596. /**
  146597. * Compute the final position from a segment made of destination-position
  146598. * @param position world position
  146599. * @param destination world position
  146600. * @returns the resulting point along the navmesh
  146601. */
  146602. moveAlong(position: Vector3, destination: Vector3): Vector3;
  146603. /**
  146604. * Compute the final position from a segment made of destination-position
  146605. * @param position world position
  146606. * @param destination world position
  146607. * @param result output the resulting point along the navmesh
  146608. */
  146609. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  146610. /**
  146611. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  146612. * @param start world position
  146613. * @param end world position
  146614. * @returns array containing world position composing the path
  146615. */
  146616. computePath(start: Vector3, end: Vector3): Vector3[];
  146617. /**
  146618. * If this plugin is supported
  146619. * @returns true if plugin is supported
  146620. */
  146621. isSupported(): boolean;
  146622. /**
  146623. * Create a new Crowd so you can add agents
  146624. * @param maxAgents the maximum agent count in the crowd
  146625. * @param maxAgentRadius the maximum radius an agent can have
  146626. * @param scene to attach the crowd to
  146627. * @returns the crowd you can add agents to
  146628. */
  146629. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  146630. /**
  146631. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  146632. * The queries will try to find a solution within those bounds
  146633. * default is (1,1,1)
  146634. * @param extent x,y,z value that define the extent around the queries point of reference
  146635. */
  146636. setDefaultQueryExtent(extent: Vector3): void;
  146637. /**
  146638. * Get the Bounding box extent specified by setDefaultQueryExtent
  146639. * @returns the box extent values
  146640. */
  146641. getDefaultQueryExtent(): Vector3;
  146642. /**
  146643. * build the navmesh from a previously saved state using getNavmeshData
  146644. * @param data the Uint8Array returned by getNavmeshData
  146645. */
  146646. buildFromNavmeshData(data: Uint8Array): void;
  146647. /**
  146648. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  146649. * @returns data the Uint8Array that can be saved and reused
  146650. */
  146651. getNavmeshData(): Uint8Array;
  146652. /**
  146653. * Get the Bounding box extent result specified by setDefaultQueryExtent
  146654. * @param result output the box extent values
  146655. */
  146656. getDefaultQueryExtentToRef(result: Vector3): void;
  146657. /**
  146658. * Release all resources
  146659. */
  146660. dispose(): void;
  146661. }
  146662. /**
  146663. * Crowd Interface. A Crowd is a collection of moving agents constrained by a navigation mesh
  146664. */
  146665. export interface ICrowd {
  146666. /**
  146667. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  146668. * You can attach anything to that node. The node position is updated in the scene update tick.
  146669. * @param pos world position that will be constrained by the navigation mesh
  146670. * @param parameters agent parameters
  146671. * @param transform hooked to the agent that will be update by the scene
  146672. * @returns agent index
  146673. */
  146674. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  146675. /**
  146676. * Returns the agent position in world space
  146677. * @param index agent index returned by addAgent
  146678. * @returns world space position
  146679. */
  146680. getAgentPosition(index: number): Vector3;
  146681. /**
  146682. * Gets the agent position result in world space
  146683. * @param index agent index returned by addAgent
  146684. * @param result output world space position
  146685. */
  146686. getAgentPositionToRef(index: number, result: Vector3): void;
  146687. /**
  146688. * Gets the agent velocity in world space
  146689. * @param index agent index returned by addAgent
  146690. * @returns world space velocity
  146691. */
  146692. getAgentVelocity(index: number): Vector3;
  146693. /**
  146694. * Gets the agent velocity result in world space
  146695. * @param index agent index returned by addAgent
  146696. * @param result output world space velocity
  146697. */
  146698. getAgentVelocityToRef(index: number, result: Vector3): void;
  146699. /**
  146700. * remove a particular agent previously created
  146701. * @param index agent index returned by addAgent
  146702. */
  146703. removeAgent(index: number): void;
  146704. /**
  146705. * get the list of all agents attached to this crowd
  146706. * @returns list of agent indices
  146707. */
  146708. getAgents(): number[];
  146709. /**
  146710. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  146711. * @param deltaTime in seconds
  146712. */
  146713. update(deltaTime: number): void;
  146714. /**
  146715. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  146716. * @param index agent index returned by addAgent
  146717. * @param destination targeted world position
  146718. */
  146719. agentGoto(index: number, destination: Vector3): void;
  146720. /**
  146721. * Teleport the agent to a new position
  146722. * @param index agent index returned by addAgent
  146723. * @param destination targeted world position
  146724. */
  146725. agentTeleport(index: number, destination: Vector3): void;
  146726. /**
  146727. * Update agent parameters
  146728. * @param index agent index returned by addAgent
  146729. * @param parameters agent parameters
  146730. */
  146731. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  146732. /**
  146733. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  146734. * The queries will try to find a solution within those bounds
  146735. * default is (1,1,1)
  146736. * @param extent x,y,z value that define the extent around the queries point of reference
  146737. */
  146738. setDefaultQueryExtent(extent: Vector3): void;
  146739. /**
  146740. * Get the Bounding box extent specified by setDefaultQueryExtent
  146741. * @returns the box extent values
  146742. */
  146743. getDefaultQueryExtent(): Vector3;
  146744. /**
  146745. * Get the Bounding box extent result specified by setDefaultQueryExtent
  146746. * @param result output the box extent values
  146747. */
  146748. getDefaultQueryExtentToRef(result: Vector3): void;
  146749. /**
  146750. * Release all resources
  146751. */
  146752. dispose(): void;
  146753. }
  146754. /**
  146755. * Configures an agent
  146756. */
  146757. export interface IAgentParameters {
  146758. /**
  146759. * Agent radius. [Limit: >= 0]
  146760. */
  146761. radius: number;
  146762. /**
  146763. * Agent height. [Limit: > 0]
  146764. */
  146765. height: number;
  146766. /**
  146767. * Maximum allowed acceleration. [Limit: >= 0]
  146768. */
  146769. maxAcceleration: number;
  146770. /**
  146771. * Maximum allowed speed. [Limit: >= 0]
  146772. */
  146773. maxSpeed: number;
  146774. /**
  146775. * Defines how close a collision element must be before it is considered for steering behaviors. [Limits: > 0]
  146776. */
  146777. collisionQueryRange: number;
  146778. /**
  146779. * The path visibility optimization range. [Limit: > 0]
  146780. */
  146781. pathOptimizationRange: number;
  146782. /**
  146783. * How aggresive the agent manager should be at avoiding collisions with this agent. [Limit: >= 0]
  146784. */
  146785. separationWeight: number;
  146786. }
  146787. /**
  146788. * Configures the navigation mesh creation
  146789. */
  146790. export interface INavMeshParameters {
  146791. /**
  146792. * The xz-plane cell size to use for fields. [Limit: > 0] [Units: wu]
  146793. */
  146794. cs: number;
  146795. /**
  146796. * The y-axis cell size to use for fields. [Limit: > 0] [Units: wu]
  146797. */
  146798. ch: number;
  146799. /**
  146800. * The maximum slope that is considered walkable. [Limits: 0 <= value < 90] [Units: Degrees]
  146801. */
  146802. walkableSlopeAngle: number;
  146803. /**
  146804. * Minimum floor to 'ceiling' height that will still allow the floor area to
  146805. * be considered walkable. [Limit: >= 3] [Units: vx]
  146806. */
  146807. walkableHeight: number;
  146808. /**
  146809. * Maximum ledge height that is considered to still be traversable. [Limit: >=0] [Units: vx]
  146810. */
  146811. walkableClimb: number;
  146812. /**
  146813. * The distance to erode/shrink the walkable area of the heightfield away from
  146814. * obstructions. [Limit: >=0] [Units: vx]
  146815. */
  146816. walkableRadius: number;
  146817. /**
  146818. * The maximum allowed length for contour edges along the border of the mesh. [Limit: >=0] [Units: vx]
  146819. */
  146820. maxEdgeLen: number;
  146821. /**
  146822. * The maximum distance a simplfied contour's border edges should deviate
  146823. * the original raw contour. [Limit: >=0] [Units: vx]
  146824. */
  146825. maxSimplificationError: number;
  146826. /**
  146827. * The minimum number of cells allowed to form isolated island areas. [Limit: >=0] [Units: vx]
  146828. */
  146829. minRegionArea: number;
  146830. /**
  146831. * Any regions with a span count smaller than this value will, if possible,
  146832. * be merged with larger regions. [Limit: >=0] [Units: vx]
  146833. */
  146834. mergeRegionArea: number;
  146835. /**
  146836. * The maximum number of vertices allowed for polygons generated during the
  146837. * contour to polygon conversion process. [Limit: >= 3]
  146838. */
  146839. maxVertsPerPoly: number;
  146840. /**
  146841. * Sets the sampling distance to use when generating the detail mesh.
  146842. * (For height detail only.) [Limits: 0 or >= 0.9] [Units: wu]
  146843. */
  146844. detailSampleDist: number;
  146845. /**
  146846. * The maximum distance the detail mesh surface should deviate from heightfield
  146847. * data. (For height detail only.) [Limit: >=0] [Units: wu]
  146848. */
  146849. detailSampleMaxError: number;
  146850. }
  146851. }
  146852. declare module BABYLON {
  146853. /**
  146854. * RecastJS navigation plugin
  146855. */
  146856. export class RecastJSPlugin implements INavigationEnginePlugin {
  146857. /**
  146858. * Reference to the Recast library
  146859. */
  146860. bjsRECAST: any;
  146861. /**
  146862. * plugin name
  146863. */
  146864. name: string;
  146865. /**
  146866. * the first navmesh created. We might extend this to support multiple navmeshes
  146867. */
  146868. navMesh: any;
  146869. /**
  146870. * Initializes the recastJS plugin
  146871. * @param recastInjection can be used to inject your own recast reference
  146872. */
  146873. constructor(recastInjection?: any);
  146874. /**
  146875. * Creates a navigation mesh
  146876. * @param meshes array of all the geometry used to compute the navigatio mesh
  146877. * @param parameters bunch of parameters used to filter geometry
  146878. */
  146879. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  146880. /**
  146881. * Create a navigation mesh debug mesh
  146882. * @param scene is where the mesh will be added
  146883. * @returns debug display mesh
  146884. */
  146885. createDebugNavMesh(scene: Scene): Mesh;
  146886. /**
  146887. * Get a navigation mesh constrained position, closest to the parameter position
  146888. * @param position world position
  146889. * @returns the closest point to position constrained by the navigation mesh
  146890. */
  146891. getClosestPoint(position: Vector3): Vector3;
  146892. /**
  146893. * Get a navigation mesh constrained position, closest to the parameter position
  146894. * @param position world position
  146895. * @param result output the closest point to position constrained by the navigation mesh
  146896. */
  146897. getClosestPointToRef(position: Vector3, result: Vector3): void;
  146898. /**
  146899. * Get a navigation mesh constrained position, within a particular radius
  146900. * @param position world position
  146901. * @param maxRadius the maximum distance to the constrained world position
  146902. * @returns the closest point to position constrained by the navigation mesh
  146903. */
  146904. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  146905. /**
  146906. * Get a navigation mesh constrained position, within a particular radius
  146907. * @param position world position
  146908. * @param maxRadius the maximum distance to the constrained world position
  146909. * @param result output the closest point to position constrained by the navigation mesh
  146910. */
  146911. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  146912. /**
  146913. * Compute the final position from a segment made of destination-position
  146914. * @param position world position
  146915. * @param destination world position
  146916. * @returns the resulting point along the navmesh
  146917. */
  146918. moveAlong(position: Vector3, destination: Vector3): Vector3;
  146919. /**
  146920. * Compute the final position from a segment made of destination-position
  146921. * @param position world position
  146922. * @param destination world position
  146923. * @param result output the resulting point along the navmesh
  146924. */
  146925. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  146926. /**
  146927. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  146928. * @param start world position
  146929. * @param end world position
  146930. * @returns array containing world position composing the path
  146931. */
  146932. computePath(start: Vector3, end: Vector3): Vector3[];
  146933. /**
  146934. * Create a new Crowd so you can add agents
  146935. * @param maxAgents the maximum agent count in the crowd
  146936. * @param maxAgentRadius the maximum radius an agent can have
  146937. * @param scene to attach the crowd to
  146938. * @returns the crowd you can add agents to
  146939. */
  146940. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  146941. /**
  146942. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  146943. * The queries will try to find a solution within those bounds
  146944. * default is (1,1,1)
  146945. * @param extent x,y,z value that define the extent around the queries point of reference
  146946. */
  146947. setDefaultQueryExtent(extent: Vector3): void;
  146948. /**
  146949. * Get the Bounding box extent specified by setDefaultQueryExtent
  146950. * @returns the box extent values
  146951. */
  146952. getDefaultQueryExtent(): Vector3;
  146953. /**
  146954. * build the navmesh from a previously saved state using getNavmeshData
  146955. * @param data the Uint8Array returned by getNavmeshData
  146956. */
  146957. buildFromNavmeshData(data: Uint8Array): void;
  146958. /**
  146959. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  146960. * @returns data the Uint8Array that can be saved and reused
  146961. */
  146962. getNavmeshData(): Uint8Array;
  146963. /**
  146964. * Get the Bounding box extent result specified by setDefaultQueryExtent
  146965. * @param result output the box extent values
  146966. */
  146967. getDefaultQueryExtentToRef(result: Vector3): void;
  146968. /**
  146969. * Disposes
  146970. */
  146971. dispose(): void;
  146972. /**
  146973. * If this plugin is supported
  146974. * @returns true if plugin is supported
  146975. */
  146976. isSupported(): boolean;
  146977. }
  146978. /**
  146979. * Recast detour crowd implementation
  146980. */
  146981. export class RecastJSCrowd implements ICrowd {
  146982. /**
  146983. * Recast/detour plugin
  146984. */
  146985. bjsRECASTPlugin: RecastJSPlugin;
  146986. /**
  146987. * Link to the detour crowd
  146988. */
  146989. recastCrowd: any;
  146990. /**
  146991. * One transform per agent
  146992. */
  146993. transforms: TransformNode[];
  146994. /**
  146995. * All agents created
  146996. */
  146997. agents: number[];
  146998. /**
  146999. * Link to the scene is kept to unregister the crowd from the scene
  147000. */
  147001. private _scene;
  147002. /**
  147003. * Observer for crowd updates
  147004. */
  147005. private _onBeforeAnimationsObserver;
  147006. /**
  147007. * Constructor
  147008. * @param plugin recastJS plugin
  147009. * @param maxAgents the maximum agent count in the crowd
  147010. * @param maxAgentRadius the maximum radius an agent can have
  147011. * @param scene to attach the crowd to
  147012. * @returns the crowd you can add agents to
  147013. */
  147014. constructor(plugin: RecastJSPlugin, maxAgents: number, maxAgentRadius: number, scene: Scene);
  147015. /**
  147016. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  147017. * You can attach anything to that node. The node position is updated in the scene update tick.
  147018. * @param pos world position that will be constrained by the navigation mesh
  147019. * @param parameters agent parameters
  147020. * @param transform hooked to the agent that will be update by the scene
  147021. * @returns agent index
  147022. */
  147023. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  147024. /**
  147025. * Returns the agent position in world space
  147026. * @param index agent index returned by addAgent
  147027. * @returns world space position
  147028. */
  147029. getAgentPosition(index: number): Vector3;
  147030. /**
  147031. * Returns the agent position result in world space
  147032. * @param index agent index returned by addAgent
  147033. * @param result output world space position
  147034. */
  147035. getAgentPositionToRef(index: number, result: Vector3): void;
  147036. /**
  147037. * Returns the agent velocity in world space
  147038. * @param index agent index returned by addAgent
  147039. * @returns world space velocity
  147040. */
  147041. getAgentVelocity(index: number): Vector3;
  147042. /**
  147043. * Returns the agent velocity result in world space
  147044. * @param index agent index returned by addAgent
  147045. * @param result output world space velocity
  147046. */
  147047. getAgentVelocityToRef(index: number, result: Vector3): void;
  147048. /**
  147049. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  147050. * @param index agent index returned by addAgent
  147051. * @param destination targeted world position
  147052. */
  147053. agentGoto(index: number, destination: Vector3): void;
  147054. /**
  147055. * Teleport the agent to a new position
  147056. * @param index agent index returned by addAgent
  147057. * @param destination targeted world position
  147058. */
  147059. agentTeleport(index: number, destination: Vector3): void;
  147060. /**
  147061. * Update agent parameters
  147062. * @param index agent index returned by addAgent
  147063. * @param parameters agent parameters
  147064. */
  147065. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  147066. /**
  147067. * remove a particular agent previously created
  147068. * @param index agent index returned by addAgent
  147069. */
  147070. removeAgent(index: number): void;
  147071. /**
  147072. * get the list of all agents attached to this crowd
  147073. * @returns list of agent indices
  147074. */
  147075. getAgents(): number[];
  147076. /**
  147077. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  147078. * @param deltaTime in seconds
  147079. */
  147080. update(deltaTime: number): void;
  147081. /**
  147082. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  147083. * The queries will try to find a solution within those bounds
  147084. * default is (1,1,1)
  147085. * @param extent x,y,z value that define the extent around the queries point of reference
  147086. */
  147087. setDefaultQueryExtent(extent: Vector3): void;
  147088. /**
  147089. * Get the Bounding box extent specified by setDefaultQueryExtent
  147090. * @returns the box extent values
  147091. */
  147092. getDefaultQueryExtent(): Vector3;
  147093. /**
  147094. * Get the Bounding box extent result specified by setDefaultQueryExtent
  147095. * @param result output the box extent values
  147096. */
  147097. getDefaultQueryExtentToRef(result: Vector3): void;
  147098. /**
  147099. * Release all resources
  147100. */
  147101. dispose(): void;
  147102. }
  147103. }
  147104. declare module BABYLON {
  147105. /**
  147106. * Class used to enable access to IndexedDB
  147107. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  147108. */
  147109. export class Database implements IOfflineProvider {
  147110. private _callbackManifestChecked;
  147111. private _currentSceneUrl;
  147112. private _db;
  147113. private _enableSceneOffline;
  147114. private _enableTexturesOffline;
  147115. private _manifestVersionFound;
  147116. private _mustUpdateRessources;
  147117. private _hasReachedQuota;
  147118. private _isSupported;
  147119. private _idbFactory;
  147120. /** Gets a boolean indicating if the user agent supports blob storage (this value will be updated after creating the first Database object) */
  147121. private static IsUASupportingBlobStorage;
  147122. /**
  147123. * Gets a boolean indicating if Database storate is enabled (off by default)
  147124. */
  147125. static IDBStorageEnabled: boolean;
  147126. /**
  147127. * Gets a boolean indicating if scene must be saved in the database
  147128. */
  147129. get enableSceneOffline(): boolean;
  147130. /**
  147131. * Gets a boolean indicating if textures must be saved in the database
  147132. */
  147133. get enableTexturesOffline(): boolean;
  147134. /**
  147135. * Creates a new Database
  147136. * @param urlToScene defines the url to load the scene
  147137. * @param callbackManifestChecked defines the callback to use when manifest is checked
  147138. * @param disableManifestCheck defines a boolean indicating that we want to skip the manifest validation (it will be considered validated and up to date)
  147139. */
  147140. constructor(urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck?: boolean);
  147141. private static _ParseURL;
  147142. private static _ReturnFullUrlLocation;
  147143. private _checkManifestFile;
  147144. /**
  147145. * Open the database and make it available
  147146. * @param successCallback defines the callback to call on success
  147147. * @param errorCallback defines the callback to call on error
  147148. */
  147149. open(successCallback: () => void, errorCallback: () => void): void;
  147150. /**
  147151. * Loads an image from the database
  147152. * @param url defines the url to load from
  147153. * @param image defines the target DOM image
  147154. */
  147155. loadImage(url: string, image: HTMLImageElement): void;
  147156. private _loadImageFromDBAsync;
  147157. private _saveImageIntoDBAsync;
  147158. private _checkVersionFromDB;
  147159. private _loadVersionFromDBAsync;
  147160. private _saveVersionIntoDBAsync;
  147161. /**
  147162. * Loads a file from database
  147163. * @param url defines the URL to load from
  147164. * @param sceneLoaded defines a callback to call on success
  147165. * @param progressCallBack defines a callback to call when progress changed
  147166. * @param errorCallback defines a callback to call on error
  147167. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  147168. */
  147169. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  147170. private _loadFileAsync;
  147171. private _saveFileAsync;
  147172. /**
  147173. * Validates if xhr data is correct
  147174. * @param xhr defines the request to validate
  147175. * @param dataType defines the expected data type
  147176. * @returns true if data is correct
  147177. */
  147178. private static _ValidateXHRData;
  147179. }
  147180. }
  147181. declare module BABYLON {
  147182. /** @hidden */
  147183. export var gpuUpdateParticlesPixelShader: {
  147184. name: string;
  147185. shader: string;
  147186. };
  147187. }
  147188. declare module BABYLON {
  147189. /** @hidden */
  147190. export var gpuUpdateParticlesVertexShader: {
  147191. name: string;
  147192. shader: string;
  147193. };
  147194. }
  147195. declare module BABYLON {
  147196. /** @hidden */
  147197. export var clipPlaneFragmentDeclaration2: {
  147198. name: string;
  147199. shader: string;
  147200. };
  147201. }
  147202. declare module BABYLON {
  147203. /** @hidden */
  147204. export var gpuRenderParticlesPixelShader: {
  147205. name: string;
  147206. shader: string;
  147207. };
  147208. }
  147209. declare module BABYLON {
  147210. /** @hidden */
  147211. export var clipPlaneVertexDeclaration2: {
  147212. name: string;
  147213. shader: string;
  147214. };
  147215. }
  147216. declare module BABYLON {
  147217. /** @hidden */
  147218. export var gpuRenderParticlesVertexShader: {
  147219. name: string;
  147220. shader: string;
  147221. };
  147222. }
  147223. declare module BABYLON {
  147224. /**
  147225. * This represents a GPU particle system in Babylon
  147226. * This is the fastest particle system in Babylon as it uses the GPU to update the individual particle data
  147227. * @see https://www.babylonjs-playground.com/#PU4WYI#4
  147228. */
  147229. export class GPUParticleSystem extends BaseParticleSystem implements IDisposable, IParticleSystem, IAnimatable {
  147230. /**
  147231. * The layer mask we are rendering the particles through.
  147232. */
  147233. layerMask: number;
  147234. private _capacity;
  147235. private _activeCount;
  147236. private _currentActiveCount;
  147237. private _accumulatedCount;
  147238. private _renderEffect;
  147239. private _updateEffect;
  147240. private _buffer0;
  147241. private _buffer1;
  147242. private _spriteBuffer;
  147243. private _updateVAO;
  147244. private _renderVAO;
  147245. private _targetIndex;
  147246. private _sourceBuffer;
  147247. private _targetBuffer;
  147248. private _currentRenderId;
  147249. private _started;
  147250. private _stopped;
  147251. private _timeDelta;
  147252. private _randomTexture;
  147253. private _randomTexture2;
  147254. private _attributesStrideSize;
  147255. private _updateEffectOptions;
  147256. private _randomTextureSize;
  147257. private _actualFrame;
  147258. private _customEffect;
  147259. private readonly _rawTextureWidth;
  147260. /**
  147261. * Gets a boolean indicating if the GPU particles can be rendered on current browser
  147262. */
  147263. static get IsSupported(): boolean;
  147264. /**
  147265. * An event triggered when the system is disposed.
  147266. */
  147267. onDisposeObservable: Observable<IParticleSystem>;
  147268. /**
  147269. * Gets the maximum number of particles active at the same time.
  147270. * @returns The max number of active particles.
  147271. */
  147272. getCapacity(): number;
  147273. /**
  147274. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  147275. * to override the particles.
  147276. */
  147277. forceDepthWrite: boolean;
  147278. /**
  147279. * Gets or set the number of active particles
  147280. */
  147281. get activeParticleCount(): number;
  147282. set activeParticleCount(value: number);
  147283. private _preWarmDone;
  147284. /**
  147285. * Specifies if the particles are updated in emitter local space or world space.
  147286. */
  147287. isLocal: boolean;
  147288. /** Gets or sets a matrix to use to compute projection */
  147289. defaultProjectionMatrix: Matrix;
  147290. /**
  147291. * Is this system ready to be used/rendered
  147292. * @return true if the system is ready
  147293. */
  147294. isReady(): boolean;
  147295. /**
  147296. * Gets if the system has been started. (Note: this will still be true after stop is called)
  147297. * @returns True if it has been started, otherwise false.
  147298. */
  147299. isStarted(): boolean;
  147300. /**
  147301. * Gets if the system has been stopped. (Note: rendering is still happening but the system is frozen)
  147302. * @returns True if it has been stopped, otherwise false.
  147303. */
  147304. isStopped(): boolean;
  147305. /**
  147306. * Gets a boolean indicating that the system is stopping
  147307. * @returns true if the system is currently stopping
  147308. */
  147309. isStopping(): boolean;
  147310. /**
  147311. * Gets the number of particles active at the same time.
  147312. * @returns The number of active particles.
  147313. */
  147314. getActiveCount(): number;
  147315. /**
  147316. * Starts the particle system and begins to emit
  147317. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  147318. */
  147319. start(delay?: number): void;
  147320. /**
  147321. * Stops the particle system.
  147322. */
  147323. stop(): void;
  147324. /**
  147325. * Remove all active particles
  147326. */
  147327. reset(): void;
  147328. /**
  147329. * Returns the string "GPUParticleSystem"
  147330. * @returns a string containing the class name
  147331. */
  147332. getClassName(): string;
  147333. /**
  147334. * Gets the custom effect used to render the particles
  147335. * @param blendMode Blend mode for which the effect should be retrieved
  147336. * @returns The effect
  147337. */
  147338. getCustomEffect(blendMode?: number): Nullable<Effect>;
  147339. /**
  147340. * Sets the custom effect used to render the particles
  147341. * @param effect The effect to set
  147342. * @param blendMode Blend mode for which the effect should be set
  147343. */
  147344. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  147345. /** @hidden */
  147346. protected _onBeforeDrawParticlesObservable: Nullable<Observable<Nullable<Effect>>>;
  147347. /**
  147348. * Observable that will be called just before the particles are drawn
  147349. */
  147350. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  147351. /**
  147352. * Gets the name of the particle vertex shader
  147353. */
  147354. get vertexShaderName(): string;
  147355. private _colorGradientsTexture;
  147356. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: RawTexture): BaseParticleSystem;
  147357. /**
  147358. * Adds a new color gradient
  147359. * @param gradient defines the gradient to use (between 0 and 1)
  147360. * @param color1 defines the color to affect to the specified gradient
  147361. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  147362. * @returns the current particle system
  147363. */
  147364. addColorGradient(gradient: number, color1: Color4, color2?: Color4): GPUParticleSystem;
  147365. private _refreshColorGradient;
  147366. /** Force the system to rebuild all gradients that need to be resync */
  147367. forceRefreshGradients(): void;
  147368. /**
  147369. * Remove a specific color gradient
  147370. * @param gradient defines the gradient to remove
  147371. * @returns the current particle system
  147372. */
  147373. removeColorGradient(gradient: number): GPUParticleSystem;
  147374. private _angularSpeedGradientsTexture;
  147375. private _sizeGradientsTexture;
  147376. private _velocityGradientsTexture;
  147377. private _limitVelocityGradientsTexture;
  147378. private _dragGradientsTexture;
  147379. private _addFactorGradient;
  147380. /**
  147381. * Adds a new size gradient
  147382. * @param gradient defines the gradient to use (between 0 and 1)
  147383. * @param factor defines the size factor to affect to the specified gradient
  147384. * @returns the current particle system
  147385. */
  147386. addSizeGradient(gradient: number, factor: number): GPUParticleSystem;
  147387. /**
  147388. * Remove a specific size gradient
  147389. * @param gradient defines the gradient to remove
  147390. * @returns the current particle system
  147391. */
  147392. removeSizeGradient(gradient: number): GPUParticleSystem;
  147393. private _refreshFactorGradient;
  147394. /**
  147395. * Adds a new angular speed gradient
  147396. * @param gradient defines the gradient to use (between 0 and 1)
  147397. * @param factor defines the angular speed to affect to the specified gradient
  147398. * @returns the current particle system
  147399. */
  147400. addAngularSpeedGradient(gradient: number, factor: number): GPUParticleSystem;
  147401. /**
  147402. * Remove a specific angular speed gradient
  147403. * @param gradient defines the gradient to remove
  147404. * @returns the current particle system
  147405. */
  147406. removeAngularSpeedGradient(gradient: number): GPUParticleSystem;
  147407. /**
  147408. * Adds a new velocity gradient
  147409. * @param gradient defines the gradient to use (between 0 and 1)
  147410. * @param factor defines the velocity to affect to the specified gradient
  147411. * @returns the current particle system
  147412. */
  147413. addVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  147414. /**
  147415. * Remove a specific velocity gradient
  147416. * @param gradient defines the gradient to remove
  147417. * @returns the current particle system
  147418. */
  147419. removeVelocityGradient(gradient: number): GPUParticleSystem;
  147420. /**
  147421. * Adds a new limit velocity gradient
  147422. * @param gradient defines the gradient to use (between 0 and 1)
  147423. * @param factor defines the limit velocity value to affect to the specified gradient
  147424. * @returns the current particle system
  147425. */
  147426. addLimitVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  147427. /**
  147428. * Remove a specific limit velocity gradient
  147429. * @param gradient defines the gradient to remove
  147430. * @returns the current particle system
  147431. */
  147432. removeLimitVelocityGradient(gradient: number): GPUParticleSystem;
  147433. /**
  147434. * Adds a new drag gradient
  147435. * @param gradient defines the gradient to use (between 0 and 1)
  147436. * @param factor defines the drag value to affect to the specified gradient
  147437. * @returns the current particle system
  147438. */
  147439. addDragGradient(gradient: number, factor: number): GPUParticleSystem;
  147440. /**
  147441. * Remove a specific drag gradient
  147442. * @param gradient defines the gradient to remove
  147443. * @returns the current particle system
  147444. */
  147445. removeDragGradient(gradient: number): GPUParticleSystem;
  147446. /**
  147447. * Not supported by GPUParticleSystem
  147448. * @param gradient defines the gradient to use (between 0 and 1)
  147449. * @param factor defines the emit rate value to affect to the specified gradient
  147450. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  147451. * @returns the current particle system
  147452. */
  147453. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  147454. /**
  147455. * Not supported by GPUParticleSystem
  147456. * @param gradient defines the gradient to remove
  147457. * @returns the current particle system
  147458. */
  147459. removeEmitRateGradient(gradient: number): IParticleSystem;
  147460. /**
  147461. * Not supported by GPUParticleSystem
  147462. * @param gradient defines the gradient to use (between 0 and 1)
  147463. * @param factor defines the start size value to affect to the specified gradient
  147464. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  147465. * @returns the current particle system
  147466. */
  147467. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  147468. /**
  147469. * Not supported by GPUParticleSystem
  147470. * @param gradient defines the gradient to remove
  147471. * @returns the current particle system
  147472. */
  147473. removeStartSizeGradient(gradient: number): IParticleSystem;
  147474. /**
  147475. * Not supported by GPUParticleSystem
  147476. * @param gradient defines the gradient to use (between 0 and 1)
  147477. * @param min defines the color remap minimal range
  147478. * @param max defines the color remap maximal range
  147479. * @returns the current particle system
  147480. */
  147481. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  147482. /**
  147483. * Not supported by GPUParticleSystem
  147484. * @param gradient defines the gradient to remove
  147485. * @returns the current particle system
  147486. */
  147487. removeColorRemapGradient(): IParticleSystem;
  147488. /**
  147489. * Not supported by GPUParticleSystem
  147490. * @param gradient defines the gradient to use (between 0 and 1)
  147491. * @param min defines the alpha remap minimal range
  147492. * @param max defines the alpha remap maximal range
  147493. * @returns the current particle system
  147494. */
  147495. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  147496. /**
  147497. * Not supported by GPUParticleSystem
  147498. * @param gradient defines the gradient to remove
  147499. * @returns the current particle system
  147500. */
  147501. removeAlphaRemapGradient(): IParticleSystem;
  147502. /**
  147503. * Not supported by GPUParticleSystem
  147504. * @param gradient defines the gradient to use (between 0 and 1)
  147505. * @param color defines the color to affect to the specified gradient
  147506. * @returns the current particle system
  147507. */
  147508. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  147509. /**
  147510. * Not supported by GPUParticleSystem
  147511. * @param gradient defines the gradient to remove
  147512. * @returns the current particle system
  147513. */
  147514. removeRampGradient(): IParticleSystem;
  147515. /**
  147516. * Not supported by GPUParticleSystem
  147517. * @returns the list of ramp gradients
  147518. */
  147519. getRampGradients(): Nullable<Array<Color3Gradient>>;
  147520. /**
  147521. * Not supported by GPUParticleSystem
  147522. * Gets or sets a boolean indicating that ramp gradients must be used
  147523. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  147524. */
  147525. get useRampGradients(): boolean;
  147526. set useRampGradients(value: boolean);
  147527. /**
  147528. * Not supported by GPUParticleSystem
  147529. * @param gradient defines the gradient to use (between 0 and 1)
  147530. * @param factor defines the life time factor to affect to the specified gradient
  147531. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  147532. * @returns the current particle system
  147533. */
  147534. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  147535. /**
  147536. * Not supported by GPUParticleSystem
  147537. * @param gradient defines the gradient to remove
  147538. * @returns the current particle system
  147539. */
  147540. removeLifeTimeGradient(gradient: number): IParticleSystem;
  147541. /**
  147542. * Instantiates a GPU particle system.
  147543. * 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.
  147544. * @param name The name of the particle system
  147545. * @param options The options used to create the system
  147546. * @param sceneOrEngine The scene the particle system belongs to or the engine to use if no scene
  147547. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  147548. * @param customEffect a custom effect used to change the way particles are rendered by default
  147549. */
  147550. constructor(name: string, options: Partial<{
  147551. capacity: number;
  147552. randomTextureSize: number;
  147553. }>, sceneOrEngine: Scene | ThinEngine, isAnimationSheetEnabled?: boolean, customEffect?: Nullable<Effect>);
  147554. protected _reset(): void;
  147555. private _createUpdateVAO;
  147556. private _createRenderVAO;
  147557. private _initialize;
  147558. /** @hidden */
  147559. _recreateUpdateEffect(): void;
  147560. private _getEffect;
  147561. /**
  147562. * Fill the defines array according to the current settings of the particle system
  147563. * @param defines Array to be updated
  147564. * @param blendMode blend mode to take into account when updating the array
  147565. */
  147566. fillDefines(defines: Array<string>, blendMode?: number): void;
  147567. /**
  147568. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  147569. * @param uniforms Uniforms array to fill
  147570. * @param attributes Attributes array to fill
  147571. * @param samplers Samplers array to fill
  147572. */
  147573. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  147574. /** @hidden */
  147575. _recreateRenderEffect(): Effect;
  147576. /**
  147577. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  147578. * @param preWarm defines if we are in the pre-warmimg phase
  147579. */
  147580. animate(preWarm?: boolean): void;
  147581. private _createFactorGradientTexture;
  147582. private _createSizeGradientTexture;
  147583. private _createAngularSpeedGradientTexture;
  147584. private _createVelocityGradientTexture;
  147585. private _createLimitVelocityGradientTexture;
  147586. private _createDragGradientTexture;
  147587. private _createColorGradientTexture;
  147588. /**
  147589. * Renders the particle system in its current state
  147590. * @param preWarm defines if the system should only update the particles but not render them
  147591. * @returns the current number of particles
  147592. */
  147593. render(preWarm?: boolean): number;
  147594. /**
  147595. * Rebuilds the particle system
  147596. */
  147597. rebuild(): void;
  147598. private _releaseBuffers;
  147599. private _releaseVAOs;
  147600. /**
  147601. * Disposes the particle system and free the associated resources
  147602. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  147603. */
  147604. dispose(disposeTexture?: boolean): void;
  147605. /**
  147606. * Clones the particle system.
  147607. * @param name The name of the cloned object
  147608. * @param newEmitter The new emitter to use
  147609. * @returns the cloned particle system
  147610. */
  147611. clone(name: string, newEmitter: any): GPUParticleSystem;
  147612. /**
  147613. * Serializes the particle system to a JSON object
  147614. * @param serializeTexture defines if the texture must be serialized as well
  147615. * @returns the JSON object
  147616. */
  147617. serialize(serializeTexture?: boolean): any;
  147618. /**
  147619. * Parses a JSON object to create a GPU particle system.
  147620. * @param parsedParticleSystem The JSON object to parse
  147621. * @param sceneOrEngine The scene or the engine to create the particle system in
  147622. * @param rootUrl The root url to use to load external dependencies like texture
  147623. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  147624. * @returns the parsed GPU particle system
  147625. */
  147626. static Parse(parsedParticleSystem: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string, doNotStart?: boolean): GPUParticleSystem;
  147627. }
  147628. }
  147629. declare module BABYLON {
  147630. /**
  147631. * Represents a set of particle systems working together to create a specific effect
  147632. */
  147633. export class ParticleSystemSet implements IDisposable {
  147634. /**
  147635. * Gets or sets base Assets URL
  147636. */
  147637. static BaseAssetsUrl: string;
  147638. private _emitterCreationOptions;
  147639. private _emitterNode;
  147640. /**
  147641. * Gets the particle system list
  147642. */
  147643. systems: IParticleSystem[];
  147644. /**
  147645. * Gets the emitter node used with this set
  147646. */
  147647. get emitterNode(): Nullable<TransformNode>;
  147648. /**
  147649. * Creates a new emitter mesh as a sphere
  147650. * @param options defines the options used to create the sphere
  147651. * @param renderingGroupId defines the renderingGroupId to use for the sphere
  147652. * @param scene defines the hosting scene
  147653. */
  147654. setEmitterAsSphere(options: {
  147655. diameter: number;
  147656. segments: number;
  147657. color: Color3;
  147658. }, renderingGroupId: number, scene: Scene): void;
  147659. /**
  147660. * Starts all particle systems of the set
  147661. * @param emitter defines an optional mesh to use as emitter for the particle systems
  147662. */
  147663. start(emitter?: AbstractMesh): void;
  147664. /**
  147665. * Release all associated resources
  147666. */
  147667. dispose(): void;
  147668. /**
  147669. * Serialize the set into a JSON compatible object
  147670. * @param serializeTexture defines if the texture must be serialized as well
  147671. * @returns a JSON compatible representation of the set
  147672. */
  147673. serialize(serializeTexture?: boolean): any;
  147674. /**
  147675. * Parse a new ParticleSystemSet from a serialized source
  147676. * @param data defines a JSON compatible representation of the set
  147677. * @param scene defines the hosting scene
  147678. * @param gpu defines if we want GPU particles or CPU particles
  147679. * @returns a new ParticleSystemSet
  147680. */
  147681. static Parse(data: any, scene: Scene, gpu?: boolean): ParticleSystemSet;
  147682. }
  147683. }
  147684. declare module BABYLON {
  147685. /**
  147686. * This class is made for on one-liner static method to help creating particle system set.
  147687. */
  147688. export class ParticleHelper {
  147689. /**
  147690. * Gets or sets base Assets URL
  147691. */
  147692. static BaseAssetsUrl: string;
  147693. /** Define the Url to load snippets */
  147694. static SnippetUrl: string;
  147695. /**
  147696. * Create a default particle system that you can tweak
  147697. * @param emitter defines the emitter to use
  147698. * @param capacity defines the system capacity (default is 500 particles)
  147699. * @param scene defines the hosting scene
  147700. * @param useGPU defines if a GPUParticleSystem must be created (default is false)
  147701. * @returns the new Particle system
  147702. */
  147703. static CreateDefault(emitter: Nullable<AbstractMesh | Vector3>, capacity?: number, scene?: Scene, useGPU?: boolean): IParticleSystem;
  147704. /**
  147705. * This is the main static method (one-liner) of this helper to create different particle systems
  147706. * @param type This string represents the type to the particle system to create
  147707. * @param scene The scene where the particle system should live
  147708. * @param gpu If the system will use gpu
  147709. * @returns the ParticleSystemSet created
  147710. */
  147711. static CreateAsync(type: string, scene: Nullable<Scene>, gpu?: boolean): Promise<ParticleSystemSet>;
  147712. /**
  147713. * Static function used to export a particle system to a ParticleSystemSet variable.
  147714. * Please note that the emitter shape is not exported
  147715. * @param systems defines the particle systems to export
  147716. * @returns the created particle system set
  147717. */
  147718. static ExportSet(systems: IParticleSystem[]): ParticleSystemSet;
  147719. /**
  147720. * Creates a particle system from a snippet saved in a remote file
  147721. * @param name defines the name of the particle system to create (can be null or empty to use the one from the json data)
  147722. * @param url defines the url to load from
  147723. * @param scene defines the hosting scene
  147724. * @param gpu If the system will use gpu
  147725. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  147726. * @returns a promise that will resolve to the new particle system
  147727. */
  147728. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  147729. /**
  147730. * Creates a particle system from a snippet saved by the particle system editor
  147731. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  147732. * @param scene defines the hosting scene
  147733. * @param gpu If the system will use gpu
  147734. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  147735. * @returns a promise that will resolve to the new particle system
  147736. */
  147737. static CreateFromSnippetAsync(snippetId: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  147738. }
  147739. }
  147740. declare module BABYLON {
  147741. interface Engine {
  147742. /**
  147743. * Create an effect to use with particle systems.
  147744. * Please note that some parameters like animation sheets or not being billboard are not supported in this configuration, except if you pass
  147745. * the particle system for which you want to create a custom effect in the last parameter
  147746. * @param fragmentName defines the base name of the effect (The name of file without .fragment.fx)
  147747. * @param uniformsNames defines a list of attribute names
  147748. * @param samplers defines an array of string used to represent textures
  147749. * @param defines defines the string containing the defines to use to compile the shaders
  147750. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  147751. * @param onCompiled defines a function to call when the effect creation is successful
  147752. * @param onError defines a function to call when the effect creation has failed
  147753. * @param particleSystem the particle system you want to create the effect for
  147754. * @returns the new Effect
  147755. */
  147756. createEffectForParticles(fragmentName: string, uniformsNames: string[], samplers: string[], defines: string, fallbacks?: EffectFallbacks, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void, particleSystem?: IParticleSystem): Effect;
  147757. }
  147758. interface Mesh {
  147759. /**
  147760. * Returns an array populated with IParticleSystem objects whose the mesh is the emitter
  147761. * @returns an array of IParticleSystem
  147762. */
  147763. getEmittedParticleSystems(): IParticleSystem[];
  147764. /**
  147765. * Returns an array populated with IParticleSystem objects whose the mesh or its children are the emitter
  147766. * @returns an array of IParticleSystem
  147767. */
  147768. getHierarchyEmittedParticleSystems(): IParticleSystem[];
  147769. }
  147770. }
  147771. declare module BABYLON {
  147772. /** Defines the 4 color options */
  147773. export enum PointColor {
  147774. /** color value */
  147775. Color = 2,
  147776. /** uv value */
  147777. UV = 1,
  147778. /** random value */
  147779. Random = 0,
  147780. /** stated value */
  147781. Stated = 3
  147782. }
  147783. /**
  147784. * The PointCloudSystem (PCS) is a single updatable mesh. The points corresponding to the vertices of this big mesh.
  147785. * 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.
  147786. * The PointCloudSytem is also a particle system, with each point being a particle. It provides some methods to manage the particles.
  147787. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  147788. *
  147789. * Full documentation here : TO BE ENTERED
  147790. */
  147791. export class PointsCloudSystem implements IDisposable {
  147792. /**
  147793. * The PCS array of cloud point objects. Just access each particle as with any classic array.
  147794. * Example : var p = SPS.particles[i];
  147795. */
  147796. particles: CloudPoint[];
  147797. /**
  147798. * The PCS total number of particles. Read only. Use PCS.counter instead if you need to set your own value.
  147799. */
  147800. nbParticles: number;
  147801. /**
  147802. * This a counter for your own usage. It's not set by any SPS functions.
  147803. */
  147804. counter: number;
  147805. /**
  147806. * The PCS name. This name is also given to the underlying mesh.
  147807. */
  147808. name: string;
  147809. /**
  147810. * The PCS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  147811. */
  147812. mesh: Mesh;
  147813. /**
  147814. * This empty object is intended to store some PCS specific or temporary values in order to lower the Garbage Collector activity.
  147815. * Please read :
  147816. */
  147817. vars: any;
  147818. /**
  147819. * @hidden
  147820. */
  147821. _size: number;
  147822. private _scene;
  147823. private _promises;
  147824. private _positions;
  147825. private _indices;
  147826. private _normals;
  147827. private _colors;
  147828. private _uvs;
  147829. private _indices32;
  147830. private _positions32;
  147831. private _colors32;
  147832. private _uvs32;
  147833. private _updatable;
  147834. private _isVisibilityBoxLocked;
  147835. private _alwaysVisible;
  147836. private _groups;
  147837. private _groupCounter;
  147838. private _computeParticleColor;
  147839. private _computeParticleTexture;
  147840. private _computeParticleRotation;
  147841. private _computeBoundingBox;
  147842. private _isReady;
  147843. /**
  147844. * Creates a PCS (Points Cloud System) object
  147845. * @param name (String) is the PCS name, this will be the underlying mesh name
  147846. * @param pointSize (number) is the size for each point
  147847. * @param scene (Scene) is the scene in which the PCS is added
  147848. * @param options defines the options of the PCS e.g.
  147849. * * updatable (optional boolean, default true) : if the PCS must be updatable or immutable
  147850. */
  147851. constructor(name: string, pointSize: number, scene: Scene, options?: {
  147852. updatable?: boolean;
  147853. });
  147854. /**
  147855. * Builds the PCS underlying mesh. Returns a standard Mesh.
  147856. * If no points were added to the PCS, the returned mesh is just a single point.
  147857. * @returns a promise for the created mesh
  147858. */
  147859. buildMeshAsync(): Promise<Mesh>;
  147860. /**
  147861. * @hidden
  147862. */
  147863. private _buildMesh;
  147864. private _addParticle;
  147865. private _randomUnitVector;
  147866. private _getColorIndicesForCoord;
  147867. private _setPointsColorOrUV;
  147868. private _colorFromTexture;
  147869. private _calculateDensity;
  147870. /**
  147871. * Adds points to the PCS in random positions within a unit sphere
  147872. * @param nb (positive integer) the number of particles to be created from this model
  147873. * @param pointFunction is an optional javascript function to be called for each particle on PCS creation
  147874. * @returns the number of groups in the system
  147875. */
  147876. addPoints(nb: number, pointFunction?: any): number;
  147877. /**
  147878. * Adds points to the PCS from the surface of the model shape
  147879. * @param mesh is any Mesh object that will be used as a surface model for the points
  147880. * @param nb (positive integer) the number of particles to be created from this model
  147881. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  147882. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  147883. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  147884. * @returns the number of groups in the system
  147885. */
  147886. addSurfacePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  147887. /**
  147888. * Adds points to the PCS inside the model shape
  147889. * @param mesh is any Mesh object that will be used as a surface model for the points
  147890. * @param nb (positive integer) the number of particles to be created from this model
  147891. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  147892. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  147893. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  147894. * @returns the number of groups in the system
  147895. */
  147896. addVolumePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  147897. /**
  147898. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  147899. * This method calls `updateParticle()` for each particle of the SPS.
  147900. * For an animated SPS, it is usually called within the render loop.
  147901. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  147902. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  147903. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  147904. * @returns the PCS.
  147905. */
  147906. setParticles(start?: number, end?: number, update?: boolean): PointsCloudSystem;
  147907. /**
  147908. * Disposes the PCS.
  147909. */
  147910. dispose(): void;
  147911. /**
  147912. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  147913. * doc :
  147914. * @returns the PCS.
  147915. */
  147916. refreshVisibleSize(): PointsCloudSystem;
  147917. /**
  147918. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  147919. * @param size the size (float) of the visibility box
  147920. * note : this doesn't lock the PCS mesh bounding box.
  147921. * doc :
  147922. */
  147923. setVisibilityBox(size: number): void;
  147924. /**
  147925. * Gets whether the PCS is always visible or not
  147926. * doc :
  147927. */
  147928. get isAlwaysVisible(): boolean;
  147929. /**
  147930. * Sets the PCS as always visible or not
  147931. * doc :
  147932. */
  147933. set isAlwaysVisible(val: boolean);
  147934. /**
  147935. * Tells to `setParticles()` to compute the particle rotations or not
  147936. * Default value : false. The PCS is faster when it's set to false
  147937. * Note : particle rotations are only applied to parent particles
  147938. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate
  147939. */
  147940. set computeParticleRotation(val: boolean);
  147941. /**
  147942. * Tells to `setParticles()` to compute the particle colors or not.
  147943. * Default value : true. The PCS is faster when it's set to false.
  147944. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  147945. */
  147946. set computeParticleColor(val: boolean);
  147947. set computeParticleTexture(val: boolean);
  147948. /**
  147949. * Gets if `setParticles()` computes the particle colors or not.
  147950. * Default value : false. The PCS is faster when it's set to false.
  147951. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  147952. */
  147953. get computeParticleColor(): boolean;
  147954. /**
  147955. * Gets if `setParticles()` computes the particle textures or not.
  147956. * Default value : false. The PCS is faster when it's set to false.
  147957. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  147958. */
  147959. get computeParticleTexture(): boolean;
  147960. /**
  147961. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  147962. */
  147963. set computeBoundingBox(val: boolean);
  147964. /**
  147965. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  147966. */
  147967. get computeBoundingBox(): boolean;
  147968. /**
  147969. * This function does nothing. It may be overwritten to set all the particle first values.
  147970. * The PCS doesn't call this function, you may have to call it by your own.
  147971. * doc :
  147972. */
  147973. initParticles(): void;
  147974. /**
  147975. * This function does nothing. It may be overwritten to recycle a particle
  147976. * The PCS doesn't call this function, you can to call it
  147977. * doc :
  147978. * @param particle The particle to recycle
  147979. * @returns the recycled particle
  147980. */
  147981. recycleParticle(particle: CloudPoint): CloudPoint;
  147982. /**
  147983. * Updates a particle : this function should be overwritten by the user.
  147984. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  147985. * doc :
  147986. * @example : just set a particle position or velocity and recycle conditions
  147987. * @param particle The particle to update
  147988. * @returns the updated particle
  147989. */
  147990. updateParticle(particle: CloudPoint): CloudPoint;
  147991. /**
  147992. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  147993. * This does nothing and may be overwritten by the user.
  147994. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  147995. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  147996. * @param update the boolean update value actually passed to setParticles()
  147997. */
  147998. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  147999. /**
  148000. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  148001. * This will be passed three parameters.
  148002. * This does nothing and may be overwritten by the user.
  148003. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  148004. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  148005. * @param update the boolean update value actually passed to setParticles()
  148006. */
  148007. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  148008. }
  148009. }
  148010. declare module BABYLON {
  148011. /**
  148012. * Represents one particle of a points cloud system.
  148013. */
  148014. export class CloudPoint {
  148015. /**
  148016. * particle global index
  148017. */
  148018. idx: number;
  148019. /**
  148020. * The color of the particle
  148021. */
  148022. color: Nullable<Color4>;
  148023. /**
  148024. * The world space position of the particle.
  148025. */
  148026. position: Vector3;
  148027. /**
  148028. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  148029. */
  148030. rotation: Vector3;
  148031. /**
  148032. * The world space rotation quaternion of the particle.
  148033. */
  148034. rotationQuaternion: Nullable<Quaternion>;
  148035. /**
  148036. * The uv of the particle.
  148037. */
  148038. uv: Nullable<Vector2>;
  148039. /**
  148040. * The current speed of the particle.
  148041. */
  148042. velocity: Vector3;
  148043. /**
  148044. * The pivot point in the particle local space.
  148045. */
  148046. pivot: Vector3;
  148047. /**
  148048. * Must the particle be translated from its pivot point in its local space ?
  148049. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  148050. * Default : false
  148051. */
  148052. translateFromPivot: boolean;
  148053. /**
  148054. * Index of this particle in the global "positions" array (Internal use)
  148055. * @hidden
  148056. */
  148057. _pos: number;
  148058. /**
  148059. * @hidden Index of this particle in the global "indices" array (Internal use)
  148060. */
  148061. _ind: number;
  148062. /**
  148063. * Group this particle belongs to
  148064. */
  148065. _group: PointsGroup;
  148066. /**
  148067. * Group id of this particle
  148068. */
  148069. groupId: number;
  148070. /**
  148071. * Index of the particle in its group id (Internal use)
  148072. */
  148073. idxInGroup: number;
  148074. /**
  148075. * @hidden Particle BoundingInfo object (Internal use)
  148076. */
  148077. _boundingInfo: BoundingInfo;
  148078. /**
  148079. * @hidden Reference to the PCS that the particle belongs to (Internal use)
  148080. */
  148081. _pcs: PointsCloudSystem;
  148082. /**
  148083. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  148084. */
  148085. _stillInvisible: boolean;
  148086. /**
  148087. * @hidden Last computed particle rotation matrix
  148088. */
  148089. _rotationMatrix: number[];
  148090. /**
  148091. * Parent particle Id, if any.
  148092. * Default null.
  148093. */
  148094. parentId: Nullable<number>;
  148095. /**
  148096. * @hidden Internal global position in the PCS.
  148097. */
  148098. _globalPosition: Vector3;
  148099. /**
  148100. * Creates a Point Cloud object.
  148101. * Don't create particles manually, use instead the PCS internal tools like _addParticle()
  148102. * @param particleIndex (integer) is the particle index in the PCS pool. It's also the particle identifier.
  148103. * @param group (PointsGroup) is the group the particle belongs to
  148104. * @param groupId (integer) is the group identifier in the PCS.
  148105. * @param idxInGroup (integer) is the index of the particle in the current point group (ex: the 10th point of addPoints(30))
  148106. * @param pcs defines the PCS it is associated to
  148107. */
  148108. constructor(particleIndex: number, group: PointsGroup, groupId: number, idxInGroup: number, pcs: PointsCloudSystem);
  148109. /**
  148110. * get point size
  148111. */
  148112. get size(): Vector3;
  148113. /**
  148114. * Set point size
  148115. */
  148116. set size(scale: Vector3);
  148117. /**
  148118. * Legacy support, changed quaternion to rotationQuaternion
  148119. */
  148120. get quaternion(): Nullable<Quaternion>;
  148121. /**
  148122. * Legacy support, changed quaternion to rotationQuaternion
  148123. */
  148124. set quaternion(q: Nullable<Quaternion>);
  148125. /**
  148126. * Returns a boolean. True if the particle intersects a mesh, else false
  148127. * The intersection is computed on the particle position and Axis Aligned Bounding Box (AABB) or Sphere
  148128. * @param target is the object (point or mesh) what the intersection is computed against
  148129. * @param isSphere is boolean flag when false (default) bounding box of mesh is used, when true the bouding sphere is used
  148130. * @returns true if it intersects
  148131. */
  148132. intersectsMesh(target: Mesh, isSphere: boolean): boolean;
  148133. /**
  148134. * get the rotation matrix of the particle
  148135. * @hidden
  148136. */
  148137. getRotationMatrix(m: Matrix): void;
  148138. }
  148139. /**
  148140. * Represents a group of points in a points cloud system
  148141. * * PCS internal tool, don't use it manually.
  148142. */
  148143. export class PointsGroup {
  148144. /**
  148145. * The group id
  148146. * @hidden
  148147. */
  148148. groupID: number;
  148149. /**
  148150. * image data for group (internal use)
  148151. * @hidden
  148152. */
  148153. _groupImageData: Nullable<ArrayBufferView>;
  148154. /**
  148155. * Image Width (internal use)
  148156. * @hidden
  148157. */
  148158. _groupImgWidth: number;
  148159. /**
  148160. * Image Height (internal use)
  148161. * @hidden
  148162. */
  148163. _groupImgHeight: number;
  148164. /**
  148165. * Custom position function (internal use)
  148166. * @hidden
  148167. */
  148168. _positionFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>;
  148169. /**
  148170. * density per facet for surface points
  148171. * @hidden
  148172. */
  148173. _groupDensity: number[];
  148174. /**
  148175. * Only when points are colored by texture carries pointer to texture list array
  148176. * @hidden
  148177. */
  148178. _textureNb: number;
  148179. /**
  148180. * Creates a points group object. This is an internal reference to produce particles for the PCS.
  148181. * PCS internal tool, don't use it manually.
  148182. * @hidden
  148183. */
  148184. constructor(id: number, posFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>);
  148185. }
  148186. }
  148187. declare module BABYLON {
  148188. interface Scene {
  148189. /** @hidden (Backing field) */
  148190. _physicsEngine: Nullable<IPhysicsEngine>;
  148191. /** @hidden */
  148192. _physicsTimeAccumulator: number;
  148193. /**
  148194. * Gets the current physics engine
  148195. * @returns a IPhysicsEngine or null if none attached
  148196. */
  148197. getPhysicsEngine(): Nullable<IPhysicsEngine>;
  148198. /**
  148199. * Enables physics to the current scene
  148200. * @param gravity defines the scene's gravity for the physics engine
  148201. * @param plugin defines the physics engine to be used. defaults to OimoJS.
  148202. * @return a boolean indicating if the physics engine was initialized
  148203. */
  148204. enablePhysics(gravity: Nullable<Vector3>, plugin?: IPhysicsEnginePlugin): boolean;
  148205. /**
  148206. * Disables and disposes the physics engine associated with the scene
  148207. */
  148208. disablePhysicsEngine(): void;
  148209. /**
  148210. * Gets a boolean indicating if there is an active physics engine
  148211. * @returns a boolean indicating if there is an active physics engine
  148212. */
  148213. isPhysicsEnabled(): boolean;
  148214. /**
  148215. * Deletes a physics compound impostor
  148216. * @param compound defines the compound to delete
  148217. */
  148218. deleteCompoundImpostor(compound: any): void;
  148219. /**
  148220. * An event triggered when physic simulation is about to be run
  148221. */
  148222. onBeforePhysicsObservable: Observable<Scene>;
  148223. /**
  148224. * An event triggered when physic simulation has been done
  148225. */
  148226. onAfterPhysicsObservable: Observable<Scene>;
  148227. }
  148228. interface AbstractMesh {
  148229. /** @hidden */
  148230. _physicsImpostor: Nullable<PhysicsImpostor>;
  148231. /**
  148232. * Gets or sets impostor used for physic simulation
  148233. * @see https://doc.babylonjs.com/features/physics_engine
  148234. */
  148235. physicsImpostor: Nullable<PhysicsImpostor>;
  148236. /**
  148237. * Gets the current physics impostor
  148238. * @see https://doc.babylonjs.com/features/physics_engine
  148239. * @returns a physics impostor or null
  148240. */
  148241. getPhysicsImpostor(): Nullable<PhysicsImpostor>;
  148242. /** Apply a physic impulse to the mesh
  148243. * @param force defines the force to apply
  148244. * @param contactPoint defines where to apply the force
  148245. * @returns the current mesh
  148246. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  148247. */
  148248. applyImpulse(force: Vector3, contactPoint: Vector3): AbstractMesh;
  148249. /**
  148250. * Creates a physic joint between two meshes
  148251. * @param otherMesh defines the other mesh to use
  148252. * @param pivot1 defines the pivot to use on this mesh
  148253. * @param pivot2 defines the pivot to use on the other mesh
  148254. * @param options defines additional options (can be plugin dependent)
  148255. * @returns the current mesh
  148256. * @see https://www.babylonjs-playground.com/#0BS5U0#0
  148257. */
  148258. setPhysicsLinkWith(otherMesh: Mesh, pivot1: Vector3, pivot2: Vector3, options?: any): AbstractMesh;
  148259. /** @hidden */
  148260. _disposePhysicsObserver: Nullable<Observer<Node>>;
  148261. }
  148262. /**
  148263. * Defines the physics engine scene component responsible to manage a physics engine
  148264. */
  148265. export class PhysicsEngineSceneComponent implements ISceneComponent {
  148266. /**
  148267. * The component name helpful to identify the component in the list of scene components.
  148268. */
  148269. readonly name: string;
  148270. /**
  148271. * The scene the component belongs to.
  148272. */
  148273. scene: Scene;
  148274. /**
  148275. * Creates a new instance of the component for the given scene
  148276. * @param scene Defines the scene to register the component in
  148277. */
  148278. constructor(scene: Scene);
  148279. /**
  148280. * Registers the component in a given scene
  148281. */
  148282. register(): void;
  148283. /**
  148284. * Rebuilds the elements related to this component in case of
  148285. * context lost for instance.
  148286. */
  148287. rebuild(): void;
  148288. /**
  148289. * Disposes the component and the associated ressources
  148290. */
  148291. dispose(): void;
  148292. }
  148293. }
  148294. declare module BABYLON {
  148295. /**
  148296. * A helper for physics simulations
  148297. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148298. */
  148299. export class PhysicsHelper {
  148300. private _scene;
  148301. private _physicsEngine;
  148302. /**
  148303. * Initializes the Physics helper
  148304. * @param scene Babylon.js scene
  148305. */
  148306. constructor(scene: Scene);
  148307. /**
  148308. * Applies a radial explosion impulse
  148309. * @param origin the origin of the explosion
  148310. * @param radiusOrEventOptions the radius or the options of radial explosion
  148311. * @param strength the explosion strength
  148312. * @param falloff possible options: Constant & Linear. Defaults to Constant
  148313. * @returns A physics radial explosion event, or null
  148314. */
  148315. applyRadialExplosionImpulse(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  148316. /**
  148317. * Applies a radial explosion force
  148318. * @param origin the origin of the explosion
  148319. * @param radiusOrEventOptions the radius or the options of radial explosion
  148320. * @param strength the explosion strength
  148321. * @param falloff possible options: Constant & Linear. Defaults to Constant
  148322. * @returns A physics radial explosion event, or null
  148323. */
  148324. applyRadialExplosionForce(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  148325. /**
  148326. * Creates a gravitational field
  148327. * @param origin the origin of the explosion
  148328. * @param radiusOrEventOptions the radius or the options of radial explosion
  148329. * @param strength the explosion strength
  148330. * @param falloff possible options: Constant & Linear. Defaults to Constant
  148331. * @returns A physics gravitational field event, or null
  148332. */
  148333. gravitationalField(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsGravitationalFieldEvent>;
  148334. /**
  148335. * Creates a physics updraft event
  148336. * @param origin the origin of the updraft
  148337. * @param radiusOrEventOptions the radius or the options of the updraft
  148338. * @param strength the strength of the updraft
  148339. * @param height the height of the updraft
  148340. * @param updraftMode possible options: Center & Perpendicular. Defaults to Center
  148341. * @returns A physics updraft event, or null
  148342. */
  148343. updraft(origin: Vector3, radiusOrEventOptions: number | PhysicsUpdraftEventOptions, strength?: number, height?: number, updraftMode?: PhysicsUpdraftMode): Nullable<PhysicsUpdraftEvent>;
  148344. /**
  148345. * Creates a physics vortex event
  148346. * @param origin the of the vortex
  148347. * @param radiusOrEventOptions the radius or the options of the vortex
  148348. * @param strength the strength of the vortex
  148349. * @param height the height of the vortex
  148350. * @returns a Physics vortex event, or null
  148351. * A physics vortex event or null
  148352. */
  148353. vortex(origin: Vector3, radiusOrEventOptions: number | PhysicsVortexEventOptions, strength?: number, height?: number): Nullable<PhysicsVortexEvent>;
  148354. }
  148355. /**
  148356. * Represents a physics radial explosion event
  148357. */
  148358. class PhysicsRadialExplosionEvent {
  148359. private _scene;
  148360. private _options;
  148361. private _sphere;
  148362. private _dataFetched;
  148363. /**
  148364. * Initializes a radial explosioin event
  148365. * @param _scene BabylonJS scene
  148366. * @param _options The options for the vortex event
  148367. */
  148368. constructor(_scene: Scene, _options: PhysicsRadialExplosionEventOptions);
  148369. /**
  148370. * Returns the data related to the radial explosion event (sphere).
  148371. * @returns The radial explosion event data
  148372. */
  148373. getData(): PhysicsRadialExplosionEventData;
  148374. /**
  148375. * Returns the force and contact point of the impostor or false, if the impostor is not affected by the force/impulse.
  148376. * @param impostor A physics imposter
  148377. * @param origin the origin of the explosion
  148378. * @returns {Nullable<PhysicsHitData>} A physics force and contact point, or null
  148379. */
  148380. getImpostorHitData(impostor: PhysicsImpostor, origin: Vector3): Nullable<PhysicsHitData>;
  148381. /**
  148382. * Triggers affecterd impostors callbacks
  148383. * @param affectedImpostorsWithData defines the list of affected impostors (including associated data)
  148384. */
  148385. triggerAffectedImpostorsCallback(affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>): void;
  148386. /**
  148387. * Disposes the sphere.
  148388. * @param force Specifies if the sphere should be disposed by force
  148389. */
  148390. dispose(force?: boolean): void;
  148391. /*** Helpers ***/
  148392. private _prepareSphere;
  148393. private _intersectsWithSphere;
  148394. }
  148395. /**
  148396. * Represents a gravitational field event
  148397. */
  148398. class PhysicsGravitationalFieldEvent {
  148399. private _physicsHelper;
  148400. private _scene;
  148401. private _origin;
  148402. private _options;
  148403. private _tickCallback;
  148404. private _sphere;
  148405. private _dataFetched;
  148406. /**
  148407. * Initializes the physics gravitational field event
  148408. * @param _physicsHelper A physics helper
  148409. * @param _scene BabylonJS scene
  148410. * @param _origin The origin position of the gravitational field event
  148411. * @param _options The options for the vortex event
  148412. */
  148413. constructor(_physicsHelper: PhysicsHelper, _scene: Scene, _origin: Vector3, _options: PhysicsRadialExplosionEventOptions);
  148414. /**
  148415. * Returns the data related to the gravitational field event (sphere).
  148416. * @returns A gravitational field event
  148417. */
  148418. getData(): PhysicsGravitationalFieldEventData;
  148419. /**
  148420. * Enables the gravitational field.
  148421. */
  148422. enable(): void;
  148423. /**
  148424. * Disables the gravitational field.
  148425. */
  148426. disable(): void;
  148427. /**
  148428. * Disposes the sphere.
  148429. * @param force The force to dispose from the gravitational field event
  148430. */
  148431. dispose(force?: boolean): void;
  148432. private _tick;
  148433. }
  148434. /**
  148435. * Represents a physics updraft event
  148436. */
  148437. class PhysicsUpdraftEvent {
  148438. private _scene;
  148439. private _origin;
  148440. private _options;
  148441. private _physicsEngine;
  148442. private _originTop;
  148443. private _originDirection;
  148444. private _tickCallback;
  148445. private _cylinder;
  148446. private _cylinderPosition;
  148447. private _dataFetched;
  148448. /**
  148449. * Initializes the physics updraft event
  148450. * @param _scene BabylonJS scene
  148451. * @param _origin The origin position of the updraft
  148452. * @param _options The options for the updraft event
  148453. */
  148454. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsUpdraftEventOptions);
  148455. /**
  148456. * Returns the data related to the updraft event (cylinder).
  148457. * @returns A physics updraft event
  148458. */
  148459. getData(): PhysicsUpdraftEventData;
  148460. /**
  148461. * Enables the updraft.
  148462. */
  148463. enable(): void;
  148464. /**
  148465. * Disables the updraft.
  148466. */
  148467. disable(): void;
  148468. /**
  148469. * Disposes the cylinder.
  148470. * @param force Specifies if the updraft should be disposed by force
  148471. */
  148472. dispose(force?: boolean): void;
  148473. private getImpostorHitData;
  148474. private _tick;
  148475. /*** Helpers ***/
  148476. private _prepareCylinder;
  148477. private _intersectsWithCylinder;
  148478. }
  148479. /**
  148480. * Represents a physics vortex event
  148481. */
  148482. class PhysicsVortexEvent {
  148483. private _scene;
  148484. private _origin;
  148485. private _options;
  148486. private _physicsEngine;
  148487. private _originTop;
  148488. private _tickCallback;
  148489. private _cylinder;
  148490. private _cylinderPosition;
  148491. private _dataFetched;
  148492. /**
  148493. * Initializes the physics vortex event
  148494. * @param _scene The BabylonJS scene
  148495. * @param _origin The origin position of the vortex
  148496. * @param _options The options for the vortex event
  148497. */
  148498. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsVortexEventOptions);
  148499. /**
  148500. * Returns the data related to the vortex event (cylinder).
  148501. * @returns The physics vortex event data
  148502. */
  148503. getData(): PhysicsVortexEventData;
  148504. /**
  148505. * Enables the vortex.
  148506. */
  148507. enable(): void;
  148508. /**
  148509. * Disables the cortex.
  148510. */
  148511. disable(): void;
  148512. /**
  148513. * Disposes the sphere.
  148514. * @param force
  148515. */
  148516. dispose(force?: boolean): void;
  148517. private getImpostorHitData;
  148518. private _tick;
  148519. /*** Helpers ***/
  148520. private _prepareCylinder;
  148521. private _intersectsWithCylinder;
  148522. }
  148523. /**
  148524. * Options fot the radial explosion event
  148525. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148526. */
  148527. export class PhysicsRadialExplosionEventOptions {
  148528. /**
  148529. * The radius of the sphere for the radial explosion.
  148530. */
  148531. radius: number;
  148532. /**
  148533. * The strenth of the explosion.
  148534. */
  148535. strength: number;
  148536. /**
  148537. * The strenght of the force in correspondence to the distance of the affected object
  148538. */
  148539. falloff: PhysicsRadialImpulseFalloff;
  148540. /**
  148541. * Sphere options for the radial explosion.
  148542. */
  148543. sphere: {
  148544. segments: number;
  148545. diameter: number;
  148546. };
  148547. /**
  148548. * Sphere options for the radial explosion.
  148549. */
  148550. affectedImpostorsCallback: (affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>) => void;
  148551. }
  148552. /**
  148553. * Options fot the updraft event
  148554. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148555. */
  148556. export class PhysicsUpdraftEventOptions {
  148557. /**
  148558. * The radius of the cylinder for the vortex
  148559. */
  148560. radius: number;
  148561. /**
  148562. * The strenth of the updraft.
  148563. */
  148564. strength: number;
  148565. /**
  148566. * The height of the cylinder for the updraft.
  148567. */
  148568. height: number;
  148569. /**
  148570. * The mode for the the updraft.
  148571. */
  148572. updraftMode: PhysicsUpdraftMode;
  148573. }
  148574. /**
  148575. * Options fot the vortex event
  148576. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148577. */
  148578. export class PhysicsVortexEventOptions {
  148579. /**
  148580. * The radius of the cylinder for the vortex
  148581. */
  148582. radius: number;
  148583. /**
  148584. * The strenth of the vortex.
  148585. */
  148586. strength: number;
  148587. /**
  148588. * The height of the cylinder for the vortex.
  148589. */
  148590. height: number;
  148591. /**
  148592. * At which distance, relative to the radius the centripetal forces should kick in? Range: 0-1
  148593. */
  148594. centripetalForceThreshold: number;
  148595. /**
  148596. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when below the treshold.
  148597. */
  148598. centripetalForceMultiplier: number;
  148599. /**
  148600. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when above the treshold.
  148601. */
  148602. centrifugalForceMultiplier: number;
  148603. /**
  148604. * This multiplier determines with how much force the objects will be pushed upwards, when in the vortex.
  148605. */
  148606. updraftForceMultiplier: number;
  148607. }
  148608. /**
  148609. * The strenght of the force in correspondence to the distance of the affected object
  148610. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148611. */
  148612. export enum PhysicsRadialImpulseFalloff {
  148613. /** Defines that impulse is constant in strength across it's whole radius */
  148614. Constant = 0,
  148615. /** Defines that impulse gets weaker if it's further from the origin */
  148616. Linear = 1
  148617. }
  148618. /**
  148619. * The strength of the force in correspondence to the distance of the affected object
  148620. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148621. */
  148622. export enum PhysicsUpdraftMode {
  148623. /** Defines that the upstream forces will pull towards the top center of the cylinder */
  148624. Center = 0,
  148625. /** Defines that once a impostor is inside the cylinder, it will shoot out perpendicular from the ground of the cylinder */
  148626. Perpendicular = 1
  148627. }
  148628. /**
  148629. * Interface for a physics hit data
  148630. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148631. */
  148632. export interface PhysicsHitData {
  148633. /**
  148634. * The force applied at the contact point
  148635. */
  148636. force: Vector3;
  148637. /**
  148638. * The contact point
  148639. */
  148640. contactPoint: Vector3;
  148641. /**
  148642. * The distance from the origin to the contact point
  148643. */
  148644. distanceFromOrigin: number;
  148645. }
  148646. /**
  148647. * Interface for radial explosion event data
  148648. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148649. */
  148650. export interface PhysicsRadialExplosionEventData {
  148651. /**
  148652. * A sphere used for the radial explosion event
  148653. */
  148654. sphere: Mesh;
  148655. }
  148656. /**
  148657. * Interface for gravitational field event data
  148658. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148659. */
  148660. export interface PhysicsGravitationalFieldEventData {
  148661. /**
  148662. * A sphere mesh used for the gravitational field event
  148663. */
  148664. sphere: Mesh;
  148665. }
  148666. /**
  148667. * Interface for updraft event data
  148668. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148669. */
  148670. export interface PhysicsUpdraftEventData {
  148671. /**
  148672. * A cylinder used for the updraft event
  148673. */
  148674. cylinder: Mesh;
  148675. }
  148676. /**
  148677. * Interface for vortex event data
  148678. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148679. */
  148680. export interface PhysicsVortexEventData {
  148681. /**
  148682. * A cylinder used for the vortex event
  148683. */
  148684. cylinder: Mesh;
  148685. }
  148686. /**
  148687. * Interface for an affected physics impostor
  148688. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148689. */
  148690. export interface PhysicsAffectedImpostorWithData {
  148691. /**
  148692. * The impostor affected by the effect
  148693. */
  148694. impostor: PhysicsImpostor;
  148695. /**
  148696. * The data about the hit/horce from the explosion
  148697. */
  148698. hitData: PhysicsHitData;
  148699. }
  148700. }
  148701. declare module BABYLON {
  148702. /** @hidden */
  148703. export var blackAndWhitePixelShader: {
  148704. name: string;
  148705. shader: string;
  148706. };
  148707. }
  148708. declare module BABYLON {
  148709. /**
  148710. * Post process used to render in black and white
  148711. */
  148712. export class BlackAndWhitePostProcess extends PostProcess {
  148713. /**
  148714. * Linear about to convert he result to black and white (default: 1)
  148715. */
  148716. degree: number;
  148717. /**
  148718. * Gets a string identifying the name of the class
  148719. * @returns "BlackAndWhitePostProcess" string
  148720. */
  148721. getClassName(): string;
  148722. /**
  148723. * Creates a black and white post process
  148724. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#black-and-white
  148725. * @param name The name of the effect.
  148726. * @param options The required width/height ratio to downsize to before computing the render pass.
  148727. * @param camera The camera to apply the render pass to.
  148728. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148729. * @param engine The engine which the post process will be applied. (default: current engine)
  148730. * @param reusable If the post process can be reused on the same frame. (default: false)
  148731. */
  148732. constructor(name: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  148733. /** @hidden */
  148734. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<BlackAndWhitePostProcess>;
  148735. }
  148736. }
  148737. declare module BABYLON {
  148738. /**
  148739. * This represents a set of one or more post processes in Babylon.
  148740. * A post process can be used to apply a shader to a texture after it is rendered.
  148741. * @example https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  148742. */
  148743. export class PostProcessRenderEffect {
  148744. private _postProcesses;
  148745. private _getPostProcesses;
  148746. private _singleInstance;
  148747. private _cameras;
  148748. private _indicesForCamera;
  148749. /**
  148750. * Name of the effect
  148751. * @hidden
  148752. */
  148753. _name: string;
  148754. /**
  148755. * Instantiates a post process render effect.
  148756. * A post process can be used to apply a shader to a texture after it is rendered.
  148757. * @param engine The engine the effect is tied to
  148758. * @param name The name of the effect
  148759. * @param getPostProcesses A function that returns a set of post processes which the effect will run in order to be run.
  148760. * @param singleInstance False if this post process can be run on multiple cameras. (default: true)
  148761. */
  148762. constructor(engine: Engine, name: string, getPostProcesses: () => Nullable<PostProcess | Array<PostProcess>>, singleInstance?: boolean);
  148763. /**
  148764. * Checks if all the post processes in the effect are supported.
  148765. */
  148766. get isSupported(): boolean;
  148767. /**
  148768. * Updates the current state of the effect
  148769. * @hidden
  148770. */
  148771. _update(): void;
  148772. /**
  148773. * Attaches the effect on cameras
  148774. * @param cameras The camera to attach to.
  148775. * @hidden
  148776. */
  148777. _attachCameras(cameras: Camera): void;
  148778. /**
  148779. * Attaches the effect on cameras
  148780. * @param cameras The camera to attach to.
  148781. * @hidden
  148782. */
  148783. _attachCameras(cameras: Camera[]): void;
  148784. /**
  148785. * Detaches the effect on cameras
  148786. * @param cameras The camera to detatch from.
  148787. * @hidden
  148788. */
  148789. _detachCameras(cameras: Camera): void;
  148790. /**
  148791. * Detatches the effect on cameras
  148792. * @param cameras The camera to detatch from.
  148793. * @hidden
  148794. */
  148795. _detachCameras(cameras: Camera[]): void;
  148796. /**
  148797. * Enables the effect on given cameras
  148798. * @param cameras The camera to enable.
  148799. * @hidden
  148800. */
  148801. _enable(cameras: Camera): void;
  148802. /**
  148803. * Enables the effect on given cameras
  148804. * @param cameras The camera to enable.
  148805. * @hidden
  148806. */
  148807. _enable(cameras: Nullable<Camera[]>): void;
  148808. /**
  148809. * Disables the effect on the given cameras
  148810. * @param cameras The camera to disable.
  148811. * @hidden
  148812. */
  148813. _disable(cameras: Camera): void;
  148814. /**
  148815. * Disables the effect on the given cameras
  148816. * @param cameras The camera to disable.
  148817. * @hidden
  148818. */
  148819. _disable(cameras: Nullable<Camera[]>): void;
  148820. /**
  148821. * Gets a list of the post processes contained in the effect.
  148822. * @param camera The camera to get the post processes on.
  148823. * @returns The list of the post processes in the effect.
  148824. */
  148825. getPostProcesses(camera?: Camera): Nullable<Array<PostProcess>>;
  148826. }
  148827. }
  148828. declare module BABYLON {
  148829. /** @hidden */
  148830. export var extractHighlightsPixelShader: {
  148831. name: string;
  148832. shader: string;
  148833. };
  148834. }
  148835. declare module BABYLON {
  148836. /**
  148837. * 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.
  148838. */
  148839. export class ExtractHighlightsPostProcess extends PostProcess {
  148840. /**
  148841. * The luminance threshold, pixels below this value will be set to black.
  148842. */
  148843. threshold: number;
  148844. /** @hidden */
  148845. _exposure: number;
  148846. /**
  148847. * Post process which has the input texture to be used when performing highlight extraction
  148848. * @hidden
  148849. */
  148850. _inputPostProcess: Nullable<PostProcess>;
  148851. /**
  148852. * Gets a string identifying the name of the class
  148853. * @returns "ExtractHighlightsPostProcess" string
  148854. */
  148855. getClassName(): string;
  148856. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  148857. }
  148858. }
  148859. declare module BABYLON {
  148860. /** @hidden */
  148861. export var bloomMergePixelShader: {
  148862. name: string;
  148863. shader: string;
  148864. };
  148865. }
  148866. declare module BABYLON {
  148867. /**
  148868. * The BloomMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  148869. */
  148870. export class BloomMergePostProcess extends PostProcess {
  148871. /** Weight of the bloom to be added to the original input. */
  148872. weight: number;
  148873. /**
  148874. * Gets a string identifying the name of the class
  148875. * @returns "BloomMergePostProcess" string
  148876. */
  148877. getClassName(): string;
  148878. /**
  148879. * Creates a new instance of @see BloomMergePostProcess
  148880. * @param name The name of the effect.
  148881. * @param originalFromInput Post process which's input will be used for the merge.
  148882. * @param blurred Blurred highlights post process which's output will be used.
  148883. * @param weight Weight of the bloom to be added to the original input.
  148884. * @param options The required width/height ratio to downsize to before computing the render pass.
  148885. * @param camera The camera to apply the render pass to.
  148886. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148887. * @param engine The engine which the post process will be applied. (default: current engine)
  148888. * @param reusable If the post process can be reused on the same frame. (default: false)
  148889. * @param textureType Type of textures used when performing the post process. (default: 0)
  148890. * @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)
  148891. */
  148892. constructor(name: string, originalFromInput: PostProcess, blurred: PostProcess,
  148893. /** Weight of the bloom to be added to the original input. */
  148894. weight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  148895. }
  148896. }
  148897. declare module BABYLON {
  148898. /**
  148899. * The bloom effect spreads bright areas of an image to simulate artifacts seen in cameras
  148900. */
  148901. export class BloomEffect extends PostProcessRenderEffect {
  148902. private bloomScale;
  148903. /**
  148904. * @hidden Internal
  148905. */
  148906. _effects: Array<PostProcess>;
  148907. /**
  148908. * @hidden Internal
  148909. */
  148910. _downscale: ExtractHighlightsPostProcess;
  148911. private _blurX;
  148912. private _blurY;
  148913. private _merge;
  148914. /**
  148915. * The luminance threshold to find bright areas of the image to bloom.
  148916. */
  148917. get threshold(): number;
  148918. set threshold(value: number);
  148919. /**
  148920. * The strength of the bloom.
  148921. */
  148922. get weight(): number;
  148923. set weight(value: number);
  148924. /**
  148925. * Specifies the size of the bloom blur kernel, relative to the final output size
  148926. */
  148927. get kernel(): number;
  148928. set kernel(value: number);
  148929. /**
  148930. * Creates a new instance of @see BloomEffect
  148931. * @param scene The scene the effect belongs to.
  148932. * @param bloomScale The ratio of the blur texture to the input texture that should be used to compute the bloom.
  148933. * @param bloomKernel The size of the kernel to be used when applying the blur.
  148934. * @param bloomWeight The the strength of bloom.
  148935. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  148936. * @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)
  148937. */
  148938. constructor(scene: Scene, bloomScale: number, bloomWeight: number, bloomKernel: number, pipelineTextureType?: number, blockCompilation?: boolean);
  148939. /**
  148940. * Disposes each of the internal effects for a given camera.
  148941. * @param camera The camera to dispose the effect on.
  148942. */
  148943. disposeEffects(camera: Camera): void;
  148944. /**
  148945. * @hidden Internal
  148946. */
  148947. _updateEffects(): void;
  148948. /**
  148949. * Internal
  148950. * @returns if all the contained post processes are ready.
  148951. * @hidden
  148952. */
  148953. _isReady(): boolean;
  148954. }
  148955. }
  148956. declare module BABYLON {
  148957. /** @hidden */
  148958. export var chromaticAberrationPixelShader: {
  148959. name: string;
  148960. shader: string;
  148961. };
  148962. }
  148963. declare module BABYLON {
  148964. /**
  148965. * The ChromaticAberrationPostProcess separates the rgb channels in an image to produce chromatic distortion around the edges of the screen
  148966. */
  148967. export class ChromaticAberrationPostProcess extends PostProcess {
  148968. /**
  148969. * The amount of seperation of rgb channels (default: 30)
  148970. */
  148971. aberrationAmount: number;
  148972. /**
  148973. * The amount the effect will increase for pixels closer to the edge of the screen. (default: 0)
  148974. */
  148975. radialIntensity: number;
  148976. /**
  148977. * 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))
  148978. */
  148979. direction: Vector2;
  148980. /**
  148981. * 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))
  148982. */
  148983. centerPosition: Vector2;
  148984. /** The width of the screen to apply the effect on */
  148985. screenWidth: number;
  148986. /** The height of the screen to apply the effect on */
  148987. screenHeight: number;
  148988. /**
  148989. * Gets a string identifying the name of the class
  148990. * @returns "ChromaticAberrationPostProcess" string
  148991. */
  148992. getClassName(): string;
  148993. /**
  148994. * Creates a new instance ChromaticAberrationPostProcess
  148995. * @param name The name of the effect.
  148996. * @param screenWidth The width of the screen to apply the effect on.
  148997. * @param screenHeight The height of the screen to apply the effect on.
  148998. * @param options The required width/height ratio to downsize to before computing the render pass.
  148999. * @param camera The camera to apply the render pass to.
  149000. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149001. * @param engine The engine which the post process will be applied. (default: current engine)
  149002. * @param reusable If the post process can be reused on the same frame. (default: false)
  149003. * @param textureType Type of textures used when performing the post process. (default: 0)
  149004. * @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)
  149005. */
  149006. constructor(name: string, screenWidth: number, screenHeight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  149007. /** @hidden */
  149008. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ChromaticAberrationPostProcess>;
  149009. }
  149010. }
  149011. declare module BABYLON {
  149012. /** @hidden */
  149013. export var circleOfConfusionPixelShader: {
  149014. name: string;
  149015. shader: string;
  149016. };
  149017. }
  149018. declare module BABYLON {
  149019. /**
  149020. * The CircleOfConfusionPostProcess computes the circle of confusion value for each pixel given required lens parameters. See https://en.wikipedia.org/wiki/Circle_of_confusion
  149021. */
  149022. export class CircleOfConfusionPostProcess extends PostProcess {
  149023. /**
  149024. * 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.
  149025. */
  149026. lensSize: number;
  149027. /**
  149028. * F-Stop of the effect's camera. The diamater of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  149029. */
  149030. fStop: number;
  149031. /**
  149032. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  149033. */
  149034. focusDistance: number;
  149035. /**
  149036. * Focal length of the effect's camera in scene units/1000 (eg. millimeter). (default: 50)
  149037. */
  149038. focalLength: number;
  149039. /**
  149040. * Gets a string identifying the name of the class
  149041. * @returns "CircleOfConfusionPostProcess" string
  149042. */
  149043. getClassName(): string;
  149044. private _depthTexture;
  149045. /**
  149046. * Creates a new instance CircleOfConfusionPostProcess
  149047. * @param name The name of the effect.
  149048. * @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.
  149049. * @param options The required width/height ratio to downsize to before computing the render pass.
  149050. * @param camera The camera to apply the render pass to.
  149051. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149052. * @param engine The engine which the post process will be applied. (default: current engine)
  149053. * @param reusable If the post process can be reused on the same frame. (default: false)
  149054. * @param textureType Type of textures used when performing the post process. (default: 0)
  149055. * @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)
  149056. */
  149057. constructor(name: string, depthTexture: Nullable<RenderTargetTexture>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  149058. /**
  149059. * 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.
  149060. */
  149061. set depthTexture(value: RenderTargetTexture);
  149062. }
  149063. }
  149064. declare module BABYLON {
  149065. /** @hidden */
  149066. export var colorCorrectionPixelShader: {
  149067. name: string;
  149068. shader: string;
  149069. };
  149070. }
  149071. declare module BABYLON {
  149072. /**
  149073. *
  149074. * This post-process allows the modification of rendered colors by using
  149075. * a 'look-up table' (LUT). This effect is also called Color Grading.
  149076. *
  149077. * The object needs to be provided an url to a texture containing the color
  149078. * look-up table: the texture must be 256 pixels wide and 16 pixels high.
  149079. * Use an image editing software to tweak the LUT to match your needs.
  149080. *
  149081. * For an example of a color LUT, see here:
  149082. * @see http://udn.epicgames.com/Three/rsrc/Three/ColorGrading/RGBTable16x1.png
  149083. * For explanations on color grading, see here:
  149084. * @see http://udn.epicgames.com/Three/ColorGrading.html
  149085. *
  149086. */
  149087. export class ColorCorrectionPostProcess extends PostProcess {
  149088. private _colorTableTexture;
  149089. /**
  149090. * Gets the color table url used to create the LUT texture
  149091. */
  149092. colorTableUrl: string;
  149093. /**
  149094. * Gets a string identifying the name of the class
  149095. * @returns "ColorCorrectionPostProcess" string
  149096. */
  149097. getClassName(): string;
  149098. constructor(name: string, colorTableUrl: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  149099. /** @hidden */
  149100. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ColorCorrectionPostProcess>;
  149101. }
  149102. }
  149103. declare module BABYLON {
  149104. /** @hidden */
  149105. export var convolutionPixelShader: {
  149106. name: string;
  149107. shader: string;
  149108. };
  149109. }
  149110. declare module BABYLON {
  149111. /**
  149112. * The ConvolutionPostProcess applies a 3x3 kernel to every pixel of the
  149113. * input texture to perform effects such as edge detection or sharpening
  149114. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  149115. */
  149116. export class ConvolutionPostProcess extends PostProcess {
  149117. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  149118. kernel: number[];
  149119. /**
  149120. * Gets a string identifying the name of the class
  149121. * @returns "ConvolutionPostProcess" string
  149122. */
  149123. getClassName(): string;
  149124. /**
  149125. * Creates a new instance ConvolutionPostProcess
  149126. * @param name The name of the effect.
  149127. * @param kernel Array of 9 values corresponding to the 3x3 kernel to be applied
  149128. * @param options The required width/height ratio to downsize to before computing the render pass.
  149129. * @param camera The camera to apply the render pass to.
  149130. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149131. * @param engine The engine which the post process will be applied. (default: current engine)
  149132. * @param reusable If the post process can be reused on the same frame. (default: false)
  149133. * @param textureType Type of textures used when performing the post process. (default: 0)
  149134. */
  149135. constructor(name: string, kernel: number[], options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  149136. /** @hidden */
  149137. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ConvolutionPostProcess>;
  149138. /**
  149139. * Edge detection 0 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  149140. */
  149141. static EdgeDetect0Kernel: number[];
  149142. /**
  149143. * Edge detection 1 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  149144. */
  149145. static EdgeDetect1Kernel: number[];
  149146. /**
  149147. * Edge detection 2 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  149148. */
  149149. static EdgeDetect2Kernel: number[];
  149150. /**
  149151. * Kernel to sharpen an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  149152. */
  149153. static SharpenKernel: number[];
  149154. /**
  149155. * Kernel to emboss an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  149156. */
  149157. static EmbossKernel: number[];
  149158. /**
  149159. * Kernel to blur an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  149160. */
  149161. static GaussianKernel: number[];
  149162. }
  149163. }
  149164. declare module BABYLON {
  149165. /**
  149166. * The DepthOfFieldBlurPostProcess applied a blur in a give direction.
  149167. * This blur differs from the standard BlurPostProcess as it attempts to avoid blurring pixels
  149168. * based on samples that have a large difference in distance than the center pixel.
  149169. * See section 2.6.2 http://fileadmin.cs.lth.se/cs/education/edan35/lectures/12dof.pdf
  149170. */
  149171. export class DepthOfFieldBlurPostProcess extends BlurPostProcess {
  149172. /**
  149173. * The direction the blur should be applied
  149174. */
  149175. direction: Vector2;
  149176. /**
  149177. * Gets a string identifying the name of the class
  149178. * @returns "DepthOfFieldBlurPostProcess" string
  149179. */
  149180. getClassName(): string;
  149181. /**
  149182. * Creates a new instance CircleOfConfusionPostProcess
  149183. * @param name The name of the effect.
  149184. * @param scene The scene the effect belongs to.
  149185. * @param direction The direction the blur should be applied.
  149186. * @param kernel The size of the kernel used to blur.
  149187. * @param options The required width/height ratio to downsize to before computing the render pass.
  149188. * @param camera The camera to apply the render pass to.
  149189. * @param circleOfConfusion The circle of confusion + depth map to be used to avoid blurring accross edges
  149190. * @param imageToBlur The image to apply the blur to (default: Current rendered frame)
  149191. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149192. * @param engine The engine which the post process will be applied. (default: current engine)
  149193. * @param reusable If the post process can be reused on the same frame. (default: false)
  149194. * @param textureType Type of textures used when performing the post process. (default: 0)
  149195. * @param blockCompilation If compilation of the shader should not be done in the constructor. The updateEffect method can be used to compile the shader at a later time. (default: false)
  149196. */
  149197. constructor(name: string, 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);
  149198. }
  149199. }
  149200. declare module BABYLON {
  149201. /** @hidden */
  149202. export var depthOfFieldMergePixelShader: {
  149203. name: string;
  149204. shader: string;
  149205. };
  149206. }
  149207. declare module BABYLON {
  149208. /**
  149209. * Options to be set when merging outputs from the default pipeline.
  149210. */
  149211. export class DepthOfFieldMergePostProcessOptions {
  149212. /**
  149213. * The original image to merge on top of
  149214. */
  149215. originalFromInput: PostProcess;
  149216. /**
  149217. * Parameters to perform the merge of the depth of field effect
  149218. */
  149219. depthOfField?: {
  149220. circleOfConfusion: PostProcess;
  149221. blurSteps: Array<PostProcess>;
  149222. };
  149223. /**
  149224. * Parameters to perform the merge of bloom effect
  149225. */
  149226. bloom?: {
  149227. blurred: PostProcess;
  149228. weight: number;
  149229. };
  149230. }
  149231. /**
  149232. * The DepthOfFieldMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  149233. */
  149234. export class DepthOfFieldMergePostProcess extends PostProcess {
  149235. private blurSteps;
  149236. /**
  149237. * Gets a string identifying the name of the class
  149238. * @returns "DepthOfFieldMergePostProcess" string
  149239. */
  149240. getClassName(): string;
  149241. /**
  149242. * Creates a new instance of DepthOfFieldMergePostProcess
  149243. * @param name The name of the effect.
  149244. * @param originalFromInput Post process which's input will be used for the merge.
  149245. * @param circleOfConfusion Circle of confusion post process which's output will be used to blur each pixel.
  149246. * @param blurSteps Blur post processes from low to high which will be mixed with the original image.
  149247. * @param options The required width/height ratio to downsize to before computing the render pass.
  149248. * @param camera The camera to apply the render pass to.
  149249. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149250. * @param engine The engine which the post process will be applied. (default: current engine)
  149251. * @param reusable If the post process can be reused on the same frame. (default: false)
  149252. * @param textureType Type of textures used when performing the post process. (default: 0)
  149253. * @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)
  149254. */
  149255. 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);
  149256. /**
  149257. * Updates the effect with the current post process compile time values and recompiles the shader.
  149258. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  149259. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  149260. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  149261. * @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
  149262. * @param onCompiled Called when the shader has been compiled.
  149263. * @param onError Called if there is an error when compiling a shader.
  149264. */
  149265. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  149266. }
  149267. }
  149268. declare module BABYLON {
  149269. /**
  149270. * Specifies the level of max blur that should be applied when using the depth of field effect
  149271. */
  149272. export enum DepthOfFieldEffectBlurLevel {
  149273. /**
  149274. * Subtle blur
  149275. */
  149276. Low = 0,
  149277. /**
  149278. * Medium blur
  149279. */
  149280. Medium = 1,
  149281. /**
  149282. * Large blur
  149283. */
  149284. High = 2
  149285. }
  149286. /**
  149287. * The depth of field effect applies a blur to objects that are closer or further from where the camera is focusing.
  149288. */
  149289. export class DepthOfFieldEffect extends PostProcessRenderEffect {
  149290. private _circleOfConfusion;
  149291. /**
  149292. * @hidden Internal, blurs from high to low
  149293. */
  149294. _depthOfFieldBlurX: Array<DepthOfFieldBlurPostProcess>;
  149295. private _depthOfFieldBlurY;
  149296. private _dofMerge;
  149297. /**
  149298. * @hidden Internal post processes in depth of field effect
  149299. */
  149300. _effects: Array<PostProcess>;
  149301. /**
  149302. * The focal the length of the camera used in the effect in scene units/1000 (eg. millimeter)
  149303. */
  149304. set focalLength(value: number);
  149305. get focalLength(): number;
  149306. /**
  149307. * F-Stop of the effect's camera. The diameter of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  149308. */
  149309. set fStop(value: number);
  149310. get fStop(): number;
  149311. /**
  149312. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  149313. */
  149314. set focusDistance(value: number);
  149315. get focusDistance(): number;
  149316. /**
  149317. * 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.
  149318. */
  149319. set lensSize(value: number);
  149320. get lensSize(): number;
  149321. /**
  149322. * Creates a new instance DepthOfFieldEffect
  149323. * @param scene The scene the effect belongs to.
  149324. * @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.
  149325. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  149326. * @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)
  149327. */
  149328. constructor(scene: Scene, depthTexture: Nullable<RenderTargetTexture>, blurLevel?: DepthOfFieldEffectBlurLevel, pipelineTextureType?: number, blockCompilation?: boolean);
  149329. /**
  149330. * Get the current class name of the current effet
  149331. * @returns "DepthOfFieldEffect"
  149332. */
  149333. getClassName(): string;
  149334. /**
  149335. * 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.
  149336. */
  149337. set depthTexture(value: RenderTargetTexture);
  149338. /**
  149339. * Disposes each of the internal effects for a given camera.
  149340. * @param camera The camera to dispose the effect on.
  149341. */
  149342. disposeEffects(camera: Camera): void;
  149343. /**
  149344. * @hidden Internal
  149345. */
  149346. _updateEffects(): void;
  149347. /**
  149348. * Internal
  149349. * @returns if all the contained post processes are ready.
  149350. * @hidden
  149351. */
  149352. _isReady(): boolean;
  149353. }
  149354. }
  149355. declare module BABYLON {
  149356. /** @hidden */
  149357. export var displayPassPixelShader: {
  149358. name: string;
  149359. shader: string;
  149360. };
  149361. }
  149362. declare module BABYLON {
  149363. /**
  149364. * DisplayPassPostProcess which produces an output the same as it's input
  149365. */
  149366. export class DisplayPassPostProcess extends PostProcess {
  149367. /**
  149368. * Gets a string identifying the name of the class
  149369. * @returns "DisplayPassPostProcess" string
  149370. */
  149371. getClassName(): string;
  149372. /**
  149373. * Creates the DisplayPassPostProcess
  149374. * @param name The name of the effect.
  149375. * @param options The required width/height ratio to downsize to before computing the render pass.
  149376. * @param camera The camera to apply the render pass to.
  149377. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149378. * @param engine The engine which the post process will be applied. (default: current engine)
  149379. * @param reusable If the post process can be reused on the same frame. (default: false)
  149380. */
  149381. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  149382. /** @hidden */
  149383. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<DisplayPassPostProcess>;
  149384. }
  149385. }
  149386. declare module BABYLON {
  149387. /** @hidden */
  149388. export var filterPixelShader: {
  149389. name: string;
  149390. shader: string;
  149391. };
  149392. }
  149393. declare module BABYLON {
  149394. /**
  149395. * Applies a kernel filter to the image
  149396. */
  149397. export class FilterPostProcess extends PostProcess {
  149398. /** The matrix to be applied to the image */
  149399. kernelMatrix: Matrix;
  149400. /**
  149401. * Gets a string identifying the name of the class
  149402. * @returns "FilterPostProcess" string
  149403. */
  149404. getClassName(): string;
  149405. /**
  149406. *
  149407. * @param name The name of the effect.
  149408. * @param kernelMatrix The matrix to be applied to the image
  149409. * @param options The required width/height ratio to downsize to before computing the render pass.
  149410. * @param camera The camera to apply the render pass to.
  149411. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149412. * @param engine The engine which the post process will be applied. (default: current engine)
  149413. * @param reusable If the post process can be reused on the same frame. (default: false)
  149414. */
  149415. constructor(name: string, kernelMatrix: Matrix, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  149416. /** @hidden */
  149417. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<FilterPostProcess>;
  149418. }
  149419. }
  149420. declare module BABYLON {
  149421. /** @hidden */
  149422. export var fxaaPixelShader: {
  149423. name: string;
  149424. shader: string;
  149425. };
  149426. }
  149427. declare module BABYLON {
  149428. /** @hidden */
  149429. export var fxaaVertexShader: {
  149430. name: string;
  149431. shader: string;
  149432. };
  149433. }
  149434. declare module BABYLON {
  149435. /**
  149436. * Fxaa post process
  149437. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#fxaa
  149438. */
  149439. export class FxaaPostProcess extends PostProcess {
  149440. /**
  149441. * Gets a string identifying the name of the class
  149442. * @returns "FxaaPostProcess" string
  149443. */
  149444. getClassName(): string;
  149445. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  149446. private _getDefines;
  149447. /** @hidden */
  149448. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): FxaaPostProcess;
  149449. }
  149450. }
  149451. declare module BABYLON {
  149452. /** @hidden */
  149453. export var grainPixelShader: {
  149454. name: string;
  149455. shader: string;
  149456. };
  149457. }
  149458. declare module BABYLON {
  149459. /**
  149460. * The GrainPostProcess adds noise to the image at mid luminance levels
  149461. */
  149462. export class GrainPostProcess extends PostProcess {
  149463. /**
  149464. * The intensity of the grain added (default: 30)
  149465. */
  149466. intensity: number;
  149467. /**
  149468. * If the grain should be randomized on every frame
  149469. */
  149470. animated: boolean;
  149471. /**
  149472. * Gets a string identifying the name of the class
  149473. * @returns "GrainPostProcess" string
  149474. */
  149475. getClassName(): string;
  149476. /**
  149477. * Creates a new instance of @see GrainPostProcess
  149478. * @param name The name of the effect.
  149479. * @param options The required width/height ratio to downsize to before computing the render pass.
  149480. * @param camera The camera to apply the render pass to.
  149481. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149482. * @param engine The engine which the post process will be applied. (default: current engine)
  149483. * @param reusable If the post process can be reused on the same frame. (default: false)
  149484. * @param textureType Type of textures used when performing the post process. (default: 0)
  149485. * @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)
  149486. */
  149487. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  149488. /** @hidden */
  149489. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): GrainPostProcess;
  149490. }
  149491. }
  149492. declare module BABYLON {
  149493. /** @hidden */
  149494. export var highlightsPixelShader: {
  149495. name: string;
  149496. shader: string;
  149497. };
  149498. }
  149499. declare module BABYLON {
  149500. /**
  149501. * Extracts highlights from the image
  149502. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  149503. */
  149504. export class HighlightsPostProcess extends PostProcess {
  149505. /**
  149506. * Gets a string identifying the name of the class
  149507. * @returns "HighlightsPostProcess" string
  149508. */
  149509. getClassName(): string;
  149510. /**
  149511. * Extracts highlights from the image
  149512. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  149513. * @param name The name of the effect.
  149514. * @param options The required width/height ratio to downsize to before computing the render pass.
  149515. * @param camera The camera to apply the render pass to.
  149516. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149517. * @param engine The engine which the post process will be applied. (default: current engine)
  149518. * @param reusable If the post process can be reused on the same frame. (default: false)
  149519. * @param textureType Type of texture for the post process (default: Engine.TEXTURETYPE_UNSIGNED_INT)
  149520. */
  149521. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  149522. }
  149523. }
  149524. declare module BABYLON {
  149525. /** @hidden */
  149526. export var mrtFragmentDeclaration: {
  149527. name: string;
  149528. shader: string;
  149529. };
  149530. }
  149531. declare module BABYLON {
  149532. /** @hidden */
  149533. export var geometryPixelShader: {
  149534. name: string;
  149535. shader: string;
  149536. };
  149537. }
  149538. declare module BABYLON {
  149539. /** @hidden */
  149540. export var geometryVertexShader: {
  149541. name: string;
  149542. shader: string;
  149543. };
  149544. }
  149545. declare module BABYLON {
  149546. /** @hidden */
  149547. interface ISavedTransformationMatrix {
  149548. world: Matrix;
  149549. viewProjection: Matrix;
  149550. }
  149551. /**
  149552. * This renderer is helpfull to fill one of the render target with a geometry buffer.
  149553. */
  149554. export class GeometryBufferRenderer {
  149555. /**
  149556. * Constant used to retrieve the position texture index in the G-Buffer textures array
  149557. * using getIndex(GeometryBufferRenderer.POSITION_TEXTURE_INDEX)
  149558. */
  149559. static readonly POSITION_TEXTURE_TYPE: number;
  149560. /**
  149561. * Constant used to retrieve the velocity texture index in the G-Buffer textures array
  149562. * using getIndex(GeometryBufferRenderer.VELOCITY_TEXTURE_INDEX)
  149563. */
  149564. static readonly VELOCITY_TEXTURE_TYPE: number;
  149565. /**
  149566. * Constant used to retrieve the reflectivity texture index in the G-Buffer textures array
  149567. * using the getIndex(GeometryBufferRenderer.REFLECTIVITY_TEXTURE_TYPE)
  149568. */
  149569. static readonly REFLECTIVITY_TEXTURE_TYPE: number;
  149570. /**
  149571. * Dictionary used to store the previous transformation matrices of each rendered mesh
  149572. * in order to compute objects velocities when enableVelocity is set to "true"
  149573. * @hidden
  149574. */
  149575. _previousTransformationMatrices: {
  149576. [index: number]: ISavedTransformationMatrix;
  149577. };
  149578. /**
  149579. * Dictionary used to store the previous bones transformation matrices of each rendered mesh
  149580. * in order to compute objects velocities when enableVelocity is set to "true"
  149581. * @hidden
  149582. */
  149583. _previousBonesTransformationMatrices: {
  149584. [index: number]: Float32Array;
  149585. };
  149586. /**
  149587. * Array used to store the ignored skinned meshes while computing velocity map (typically used by the motion blur post-process).
  149588. * Avoids computing bones velocities and computes only mesh's velocity itself (position, rotation, scaling).
  149589. */
  149590. excludedSkinnedMeshesFromVelocity: AbstractMesh[];
  149591. /** Gets or sets a boolean indicating if transparent meshes should be rendered */
  149592. renderTransparentMeshes: boolean;
  149593. private _scene;
  149594. private _resizeObserver;
  149595. private _multiRenderTarget;
  149596. private _ratio;
  149597. private _enablePosition;
  149598. private _enableVelocity;
  149599. private _enableReflectivity;
  149600. private _positionIndex;
  149601. private _velocityIndex;
  149602. private _reflectivityIndex;
  149603. protected _effect: Effect;
  149604. protected _cachedDefines: string;
  149605. /**
  149606. * Set the render list (meshes to be rendered) used in the G buffer.
  149607. */
  149608. set renderList(meshes: Mesh[]);
  149609. /**
  149610. * Gets wether or not G buffer are supported by the running hardware.
  149611. * This requires draw buffer supports
  149612. */
  149613. get isSupported(): boolean;
  149614. /**
  149615. * Returns the index of the given texture type in the G-Buffer textures array
  149616. * @param textureType The texture type constant. For example GeometryBufferRenderer.POSITION_TEXTURE_INDEX
  149617. * @returns the index of the given texture type in the G-Buffer textures array
  149618. */
  149619. getTextureIndex(textureType: number): number;
  149620. /**
  149621. * Gets a boolean indicating if objects positions are enabled for the G buffer.
  149622. */
  149623. get enablePosition(): boolean;
  149624. /**
  149625. * Sets whether or not objects positions are enabled for the G buffer.
  149626. */
  149627. set enablePosition(enable: boolean);
  149628. /**
  149629. * Gets a boolean indicating if objects velocities are enabled for the G buffer.
  149630. */
  149631. get enableVelocity(): boolean;
  149632. /**
  149633. * Sets wether or not objects velocities are enabled for the G buffer.
  149634. */
  149635. set enableVelocity(enable: boolean);
  149636. /**
  149637. * Gets a boolean indicating if objects roughness are enabled in the G buffer.
  149638. */
  149639. get enableReflectivity(): boolean;
  149640. /**
  149641. * Sets wether or not objects roughness are enabled for the G buffer.
  149642. */
  149643. set enableReflectivity(enable: boolean);
  149644. /**
  149645. * Gets the scene associated with the buffer.
  149646. */
  149647. get scene(): Scene;
  149648. /**
  149649. * Gets the ratio used by the buffer during its creation.
  149650. * How big is the buffer related to the main canvas.
  149651. */
  149652. get ratio(): number;
  149653. /** @hidden */
  149654. static _SceneComponentInitialization: (scene: Scene) => void;
  149655. /**
  149656. * Creates a new G Buffer for the scene
  149657. * @param scene The scene the buffer belongs to
  149658. * @param ratio How big is the buffer related to the main canvas.
  149659. */
  149660. constructor(scene: Scene, ratio?: number);
  149661. /**
  149662. * Checks wether everything is ready to render a submesh to the G buffer.
  149663. * @param subMesh the submesh to check readiness for
  149664. * @param useInstances is the mesh drawn using instance or not
  149665. * @returns true if ready otherwise false
  149666. */
  149667. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  149668. /**
  149669. * Gets the current underlying G Buffer.
  149670. * @returns the buffer
  149671. */
  149672. getGBuffer(): MultiRenderTarget;
  149673. /**
  149674. * Gets the number of samples used to render the buffer (anti aliasing).
  149675. */
  149676. get samples(): number;
  149677. /**
  149678. * Sets the number of samples used to render the buffer (anti aliasing).
  149679. */
  149680. set samples(value: number);
  149681. /**
  149682. * Disposes the renderer and frees up associated resources.
  149683. */
  149684. dispose(): void;
  149685. protected _createRenderTargets(): void;
  149686. private _copyBonesTransformationMatrices;
  149687. }
  149688. }
  149689. declare module BABYLON {
  149690. interface Scene {
  149691. /** @hidden (Backing field) */
  149692. _geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  149693. /**
  149694. * Gets or Sets the current geometry buffer associated to the scene.
  149695. */
  149696. geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  149697. /**
  149698. * Enables a GeometryBufferRender and associates it with the scene
  149699. * @param ratio defines the scaling ratio to apply to the renderer (1 by default which means same resolution)
  149700. * @returns the GeometryBufferRenderer
  149701. */
  149702. enableGeometryBufferRenderer(ratio?: number): Nullable<GeometryBufferRenderer>;
  149703. /**
  149704. * Disables the GeometryBufferRender associated with the scene
  149705. */
  149706. disableGeometryBufferRenderer(): void;
  149707. }
  149708. /**
  149709. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  149710. * in several rendering techniques.
  149711. */
  149712. export class GeometryBufferRendererSceneComponent implements ISceneComponent {
  149713. /**
  149714. * The component name helpful to identify the component in the list of scene components.
  149715. */
  149716. readonly name: string;
  149717. /**
  149718. * The scene the component belongs to.
  149719. */
  149720. scene: Scene;
  149721. /**
  149722. * Creates a new instance of the component for the given scene
  149723. * @param scene Defines the scene to register the component in
  149724. */
  149725. constructor(scene: Scene);
  149726. /**
  149727. * Registers the component in a given scene
  149728. */
  149729. register(): void;
  149730. /**
  149731. * Rebuilds the elements related to this component in case of
  149732. * context lost for instance.
  149733. */
  149734. rebuild(): void;
  149735. /**
  149736. * Disposes the component and the associated ressources
  149737. */
  149738. dispose(): void;
  149739. private _gatherRenderTargets;
  149740. }
  149741. }
  149742. declare module BABYLON {
  149743. /** @hidden */
  149744. export var motionBlurPixelShader: {
  149745. name: string;
  149746. shader: string;
  149747. };
  149748. }
  149749. declare module BABYLON {
  149750. /**
  149751. * The Motion Blur Post Process which blurs an image based on the objects velocity in scene.
  149752. * Velocity can be affected by each object's rotation, position and scale depending on the transformation speed.
  149753. * As an example, all you have to do is to create the post-process:
  149754. * var mb = new BABYLON.MotionBlurPostProcess(
  149755. * 'mb', // The name of the effect.
  149756. * scene, // The scene containing the objects to blur according to their velocity.
  149757. * 1.0, // The required width/height ratio to downsize to before computing the render pass.
  149758. * camera // The camera to apply the render pass to.
  149759. * );
  149760. * Then, all objects moving, rotating and/or scaling will be blurred depending on the transformation speed.
  149761. */
  149762. export class MotionBlurPostProcess extends PostProcess {
  149763. /**
  149764. * Defines how much the image is blurred by the movement. Default value is equal to 1
  149765. */
  149766. motionStrength: number;
  149767. /**
  149768. * Gets the number of iterations are used for motion blur quality. Default value is equal to 32
  149769. */
  149770. get motionBlurSamples(): number;
  149771. /**
  149772. * Sets the number of iterations to be used for motion blur quality
  149773. */
  149774. set motionBlurSamples(samples: number);
  149775. private _motionBlurSamples;
  149776. private _geometryBufferRenderer;
  149777. /**
  149778. * Gets a string identifying the name of the class
  149779. * @returns "MotionBlurPostProcess" string
  149780. */
  149781. getClassName(): string;
  149782. /**
  149783. * Creates a new instance MotionBlurPostProcess
  149784. * @param name The name of the effect.
  149785. * @param scene The scene containing the objects to blur according to their velocity.
  149786. * @param options The required width/height ratio to downsize to before computing the render pass.
  149787. * @param camera The camera to apply the render pass to.
  149788. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149789. * @param engine The engine which the post process will be applied. (default: current engine)
  149790. * @param reusable If the post process can be reused on the same frame. (default: false)
  149791. * @param textureType Type of textures used when performing the post process. (default: 0)
  149792. * @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)
  149793. */
  149794. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  149795. /**
  149796. * Excludes the given skinned mesh from computing bones velocities.
  149797. * 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.
  149798. * @param skinnedMesh The mesh containing the skeleton to ignore when computing the velocity map.
  149799. */
  149800. excludeSkinnedMesh(skinnedMesh: AbstractMesh): void;
  149801. /**
  149802. * Removes the given skinned mesh from the excluded meshes to integrate bones velocities while rendering the velocity map.
  149803. * @param skinnedMesh The mesh containing the skeleton that has been ignored previously.
  149804. * @see excludeSkinnedMesh to exclude a skinned mesh from bones velocity computation.
  149805. */
  149806. removeExcludedSkinnedMesh(skinnedMesh: AbstractMesh): void;
  149807. /**
  149808. * Disposes the post process.
  149809. * @param camera The camera to dispose the post process on.
  149810. */
  149811. dispose(camera?: Camera): void;
  149812. /** @hidden */
  149813. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<MotionBlurPostProcess>;
  149814. }
  149815. }
  149816. declare module BABYLON {
  149817. /** @hidden */
  149818. export var refractionPixelShader: {
  149819. name: string;
  149820. shader: string;
  149821. };
  149822. }
  149823. declare module BABYLON {
  149824. /**
  149825. * Post process which applies a refractin texture
  149826. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  149827. */
  149828. export class RefractionPostProcess extends PostProcess {
  149829. private _refTexture;
  149830. private _ownRefractionTexture;
  149831. /** the base color of the refraction (used to taint the rendering) */
  149832. color: Color3;
  149833. /** simulated refraction depth */
  149834. depth: number;
  149835. /** the coefficient of the base color (0 to remove base color tainting) */
  149836. colorLevel: number;
  149837. /** Gets the url used to load the refraction texture */
  149838. refractionTextureUrl: string;
  149839. /**
  149840. * Gets or sets the refraction texture
  149841. * Please note that you are responsible for disposing the texture if you set it manually
  149842. */
  149843. get refractionTexture(): Texture;
  149844. set refractionTexture(value: Texture);
  149845. /**
  149846. * Gets a string identifying the name of the class
  149847. * @returns "RefractionPostProcess" string
  149848. */
  149849. getClassName(): string;
  149850. /**
  149851. * Initializes the RefractionPostProcess
  149852. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  149853. * @param name The name of the effect.
  149854. * @param refractionTextureUrl Url of the refraction texture to use
  149855. * @param color the base color of the refraction (used to taint the rendering)
  149856. * @param depth simulated refraction depth
  149857. * @param colorLevel the coefficient of the base color (0 to remove base color tainting)
  149858. * @param camera The camera to apply the render pass to.
  149859. * @param options The required width/height ratio to downsize to before computing the render pass.
  149860. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149861. * @param engine The engine which the post process will be applied. (default: current engine)
  149862. * @param reusable If the post process can be reused on the same frame. (default: false)
  149863. */
  149864. constructor(name: string, refractionTextureUrl: string, color: Color3, depth: number, colorLevel: number, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  149865. /**
  149866. * Disposes of the post process
  149867. * @param camera Camera to dispose post process on
  149868. */
  149869. dispose(camera: Camera): void;
  149870. /** @hidden */
  149871. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): RefractionPostProcess;
  149872. }
  149873. }
  149874. declare module BABYLON {
  149875. /** @hidden */
  149876. export var sharpenPixelShader: {
  149877. name: string;
  149878. shader: string;
  149879. };
  149880. }
  149881. declare module BABYLON {
  149882. /**
  149883. * The SharpenPostProcess applies a sharpen kernel to every pixel
  149884. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  149885. */
  149886. export class SharpenPostProcess extends PostProcess {
  149887. /**
  149888. * How much of the original color should be applied. Setting this to 0 will display edge detection. (default: 1)
  149889. */
  149890. colorAmount: number;
  149891. /**
  149892. * How much sharpness should be applied (default: 0.3)
  149893. */
  149894. edgeAmount: number;
  149895. /**
  149896. * Gets a string identifying the name of the class
  149897. * @returns "SharpenPostProcess" string
  149898. */
  149899. getClassName(): string;
  149900. /**
  149901. * Creates a new instance ConvolutionPostProcess
  149902. * @param name The name of the effect.
  149903. * @param options The required width/height ratio to downsize to before computing the render pass.
  149904. * @param camera The camera to apply the render pass to.
  149905. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149906. * @param engine The engine which the post process will be applied. (default: current engine)
  149907. * @param reusable If the post process can be reused on the same frame. (default: false)
  149908. * @param textureType Type of textures used when performing the post process. (default: 0)
  149909. * @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)
  149910. */
  149911. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  149912. /** @hidden */
  149913. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): SharpenPostProcess;
  149914. }
  149915. }
  149916. declare module BABYLON {
  149917. /**
  149918. * PostProcessRenderPipeline
  149919. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  149920. */
  149921. export class PostProcessRenderPipeline {
  149922. private engine;
  149923. private _renderEffects;
  149924. private _renderEffectsForIsolatedPass;
  149925. /**
  149926. * List of inspectable custom properties (used by the Inspector)
  149927. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  149928. */
  149929. inspectableCustomProperties: IInspectable[];
  149930. /**
  149931. * @hidden
  149932. */
  149933. protected _cameras: Camera[];
  149934. /** @hidden */
  149935. _name: string;
  149936. /**
  149937. * Gets pipeline name
  149938. */
  149939. get name(): string;
  149940. /** Gets the list of attached cameras */
  149941. get cameras(): Camera[];
  149942. /**
  149943. * Initializes a PostProcessRenderPipeline
  149944. * @param engine engine to add the pipeline to
  149945. * @param name name of the pipeline
  149946. */
  149947. constructor(engine: Engine, name: string);
  149948. /**
  149949. * Gets the class name
  149950. * @returns "PostProcessRenderPipeline"
  149951. */
  149952. getClassName(): string;
  149953. /**
  149954. * If all the render effects in the pipeline are supported
  149955. */
  149956. get isSupported(): boolean;
  149957. /**
  149958. * Adds an effect to the pipeline
  149959. * @param renderEffect the effect to add
  149960. */
  149961. addEffect(renderEffect: PostProcessRenderEffect): void;
  149962. /** @hidden */
  149963. _rebuild(): void;
  149964. /** @hidden */
  149965. _enableEffect(renderEffectName: string, cameras: Camera): void;
  149966. /** @hidden */
  149967. _enableEffect(renderEffectName: string, cameras: Camera[]): void;
  149968. /** @hidden */
  149969. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  149970. /** @hidden */
  149971. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  149972. /** @hidden */
  149973. _attachCameras(cameras: Camera, unique: boolean): void;
  149974. /** @hidden */
  149975. _attachCameras(cameras: Camera[], unique: boolean): void;
  149976. /** @hidden */
  149977. _detachCameras(cameras: Camera): void;
  149978. /** @hidden */
  149979. _detachCameras(cameras: Nullable<Camera[]>): void;
  149980. /** @hidden */
  149981. _update(): void;
  149982. /** @hidden */
  149983. _reset(): void;
  149984. protected _enableMSAAOnFirstPostProcess(sampleCount: number): boolean;
  149985. /**
  149986. * Sets the required values to the prepass renderer.
  149987. * @param prePassRenderer defines the prepass renderer to setup.
  149988. * @returns true if the pre pass is needed.
  149989. */
  149990. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  149991. /**
  149992. * Disposes of the pipeline
  149993. */
  149994. dispose(): void;
  149995. }
  149996. }
  149997. declare module BABYLON {
  149998. /**
  149999. * PostProcessRenderPipelineManager class
  150000. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  150001. */
  150002. export class PostProcessRenderPipelineManager {
  150003. private _renderPipelines;
  150004. /**
  150005. * Initializes a PostProcessRenderPipelineManager
  150006. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  150007. */
  150008. constructor();
  150009. /**
  150010. * Gets the list of supported render pipelines
  150011. */
  150012. get supportedPipelines(): PostProcessRenderPipeline[];
  150013. /**
  150014. * Adds a pipeline to the manager
  150015. * @param renderPipeline The pipeline to add
  150016. */
  150017. addPipeline(renderPipeline: PostProcessRenderPipeline): void;
  150018. /**
  150019. * Attaches a camera to the pipeline
  150020. * @param renderPipelineName The name of the pipeline to attach to
  150021. * @param cameras the camera to attach
  150022. * @param unique if the camera can be attached multiple times to the pipeline
  150023. */
  150024. attachCamerasToRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera, unique?: boolean): void;
  150025. /**
  150026. * Detaches a camera from the pipeline
  150027. * @param renderPipelineName The name of the pipeline to detach from
  150028. * @param cameras the camera to detach
  150029. */
  150030. detachCamerasFromRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera): void;
  150031. /**
  150032. * Enables an effect by name on a pipeline
  150033. * @param renderPipelineName the name of the pipeline to enable the effect in
  150034. * @param renderEffectName the name of the effect to enable
  150035. * @param cameras the cameras that the effect should be enabled on
  150036. */
  150037. enableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  150038. /**
  150039. * Disables an effect by name on a pipeline
  150040. * @param renderPipelineName the name of the pipeline to disable the effect in
  150041. * @param renderEffectName the name of the effect to disable
  150042. * @param cameras the cameras that the effect should be disabled on
  150043. */
  150044. disableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  150045. /**
  150046. * Updates the state of all contained render pipelines and disposes of any non supported pipelines
  150047. */
  150048. update(): void;
  150049. /** @hidden */
  150050. _rebuild(): void;
  150051. /**
  150052. * Disposes of the manager and pipelines
  150053. */
  150054. dispose(): void;
  150055. }
  150056. }
  150057. declare module BABYLON {
  150058. interface Scene {
  150059. /** @hidden (Backing field) */
  150060. _postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  150061. /**
  150062. * Gets the postprocess render pipeline manager
  150063. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  150064. * @see https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  150065. */
  150066. readonly postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  150067. }
  150068. /**
  150069. * Defines the Render Pipeline scene component responsible to rendering pipelines
  150070. */
  150071. export class PostProcessRenderPipelineManagerSceneComponent implements ISceneComponent {
  150072. /**
  150073. * The component name helpfull to identify the component in the list of scene components.
  150074. */
  150075. readonly name: string;
  150076. /**
  150077. * The scene the component belongs to.
  150078. */
  150079. scene: Scene;
  150080. /**
  150081. * Creates a new instance of the component for the given scene
  150082. * @param scene Defines the scene to register the component in
  150083. */
  150084. constructor(scene: Scene);
  150085. /**
  150086. * Registers the component in a given scene
  150087. */
  150088. register(): void;
  150089. /**
  150090. * Rebuilds the elements related to this component in case of
  150091. * context lost for instance.
  150092. */
  150093. rebuild(): void;
  150094. /**
  150095. * Disposes the component and the associated ressources
  150096. */
  150097. dispose(): void;
  150098. private _gatherRenderTargets;
  150099. }
  150100. }
  150101. declare module BABYLON {
  150102. /**
  150103. * The default rendering pipeline can be added to a scene to apply common post processing effects such as anti-aliasing or depth of field.
  150104. * See https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  150105. */
  150106. export class DefaultRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  150107. private _scene;
  150108. private _camerasToBeAttached;
  150109. /**
  150110. * ID of the sharpen post process,
  150111. */
  150112. private readonly SharpenPostProcessId;
  150113. /**
  150114. * @ignore
  150115. * ID of the image processing post process;
  150116. */
  150117. readonly ImageProcessingPostProcessId: string;
  150118. /**
  150119. * @ignore
  150120. * ID of the Fast Approximate Anti-Aliasing post process;
  150121. */
  150122. readonly FxaaPostProcessId: string;
  150123. /**
  150124. * ID of the chromatic aberration post process,
  150125. */
  150126. private readonly ChromaticAberrationPostProcessId;
  150127. /**
  150128. * ID of the grain post process
  150129. */
  150130. private readonly GrainPostProcessId;
  150131. /**
  150132. * Sharpen post process which will apply a sharpen convolution to enhance edges
  150133. */
  150134. sharpen: SharpenPostProcess;
  150135. private _sharpenEffect;
  150136. private bloom;
  150137. /**
  150138. * Depth of field effect, applies a blur based on how far away objects are from the focus distance.
  150139. */
  150140. depthOfField: DepthOfFieldEffect;
  150141. /**
  150142. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  150143. */
  150144. fxaa: FxaaPostProcess;
  150145. /**
  150146. * Image post processing pass used to perform operations such as tone mapping or color grading.
  150147. */
  150148. imageProcessing: ImageProcessingPostProcess;
  150149. /**
  150150. * Chromatic aberration post process which will shift rgb colors in the image
  150151. */
  150152. chromaticAberration: ChromaticAberrationPostProcess;
  150153. private _chromaticAberrationEffect;
  150154. /**
  150155. * Grain post process which add noise to the image
  150156. */
  150157. grain: GrainPostProcess;
  150158. private _grainEffect;
  150159. /**
  150160. * Glow post process which adds a glow to emissive areas of the image
  150161. */
  150162. private _glowLayer;
  150163. /**
  150164. * Animations which can be used to tweak settings over a period of time
  150165. */
  150166. animations: Animation[];
  150167. private _imageProcessingConfigurationObserver;
  150168. private _sharpenEnabled;
  150169. private _bloomEnabled;
  150170. private _depthOfFieldEnabled;
  150171. private _depthOfFieldBlurLevel;
  150172. private _fxaaEnabled;
  150173. private _imageProcessingEnabled;
  150174. private _defaultPipelineTextureType;
  150175. private _bloomScale;
  150176. private _chromaticAberrationEnabled;
  150177. private _grainEnabled;
  150178. private _buildAllowed;
  150179. /**
  150180. * Gets active scene
  150181. */
  150182. get scene(): Scene;
  150183. /**
  150184. * Enable or disable the sharpen process from the pipeline
  150185. */
  150186. set sharpenEnabled(enabled: boolean);
  150187. get sharpenEnabled(): boolean;
  150188. private _resizeObserver;
  150189. private _hardwareScaleLevel;
  150190. private _bloomKernel;
  150191. /**
  150192. * Specifies the size of the bloom blur kernel, relative to the final output size
  150193. */
  150194. get bloomKernel(): number;
  150195. set bloomKernel(value: number);
  150196. /**
  150197. * Specifies the weight of the bloom in the final rendering
  150198. */
  150199. private _bloomWeight;
  150200. /**
  150201. * Specifies the luma threshold for the area that will be blurred by the bloom
  150202. */
  150203. private _bloomThreshold;
  150204. private _hdr;
  150205. /**
  150206. * The strength of the bloom.
  150207. */
  150208. set bloomWeight(value: number);
  150209. get bloomWeight(): number;
  150210. /**
  150211. * The strength of the bloom.
  150212. */
  150213. set bloomThreshold(value: number);
  150214. get bloomThreshold(): number;
  150215. /**
  150216. * The scale of the bloom, lower value will provide better performance.
  150217. */
  150218. set bloomScale(value: number);
  150219. get bloomScale(): number;
  150220. /**
  150221. * Enable or disable the bloom from the pipeline
  150222. */
  150223. set bloomEnabled(enabled: boolean);
  150224. get bloomEnabled(): boolean;
  150225. private _rebuildBloom;
  150226. /**
  150227. * If the depth of field is enabled.
  150228. */
  150229. get depthOfFieldEnabled(): boolean;
  150230. set depthOfFieldEnabled(enabled: boolean);
  150231. /**
  150232. * Blur level of the depth of field effect. (Higher blur will effect performance)
  150233. */
  150234. get depthOfFieldBlurLevel(): DepthOfFieldEffectBlurLevel;
  150235. set depthOfFieldBlurLevel(value: DepthOfFieldEffectBlurLevel);
  150236. /**
  150237. * If the anti aliasing is enabled.
  150238. */
  150239. set fxaaEnabled(enabled: boolean);
  150240. get fxaaEnabled(): boolean;
  150241. private _samples;
  150242. /**
  150243. * MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  150244. */
  150245. set samples(sampleCount: number);
  150246. get samples(): number;
  150247. /**
  150248. * If image processing is enabled.
  150249. */
  150250. set imageProcessingEnabled(enabled: boolean);
  150251. get imageProcessingEnabled(): boolean;
  150252. /**
  150253. * If glow layer is enabled. (Adds a glow effect to emmissive materials)
  150254. */
  150255. set glowLayerEnabled(enabled: boolean);
  150256. get glowLayerEnabled(): boolean;
  150257. /**
  150258. * Gets the glow layer (or null if not defined)
  150259. */
  150260. get glowLayer(): Nullable<GlowLayer>;
  150261. /**
  150262. * Enable or disable the chromaticAberration process from the pipeline
  150263. */
  150264. set chromaticAberrationEnabled(enabled: boolean);
  150265. get chromaticAberrationEnabled(): boolean;
  150266. /**
  150267. * Enable or disable the grain process from the pipeline
  150268. */
  150269. set grainEnabled(enabled: boolean);
  150270. get grainEnabled(): boolean;
  150271. /**
  150272. * @constructor
  150273. * @param name - The rendering pipeline name (default: "")
  150274. * @param hdr - If high dynamic range textures should be used (default: true)
  150275. * @param scene - The scene linked to this pipeline (default: the last created scene)
  150276. * @param cameras - The array of cameras that the rendering pipeline will be attached to (default: scene.cameras)
  150277. * @param automaticBuild - if false, you will have to manually call prepare() to update the pipeline (default: true)
  150278. */
  150279. constructor(name?: string, hdr?: boolean, scene?: Scene, cameras?: Camera[], automaticBuild?: boolean);
  150280. /**
  150281. * Get the class name
  150282. * @returns "DefaultRenderingPipeline"
  150283. */
  150284. getClassName(): string;
  150285. /**
  150286. * Force the compilation of the entire pipeline.
  150287. */
  150288. prepare(): void;
  150289. private _hasCleared;
  150290. private _prevPostProcess;
  150291. private _prevPrevPostProcess;
  150292. private _setAutoClearAndTextureSharing;
  150293. private _depthOfFieldSceneObserver;
  150294. private _buildPipeline;
  150295. private _disposePostProcesses;
  150296. /**
  150297. * Adds a camera to the pipeline
  150298. * @param camera the camera to be added
  150299. */
  150300. addCamera(camera: Camera): void;
  150301. /**
  150302. * Removes a camera from the pipeline
  150303. * @param camera the camera to remove
  150304. */
  150305. removeCamera(camera: Camera): void;
  150306. /**
  150307. * Dispose of the pipeline and stop all post processes
  150308. */
  150309. dispose(): void;
  150310. /**
  150311. * Serialize the rendering pipeline (Used when exporting)
  150312. * @returns the serialized object
  150313. */
  150314. serialize(): any;
  150315. /**
  150316. * Parse the serialized pipeline
  150317. * @param source Source pipeline.
  150318. * @param scene The scene to load the pipeline to.
  150319. * @param rootUrl The URL of the serialized pipeline.
  150320. * @returns An instantiated pipeline from the serialized object.
  150321. */
  150322. static Parse(source: any, scene: Scene, rootUrl: string): DefaultRenderingPipeline;
  150323. }
  150324. }
  150325. declare module BABYLON {
  150326. /** @hidden */
  150327. export var lensHighlightsPixelShader: {
  150328. name: string;
  150329. shader: string;
  150330. };
  150331. }
  150332. declare module BABYLON {
  150333. /** @hidden */
  150334. export var depthOfFieldPixelShader: {
  150335. name: string;
  150336. shader: string;
  150337. };
  150338. }
  150339. declare module BABYLON {
  150340. /**
  150341. * BABYLON.JS Chromatic Aberration GLSL Shader
  150342. * Author: Olivier Guyot
  150343. * Separates very slightly R, G and B colors on the edges of the screen
  150344. * Inspired by Francois Tarlier & Martins Upitis
  150345. */
  150346. export class LensRenderingPipeline extends PostProcessRenderPipeline {
  150347. /**
  150348. * @ignore
  150349. * The chromatic aberration PostProcess id in the pipeline
  150350. */
  150351. LensChromaticAberrationEffect: string;
  150352. /**
  150353. * @ignore
  150354. * The highlights enhancing PostProcess id in the pipeline
  150355. */
  150356. HighlightsEnhancingEffect: string;
  150357. /**
  150358. * @ignore
  150359. * The depth-of-field PostProcess id in the pipeline
  150360. */
  150361. LensDepthOfFieldEffect: string;
  150362. private _scene;
  150363. private _depthTexture;
  150364. private _grainTexture;
  150365. private _chromaticAberrationPostProcess;
  150366. private _highlightsPostProcess;
  150367. private _depthOfFieldPostProcess;
  150368. private _edgeBlur;
  150369. private _grainAmount;
  150370. private _chromaticAberration;
  150371. private _distortion;
  150372. private _highlightsGain;
  150373. private _highlightsThreshold;
  150374. private _dofDistance;
  150375. private _dofAperture;
  150376. private _dofDarken;
  150377. private _dofPentagon;
  150378. private _blurNoise;
  150379. /**
  150380. * @constructor
  150381. *
  150382. * Effect parameters are as follow:
  150383. * {
  150384. * chromatic_aberration: number; // from 0 to x (1 for realism)
  150385. * edge_blur: number; // from 0 to x (1 for realism)
  150386. * distortion: number; // from 0 to x (1 for realism)
  150387. * grain_amount: number; // from 0 to 1
  150388. * grain_texture: BABYLON.Texture; // texture to use for grain effect; if unset, use random B&W noise
  150389. * dof_focus_distance: number; // depth-of-field: focus distance; unset to disable (disabled by default)
  150390. * dof_aperture: number; // depth-of-field: focus blur bias (default: 1)
  150391. * dof_darken: number; // depth-of-field: darken that which is out of focus (from 0 to 1, disabled by default)
  150392. * dof_pentagon: boolean; // depth-of-field: makes a pentagon-like "bokeh" effect
  150393. * dof_gain: number; // depth-of-field: highlights gain; unset to disable (disabled by default)
  150394. * dof_threshold: number; // depth-of-field: highlights threshold (default: 1)
  150395. * blur_noise: boolean; // add a little bit of noise to the blur (default: true)
  150396. * }
  150397. * Note: if an effect parameter is unset, effect is disabled
  150398. *
  150399. * @param name The rendering pipeline name
  150400. * @param parameters - An object containing all parameters (see above)
  150401. * @param scene The scene linked to this pipeline
  150402. * @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)
  150403. * @param cameras The array of cameras that the rendering pipeline will be attached to
  150404. */
  150405. constructor(name: string, parameters: any, scene: Scene, ratio?: number, cameras?: Camera[]);
  150406. /**
  150407. * Get the class name
  150408. * @returns "LensRenderingPipeline"
  150409. */
  150410. getClassName(): string;
  150411. /**
  150412. * Gets associated scene
  150413. */
  150414. get scene(): Scene;
  150415. /**
  150416. * Gets or sets the edge blur
  150417. */
  150418. get edgeBlur(): number;
  150419. set edgeBlur(value: number);
  150420. /**
  150421. * Gets or sets the grain amount
  150422. */
  150423. get grainAmount(): number;
  150424. set grainAmount(value: number);
  150425. /**
  150426. * Gets or sets the chromatic aberration amount
  150427. */
  150428. get chromaticAberration(): number;
  150429. set chromaticAberration(value: number);
  150430. /**
  150431. * Gets or sets the depth of field aperture
  150432. */
  150433. get dofAperture(): number;
  150434. set dofAperture(value: number);
  150435. /**
  150436. * Gets or sets the edge distortion
  150437. */
  150438. get edgeDistortion(): number;
  150439. set edgeDistortion(value: number);
  150440. /**
  150441. * Gets or sets the depth of field distortion
  150442. */
  150443. get dofDistortion(): number;
  150444. set dofDistortion(value: number);
  150445. /**
  150446. * Gets or sets the darken out of focus amount
  150447. */
  150448. get darkenOutOfFocus(): number;
  150449. set darkenOutOfFocus(value: number);
  150450. /**
  150451. * Gets or sets a boolean indicating if blur noise is enabled
  150452. */
  150453. get blurNoise(): boolean;
  150454. set blurNoise(value: boolean);
  150455. /**
  150456. * Gets or sets a boolean indicating if pentagon bokeh is enabled
  150457. */
  150458. get pentagonBokeh(): boolean;
  150459. set pentagonBokeh(value: boolean);
  150460. /**
  150461. * Gets or sets the highlight grain amount
  150462. */
  150463. get highlightsGain(): number;
  150464. set highlightsGain(value: number);
  150465. /**
  150466. * Gets or sets the highlight threshold
  150467. */
  150468. get highlightsThreshold(): number;
  150469. set highlightsThreshold(value: number);
  150470. /**
  150471. * Sets the amount of blur at the edges
  150472. * @param amount blur amount
  150473. */
  150474. setEdgeBlur(amount: number): void;
  150475. /**
  150476. * Sets edge blur to 0
  150477. */
  150478. disableEdgeBlur(): void;
  150479. /**
  150480. * Sets the amout of grain
  150481. * @param amount Amount of grain
  150482. */
  150483. setGrainAmount(amount: number): void;
  150484. /**
  150485. * Set grain amount to 0
  150486. */
  150487. disableGrain(): void;
  150488. /**
  150489. * Sets the chromatic aberration amount
  150490. * @param amount amount of chromatic aberration
  150491. */
  150492. setChromaticAberration(amount: number): void;
  150493. /**
  150494. * Sets chromatic aberration amount to 0
  150495. */
  150496. disableChromaticAberration(): void;
  150497. /**
  150498. * Sets the EdgeDistortion amount
  150499. * @param amount amount of EdgeDistortion
  150500. */
  150501. setEdgeDistortion(amount: number): void;
  150502. /**
  150503. * Sets edge distortion to 0
  150504. */
  150505. disableEdgeDistortion(): void;
  150506. /**
  150507. * Sets the FocusDistance amount
  150508. * @param amount amount of FocusDistance
  150509. */
  150510. setFocusDistance(amount: number): void;
  150511. /**
  150512. * Disables depth of field
  150513. */
  150514. disableDepthOfField(): void;
  150515. /**
  150516. * Sets the Aperture amount
  150517. * @param amount amount of Aperture
  150518. */
  150519. setAperture(amount: number): void;
  150520. /**
  150521. * Sets the DarkenOutOfFocus amount
  150522. * @param amount amount of DarkenOutOfFocus
  150523. */
  150524. setDarkenOutOfFocus(amount: number): void;
  150525. private _pentagonBokehIsEnabled;
  150526. /**
  150527. * Creates a pentagon bokeh effect
  150528. */
  150529. enablePentagonBokeh(): void;
  150530. /**
  150531. * Disables the pentagon bokeh effect
  150532. */
  150533. disablePentagonBokeh(): void;
  150534. /**
  150535. * Enables noise blur
  150536. */
  150537. enableNoiseBlur(): void;
  150538. /**
  150539. * Disables noise blur
  150540. */
  150541. disableNoiseBlur(): void;
  150542. /**
  150543. * Sets the HighlightsGain amount
  150544. * @param amount amount of HighlightsGain
  150545. */
  150546. setHighlightsGain(amount: number): void;
  150547. /**
  150548. * Sets the HighlightsThreshold amount
  150549. * @param amount amount of HighlightsThreshold
  150550. */
  150551. setHighlightsThreshold(amount: number): void;
  150552. /**
  150553. * Disables highlights
  150554. */
  150555. disableHighlights(): void;
  150556. /**
  150557. * Removes the internal pipeline assets and detaches the pipeline from the scene cameras
  150558. * @param disableDepthRender If the scens depth rendering should be disabled (default: false)
  150559. */
  150560. dispose(disableDepthRender?: boolean): void;
  150561. private _createChromaticAberrationPostProcess;
  150562. private _createHighlightsPostProcess;
  150563. private _createDepthOfFieldPostProcess;
  150564. private _createGrainTexture;
  150565. }
  150566. }
  150567. declare module BABYLON {
  150568. /** @hidden */
  150569. export var ssao2PixelShader: {
  150570. name: string;
  150571. shader: string;
  150572. };
  150573. }
  150574. declare module BABYLON {
  150575. /** @hidden */
  150576. export var ssaoCombinePixelShader: {
  150577. name: string;
  150578. shader: string;
  150579. };
  150580. }
  150581. declare module BABYLON {
  150582. /**
  150583. * Render pipeline to produce ssao effect
  150584. */
  150585. export class SSAO2RenderingPipeline extends PostProcessRenderPipeline {
  150586. /**
  150587. * @ignore
  150588. * The PassPostProcess id in the pipeline that contains the original scene color
  150589. */
  150590. SSAOOriginalSceneColorEffect: string;
  150591. /**
  150592. * @ignore
  150593. * The SSAO PostProcess id in the pipeline
  150594. */
  150595. SSAORenderEffect: string;
  150596. /**
  150597. * @ignore
  150598. * The horizontal blur PostProcess id in the pipeline
  150599. */
  150600. SSAOBlurHRenderEffect: string;
  150601. /**
  150602. * @ignore
  150603. * The vertical blur PostProcess id in the pipeline
  150604. */
  150605. SSAOBlurVRenderEffect: string;
  150606. /**
  150607. * @ignore
  150608. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  150609. */
  150610. SSAOCombineRenderEffect: string;
  150611. /**
  150612. * The output strength of the SSAO post-process. Default value is 1.0.
  150613. */
  150614. totalStrength: number;
  150615. /**
  150616. * Maximum depth value to still render AO. A smooth falloff makes the dimming more natural, so there will be no abrupt shading change.
  150617. */
  150618. maxZ: number;
  150619. /**
  150620. * In order to save performances, SSAO radius is clamped on close geometry. This ratio changes by how much
  150621. */
  150622. minZAspect: number;
  150623. private _samples;
  150624. /**
  150625. * Number of samples used for the SSAO calculations. Default value is 8
  150626. */
  150627. set samples(n: number);
  150628. get samples(): number;
  150629. private _textureSamples;
  150630. /**
  150631. * Number of samples to use for antialiasing
  150632. */
  150633. set textureSamples(n: number);
  150634. get textureSamples(): number;
  150635. /**
  150636. * Force rendering the geometry through geometry buffer
  150637. */
  150638. private _forceGeometryBuffer;
  150639. /**
  150640. * Ratio object used for SSAO ratio and blur ratio
  150641. */
  150642. private _ratio;
  150643. /**
  150644. * Dynamically generated sphere sampler.
  150645. */
  150646. private _sampleSphere;
  150647. /**
  150648. * Blur filter offsets
  150649. */
  150650. private _samplerOffsets;
  150651. private _expensiveBlur;
  150652. /**
  150653. * If bilateral blur should be used
  150654. */
  150655. set expensiveBlur(b: boolean);
  150656. get expensiveBlur(): boolean;
  150657. /**
  150658. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 2.0
  150659. */
  150660. radius: number;
  150661. /**
  150662. * The base color of the SSAO post-process
  150663. * The final result is "base + ssao" between [0, 1]
  150664. */
  150665. base: number;
  150666. /**
  150667. * Support test.
  150668. */
  150669. static get IsSupported(): boolean;
  150670. private _scene;
  150671. private _randomTexture;
  150672. private _originalColorPostProcess;
  150673. private _ssaoPostProcess;
  150674. private _blurHPostProcess;
  150675. private _blurVPostProcess;
  150676. private _ssaoCombinePostProcess;
  150677. private _prePassRenderer;
  150678. /**
  150679. * Gets active scene
  150680. */
  150681. get scene(): Scene;
  150682. /**
  150683. * @constructor
  150684. * @param name The rendering pipeline name
  150685. * @param scene The scene linked to this pipeline
  150686. * @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 }
  150687. * @param cameras The array of cameras that the rendering pipeline will be attached to
  150688. * @param forceGeometryBuffer Set to true if you want to use the legacy geometry buffer renderer
  150689. */
  150690. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[], forceGeometryBuffer?: boolean);
  150691. /**
  150692. * Get the class name
  150693. * @returns "SSAO2RenderingPipeline"
  150694. */
  150695. getClassName(): string;
  150696. /**
  150697. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  150698. */
  150699. dispose(disableGeometryBufferRenderer?: boolean): void;
  150700. private _createBlurPostProcess;
  150701. /** @hidden */
  150702. _rebuild(): void;
  150703. private _bits;
  150704. private _radicalInverse_VdC;
  150705. private _hammersley;
  150706. private _hemisphereSample_uniform;
  150707. private _generateHemisphere;
  150708. private _getDefinesForSSAO;
  150709. private _createSSAOPostProcess;
  150710. private _createSSAOCombinePostProcess;
  150711. private _createRandomTexture;
  150712. /**
  150713. * Serialize the rendering pipeline (Used when exporting)
  150714. * @returns the serialized object
  150715. */
  150716. serialize(): any;
  150717. /**
  150718. * Parse the serialized pipeline
  150719. * @param source Source pipeline.
  150720. * @param scene The scene to load the pipeline to.
  150721. * @param rootUrl The URL of the serialized pipeline.
  150722. * @returns An instantiated pipeline from the serialized object.
  150723. */
  150724. static Parse(source: any, scene: Scene, rootUrl: string): SSAO2RenderingPipeline;
  150725. /**
  150726. * Sets the required values to the prepass renderer.
  150727. * @param prePassRenderer defines the prepass renderer to setup
  150728. * @returns true if the pre pass is needed.
  150729. */
  150730. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  150731. }
  150732. }
  150733. declare module BABYLON {
  150734. /** @hidden */
  150735. export var ssaoPixelShader: {
  150736. name: string;
  150737. shader: string;
  150738. };
  150739. }
  150740. declare module BABYLON {
  150741. /**
  150742. * Render pipeline to produce ssao effect
  150743. */
  150744. export class SSAORenderingPipeline extends PostProcessRenderPipeline {
  150745. /**
  150746. * @ignore
  150747. * The PassPostProcess id in the pipeline that contains the original scene color
  150748. */
  150749. SSAOOriginalSceneColorEffect: string;
  150750. /**
  150751. * @ignore
  150752. * The SSAO PostProcess id in the pipeline
  150753. */
  150754. SSAORenderEffect: string;
  150755. /**
  150756. * @ignore
  150757. * The horizontal blur PostProcess id in the pipeline
  150758. */
  150759. SSAOBlurHRenderEffect: string;
  150760. /**
  150761. * @ignore
  150762. * The vertical blur PostProcess id in the pipeline
  150763. */
  150764. SSAOBlurVRenderEffect: string;
  150765. /**
  150766. * @ignore
  150767. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  150768. */
  150769. SSAOCombineRenderEffect: string;
  150770. /**
  150771. * The output strength of the SSAO post-process. Default value is 1.0.
  150772. */
  150773. totalStrength: number;
  150774. /**
  150775. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 0.0006
  150776. */
  150777. radius: number;
  150778. /**
  150779. * Related to fallOff, used to interpolate SSAO samples (first interpolate function input) based on the occlusion difference of each pixel
  150780. * Must not be equal to fallOff and superior to fallOff.
  150781. * Default value is 0.0075
  150782. */
  150783. area: number;
  150784. /**
  150785. * Related to area, used to interpolate SSAO samples (second interpolate function input) based on the occlusion difference of each pixel
  150786. * Must not be equal to area and inferior to area.
  150787. * Default value is 0.000001
  150788. */
  150789. fallOff: number;
  150790. /**
  150791. * The base color of the SSAO post-process
  150792. * The final result is "base + ssao" between [0, 1]
  150793. */
  150794. base: number;
  150795. private _scene;
  150796. private _depthTexture;
  150797. private _randomTexture;
  150798. private _originalColorPostProcess;
  150799. private _ssaoPostProcess;
  150800. private _blurHPostProcess;
  150801. private _blurVPostProcess;
  150802. private _ssaoCombinePostProcess;
  150803. private _firstUpdate;
  150804. /**
  150805. * Gets active scene
  150806. */
  150807. get scene(): Scene;
  150808. /**
  150809. * @constructor
  150810. * @param name - The rendering pipeline name
  150811. * @param scene - The scene linked to this pipeline
  150812. * @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 }
  150813. * @param cameras - The array of cameras that the rendering pipeline will be attached to
  150814. */
  150815. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  150816. /**
  150817. * Get the class name
  150818. * @returns "SSAORenderingPipeline"
  150819. */
  150820. getClassName(): string;
  150821. /**
  150822. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  150823. */
  150824. dispose(disableDepthRender?: boolean): void;
  150825. private _createBlurPostProcess;
  150826. /** @hidden */
  150827. _rebuild(): void;
  150828. private _createSSAOPostProcess;
  150829. private _createSSAOCombinePostProcess;
  150830. private _createRandomTexture;
  150831. }
  150832. }
  150833. declare module BABYLON {
  150834. /** @hidden */
  150835. export var screenSpaceReflectionPixelShader: {
  150836. name: string;
  150837. shader: string;
  150838. };
  150839. }
  150840. declare module BABYLON {
  150841. /**
  150842. * The ScreenSpaceReflectionPostProcess performs realtime reflections using only and only the available informations on the screen (positions and normals).
  150843. * Basically, the screen space reflection post-process will compute reflections according the material's reflectivity.
  150844. */
  150845. export class ScreenSpaceReflectionPostProcess extends PostProcess {
  150846. /**
  150847. * Gets or sets a reflection threshold mainly used to adjust the reflection's height.
  150848. */
  150849. threshold: number;
  150850. /**
  150851. * Gets or sets the current reflection strength. 1.0 is an ideal value but can be increased/decreased for particular results.
  150852. */
  150853. strength: number;
  150854. /**
  150855. * Gets or sets the falloff exponent used while computing fresnel. More the exponent is high, more the reflections will be discrete.
  150856. */
  150857. reflectionSpecularFalloffExponent: number;
  150858. /**
  150859. * 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]
  150860. */
  150861. step: number;
  150862. /**
  150863. * Gets or sets the factor applied when computing roughness. Default value is 0.2.
  150864. */
  150865. roughnessFactor: number;
  150866. private _geometryBufferRenderer;
  150867. private _enableSmoothReflections;
  150868. private _reflectionSamples;
  150869. private _smoothSteps;
  150870. /**
  150871. * Gets a string identifying the name of the class
  150872. * @returns "ScreenSpaceReflectionPostProcess" string
  150873. */
  150874. getClassName(): string;
  150875. /**
  150876. * Creates a new instance of ScreenSpaceReflectionPostProcess.
  150877. * @param name The name of the effect.
  150878. * @param scene The scene containing the objects to calculate reflections.
  150879. * @param options The required width/height ratio to downsize to before computing the render pass.
  150880. * @param camera The camera to apply the render pass to.
  150881. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  150882. * @param engine The engine which the post process will be applied. (default: current engine)
  150883. * @param reusable If the post process can be reused on the same frame. (default: false)
  150884. * @param textureType Type of textures used when performing the post process. (default: 0)
  150885. * @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)
  150886. */
  150887. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  150888. /**
  150889. * Gets wether or not smoothing reflections is enabled.
  150890. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  150891. */
  150892. get enableSmoothReflections(): boolean;
  150893. /**
  150894. * Sets wether or not smoothing reflections is enabled.
  150895. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  150896. */
  150897. set enableSmoothReflections(enabled: boolean);
  150898. /**
  150899. * Gets the number of samples taken while computing reflections. More samples count is high,
  150900. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  150901. */
  150902. get reflectionSamples(): number;
  150903. /**
  150904. * Sets the number of samples taken while computing reflections. More samples count is high,
  150905. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  150906. */
  150907. set reflectionSamples(samples: number);
  150908. /**
  150909. * Gets the number of samples taken while smoothing reflections. More samples count is high,
  150910. * more the post-process will require GPU power and can generate a drop in FPS.
  150911. * Default value (5.0) work pretty well in all cases but can be adjusted.
  150912. */
  150913. get smoothSteps(): number;
  150914. set smoothSteps(steps: number);
  150915. private _updateEffectDefines;
  150916. /** @hidden */
  150917. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): ScreenSpaceReflectionPostProcess;
  150918. }
  150919. }
  150920. declare module BABYLON {
  150921. /** @hidden */
  150922. export var standardPixelShader: {
  150923. name: string;
  150924. shader: string;
  150925. };
  150926. }
  150927. declare module BABYLON {
  150928. /**
  150929. * Standard rendering pipeline
  150930. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  150931. * @see https://doc.babylonjs.com/how_to/using_standard_rendering_pipeline
  150932. */
  150933. export class StandardRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  150934. /**
  150935. * Public members
  150936. */
  150937. /**
  150938. * Post-process which contains the original scene color before the pipeline applies all the effects
  150939. */
  150940. originalPostProcess: Nullable<PostProcess>;
  150941. /**
  150942. * Post-process used to down scale an image x4
  150943. */
  150944. downSampleX4PostProcess: Nullable<PostProcess>;
  150945. /**
  150946. * Post-process used to calculate the illuminated surfaces controlled by a threshold
  150947. */
  150948. brightPassPostProcess: Nullable<PostProcess>;
  150949. /**
  150950. * Post-process array storing all the horizontal blur post-processes used by the pipeline
  150951. */
  150952. blurHPostProcesses: PostProcess[];
  150953. /**
  150954. * Post-process array storing all the vertical blur post-processes used by the pipeline
  150955. */
  150956. blurVPostProcesses: PostProcess[];
  150957. /**
  150958. * Post-process used to add colors of 2 textures (typically brightness + real scene color)
  150959. */
  150960. textureAdderPostProcess: Nullable<PostProcess>;
  150961. /**
  150962. * Post-process used to create volumetric lighting effect
  150963. */
  150964. volumetricLightPostProcess: Nullable<PostProcess>;
  150965. /**
  150966. * Post-process used to smooth the previous volumetric light post-process on the X axis
  150967. */
  150968. volumetricLightSmoothXPostProcess: Nullable<BlurPostProcess>;
  150969. /**
  150970. * Post-process used to smooth the previous volumetric light post-process on the Y axis
  150971. */
  150972. volumetricLightSmoothYPostProcess: Nullable<BlurPostProcess>;
  150973. /**
  150974. * Post-process used to merge the volumetric light effect and the real scene color
  150975. */
  150976. volumetricLightMergePostProces: Nullable<PostProcess>;
  150977. /**
  150978. * Post-process used to store the final volumetric light post-process (attach/detach for debug purpose)
  150979. */
  150980. volumetricLightFinalPostProcess: Nullable<PostProcess>;
  150981. /**
  150982. * Base post-process used to calculate the average luminance of the final image for HDR
  150983. */
  150984. luminancePostProcess: Nullable<PostProcess>;
  150985. /**
  150986. * Post-processes used to create down sample post-processes in order to get
  150987. * the average luminance of the final image for HDR
  150988. * Array of length "StandardRenderingPipeline.LuminanceSteps"
  150989. */
  150990. luminanceDownSamplePostProcesses: PostProcess[];
  150991. /**
  150992. * Post-process used to create a HDR effect (light adaptation)
  150993. */
  150994. hdrPostProcess: Nullable<PostProcess>;
  150995. /**
  150996. * Post-process used to store the final texture adder post-process (attach/detach for debug purpose)
  150997. */
  150998. textureAdderFinalPostProcess: Nullable<PostProcess>;
  150999. /**
  151000. * Post-process used to store the final lens flare post-process (attach/detach for debug purpose)
  151001. */
  151002. lensFlareFinalPostProcess: Nullable<PostProcess>;
  151003. /**
  151004. * Post-process used to merge the final HDR post-process and the real scene color
  151005. */
  151006. hdrFinalPostProcess: Nullable<PostProcess>;
  151007. /**
  151008. * Post-process used to create a lens flare effect
  151009. */
  151010. lensFlarePostProcess: Nullable<PostProcess>;
  151011. /**
  151012. * Post-process that merges the result of the lens flare post-process and the real scene color
  151013. */
  151014. lensFlareComposePostProcess: Nullable<PostProcess>;
  151015. /**
  151016. * Post-process used to create a motion blur effect
  151017. */
  151018. motionBlurPostProcess: Nullable<PostProcess>;
  151019. /**
  151020. * Post-process used to create a depth of field effect
  151021. */
  151022. depthOfFieldPostProcess: Nullable<PostProcess>;
  151023. /**
  151024. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  151025. */
  151026. fxaaPostProcess: Nullable<FxaaPostProcess>;
  151027. /**
  151028. * Post-process used to simulate realtime reflections using the screen space and geometry renderer.
  151029. */
  151030. screenSpaceReflectionPostProcess: Nullable<ScreenSpaceReflectionPostProcess>;
  151031. /**
  151032. * Represents the brightness threshold in order to configure the illuminated surfaces
  151033. */
  151034. brightThreshold: number;
  151035. /**
  151036. * Configures the blur intensity used for surexposed surfaces are highlighted surfaces (light halo)
  151037. */
  151038. blurWidth: number;
  151039. /**
  151040. * Sets if the blur for highlighted surfaces must be only horizontal
  151041. */
  151042. horizontalBlur: boolean;
  151043. /**
  151044. * Gets the overall exposure used by the pipeline
  151045. */
  151046. get exposure(): number;
  151047. /**
  151048. * Sets the overall exposure used by the pipeline
  151049. */
  151050. set exposure(value: number);
  151051. /**
  151052. * Texture used typically to simulate "dirty" on camera lens
  151053. */
  151054. lensTexture: Nullable<Texture>;
  151055. /**
  151056. * Represents the offset coefficient based on Rayleigh principle. Typically in interval [-0.2, 0.2]
  151057. */
  151058. volumetricLightCoefficient: number;
  151059. /**
  151060. * The overall power of volumetric lights, typically in interval [0, 10] maximum
  151061. */
  151062. volumetricLightPower: number;
  151063. /**
  151064. * Used the set the blur intensity to smooth the volumetric lights
  151065. */
  151066. volumetricLightBlurScale: number;
  151067. /**
  151068. * Light (spot or directional) used to generate the volumetric lights rays
  151069. * The source light must have a shadow generate so the pipeline can get its
  151070. * depth map
  151071. */
  151072. sourceLight: Nullable<SpotLight | DirectionalLight>;
  151073. /**
  151074. * For eye adaptation, represents the minimum luminance the eye can see
  151075. */
  151076. hdrMinimumLuminance: number;
  151077. /**
  151078. * For eye adaptation, represents the decrease luminance speed
  151079. */
  151080. hdrDecreaseRate: number;
  151081. /**
  151082. * For eye adaptation, represents the increase luminance speed
  151083. */
  151084. hdrIncreaseRate: number;
  151085. /**
  151086. * Gets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  151087. */
  151088. get hdrAutoExposure(): boolean;
  151089. /**
  151090. * Sets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  151091. */
  151092. set hdrAutoExposure(value: boolean);
  151093. /**
  151094. * Lens color texture used by the lens flare effect. Mandatory if lens flare effect enabled
  151095. */
  151096. lensColorTexture: Nullable<Texture>;
  151097. /**
  151098. * The overall strengh for the lens flare effect
  151099. */
  151100. lensFlareStrength: number;
  151101. /**
  151102. * Dispersion coefficient for lens flare ghosts
  151103. */
  151104. lensFlareGhostDispersal: number;
  151105. /**
  151106. * Main lens flare halo width
  151107. */
  151108. lensFlareHaloWidth: number;
  151109. /**
  151110. * Based on the lens distortion effect, defines how much the lens flare result
  151111. * is distorted
  151112. */
  151113. lensFlareDistortionStrength: number;
  151114. /**
  151115. * Configures the blur intensity used for for lens flare (halo)
  151116. */
  151117. lensFlareBlurWidth: number;
  151118. /**
  151119. * Lens star texture must be used to simulate rays on the flares and is available
  151120. * in the documentation
  151121. */
  151122. lensStarTexture: Nullable<Texture>;
  151123. /**
  151124. * As the "lensTexture" (can be the same texture or different), it is used to apply the lens
  151125. * flare effect by taking account of the dirt texture
  151126. */
  151127. lensFlareDirtTexture: Nullable<Texture>;
  151128. /**
  151129. * Represents the focal length for the depth of field effect
  151130. */
  151131. depthOfFieldDistance: number;
  151132. /**
  151133. * Represents the blur intensity for the blurred part of the depth of field effect
  151134. */
  151135. depthOfFieldBlurWidth: number;
  151136. /**
  151137. * Gets how much the image is blurred by the movement while using the motion blur post-process
  151138. */
  151139. get motionStrength(): number;
  151140. /**
  151141. * Sets how much the image is blurred by the movement while using the motion blur post-process
  151142. */
  151143. set motionStrength(strength: number);
  151144. /**
  151145. * Gets wether or not the motion blur post-process is object based or screen based.
  151146. */
  151147. get objectBasedMotionBlur(): boolean;
  151148. /**
  151149. * Sets wether or not the motion blur post-process should be object based or screen based
  151150. */
  151151. set objectBasedMotionBlur(value: boolean);
  151152. /**
  151153. * List of animations for the pipeline (IAnimatable implementation)
  151154. */
  151155. animations: Animation[];
  151156. /**
  151157. * Private members
  151158. */
  151159. private _scene;
  151160. private _currentDepthOfFieldSource;
  151161. private _basePostProcess;
  151162. private _fixedExposure;
  151163. private _currentExposure;
  151164. private _hdrAutoExposure;
  151165. private _hdrCurrentLuminance;
  151166. private _motionStrength;
  151167. private _isObjectBasedMotionBlur;
  151168. private _floatTextureType;
  151169. private _camerasToBeAttached;
  151170. private _ratio;
  151171. private _bloomEnabled;
  151172. private _depthOfFieldEnabled;
  151173. private _vlsEnabled;
  151174. private _lensFlareEnabled;
  151175. private _hdrEnabled;
  151176. private _motionBlurEnabled;
  151177. private _fxaaEnabled;
  151178. private _screenSpaceReflectionsEnabled;
  151179. private _motionBlurSamples;
  151180. private _volumetricLightStepsCount;
  151181. private _samples;
  151182. /**
  151183. * @ignore
  151184. * Specifies if the bloom pipeline is enabled
  151185. */
  151186. get BloomEnabled(): boolean;
  151187. set BloomEnabled(enabled: boolean);
  151188. /**
  151189. * @ignore
  151190. * Specifies if the depth of field pipeline is enabed
  151191. */
  151192. get DepthOfFieldEnabled(): boolean;
  151193. set DepthOfFieldEnabled(enabled: boolean);
  151194. /**
  151195. * @ignore
  151196. * Specifies if the lens flare pipeline is enabed
  151197. */
  151198. get LensFlareEnabled(): boolean;
  151199. set LensFlareEnabled(enabled: boolean);
  151200. /**
  151201. * @ignore
  151202. * Specifies if the HDR pipeline is enabled
  151203. */
  151204. get HDREnabled(): boolean;
  151205. set HDREnabled(enabled: boolean);
  151206. /**
  151207. * @ignore
  151208. * Specifies if the volumetric lights scattering effect is enabled
  151209. */
  151210. get VLSEnabled(): boolean;
  151211. set VLSEnabled(enabled: boolean);
  151212. /**
  151213. * @ignore
  151214. * Specifies if the motion blur effect is enabled
  151215. */
  151216. get MotionBlurEnabled(): boolean;
  151217. set MotionBlurEnabled(enabled: boolean);
  151218. /**
  151219. * Specifies if anti-aliasing is enabled
  151220. */
  151221. get fxaaEnabled(): boolean;
  151222. set fxaaEnabled(enabled: boolean);
  151223. /**
  151224. * Specifies if screen space reflections are enabled.
  151225. */
  151226. get screenSpaceReflectionsEnabled(): boolean;
  151227. set screenSpaceReflectionsEnabled(enabled: boolean);
  151228. /**
  151229. * Specifies the number of steps used to calculate the volumetric lights
  151230. * Typically in interval [50, 200]
  151231. */
  151232. get volumetricLightStepsCount(): number;
  151233. set volumetricLightStepsCount(count: number);
  151234. /**
  151235. * Specifies the number of samples used for the motion blur effect
  151236. * Typically in interval [16, 64]
  151237. */
  151238. get motionBlurSamples(): number;
  151239. set motionBlurSamples(samples: number);
  151240. /**
  151241. * Specifies MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  151242. */
  151243. get samples(): number;
  151244. set samples(sampleCount: number);
  151245. /**
  151246. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  151247. * @constructor
  151248. * @param name The rendering pipeline name
  151249. * @param scene The scene linked to this pipeline
  151250. * @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)
  151251. * @param originalPostProcess the custom original color post-process. Must be "reusable". Can be null.
  151252. * @param cameras The array of cameras that the rendering pipeline will be attached to
  151253. */
  151254. constructor(name: string, scene: Scene, ratio: number, originalPostProcess?: Nullable<PostProcess>, cameras?: Camera[]);
  151255. private _buildPipeline;
  151256. private _createDownSampleX4PostProcess;
  151257. private _createBrightPassPostProcess;
  151258. private _createBlurPostProcesses;
  151259. private _createTextureAdderPostProcess;
  151260. private _createVolumetricLightPostProcess;
  151261. private _createLuminancePostProcesses;
  151262. private _createHdrPostProcess;
  151263. private _createLensFlarePostProcess;
  151264. private _createDepthOfFieldPostProcess;
  151265. private _createMotionBlurPostProcess;
  151266. private _getDepthTexture;
  151267. private _disposePostProcesses;
  151268. /**
  151269. * Dispose of the pipeline and stop all post processes
  151270. */
  151271. dispose(): void;
  151272. /**
  151273. * Serialize the rendering pipeline (Used when exporting)
  151274. * @returns the serialized object
  151275. */
  151276. serialize(): any;
  151277. /**
  151278. * Parse the serialized pipeline
  151279. * @param source Source pipeline.
  151280. * @param scene The scene to load the pipeline to.
  151281. * @param rootUrl The URL of the serialized pipeline.
  151282. * @returns An instantiated pipeline from the serialized object.
  151283. */
  151284. static Parse(source: any, scene: Scene, rootUrl: string): StandardRenderingPipeline;
  151285. /**
  151286. * Luminance steps
  151287. */
  151288. static LuminanceSteps: number;
  151289. }
  151290. }
  151291. declare module BABYLON {
  151292. /** @hidden */
  151293. export var stereoscopicInterlacePixelShader: {
  151294. name: string;
  151295. shader: string;
  151296. };
  151297. }
  151298. declare module BABYLON {
  151299. /**
  151300. * StereoscopicInterlacePostProcessI used to render stereo views from a rigged camera with support for alternate line interlacing
  151301. */
  151302. export class StereoscopicInterlacePostProcessI extends PostProcess {
  151303. private _stepSize;
  151304. private _passedProcess;
  151305. /**
  151306. * Gets a string identifying the name of the class
  151307. * @returns "StereoscopicInterlacePostProcessI" string
  151308. */
  151309. getClassName(): string;
  151310. /**
  151311. * Initializes a StereoscopicInterlacePostProcessI
  151312. * @param name The name of the effect.
  151313. * @param rigCameras The rig cameras to be appled to the post process
  151314. * @param isStereoscopicHoriz If the rendered results are horizontal or vertical
  151315. * @param isStereoscopicInterlaced If the rendered results are alternate line interlaced
  151316. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  151317. * @param engine The engine which the post process will be applied. (default: current engine)
  151318. * @param reusable If the post process can be reused on the same frame. (default: false)
  151319. */
  151320. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, isStereoscopicInterlaced: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  151321. }
  151322. /**
  151323. * StereoscopicInterlacePostProcess used to render stereo views from a rigged camera
  151324. */
  151325. export class StereoscopicInterlacePostProcess extends PostProcess {
  151326. private _stepSize;
  151327. private _passedProcess;
  151328. /**
  151329. * Gets a string identifying the name of the class
  151330. * @returns "StereoscopicInterlacePostProcess" string
  151331. */
  151332. getClassName(): string;
  151333. /**
  151334. * Initializes a StereoscopicInterlacePostProcess
  151335. * @param name The name of the effect.
  151336. * @param rigCameras The rig cameras to be appled to the post process
  151337. * @param isStereoscopicHoriz If the rendered results are horizontal or verticle
  151338. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  151339. * @param engine The engine which the post process will be applied. (default: current engine)
  151340. * @param reusable If the post process can be reused on the same frame. (default: false)
  151341. */
  151342. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  151343. }
  151344. }
  151345. declare module BABYLON {
  151346. /** @hidden */
  151347. export var tonemapPixelShader: {
  151348. name: string;
  151349. shader: string;
  151350. };
  151351. }
  151352. declare module BABYLON {
  151353. /** Defines operator used for tonemapping */
  151354. export enum TonemappingOperator {
  151355. /** Hable */
  151356. Hable = 0,
  151357. /** Reinhard */
  151358. Reinhard = 1,
  151359. /** HejiDawson */
  151360. HejiDawson = 2,
  151361. /** Photographic */
  151362. Photographic = 3
  151363. }
  151364. /**
  151365. * Defines a post process to apply tone mapping
  151366. */
  151367. export class TonemapPostProcess extends PostProcess {
  151368. private _operator;
  151369. /** Defines the required exposure adjustement */
  151370. exposureAdjustment: number;
  151371. /**
  151372. * Gets a string identifying the name of the class
  151373. * @returns "TonemapPostProcess" string
  151374. */
  151375. getClassName(): string;
  151376. /**
  151377. * Creates a new TonemapPostProcess
  151378. * @param name defines the name of the postprocess
  151379. * @param _operator defines the operator to use
  151380. * @param exposureAdjustment defines the required exposure adjustement
  151381. * @param camera defines the camera to use (can be null)
  151382. * @param samplingMode defines the required sampling mode (BABYLON.Texture.BILINEAR_SAMPLINGMODE by default)
  151383. * @param engine defines the hosting engine (can be ignore if camera is set)
  151384. * @param textureFormat defines the texture format to use (BABYLON.Engine.TEXTURETYPE_UNSIGNED_INT by default)
  151385. */
  151386. constructor(name: string, _operator: TonemappingOperator,
  151387. /** Defines the required exposure adjustement */
  151388. exposureAdjustment: number, camera: Camera, samplingMode?: number, engine?: Engine, textureFormat?: number);
  151389. }
  151390. }
  151391. declare module BABYLON {
  151392. /** @hidden */
  151393. export var volumetricLightScatteringPixelShader: {
  151394. name: string;
  151395. shader: string;
  151396. };
  151397. }
  151398. declare module BABYLON {
  151399. /** @hidden */
  151400. export var volumetricLightScatteringPassVertexShader: {
  151401. name: string;
  151402. shader: string;
  151403. };
  151404. }
  151405. declare module BABYLON {
  151406. /** @hidden */
  151407. export var volumetricLightScatteringPassPixelShader: {
  151408. name: string;
  151409. shader: string;
  151410. };
  151411. }
  151412. declare module BABYLON {
  151413. /**
  151414. * Inspired by http://http.developer.nvidia.com/GPUGems3/gpugems3_ch13.html
  151415. */
  151416. export class VolumetricLightScatteringPostProcess extends PostProcess {
  151417. private _volumetricLightScatteringPass;
  151418. private _volumetricLightScatteringRTT;
  151419. private _viewPort;
  151420. private _screenCoordinates;
  151421. private _cachedDefines;
  151422. /**
  151423. * If not undefined, the mesh position is computed from the attached node position
  151424. */
  151425. attachedNode: {
  151426. position: Vector3;
  151427. };
  151428. /**
  151429. * Custom position of the mesh. Used if "useCustomMeshPosition" is set to "true"
  151430. */
  151431. customMeshPosition: Vector3;
  151432. /**
  151433. * Set if the post-process should use a custom position for the light source (true) or the internal mesh position (false)
  151434. */
  151435. useCustomMeshPosition: boolean;
  151436. /**
  151437. * If the post-process should inverse the light scattering direction
  151438. */
  151439. invert: boolean;
  151440. /**
  151441. * The internal mesh used by the post-process
  151442. */
  151443. mesh: Mesh;
  151444. /**
  151445. * @hidden
  151446. * VolumetricLightScatteringPostProcess.useDiffuseColor is no longer used, use the mesh material directly instead
  151447. */
  151448. get useDiffuseColor(): boolean;
  151449. set useDiffuseColor(useDiffuseColor: boolean);
  151450. /**
  151451. * Array containing the excluded meshes not rendered in the internal pass
  151452. */
  151453. excludedMeshes: AbstractMesh[];
  151454. /**
  151455. * Controls the overall intensity of the post-process
  151456. */
  151457. exposure: number;
  151458. /**
  151459. * Dissipates each sample's contribution in range [0, 1]
  151460. */
  151461. decay: number;
  151462. /**
  151463. * Controls the overall intensity of each sample
  151464. */
  151465. weight: number;
  151466. /**
  151467. * Controls the density of each sample
  151468. */
  151469. density: number;
  151470. /**
  151471. * @constructor
  151472. * @param name The post-process name
  151473. * @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)
  151474. * @param camera The camera that the post-process will be attached to
  151475. * @param mesh The mesh used to create the light scattering
  151476. * @param samples The post-process quality, default 100
  151477. * @param samplingModeThe post-process filtering mode
  151478. * @param engine The babylon engine
  151479. * @param reusable If the post-process is reusable
  151480. * @param scene The constructor needs a scene reference to initialize internal components. If "camera" is null a "scene" must be provided
  151481. */
  151482. constructor(name: string, ratio: any, camera: Camera, mesh?: Mesh, samples?: number, samplingMode?: number, engine?: Engine, reusable?: boolean, scene?: Scene);
  151483. /**
  151484. * Returns the string "VolumetricLightScatteringPostProcess"
  151485. * @returns "VolumetricLightScatteringPostProcess"
  151486. */
  151487. getClassName(): string;
  151488. private _isReady;
  151489. /**
  151490. * Sets the new light position for light scattering effect
  151491. * @param position The new custom light position
  151492. */
  151493. setCustomMeshPosition(position: Vector3): void;
  151494. /**
  151495. * Returns the light position for light scattering effect
  151496. * @return Vector3 The custom light position
  151497. */
  151498. getCustomMeshPosition(): Vector3;
  151499. /**
  151500. * Disposes the internal assets and detaches the post-process from the camera
  151501. */
  151502. dispose(camera: Camera): void;
  151503. /**
  151504. * Returns the render target texture used by the post-process
  151505. * @return the render target texture used by the post-process
  151506. */
  151507. getPass(): RenderTargetTexture;
  151508. private _meshExcluded;
  151509. private _createPass;
  151510. private _updateMeshScreenCoordinates;
  151511. /**
  151512. * Creates a default mesh for the Volumeric Light Scattering post-process
  151513. * @param name The mesh name
  151514. * @param scene The scene where to create the mesh
  151515. * @return the default mesh
  151516. */
  151517. static CreateDefaultMesh(name: string, scene: Scene): Mesh;
  151518. }
  151519. }
  151520. declare module BABYLON {
  151521. /** @hidden */
  151522. export var screenSpaceCurvaturePixelShader: {
  151523. name: string;
  151524. shader: string;
  151525. };
  151526. }
  151527. declare module BABYLON {
  151528. /**
  151529. * The Screen Space curvature effect can help highlighting ridge and valley of a model.
  151530. */
  151531. export class ScreenSpaceCurvaturePostProcess extends PostProcess {
  151532. /**
  151533. * Defines how much ridge the curvature effect displays.
  151534. */
  151535. ridge: number;
  151536. /**
  151537. * Defines how much valley the curvature effect displays.
  151538. */
  151539. valley: number;
  151540. private _geometryBufferRenderer;
  151541. /**
  151542. * Gets a string identifying the name of the class
  151543. * @returns "ScreenSpaceCurvaturePostProcess" string
  151544. */
  151545. getClassName(): string;
  151546. /**
  151547. * Creates a new instance ScreenSpaceCurvaturePostProcess
  151548. * @param name The name of the effect.
  151549. * @param scene The scene containing the objects to blur according to their velocity.
  151550. * @param options The required width/height ratio to downsize to before computing the render pass.
  151551. * @param camera The camera to apply the render pass to.
  151552. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  151553. * @param engine The engine which the post process will be applied. (default: current engine)
  151554. * @param reusable If the post process can be reused on the same frame. (default: false)
  151555. * @param textureType Type of textures used when performing the post process. (default: 0)
  151556. * @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)
  151557. */
  151558. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  151559. /**
  151560. * Support test.
  151561. */
  151562. static get IsSupported(): boolean;
  151563. /** @hidden */
  151564. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): ScreenSpaceCurvaturePostProcess;
  151565. }
  151566. }
  151567. declare module BABYLON {
  151568. interface Scene {
  151569. /** @hidden (Backing field) */
  151570. _boundingBoxRenderer: BoundingBoxRenderer;
  151571. /** @hidden (Backing field) */
  151572. _forceShowBoundingBoxes: boolean;
  151573. /**
  151574. * Gets or sets a boolean indicating if all bounding boxes must be rendered
  151575. */
  151576. forceShowBoundingBoxes: boolean;
  151577. /**
  151578. * Gets the bounding box renderer associated with the scene
  151579. * @returns a BoundingBoxRenderer
  151580. */
  151581. getBoundingBoxRenderer(): BoundingBoxRenderer;
  151582. }
  151583. interface AbstractMesh {
  151584. /** @hidden (Backing field) */
  151585. _showBoundingBox: boolean;
  151586. /**
  151587. * Gets or sets a boolean indicating if the bounding box must be rendered as well (false by default)
  151588. */
  151589. showBoundingBox: boolean;
  151590. }
  151591. /**
  151592. * Component responsible of rendering the bounding box of the meshes in a scene.
  151593. * This is usually used through the mesh.showBoundingBox or the scene.forceShowBoundingBoxes properties
  151594. */
  151595. export class BoundingBoxRenderer implements ISceneComponent {
  151596. /**
  151597. * The component name helpfull to identify the component in the list of scene components.
  151598. */
  151599. readonly name: string;
  151600. /**
  151601. * The scene the component belongs to.
  151602. */
  151603. scene: Scene;
  151604. /**
  151605. * Color of the bounding box lines placed in front of an object
  151606. */
  151607. frontColor: Color3;
  151608. /**
  151609. * Color of the bounding box lines placed behind an object
  151610. */
  151611. backColor: Color3;
  151612. /**
  151613. * Defines if the renderer should show the back lines or not
  151614. */
  151615. showBackLines: boolean;
  151616. /**
  151617. * Observable raised before rendering a bounding box
  151618. */
  151619. onBeforeBoxRenderingObservable: Observable<BoundingBox>;
  151620. /**
  151621. * Observable raised after rendering a bounding box
  151622. */
  151623. onAfterBoxRenderingObservable: Observable<BoundingBox>;
  151624. /**
  151625. * @hidden
  151626. */
  151627. renderList: SmartArray<BoundingBox>;
  151628. private _colorShader;
  151629. private _vertexBuffers;
  151630. private _indexBuffer;
  151631. private _fillIndexBuffer;
  151632. private _fillIndexData;
  151633. /**
  151634. * Instantiates a new bounding box renderer in a scene.
  151635. * @param scene the scene the renderer renders in
  151636. */
  151637. constructor(scene: Scene);
  151638. /**
  151639. * Registers the component in a given scene
  151640. */
  151641. register(): void;
  151642. private _evaluateSubMesh;
  151643. private _activeMesh;
  151644. private _prepareRessources;
  151645. private _createIndexBuffer;
  151646. /**
  151647. * Rebuilds the elements related to this component in case of
  151648. * context lost for instance.
  151649. */
  151650. rebuild(): void;
  151651. /**
  151652. * @hidden
  151653. */
  151654. reset(): void;
  151655. /**
  151656. * Render the bounding boxes of a specific rendering group
  151657. * @param renderingGroupId defines the rendering group to render
  151658. */
  151659. render(renderingGroupId: number): void;
  151660. /**
  151661. * In case of occlusion queries, we can render the occlusion bounding box through this method
  151662. * @param mesh Define the mesh to render the occlusion bounding box for
  151663. */
  151664. renderOcclusionBoundingBox(mesh: AbstractMesh): void;
  151665. /**
  151666. * Dispose and release the resources attached to this renderer.
  151667. */
  151668. dispose(): void;
  151669. }
  151670. }
  151671. declare module BABYLON {
  151672. interface Scene {
  151673. /** @hidden (Backing field) */
  151674. _depthRenderer: {
  151675. [id: string]: DepthRenderer;
  151676. };
  151677. /**
  151678. * Creates a depth renderer a given camera which contains a depth map which can be used for post processing.
  151679. * @param camera The camera to create the depth renderer on (default: scene's active camera)
  151680. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  151681. * @returns the created depth renderer
  151682. */
  151683. enableDepthRenderer(camera?: Nullable<Camera>, storeNonLinearDepth?: boolean): DepthRenderer;
  151684. /**
  151685. * Disables a depth renderer for a given camera
  151686. * @param camera The camera to disable the depth renderer on (default: scene's active camera)
  151687. */
  151688. disableDepthRenderer(camera?: Nullable<Camera>): void;
  151689. }
  151690. /**
  151691. * Defines the Depth Renderer scene component responsible to manage a depth buffer useful
  151692. * in several rendering techniques.
  151693. */
  151694. export class DepthRendererSceneComponent implements ISceneComponent {
  151695. /**
  151696. * The component name helpfull to identify the component in the list of scene components.
  151697. */
  151698. readonly name: string;
  151699. /**
  151700. * The scene the component belongs to.
  151701. */
  151702. scene: Scene;
  151703. /**
  151704. * Creates a new instance of the component for the given scene
  151705. * @param scene Defines the scene to register the component in
  151706. */
  151707. constructor(scene: Scene);
  151708. /**
  151709. * Registers the component in a given scene
  151710. */
  151711. register(): void;
  151712. /**
  151713. * Rebuilds the elements related to this component in case of
  151714. * context lost for instance.
  151715. */
  151716. rebuild(): void;
  151717. /**
  151718. * Disposes the component and the associated ressources
  151719. */
  151720. dispose(): void;
  151721. private _gatherRenderTargets;
  151722. private _gatherActiveCameraRenderTargets;
  151723. }
  151724. }
  151725. declare module BABYLON {
  151726. interface AbstractScene {
  151727. /** @hidden (Backing field) */
  151728. _prePassRenderer: Nullable<PrePassRenderer>;
  151729. /**
  151730. * Gets or Sets the current prepass renderer associated to the scene.
  151731. */
  151732. prePassRenderer: Nullable<PrePassRenderer>;
  151733. /**
  151734. * Enables the prepass and associates it with the scene
  151735. * @returns the PrePassRenderer
  151736. */
  151737. enablePrePassRenderer(): Nullable<PrePassRenderer>;
  151738. /**
  151739. * Disables the prepass associated with the scene
  151740. */
  151741. disablePrePassRenderer(): void;
  151742. }
  151743. /**
  151744. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  151745. * in several rendering techniques.
  151746. */
  151747. export class PrePassRendererSceneComponent implements ISceneSerializableComponent {
  151748. /**
  151749. * The component name helpful to identify the component in the list of scene components.
  151750. */
  151751. readonly name: string;
  151752. /**
  151753. * The scene the component belongs to.
  151754. */
  151755. scene: Scene;
  151756. /**
  151757. * Creates a new instance of the component for the given scene
  151758. * @param scene Defines the scene to register the component in
  151759. */
  151760. constructor(scene: Scene);
  151761. /**
  151762. * Registers the component in a given scene
  151763. */
  151764. register(): void;
  151765. private _beforeCameraDraw;
  151766. private _afterCameraDraw;
  151767. private _beforeClearStage;
  151768. /**
  151769. * Serializes the component data to the specified json object
  151770. * @param serializationObject The object to serialize to
  151771. */
  151772. serialize(serializationObject: any): void;
  151773. /**
  151774. * Adds all the elements from the container to the scene
  151775. * @param container the container holding the elements
  151776. */
  151777. addFromContainer(container: AbstractScene): void;
  151778. /**
  151779. * Removes all the elements in the container from the scene
  151780. * @param container contains the elements to remove
  151781. * @param dispose if the removed element should be disposed (default: false)
  151782. */
  151783. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  151784. /**
  151785. * Rebuilds the elements related to this component in case of
  151786. * context lost for instance.
  151787. */
  151788. rebuild(): void;
  151789. /**
  151790. * Disposes the component and the associated ressources
  151791. */
  151792. dispose(): void;
  151793. }
  151794. }
  151795. declare module BABYLON {
  151796. /** @hidden */
  151797. export var outlinePixelShader: {
  151798. name: string;
  151799. shader: string;
  151800. };
  151801. }
  151802. declare module BABYLON {
  151803. /** @hidden */
  151804. export var outlineVertexShader: {
  151805. name: string;
  151806. shader: string;
  151807. };
  151808. }
  151809. declare module BABYLON {
  151810. interface Scene {
  151811. /** @hidden */
  151812. _outlineRenderer: OutlineRenderer;
  151813. /**
  151814. * Gets the outline renderer associated with the scene
  151815. * @returns a OutlineRenderer
  151816. */
  151817. getOutlineRenderer(): OutlineRenderer;
  151818. }
  151819. interface AbstractMesh {
  151820. /** @hidden (Backing field) */
  151821. _renderOutline: boolean;
  151822. /**
  151823. * Gets or sets a boolean indicating if the outline must be rendered as well
  151824. * @see https://www.babylonjs-playground.com/#10WJ5S#3
  151825. */
  151826. renderOutline: boolean;
  151827. /** @hidden (Backing field) */
  151828. _renderOverlay: boolean;
  151829. /**
  151830. * Gets or sets a boolean indicating if the overlay must be rendered as well
  151831. * @see https://www.babylonjs-playground.com/#10WJ5S#2
  151832. */
  151833. renderOverlay: boolean;
  151834. }
  151835. /**
  151836. * This class is responsible to draw bothe outline/overlay of meshes.
  151837. * It should not be used directly but through the available method on mesh.
  151838. */
  151839. export class OutlineRenderer implements ISceneComponent {
  151840. /**
  151841. * Stencil value used to avoid outline being seen within the mesh when the mesh is transparent
  151842. */
  151843. private static _StencilReference;
  151844. /**
  151845. * The name of the component. Each component must have a unique name.
  151846. */
  151847. name: string;
  151848. /**
  151849. * The scene the component belongs to.
  151850. */
  151851. scene: Scene;
  151852. /**
  151853. * Defines a zOffset to prevent zFighting between the overlay and the mesh.
  151854. */
  151855. zOffset: number;
  151856. private _engine;
  151857. private _effect;
  151858. private _cachedDefines;
  151859. private _savedDepthWrite;
  151860. /**
  151861. * Instantiates a new outline renderer. (There could be only one per scene).
  151862. * @param scene Defines the scene it belongs to
  151863. */
  151864. constructor(scene: Scene);
  151865. /**
  151866. * Register the component to one instance of a scene.
  151867. */
  151868. register(): void;
  151869. /**
  151870. * Rebuilds the elements related to this component in case of
  151871. * context lost for instance.
  151872. */
  151873. rebuild(): void;
  151874. /**
  151875. * Disposes the component and the associated ressources.
  151876. */
  151877. dispose(): void;
  151878. /**
  151879. * Renders the outline in the canvas.
  151880. * @param subMesh Defines the sumesh to render
  151881. * @param batch Defines the batch of meshes in case of instances
  151882. * @param useOverlay Defines if the rendering is for the overlay or the outline
  151883. */
  151884. render(subMesh: SubMesh, batch: _InstancesBatch, useOverlay?: boolean): void;
  151885. /**
  151886. * Returns whether or not the outline renderer is ready for a given submesh.
  151887. * All the dependencies e.g. submeshes, texture, effect... mus be ready
  151888. * @param subMesh Defines the submesh to check readyness for
  151889. * @param useInstances Defines wheter wee are trying to render instances or not
  151890. * @returns true if ready otherwise false
  151891. */
  151892. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  151893. private _beforeRenderingMesh;
  151894. private _afterRenderingMesh;
  151895. }
  151896. }
  151897. declare module BABYLON {
  151898. /**
  151899. * Defines the basic options interface of a Sprite Frame Source Size.
  151900. */
  151901. export interface ISpriteJSONSpriteSourceSize {
  151902. /**
  151903. * number of the original width of the Frame
  151904. */
  151905. w: number;
  151906. /**
  151907. * number of the original height of the Frame
  151908. */
  151909. h: number;
  151910. }
  151911. /**
  151912. * Defines the basic options interface of a Sprite Frame Data.
  151913. */
  151914. export interface ISpriteJSONSpriteFrameData {
  151915. /**
  151916. * number of the x offset of the Frame
  151917. */
  151918. x: number;
  151919. /**
  151920. * number of the y offset of the Frame
  151921. */
  151922. y: number;
  151923. /**
  151924. * number of the width of the Frame
  151925. */
  151926. w: number;
  151927. /**
  151928. * number of the height of the Frame
  151929. */
  151930. h: number;
  151931. }
  151932. /**
  151933. * Defines the basic options interface of a JSON Sprite.
  151934. */
  151935. export interface ISpriteJSONSprite {
  151936. /**
  151937. * string name of the Frame
  151938. */
  151939. filename: string;
  151940. /**
  151941. * ISpriteJSONSpriteFrame basic object of the frame data
  151942. */
  151943. frame: ISpriteJSONSpriteFrameData;
  151944. /**
  151945. * boolean to flag is the frame was rotated.
  151946. */
  151947. rotated: boolean;
  151948. /**
  151949. * boolean to flag is the frame was trimmed.
  151950. */
  151951. trimmed: boolean;
  151952. /**
  151953. * ISpriteJSONSpriteFrame basic object of the source data
  151954. */
  151955. spriteSourceSize: ISpriteJSONSpriteFrameData;
  151956. /**
  151957. * ISpriteJSONSpriteFrame basic object of the source data
  151958. */
  151959. sourceSize: ISpriteJSONSpriteSourceSize;
  151960. }
  151961. /**
  151962. * Defines the basic options interface of a JSON atlas.
  151963. */
  151964. export interface ISpriteJSONAtlas {
  151965. /**
  151966. * Array of objects that contain the frame data.
  151967. */
  151968. frames: Array<ISpriteJSONSprite>;
  151969. /**
  151970. * object basic object containing the sprite meta data.
  151971. */
  151972. meta?: object;
  151973. }
  151974. }
  151975. declare module BABYLON {
  151976. /** @hidden */
  151977. export var spriteMapPixelShader: {
  151978. name: string;
  151979. shader: string;
  151980. };
  151981. }
  151982. declare module BABYLON {
  151983. /** @hidden */
  151984. export var spriteMapVertexShader: {
  151985. name: string;
  151986. shader: string;
  151987. };
  151988. }
  151989. declare module BABYLON {
  151990. /**
  151991. * Defines the basic options interface of a SpriteMap
  151992. */
  151993. export interface ISpriteMapOptions {
  151994. /**
  151995. * Vector2 of the number of cells in the grid.
  151996. */
  151997. stageSize?: Vector2;
  151998. /**
  151999. * Vector2 of the size of the output plane in World Units.
  152000. */
  152001. outputSize?: Vector2;
  152002. /**
  152003. * Vector3 of the position of the output plane in World Units.
  152004. */
  152005. outputPosition?: Vector3;
  152006. /**
  152007. * Vector3 of the rotation of the output plane.
  152008. */
  152009. outputRotation?: Vector3;
  152010. /**
  152011. * number of layers that the system will reserve in resources.
  152012. */
  152013. layerCount?: number;
  152014. /**
  152015. * number of max animation frames a single cell will reserve in resources.
  152016. */
  152017. maxAnimationFrames?: number;
  152018. /**
  152019. * number cell index of the base tile when the system compiles.
  152020. */
  152021. baseTile?: number;
  152022. /**
  152023. * boolean flip the sprite after its been repositioned by the framing data.
  152024. */
  152025. flipU?: boolean;
  152026. /**
  152027. * Vector3 scalar of the global RGB values of the SpriteMap.
  152028. */
  152029. colorMultiply?: Vector3;
  152030. }
  152031. /**
  152032. * Defines the IDisposable interface in order to be cleanable from resources.
  152033. */
  152034. export interface ISpriteMap extends IDisposable {
  152035. /**
  152036. * String name of the SpriteMap.
  152037. */
  152038. name: string;
  152039. /**
  152040. * The JSON Array file from a https://www.codeandweb.com/texturepacker export. Or similar structure.
  152041. */
  152042. atlasJSON: ISpriteJSONAtlas;
  152043. /**
  152044. * Texture of the SpriteMap.
  152045. */
  152046. spriteSheet: Texture;
  152047. /**
  152048. * The parameters to initialize the SpriteMap with.
  152049. */
  152050. options: ISpriteMapOptions;
  152051. }
  152052. /**
  152053. * Class used to manage a grid restricted sprite deployment on an Output plane.
  152054. */
  152055. export class SpriteMap implements ISpriteMap {
  152056. /** The Name of the spriteMap */
  152057. name: string;
  152058. /** The JSON file with the frame and meta data */
  152059. atlasJSON: ISpriteJSONAtlas;
  152060. /** The systems Sprite Sheet Texture */
  152061. spriteSheet: Texture;
  152062. /** Arguments passed with the Constructor */
  152063. options: ISpriteMapOptions;
  152064. /** Public Sprite Storage array, parsed from atlasJSON */
  152065. sprites: Array<ISpriteJSONSprite>;
  152066. /** Returns the Number of Sprites in the System */
  152067. get spriteCount(): number;
  152068. /** Returns the Position of Output Plane*/
  152069. get position(): Vector3;
  152070. /** Returns the Position of Output Plane*/
  152071. set position(v: Vector3);
  152072. /** Returns the Rotation of Output Plane*/
  152073. get rotation(): Vector3;
  152074. /** Returns the Rotation of Output Plane*/
  152075. set rotation(v: Vector3);
  152076. /** Sets the AnimationMap*/
  152077. get animationMap(): RawTexture;
  152078. /** Sets the AnimationMap*/
  152079. set animationMap(v: RawTexture);
  152080. /** Scene that the SpriteMap was created in */
  152081. private _scene;
  152082. /** Texture Buffer of Float32 that holds tile frame data*/
  152083. private _frameMap;
  152084. /** Texture Buffers of Float32 that holds tileMap data*/
  152085. private _tileMaps;
  152086. /** Texture Buffer of Float32 that holds Animation Data*/
  152087. private _animationMap;
  152088. /** Custom ShaderMaterial Central to the System*/
  152089. private _material;
  152090. /** Custom ShaderMaterial Central to the System*/
  152091. private _output;
  152092. /** Systems Time Ticker*/
  152093. private _time;
  152094. /**
  152095. * Creates a new SpriteMap
  152096. * @param name defines the SpriteMaps Name
  152097. * @param atlasJSON is the JSON file that controls the Sprites Frames and Meta
  152098. * @param spriteSheet is the Texture that the Sprites are on.
  152099. * @param options a basic deployment configuration
  152100. * @param scene The Scene that the map is deployed on
  152101. */
  152102. constructor(name: string, atlasJSON: ISpriteJSONAtlas, spriteSheet: Texture, options: ISpriteMapOptions, scene: Scene);
  152103. /**
  152104. * Returns tileID location
  152105. * @returns Vector2 the cell position ID
  152106. */
  152107. getTileID(): Vector2;
  152108. /**
  152109. * Gets the UV location of the mouse over the SpriteMap.
  152110. * @returns Vector2 the UV position of the mouse interaction
  152111. */
  152112. getMousePosition(): Vector2;
  152113. /**
  152114. * Creates the "frame" texture Buffer
  152115. * -------------------------------------
  152116. * Structure of frames
  152117. * "filename": "Falling-Water-2.png",
  152118. * "frame": {"x":69,"y":103,"w":24,"h":32},
  152119. * "rotated": true,
  152120. * "trimmed": true,
  152121. * "spriteSourceSize": {"x":4,"y":0,"w":24,"h":32},
  152122. * "sourceSize": {"w":32,"h":32}
  152123. * @returns RawTexture of the frameMap
  152124. */
  152125. private _createFrameBuffer;
  152126. /**
  152127. * Creates the tileMap texture Buffer
  152128. * @param buffer normally and array of numbers, or a false to generate from scratch
  152129. * @param _layer indicates what layer for a logic trigger dealing with the baseTile. The system uses this
  152130. * @returns RawTexture of the tileMap
  152131. */
  152132. private _createTileBuffer;
  152133. /**
  152134. * Modifies the data of the tileMaps
  152135. * @param _layer is the ID of the layer you want to edit on the SpriteMap
  152136. * @param pos is the iVector2 Coordinates of the Tile
  152137. * @param tile The SpriteIndex of the new Tile
  152138. */
  152139. changeTiles(_layer: number | undefined, pos: Vector2 | Vector2[], tile?: number): void;
  152140. /**
  152141. * Creates the animationMap texture Buffer
  152142. * @param buffer normally and array of numbers, or a false to generate from scratch
  152143. * @returns RawTexture of the animationMap
  152144. */
  152145. private _createTileAnimationBuffer;
  152146. /**
  152147. * Modifies the data of the animationMap
  152148. * @param cellID is the Index of the Sprite
  152149. * @param _frame is the target Animation frame
  152150. * @param toCell is the Target Index of the next frame of the animation
  152151. * @param time is a value between 0-1 that is the trigger for when the frame should change tiles
  152152. * @param speed is a global scalar of the time variable on the map.
  152153. */
  152154. addAnimationToTile(cellID?: number, _frame?: number, toCell?: number, time?: number, speed?: number): void;
  152155. /**
  152156. * Exports the .tilemaps file
  152157. */
  152158. saveTileMaps(): void;
  152159. /**
  152160. * Imports the .tilemaps file
  152161. * @param url of the .tilemaps file
  152162. */
  152163. loadTileMaps(url: string): void;
  152164. /**
  152165. * Release associated resources
  152166. */
  152167. dispose(): void;
  152168. }
  152169. }
  152170. declare module BABYLON {
  152171. /**
  152172. * Class used to manage multiple sprites of different sizes on the same spritesheet
  152173. * @see https://doc.babylonjs.com/babylon101/sprites
  152174. */
  152175. export class SpritePackedManager extends SpriteManager {
  152176. /** defines the packed manager's name */
  152177. name: string;
  152178. /**
  152179. * Creates a new sprite manager from a packed sprite sheet
  152180. * @param name defines the manager's name
  152181. * @param imgUrl defines the sprite sheet url
  152182. * @param capacity defines the maximum allowed number of sprites
  152183. * @param scene defines the hosting scene
  152184. * @param spriteJSON null otherwise a JSON object defining sprite sheet data
  152185. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  152186. * @param samplingMode defines the smapling mode to use with spritesheet
  152187. * @param fromPacked set to true; do not alter
  152188. */
  152189. constructor(
  152190. /** defines the packed manager's name */
  152191. name: string, imgUrl: string, capacity: number, scene: Scene, spriteJSON?: string | null, epsilon?: number, samplingMode?: number);
  152192. }
  152193. }
  152194. declare module BABYLON {
  152195. /**
  152196. * Defines the list of states available for a task inside a AssetsManager
  152197. */
  152198. export enum AssetTaskState {
  152199. /**
  152200. * Initialization
  152201. */
  152202. INIT = 0,
  152203. /**
  152204. * Running
  152205. */
  152206. RUNNING = 1,
  152207. /**
  152208. * Done
  152209. */
  152210. DONE = 2,
  152211. /**
  152212. * Error
  152213. */
  152214. ERROR = 3
  152215. }
  152216. /**
  152217. * Define an abstract asset task used with a AssetsManager class to load assets into a scene
  152218. */
  152219. export abstract class AbstractAssetTask {
  152220. /**
  152221. * Task name
  152222. */ name: string;
  152223. /**
  152224. * Callback called when the task is successful
  152225. */
  152226. onSuccess: (task: any) => void;
  152227. /**
  152228. * Callback called when the task is not successful
  152229. */
  152230. onError: (task: any, message?: string, exception?: any) => void;
  152231. /**
  152232. * Creates a new AssetsManager
  152233. * @param name defines the name of the task
  152234. */
  152235. constructor(
  152236. /**
  152237. * Task name
  152238. */ name: string);
  152239. private _isCompleted;
  152240. private _taskState;
  152241. private _errorObject;
  152242. /**
  152243. * Get if the task is completed
  152244. */
  152245. get isCompleted(): boolean;
  152246. /**
  152247. * Gets the current state of the task
  152248. */
  152249. get taskState(): AssetTaskState;
  152250. /**
  152251. * Gets the current error object (if task is in error)
  152252. */
  152253. get errorObject(): {
  152254. message?: string;
  152255. exception?: any;
  152256. };
  152257. /**
  152258. * Internal only
  152259. * @hidden
  152260. */
  152261. _setErrorObject(message?: string, exception?: any): void;
  152262. /**
  152263. * Execute the current task
  152264. * @param scene defines the scene where you want your assets to be loaded
  152265. * @param onSuccess is a callback called when the task is successfully executed
  152266. * @param onError is a callback called if an error occurs
  152267. */
  152268. run(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152269. /**
  152270. * Execute the current task
  152271. * @param scene defines the scene where you want your assets to be loaded
  152272. * @param onSuccess is a callback called when the task is successfully executed
  152273. * @param onError is a callback called if an error occurs
  152274. */
  152275. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152276. /**
  152277. * Reset will set the task state back to INIT, so the next load call of the assets manager will execute this task again.
  152278. * This can be used with failed tasks that have the reason for failure fixed.
  152279. */
  152280. reset(): void;
  152281. private onErrorCallback;
  152282. private onDoneCallback;
  152283. }
  152284. /**
  152285. * Define the interface used by progress events raised during assets loading
  152286. */
  152287. export interface IAssetsProgressEvent {
  152288. /**
  152289. * Defines the number of remaining tasks to process
  152290. */
  152291. remainingCount: number;
  152292. /**
  152293. * Defines the total number of tasks
  152294. */
  152295. totalCount: number;
  152296. /**
  152297. * Defines the task that was just processed
  152298. */
  152299. task: AbstractAssetTask;
  152300. }
  152301. /**
  152302. * Class used to share progress information about assets loading
  152303. */
  152304. export class AssetsProgressEvent implements IAssetsProgressEvent {
  152305. /**
  152306. * Defines the number of remaining tasks to process
  152307. */
  152308. remainingCount: number;
  152309. /**
  152310. * Defines the total number of tasks
  152311. */
  152312. totalCount: number;
  152313. /**
  152314. * Defines the task that was just processed
  152315. */
  152316. task: AbstractAssetTask;
  152317. /**
  152318. * Creates a AssetsProgressEvent
  152319. * @param remainingCount defines the number of remaining tasks to process
  152320. * @param totalCount defines the total number of tasks
  152321. * @param task defines the task that was just processed
  152322. */
  152323. constructor(remainingCount: number, totalCount: number, task: AbstractAssetTask);
  152324. }
  152325. /**
  152326. * Define a task used by AssetsManager to load assets into a container
  152327. */
  152328. export class ContainerAssetTask extends AbstractAssetTask {
  152329. /**
  152330. * Defines the name of the task
  152331. */
  152332. name: string;
  152333. /**
  152334. * Defines the list of mesh's names you want to load
  152335. */
  152336. meshesNames: any;
  152337. /**
  152338. * Defines the root url to use as a base to load your meshes and associated resources
  152339. */
  152340. rootUrl: string;
  152341. /**
  152342. * Defines the filename or File of the scene to load from
  152343. */
  152344. sceneFilename: string | File;
  152345. /**
  152346. * Get the loaded asset container
  152347. */
  152348. loadedContainer: AssetContainer;
  152349. /**
  152350. * Gets the list of loaded meshes
  152351. */
  152352. loadedMeshes: Array<AbstractMesh>;
  152353. /**
  152354. * Gets the list of loaded particle systems
  152355. */
  152356. loadedParticleSystems: Array<IParticleSystem>;
  152357. /**
  152358. * Gets the list of loaded skeletons
  152359. */
  152360. loadedSkeletons: Array<Skeleton>;
  152361. /**
  152362. * Gets the list of loaded animation groups
  152363. */
  152364. loadedAnimationGroups: Array<AnimationGroup>;
  152365. /**
  152366. * Callback called when the task is successful
  152367. */
  152368. onSuccess: (task: ContainerAssetTask) => void;
  152369. /**
  152370. * Callback called when the task is successful
  152371. */
  152372. onError: (task: ContainerAssetTask, message?: string, exception?: any) => void;
  152373. /**
  152374. * Creates a new ContainerAssetTask
  152375. * @param name defines the name of the task
  152376. * @param meshesNames defines the list of mesh's names you want to load
  152377. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  152378. * @param sceneFilename defines the filename or File of the scene to load from
  152379. */
  152380. constructor(
  152381. /**
  152382. * Defines the name of the task
  152383. */
  152384. name: string,
  152385. /**
  152386. * Defines the list of mesh's names you want to load
  152387. */
  152388. meshesNames: any,
  152389. /**
  152390. * Defines the root url to use as a base to load your meshes and associated resources
  152391. */
  152392. rootUrl: string,
  152393. /**
  152394. * Defines the filename or File of the scene to load from
  152395. */
  152396. sceneFilename: string | File);
  152397. /**
  152398. * Execute the current task
  152399. * @param scene defines the scene where you want your assets to be loaded
  152400. * @param onSuccess is a callback called when the task is successfully executed
  152401. * @param onError is a callback called if an error occurs
  152402. */
  152403. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152404. }
  152405. /**
  152406. * Define a task used by AssetsManager to load meshes
  152407. */
  152408. export class MeshAssetTask extends AbstractAssetTask {
  152409. /**
  152410. * Defines the name of the task
  152411. */
  152412. name: string;
  152413. /**
  152414. * Defines the list of mesh's names you want to load
  152415. */
  152416. meshesNames: any;
  152417. /**
  152418. * Defines the root url to use as a base to load your meshes and associated resources
  152419. */
  152420. rootUrl: string;
  152421. /**
  152422. * Defines the filename or File of the scene to load from
  152423. */
  152424. sceneFilename: string | File;
  152425. /**
  152426. * Gets the list of loaded meshes
  152427. */
  152428. loadedMeshes: Array<AbstractMesh>;
  152429. /**
  152430. * Gets the list of loaded particle systems
  152431. */
  152432. loadedParticleSystems: Array<IParticleSystem>;
  152433. /**
  152434. * Gets the list of loaded skeletons
  152435. */
  152436. loadedSkeletons: Array<Skeleton>;
  152437. /**
  152438. * Gets the list of loaded animation groups
  152439. */
  152440. loadedAnimationGroups: Array<AnimationGroup>;
  152441. /**
  152442. * Callback called when the task is successful
  152443. */
  152444. onSuccess: (task: MeshAssetTask) => void;
  152445. /**
  152446. * Callback called when the task is successful
  152447. */
  152448. onError: (task: MeshAssetTask, message?: string, exception?: any) => void;
  152449. /**
  152450. * Creates a new MeshAssetTask
  152451. * @param name defines the name of the task
  152452. * @param meshesNames defines the list of mesh's names you want to load
  152453. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  152454. * @param sceneFilename defines the filename or File of the scene to load from
  152455. */
  152456. constructor(
  152457. /**
  152458. * Defines the name of the task
  152459. */
  152460. name: string,
  152461. /**
  152462. * Defines the list of mesh's names you want to load
  152463. */
  152464. meshesNames: any,
  152465. /**
  152466. * Defines the root url to use as a base to load your meshes and associated resources
  152467. */
  152468. rootUrl: string,
  152469. /**
  152470. * Defines the filename or File of the scene to load from
  152471. */
  152472. sceneFilename: string | File);
  152473. /**
  152474. * Execute the current task
  152475. * @param scene defines the scene where you want your assets to be loaded
  152476. * @param onSuccess is a callback called when the task is successfully executed
  152477. * @param onError is a callback called if an error occurs
  152478. */
  152479. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152480. }
  152481. /**
  152482. * Define a task used by AssetsManager to load text content
  152483. */
  152484. export class TextFileAssetTask extends AbstractAssetTask {
  152485. /**
  152486. * Defines the name of the task
  152487. */
  152488. name: string;
  152489. /**
  152490. * Defines the location of the file to load
  152491. */
  152492. url: string;
  152493. /**
  152494. * Gets the loaded text string
  152495. */
  152496. text: string;
  152497. /**
  152498. * Callback called when the task is successful
  152499. */
  152500. onSuccess: (task: TextFileAssetTask) => void;
  152501. /**
  152502. * Callback called when the task is successful
  152503. */
  152504. onError: (task: TextFileAssetTask, message?: string, exception?: any) => void;
  152505. /**
  152506. * Creates a new TextFileAssetTask object
  152507. * @param name defines the name of the task
  152508. * @param url defines the location of the file to load
  152509. */
  152510. constructor(
  152511. /**
  152512. * Defines the name of the task
  152513. */
  152514. name: string,
  152515. /**
  152516. * Defines the location of the file to load
  152517. */
  152518. url: string);
  152519. /**
  152520. * Execute the current task
  152521. * @param scene defines the scene where you want your assets to be loaded
  152522. * @param onSuccess is a callback called when the task is successfully executed
  152523. * @param onError is a callback called if an error occurs
  152524. */
  152525. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152526. }
  152527. /**
  152528. * Define a task used by AssetsManager to load binary data
  152529. */
  152530. export class BinaryFileAssetTask extends AbstractAssetTask {
  152531. /**
  152532. * Defines the name of the task
  152533. */
  152534. name: string;
  152535. /**
  152536. * Defines the location of the file to load
  152537. */
  152538. url: string;
  152539. /**
  152540. * Gets the lodaded data (as an array buffer)
  152541. */
  152542. data: ArrayBuffer;
  152543. /**
  152544. * Callback called when the task is successful
  152545. */
  152546. onSuccess: (task: BinaryFileAssetTask) => void;
  152547. /**
  152548. * Callback called when the task is successful
  152549. */
  152550. onError: (task: BinaryFileAssetTask, message?: string, exception?: any) => void;
  152551. /**
  152552. * Creates a new BinaryFileAssetTask object
  152553. * @param name defines the name of the new task
  152554. * @param url defines the location of the file to load
  152555. */
  152556. constructor(
  152557. /**
  152558. * Defines the name of the task
  152559. */
  152560. name: string,
  152561. /**
  152562. * Defines the location of the file to load
  152563. */
  152564. url: string);
  152565. /**
  152566. * Execute the current task
  152567. * @param scene defines the scene where you want your assets to be loaded
  152568. * @param onSuccess is a callback called when the task is successfully executed
  152569. * @param onError is a callback called if an error occurs
  152570. */
  152571. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152572. }
  152573. /**
  152574. * Define a task used by AssetsManager to load images
  152575. */
  152576. export class ImageAssetTask extends AbstractAssetTask {
  152577. /**
  152578. * Defines the name of the task
  152579. */
  152580. name: string;
  152581. /**
  152582. * Defines the location of the image to load
  152583. */
  152584. url: string;
  152585. /**
  152586. * Gets the loaded images
  152587. */
  152588. image: HTMLImageElement;
  152589. /**
  152590. * Callback called when the task is successful
  152591. */
  152592. onSuccess: (task: ImageAssetTask) => void;
  152593. /**
  152594. * Callback called when the task is successful
  152595. */
  152596. onError: (task: ImageAssetTask, message?: string, exception?: any) => void;
  152597. /**
  152598. * Creates a new ImageAssetTask
  152599. * @param name defines the name of the task
  152600. * @param url defines the location of the image to load
  152601. */
  152602. constructor(
  152603. /**
  152604. * Defines the name of the task
  152605. */
  152606. name: string,
  152607. /**
  152608. * Defines the location of the image to load
  152609. */
  152610. url: string);
  152611. /**
  152612. * Execute the current task
  152613. * @param scene defines the scene where you want your assets to be loaded
  152614. * @param onSuccess is a callback called when the task is successfully executed
  152615. * @param onError is a callback called if an error occurs
  152616. */
  152617. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152618. }
  152619. /**
  152620. * Defines the interface used by texture loading tasks
  152621. */
  152622. export interface ITextureAssetTask<TEX extends BaseTexture> {
  152623. /**
  152624. * Gets the loaded texture
  152625. */
  152626. texture: TEX;
  152627. }
  152628. /**
  152629. * Define a task used by AssetsManager to load 2D textures
  152630. */
  152631. export class TextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<Texture> {
  152632. /**
  152633. * Defines the name of the task
  152634. */
  152635. name: string;
  152636. /**
  152637. * Defines the location of the file to load
  152638. */
  152639. url: string;
  152640. /**
  152641. * Defines if mipmap should not be generated (default is false)
  152642. */
  152643. noMipmap?: boolean | undefined;
  152644. /**
  152645. * Defines if texture must be inverted on Y axis (default is true)
  152646. */
  152647. invertY: boolean;
  152648. /**
  152649. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  152650. */
  152651. samplingMode: number;
  152652. /**
  152653. * Gets the loaded texture
  152654. */
  152655. texture: Texture;
  152656. /**
  152657. * Callback called when the task is successful
  152658. */
  152659. onSuccess: (task: TextureAssetTask) => void;
  152660. /**
  152661. * Callback called when the task is successful
  152662. */
  152663. onError: (task: TextureAssetTask, message?: string, exception?: any) => void;
  152664. /**
  152665. * Creates a new TextureAssetTask object
  152666. * @param name defines the name of the task
  152667. * @param url defines the location of the file to load
  152668. * @param noMipmap defines if mipmap should not be generated (default is false)
  152669. * @param invertY defines if texture must be inverted on Y axis (default is true)
  152670. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  152671. */
  152672. constructor(
  152673. /**
  152674. * Defines the name of the task
  152675. */
  152676. name: string,
  152677. /**
  152678. * Defines the location of the file to load
  152679. */
  152680. url: string,
  152681. /**
  152682. * Defines if mipmap should not be generated (default is false)
  152683. */
  152684. noMipmap?: boolean | undefined,
  152685. /**
  152686. * Defines if texture must be inverted on Y axis (default is true)
  152687. */
  152688. invertY?: boolean,
  152689. /**
  152690. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  152691. */
  152692. samplingMode?: number);
  152693. /**
  152694. * Execute the current task
  152695. * @param scene defines the scene where you want your assets to be loaded
  152696. * @param onSuccess is a callback called when the task is successfully executed
  152697. * @param onError is a callback called if an error occurs
  152698. */
  152699. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152700. }
  152701. /**
  152702. * Define a task used by AssetsManager to load cube textures
  152703. */
  152704. export class CubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<CubeTexture> {
  152705. /**
  152706. * Defines the name of the task
  152707. */
  152708. name: string;
  152709. /**
  152710. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  152711. */
  152712. url: string;
  152713. /**
  152714. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  152715. */
  152716. extensions?: string[] | undefined;
  152717. /**
  152718. * Defines if mipmaps should not be generated (default is false)
  152719. */
  152720. noMipmap?: boolean | undefined;
  152721. /**
  152722. * Defines the explicit list of files (undefined by default)
  152723. */
  152724. files?: string[] | undefined;
  152725. /**
  152726. * Gets the loaded texture
  152727. */
  152728. texture: CubeTexture;
  152729. /**
  152730. * Callback called when the task is successful
  152731. */
  152732. onSuccess: (task: CubeTextureAssetTask) => void;
  152733. /**
  152734. * Callback called when the task is successful
  152735. */
  152736. onError: (task: CubeTextureAssetTask, message?: string, exception?: any) => void;
  152737. /**
  152738. * Creates a new CubeTextureAssetTask
  152739. * @param name defines the name of the task
  152740. * @param url defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  152741. * @param extensions defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  152742. * @param noMipmap defines if mipmaps should not be generated (default is false)
  152743. * @param files defines the explicit list of files (undefined by default)
  152744. */
  152745. constructor(
  152746. /**
  152747. * Defines the name of the task
  152748. */
  152749. name: string,
  152750. /**
  152751. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  152752. */
  152753. url: string,
  152754. /**
  152755. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  152756. */
  152757. extensions?: string[] | undefined,
  152758. /**
  152759. * Defines if mipmaps should not be generated (default is false)
  152760. */
  152761. noMipmap?: boolean | undefined,
  152762. /**
  152763. * Defines the explicit list of files (undefined by default)
  152764. */
  152765. files?: string[] | undefined);
  152766. /**
  152767. * Execute the current task
  152768. * @param scene defines the scene where you want your assets to be loaded
  152769. * @param onSuccess is a callback called when the task is successfully executed
  152770. * @param onError is a callback called if an error occurs
  152771. */
  152772. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152773. }
  152774. /**
  152775. * Define a task used by AssetsManager to load HDR cube textures
  152776. */
  152777. export class HDRCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<HDRCubeTexture> {
  152778. /**
  152779. * Defines the name of the task
  152780. */
  152781. name: string;
  152782. /**
  152783. * Defines the location of the file to load
  152784. */
  152785. url: string;
  152786. /**
  152787. * Defines the desired size (the more it increases the longer the generation will be)
  152788. */
  152789. size: number;
  152790. /**
  152791. * Defines if mipmaps should not be generated (default is false)
  152792. */
  152793. noMipmap: boolean;
  152794. /**
  152795. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  152796. */
  152797. generateHarmonics: boolean;
  152798. /**
  152799. * 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)
  152800. */
  152801. gammaSpace: boolean;
  152802. /**
  152803. * Internal Use Only
  152804. */
  152805. reserved: boolean;
  152806. /**
  152807. * Gets the loaded texture
  152808. */
  152809. texture: HDRCubeTexture;
  152810. /**
  152811. * Callback called when the task is successful
  152812. */
  152813. onSuccess: (task: HDRCubeTextureAssetTask) => void;
  152814. /**
  152815. * Callback called when the task is successful
  152816. */
  152817. onError: (task: HDRCubeTextureAssetTask, message?: string, exception?: any) => void;
  152818. /**
  152819. * Creates a new HDRCubeTextureAssetTask object
  152820. * @param name defines the name of the task
  152821. * @param url defines the location of the file to load
  152822. * @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.
  152823. * @param noMipmap defines if mipmaps should not be generated (default is false)
  152824. * @param generateHarmonics specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  152825. * @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)
  152826. * @param reserved Internal use only
  152827. */
  152828. constructor(
  152829. /**
  152830. * Defines the name of the task
  152831. */
  152832. name: string,
  152833. /**
  152834. * Defines the location of the file to load
  152835. */
  152836. url: string,
  152837. /**
  152838. * Defines the desired size (the more it increases the longer the generation will be)
  152839. */
  152840. size: number,
  152841. /**
  152842. * Defines if mipmaps should not be generated (default is false)
  152843. */
  152844. noMipmap?: boolean,
  152845. /**
  152846. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  152847. */
  152848. generateHarmonics?: boolean,
  152849. /**
  152850. * 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)
  152851. */
  152852. gammaSpace?: boolean,
  152853. /**
  152854. * Internal Use Only
  152855. */
  152856. reserved?: boolean);
  152857. /**
  152858. * Execute the current task
  152859. * @param scene defines the scene where you want your assets to be loaded
  152860. * @param onSuccess is a callback called when the task is successfully executed
  152861. * @param onError is a callback called if an error occurs
  152862. */
  152863. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152864. }
  152865. /**
  152866. * Define a task used by AssetsManager to load Equirectangular cube textures
  152867. */
  152868. export class EquiRectangularCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<EquiRectangularCubeTexture> {
  152869. /**
  152870. * Defines the name of the task
  152871. */
  152872. name: string;
  152873. /**
  152874. * Defines the location of the file to load
  152875. */
  152876. url: string;
  152877. /**
  152878. * Defines the desired size (the more it increases the longer the generation will be)
  152879. */
  152880. size: number;
  152881. /**
  152882. * Defines if mipmaps should not be generated (default is false)
  152883. */
  152884. noMipmap: boolean;
  152885. /**
  152886. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  152887. * but the standard material would require them in Gamma space) (default is true)
  152888. */
  152889. gammaSpace: boolean;
  152890. /**
  152891. * Gets the loaded texture
  152892. */
  152893. texture: EquiRectangularCubeTexture;
  152894. /**
  152895. * Callback called when the task is successful
  152896. */
  152897. onSuccess: (task: EquiRectangularCubeTextureAssetTask) => void;
  152898. /**
  152899. * Callback called when the task is successful
  152900. */
  152901. onError: (task: EquiRectangularCubeTextureAssetTask, message?: string, exception?: any) => void;
  152902. /**
  152903. * Creates a new EquiRectangularCubeTextureAssetTask object
  152904. * @param name defines the name of the task
  152905. * @param url defines the location of the file to load
  152906. * @param size defines the desired size (the more it increases the longer the generation will be)
  152907. * If the size is omitted this implies you are using a preprocessed cubemap.
  152908. * @param noMipmap defines if mipmaps should not be generated (default is false)
  152909. * @param gammaSpace specifies if the texture will be used in gamma or linear space
  152910. * (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space)
  152911. * (default is true)
  152912. */
  152913. constructor(
  152914. /**
  152915. * Defines the name of the task
  152916. */
  152917. name: string,
  152918. /**
  152919. * Defines the location of the file to load
  152920. */
  152921. url: string,
  152922. /**
  152923. * Defines the desired size (the more it increases the longer the generation will be)
  152924. */
  152925. size: number,
  152926. /**
  152927. * Defines if mipmaps should not be generated (default is false)
  152928. */
  152929. noMipmap?: boolean,
  152930. /**
  152931. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  152932. * but the standard material would require them in Gamma space) (default is true)
  152933. */
  152934. gammaSpace?: boolean);
  152935. /**
  152936. * Execute the current task
  152937. * @param scene defines the scene where you want your assets to be loaded
  152938. * @param onSuccess is a callback called when the task is successfully executed
  152939. * @param onError is a callback called if an error occurs
  152940. */
  152941. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152942. }
  152943. /**
  152944. * This class can be used to easily import assets into a scene
  152945. * @see https://doc.babylonjs.com/how_to/how_to_use_assetsmanager
  152946. */
  152947. export class AssetsManager {
  152948. private _scene;
  152949. private _isLoading;
  152950. protected _tasks: AbstractAssetTask[];
  152951. protected _waitingTasksCount: number;
  152952. protected _totalTasksCount: number;
  152953. /**
  152954. * Callback called when all tasks are processed
  152955. */
  152956. onFinish: (tasks: AbstractAssetTask[]) => void;
  152957. /**
  152958. * Callback called when a task is successful
  152959. */
  152960. onTaskSuccess: (task: AbstractAssetTask) => void;
  152961. /**
  152962. * Callback called when a task had an error
  152963. */
  152964. onTaskError: (task: AbstractAssetTask) => void;
  152965. /**
  152966. * Callback called when a task is done (whatever the result is)
  152967. */
  152968. onProgress: (remainingCount: number, totalCount: number, task: AbstractAssetTask) => void;
  152969. /**
  152970. * Observable called when all tasks are processed
  152971. */
  152972. onTaskSuccessObservable: Observable<AbstractAssetTask>;
  152973. /**
  152974. * Observable called when a task had an error
  152975. */
  152976. onTaskErrorObservable: Observable<AbstractAssetTask>;
  152977. /**
  152978. * Observable called when all tasks were executed
  152979. */
  152980. onTasksDoneObservable: Observable<AbstractAssetTask[]>;
  152981. /**
  152982. * Observable called when a task is done (whatever the result is)
  152983. */
  152984. onProgressObservable: Observable<IAssetsProgressEvent>;
  152985. /**
  152986. * Gets or sets a boolean defining if the AssetsManager should use the default loading screen
  152987. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  152988. */
  152989. useDefaultLoadingScreen: boolean;
  152990. /**
  152991. * Gets or sets a boolean defining if the AssetsManager should automatically hide the loading screen
  152992. * when all assets have been downloaded.
  152993. * If set to false, you need to manually call in hideLoadingUI() once your scene is ready.
  152994. */
  152995. autoHideLoadingUI: boolean;
  152996. /**
  152997. * Creates a new AssetsManager
  152998. * @param scene defines the scene to work on
  152999. */
  153000. constructor(scene: Scene);
  153001. /**
  153002. * Add a ContainerAssetTask to the list of active tasks
  153003. * @param taskName defines the name of the new task
  153004. * @param meshesNames defines the name of meshes to load
  153005. * @param rootUrl defines the root url to use to locate files
  153006. * @param sceneFilename defines the filename of the scene file
  153007. * @returns a new ContainerAssetTask object
  153008. */
  153009. addContainerTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): ContainerAssetTask;
  153010. /**
  153011. * Add a MeshAssetTask to the list of active tasks
  153012. * @param taskName defines the name of the new task
  153013. * @param meshesNames defines the name of meshes to load
  153014. * @param rootUrl defines the root url to use to locate files
  153015. * @param sceneFilename defines the filename of the scene file
  153016. * @returns a new MeshAssetTask object
  153017. */
  153018. addMeshTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): MeshAssetTask;
  153019. /**
  153020. * Add a TextFileAssetTask to the list of active tasks
  153021. * @param taskName defines the name of the new task
  153022. * @param url defines the url of the file to load
  153023. * @returns a new TextFileAssetTask object
  153024. */
  153025. addTextFileTask(taskName: string, url: string): TextFileAssetTask;
  153026. /**
  153027. * Add a BinaryFileAssetTask to the list of active tasks
  153028. * @param taskName defines the name of the new task
  153029. * @param url defines the url of the file to load
  153030. * @returns a new BinaryFileAssetTask object
  153031. */
  153032. addBinaryFileTask(taskName: string, url: string): BinaryFileAssetTask;
  153033. /**
  153034. * Add a ImageAssetTask to the list of active tasks
  153035. * @param taskName defines the name of the new task
  153036. * @param url defines the url of the file to load
  153037. * @returns a new ImageAssetTask object
  153038. */
  153039. addImageTask(taskName: string, url: string): ImageAssetTask;
  153040. /**
  153041. * Add a TextureAssetTask to the list of active tasks
  153042. * @param taskName defines the name of the new task
  153043. * @param url defines the url of the file to load
  153044. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  153045. * @param invertY defines if you want to invert Y axis of the loaded texture (false by default)
  153046. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  153047. * @returns a new TextureAssetTask object
  153048. */
  153049. addTextureTask(taskName: string, url: string, noMipmap?: boolean, invertY?: boolean, samplingMode?: number): TextureAssetTask;
  153050. /**
  153051. * Add a CubeTextureAssetTask to the list of active tasks
  153052. * @param taskName defines the name of the new task
  153053. * @param url defines the url of the file to load
  153054. * @param extensions defines the extension to use to load the cube map (can be null)
  153055. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  153056. * @param files defines the list of files to load (can be null)
  153057. * @returns a new CubeTextureAssetTask object
  153058. */
  153059. addCubeTextureTask(taskName: string, url: string, extensions?: string[], noMipmap?: boolean, files?: string[]): CubeTextureAssetTask;
  153060. /**
  153061. *
  153062. * Add a HDRCubeTextureAssetTask to the list of active tasks
  153063. * @param taskName defines the name of the new task
  153064. * @param url defines the url of the file to load
  153065. * @param size defines the size you want for the cubemap (can be null)
  153066. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  153067. * @param generateHarmonics defines if you want to automatically generate (true by default)
  153068. * @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)
  153069. * @param reserved Internal use only
  153070. * @returns a new HDRCubeTextureAssetTask object
  153071. */
  153072. addHDRCubeTextureTask(taskName: string, url: string, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, reserved?: boolean): HDRCubeTextureAssetTask;
  153073. /**
  153074. *
  153075. * Add a EquiRectangularCubeTextureAssetTask to the list of active tasks
  153076. * @param taskName defines the name of the new task
  153077. * @param url defines the url of the file to load
  153078. * @param size defines the size you want for the cubemap (can be null)
  153079. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  153080. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  153081. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  153082. * @returns a new EquiRectangularCubeTextureAssetTask object
  153083. */
  153084. addEquiRectangularCubeTextureAssetTask(taskName: string, url: string, size: number, noMipmap?: boolean, gammaSpace?: boolean): EquiRectangularCubeTextureAssetTask;
  153085. /**
  153086. * Remove a task from the assets manager.
  153087. * @param task the task to remove
  153088. */
  153089. removeTask(task: AbstractAssetTask): void;
  153090. private _decreaseWaitingTasksCount;
  153091. private _runTask;
  153092. /**
  153093. * Reset the AssetsManager and remove all tasks
  153094. * @return the current instance of the AssetsManager
  153095. */
  153096. reset(): AssetsManager;
  153097. /**
  153098. * Start the loading process
  153099. * @return the current instance of the AssetsManager
  153100. */
  153101. load(): AssetsManager;
  153102. /**
  153103. * Start the loading process as an async operation
  153104. * @return a promise returning the list of failed tasks
  153105. */
  153106. loadAsync(): Promise<void>;
  153107. }
  153108. }
  153109. declare module BABYLON {
  153110. /**
  153111. * Wrapper class for promise with external resolve and reject.
  153112. */
  153113. export class Deferred<T> {
  153114. /**
  153115. * The promise associated with this deferred object.
  153116. */
  153117. readonly promise: Promise<T>;
  153118. private _resolve;
  153119. private _reject;
  153120. /**
  153121. * The resolve method of the promise associated with this deferred object.
  153122. */
  153123. get resolve(): (value?: T | PromiseLike<T> | undefined) => void;
  153124. /**
  153125. * The reject method of the promise associated with this deferred object.
  153126. */
  153127. get reject(): (reason?: any) => void;
  153128. /**
  153129. * Constructor for this deferred object.
  153130. */
  153131. constructor();
  153132. }
  153133. }
  153134. declare module BABYLON {
  153135. /**
  153136. * Class used to explode meshes (ie. to have a center and move them away from that center to better see the overall organization)
  153137. */
  153138. export class MeshExploder {
  153139. private _centerMesh;
  153140. private _meshes;
  153141. private _meshesOrigins;
  153142. private _toCenterVectors;
  153143. private _scaledDirection;
  153144. private _newPosition;
  153145. private _centerPosition;
  153146. /**
  153147. * Explodes meshes from a center mesh.
  153148. * @param meshes The meshes to explode.
  153149. * @param centerMesh The mesh to be center of explosion.
  153150. */
  153151. constructor(meshes: Array<Mesh>, centerMesh?: Mesh);
  153152. private _setCenterMesh;
  153153. /**
  153154. * Get class name
  153155. * @returns "MeshExploder"
  153156. */
  153157. getClassName(): string;
  153158. /**
  153159. * "Exploded meshes"
  153160. * @returns Array of meshes with the centerMesh at index 0.
  153161. */
  153162. getMeshes(): Array<Mesh>;
  153163. /**
  153164. * Explodes meshes giving a specific direction
  153165. * @param direction Number to multiply distance of each mesh's origin from center. Use a negative number to implode, or zero to reset.
  153166. */
  153167. explode(direction?: number): void;
  153168. }
  153169. }
  153170. declare module BABYLON {
  153171. /**
  153172. * Class used to help managing file picking and drag'n'drop
  153173. */
  153174. export class FilesInput {
  153175. /**
  153176. * List of files ready to be loaded
  153177. */
  153178. static get FilesToLoad(): {
  153179. [key: string]: File;
  153180. };
  153181. /**
  153182. * Callback called when a file is processed
  153183. */
  153184. onProcessFileCallback: (file: File, name: string, extension: string) => boolean;
  153185. private _engine;
  153186. private _currentScene;
  153187. private _sceneLoadedCallback;
  153188. private _progressCallback;
  153189. private _additionalRenderLoopLogicCallback;
  153190. private _textureLoadingCallback;
  153191. private _startingProcessingFilesCallback;
  153192. private _onReloadCallback;
  153193. private _errorCallback;
  153194. private _elementToMonitor;
  153195. private _sceneFileToLoad;
  153196. private _filesToLoad;
  153197. /**
  153198. * Creates a new FilesInput
  153199. * @param engine defines the rendering engine
  153200. * @param scene defines the hosting scene
  153201. * @param sceneLoadedCallback callback called when scene is loaded
  153202. * @param progressCallback callback called to track progress
  153203. * @param additionalRenderLoopLogicCallback callback called to add user logic to the rendering loop
  153204. * @param textureLoadingCallback callback called when a texture is loading
  153205. * @param startingProcessingFilesCallback callback called when the system is about to process all files
  153206. * @param onReloadCallback callback called when a reload is requested
  153207. * @param errorCallback callback call if an error occurs
  153208. */
  153209. 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>);
  153210. private _dragEnterHandler;
  153211. private _dragOverHandler;
  153212. private _dropHandler;
  153213. /**
  153214. * Calls this function to listen to drag'n'drop events on a specific DOM element
  153215. * @param elementToMonitor defines the DOM element to track
  153216. */
  153217. monitorElementForDragNDrop(elementToMonitor: HTMLElement): void;
  153218. /** Gets the current list of files to load */
  153219. get filesToLoad(): File[];
  153220. /**
  153221. * Release all associated resources
  153222. */
  153223. dispose(): void;
  153224. private renderFunction;
  153225. private drag;
  153226. private drop;
  153227. private _traverseFolder;
  153228. private _processFiles;
  153229. /**
  153230. * Load files from a drop event
  153231. * @param event defines the drop event to use as source
  153232. */
  153233. loadFiles(event: any): void;
  153234. private _processReload;
  153235. /**
  153236. * Reload the current scene from the loaded files
  153237. */
  153238. reload(): void;
  153239. }
  153240. }
  153241. declare module BABYLON {
  153242. /**
  153243. * Defines the root class used to create scene optimization to use with SceneOptimizer
  153244. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153245. */
  153246. export class SceneOptimization {
  153247. /**
  153248. * Defines the priority of this optimization (0 by default which means first in the list)
  153249. */
  153250. priority: number;
  153251. /**
  153252. * Gets a string describing the action executed by the current optimization
  153253. * @returns description string
  153254. */
  153255. getDescription(): string;
  153256. /**
  153257. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153258. * @param scene defines the current scene where to apply this optimization
  153259. * @param optimizer defines the current optimizer
  153260. * @returns true if everything that can be done was applied
  153261. */
  153262. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153263. /**
  153264. * Creates the SceneOptimization object
  153265. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  153266. * @param desc defines the description associated with the optimization
  153267. */
  153268. constructor(
  153269. /**
  153270. * Defines the priority of this optimization (0 by default which means first in the list)
  153271. */
  153272. priority?: number);
  153273. }
  153274. /**
  153275. * Defines an optimization used to reduce the size of render target textures
  153276. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153277. */
  153278. export class TextureOptimization extends SceneOptimization {
  153279. /**
  153280. * Defines the priority of this optimization (0 by default which means first in the list)
  153281. */
  153282. priority: number;
  153283. /**
  153284. * 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
  153285. */
  153286. maximumSize: number;
  153287. /**
  153288. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  153289. */
  153290. step: number;
  153291. /**
  153292. * Gets a string describing the action executed by the current optimization
  153293. * @returns description string
  153294. */
  153295. getDescription(): string;
  153296. /**
  153297. * Creates the TextureOptimization object
  153298. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  153299. * @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
  153300. * @param step defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  153301. */
  153302. constructor(
  153303. /**
  153304. * Defines the priority of this optimization (0 by default which means first in the list)
  153305. */
  153306. priority?: number,
  153307. /**
  153308. * 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
  153309. */
  153310. maximumSize?: number,
  153311. /**
  153312. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  153313. */
  153314. step?: number);
  153315. /**
  153316. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153317. * @param scene defines the current scene where to apply this optimization
  153318. * @param optimizer defines the current optimizer
  153319. * @returns true if everything that can be done was applied
  153320. */
  153321. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153322. }
  153323. /**
  153324. * Defines an optimization used to increase or decrease the rendering resolution
  153325. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153326. */
  153327. export class HardwareScalingOptimization extends SceneOptimization {
  153328. /**
  153329. * Defines the priority of this optimization (0 by default which means first in the list)
  153330. */
  153331. priority: number;
  153332. /**
  153333. * Defines the maximum scale to use (2 by default)
  153334. */
  153335. maximumScale: number;
  153336. /**
  153337. * Defines the step to use between two passes (0.5 by default)
  153338. */
  153339. step: number;
  153340. private _currentScale;
  153341. private _directionOffset;
  153342. /**
  153343. * Gets a string describing the action executed by the current optimization
  153344. * @return description string
  153345. */
  153346. getDescription(): string;
  153347. /**
  153348. * Creates the HardwareScalingOptimization object
  153349. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  153350. * @param maximumScale defines the maximum scale to use (2 by default)
  153351. * @param step defines the step to use between two passes (0.5 by default)
  153352. */
  153353. constructor(
  153354. /**
  153355. * Defines the priority of this optimization (0 by default which means first in the list)
  153356. */
  153357. priority?: number,
  153358. /**
  153359. * Defines the maximum scale to use (2 by default)
  153360. */
  153361. maximumScale?: number,
  153362. /**
  153363. * Defines the step to use between two passes (0.5 by default)
  153364. */
  153365. step?: number);
  153366. /**
  153367. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153368. * @param scene defines the current scene where to apply this optimization
  153369. * @param optimizer defines the current optimizer
  153370. * @returns true if everything that can be done was applied
  153371. */
  153372. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153373. }
  153374. /**
  153375. * Defines an optimization used to remove shadows
  153376. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153377. */
  153378. export class ShadowsOptimization extends SceneOptimization {
  153379. /**
  153380. * Gets a string describing the action executed by the current optimization
  153381. * @return description string
  153382. */
  153383. getDescription(): string;
  153384. /**
  153385. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153386. * @param scene defines the current scene where to apply this optimization
  153387. * @param optimizer defines the current optimizer
  153388. * @returns true if everything that can be done was applied
  153389. */
  153390. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153391. }
  153392. /**
  153393. * Defines an optimization used to turn post-processes off
  153394. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153395. */
  153396. export class PostProcessesOptimization extends SceneOptimization {
  153397. /**
  153398. * Gets a string describing the action executed by the current optimization
  153399. * @return description string
  153400. */
  153401. getDescription(): string;
  153402. /**
  153403. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153404. * @param scene defines the current scene where to apply this optimization
  153405. * @param optimizer defines the current optimizer
  153406. * @returns true if everything that can be done was applied
  153407. */
  153408. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153409. }
  153410. /**
  153411. * Defines an optimization used to turn lens flares off
  153412. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153413. */
  153414. export class LensFlaresOptimization extends SceneOptimization {
  153415. /**
  153416. * Gets a string describing the action executed by the current optimization
  153417. * @return description string
  153418. */
  153419. getDescription(): string;
  153420. /**
  153421. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153422. * @param scene defines the current scene where to apply this optimization
  153423. * @param optimizer defines the current optimizer
  153424. * @returns true if everything that can be done was applied
  153425. */
  153426. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153427. }
  153428. /**
  153429. * Defines an optimization based on user defined callback.
  153430. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153431. */
  153432. export class CustomOptimization extends SceneOptimization {
  153433. /**
  153434. * Callback called to apply the custom optimization.
  153435. */
  153436. onApply: (scene: Scene, optimizer: SceneOptimizer) => boolean;
  153437. /**
  153438. * Callback called to get custom description
  153439. */
  153440. onGetDescription: () => string;
  153441. /**
  153442. * Gets a string describing the action executed by the current optimization
  153443. * @returns description string
  153444. */
  153445. getDescription(): string;
  153446. /**
  153447. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153448. * @param scene defines the current scene where to apply this optimization
  153449. * @param optimizer defines the current optimizer
  153450. * @returns true if everything that can be done was applied
  153451. */
  153452. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153453. }
  153454. /**
  153455. * Defines an optimization used to turn particles off
  153456. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153457. */
  153458. export class ParticlesOptimization extends SceneOptimization {
  153459. /**
  153460. * Gets a string describing the action executed by the current optimization
  153461. * @return description string
  153462. */
  153463. getDescription(): string;
  153464. /**
  153465. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153466. * @param scene defines the current scene where to apply this optimization
  153467. * @param optimizer defines the current optimizer
  153468. * @returns true if everything that can be done was applied
  153469. */
  153470. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153471. }
  153472. /**
  153473. * Defines an optimization used to turn render targets off
  153474. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153475. */
  153476. export class RenderTargetsOptimization extends SceneOptimization {
  153477. /**
  153478. * Gets a string describing the action executed by the current optimization
  153479. * @return description string
  153480. */
  153481. getDescription(): string;
  153482. /**
  153483. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153484. * @param scene defines the current scene where to apply this optimization
  153485. * @param optimizer defines the current optimizer
  153486. * @returns true if everything that can be done was applied
  153487. */
  153488. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153489. }
  153490. /**
  153491. * Defines an optimization used to merge meshes with compatible materials
  153492. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153493. */
  153494. export class MergeMeshesOptimization extends SceneOptimization {
  153495. private static _UpdateSelectionTree;
  153496. /**
  153497. * Gets or sets a boolean which defines if optimization octree has to be updated
  153498. */
  153499. static get UpdateSelectionTree(): boolean;
  153500. /**
  153501. * Gets or sets a boolean which defines if optimization octree has to be updated
  153502. */
  153503. static set UpdateSelectionTree(value: boolean);
  153504. /**
  153505. * Gets a string describing the action executed by the current optimization
  153506. * @return description string
  153507. */
  153508. getDescription(): string;
  153509. private _canBeMerged;
  153510. /**
  153511. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153512. * @param scene defines the current scene where to apply this optimization
  153513. * @param optimizer defines the current optimizer
  153514. * @param updateSelectionTree defines that the selection octree has to be updated (false by default)
  153515. * @returns true if everything that can be done was applied
  153516. */
  153517. apply(scene: Scene, optimizer: SceneOptimizer, updateSelectionTree?: boolean): boolean;
  153518. }
  153519. /**
  153520. * Defines a list of options used by SceneOptimizer
  153521. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153522. */
  153523. export class SceneOptimizerOptions {
  153524. /**
  153525. * Defines the target frame rate to reach (60 by default)
  153526. */
  153527. targetFrameRate: number;
  153528. /**
  153529. * Defines the interval between two checkes (2000ms by default)
  153530. */
  153531. trackerDuration: number;
  153532. /**
  153533. * Gets the list of optimizations to apply
  153534. */
  153535. optimizations: SceneOptimization[];
  153536. /**
  153537. * Creates a new list of options used by SceneOptimizer
  153538. * @param targetFrameRate defines the target frame rate to reach (60 by default)
  153539. * @param trackerDuration defines the interval between two checkes (2000ms by default)
  153540. */
  153541. constructor(
  153542. /**
  153543. * Defines the target frame rate to reach (60 by default)
  153544. */
  153545. targetFrameRate?: number,
  153546. /**
  153547. * Defines the interval between two checkes (2000ms by default)
  153548. */
  153549. trackerDuration?: number);
  153550. /**
  153551. * Add a new optimization
  153552. * @param optimization defines the SceneOptimization to add to the list of active optimizations
  153553. * @returns the current SceneOptimizerOptions
  153554. */
  153555. addOptimization(optimization: SceneOptimization): SceneOptimizerOptions;
  153556. /**
  153557. * Add a new custom optimization
  153558. * @param onApply defines the callback called to apply the custom optimization (true if everything that can be done was applied)
  153559. * @param onGetDescription defines the callback called to get the description attached with the optimization.
  153560. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  153561. * @returns the current SceneOptimizerOptions
  153562. */
  153563. addCustomOptimization(onApply: (scene: Scene) => boolean, onGetDescription: () => string, priority?: number): SceneOptimizerOptions;
  153564. /**
  153565. * Creates a list of pre-defined optimizations aimed to reduce the visual impact on the scene
  153566. * @param targetFrameRate defines the target frame rate (60 by default)
  153567. * @returns a SceneOptimizerOptions object
  153568. */
  153569. static LowDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  153570. /**
  153571. * Creates a list of pre-defined optimizations aimed to have a moderate impact on the scene visual
  153572. * @param targetFrameRate defines the target frame rate (60 by default)
  153573. * @returns a SceneOptimizerOptions object
  153574. */
  153575. static ModerateDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  153576. /**
  153577. * Creates a list of pre-defined optimizations aimed to have a big impact on the scene visual
  153578. * @param targetFrameRate defines the target frame rate (60 by default)
  153579. * @returns a SceneOptimizerOptions object
  153580. */
  153581. static HighDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  153582. }
  153583. /**
  153584. * Class used to run optimizations in order to reach a target frame rate
  153585. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153586. */
  153587. export class SceneOptimizer implements IDisposable {
  153588. private _isRunning;
  153589. private _options;
  153590. private _scene;
  153591. private _currentPriorityLevel;
  153592. private _targetFrameRate;
  153593. private _trackerDuration;
  153594. private _currentFrameRate;
  153595. private _sceneDisposeObserver;
  153596. private _improvementMode;
  153597. /**
  153598. * Defines an observable called when the optimizer reaches the target frame rate
  153599. */
  153600. onSuccessObservable: Observable<SceneOptimizer>;
  153601. /**
  153602. * Defines an observable called when the optimizer enables an optimization
  153603. */
  153604. onNewOptimizationAppliedObservable: Observable<SceneOptimization>;
  153605. /**
  153606. * Defines an observable called when the optimizer is not able to reach the target frame rate
  153607. */
  153608. onFailureObservable: Observable<SceneOptimizer>;
  153609. /**
  153610. * Gets a boolean indicating if the optimizer is in improvement mode
  153611. */
  153612. get isInImprovementMode(): boolean;
  153613. /**
  153614. * Gets the current priority level (0 at start)
  153615. */
  153616. get currentPriorityLevel(): number;
  153617. /**
  153618. * Gets the current frame rate checked by the SceneOptimizer
  153619. */
  153620. get currentFrameRate(): number;
  153621. /**
  153622. * Gets or sets the current target frame rate (60 by default)
  153623. */
  153624. get targetFrameRate(): number;
  153625. /**
  153626. * Gets or sets the current target frame rate (60 by default)
  153627. */
  153628. set targetFrameRate(value: number);
  153629. /**
  153630. * Gets or sets the current interval between two checks (every 2000ms by default)
  153631. */
  153632. get trackerDuration(): number;
  153633. /**
  153634. * Gets or sets the current interval between two checks (every 2000ms by default)
  153635. */
  153636. set trackerDuration(value: number);
  153637. /**
  153638. * Gets the list of active optimizations
  153639. */
  153640. get optimizations(): SceneOptimization[];
  153641. /**
  153642. * Creates a new SceneOptimizer
  153643. * @param scene defines the scene to work on
  153644. * @param options defines the options to use with the SceneOptimizer
  153645. * @param autoGeneratePriorities defines if priorities must be generated and not read from SceneOptimization property (true by default)
  153646. * @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)
  153647. */
  153648. constructor(scene: Scene, options?: SceneOptimizerOptions, autoGeneratePriorities?: boolean, improvementMode?: boolean);
  153649. /**
  153650. * Stops the current optimizer
  153651. */
  153652. stop(): void;
  153653. /**
  153654. * Reset the optimizer to initial step (current priority level = 0)
  153655. */
  153656. reset(): void;
  153657. /**
  153658. * Start the optimizer. By default it will try to reach a specific framerate
  153659. * but if the optimizer is set with improvementMode === true then it will run all optimiatiation while frame rate is above the target frame rate
  153660. */
  153661. start(): void;
  153662. private _checkCurrentState;
  153663. /**
  153664. * Release all resources
  153665. */
  153666. dispose(): void;
  153667. /**
  153668. * Helper function to create a SceneOptimizer with one single line of code
  153669. * @param scene defines the scene to work on
  153670. * @param options defines the options to use with the SceneOptimizer
  153671. * @param onSuccess defines a callback to call on success
  153672. * @param onFailure defines a callback to call on failure
  153673. * @returns the new SceneOptimizer object
  153674. */
  153675. static OptimizeAsync(scene: Scene, options?: SceneOptimizerOptions, onSuccess?: () => void, onFailure?: () => void): SceneOptimizer;
  153676. }
  153677. }
  153678. declare module BABYLON {
  153679. /**
  153680. * Class used to serialize a scene into a string
  153681. */
  153682. export class SceneSerializer {
  153683. /**
  153684. * Clear cache used by a previous serialization
  153685. */
  153686. static ClearCache(): void;
  153687. /**
  153688. * Serialize a scene into a JSON compatible object
  153689. * @param scene defines the scene to serialize
  153690. * @returns a JSON compatible object
  153691. */
  153692. static Serialize(scene: Scene): any;
  153693. /**
  153694. * Serialize a mesh into a JSON compatible object
  153695. * @param toSerialize defines the mesh to serialize
  153696. * @param withParents defines if parents must be serialized as well
  153697. * @param withChildren defines if children must be serialized as well
  153698. * @returns a JSON compatible object
  153699. */
  153700. static SerializeMesh(toSerialize: any, withParents?: boolean, withChildren?: boolean): any;
  153701. }
  153702. }
  153703. declare module BABYLON {
  153704. /**
  153705. * Class used to host texture specific utilities
  153706. */
  153707. export class TextureTools {
  153708. /**
  153709. * Uses the GPU to create a copy texture rescaled at a given size
  153710. * @param texture Texture to copy from
  153711. * @param width defines the desired width
  153712. * @param height defines the desired height
  153713. * @param useBilinearMode defines if bilinear mode has to be used
  153714. * @return the generated texture
  153715. */
  153716. static CreateResizedCopy(texture: Texture, width: number, height: number, useBilinearMode?: boolean): Texture;
  153717. }
  153718. }
  153719. declare module BABYLON {
  153720. /**
  153721. * This represents the different options available for the video capture.
  153722. */
  153723. export interface VideoRecorderOptions {
  153724. /** Defines the mime type of the video. */
  153725. mimeType: string;
  153726. /** Defines the FPS the video should be recorded at. */
  153727. fps: number;
  153728. /** Defines the chunk size for the recording data. */
  153729. recordChunckSize: number;
  153730. /** The audio tracks to attach to the recording. */
  153731. audioTracks?: MediaStreamTrack[];
  153732. }
  153733. /**
  153734. * This can help with recording videos from BabylonJS.
  153735. * This is based on the available WebRTC functionalities of the browser.
  153736. *
  153737. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_video
  153738. */
  153739. export class VideoRecorder {
  153740. private static readonly _defaultOptions;
  153741. /**
  153742. * Returns whether or not the VideoRecorder is available in your browser.
  153743. * @param engine Defines the Babylon Engine.
  153744. * @returns true if supported otherwise false.
  153745. */
  153746. static IsSupported(engine: Engine): boolean;
  153747. private readonly _options;
  153748. private _canvas;
  153749. private _mediaRecorder;
  153750. private _recordedChunks;
  153751. private _fileName;
  153752. private _resolve;
  153753. private _reject;
  153754. /**
  153755. * True when a recording is already in progress.
  153756. */
  153757. get isRecording(): boolean;
  153758. /**
  153759. * Create a new VideoCapture object which can help converting what you see in Babylon to a video file.
  153760. * @param engine Defines the BabylonJS Engine you wish to record.
  153761. * @param options Defines options that can be used to customize the capture.
  153762. */
  153763. constructor(engine: Engine, options?: Nullable<VideoRecorderOptions>);
  153764. /**
  153765. * Stops the current recording before the default capture timeout passed in the startRecording function.
  153766. */
  153767. stopRecording(): void;
  153768. /**
  153769. * Starts recording the canvas for a max duration specified in parameters.
  153770. * @param fileName Defines the name of the file to be downloaded when the recording stop.
  153771. * If null no automatic download will start and you can rely on the promise to get the data back.
  153772. * @param maxDuration Defines the maximum recording time in seconds.
  153773. * It defaults to 7 seconds. A value of zero will not stop automatically, you would need to call stopRecording manually.
  153774. * @return A promise callback at the end of the recording with the video data in Blob.
  153775. */
  153776. startRecording(fileName?: Nullable<string>, maxDuration?: number): Promise<Blob>;
  153777. /**
  153778. * Releases internal resources used during the recording.
  153779. */
  153780. dispose(): void;
  153781. private _handleDataAvailable;
  153782. private _handleError;
  153783. private _handleStop;
  153784. }
  153785. }
  153786. declare module BABYLON {
  153787. /**
  153788. * Class containing a set of static utilities functions for screenshots
  153789. */
  153790. export class ScreenshotTools {
  153791. /**
  153792. * Captures a screenshot of the current rendering
  153793. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  153794. * @param engine defines the rendering engine
  153795. * @param camera defines the source camera
  153796. * @param size This parameter can be set to a single number or to an object with the
  153797. * following (optional) properties: precision, width, height. If a single number is passed,
  153798. * it will be used for both width and height. If an object is passed, the screenshot size
  153799. * will be derived from the parameters. The precision property is a multiplier allowing
  153800. * rendering at a higher or lower resolution
  153801. * @param successCallback defines the callback receives a single parameter which contains the
  153802. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  153803. * src parameter of an <img> to display it
  153804. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  153805. * Check your browser for supported MIME types
  153806. */
  153807. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  153808. /**
  153809. * Captures a screenshot of the current rendering
  153810. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  153811. * @param engine defines the rendering engine
  153812. * @param camera defines the source camera
  153813. * @param size This parameter can be set to a single number or to an object with the
  153814. * following (optional) properties: precision, width, height. If a single number is passed,
  153815. * it will be used for both width and height. If an object is passed, the screenshot size
  153816. * will be derived from the parameters. The precision property is a multiplier allowing
  153817. * rendering at a higher or lower resolution
  153818. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  153819. * Check your browser for supported MIME types
  153820. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  153821. * to the src parameter of an <img> to display it
  153822. */
  153823. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: any, mimeType?: string): Promise<string>;
  153824. /**
  153825. * Generates an image screenshot from the specified camera.
  153826. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  153827. * @param engine The engine to use for rendering
  153828. * @param camera The camera to use for rendering
  153829. * @param size This parameter can be set to a single number or to an object with the
  153830. * following (optional) properties: precision, width, height. If a single number is passed,
  153831. * it will be used for both width and height. If an object is passed, the screenshot size
  153832. * will be derived from the parameters. The precision property is a multiplier allowing
  153833. * rendering at a higher or lower resolution
  153834. * @param successCallback The callback receives a single parameter which contains the
  153835. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  153836. * src parameter of an <img> to display it
  153837. * @param mimeType The MIME type of the screenshot image (default: image/png).
  153838. * Check your browser for supported MIME types
  153839. * @param samples Texture samples (default: 1)
  153840. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  153841. * @param fileName A name for for the downloaded file.
  153842. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  153843. * @param enableStencilBuffer Whether the stencil buffer should be enabled or not (default: false)
  153844. */
  153845. 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;
  153846. /**
  153847. * Generates an image screenshot from the specified camera.
  153848. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  153849. * @param engine The engine to use for rendering
  153850. * @param camera The camera to use for rendering
  153851. * @param size This parameter can be set to a single number or to an object with the
  153852. * following (optional) properties: precision, width, height. If a single number is passed,
  153853. * it will be used for both width and height. If an object is passed, the screenshot size
  153854. * will be derived from the parameters. The precision property is a multiplier allowing
  153855. * rendering at a higher or lower resolution
  153856. * @param mimeType The MIME type of the screenshot image (default: image/png).
  153857. * Check your browser for supported MIME types
  153858. * @param samples Texture samples (default: 1)
  153859. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  153860. * @param fileName A name for for the downloaded file.
  153861. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  153862. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  153863. * to the src parameter of an <img> to display it
  153864. */
  153865. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: any, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string, renderSprites?: boolean): Promise<string>;
  153866. /**
  153867. * Gets height and width for screenshot size
  153868. * @private
  153869. */
  153870. private static _getScreenshotSize;
  153871. }
  153872. }
  153873. declare module BABYLON {
  153874. /**
  153875. * Interface for a data buffer
  153876. */
  153877. export interface IDataBuffer {
  153878. /**
  153879. * Reads bytes from the data buffer.
  153880. * @param byteOffset The byte offset to read
  153881. * @param byteLength The byte length to read
  153882. * @returns A promise that resolves when the bytes are read
  153883. */
  153884. readAsync(byteOffset: number, byteLength: number): Promise<ArrayBufferView>;
  153885. /**
  153886. * The byte length of the buffer.
  153887. */
  153888. readonly byteLength: number;
  153889. }
  153890. /**
  153891. * Utility class for reading from a data buffer
  153892. */
  153893. export class DataReader {
  153894. /**
  153895. * The data buffer associated with this data reader.
  153896. */
  153897. readonly buffer: IDataBuffer;
  153898. /**
  153899. * The current byte offset from the beginning of the data buffer.
  153900. */
  153901. byteOffset: number;
  153902. private _dataView;
  153903. private _dataByteOffset;
  153904. /**
  153905. * Constructor
  153906. * @param buffer The buffer to read
  153907. */
  153908. constructor(buffer: IDataBuffer);
  153909. /**
  153910. * Loads the given byte length.
  153911. * @param byteLength The byte length to load
  153912. * @returns A promise that resolves when the load is complete
  153913. */
  153914. loadAsync(byteLength: number): Promise<void>;
  153915. /**
  153916. * Read a unsigned 32-bit integer from the currently loaded data range.
  153917. * @returns The 32-bit integer read
  153918. */
  153919. readUint32(): number;
  153920. /**
  153921. * Read a byte array from the currently loaded data range.
  153922. * @param byteLength The byte length to read
  153923. * @returns The byte array read
  153924. */
  153925. readUint8Array(byteLength: number): Uint8Array;
  153926. /**
  153927. * Read a string from the currently loaded data range.
  153928. * @param byteLength The byte length to read
  153929. * @returns The string read
  153930. */
  153931. readString(byteLength: number): string;
  153932. /**
  153933. * Skips the given byte length the currently loaded data range.
  153934. * @param byteLength The byte length to skip
  153935. */
  153936. skipBytes(byteLength: number): void;
  153937. }
  153938. }
  153939. declare module BABYLON {
  153940. /**
  153941. * Class for storing data to local storage if available or in-memory storage otherwise
  153942. */
  153943. export class DataStorage {
  153944. private static _Storage;
  153945. private static _GetStorage;
  153946. /**
  153947. * Reads a string from the data storage
  153948. * @param key The key to read
  153949. * @param defaultValue The value if the key doesn't exist
  153950. * @returns The string value
  153951. */
  153952. static ReadString(key: string, defaultValue: string): string;
  153953. /**
  153954. * Writes a string to the data storage
  153955. * @param key The key to write
  153956. * @param value The value to write
  153957. */
  153958. static WriteString(key: string, value: string): void;
  153959. /**
  153960. * Reads a boolean from the data storage
  153961. * @param key The key to read
  153962. * @param defaultValue The value if the key doesn't exist
  153963. * @returns The boolean value
  153964. */
  153965. static ReadBoolean(key: string, defaultValue: boolean): boolean;
  153966. /**
  153967. * Writes a boolean to the data storage
  153968. * @param key The key to write
  153969. * @param value The value to write
  153970. */
  153971. static WriteBoolean(key: string, value: boolean): void;
  153972. /**
  153973. * Reads a number from the data storage
  153974. * @param key The key to read
  153975. * @param defaultValue The value if the key doesn't exist
  153976. * @returns The number value
  153977. */
  153978. static ReadNumber(key: string, defaultValue: number): number;
  153979. /**
  153980. * Writes a number to the data storage
  153981. * @param key The key to write
  153982. * @param value The value to write
  153983. */
  153984. static WriteNumber(key: string, value: number): void;
  153985. }
  153986. }
  153987. declare module BABYLON {
  153988. /**
  153989. * Class used to record delta files between 2 scene states
  153990. */
  153991. export class SceneRecorder {
  153992. private _trackedScene;
  153993. private _savedJSON;
  153994. /**
  153995. * Track a given scene. This means the current scene state will be considered the original state
  153996. * @param scene defines the scene to track
  153997. */
  153998. track(scene: Scene): void;
  153999. /**
  154000. * Get the delta between current state and original state
  154001. * @returns a string containing the delta
  154002. */
  154003. getDelta(): any;
  154004. private _compareArray;
  154005. private _compareObjects;
  154006. private _compareCollections;
  154007. private static GetShadowGeneratorById;
  154008. /**
  154009. * Apply a given delta to a given scene
  154010. * @param deltaJSON defines the JSON containing the delta
  154011. * @param scene defines the scene to apply the delta to
  154012. */
  154013. static ApplyDelta(deltaJSON: any | string, scene: Scene): void;
  154014. private static _ApplyPropertiesToEntity;
  154015. private static _ApplyDeltaForEntity;
  154016. }
  154017. }
  154018. declare module BABYLON {
  154019. /**
  154020. * An interface for all Hit test features
  154021. */
  154022. export interface IWebXRHitTestFeature<T extends IWebXRLegacyHitResult> extends IWebXRFeature {
  154023. /**
  154024. * Triggered when new babylon (transformed) hit test results are available
  154025. */
  154026. onHitTestResultObservable: Observable<T[]>;
  154027. }
  154028. /**
  154029. * Options used for hit testing
  154030. */
  154031. export interface IWebXRLegacyHitTestOptions {
  154032. /**
  154033. * Only test when user interacted with the scene. Default - hit test every frame
  154034. */
  154035. testOnPointerDownOnly?: boolean;
  154036. /**
  154037. * The node to use to transform the local results to world coordinates
  154038. */
  154039. worldParentNode?: TransformNode;
  154040. }
  154041. /**
  154042. * Interface defining the babylon result of raycasting/hit-test
  154043. */
  154044. export interface IWebXRLegacyHitResult {
  154045. /**
  154046. * Transformation matrix that can be applied to a node that will put it in the hit point location
  154047. */
  154048. transformationMatrix: Matrix;
  154049. /**
  154050. * The native hit test result
  154051. */
  154052. xrHitResult: XRHitResult | XRHitTestResult;
  154053. }
  154054. /**
  154055. * The currently-working hit-test module.
  154056. * Hit test (or Ray-casting) is used to interact with the real world.
  154057. * For further information read here - https://github.com/immersive-web/hit-test
  154058. */
  154059. export class WebXRHitTestLegacy extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRLegacyHitResult> {
  154060. /**
  154061. * options to use when constructing this feature
  154062. */
  154063. readonly options: IWebXRLegacyHitTestOptions;
  154064. private _direction;
  154065. private _mat;
  154066. private _onSelectEnabled;
  154067. private _origin;
  154068. /**
  154069. * The module's name
  154070. */
  154071. static readonly Name: string;
  154072. /**
  154073. * The (Babylon) version of this module.
  154074. * This is an integer representing the implementation version.
  154075. * This number does not correspond to the WebXR specs version
  154076. */
  154077. static readonly Version: number;
  154078. /**
  154079. * Populated with the last native XR Hit Results
  154080. */
  154081. lastNativeXRHitResults: XRHitResult[];
  154082. /**
  154083. * Triggered when new babylon (transformed) hit test results are available
  154084. */
  154085. onHitTestResultObservable: Observable<IWebXRLegacyHitResult[]>;
  154086. /**
  154087. * Creates a new instance of the (legacy version) hit test feature
  154088. * @param _xrSessionManager an instance of WebXRSessionManager
  154089. * @param options options to use when constructing this feature
  154090. */
  154091. constructor(_xrSessionManager: WebXRSessionManager,
  154092. /**
  154093. * options to use when constructing this feature
  154094. */
  154095. options?: IWebXRLegacyHitTestOptions);
  154096. /**
  154097. * execute a hit test with an XR Ray
  154098. *
  154099. * @param xrSession a native xrSession that will execute this hit test
  154100. * @param xrRay the ray (position and direction) to use for ray-casting
  154101. * @param referenceSpace native XR reference space to use for the hit-test
  154102. * @param filter filter function that will filter the results
  154103. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  154104. */
  154105. static XRHitTestWithRay(xrSession: XRSession, xrRay: XRRay, referenceSpace: XRReferenceSpace, filter?: (result: XRHitResult) => boolean): Promise<XRHitResult[]>;
  154106. /**
  154107. * Execute a hit test on the current running session using a select event returned from a transient input (such as touch)
  154108. * @param event the (select) event to use to select with
  154109. * @param referenceSpace the reference space to use for this hit test
  154110. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  154111. */
  154112. static XRHitTestWithSelectEvent(event: XRInputSourceEvent, referenceSpace: XRReferenceSpace): Promise<XRHitResult[]>;
  154113. /**
  154114. * attach this feature
  154115. * Will usually be called by the features manager
  154116. *
  154117. * @returns true if successful.
  154118. */
  154119. attach(): boolean;
  154120. /**
  154121. * detach this feature.
  154122. * Will usually be called by the features manager
  154123. *
  154124. * @returns true if successful.
  154125. */
  154126. detach(): boolean;
  154127. /**
  154128. * Dispose this feature and all of the resources attached
  154129. */
  154130. dispose(): void;
  154131. protected _onXRFrame(frame: XRFrame): void;
  154132. private _onHitTestResults;
  154133. private _onSelect;
  154134. }
  154135. }
  154136. declare module BABYLON {
  154137. /**
  154138. * Options used for hit testing (version 2)
  154139. */
  154140. export interface IWebXRHitTestOptions extends IWebXRLegacyHitTestOptions {
  154141. /**
  154142. * Do not create a permanent hit test. Will usually be used when only
  154143. * transient inputs are needed.
  154144. */
  154145. disablePermanentHitTest?: boolean;
  154146. /**
  154147. * Enable transient (for example touch-based) hit test inspections
  154148. */
  154149. enableTransientHitTest?: boolean;
  154150. /**
  154151. * Offset ray for the permanent hit test
  154152. */
  154153. offsetRay?: Vector3;
  154154. /**
  154155. * Offset ray for the transient hit test
  154156. */
  154157. transientOffsetRay?: Vector3;
  154158. /**
  154159. * Instead of using viewer space for hit tests, use the reference space defined in the session manager
  154160. */
  154161. useReferenceSpace?: boolean;
  154162. /**
  154163. * Override the default entity type(s) of the hit-test result
  154164. */
  154165. entityTypes?: XRHitTestTrackableType[];
  154166. }
  154167. /**
  154168. * Interface defining the babylon result of hit-test
  154169. */
  154170. export interface IWebXRHitResult extends IWebXRLegacyHitResult {
  154171. /**
  154172. * The input source that generated this hit test (if transient)
  154173. */
  154174. inputSource?: XRInputSource;
  154175. /**
  154176. * Is this a transient hit test
  154177. */
  154178. isTransient?: boolean;
  154179. /**
  154180. * Position of the hit test result
  154181. */
  154182. position: Vector3;
  154183. /**
  154184. * Rotation of the hit test result
  154185. */
  154186. rotationQuaternion: Quaternion;
  154187. /**
  154188. * The native hit test result
  154189. */
  154190. xrHitResult: XRHitTestResult;
  154191. }
  154192. /**
  154193. * The currently-working hit-test module.
  154194. * Hit test (or Ray-casting) is used to interact with the real world.
  154195. * For further information read here - https://github.com/immersive-web/hit-test
  154196. *
  154197. * Tested on chrome (mobile) 80.
  154198. */
  154199. export class WebXRHitTest extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRHitResult> {
  154200. /**
  154201. * options to use when constructing this feature
  154202. */
  154203. readonly options: IWebXRHitTestOptions;
  154204. private _tmpMat;
  154205. private _tmpPos;
  154206. private _tmpQuat;
  154207. private _transientXrHitTestSource;
  154208. private _xrHitTestSource;
  154209. private initHitTestSource;
  154210. /**
  154211. * The module's name
  154212. */
  154213. static readonly Name: string;
  154214. /**
  154215. * The (Babylon) version of this module.
  154216. * This is an integer representing the implementation version.
  154217. * This number does not correspond to the WebXR specs version
  154218. */
  154219. static readonly Version: number;
  154220. /**
  154221. * When set to true, each hit test will have its own position/rotation objects
  154222. * When set to false, position and rotation objects will be reused for each hit test. It is expected that
  154223. * the developers will clone them or copy them as they see fit.
  154224. */
  154225. autoCloneTransformation: boolean;
  154226. /**
  154227. * Triggered when new babylon (transformed) hit test results are available
  154228. */
  154229. onHitTestResultObservable: Observable<IWebXRHitResult[]>;
  154230. /**
  154231. * Use this to temporarily pause hit test checks.
  154232. */
  154233. paused: boolean;
  154234. /**
  154235. * Creates a new instance of the hit test feature
  154236. * @param _xrSessionManager an instance of WebXRSessionManager
  154237. * @param options options to use when constructing this feature
  154238. */
  154239. constructor(_xrSessionManager: WebXRSessionManager,
  154240. /**
  154241. * options to use when constructing this feature
  154242. */
  154243. options?: IWebXRHitTestOptions);
  154244. /**
  154245. * attach this feature
  154246. * Will usually be called by the features manager
  154247. *
  154248. * @returns true if successful.
  154249. */
  154250. attach(): boolean;
  154251. /**
  154252. * detach this feature.
  154253. * Will usually be called by the features manager
  154254. *
  154255. * @returns true if successful.
  154256. */
  154257. detach(): boolean;
  154258. /**
  154259. * Dispose this feature and all of the resources attached
  154260. */
  154261. dispose(): void;
  154262. protected _onXRFrame(frame: XRFrame): void;
  154263. private _processWebXRHitTestResult;
  154264. }
  154265. }
  154266. declare module BABYLON {
  154267. /**
  154268. * Configuration options of the anchor system
  154269. */
  154270. export interface IWebXRAnchorSystemOptions {
  154271. /**
  154272. * a node that will be used to convert local to world coordinates
  154273. */
  154274. worldParentNode?: TransformNode;
  154275. /**
  154276. * If set to true a reference of the created anchors will be kept until the next session starts
  154277. * If not defined, anchors will be removed from the array when the feature is detached or the session ended.
  154278. */
  154279. doNotRemoveAnchorsOnSessionEnded?: boolean;
  154280. }
  154281. /**
  154282. * A babylon container for an XR Anchor
  154283. */
  154284. export interface IWebXRAnchor {
  154285. /**
  154286. * A babylon-assigned ID for this anchor
  154287. */
  154288. id: number;
  154289. /**
  154290. * Transformation matrix to apply to an object attached to this anchor
  154291. */
  154292. transformationMatrix: Matrix;
  154293. /**
  154294. * The native anchor object
  154295. */
  154296. xrAnchor: XRAnchor;
  154297. /**
  154298. * if defined, this object will be constantly updated by the anchor's position and rotation
  154299. */
  154300. attachedNode?: TransformNode;
  154301. }
  154302. /**
  154303. * An implementation of the anchor system for WebXR.
  154304. * For further information see https://github.com/immersive-web/anchors/
  154305. */
  154306. export class WebXRAnchorSystem extends WebXRAbstractFeature {
  154307. private _options;
  154308. private _lastFrameDetected;
  154309. private _trackedAnchors;
  154310. private _referenceSpaceForFrameAnchors;
  154311. private _futureAnchors;
  154312. /**
  154313. * The module's name
  154314. */
  154315. static readonly Name: string;
  154316. /**
  154317. * The (Babylon) version of this module.
  154318. * This is an integer representing the implementation version.
  154319. * This number does not correspond to the WebXR specs version
  154320. */
  154321. static readonly Version: number;
  154322. /**
  154323. * Observers registered here will be executed when a new anchor was added to the session
  154324. */
  154325. onAnchorAddedObservable: Observable<IWebXRAnchor>;
  154326. /**
  154327. * Observers registered here will be executed when an anchor was removed from the session
  154328. */
  154329. onAnchorRemovedObservable: Observable<IWebXRAnchor>;
  154330. /**
  154331. * Observers registered here will be executed when an existing anchor updates
  154332. * This can execute N times every frame
  154333. */
  154334. onAnchorUpdatedObservable: Observable<IWebXRAnchor>;
  154335. /**
  154336. * Set the reference space to use for anchor creation, when not using a hit test.
  154337. * Will default to the session's reference space if not defined
  154338. */
  154339. set referenceSpaceForFrameAnchors(referenceSpace: XRReferenceSpace);
  154340. /**
  154341. * constructs a new anchor system
  154342. * @param _xrSessionManager an instance of WebXRSessionManager
  154343. * @param _options configuration object for this feature
  154344. */
  154345. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRAnchorSystemOptions);
  154346. private _tmpVector;
  154347. private _tmpQuaternion;
  154348. private _populateTmpTransformation;
  154349. /**
  154350. * Create a new anchor point using a hit test result at a specific point in the scene
  154351. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  154352. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  154353. *
  154354. * @param hitTestResult The hit test result to use for this anchor creation
  154355. * @param position an optional position offset for this anchor
  154356. * @param rotationQuaternion an optional rotation offset for this anchor
  154357. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  154358. */
  154359. addAnchorPointUsingHitTestResultAsync(hitTestResult: IWebXRHitResult, position?: Vector3, rotationQuaternion?: Quaternion): Promise<XRAnchor>;
  154360. /**
  154361. * Add a new anchor at a specific position and rotation
  154362. * This function will add a new anchor per default in the next available frame. Unless forced, the createAnchor function
  154363. * will be called in the next xrFrame loop to make sure that the anchor can be created correctly.
  154364. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  154365. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  154366. *
  154367. * @param position the position in which to add an anchor
  154368. * @param rotationQuaternion an optional rotation for the anchor transformation
  154369. * @param forceCreateInCurrentFrame force the creation of this anchor in the current frame. Must be called inside xrFrame loop!
  154370. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  154371. */
  154372. addAnchorAtPositionAndRotationAsync(position: Vector3, rotationQuaternion?: Quaternion, forceCreateInCurrentFrame?: boolean): Promise<XRAnchor>;
  154373. /**
  154374. * detach this feature.
  154375. * Will usually be called by the features manager
  154376. *
  154377. * @returns true if successful.
  154378. */
  154379. detach(): boolean;
  154380. /**
  154381. * Dispose this feature and all of the resources attached
  154382. */
  154383. dispose(): void;
  154384. protected _onXRFrame(frame: XRFrame): void;
  154385. /**
  154386. * avoiding using Array.find for global support.
  154387. * @param xrAnchor the plane to find in the array
  154388. */
  154389. private _findIndexInAnchorArray;
  154390. private _updateAnchorWithXRFrame;
  154391. private _createAnchorAtTransformation;
  154392. }
  154393. }
  154394. declare module BABYLON {
  154395. /**
  154396. * Options used in the plane detector module
  154397. */
  154398. export interface IWebXRPlaneDetectorOptions {
  154399. /**
  154400. * The node to use to transform the local results to world coordinates
  154401. */
  154402. worldParentNode?: TransformNode;
  154403. /**
  154404. * If set to true a reference of the created planes will be kept until the next session starts
  154405. * If not defined, planes will be removed from the array when the feature is detached or the session ended.
  154406. */
  154407. doNotRemovePlanesOnSessionEnded?: boolean;
  154408. }
  154409. /**
  154410. * A babylon interface for a WebXR plane.
  154411. * A Plane is actually a polygon, built from N points in space
  154412. *
  154413. * Supported in chrome 79, not supported in canary 81 ATM
  154414. */
  154415. export interface IWebXRPlane {
  154416. /**
  154417. * a babylon-assigned ID for this polygon
  154418. */
  154419. id: number;
  154420. /**
  154421. * an array of vector3 points in babylon space. right/left hand system is taken into account.
  154422. */
  154423. polygonDefinition: Array<Vector3>;
  154424. /**
  154425. * A transformation matrix to apply on the mesh that will be built using the polygonDefinition
  154426. * Local vs. World are decided if worldParentNode was provided or not in the options when constructing the module
  154427. */
  154428. transformationMatrix: Matrix;
  154429. /**
  154430. * the native xr-plane object
  154431. */
  154432. xrPlane: XRPlane;
  154433. }
  154434. /**
  154435. * The plane detector is used to detect planes in the real world when in AR
  154436. * For more information see https://github.com/immersive-web/real-world-geometry/
  154437. */
  154438. export class WebXRPlaneDetector extends WebXRAbstractFeature {
  154439. private _options;
  154440. private _detectedPlanes;
  154441. private _enabled;
  154442. private _lastFrameDetected;
  154443. /**
  154444. * The module's name
  154445. */
  154446. static readonly Name: string;
  154447. /**
  154448. * The (Babylon) version of this module.
  154449. * This is an integer representing the implementation version.
  154450. * This number does not correspond to the WebXR specs version
  154451. */
  154452. static readonly Version: number;
  154453. /**
  154454. * Observers registered here will be executed when a new plane was added to the session
  154455. */
  154456. onPlaneAddedObservable: Observable<IWebXRPlane>;
  154457. /**
  154458. * Observers registered here will be executed when a plane is no longer detected in the session
  154459. */
  154460. onPlaneRemovedObservable: Observable<IWebXRPlane>;
  154461. /**
  154462. * Observers registered here will be executed when an existing plane updates (for example - expanded)
  154463. * This can execute N times every frame
  154464. */
  154465. onPlaneUpdatedObservable: Observable<IWebXRPlane>;
  154466. /**
  154467. * construct a new Plane Detector
  154468. * @param _xrSessionManager an instance of xr Session manager
  154469. * @param _options configuration to use when constructing this feature
  154470. */
  154471. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRPlaneDetectorOptions);
  154472. /**
  154473. * detach this feature.
  154474. * Will usually be called by the features manager
  154475. *
  154476. * @returns true if successful.
  154477. */
  154478. detach(): boolean;
  154479. /**
  154480. * Dispose this feature and all of the resources attached
  154481. */
  154482. dispose(): void;
  154483. protected _onXRFrame(frame: XRFrame): void;
  154484. private _init;
  154485. private _updatePlaneWithXRPlane;
  154486. /**
  154487. * avoiding using Array.find for global support.
  154488. * @param xrPlane the plane to find in the array
  154489. */
  154490. private findIndexInPlaneArray;
  154491. }
  154492. }
  154493. declare module BABYLON {
  154494. /**
  154495. * Options interface for the background remover plugin
  154496. */
  154497. export interface IWebXRBackgroundRemoverOptions {
  154498. /**
  154499. * Further background meshes to disable when entering AR
  154500. */
  154501. backgroundMeshes?: AbstractMesh[];
  154502. /**
  154503. * flags to configure the removal of the environment helper.
  154504. * If not set, the entire background will be removed. If set, flags should be set as well.
  154505. */
  154506. environmentHelperRemovalFlags?: {
  154507. /**
  154508. * Should the skybox be removed (default false)
  154509. */
  154510. skyBox?: boolean;
  154511. /**
  154512. * Should the ground be removed (default false)
  154513. */
  154514. ground?: boolean;
  154515. };
  154516. /**
  154517. * don't disable the environment helper
  154518. */
  154519. ignoreEnvironmentHelper?: boolean;
  154520. }
  154521. /**
  154522. * A module that will automatically disable background meshes when entering AR and will enable them when leaving AR.
  154523. */
  154524. export class WebXRBackgroundRemover extends WebXRAbstractFeature {
  154525. /**
  154526. * read-only options to be used in this module
  154527. */
  154528. readonly options: IWebXRBackgroundRemoverOptions;
  154529. /**
  154530. * The module's name
  154531. */
  154532. static readonly Name: string;
  154533. /**
  154534. * The (Babylon) version of this module.
  154535. * This is an integer representing the implementation version.
  154536. * This number does not correspond to the WebXR specs version
  154537. */
  154538. static readonly Version: number;
  154539. /**
  154540. * registered observers will be triggered when the background state changes
  154541. */
  154542. onBackgroundStateChangedObservable: Observable<boolean>;
  154543. /**
  154544. * constructs a new background remover module
  154545. * @param _xrSessionManager the session manager for this module
  154546. * @param options read-only options to be used in this module
  154547. */
  154548. constructor(_xrSessionManager: WebXRSessionManager,
  154549. /**
  154550. * read-only options to be used in this module
  154551. */
  154552. options?: IWebXRBackgroundRemoverOptions);
  154553. /**
  154554. * attach this feature
  154555. * Will usually be called by the features manager
  154556. *
  154557. * @returns true if successful.
  154558. */
  154559. attach(): boolean;
  154560. /**
  154561. * detach this feature.
  154562. * Will usually be called by the features manager
  154563. *
  154564. * @returns true if successful.
  154565. */
  154566. detach(): boolean;
  154567. /**
  154568. * Dispose this feature and all of the resources attached
  154569. */
  154570. dispose(): void;
  154571. protected _onXRFrame(_xrFrame: XRFrame): void;
  154572. private _setBackgroundState;
  154573. }
  154574. }
  154575. declare module BABYLON {
  154576. /**
  154577. * Options for the controller physics feature
  154578. */
  154579. export class IWebXRControllerPhysicsOptions {
  154580. /**
  154581. * Should the headset get its own impostor
  154582. */
  154583. enableHeadsetImpostor?: boolean;
  154584. /**
  154585. * Optional parameters for the headset impostor
  154586. */
  154587. headsetImpostorParams?: {
  154588. /**
  154589. * The type of impostor to create. Default is sphere
  154590. */
  154591. impostorType: number;
  154592. /**
  154593. * the size of the impostor. Defaults to 10cm
  154594. */
  154595. impostorSize?: number | {
  154596. width: number;
  154597. height: number;
  154598. depth: number;
  154599. };
  154600. /**
  154601. * Friction definitions
  154602. */
  154603. friction?: number;
  154604. /**
  154605. * Restitution
  154606. */
  154607. restitution?: number;
  154608. };
  154609. /**
  154610. * The physics properties of the future impostors
  154611. */
  154612. physicsProperties?: {
  154613. /**
  154614. * If set to true, a mesh impostor will be created when the controller mesh was loaded
  154615. * Note that this requires a physics engine that supports mesh impostors!
  154616. */
  154617. useControllerMesh?: boolean;
  154618. /**
  154619. * The type of impostor to create. Default is sphere
  154620. */
  154621. impostorType?: number;
  154622. /**
  154623. * the size of the impostor. Defaults to 10cm
  154624. */
  154625. impostorSize?: number | {
  154626. width: number;
  154627. height: number;
  154628. depth: number;
  154629. };
  154630. /**
  154631. * Friction definitions
  154632. */
  154633. friction?: number;
  154634. /**
  154635. * Restitution
  154636. */
  154637. restitution?: number;
  154638. };
  154639. /**
  154640. * the xr input to use with this pointer selection
  154641. */
  154642. xrInput: WebXRInput;
  154643. }
  154644. /**
  154645. * Add physics impostor to your webxr controllers,
  154646. * including naive calculation of their linear and angular velocity
  154647. */
  154648. export class WebXRControllerPhysics extends WebXRAbstractFeature {
  154649. private readonly _options;
  154650. private _attachController;
  154651. private _controllers;
  154652. private _debugMode;
  154653. private _delta;
  154654. private _headsetImpostor?;
  154655. private _headsetMesh?;
  154656. private _lastTimestamp;
  154657. private _tmpQuaternion;
  154658. private _tmpVector;
  154659. /**
  154660. * The module's name
  154661. */
  154662. static readonly Name: string;
  154663. /**
  154664. * The (Babylon) version of this module.
  154665. * This is an integer representing the implementation version.
  154666. * This number does not correspond to the webxr specs version
  154667. */
  154668. static readonly Version: number;
  154669. /**
  154670. * Construct a new Controller Physics Feature
  154671. * @param _xrSessionManager the corresponding xr session manager
  154672. * @param _options options to create this feature with
  154673. */
  154674. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPhysicsOptions);
  154675. /**
  154676. * @hidden
  154677. * enable debugging - will show console outputs and the impostor mesh
  154678. */
  154679. _enablePhysicsDebug(): void;
  154680. /**
  154681. * Manually add a controller (if no xrInput was provided or physics engine was not enabled)
  154682. * @param xrController the controller to add
  154683. */
  154684. addController(xrController: WebXRInputSource): void;
  154685. /**
  154686. * attach this feature
  154687. * Will usually be called by the features manager
  154688. *
  154689. * @returns true if successful.
  154690. */
  154691. attach(): boolean;
  154692. /**
  154693. * detach this feature.
  154694. * Will usually be called by the features manager
  154695. *
  154696. * @returns true if successful.
  154697. */
  154698. detach(): boolean;
  154699. /**
  154700. * Get the headset impostor, if enabled
  154701. * @returns the impostor
  154702. */
  154703. getHeadsetImpostor(): PhysicsImpostor | undefined;
  154704. /**
  154705. * Get the physics impostor of a specific controller.
  154706. * The impostor is not attached to a mesh because a mesh for each controller is not obligatory
  154707. * @param controller the controller or the controller id of which to get the impostor
  154708. * @returns the impostor or null
  154709. */
  154710. getImpostorForController(controller: WebXRInputSource | string): Nullable<PhysicsImpostor>;
  154711. /**
  154712. * Update the physics properties provided in the constructor
  154713. * @param newProperties the new properties object
  154714. */
  154715. setPhysicsProperties(newProperties: {
  154716. impostorType?: number;
  154717. impostorSize?: number | {
  154718. width: number;
  154719. height: number;
  154720. depth: number;
  154721. };
  154722. friction?: number;
  154723. restitution?: number;
  154724. }): void;
  154725. protected _onXRFrame(_xrFrame: any): void;
  154726. private _detachController;
  154727. }
  154728. }
  154729. declare module BABYLON {
  154730. /**
  154731. * A babylon interface for a "WebXR" feature point.
  154732. * Represents the position and confidence value of a given feature point.
  154733. */
  154734. export interface IWebXRFeaturePoint {
  154735. /**
  154736. * Represents the position of the feature point in world space.
  154737. */
  154738. position: Vector3;
  154739. /**
  154740. * Represents the confidence value of the feature point in world space. 0 being least confident, and 1 being most confident.
  154741. */
  154742. confidenceValue: number;
  154743. }
  154744. /**
  154745. * The feature point system is used to detect feature points from real world geometry.
  154746. * This feature is currently experimental and only supported on BabylonNative, and should not be used in the browser.
  154747. * The newly introduced API can be seen in webxr.nativeextensions.d.ts and described in FeaturePoints.md.
  154748. */
  154749. export class WebXRFeaturePointSystem extends WebXRAbstractFeature {
  154750. private _enabled;
  154751. private _featurePointCloud;
  154752. /**
  154753. * The module's name
  154754. */
  154755. static readonly Name: string;
  154756. /**
  154757. * The (Babylon) version of this module.
  154758. * This is an integer representing the implementation version.
  154759. * This number does not correspond to the WebXR specs version
  154760. */
  154761. static readonly Version: number;
  154762. /**
  154763. * Observers registered here will be executed whenever new feature points are added (on XRFrame while the session is tracking).
  154764. * Will notify the observers about which feature points have been added.
  154765. */
  154766. readonly onFeaturePointsAddedObservable: Observable<number[]>;
  154767. /**
  154768. * Observers registered here will be executed whenever a feature point has been updated (on XRFrame while the session is tracking).
  154769. * Will notify the observers about which feature points have been updated.
  154770. */
  154771. readonly onFeaturePointsUpdatedObservable: Observable<number[]>;
  154772. /**
  154773. * The current feature point cloud maintained across frames.
  154774. */
  154775. get featurePointCloud(): Array<IWebXRFeaturePoint>;
  154776. /**
  154777. * construct the feature point system
  154778. * @param _xrSessionManager an instance of xr Session manager
  154779. */
  154780. constructor(_xrSessionManager: WebXRSessionManager);
  154781. /**
  154782. * Detach this feature.
  154783. * Will usually be called by the features manager
  154784. *
  154785. * @returns true if successful.
  154786. */
  154787. detach(): boolean;
  154788. /**
  154789. * Dispose this feature and all of the resources attached
  154790. */
  154791. dispose(): void;
  154792. /**
  154793. * On receiving a new XR frame if this feature is attached notify observers new feature point data is available.
  154794. */
  154795. protected _onXRFrame(frame: XRFrame): void;
  154796. /**
  154797. * Initializes the feature. If the feature point feature is not available for this environment do not mark the feature as enabled.
  154798. */
  154799. private _init;
  154800. }
  154801. }
  154802. declare module BABYLON {
  154803. /**
  154804. * Configuration interface for the hand tracking feature
  154805. */
  154806. export interface IWebXRHandTrackingOptions {
  154807. /**
  154808. * The xrInput that will be used as source for new hands
  154809. */
  154810. xrInput: WebXRInput;
  154811. /**
  154812. * Configuration object for the joint meshes
  154813. */
  154814. jointMeshes?: {
  154815. /**
  154816. * Should the meshes created be invisible (defaults to false)
  154817. */
  154818. invisible?: boolean;
  154819. /**
  154820. * A source mesh to be used to create instances. Defaults to a sphere.
  154821. * This mesh will be the source for all other (25) meshes.
  154822. * It should have the general size of a single unit, as the instances will be scaled according to the provided radius
  154823. */
  154824. sourceMesh?: Mesh;
  154825. /**
  154826. * Should the source mesh stay visible. Defaults to false
  154827. */
  154828. keepOriginalVisible?: boolean;
  154829. /**
  154830. * Scale factor for all instances (defaults to 2)
  154831. */
  154832. scaleFactor?: number;
  154833. /**
  154834. * Should each instance have its own physics impostor
  154835. */
  154836. enablePhysics?: boolean;
  154837. /**
  154838. * If enabled, override default physics properties
  154839. */
  154840. physicsProps?: {
  154841. friction?: number;
  154842. restitution?: number;
  154843. impostorType?: number;
  154844. };
  154845. /**
  154846. * For future use - a single hand-mesh that will be updated according to the XRHand data provided
  154847. */
  154848. handMesh?: AbstractMesh;
  154849. };
  154850. }
  154851. /**
  154852. * Parts of the hands divided to writs and finger names
  154853. */
  154854. export const enum HandPart {
  154855. /**
  154856. * HandPart - Wrist
  154857. */
  154858. WRIST = "wrist",
  154859. /**
  154860. * HandPart - The THumb
  154861. */
  154862. THUMB = "thumb",
  154863. /**
  154864. * HandPart - Index finger
  154865. */
  154866. INDEX = "index",
  154867. /**
  154868. * HandPart - Middle finger
  154869. */
  154870. MIDDLE = "middle",
  154871. /**
  154872. * HandPart - Ring finger
  154873. */
  154874. RING = "ring",
  154875. /**
  154876. * HandPart - Little finger
  154877. */
  154878. LITTLE = "little"
  154879. }
  154880. /**
  154881. * Representing a single hand (with its corresponding native XRHand object)
  154882. */
  154883. export class WebXRHand implements IDisposable {
  154884. /** the controller to which the hand correlates */
  154885. readonly xrController: WebXRInputSource;
  154886. /** the meshes to be used to track the hand joints */
  154887. readonly trackedMeshes: AbstractMesh[];
  154888. /**
  154889. * Hand-parts definition (key is HandPart)
  154890. */
  154891. handPartsDefinition: {
  154892. [key: string]: number[];
  154893. };
  154894. /**
  154895. * Populate the HandPartsDefinition object.
  154896. * This is called as a side effect since certain browsers don't have XRHand defined.
  154897. */
  154898. private generateHandPartsDefinition;
  154899. /**
  154900. * Construct a new hand object
  154901. * @param xrController the controller to which the hand correlates
  154902. * @param trackedMeshes the meshes to be used to track the hand joints
  154903. */
  154904. constructor(
  154905. /** the controller to which the hand correlates */
  154906. xrController: WebXRInputSource,
  154907. /** the meshes to be used to track the hand joints */
  154908. trackedMeshes: AbstractMesh[]);
  154909. /**
  154910. * Update this hand from the latest xr frame
  154911. * @param xrFrame xrFrame to update from
  154912. * @param referenceSpace The current viewer reference space
  154913. * @param scaleFactor optional scale factor for the meshes
  154914. */
  154915. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace, scaleFactor?: number): void;
  154916. /**
  154917. * Get meshes of part of the hand
  154918. * @param part the part of hand to get
  154919. * @returns An array of meshes that correlate to the hand part requested
  154920. */
  154921. getHandPartMeshes(part: HandPart): AbstractMesh[];
  154922. /**
  154923. * Dispose this Hand object
  154924. */
  154925. dispose(): void;
  154926. }
  154927. /**
  154928. * WebXR Hand Joint tracking feature, available for selected browsers and devices
  154929. */
  154930. export class WebXRHandTracking extends WebXRAbstractFeature {
  154931. /**
  154932. * options to use when constructing this feature
  154933. */
  154934. readonly options: IWebXRHandTrackingOptions;
  154935. private static _idCounter;
  154936. /**
  154937. * The module's name
  154938. */
  154939. static readonly Name: string;
  154940. /**
  154941. * The (Babylon) version of this module.
  154942. * This is an integer representing the implementation version.
  154943. * This number does not correspond to the WebXR specs version
  154944. */
  154945. static readonly Version: number;
  154946. /**
  154947. * This observable will notify registered observers when a new hand object was added and initialized
  154948. */
  154949. onHandAddedObservable: Observable<WebXRHand>;
  154950. /**
  154951. * This observable will notify its observers right before the hand object is disposed
  154952. */
  154953. onHandRemovedObservable: Observable<WebXRHand>;
  154954. private _hands;
  154955. /**
  154956. * Creates a new instance of the hit test feature
  154957. * @param _xrSessionManager an instance of WebXRSessionManager
  154958. * @param options options to use when constructing this feature
  154959. */
  154960. constructor(_xrSessionManager: WebXRSessionManager,
  154961. /**
  154962. * options to use when constructing this feature
  154963. */
  154964. options: IWebXRHandTrackingOptions);
  154965. /**
  154966. * Check if the needed objects are defined.
  154967. * This does not mean that the feature is enabled, but that the objects needed are well defined.
  154968. */
  154969. isCompatible(): boolean;
  154970. /**
  154971. * attach this feature
  154972. * Will usually be called by the features manager
  154973. *
  154974. * @returns true if successful.
  154975. */
  154976. attach(): boolean;
  154977. /**
  154978. * detach this feature.
  154979. * Will usually be called by the features manager
  154980. *
  154981. * @returns true if successful.
  154982. */
  154983. detach(): boolean;
  154984. /**
  154985. * Dispose this feature and all of the resources attached
  154986. */
  154987. dispose(): void;
  154988. /**
  154989. * Get the hand object according to the controller id
  154990. * @param controllerId the controller id to which we want to get the hand
  154991. * @returns null if not found or the WebXRHand object if found
  154992. */
  154993. getHandByControllerId(controllerId: string): Nullable<WebXRHand>;
  154994. /**
  154995. * Get a hand object according to the requested handedness
  154996. * @param handedness the handedness to request
  154997. * @returns null if not found or the WebXRHand object if found
  154998. */
  154999. getHandByHandedness(handedness: XRHandedness): Nullable<WebXRHand>;
  155000. protected _onXRFrame(_xrFrame: XRFrame): void;
  155001. private _attachHand;
  155002. private _detachHand;
  155003. }
  155004. }
  155005. declare module BABYLON {
  155006. /**
  155007. * The motion controller class for all microsoft mixed reality controllers
  155008. */
  155009. export class WebXRMicrosoftMixedRealityController extends WebXRAbstractMotionController {
  155010. protected readonly _mapping: {
  155011. defaultButton: {
  155012. valueNodeName: string;
  155013. unpressedNodeName: string;
  155014. pressedNodeName: string;
  155015. };
  155016. defaultAxis: {
  155017. valueNodeName: string;
  155018. minNodeName: string;
  155019. maxNodeName: string;
  155020. };
  155021. buttons: {
  155022. "xr-standard-trigger": {
  155023. rootNodeName: string;
  155024. componentProperty: string;
  155025. states: string[];
  155026. };
  155027. "xr-standard-squeeze": {
  155028. rootNodeName: string;
  155029. componentProperty: string;
  155030. states: string[];
  155031. };
  155032. "xr-standard-touchpad": {
  155033. rootNodeName: string;
  155034. labelAnchorNodeName: string;
  155035. touchPointNodeName: string;
  155036. };
  155037. "xr-standard-thumbstick": {
  155038. rootNodeName: string;
  155039. componentProperty: string;
  155040. states: string[];
  155041. };
  155042. };
  155043. axes: {
  155044. "xr-standard-touchpad": {
  155045. "x-axis": {
  155046. rootNodeName: string;
  155047. };
  155048. "y-axis": {
  155049. rootNodeName: string;
  155050. };
  155051. };
  155052. "xr-standard-thumbstick": {
  155053. "x-axis": {
  155054. rootNodeName: string;
  155055. };
  155056. "y-axis": {
  155057. rootNodeName: string;
  155058. };
  155059. };
  155060. };
  155061. };
  155062. /**
  155063. * The base url used to load the left and right controller models
  155064. */
  155065. static MODEL_BASE_URL: string;
  155066. /**
  155067. * The name of the left controller model file
  155068. */
  155069. static MODEL_LEFT_FILENAME: string;
  155070. /**
  155071. * The name of the right controller model file
  155072. */
  155073. static MODEL_RIGHT_FILENAME: string;
  155074. profileId: string;
  155075. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  155076. protected _getFilenameAndPath(): {
  155077. filename: string;
  155078. path: string;
  155079. };
  155080. protected _getModelLoadingConstraints(): boolean;
  155081. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  155082. protected _setRootMesh(meshes: AbstractMesh[]): void;
  155083. protected _updateModel(): void;
  155084. }
  155085. }
  155086. declare module BABYLON {
  155087. /**
  155088. * The motion controller class for oculus touch (quest, rift).
  155089. * This class supports legacy mapping as well the standard xr mapping
  155090. */
  155091. export class WebXROculusTouchMotionController extends WebXRAbstractMotionController {
  155092. private _forceLegacyControllers;
  155093. private _modelRootNode;
  155094. /**
  155095. * The base url used to load the left and right controller models
  155096. */
  155097. static MODEL_BASE_URL: string;
  155098. /**
  155099. * The name of the left controller model file
  155100. */
  155101. static MODEL_LEFT_FILENAME: string;
  155102. /**
  155103. * The name of the right controller model file
  155104. */
  155105. static MODEL_RIGHT_FILENAME: string;
  155106. /**
  155107. * Base Url for the Quest controller model.
  155108. */
  155109. static QUEST_MODEL_BASE_URL: string;
  155110. profileId: string;
  155111. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness, legacyMapping?: boolean, _forceLegacyControllers?: boolean);
  155112. protected _getFilenameAndPath(): {
  155113. filename: string;
  155114. path: string;
  155115. };
  155116. protected _getModelLoadingConstraints(): boolean;
  155117. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  155118. protected _setRootMesh(meshes: AbstractMesh[]): void;
  155119. protected _updateModel(): void;
  155120. /**
  155121. * Is this the new type of oculus touch. At the moment both have the same profile and it is impossible to differentiate
  155122. * between the touch and touch 2.
  155123. */
  155124. private _isQuest;
  155125. }
  155126. }
  155127. declare module BABYLON {
  155128. /**
  155129. * The motion controller class for the standard HTC-Vive controllers
  155130. */
  155131. export class WebXRHTCViveMotionController extends WebXRAbstractMotionController {
  155132. private _modelRootNode;
  155133. /**
  155134. * The base url used to load the left and right controller models
  155135. */
  155136. static MODEL_BASE_URL: string;
  155137. /**
  155138. * File name for the controller model.
  155139. */
  155140. static MODEL_FILENAME: string;
  155141. profileId: string;
  155142. /**
  155143. * Create a new Vive motion controller object
  155144. * @param scene the scene to use to create this controller
  155145. * @param gamepadObject the corresponding gamepad object
  155146. * @param handedness the handedness of the controller
  155147. */
  155148. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  155149. protected _getFilenameAndPath(): {
  155150. filename: string;
  155151. path: string;
  155152. };
  155153. protected _getModelLoadingConstraints(): boolean;
  155154. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  155155. protected _setRootMesh(meshes: AbstractMesh[]): void;
  155156. protected _updateModel(): void;
  155157. }
  155158. }
  155159. declare module BABYLON {
  155160. /**
  155161. * A cursor which tracks a point on a path
  155162. */
  155163. export class PathCursor {
  155164. private path;
  155165. /**
  155166. * Stores path cursor callbacks for when an onchange event is triggered
  155167. */
  155168. private _onchange;
  155169. /**
  155170. * The value of the path cursor
  155171. */
  155172. value: number;
  155173. /**
  155174. * The animation array of the path cursor
  155175. */
  155176. animations: Animation[];
  155177. /**
  155178. * Initializes the path cursor
  155179. * @param path The path to track
  155180. */
  155181. constructor(path: Path2);
  155182. /**
  155183. * Gets the cursor point on the path
  155184. * @returns A point on the path cursor at the cursor location
  155185. */
  155186. getPoint(): Vector3;
  155187. /**
  155188. * Moves the cursor ahead by the step amount
  155189. * @param step The amount to move the cursor forward
  155190. * @returns This path cursor
  155191. */
  155192. moveAhead(step?: number): PathCursor;
  155193. /**
  155194. * Moves the cursor behind by the step amount
  155195. * @param step The amount to move the cursor back
  155196. * @returns This path cursor
  155197. */
  155198. moveBack(step?: number): PathCursor;
  155199. /**
  155200. * Moves the cursor by the step amount
  155201. * If the step amount is greater than one, an exception is thrown
  155202. * @param step The amount to move the cursor
  155203. * @returns This path cursor
  155204. */
  155205. move(step: number): PathCursor;
  155206. /**
  155207. * Ensures that the value is limited between zero and one
  155208. * @returns This path cursor
  155209. */
  155210. private ensureLimits;
  155211. /**
  155212. * Runs onchange callbacks on change (used by the animation engine)
  155213. * @returns This path cursor
  155214. */
  155215. private raiseOnChange;
  155216. /**
  155217. * Executes a function on change
  155218. * @param f A path cursor onchange callback
  155219. * @returns This path cursor
  155220. */
  155221. onchange(f: (cursor: PathCursor) => void): PathCursor;
  155222. }
  155223. }
  155224. declare module BABYLON {
  155225. /** @hidden */
  155226. export var blurPixelShader: {
  155227. name: string;
  155228. shader: string;
  155229. };
  155230. }
  155231. declare module BABYLON {
  155232. /** @hidden */
  155233. export var pointCloudVertexDeclaration: {
  155234. name: string;
  155235. shader: string;
  155236. };
  155237. }
  155238. // Mixins
  155239. interface Window {
  155240. mozIndexedDB: IDBFactory;
  155241. webkitIndexedDB: IDBFactory;
  155242. msIndexedDB: IDBFactory;
  155243. webkitURL: typeof URL;
  155244. mozRequestAnimationFrame(callback: FrameRequestCallback): number;
  155245. oRequestAnimationFrame(callback: FrameRequestCallback): number;
  155246. WebGLRenderingContext: WebGLRenderingContext;
  155247. MSGesture: MSGesture;
  155248. CANNON: any;
  155249. AudioContext: AudioContext;
  155250. webkitAudioContext: AudioContext;
  155251. PointerEvent: any;
  155252. Math: Math;
  155253. Uint8Array: Uint8ArrayConstructor;
  155254. Float32Array: Float32ArrayConstructor;
  155255. mozURL: typeof URL;
  155256. msURL: typeof URL;
  155257. VRFrameData: any; // WebVR, from specs 1.1
  155258. DracoDecoderModule: any;
  155259. setImmediate(handler: (...args: any[]) => void): number;
  155260. }
  155261. interface HTMLCanvasElement {
  155262. requestPointerLock(): void;
  155263. msRequestPointerLock?(): void;
  155264. mozRequestPointerLock?(): void;
  155265. webkitRequestPointerLock?(): void;
  155266. /** Track wether a record is in progress */
  155267. isRecording: boolean;
  155268. /** Capture Stream method defined by some browsers */
  155269. captureStream(fps?: number): MediaStream;
  155270. }
  155271. interface CanvasRenderingContext2D {
  155272. msImageSmoothingEnabled: boolean;
  155273. }
  155274. interface MouseEvent {
  155275. mozMovementX: number;
  155276. mozMovementY: number;
  155277. webkitMovementX: number;
  155278. webkitMovementY: number;
  155279. msMovementX: number;
  155280. msMovementY: number;
  155281. }
  155282. interface Navigator {
  155283. mozGetVRDevices: (any: any) => any;
  155284. webkitGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  155285. mozGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  155286. msGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  155287. webkitGetGamepads(): Gamepad[];
  155288. msGetGamepads(): Gamepad[];
  155289. webkitGamepads(): Gamepad[];
  155290. }
  155291. interface HTMLVideoElement {
  155292. mozSrcObject: any;
  155293. }
  155294. interface Math {
  155295. fround(x: number): number;
  155296. imul(a: number, b: number): number;
  155297. }
  155298. interface WebGLRenderingContext {
  155299. drawArraysInstanced(mode: number, first: number, count: number, primcount: number): void;
  155300. drawElementsInstanced(mode: number, count: number, type: number, offset: number, primcount: number): void;
  155301. vertexAttribDivisor(index: number, divisor: number): void;
  155302. createVertexArray(): any;
  155303. bindVertexArray(vao?: WebGLVertexArrayObject | null): void;
  155304. deleteVertexArray(vao: WebGLVertexArrayObject): void;
  155305. blitFramebuffer(srcX0: number, srcY0: number, srcX1: number, srcY1: number, dstX0: number, dstY0: number, dstX1: number, dstY1: number, mask: number, filter: number): void;
  155306. renderbufferStorageMultisample?(target: number, samples: number, internalformat: number, width: number, height: number): void;
  155307. bindBufferBase(target: number, index: number, buffer: WebGLBuffer | null): void;
  155308. getUniformBlockIndex(program: WebGLProgram, uniformBlockName: string): number;
  155309. uniformBlockBinding(program: WebGLProgram, uniformBlockIndex: number, uniformBlockBinding: number): void;
  155310. // Queries
  155311. createQuery(): WebGLQuery;
  155312. deleteQuery(query: WebGLQuery): void;
  155313. beginQuery(target: number, query: WebGLQuery): void;
  155314. endQuery(target: number): void;
  155315. getQueryParameter(query: WebGLQuery, pname: number): any;
  155316. getQuery(target: number, pname: number): any;
  155317. MAX_SAMPLES: number;
  155318. RGBA8: number;
  155319. READ_FRAMEBUFFER: number;
  155320. DRAW_FRAMEBUFFER: number;
  155321. UNIFORM_BUFFER: number;
  155322. HALF_FLOAT_OES: number;
  155323. RGBA16F: number;
  155324. RGBA32F: number;
  155325. R32F: number;
  155326. RG32F: number;
  155327. RGB32F: number;
  155328. R16F: number;
  155329. RG16F: number;
  155330. RGB16F: number;
  155331. RED: number;
  155332. RG: number;
  155333. R8: number;
  155334. RG8: number;
  155335. UNSIGNED_INT_24_8: number;
  155336. DEPTH24_STENCIL8: number;
  155337. MIN: number;
  155338. MAX: number;
  155339. /* Multiple Render Targets */
  155340. drawBuffers(buffers: number[]): void;
  155341. readBuffer(src: number): void;
  155342. readonly COLOR_ATTACHMENT0: number; // 0x8CE1
  155343. readonly COLOR_ATTACHMENT1: number; // 0x8CE2
  155344. readonly COLOR_ATTACHMENT2: number; // 0x8CE3
  155345. readonly COLOR_ATTACHMENT3: number; // 0x8CE4
  155346. // Occlusion Query
  155347. ANY_SAMPLES_PASSED_CONSERVATIVE: number;
  155348. ANY_SAMPLES_PASSED: number;
  155349. QUERY_RESULT_AVAILABLE: number;
  155350. QUERY_RESULT: number;
  155351. }
  155352. interface WebGLProgram {
  155353. __SPECTOR_rebuildProgram?: ((vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (program: WebGLProgram) => void, onError: (message: string) => void) => void) | null;
  155354. }
  155355. interface EXT_disjoint_timer_query {
  155356. QUERY_COUNTER_BITS_EXT: number;
  155357. TIME_ELAPSED_EXT: number;
  155358. TIMESTAMP_EXT: number;
  155359. GPU_DISJOINT_EXT: number;
  155360. QUERY_RESULT_EXT: number;
  155361. QUERY_RESULT_AVAILABLE_EXT: number;
  155362. queryCounterEXT(query: WebGLQuery, target: number): void;
  155363. createQueryEXT(): WebGLQuery;
  155364. beginQueryEXT(target: number, query: WebGLQuery): void;
  155365. endQueryEXT(target: number): void;
  155366. getQueryObjectEXT(query: WebGLQuery, target: number): any;
  155367. deleteQueryEXT(query: WebGLQuery): void;
  155368. }
  155369. interface WebGLUniformLocation {
  155370. _currentState: any;
  155371. }
  155372. // Type definitions for WebGL 2, Editor's Draft Fri Feb 24 16:10:18 2017 -0800
  155373. // Project: https://www.khronos.org/registry/webgl/specs/latest/2.0/
  155374. // Definitions by: Nico Kemnitz <https://github.com/nkemnitz/>
  155375. // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
  155376. interface WebGLRenderingContext {
  155377. readonly RASTERIZER_DISCARD: number;
  155378. readonly DEPTH_COMPONENT24: number;
  155379. readonly TEXTURE_3D: number;
  155380. readonly TEXTURE_2D_ARRAY: number;
  155381. readonly TEXTURE_COMPARE_FUNC: number;
  155382. readonly TEXTURE_COMPARE_MODE: number;
  155383. readonly COMPARE_REF_TO_TEXTURE: number;
  155384. readonly TEXTURE_WRAP_R: number;
  155385. readonly HALF_FLOAT: number;
  155386. readonly RGB8: number;
  155387. readonly RED_INTEGER: number;
  155388. readonly RG_INTEGER: number;
  155389. readonly RGB_INTEGER: number;
  155390. readonly RGBA_INTEGER: number;
  155391. readonly R8_SNORM: number;
  155392. readonly RG8_SNORM: number;
  155393. readonly RGB8_SNORM: number;
  155394. readonly RGBA8_SNORM: number;
  155395. readonly R8I: number;
  155396. readonly RG8I: number;
  155397. readonly RGB8I: number;
  155398. readonly RGBA8I: number;
  155399. readonly R8UI: number;
  155400. readonly RG8UI: number;
  155401. readonly RGB8UI: number;
  155402. readonly RGBA8UI: number;
  155403. readonly R16I: number;
  155404. readonly RG16I: number;
  155405. readonly RGB16I: number;
  155406. readonly RGBA16I: number;
  155407. readonly R16UI: number;
  155408. readonly RG16UI: number;
  155409. readonly RGB16UI: number;
  155410. readonly RGBA16UI: number;
  155411. readonly R32I: number;
  155412. readonly RG32I: number;
  155413. readonly RGB32I: number;
  155414. readonly RGBA32I: number;
  155415. readonly R32UI: number;
  155416. readonly RG32UI: number;
  155417. readonly RGB32UI: number;
  155418. readonly RGBA32UI: number;
  155419. readonly RGB10_A2UI: number;
  155420. readonly R11F_G11F_B10F: number;
  155421. readonly RGB9_E5: number;
  155422. readonly RGB10_A2: number;
  155423. readonly UNSIGNED_INT_2_10_10_10_REV: number;
  155424. readonly UNSIGNED_INT_10F_11F_11F_REV: number;
  155425. readonly UNSIGNED_INT_5_9_9_9_REV: number;
  155426. readonly FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  155427. readonly DEPTH_COMPONENT32F: number;
  155428. texImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, format: number, type: number, pixels: ArrayBufferView | null): void;
  155429. texImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, format: number, type: number, pixels: ArrayBufferView, offset: number): void;
  155430. 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;
  155431. framebufferTextureLayer(target: number, attachment: number, texture: WebGLTexture | null, level: number, layer: number): void;
  155432. compressedTexImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, data: ArrayBufferView, offset?: number, length?: number): void;
  155433. readonly TRANSFORM_FEEDBACK: number;
  155434. readonly INTERLEAVED_ATTRIBS: number;
  155435. readonly TRANSFORM_FEEDBACK_BUFFER: number;
  155436. createTransformFeedback(): WebGLTransformFeedback;
  155437. deleteTransformFeedback(transformFeedbac: WebGLTransformFeedback): void;
  155438. bindTransformFeedback(target: number, transformFeedback: WebGLTransformFeedback | null): void;
  155439. beginTransformFeedback(primitiveMode: number): void;
  155440. endTransformFeedback(): void;
  155441. transformFeedbackVaryings(program: WebGLProgram, varyings: string[], bufferMode: number): void;
  155442. clearBufferfv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  155443. clearBufferiv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  155444. clearBufferuiv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  155445. clearBufferfi(buffer: number, drawbuffer: number, depth: number, stencil: number): void;
  155446. }
  155447. interface ImageBitmap {
  155448. readonly width: number;
  155449. readonly height: number;
  155450. close(): void;
  155451. }
  155452. interface WebGLQuery extends WebGLObject {
  155453. }
  155454. declare var WebGLQuery: {
  155455. prototype: WebGLQuery;
  155456. new(): WebGLQuery;
  155457. };
  155458. interface WebGLSampler extends WebGLObject {
  155459. }
  155460. declare var WebGLSampler: {
  155461. prototype: WebGLSampler;
  155462. new(): WebGLSampler;
  155463. };
  155464. interface WebGLSync extends WebGLObject {
  155465. }
  155466. declare var WebGLSync: {
  155467. prototype: WebGLSync;
  155468. new(): WebGLSync;
  155469. };
  155470. interface WebGLTransformFeedback extends WebGLObject {
  155471. }
  155472. declare var WebGLTransformFeedback: {
  155473. prototype: WebGLTransformFeedback;
  155474. new(): WebGLTransformFeedback;
  155475. };
  155476. interface WebGLVertexArrayObject extends WebGLObject {
  155477. }
  155478. declare var WebGLVertexArrayObject: {
  155479. prototype: WebGLVertexArrayObject;
  155480. new(): WebGLVertexArrayObject;
  155481. };
  155482. // Type definitions for WebVR API
  155483. // Project: https://w3c.github.io/webvr/
  155484. // Definitions by: six a <https://github.com/lostfictions>
  155485. // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
  155486. interface VRDisplay extends EventTarget {
  155487. /**
  155488. * Dictionary of capabilities describing the VRDisplay.
  155489. */
  155490. readonly capabilities: VRDisplayCapabilities;
  155491. /**
  155492. * z-depth defining the far plane of the eye view frustum
  155493. * enables mapping of values in the render target depth
  155494. * attachment to scene coordinates. Initially set to 10000.0.
  155495. */
  155496. depthFar: number;
  155497. /**
  155498. * z-depth defining the near plane of the eye view frustum
  155499. * enables mapping of values in the render target depth
  155500. * attachment to scene coordinates. Initially set to 0.01.
  155501. */
  155502. depthNear: number;
  155503. /**
  155504. * An identifier for this distinct VRDisplay. Used as an
  155505. * association point in the Gamepad API.
  155506. */
  155507. readonly displayId: number;
  155508. /**
  155509. * A display name, a user-readable name identifying it.
  155510. */
  155511. readonly displayName: string;
  155512. readonly isConnected: boolean;
  155513. readonly isPresenting: boolean;
  155514. /**
  155515. * If this VRDisplay supports room-scale experiences, the optional
  155516. * stage attribute contains details on the room-scale parameters.
  155517. */
  155518. readonly stageParameters: VRStageParameters | null;
  155519. /**
  155520. * Passing the value returned by `requestAnimationFrame` to
  155521. * `cancelAnimationFrame` will unregister the callback.
  155522. * @param handle Define the hanle of the request to cancel
  155523. */
  155524. cancelAnimationFrame(handle: number): void;
  155525. /**
  155526. * Stops presenting to the VRDisplay.
  155527. * @returns a promise to know when it stopped
  155528. */
  155529. exitPresent(): Promise<void>;
  155530. /**
  155531. * Return the current VREyeParameters for the given eye.
  155532. * @param whichEye Define the eye we want the parameter for
  155533. * @returns the eye parameters
  155534. */
  155535. getEyeParameters(whichEye: string): VREyeParameters;
  155536. /**
  155537. * Populates the passed VRFrameData with the information required to render
  155538. * the current frame.
  155539. * @param frameData Define the data structure to populate
  155540. * @returns true if ok otherwise false
  155541. */
  155542. getFrameData(frameData: VRFrameData): boolean;
  155543. /**
  155544. * Get the layers currently being presented.
  155545. * @returns the list of VR layers
  155546. */
  155547. getLayers(): VRLayer[];
  155548. /**
  155549. * Return a VRPose containing the future predicted pose of the VRDisplay
  155550. * when the current frame will be presented. The value returned will not
  155551. * change until JavaScript has returned control to the browser.
  155552. *
  155553. * The VRPose will contain the position, orientation, velocity,
  155554. * and acceleration of each of these properties.
  155555. * @returns the pose object
  155556. */
  155557. getPose(): VRPose;
  155558. /**
  155559. * Return the current instantaneous pose of the VRDisplay, with no
  155560. * prediction applied.
  155561. * @returns the current instantaneous pose
  155562. */
  155563. getImmediatePose(): VRPose;
  155564. /**
  155565. * The callback passed to `requestAnimationFrame` will be called
  155566. * any time a new frame should be rendered. When the VRDisplay is
  155567. * presenting the callback will be called at the native refresh
  155568. * rate of the HMD. When not presenting this function acts
  155569. * identically to how window.requestAnimationFrame acts. Content should
  155570. * make no assumptions of frame rate or vsync behavior as the HMD runs
  155571. * asynchronously from other displays and at differing refresh rates.
  155572. * @param callback Define the eaction to run next frame
  155573. * @returns the request handle it
  155574. */
  155575. requestAnimationFrame(callback: FrameRequestCallback): number;
  155576. /**
  155577. * Begin presenting to the VRDisplay. Must be called in response to a user gesture.
  155578. * Repeat calls while already presenting will update the VRLayers being displayed.
  155579. * @param layers Define the list of layer to present
  155580. * @returns a promise to know when the request has been fulfilled
  155581. */
  155582. requestPresent(layers: VRLayer[]): Promise<void>;
  155583. /**
  155584. * Reset the pose for this display, treating its current position and
  155585. * orientation as the "origin/zero" values. VRPose.position,
  155586. * VRPose.orientation, and VRStageParameters.sittingToStandingTransform may be
  155587. * updated when calling resetPose(). This should be called in only
  155588. * sitting-space experiences.
  155589. */
  155590. resetPose(): void;
  155591. /**
  155592. * The VRLayer provided to the VRDisplay will be captured and presented
  155593. * in the HMD. Calling this function has the same effect on the source
  155594. * canvas as any other operation that uses its source image, and canvases
  155595. * created without preserveDrawingBuffer set to true will be cleared.
  155596. * @param pose Define the pose to submit
  155597. */
  155598. submitFrame(pose?: VRPose): void;
  155599. }
  155600. declare var VRDisplay: {
  155601. prototype: VRDisplay;
  155602. new(): VRDisplay;
  155603. };
  155604. interface VRLayer {
  155605. leftBounds?: number[] | Float32Array | null;
  155606. rightBounds?: number[] | Float32Array | null;
  155607. source?: HTMLCanvasElement | null;
  155608. }
  155609. interface VRDisplayCapabilities {
  155610. readonly canPresent: boolean;
  155611. readonly hasExternalDisplay: boolean;
  155612. readonly hasOrientation: boolean;
  155613. readonly hasPosition: boolean;
  155614. readonly maxLayers: number;
  155615. }
  155616. interface VREyeParameters {
  155617. /** @deprecated */
  155618. readonly fieldOfView: VRFieldOfView;
  155619. readonly offset: Float32Array;
  155620. readonly renderHeight: number;
  155621. readonly renderWidth: number;
  155622. }
  155623. interface VRFieldOfView {
  155624. readonly downDegrees: number;
  155625. readonly leftDegrees: number;
  155626. readonly rightDegrees: number;
  155627. readonly upDegrees: number;
  155628. }
  155629. interface VRFrameData {
  155630. readonly leftProjectionMatrix: Float32Array;
  155631. readonly leftViewMatrix: Float32Array;
  155632. readonly pose: VRPose;
  155633. readonly rightProjectionMatrix: Float32Array;
  155634. readonly rightViewMatrix: Float32Array;
  155635. readonly timestamp: number;
  155636. }
  155637. interface VRPose {
  155638. readonly angularAcceleration: Float32Array | null;
  155639. readonly angularVelocity: Float32Array | null;
  155640. readonly linearAcceleration: Float32Array | null;
  155641. readonly linearVelocity: Float32Array | null;
  155642. readonly orientation: Float32Array | null;
  155643. readonly position: Float32Array | null;
  155644. readonly timestamp: number;
  155645. }
  155646. interface VRStageParameters {
  155647. sittingToStandingTransform?: Float32Array;
  155648. sizeX?: number;
  155649. sizeY?: number;
  155650. }
  155651. interface Navigator {
  155652. getVRDisplays(): Promise<VRDisplay[]>;
  155653. readonly activeVRDisplays: ReadonlyArray<VRDisplay>;
  155654. }
  155655. interface Window {
  155656. onvrdisplayconnected: ((this: Window, ev: Event) => any) | null;
  155657. onvrdisplaydisconnected: ((this: Window, ev: Event) => any) | null;
  155658. onvrdisplaypresentchange: ((this: Window, ev: Event) => any) | null;
  155659. addEventListener(type: "vrdisplayconnected", listener: (ev: Event) => any, useCapture?: boolean): void;
  155660. addEventListener(type: "vrdisplaydisconnected", listener: (ev: Event) => any, useCapture?: boolean): void;
  155661. addEventListener(type: "vrdisplaypresentchange", listener: (ev: Event) => any, useCapture?: boolean): void;
  155662. }
  155663. interface Gamepad {
  155664. readonly displayId: number;
  155665. }
  155666. type XRSessionMode = "inline" | "immersive-vr" | "immersive-ar";
  155667. type XRReferenceSpaceType = "viewer" | "local" | "local-floor" | "bounded-floor" | "unbounded";
  155668. type XREnvironmentBlendMode = "opaque" | "additive" | "alpha-blend";
  155669. type XRVisibilityState = "visible" | "visible-blurred" | "hidden";
  155670. type XRHandedness = "none" | "left" | "right";
  155671. type XRTargetRayMode = "gaze" | "tracked-pointer" | "screen";
  155672. type XREye = "none" | "left" | "right";
  155673. type XREventType = "devicechange" | "visibilitychange" | "end" | "inputsourceschange" | "select" | "selectstart" | "selectend" | "squeeze" | "squeezestart" | "squeezeend" | "reset";
  155674. interface XRSpace extends EventTarget {}
  155675. interface XRRenderState {
  155676. depthNear?: number;
  155677. depthFar?: number;
  155678. inlineVerticalFieldOfView?: number;
  155679. baseLayer?: XRWebGLLayer;
  155680. }
  155681. interface XRInputSource {
  155682. handedness: XRHandedness;
  155683. targetRayMode: XRTargetRayMode;
  155684. targetRaySpace: XRSpace;
  155685. gripSpace: XRSpace | undefined;
  155686. gamepad: Gamepad | undefined;
  155687. profiles: Array<string>;
  155688. hand: XRHand | undefined;
  155689. }
  155690. interface XRSessionInit {
  155691. optionalFeatures?: string[];
  155692. requiredFeatures?: string[];
  155693. }
  155694. interface XRSession {
  155695. addEventListener: Function;
  155696. removeEventListener: Function;
  155697. requestReferenceSpace(type: XRReferenceSpaceType): Promise<XRReferenceSpace>;
  155698. updateRenderState(XRRenderStateInit: XRRenderState): Promise<void>;
  155699. requestAnimationFrame: Function;
  155700. end(): Promise<void>;
  155701. renderState: XRRenderState;
  155702. inputSources: Array<XRInputSource>;
  155703. // hit test
  155704. requestHitTestSource(options: XRHitTestOptionsInit): Promise<XRHitTestSource>;
  155705. requestHitTestSourceForTransientInput(options: XRTransientInputHitTestOptionsInit): Promise<XRTransientInputHitTestSource>;
  155706. // legacy AR hit test
  155707. requestHitTest(ray: XRRay, referenceSpace: XRReferenceSpace): Promise<XRHitResult[]>;
  155708. // legacy plane detection
  155709. updateWorldTrackingState(options: { planeDetectionState?: { enabled: boolean } }): void;
  155710. }
  155711. interface XRReferenceSpace extends XRSpace {
  155712. getOffsetReferenceSpace(originOffset: XRRigidTransform): XRReferenceSpace;
  155713. onreset: any;
  155714. }
  155715. type XRPlaneSet = Set<XRPlane>;
  155716. type XRAnchorSet = Set<XRAnchor>;
  155717. interface XRFrame {
  155718. session: XRSession;
  155719. getViewerPose(referenceSpace: XRReferenceSpace): XRViewerPose | undefined;
  155720. getPose(space: XRSpace, baseSpace: XRSpace): XRPose | undefined;
  155721. // AR
  155722. getHitTestResults(hitTestSource: XRHitTestSource): Array<XRHitTestResult>;
  155723. getHitTestResultsForTransientInput(hitTestSource: XRTransientInputHitTestSource): Array<XRTransientInputHitTestResult>;
  155724. // Anchors
  155725. trackedAnchors?: XRAnchorSet;
  155726. createAnchor(pose: XRRigidTransform, space: XRSpace): Promise<XRAnchor>;
  155727. // Planes
  155728. worldInformation: {
  155729. detectedPlanes?: XRPlaneSet;
  155730. };
  155731. // Hand tracking
  155732. getJointPose(joint: XRJointSpace, baseSpace: XRSpace): XRJointPose;
  155733. }
  155734. interface XRViewerPose extends XRPose {
  155735. views: Array<XRView>;
  155736. }
  155737. interface XRPose {
  155738. transform: XRRigidTransform;
  155739. emulatedPosition: boolean;
  155740. }
  155741. interface XRWebGLLayerOptions {
  155742. antialias?: boolean;
  155743. depth?: boolean;
  155744. stencil?: boolean;
  155745. alpha?: boolean;
  155746. multiview?: boolean;
  155747. framebufferScaleFactor?: number;
  155748. }
  155749. declare var XRWebGLLayer: {
  155750. prototype: XRWebGLLayer;
  155751. new (session: XRSession, context: WebGLRenderingContext | undefined, options?: XRWebGLLayerOptions): XRWebGLLayer;
  155752. };
  155753. interface XRWebGLLayer {
  155754. framebuffer: WebGLFramebuffer;
  155755. framebufferWidth: number;
  155756. framebufferHeight: number;
  155757. getViewport: Function;
  155758. }
  155759. declare class XRRigidTransform {
  155760. constructor(matrix: Float32Array | DOMPointInit, direction?: DOMPointInit);
  155761. position: DOMPointReadOnly;
  155762. orientation: DOMPointReadOnly;
  155763. matrix: Float32Array;
  155764. inverse: XRRigidTransform;
  155765. }
  155766. interface XRView {
  155767. eye: XREye;
  155768. projectionMatrix: Float32Array;
  155769. transform: XRRigidTransform;
  155770. }
  155771. interface XRInputSourceChangeEvent {
  155772. session: XRSession;
  155773. removed: Array<XRInputSource>;
  155774. added: Array<XRInputSource>;
  155775. }
  155776. interface XRInputSourceEvent extends Event {
  155777. readonly frame: XRFrame;
  155778. readonly inputSource: XRInputSource;
  155779. }
  155780. // Experimental(er) features
  155781. declare class XRRay {
  155782. constructor(transformOrOrigin: XRRigidTransform | DOMPointInit, direction?: DOMPointInit);
  155783. origin: DOMPointReadOnly;
  155784. direction: DOMPointReadOnly;
  155785. matrix: Float32Array;
  155786. }
  155787. declare enum XRHitTestTrackableType {
  155788. "point",
  155789. "plane",
  155790. "mesh",
  155791. }
  155792. interface XRHitResult {
  155793. hitMatrix: Float32Array;
  155794. }
  155795. interface XRTransientInputHitTestResult {
  155796. readonly inputSource: XRInputSource;
  155797. readonly results: Array<XRHitTestResult>;
  155798. }
  155799. interface XRHitTestResult {
  155800. getPose(baseSpace: XRSpace): XRPose | undefined;
  155801. // When anchor system is enabled
  155802. createAnchor?(pose: XRRigidTransform): Promise<XRAnchor>;
  155803. }
  155804. interface XRHitTestSource {
  155805. cancel(): void;
  155806. }
  155807. interface XRTransientInputHitTestSource {
  155808. cancel(): void;
  155809. }
  155810. interface XRHitTestOptionsInit {
  155811. space: XRSpace;
  155812. entityTypes?: Array<XRHitTestTrackableType>;
  155813. offsetRay?: XRRay;
  155814. }
  155815. interface XRTransientInputHitTestOptionsInit {
  155816. profile: string;
  155817. entityTypes?: Array<XRHitTestTrackableType>;
  155818. offsetRay?: XRRay;
  155819. }
  155820. interface XRAnchor {
  155821. anchorSpace: XRSpace;
  155822. delete(): void;
  155823. }
  155824. interface XRPlane {
  155825. orientation: "Horizontal" | "Vertical";
  155826. planeSpace: XRSpace;
  155827. polygon: Array<DOMPointReadOnly>;
  155828. lastChangedTime: number;
  155829. }
  155830. interface XRJointSpace extends XRSpace {}
  155831. interface XRJointPose extends XRPose {
  155832. radius: number | undefined;
  155833. }
  155834. interface XRHand /*extends Iterablele<XRJointSpace>*/ {
  155835. readonly length: number;
  155836. [index: number]: XRJointSpace;
  155837. // Specs have the function 'joint(idx: number)', but chrome doesn't support it yet.
  155838. readonly WRIST: number;
  155839. readonly THUMB_METACARPAL: number;
  155840. readonly THUMB_PHALANX_PROXIMAL: number;
  155841. readonly THUMB_PHALANX_DISTAL: number;
  155842. readonly THUMB_PHALANX_TIP: number;
  155843. readonly INDEX_METACARPAL: number;
  155844. readonly INDEX_PHALANX_PROXIMAL: number;
  155845. readonly INDEX_PHALANX_INTERMEDIATE: number;
  155846. readonly INDEX_PHALANX_DISTAL: number;
  155847. readonly INDEX_PHALANX_TIP: number;
  155848. readonly MIDDLE_METACARPAL: number;
  155849. readonly MIDDLE_PHALANX_PROXIMAL: number;
  155850. readonly MIDDLE_PHALANX_INTERMEDIATE: number;
  155851. readonly MIDDLE_PHALANX_DISTAL: number;
  155852. readonly MIDDLE_PHALANX_TIP: number;
  155853. readonly RING_METACARPAL: number;
  155854. readonly RING_PHALANX_PROXIMAL: number;
  155855. readonly RING_PHALANX_INTERMEDIATE: number;
  155856. readonly RING_PHALANX_DISTAL: number;
  155857. readonly RING_PHALANX_TIP: number;
  155858. readonly LITTLE_METACARPAL: number;
  155859. readonly LITTLE_PHALANX_PROXIMAL: number;
  155860. readonly LITTLE_PHALANX_INTERMEDIATE: number;
  155861. readonly LITTLE_PHALANX_DISTAL: number;
  155862. readonly LITTLE_PHALANX_TIP: number;
  155863. }
  155864. // This file contains native only extensions for WebXR These APIs are not supported in the browser yet.
  155865. // They are intended for use with either Babylon Native https://github.com/BabylonJS/BabylonNative or
  155866. // Babylon React Native: https://github.com/BabylonJS/BabylonReactNative
  155867. interface XRSession {
  155868. trySetFeaturePointCloudEnabled(enabled: boolean): boolean;
  155869. }
  155870. interface XRFrame {
  155871. featurePointCloud? : Array<number>;
  155872. }